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

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

Modules

 QDEC peripheral driver - legacy layer configuration
 

Macros

#define NRF_DRV_QDEC_DEFAULT_CONFIG   NRFX_QDEC_DEFAULT_CONFIG
 Macro for forwarding the new implementation.
 
#define qdec_event_handler_t   nrfx_qdec_event_handler_t
 Macro for forwarding the new implementation.
 
#define nrf_drv_qdec_uninit   nrfx_qdec_uninit
 Macro for forwarding the new implementation.
 
#define nrf_drv_qdec_enable   nrfx_qdec_enable
 Macro for forwarding the new implementation.
 
#define nrf_drv_qdec_disable   nrfx_qdec_disable
 Macro for forwarding the new implementation.
 
#define nrf_drv_qdec_accumulators_read   nrfx_qdec_accumulators_read
 Macro for forwarding the new implementation.
 

Typedefs

typedef nrfx_qdec_config_t nrf_drv_qdec_config_t
 Type definition for forwarding the new implementation.
 
typedef nrfx_qdec_sample_data_evt_t nrf_drv_qdec_sample_data_evt_t
 Type definition for forwarding the new implementation.
 
typedef nrfx_qdec_report_data_evt_t nrf_drv_qdec_report_data_evt_t
 Type definition for forwarding the new implementation.
 
typedef nrfx_qdec_event_t nrf_drv_qdec_event_t
 Type definition for forwarding the new implementation.
 

Functions

__STATIC_INLINE ret_code_t nrf_drv_qdec_init (nrf_drv_qdec_config_t const *p_config, nrfx_qdec_event_handler_t event_handler)
 Function for initializing QDEC. More...
 
void nrf_drv_qdec_task_address_get (nrf_qdec_task_t task, uint32_t *p_task)
 Function for returning the address of a specific timer task. More...
 
void nrf_drv_qdec_event_address_get (nrf_qdec_event_t event, uint32_t *p_event)
 Function for returning the address of a specific timer event. More...
 

Detailed Description

Layer providing compatibility with the former API.

Function Documentation

void nrf_drv_qdec_event_address_get ( nrf_qdec_event_t  event,
uint32_t *  p_event 
)

Function for returning the address of a specific timer event.

Parameters
[in]eventQDEC event.
[out]p_eventEvent address.
__STATIC_INLINE ret_code_t nrf_drv_qdec_init ( nrf_drv_qdec_config_t const *  p_config,
nrfx_qdec_event_handler_t  event_handler 
)

Function for initializing QDEC.

Parameters
[in]p_configPointer to the structure with initial configuration.
[in]event_handlerEvent handler function.
Return values
NRF_SUCCESSIf initialization was successful.
NRF_ERROR_INVALID_PARAMIf invalid parameters were supplied.
NRF_ERROR_INVALID_STATEIf QDEC was already initialized.
void nrf_drv_qdec_task_address_get ( nrf_qdec_task_t  task,
uint32_t *  p_task 
)

Function for returning the address of a specific timer task.

Parameters
[in]taskQDEC task.
[out]p_taskTask address.

Documentation feedback | Developer Zone | Subscribe | Updated