|
| | CFN_HAL_VMT_CHECK (struct cfn_hal_gpio_api_s) |
| |
| | CFN_HAL_CREATE_DRIVER_TYPE (gpio, void, cfn_hal_gpio_api_t, cfn_hal_gpio_phy_t, cfn_hal_gpio_callback_t) |
| |
| CFN_HAL_INLINE void | cfn_hal_gpio_populate (cfn_hal_gpio_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_gpio_api_t *api, const cfn_hal_gpio_phy_t *phy, cfn_hal_gpio_callback_t callback, void *user_arg) |
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_pin_config_validate (const cfn_hal_gpio_t *driver, const cfn_hal_gpio_pin_config_t *pin_cfg) |
| | Validates the GPIO pin configuration.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_init (cfn_hal_gpio_t *driver) |
| | Initializes the GPIO driver.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_deinit (cfn_hal_gpio_t *driver) |
| | Deinitializes the GPIO driver.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_callback_register (cfn_hal_gpio_t *driver, const cfn_hal_gpio_callback_t callback, void *user_arg) |
| | Registers a callback for GPIO events and errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_power_state_set (cfn_hal_gpio_t *driver, cfn_hal_power_state_t state) |
| | Sets the GPIO power state.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_event_enable (cfn_hal_gpio_t *driver, uint32_t event_mask) |
| | Enables one or more GPIO nominal events.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_event_disable (cfn_hal_gpio_t *driver, uint32_t event_mask) |
| | Disables one or more GPIO nominal events.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_event_get (cfn_hal_gpio_t *driver, uint32_t *event_mask) |
| | Retrieves the current GPIO nominal event status.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_error_enable (cfn_hal_gpio_t *driver, uint32_t error_mask) |
| | Enables one or more GPIO exception errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_error_disable (cfn_hal_gpio_t *driver, uint32_t error_mask) |
| | Disables one or more GPIO exception errors.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_error_get (cfn_hal_gpio_t *driver, uint32_t *error_mask) |
| | Retrieves the current GPIO exception error status.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_pin_config (cfn_hal_gpio_t *port, const cfn_hal_gpio_pin_config_t *pin_cfg) |
| | Configures specific pins on the port using a payload structure.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_pin_read (cfn_hal_gpio_t *port, cfn_hal_gpio_pin_t pin, cfn_hal_gpio_state_t *state) |
| | Reads the logical state of a single GPIO pin.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_pin_write (cfn_hal_gpio_t *port, cfn_hal_gpio_pin_t pin, cfn_hal_gpio_state_t state) |
| | Writes a logical state to a single GPIO pin.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_pin_toggle (cfn_hal_gpio_t *port, cfn_hal_gpio_pin_t pin) |
| | Toggles the logical state of a single GPIO pin.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_port_read (cfn_hal_gpio_t *port, uint32_t *port_value) |
| | Reads the 32-bit raw value of the entire GPIO port.
|
| |
| CFN_HAL_INLINE cfn_hal_error_code_t | cfn_hal_gpio_port_write (cfn_hal_gpio_t *port, uint32_t pin_mask, uint32_t port_value) |
| | Atomically writes to multiple pins on the port using a mask.
|
| |
| cfn_hal_error_code_t | cfn_hal_gpio_construct (cfn_hal_gpio_t *driver, const cfn_hal_gpio_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_gpio_callback_t callback, void *user_arg) |
| |
| cfn_hal_error_code_t | cfn_hal_gpio_destruct (cfn_hal_gpio_t *driver) |
| |
General Purpose Input/Output (GPIO) HAL API.
Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.