soundwire.h File Reference

#include <types.h>

Include dependency graph for soundwire.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	soundwire_address
struct	soundwire_link
	struct soundwire_link - SoundWire master device properties. More...
struct	soundwire_controller
	struct soundwire_controller - SoundWire controller properties. More...
struct	soundwire_slave
	struct soundwire_slave - SoundWire slave device properties. More...
struct	soundwire_multilane_map
	struct soundwire_multilane_map - Pair a soundwire lane with direction. More...
union	soundwire_multilane_map::lane_type
struct	soundwire_multilane
	struct soundwire_multilane - Multi-Lane SoundWire slave device. More...
struct	soundwire_audio_mode
	struct soundwire_audio_mode - Properties for each supported Audio Mode. More...
struct	soundwire_dpn
	struct soundwire_dpn - Configuration properties for SoundWire DPn Data Ports. More...
struct	soundwire_bra_mode
	struct soundwire_bra_mode - Bulk Register Access mode properties. More...
struct	soundwire_dp0
	struct soundwire_dp0 - Configuration properties for SoundWire DP0 Data Port. More...
struct	soundwire_dpn_entry
	struct soundwire_dpn_entry - Full duplex data port properties for DPn 1-14. More...
struct	soundwire_codec
	struct soundwire_codec - Contains all configuration for a SoundWire codec slave device. More...

Macros
#define	SOUNDWIRE_PORT(port)   BIT(port)

Enumerations
enum	soundwire_limits {   SOUNDWIRE_MAX = 32 , SOUNDWIRE_MIN_DPN = 1 , SOUNDWIRE_MAX_DPN = 14 , SOUNDWIRE_MAX_SLAVE = 11 ,   SOUNDWIRE_MAX_LINK = 8 , SOUNDWIRE_MAX_LANE = 8 , SOUNDWIRE_MAX_MODE = 4 }
	enum soundwire_limits - Limits on number of SoundWire devices in topology. More...
enum	soundwire_sw_version { SOUNDWIRE_SW_VERSION_1_0 = 0x00010000 }
	enum soundwire_sw_version - Versions of SoundWire Discovery and Configuration Specification. More...
enum	soundwire_version { SOUNDWIRE_VERSION_1_0 = 1 , SOUNDWIRE_VERSION_1_1 , SOUNDWIRE_VERSION_1_2 }
	enum soundwire_version - Versions of SoundWire Specification supported by a device. More...
enum	mipi_class { MIPI_CLASS_NONE , MIPI_CLASS_SDCA }
	enum mipi_class - MIPI class encoding. More...
enum	soundwire_multilane_dir { MASTER_LANE , SLAVE_LINK }
	enum soundwire_multilane_dir - Direction of lane in slave multilane device. More...
enum	soundwire_prepare_channel_behavior { CHANNEL_PREPARE_ANY_FREQUENCY , CHANNEL_PREPARE_SUPPORTED_FREQUENCY }
	enum soundwire_prepare_channel_behavior - Specifies the dependencies between the Channel Prepare sequence and bus clock config. More...
enum	soundwire_data_port_type { FULL_DATA_PORT , SIMPLIFIED_DATA_PORT , REDUCED_DATA_PORT }
enum	soundwire_block_group_count { BLOCK_GROUP_COUNT_1 , BLOCK_GROUP_COUNT_2 , BLOCK_GROUP_COUNT_3 , BLOCK_GROUP_COUNT_4 }
enum	soundwire_mode_bitmap { MODE_ISOCHRONOUS = BIT(0) , MODE_TX_CONTROLLED = BIT(1) , MODE_RX_CONTROLLED = BIT(2) , MODE_FULL_ASYNCHRONOUS = BIT(3) }
enum	soundwire_port_encoding_bitmap { ENCODE_TWOS_COMPLEMENT = BIT(0) , ENCODE_SIGN_MAGNITUDE = BIT(1) , ENCODE_IEEE_32BIT_FP = BIT(2) }

Macro Definition Documentation

SOUNDWIRE_PORT

#define SOUNDWIRE_PORT

(

port

)

BIT(port)

Definition at line 133 of file soundwire.h.

Enumeration Type Documentation

mipi_class

enum mipi_class

enum mipi_class - MIPI class encoding.

@MIPI_CLASS_NONE: No further class decoding. @MIPI_CLASS_SDCA: Device implements SoundWire Device Class for Audio (SDCA).

0x02-0x7F: Reserved 0x80-0xFF: MIPI Alliance extended device class

Enumerator
MIPI_CLASS_NONE
MIPI_CLASS_SDCA

Definition at line 69 of file soundwire.h.

soundwire_block_group_count

enum soundwire_block_group_count

Enumerator
BLOCK_GROUP_COUNT_1
BLOCK_GROUP_COUNT_2
BLOCK_GROUP_COUNT_3
BLOCK_GROUP_COUNT_4

Definition at line 264 of file soundwire.h.

soundwire_data_port_type

enum soundwire_data_port_type

Enumerator
FULL_DATA_PORT
SIMPLIFIED_DATA_PORT
REDUCED_DATA_PORT

Definition at line 257 of file soundwire.h.

soundwire_limits

enum soundwire_limits

enum soundwire_limits - Limits on number of SoundWire devices in topology.

@SOUNDWIRE_MAX: Maximum value for lists of configuration values in SoundWire devices. @SOUNDWIRE_MIN_DPN: Data Port minimum value. DPn range is 1-14. @SOUNDWIRE_MAX_DPN: Data Port maximum value. DPn range is 1-14. @SOUNDWIRE_MAX_SLAVE: Maximum number of slave devices that can be attached to one master. @SOUNDWIRE_MAX_LINK: Maximum number of master link devices that can be on one controller. @SOUNDWIRE_MAX_LANE: Maximum number of lanes in a multi-lane slave device. @SOUNDWIRE_MAX_MODE: Maximum number of Audio or Bulk Register Access modes.

Enumerator
SOUNDWIRE_MAX
SOUNDWIRE_MIN_DPN
SOUNDWIRE_MAX_DPN
SOUNDWIRE_MAX_SLAVE
SOUNDWIRE_MAX_LINK
SOUNDWIRE_MAX_LANE
SOUNDWIRE_MAX_MODE

Definition at line 31 of file soundwire.h.

soundwire_mode_bitmap

enum soundwire_mode_bitmap

Enumerator
MODE_ISOCHRONOUS
MODE_TX_CONTROLLED
MODE_RX_CONTROLLED
MODE_FULL_ASYNCHRONOUS

Definition at line 272 of file soundwire.h.

soundwire_multilane_dir

enum soundwire_multilane_dir

enum soundwire_multilane_dir - Direction of lane in slave multilane device.

@MASTER_LANE: Lane is connected to a master device. @SLAVE_LINK: Lane is connected to a slave device.

Enumerator
MASTER_LANE
SLAVE_LINK

Definition at line 178 of file soundwire.h.

soundwire_port_encoding_bitmap

enum soundwire_port_encoding_bitmap

Enumerator
ENCODE_TWOS_COMPLEMENT
ENCODE_SIGN_MAGNITUDE
ENCODE_IEEE_32BIT_FP

Definition at line 280 of file soundwire.h.

soundwire_prepare_channel_behavior

enum soundwire_prepare_channel_behavior

enum soundwire_prepare_channel_behavior - Specifies the dependencies between the Channel Prepare sequence and bus clock config.

@CHANNEL_PREPARE_ANY_FREQUENCY: Channel Prepare can happen at any bus clock rate. @CHANNEL_PREPARE_SUPPORTED_FREQUENCY: Channel Prepare sequence shall happen only after the bus clock is changed to a supported frequency.

Enumerator
CHANNEL_PREPARE_ANY_FREQUENCY
CHANNEL_PREPARE_SUPPORTED_FREQUENCY

Definition at line 221 of file soundwire.h.

soundwire_sw_version

enum soundwire_sw_version

enum soundwire_sw_version - Versions of SoundWire Discovery and Configuration Specification.

@SOUNDWIRE_SW_VERSION_1_0: DisCo Specification Version 1.0 released November 2016.

Enumerator
SOUNDWIRE_SW_VERSION_1_0

Definition at line 45 of file soundwire.h.

soundwire_version

enum soundwire_version

enum soundwire_version - Versions of SoundWire Specification supported by a device.

@SOUNDWIRE_VERSION_1_0: SoundWire Specification Version 1.0 released January 2015. @SOUNDWIRE_VERSION_1_1: SoundWire Specification Version 1.1 released June 2016. @SOUNDWIRE_VERSION_1_2: SoundWire Specification Version 1.2 released April 2019.

Enumerator
SOUNDWIRE_VERSION_1_0
SOUNDWIRE_VERSION_1_1
SOUNDWIRE_VERSION_1_2

Definition at line 55 of file soundwire.h.