control.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2018 Intel Corporation. All rights reserved.
 *
 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
 *         Keyon Jie <yang.jie@linux.intel.com>
 */

 
#ifndef __IPC_CONTROL_H__
#define __IPC_CONTROL_H__
 
#include <ipc/header.h>
#include <ipc/stream.h>
#include <kernel/header.h>
#include <stdint.h>



enum sof_ipc_chmap {
    SOF_CHMAP_UNKNOWN = 0,
    SOF_CHMAP_NA,       
    SOF_CHMAP_MONO,     
    SOF_CHMAP_FL,       
    SOF_CHMAP_FR,       
    SOF_CHMAP_RL,       
    SOF_CHMAP_RR,       
    SOF_CHMAP_FC,       
    SOF_CHMAP_LFE,      
    SOF_CHMAP_SL,       
    SOF_CHMAP_SR,       
    SOF_CHMAP_RC,       
    SOF_CHMAP_FLC,      
    SOF_CHMAP_FRC,      
    SOF_CHMAP_RLC,      
    SOF_CHMAP_RRC,      
    SOF_CHMAP_FLW,      
    SOF_CHMAP_FRW,      
    SOF_CHMAP_FLH,      
    SOF_CHMAP_FCH,      
    SOF_CHMAP_FRH,      
    SOF_CHMAP_TC,       
    SOF_CHMAP_TFL,      
    SOF_CHMAP_TFR,      
    SOF_CHMAP_TFC,      
    SOF_CHMAP_TRL,      
    SOF_CHMAP_TRR,      
    SOF_CHMAP_TRC,      
    SOF_CHMAP_TFLC,     
    SOF_CHMAP_TFRC,     
    SOF_CHMAP_TSL,      
    SOF_CHMAP_TSR,      
    SOF_CHMAP_LLFE,     
    SOF_CHMAP_RLFE,     
    SOF_CHMAP_BC,       
    SOF_CHMAP_BLC,      
    SOF_CHMAP_BRC,      
    SOF_CHMAP_LAST = SOF_CHMAP_BRC,
};

enum sof_ipc_ctrl_type {
    SOF_CTRL_TYPE_VALUE_CHAN_GET = 0,
    SOF_CTRL_TYPE_VALUE_CHAN_SET,
 
    SOF_CTRL_TYPE_VALUE_COMP_GET,
    SOF_CTRL_TYPE_VALUE_COMP_SET,
 
    SOF_CTRL_TYPE_DATA_GET,
    SOF_CTRL_TYPE_DATA_SET,
};

enum sof_ipc_ctrl_cmd {
    SOF_CTRL_CMD_VOLUME = 0, 
    SOF_CTRL_CMD_ENUM,  
    SOF_CTRL_CMD_SWITCH,    
    SOF_CTRL_CMD_BINARY,    
};

struct sof_ipc_ctrl_value_chan {
    uint32_t channel;   
    uint32_t value;
} __attribute__((packed, aligned(4)));

struct sof_ipc_ctrl_value_comp {
    uint32_t index; 
    union {
        uint32_t uvalue;
        int32_t svalue;
    };
} __attribute__((packed, aligned(4)));

struct sof_ipc_ctrl_data {
    struct sof_ipc_reply rhdr;
    uint32_t comp_id;
 
    /* control access and data type */
    uint32_t type;      
    uint32_t cmd;       
    uint32_t index;     
 
    /* control data - can either be appended or DMAed from host */
    struct sof_ipc_host_buffer buffer;
    uint32_t num_elems; 
    uint32_t elems_remaining;   
 
    uint32_t msg_index; 
 
    /* reserved for future use */
    uint32_t reserved[6];
 
    /* Flexible array members[] are forbidden in unions but this
     * does not seem to bother gcc as long as non-standard
     * zero-length arrays[0] are used instead.  Nesting flexible
     * array member declarations in arrays or structures is
     * forbidden too. Cleaning this up would likely require code
     * changes to explicitly cast intermediate steps.
     */
    /* control data - add new types if needed */
    union {
        /* channel values can be used by volume type controls */
        struct sof_ipc_ctrl_value_chan chanv[0];
        /* component values used by routing controls like mux, mixer */
        struct sof_ipc_ctrl_value_comp compv[0];
        /* data can be used by binary controls */
        struct sof_abi_hdr data[0];
    };
} __attribute__((packed, aligned(4)));

enum sof_ipc_ctrl_event_type {
    SOF_CTRL_EVENT_GENERIC = 0, 
    SOF_CTRL_EVENT_GENERIC_METADATA,    
    SOF_CTRL_EVENT_KD,  
    SOF_CTRL_EVENT_VAD, 
};

struct sof_ipc_comp_event {
    struct sof_ipc_reply rhdr;
    uint16_t src_comp_type; 
    uint32_t src_comp_id;   
    uint32_t event_type;    
    uint32_t num_elems; 
 
    /* reserved for future use */
    uint32_t reserved[8];
 
    /* control data - add new types if needed */
    union {
        /* data can be used by binary controls */
        struct sof_abi_hdr data[0];
        /* event specific values */
        uint32_t event_value;
    };
} __attribute__((packed, aligned(4)));


 
#endif /* __IPC_CONTROL_H__ */