/ 11111

1

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/drivers_nrf/hal/nrf_gpio.h@345:dfde56236c36, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:55:35 2015 +0100
Revision:
345:dfde56236c36
Parent:
343:6675661fa600
Child:
346:14b090482fd2
Synchronized with git rev fbfc6d16

Author: Andrew Fernandes

Fix various GCC compilation issues.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 345:dfde56236c36 1 #ifndef NRF_GPIO_H__
rgrover1 345:dfde56236c36 2 #define NRF_GPIO_H__
rgrover1 345:dfde56236c36 3
rgrover1 345:dfde56236c36 4 #include "nrf51.h"
rgrover1 345:dfde56236c36 5 #include "nrf51_bitfields.h"
rgrover1 345:dfde56236c36 6
rgrover1 345:dfde56236c36 7 /**
rgrover1 345:dfde56236c36 8 * @defgroup nrf_gpio GPIO abstraction
rgrover1 345:dfde56236c36 9 * @{
rgrover1 345:dfde56236c36 10 * @ingroup nrf_drivers
rgrover1 345:dfde56236c36 11 * @brief GPIO pin abstraction and port abstraction for reading and writing byte-wise to GPIO ports.
rgrover1 345:dfde56236c36 12 *
rgrover1 345:dfde56236c36 13 * Here, the GPIO ports are defined as follows:
rgrover1 345:dfde56236c36 14 * - Port 0 -> pin 0-7
rgrover1 345:dfde56236c36 15 * - Port 1 -> pin 8-15
rgrover1 345:dfde56236c36 16 * - Port 2 -> pin 16-23
rgrover1 345:dfde56236c36 17 * - Port 3 -> pin 24-31
rgrover1 345:dfde56236c36 18 */
rgrover1 345:dfde56236c36 19
rgrover1 345:dfde56236c36 20 /**
rgrover1 345:dfde56236c36 21 * @enum nrf_gpio_port_dir_t
rgrover1 345:dfde56236c36 22 * @brief Enumerator used for setting the direction of a GPIO port.
rgrover1 345:dfde56236c36 23 */
rgrover1 345:dfde56236c36 24 typedef enum
rgrover1 345:dfde56236c36 25 {
rgrover1 345:dfde56236c36 26 NRF_GPIO_PORT_DIR_OUTPUT, ///< Output
rgrover1 345:dfde56236c36 27 NRF_GPIO_PORT_DIR_INPUT ///< Input
rgrover1 345:dfde56236c36 28 } nrf_gpio_port_dir_t;
rgrover1 345:dfde56236c36 29
rgrover1 345:dfde56236c36 30 /**
rgrover1 345:dfde56236c36 31 * @enum nrf_gpio_pin_dir_t
rgrover1 345:dfde56236c36 32 * Pin direction definitions.
rgrover1 345:dfde56236c36 33 */
rgrover1 345:dfde56236c36 34 typedef enum
rgrover1 345:dfde56236c36 35 {
rgrover1 345:dfde56236c36 36 NRF_GPIO_PIN_DIR_INPUT, ///< Input
rgrover1 345:dfde56236c36 37 NRF_GPIO_PIN_DIR_OUTPUT ///< Output
rgrover1 345:dfde56236c36 38 } nrf_gpio_pin_dir_t;
rgrover1 345:dfde56236c36 39
rgrover1 345:dfde56236c36 40 /**
rgrover1 345:dfde56236c36 41 * @enum nrf_gpio_port_select_t
rgrover1 345:dfde56236c36 42 * @brief Enumerator used for selecting between port 0 - 3.
rgrover1 345:dfde56236c36 43 */
rgrover1 345:dfde56236c36 44 typedef enum
rgrover1 345:dfde56236c36 45 {
rgrover1 345:dfde56236c36 46 NRF_GPIO_PORT_SELECT_PORT0 = 0, ///< Port 0 (GPIO pin 0-7)
rgrover1 345:dfde56236c36 47 NRF_GPIO_PORT_SELECT_PORT1, ///< Port 1 (GPIO pin 8-15)
rgrover1 345:dfde56236c36 48 NRF_GPIO_PORT_SELECT_PORT2, ///< Port 2 (GPIO pin 16-23)
rgrover1 345:dfde56236c36 49 NRF_GPIO_PORT_SELECT_PORT3, ///< Port 3 (GPIO pin 24-31)
rgrover1 345:dfde56236c36 50 } nrf_gpio_port_select_t;
rgrover1 345:dfde56236c36 51
rgrover1 345:dfde56236c36 52 /**
rgrover1 345:dfde56236c36 53 * @enum nrf_gpio_pin_pull_t
rgrover1 345:dfde56236c36 54 * @brief Enumerator used for selecting the pin to be pulled down or up at the time of pin configuration
rgrover1 345:dfde56236c36 55 */
rgrover1 345:dfde56236c36 56 typedef enum
rgrover1 345:dfde56236c36 57 {
rgrover1 345:dfde56236c36 58 NRF_GPIO_PIN_NOPULL = GPIO_PIN_CNF_PULL_Disabled, ///< Pin pullup resistor disabled
rgrover1 345:dfde56236c36 59 NRF_GPIO_PIN_PULLDOWN = GPIO_PIN_CNF_PULL_Pulldown, ///< Pin pulldown resistor enabled
rgrover1 345:dfde56236c36 60 NRF_GPIO_PIN_PULLUP = GPIO_PIN_CNF_PULL_Pullup, ///< Pin pullup resistor enabled
rgrover1 345:dfde56236c36 61 } nrf_gpio_pin_pull_t;
rgrover1 345:dfde56236c36 62
rgrover1 345:dfde56236c36 63 /**
rgrover1 345:dfde56236c36 64 * @enum nrf_gpio_pin_sense_t
rgrover1 345:dfde56236c36 65 * @brief Enumerator used for selecting the pin to sense high or low level on the pin input.
rgrover1 345:dfde56236c36 66 */
rgrover1 345:dfde56236c36 67 typedef enum
rgrover1 345:dfde56236c36 68 {
rgrover1 345:dfde56236c36 69 NRF_GPIO_PIN_NOSENSE = GPIO_PIN_CNF_SENSE_Disabled, ///< Pin sense level disabled.
rgrover1 345:dfde56236c36 70 NRF_GPIO_PIN_SENSE_LOW = GPIO_PIN_CNF_SENSE_Low, ///< Pin sense low level.
rgrover1 345:dfde56236c36 71 NRF_GPIO_PIN_SENSE_HIGH = GPIO_PIN_CNF_SENSE_High, ///< Pin sense high level.
rgrover1 345:dfde56236c36 72 } nrf_gpio_pin_sense_t;
rgrover1 345:dfde56236c36 73
rgrover1 345:dfde56236c36 74 /**
rgrover1 345:dfde56236c36 75 * @brief Function for configuring the GPIO pin range as outputs with normal drive strength.
rgrover1 345:dfde56236c36 76 * This function can be used to configure pin range as simple output with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases).
rgrover1 345:dfde56236c36 77 *
rgrover1 345:dfde56236c36 78 * @param pin_range_start specifies the start number (inclusive) in the range of pin numbers to be configured (allowed values 0-30)
rgrover1 345:dfde56236c36 79 *
rgrover1 345:dfde56236c36 80 * @param pin_range_end specifies the end number (inclusive) in the range of pin numbers to be configured (allowed values 0-30)
rgrover1 345:dfde56236c36 81 *
rgrover1 345:dfde56236c36 82 * @note For configuring only one pin as output use @ref nrf_gpio_cfg_output
rgrover1 345:dfde56236c36 83 * Sense capability on the pin is disabled, and input is disconnected from the buffer as the pins are configured as output.
rgrover1 345:dfde56236c36 84 */
rgrover1 345:dfde56236c36 85 static __INLINE void nrf_gpio_range_cfg_output(uint32_t pin_range_start, uint32_t pin_range_end)
rgrover1 345:dfde56236c36 86 {
rgrover1 345:dfde56236c36 87 /*lint -e{845} // A zero has been given as right argument to operator '|'" */
rgrover1 345:dfde56236c36 88 for (; pin_range_start <= pin_range_end; pin_range_start++)
rgrover1 345:dfde56236c36 89 {
rgrover1 345:dfde56236c36 90 NRF_GPIO->PIN_CNF[pin_range_start] = (GPIO_PIN_CNF_SENSE_Disabled << GPIO_PIN_CNF_SENSE_Pos)
rgrover1 345:dfde56236c36 91 | (GPIO_PIN_CNF_DRIVE_S0S1 << GPIO_PIN_CNF_DRIVE_Pos)
rgrover1 345:dfde56236c36 92 | (GPIO_PIN_CNF_PULL_Disabled << GPIO_PIN_CNF_PULL_Pos)
rgrover1 345:dfde56236c36 93 | (GPIO_PIN_CNF_INPUT_Disconnect << GPIO_PIN_CNF_INPUT_Pos)
rgrover1 345:dfde56236c36 94 | (GPIO_PIN_CNF_DIR_Output << GPIO_PIN_CNF_DIR_Pos);
rgrover1 345:dfde56236c36 95 }
rgrover1 345:dfde56236c36 96 }
rgrover1 345:dfde56236c36 97
rgrover1 345:dfde56236c36 98 /**
rgrover1 345:dfde56236c36 99 * @brief Function for configuring the GPIO pin range as inputs with given initial value set, hiding inner details.
rgrover1 345:dfde56236c36 100 * This function can be used to configure pin range as simple input.
rgrover1 345:dfde56236c36 101 *
rgrover1 345:dfde56236c36 102 * @param pin_range_start specifies the start number (inclusive) in the range of pin numbers to be configured (allowed values 0-30)
rgrover1 345:dfde56236c36 103 *
rgrover1 345:dfde56236c36 104 * @param pin_range_end specifies the end number (inclusive) in the range of pin numbers to be configured (allowed values 0-30)
rgrover1 345:dfde56236c36 105 *
rgrover1 345:dfde56236c36 106 * @param pull_config State of the pin range pull resistor (no pull, pulled down or pulled high)
rgrover1 345:dfde56236c36 107 *
rgrover1 345:dfde56236c36 108 * @note For configuring only one pin as input use @ref nrf_gpio_cfg_input
rgrover1 345:dfde56236c36 109 * Sense capability on the pin is disabled, and input is connected to buffer so that the GPIO->IN register is readable
rgrover1 345:dfde56236c36 110 */
rgrover1 345:dfde56236c36 111 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)
rgrover1 345:dfde56236c36 112 {
rgrover1 345:dfde56236c36 113 /*lint -e{845} // A zero has been given as right argument to operator '|'" */
rgrover1 345:dfde56236c36 114 for (; pin_range_start <= pin_range_end; pin_range_start++)
rgrover1 345:dfde56236c36 115 {
rgrover1 345:dfde56236c36 116 NRF_GPIO->PIN_CNF[pin_range_start] = (GPIO_PIN_CNF_SENSE_Disabled << GPIO_PIN_CNF_SENSE_Pos)
rgrover1 345:dfde56236c36 117 | (GPIO_PIN_CNF_DRIVE_S0S1 << GPIO_PIN_CNF_DRIVE_Pos)
rgrover1 345:dfde56236c36 118 | (pull_config << GPIO_PIN_CNF_PULL_Pos)
rgrover1 345:dfde56236c36 119 | (GPIO_PIN_CNF_INPUT_Connect << GPIO_PIN_CNF_INPUT_Pos)
rgrover1 345:dfde56236c36 120 | (GPIO_PIN_CNF_DIR_Input << GPIO_PIN_CNF_DIR_Pos);
rgrover1 345:dfde56236c36 121 }
rgrover1 345:dfde56236c36 122 }
rgrover1 345:dfde56236c36 123
rgrover1 345:dfde56236c36 124 /**
rgrover1 345:dfde56236c36 125 * @brief Function for configuring the given GPIO pin number as output with given initial value set, hiding inner details.
rgrover1 345:dfde56236c36 126 * This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases).
rgrover1 345:dfde56236c36 127 *
rgrover1 345:dfde56236c36 128 * @param pin_number specifies the pin number of gpio pin numbers to be configured (allowed values 0-30)
rgrover1 345:dfde56236c36 129 *
rgrover1 345:dfde56236c36 130 * @note Sense capability on the pin is disabled, and input is disconnected from the buffer as the pins are configured as output.
rgrover1 345:dfde56236c36 131 */
rgrover1 345:dfde56236c36 132 static __INLINE void nrf_gpio_cfg_output(uint32_t pin_number)
rgrover1 345:dfde56236c36 133 {
rgrover1 345:dfde56236c36 134 /*lint -e{845} // A zero has been given as right argument to operator '|'" */
rgrover1 345:dfde56236c36 135 NRF_GPIO->PIN_CNF[pin_number] = (GPIO_PIN_CNF_SENSE_Disabled << GPIO_PIN_CNF_SENSE_Pos)
rgrover1 345:dfde56236c36 136 | (GPIO_PIN_CNF_DRIVE_S0S1 << GPIO_PIN_CNF_DRIVE_Pos)
rgrover1 345:dfde56236c36 137 | (GPIO_PIN_CNF_PULL_Disabled << GPIO_PIN_CNF_PULL_Pos)
rgrover1 345:dfde56236c36 138 | (GPIO_PIN_CNF_INPUT_Disconnect << GPIO_PIN_CNF_INPUT_Pos)
rgrover1 345:dfde56236c36 139 | (GPIO_PIN_CNF_DIR_Output << GPIO_PIN_CNF_DIR_Pos);
rgrover1 345:dfde56236c36 140 }
rgrover1 345:dfde56236c36 141
rgrover1 345:dfde56236c36 142 /**
rgrover1 345:dfde56236c36 143 * @brief Function for configuring the given GPIO pin number as input with given initial value set, hiding inner details.
rgrover1 345:dfde56236c36 144 * This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases).
rgrover1 345:dfde56236c36 145 *
rgrover1 345:dfde56236c36 146 * @param pin_number specifies the pin number of gpio pin numbers to be configured (allowed values 0-30)
rgrover1 345:dfde56236c36 147 *
rgrover1 345:dfde56236c36 148 * @param pull_config State of the pin range pull resistor (no pull, pulled down or pulled high)
rgrover1 345:dfde56236c36 149 *
rgrover1 345:dfde56236c36 150 * @note Sense capability on the pin is disabled, and input is connected to buffer so that the GPIO->IN register is readable
rgrover1 345:dfde56236c36 151 */
rgrover1 345:dfde56236c36 152 static __INLINE void nrf_gpio_cfg_input(uint32_t pin_number, nrf_gpio_pin_pull_t pull_config)
rgrover1 345:dfde56236c36 153 {
rgrover1 345:dfde56236c36 154 /*lint -e{845} // A zero has been given as right argument to operator '|'" */
rgrover1 345:dfde56236c36 155 NRF_GPIO->PIN_CNF[pin_number] = (GPIO_PIN_CNF_SENSE_Disabled << GPIO_PIN_CNF_SENSE_Pos)
rgrover1 345:dfde56236c36 156 | (GPIO_PIN_CNF_DRIVE_S0S1 << GPIO_PIN_CNF_DRIVE_Pos)
rgrover1 345:dfde56236c36 157 | (pull_config << GPIO_PIN_CNF_PULL_Pos)
rgrover1 345:dfde56236c36 158 | (GPIO_PIN_CNF_INPUT_Connect << GPIO_PIN_CNF_INPUT_Pos)
rgrover1 345:dfde56236c36 159 | (GPIO_PIN_CNF_DIR_Input << GPIO_PIN_CNF_DIR_Pos);
rgrover1 345:dfde56236c36 160 }
rgrover1 345:dfde56236c36 161
rgrover1 345:dfde56236c36 162 /**
rgrover1 345:dfde56236c36 163 * @brief Function for configuring the given GPIO pin number as input with given initial value set, hiding inner details.
rgrover1 345:dfde56236c36 164 * This function can be used to configure pin range as simple input with gate driving GPIO_PIN_CNF_DRIVE_S0S1 (normal cases).
rgrover1 345:dfde56236c36 165 * Sense capability on the pin is configurable, and input is connected to buffer so that the GPIO->IN register is readable.
rgrover1 345:dfde56236c36 166 *
rgrover1 345:dfde56236c36 167 * @param pin_number specifies the pin number of gpio pin numbers to be configured (allowed values 0-30).
rgrover1 345:dfde56236c36 168 *
rgrover1 345:dfde56236c36 169 * @param pull_config state of the pin pull resistor (no pull, pulled down or pulled high).
rgrover1 345:dfde56236c36 170 *
rgrover1 345:dfde56236c36 171 * @param sense_config sense level of the pin (no sense, sense low or sense high).
rgrover1 345:dfde56236c36 172 */
rgrover1 345:dfde56236c36 173 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)
rgrover1 345:dfde56236c36 174 {
rgrover1 345:dfde56236c36 175 /*lint -e{845} // A zero has been given as right argument to operator '|'" */
rgrover1 345:dfde56236c36 176 NRF_GPIO->PIN_CNF[pin_number] = (sense_config << GPIO_PIN_CNF_SENSE_Pos)
rgrover1 345:dfde56236c36 177 | (GPIO_PIN_CNF_DRIVE_S0S1 << GPIO_PIN_CNF_DRIVE_Pos)
rgrover1 345:dfde56236c36 178 | (pull_config << GPIO_PIN_CNF_PULL_Pos)
rgrover1 345:dfde56236c36 179 | (GPIO_PIN_CNF_INPUT_Connect << GPIO_PIN_CNF_INPUT_Pos)
rgrover1 345:dfde56236c36 180 | (GPIO_PIN_CNF_DIR_Input << GPIO_PIN_CNF_DIR_Pos);
rgrover1 345:dfde56236c36 181 }
rgrover1 345:dfde56236c36 182
rgrover1 345:dfde56236c36 183 /**
rgrover1 345:dfde56236c36 184 * @brief Function for setting the direction for a GPIO pin.
rgrover1 345:dfde56236c36 185 *
rgrover1 345:dfde56236c36 186 * @param pin_number specifies the pin number [0:31] for which to
rgrover1 345:dfde56236c36 187 * set the direction.
rgrover1 345:dfde56236c36 188 *
rgrover1 345:dfde56236c36 189 * @param direction specifies the direction
rgrover1 345:dfde56236c36 190 */
rgrover1 345:dfde56236c36 191 static __INLINE void nrf_gpio_pin_dir_set(uint32_t pin_number, nrf_gpio_pin_dir_t direction)
rgrover1 345:dfde56236c36 192 {
rgrover1 345:dfde56236c36 193 if(direction == NRF_GPIO_PIN_DIR_INPUT)
rgrover1 345:dfde56236c36 194 {
rgrover1 345:dfde56236c36 195 NRF_GPIO->PIN_CNF[pin_number] =
rgrover1 345:dfde56236c36 196 (GPIO_PIN_CNF_SENSE_Disabled << GPIO_PIN_CNF_SENSE_Pos)
rgrover1 345:dfde56236c36 197 | (GPIO_PIN_CNF_DRIVE_S0S1 << GPIO_PIN_CNF_DRIVE_Pos)
rgrover1 345:dfde56236c36 198 | (GPIO_PIN_CNF_PULL_Disabled << GPIO_PIN_CNF_PULL_Pos)
rgrover1 345:dfde56236c36 199 | (GPIO_PIN_CNF_INPUT_Connect << GPIO_PIN_CNF_INPUT_Pos)
rgrover1 345:dfde56236c36 200 | (GPIO_PIN_CNF_DIR_Input << GPIO_PIN_CNF_DIR_Pos);
rgrover1 345:dfde56236c36 201 }
rgrover1 345:dfde56236c36 202 else
rgrover1 345:dfde56236c36 203 {
rgrover1 345:dfde56236c36 204 NRF_GPIO->DIRSET = (1UL << pin_number);
rgrover1 345:dfde56236c36 205 }
rgrover1 345:dfde56236c36 206 }
rgrover1 345:dfde56236c36 207
rgrover1 345:dfde56236c36 208 /**
rgrover1 345:dfde56236c36 209 * @brief Function for setting a GPIO pin.
rgrover1 345:dfde56236c36 210 *
rgrover1 345:dfde56236c36 211 * Note that the pin must be configured as an output for this
rgrover1 345:dfde56236c36 212 * function to have any effect.
rgrover1 345:dfde56236c36 213 *
rgrover1 345:dfde56236c36 214 * @param pin_number specifies the pin number [0:31] to
rgrover1 345:dfde56236c36 215 * set.
rgrover1 345:dfde56236c36 216 */
rgrover1 345:dfde56236c36 217 static __INLINE void nrf_gpio_pin_set(uint32_t pin_number)
rgrover1 345:dfde56236c36 218 {
rgrover1 345:dfde56236c36 219 NRF_GPIO->OUTSET = (1UL << pin_number);
rgrover1 345:dfde56236c36 220 }
rgrover1 345:dfde56236c36 221
rgrover1 345:dfde56236c36 222 /**
rgrover1 345:dfde56236c36 223 * @brief Function for clearing a GPIO pin.
rgrover1 345:dfde56236c36 224 *
rgrover1 345:dfde56236c36 225 * Note that the pin must be configured as an output for this
rgrover1 345:dfde56236c36 226 * function to have any effect.
rgrover1 345:dfde56236c36 227 *
rgrover1 345:dfde56236c36 228 * @param pin_number specifies the pin number [0:31] to
rgrover1 345:dfde56236c36 229 * clear.
rgrover1 345:dfde56236c36 230 */
rgrover1 345:dfde56236c36 231 static __INLINE void nrf_gpio_pin_clear(uint32_t pin_number)
rgrover1 345:dfde56236c36 232 {
rgrover1 345:dfde56236c36 233 NRF_GPIO->OUTCLR = (1UL << pin_number);
rgrover1 345:dfde56236c36 234 }
rgrover1 345:dfde56236c36 235
rgrover1 345:dfde56236c36 236 /**
rgrover1 345:dfde56236c36 237 * @brief Function for toggling a GPIO pin.
rgrover1 345:dfde56236c36 238 *
rgrover1 345:dfde56236c36 239 * Note that the pin must be configured as an output for this
rgrover1 345:dfde56236c36 240 * function to have any effect.
rgrover1 345:dfde56236c36 241 *
rgrover1 345:dfde56236c36 242 * @param pin_number specifies the pin number [0:31] to
rgrover1 345:dfde56236c36 243 * toggle.
rgrover1 345:dfde56236c36 244 */
rgrover1 345:dfde56236c36 245 static __INLINE void nrf_gpio_pin_toggle(uint32_t pin_number)
rgrover1 345:dfde56236c36 246 {
rgrover1 345:dfde56236c36 247 const uint32_t pin_bit = 1UL << pin_number;
rgrover1 345:dfde56236c36 248 const uint32_t pin_state = ((NRF_GPIO->OUT >> pin_number) & 1UL);
rgrover1 345:dfde56236c36 249
rgrover1 345:dfde56236c36 250 if (pin_state == 0)
rgrover1 345:dfde56236c36 251 {
rgrover1 345:dfde56236c36 252 // Current state low, set high.
rgrover1 345:dfde56236c36 253 NRF_GPIO->OUTSET = pin_bit;
rgrover1 345:dfde56236c36 254 }
rgrover1 345:dfde56236c36 255 else
rgrover1 345:dfde56236c36 256 {
rgrover1 345:dfde56236c36 257 // Current state high, set low.
rgrover1 345:dfde56236c36 258 NRF_GPIO->OUTCLR = pin_bit;
rgrover1 345:dfde56236c36 259 }
rgrover1 345:dfde56236c36 260 }
rgrover1 345:dfde56236c36 261
rgrover1 345:dfde56236c36 262 /**
rgrover1 345:dfde56236c36 263 * @brief Function for writing a value to a GPIO pin.
rgrover1 345:dfde56236c36 264 *
rgrover1 345:dfde56236c36 265 * Note that the pin must be configured as an output for this
rgrover1 345:dfde56236c36 266 * function to have any effect.
rgrover1 345:dfde56236c36 267 *
rgrover1 345:dfde56236c36 268 * @param pin_number specifies the pin number [0:31] to
rgrover1 345:dfde56236c36 269 * write.
rgrover1 345:dfde56236c36 270 *
rgrover1 345:dfde56236c36 271 * @param value specifies the value to be written to the pin.
rgrover1 345:dfde56236c36 272 * @arg 0 clears the pin
rgrover1 345:dfde56236c36 273 * @arg >=1 sets the pin.
rgrover1 345:dfde56236c36 274 */
rgrover1 345:dfde56236c36 275 static __INLINE void nrf_gpio_pin_write(uint32_t pin_number, uint32_t value)
rgrover1 345:dfde56236c36 276 {
rgrover1 345:dfde56236c36 277 if (value == 0)
rgrover1 345:dfde56236c36 278 {
rgrover1 345:dfde56236c36 279 nrf_gpio_pin_clear(pin_number);
rgrover1 345:dfde56236c36 280 }
rgrover1 345:dfde56236c36 281 else
rgrover1 345:dfde56236c36 282 {
rgrover1 345:dfde56236c36 283 nrf_gpio_pin_set(pin_number);
rgrover1 345:dfde56236c36 284 }
rgrover1 345:dfde56236c36 285 }
rgrover1 345:dfde56236c36 286
rgrover1 345:dfde56236c36 287 /**
rgrover1 345:dfde56236c36 288 * @brief Function for reading the input level of a GPIO pin.
rgrover1 345:dfde56236c36 289 *
rgrover1 345:dfde56236c36 290 * Note that the pin must have input connected for the value
rgrover1 345:dfde56236c36 291 * returned from this function to be valid.
rgrover1 345:dfde56236c36 292 *
rgrover1 345:dfde56236c36 293 * @param pin_number specifies the pin number [0:31] to
rgrover1 345:dfde56236c36 294 * read.
rgrover1 345:dfde56236c36 295 *
rgrover1 345:dfde56236c36 296 * @return
rgrover1 345:dfde56236c36 297 * @retval 0 if the pin input level is low.
rgrover1 345:dfde56236c36 298 * @retval 1 if the pin input level is high.
rgrover1 345:dfde56236c36 299 * @retval > 1 should never occur.
rgrover1 345:dfde56236c36 300 */
rgrover1 345:dfde56236c36 301 static __INLINE uint32_t nrf_gpio_pin_read(uint32_t pin_number)
rgrover1 345:dfde56236c36 302 {
rgrover1 345:dfde56236c36 303 return ((NRF_GPIO->IN >> pin_number) & 1UL);
rgrover1 345:dfde56236c36 304 }
rgrover1 345:dfde56236c36 305
rgrover1 345:dfde56236c36 306 /**
rgrover1 345:dfde56236c36 307 * @brief Generic function for writing a single byte of a 32 bit word at a given
rgrover1 345:dfde56236c36 308 * address.
rgrover1 345:dfde56236c36 309 *
rgrover1 345:dfde56236c36 310 * This function should not be called from outside the nrf_gpio
rgrover1 345:dfde56236c36 311 * abstraction layer.
rgrover1 345:dfde56236c36 312 *
rgrover1 345:dfde56236c36 313 * @param word_address is the address of the word to be written.
rgrover1 345:dfde56236c36 314 *
rgrover1 345:dfde56236c36 315 * @param byte_no is the the word byte number (0-3) to be written.
rgrover1 345:dfde56236c36 316 *
rgrover1 345:dfde56236c36 317 * @param value is the value to be written to byte "byte_no" of word
rgrover1 345:dfde56236c36 318 * at address "word_address"
rgrover1 345:dfde56236c36 319 */
rgrover1 345:dfde56236c36 320 static __INLINE void nrf_gpio_word_byte_write(volatile uint32_t * word_address, uint8_t byte_no, uint8_t value)
rgrover1 345:dfde56236c36 321 {
rgrover1 345:dfde56236c36 322 *((volatile uint8_t*)(word_address) + byte_no) = value;
rgrover1 345:dfde56236c36 323 }
rgrover1 345:dfde56236c36 324
rgrover1 345:dfde56236c36 325 /**
rgrover1 345:dfde56236c36 326 * @brief Generic function for reading a single byte of a 32 bit word at a given
rgrover1 345:dfde56236c36 327 * address.
rgrover1 345:dfde56236c36 328 *
rgrover1 345:dfde56236c36 329 * This function should not be called from outside the nrf_gpio
rgrover1 345:dfde56236c36 330 * abstraction layer.
rgrover1 345:dfde56236c36 331 *
rgrover1 345:dfde56236c36 332 * @param word_address is the address of the word to be read.
rgrover1 345:dfde56236c36 333 *
rgrover1 345:dfde56236c36 334 * @param byte_no is the the byte number (0-3) of the word to be read.
rgrover1 345:dfde56236c36 335 *
rgrover1 345:dfde56236c36 336 * @return byte "byte_no" of word at address "word_address".
rgrover1 345:dfde56236c36 337 */
rgrover1 345:dfde56236c36 338 static __INLINE uint8_t nrf_gpio_word_byte_read(const volatile uint32_t* word_address, uint8_t byte_no)
rgrover1 345:dfde56236c36 339 {
rgrover1 345:dfde56236c36 340 return (*((const volatile uint8_t*)(word_address) + byte_no));
rgrover1 345:dfde56236c36 341 }
rgrover1 345:dfde56236c36 342
rgrover1 345:dfde56236c36 343 /**
rgrover1 345:dfde56236c36 344 * @brief Function for setting the direction of a port.
rgrover1 345:dfde56236c36 345 *
rgrover1 345:dfde56236c36 346 * @param port is the port for which to set the direction.
rgrover1 345:dfde56236c36 347 *
rgrover1 345:dfde56236c36 348 * @param dir direction to be set for this port.
rgrover1 345:dfde56236c36 349 */
rgrover1 345:dfde56236c36 350 static __INLINE void nrf_gpio_port_dir_set(nrf_gpio_port_select_t port, nrf_gpio_port_dir_t dir)
rgrover1 345:dfde56236c36 351 {
rgrover1 345:dfde56236c36 352 if (dir == NRF_GPIO_PORT_DIR_OUTPUT)
rgrover1 345:dfde56236c36 353 {
rgrover1 345:dfde56236c36 354 nrf_gpio_word_byte_write(&NRF_GPIO->DIRSET, port, 0xFF);
rgrover1 345:dfde56236c36 355 }
rgrover1 345:dfde56236c36 356 else
rgrover1 345:dfde56236c36 357 {
rgrover1 345:dfde56236c36 358 nrf_gpio_range_cfg_input(port*8, (port+1)*8-1, NRF_GPIO_PIN_NOPULL);
rgrover1 345:dfde56236c36 359 }
rgrover1 345:dfde56236c36 360 }
rgrover1 345:dfde56236c36 361
rgrover1 345:dfde56236c36 362 /**
rgrover1 345:dfde56236c36 363 * @brief Function for reading a GPIO port.
rgrover1 345:dfde56236c36 364 *
rgrover1 345:dfde56236c36 365 * @param port is the port to read.
rgrover1 345:dfde56236c36 366 *
rgrover1 345:dfde56236c36 367 * @return the input value on this port.
rgrover1 345:dfde56236c36 368 */
rgrover1 345:dfde56236c36 369 static __INLINE uint8_t nrf_gpio_port_read(nrf_gpio_port_select_t port)
rgrover1 345:dfde56236c36 370 {
rgrover1 345:dfde56236c36 371 return nrf_gpio_word_byte_read(&NRF_GPIO->IN, port);
rgrover1 345:dfde56236c36 372 }
rgrover1 345:dfde56236c36 373
rgrover1 345:dfde56236c36 374 /**
rgrover1 345:dfde56236c36 375 * @brief Function for writing to a GPIO port.
rgrover1 345:dfde56236c36 376 *
rgrover1 345:dfde56236c36 377 * @param port is the port to write.
rgrover1 345:dfde56236c36 378 *
rgrover1 345:dfde56236c36 379 * @param value is the value to write to this port.
rgrover1 345:dfde56236c36 380 *
rgrover1 345:dfde56236c36 381 * @sa nrf_gpio_port_dir_set()
rgrover1 345:dfde56236c36 382 */
rgrover1 345:dfde56236c36 383 static __INLINE void nrf_gpio_port_write(nrf_gpio_port_select_t port, uint8_t value)
rgrover1 345:dfde56236c36 384 {
rgrover1 345:dfde56236c36 385 nrf_gpio_word_byte_write(&NRF_GPIO->OUT, port, value);
rgrover1 345:dfde56236c36 386 }
rgrover1 345:dfde56236c36 387
rgrover1 345:dfde56236c36 388 /**
rgrover1 345:dfde56236c36 389 * @brief Function for setting individual pins on GPIO port.
rgrover1 345:dfde56236c36 390 *
rgrover1 345:dfde56236c36 391 * @param port is the port for which to set the pins.
rgrover1 345:dfde56236c36 392 *
rgrover1 345:dfde56236c36 393 * @param set_mask is a mask specifying which pins to set. A bit
rgrover1 345:dfde56236c36 394 * set to 1 indicates that the corresponding port pin shall be
rgrover1 345:dfde56236c36 395 * set.
rgrover1 345:dfde56236c36 396 *
rgrover1 345:dfde56236c36 397 * @sa nrf_gpio_port_dir_set()
rgrover1 345:dfde56236c36 398 */
rgrover1 345:dfde56236c36 399 static __INLINE void nrf_gpio_port_set(nrf_gpio_port_select_t port, uint8_t set_mask)
rgrover1 345:dfde56236c36 400 {
rgrover1 345:dfde56236c36 401 nrf_gpio_word_byte_write(&NRF_GPIO->OUTSET, port, set_mask);
rgrover1 345:dfde56236c36 402 }
rgrover1 345:dfde56236c36 403
rgrover1 345:dfde56236c36 404 /**
rgrover1 345:dfde56236c36 405 * @brief Function for clearing individual pins on GPIO port.
rgrover1 345:dfde56236c36 406 *
rgrover1 345:dfde56236c36 407 * @param port is the port for which to clear the pins.
rgrover1 345:dfde56236c36 408 *
rgrover1 345:dfde56236c36 409 * @param clr_mask is a mask specifying which pins to clear. A bit
rgrover1 345:dfde56236c36 410 * set to 1 indicates that the corresponding port pin shall be
rgrover1 345:dfde56236c36 411 * cleared.
rgrover1 345:dfde56236c36 412 *
rgrover1 345:dfde56236c36 413 * @sa nrf_gpio_port_dir_set()
rgrover1 345:dfde56236c36 414 */
rgrover1 345:dfde56236c36 415 static __INLINE void nrf_gpio_port_clear(nrf_gpio_port_select_t port, uint8_t clr_mask)
rgrover1 345:dfde56236c36 416 {
rgrover1 345:dfde56236c36 417 nrf_gpio_word_byte_write(&NRF_GPIO->OUTCLR, port, clr_mask);
rgrover1 345:dfde56236c36 418 }
rgrover1 345:dfde56236c36 419
rgrover1 345:dfde56236c36 420 /** @} */
rgrover1 345:dfde56236c36 421
rgrover1 345:dfde56236c36 422 #endif