AM275 FreeRTOS SDK  11.00.00
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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/am275x/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...
 
void Pinmux_unlockMMR (uint32_t domainId)
 This API unlocks the PAD config control MMRs for the given domain. More...
 
void Pinmux_lockMMR (uint32_t domainId)
 This API locks the PAD config control MMRs for the given domain. More...
 

Enumerations

enum  Pinmux_MainOffsets {
  PIN_OSPI0_CLK = 0x000, PIN_OSPI0_LBCLKO = 0x004, PIN_OSPI0_DQS = 0x008, PIN_OSPI0_D0 = 0x00C,
  PIN_OSPI0_D1 = 0x010, PIN_OSPI0_D2 = 0x014, PIN_OSPI0_D3 = 0x018, PIN_OSPI0_D4 = 0x01C,
  PIN_OSPI0_D5 = 0x020, PIN_OSPI0_D6 = 0x024, PIN_OSPI0_D7 = 0x028, PIN_OSPI0_CSN0 = 0x02C,
  PIN_OSPI0_CSN1 = 0x030, PIN_OSPI0_CSN2 = 0x034, PIN_OSPI0_CSN3 = 0x038, PIN_MCASP0_ACLKX = 0x03C,
  PIN_MCASP0_AFSX = 0x040, PIN_MCASP0_AXR0 = 0x044, PIN_MCASP0_AXR1 = 0x048, PIN_MCASP0_AXR2 = 0x04C,
  PIN_MCASP0_AXR3 = 0x050, PIN_MCASP0_AXR4 = 0x054, PIN_MCASP0_AXR5 = 0x058, PIN_MCASP0_AXR6 = 0x05C,
  PIN_MCASP0_AXR7 = 0x060, PIN_MCASP0_AXR8 = 0x064, PIN_MCASP0_AXR9 = 0x068, PIN_MCASP0_AXR10 = 0x06C,
  PIN_MCASP0_AXR11 = 0x070, PIN_MCASP0_AXR12 = 0x074, PIN_MCASP0_AXR13 = 0x078, PIN_MCASP0_AXR14 = 0x07C,
  PIN_MCASP0_AXR15 = 0x084, PIN_MCASP1_ACLKX = 0x088, PIN_MCASP1_AFSX = 0x08C, PIN_MCASP1_AXR0 = 0x090,
  PIN_MCASP1_AXR1 = 0x094, PIN_MCASP1_AXR2 = 0x098, PIN_MCASP1_AXR3 = 0x09C, PIN_MCASP2_ACLKX = 0x0A0,
  PIN_MCASP2_AFSX = 0x0A4, PIN_MCASP2_AXR0 = 0x0A8, PIN_MCASP2_AXR1 = 0x0AC, PIN_MCASP2_AXR2 = 0x0B0,
  PIN_MCASP2_AXR3 = 0x0B4, PIN_MCASP2_AXR4 = 0x0B8, PIN_MCASP2_AXR5 = 0x0BC, PIN_MCASP3_ACLKX = 0x0C0,
  PIN_MCASP3_AFSX = 0x0C4, PIN_MCASP3_AXR0 = 0x0C8, PIN_MCASP3_AXR1 = 0x0CC, PIN_MCASP3_AXR2 = 0x0D0,
  PIN_MCASP3_AXR3 = 0x0D4, PIN_MCASP4_ACLKX = 0x0E0, PIN_MCASP4_AFSX = 0x0E4, PIN_MCASP4_AXR0 = 0x0E8,
  PIN_MCASP4_AXR1 = 0x0EC, PIN_MCASP4_AXR2 = 0x0F0, PIN_MLB0_MLBSIG = 0x0FC, PIN_MLB0_MLBCLK = 0x100,
  PIN_MLB0_MLBDAT = 0x104, PIN_OSPI1_CLK = 0x108, PIN_OSPI1_LBCLKO = 0x10C, PIN_OSPI1_DQS = 0x110,
  PIN_OSPI1_D0 = 0x114, PIN_OSPI1_D1 = 0x118, PIN_OSPI1_D2 = 0x11C, PIN_OSPI1_D3 = 0x120,
  PIN_OSPI1_CSN0 = 0x124, PIN_RGMII1_TX_CTL = 0x12C, PIN_RGMII1_TXC = 0x130, PIN_RGMII1_TD0 = 0x134,
  PIN_RGMII1_TD1 = 0x138, PIN_RGMII1_TD2 = 0x13C, PIN_RGMII1_TD3 = 0x140, PIN_RGMII1_RX_CTL = 0x144,
  PIN_RGMII1_RXC = 0x148, PIN_RGMII1_RD0 = 0x14C, PIN_RGMII1_RD1 = 0x150, PIN_RGMII1_RD2 = 0x154,
  PIN_RGMII1_RD3 = 0x158, PIN_MDIO0_MDIO = 0x15C, PIN_MDIO0_MDC = 0x160, PIN_RGMII2_TX_CTL = 0x164,
  PIN_RGMII2_TXC = 0x168, PIN_RGMII2_TD0 = 0x16C, PIN_RGMII2_TD1 = 0x170, PIN_RGMII2_TD2 = 0x174,
  PIN_OSPI1_CSN1 = 0x128, PIN_RGMII2_TD3 = 0x178, PIN_RGMII2_RX_CTL = 0x17C, PIN_RGMII2_RXC = 0x180,
  PIN_RGMII2_RD0 = 0x184, PIN_RGMII2_RD1 = 0x188, PIN_RGMII2_RD2 = 0x18C, PIN_RGMII2_RD3 = 0x190,
  PIN_SPI2_D0 = 0x194, PIN_SPI2_D1 = 0x198, PIN_SPI2_CS2 = 0x19C, PIN_AUDIO_EXT_REFCLK0 = 0x1A0,
  PIN_SPI2_CS1 = 0x1A4, PIN_SPI2_CS3 = 0x1A8, PIN_SPI2_CS0 = 0x1AC, PIN_SPI2_CLK = 0x1B0,
  PIN_SPI0_CS0 = 0x1B4, PIN_SPI0_CS1 = 0x1B8, PIN_SPI0_CLK = 0x1BC, PIN_SPI0_D0 = 0x1C0,
  PIN_SPI0_D1 = 0x1C4, PIN_UART0_RXD = 0x1C8, PIN_UART0_TXD = 0x1CC, PIN_UART0_CTSN = 0x1D0,
  PIN_UART0_RTSN = 0x1D4, PIN_MCAN0_TX = 0x1D8, PIN_MCAN0_RX = 0x1DC, PIN_I2C0_SCL = 0x1E0,
  PIN_I2C0_SDA = 0x1E4, PIN_I2C1_SCL = 0x1E8, PIN_I2C1_SDA = 0x1EC, PIN_EXT_REFCLK1 = 0x1F0,
  PIN_EXTINTN = 0x1F4, PIN_MMC0_DAT7 = 0x1F8, PIN_MMC0_DAT6 = 0x1FC, PIN_MMC0_DAT5 = 0x200,
  PIN_MMC0_DAT4 = 0x204, PIN_MMC0_DAT3 = 0x208, PIN_MMC0_DAT2 = 0x20C, PIN_MMC0_DAT1 = 0x210,
  PIN_MMC0_DAT0 = 0x214, PIN_MMC0_CLK = 0x218, PIN_MMC0_CMD = 0x220, PIN_SPI1_CS0 = 0x224,
  PIN_SPI1_CS1 = 0x228, PIN_SPI1_CLK = 0x22C, PIN_SPI1_D0 = 0x230, PIN_SPI1_D1 = 0x234,
  PIN_GPIO1_47 = 0x23C, PIN_GPIO1_48 = 0x240, PIN_GPIO1_49 = 0x244, PIN_USB0_DRVVBUS = 0x254,
  PIN_GPIO1_72 = 0x2AC, PIN_ADC0_AIN0 = 0x2B0, PIN_ADC0_AIN1 = 0x2B4, PIN_ADC0_AIN2 = 0x2B8,
  PIN_ADC0_AIN3 = 0x2BC, PIN_ADC0_AIN4 = 0x2C0, PIN_ADC0_AIN5 = 0x2C4, PIN_ADC0_AIN6 = 0x2C8,
  PIN_ADC0_AIN7 = 0x2CC, PIN_OSPI1_D4 = 0x2D0, PIN_OSPI1_D5 = 0x2D4, PIN_OSPI1_D6 = 0x2D8,
  PIN_OSPI1_D7 = 0x2DC
}
 Main domain pad config register offset in control module. More...
 
enum  Pinmux_McuOffsets {
  PIN_EMU1 = 0x07C, PIN_EMU0 = 0x078, PIN_WKUP_CLKOUT0 = 0x084, PIN_PMIC_LPM_EN0 = 0x080,
  PIN_WKUP_I2C0_SDA = 0x050, PIN_WKUP_I2C0_SCL = 0x04C, PIN_MCU_GPIO0_16 = 0x040, PIN_MCU_GPIO0_15 = 0x03C,
  PIN_MCU_GPIO0_14 = 0x038, PIN_MCU_GPIO0_13 = 0x034, PIN_WKUP_UART0_RTSN = 0x030, PIN_WKUP_UART0_CTSN = 0x02C,
  PIN_WKUP_UART0_TXD = 0x028, PIN_WKUP_UART0_RXD = 0x024, PIN_MCU_GPIO0_8 = 0x020, PIN_MCU_GPIO0_7 = 0x01C,
  PIN_MCU_GPIO0_6 = 0x018, PIN_MCU_GPIO0_5 = 0x014, PIN_MCU_GPIO0_4 = 0x010, PIN_MCU_GPIO0_3 = 0x00C,
  PIN_MCU_GPIO0_2 = 0x008, PIN_WKUP_TIMER_IO1 = 0x004, PIN_WKUP_TIMER_IO0 = 0x000
}
 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_OSPI0_CLK 
PIN_OSPI0_LBCLKO 
PIN_OSPI0_DQS 
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_CSN0 
PIN_OSPI0_CSN1 
PIN_OSPI0_CSN2 
PIN_OSPI0_CSN3 
PIN_MCASP0_ACLKX 
PIN_MCASP0_AFSX 
PIN_MCASP0_AXR0 
PIN_MCASP0_AXR1 
PIN_MCASP0_AXR2 
PIN_MCASP0_AXR3 
PIN_MCASP0_AXR4 
PIN_MCASP0_AXR5 
PIN_MCASP0_AXR6 
PIN_MCASP0_AXR7 
PIN_MCASP0_AXR8 
PIN_MCASP0_AXR9 
PIN_MCASP0_AXR10 
PIN_MCASP0_AXR11 
PIN_MCASP0_AXR12 
PIN_MCASP0_AXR13 
PIN_MCASP0_AXR14 
PIN_MCASP0_AXR15 
PIN_MCASP1_ACLKX 
PIN_MCASP1_AFSX 
PIN_MCASP1_AXR0 
PIN_MCASP1_AXR1 
PIN_MCASP1_AXR2 
PIN_MCASP1_AXR3 
PIN_MCASP2_ACLKX 
PIN_MCASP2_AFSX 
PIN_MCASP2_AXR0 
PIN_MCASP2_AXR1 
PIN_MCASP2_AXR2 
PIN_MCASP2_AXR3 
PIN_MCASP2_AXR4 
PIN_MCASP2_AXR5 
PIN_MCASP3_ACLKX 
PIN_MCASP3_AFSX 
PIN_MCASP3_AXR0 
PIN_MCASP3_AXR1 
PIN_MCASP3_AXR2 
PIN_MCASP3_AXR3 
PIN_MCASP4_ACLKX 
PIN_MCASP4_AFSX 
PIN_MCASP4_AXR0 
PIN_MCASP4_AXR1 
PIN_MCASP4_AXR2 
PIN_MLB0_MLBSIG 
PIN_MLB0_MLBCLK 
PIN_MLB0_MLBDAT 
PIN_OSPI1_CLK 
PIN_OSPI1_LBCLKO 
PIN_OSPI1_DQS 
PIN_OSPI1_D0 
PIN_OSPI1_D1 
PIN_OSPI1_D2 
PIN_OSPI1_D3 
PIN_OSPI1_CSN0 
PIN_RGMII1_TX_CTL 
PIN_RGMII1_TXC 
PIN_RGMII1_TD0 
PIN_RGMII1_TD1 
PIN_RGMII1_TD2 
PIN_RGMII1_TD3 
PIN_RGMII1_RX_CTL 
PIN_RGMII1_RXC 
PIN_RGMII1_RD0 
PIN_RGMII1_RD1 
PIN_RGMII1_RD2 
PIN_RGMII1_RD3 
PIN_MDIO0_MDIO 
PIN_MDIO0_MDC 
PIN_RGMII2_TX_CTL 
PIN_RGMII2_TXC 
PIN_RGMII2_TD0 
PIN_RGMII2_TD1 
PIN_RGMII2_TD2 
PIN_OSPI1_CSN1 
PIN_RGMII2_TD3 
PIN_RGMII2_RX_CTL 
PIN_RGMII2_RXC 
PIN_RGMII2_RD0 
PIN_RGMII2_RD1 
PIN_RGMII2_RD2 
PIN_RGMII2_RD3 
PIN_SPI2_D0 
PIN_SPI2_D1 
PIN_SPI2_CS2 
PIN_AUDIO_EXT_REFCLK0 
PIN_SPI2_CS1 
PIN_SPI2_CS3 
PIN_SPI2_CS0 
PIN_SPI2_CLK 
PIN_SPI0_CS0 
PIN_SPI0_CS1 
PIN_SPI0_CLK 
PIN_SPI0_D0 
PIN_SPI0_D1 
PIN_UART0_RXD 
PIN_UART0_TXD 
PIN_UART0_CTSN 
PIN_UART0_RTSN 
PIN_MCAN0_TX 
PIN_MCAN0_RX 
PIN_I2C0_SCL 
PIN_I2C0_SDA 
PIN_I2C1_SCL 
PIN_I2C1_SDA 
PIN_EXT_REFCLK1 
PIN_EXTINTN 
PIN_MMC0_DAT7 
PIN_MMC0_DAT6 
PIN_MMC0_DAT5 
PIN_MMC0_DAT4 
PIN_MMC0_DAT3 
PIN_MMC0_DAT2 
PIN_MMC0_DAT1 
PIN_MMC0_DAT0 
PIN_MMC0_CLK 
PIN_MMC0_CMD 
PIN_SPI1_CS0 
PIN_SPI1_CS1 
PIN_SPI1_CLK 
PIN_SPI1_D0 
PIN_SPI1_D1 
PIN_GPIO1_47 
PIN_GPIO1_48 
PIN_GPIO1_49 
PIN_USB0_DRVVBUS 
PIN_GPIO1_72 
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_OSPI1_D4 
PIN_OSPI1_D5 
PIN_OSPI1_D6 
PIN_OSPI1_D7 

◆ Pinmux_McuOffsets

enum Pinmux_McuOffsets

Wakeup domain pad config register offset in control module.

Enumerator
PIN_EMU1 
PIN_EMU0 
PIN_WKUP_CLKOUT0 
PIN_PMIC_LPM_EN0 
PIN_WKUP_I2C0_SDA 
PIN_WKUP_I2C0_SCL 
PIN_MCU_GPIO0_16 
PIN_MCU_GPIO0_15 
PIN_MCU_GPIO0_14 
PIN_MCU_GPIO0_13 
PIN_WKUP_UART0_RTSN 
PIN_WKUP_UART0_CTSN 
PIN_WKUP_UART0_TXD 
PIN_WKUP_UART0_RXD 
PIN_MCU_GPIO0_8 
PIN_MCU_GPIO0_7 
PIN_MCU_GPIO0_6 
PIN_MCU_GPIO0_5 
PIN_MCU_GPIO0_4 
PIN_MCU_GPIO0_3 
PIN_MCU_GPIO0_2 
PIN_WKUP_TIMER_IO1 
PIN_WKUP_TIMER_IO0 

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

◆ Pinmux_unlockMMR()

void Pinmux_unlockMMR ( uint32_t  domainId)

This API unlocks the PAD config control MMRs for the given domain.

Parameters
domainIdDomain ID to unlock the PAD config MMRs. Refer Pinmux_DomainId_t

◆ Pinmux_lockMMR()

void Pinmux_lockMMR ( uint32_t  domainId)

This API locks the PAD config control MMRs for the given domain.

Parameters
domainIdDomain ID to lock the PAD config MMRs. Refer Pinmux_DomainId_t