SystemPeripherals_GPIO.h File Reference

#include <Imt.Base.Core.Platform/Platform.h>
#include "SystemMemoryMap.h"

Enumerations
enum	GpioModuleAddress { GpioModuleAddress_Gpio0 = SOC_GPIO_0_REGS , GpioModuleAddress_Gpio1 = SOC_GPIO_1_REGS , GpioModuleAddress_Gpio2 = SOC_GPIO_2_REGS , GpioModuleAddress_Gpio3 = SOC_GPIO_3_REGS }
	General-purpose I/Os (GPIO) peripheral module. More...
enum	GpioInterruptMode { GpioInterruptMode_Disabled , GpioInterruptMode_EdgeFalling , GpioInterruptMode_EdgeRising , GpioInterruptMode_EdgeBoth }
	Enumeration of the supported digital input interrupt mode. More...
enum	GpioPinMask {   GpioPinMask_Pin0 = 1U << 0 , GpioPinMask_Pin1 = 1U << 1 , GpioPinMask_Pin2 = 1U << 2 , GpioPinMask_Pin3 = 1U << 3 ,   GpioPinMask_Pin4 = 1U << 4 , GpioPinMask_Pin5 = 1U << 5 , GpioPinMask_Pin6 = 1U << 6 , GpioPinMask_Pin7 = 1U << 7 ,   GpioPinMask_Pin8 = 1U << 8 , GpioPinMask_Pin9 = 1U << 9 , GpioPinMask_Pin10 = 1U << 10 , GpioPinMask_Pin11 = 1U << 11 ,   GpioPinMask_Pin12 = 1U << 12 , GpioPinMask_Pin13 = 1U << 13 , GpioPinMask_Pin14 = 1U << 14 , GpioPinMask_Pin15 = 1U << 15 ,   GpioPinMask_Pin16 = 1U << 16 , GpioPinMask_Pin17 = 1U << 17 , GpioPinMask_Pin18 = 1U << 18 , GpioPinMask_Pin19 = 1U << 19 ,   GpioPinMask_Pin20 = 1U << 20 , GpioPinMask_Pin21 = 1U << 21 , GpioPinMask_Pin22 = 1U << 22 , GpioPinMask_Pin23 = 1U << 23 ,   GpioPinMask_Pin24 = 1U << 24 , GpioPinMask_Pin25 = 1U << 25 , GpioPinMask_Pin26 = 1U << 26 , GpioPinMask_Pin27 = 1U << 27 ,   GpioPinMask_Pin28 = 1U << 28 , GpioPinMask_Pin29 = 1U << 29 , GpioPinMask_Pin30 = 1U << 30 , GpioPinMask_Pin31 = 1U << 31 }
	Enumeration of the allowed GPIO pin masks. More...

Functions
void	GPIO_InitDigitalIn (const GpioModuleAddress moduleAddress, const GpioPinMask pinMask, const GpioInterruptMode interruptMode)
	Initializes the GPIO pin according to the specified parameters. More...
void	GPIO_InitDigitalOut (const GpioModuleAddress moduleAddress, const GpioPinMask pinMask, const bool initialValue)
	Initializes the GPIO pin according to the specified parameters. More...
void	GPIO_Write (const GpioModuleAddress moduleAddress, const GpioPinMask pinMask, const bool value)
	Set the given GPIO pin according to the specified parameters. More...
bool	GPIO_Read (const GpioModuleAddress moduleAddress, const GpioPinMask pinMask)
	Read the given GPIO pin status. More...

Enumeration Type Documentation

GpioInterruptMode

enum GpioInterruptMode

Enumeration of the supported digital input interrupt mode.

Enumerator
GpioInterruptMode_Disabled
GpioInterruptMode_EdgeFalling
GpioInterruptMode_EdgeRising
GpioInterruptMode_EdgeBoth

GpioModuleAddress

enum GpioModuleAddress

General-purpose I/Os (GPIO) peripheral module.

The general-purpose interface combines four general-purpose input/output (GPIO) modules. Each GPIO module provides 32 dedicated general-purpose pins with input and output capabilities; thus, the generalpurpose interface supports up to 128 (4 × 32) pins. Enumeration of the available GPIO modules

Enumerator
GpioModuleAddress_Gpio0
GpioModuleAddress_Gpio1
GpioModuleAddress_Gpio2
GpioModuleAddress_Gpio3

GpioPinMask

enum GpioPinMask

Enumeration of the allowed GPIO pin masks.

Enumerator
GpioPinMask_Pin0
GpioPinMask_Pin1
GpioPinMask_Pin2
GpioPinMask_Pin3
GpioPinMask_Pin4
GpioPinMask_Pin5
GpioPinMask_Pin6
GpioPinMask_Pin7
GpioPinMask_Pin8
GpioPinMask_Pin9
GpioPinMask_Pin10
GpioPinMask_Pin11
GpioPinMask_Pin12
GpioPinMask_Pin13
GpioPinMask_Pin14
GpioPinMask_Pin15
GpioPinMask_Pin16
GpioPinMask_Pin17
GpioPinMask_Pin18
GpioPinMask_Pin19
GpioPinMask_Pin20
GpioPinMask_Pin21
GpioPinMask_Pin22
GpioPinMask_Pin23
GpioPinMask_Pin24
GpioPinMask_Pin25
GpioPinMask_Pin26
GpioPinMask_Pin27
GpioPinMask_Pin28
GpioPinMask_Pin29
GpioPinMask_Pin30
GpioPinMask_Pin31

Function Documentation

GPIO_InitDigitalIn()

void GPIO_InitDigitalIn	(	const GpioModuleAddress	moduleAddress,
		const GpioPinMask	pinMask,
		const GpioInterruptMode	interruptMode
	)

Initializes the GPIO pin according to the specified parameters.

Parameters

moduleAddress	base address of the GPIO module
pinMask	pin number (0 to 31)
interruptMode	selects the interrupt mode (disabled, rising edge, falling edge, both edges)

GPIO_InitDigitalOut()

void GPIO_InitDigitalOut	(	const GpioModuleAddress	moduleAddress,
		const GpioPinMask	pinMask,
		const bool	initialValue
	)

Initializes the GPIO pin according to the specified parameters.

Parameters

moduleAddress	base address of the GPIO module
pinMask	pin number (0 to 31)
initialValue	true for logic high, false for logic low

GPIO_Read()

bool GPIO_Read	(	const GpioModuleAddress	moduleAddress,
		const GpioPinMask	pinMask
	)

Read the given GPIO pin status.

Parameters

moduleAddress	- base address of the GPIO module
pinMask	- pin number (0 to 31)

Returns

true for logic high, false for logic low

GPIO_Write()

void GPIO_Write	(	const GpioModuleAddress	moduleAddress,
		const GpioPinMask	pinMask,
		const bool	value
	)

Set the given GPIO pin according to the specified parameters.

Parameters

moduleAddress	base address of the GPIO module
pinMask	pin number (0 to 31)
value	true for logic high, false for logic low