Classes | Macros | Typedefs | Enumerations | Functions
gr55xx_hal_aon_gpio.h File Reference

Header file containing functions prototypes of AON GPIO HAL library. More...

`#include "gr55xx_ll_aon_gpio.h"`
`#include "gr55xx_hal_def.h"`
`#include "gr55xx_hal_aon_gpio_ex.h"`
Include dependency graph for gr55xx_hal_aon_gpio.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes
struct | _aon_gpio_init
| AON_GPIO init structure definition. More...
struct | _aon_gpio_callback
| HAL AON_GPIO Callback function definition. More...

## Macros
#define | AON_GPIO_PIN_0 ((uint16_t)0x0001U)
| Pin 0 selected More...
#define | AON_GPIO_PIN_1 ((uint16_t)0x0002U)
| Pin 1 selected More...
#define | AON_GPIO_PIN_2 ((uint16_t)0x0004U)
| Pin 2 selected More...
#define | AON_GPIO_PIN_3 ((uint16_t)0x0008U)
| Pin 3 selected More...
#define | AON_GPIO_PIN_4 ((uint16_t)0x0010U)
| Pin 4 selected More...
#define | AON_GPIO_PIN_5 ((uint16_t)0x0020U)
| Pin 5 selected More...
#define | AON_GPIO_PIN_6 ((uint16_t)0x0040U)
| Pin 6 selected More...
#define | AON_GPIO_PIN_7 ((uint16_t)0x0080U)
| Pin 7 selected More...
#define | AON_GPIO_PIN_ALL ((uint16_t)0x00FFU)
| All pins selected. More...
#define | AON_GPIO_PIN_MASK (0x000000FFU)
| PIN mask for assert test. More...
#define | AON_GPIO_MODE_INPUT (LL_AON_GPIO_MODE_INPUT << 0)
| Input Mode More...
#define | AON_GPIO_MODE_OUTPUT (LL_AON_GPIO_MODE_OUTPUT << 0)
| Output Mode More...
#define | AON_GPIO_MODE_MUX (LL_GPIO_MODE_MUX << 0)
| Mux Mode More...
#define | AON_GPIO_MODE_IT_RISING (LL_AON_GPIO_TRIGGER_RISING << 4)
| Interrupt Mode with Rising edge trigger detection More...
#define | AON_GPIO_MODE_IT_FALLING (LL_AON_GPIO_TRIGGER_FALLING << 4)
| Interrupt Mode with Falling edge trigger detection. More...
#define | AON_GPIO_MODE_IT_HIGH (LL_AON_GPIO_TRIGGER_HIGH << 4)
| Interrupt Mode with High-level trigger detection More...
#define | AON_GPIO_MODE_IT_LOW (LL_AON_GPIO_TRIGGER_LOW << 4)
| Interrupt Mode with Low-level trigger detection More...
#define | AON_GPIO_NOPULL LL_AON_GPIO_PULL_NO
| No Pull-up or Pull-down activation More...
#define | AON_GPIO_PULLUP LL_AON_GPIO_PULL_UP
| Pull-up activation More...
#define | AON_GPIO_PULLDOWN LL_AON_GPIO_PULL_DOWN
| Pull-down activation More...
#define | AON_GPIO_DEFAULT_CONFIG
| AON_GPIO_default_config initStruct default configuartion. More...
#define | __HAL_AON_GPIO_IT_GET_IT(__AON_GPIO_PIN__) ll_aon_gpio_read_flag_it(__AON_GPIO_PIN__)
| Check whether the specified AON_GPIO pin is asserted or not. More...
#define | __HAL_AON_GPIO_IT_CLEAR_IT(__AON_GPIO_PIN__) ll_aon_gpio_clear_flag_it(__AON_GPIO_PIN__)
| Clear the AON_GPIO pin pending bits. More...
#define | IS_AON_GPIO_PIN_ACTION(__ACTION__) (((__ACTION__) == AON_GPIO_PIN_RESET) || ((__ACTION__) == AON_GPIO_PIN_SET))
| Check if AON GPIO pin action is valid. More...
#define | IS_AON_GPIO_PIN(__PIN__)
| Check if AON GPIO pins are valid. More...
#define | IS_AON_GPIO_MODE(__MODE__)
| Check if AON GPIO mode is valid. More...
#define | IS_AON_GPIO_PULL(__PULL__)
| Check if AON GPIO pull type is valid. More...

## Typedefs
typedef struct _aon_gpio_init | aon_gpio_init_t
| AON_GPIO init structure definition. More...
typedef struct _aon_gpio_callback | aon_gpio_callback_t
| HAL AON_GPIO Callback function definition. More...

## Enumerations
enum | aon_gpio_pin_state_t { AON_GPIO_PIN_RESET = 0U, AON_GPIO_PIN_SET }
| AON_GPIO Bit SET and Bit RESET enumerations. More...

## Functions
void | hal_aon_gpio_init (aon_gpio_init_t *p_aon_gpio_init)
| Initialize the AON_GPIOx peripheral according to the specified parameters in the aon_gpio_init_t. More...
void | hal_aon_gpio_deinit (uint32_t aon_gpio_pin)
| De-initialize the AON_GPIOx peripheral registers to their default reset values. More...
aon_gpio_pin_state_t | hal_aon_gpio_read_pin (uint16_t aon_gpio_pin)
| Read the specified input port pin. More...
void | hal_aon_gpio_write_pin (uint16_t aon_gpio_pin, aon_gpio_pin_state_t pin_state)
| Set or clear the selected data port bit. More...
void | hal_aon_gpio_toggle_pin (uint16_t aon_gpio_pin)
| Toggle the specified AON_GPIO pin. More...
void | hal_aon_gpio_irq_handler (void)
| Handle AON_GPIO interrupt request. More...
void | hal_aon_gpio_callback (uint16_t aon_gpio_pin)
| AON GPIO pin detection callback. More...

## Detailed Description

Header file containing functions prototypes of AON GPIO HAL library.

Author
  BLE Driver Team

Attention

  ##### Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file gr55xx_hal_aon_gpio.h.