VSF Documented
vsf_template_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 __VSF_TEMPLATE_GPIO_H__
19#define __VSF_TEMPLATE_GPIO_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "./vsf_template_hal_driver.h"
24#include "hal/arch/vsf_arch.h"
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/*============================ MACROS ========================================*/
31
39#ifndef VSF_GPIO_CFG_MULTI_CLASS
40# define VSF_GPIO_CFG_MULTI_CLASS ENABLED
41#endif
42
50#if defined(VSF_HW_GPIO_PORT_COUNT) && !defined(VSF_HW_GPIO_PORT_MASK)
51# define VSF_HW_GPIO_PORT_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_GPIO_PORT_COUNT)
52#endif
53
61#if defined(VSF_HW_GPIO_PORT_MASK) && !defined(VSF_HW_GPIO_PORT_COUNT)
62# define VSF_HW_GPIO_PORT_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_GPIO_PORT_MASK)
63#endif
64
72#if defined(VSF_HW_GPIO_PIN_COUNT) && !defined(VSF_HW_GPIO_PIN_MASK)
73# define VSF_HW_GPIO_PIN_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_GPIO_PIN_COUNT)
74#endif
75
83#if defined(VSF_HW_GPIO_PIN_MASK) && !defined(VSF_HW_GPIO_PIN_COUNT)
84# define VSF_HW_GPIO_PIN_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_GPIO_PIN_MASK)
85#endif
86
94#ifdef VSF_HW_GPIO_PORT_COUNT
95# define VSF_HW_GPIO_COUNT VSF_HW_GPIO_PORT_COUNT
96#endif
97
105#ifdef VSF_HW_GPIO_PORT_MASK
106# define VSF_HW_GPIO_MASK VSF_HW_GPIO_PORT_MASK
107#endif
108
117#if !defined(VSF_GPIO_CFG_PORT0) && (VSF_HW_GPIO_PORT_MASK & (1ul << 0))
118# define VSF_GPIO_CFG_PORT0 ENABLED
119#endif
120
121#if !defined(VSF_GPIO_CFG_PORT1) && (VSF_HW_GPIO_PORT_MASK & (1ul << 1))
122# define VSF_GPIO_CFG_PORT1 ENABLED
123#endif
124
125#if !defined(VSF_GPIO_CFG_PORT2) && (VSF_HW_GPIO_PORT_MASK & (1ul << 2))
126# define VSF_GPIO_CFG_PORT2 ENABLED
127#endif
128
129#if !defined(VSF_GPIO_CFG_PORT3) && (VSF_HW_GPIO_PORT_MASK & (1ul << 3))
130# define VSF_GPIO_CFG_PORT3 ENABLED
131#endif
132
133#if !defined(VSF_GPIO_CFG_PORT4) && (VSF_HW_GPIO_PORT_MASK & (1ul << 4))
134# define VSF_GPIO_CFG_PORT4 ENABLED
135#endif
136
137#if !defined(VSF_GPIO_CFG_PORT5) && (VSF_HW_GPIO_PORT_MASK & (1ul << 5))
138# define VSF_GPIO_CFG_PORT5 ENABLED
139#endif
140
141#if !defined(VSF_GPIO_CFG_PORT6) && (VSF_HW_GPIO_PORT_MASK & (1ul << 6))
142# define VSF_GPIO_CFG_PORT6 ENABLED
143#endif
144
145#if !defined(VSF_GPIO_CFG_PORT7) && (VSF_HW_GPIO_PORT_MASK & (1ul << 7))
146# define VSF_GPIO_CFG_PORT7 ENABLED
147#endif
148
149#if !defined(VSF_GPIO_CFG_PORT8) && (VSF_HW_GPIO_PORT_MASK & (1ul << 8))
150# define VSF_GPIO_CFG_PORT8 ENABLED
151#endif
152
153#if !defined(VSF_GPIO_CFG_PORT9) && (VSF_HW_GPIO_PORT_MASK & (1ul << 9))
154# define VSF_GPIO_CFG_PORT9 ENABLED
155#endif
156
157#if !defined(VSF_GPIO_CFG_PORT10) && (VSF_HW_GPIO_PORT_MASK & (1ul << 10))
158# define VSF_GPIO_CFG_PORT10 ENABLED
159#endif
160
161#if !defined(VSF_GPIO_CFG_PORT11) && (VSF_HW_GPIO_PORT_MASK & (1ul << 11))
162# define VSF_GPIO_CFG_PORT11 ENABLED
163#endif
164
165#if !defined(VSF_GPIO_CFG_PORT12) && (VSF_HW_GPIO_PORT_MASK & (1ul << 12))
166# define VSF_GPIO_CFG_PORT12 ENABLED
167#endif
168
169#if !defined(VSF_GPIO_CFG_PORT13) && (VSF_HW_GPIO_PORT_MASK & (1ul << 13))
170# define VSF_GPIO_CFG_PORT13 ENABLED
171#endif
172
173#if !defined(VSF_GPIO_CFG_PORT14) && (VSF_HW_GPIO_PORT_MASK & (1ul << 14))
174# define VSF_GPIO_CFG_PORT14 ENABLED
175#endif
176
177#if !defined(VSF_GPIO_CFG_PORT15) && (VSF_HW_GPIO_PORT_MASK & (1ul << 15))
178# define VSF_GPIO_CFG_PORT15 ENABLED
179#endif
184#ifndef VSF_GPIO_CFG_PIN_COUNT
185# if defined(VSF_HW_GPIO_PIN_COUNT) && (VSF_HW_GPIO_PIN_COUNT > 32)
186# define VSF_GPIO_CFG_PIN_COUNT 64
187# define VSF_GPIO_CFG_PIN_MASK 0xFFFFFFFFFFFFFFFF
188# elif defined(VSF_HW_GPIO_PIN_MASK) && (VSF_HW_GPIO_PIN_MASK & 0xFFFFFFFF00000000)
189# define VSF_GPIO_CFG_PIN_COUNT 64
190# define VSF_GPIO_CFG_PIN_MASK 0xFFFFFFFFFFFFFFFF
191# else
192# define VSF_GPIO_CFG_PIN_COUNT 32
193# define VSF_GPIO_CFG_PIN_MASK 0xFFFFFFFF
194# endif
195#endif
196
220#ifndef VSF_GPIO_CFG_PREFIX
221# if VSF_GPIO_CFG_MULTI_CLASS == ENABLED
222# define VSF_GPIO_CFG_PREFIX vsf
223# elif defined(VSF_HW_GPIO_PIN_MASK) && (VSF_HW_GPIO_PIN_MASK != 0)
224# define VSF_GPIO_CFG_PREFIX vsf_hw
225# else
226# define VSF_GPIO_CFG_PREFIX vsf
227# endif
228#endif
229
237#ifndef VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE
238# define VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE DISABLED
239#endif
240
248#ifndef VSF_GPIO_CFG_FUNCTION_RENAME
249# define VSF_GPIO_CFG_FUNCTION_RENAME ENABLED
250#endif
251
252
256#ifndef VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG
257# define VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG DISABLED
258#endif
259
263#ifndef VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY
264# define VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
265#endif
266
290#ifndef __VSF_GPIO_CFG_SUPPORT_STANDARD_OPTIONAL
291# define __VSF_GPIO_CFG_SUPPORT_STANDARD_OPTIONAL DISABLED
292#endif
293
294#ifndef VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY
295# define VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY ENABLED
296#endif
297
308#ifndef VSF_GPIO_CFG_REIMPLEMENT_TYPE_CTRL
309# define VSF_GPIO_CFG_REIMPLEMENT_TYPE_CTRL DISABLED
310#endif
311
312/*============================ MACROFIED FUNCTIONS ===========================*/
313
314#define __VSF_GPIO_PORT_PIN_NUM(__PIN_NUM, __PORT_NUM, __PORT_CHAR) \
315 VSF_P ## __PORT_NUM ## _ ## __PIN_NUM = ((VSF_PORT ## __PORT_NUM) << 8) | __PIN_NUM,\
316 VSF_P ## __PORT_CHAR ## __PIN_NUM = ((VSF_PORT ## __PORT_NUM) << 8) | __PIN_NUM,
317
318#define VSF_GPIO_APIS(__prefix_name) \
319 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_gpio_capability_t, gpio, capability, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr) \
320 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, gpio, port_config_pins, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask, vsf_gpio_cfg_t * cfg_ptr) \
321 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, gpio, get_pin_configuration, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, uint16_t pin_index, vsf_gpio_cfg_t * cfg_ptr) \
322 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, set_direction, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask, vsf_gpio_pin_mask_t direction_mask) \
323 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_gpio_pin_mask_t, gpio, get_direction, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
324 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, set_input, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
325 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, set_output, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
326 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, switch_direction, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
327 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_gpio_pin_mask_t, gpio, read, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr) \
328 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_gpio_pin_mask_t, gpio, read_output_register, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr) \
329 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, write, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask, vsf_gpio_pin_mask_t value) \
330 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, set, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
331 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, clear, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
332 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, toggle, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
333 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, output_and_set, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
334 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, output_and_clear, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
335 /* exti_irq APIs: may return VSF_ERR_NOT_SUPPORT when the hardware GPIO driver
336 * does not implement EXTI via GPIO. Users should fall back to the dedicated EXTI
337 * interface (vsf_template_exti.h) when GPIO-based EXTI is unavailable. */ \
338 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, gpio, exti_irq_config, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_exti_irq_cfg_t *irq_cfg_ptr) \
339 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, gpio, exti_irq_get_configuration, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_exti_irq_cfg_t *irq_cfg_ptr) \
340 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, gpio, exti_irq_enable, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
341 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, gpio, exti_irq_disable, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
342 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_gpio_pin_mask_t, gpio, exti_irq_clear, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
343 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, gpio, ctrl, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_ctrl_t ctrl, void* param)
344
345/*============================ TYPES =========================================*/
346
347#ifndef vsf_gpio_pin_mask_t
348# if defined(VSF_HW_GPIO_PIN_COUNT) && (VSF_HW_GPIO_PIN_COUNT > 32)
349typedef uint64_t vsf_gpio_pin_mask_t;
350# elif defined(VSF_HW_GPIO_PIN_MASK) && (VSF_HW_GPIO_PIN_MASK & 0xFFFFFFFF00000000)
351typedef uint64_t vsf_gpio_pin_mask_t;
352# else
353typedef uint32_t vsf_gpio_pin_mask_t;
354# endif
355# define vsf_gpio_pin_mask_t vsf_gpio_pin_mask_t
356#endif
357
358#ifndef vsf_gpio_alternate_function_t
359typedef uint16_t vsf_gpio_alternate_function_t;
360# define vsf_gpio_alternate_function_t vsf_gpio_alternate_function_t
361#endif
362
363#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
426typedef enum vsf_gpio_mode_t {
437 VSF_GPIO_INPUT = (0 << 0),
438
447 VSF_GPIO_ANALOG = (1 << 0),
448
457 VSF_GPIO_OUTPUT_PUSH_PULL = (2 << 0),
458
467 VSF_GPIO_OUTPUT_OPEN_DRAIN = (3 << 0),
468
477 VSF_GPIO_EXTI = (4 << 0),
478
495 /*
496 VSF_GPIO_AF = (5 << 0),
497 #define VSF_GPIO_AF VSF_GPIO_AF
498 VSF_GPIO_AF_OUTPUT_PUSH_PULL = (5 << 0),
499 #define VSF_GPIO_AF_OUTPUT_PUSH_PULL VSF_GPIO_AF_OUTPUT_PUSH_PULL
500 VSF_GPIO_AF_OUTPUT_OPEN_DRAIN = (6 << 0),
501 #define VSF_GPIO_AF_OUTPUT_OPEN_DRAIN VSF_GPIO_AF_OUTPUT_OPEN_DRAIN
502 VSF_GPIO_AF_INPUT = (7 << 0),
503 #define VSF_GPIO_AF_INPUT VSF_GPIO_AF_INPUT
504 */
505
514 VSF_GPIO_NO_PULL_UP_DOWN = (0 << 4),
515
524 VSF_GPIO_PULL_UP = (1 << 4),
525
534 VSF_GPIO_PULL_DOWN = (2 << 4),
535
542 VSF_GPIO_EXTI_MODE_NONE = (0 << 6),
543
550 VSF_GPIO_EXTI_MODE_LOW_LEVEL = (1 << 6),
551
558 VSF_GPIO_EXTI_MODE_HIGH_LEVEL = (2 << 6),
559
566 VSF_GPIO_EXTI_MODE_RISING = (3 << 6),
567
574 VSF_GPIO_EXTI_MODE_FALLING = (4 << 6),
575
582 VSF_GPIO_EXTI_MODE_RISING_FALLING = (5 << 6),
583
584/*
585 VSF_GPIO_INVERT_INPUT = (1 << 7),
586 #define VSF_GPIO_INVERT_INPUT VSF_GPIO_INVERT_INPUT
587
588 VSF_GPIO_DRIVE_STRENGTH_LOW = (0 << 8),
589 VSF_GPIO_DRIVE_STRENGTH_MEDIUM = (1 << 8),
590 VSF_GPIO_DRIVE_STRENGTH_HIGH = (2 << 8),
591 VSF_GPIO_DRIVE_STRENGTH_VERY_HIGH = (3 << 8),
592 VSF_GPIO_DRIVE_STRENGTH_MASK = (3 << 8),
593 #define VSF_GPIO_DRIVE_STRENGTH_LOW VSF_GPIO_DRIVE_STRENGTH_LOW
594 #define VSF_GPIO_DRIVE_STRENGTH_MEDIUM VSF_GPIO_DRIVE_STRENGTH_MEDIUM
595 #define VSF_GPIO_DRIVE_STRENGTH_HIGH VSF_GPIO_DRIVE_STRENGTH_HIGH
596 #define VSF_GPIO_DRIVE_STRENGTH_VERY_HIGH VSF_GPIO_DRIVE_STRENGTH_VERY_HIGH
597 #define VSF_GPIO_DRIVE_STRENGTH_MASK VSF_GPIO_DRIVE_STRENGTH_MASK
598
599 VSF_GPIO_SPEED_LOW = (0 << 10),
600 VSF_GPIO_SPEED_MEDIUM = (1 << 10),
601 VSF_GPIO_SPEED_HIGH = (2 << 10),
602 VSF_GPIO_SPEED_VERY_HIGH = (3 << 10),
603 VSF_GPIO_SPEED_MASK = (3 << 10),
604 #define VSF_GPIO_SPEED_LOW VSF_GPIO_SPEED_LOW
605 #define VSF_GPIO_SPEED_MEDIUM VSF_GPIO_SPEED_MEDIUM
606 #define VSF_GPIO_SPEED_HIGH VSF_GPIO_SPEED_HIGH
607 #define VSF_GPIO_SPEED_VERY_HIGH VSF_GPIO_SPEED_VERY_HIGH
608 #define VSF_GPIO_SPEED_MASK VSF_GPIO_SPEED_MASK
609*/
610} vsf_gpio_mode_t;
611#endif
612
613enum {
614 VSF_GPIO_FLOATING = VSF_GPIO_NO_PULL_UP_DOWN,
615
616#ifndef VSF_GPIO_MODE_AF_MASK
617 VSF_GPIO_MODE_AF_MASK = 0
618#ifdef VSF_GPIO_AF
619 | VSF_GPIO_AF
620#endif
621#ifdef VSF_GPIO_AF_OUTPUT_PUSH_PULL
622 | VSF_GPIO_AF_OUTPUT_PUSH_PULL
623#endif
624#ifdef VSF_GPIO_AF_OUTPUT_OPEN_DRAIN
625 | VSF_GPIO_AF_OUTPUT_OPEN_DRAIN
626#endif
627#ifdef VSF_GPIO_AF_INPUT
628 | VSF_GPIO_AF_INPUT
629#endif
630 ,
631#endif
632
633#ifndef VSF_GPIO_MODE_MASK
634 VSF_GPIO_MODE_MASK = VSF_GPIO_INPUT
635 | VSF_GPIO_EXTI
636 | VSF_GPIO_ANALOG
637 | VSF_GPIO_OUTPUT_PUSH_PULL
638 | VSF_GPIO_OUTPUT_OPEN_DRAIN
639 | VSF_GPIO_MODE_AF_MASK,
640#endif
641
642 VSF_GPIO_PULL_UP_DOWN_MASK = VSF_GPIO_NO_PULL_UP_DOWN
643 | VSF_GPIO_PULL_UP
644 | VSF_GPIO_PULL_DOWN,
645
646 VSF_GPIO_EXTI_MODE_MASK = VSF_GPIO_EXTI_MODE_NONE
647 | VSF_GPIO_EXTI_MODE_LOW_LEVEL
648 | VSF_GPIO_EXTI_MODE_HIGH_LEVEL
649 | VSF_GPIO_EXTI_MODE_RISING
650 | VSF_GPIO_EXTI_MODE_FALLING
651 | VSF_GPIO_EXTI_MODE_RISING_FALLING,
652
653 VSF_GPIO_MODE_ALL_BITS_MASK = VSF_GPIO_MODE_MASK
654 | VSF_GPIO_PULL_UP_DOWN_MASK
655 | VSF_GPIO_EXTI_MODE_MASK
656#ifdef VSF_GPIO_INVERT_INPUT
657 | VSF_GPIO_INVERT_INPUT
658#endif
659#ifdef VSF_GPIO_DRIVE_STRENGTH_MASK
660 | VSF_GPIO_DRIVE_STRENGTH_MASK
661#endif
662#ifdef VSF_GPIO_SPEED_MASK
663 | VSF_GPIO_SPEED_MASK
664#endif
665};
666
667#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
669typedef struct vsf_gpio_t vsf_gpio_t;
670
672typedef void vsf_gpio_exti_isr_handler_t(void *target_ptr, vsf_gpio_t *gpio_ptr,
673 vsf_gpio_pin_mask_t pin_mask);
674
677typedef struct vsf_gpio_exti_irq_cfg_t {
678 vsf_gpio_exti_isr_handler_t *handler_fn;
679 void *target_ptr;
680 vsf_arch_prio_t prio;
681} vsf_gpio_exti_irq_cfg_t;
682
684typedef struct vsf_gpio_cfg_t {
685 vsf_gpio_mode_t mode;
687 vsf_gpio_alternate_function_t alternate_function;
688} vsf_gpio_cfg_t;
689#endif
690
691typedef struct vsf_gpio_port_cfg_pin_t {
692 uint16_t port_pin_index;
693
696 vsf_gpio_mode_t mode;
698 vsf_gpio_alternate_function_t alternate_function;
699} vsf_gpio_port_cfg_pin_t;
700
704typedef struct vsf_gpio_port_cfg_pins_t {
705 uint16_t port_index;
706 vsf_gpio_pin_mask_t pin_mask;
709 vsf_gpio_mode_t mode;
711 vsf_gpio_alternate_function_t alternate_function;
712} vsf_gpio_port_cfg_pins_t;
713
714#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
715typedef struct vsf_gpio_capability_t {
716#if VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY == ENABLED
717 inherit(vsf_peripheral_capability_t)
718#endif
730 uint8_t is_async : 1;
731
740 uint8_t support_output_and_set : 1;
741
750 uint8_t support_output_and_clear : 1;
751
760 uint8_t can_read_in_gpio_output_mode : 1;
761
770 uint8_t can_read_in_alternate_mode : 1;
771
780 uint8_t support_interrupt : 1;
781
792 uint8_t pin_count;
793
810 vsf_gpio_pin_mask_t pin_mask;
811} vsf_gpio_capability_t;
812#endif
813
814#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED
823typedef enum vsf_gpio_ctrl_t {
841 __VSF_GPIO_CTRL_DUMMY = 0,
842
843 // ------------------------------------------------------------------------
844 // Optional members (documented only, not defined here).
845 // Concrete hardware drivers may add the following commands by enabling
846 // VSF_GPIO_CFG_REIMPLEMENT_TYPE_CTRL and redefining vsf_gpio_ctrl_t,
847 // together with a same-name macro so callers can probe support via #ifdef.
848 // They are optional because each command is only meaningful when the
849 // underlying hardware exhibits a specific constraint; drivers without
850 // that constraint should simply omit the command.
851 //
852 // VSF_GPIO_CTRL_EXTI_GET_STATUS
853 // Purpose : read which pins on this GPIO port currently have a
854 // pending EXTI (external interrupt) latch, so that
855 // glue layers such as gpio_to_exti can implement
856 // vsf_exti_status without adding a dedicated public
857 // GPIO API.
858 // Param : vsf_gpio_pin_mask_t * (out) - receives the pending
859 // pin mask.
860 // Returns : VSF_ERR_NONE on success;
861 // VSF_ERR_NOT_SUPPORT when the driver does not
862 // implement the command.
863 // Applicability : GPIO controllers whose EXTI pending status is
864 // aggregated per port and exposed through the same
865 // register block as GPIO; platforms with a dedicated
866 // EXTI IP block that already carries its own status
867 // API do not need this command.
868 //
869 // VSF_GPIO_CTRL_EXTI_TRIGGER
870 // Purpose : software-trigger EXTI on the given pins, i.e. force
871 // the EXTI pending latch to assert as if the pin had
872 // seen an external edge/level. Consumed by the
873 // gpio_to_exti glue layer to back vsf_exti_trigger
874 // and report cap.support_sw_trigger=1; the glue uses
875 // #ifdef on this macro to compile-time gate the
876 // feature.
877 // Param : vsf_gpio_pin_mask_t * (in) - mask of pins to trigger.
878 // Returns : VSF_ERR_NONE on success;
879 // VSF_ERR_NOT_SUPPORT when the driver does not
880 // implement the command.
881 // Applicability : GPIO/EXTI controllers that provide a software-
882 // trigger register (e.g. an SWIER-style latch set
883 // bit) reachable from the GPIO register block;
884 // platforms without such a register cannot honour
885 // the request and MUST omit both the enum member
886 // and the same-name macro so that the #ifdef guard
887 // disables the capability.
888 //
889 // 可选成员（仅文档化，这里不定义）。
890 // 具体硬件驱动可通过启用 VSF_GPIO_CFG_REIMPLEMENT_TYPE_CTRL 并重新
891 // 定义 vsf_gpio_ctrl_t 来增加以下命令，并提供同名宏以便调用方通过
892 // #ifdef 在编译期探测是否支持。之所以为可选，是因为每条命令仅在
893 // 底层硬件存在特定约束时才有意义；不具备该约束的驱动直接省略即可。
894 //
895 // VSF_GPIO_CTRL_EXTI_GET_STATUS
896 // 用途 : 读取当前 GPIO 口上哪些引脚存在未处理的 EXTI
897 // （外部中断）挂起标志，供 gpio_to_exti 等胶水层
898 // 在不引入专用公开 GPIO API 的前提下实现
899 // vsf_exti_status。
900 // 参数 : vsf_gpio_pin_mask_t *（输出） - 接收挂起的
901 // 引脚掩码。
902 // 返回值 : 成功返回 VSF_ERR_NONE；
903 // 驱动未实现此命令时返回 VSF_ERR_NOT_SUPPORT。
904 // 适用场景 : EXTI 挂起状态按 port 聚合、且寄存器块与 GPIO
905 // 共用的控制器；若平台有独立的 EXTI IP 且自带
906 // status API，则不必实现此命令。
907 //
908 // VSF_GPIO_CTRL_EXTI_TRIGGER
909 // 用途 : 对指定引脚软件触发 EXTI，使对应 pending latch
910 // 如同外部边沿/电平到来一样置位。由 gpio_to_exti
911 // 胶水层用于实现 vsf_exti_trigger、并据此把
912 // capability.support_sw_trigger 置为 1；胶水层
913 // 通过 #ifdef 此宏在编译期判断是否启用该能力。
914 // 参数 : vsf_gpio_pin_mask_t *（输入） - 要触发的引脚掩码。
915 // 返回值 : 成功返回 VSF_ERR_NONE；
916 // 驱动未实现此命令时返回 VSF_ERR_NOT_SUPPORT。
917 // 适用场景 : GPIO/EXTI 控制器提供软件触发寄存器（如 SWIER
918 // 那样的挂起置位位），且该寄存器可从 GPIO 寄存器
919 // 块访问；若平台没有这种寄存器，则不能实现该命令，
920 // 必须同时省略枚举成员与同名宏，使 #ifdef 保护
921 // 自动关闭该能力。
922 // ------------------------------------------------------------------------
923} vsf_gpio_ctrl_t;
924#endif
925
926typedef struct vsf_gpio_op_t {
928#undef __VSF_HAL_TEMPLATE_API
929#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
931
932 VSF_GPIO_APIS(vsf_gpio)
933} vsf_gpio_op_t;
934
935#if VSF_GPIO_CFG_MULTI_CLASS == ENABLED
944struct vsf_gpio_t {
945 const vsf_gpio_op_t * op;
946};
947#endif
948
949
950#if VSF_HW_GPIO_PORT_COUNT > 0
951typedef enum vsf_gpio_port_no_t {
952#if defined(VSF_GPIO_CFG_PORT0)
953 VSF_PORT0,
954#endif
955#if defined(VSF_GPIO_CFG_PORT1)
956 VSF_PORT1,
957#endif
958#if defined(VSF_GPIO_CFG_PORT2)
959 VSF_PORT2,
960#endif
961#if defined(VSF_GPIO_CFG_PORT3)
962 VSF_PORT3,
963#endif
964#if defined(VSF_GPIO_CFG_PORT4)
965 VSF_PORT4,
966#endif
967#if defined(VSF_GPIO_CFG_PORT5)
968 VSF_PORT5,
969#endif
970#if defined(VSF_GPIO_CFG_PORT6)
971 VSF_PORT6,
972#endif
973#if defined(VSF_GPIO_CFG_PORT7)
974 VSF_PORT7,
975#endif
976#if defined(VSF_GPIO_CFG_PORT8)
977 VSF_PORT8,
978#endif
979#if defined(VSF_GPIO_CFG_PORT9)
980 VSF_PORT9,
981#endif
982#if defined(VSF_GPIO_CFG_PORT10)
983 VSF_PORT10,
984#endif
985#if defined(VSF_GPIO_CFG_PORT11)
986 VSF_PORT11,
987#endif
988#if defined(VSF_GPIO_CFG_PORT12)
989 VSF_PORT12,
990#endif
991#if defined(VSF_GPIO_CFG_PORT13)
992 VSF_PORT13,
993#endif
994#if defined(VSF_GPIO_CFG_PORT14)
995 VSF_PORT14,
996#endif
997#if defined(VSF_GPIO_CFG_PORT15)
998 VSF_PORT15,
999#endif
1000#if defined(VSF_GPIO_CFG_PORT0)
1001 VSF_PORTA = VSF_PORT0,
1002#endif
1003#if defined(VSF_GPIO_CFG_PORT1)
1004 VSF_PORTB = VSF_PORT1,
1005#endif
1006#if defined(VSF_GPIO_CFG_PORT2)
1007 VSF_PORTC = VSF_PORT2,
1008#endif
1009#if defined(VSF_GPIO_CFG_PORT3)
1010 VSF_PORTD = VSF_PORT3,
1011#endif
1012#if defined(VSF_GPIO_CFG_PORT4)
1013 VSF_PORTE = VSF_PORT4,
1014#endif
1015#if defined(VSF_GPIO_CFG_PORT5)
1016 VSF_PORTF = VSF_PORT5,
1017#endif
1018#if defined(VSF_GPIO_CFG_PORT6)
1019 VSF_PORTG = VSF_PORT6,
1020#endif
1021#if defined(VSF_GPIO_CFG_PORT7)
1022 VSF_PORTH = VSF_PORT7,
1023#endif
1024#if defined(VSF_GPIO_CFG_PORT8)
1025 VSF_PORTI = VSF_PORT8,
1026#endif
1027#if defined(VSF_GPIO_CFG_PORT9)
1028 VSF_PORTJ = VSF_PORT9,
1029#endif
1030#if defined(VSF_GPIO_CFG_PORT10)
1031 VSF_PORTK = VSF_PORT10,
1032#endif
1033#if defined(VSF_GPIO_CFG_PORT11)
1034 VSF_PORTL = VSF_PORT11,
1035#endif
1036#if defined(VSF_GPIO_CFG_PORT12)
1037 VSF_PORTM = VSF_PORT12,
1038#endif
1039#if defined(VSF_GPIO_CFG_PORT13)
1040 VSF_PORTN = VSF_PORT13,
1041#endif
1042#if defined(VSF_GPIO_CFG_PORT14)
1043 VSF_PORTO = VSF_PORT14,
1044#endif
1045#if defined(VSF_GPIO_CFG_PORT15)
1046 VSF_PORTP = VSF_PORT15,
1047#endif
1048} vsf_gpio_port_no_t;
1049
1050typedef enum vsf_gpio_port_pin_no_t {
1051#if defined(VSF_GPIO_CFG_PORT0)
1052 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 0, A)
1053#endif
1054#if defined(VSF_GPIO_CFG_PORT1)
1055 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 1, B)
1056#endif
1057#if defined(VSF_GPIO_CFG_PORT2)
1058 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 2, C)
1059#endif
1060#if defined(VSF_GPIO_CFG_PORT3)
1061 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 3, D)
1062#endif
1063#if defined(VSF_GPIO_CFG_PORT4)
1064 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 4, E)
1065#endif
1066#if defined(VSF_GPIO_CFG_PORT5)
1067 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 5, F)
1068#endif
1069#if defined(VSF_GPIO_CFG_PORT6)
1070 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 6, G)
1071#endif
1072#if defined(VSF_GPIO_CFG_PORT7)
1073 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 7, H)
1074#endif
1075#if defined(VSF_GPIO_CFG_PORT8)
1076 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 8, I)
1077#endif
1078#if defined(VSF_GPIO_CFG_PORT9)
1079 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 9, J)
1080#endif
1081#if defined(VSF_GPIO_CFG_PORT10)
1082 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 10, K)
1083#endif
1084#if defined(VSF_GPIO_CFG_PORT11)
1085 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 11, L)
1086#endif
1087#if defined(VSF_GPIO_CFG_PORT12)
1088 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 12, M)
1089#endif
1090#if defined(VSF_GPIO_CFG_PORT13)
1091 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 13, N)
1092#endif
1093#if defined(VSF_GPIO_CFG_PORT14)
1094 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 14, O)
1095#endif
1096#if defined(VSF_GPIO_CFG_PORT15)
1097 VSF_MREPEAT(VSF_GPIO_CFG_PIN_COUNT, __VSF_GPIO_PORT_PIN_NUM, 15, P)
1098#endif
1099} vsf_gpio_port_pin_no_t;
1100#endif
1101
1102/*============================ GLOBAL VARIABLES ==============================*/
1103/*============================ MACROFIED FUNCTIONS ===========================*/
1104/*============================ PROTOTYPES ====================================*/
1105
1122extern vsf_err_t vsf_gpio_port_config_pins(vsf_gpio_t *gpio_ptr,
1123 vsf_gpio_pin_mask_t pin_mask,
1124 vsf_gpio_cfg_t *cfg_ptr);
1125
1144extern vsf_err_t vsf_gpio_get_pin_configuration(vsf_gpio_t *gpio_ptr,
1145 uint16_t pin_index,
1146 vsf_gpio_cfg_t *cfg_ptr);
1147
1149// \~english
1150// @brief Configure one or more ports and pin of the gpio instance
1151// @param[in] cfg: array of vsf_gpio_port_cfg_pins_t structures, refer @ref vsf_gpio_port_cfg_pins_t
1152// @param[in] count: number of struct array vsf_gpio_port_cfg_pins_t
1153// @return vsf_err_t: VSF_ERR_NONE if GPIO Configuration Successful, or a negative error code
1154// @note The VSF_PREFIX prefix of this can be replaced with the actual prefix, e.g. vsf_hw
1155//
1156// \~chinese
1157// @brief 配置 gpio 的一个或者多个端口和引脚
1158// @param[in] cfg: vsf_gpio_port_cfg_pins_t 结构体数组，参考 @ref vsf_gpio_port_cfg_pins_t
1159// @param[in] count: 结构体数组 vsf_gpio_port_cfg_pins_t 的数量
1160// @return vsf_err_t: 如果 GPIO 配置成功返回 VSF_ERR_NONE，失败返回负值错误码。
1161// @note VSF_PREFIX 前缀可以替换成实际的前缀，例如 vsf_hw
1162// */
1163#if __VSF_GPIO_CFG_SUPPORT_STANDARD_OPTIONAL
1181extern vsf_err_t vsf_gpio_ports_config_pins(vsf_gpio_port_cfg_pins_t *cfg_ptr,
1182 uint_fast8_t count);
1183
1201extern vsf_err_t vsf_gpio_ports_config_pin(vsf_gpio_port_cfg_pin_t *cfg_ptr,
1202 uint_fast8_t count);
1203#endif
1204
1205
1219extern void vsf_gpio_set_direction(vsf_gpio_t *gpio_ptr,
1220 vsf_gpio_pin_mask_t pin_mask,
1221 vsf_gpio_pin_mask_t direction_mask);
1222
1236extern vsf_gpio_pin_mask_t vsf_gpio_get_direction(vsf_gpio_t *gpio_ptr,
1237 vsf_gpio_pin_mask_t pin_mask);
1238
1250extern void vsf_gpio_set_input(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1251
1264extern void vsf_gpio_set_output(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1265
1278extern void vsf_gpio_switch_direction(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1279
1296extern vsf_gpio_pin_mask_t vsf_gpio_read(vsf_gpio_t *gpio_ptr);
1297
1316extern vsf_gpio_pin_mask_t vsf_gpio_read_output_register(vsf_gpio_t *gpio_ptr);
1317
1332extern void vsf_gpio_write(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask,
1333 vsf_gpio_pin_mask_t value);
1334
1347extern void vsf_gpio_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1348
1361extern void vsf_gpio_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1362
1375extern void vsf_gpio_toggle(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1376
1396extern void vsf_gpio_output_and_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1397
1417extern void vsf_gpio_output_and_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1418
1428extern vsf_gpio_capability_t vsf_gpio_capability(vsf_gpio_t *gpio_ptr);
1429
1443extern vsf_err_t vsf_gpio_exti_irq_config(vsf_gpio_t *gpio_ptr, vsf_gpio_exti_irq_cfg_t *cfg_ptr);
1444
1458extern vsf_err_t vsf_gpio_exti_irq_get_configuration(vsf_gpio_t *gpio_ptr, vsf_gpio_exti_irq_cfg_t *cfg_ptr);
1459
1478extern vsf_err_t vsf_gpio_exti_irq_enable(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1479
1496extern vsf_err_t vsf_gpio_exti_irq_disable(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1497
1523extern vsf_gpio_pin_mask_t vsf_gpio_exti_irq_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1524
1540extern vsf_err_t vsf_gpio_ctrl(vsf_gpio_t *gpio_ptr, vsf_gpio_ctrl_t ctrl, void * param);
1541
1542/*============================ INLINE FUNCTIONS ==============================*/
1543
1544static inline uint8_t vsf_gpio_get_port(uint16_t port_pin_index)
1545{
1546 return port_pin_index >> 8;
1547}
1548
1549static inline uint8_t vsf_gpio_get_pin(uint16_t port_pin_index)
1550{
1551 return port_pin_index & 0xFF;
1552}
1553
1554static inline vsf_err_t vsf_gpio_port_config_pin(vsf_gpio_t *gpio_ptr,
1555 uint16_t pin_index,
1556 vsf_gpio_cfg_t *cfg_ptr)
1557{
1558 return vsf_gpio_port_config_pins(gpio_ptr, (vsf_gpio_pin_mask_t)1 << pin_index, cfg_ptr);
1559}
1560
1561
1562/*============================ MACROS ========================================*/
1563
1565#if VSF_GPIO_CFG_FUNCTION_RENAME == ENABLED
1566# define __vsf_gpio_t VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_t)
1567# define vsf_gpio_capability(__GPIO) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_capability) ((__vsf_gpio_t *)(__GPIO))
1568# define vsf_gpio_port_config_pins(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_port_config_pins) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1569# define vsf_gpio_get_pin_configuration(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_get_pin_configuration) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1570# define vsf_gpio_set_direction(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_set_direction) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1571# define vsf_gpio_get_direction(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_get_direction) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1572# define vsf_gpio_set_input(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_set_input) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1573# define vsf_gpio_set_output(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_set_output) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1574# define vsf_gpio_switch_direction(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_switch_direction) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1575# define vsf_gpio_read(__GPIO) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_read) ((__vsf_gpio_t *)(__GPIO))
1576# define vsf_gpio_read_output_register(__GPIO) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_read_output_register) ((__vsf_gpio_t *)(__GPIO))
1577# define vsf_gpio_write(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_write) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1578# define vsf_gpio_set(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_set) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1579# define vsf_gpio_clear(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_clear) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1580# define vsf_gpio_output_and_set(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_output_and_set) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1581# define vsf_gpio_output_and_clear(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_output_and_clear) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1582# define vsf_gpio_toggle(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_toggle) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1583# define vsf_gpio_exti_irq_config(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_exti_irq_config) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1584# define vsf_gpio_exti_irq_get_configuration(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_exti_irq_get_configuration) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1585# define vsf_gpio_exti_irq_enable(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_exti_irq_enable) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1586# define vsf_gpio_exti_irq_disable(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_exti_irq_disable) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1587# define vsf_gpio_exti_irq_clear(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_exti_irq_clear) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1588# define vsf_gpio_ctrl(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_ctrl) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1589#endif
1591
1592// too long, put it end of file
1593#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 0)
1594# define VSF_PIN0 0
1595# define VSF_PIN0_MASK (1 << VSF_PIN0)
1596#endif
1597
1598#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 1)
1599# define VSF_PIN1 1
1600# define VSF_PIN1_MASK (1 << VSF_PIN1)
1601#endif
1602
1603#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 2)
1604# define VSF_PIN2 2
1605# define VSF_PIN2_MASK (1 << VSF_PIN2)
1606#endif
1607
1608#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 3)
1609# define VSF_PIN3 3
1610# define VSF_PIN3_MASK (1 << VSF_PIN3)
1611#endif
1612
1613#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 4)
1614# define VSF_PIN4 4
1615# define VSF_PIN4_MASK (1 << VSF_PIN4)
1616#endif
1617
1618#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 5)
1619# define VSF_PIN5 5
1620# define VSF_PIN5_MASK (1 << VSF_PIN5)
1621#endif
1622
1623#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 6)
1624# define VSF_PIN6 6
1625# define VSF_PIN6_MASK (1 << VSF_PIN6)
1626#endif
1627
1628#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 7)
1629# define VSF_PIN7 7
1630# define VSF_PIN7_MASK (1 << VSF_PIN7)
1631#endif
1632
1633#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 8)
1634# define VSF_PIN8 8
1635# define VSF_PIN8_MASK (1 << VSF_PIN8)
1636#endif
1637
1638#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 9)
1639# define VSF_PIN9 9
1640# define VSF_PIN9_MASK (1 << VSF_PIN9)
1641#endif
1642
1643#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 10)
1644# define VSF_PIN10 10
1645# define VSF_PIN10_MASK (1 << VSF_PIN10)
1646#endif
1647
1648#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 11)
1649# define VSF_PIN11 11
1650# define VSF_PIN11_MASK (1 << VSF_PIN11)
1651#endif
1652
1653#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 12)
1654# define VSF_PIN12 12
1655# define VSF_PIN12_MASK (1 << VSF_PIN12)
1656#endif
1657
1658#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 13)
1659# define VSF_PIN13 13
1660# define VSF_PIN13_MASK (1 << VSF_PIN13)
1661#endif
1662
1663#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 14)
1664# define VSF_PIN14 14
1665# define VSF_PIN14_MASK (1 << VSF_PIN14)
1666#endif
1667
1668#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 15)
1669# define VSF_PIN15 15
1670# define VSF_PIN15_MASK (1 << VSF_PIN15)
1671#endif
1672
1673#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 16)
1674# define VSF_PIN16 16
1675# define VSF_PIN16_MASK (1 << VSF_PIN16)
1676#endif
1677
1678#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 17)
1679# define VSF_PIN17 17
1680# define VSF_PIN17_MASK (1 << VSF_PIN17)
1681#endif
1682
1683#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 18)
1684# define VSF_PIN18 18
1685# define VSF_PIN18_MASK (1 << VSF_PIN18)
1686#endif
1687
1688#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 19)
1689# define VSF_PIN19 19
1690# define VSF_PIN19_MASK (1 << VSF_PIN19)
1691#endif
1692
1693#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 20)
1694# define VSF_PIN20 20
1695# define VSF_PIN20_MASK (1 << VSF_PIN20)
1696#endif
1697
1698#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 21)
1699# define VSF_PIN21 21
1700# define VSF_PIN21_MASK (1 << VSF_PIN21)
1701#endif
1702
1703#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 22)
1704# define VSF_PIN22 22
1705# define VSF_PIN22_MASK (1 << VSF_PIN22)
1706#endif
1707
1708#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 23)
1709# define VSF_PIN23 23
1710# define VSF_PIN23_MASK (1 << VSF_PIN23)
1711#endif
1712
1713#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 24)
1714# define VSF_PIN24 24
1715# define VSF_PIN24_MASK (1 << VSF_PIN24)
1716#endif
1717
1718#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 25)
1719# define VSF_PIN25 25
1720# define VSF_PIN25_MASK (1 << VSF_PIN25)
1721#endif
1722
1723#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 26)
1724# define VSF_PIN26 26
1725# define VSF_PIN26_MASK (1 << VSF_PIN26)
1726#endif
1727
1728#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 27)
1729# define VSF_PIN27 27
1730# define VSF_PIN27_MASK (1 << VSF_PIN27)
1731#endif
1732
1733#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 28)
1734# define VSF_PIN28 28
1735# define VSF_PIN28_MASK (1 << VSF_PIN28)
1736#endif
1737
1738#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 29)
1739# define VSF_PIN29 29
1740# define VSF_PIN29_MASK (1 << VSF_PIN29)
1741#endif
1742
1743#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 30)
1744# define VSF_PIN30 30
1745# define VSF_PIN30_MASK (1 << VSF_PIN30)
1746#endif
1747
1748#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 31)
1749# define VSF_PIN31 31
1750# define VSF_PIN31_MASK (1 << VSF_PIN31)
1751#endif
1752
1753#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 32)
1754# define VSF_PIN32 32
1755# define VSF_PIN32_MASK (1 << VSF_PIN32)
1756#endif
1757
1758#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 33)
1759# define VSF_PIN33 33
1760# define VSF_PIN33_MASK (1 << VSF_PIN33)
1761#endif
1762
1763#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 34)
1764# define VSF_PIN34 34
1765# define VSF_PIN34_MASK (1 << VSF_PIN34)
1766#endif
1767
1768#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 35)
1769# define VSF_PIN35 35
1770# define VSF_PIN35_MASK (1 << VSF_PIN35)
1771#endif
1772
1773#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 36)
1774# define VSF_PIN36 36
1775# define VSF_PIN36_MASK (1 << VSF_PIN36)
1776#endif
1777
1778#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 37)
1779# define VSF_PIN37 37
1780# define VSF_PIN37_MASK (1 << VSF_PIN37)
1781#endif
1782
1783#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 38)
1784# define VSF_PIN38 38
1785# define VSF_PIN38_MASK (1 << VSF_PIN38)
1786#endif
1787
1788#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 39)
1789# define VSF_PIN39 39
1790# define VSF_PIN39_MASK (1 << VSF_PIN39)
1791#endif
1792
1793#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 40)
1794# define VSF_PIN40 40
1795# define VSF_PIN40_MASK (1 << VSF_PIN40)
1796#endif
1797
1798#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 41)
1799# define VSF_PIN41 41
1800# define VSF_PIN41_MASK (1 << VSF_PIN41)
1801#endif
1802
1803#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 42)
1804# define VSF_PIN42 42
1805# define VSF_PIN42_MASK (1 << VSF_PIN42)
1806#endif
1807
1808#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 43)
1809# define VSF_PIN43 43
1810# define VSF_PIN43_MASK (1 << VSF_PIN43)
1811#endif
1812
1813#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 44)
1814# define VSF_PIN44 44
1815# define VSF_PIN44_MASK (1 << VSF_PIN44)
1816#endif
1817
1818#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 45)
1819# define VSF_PIN45 45
1820# define VSF_PIN45_MASK (1 << VSF_PIN45)
1821#endif
1822
1823#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 46)
1824# define VSF_PIN46 46
1825# define VSF_PIN46_MASK (1 << VSF_PIN46)
1826#endif
1827
1828#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 47)
1829# define VSF_PIN47 47
1830# define VSF_PIN47_MASK (1 << VSF_PIN47)
1831#endif
1832
1833#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 48)
1834# define VSF_PIN48 48
1835# define VSF_PIN48_MASK (1 << VSF_PIN48)
1836#endif
1837
1838#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 49)
1839# define VSF_PIN49 49
1840# define VSF_PIN49_MASK (1 << VSF_PIN49)
1841#endif
1842
1843#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 50)
1844# define VSF_PIN50 50
1845# define VSF_PIN50_MASK (1 << VSF_PIN50)
1846#endif
1847
1848#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 51)
1849# define VSF_PIN51 51
1850# define VSF_PIN51_MASK (1 << VSF_PIN51)
1851#endif
1852
1853#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 52)
1854# define VSF_PIN52 52
1855# define VSF_PIN52_MASK (1 << VSF_PIN52)
1856#endif
1857
1858#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 53)
1859# define VSF_PIN53 53
1860# define VSF_PIN53_MASK (1 << VSF_PIN53)
1861#endif
1862
1863#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 54)
1864# define VSF_PIN54 54
1865# define VSF_PIN54_MASK (1 << VSF_PIN54)
1866#endif
1867
1868#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 55)
1869# define VSF_PIN55 55
1870# define VSF_PIN55_MASK (1 << VSF_PIN55)
1871#endif
1872
1873#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 56)
1874# define VSF_PIN56 56
1875# define VSF_PIN56_MASK (1 << VSF_PIN56)
1876#endif
1877
1878#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 57)
1879# define VSF_PIN57 57
1880# define VSF_PIN57_MASK (1 << VSF_PIN57)
1881#endif
1882
1883#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 58)
1884# define VSF_PIN58 58
1885# define VSF_PIN58_MASK (1 << VSF_PIN58)
1886#endif
1887
1888#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 59)
1889# define VSF_PIN59 59
1890# define VSF_PIN59_MASK (1 << VSF_PIN59)
1891#endif
1892
1893#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 60)
1894# define VSF_PIN60 60
1895# define VSF_PIN60_MASK (1 << VSF_PIN60)
1896#endif
1897
1898#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 61)
1899# define VSF_PIN61 61
1900# define VSF_PIN61_MASK (1 << VSF_PIN61)
1901#endif
1902
1903#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 62)
1904# define VSF_PIN62 62
1905# define VSF_PIN62_MASK (1 << VSF_PIN62)
1906#endif
1907
1908#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 63)
1909# define VSF_PIN63 63
1910# define VSF_PIN63_MASK (1 << VSF_PIN63)
1911#endif
1912
1913#ifdef __cplusplus
1914}
1915#endif
1916
1917#endif /* __VSF_TEMPLATE_GPIO_H__ */
vsf_err_t
vsf_err_t
Definition __type.h:42
vsf_arch_prio_t
vsf_arch_prio_t
Definition cortex_a_generic.h:85
vsf_gpio_mode_t
vsf_gpio_mode_t
Definition gpio.h:31
VSF_GPIO_AF
@ VSF_GPIO_AF
Definition gpio.h:46
VSF_GPIO_AF_INPUT
#define VSF_GPIO_AF_INPUT
Definition gpio.h:96
VSF_GPIO_DRIVE_STRENGTH_MASK
#define VSF_GPIO_DRIVE_STRENGTH_MASK
Definition gpio.h:112
VSF_GPIO_AF_OUTPUT_PUSH_PULL
#define VSF_GPIO_AF_OUTPUT_PUSH_PULL
Definition gpio.h:94
VSF_GPIO_AF_OUTPUT_OPEN_DRAIN
#define VSF_GPIO_AF_OUTPUT_OPEN_DRAIN
Definition gpio.h:95
VSF_GPIO_SPEED_MASK
#define VSF_GPIO_SPEED_MASK
Definition gpio.h:86
vsf_gpio_exti_isr_handler_t
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:113
vsf_gpio_mode_t
vsf_gpio_mode_t
Definition gpio.h:90
vsf_gpio_pin_mask_t
uint32_t vsf_gpio_pin_mask_t
Definition gpio.h:75
K
#define K(t, v)
Definition keyboard.h:40
uint16_t
unsigned short uint16_t
Definition stdint.h:7
uint_fast8_t
unsigned char uint_fast8_t
Definition stdint.h:23
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint64_t
unsigned long long uint64_t
Definition stdint.h:11
uint8_t
unsigned char uint8_t
Definition stdint.h:5
vsf_gpio_capability_t
Definition vsf_template_gpio.h:713
vsf_gpio_capability_t::support_output_and_clear
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:748
vsf_gpio_capability_t::pin_count
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:790
vsf_gpio_capability_t::support_interrupt
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:778
vsf_gpio_capability_t::can_read_in_alternate_mode
uint8_t can_read_in_alternate_mode
Indicates whether vsf_gpio_read is valid in alternate function mode. When set, reading pin state is s...
Definition vsf_template_gpio.h:768
vsf_gpio_capability_t::pin_mask
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:808
vsf_gpio_capability_t::support_output_and_set
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:715
vsf_gpio_capability_t::can_read_in_gpio_output_mode
uint8_t can_read_in_gpio_output_mode
Indicates whether vsf_gpio_read is valid when configured as GPIO output mode. When set,...
Definition vsf_template_gpio.h:758
vsf_gpio_cfg_t
gpio configuration
Definition vsf_template_gpio.h:682
vsf_gpio_cfg_t::alternate_function
vsf_gpio_alternate_function_t alternate_function
alternate function is only valid in GPIO_AF mode
Definition vsf_template_gpio.h:685
vsf_gpio_cfg_t::mode
vsf_gpio_mode_t mode
Definition vsf_template_gpio.h:683
vsf_gpio_exti_irq_cfg_t
Definition vsf_template_gpio.h:675
vsf_gpio_exti_irq_cfg_t::handler_fn
vsf_gpio_exti_isr_handler_t * handler_fn
Definition vsf_template_gpio.h:676
vsf_gpio_exti_irq_cfg_t::prio
vsf_arch_prio_t prio
Definition vsf_template_gpio.h:678
vsf_gpio_exti_irq_cfg_t::target_ptr
void * target_ptr
Definition vsf_template_gpio.h:677
vsf_gpio_op_t
Definition vsf_template_gpio.h:924
vsf_gpio_port_cfg_pin_t
Definition vsf_template_gpio.h:689
vsf_gpio_port_cfg_pin_t::alternate_function
vsf_gpio_alternate_function_t alternate_function
alternate function is only valid in GPIO_AF mode
Definition vsf_template_gpio.h:696
vsf_gpio_port_cfg_pin_t::port_pin_index
uint16_t port_pin_index
Definition vsf_template_gpio.h:690
vsf_gpio_port_cfg_pin_t::mode
vsf_gpio_mode_t mode
Definition vsf_template_gpio.h:694
vsf_gpio_port_cfg_pins_t
Definition vsf_template_gpio.h:702
vsf_gpio_port_cfg_pins_t::mode
vsf_gpio_mode_t mode
Definition vsf_template_gpio.h:707
vsf_gpio_port_cfg_pins_t::port_index
uint16_t port_index
Definition vsf_template_gpio.h:703
vsf_gpio_port_cfg_pins_t::pin_mask
vsf_gpio_pin_mask_t pin_mask
Definition vsf_template_gpio.h:704
vsf_gpio_port_cfg_pins_t::alternate_function
vsf_gpio_alternate_function_t alternate_function
alternate function is only valid in GPIO_AF mode
Definition vsf_template_gpio.h:709
vsf_gpio_t
Definition vsf_template_gpio.h:942
vsf_gpio_t::op
const vsf_gpio_op_t * op
Definition vsf_template_gpio.h:943
vsf_peripheral_capability_t
Definition vsf_template_hal_driver.h:204
vsf_arch.h
value
vk_av_control_value_t value
Definition vsf_audio.h:171
VSF_MREPEAT
#define VSF_MREPEAT(__COUNT, __MACRO, __PARAM)
Definition vsf_repeat_macro.h:51
vsf_gpio_exti_isr_handler_t
void vsf_gpio_exti_isr_handler_t(void *target_ptr, vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
External interrupt callback function for gpio.
Definition vsf_template_gpio.h:670
vsf_gpio_set_direction
void vsf_gpio_set_direction(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask, vsf_gpio_pin_mask_t direction_mask)
‍**
Definition gpio_common.c:54
vsf_gpio_write
void vsf_gpio_write(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask, vsf_gpio_pin_mask_t value)
set the value of one or more of the gpio instances
Definition gpio_common.c:117
vsf_gpio_clear
void vsf_gpio_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Set the value of one or more pins of the gpio instance to low.
Definition gpio_common.c:135
vsf_gpio_set_output
void vsf_gpio_set_output(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Set the direction of one or more pins of the gpio instance to output.
Definition gpio_common.c:81
vsf_gpio_alternate_function_t
#define vsf_gpio_alternate_function_t
Definition vsf_template_gpio.h:358
vsf_gpio_output_and_set
void vsf_gpio_output_and_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Set the direction of one or more pins of the gpio instance to output high.
Definition gpio_common.c:153
vsf_gpio_port_config_pins
vsf_err_t vsf_gpio_port_config_pins(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask, vsf_gpio_cfg_t *cfg_ptr)
Configure one or more pins of the gpio instance.
Definition gpio_common.c:35
vsf_gpio_exti_irq_get_configuration
vsf_err_t vsf_gpio_exti_irq_get_configuration(vsf_gpio_t *gpio_ptr, vsf_gpio_exti_irq_cfg_t *cfg_ptr)
Get the current external interrupt configuration of the gpio instance.
Definition gpio_common.c:190
VSF_GPIO_CFG_PIN_COUNT
#define VSF_GPIO_CFG_PIN_COUNT
Definition vsf_template_gpio.h:192
VSF_GPIO_EXTI_MODE_MASK
@ VSF_GPIO_EXTI_MODE_MASK
Definition vsf_template_gpio.h:644
VSF_GPIO_MODE_MASK
@ VSF_GPIO_MODE_MASK
Definition vsf_template_gpio.h:632
VSF_GPIO_MODE_AF_MASK
@ VSF_GPIO_MODE_AF_MASK
Definition vsf_template_gpio.h:615
VSF_GPIO_PULL_UP_DOWN_MASK
@ VSF_GPIO_PULL_UP_DOWN_MASK
Definition vsf_template_gpio.h:640
VSF_GPIO_MODE_ALL_BITS_MASK
@ VSF_GPIO_MODE_ALL_BITS_MASK
Definition vsf_template_gpio.h:651
VSF_GPIO_FLOATING
@ VSF_GPIO_FLOATING
Definition vsf_template_gpio.h:612
vsf_gpio_ctrl
vsf_err_t vsf_gpio_ctrl(vsf_gpio_t *gpio_ptr, vsf_gpio_ctrl_t ctrl, void *param)
Calls the specified GPIO command.
Definition gpio_common.c:227
vsf_gpio_exti_irq_enable
vsf_err_t vsf_gpio_exti_irq_enable(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Enable interrupt of one or more pins.
Definition gpio_common.c:200
vsf_gpio_capability_t
struct vsf_gpio_capability_t vsf_gpio_capability_t
vsf_gpio_exti_irq_config
vsf_err_t vsf_gpio_exti_irq_config(vsf_gpio_t *gpio_ptr, vsf_gpio_exti_irq_cfg_t *cfg_ptr)
Configure external interrupt of the gpio instance.
Definition gpio_common.c:180
vsf_gpio_alternate_function_t
uint16_t vsf_gpio_alternate_function_t
Definition vsf_template_gpio.h:357
vsf_gpio_capability
vsf_gpio_capability_t vsf_gpio_capability(vsf_gpio_t *gpio_ptr)
Get the capability of gpio instance.
Definition gpio_common.c:171
vsf_gpio_read
vsf_gpio_pin_mask_t vsf_gpio_read(vsf_gpio_t *gpio_ptr)
Read the values of all pins of the gpio instance.
Definition gpio_common.c:99
vsf_gpio_exti_irq_cfg_t
struct vsf_gpio_exti_irq_cfg_t vsf_gpio_exti_irq_cfg_t
__VSF_GPIO_PORT_PIN_NUM
#define __VSF_GPIO_PORT_PIN_NUM(__PIN_NUM, __PORT_NUM, __PORT_CHAR)
Definition vsf_template_gpio.h:314
vsf_gpio_pin_mask_t
#define vsf_gpio_pin_mask_t
Definition vsf_template_gpio.h:353
vsf_gpio_toggle
void vsf_gpio_toggle(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Toggle the value of one or more pins of the gpio instance.
Definition gpio_common.c:144
vsf_gpio_cfg_t
struct vsf_gpio_cfg_t vsf_gpio_cfg_t
gpio configuration
vsf_gpio_read_output_register
vsf_gpio_pin_mask_t vsf_gpio_read_output_register(vsf_gpio_t *gpio_ptr)
Read the output register values of all pins of the gpio instance.
Definition gpio_common.c:108
vsf_gpio_exti_irq_disable
vsf_err_t vsf_gpio_exti_irq_disable(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Disable interrupt of one or more pins.
Definition gpio_common.c:209
VSF_GPIO_APIS
#define VSF_GPIO_APIS(__prefix_name)
Definition vsf_template_gpio.h:318
vsf_gpio_output_and_clear
void vsf_gpio_output_and_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Set the direction of one or more pins of the gpio instance to output low.
Definition gpio_common.c:162
vsf_gpio_mode_t
vsf_gpio_mode_t
Predefined VSF GPIO modes that can be reimplemented in specific hal drivers.
Definition vsf_template_gpio.h:424
VSF_GPIO_NO_PULL_UP_DOWN
@ VSF_GPIO_NO_PULL_UP_DOWN
Set GPIO pin to Alternative Function mode. Configures pin for peripheral-specific functions like UART...
Definition vsf_template_gpio.h:512
VSF_GPIO_EXTI_MODE_HIGH_LEVEL
@ VSF_GPIO_EXTI_MODE_HIGH_LEVEL
Detect interrupts on high signal level.
Definition vsf_template_gpio.h:556
VSF_GPIO_OUTPUT_PUSH_PULL
@ VSF_GPIO_OUTPUT_PUSH_PULL
Set GPIO pin as general-purpose push-pull output. Selects GPIO for the alternative function.
Definition vsf_template_gpio.h:455
VSF_GPIO_EXTI
@ VSF_GPIO_EXTI
Set GPIO pin as external interrupt IO. Configures the pin to detect and generate interrupts on signal...
Definition vsf_template_gpio.h:475
VSF_GPIO_EXTI_MODE_LOW_LEVEL
@ VSF_GPIO_EXTI_MODE_LOW_LEVEL
Detect interrupts on low signal level.
Definition vsf_template_gpio.h:548
VSF_GPIO_EXTI_MODE_NONE
@ VSF_GPIO_EXTI_MODE_NONE
No external interrupt detection enabled.
Definition vsf_template_gpio.h:540
VSF_GPIO_EXTI_MODE_RISING
@ VSF_GPIO_EXTI_MODE_RISING
Detect interrupts on rising edge of signal.
Definition vsf_template_gpio.h:564
VSF_GPIO_EXTI_MODE_RISING_FALLING
@ VSF_GPIO_EXTI_MODE_RISING_FALLING
Detect interrupts on both rising and falling edges.
Definition vsf_template_gpio.h:580
VSF_GPIO_PULL_UP
@ VSF_GPIO_PULL_UP
Enable internal pull-up resistor. Independent of IO direction and alternative function.
Definition vsf_template_gpio.h:522
VSF_GPIO_INPUT
@ VSF_GPIO_INPUT
Set the GPIO pin as general-purpose input. Selects GPIO for the alternative function....
Definition vsf_template_gpio.h:435
VSF_GPIO_ANALOG
@ VSF_GPIO_ANALOG
Set the GPIO pin as analog IO (input or output). Selects analog or GPIO as an alternative function an...
Definition vsf_template_gpio.h:445
VSF_GPIO_EXTI_MODE_FALLING
@ VSF_GPIO_EXTI_MODE_FALLING
Detect interrupts on falling edge of signal.
Definition vsf_template_gpio.h:572
VSF_GPIO_OUTPUT_OPEN_DRAIN
@ VSF_GPIO_OUTPUT_OPEN_DRAIN
Set GPIO pin as general-purpose open-drain output. Selects GPIO for the alternative function.
Definition vsf_template_gpio.h:465
VSF_GPIO_PULL_DOWN
@ VSF_GPIO_PULL_DOWN
Enable internal pull-down resistor. Independent of IO direction and alternative function.
Definition vsf_template_gpio.h:532
vsf_gpio_ctrl_t
vsf_gpio_ctrl_t
GPIO control commands for hardware-specific operations.
Definition vsf_template_gpio.h:821
__VSF_GPIO_CTRL_DUMMY
@ __VSF_GPIO_CTRL_DUMMY
Dummy value for compilation, required when no actual control commands are defined.
Definition vsf_template_gpio.h:839
vsf_gpio_set
void vsf_gpio_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Set the value of one or more pins of the gpio instance to high.
Definition gpio_common.c:126
vsf_gpio_get_direction
vsf_gpio_pin_mask_t vsf_gpio_get_direction(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Get GPIO port pin direction.
Definition gpio_common.c:63
vsf_gpio_pin_mask_t
uint32_t vsf_gpio_pin_mask_t
Definition vsf_template_gpio.h:351
vsf_gpio_set_input
void vsf_gpio_set_input(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
set specified pins to input mode
Definition gpio_common.c:72
vsf_gpio_switch_direction
void vsf_gpio_switch_direction(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Toggle the orientation of one or more pins of a gpio instance.
Definition gpio_common.c:90
vsf_gpio_get_pin_configuration
vsf_err_t vsf_gpio_get_pin_configuration(vsf_gpio_t *gpio_ptr, uint16_t pin_index, vsf_gpio_cfg_t *cfg_ptr)
Get configuration of a specific pin of the gpio instance.
Definition gpio_common.c:44
vsf_gpio_exti_irq_clear
vsf_gpio_pin_mask_t vsf_gpio_exti_irq_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask)
Clear interrupt flags of GPIO EXTI instance and return previous state.
Definition gpio_common.c:218
vsf_template_hal_driver.h
Generated from commit: vsfteam/vsf@3b461d0