nRF5 SDK v17.1.0
Modules | Macros | Typedefs | Functions
I2S driver - legacy layer

Layer providing compatibility with the former API. More...

Modules

 I2S peripheral driver - legacy layer configuration
 

Macros

#define NRF_DRV_I2S_PIN_NOT_USED   NRFX_I2S_PIN_NOT_USED
 Macro for forwarding the new implementation.
 
#define NRF_DRV_I2S_FLAG_SYNCHRONIZED_MODE   NRFX_I2S_FLAG_SYNCHRONIZED_MODE
 Macro for forwarding the new implementation.
 
#define NRF_DRV_I2S_DEFAULT_CONFIG   NRFX_I2S_DEFAULT_CONFIG
 Macro for forwarding the new implementation.
 
#define NRF_DRV_I2S_STATUS_NEXT_BUFFERS_NEEDED   NRFX_I2S_STATUS_NEXT_BUFFERS_NEEDED
 Macro for forwarding the new implementation.
 
#define nrf_drv_i2s_data_handler_t   nrfx_i2s_data_handler_t
 Macro for forwarding the new implementation.
 
#define nrf_drv_i2s_uninit   nrfx_i2s_uninit
 Macro for forwarding the new implementation.
 
#define nrf_drv_i2s_start   nrfx_i2s_start
 Macro for forwarding the new implementation.
 
#define nrf_drv_i2s_next_buffers_set   nrfx_i2s_next_buffers_set
 Macro for forwarding the new implementation.
 
#define nrf_drv_i2s_stop   nrfx_i2s_stop
 Macro for forwarding the new implementation.
 

Typedefs

typedef nrfx_i2s_config_t nrf_drv_i2s_config_t
 Type definition for forwarding the new implementation.
 
typedef nrfx_i2s_buffers_t nrf_drv_i2s_buffers_t
 Type definition for forwarding the new implementation.
 

Functions

__STATIC_INLINE ret_code_t nrf_drv_i2s_init (nrf_drv_i2s_config_t const *p_config, nrfx_i2s_data_handler_t handler)
 Function for initializing the I2S driver. More...
 

Detailed Description

Layer providing compatibility with the former API.

Function Documentation

__STATIC_INLINE ret_code_t nrf_drv_i2s_init ( nrf_drv_i2s_config_t const *  p_config,
nrfx_i2s_data_handler_t  handler 
)

Function for initializing the I2S driver.

Parameters
[in]p_configPointer to the structure with initial configuration. If NULL, the default configuration is used.
[in]handlerData handler provided by the user. Must not be NULL.
Return values
NRF_SUCCESSIf initialization was successful.
NRF_ERROR_INVALID_STATEIf the driver was already initialized.
NRF_ERROR_INVALID_PARAMIf the requested combination of configuration options is not allowed by the I2S peripheral.

Documentation feedback | Developer Zone | Subscribe | Updated