EFM32 Happy Gecko Software Documentation
efm32hg-doc-5.1.2
|
General Purpose Input/Output (GPIO) API.
This module contains functions to control the GPIO peripheral of Silicon Labs 32-bit MCUs and SoCs. The GPIO peripheral is used for pin configuration and direct pin manipulation and sensing as well as routing for peripheral pin connections.
Enumerations | |
enum | GPIO_DriveMode_TypeDef { gpioDriveModeStandard = GPIO_P_CTRL_DRIVEMODE_STANDARD, gpioDriveModeLowest = GPIO_P_CTRL_DRIVEMODE_LOWEST, gpioDriveModeHigh = GPIO_P_CTRL_DRIVEMODE_HIGH, gpioDriveModeLow = GPIO_P_CTRL_DRIVEMODE_LOW } |
enum | GPIO_Mode_TypeDef { gpioModeDisabled = _GPIO_P_MODEL_MODE0_DISABLED, gpioModeInput = _GPIO_P_MODEL_MODE0_INPUT, gpioModeInputPull = _GPIO_P_MODEL_MODE0_INPUTPULL, gpioModeInputPullFilter = _GPIO_P_MODEL_MODE0_INPUTPULLFILTER, gpioModePushPull = _GPIO_P_MODEL_MODE0_PUSHPULL, gpioModePushPullDrive = _GPIO_P_MODEL_MODE0_PUSHPULLDRIVE, gpioModeWiredOr = _GPIO_P_MODEL_MODE0_WIREDOR, gpioModeWiredOrPullDown = _GPIO_P_MODEL_MODE0_WIREDORPULLDOWN, gpioModeWiredAnd = _GPIO_P_MODEL_MODE0_WIREDAND, gpioModeWiredAndFilter = _GPIO_P_MODEL_MODE0_WIREDANDFILTER, gpioModeWiredAndPullUp = _GPIO_P_MODEL_MODE0_WIREDANDPULLUP, gpioModeWiredAndPullUpFilter = _GPIO_P_MODEL_MODE0_WIREDANDPULLUPFILTER, gpioModeWiredAndDrive = _GPIO_P_MODEL_MODE0_WIREDANDDRIVE, gpioModeWiredAndDriveFilter = _GPIO_P_MODEL_MODE0_WIREDANDDRIVEFILTER, gpioModeWiredAndDrivePullUp = _GPIO_P_MODEL_MODE0_WIREDANDDRIVEPULLUP, gpioModeWiredAndDrivePullUpFilter = _GPIO_P_MODEL_MODE0_WIREDANDDRIVEPULLUPFILTER } |
enum | GPIO_Port_TypeDef |
Functions | |
void | GPIO_DbgLocationSet (unsigned int location) |
Sets the pin location of the debug pins (Serial Wire interface). More... | |
__STATIC_INLINE void | GPIO_DbgSWDClkEnable (bool enable) |
Enable/disable serial wire clock pin. More... | |
__STATIC_INLINE void | GPIO_DbgSWDIOEnable (bool enable) |
Enable/disable serial wire data I/O pin. More... | |
void | GPIO_DriveModeSet (GPIO_Port_TypeDef port, GPIO_DriveMode_TypeDef mode) |
Sets the drive mode for a GPIO port. More... | |
__STATIC_INLINE void | GPIO_EM4DisablePinWakeup (uint32_t pinmask) |
Disable GPIO pin wake-up from EM4. More... | |
void | GPIO_EM4EnablePinWakeup (uint32_t pinmask, uint32_t polaritymask) |
Enable GPIO pin wake-up from EM4. When the function exits, EM4 mode can be safely entered. More... | |
__STATIC_INLINE uint32_t | GPIO_EM4GetPinWakeupCause (void) |
Check which GPIO pin(s) that caused a wake-up from EM4. More... | |
__STATIC_INLINE void | GPIO_EM4SetPinRetention (bool enable) |
Enable GPIO pin retention of output enable, output value, pull enable and pull direction in EM4. More... | |
void | GPIO_ExtIntConfig (GPIO_Port_TypeDef port, unsigned int pin, unsigned int intNo, bool risingEdge, bool fallingEdge, bool enable) |
Configure GPIO external pin interrupt. More... | |
__STATIC_INLINE void | GPIO_InputSenseSet (uint32_t val, uint32_t mask) |
Enable/disable input sensing. More... | |
__STATIC_INLINE void | GPIO_IntClear (uint32_t flags) |
Clear one or more pending GPIO interrupts. More... | |
__STATIC_INLINE void | GPIO_IntConfig (GPIO_Port_TypeDef port, unsigned int pin, bool risingEdge, bool fallingEdge, bool enable) |
Configure GPIO interrupt. More... | |
__STATIC_INLINE void | GPIO_IntDisable (uint32_t flags) |
Disable one or more GPIO interrupts. More... | |
__STATIC_INLINE void | GPIO_IntEnable (uint32_t flags) |
Enable one or more GPIO interrupts. More... | |
__STATIC_INLINE uint32_t | GPIO_IntGet (void) |
Get pending GPIO interrupts. More... | |
__STATIC_INLINE uint32_t | GPIO_IntGetEnabled (void) |
Get enabled and pending GPIO interrupt flags. Useful for handling more interrupt sources in the same interrupt handler. More... | |
__STATIC_INLINE void | GPIO_IntSet (uint32_t flags) |
Set one or more pending GPIO interrupts from SW. More... | |
__STATIC_INLINE void | GPIO_Lock (void) |
Locks the GPIO configuration. | |
__STATIC_INLINE unsigned int | GPIO_PinInGet (GPIO_Port_TypeDef port, unsigned int pin) |
Read the pad value for a single pin in a GPIO port. More... | |
GPIO_Mode_TypeDef | GPIO_PinModeGet (GPIO_Port_TypeDef port, unsigned int pin) |
Get the mode for a GPIO pin. More... | |
void | GPIO_PinModeSet (GPIO_Port_TypeDef port, unsigned int pin, GPIO_Mode_TypeDef mode, unsigned int out) |
Set the mode for a GPIO pin. More... | |
__STATIC_INLINE void | GPIO_PinOutClear (GPIO_Port_TypeDef port, unsigned int pin) |
Set a single pin in GPIO data out port register to 0. More... | |
__STATIC_INLINE unsigned int | GPIO_PinOutGet (GPIO_Port_TypeDef port, unsigned int pin) |
Get current setting for a pin in a GPIO port data out register. More... | |
__STATIC_INLINE void | GPIO_PinOutSet (GPIO_Port_TypeDef port, unsigned int pin) |
Set a single pin in GPIO data out register to 1. More... | |
__STATIC_INLINE void | GPIO_PinOutToggle (GPIO_Port_TypeDef port, unsigned int pin) |
Toggle a single pin in GPIO port data out register. More... | |
__STATIC_INLINE uint32_t | GPIO_PortInGet (GPIO_Port_TypeDef port) |
Read the pad values for GPIO port. More... | |
__STATIC_INLINE void | GPIO_PortOutClear (GPIO_Port_TypeDef port, uint32_t pins) |
Set bits in DOUT register for a port to 0. More... | |
__STATIC_INLINE uint32_t | GPIO_PortOutGet (GPIO_Port_TypeDef port) |
Get current setting for a GPIO port data out register. More... | |
__STATIC_INLINE void | GPIO_PortOutSet (GPIO_Port_TypeDef port, uint32_t pins) |
Set bits GPIO data out register to 1. More... | |
__STATIC_INLINE void | GPIO_PortOutSetVal (GPIO_Port_TypeDef port, uint32_t val, uint32_t mask) |
Set GPIO port data out register. More... | |
__STATIC_INLINE void | GPIO_PortOutToggle (GPIO_Port_TypeDef port, uint32_t pins) |
Toggle pins in GPIO port data out register. More... | |
__STATIC_INLINE void | GPIO_Unlock (void) |
Unlocks the GPIO configuration. | |
enum GPIO_Mode_TypeDef |
Pin mode. For more details on each mode, please refer to the reference manual.
enum GPIO_Port_TypeDef |
void GPIO_DbgLocationSet | ( | unsigned int | location | ) |
__STATIC_INLINE void GPIO_DbgSWDClkEnable | ( | bool | enable | ) |
Enable/disable serial wire clock pin.
[in] | enable |
|
Definition at line 493 of file em_gpio.h.
References _GPIO_ROUTE_SWCLKPEN_SHIFT, BUS_RegBitWrite(), and GPIO.
__STATIC_INLINE void GPIO_DbgSWDIOEnable | ( | bool | enable | ) |
Enable/disable serial wire data I/O pin.
[in] | enable |
|
Definition at line 516 of file em_gpio.h.
References _GPIO_ROUTE_SWDIOPEN_SHIFT, BUS_RegBitWrite(), and GPIO.
void GPIO_DriveModeSet | ( | GPIO_Port_TypeDef | port, |
GPIO_DriveMode_TypeDef | mode | ||
) |
Sets the drive mode for a GPIO port.
[in] | port | The GPIO port to access. |
[in] | mode | Drive mode to use for port. |
Definition at line 106 of file em_gpio.c.
References _GPIO_P_CTRL_DRIVEMODE_MASK, _GPIO_P_CTRL_DRIVEMODE_SHIFT, and GPIO.
Referenced by CAPLESENSE_setupGPIO().
__STATIC_INLINE void GPIO_EM4DisablePinWakeup | ( | uint32_t | pinmask | ) |
Disable GPIO pin wake-up from EM4.
[in] | pinmask | Bitmask containing the bitwise logic OR of which GPIO pin(s) to disable. Refer to Reference Manuals for pinmask to GPIO port/pin mapping. |
Definition at line 570 of file em_gpio.h.
References _GPIO_EM4WUEN_MASK, and GPIO.
void GPIO_EM4EnablePinWakeup | ( | uint32_t | pinmask, |
uint32_t | polaritymask | ||
) |
Enable GPIO pin wake-up from EM4. When the function exits, EM4 mode can be safely entered.
[in] | pinmask | Bitmask containing the bitwise logic OR of which GPIO pin(s) to enable. Refer to Reference Manuals for pinmask to GPIO port/pin mapping. |
[in] | polaritymask | Bitmask containing the bitwise logic OR of GPIO pin(s) wake-up polarity. Refer to Reference Manuals for pinmask to GPIO port/pin mapping. |
Definition at line 361 of file em_gpio.c.
References _GPIO_EM4WUEN_MASK, _GPIO_EM4WUPOL_MASK, GPIO, GPIO_CMD_EM4WUCLR, GPIO_EM4SetPinRetention(), and GPIO_IntClear().
Referenced by UTIL_shutdown().
__STATIC_INLINE uint32_t GPIO_EM4GetPinWakeupCause | ( | void | ) |
Check which GPIO pin(s) that caused a wake-up from EM4.
Definition at line 591 of file em_gpio.h.
References _GPIO_EM4WUCAUSE_MASK, and GPIO.
__STATIC_INLINE void GPIO_EM4SetPinRetention | ( | bool | enable | ) |
Enable GPIO pin retention of output enable, output value, pull enable and pull direction in EM4.
[in] | enable |
|
Definition at line 616 of file em_gpio.h.
References EMU, GPIO, and GPIO_CTRL_EM4RET.
Referenced by GPIO_EM4EnablePinWakeup().
void GPIO_ExtIntConfig | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin, | ||
unsigned int | intNo, | ||
bool | risingEdge, | ||
bool | fallingEdge, | ||
bool | enable | ||
) |
Configure GPIO external pin interrupt.
If reconfiguring a GPIO interrupt that is already enabled, it is generally recommended to disable it first, see GPIO_Disable().
The actual GPIO interrupt handler must be in place before enabling the interrupt.
Notice that any pending interrupt for the selected interrupt is cleared by this function.
[in] | port | The port to associate with pin . |
[in] | pin | The pin number on the port. |
[in] | intNo | The interrupt number to trigger. |
[in] | risingEdge | Set to true if interrupts shall be enabled on rising edge, otherwise false. |
[in] | fallingEdge | Set to true if interrupts shall be enabled on falling edge, otherwise false. |
[in] | enable | Set to true if interrupt shall be enabled after configuration completed, false to leave disabled. See GPIO_IntDisable() and GPIO_IntEnable(). |
Definition at line 181 of file em_gpio.c.
References _GPIO_EXTIPSELH_EXTIPSEL8_MASK, _GPIO_EXTIPSELH_EXTIPSEL9_SHIFT, _GPIO_EXTIPSELL_EXTIPSEL0_MASK, _GPIO_EXTIPSELL_EXTIPSEL1_SHIFT, BUS_RegBitWrite(), BUS_RegMaskedWrite(), and GPIO.
Referenced by GPIO_IntConfig().
__STATIC_INLINE void GPIO_InputSenseSet | ( | uint32_t | val, |
uint32_t | mask | ||
) |
Enable/disable input sensing.
Disabling input sensing if not used, can save some energy consumption.
[in] | val | Bitwise logic OR of one or more of:
|
[in] | mask | Mask containing bitwise logic OR of bits similar as for val used to indicate which input sense options to disable/enable. |
Definition at line 662 of file em_gpio.h.
References GPIO.
Referenced by ezradio_hal_GpioInit().
__STATIC_INLINE void GPIO_IntClear | ( | uint32_t | flags | ) |
Clear one or more pending GPIO interrupts.
[in] | flags | Bitwise logic OR of GPIO interrupt sources to clear. |
Definition at line 674 of file em_gpio.h.
References GPIO.
Referenced by BOARD_picGetFwRevision(), GPIO_EM4EnablePinWakeup(), and GPIOINT_CallbackRegister().
__STATIC_INLINE void GPIO_IntConfig | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin, | ||
bool | risingEdge, | ||
bool | fallingEdge, | ||
bool | enable | ||
) |
Configure GPIO interrupt.
If reconfiguring a GPIO interrupt that is already enabled, it is generally recommended to disable it first, see GPIO_Disable().
The actual GPIO interrupt handler must be in place before enabling the interrupt.
Notice that any pending interrupt for the selected pin is cleared by this function.
[in] | port | The port to associate with pin . |
[in] | pin | The pin number on the port ( == GPIO EXTI interrupt number). |
[in] | risingEdge | Set to true if interrupts shall be enabled on rising edge, otherwise false. |
[in] | fallingEdge | Set to true if interrupts shall be enabled on falling edge, otherwise false. |
[in] | enable | Set to true if interrupt shall be enabled after configuration completed, false to leave disabled. See GPIO_IntDisable() and GPIO_IntEnable(). |
Definition at line 1104 of file em_gpio.h.
References GPIO_ExtIntConfig().
Referenced by BOARD_init(), BOARD_pushButtonEnableIRQ(), ezradio_hal_GpioInit(), SI7210_config(), and SI7210_deInit().
__STATIC_INLINE void GPIO_IntDisable | ( | uint32_t | flags | ) |
Disable one or more GPIO interrupts.
[in] | flags | GPIO interrupt sources to disable. |
Definition at line 686 of file em_gpio.h.
References GPIO.
Referenced by BOARD_picGetFwRevision().
__STATIC_INLINE void GPIO_IntEnable | ( | uint32_t | flags | ) |
Enable one or more GPIO interrupts.
[in] | flags | GPIO interrupt sources to enable. |
Definition at line 703 of file em_gpio.h.
References GPIO.
Referenced by BOARD_picGetFwRevision().
__STATIC_INLINE uint32_t GPIO_IntGet | ( | void | ) |
__STATIC_INLINE uint32_t GPIO_IntGetEnabled | ( | void | ) |
Get enabled and pending GPIO interrupt flags. Useful for handling more interrupt sources in the same interrupt handler.
Definition at line 735 of file em_gpio.h.
References GPIO.
Referenced by GPIOINT_CallbackRegister().
__STATIC_INLINE void GPIO_IntSet | ( | uint32_t | flags | ) |
__STATIC_INLINE unsigned int GPIO_PinInGet | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin | ||
) |
Read the pad value for a single pin in a GPIO port.
[in] | port | The GPIO port to access. |
[in] | pin | The pin number to read. |
Definition at line 781 of file em_gpio.h.
References BUS_RegBitRead(), and GPIO.
Referenced by ADC0_IRQHandler(), BSP_McuBoard_UsbVbusOcFlagGet(), ezradio_hal_NirqLevel(), IMU_isDataReadyFlag(), and TOUCH_IsBusy().
GPIO_Mode_TypeDef GPIO_PinModeGet | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin | ||
) |
void GPIO_PinModeSet | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin, | ||
GPIO_Mode_TypeDef | mode, | ||
unsigned int | out | ||
) |
Set the mode for a GPIO pin.
[in] | port | The GPIO port to access. |
[in] | pin | The pin number in the port. |
[in] | mode | The desired pin mode. |
[in] | out | Value to set for pin in DOUT register. The DOUT setting is important for even some input mode configurations, determining pull-up/down direction. |
Definition at line 269 of file em_gpio.c.
References GPIO, GPIO_PinOutClear(), GPIO_PinOutSet(), and gpioModeDisabled.
Referenced by ADC0_IRQHandler(), BOARD_flashDeepPowerDown(), BOARD_init(), BSP_BccPinsEnable(), BSP_BusControlModeSet(), BSP_EbiInit(), BSP_McuBoard_DeInit(), BSP_McuBoard_Init(), BSP_McuBoard_UsbVbusPowerEnable(), CAPLESENSE_setupGPIO(), ezradio_hal_GpioInit(), I2CSPM_Init(), ICM20648_spiInit(), KSZ8851SNL_SPI_Init(), MICROSD_Deinit(), MICROSD_Init(), MSDD_Init(), RETARGET_SerialInit(), setupI2C(), SI7210_deInit(), SI7210_init(), SPI_TFT_Init(), TFT_DirectGPIOConfig(), and UTIL_shutdown().
__STATIC_INLINE void GPIO_PinOutClear | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin | ||
) |
Set a single pin in GPIO data out port register to 0.
[in] | port | The GPIO port to access. |
[in] | pin | The pin to set. |
Definition at line 811 of file em_gpio.h.
References BUS_RegBitWrite(), and GPIO.
Referenced by BOARD_flashDeepPowerDown(), BOARD_ledSet(), BOARD_picGetFwRevision(), BSP_McuBoard_UsbStatusLedEnable(), ezradio_hal_ClearNsel(), ezradio_hal_DeassertShutdown(), GPIO_PinModeSet(), I2CSPM_Init(), KSZ8851SNL_SPI_SetChipSelect(), and SPI_TFT_WriteRegister().
__STATIC_INLINE unsigned int GPIO_PinOutGet | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin | ||
) |
Get current setting for a pin in a GPIO port data out register.
[in] | port | The GPIO port to access. |
[in] | pin | The pin to get setting for. |
Definition at line 834 of file em_gpio.h.
References BUS_RegBitRead(), and GPIO.
__STATIC_INLINE void GPIO_PinOutSet | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin | ||
) |
Set a single pin in GPIO data out register to 1.
[in] | port | The GPIO port to access. |
[in] | pin | The pin to set. |
Definition at line 856 of file em_gpio.h.
References BUS_RegBitWrite(), and GPIO.
Referenced by BOARD_flashDeepPowerDown(), BOARD_ledSet(), BOARD_picGetFwRevision(), BSP_McuBoard_UsbStatusLedEnable(), ezradio_hal_AssertShutdown(), ezradio_hal_SetNsel(), GPIO_PinModeSet(), I2CSPM_Init(), KSZ8851SNL_SPI_SetChipSelect(), and SPI_TFT_WriteRegister().
__STATIC_INLINE void GPIO_PinOutToggle | ( | GPIO_Port_TypeDef | port, |
unsigned int | pin | ||
) |
Toggle a single pin in GPIO port data out register.
[in] | port | The GPIO port to access. |
[in] | pin | The pin to toggle. |
Definition at line 881 of file em_gpio.h.
References GPIO.
__STATIC_INLINE uint32_t GPIO_PortInGet | ( | GPIO_Port_TypeDef | port | ) |
Read the pad values for GPIO port.
[in] | port | The GPIO port to access. |
Definition at line 895 of file em_gpio.h.
References GPIO.
Referenced by BOARD_pushButtonGetState().
__STATIC_INLINE void GPIO_PortOutClear | ( | GPIO_Port_TypeDef | port, |
uint32_t | pins | ||
) |
Set bits in DOUT register for a port to 0.
[in] | port | The GPIO port to access. |
[in] | pins | Bit mask for bits to clear in DOUT register. |
Definition at line 917 of file em_gpio.h.
References BUS_RegMaskedClear(), and GPIO.
__STATIC_INLINE uint32_t GPIO_PortOutGet | ( | GPIO_Port_TypeDef | port | ) |
__STATIC_INLINE void GPIO_PortOutSet | ( | GPIO_Port_TypeDef | port, |
uint32_t | pins | ||
) |
Set bits GPIO data out register to 1.
[in] | port | The GPIO port to access. |
[in] | pins | Bit mask for bits to set to 1 in DOUT register. |
Definition at line 959 of file em_gpio.h.
References BUS_RegMaskedSet(), and GPIO.
__STATIC_INLINE void GPIO_PortOutSetVal | ( | GPIO_Port_TypeDef | port, |
uint32_t | val, | ||
uint32_t | mask | ||
) |
Set GPIO port data out register.
[in] | port | The GPIO port to access. |
[in] | val | Value to write to port data out register. |
[in] | mask | Mask indicating which bits to modify. |
Definition at line 987 of file em_gpio.h.
References GPIO.
__STATIC_INLINE void GPIO_PortOutToggle | ( | GPIO_Port_TypeDef | port, |
uint32_t | pins | ||
) |
Toggle pins in GPIO port data out register.
[in] | port | The GPIO port to access. |
[in] | pins | Bitmask with pins to toggle. |
Definition at line 1011 of file em_gpio.h.
References GPIO.