uAPI Control

SOF uAPI specification - component controls. More...

Data Structures
struct	sof_ipc_ctrl_value_chan
	Generic channel mapped value data. More...
struct	sof_ipc_ctrl_value_comp
	Generic component mapped value data. More...
struct	sof_ipc_ctrl_data
	Generic control data. More...
struct	sof_ipc_comp_event
	Generic notification data. More...

Component Mixers and Controls
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 }
	Channel positions - uses same values as ALSA. More...
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 }
	Control data type and direction. More...
enum	sof_ipc_ctrl_cmd { SOF_CTRL_CMD_VOLUME = 0 , SOF_CTRL_CMD_ENUM , SOF_CTRL_CMD_SWITCH , SOF_CTRL_CMD_BINARY }
	Control command type. More...
enum	sof_ipc_ctrl_event_type { SOF_CTRL_EVENT_GENERIC = 0 , SOF_CTRL_EVENT_GENERIC_METADATA , SOF_CTRL_EVENT_KD , SOF_CTRL_EVENT_VAD }
	Event type. More...

Detailed Description

SOF uAPI specification - component controls.

Enumeration Type Documentation

sof_ipc_chmap

enum sof_ipc_chmap

Channel positions - uses same values as ALSA.

Enumerator
SOF_CHMAP_UNKNOWN
SOF_CHMAP_NA	N/A, silent.
SOF_CHMAP_MONO	mono stream
SOF_CHMAP_FL	front left
SOF_CHMAP_FR	front right
SOF_CHMAP_RL	rear left
SOF_CHMAP_RR	rear right
SOF_CHMAP_FC	front centre
SOF_CHMAP_LFE	LFE.
SOF_CHMAP_SL	side left
SOF_CHMAP_SR	side right
SOF_CHMAP_RC	rear centre
SOF_CHMAP_FLC	front left centre
SOF_CHMAP_FRC	front right centre
SOF_CHMAP_RLC	rear left centre
SOF_CHMAP_RRC	rear right centre
SOF_CHMAP_FLW	front left wide
SOF_CHMAP_FRW	front right wide
SOF_CHMAP_FLH	front left high
SOF_CHMAP_FCH	front centre high
SOF_CHMAP_FRH	front right high
SOF_CHMAP_TC	top centre
SOF_CHMAP_TFL	top front left
SOF_CHMAP_TFR	top front right
SOF_CHMAP_TFC	top front centre
SOF_CHMAP_TRL	top rear left
SOF_CHMAP_TRR	top rear right
SOF_CHMAP_TRC	top rear centre
SOF_CHMAP_TFLC	top front left centre
SOF_CHMAP_TFRC	top front right centre
SOF_CHMAP_TSL	top side left
SOF_CHMAP_TSR	top side right
SOF_CHMAP_LLFE	left LFE
SOF_CHMAP_RLFE	right LFE
SOF_CHMAP_BC	bottom centre
SOF_CHMAP_BLC	bottom left centre
SOF_CHMAP_BRC	bottom right centre
SOF_CHMAP_LAST

sof_ipc_ctrl_cmd

enum sof_ipc_ctrl_cmd

Control command type.

Enumerator
SOF_CTRL_CMD_VOLUME	maps to ALSA volume style controls
SOF_CTRL_CMD_ENUM	maps to ALSA enum style controls
SOF_CTRL_CMD_SWITCH	maps to ALSA switch style controls
SOF_CTRL_CMD_BINARY	maps to ALSA binary style controls

sof_ipc_ctrl_event_type

enum sof_ipc_ctrl_event_type

Event type.

Enumerator
SOF_CTRL_EVENT_GENERIC	generic event
SOF_CTRL_EVENT_GENERIC_METADATA	generic event with metadata
SOF_CTRL_EVENT_KD	keyword detection event
SOF_CTRL_EVENT_VAD	voice activity detection event

sof_ipc_ctrl_type

enum sof_ipc_ctrl_type

Control data type and direction.

SOF_CTRL_TYPE_VALUE_CHAN uses struct sof_ipc_ctrl_value_chan. SOF_CTRL_TYPE_VALUE_COMP uses struct sof_ipc_ctrl_value_comp. SOF_CTRL_TYPE_DATA_GET uses sof_abi_hdr.

Enumerator
SOF_CTRL_TYPE_VALUE_CHAN_GET
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