dai.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_DAI_H__
#define __IPC_DAI_H__
 
#include <ipc/dai-intel.h>
#include <ipc/dai-imx.h>
#include <ipc/dai-mediatek.h>
#include <ipc/dai-amd.h>
#include <ipc/header.h>
#include <stddef.h>
#include <stdint.h>
 
/*
 * DAI Configuration.
 *
 * Each different DAI type will have it's own structure and IPC cmd.
 */
 
#define SOF_DAI_FMT_I2S     1 
#define SOF_DAI_FMT_RIGHT_J 2 
#define SOF_DAI_FMT_LEFT_J  3 
#define SOF_DAI_FMT_DSP_A   4 
#define SOF_DAI_FMT_DSP_B   5 
#define SOF_DAI_FMT_PDM     6 
 
#define SOF_DAI_FMT_CONT    (1 << 4) 
#define SOF_DAI_FMT_GATED   (0 << 4) 
 
#define SOF_DAI_FMT_NB_NF   (0 << 8) 
#define SOF_DAI_FMT_NB_IF   (2 << 8) 
#define SOF_DAI_FMT_IB_NF   (3 << 8) 
#define SOF_DAI_FMT_IB_IF   (4 << 8) 
 
#define SOF_DAI_FMT_CBP_CFP (0 << 12) 
#define SOF_DAI_FMT_CBC_CFP (2 << 12) 
#define SOF_DAI_FMT_CBP_CFC (3 << 12) 
#define SOF_DAI_FMT_CBC_CFC (4 << 12) 
 
#define SOF_DAI_FMT_FORMAT_MASK     0x000f
#define SOF_DAI_FMT_CLOCK_MASK      0x00f0
#define SOF_DAI_FMT_INV_MASK        0x0f00
#define SOF_DAI_FMT_CLOCK_PROVIDER_MASK 0xf000
 
/*
 * DAI_CONFIG flags. The 4 LSB bits are used for the commands, HW_PARAMS, HW_FREE and PAUSE
 * representing when the IPC is sent. The 4 MSB bits are used to add quirks along with the above
 * commands.
 */
#define SOF_DAI_CONFIG_FLAGS_CMD_MASK   0xF
#define SOF_DAI_CONFIG_FLAGS_NONE   0 
#define SOF_DAI_CONFIG_FLAGS_HW_PARAMS  BIT(0) 
#define SOF_DAI_CONFIG_FLAGS_HW_FREE    BIT(1) 
#define SOF_DAI_CONFIG_FLAGS_PAUSE  BIT(2)
#define SOF_DAI_CONFIG_FLAGS_QUIRK_SHIFT 4
#define SOF_DAI_CONFIG_FLAGS_QUIRK_MASK  (0xF << SOF_DAI_CONFIG_FLAGS_QUIRK_SHIFT)
/*
 * This should be used along with the SOF_DAI_CONFIG_FLAGS_HW_PARAMS to indicate that pipeline
 * stop/pause and DAI DMA stop/pause should happen in two steps. This change is only available
 * ABI 3.20 onwards.
 */
#define SOF_DAI_CONFIG_FLAGS_2_STEP_STOP BIT(0)
 
#define SOF_DAI_QUIRK_IS_SET(flags, quirk) \
    (((flags & SOF_DAI_CONFIG_FLAGS_QUIRK_MASK) >> SOF_DAI_CONFIG_FLAGS_QUIRK_SHIFT) & quirk)

enum sof_ipc_dai_type {
    SOF_DAI_INTEL_NONE = 0,     
    SOF_DAI_INTEL_SSP,      
    SOF_DAI_INTEL_DMIC,     
    SOF_DAI_INTEL_HDA,      
    SOF_DAI_INTEL_ALH,      
    SOF_DAI_IMX_SAI,                
    SOF_DAI_IMX_ESAI,               
    SOF_DAI_AMD_BT,         
    SOF_DAI_AMD_SP,         
    SOF_DAI_AMD_DMIC,       
    SOF_DAI_MEDIATEK_AFE,           
    SOF_DAI_AMD_HS,         
    SOF_DAI_AMD_SP_VIRTUAL,     
    SOF_DAI_AMD_HS_VIRTUAL,     
    SOF_DAI_IMX_MICFIL,     
    SOF_DAI_AMD_SDW,        
    SOF_DAI_INTEL_UAOL,     
    SOF_DAI_AMD_TDM         
};
 
#define SOF_DAI_CONFIG_HW_SPEC_OFFSET offsetof(struct sof_ipc_dai_config, ssp)
 
/* general purpose DAI configuration */
struct sof_ipc_dai_config {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t type;      
    uint32_t dai_index; 
 
    /* physical protocol and clocking */
    uint16_t format;    
    uint8_t group_id;   
    uint8_t flags;      
 
    /* reserved for future use */
    uint32_t reserved[8];
 
    /* HW specific data */
    union {
        struct sof_ipc_dai_ssp_params ssp;
        struct sof_ipc_dai_dmic_params dmic;
        struct sof_ipc_dai_hda_params hda;
        struct sof_ipc_dai_alh_params alh;
        struct sof_ipc_dai_esai_params esai;
        struct sof_ipc_dai_sai_params sai;
        struct sof_ipc_dai_acp_params acpbt;
        struct sof_ipc_dai_acp_params acpsp;
        struct sof_ipc_dai_acpdmic_params acpdmic;
        struct sof_ipc_dai_acp_params acptdm;
        struct sof_ipc_dai_afe_params afe;
        struct sof_ipc_dai_micfil_params micfil;
        struct sof_ipc_dai_acp_sdw_params acpsdw;
    };
} __attribute__((packed, aligned(4)));
 
#endif /* __IPC_DAI_H__ */