BELLBOARD driver

BELLBOARD peripheral driver. More...

Data Structures
struct	nrfx_bellboard_t
	Structure for the BELLBOARD driver instance. More...

Macros
#define	NRFX_BELLBOARD_INSTANCE(id)
	Macro for creating a BELLBOARD driver instance.
#define	NRFX_BELLBOARD_INST_HANDLER_GET(idx)
	Macro returning BELLBOARD interrupt handler.

Typedefs
typedef void(*	nrfx_bellboard_event_handler_t) (uint8_t event_idx, void *p_context)
	Bellboard event handler callback.

Functions
int	nrfx_bellboard_init (nrfx_bellboard_t *p_instance, uint8_t irq_priority, nrfx_bellboard_event_handler_t event_handler, void *p_context)
	Initialize BELLBOARD driver instance.
void	nrfx_bellboard_uninit (nrfx_bellboard_t *p_instance)
	Uninitialize BELLBOARD driver instance.
bool	nrfx_bellboard_init_check (nrfx_bellboard_t const *p_instance)
	Function for checking if the BELLBOARD driver instance is initialized.
void	nrfx_bellboard_int_enable (nrfx_bellboard_t const *p_instance, uint32_t mask)
	Enable interrupt mask for given bellboard interrupt.
void	nrfx_bellboard_int_disable (nrfx_bellboard_t const *p_instance, uint32_t mask)
	Disable interrupt mask for given bellboard interrupt.
void	nrfx_bellboard_irq_handler (nrfx_bellboard_t *p_instance)
	Driver interrupt handler.

Detailed Description

BELLBOARD peripheral driver.

Macro Definition Documentation

NRFX_BELLBOARD_INST_HANDLER_GET

#define NRFX_BELLBOARD_INST_HANDLER_GET

(

idx

)

Value:

NRFX_CONCAT_3(nrfx_bellboard_, idx, _irq_handler)

Macro returning BELLBOARD interrupt handler.

param[in] idx BELLBOARD index.

Returns

Interrupt handler.

NRFX_BELLBOARD_INSTANCE

#define NRFX_BELLBOARD_INSTANCE

(

id

)

Value:

{                                   \
    .cb =                           \
    {                               \
        .int_idx = id,              \
    }                               \
}

Macro for creating a BELLBOARD driver instance.

Typedef Documentation

nrfx_bellboard_event_handler_t

typedef void(* nrfx_bellboard_event_handler_t) (uint8_t event_idx, void *p_context)

Bellboard event handler callback.

Parameters

[in]	event_idx	Bellboard event index.
[in]	p_context	User context.

Function Documentation

nrfx_bellboard_init()

int nrfx_bellboard_init	(	nrfx_bellboard_t *	p_instance,
		uint8_t	irq_priority,
		nrfx_bellboard_event_handler_t	event_handler,
		void *	p_context )

Initialize BELLBOARD driver instance.

Parameters

[in]	p_instance	Pointer to BELLBOARD driver instance.
[in]	irq_priority	Interrupt priority.
[in]	event_handler	Function to be called on bellboard interrupt.
[in]	p_context	User context passed to event handler.

Return values

0	Instance successfully initialized.
-EALREADY	Instance already initialized.

nrfx_bellboard_init_check()

bool nrfx_bellboard_init_check

(

nrfx_bellboard_t const *

p_instance

)

Function for checking if the BELLBOARD driver instance is initialized.

Parameters

[in]

p_instance

Pointer to BELLBOARD driver instance.

Return values

true	Instance is already initialized.
false	Instance is not initialized.

nrfx_bellboard_int_disable()

void nrfx_bellboard_int_disable	(	nrfx_bellboard_t const *	p_instance,
		uint32_t	mask )

Disable interrupt mask for given bellboard interrupt.

Parameters

[in]	p_instance	Pointer to BELLBOARD driver instance.
[in]	mask	Interrupt mask.

nrfx_bellboard_int_enable()

void nrfx_bellboard_int_enable	(	nrfx_bellboard_t const *	p_instance,
		uint32_t	mask )

Enable interrupt mask for given bellboard interrupt.

Parameters

[in]	p_instance	Pointer to BELLBOARD driver instance.
[in]	mask	Interrupt mask.

nrfx_bellboard_irq_handler()

void nrfx_bellboard_irq_handler

(

nrfx_bellboard_t *

p_instance

)

Driver interrupt handler.

Parameters

[in]

p_instance

Pointer to the driver instance structure.

nrfx_bellboard_uninit()

void nrfx_bellboard_uninit

(

nrfx_bellboard_t *

p_instance

)

Uninitialize BELLBOARD driver instance.

Parameters

[in]

p_instance

Pointer to BELLBOARD driver instance.