pipeline.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_PIPELINE_H__
#define __SOF_IPC4_PIPELINE_H__
 
#include <stdint.h>
#include <ipc4/error_status.h>
 
enum ipc4_pipeline_priority {
    SOF_IPC4_PIPELINE_PRIORITY_0 = 0, 
    SOF_IPC4_PIPELINE_PRIORITY_1,     
    SOF_IPC4_PIPELINE_PRIORITY_2,     
    SOF_IPC4_PIPELINE_PRIORITY_3,     
    SOF_IPC4_PIPELINE_PRIORITY_4,     
    SOF_IPC4_PIPELINE_PRIORITY_5,     
    SOF_IPC4_PIPELINE_PRIORITY_6,     
    SOF_IPC4_PIPELINE_PRIORITY_7,     
    SOF_IPC4_MAX_PIPELINE_PRIORITY = SOF_IPC4_PIPELINE_PRIORITY_7 
};
 
enum ipc4_pipeline_state {
    SOF_IPC4_PIPELINE_STATE_INVALID = 0,       
    SOF_IPC4_PIPELINE_STATE_UNINITIALIZED = 1, 
    SOF_IPC4_PIPELINE_STATE_RESET = 2,         
    SOF_IPC4_PIPELINE_STATE_PAUSED = 3,        
    SOF_IPC4_PIPELINE_STATE_RUNNING = 4,       
    SOF_IPC4_PIPELINE_STATE_EOS = 5,           
    SOF_IPC4_PIPELINE_STATE_ERROR_STOP,        
    SOF_IPC4_PIPELINE_STATE_SAVED              
};
 
enum ipc4_pipeline_ext_obj_id {
    IPC4_GLB_PIPE_EXT_OBJ_ID_INVALID = 0,     
    IPC4_GLB_PIPE_EXT_OBJ_ID_MEM_DATA = 1,    
    IPC4_GLB_PIPE_EXT_OBJ_ID_MAX = IPC4_GLB_PIPE_EXT_OBJ_ID_MEM_DATA, 
};
 
struct ipc4_pipeline_ext_object {
    uint32_t last_object : 1;   
    uint32_t object_id : 15;    
    uint32_t object_words : 16; 
} __packed __aligned(4);
 
struct ipc4_pipeline_ext_obj_mem_data {
    uint32_t domain_id;     
    uint32_t stack_bytes;       
    uint32_t heap_bytes;        
} __packed __aligned(4);
 
struct ipc4_pipeline_ext_payload {
    uint32_t payload_words : 24;    
    uint32_t data_obj_array : 1;    
    uint32_t rsvd0      : 7;    
    uint32_t rsvd1;         
    uint32_t rsvd2;         
} __packed __aligned(4);
 
struct ipc4_pipeline_create {
    union {
        uint32_t dat; 
        struct {
            uint32_t ppl_mem_size   : 11; 
            uint32_t ppl_priority   : 5;  
            uint32_t instance_id    : 8;  
            uint32_t type           : 5;  
            uint32_t rsp            : 1;  
            uint32_t msg_tgt        : 1;  
            uint32_t _reserved_0    : 1;  
        } r;
    } primary;
 
    union{
        uint32_t dat; 
        struct {
            uint32_t lp             : 1;  
            uint32_t rsvd1          : 3;  
            uint32_t attributes     : 16; 
            uint32_t core_id        : 4;  
            uint32_t rsvd2          : 5;  
            uint32_t payload    : 1;  
            uint32_t _reserved_2    : 2;  
        } r;
    } extension;
} __attribute__((packed, aligned(4)));
 
struct ipc4_pipeline_delete {
    union {
        uint32_t dat; 
        struct {
            uint32_t rsvd0          : 16; 
            uint32_t instance_id    : 8;  
            uint32_t type           : 5;  
            uint32_t rsp            : 1;  
            uint32_t msg_tgt        : 1;  
            uint32_t _reserved_0    : 1;  
        } r;
    } primary;
 
    union{
        uint32_t dat; 
        struct {
            uint32_t rsvd1          : 30; 
            uint32_t _reserved_2    : 2;  
        } r;
    } extension;
} __attribute__((packed, aligned(4)));
 
struct ipc4_pipeline_set_state_data {
    uint32_t pipelines_count; 
    uint32_t ppl_id[];        
} __attribute__((packed, aligned(4)));
 
struct ipc4_pipeline_set_state {
    union {
        uint32_t dat; 
        struct {
            uint32_t ppl_state  : 16;
            uint32_t ppl_id     : 8;
            uint32_t type       : 5;
            uint32_t rsp        : 1;
            uint32_t msg_tgt    : 1;
            uint32_t _reserved_0: 1; 
        } r;
    } primary;
 
    union{
        uint32_t dat; 
        struct {
            uint32_t multi_ppl  : 1;
            uint32_t sync_stop_start : 1;
            uint32_t rsvd1      : 28; 
            uint32_t _reserved_2: 2;  
        } r;
    } extension;
 
    struct ipc4_pipeline_set_state_data s_data; 
} __attribute__((packed, aligned(4)));
 
struct ipc4_pipeline_set_state_reply {
    union {
        uint32_t dat; 
        struct {
            uint32_t status     : IPC4_IXC_STATUS_BITS; 
            uint32_t type       : 5;  
            uint32_t rsp        : 1;  
            uint32_t msg_tgt    : 1;  
            uint32_t _reserved_0: 1;  
        } r;
    } primary;
 
    union{
        uint32_t dat; 
        struct {
            uint32_t ppl_id     : 30;
            uint32_t _reserved_2: 2;  
        } r;
    } extension;
} __attribute__((packed, aligned(4)));
 
struct ipc4_pipeline_get_state {
    union {
        uint32_t dat; 
        struct {
            uint32_t ppl_id     : 8;  
            uint32_t rsvd       : 16; 
            uint32_t type       : 5;  
            uint32_t rsp        : 1;  
            uint32_t msg_tgt    : 1;  
            uint32_t _reserved_0: 1;  
        } r;
    } primary;
 
    union{
        uint32_t dat; 
        struct {
            uint32_t rsvd1      : 30; 
            uint32_t _reserved_2: 2;  
        } r;
    } extension;
} __attribute__((packed, aligned(4)));
 
struct ipc4_pipeline_get_state_reply {
    union {
        uint32_t dat; 
        struct {
            uint32_t status      : IPC4_IXC_STATUS_BITS; 
            uint32_t type       : 5;  
            uint32_t rsp        : 1;  
            uint32_t msg_tgt    : 1;  
            uint32_t _reserved_0: 1;  
        } r;
    } primary;
 
    union{
        uint32_t dat; 
        struct {
            uint32_t state      : 5;
            uint32_t rsvd1      : 25; 
            uint32_t _reserved_2: 2;  
        } r;
    } extension;
} __attribute__((packed, aligned(4)));
 
struct ipc4_pipeline_get_context_size {
    union {
        uint32_t dat; 
        struct {
            uint32_t rsvd0          : 16; 
            uint32_t instance_id    : 8;  
            uint32_t type           : 5;  
            uint32_t rsp            : 1;  
            uint32_t msg_tgt        : 1;  
            uint32_t _reserved_0    : 1;  
        } r;
    } primary;
 
    union{
        uint32_t dat; 
        struct {
            uint32_t rsvd1          : 30; 
            uint32_t _reserved_2    : 2;  
        } r;
    } extension;
} __attribute__((packed, aligned(4)));
 
struct ipc4_pipeline_get_context_size_reply {
    union {
        uint32_t dat; 
        struct {
            uint32_t status : IPC4_IXC_STATUS_BITS; 
            uint32_t type       : 5;  
            uint32_t rsp        : 1;  
            uint32_t msg_tgt    : 1;  
            uint32_t _reserved_0: 1;  
        } r;
    } primary;
 
    union{
        uint32_t dat; 
        struct {
            uint32_t ctx_size   : 16;
            uint32_t rsvd1      : 14; 
            uint32_t _reserved_2: 2;  
        } r;
    } extension;
} __attribute__((packed, aligned(4)));
 
struct ipc4_chain_dma {
    union {
        uint32_t dat; 
        struct {
            uint32_t host_dma_id        : 5; 
            uint32_t rsvd4          : 3; 
            uint32_t link_dma_id        : 5; 
            uint32_t rsvd3          : 3; 
            uint32_t allocate       : 1; 
            uint32_t enable         : 1; 
            uint32_t scs            : 1; 
            uint32_t rsvd2          : 5; 
            uint32_t type           : 5; 
            uint32_t rsp            : 1; 
            uint32_t msg_tgt        : 1; 
            uint32_t _reserved_0        : 1; 
        } r;
    } primary;
 
    union {
        uint32_t dat; 
        struct {
            uint32_t fifo_size      : 24; 
            uint32_t rsvd1          : 6;  
            uint32_t _reserved_2        : 2;  
        } r;
    } extension;
} __attribute__((packed, aligned(4)));
 
#endif