gateway.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2021 Intel Corporation. All rights reserved.
 */
 
/*
 * This file contains structures that are exact copies of an existing ABI used
 * by IOT middleware. They are Intel specific and will be used by one middleware.
 *
 * Some of the structures may contain programming implementations that makes them
 * unsuitable for generic use and general usage.
 *
 * This code is mostly copied "as-is" from existing C++ interface files hence the use of
 * different style in places. The intention is to keep the interface as close as possible to
 * original so it's easier to track changes with IPC host code.
 */
 
#ifndef __SOF_IPC4_GATEWAY_H__
#define __SOF_IPC4_GATEWAY_H__
 
#include <stdint.h>
#include <rtos/bit.h>
 
enum ipc4_connector_node_id_type {
    ipc4_hda_host_output_class = 0,
    ipc4_hda_host_input_class = 1,
    ipc4_hda_host_inout_class = 2,
 
    ipc4_hda_link_output_class = 8,
    ipc4_hda_link_input_class = 9,
    ipc4_hda_link_inout_class = 10,
 
    ipc4_dmic_link_input_class = 11,
 
    ipc4_i2s_link_output_class = 12,
    ipc4_i2s_link_input_class = 13,
 
    ipc4_alh_link_output_class = 16,
    ipc4_alh_link_input_class = 17,
 
    ipc4_alh_snd_wire_stream_link_output_class = 16,
    ipc4_alh_snd_wire_stream_link_input_class = 17,
 
    ipc4_alh_uaol_stream_link_output_class = 18,
    ipc4_alh_uaol_stream_link_input_class = 19,
 
    ipc4_ipc_output_class = 20,
    ipc4_ipc_input_class = 21,
 
    ipc4_i2s_multi_link_output_class = 22,
    ipc4_i2s_multi_link_input_class = 23,
    ipc4_gpio_class = 24,
    ipc4_spi_output_class = 25,
    ipc4_spi_input_class = 26,
    ipc4_max_connector_node_id_type
};
 
#define IPC4_INVALID_NODE_ID    0xffffffff
 
#define IPC4_NODE_ID_MASK   0x1fff
 
union ipc4_connector_node_id {
    uint32_t dw; 
    struct {
        uint32_t v_index : 8;  
        uint32_t dma_type : 5; 
        uint32_t _rsvd : 19;   
    } f; 
} __attribute__((packed, aligned(4)));
 
#define IPC4_HW_HOST_OUTPUT_NODE_ID_BASE    0x00
#define IPC4_HW_CODE_LOADER_NODE_ID     0x0F
#define IPC4_HW_LINK_INPUT_NODE_ID_BASE     0x10
 
union ipc4_gateway_attributes {
    uint32_t dw; 
    struct {
        uint32_t lp_buffer_alloc : 1;     
        uint32_t alloc_from_reg_file : 1; 
        uint32_t _rsvd : 30;              
    } bits; 
} __attribute__((packed, aligned(4)));
 
struct ipc4_gateway_config_data {
    union ipc4_gateway_attributes gtw_attributes; 
    uint32_t config_blob[]; 
} __attribute__((packed, aligned(4)));
 
struct ipc4_ipc_gateway_config_blob {
    uint32_t buffer_size; 
    union {
        struct {
            uint32_t notif_high : 1; 
            uint32_t notif_low : 1;  
            uint32_t rsvd : 30;      
        } f; 
        uint32_t flags_raw; 
    } u; 
    uint32_t threshold_high; 
    uint32_t threshold_low;  
} __attribute__((packed, aligned(4)));
 
enum ipc4_gateway_type {
    ipc4_gtw_none   = BIT(0), 
    ipc4_gtw_host   = BIT(1), 
    ipc4_gtw_dmic   = BIT(2), 
    ipc4_gtw_link   = BIT(3), 
    ipc4_gtw_alh    = BIT(4), 
    ipc4_gtw_ssp    = BIT(5), 
    ipc4_gtw_all    = BIT(6) - 1 
};
 
enum ipc4_direction_type {
    ipc4_playback = BIT(0),                 
    ipc4_capture = BIT(1),                  
    ipc4_bidirection = BIT(0) | BIT(1)      
};
 
#define IPC4_DIRECTION(x) BIT(x)
#endif