nRF5 SDK v16.0.0
Modules | Macros | Typedefs | Functions
PDM driver - legacy layer

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

Modules

 PDM peripheral driver - legacy layer configuration
 

Macros

#define NRF_PDM_MAX_BUFFER_SIZE   NRFX_PDM_MAX_BUFFER_SIZE
 Macro for forwarding the new implementation.
 
#define NRF_DRV_PDM_DEFAULT_CONFIG   NRFX_PDM_DEFAULT_CONFIG
 Macro for forwarding the new implementation.
 
#define PDM_NO_ERROR   NRFX_PDM_NO_ERROR
 Macro for forwarding the new implementation.
 
#define PDM_ERROR_OVERFLOW   NRFX_PDM_ERROR_OVERFLOW
 Macro for forwarding the new implementation.
 
#define nrf_drv_pdm_error_t   nrfx_pdm_error_t
 Macro for forwarding the new implementation.
 
#define nrf_drv_pdm_event_handler_t   nrfx_pdm_event_handler_t
 Macro for forwarding the new implementation.
 
#define nrf_drv_pdm_uninit   nrfx_pdm_uninit
 Macro for forwarding the new implementation.
 
#define nrf_drv_pdm_task_address_get   nrfx_pdm_task_address_get
 Macro for forwarding the new implementation.
 
#define nrf_drv_pdm_enable_check   nrfx_pdm_enable_check
 Macro for forwarding the new implementation.
 
#define nrf_drv_pdm_start   nrfx_pdm_start
 Macro for forwarding the new implementation.
 
#define nrf_drv_pdm_stop   nrfx_pdm_stop
 Macro for forwarding the new implementation.
 
#define nrf_drv_pdm_buffer_set   nrfx_pdm_buffer_set
 Macro for forwarding the new implementation.
 

Typedefs

typedef nrfx_pdm_config_t nrf_drv_pdm_config_t
 Type definition for forwarding the new implementation.
 
typedef nrfx_pdm_evt_t nrf_drv_pdm_evt_t
 Type definition for forwarding the new implementation.
 

Functions

__STATIC_INLINE ret_code_t nrf_drv_pdm_init (nrf_drv_pdm_config_t const *p_config, nrfx_pdm_event_handler_t event_handler)
 Function for initializing the PDM interface. More...
 

Detailed Description

Layer providing compatibility with the former API.

Function Documentation

__STATIC_INLINE ret_code_t nrf_drv_pdm_init ( nrf_drv_pdm_config_t const *  p_config,
nrfx_pdm_event_handler_t  event_handler 
)

Function for initializing the PDM interface.

Parameters
[in]p_configPointer to the structure with initial configuration. Cannot be NULL.
[in]event_handlerEvent handler provided by the user. Cannot be NULL.
Return values
NRF_SUCCESSIf initialization was successful.
NRF_ERROR_INVALID_STATEIf the driver is already initialized.
NRF_ERROR_INVALID_PARAMIf invalid parameters were specified.

Documentation feedback | Developer Zone | Subscribe | Updated