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_NATIONS_N32H76X_N32H78X_GPIO_H__
19#define __HAL_DRIVER_NATIONS_N32H76X_N32H78X_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/*\note Refer to template/README.md for usage cases.
35 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
36 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
37 * For emulated drivers, **** No reimplementation ****.
38 *
39 * Usually, there is no IPCore driver for GPIO.
40 */
41
42/*\note Includes CAN ONLY be put here. */
43
44#ifdef __cplusplus
45extern "C" {
46#endif
47
48/*============================ MACROS ========================================*/
49
50// HW
51/*\note hw GPIO driver can reimplement following types:
52 * To enable reimplementation, please enable macro below:
53 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE for vsf_gpio_mode_t
54 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG for vsf_gpio_cfg_t
55 * VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_gpio_capability_t
56 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
57 * *** DO NOT reimplement these in emulated drivers. ***
58 */
59
60#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE ENABLED
61#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG DISABLED
62#define VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
63// HW end
64
65// HW/IPCore
66/*\note To redefine these two macros, vsf_gpio_pin_mask_t type must be defined according to actual situation,
67 * and macro with the same name must be defined.
68 */
69#if (VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG == ENABLED) || (VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED)
71#define vsf_gpio_pin_mask_t vsf_gpio_pin_mask_t
72#endif
73// HW/IPCore end
74
75/*============================ MACROFIED FUNCTIONS ===========================*/
76/*============================ TYPES =========================================*/
77
78// HW/IPCore, not for emulated drivers
79#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
80typedef enum vsf_gpio_mode_t {
81 // 0..1, GPIO_PMODE: INPUT(0)/OUTPUT(1)/AF(2)/ANALOG(3)
82 // 2: GPIO_POTYPE: PUSHPULL(0)/OPENDRAIN(1)
83 VSF_GPIO_INPUT = (0 << 0),
84 VSF_GPIO_ANALOG = (3 << 0),
85 VSF_GPIO_OUTPUT_PUSH_PULL = (1 << 0) | (0 << 2),
86 VSF_GPIO_OUTPUT_OPEN_DRAIN = (1 << 0) | (1 << 2),
87 VSF_GPIO_AF = (2 << 0),
88 VSF_GPIO_AF_PUSH_PULL = (2 << 0) | (0 << 2),
89 VSF_GPIO_AF_OPEN_DRAIN = (2 << 0) | (1 << 2),
91
92 // 3..4, GPIO_PUPD: FLOATING(0)/PULLUP(1)/PULLDOWN(2)
94 VSF_GPIO_PULL_UP = (1 << 3),
95 VSF_GPIO_PULL_DOWN = (2 << 3),
96
97 // 5, GPIO_SR: FAST(0)/SLOW(1)
102#define VSF_GPIO_SPEED_LOW VSF_GPIO_SPEED_LOW
103#define VSF_GPIO_SPEED_HIGH VSF_GPIO_SPEED_HIGH
104#define VSF_GPIO_SPEED_MASK VSF_GPIO_SPEED_MASK
105
106 // 6..7: GPIO_DS: LOW(0), MEDIUM(2), HIGH(1), VERY_HIGH(3)
117
118 // TODO: add exti support
125
128#endif
129
130#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
131typedef struct vsf_gpio_t vsf_gpio_t;
132typedef void vsf_gpio_exti_isr_handler_t(void *target_ptr, vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
133typedef struct vsf_gpio_exti_irq_cfg_t {
135 void *target_ptr;
138typedef struct vsf_gpio_cfg_t {
142#endif
143
144#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
145typedef struct vsf_gpio_capability_t {
146#if VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY == ENABLED
148#endif
149 uint8_t is_async : 1;
156#endif
157// HW/IPCore end
158
159/*============================ INCLUDES ======================================*/
160/*============================ PROTOTYPES ====================================*/
161
162#ifdef __cplusplus
163}
164#endif
165
166#endif // VSF_HAL_USE_GPIO
167#endif // __HAL_DRIVER_NATIONS_N32H76X_N32H78X_GPIO_H__
168/* 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
#define VSF_GPIO_SPEED_HIGH
Definition gpio.h:84
#define VSF_GPIO_SPEED_MASK
Definition gpio.h:86
@ __VSF_HW_GPIO_MODE_ALL_BITS
Definition gpio.h:98
@ VSF_GPIO_AF_PUSH_PULL
enable output push-pull mode
Definition gpio.h:67
@ VSF_GPIO_AF_OPEN_DRAIN
enable output open-drain mode
Definition gpio.h:68
#define VSF_GPIO_SPEED_LOW
Definition gpio.h:82
#define VSF_GPIO_DRIVE_STRENGTH_MEDIUM
Definition gpio.h:113
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:132
#define VSF_GPIO_HIGH_DRIVE_STRENGTH_MASK
Definition gpio.h:116
#define VSF_GPIO_DRIVE_STRENGTH_HIGH
Definition gpio.h:114
#define VSF_GPIO_DRIVE_STRENGTH_VERY_HIGH
Definition gpio.h:115
struct vsf_gpio_capability_t vsf_gpio_capability_t
struct vsf_gpio_exti_irq_cfg_t vsf_gpio_exti_irq_cfg_t
#define vsf_gpio_pin_mask_t
Definition gpio.h:71
struct vsf_gpio_cfg_t vsf_gpio_cfg_t
#define VSF_GPIO_DRIVE_STRENGTH_LOW
Definition gpio.h:112
@ VSF_GPIO_DRIVE_STRENGTH_MASK
Definition gpio.h:111
vsf_arch_prio_t
Definition cortex_a_generic.h:88
unsigned short uint16_t
Definition stdint.h:7
unsigned uint32_t
Definition stdint.h:9
unsigned char uint8_t
Definition stdint.h:5
Definition vsf_template_gpio.h:635
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:670
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:692
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:680
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:710
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:637
gpio channel configuration
Definition vsf_template_gpio.h:604
uint16_t alternate_function
alternate function is only valid in GPIO_AF mode
Definition vsf_template_gpio.h:607
vsf_gpio_mode_t mode
Definition vsf_template_gpio.h:605
Definition vsf_template_gpio.h:597
vsf_gpio_exti_isr_handler_t * handler_fn
Definition vsf_template_gpio.h:598
vsf_arch_prio_t prio
Definition vsf_template_gpio.h:600
void * target_ptr
Definition vsf_template_gpio.h:599
Definition vsf_template_gpio.h:732
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:103
uint32_t vsf_gpio_pin_mask_t
Definition vsf_template_gpio.h:308
Generated from commit: vsfteam/vsf@74aa6ce