Detailed Description

Files
file	cc2538_gpio.h
	Driver for the cc2538 GPIO controller.

Data Structures
struct	cc2538_gpio_t
	GPIO port component registers. More...

struct	cc2538_ioc_t
	IOC port component registers. More...

Macros
#define	GPIO_PORT_SHIFT 3
	Right-shift amount to obtain the port number from a GPIO number.

#define	GPIO_BITS_PER_PORT ( 1 << GPIO_PORT_SHIFT )
	Number of bits per GPIO port (8)

#define	GPIO_BIT_MASK ( GPIO_BITS_PER_PORT - 1 )
	Mask to obtain the bit number from a GPIO number.

#define	PIN_MASK(n) ( 1 << (n) )
	Generate a bit mask in which only the specified bit is high.

#define	GPIO_NUM_TO_PORT_NUM(gpio_num) ( (gpio_num) >> GPIO_PORT_SHIFT )
	Extract the GPIO port number (0-3) from a GPIO number (0-31)

#define	GPIO_BIT_NUM(gpio_num) ( (gpio_num) & GPIO_BIT_MASK )
	Extract the GPIO port bit number (0-7) from a GPIO number (0-31)

#define	GPIO_PXX_TO_NUM(port_num, bit_num) ( ((port_num) << GPIO_PORT_SHIFT) \| (bit_num) )
	Generate a GPIO number given a port and bit number.

#define	GPIO_NUM_TO_DEV(gpio_num) ( GPIO_A + GPIO_NUM_TO_PORT_NUM(gpio_num) )
	Obtain the GPIO port instance given a GPIO number (0-31)

#define	gpio_hardware_control(gpio_num) ( GPIO_NUM_TO_DEV(gpio_num)->AFSEL \|= PIN_MASK(GPIO_BIT_NUM(gpio_num)) )
	Enable hardware (peripheral) control for a given GPIO pin number.

#define	gpio_software_control(gpio_num) ( GPIO_NUM_TO_DEV(gpio_num)->AFSEL &= ~PIN_MASK(GPIO_BIT_NUM(gpio_num)) )
	Enable software control for a given GPIO pin number.

#define	gpio_dir_output(gpio_num) ( GPIO_NUM_TO_DEV(gpio_num)->DIR \|= PIN_MASK(GPIO_BIT_NUM(gpio_num)) )
	Configure the given GPIO as an output.

#define	gpio_dir_input(gpio_num) ( GPIO_NUM_TO_DEV(gpio_num)->DIR &= ~PIN_MASK(GPIO_BIT_NUM(gpio_num)) )
	Configure the given GPIO as an input.

#define	cc2538_gpio_read(gpio_num) ( (GPIO_NUM_TO_DEV(gpio_num)->DATA >> GPIO_BIT_NUM(gpio_num)) & 1 )
	Read the value of the given pin.

#define	cc2538_gpio_clear(gpio_num) ( GPIO_NUM_TO_DEV(gpio_num)->DATA &= ~PIN_MASK(GPIO_BIT_NUM(gpio_num)) )
	Set a specific GPIO output pin low.

#define	GPIO_BASE (0x400d9000)
	GPIO port instance base address.

#define	IOC ((cc2538_ioc_t *)0x400d4000)
	IOC instance definition.

Enumerations
enum	cc2538_ioc_over_t { OVERRIDE_DISABLE = 0x0 , OVERRIDE_ANALOG = 0x1 , OVERRIDE_PULLDOWN = 0x2 , OVERRIDE_PULLUP = 0x4 , OVERRIDE_ENABLE = 0x8 }
	Values to override pin configuration. More...

Numeric representation of the four GPIO ports
enum	{ PORT_A = 0 , PORT_B = 1 , PORT_C = 2 , PORT_D = 3 }

Unique names for each GPIO port/pin combination
Deprecated: will be removed after adaption of periph drivers, use GPIO_PIN macro instead
enum	{ GPIO_PA0 = GPIO_PXX_TO_NUM(PORT_A, 0) , GPIO_PA1 = GPIO_PXX_TO_NUM(PORT_A, 1) , GPIO_PA2 = GPIO_PXX_TO_NUM(PORT_A, 2) , GPIO_PA3 = GPIO_PXX_TO_NUM(PORT_A, 3) , GPIO_PA4 = GPIO_PXX_TO_NUM(PORT_A, 4) , GPIO_PA5 = GPIO_PXX_TO_NUM(PORT_A, 5) , GPIO_PA6 = GPIO_PXX_TO_NUM(PORT_A, 6) , GPIO_PA7 = GPIO_PXX_TO_NUM(PORT_A, 7) , GPIO_PB0 = GPIO_PXX_TO_NUM(PORT_B, 0) , GPIO_PB1 = GPIO_PXX_TO_NUM(PORT_B, 1) , GPIO_PB2 = GPIO_PXX_TO_NUM(PORT_B, 2) , GPIO_PB3 = GPIO_PXX_TO_NUM(PORT_B, 3) , GPIO_PB4 = GPIO_PXX_TO_NUM(PORT_B, 4) , GPIO_PB5 = GPIO_PXX_TO_NUM(PORT_B, 5) , GPIO_PB6 = GPIO_PXX_TO_NUM(PORT_B, 6) , GPIO_PB7 = GPIO_PXX_TO_NUM(PORT_B, 7) , GPIO_PC0 = GPIO_PXX_TO_NUM(PORT_C, 0) , GPIO_PC1 = GPIO_PXX_TO_NUM(PORT_C, 1) , GPIO_PC2 = GPIO_PXX_TO_NUM(PORT_C, 2) , GPIO_PC3 = GPIO_PXX_TO_NUM(PORT_C, 3) , GPIO_PC4 = GPIO_PXX_TO_NUM(PORT_C, 4) , GPIO_PC5 = GPIO_PXX_TO_NUM(PORT_C, 5) , GPIO_PC6 = GPIO_PXX_TO_NUM(PORT_C, 6) , GPIO_PC7 = GPIO_PXX_TO_NUM(PORT_C, 7) , GPIO_PD0 = GPIO_PXX_TO_NUM(PORT_D, 0) , GPIO_PD1 = GPIO_PXX_TO_NUM(PORT_D, 1) , GPIO_PD2 = GPIO_PXX_TO_NUM(PORT_D, 2) , GPIO_PD3 = GPIO_PXX_TO_NUM(PORT_D, 3) , GPIO_PD4 = GPIO_PXX_TO_NUM(PORT_D, 4) , GPIO_PD5 = GPIO_PXX_TO_NUM(PORT_D, 5) , GPIO_PD6 = GPIO_PXX_TO_NUM(PORT_D, 6) , GPIO_PD7 = GPIO_PXX_TO_NUM(PORT_D, 7) }

Peripheral Signal Select Values (for IOC_Pxx_SEL registers)
enum	cc2538_ioc_sel_t { UART0_TXD = 0 , UART1_RTS , UART1_TXD , SSI0_TXD , SSI0_CLK_OUT , SSI0_FSS_OUT , SSI0_TX_SER , SSI1_TXD , SSI1_CLK_OUT , SSI1_FSS_OUT , SSI1_TX_SER , I2C_SDA_OUT , I2C_SCL_OUT , GPT0_ICP1 , GPT0_ICP2 , GPT1_ICP1 , GPT1_ICP2 , GPT2_ICP1 , GPT2_ICP2 , GPT3_ICP1 , GPT3_ICP2 }

Pin select for periphical functions
enum	cc2538_ioc_pin_t { UART0_RXD = 0 , UART1_CTS , UART1_RXD , SSI0_CLK , SSI0_RXD , SSI0_FSS_IN , SSI0_CLK_IN , SSI1_CLK , SSI1_RXD , SSI1_FSS_IN , SSI1_CLK_IN , I2C_SDA_IN , I2C_SCL_IN , GPT0_OCP1 , GPT0_OCP2 , GPT1_OCP1 , GPT1_OCP2 , GPT2_OCP1 , GPT2_OCP2 , GPT3_OCP1 , GPT3_OCP2 }

GPIO shift and masking
#define	GPIO_PORTNUM_SHIFT (12U)
	bit shift for GPIO port

#define	GPIO_PORTNUM_MASK (0x00007000)
	bit mask for GPIO port [0-3]

#define	GPIO_PIN_MASK (0x00000007)
	bit mask for GPIO pin [0-7]

#define	GPIO_PORT_MASK (0xfffff000)
	bit mask for GPIO port addr

GPIO instance definitions
Deprecated: will be removed after adaption of periph drivers
#define	GPIO_A ((cc2538_gpio_t *)0x400d9000)
	GPIO Port A instance.

#define	GPIO_B ((cc2538_gpio_t *)0x400da000)
	GPIO Port B instance.

#define	GPIO_C ((cc2538_gpio_t *)0x400db000)
	GPIO Port C instance.

#define	GPIO_D ((cc2538_gpio_t *)0x400dc000)
	GPIO Port D instance.

Values for IOC_PXX_OVER
Deprecated: will be removed after adaption of periph drivers, use cc2538_ioc_over_t instead
#define	IOC_OVERRIDE_OE 0x00000008
	Output Enable.

#define	IOC_OVERRIDE_PUE 0x00000004
	Pull Up Enable.

#define	IOC_OVERRIDE_PDE 0x00000002
	Pull Down Enable.

#define	IOC_OVERRIDE_ANA 0x00000001
	Analog Enable.

#define	IOC_OVERRIDE_DIS 0x00000000
	Override Disabled.

Port control register addresses
Deprecated: will be removed after adaption of periph drivers, use IOC->OVER and IOC->SEL instead
#define	IOC_PXX_OVER (IOC->OVER)

#define	IOC_PXX_SEL (IOC->SEL)

Macro Definition Documentation

◆ cc2538_gpio_clear

#define cc2538_gpio_clear ( gpio_num ) ( GPIO_NUM_TO_DEV(gpio_num)->DATA &= ~PIN_MASK(GPIO_BIT_NUM(gpio_num)) )

Set a specific GPIO output pin low.

Parameters

[in] gpio_num GPIO number (0-31)

Definition at line 137 of file cc2538_gpio.h.

◆ cc2538_gpio_read

#define cc2538_gpio_read ( gpio_num ) ( (GPIO_NUM_TO_DEV(gpio_num)->DATA >> GPIO_BIT_NUM(gpio_num)) & 1 )

Read the value of the given pin.

Parameters

[in] gpio_num GPIO number (0-31)

Definition at line 130 of file cc2538_gpio.h.

◆ GPIO_A

#define GPIO_A ((cc2538_gpio_t *)0x400d9000)

GPIO Port A instance.

Definition at line 231 of file cc2538_gpio.h.

◆ GPIO_B

#define GPIO_B ((cc2538_gpio_t *)0x400da000)

GPIO Port B instance.

Definition at line 232 of file cc2538_gpio.h.

◆ GPIO_BASE

#define GPIO_BASE (0x400d9000)

GPIO port instance base address.

Definition at line 214 of file cc2538_gpio.h.

◆ GPIO_BIT_MASK

#define GPIO_BIT_MASK ( GPIO_BITS_PER_PORT - 1 )

Mask to obtain the bit number from a GPIO number.

Definition at line 49 of file cc2538_gpio.h.

◆ GPIO_BIT_NUM

#define GPIO_BIT_NUM ( gpio_num ) ( (gpio_num) & GPIO_BIT_MASK )

Extract the GPIO port bit number (0-7) from a GPIO number (0-31)

Parameters

[in] gpio_num GPIO number (0-31)

Returns: Corresponding GPIO port bit number (0-7)

Definition at line 76 of file cc2538_gpio.h.

◆ GPIO_BITS_PER_PORT

#define GPIO_BITS_PER_PORT ( 1 << GPIO_PORT_SHIFT )

Number of bits per GPIO port (8)

Definition at line 48 of file cc2538_gpio.h.

◆ GPIO_C

#define GPIO_C ((cc2538_gpio_t *)0x400db000)

GPIO Port C instance.

Definition at line 233 of file cc2538_gpio.h.

◆ GPIO_D

#define GPIO_D ((cc2538_gpio_t *)0x400dc000)

GPIO Port D instance.

Definition at line 234 of file cc2538_gpio.h.

◆ gpio_dir_input

#define gpio_dir_input ( gpio_num ) ( GPIO_NUM_TO_DEV(gpio_num)->DIR &= ~PIN_MASK(GPIO_BIT_NUM(gpio_num)) )

Configure the given GPIO as an input.

Parameters

[in] gpio_num GPIO number (0-31)

Definition at line 123 of file cc2538_gpio.h.

◆ gpio_dir_output

#define gpio_dir_output ( gpio_num ) ( GPIO_NUM_TO_DEV(gpio_num)->DIR |= PIN_MASK(GPIO_BIT_NUM(gpio_num)) )

Configure the given GPIO as an output.

Parameters

[in] gpio_num GPIO number (0-31)

Definition at line 116 of file cc2538_gpio.h.

◆ gpio_hardware_control

#define gpio_hardware_control ( gpio_num ) ( GPIO_NUM_TO_DEV(gpio_num)->AFSEL |= PIN_MASK(GPIO_BIT_NUM(gpio_num)) )

Enable hardware (peripheral) control for a given GPIO pin number.

Parameters

[in] gpio_num GPIO number (0-31)

Definition at line 102 of file cc2538_gpio.h.

◆ GPIO_NUM_TO_DEV

#define GPIO_NUM_TO_DEV ( gpio_num ) ( GPIO_A + GPIO_NUM_TO_PORT_NUM(gpio_num) )

Obtain the GPIO port instance given a GPIO number (0-31)

Parameters

[in] gpio_num GPIO number (0-31)

Returns: Corresponding GPIO port instance

Definition at line 95 of file cc2538_gpio.h.

◆ GPIO_NUM_TO_PORT_NUM

#define GPIO_NUM_TO_PORT_NUM ( gpio_num ) ( (gpio_num) >> GPIO_PORT_SHIFT )

Extract the GPIO port number (0-3) from a GPIO number (0-31)

Parameters

[in] gpio_num GPIO number (0-31)

Returns: Corresponding GPIO port number (0-3)

Definition at line 67 of file cc2538_gpio.h.

◆ GPIO_PIN_MASK

#define GPIO_PIN_MASK (0x00000007)

bit mask for GPIO pin [0-7]

Definition at line 222 of file cc2538_gpio.h.

◆ GPIO_PORT_MASK

#define GPIO_PORT_MASK (0xfffff000)

bit mask for GPIO port addr

Definition at line 223 of file cc2538_gpio.h.

◆ GPIO_PORT_SHIFT

#define GPIO_PORT_SHIFT 3

Right-shift amount to obtain the port number from a GPIO number.

Definition at line 47 of file cc2538_gpio.h.

◆ GPIO_PORTNUM_MASK

#define GPIO_PORTNUM_MASK (0x00007000)

bit mask for GPIO port [0-3]

Definition at line 221 of file cc2538_gpio.h.

◆ GPIO_PORTNUM_SHIFT

#define GPIO_PORTNUM_SHIFT (12U)

bit shift for GPIO port

Definition at line 220 of file cc2538_gpio.h.

◆ GPIO_PXX_TO_NUM

#define GPIO_PXX_TO_NUM	(	port_num,
		bit_num
	)	( ((port_num) << GPIO_PORT_SHIFT) \| (bit_num) )

Generate a GPIO number given a port and bit number.

Parameters

[in]	port_num	GPIO port (PORT_A, PORT_B, PORT_C, or PORT_D)
[in]	bit_num	GPIO bit number (0-7)

Returns: Corresponding GPIO number (0-31)

Definition at line 86 of file cc2538_gpio.h.

◆ gpio_software_control

#define gpio_software_control ( gpio_num ) ( GPIO_NUM_TO_DEV(gpio_num)->AFSEL &= ~PIN_MASK(GPIO_BIT_NUM(gpio_num)) )

Enable software control for a given GPIO pin number.

Parameters

[in] gpio_num GPIO number (0-31)

Definition at line 109 of file cc2538_gpio.h.

◆ IOC

#define IOC ((cc2538_ioc_t *)0x400d4000)

IOC instance definition.

Definition at line 331 of file cc2538_gpio.h.

◆ IOC_OVERRIDE_ANA

#define IOC_OVERRIDE_ANA 0x00000001

Analog Enable.

Definition at line 324 of file cc2538_gpio.h.

◆ IOC_OVERRIDE_DIS

#define IOC_OVERRIDE_DIS 0x00000000

Override Disabled.

Definition at line 325 of file cc2538_gpio.h.

◆ IOC_OVERRIDE_OE

#define IOC_OVERRIDE_OE 0x00000008

Output Enable.

Definition at line 321 of file cc2538_gpio.h.

◆ IOC_OVERRIDE_PDE

#define IOC_OVERRIDE_PDE 0x00000002

Pull Down Enable.

Definition at line 323 of file cc2538_gpio.h.

◆ IOC_OVERRIDE_PUE

#define IOC_OVERRIDE_PUE 0x00000004

Pull Up Enable.

Definition at line 322 of file cc2538_gpio.h.

◆ IOC_PXX_OVER

#define IOC_PXX_OVER (IOC->OVER)

Definition at line 339 of file cc2538_gpio.h.

◆ IOC_PXX_SEL

#define IOC_PXX_SEL (IOC->SEL)

Definition at line 340 of file cc2538_gpio.h.

◆ PIN_MASK

#define PIN_MASK ( n ) ( 1 << (n) )

Generate a bit mask in which only the specified bit is high.

Parameters

[in] n Number of the bit to set high in the mask.

Returns: A bit mask in which bit n is high.

Definition at line 58 of file cc2538_gpio.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Definition at line 39 of file cc2538_gpio.h.

◆ anonymous enum

anonymous enum

Enumerator
GPIO_PA0	PA0.
GPIO_PA1	PA1.
GPIO_PA2	PA2.
GPIO_PA3	PA3.
GPIO_PA4	PA4.
GPIO_PA5	PA5.
GPIO_PA6	PA6.
GPIO_PA7	PA7.
GPIO_PB0	PB0.
GPIO_PB1	PB1.
GPIO_PB2	PB2.
GPIO_PB3	PB3.
GPIO_PB4	PB4.
GPIO_PB5	PB5.
GPIO_PB6	PB6.
GPIO_PB7	PB7.
GPIO_PC0	PC0.
GPIO_PC1	PC1.
GPIO_PC2	PC2.
GPIO_PC3	PC3.
GPIO_PC4	PC4.
GPIO_PC5	PC5.
GPIO_PC6	PC6.
GPIO_PC7	PC7.
GPIO_PD0	PD0.
GPIO_PD1	PD1.
GPIO_PD2	PD2.
GPIO_PD3	PD3.
GPIO_PD4	PD4.
GPIO_PD5	PD5.
GPIO_PD6	PD6.
GPIO_PD7	PD7.

Definition at line 145 of file cc2538_gpio.h.

◆ cc2538_ioc_over_t

enum cc2538_ioc_over_t

Values to override pin configuration.

Definition at line 307 of file cc2538_gpio.h.

◆ cc2538_ioc_pin_t

enum cc2538_ioc_pin_t

Enumerator
UART0_RXD	UART0 RXD.
UART1_CTS	UART1 CTS.
UART1_RXD	UART1 RXD.
SSI0_CLK	SSI0 CLK.
SSI0_RXD	SSI0 RXD.
SSI0_FSS_IN	SSI0 FSS IN.
SSI0_CLK_IN	SSI0 CLK IN.
SSI1_CLK	SSI1 CLK.
SSI1_RXD	SSI1 RXD.
SSI1_FSS_IN	SSI1 FSS IN.
SSI1_CLK_IN	SSI1 CLK IN.
I2C_SDA_IN	I2C SDA IN.
I2C_SCL_IN	I2C SCL IN.
GPT0_OCP1	GPT0 OCP1.
GPT0_OCP2	GPT0 OCP2.
GPT1_OCP1	GPT1 OCP1.
GPT1_OCP2	GPT1 OCP2.
GPT2_OCP1	GPT2 OCP1.
GPT2_OCP2	GPT2 OCP2.
GPT3_OCP1	GPT3 OCP1.
GPT3_OCP2	GPT3 OCP2.

Definition at line 279 of file cc2538_gpio.h.

◆ cc2538_ioc_sel_t

enum cc2538_ioc_sel_t

Enumerator
UART0_TXD	UART0 TXD.
UART1_RTS	UART1 RTS.
UART1_TXD	UART1 TXD.
SSI0_TXD	SSI0 TXD.
SSI0_CLK_OUT	SSI0 CLKOUT.
SSI0_FSS_OUT	SSI0 FSSOUT.
SSI0_TX_SER	SSI0 STXSER EN.
SSI1_TXD	SSI1 TXD.
SSI1_CLK_OUT	SSI1 CLKOUT.
SSI1_FSS_OUT	SSI1 FSSOUT.
SSI1_TX_SER	SSI1 STXSER EN.
I2C_SDA_OUT	I2C CMSSDA.
I2C_SCL_OUT	I2C CMSSCL.
GPT0_ICP1	GPT0 ICP1.
GPT0_ICP2	GPT0 ICP2.
GPT1_ICP1	GPT1 ICP1.
GPT1_ICP2	GPT1 ICP2.
GPT2_ICP1	GPT2 ICP1.
GPT2_ICP2	GPT2 ICP2.
GPT3_ICP1	GPT3 ICP1.
GPT3_ICP2	GPT3 ICP2.

Definition at line 250 of file cc2538_gpio.h.

Detailed Description

Files

Data Structures

Macros

Enumerations

Numeric representation of the four GPIO ports

Unique names for each GPIO port/pin combination

Peripheral Signal Select Values (for IOC_Pxx_SEL registers)

Pin select for periphical functions

GPIO shift and masking

GPIO instance definitions

Values for IOC_PXX_OVER

Port control register addresses

Macro Definition Documentation

◆ cc2538_gpio_clear

◆ cc2538_gpio_read

◆ GPIO_A

◆ GPIO_B

◆ GPIO_BASE

◆ GPIO_BIT_MASK

◆ GPIO_BIT_NUM

◆ GPIO_BITS_PER_PORT

◆ GPIO_C

◆ GPIO_D

◆ gpio_dir_input

◆ gpio_dir_output

◆ gpio_hardware_control

◆ GPIO_NUM_TO_DEV

◆ GPIO_NUM_TO_PORT_NUM

◆ GPIO_PIN_MASK

◆ GPIO_PORT_MASK

◆ GPIO_PORT_SHIFT

◆ GPIO_PORTNUM_MASK

◆ GPIO_PORTNUM_SHIFT

◆ GPIO_PXX_TO_NUM

◆ gpio_software_control

◆ IOC

◆ IOC_OVERRIDE_ANA

◆ IOC_OVERRIDE_DIS

◆ IOC_OVERRIDE_OE

◆ IOC_OVERRIDE_PDE

◆ IOC_OVERRIDE_PUE

◆ IOC_PXX_OVER

◆ IOC_PXX_SEL

◆ PIN_MASK

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ cc2538_ioc_over_t

◆ cc2538_ioc_pin_t

◆ cc2538_ioc_sel_t