VSF Documented
gpio.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __HAL_DRIVER_${SERIES/GPIO_IP}_GPIO_H__
19#define __HAL_DRIVER_${SERIES/GPIO_IP}_GPIO_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24
25#if VSF_HAL_USE_GPIO == ENABLED
26
27// HW/IPCore
32// HW/IPCore end
33
34#include "../../__device.h"
35
36/*\note Refer to template/README.md for usage cases.
37 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
38 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
39 * For emulated drivers, **** No reimplementation ****.
40 *
41 * Usually, there is no IPCore driver for GPIO.
42 */
43
44/*\note Includes CAN ONLY be put here. */
45
46#ifdef __cplusplus
47extern "C" {
48#endif
49
50/*============================ MACROS ========================================*/
51
52// HW
53/*\note hw GPIO driver can reimplement following types:
54 * To enable reimplementation, please enable macro below:
55 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE for vsf_gpio_mode_t
56 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_STATUS for vsf_gpio_status_t
57 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_gpio_irq_mask_t
58 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_CTRL for vsf_gpio_ctrl_t
59 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG for vsf_gpio_cfg_t
60 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_gpio_capability_t
61 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
62 * *** DO NOT reimplement these in emulated drivers. ***
63 */
64
65#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE ENABLED
66#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_STATUS ENABLED
67#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
68#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
69#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG ENABLED
70#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY ENABLED
71// HW end
72
73/*============================ MACROFIED FUNCTIONS ===========================*/
74/*============================ TYPES =========================================*/
75
76// HW/IPCore, not for emulated drivers
77#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
78typedef enum vsf_gpio_mode_t {
79 VSF_GPIO_INPUT = (0 << 0),
80 VSF_GPIO_ANALOG = (1 << 0),
83 VSF_GPIO_EXTI = (4 << 0),
84 VSF_GPIO_AF = (5 << 0),
85
87 VSF_GPIO_PULL_UP = (1 << 4),
89
97#endif
98
99#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
100typedef struct vsf_gpio_t vsf_gpio_t;
101typedef void vsf_gpio_exti_isr_handler_t(void *target_ptr, vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
102typedef struct vsf_gpio_exti_irq_cfg_t {
104 void *target_ptr;
107typedef struct vsf_gpio_cfg_t {
111#endif
112
113#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
114typedef struct vsf_gpio_capability_t {
115#if VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY == ENABLED
117#endif
118 uint8_t is_async : 1;
125#endif
126// HW/IPCore end
127
128/*============================ INCLUDES ======================================*/
129/*============================ PROTOTYPES ====================================*/
130
131#ifdef __cplusplus
132}
133#endif
134
135#endif // VSF_HAL_USE_GPIO
136#endif // __HAL_DRIVER_${SERIES/GPIO_IP}_GPIO_H__
137/* EOF */
vsf_gpio_mode_t
Definition gpio.h:31
@ VSF_GPIO_NO_PULL_UP_DOWN
Definition gpio.h:39
@ VSF_GPIO_EXTI_MODE_HIGH_LEVEL
Definition gpio.h:50
@ VSF_GPIO_OUTPUT_PUSH_PULL
Definition gpio.h:43
@ VSF_GPIO_EXTI
Definition gpio.h:45
@ VSF_GPIO_EXTI_MODE_LOW_LEVEL
Definition gpio.h:49
@ VSF_GPIO_EXTI_MODE_NONE
Definition gpio.h:48
@ VSF_GPIO_EXTI_MODE_RISING
Definition gpio.h:51
@ VSF_GPIO_EXTI_MODE_RISING_FALLING
Definition gpio.h:53
@ VSF_GPIO_PULL_UP
Definition gpio.h:37
@ VSF_GPIO_AF
Definition gpio.h:46
@ VSF_GPIO_INPUT
Definition gpio.h:41
@ VSF_GPIO_ANALOG
Definition gpio.h:44
@ VSF_GPIO_EXTI_MODE_FALLING
Definition gpio.h:52
@ VSF_GPIO_OUTPUT_OPEN_DRAIN
Definition gpio.h:42
@ VSF_GPIO_PULL_DOWN
Definition gpio.h:38
vsf_arch_prio_t
Definition cortex_a_generic.h:88
unsigned short uint16_t
Definition stdint.h:7
unsigned char uint8_t
Definition stdint.h:5
Definition vsf_template_gpio.h:623
uint8_t support_output_and_clear
Support for atomic output and clear operations. Prevents signal glitches when switching from input to...
Definition vsf_template_gpio.h:658
uint8_t pin_count
Total number of pins in hardware. Includes all pins, even those that cannot be configured as GPIO....
Definition vsf_template_gpio.h:680
uint8_t support_interrupt
Support for external interrupt functionality. When set, the GPIO pins can be configured to generate i...
Definition vsf_template_gpio.h:668
vsf_gpio_pin_mask_t pin_mask
Available pin mask indicating which pins can be used as GPIO. Common bit patterns include:
Definition vsf_template_gpio.h:698
inherit(vsf_peripheral_capability_t) uint8_t is_async uint8_t support_output_and_set
Flag indicating if GPIO operations are asynchronous. When set, operations are only guaranteed to be s...
Definition vsf_template_gpio.h:625
gpio channel configuration
Definition vsf_template_gpio.h:595
uint16_t alternate_function
alternate function is only valid in GPIO_AF mode
Definition vsf_template_gpio.h:598
vsf_gpio_mode_t mode
Definition vsf_template_gpio.h:596
Definition vsf_template_gpio.h:588
vsf_gpio_exti_isr_handler_t * handler_fn
Definition vsf_template_gpio.h:589
vsf_arch_prio_t prio
Definition vsf_template_gpio.h:591
void * target_ptr
Definition vsf_template_gpio.h:590
Definition vsf_template_gpio.h:720
Definition vsf_template_hal_driver.h:203
void vsf_gpio_exti_isr_handler_t(void *target_ptr, vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Definition gpio.h:101
#define vsf_gpio_pin_mask_t
Definition vsf_template_gpio.h:279
Generated from commit: vsfteam/vsf@2b286be