1 /** 2 * @file gpio.h 3 * @brief General-Purpose Input/Output (GPIO) function prototypes and data types. 4 */ 5 6 /****************************************************************************** 7 * 8 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 9 * Analog Devices, Inc.), 10 * Copyright (C) 2023-2025 Analog Devices, Inc. 11 * 12 * Licensed under the Apache License, Version 2.0 (the "License"); 13 * you may not use this file except in compliance with the License. 14 * You may obtain a copy of the License at 15 * 16 * http://www.apache.org/licenses/LICENSE-2.0 17 * 18 * Unless required by applicable law or agreed to in writing, software 19 * distributed under the License is distributed on an "AS IS" BASIS, 20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 21 * See the License for the specific language governing permissions and 22 * limitations under the License. 23 * 24 ******************************************************************************/ 25 26 /* Define to prevent redundant inclusion */ 27 #ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32650_GPIO_H_ 28 #define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32650_GPIO_H_ 29 30 /* **** Includes **** */ 31 #include "gpio_regs.h" 32 #include "max32650.h" 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 /** 39 * @defgroup gpio General-Purpose Input/Output (GPIO) 40 * @ingroup periphlibs 41 * @{ 42 */ 43 44 /* **** Definitions **** */ 45 /** 46 * @defgroup gpio_port_pin Port and Pin Definitions 47 * @ingroup gpio 48 * @{ 49 * @defgroup gpio_port Port Definitions 50 * @ingroup gpio_port_pin 51 * @{ 52 */ 53 #define MXC_GPIO_PORT_0 ((uint32_t)(0UL)) /**< Port 0 Define*/ 54 #define MXC_GPIO_PORT_1 ((uint32_t)(1UL)) /**< Port 1 Define*/ 55 #define MXC_GPIO_PORT_2 ((uint32_t)(2UL)) /**< Port 2 Define*/ 56 #define MXC_GPIO_PORT_3 ((uint32_t)(3UL)) /**< Port 3 Define*/ 57 58 /**@} end of gpio_port group*/ 59 /** 60 * @defgroup gpio_pin Pin Definitions 61 * @ingroup gpio_port_pin 62 * @{ 63 */ 64 #define MXC_GPIO_PIN_0 ((uint32_t)(1UL << 0)) /**< Pin 0 Define */ 65 #define MXC_GPIO_PIN_1 ((uint32_t)(1UL << 1)) /**< Pin 1 Define */ 66 #define MXC_GPIO_PIN_2 ((uint32_t)(1UL << 2)) /**< Pin 2 Define */ 67 #define MXC_GPIO_PIN_3 ((uint32_t)(1UL << 3)) /**< Pin 3 Define */ 68 #define MXC_GPIO_PIN_4 ((uint32_t)(1UL << 4)) /**< Pin 4 Define */ 69 #define MXC_GPIO_PIN_5 ((uint32_t)(1UL << 5)) /**< Pin 5 Define */ 70 #define MXC_GPIO_PIN_6 ((uint32_t)(1UL << 6)) /**< Pin 6 Define */ 71 #define MXC_GPIO_PIN_7 ((uint32_t)(1UL << 7)) /**< Pin 7 Define */ 72 #define MXC_GPIO_PIN_8 ((uint32_t)(1UL << 8)) /**< Pin 8 Define */ 73 #define MXC_GPIO_PIN_9 ((uint32_t)(1UL << 9)) /**< Pin 9 Define */ 74 #define MXC_GPIO_PIN_10 ((uint32_t)(1UL << 10)) /**< Pin 10 Define */ 75 #define MXC_GPIO_PIN_11 ((uint32_t)(1UL << 11)) /**< Pin 11 Define */ 76 #define MXC_GPIO_PIN_12 ((uint32_t)(1UL << 12)) /**< Pin 12 Define */ 77 #define MXC_GPIO_PIN_13 ((uint32_t)(1UL << 13)) /**< Pin 13 Define */ 78 #define MXC_GPIO_PIN_14 ((uint32_t)(1UL << 14)) /**< Pin 14 Define */ 79 #define MXC_GPIO_PIN_15 ((uint32_t)(1UL << 15)) /**< Pin 15 Define */ 80 #define MXC_GPIO_PIN_16 ((uint32_t)(1UL << 16)) /**< Pin 16 Define */ 81 #define MXC_GPIO_PIN_17 ((uint32_t)(1UL << 17)) /**< Pin 17 Define */ 82 #define MXC_GPIO_PIN_18 ((uint32_t)(1UL << 18)) /**< Pin 18 Define */ 83 #define MXC_GPIO_PIN_19 ((uint32_t)(1UL << 19)) /**< Pin 19 Define */ 84 #define MXC_GPIO_PIN_20 ((uint32_t)(1UL << 20)) /**< Pin 20 Define */ 85 #define MXC_GPIO_PIN_21 ((uint32_t)(1UL << 21)) /**< Pin 21 Define */ 86 #define MXC_GPIO_PIN_22 ((uint32_t)(1UL << 22)) /**< Pin 22 Define */ 87 #define MXC_GPIO_PIN_23 ((uint32_t)(1UL << 23)) /**< Pin 23 Define */ 88 #define MXC_GPIO_PIN_24 ((uint32_t)(1UL << 24)) /**< Pin 24 Define */ 89 #define MXC_GPIO_PIN_25 ((uint32_t)(1UL << 25)) /**< Pin 25 Define */ 90 #define MXC_GPIO_PIN_26 ((uint32_t)(1UL << 26)) /**< Pin 26 Define */ 91 #define MXC_GPIO_PIN_27 ((uint32_t)(1UL << 27)) /**< Pin 27 Define */ 92 #define MXC_GPIO_PIN_28 ((uint32_t)(1UL << 28)) /**< Pin 28 Define */ 93 #define MXC_GPIO_PIN_29 ((uint32_t)(1UL << 29)) /**< Pin 29 Define */ 94 #define MXC_GPIO_PIN_30 ((uint32_t)(1UL << 30)) /**< Pin 30 Define */ 95 #define MXC_GPIO_PIN_31 ((uint32_t)(1UL << 31)) /**< Pin 31 Define */ 96 /**@} end of gpio_pin group */ 97 /**@} end of gpio_port_pin group */ 98 99 /** 100 * Enumeration type for the GPIO Function Type 101 */ 102 typedef enum { 103 MXC_GPIO_FUNC_IN, /**< GPIO Input */ 104 MXC_GPIO_FUNC_OUT, /**< GPIO Output */ 105 MXC_GPIO_FUNC_ALT1, /**< Alternate Function Selection */ 106 MXC_GPIO_FUNC_ALT2, /**< Alternate Function Selection */ 107 } mxc_gpio_func_t; 108 109 /** 110 * Enumeration type for the type of GPIO pad on a given pin. 111 */ 112 typedef enum { 113 MXC_GPIO_PAD_NONE, /**< No pull-up or pull-down */ 114 MXC_GPIO_PAD_WEAK_PULL_UP, /**< Set pad to weak pull-up */ 115 MXC_GPIO_PAD_WEAK_PULL_DOWN, /**< Set pad to weak pull-down */ 116 MXC_GPIO_PAD_PULL_UP, /**< Set pad to strong pull-up */ 117 MXC_GPIO_PAD_PULL_DOWN, /**< Set pad to strong pull-down */ 118 } mxc_gpio_pad_t; 119 120 /** 121 * @brief Enumeration type for the voltage level on a given pin. 122 */ 123 typedef enum { 124 MXC_GPIO_VSSEL_VDDIO, /**< Set pin to VIDDIO voltage */ 125 MXC_GPIO_VSSEL_VDDIOH, /**< Set pin to VIDDIOH voltage */ 126 } mxc_gpio_vssel_t; 127 128 /** 129 * @brief Enumeration type for drive strength configuration. 130 */ 131 typedef enum { 132 MXC_GPIO_DRVSTR_0, /**< Drive Strength 0 */ 133 MXC_GPIO_DRVSTR_1, /**< Drive Strength 1 */ 134 MXC_GPIO_DRVSTR_2, /**< Drive Strength 2 */ 135 MXC_GPIO_DRVSTR_3, /**< Drive Strength 3 */ 136 } mxc_gpio_drvstr_t; 137 138 /** 139 * Structure type for configuring a GPIO port. 140 */ 141 typedef struct { 142 mxc_gpio_regs_t *port; /**< Index of GPIO port */ 143 uint32_t mask; /**< Pin mask (multiple pins may be set) */ 144 mxc_gpio_func_t func; /**< Function type */ 145 mxc_gpio_pad_t pad; /**< Pad type */ 146 mxc_gpio_vssel_t vssel; /**< Voltage select */ 147 mxc_gpio_drvstr_t drvstr; /**< Drive Strength select */ 148 } mxc_gpio_cfg_t; 149 150 /** 151 * Enumeration type for the interrupt modes. 152 */ 153 typedef enum { 154 MXC_GPIO_INT_LEVEL = 0, /**< Interrupt is level sensitive */ 155 MXC_GPIO_INT_EDGE = 1 /**< Interrupt is edge sensitive */ 156 } mxc_gpio_int_mode_t; 157 158 /** 159 * Enumeration type for the interrupt polarity. 160 */ 161 typedef enum { 162 MXC_GPIO_INT_FALLING, /**< Interrupt triggers on falling edge */ 163 MXC_GPIO_INT_HIGH, /**< Interrupt triggers when level is high */ 164 MXC_GPIO_INT_RISING, /**< Interrupt triggers on rising edge */ 165 MXC_GPIO_INT_LOW, /**< Interrupt triggers when level is low */ 166 MXC_GPIO_INT_BOTH /**< Interrupt triggers on either edge */ 167 } mxc_gpio_int_pol_t; 168 169 /* **** Function Prototypes **** */ 170 171 /** 172 * @brief Initialize GPIO. 173 * @return #E_NO_ERROR if everything is successful. 174 */ 175 int MXC_GPIO_Init(uint32_t port); 176 177 /** 178 * @brief Shutdown GPIO. 179 * @param portMask Mask for the port to shutdown 180 * @return #E_NO_ERROR if everything is successful. 181 */ 182 int MXC_GPIO_Shutdown(uint32_t port); 183 184 /** 185 * @brief Reset GPIO. 186 * @param portMask Mask for the port to reset 187 * @return #E_NO_ERROR if everything is successful. 188 */ 189 int MXC_GPIO_Reset(uint32_t port); 190 191 /** 192 * @brief Configure GPIO pin(s). 193 * @param cfg Pointer to configuration structure describing the pin. 194 * @return #E_NO_ERROR if everything is successful. 195 */ 196 int MXC_GPIO_Config(const mxc_gpio_cfg_t *cfg); 197 198 /** 199 * @brief Gets the pin(s) input state. 200 * @param cfg Pointer to configuration structure describing the pin. 201 * @return The requested pin state. 202 */ 203 uint32_t MXC_GPIO_InGet(mxc_gpio_regs_t *port, uint32_t mask); 204 205 /** 206 * @brief Sets the pin(s) to a high level output. 207 * @param cfg Pointer to configuration structure describing the pin. 208 * 209 */ 210 void MXC_GPIO_OutSet(mxc_gpio_regs_t *port, uint32_t mask); 211 212 /** 213 * @brief Clears the pin(s) to a low level output. 214 * @param cfg Pointer to configuration structure describing the pin. 215 * 216 */ 217 void MXC_GPIO_OutClr(mxc_gpio_regs_t *port, uint32_t mask); 218 219 /** 220 * @brief Gets the pin(s) output state. 221 * @param cfg Pointer to configuration structure describing the pin. 222 * 223 * @return The state of the requested pin. 224 * 225 */ 226 uint32_t MXC_GPIO_OutGet(mxc_gpio_regs_t *port, uint32_t mask); 227 228 /** 229 * @brief Write the pin(s) to a desired output level. 230 * @param cfg Pointer to configuration structure describing the pin. 231 * @param val Desired output level of the pin(s). This will be masked 232 * with the configuration mask. 233 */ 234 void MXC_GPIO_OutPut(mxc_gpio_regs_t *port, uint32_t mask, uint32_t val); 235 236 /** 237 * @brief Toggles the the pin(s) output level. 238 * @param cfg Pointer to configuration structure describing the pin. 239 * 240 */ 241 void MXC_GPIO_OutToggle(mxc_gpio_regs_t *port, uint32_t mask); 242 243 /** 244 * @brief Configure GPIO interrupt(s) 245 * @param cfg Pointer to configuration structure describing the pin. 246 * @param mode Requested interrupt mode. 247 * @param pol Requested interrupt polarity. 248 * @return #E_NO_ERROR if everything is successful. 249 */ 250 int MXC_GPIO_IntConfig(const mxc_gpio_cfg_t *cfg, mxc_gpio_int_pol_t pol); 251 252 /** 253 * @brief Enables the specified GPIO interrupt 254 * @param cfg Pointer to configuration structure describing the pin. 255 * 256 */ 257 void MXC_GPIO_EnableInt(mxc_gpio_regs_t *port, uint32_t mask); 258 259 /** 260 * @brief Disables the specified GPIO interrupt. 261 * @param cfg Pointer to configuration structure describing the pin. 262 */ 263 void MXC_GPIO_DisableInt(mxc_gpio_regs_t *port, uint32_t mask); 264 265 /** 266 * @brief Gets the interrupt(s) status on a GPIO port 267 * 268 * @param port Pointer to the port requested 269 * 270 * @return The requested interrupt status. 271 */ 272 uint32_t MXC_GPIO_GetFlags(mxc_gpio_regs_t *port); 273 274 /** 275 * @brief Gets the interrupt(s) status on a GPIO port 276 * 277 * @param port Pointer to the port requested 278 * @param flags The flags to clear 279 */ 280 void MXC_GPIO_ClearFlags(mxc_gpio_regs_t *port, uint32_t flags); 281 282 /** 283 * @brief Type alias for a GPIO callback function with prototype: 284 * @code 285 void callback_fn(void *cbdata); 286 * @endcode 287 * @param cbdata A void pointer to the data type as registered when 288 * GPIO_RegisterCallback() was called. 289 */ 290 typedef void (*mxc_gpio_callback_fn)(void *cbdata); 291 292 /** 293 * @brief Registers a callback for the interrupt on a given port and pin. 294 * @param cfg Pointer to configuration structure describing the pin 295 * @param callback A pointer to a function of type \c #gpio_callback_fn. 296 * @param cbdata The parameter to be passed to the callback function, #gpio_callback_fn, when an interrupt occurs. 297 * 298 */ 299 void MXC_GPIO_RegisterCallback(const mxc_gpio_cfg_t *cfg, mxc_gpio_callback_fn callback, 300 void *cbdata); 301 302 /** 303 * @brief GPIO IRQ Handler. @note If a callback is registered for a given 304 * interrupt, the callback function will be called. 305 * 306 * @param port number of the port that generated the interrupt service routine. 307 * 308 */ 309 void MXC_GPIO_Handler(unsigned int port); 310 311 /** 312 * @brief Set Voltage select for pins to VDDIO or VDDIOH 313 * 314 * @param port The GPIO port 315 * @param[in] vssel VDDIO or VDDIOH to set the voltatge to 316 * @param[in] mask Pins in the GPIO port that will be set to the voltage. 317 * 318 * @return #E_NO_ERROR if everything is successful. See \ref MXC_Error_Codes for the list of error codes. 319 */ 320 int MXC_GPIO_SetVSSEL(mxc_gpio_regs_t *port, mxc_gpio_vssel_t vssel, uint32_t mask); 321 322 /** 323 * @brief Enables GPIO pins to be used as a wakeup source. 324 * 325 * @param port The GPIO port 326 * @param mask Pins in the GPIO port that will be enabled as a wakeup source. 327 */ 328 void MXC_GPIO_SetWakeEn(mxc_gpio_regs_t *port, uint32_t mask); 329 330 /** 331 * @brief Disables GPIO pins from being used as a wakeup source. 332 * 333 * @param port The GPIO port 334 * @param mask Pins in the GPIO port that will be disabled as a wakeup source. 335 */ 336 void MXC_GPIO_ClearWakeEn(mxc_gpio_regs_t *port, uint32_t mask); 337 338 /** 339 * @brief Returns the pins currently enabled as wakeup sources. 340 * 341 * @param port The GPIO port to check. 342 * 343 * @returns The value of the wake enable register. 344 */ 345 uint32_t MXC_GPIO_GetWakeEn(mxc_gpio_regs_t *port); 346 347 /** 348 * @brief Set Drive Strength for pins. 349 * 350 * @param port The GPIO port. 351 * @param[in] ds Drive strength level. Ref /mxc_gpio_ds_t enum type. 352 * @param[in] mask Pins in the GPIO port that will be set to the voltage. 353 */ 354 int MXC_GPIO_SetDriveStrength(mxc_gpio_regs_t *port, mxc_gpio_drvstr_t drvstr, uint32_t mask); 355 356 /**@} end of group gpio */ 357 358 #ifdef __cplusplus 359 } 360 #endif 361 362 #endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32650_GPIO_H_ 363
