VSF Documented
vsf_io_mapper.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_IO_MAPPER_H__
19#define __VSF_IO_MAPPER_H__
20
21/*============================ INCLUDES ======================================*/
22
23#if VSF_HW_GPIO_COUNT > 0
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29/*============================ MACROS ========================================*/
30
31// default is 2^8 = 256-pin IO (leaves headroom for MCUs with >32 pins/port)
32#ifndef VSF_HW_IO_MAPPER_PORT_BITS_LOG2
33# define VSF_HW_IO_MAPPER_PORT_BITS_LOG2 8
34#endif
35
36/*============================ MACROFIED FUNCTIONS ===========================*/
37
38#define __VSF_IO_MAPPER_INIT(__PORT_NUM, __PORT_BITS_LOG2) \
39 .port_num = (__PORT_NUM), \
40 .port_bits_log2 = (__PORT_BITS_LOG2), \
41 .pin_mask = (1 << (__PORT_BITS_LOG2)) - 1,
42#define VSF_IO_MAPPER_INIT(__PORT_NUM, __PORT_BITS_LOG2) \
43 __VSF_IO_MAPPER_INIT((__PORT_NUM), (__PORT_BITS_LOG2))
44
45#define __vsf_io_mapper_type(__name) __name##_io_mapper_t
46#define vsf_io_mapper_type(__name) __vsf_io_mapper_type(__name)
47
48#define __define_io_mapper(__name, __port_num) \
49 typedef struct vsf_io_mapper_type(__name) { \
50 uint8_t port_num; /* num of ports */ \
51 uint8_t port_bits_log2; /* num of io bits per port in log2 */ \
52 uint8_t pin_mask; \
53 void * io[(__port_num)]; \
54 } vsf_io_mapper_type(__name);
55#define define_io_mapper(__name, __port_num) __define_io_mapper(__name, __port_num)
56#define def_io_mapper(__name, __port_num) define_io_mapper(__name, __port_num)
57
58#define __describe_io_mapper(__name, __port_num, __port_bits_log2, ...) \
59 define_io_mapper(__name, __port_num) \
60 vsf_io_mapper_type(__name) __name = { \
61 VSF_IO_MAPPER_INIT(__port_num, __port_bits_log2) \
62 __io = { \
63 __VA_ARGS__ \
64 } \
65 };
66#define describe_io_mapper(__name, __port_num, __port_bits_log2) \
67 __describe_io_mapper(__name, (__port_num), (__port_bits_log2))
68
69
70#define vsf_io_mapper_pin(__io_mapper, __port_idx, __pin_idx) \
71 ((__pin_idx) | ((__port_idx) << (__io_mapper)->port_bits_log2))
72#define vsf_io_mapper_get_port(__io_mapper, __pin) \
73 ((__pin) >> (__io_mapper)->port_bits_log2)
74#define vsf_io_mapper_get_pin(__io_mapper, __pin) \
75 ((__pin) & (__io_mapper)->pin_mask)
76
77#define vsf_io_mapper_config(__io_mapper, __pin, __feature) ({ \
78 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
79 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
80 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
81 vsf_gpio_cfg_t cfg = { \
82 .mode = (__feature), \
83 }; \
84 vsf_gpio_port_config_pins((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)],\
85 1 << VSF_MACRO_SAFE_NAME(pin_idx), &cfg);\
86 })
87#define vsf_io_mapper_set_direction(__io_mapper, __dir, __pin) ({ \
88 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
89 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
90 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
91 vsf_gpio_set_direction((__dir) ? (1 << VSF_MACRO_SAFE_NAME(pin_idx)) : 0, 1 << VSF_MACRO_SAFE_NAME(pin_idx),\
92 (__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)]);\
93 })
94#define vsf_io_mapper_get_direction(__io_mapper, __pin) ({ \
95 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
96 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
97 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
98 vsf_gpio_get_direction((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)], 1 << VSF_MACRO_SAFE_NAME(pin_idx));\
99 })
100#define vsf_io_mapper_switch_direction(__io_mapper, __pin) ({ \
101 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
102 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
103 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
104 vsf_gpio_switch_direction((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)], 1 << VSF_MACRO_SAFE_NAME(pin_idx));\
105 })
106#define vsf_io_mapper_set_input(__io_mapper, __pin) ({ \
107 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
108 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
109 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
110 vsf_gpio_set_input((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)], 1 << VSF_MACRO_SAFE_NAME(pin_idx));\
111 })
112#define vsf_io_mapper_set_output(__io_mapper, __pin) ({ \
113 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
114 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
115 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
116 vsf_gpio_set_output((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)], 1 << VSF_MACRO_SAFE_NAME(pin_idx));\
117 })
118#define vsf_io_mapper_read(__io_mapper, __pin) ({ \
119 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
120 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
121 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
122 uint32_t pin_value = vsf_gpio_read((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)]);\
123 ((pin_value >> VSF_MACRO_SAFE_NAME(pin_idx)) & 1); \
124 })
125#define vsf_io_mapper_set(__io_mapper, __pin) ({ \
126 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
127 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
128 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
129 vsf_gpio_set((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)], 1 << VSF_MACRO_SAFE_NAME(pin_idx));\
130 })
131#define vsf_io_mapper_clear(__io_mapper, __pin) ({ \
132 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
133 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
134 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
135 vsf_gpio_clear((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)], 1 << VSF_MACRO_SAFE_NAME(pin_idx));\
136 })
137#define vsf_io_mapper_toggle(__io_mapper, __pin) ({ \
138 uint8_t VSF_MACRO_SAFE_NAME(port_idx) = vsf_io_mapper_get_port(__io_mapper, __pin);\
139 uint8_t VSF_MACRO_SAFE_NAME(pin_idx) = vsf_io_mapper_get_pin(__io_mapper, __pin);\
140 VSF_HAL_ASSERT(VSF_MACRO_SAFE_NAME(port_idx) < (__io_mapper)->port_num);\
141 vsf_gpio_toggle((__io_mapper)->io[VSF_MACRO_SAFE_NAME(port_idx)], 1 << VSF_MACRO_SAFE_NAME(pin_idx));\
142 })
143
144
145#define vsf_hw_io_mapper_pin(__port_idx, __pin_idx) \
146 ((__pin_idx) | ((__port_idx) << VSF_HW_IO_MAPPER_PORT_BITS_LOG2))
147
148/*============================ TYPES =========================================*/
149
150typedef struct vsf_io_mapper_t {
151 uint8_t port_num; // num of ports
152 uint8_t port_bits_log2; // num of io bits per port in log2
153 uint8_t pin_mask;
154 void *io[0];
155} vsf_io_mapper_t;
156
157define_io_mapper(vsf_hw, VSF_HW_GPIO_COUNT)
158
159/*============================ GLOBAL VARIABLES ==============================*/
160
161extern const vsf_io_mapper_type(vsf_hw) vsf_hw_io_mapper;
162
163/*============================ PROTOTYPES ====================================*/
164
165
166
167#ifdef __cplusplus
168}
169#endif
170
171#endif // VSF_HW_GPIO_COUNT > 0
172#endif // __VSF_IO_MAPPER_H__
VSF_HW_GPIO_COUNT
#define VSF_HW_GPIO_COUNT
Definition device.h:80
uint8_t
unsigned char uint8_t
Definition stdint.h:5
Generated from commit: vsfteam/vsf@c3767bf