Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
tiva-c-pinctrl.h File Reference

Tiva C pinctrl encoding definitions. More...

Go to the source code of this file.

Macros

#define TIVA_C_PORT_SHIFT   0
 Bit shift for the GPIO port field.
#define TIVA_C_PORT_MASK   0x7
 Bit mask for the GPIO port field.
#define TIVA_C_PIN_SHIFT   16
 Bit shift for the GPIO pin field.
#define TIVA_C_PIN_MASK   0x7
 Bit mask for the GPIO pin field.
#define TIVA_C_MUX_SHIFT   19
 Bit shift for the mux function field.
#define TIVA_C_MUX_MASK   0xF
 Bit mask for the mux function field.
#define TIVA_C_TYPE_SHIFT   23
 Bit shift for the pin type field.
#define TIVA_C_TYPE_MASK   0x7
 Bit mask for the pin type field.
#define TIVA_C_PORT_A   0
 GPIO Port A identifier.
#define TIVA_C_PORT_B   1
 GPIO Port B identifier.
#define TIVA_C_PORT_C   2
 GPIO Port C identifier.
#define TIVA_C_PORT_D   3
 GPIO Port D identifier.
#define TIVA_C_PORT_E   4
 GPIO Port E identifier.
#define TIVA_C_PORT_F   5
 GPIO Port F identifier.
#define TIVA_C_TYPE_GPIO   0
 GPIO pin type.
#define TIVA_C_TYPE_UART   1
 UART pin type.
#define TIVA_C_TYPE_I2C   2
 I2C SDA pin type.
#define TIVA_C_TYPE_I2C_SCL   3
 I2C SCL pin type.
#define TIVA_C_TYPE_SSI   4
 SSI pin type.
#define TIVA_C_TYPE_CAN   5
 CAN pin type.
#define TIVA_C_TYPE_PWM   6
 PWM pin type.
#define TIVA_C_PINMUX(port, pin, mux, type)
 Encode a 32-bit Tiva C pinmux value.
#define TIVA_C_PINMUX_PORT(pm)
 Extract GPIO port from an encoded pinmux value.
#define TIVA_C_PINMUX_PIN(pm)
 Extract GPIO pin from an encoded pinmux value.
#define TIVA_C_PINMUX_MUX(pm)
 Extract mux function from an encoded pinmux value.
#define TIVA_C_PINMUX_TYPE(pm)
 Extract peripheral type from an encoded pinmux value.
#define TIVA_C_PULL_UP_SHIFT   26
 Bit position of the pull-up flag.
#define TIVA_C_PULL_DOWN_SHIFT   27
 Bit position of the pull-down flag.
#define TIVA_C_OPEN_DRAIN_SHIFT   28
 Bit position of the open-drain flag.
#define TIVA_C_PINMUX_PULL_UP(pm)
 Return the encoded pull-up flag.
#define TIVA_C_PINMUX_PULL_DOWN(pm)
 Return the encoded pull-down flag.
#define TIVA_C_PINMUX_OPEN_DRAIN(pm)
 Return the encoded open-drain flag.
#define TIVA_C_PINCFG_PORT_SHIFT   16
 Bit shift for pin configuration port field.
#define TIVA_C_PINCFG_PIN_SHIFT   10
 Bit shift for pin configuration pin field.

Detailed Description

Tiva C pinctrl encoding definitions.

SPDX-License-Identifier: Apache-2.0 Copyright (c) 2026 Linumiz

Macro Definition Documentation

◆ TIVA_C_MUX_MASK

#define TIVA_C_MUX_MASK   0xF

Bit mask for the mux function field.

◆ TIVA_C_MUX_SHIFT

#define TIVA_C_MUX_SHIFT   19

Bit shift for the mux function field.

◆ TIVA_C_OPEN_DRAIN_SHIFT

#define TIVA_C_OPEN_DRAIN_SHIFT   28

Bit position of the open-drain flag.

◆ TIVA_C_PIN_MASK

#define TIVA_C_PIN_MASK   0x7

Bit mask for the GPIO pin field.

◆ TIVA_C_PIN_SHIFT

#define TIVA_C_PIN_SHIFT   16

Bit shift for the GPIO pin field.

◆ TIVA_C_PINCFG_PIN_SHIFT

#define TIVA_C_PINCFG_PIN_SHIFT   10

Bit shift for pin configuration pin field.

◆ TIVA_C_PINCFG_PORT_SHIFT

#define TIVA_C_PINCFG_PORT_SHIFT   16

Bit shift for pin configuration port field.

◆ TIVA_C_PINMUX

#define TIVA_C_PINMUX ( port,
pin,
mux,
type )
Value:
((((port) & TIVA_C_PORT_MASK) << TIVA_C_PORT_SHIFT) | \
(((pin) & TIVA_C_PIN_MASK) << TIVA_C_PIN_SHIFT) | \
(((mux) & TIVA_C_MUX_MASK) << TIVA_C_MUX_SHIFT) | \
#define TIVA_C_PORT_MASK
Bit mask for the GPIO port field.
Definition tiva-c-pinctrl.h:21
#define TIVA_C_TYPE_SHIFT
Bit shift for the pin type field.
Definition tiva-c-pinctrl.h:31
#define TIVA_C_TYPE_MASK
Bit mask for the pin type field.
Definition tiva-c-pinctrl.h:33
#define TIVA_C_PIN_MASK
Bit mask for the GPIO pin field.
Definition tiva-c-pinctrl.h:25
#define TIVA_C_MUX_SHIFT
Bit shift for the mux function field.
Definition tiva-c-pinctrl.h:27
#define TIVA_C_PORT_SHIFT
Bit shift for the GPIO port field.
Definition tiva-c-pinctrl.h:19
#define TIVA_C_MUX_MASK
Bit mask for the mux function field.
Definition tiva-c-pinctrl.h:29
#define TIVA_C_PIN_SHIFT
Bit shift for the GPIO pin field.
Definition tiva-c-pinctrl.h:23

Encode a 32-bit Tiva C pinmux value.

Parameters
portGPIO port identifier.
pinGPIO pin number.
muxAlternate function number.
typePeripheral type.
Returns
Encoded pinmux value.

◆ TIVA_C_PINMUX_MUX

#define TIVA_C_PINMUX_MUX ( pm)
Value:

Extract mux function from an encoded pinmux value.

◆ TIVA_C_PINMUX_OPEN_DRAIN

#define TIVA_C_PINMUX_OPEN_DRAIN ( pm)
Value:
(((pm) >> TIVA_C_OPEN_DRAIN_SHIFT) & 0x1U)
#define TIVA_C_OPEN_DRAIN_SHIFT
Bit position of the open-drain flag.
Definition tiva-c-pinctrl.h:97

Return the encoded open-drain flag.

◆ TIVA_C_PINMUX_PIN

#define TIVA_C_PINMUX_PIN ( pm)
Value:

Extract GPIO pin from an encoded pinmux value.

◆ TIVA_C_PINMUX_PORT

#define TIVA_C_PINMUX_PORT ( pm)
Value:

Extract GPIO port from an encoded pinmux value.

◆ TIVA_C_PINMUX_PULL_DOWN

#define TIVA_C_PINMUX_PULL_DOWN ( pm)
Value:
(((pm) >> TIVA_C_PULL_DOWN_SHIFT) & 0x1U)
#define TIVA_C_PULL_DOWN_SHIFT
Bit position of the pull-down flag.
Definition tiva-c-pinctrl.h:95

Return the encoded pull-down flag.

◆ TIVA_C_PINMUX_PULL_UP

#define TIVA_C_PINMUX_PULL_UP ( pm)
Value:
(((pm) >> TIVA_C_PULL_UP_SHIFT) & 0x1U)
#define TIVA_C_PULL_UP_SHIFT
Bit position of the pull-up flag.
Definition tiva-c-pinctrl.h:93

Return the encoded pull-up flag.

◆ TIVA_C_PINMUX_TYPE

#define TIVA_C_PINMUX_TYPE ( pm)
Value:

Extract peripheral type from an encoded pinmux value.

◆ TIVA_C_PORT_A

#define TIVA_C_PORT_A   0

GPIO Port A identifier.

◆ TIVA_C_PORT_B

#define TIVA_C_PORT_B   1

GPIO Port B identifier.

◆ TIVA_C_PORT_C

#define TIVA_C_PORT_C   2

GPIO Port C identifier.

◆ TIVA_C_PORT_D

#define TIVA_C_PORT_D   3

GPIO Port D identifier.

◆ TIVA_C_PORT_E

#define TIVA_C_PORT_E   4

GPIO Port E identifier.

◆ TIVA_C_PORT_F

#define TIVA_C_PORT_F   5

GPIO Port F identifier.

◆ TIVA_C_PORT_MASK

#define TIVA_C_PORT_MASK   0x7

Bit mask for the GPIO port field.

◆ TIVA_C_PORT_SHIFT

#define TIVA_C_PORT_SHIFT   0

Bit shift for the GPIO port field.

◆ TIVA_C_PULL_DOWN_SHIFT

#define TIVA_C_PULL_DOWN_SHIFT   27

Bit position of the pull-down flag.

◆ TIVA_C_PULL_UP_SHIFT

#define TIVA_C_PULL_UP_SHIFT   26

Bit position of the pull-up flag.

◆ TIVA_C_TYPE_CAN

#define TIVA_C_TYPE_CAN   5

CAN pin type.

◆ TIVA_C_TYPE_GPIO

#define TIVA_C_TYPE_GPIO   0

GPIO pin type.

◆ TIVA_C_TYPE_I2C

#define TIVA_C_TYPE_I2C   2

I2C SDA pin type.

◆ TIVA_C_TYPE_I2C_SCL

#define TIVA_C_TYPE_I2C_SCL   3

I2C SCL pin type.

◆ TIVA_C_TYPE_MASK

#define TIVA_C_TYPE_MASK   0x7

Bit mask for the pin type field.

◆ TIVA_C_TYPE_PWM

#define TIVA_C_TYPE_PWM   6

PWM pin type.

◆ TIVA_C_TYPE_SHIFT

#define TIVA_C_TYPE_SHIFT   23

Bit shift for the pin type field.

◆ TIVA_C_TYPE_SSI

#define TIVA_C_TYPE_SSI   4

SSI pin type.

◆ TIVA_C_TYPE_UART

#define TIVA_C_TYPE_UART   1

UART pin type.