stream.h

Go to the documentation of this file.

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

 
#ifndef __IPC_STREAM_H__
#define __IPC_STREAM_H__
 
#include <module/ipc/stream.h>
#include <ipc/header.h>
#include <stdint.h>
 
/*
 * Stream configuration.
 */
/* common sample rates for use in masks */
#define SOF_RATE_8000       (1 <<  0) 
#define SOF_RATE_11025      (1 <<  1) 
#define SOF_RATE_12000      (1 <<  2) 
#define SOF_RATE_16000      (1 <<  3) 
#define SOF_RATE_22050      (1 <<  4) 
#define SOF_RATE_24000      (1 <<  5) 
#define SOF_RATE_32000      (1 <<  6) 
#define SOF_RATE_44100      (1 <<  7) 
#define SOF_RATE_48000      (1 <<  8) 
#define SOF_RATE_64000      (1 <<  9) 
#define SOF_RATE_88200      (1 << 10) 
#define SOF_RATE_96000      (1 << 11) 
#define SOF_RATE_176400     (1 << 12) 
#define SOF_RATE_192000     (1 << 13) 
 
/* continuous and non-standard rates for flexibility */
#define SOF_RATE_CONTINUOUS (1 << 30)  
#define SOF_RATE_KNOT       (1 << 31)  
 
/* generic PCM flags for runtime settings */
#define SOF_PCM_FLAG_XRUN_STOP  (1 << 0) 
 
/* stream buffer format */
enum sof_ipc_buffer_format {
    SOF_IPC_BUFFER_INTERLEAVED,
    SOF_IPC_BUFFER_NONINTERLEAVED,
    /* other formats here */
};
 
/* stream direction */
enum sof_ipc_stream_direction {
    SOF_IPC_STREAM_PLAYBACK = 0,
    SOF_IPC_STREAM_CAPTURE,
};
 
/* stream ring info */
struct sof_ipc_host_buffer {
    struct sof_ipc_hdr hdr;
    uint32_t phy_addr;
    uint32_t pages;
    uint32_t size;
    uint32_t reserved[3];
} __attribute__((packed, aligned(4)));
 
struct sof_ipc_stream_params {
    struct sof_ipc_hdr hdr;
    struct sof_ipc_host_buffer buffer;
    uint32_t direction; 
    uint32_t frame_fmt; 
    uint32_t buffer_fmt;    
    uint32_t rate;
    uint16_t stream_tag;
    uint16_t channels;
    uint16_t sample_valid_bytes;
    uint16_t sample_container_bytes;
 
    uint32_t host_period_bytes;
    uint16_t no_stream_position; 
    uint8_t cont_update_posn; 
    uint8_t reserved0;
    uint16_t ext_data_length; 
 
    uint8_t reserved[2];
    uint16_t chmap[SOF_IPC_MAX_CHANNELS];   
    int8_t data[]; 
} __attribute__((packed, aligned(4)));
 
/* PCM params info - SOF_IPC_STREAM_PCM_PARAMS */
struct sof_ipc_pcm_params {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t comp_id;
    uint32_t flags;     
    uint32_t reserved[2];
    struct sof_ipc_stream_params params;
} __attribute__((packed, aligned(4)));
 
/* PCM params info reply - SOF_IPC_STREAM_PCM_PARAMS_REPLY */
struct sof_ipc_pcm_params_reply {
    struct sof_ipc_reply rhdr;
    uint32_t comp_id;
    uint32_t posn_offset;
} __attribute__((packed, aligned(4)));
 
/* free stream - SOF_IPC_STREAM_PCM_PARAMS */
struct sof_ipc_stream {
    struct sof_ipc_cmd_hdr hdr;
    uint32_t comp_id;
} __attribute__((packed, aligned(4)));
 
/* flags indicating which time stamps are in sync with each other */
#define SOF_TIME_HOST_SYNC  (1 << 0)
#define SOF_TIME_DAI_SYNC   (1 << 1)
#define SOF_TIME_WALL_SYNC  (1 << 2)
#define SOF_TIME_STAMP_SYNC (1 << 3)
 
/* flags indicating which time stamps are valid */
#define SOF_TIME_HOST_VALID (1 << 8)
#define SOF_TIME_DAI_VALID  (1 << 9)
#define SOF_TIME_WALL_VALID (1 << 10)
#define SOF_TIME_STAMP_VALID    (1 << 11)
 
/* flags indicating time stamps are 64bit else 3use low 32bit */
#define SOF_TIME_HOST_64    (1 << 16)
#define SOF_TIME_DAI_64     (1 << 17)
#define SOF_TIME_WALL_64    (1 << 18)
#define SOF_TIME_STAMP_64   (1 << 19)
 
struct sof_ipc_stream_posn {
    struct sof_ipc_reply rhdr;
    uint32_t comp_id;   
    uint32_t flags;     
    uint32_t wallclock_hz;  
    uint32_t timestamp_ns;  
    uint64_t host_posn; 
    uint64_t dai_posn;  
    uint64_t comp_posn; 
    uint64_t wallclock; 
    uint64_t timestamp; 
    uint32_t xrun_comp_id;  
    int32_t xrun_size;  
} __attribute__((packed, aligned(4)));
 
#endif /* __IPC_STREAM_H__ */