nRF51 SDK - S120 SoftDevice
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
GPIO abstraction

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

Enumerations

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,
  NRF_GPIO_PIN_DIR_OUTPUT
}
 
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_pin_pull_t {
  NRF_GPIO_PIN_NOPULL = (0x00UL),
  NRF_GPIO_PIN_PULLDOWN = (0x01UL),
  NRF_GPIO_PIN_PULLUP = (0x03UL)
}
 Enumerator used for selecting the pin to be pulled down or up at the time of pin configuration. More...
 
enum  nrf_gpio_pin_sense_t {
  NRF_GPIO_PIN_NOSENSE = (0x00UL),
  NRF_GPIO_PIN_SENSE_LOW = (0x03UL),
  NRF_GPIO_PIN_SENSE_HIGH = (0x02UL)
}
 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_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_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_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_pin_clear (uint32_t pin_number)
 Function for clearing a GPIO pin. More...
 
static __INLINE void nrf_gpio_pin_toggle (uint32_t pin_number)
 Function for toggling a GPIO pin. 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 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 the pin to be pulled down or up at the time of pin configuration.

Enumerator
NRF_GPIO_PIN_NOPULL 

Pin pullup resistor disabled.

No pull.

NRF_GPIO_PIN_PULLDOWN 

Pin pulldown resistor enabled.

Pulldown on pin.

NRF_GPIO_PIN_PULLUP 

Pin pullup resistor enabled.

Pullup on pin.

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.

Disabled.

NRF_GPIO_PIN_SENSE_LOW 

Pin sense low level.

Wakeup on low level.

NRF_GPIO_PIN_SENSE_HIGH 

Pin sense high level.

Wakeup on 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_input ( uint32_t  pin_number,
nrf_gpio_pin_pull_t  pull_config 
)
static

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 of gpio 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
Sense capability on the pin is disabled, and input is connected to buffer so that the GPIO->IN register is readable

< Disabled.

< Position of SENSE field.

< Standard '0', Standard '1'.

< Position of DRIVE field.

< Position of PULL field.

< Connect input pin.

< Position of INPUT field.

< Configure pin as an input pin.

< Position of DIR field.

static __INLINE void nrf_gpio_cfg_output ( uint32_t  pin_number)
static

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 of gpio pin numbers to be configured (allowed values 0-30)
Note
Sense capability on the pin is disabled, and input is disconnected from the buffer as the pins are configured as output.

< Disabled.

< Position of SENSE field.

< Standard '0', Standard '1'.

< Position of DRIVE field.

< No pull.

< Position of PULL field.

< Disconnect input pin.

< Position of INPUT field.

< Configure pin as an output pin.

< Position of DIR field.

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 
)
static

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 of gpio pin numbers to be configured (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).

< Position of SENSE field.

< Standard '0', Standard '1'.

< Position of DRIVE field.

< Position of PULL field.

< Connect input pin.

< Position of INPUT field.

< Configure pin as an input pin.

< Position of DIR field.

static __INLINE void nrf_gpio_pin_clear ( uint32_t  pin_number)
static

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 
)
static

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

< Disabled.

< Position of SENSE field.

< Standard '0', Standard '1'.

< Position of DRIVE field.

< No pull.

< Position of PULL field.

< Connect input pin.

< Position of INPUT field.

< Configure pin as an input pin.

< Position of DIR field.

static __INLINE uint32_t nrf_gpio_pin_read ( uint32_t  pin_number)
static

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 void nrf_gpio_pin_set ( uint32_t  pin_number)
static

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)
static

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 
)
static

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_port_clear ( nrf_gpio_port_select_t  port,
uint8_t  clr_mask 
)
static

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 
)
static

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)
static

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 
)
static

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 
)
static

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 
)
static

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

< Disabled.

< Position of SENSE field.

< Standard '0', Standard '1'.

< Position of DRIVE field.

< Position of PULL field.

< Connect input pin.

< Position of INPUT field.

< Configure pin as an input pin.

< Position of DIR field.

static __INLINE void nrf_gpio_range_cfg_output ( uint32_t  pin_range_start,
uint32_t  pin_range_end 
)
static

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.

< Disabled.

< Position of SENSE field.

< Standard '0', Standard '1'.

< Position of DRIVE field.

< No pull.

< Position of PULL field.

< Disconnect input pin.

< Position of INPUT field.

< Configure pin as an output pin.

< Position of DIR field.

static __INLINE uint8_t nrf_gpio_word_byte_read ( const volatile uint32_t *  word_address,
uint8_t  byte_no 
)
static

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 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 
)
static

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 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"