/ 11111

1

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/drivers_nrf/hal/nrf_gpio.h@370:295f76db798e, 2015-07-06 (annotated)

Committer:
rgrover1
Date:
Mon Jul 06 10:13:26 2015 +0100
Revision:
370:295f76db798e
Parent:
362:6fa0d4d555f6
Child:
371:8f7d2137727a
Synchronized with git rev 9f72c4ba

Author: Rohit Grover

Release 0.3.7

=============



This is a minor set of enhancements mostly around reduce our global static

memory footprint.



Enhancements

~~~~~~~~~~~~



* Reduce the maximum number of CHARACTERISTICS and DESCRIPTORS that can be

  handled. This has memory implications for static global memory. It should

  be possible to re-architect our solution for add_characteristic() to not

  require these limits; hopefully we'll get there soon.



* Move nRF51GattServer::getInstance() into a .cpp file; same for nRF51Gap::getInstance().



* Reduce max bonds to managed by device-manager to 4; this has memory implications for static global memory.



* Reduce pStorage command queue size to 2; this has memory implications for static global memory.



* Replace uses of deprecated Gap::addr_type_t with Gap::AddressType_t.



* Some UUID-related types have moved into UUID class. Minor changes were needed to work around build errors.



Bugfixes

~~~~~~~~



* None.

Who changed what in which revision?

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