General-Purpose Input/Output (GPIO)

Modules
	Port and Pin Definitions
	GPIO_Registers

Data Structures
struct	mxc_gpio_cfg_t

Typedefs
typedef void(*	mxc_gpio_callback_fn) (void *cbdata)

Enumerations
enum	mxc_gpio_func_t
enum	mxc_gpio_vssel_t
enum	mxc_gpio_drvstr_t
enum	mxc_gpio_pad_t
enum	mxc_gpio_int_mode_t
enum	mxc_gpio_int_pol_t
enum	mxc_gpio_config_lock_t

Functions
int	MXC_GPIO_Init (uint32_t portMask)
int	MXC_GPIO_Shutdown (uint32_t portMask)
int	MXC_GPIO_Reset (uint32_t portMask)
int	MXC_GPIO_Config (const mxc_gpio_cfg_t *cfg)
uint32_t	MXC_GPIO_InGet (mxc_gpio_regs_t *port, uint32_t mask)
void	MXC_GPIO_OutSet (mxc_gpio_regs_t *port, uint32_t mask)
void	MXC_GPIO_OutClr (mxc_gpio_regs_t *port, uint32_t mask)
uint32_t	MXC_GPIO_OutGet (mxc_gpio_regs_t *port, uint32_t mask)
void	MXC_GPIO_OutPut (mxc_gpio_regs_t *port, uint32_t mask, uint32_t val)
void	MXC_GPIO_OutToggle (mxc_gpio_regs_t *port, uint32_t mask)
int	MXC_GPIO_IntConfig (const mxc_gpio_cfg_t *cfg, mxc_gpio_int_pol_t pol)
void	MXC_GPIO_EnableInt (mxc_gpio_regs_t *port, uint32_t mask)
void	MXC_GPIO_DisableInt (mxc_gpio_regs_t *port, uint32_t mask)
uint32_t	MXC_GPIO_GetFlags (mxc_gpio_regs_t *port)
void	MXC_GPIO_ClearFlags (mxc_gpio_regs_t *port, uint32_t flags)
void	MXC_GPIO_RegisterCallback (const mxc_gpio_cfg_t *cfg, mxc_gpio_callback_fn callback, void *cbdata)
void	MXC_GPIO_Handler (unsigned int port)
int	MXC_GPIO_SetVSSEL (mxc_gpio_regs_t *port, mxc_gpio_vssel_t vssel, uint32_t mask)
void	MXC_GPIO_SetWakeEn (mxc_gpio_regs_t *port, uint32_t mask)
void	MXC_GPIO_ClearWakeEn (mxc_gpio_regs_t *port, uint32_t mask)
uint32_t	MXC_GPIO_GetWakeEn (mxc_gpio_regs_t *port)
int	MXC_GPIO_SetDriveStrength (mxc_gpio_regs_t *port, mxc_gpio_drvstr_t drvstr, uint32_t mask)
void	MXC_GPIO_SetConfigLock (mxc_gpio_config_lock_t locked)
mxc_gpio_config_lock_t	MXC_GPIO_GetConfigLock (void)

Detailed Description

---

Data Structure Documentation

mxc_gpio_cfg_t

struct mxc_gpio_cfg_t

Structure type for configuring a GPIO port.

Data Fields
mxc_gpio_regs_t *	port
uint32_t	mask
mxc_gpio_func_t	func
mxc_gpio_pad_t	pad
mxc_gpio_vssel_t	vssel
mxc_gpio_drvstr_t	drvstr

Field Documentation

drvstr

mxc_gpio_drvstr_t drvstr

Drive Strength select

func

mxc_gpio_func_t func

Function type

mask

uint32_t mask

Pin mask (multiple pins may be set)

pad

mxc_gpio_pad_t pad

Pad type

port

mxc_gpio_regs_t* port

Pointer to GPIO regs

vssel

mxc_gpio_vssel_t vssel

Voltage select

Typedef Documentation

mxc_gpio_callback_fn

typedef void(* mxc_gpio_callback_fn) (void *cbdata)

Type alias for a GPIO callback function with prototype:

void callback_fn(void *cbdata);

Parameters

cbdata

A void pointer to the data type as registered when MXC_GPIO_RegisterCallback() was called.

Enumeration Type Documentation

mxc_gpio_config_lock_t

enum mxc_gpio_config_lock_t

Enumeration type for the pin configuration lock mechanism.

Enumerator
MXC_GPIO_CONFIG_UNLOCKED	Allow changing pins' configuration.
MXC_GPIO_CONFIG_LOCKED	Ignore changes to a pin's configuration.

mxc_gpio_drvstr_t

enum mxc_gpio_drvstr_t

Enumeration type for drive strength on a given pin. This represents what the two GPIO_DS[2] (Drive Strength) registers are set to for a given GPIO pin; NOT the drive strength level.

For example: MXC_GPIO_DRVSTR_0: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 0 MXC_GPIO_DRVSTR_1: GPIO_DS1[pin] = 0; GPIO_DS0[pin] = 1 MXC_GPIO_DRVSTR_2: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 0 MXC_GPIO_DRVSTR_3: GPIO_DS1[pin] = 1; GPIO_DS0[pin] = 1

Refer to the user guide and datasheet to select the appropriate drive strength. Note: the drive strength values are not linear, and can vary from pin-to-pin and the state of the GPIO pin (alternate function and voltage level).

Enumerator
MXC_GPIO_DRVSTR_0	Drive Strength GPIO_DS[2][pin]=0b00
MXC_GPIO_DRVSTR_1	Drive Strength GPIO_DS[2][pin]=0b01
MXC_GPIO_DRVSTR_2	Drive Strength GPIO_DS[2][pin]=0b10
MXC_GPIO_DRVSTR_3	Drive Strength GPIO_DS[2][pin]=0b11

mxc_gpio_func_t

enum mxc_gpio_func_t

Enumeration type for the GPIO Function Type.

Enumerator
MXC_GPIO_FUNC_IN	GPIO Input
MXC_GPIO_FUNC_OUT	GPIO Output
MXC_GPIO_FUNC_ALT1	Alternate Function Selection
MXC_GPIO_FUNC_ALT2	Alternate Function Selection
MXC_GPIO_FUNC_ALT3	Alternate Function Selection
MXC_GPIO_FUNC_ALT4	Alternate Function Selection

mxc_gpio_int_mode_t

enum mxc_gpio_int_mode_t

Enumeration type for the interrupt modes.

Enumerator
MXC_GPIO_INT_LEVEL	Interrupt is level sensitive
MXC_GPIO_INT_EDGE	Interrupt is edge sensitive

mxc_gpio_int_pol_t

enum mxc_gpio_int_pol_t

Enumeration type for the interrupt polarity.

Enumerator
MXC_GPIO_INT_FALLING	Interrupt triggers on falling edge
MXC_GPIO_INT_HIGH	Interrupt triggers when level is high
MXC_GPIO_INT_RISING	Interrupt triggers on rising edge
MXC_GPIO_INT_LOW	Interrupt triggers when level is low
MXC_GPIO_INT_BOTH	Interrupt triggers on either edge

mxc_gpio_pad_t

enum mxc_gpio_pad_t

Enumeration type for the type of GPIO pad on a given pin.

Enumerator
MXC_GPIO_PAD_NONE	No pull-up or pull-down
MXC_GPIO_PAD_PULL_UP	Set pad to strong pull-up
MXC_GPIO_PAD_PULL_DOWN	Set pad to strong pull-down
MXC_GPIO_PAD_WEAK_PULL_UP	Set pad to weak pull-up
MXC_GPIO_PAD_WEAK_PULL_DOWN	Set pad to weak pull-down

mxc_gpio_vssel_t

enum mxc_gpio_vssel_t

Enumeration type for the voltage level on a given pin.

Enumerator
MXC_GPIO_VSSEL_VDDIO	Set pin to VIDDIO voltage
MXC_GPIO_VSSEL_VDDIOH	Set pin to VIDDIOH voltage

Function Documentation

MXC_GPIO_ClearFlags()

void MXC_GPIO_ClearFlags	(	mxc_gpio_regs_t *	port,
		uint32_t	flags
	)

Gets the interrupt(s) status on a GPIO port.

Parameters

port	Pointer to the GPIO port registers
flags	The flags to clear

MXC_GPIO_ClearWakeEn()

void MXC_GPIO_ClearWakeEn	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Disables GPIO pins from being used as a wakeup source.

Parameters

port	The GPIO port
mask	Pins in the GPIO port that will be disabled as a wakeup source.

MXC_GPIO_Config()

int MXC_GPIO_Config

(

const mxc_gpio_cfg_t *

cfg

)

Configure GPIO pin(s).

Parameters

cfg	Pointer to configuration structure describing the pin.

Returns

E_NO_ERROR if everything is successful.

MXC_GPIO_DisableInt()

void MXC_GPIO_DisableInt	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Disables the specified GPIO interrupt.

Parameters

port	Pointer to the GPIO port registers
mask	Mask of the pin(s) to disable interrupts for

MXC_GPIO_EnableInt()

void MXC_GPIO_EnableInt	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Enables the specified GPIO interrupt.

Parameters

port	Pointer to the GPIO port registers
mask	Mask of the pin(s) to enable interrupts for

MXC_GPIO_GetConfigLock()

mxc_gpio_config_lock_t MXC_GPIO_GetConfigLock

(

void

)

Reads the current lock state on pin configuration.

Returns

The lock state.

MXC_GPIO_GetFlags()

uint32_t MXC_GPIO_GetFlags

(

mxc_gpio_regs_t *

port

)

Gets the interrupt(s) status on a GPIO port.

Parameters

port	Pointer to the GPIO port registers

Returns

The requested interrupt status.

MXC_GPIO_GetWakeEn()

uint32_t MXC_GPIO_GetWakeEn

(

mxc_gpio_regs_t *

port

)

Returns the pins currently enabled as wakeup sources.

Parameters

port	The GPIO port to check.

Returns

The value of the wake enable register.

MXC_GPIO_Handler()

void MXC_GPIO_Handler

(

unsigned int

port

)

GPIO IRQ Handler.

Note

If a callback is registered for a given interrupt, the callback function will be called.

Parameters

port	Number of the port that generated the interrupt service routine.

MXC_GPIO_InGet()

uint32_t MXC_GPIO_InGet	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Gets the pin(s) input state.

Parameters

port	Pointer to the GPIO port registers
mask	Mask of the pin(s) to read

Returns

The requested pin state.

MXC_GPIO_Init()

int MXC_GPIO_Init

(

uint32_t

portMask

)

Initialize GPIO.

Parameters

portMask

Mask for the port to be initialized

Returns

E_NO_ERROR if everything is successful.

MXC_GPIO_IntConfig()

int MXC_GPIO_IntConfig	(	const mxc_gpio_cfg_t *	cfg,
		mxc_gpio_int_pol_t	pol
	)

Configure GPIO interrupt(s)

Parameters

cfg	Pointer to configuration structure describing the pin.
pol	Requested interrupt polarity.

Returns

E_NO_ERROR if everything is successful.

MXC_GPIO_OutClr()

void MXC_GPIO_OutClr	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Clears the pin(s) to a low level output.

Parameters

port	Pointer to the GPIO port registers
mask	Mask of the pin(s) to clear

MXC_GPIO_OutGet()

uint32_t MXC_GPIO_OutGet	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Gets the pin(s) output state.

Parameters

port	Pointer to the GPIO port registers
mask	Mask of the pin(s) to read the output state of

Returns

The state of the requested pin.

MXC_GPIO_OutPut()

void MXC_GPIO_OutPut	(	mxc_gpio_regs_t *	port,
		uint32_t	mask,
		uint32_t	val
	)

Write the pin(s) to a desired output level.

Parameters

port	Pointer to the GPIO port registers
mask	Mask of the pin(s) to set output level of
val	Desired output level of the pin(s). This will be masked with the configuration mask.

MXC_GPIO_OutSet()

void MXC_GPIO_OutSet	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Sets the pin(s) to a high level output.

Parameters

port	Pointer to the GPIO port registers
mask	Mask of the pin(s) to set

MXC_GPIO_OutToggle()

void MXC_GPIO_OutToggle	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Toggles the the pin(s) output level.

Parameters

port	Pointer to the GPIO port registers
mask	Mask of the pin(s) to toggle the output

MXC_GPIO_RegisterCallback()

void MXC_GPIO_RegisterCallback	(	const mxc_gpio_cfg_t *	cfg,
		mxc_gpio_callback_fn	callback,
		void *	cbdata
	)

Registers a callback for the interrupt on a given port and pin.

Parameters

cfg	Pointer to configuration structure describing the pin
callback	A pointer to a function of type #callback_fn.
cbdata	The parameter to be passed to the callback function, #callback_fn, when an interrupt occurs.

MXC_GPIO_Reset()

int MXC_GPIO_Reset

(

uint32_t

portMask

)

Reset GPIO.

Parameters

portMask

Mask for the port to be initialized

Returns

E_NO_ERROR if everything is successful.

MXC_GPIO_SetConfigLock()

void MXC_GPIO_SetConfigLock

(

mxc_gpio_config_lock_t

locked

)

Enables/Disables the lock on all pins' configurations. If locked, any changes to a pin's configuration made through the MXC_GPIO_Config function will be ignored.

Parameters

locked

Determines if changes will be allowed.

MXC_GPIO_SetDriveStrength()

int MXC_GPIO_SetDriveStrength	(	mxc_gpio_regs_t *	port,
		mxc_gpio_drvstr_t	drvstr,
		uint32_t	mask
	)

Set Drive Strength for pins.

Parameters

	port	The GPIO port.
[in]	ds	Drive strength level. Ref /mxc_gpio_ds_t enum type.
[in]	mask	Pins in the GPIO port that will be set to the voltage.

MXC_GPIO_SetVSSEL()

int MXC_GPIO_SetVSSEL	(	mxc_gpio_regs_t *	port,
		mxc_gpio_vssel_t	vssel,
		uint32_t	mask
	)

Set Voltage select for pins to VDDIO or VDDIOH.

Parameters

	port	Pointer to the GPIO port registers
[in]	vssel	VDDIO or VDDIOH to set the voltatge to
[in]	mask	Pins in the GPIO port that will be set to the voltage.

MXC_GPIO_SetWakeEn()

void MXC_GPIO_SetWakeEn	(	mxc_gpio_regs_t *	port,
		uint32_t	mask
	)

Enables GPIO pins to be used as a wakeup source.

Parameters

port	The GPIO port
mask	Pins in the GPIO port that will be enabled as a wakeup source.

MXC_GPIO_Shutdown()

int MXC_GPIO_Shutdown

(

uint32_t

portMask

)

Shutdown GPIO.

Parameters

portMask

Mask for the port to be initialized

Returns

E_NO_ERROR if everything is successful.