Enum

Overview

Enumerations
enum	hal_i2s_status_t {   HAL_I2S_STATUS_INVALID_PARAMETER = -2,   HAL_I2S_STATUS_ERROR = -1,   HAL_I2S_STATUS_OK = 0 }
	This enum defines the I2S status. More...
enum	hal_i2s_clock_mode_t {   HAL_I2S_MASTER = 0,   HAL_I2S_SLAVE = 1 }
	This enum defines the I2S clock mode. More...
enum	hal_i2s_channel_number_t {   HAL_I2S_MONO = 0,   HAL_I2S_STEREO = 1 }
	This enum defines the I2S channel number. More...
enum	hal_i2s_initial_type_t {   HAL_I2S_TYPE_EXTERNAL_MODE = 0,   HAL_I2S_TYPE_EXTERNAL_TDM_MODE = 1,   HAL_I2S_TYPE_INTERNAL_MODE = 2,   HAL_I2S_TYPE_INTERNAL_LOOPBACK_MODE = 3 }
	This enum defines initial type of I2S. More...
enum	hal_i2s_event_t {   HAL_I2S_EVENT_DATA_REQUEST = 0,   HAL_I2S_EVENT_DATA_NOTIFICATION = 1 }
	I2S event. More...
enum	hal_i2s_sample_rate_t {   HAL_I2S_SAMPLE_RATE_8K = 0,   HAL_I2S_SAMPLE_RATE_12K = 1,   HAL_I2S_SAMPLE_RATE_16K = 2,   HAL_I2S_SAMPLE_RATE_24K = 3,   HAL_I2S_SAMPLE_RATE_32K = 4,   HAL_I2S_SAMPLE_RATE_48K = 5 }
	I2S sample rate definition. More...
enum	hal_i2s_sample_width_t {   HAL_I2S_SAMPLE_WIDTH_8BIT = 0,   HAL_I2S_SAMPLE_WIDTH_16BIT = 1,   HAL_I2S_SAMPLE_WIDTH_24BIT = 2 }
	I2S sample widths. More...
enum	hal_i2s_frame_sync_width_t {   HAL_I2S_FRAME_SYNC_WIDTH_32 = 0,   HAL_I2S_FRAME_SYNC_WIDTH_64 = 1,   HAL_I2S_FRAME_SYNC_WIDTH_128 = 2 }
	Number of bits per frame sync(FS). More...
enum	hal_i2s_tx_mode_t {   HAL_I2S_TX_MONO_DUPLICATE_DISABLE = 0,   HAL_I2S_TX_MONO_DUPLICATE_ENABLE = 1 }
	Enable or disable right channel of the I2S TX to send the same data as on the left channel of the I2S TX. More...
enum	hal_i2s_rx_down_rate_t {   HAL_I2S_RX_DOWN_RATE_DISABLE = 0,   HAL_I2S_RX_DOWN_RATE_ENABLE = 1 }
	Enable or disable twice the downsampling rate mode in the I2S RX link. More...
enum	hal_i2s_lr_swap_t {   HAL_I2S_LR_SWAP_DISABLE = 0,   HAL_I2S_LR_SWAP_ENABLE = 1 }
	Enable or disable data swapping between right and left channels of the I2S link. More...
enum	hal_i2s_word_select_inverse_t {   HAL_I2S_WORD_SELECT_INVERSE_DISABLE = 0,   HAL_I2S_WORD_SELECT_INVERSE_ENABLE = 1 }
	Enable or disable word select clock inverting of the I2S link. More...

Enumeration Type Documentation

enum hal_i2s_channel_number_t

This enum defines the I2S channel number.

Enumerator
HAL_I2S_MONO	A single channel.
HAL_I2S_STEREO	Two channels.

enum hal_i2s_clock_mode_t

This enum defines the I2S clock mode.

Enumerator
HAL_I2S_MASTER	Clock source fed to an external device.
HAL_I2S_SLAVE	Clock source comes from an external device.

enum hal_i2s_event_t

I2S event.

Enumerator
HAL_I2S_EVENT_DATA_REQUEST	This value means request user to fill data.
HAL_I2S_EVENT_DATA_NOTIFICATION	This value means notify user the RX data is ready.

enum hal_i2s_frame_sync_width_t

Number of bits per frame sync(FS).

This parameter determines the bits of a complete sample of both left and right channels.

Enumerator
HAL_I2S_FRAME_SYNC_WIDTH_32	32 bits per frame.
HAL_I2S_FRAME_SYNC_WIDTH_64	64 bits per frame. (Invalid)
HAL_I2S_FRAME_SYNC_WIDTH_128	128 bits per frame. (Invalid)

enum hal_i2s_initial_type_t

This enum defines initial type of I2S.

Enumerator
HAL_I2S_TYPE_EXTERNAL_MODE	i2s external mode
HAL_I2S_TYPE_EXTERNAL_TDM_MODE	i2s external tdm mode<invalid>
HAL_I2S_TYPE_INTERNAL_MODE	i2s internal mode<invalid>
HAL_I2S_TYPE_INTERNAL_LOOPBACK_MODE	i2s internal loopback mode

enum hal_i2s_lr_swap_t

Enable or disable data swapping between right and left channels of the I2S link.

Enumerator
HAL_I2S_LR_SWAP_DISABLE	Disable the data swapping.
HAL_I2S_LR_SWAP_ENABLE	Enable the data swapping.

enum hal_i2s_rx_down_rate_t

Enable or disable twice the downsampling rate mode in the I2S RX link.

In this mode the sampling rate of the I2S TX is 48kHz while the sampling rate of the I2S RX is 24kHz. The I2S RX automatically drops 1 sample in each 2 input samples received.

Enumerator
HAL_I2S_RX_DOWN_RATE_DISABLE	Actual sampling rate of the I2S RX = sampling rate.
HAL_I2S_RX_DOWN_RATE_ENABLE	Actual sampling rate of the I2S RX is half of the original sampling rate. (Invalid)

enum hal_i2s_sample_rate_t

I2S sample rate definition.

Enumerator
HAL_I2S_SAMPLE_RATE_8K	8000Hz
HAL_I2S_SAMPLE_RATE_12K	12000Hz
HAL_I2S_SAMPLE_RATE_16K	16000Hz
HAL_I2S_SAMPLE_RATE_24K	24000Hz
HAL_I2S_SAMPLE_RATE_32K	32000Hz
HAL_I2S_SAMPLE_RATE_48K	48000Hz

enum hal_i2s_sample_width_t

I2S sample widths.

Enumerator
HAL_I2S_SAMPLE_WIDTH_8BIT	I2S sample width is 8bit. (Invalid)
HAL_I2S_SAMPLE_WIDTH_16BIT	I2S sample width is 16bit.
HAL_I2S_SAMPLE_WIDTH_24BIT	I2S sample width is 24bit. (Invalid)

enum hal_i2s_status_t

This enum defines the I2S status.

Enumerator
HAL_I2S_STATUS_INVALID_PARAMETER	A wrong parameter is given.
HAL_I2S_STATUS_ERROR	An error occurred during the function call.
HAL_I2S_STATUS_OK	No error occurred during the function call.

enum hal_i2s_tx_mode_t

Enable or disable right channel of the I2S TX to send the same data as on the left channel of the I2S TX.

Enumerator
HAL_I2S_TX_MONO_DUPLICATE_DISABLE	Keep data to its channel.
HAL_I2S_TX_MONO_DUPLICATE_ENABLE	Right channel of the TX, sends the same data as the left.

enum hal_i2s_word_select_inverse_t

Enable or disable word select clock inverting of the I2S link.

Enumerator
HAL_I2S_WORD_SELECT_INVERSE_DISABLE	Disable the word select clock inverting.
HAL_I2S_WORD_SELECT_INVERSE_ENABLE	Enable the word select clock inverting.