Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
nxp_flexio.h File Reference
#include <zephyr/device.h>

Go to the source code of this file.

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.
 

Typedef Documentation

◆ nxp_flexio_child_isr_t

typedef int(* nxp_flexio_child_isr_t) (void *user_data)

Callback API to inform API user that FlexIO triggered interrupt.

This callback is called from IRQ context.

Function Documentation

◆ nxp_flexio_child_attach()

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

Attach flexio child to flexio controller.

Parameters
devPointer to the device structure for the FlexIO driver instance
childPointer to flexio child
Return values
0if successful
-ENOBUFSif there are not enough available resources

◆ nxp_flexio_get_rate()

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

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

Parameters
devPointer to the device structure for the FlexIO driver instance
[out]rateSubsystem clock rate
Return values
0on successful rate reading.
-EAGAINif rate cannot be read. Some drivers do not support returning the rate when the clock is off.
-ENOTSUPif reading the clock rate is not supported for the given sub-system.
-ENOSYSif the interface is not implemented.

◆ nxp_flexio_irq_disable()

void nxp_flexio_irq_disable ( const struct device * dev)

Disable FlexIO IRQ.

Parameters
devPointer to the device structure for the FlexIO driver instance

◆ nxp_flexio_irq_enable()

void nxp_flexio_irq_enable ( const struct device * dev)

Enable FlexIO IRQ.

Parameters
devPointer to the device structure for the FlexIO driver instance

◆ nxp_flexio_lock()

void nxp_flexio_lock ( const struct device * dev)

Lock FlexIO mutex.

Parameters
devPointer to the device structure for the FlexIO driver instance

◆ nxp_flexio_unlock()

void nxp_flexio_unlock ( const struct device * dev)

Unlock FlexIO mutex.

Parameters
devPointer to the device structure for the FlexIO driver instance