AM64x MCU+ SDK  08.02.00
Files | Data Structures | Functions | Enumerations | Macros
APIs for PINMUX
APIs for SOC Specific Device Drivers

Introduction

This module contains APIs to program and use the pinmux module.

Files

file  pinmux/am64x_am243x/pinmux.h
 PINMUX Driver API/interface file.
 

Data Structures

struct  Pinmux_PerCfg_t
 Structure defining the pin configuration parameters. More...
 

Functions

void Pinmux_config (const Pinmux_PerCfg_t *pinmuxCfg, uint32_t domainId)
 This API configures the pinmux based on the domain. More...
 

Enumerations

enum  Pinmux_MainOffsets {
  PIN_ADC0_AIN0 = 0x02B0, PIN_ADC0_AIN1 = 0x02B4, PIN_ADC0_AIN2 = 0x02B8, PIN_ADC0_AIN3 = 0x02BC,
  PIN_ADC0_AIN4 = 0x02C0, PIN_ADC0_AIN5 = 0x02C4, PIN_ADC0_AIN6 = 0x02C8, PIN_ADC0_AIN7 = 0x02CC,
  PIN_PRG1_PRU0_GPO18 = 0x0100, PIN_PRG1_PRU0_GPO7 = 0x00D4, PIN_PRG1_PRU0_GPO19 = 0x0104, PIN_PRG1_PRU0_GPO17 = 0x00FC,
  PIN_GPMC0_AD0 = 0x003C, PIN_GPMC0_AD1 = 0x0040, PIN_GPMC0_AD2 = 0x0044, PIN_GPMC0_AD3 = 0x0048,
  PIN_GPMC0_AD4 = 0x004C, PIN_GPMC0_AD5 = 0x0050, PIN_GPMC0_AD6 = 0x0054, PIN_GPMC0_AD7 = 0x0058,
  PIN_GPMC0_AD11 = 0x0068, PIN_GPMC0_AD12 = 0x006C, PIN_GPMC0_AD13 = 0x0070, PIN_GPMC0_ADVN_ALE = 0x0084,
  PIN_GPMC0_OEN_REN = 0x0088, PIN_GPMC0_WEN = 0x008C, PIN_GPMC0_BE0N_CLE = 0x0090, PIN_GPMC0_WAIT0 = 0x0098,
  PIN_GPMC0_WAIT1 = 0x009C, PIN_GPMC0_WPN = 0x00A0, PIN_GPMC0_CSN0 = 0x00A8, PIN_PRG0_PRU0_GPO18 = 0x01A8,
  PIN_PRG0_PRU0_GPO19 = 0x01AC, PIN_SPI1_CS0 = 0x021C, PIN_SPI1_D1 = 0x022C, PIN_GPMC0_AD8 = 0x005C,
  PIN_GPMC0_AD9 = 0x0060, PIN_GPMC0_AD10 = 0x0064, PIN_GPMC0_BE1N = 0x0094, PIN_GPMC0_AD14 = 0x0074,
  PIN_GPMC0_AD15 = 0x0078, PIN_OSPI0_CSN1 = 0x0030, PIN_OSPI0_CSN2 = 0x0034, PIN_OSPI0_CSN3 = 0x0038,
  PIN_SPI0_CS1 = 0x020C, PIN_EXTINTN = 0x0278, PIN_MMC1_SDWP = 0x029C, PIN_PRG1_PRU1_GPO8 = 0x0128,
  PIN_PRG1_PRU1_GPO5 = 0x011C, PIN_PRG1_PRU0_GPO5 = 0x00CC, PIN_GPMC0_CSN1 = 0x00AC, PIN_GPMC0_DIR = 0x00A4,
  PIN_I2C0_SCL = 0x0260, PIN_I2C0_SDA = 0x0264, PIN_I2C1_SCL = 0x0268, PIN_I2C1_SDA = 0x026C,
  PIN_GPMC0_CSN2 = 0x00B0, PIN_GPMC0_CSN3 = 0x00B4, PIN_MCAN0_RX = 0x0254, PIN_MCAN0_TX = 0x0250,
  PIN_MCAN1_RX = 0x025C, PIN_MCAN1_TX = 0x0258, PIN_PRG0_PRU1_GPO19 = 0x01FC, PIN_PRG0_PRU1_GPO18 = 0x01F8,
  PIN_MMC1_CMD = 0x0294, PIN_MMC1_CLK = 0x028C, PIN_MMC1_CLKLB = 0x0290, PIN_MMC1_LB = 0x0290,
  PIN_MMC1_DAT0 = 0x0288, PIN_MMC1_DAT1 = 0x0284, PIN_MMC1_DAT2 = 0x0280, PIN_MMC1_DAT3 = 0x027C,
  PIN_MMC1_SDCD = 0x0298, PIN_OSPI0_CLK = 0x0000, PIN_OSPI0_CSN0 = 0x002C, PIN_OSPI0_D0 = 0x000C,
  PIN_OSPI0_D1 = 0x0010, PIN_OSPI0_D2 = 0x0014, PIN_OSPI0_D3 = 0x0018, PIN_OSPI0_D4 = 0x001C,
  PIN_OSPI0_D5 = 0x0020, PIN_OSPI0_D6 = 0x0024, PIN_OSPI0_D7 = 0x0028, PIN_OSPI0_DQS = 0x0008,
  PIN_PRG0_MDIO0_MDC = 0x0204, PIN_PRG0_MDIO0_MDIO = 0x0200, PIN_PRG0_PRU0_GPO0 = 0x0160, PIN_PRG0_PRU0_GPO1 = 0x0164,
  PIN_PRG0_PRU0_GPO11 = 0x018C, PIN_PRG0_PRU0_GPO12 = 0x0190, PIN_PRG0_PRU0_GPO13 = 0x0194, PIN_PRG0_PRU0_GPO14 = 0x0198,
  PIN_PRG0_PRU0_GPO15 = 0x019C, PIN_PRG0_PRU0_GPO16 = 0x01A0, PIN_PRG0_PRU0_GPO17 = 0x01A4, PIN_PRG0_PRU0_GPO2 = 0x0168,
  PIN_PRG0_PRU0_GPO3 = 0x016C, PIN_PRG0_PRU0_GPO4 = 0x0170, PIN_PRG0_PRU0_GPO5 = 0x0174, PIN_PRG0_PRU0_GPO6 = 0x0178,
  PIN_PRG0_PRU0_GPO7 = 0x017C, PIN_PRG0_PRU0_GPO8 = 0x0180, PIN_PRG0_PRU1_GPO0 = 0x01B0, PIN_PRG0_PRU1_GPO1 = 0x01B4,
  PIN_PRG0_PRU1_GPO11 = 0x01DC, PIN_PRG0_PRU1_GPO12 = 0x01E0, PIN_PRG0_PRU1_GPO13 = 0x01E4, PIN_PRG0_PRU1_GPO14 = 0x01E8,
  PIN_PRG0_PRU1_GPO15 = 0x01EC, PIN_PRG0_PRU1_GPO16 = 0x01F0, PIN_PRG0_PRU1_GPO2 = 0x01B8, PIN_PRG0_PRU1_GPO3 = 0x01BC,
  PIN_PRG0_PRU1_GPO4 = 0x01C0, PIN_PRG0_PRU1_GPO5 = 0x01C4, PIN_PRG0_PRU1_GPO6 = 0x01C8, PIN_PRG0_PRU1_GPO8 = 0x01D0,
  PIN_PRG1_MDIO0_MDC = 0x015C, PIN_PRG1_MDIO0_MDIO = 0x0158, PIN_PRG1_PRU1_GPO18 = 0x0150, PIN_PRG1_PRU1_GPO19 = 0x0154,
  PIN_PRG1_PRU0_GPO0 = 0x00B8, PIN_PRG1_PRU0_GPO1 = 0x00BC, PIN_PRG1_PRU0_GPO2 = 0x00C0, PIN_PRG1_PRU0_GPO3 = 0x00C4,
  PIN_PRG1_PRU0_GPO6 = 0x00D0, PIN_PRG1_PRU0_GPO4 = 0x00C8, PIN_PRG1_PRU0_GPO8 = 0x00D8, PIN_PRG1_PRU0_GPO11 = 0x00E4,
  PIN_PRG1_PRU0_GPO12 = 0x00E8, PIN_PRG1_PRU0_GPO13 = 0x00EC, PIN_PRG1_PRU0_GPO14 = 0x00F0, PIN_PRG1_PRU0_GPO16 = 0x00F8,
  PIN_PRG1_PRU0_GPO15 = 0x00F4, PIN_PRG1_PRU1_GPO0 = 0x0108, PIN_PRG1_PRU1_GPO1 = 0x010C, PIN_PRG1_PRU1_GPO2 = 0x0110,
  PIN_PRG1_PRU1_GPO3 = 0x0114, PIN_PRG1_PRU1_GPO6 = 0x0120, PIN_PRG1_PRU1_GPO4 = 0x0118, PIN_PRG1_PRU1_GPO11 = 0x0134,
  PIN_PRG1_PRU1_GPO12 = 0x0138, PIN_PRG1_PRU1_GPO13 = 0x013C, PIN_PRG1_PRU1_GPO14 = 0x0140, PIN_PRG1_PRU1_GPO16 = 0x0148,
  PIN_PRG1_PRU1_GPO15 = 0x0144, PIN_PRG0_PRU1_GPO7 = 0x01CC, PIN_PRG0_PRU1_GPO9 = 0x01D4, PIN_PRG0_PRU1_GPO10 = 0x01D8,
  PIN_PRG0_PRU1_GPO17 = 0x01F4, PIN_PRG0_PRU0_GPO10 = 0x0188, PIN_PRG0_PRU0_GPO9 = 0x0184, PIN_PRG1_PRU1_GPO7 = 0x0124,
  PIN_PRG1_PRU1_GPO9 = 0x012C, PIN_PRG1_PRU1_GPO10 = 0x0130, PIN_PRG1_PRU1_GPO17 = 0x014C, PIN_PRG1_PRU0_GPO10 = 0x00E0,
  PIN_PRG1_PRU0_GPO9 = 0x00DC, PIN_SPI0_CLK = 0x0210, PIN_SPI0_CS0 = 0x0208, PIN_SPI0_D0 = 0x0214,
  PIN_SPI0_D1 = 0x0218, PIN_SPI1_CLK = 0x0224, PIN_SPI1_CS1 = 0x0220, PIN_SPI1_D0 = 0x0228,
  PIN_EXT_REFCLK1 = 0x0274, PIN_GPMC0_CLK = 0x007C, PIN_USB0_DRVVBUS = 0x02A8, PIN_PORZ_OUT = 0x02AC,
  PIN_RESETSTATZ = 0x02A4, PIN_ECAP0_IN_APWM_OUT = 0x0270, PIN_UART0_CTSN = 0x0238, PIN_UART0_RTSN = 0x023C,
  PIN_UART0_RXD = 0x0230, PIN_UART0_TXD = 0x0234, PIN_UART1_RXD = 0x0240, PIN_UART1_TXD = 0x0244,
  PIN_UART1_CTSN = 0x0248, PIN_UART1_RTSN = 0x024C
}
 Main domain pad config register offset in control module. More...
 
enum  Pinmux_McuOffsets {
  PIN_MCU_SPI1_CS0 = 0x0014, PIN_MCU_I2C0_SCL = 0x0048, PIN_MCU_I2C0_SDA = 0x004C, PIN_MCU_I2C1_SCL = 0x0050,
  PIN_MCU_I2C1_SDA = 0x0054, PIN_MCU_SPI0_CLK = 0x0008, PIN_MCU_SPI0_CS0 = 0x0000, PIN_MCU_SPI0_CS1 = 0x0004,
  PIN_MCU_SPI0_D0 = 0x000C, PIN_MCU_SPI0_D1 = 0x0010, PIN_MCU_SPI1_CLK = 0x001C, PIN_MCU_SPI1_CS1 = 0x0018,
  PIN_MCU_SPI1_D0 = 0x0020, PIN_MCU_SPI1_D1 = 0x0024, PIN_MCU_PORZ = 0x005C, PIN_MCU_RESETSTATZ = 0x0060,
  PIN_MCU_RESETZ = 0x0058, PIN_MCU_SAFETY_ERRORN = 0x0064, PIN_MCU_UART0_CTSN = 0x0030, PIN_MCU_UART0_RTSN = 0x0034,
  PIN_MCU_UART0_RXD = 0x0028, PIN_MCU_UART0_TXD = 0x002C, PIN_MCU_UART1_CTSN = 0x0040, PIN_MCU_UART1_RTSN = 0x0044,
  PIN_MCU_UART1_RXD = 0x0038, PIN_MCU_UART1_TXD = 0x003C
}
 Wakeup domain pad config register offset in control module. More...
 

Macros

#define PINMUX_END   (-1)
 Macro to mark end of pinmux config array. More...
 
#define PIN_MODE(mode)   ((uint32_t) mode)
 Pin mode - it is at 0th bit. No shift requried. More...
 
#define PIN_PULL_DISABLE   (((uint32_t) 0x1U) << 16U)
 Resistor enable. More...
 
#define PIN_PULL_DIRECTION   (((uint32_t) 0x1U) << 17U)
 Pull direction. More...
 
#define PIN_INPUT_ENABLE   (((uint32_t) 0x1U) << 18U)
 Receiver enable. More...
 
#define PIN_OUTPUT_DISABLE   (((uint32_t) 0x1U) << 21U)
 Driver disable. More...
 
#define PIN_WAKEUP_ENABLE   (((uint32_t) 0x1U) << 29U)
 Wakeup enable. More...
 

Pinmux Domain ID

#define PINMUX_DOMAIN_ID_MAIN   (0U)
 
#define PINMUX_DOMAIN_ID_MCU   (1U)
 

Macro Definition Documentation

◆ PINMUX_DOMAIN_ID_MAIN

#define PINMUX_DOMAIN_ID_MAIN   (0U)

◆ PINMUX_DOMAIN_ID_MCU

#define PINMUX_DOMAIN_ID_MCU   (1U)

◆ PINMUX_END

#define PINMUX_END   (-1)

Macro to mark end of pinmux config array.

◆ PIN_MODE

#define PIN_MODE (   mode)    ((uint32_t) mode)

Pin mode - it is at 0th bit. No shift requried.

◆ PIN_PULL_DISABLE

#define PIN_PULL_DISABLE   (((uint32_t) 0x1U) << 16U)

Resistor enable.

◆ PIN_PULL_DIRECTION

#define PIN_PULL_DIRECTION   (((uint32_t) 0x1U) << 17U)

Pull direction.

◆ PIN_INPUT_ENABLE

#define PIN_INPUT_ENABLE   (((uint32_t) 0x1U) << 18U)

Receiver enable.

◆ PIN_OUTPUT_DISABLE

#define PIN_OUTPUT_DISABLE   (((uint32_t) 0x1U) << 21U)

Driver disable.

◆ PIN_WAKEUP_ENABLE

#define PIN_WAKEUP_ENABLE   (((uint32_t) 0x1U) << 29U)

Wakeup enable.

Enumeration Type Documentation

◆ Pinmux_MainOffsets

enum Pinmux_MainOffsets

Main domain pad config register offset in control module.

Enumerator
PIN_ADC0_AIN0 
PIN_ADC0_AIN1 
PIN_ADC0_AIN2 
PIN_ADC0_AIN3 
PIN_ADC0_AIN4 
PIN_ADC0_AIN5 
PIN_ADC0_AIN6 
PIN_ADC0_AIN7 
PIN_PRG1_PRU0_GPO18 
PIN_PRG1_PRU0_GPO7 
PIN_PRG1_PRU0_GPO19 
PIN_PRG1_PRU0_GPO17 
PIN_GPMC0_AD0 
PIN_GPMC0_AD1 
PIN_GPMC0_AD2 
PIN_GPMC0_AD3 
PIN_GPMC0_AD4 
PIN_GPMC0_AD5 
PIN_GPMC0_AD6 
PIN_GPMC0_AD7 
PIN_GPMC0_AD11 
PIN_GPMC0_AD12 
PIN_GPMC0_AD13 
PIN_GPMC0_ADVN_ALE 
PIN_GPMC0_OEN_REN 
PIN_GPMC0_WEN 
PIN_GPMC0_BE0N_CLE 
PIN_GPMC0_WAIT0 
PIN_GPMC0_WAIT1 
PIN_GPMC0_WPN 
PIN_GPMC0_CSN0 
PIN_PRG0_PRU0_GPO18 
PIN_PRG0_PRU0_GPO19 
PIN_SPI1_CS0 
PIN_SPI1_D1 
PIN_GPMC0_AD8 
PIN_GPMC0_AD9 
PIN_GPMC0_AD10 
PIN_GPMC0_BE1N 
PIN_GPMC0_AD14 
PIN_GPMC0_AD15 
PIN_OSPI0_CSN1 
PIN_OSPI0_CSN2 
PIN_OSPI0_CSN3 
PIN_SPI0_CS1 
PIN_EXTINTN 
PIN_MMC1_SDWP 
PIN_PRG1_PRU1_GPO8 
PIN_PRG1_PRU1_GPO5 
PIN_PRG1_PRU0_GPO5 
PIN_GPMC0_CSN1 
PIN_GPMC0_DIR 
PIN_I2C0_SCL 
PIN_I2C0_SDA 
PIN_I2C1_SCL 
PIN_I2C1_SDA 
PIN_GPMC0_CSN2 
PIN_GPMC0_CSN3 
PIN_MCAN0_RX 
PIN_MCAN0_TX 
PIN_MCAN1_RX 
PIN_MCAN1_TX 
PIN_PRG0_PRU1_GPO19 
PIN_PRG0_PRU1_GPO18 
PIN_MMC1_CMD 
PIN_MMC1_CLK 
PIN_MMC1_CLKLB 
PIN_MMC1_LB 
PIN_MMC1_DAT0 
PIN_MMC1_DAT1 
PIN_MMC1_DAT2 
PIN_MMC1_DAT3 
PIN_MMC1_SDCD 
PIN_OSPI0_CLK 
PIN_OSPI0_CSN0 
PIN_OSPI0_D0 
PIN_OSPI0_D1 
PIN_OSPI0_D2 
PIN_OSPI0_D3 
PIN_OSPI0_D4 
PIN_OSPI0_D5 
PIN_OSPI0_D6 
PIN_OSPI0_D7 
PIN_OSPI0_DQS 
PIN_PRG0_MDIO0_MDC 
PIN_PRG0_MDIO0_MDIO 
PIN_PRG0_PRU0_GPO0 
PIN_PRG0_PRU0_GPO1 
PIN_PRG0_PRU0_GPO11 
PIN_PRG0_PRU0_GPO12 
PIN_PRG0_PRU0_GPO13 
PIN_PRG0_PRU0_GPO14 
PIN_PRG0_PRU0_GPO15 
PIN_PRG0_PRU0_GPO16 
PIN_PRG0_PRU0_GPO17 
PIN_PRG0_PRU0_GPO2 
PIN_PRG0_PRU0_GPO3 
PIN_PRG0_PRU0_GPO4 
PIN_PRG0_PRU0_GPO5 
PIN_PRG0_PRU0_GPO6 
PIN_PRG0_PRU0_GPO7 
PIN_PRG0_PRU0_GPO8 
PIN_PRG0_PRU1_GPO0 
PIN_PRG0_PRU1_GPO1 
PIN_PRG0_PRU1_GPO11 
PIN_PRG0_PRU1_GPO12 
PIN_PRG0_PRU1_GPO13 
PIN_PRG0_PRU1_GPO14 
PIN_PRG0_PRU1_GPO15 
PIN_PRG0_PRU1_GPO16 
PIN_PRG0_PRU1_GPO2 
PIN_PRG0_PRU1_GPO3 
PIN_PRG0_PRU1_GPO4 
PIN_PRG0_PRU1_GPO5 
PIN_PRG0_PRU1_GPO6 
PIN_PRG0_PRU1_GPO8 
PIN_PRG1_MDIO0_MDC 
PIN_PRG1_MDIO0_MDIO 
PIN_PRG1_PRU1_GPO18 
PIN_PRG1_PRU1_GPO19 
PIN_PRG1_PRU0_GPO0 
PIN_PRG1_PRU0_GPO1 
PIN_PRG1_PRU0_GPO2 
PIN_PRG1_PRU0_GPO3 
PIN_PRG1_PRU0_GPO6 
PIN_PRG1_PRU0_GPO4 
PIN_PRG1_PRU0_GPO8 
PIN_PRG1_PRU0_GPO11 
PIN_PRG1_PRU0_GPO12 
PIN_PRG1_PRU0_GPO13 
PIN_PRG1_PRU0_GPO14 
PIN_PRG1_PRU0_GPO16 
PIN_PRG1_PRU0_GPO15 
PIN_PRG1_PRU1_GPO0 
PIN_PRG1_PRU1_GPO1 
PIN_PRG1_PRU1_GPO2 
PIN_PRG1_PRU1_GPO3 
PIN_PRG1_PRU1_GPO6 
PIN_PRG1_PRU1_GPO4 
PIN_PRG1_PRU1_GPO11 
PIN_PRG1_PRU1_GPO12 
PIN_PRG1_PRU1_GPO13 
PIN_PRG1_PRU1_GPO14 
PIN_PRG1_PRU1_GPO16 
PIN_PRG1_PRU1_GPO15 
PIN_PRG0_PRU1_GPO7 
PIN_PRG0_PRU1_GPO9 
PIN_PRG0_PRU1_GPO10 
PIN_PRG0_PRU1_GPO17 
PIN_PRG0_PRU0_GPO10 
PIN_PRG0_PRU0_GPO9 
PIN_PRG1_PRU1_GPO7 
PIN_PRG1_PRU1_GPO9 
PIN_PRG1_PRU1_GPO10 
PIN_PRG1_PRU1_GPO17 
PIN_PRG1_PRU0_GPO10 
PIN_PRG1_PRU0_GPO9 
PIN_SPI0_CLK 
PIN_SPI0_CS0 
PIN_SPI0_D0 
PIN_SPI0_D1 
PIN_SPI1_CLK 
PIN_SPI1_CS1 
PIN_SPI1_D0 
PIN_EXT_REFCLK1 
PIN_GPMC0_CLK 
PIN_USB0_DRVVBUS 
PIN_PORZ_OUT 
PIN_RESETSTATZ 
PIN_ECAP0_IN_APWM_OUT 
PIN_UART0_CTSN 
PIN_UART0_RTSN 
PIN_UART0_RXD 
PIN_UART0_TXD 
PIN_UART1_RXD 
PIN_UART1_TXD 
PIN_UART1_CTSN 
PIN_UART1_RTSN 

◆ Pinmux_McuOffsets

enum Pinmux_McuOffsets

Wakeup domain pad config register offset in control module.

Enumerator
PIN_MCU_SPI1_CS0 
PIN_MCU_I2C0_SCL 
PIN_MCU_I2C0_SDA 
PIN_MCU_I2C1_SCL 
PIN_MCU_I2C1_SDA 
PIN_MCU_SPI0_CLK 
PIN_MCU_SPI0_CS0 
PIN_MCU_SPI0_CS1 
PIN_MCU_SPI0_D0 
PIN_MCU_SPI0_D1 
PIN_MCU_SPI1_CLK 
PIN_MCU_SPI1_CS1 
PIN_MCU_SPI1_D0 
PIN_MCU_SPI1_D1 
PIN_MCU_PORZ 
PIN_MCU_RESETSTATZ 
PIN_MCU_RESETZ 
PIN_MCU_SAFETY_ERRORN 
PIN_MCU_UART0_CTSN 
PIN_MCU_UART0_RTSN 
PIN_MCU_UART0_RXD 
PIN_MCU_UART0_TXD 
PIN_MCU_UART1_CTSN 
PIN_MCU_UART1_RTSN 
PIN_MCU_UART1_RXD 
PIN_MCU_UART1_TXD 

Function Documentation

◆ Pinmux_config()

void Pinmux_config ( const Pinmux_PerCfg_t *  pinmuxCfg,
uint32_t  domainId 
)

This API configures the pinmux based on the domain.

Parameters
pinmuxCfgPointer to list of pinmux configuration array. This parameter cannot be NULL and the last entry should be initialized with PINMUX_END so that this function knows the end of configuration.
domainIdDomain ID to set pinmux configuration. Refer Pinmux_DomainId_t