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 the I2S. More...
enum	hal_i2s_event_t {   HAL_I2S_EVENT_ERROR = -1,   HAL_I2S_EVENT_NONE = 0,   HAL_I2S_EVENT_OVERFLOW = 1,   HAL_I2S_EVENT_UNDERFLOW = 2,   HAL_I2S_EVENT_DATA_REQUEST = 3,   HAL_I2S_EVENT_DATA_NOTIFICATION = 4 }
	I2S event. More...
enum	hal_i2s_sample_rate_t {   HAL_I2S_SAMPLE_RATE_8K = 0,   HAL_I2S_SAMPLE_RATE_11_025K = 1,   HAL_I2S_SAMPLE_RATE_12K = 2,   HAL_I2S_SAMPLE_RATE_16K = 3,   HAL_I2S_SAMPLE_RATE_22_05K = 4,   HAL_I2S_SAMPLE_RATE_24K = 5,   HAL_I2S_SAMPLE_RATE_32K = 6,   HAL_I2S_SAMPLE_RATE_44_1K = 7,   HAL_I2S_SAMPLE_RATE_48K = 8 }
	I2S sampling rates. 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_ERROR	An error occurred during the function call.
HAL_I2S_EVENT_NONE	No error occurred during the function call.
HAL_I2S_EVENT_OVERFLOW	RX data overflow.
HAL_I2S_EVENT_UNDERFLOW	TX data underflow.
HAL_I2S_EVENT_DATA_REQUEST	Request for user-defined data.
HAL_I2S_EVENT_DATA_NOTIFICATION	Notify user the RX data is ready.

enum hal_i2s_initial_type_t

This enum defines initial type of the I2S.

Enumerator
HAL_I2S_TYPE_EXTERNAL_MODE	External mode.
HAL_I2S_TYPE_EXTERNAL_TDM_MODE	External TDM mode (invalid).
HAL_I2S_TYPE_INTERNAL_MODE	Internal mode (invalid).
HAL_I2S_TYPE_INTERNAL_LOOPBACK_MODE	Internal loopback mode.

enum hal_i2s_sample_rate_t

I2S sampling rates.

Enumerator
HAL_I2S_SAMPLE_RATE_8K	8000Hz
HAL_I2S_SAMPLE_RATE_11_025K	11025Hz
HAL_I2S_SAMPLE_RATE_12K	12000Hz
HAL_I2S_SAMPLE_RATE_16K	16000Hz
HAL_I2S_SAMPLE_RATE_22_05K	22050Hz
HAL_I2S_SAMPLE_RATE_24K	24000Hz
HAL_I2S_SAMPLE_RATE_32K	32000Hz
HAL_I2S_SAMPLE_RATE_44_1K	44100Hz
HAL_I2S_SAMPLE_RATE_48K	48000Hz

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.