NXP FlexIO driver APIs

NXP FlexIO driver APIs. More...

Files
file	nxp_flexio.h
	Header file for NXP FlexIO driver.

Data Structures
struct	nxp_flexio_child_res
	Structure containing information about the required resources for a FlexIO child. More...
struct	nxp_flexio_child
	Structure containing the required child data for FlexIO. More...

Typedefs
typedef int(*	nxp_flexio_child_isr_t) (void *user_data)
	Callback API to inform API user that FlexIO triggered interrupt.

Functions
void	nxp_flexio_irq_enable (const struct device *dev)
	Enable FlexIO IRQ.
void	nxp_flexio_irq_disable (const struct device *dev)
	Disable FlexIO IRQ.
void	nxp_flexio_lock (const struct device *dev)
	Lock FlexIO mutex.
void	nxp_flexio_unlock (const struct device *dev)
	Unlock FlexIO mutex.
int	nxp_flexio_get_rate (const struct device *dev, uint32_t *rate)
	Obtain the clock rate of sub-system used by the FlexIO.
int	nxp_flexio_child_attach (const struct device *dev, const struct nxp_flexio_child *child)
	Attach flexio child to flexio controller.

Detailed Description

NXP FlexIO driver APIs.

Typedef Documentation

nxp_flexio_child_isr_t

nxp_flexio_child_isr_t

#include <include/zephyr/drivers/misc/nxp_flexio/nxp_flexio.h>

Callback API to inform API user that FlexIO triggered interrupt.

The controller calls this from IRQ context whenever one of the child's mapped shifters or timers has a pending and enabled interrupt.

Parameters

user_data

Opaque pointer provided at attachment time.

Function Documentation

nxp_flexio_child_attach()

int nxp_flexio_child_attach	(	const struct device *	dev,
		const struct nxp_flexio_child *	child
	)

#include <include/zephyr/drivers/misc/nxp_flexio/nxp_flexio.h>

Attach flexio child to flexio controller.

Parameters

dev	Pointer to the device structure for the FlexIO driver instance
child	Pointer to flexio child

Return values

0	if successful
-ENOBUFS	if there are not enough available resources

nxp_flexio_get_rate()

int nxp_flexio_get_rate	(	const struct device *	dev,
		uint32_t *	rate
	)

#include <include/zephyr/drivers/misc/nxp_flexio/nxp_flexio.h>

Obtain the clock rate of sub-system used by the FlexIO.

Parameters

	dev	Pointer to the device structure for the FlexIO driver instance
[out]	rate	Subsystem clock rate

Return values

0	on successful rate reading.
-EAGAIN	if rate cannot be read. Some drivers do not support returning the rate when the clock is off.
-ENOTSUP	if reading the clock rate is not supported for the given sub-system.
-ENOSYS	if the interface is not implemented.

nxp_flexio_irq_disable()

void nxp_flexio_irq_disable

(

const struct device *

dev

)

#include <include/zephyr/drivers/misc/nxp_flexio/nxp_flexio.h>

Disable FlexIO IRQ.

Parameters

dev	Pointer to the device structure for the FlexIO driver instance

nxp_flexio_irq_enable()

void nxp_flexio_irq_enable

(

const struct device *

dev

)

#include <include/zephyr/drivers/misc/nxp_flexio/nxp_flexio.h>

Enable FlexIO IRQ.

Parameters

dev	Pointer to the device structure for the FlexIO driver instance

nxp_flexio_lock()

void nxp_flexio_lock

(

const struct device *

dev

)

#include <include/zephyr/drivers/misc/nxp_flexio/nxp_flexio.h>

Lock FlexIO mutex.

Parameters

dev	Pointer to the device structure for the FlexIO driver instance

nxp_flexio_unlock()

void nxp_flexio_unlock

(

const struct device *

dev

)

#include <include/zephyr/drivers/misc/nxp_flexio/nxp_flexio.h>

Unlock FlexIO mutex.

Parameters

dev	Pointer to the device structure for the FlexIO driver instance