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
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
267
268#ifndef VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY
269# define VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY ENABLED
270#endif
271
272/*============================ MACROFIED FUNCTIONS ===========================*/
273
274#define __VSF_GPIO_PORT_PIN_NUM(__PIN_NUM, __PORT_NUM, __PORT_CHAR) \
275 VSF_P ## __PORT_NUM ## _ ## __PIN_NUM = ((VSF_PORT ## __PORT_NUM) << 8) | __PIN_NUM,\
276 VSF_P ## __PORT_CHAR ## __PIN_NUM = ((VSF_PORT ## __PORT_NUM) << 8) | __PIN_NUM,
277
278#define VSF_GPIO_APIS(__prefix_name) \
279 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_gpio_capability_t, gpio, capability, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr) \
280 __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) \
281 __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) \
282 __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) \
283 __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) \
284 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, set_input, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
285 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, set_output, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
286 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, switch_direction, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
287 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_gpio_pin_mask_t, gpio, read, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr) \
288 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_gpio_pin_mask_t, gpio, read_output_register, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr) \
289 __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) \
290 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, set, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
291 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, clear, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
292 __VSF_HAL_TEMPLATE_API(__prefix_name, void, gpio, toggle, VSF_MCONNECT(__prefix_name, _t) *gpio_ptr, vsf_gpio_pin_mask_t pin_mask) \
293 __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) \
294 __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) \
295 __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) \
296 __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) \
297 __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) \
298 __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)
299
300/*============================ TYPES =========================================*/
301
302#ifndef vsf_gpio_pin_mask_t
303# if defined(VSF_HW_GPIO_PIN_COUNT) && (VSF_HW_GPIO_PIN_COUNT > 32)
305# elif defined(VSF_HW_GPIO_PIN_MASK) && (VSF_HW_GPIO_PIN_MASK & 0xFFFFFFFF00000000)
307# else
309# endif
310# define vsf_gpio_pin_mask_t vsf_gpio_pin_mask_t
311#endif
312
313#ifndef vsf_gpio_alternate_function_t
315# define vsf_gpio_alternate_function_t vsf_gpio_alternate_function_t
316#endif
317
318#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
365typedef enum vsf_gpio_mode_t {
376 VSF_GPIO_INPUT = (0 << 0),
377
386 VSF_GPIO_ANALOG = (1 << 0),
387
397
407
416 VSF_GPIO_EXTI = (4 << 0),
417
434 /*
435 VSF_GPIO_AF = (5 << 0),
436 #define VSF_GPIO_AF VSF_GPIO_AF
437 VSF_GPIO_AF_OUTPUT_PUSH_PULL = (5 << 0),
438 #define VSF_GPIO_AF_OUTPUT_PUSH_PULL VSF_GPIO_AF_OUTPUT_PUSH_PULL
439 VSF_GPIO_AF_OUTPUT_OPEN_DRAIN = (6 << 0),
440 #define VSF_GPIO_AF_OUTPUT_OPEN_DRAIN VSF_GPIO_AF_OUTPUT_OPEN_DRAIN
441 VSF_GPIO_AF_INPUT = (7 << 0),
442 #define VSF_GPIO_AF_INPUT VSF_GPIO_AF_INPUT
443 */
444
454
464
474
482
490
498
506
514
522
523/*
524 VSF_GPIO_INVERT_INPUT = (1 << 7),
525 #define VSF_GPIO_INVERT_INPUT VSF_GPIO_INVERT_INPUT
526
527 VSF_GPIO_DRIVE_STRENGTH_LOW = (0 << 8),
528 VSF_GPIO_DRIVE_STRENGTH_MEDIUM = (1 << 8),
529 VSF_GPIO_DRIVE_STRENGTH_HIGH = (2 << 8),
530 VSF_GPIO_DRIVE_STRENGTH_VERY_HIGH = (3 << 8),
531 VSF_GPIO_DRIVE_STRENGTH_MASK = (3 << 8),
532 #define VSF_GPIO_DRIVE_STRENGTH_LOW VSF_GPIO_DRIVE_STRENGTH_LOW
533 #define VSF_GPIO_DRIVE_STRENGTH_MEDIUM VSF_GPIO_DRIVE_STRENGTH_MEDIUM
534 #define VSF_GPIO_DRIVE_STRENGTH_HIGH VSF_GPIO_DRIVE_STRENGTH_HIGH
535 #define VSF_GPIO_DRIVE_STRENGTH_VERY_HIGH VSF_GPIO_DRIVE_STRENGTH_VERY_HIGH
536 #define VSF_GPIO_DRIVE_STRENGTH_MASK VSF_GPIO_DRIVE_STRENGTH_MASK
537
538 VSF_GPIO_SPEED_LOW = (0 << 10),
539 VSF_GPIO_SPEED_MEDIUM = (1 << 10),
540 VSF_GPIO_SPEED_HIGH = (2 << 10),
541 VSF_GPIO_SPEED_VERY_HIGH = (3 << 10),
542 VSF_GPIO_SPEED_MASK = (3 << 10),
543 #define VSF_GPIO_SPEED_LOW VSF_GPIO_SPEED_LOW
544 #define VSF_GPIO_SPEED_MEDIUM VSF_GPIO_SPEED_MEDIUM
545 #define VSF_GPIO_SPEED_HIGH VSF_GPIO_SPEED_HIGH
546 #define VSF_GPIO_SPEED_VERY_HIGH VSF_GPIO_SPEED_VERY_HIGH
547 #define VSF_GPIO_SPEED_MASK VSF_GPIO_SPEED_MASK
548*/
550#endif
551
552enum {
554
555#ifndef VSF_GPIO_MODE_AF_MASK
557#ifdef VSF_GPIO_AF
559#endif
560#ifdef VSF_GPIO_AF_OUTPUT_PUSH_PULL
562#endif
563#ifdef VSF_GPIO_AF_OUTPUT_OPEN_DRAIN
565#endif
566#ifdef VSF_GPIO_AF_INPUT
568#endif
570#endif
571
572#ifndef VSF_GPIO_MODE_MASK
579#endif
580
584
591
595#ifdef VSF_GPIO_INVERT_INPUT
596 | VSF_GPIO_INVERT_INPUT
597#endif
598#ifdef VSF_GPIO_DRIVE_STRENGTH_MASK
600#endif
601#ifdef VSF_GPIO_SPEED_MASK
603#endif
605
606#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
608typedef struct vsf_gpio_t vsf_gpio_t;
609
611typedef void vsf_gpio_exti_isr_handler_t(void *target_ptr, vsf_gpio_t *gpio_ptr,
612 vsf_gpio_pin_mask_t pin_mask);
613
621
623typedef struct vsf_gpio_cfg_t {
628#endif
629
632
639
652
653#if VSF_GPIO_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
654typedef struct vsf_gpio_capability_t {
655#if VSF_GPIO_CFG_INHERIT_HAL_CAPABILITY == ENABLED
657#endif
669 uint8_t is_async : 1;
670
680
690
700
710
720
732
751#endif
752
753typedef struct vsf_gpio_op_t {
755#undef __VSF_HAL_TEMPLATE_API
756#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
758
759 VSF_GPIO_APIS(vsf_gpio)
761
762#if VSF_GPIO_CFG_MULTI_CLASS == ENABLED
773};
774#endif
775
776
777#if VSF_HW_GPIO_PORT_COUNT > 0
778typedef enum vsf_gpio_port_no_t {
779#if defined(VSF_GPIO_CFG_PORT0)
780 VSF_PORT0,
781#endif
782#if defined(VSF_GPIO_CFG_PORT1)
783 VSF_PORT1,
784#endif
785#if defined(VSF_GPIO_CFG_PORT2)
786 VSF_PORT2,
787#endif
788#if defined(VSF_GPIO_CFG_PORT3)
789 VSF_PORT3,
790#endif
791#if defined(VSF_GPIO_CFG_PORT4)
792 VSF_PORT4,
793#endif
794#if defined(VSF_GPIO_CFG_PORT5)
795 VSF_PORT5,
796#endif
797#if defined(VSF_GPIO_CFG_PORT6)
798 VSF_PORT6,
799#endif
800#if defined(VSF_GPIO_CFG_PORT7)
801 VSF_PORT7,
802#endif
803#if defined(VSF_GPIO_CFG_PORT8)
804 VSF_PORT8,
805#endif
806#if defined(VSF_GPIO_CFG_PORT9)
807 VSF_PORT9,
808#endif
809#if defined(VSF_GPIO_CFG_PORT10)
810 VSF_PORT10,
811#endif
812#if defined(VSF_GPIO_CFG_PORT11)
813 VSF_PORT11,
814#endif
815#if defined(VSF_GPIO_CFG_PORT12)
816 VSF_PORT12,
817#endif
818#if defined(VSF_GPIO_CFG_PORT13)
819 VSF_PORT13,
820#endif
821#if defined(VSF_GPIO_CFG_PORT14)
822 VSF_PORT14,
823#endif
824#if defined(VSF_GPIO_CFG_PORT15)
825 VSF_PORT15,
826#endif
827#if defined(VSF_GPIO_CFG_PORT0)
828 VSF_PORTA = VSF_PORT0,
829#endif
830#if defined(VSF_GPIO_CFG_PORT1)
831 VSF_PORTB = VSF_PORT1,
832#endif
833#if defined(VSF_GPIO_CFG_PORT2)
834 VSF_PORTC = VSF_PORT2,
835#endif
836#if defined(VSF_GPIO_CFG_PORT3)
837 VSF_PORTD = VSF_PORT3,
838#endif
839#if defined(VSF_GPIO_CFG_PORT4)
840 VSF_PORTE = VSF_PORT4,
841#endif
842#if defined(VSF_GPIO_CFG_PORT5)
843 VSF_PORTF = VSF_PORT5,
844#endif
845#if defined(VSF_GPIO_CFG_PORT6)
846 VSF_PORTG = VSF_PORT6,
847#endif
848#if defined(VSF_GPIO_CFG_PORT7)
849 VSF_PORTH = VSF_PORT7,
850#endif
851#if defined(VSF_GPIO_CFG_PORT8)
852 VSF_PORTI = VSF_PORT8,
853#endif
854#if defined(VSF_GPIO_CFG_PORT9)
855 VSF_PORTJ = VSF_PORT9,
856#endif
857#if defined(VSF_GPIO_CFG_PORT10)
858 VSF_PORTK = VSF_PORT10,
859#endif
860#if defined(VSF_GPIO_CFG_PORT11)
861 VSF_PORTL = VSF_PORT11,
862#endif
863#if defined(VSF_GPIO_CFG_PORT12)
864 VSF_PORTM = VSF_PORT12,
865#endif
866#if defined(VSF_GPIO_CFG_PORT13)
867 VSF_PORTN = VSF_PORT13,
868#endif
869#if defined(VSF_GPIO_CFG_PORT14)
870 VSF_PORTO = VSF_PORT14,
871#endif
872#if defined(VSF_GPIO_CFG_PORT15)
873 VSF_PORTP = VSF_PORT15,
874#endif
875} vsf_gpio_port_no_t;
876
877typedef enum vsf_gpio_port_pin_no_t {
878#if defined(VSF_GPIO_CFG_PORT0)
880#endif
881#if defined(VSF_GPIO_CFG_PORT1)
883#endif
884#if defined(VSF_GPIO_CFG_PORT2)
886#endif
887#if defined(VSF_GPIO_CFG_PORT3)
889#endif
890#if defined(VSF_GPIO_CFG_PORT4)
892#endif
893#if defined(VSF_GPIO_CFG_PORT5)
895#endif
896#if defined(VSF_GPIO_CFG_PORT6)
898#endif
899#if defined(VSF_GPIO_CFG_PORT7)
901#endif
902#if defined(VSF_GPIO_CFG_PORT8)
904#endif
905#if defined(VSF_GPIO_CFG_PORT9)
907#endif
908#if defined(VSF_GPIO_CFG_PORT10)
910#endif
911#if defined(VSF_GPIO_CFG_PORT11)
913#endif
914#if defined(VSF_GPIO_CFG_PORT12)
916#endif
917#if defined(VSF_GPIO_CFG_PORT13)
919#endif
920#if defined(VSF_GPIO_CFG_PORT14)
922#endif
923#if defined(VSF_GPIO_CFG_PORT15)
925#endif
926} vsf_gpio_port_pin_no_t;
927#endif
928
929/*============================ GLOBAL VARIABLES ==============================*/
930/*============================ MACROFIED FUNCTIONS ===========================*/
931/*============================ PROTOTYPES ====================================*/
932
950 vsf_gpio_pin_mask_t pin_mask,
951 vsf_gpio_cfg_t *cfg_ptr);
952
972 uint16_t pin_index,
973 vsf_gpio_cfg_t *cfg_ptr);
974
976// \~english
977// @brief Configure one or more ports and pin of the gpio instance
978// @param[in] cfg: array of vsf_gpio_port_cfg_pins_t structures, refer @ref vsf_gpio_port_cfg_pins_t
979// @param[in] count: number of struct array vsf_gpio_port_cfg_pins_t
980// @return vsf_err_t: VSF_ERR_NONE if GPIO Configuration Successful, or a negative error code
981// @note The VSF_PREFIX prefix of this can be replaced with the actual prefix, e.g. vsf_hw
982//
983// \~chinese
984// @brief 配置 gpio 的一个或者多个端口和引脚
985// @param[in] cfg: vsf_gpio_port_cfg_pins_t 结构体数组,参考 @ref vsf_gpio_port_cfg_pins_t
986// @param[in] count: 结构体数组 vsf_gpio_port_cfg_pins_t 的数量
987// @return vsf_err_t: 如果 GPIO 配置成功返回 VSF_ERR_NONE,失败返回负值错误码。
988// @note VSF_PREFIX 前缀可以替换成实际的前缀,例如 vsf_hw
989// */
990//extern vsf_err_t VSF_PREFIX_gpio_ports_config_pins(vsf_gpio_port_cfg_pins_t *cfg_ptr,
991// uint_fast8_t count);
992//
994// \~english
995// @brief Configure one pin for one or more ports of the gpio instance
996// @param[in] cfg: a pointer to structure @ref vsf_gpio_port_cfg_pin_t
997// @param[in] count: number of struct array vsf_gpio_port_cfg_pin_t
998// @return vsf_err_t: VSF_ERR_NONE if GPIO Configuration Successful, or a negative error code
999// @note The VSF_PREFIX prefix of this can be replaced with the actual prefix, e.g. vsf_hw
1000//
1001// \~chinese
1002// @brief 配置 gpio 的一个或者多个端口的一个引脚
1003// @param[in] cfg: 结构体 vsf_gpio_port_cfg_pin_t 的指针,参考 @ref vsf_gpio_port_cfg_pin_t
1004// @param[in] count: 结构体数组 vsf_gpio_port_cfg_pin_t 的数量
1005// @return vsf_err_t: 如果 GPIO 配置成功返回 VSF_ERR_NONE,失败返回负值错误码。
1006// @note VSF_PREFIX 前缀可以替换成实际的前缀,例如 vsf_hw
1007// */
1008//extern vsf_err_t VSF_PREFIX_gpio_ports_config_pin(vsf_gpio_port_cfg_pin_t *cfg_ptr,
1009// uint_fast8_t count);
1010
1011
1025extern void vsf_gpio_set_direction(vsf_gpio_t *gpio_ptr,
1026 vsf_gpio_pin_mask_t pin_mask,
1027 vsf_gpio_pin_mask_t direction_mask);
1028
1043 vsf_gpio_pin_mask_t pin_mask);
1044
1056extern void vsf_gpio_set_input(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1057
1070extern void vsf_gpio_set_output(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1071
1084extern void vsf_gpio_switch_direction(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1085
1103
1123
1138extern void vsf_gpio_write(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask,
1140
1153extern void vsf_gpio_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1154
1167extern void vsf_gpio_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1168
1181extern void vsf_gpio_toggle(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1182
1202extern void vsf_gpio_output_and_set(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1203
1223extern void vsf_gpio_output_and_clear(vsf_gpio_t *gpio_ptr, vsf_gpio_pin_mask_t pin_mask);
1224
1235
1250
1265
1285
1303
1304/*============================ INLINE FUNCTIONS ==============================*/
1305
1306static inline uint8_t vsf_gpio_get_port(uint16_t port_pin_index)
1307{
1308 return port_pin_index >> 8;
1309}
1310
1311static inline uint8_t vsf_gpio_get_pin(uint16_t port_pin_index)
1312{
1313 return port_pin_index & 0xFF;
1314}
1315
1316static inline vsf_err_t vsf_gpio_port_config_pin(vsf_gpio_t *gpio_ptr,
1317 uint16_t pin_index,
1318 vsf_gpio_cfg_t *cfg_ptr)
1319{
1320 return vsf_gpio_port_config_pins(gpio_ptr, 1 << pin_index, cfg_ptr);
1321}
1322
1323
1324/*============================ MACROS ========================================*/
1325
1327#if VSF_GPIO_CFG_FUNCTION_RENAME == ENABLED
1328# define __vsf_gpio_t VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_t)
1329# define vsf_gpio_capability(__GPIO) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_capability) ((__vsf_gpio_t *)(__GPIO))
1330# define vsf_gpio_port_config_pins(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_port_config_pins) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1331# define vsf_gpio_get_pin_configuration(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_get_pin_configuration) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1332# define vsf_gpio_set_direction(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_set_direction) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1333# define vsf_gpio_get_direction(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_get_direction) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1334# define vsf_gpio_set_input(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_set_input) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1335# define vsf_gpio_set_output(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_set_output) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1336# define vsf_gpio_switch_direction(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_switch_direction) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1337# define vsf_gpio_read(__GPIO) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_read) ((__vsf_gpio_t *)(__GPIO))
1338# define vsf_gpio_read_output_register(__GPIO) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_read_output_register) ((__vsf_gpio_t *)(__GPIO))
1339# define vsf_gpio_write(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_write) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1340# define vsf_gpio_set(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_set) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1341# define vsf_gpio_clear(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_clear) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1342# define vsf_gpio_output_and_set(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_output_and_set) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1343# define vsf_gpio_output_and_clear(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_output_and_clear) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1344# define vsf_gpio_toggle(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_toggle) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1345# define vsf_gpio_exti_irq_config(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_exti_irq_config) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1346# 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__)
1347# define vsf_gpio_exti_irq_enable(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_exti_irq_enable) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1348# define vsf_gpio_exti_irq_disable(__GPIO, ...) VSF_MCONNECT(VSF_GPIO_CFG_PREFIX, _gpio_exti_irq_disable) ((__vsf_gpio_t *)(__GPIO), ##__VA_ARGS__)
1349#endif
1351
1352// too long, put it end of file
1353#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 0)
1354# define VSF_PIN0 0
1355# define VSF_PIN0_MASK (1 << VSF_PIN0)
1356#endif
1357
1358#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 1)
1359# define VSF_PIN1 1
1360# define VSF_PIN1_MASK (1 << VSF_PIN1)
1361#endif
1362
1363#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 2)
1364# define VSF_PIN2 2
1365# define VSF_PIN2_MASK (1 << VSF_PIN2)
1366#endif
1367
1368#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 3)
1369# define VSF_PIN3 3
1370# define VSF_PIN3_MASK (1 << VSF_PIN3)
1371#endif
1372
1373#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 4)
1374# define VSF_PIN4 4
1375# define VSF_PIN4_MASK (1 << VSF_PIN4)
1376#endif
1377
1378#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 5)
1379# define VSF_PIN5 5
1380# define VSF_PIN5_MASK (1 << VSF_PIN5)
1381#endif
1382
1383#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 6)
1384# define VSF_PIN6 6
1385# define VSF_PIN6_MASK (1 << VSF_PIN6)
1386#endif
1387
1388#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 7)
1389# define VSF_PIN7 7
1390# define VSF_PIN7_MASK (1 << VSF_PIN7)
1391#endif
1392
1393#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 8)
1394# define VSF_PIN8 8
1395# define VSF_PIN8_MASK (1 << VSF_PIN8)
1396#endif
1397
1398#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 9)
1399# define VSF_PIN9 9
1400# define VSF_PIN9_MASK (1 << VSF_PIN9)
1401#endif
1402
1403#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 10)
1404# define VSF_PIN10 10
1405# define VSF_PIN10_MASK (1 << VSF_PIN10)
1406#endif
1407
1408#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 11)
1409# define VSF_PIN11 11
1410# define VSF_PIN11_MASK (1 << VSF_PIN11)
1411#endif
1412
1413#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 12)
1414# define VSF_PIN12 12
1415# define VSF_PIN12_MASK (1 << VSF_PIN12)
1416#endif
1417
1418#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 13)
1419# define VSF_PIN13 13
1420# define VSF_PIN13_MASK (1 << VSF_PIN13)
1421#endif
1422
1423#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 14)
1424# define VSF_PIN14 14
1425# define VSF_PIN14_MASK (1 << VSF_PIN14)
1426#endif
1427
1428#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 15)
1429# define VSF_PIN15 15
1430# define VSF_PIN15_MASK (1 << VSF_PIN15)
1431#endif
1432
1433#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 16)
1434# define VSF_PIN16 16
1435# define VSF_PIN16_MASK (1 << VSF_PIN16)
1436#endif
1437
1438#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 17)
1439# define VSF_PIN17 17
1440# define VSF_PIN17_MASK (1 << VSF_PIN17)
1441#endif
1442
1443#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 18)
1444# define VSF_PIN18 18
1445# define VSF_PIN18_MASK (1 << VSF_PIN18)
1446#endif
1447
1448#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 19)
1449# define VSF_PIN19 19
1450# define VSF_PIN19_MASK (1 << VSF_PIN19)
1451#endif
1452
1453#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 20)
1454# define VSF_PIN20 20
1455# define VSF_PIN20_MASK (1 << VSF_PIN20)
1456#endif
1457
1458#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 21)
1459# define VSF_PIN21 21
1460# define VSF_PIN21_MASK (1 << VSF_PIN21)
1461#endif
1462
1463#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 22)
1464# define VSF_PIN22 22
1465# define VSF_PIN22_MASK (1 << VSF_PIN22)
1466#endif
1467
1468#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 23)
1469# define VSF_PIN23 23
1470# define VSF_PIN23_MASK (1 << VSF_PIN23)
1471#endif
1472
1473#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 24)
1474# define VSF_PIN24 24
1475# define VSF_PIN24_MASK (1 << VSF_PIN24)
1476#endif
1477
1478#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 25)
1479# define VSF_PIN25 25
1480# define VSF_PIN25_MASK (1 << VSF_PIN25)
1481#endif
1482
1483#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 26)
1484# define VSF_PIN26 26
1485# define VSF_PIN26_MASK (1 << VSF_PIN26)
1486#endif
1487
1488#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 27)
1489# define VSF_PIN27 27
1490# define VSF_PIN27_MASK (1 << VSF_PIN27)
1491#endif
1492
1493#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 28)
1494# define VSF_PIN28 28
1495# define VSF_PIN28_MASK (1 << VSF_PIN28)
1496#endif
1497
1498#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 29)
1499# define VSF_PIN29 29
1500# define VSF_PIN29_MASK (1 << VSF_PIN29)
1501#endif
1502
1503#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 30)
1504# define VSF_PIN30 30
1505# define VSF_PIN30_MASK (1 << VSF_PIN30)
1506#endif
1507
1508#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 31)
1509# define VSF_PIN31 31
1510# define VSF_PIN31_MASK (1 << VSF_PIN31)
1511#endif
1512
1513#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 32)
1514# define VSF_PIN32 32
1515# define VSF_PIN32_MASK (1 << VSF_PIN32)
1516#endif
1517
1518#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 33)
1519# define VSF_PIN33 33
1520# define VSF_PIN33_MASK (1 << VSF_PIN33)
1521#endif
1522
1523#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 34)
1524# define VSF_PIN34 34
1525# define VSF_PIN34_MASK (1 << VSF_PIN34)
1526#endif
1527
1528#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 35)
1529# define VSF_PIN35 35
1530# define VSF_PIN35_MASK (1 << VSF_PIN35)
1531#endif
1532
1533#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 36)
1534# define VSF_PIN36 36
1535# define VSF_PIN36_MASK (1 << VSF_PIN36)
1536#endif
1537
1538#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 37)
1539# define VSF_PIN37 37
1540# define VSF_PIN37_MASK (1 << VSF_PIN37)
1541#endif
1542
1543#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 38)
1544# define VSF_PIN38 38
1545# define VSF_PIN38_MASK (1 << VSF_PIN38)
1546#endif
1547
1548#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 39)
1549# define VSF_PIN39 39
1550# define VSF_PIN39_MASK (1 << VSF_PIN39)
1551#endif
1552
1553#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 40)
1554# define VSF_PIN40 40
1555# define VSF_PIN40_MASK (1 << VSF_PIN40)
1556#endif
1557
1558#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 41)
1559# define VSF_PIN41 41
1560# define VSF_PIN41_MASK (1 << VSF_PIN41)
1561#endif
1562
1563#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 42)
1564# define VSF_PIN42 42
1565# define VSF_PIN42_MASK (1 << VSF_PIN42)
1566#endif
1567
1568#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 43)
1569# define VSF_PIN43 43
1570# define VSF_PIN43_MASK (1 << VSF_PIN43)
1571#endif
1572
1573#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 44)
1574# define VSF_PIN44 44
1575# define VSF_PIN44_MASK (1 << VSF_PIN44)
1576#endif
1577
1578#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 45)
1579# define VSF_PIN45 45
1580# define VSF_PIN45_MASK (1 << VSF_PIN45)
1581#endif
1582
1583#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 46)
1584# define VSF_PIN46 46
1585# define VSF_PIN46_MASK (1 << VSF_PIN46)
1586#endif
1587
1588#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 47)
1589# define VSF_PIN47 47
1590# define VSF_PIN47_MASK (1 << VSF_PIN47)
1591#endif
1592
1593#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 48)
1594# define VSF_PIN48 48
1595# define VSF_PIN48_MASK (1 << VSF_PIN48)
1596#endif
1597
1598#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 49)
1599# define VSF_PIN49 49
1600# define VSF_PIN49_MASK (1 << VSF_PIN49)
1601#endif
1602
1603#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 50)
1604# define VSF_PIN50 50
1605# define VSF_PIN50_MASK (1 << VSF_PIN50)
1606#endif
1607
1608#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 51)
1609# define VSF_PIN51 51
1610# define VSF_PIN51_MASK (1 << VSF_PIN51)
1611#endif
1612
1613#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 52)
1614# define VSF_PIN52 52
1615# define VSF_PIN52_MASK (1 << VSF_PIN52)
1616#endif
1617
1618#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 53)
1619# define VSF_PIN53 53
1620# define VSF_PIN53_MASK (1 << VSF_PIN53)
1621#endif
1622
1623#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 54)
1624# define VSF_PIN54 54
1625# define VSF_PIN54_MASK (1 << VSF_PIN54)
1626#endif
1627
1628#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 55)
1629# define VSF_PIN55 55
1630# define VSF_PIN55_MASK (1 << VSF_PIN55)
1631#endif
1632
1633#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 56)
1634# define VSF_PIN56 56
1635# define VSF_PIN56_MASK (1 << VSF_PIN56)
1636#endif
1637
1638#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 57)
1639# define VSF_PIN57 57
1640# define VSF_PIN57_MASK (1 << VSF_PIN57)
1641#endif
1642
1643#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 58)
1644# define VSF_PIN58 58
1645# define VSF_PIN58_MASK (1 << VSF_PIN58)
1646#endif
1647
1648#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 59)
1649# define VSF_PIN59 59
1650# define VSF_PIN59_MASK (1 << VSF_PIN59)
1651#endif
1652
1653#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 60)
1654# define VSF_PIN60 60
1655# define VSF_PIN60_MASK (1 << VSF_PIN60)
1656#endif
1657
1658#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 61)
1659# define VSF_PIN61 61
1660# define VSF_PIN61_MASK (1 << VSF_PIN61)
1661#endif
1662
1663#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 62)
1664# define VSF_PIN62 62
1665# define VSF_PIN62_MASK (1 << VSF_PIN62)
1666#endif
1667
1668#if VSF_GPIO_CFG_PIN_MASK & (0x01ul << 63)
1669# define VSF_PIN63 63
1670# define VSF_PIN63_MASK (1 << VSF_PIN63)
1671#endif
1672
1673#ifdef __cplusplus
1674}
1675#endif
1676
1677#endif /* __VSF_TEMPLATE_GPIO_H__ */
vsf_err_t
Definition __type.h:42
vsf_gpio_mode_t
Definition gpio.h:31
@ VSF_GPIO_AF
Definition gpio.h:46
#define VSF_GPIO_AF_INPUT
Definition gpio.h:96
#define VSF_GPIO_DRIVE_STRENGTH_MASK
Definition gpio.h:112
#define VSF_GPIO_AF_OUTPUT_PUSH_PULL
Definition gpio.h:94
#define VSF_GPIO_AF_OUTPUT_OPEN_DRAIN
Definition gpio.h:95
#define VSF_GPIO_SPEED_MASK
Definition gpio.h:86
vsf_arch_prio_t
Definition cortex_a_generic.h:88
#define K(t, v)
Definition keyboard.h:40
unsigned short uint16_t
Definition stdint.h:7
unsigned uint32_t
Definition stdint.h:9
unsigned long long uint64_t
Definition stdint.h:11
unsigned char uint8_t
Definition stdint.h:5
Definition vsf_template_gpio.h:654
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:689
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:731
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:719
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:709
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:749
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:656
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:699
gpio configuration
Definition vsf_template_gpio.h:623
vsf_gpio_alternate_function_t alternate_function
alternate function is only valid in GPIO_AF mode
Definition vsf_template_gpio.h:626
vsf_gpio_mode_t mode
Definition vsf_template_gpio.h:624
Definition vsf_template_gpio.h:616
vsf_gpio_exti_isr_handler_t * handler_fn
Definition vsf_template_gpio.h:617
vsf_arch_prio_t prio
Definition vsf_template_gpio.h:619
void * target_ptr
Definition vsf_template_gpio.h:618
Definition vsf_template_gpio.h:753
Definition vsf_template_gpio.h:630
vsf_gpio_alternate_function_t alternate_function
alternate function is only valid in GPIO_AF mode
Definition vsf_template_gpio.h:637
uint16_t port_pin_index
Definition vsf_template_gpio.h:631
vsf_gpio_mode_t mode
Definition vsf_template_gpio.h:635
Definition vsf_template_gpio.h:643
vsf_gpio_mode_t mode
Definition vsf_template_gpio.h:648
uint16_t port_index
Definition vsf_template_gpio.h:644
vsf_gpio_pin_mask_t pin_mask
Definition vsf_template_gpio.h:645
vsf_gpio_alternate_function_t alternate_function
alternate function is only valid in GPIO_AF mode
Definition vsf_template_gpio.h:650
Definition vsf_template_gpio.h:771
const vsf_gpio_op_t * op
Definition vsf_template_gpio.h:772
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:111
vsf_gpio_mode_t
Definition gpio.h:88
uint32_t vsf_gpio_pin_mask_t
Definition gpio.h:73
vk_av_control_value_t value
Definition vsf_audio.h:171
#define VSF_MREPEAT(__COUNT, __MACRO, __PARAM)
Definition vsf_repeat_macro.h:51
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:611
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
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
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
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
#define vsf_gpio_alternate_function_t
Definition vsf_template_gpio.h:315
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_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_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
#define VSF_GPIO_CFG_PIN_COUNT
Definition vsf_template_gpio.h:192
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
struct vsf_gpio_capability_t vsf_gpio_capability_t
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
uint16_t vsf_gpio_alternate_function_t
Definition vsf_template_gpio.h:314
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_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
struct vsf_gpio_exti_irq_cfg_t vsf_gpio_exti_irq_cfg_t
#define __VSF_GPIO_PORT_PIN_NUM(__PIN_NUM, __PORT_NUM, __PORT_CHAR)
Definition vsf_template_gpio.h:274
#define vsf_gpio_pin_mask_t
Definition vsf_template_gpio.h:310
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
struct vsf_gpio_cfg_t vsf_gpio_cfg_t
gpio configuration
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_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
#define VSF_GPIO_APIS(__prefix_name)
Definition vsf_template_gpio.h:278
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
Predefined VSF GPIO modes that can be reimplemented in specific hal drivers.
Definition vsf_template_gpio.h:365
@ 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:453
@ VSF_GPIO_EXTI_MODE_HIGH_LEVEL
Detect interrupts on high signal level.
Definition vsf_template_gpio.h:497
@ 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:396
@ 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:416
@ VSF_GPIO_EXTI_MODE_LOW_LEVEL
Detect interrupts on low signal level.
Definition vsf_template_gpio.h:489
@ VSF_GPIO_EXTI_MODE_NONE
No external interrupt detection enabled.
Definition vsf_template_gpio.h:481
@ VSF_GPIO_EXTI_MODE_RISING
Detect interrupts on rising edge of signal.
Definition vsf_template_gpio.h:505
@ VSF_GPIO_EXTI_MODE_RISING_FALLING
Detect interrupts on both rising and falling edges.
Definition vsf_template_gpio.h:521
@ VSF_GPIO_PULL_UP
Enable internal pull-up resistor. Independent of IO direction and alternative function.
Definition vsf_template_gpio.h:463
@ VSF_GPIO_INPUT
Set the GPIO pin as general-purpose input. Selects GPIO for the alternative function....
Definition vsf_template_gpio.h:376
@ 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:386
@ VSF_GPIO_EXTI_MODE_FALLING
Detect interrupts on falling edge of signal.
Definition vsf_template_gpio.h:513
@ 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:406
@ VSF_GPIO_PULL_DOWN
Enable internal pull-down resistor. Independent of IO direction and alternative function.
Definition vsf_template_gpio.h:473
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_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
uint32_t vsf_gpio_pin_mask_t
Definition vsf_template_gpio.h:308
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
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_EXTI_MODE_MASK
Definition vsf_template_gpio.h:585
@ VSF_GPIO_MODE_MASK
Definition vsf_template_gpio.h:573
@ VSF_GPIO_MODE_AF_MASK
Definition vsf_template_gpio.h:556
@ VSF_GPIO_PULL_UP_DOWN_MASK
Definition vsf_template_gpio.h:581
@ VSF_GPIO_MODE_ALL_BITS_MASK
Definition vsf_template_gpio.h:592
@ VSF_GPIO_FLOATING
Definition vsf_template_gpio.h:553
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
Generated from commit: vsfteam/vsf@0d4e00d