nRF5 SDK v12.1.0
Macros | Enumerations | Functions
GPIO abstraction

GPIO pin abstraction and port abstraction for reading and writing byte-wise to GPIO ports. More...

Macros

#define NUMBER_OF_PINS   32
 

Enumerations

enum  nrf_gpio_port_select_t {
  NRF_GPIO_PORT_SELECT_PORT0 = 0,
  NRF_GPIO_PORT_SELECT_PORT1,
  NRF_GPIO_PORT_SELECT_PORT2,
  NRF_GPIO_PORT_SELECT_PORT3
}
 Enumerator used for selecting between port 0 - 3. More...
 
enum  nrf_gpio_port_dir_t {
  NRF_GPIO_PORT_DIR_OUTPUT,
  NRF_GPIO_PORT_DIR_INPUT
}
 Enumerator used for setting the direction of a GPIO port. More...
 
enum  nrf_gpio_pin_dir_t {
  NRF_GPIO_PIN_DIR_INPUT = GPIO_PIN_CNF_DIR_Input,
  NRF_GPIO_PIN_DIR_OUTPUT = GPIO_PIN_CNF_DIR_Output
}
 Pin direction definitions. More...
 
enum  nrf_gpio_pin_input_t {
  NRF_GPIO_PIN_INPUT_CONNECT = GPIO_PIN_CNF_INPUT_Connect,
  NRF_GPIO_PIN_INPUT_DISCONNECT = GPIO_PIN_CNF_INPUT_Disconnect
}
 Connection of input buffer. More...
 
enum  nrf_gpio_pin_pull_t {
  NRF_GPIO_PIN_NOPULL = GPIO_PIN_CNF_PULL_Disabled,
  NRF_GPIO_PIN_PULLDOWN = GPIO_PIN_CNF_PULL_Pulldown,
  NRF_GPIO_PIN_PULLUP = GPIO_PIN_CNF_PULL_Pullup
}
 Enumerator used for selecting the pin to be pulled down or up at the time of pin configuration. More...
 
enum  nrf_gpio_pin_drive_t {
  NRF_GPIO_PIN_S0S1 = GPIO_PIN_CNF_DRIVE_S0S1,
  NRF_GPIO_PIN_H0S1 = GPIO_PIN_CNF_DRIVE_H0S1,
  NRF_GPIO_PIN_S0H1 = GPIO_PIN_CNF_DRIVE_S0H1,
  NRF_GPIO_PIN_H0H1 = GPIO_PIN_CNF_DRIVE_H0H1,
  NRF_GPIO_PIN_D0S1 = GPIO_PIN_CNF_DRIVE_D0S1,
  NRF_GPIO_PIN_D0H1 = GPIO_PIN_CNF_DRIVE_D0H1,
  NRF_GPIO_PIN_S0D1 = GPIO_PIN_CNF_DRIVE_S0D1,
  NRF_GPIO_PIN_H0D1 = GPIO_PIN_CNF_DRIVE_H0D1
}
 Enumerator used for selecting output drive mode. More...
 
enum  nrf_gpio_pin_sense_t {
  NRF_GPIO_PIN_NOSENSE = GPIO_PIN_CNF_SENSE_Disabled,
  NRF_GPIO_PIN_SENSE_LOW = GPIO_PIN_CNF_SENSE_Low,
  NRF_GPIO_PIN_SENSE_HIGH = GPIO_PIN_CNF_SENSE_High
}
 Enumerator used for selecting the pin to sense high or low level on the pin input. More...
 

Functions

__STATIC_INLINE void nrf_gpio_range_cfg_output (uint32_t pin_range_start, uint32_t pin_range_end)
 Function for configuring the GPIO pin range as outputs with normal drive strength. This function can be used to configure pin range as simple output with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases). More...
 
__STATIC_INLINE void nrf_gpio_range_cfg_input (uint32_t pin_range_start, uint32_t pin_range_end, nrf_gpio_pin_pull_t pull_config)
 Function for configuring the GPIO pin range as inputs with given initial value set, hiding inner details. This function can be used to configure pin range as simple input. More...
 
__STATIC_INLINE void nrf_gpio_cfg (uint32_t pin_number, nrf_gpio_pin_dir_t dir, nrf_gpio_pin_input_t input, nrf_gpio_pin_pull_t pull, nrf_gpio_pin_drive_t drive, nrf_gpio_pin_sense_t sense)
 Pin configuration function. More...
 
__STATIC_INLINE void nrf_gpio_cfg_output (uint32_t pin_number)
 Function for configuring the given GPIO pin number as output with given initial value set, hiding inner details. This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases). More...
 
__STATIC_INLINE void nrf_gpio_cfg_input (uint32_t pin_number, nrf_gpio_pin_pull_t pull_config)
 Function for configuring the given GPIO pin number as input with given initial value set, hiding inner details. This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases). More...
 
__STATIC_INLINE void nrf_gpio_cfg_default (uint32_t pin_number)
 Function for reseting pin configuration to its default state. More...
 
__STATIC_INLINE void nrf_gpio_cfg_watcher (uint32_t pin_number)
 Function for configuring the given GPIO pin number as a watcher. Only input is connected. More...
 
__STATIC_INLINE void nrf_gpio_input_disconnect (uint32_t pin_number)
 Function for disconnecting input for the given GPIO. More...
 
__STATIC_INLINE void nrf_gpio_cfg_sense_input (uint32_t pin_number, nrf_gpio_pin_pull_t pull_config, nrf_gpio_pin_sense_t sense_config)
 Function for configuring the given GPIO pin number as input with given initial value set, hiding inner details. This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases). Sense capability on the pin is configurable, and input is connected to buffer so that the GPIO->IN register is readable. More...
 
__STATIC_INLINE void nrf_gpio_cfg_sense_set (uint32_t pin_number, nrf_gpio_pin_sense_t sense_config)
 Function for configuring sense level for the given GPIO. More...
 
__STATIC_INLINE void nrf_gpio_pin_dir_set (uint32_t pin_number, nrf_gpio_pin_dir_t direction)
 Function for setting the direction for a GPIO pin. More...
 
__STATIC_INLINE void nrf_gpio_pin_set (uint32_t pin_number)
 Function for setting a GPIO pin. More...
 
__STATIC_INLINE void nrf_gpio_pins_set (uint32_t pin_mask)
 Function for setting GPIO pins. More...
 
__STATIC_INLINE void nrf_gpio_pin_clear (uint32_t pin_number)
 Function for clearing a GPIO pin. More...
 
__STATIC_INLINE void nrf_gpio_pins_clear (uint32_t pin_mask)
 Function for clearing GPIO pins. More...
 
__STATIC_INLINE void nrf_gpio_pin_toggle (uint32_t pin_number)
 Function for toggling a GPIO pin. More...
 
__STATIC_INLINE void nrf_gpio_pins_toggle (uint32_t pin_mask)
 Function for toggling GPIO pins. More...
 
__STATIC_INLINE void nrf_gpio_pin_write (uint32_t pin_number, uint32_t value)
 Function for writing a value to a GPIO pin. More...
 
__STATIC_INLINE uint32_t nrf_gpio_pin_read (uint32_t pin_number)
 Function for reading the input level of a GPIO pin. More...
 
__STATIC_INLINE uint32_t nrf_gpio_pins_read (void)
 Function for reading the input level of all GPIO pins. More...
 
__STATIC_INLINE
nrf_gpio_pin_sense_t 
nrf_gpio_pin_sense_get (uint32_t pin_number)
 Function for reading the sense configuration of a GPIO pin. More...
 
__STATIC_INLINE void nrf_gpio_word_byte_write (volatile uint32_t *word_address, uint8_t byte_no, uint8_t value)
 Generic function for writing a single byte of a 32 bit word at a given address. More...
 
__STATIC_INLINE uint8_t nrf_gpio_word_byte_read (const volatile uint32_t *word_address, uint8_t byte_no)
 Generic function for reading a single byte of a 32 bit word at a given address. More...
 
__STATIC_INLINE void nrf_gpio_port_dir_set (nrf_gpio_port_select_t port, nrf_gpio_port_dir_t dir)
 Function for setting the direction of a port. More...
 
__STATIC_INLINE uint8_t nrf_gpio_port_read (nrf_gpio_port_select_t port)
 Function for reading a GPIO port. More...
 
__STATIC_INLINE void nrf_gpio_port_write (nrf_gpio_port_select_t port, uint8_t value)
 Function for writing to a GPIO port. More...
 
__STATIC_INLINE void nrf_gpio_port_set (nrf_gpio_port_select_t port, uint8_t set_mask)
 Function for setting individual pins on GPIO port. More...
 
__STATIC_INLINE void nrf_gpio_port_clear (nrf_gpio_port_select_t port, uint8_t clr_mask)
 Function for clearing individual pins on GPIO port. More...
 

Detailed Description

GPIO pin abstraction and port abstraction for reading and writing byte-wise to GPIO ports.

Here, the GPIO ports are defined as follows:

Enumeration Type Documentation

Pin direction definitions.

Enumerator
NRF_GPIO_PIN_DIR_INPUT 

Input.

NRF_GPIO_PIN_DIR_OUTPUT 

Output.

Enumerator used for selecting output drive mode.

Enumerator
NRF_GPIO_PIN_S0S1 

!< Standard '0', standard '1'

NRF_GPIO_PIN_H0S1 

!< High drive '0', standard '1'

NRF_GPIO_PIN_S0H1 

!< Standard '0', high drive '1'

NRF_GPIO_PIN_H0H1 

!< High drive '0', high 'drive '1''

NRF_GPIO_PIN_D0S1 

!< Disconnect '0' standard '1'

NRF_GPIO_PIN_D0H1 

!< Disconnect '0', high drive '1'

NRF_GPIO_PIN_S0D1 

!< Standard '0'. disconnect '1'

NRF_GPIO_PIN_H0D1 

!< High drive '0', disconnect '1'

Connection of input buffer.

Enumerator
NRF_GPIO_PIN_INPUT_CONNECT 

Connect input buffer.

NRF_GPIO_PIN_INPUT_DISCONNECT 

Disconnect input buffer.

Enumerator used for selecting the pin to be pulled down or up at the time of pin configuration.

Enumerator
NRF_GPIO_PIN_NOPULL 

Pin pullup resistor disabled.

NRF_GPIO_PIN_PULLDOWN 

Pin pulldown resistor enabled.

NRF_GPIO_PIN_PULLUP 

Pin pullup resistor enabled.

Enumerator used for selecting the pin to sense high or low level on the pin input.

Enumerator
NRF_GPIO_PIN_NOSENSE 

Pin sense level disabled.

NRF_GPIO_PIN_SENSE_LOW 

Pin sense low level.

NRF_GPIO_PIN_SENSE_HIGH 

Pin sense high level.

Enumerator used for setting the direction of a GPIO port.

Enumerator
NRF_GPIO_PORT_DIR_OUTPUT 

Output.

NRF_GPIO_PORT_DIR_INPUT 

Input.

Enumerator used for selecting between port 0 - 3.

Enumerator
NRF_GPIO_PORT_SELECT_PORT0 

Port 0 (GPIO pin 0-7)

NRF_GPIO_PORT_SELECT_PORT1 

Port 1 (GPIO pin 8-15)

NRF_GPIO_PORT_SELECT_PORT2 

Port 2 (GPIO pin 16-23)

NRF_GPIO_PORT_SELECT_PORT3 

Port 3 (GPIO pin 24-31)

Function Documentation

__STATIC_INLINE void nrf_gpio_cfg ( uint32_t  pin_number,
nrf_gpio_pin_dir_t  dir,
nrf_gpio_pin_input_t  input,
nrf_gpio_pin_pull_t  pull,
nrf_gpio_pin_drive_t  drive,
nrf_gpio_pin_sense_t  sense 
)

Pin configuration function.

The main pin configuration function. This function allows to set any aspect in PIN_CNF register.

Parameters
pin_numberSpecifies the pin number (allowed values 0-31).
dirPin direction
inputConnect or disconnect input buffer
pullPull configuration
driveDrive configuration
sensePin sensing mechanism
__STATIC_INLINE void nrf_gpio_cfg_default ( uint32_t  pin_number)

Function for reseting pin configuration to its default state.

Parameters
pin_numberSpecifies the pin number (allowed values 0-31).
__STATIC_INLINE void nrf_gpio_cfg_input ( uint32_t  pin_number,
nrf_gpio_pin_pull_t  pull_config 
)

Function for configuring the given GPIO pin number as input with given initial value set, hiding inner details. This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases).

Parameters
pin_numberSpecifies the pin number (allowed values 0-30).
pull_configState of the pin range pull resistor (no pull, pulled down or pulled high).
Note
Sense capability on the pin is disabled, and input is connected to buffer so that the GPIO->IN register is readable
__STATIC_INLINE void nrf_gpio_cfg_output ( uint32_t  pin_number)

Function for configuring the given GPIO pin number as output with given initial value set, hiding inner details. This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases).

Parameters
pin_numberspecifies the pin number (allowed values 0-31)
Note
Sense capability on the pin is disabled, and input is disconnected from the buffer as the pins are configured as output.
__STATIC_INLINE void nrf_gpio_cfg_sense_input ( uint32_t  pin_number,
nrf_gpio_pin_pull_t  pull_config,
nrf_gpio_pin_sense_t  sense_config 
)

Function for configuring the given GPIO pin number as input with given initial value set, hiding inner details. This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases). Sense capability on the pin is configurable, and input is connected to buffer so that the GPIO->IN register is readable.

Parameters
pin_numberSpecifies the pin number (allowed values 0-30).
pull_configState of the pin pull resistor (no pull, pulled down or pulled high).
sense_configSense level of the pin (no sense, sense low or sense high).
__STATIC_INLINE void nrf_gpio_cfg_sense_set ( uint32_t  pin_number,
nrf_gpio_pin_sense_t  sense_config 
)

Function for configuring sense level for the given GPIO.

Parameters
pin_numberSpecifies the pin number of gpio pin numbers to be configured (allowed values 0-30).
sense_configSense configuration.
__STATIC_INLINE void nrf_gpio_cfg_watcher ( uint32_t  pin_number)

Function for configuring the given GPIO pin number as a watcher. Only input is connected.

Parameters
pin_numberSpecifies the pin number (allowed values 0-31).
__STATIC_INLINE void nrf_gpio_input_disconnect ( uint32_t  pin_number)

Function for disconnecting input for the given GPIO.

Parameters
pin_numberSpecifies the pin number (allowed values 0-31).
__STATIC_INLINE void nrf_gpio_pin_clear ( uint32_t  pin_number)

Function for clearing a GPIO pin.

Note that the pin must be configured as an output for this function to have any effect.

Parameters
pin_numberSpecifies the pin number (0-31) to clear.
__STATIC_INLINE void nrf_gpio_pin_dir_set ( uint32_t  pin_number,
nrf_gpio_pin_dir_t  direction 
)

Function for setting the direction for a GPIO pin.

Parameters
pin_numberspecifies the pin number (0-31) for which to set the direction.
directionspecifies the direction
__STATIC_INLINE uint32_t nrf_gpio_pin_read ( uint32_t  pin_number)

Function for reading the input level of a GPIO pin.

Note that the pin must have input connected for the value returned from this function to be valid.

Parameters
pin_numberspecifies the pin number (0-31) to read.
Returns
Return values
0if the pin input level is low.
1if the pin input level is high.
>1 should never occur.
__STATIC_INLINE nrf_gpio_pin_sense_t nrf_gpio_pin_sense_get ( uint32_t  pin_number)

Function for reading the sense configuration of a GPIO pin.

Parameters
pin_numberspecifies the pin number (0-31) to read.
Return values
Senseconfiguration
__STATIC_INLINE void nrf_gpio_pin_set ( uint32_t  pin_number)

Function for setting a GPIO pin.

Note that the pin must be configured as an output for this function to have any effect.

Parameters
pin_numberSpecifies the pin number (0-31) to set.
__STATIC_INLINE void nrf_gpio_pin_toggle ( uint32_t  pin_number)

Function for toggling a GPIO pin.

Note that the pin must be configured as an output for this function to have any effect.

Parameters
pin_numberSpecifies the pin number (0-31) to toggle.
__STATIC_INLINE void nrf_gpio_pin_write ( uint32_t  pin_number,
uint32_t  value 
)

Function for writing a value to a GPIO pin.

Note that the pin must be configured as an output for this function to have any effect.

Parameters
pin_numberspecifies the pin number (0-31) to write.
valuespecifies the value to be written to the pin.
  • 0 clears the pin
  • >=1 sets the pin.
__STATIC_INLINE void nrf_gpio_pins_clear ( uint32_t  pin_mask)

Function for clearing GPIO pins.

Note that the pins must be configured as outputs for this function to have any effect.

Parameters
pin_maskSpecifies the pins to clear.
__STATIC_INLINE uint32_t nrf_gpio_pins_read ( void  )

Function for reading the input level of all GPIO pins.

Note that the pin must have input connected for the value returned from this function to be valid.

Return values
Statusof input of all pins
__STATIC_INLINE void nrf_gpio_pins_set ( uint32_t  pin_mask)

Function for setting GPIO pins.

Note that the pins must be configured as outputs for this function to have any effect.

Parameters
pin_maskSpecifies the pins to set.
__STATIC_INLINE void nrf_gpio_pins_toggle ( uint32_t  pin_mask)

Function for toggling GPIO pins.

Note that the pins must be configured as outputs for this function to have any effect.

Parameters
pin_maskSpecifies the pins to toggle.
__STATIC_INLINE void nrf_gpio_port_clear ( nrf_gpio_port_select_t  port,
uint8_t  clr_mask 
)

Function for clearing individual pins on GPIO port.

Parameters
portis the port for which to clear the pins.
clr_maskis a mask specifying which pins to clear. A bit set to 1 indicates that the corresponding port pin shall be cleared.
See Also
nrf_gpio_port_dir_set()
__STATIC_INLINE void nrf_gpio_port_dir_set ( nrf_gpio_port_select_t  port,
nrf_gpio_port_dir_t  dir 
)

Function for setting the direction of a port.

Parameters
portis the port for which to set the direction.
dirdirection to be set for this port.
__STATIC_INLINE uint8_t nrf_gpio_port_read ( nrf_gpio_port_select_t  port)

Function for reading a GPIO port.

Parameters
portis the port to read.
Returns
the input value on this port.
__STATIC_INLINE void nrf_gpio_port_set ( nrf_gpio_port_select_t  port,
uint8_t  set_mask 
)

Function for setting individual pins on GPIO port.

Parameters
portis the port for which to set the pins.
set_maskis a mask specifying which pins to set. A bit set to 1 indicates that the corresponding port pin shall be set.
See Also
nrf_gpio_port_dir_set()
__STATIC_INLINE void nrf_gpio_port_write ( nrf_gpio_port_select_t  port,
uint8_t  value 
)

Function for writing to a GPIO port.

Parameters
portis the port to write.
valueis the value to write to this port.
See Also
nrf_gpio_port_dir_set()
__STATIC_INLINE void nrf_gpio_range_cfg_input ( uint32_t  pin_range_start,
uint32_t  pin_range_end,
nrf_gpio_pin_pull_t  pull_config 
)

Function for configuring the GPIO pin range as inputs with given initial value set, hiding inner details. This function can be used to configure pin range as simple input.

Parameters
pin_range_startspecifies the start number (inclusive) in the range of pin numbers to be configured (allowed values 0-30)
pin_range_endspecifies the end number (inclusive) in the range of pin numbers to be configured (allowed values 0-30)
pull_configState of the pin range pull resistor (no pull, pulled down or pulled high)
Note
For configuring only one pin as input use nrf_gpio_cfg_input Sense capability on the pin is disabled, and input is connected to buffer so that the GPIO->IN register is readable
__STATIC_INLINE void nrf_gpio_range_cfg_output ( uint32_t  pin_range_start,
uint32_t  pin_range_end 
)

Function for configuring the GPIO pin range as outputs with normal drive strength. This function can be used to configure pin range as simple output with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases).

Parameters
pin_range_startspecifies the start number (inclusive) in the range of pin numbers to be configured (allowed values 0-30)
pin_range_endspecifies the end number (inclusive) in the range of pin numbers to be configured (allowed values 0-30)
Note
For configuring only one pin as output use nrf_gpio_cfg_output Sense capability on the pin is disabled, and input is disconnected from the buffer as the pins are configured as output.
__STATIC_INLINE uint8_t nrf_gpio_word_byte_read ( const volatile uint32_t *  word_address,
uint8_t  byte_no 
)

Generic function for reading a single byte of a 32 bit word at a given address.

This function should not be called from outside the nrf_gpio abstraction layer.

Parameters
word_addressis the address of the word to be read.
byte_nois the byte number (0-3) of the word to be read.
Returns
byte "byte_no" of word at address "word_address".
__STATIC_INLINE void nrf_gpio_word_byte_write ( volatile uint32_t *  word_address,
uint8_t  byte_no,
uint8_t  value 
)

Generic function for writing a single byte of a 32 bit word at a given address.

This function should not be called from outside the nrf_gpio abstraction layer.

Parameters
word_addressis the address of the word to be written.
byte_nois the word byte number (0-3) to be written.
valueis the value to be written to byte "byte_no" of word at address "word_address"

Documentation feedback | Developer Zone | Subscribe | Updated