VSF Documented
driver.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/*============================ INCLUDES ======================================*/
19
20#if defined(__VSF_HEADER_ONLY_SHOW_ARCH_INFO__) || defined(__VSF_HAL_SHOW_VENDOR_INFO__)
21
22# include "../__device.h"
23
24#else
25
26#ifndef __VSF_HAL_DRIVER_${VENDOR}_${DEVICE}_H__
27#define __VSF_HAL_DRIVER_${VENDOR}_${DEVICE}_H__
28
29/*============================ INCLUDES ======================================*/
30
31# include "hal/vsf_hal_cfg.h"
32# include "./device.h"
33
34// for common hal structure/enum/etc, include before user driver headers below.
35# include "hal/driver/common/template/vsf_template_hal_driver.h"
36
37// For SWI
38# include "hal/driver/common/swi/vsf_swi_template.h"
39
40/*\note It's up to developer to decide the actual path of the driver headers. */
41
42# if VSF_HAL_USE_ADC == ENABLED
43# include "../common/adc/adc.h"
44# endif
45# if VSF_HAL_USE_FLASH == ENABLED
46# include "../common/flash/flash.h"
47# endif
48# if VSF_HAL_USE_GPIO == ENABLED
49# include "../common/gpio/gpio.h"
50# endif
51# if VSF_HAL_USE_I2C == ENABLED
52# include "../common/i2c/i2c.h"
53# endif
54# if VSF_HAL_USE_PWM == ENABLED
55# include "../common/pwm/pwm.h"
56# endif
57# if VSF_HAL_USE_RTC == ENABLED
58# include "../common/rtc/rtc.h"
59# endif
60# if VSF_HAL_USE_SPI == ENABLED
61# include "../common/spi/spi.h"
62# endif
63# if VSF_HAL_USE_TIMER == ENABLED
64# include "../common/timer/timer.h"
65# endif
66# if VSF_HAL_USE_TRNG == ENABLED
67# include "../common/trng/trng.h"
68# endif
69# if VSF_HAL_USE_USART == ENABLED
70# include "../common/uart/uart.h"
71# endif
72# if VSF_HAL_USE_USB == ENABLED
73# include "../common/usb/usb.h"
74# endif
75# if VSF_HAL_USE_SDIO == ENABLED
76# include "../common/sdio/sdio.h"
77# endif
78# if VSF_HAL_USE_I2S == ENABLED
79# include "../common/i2s/i2s.h"
80# endif
81# if VSF_HAL_USE_WDT == ENABLED
82# include "../common/wdt/wdt.h"
83# endif
84# if VSF_HAL_USE_ETH == ENABLED
85# include "../common/mac/mac.h"
86# endif
87
88/*============================ MACROS ========================================*/
89/*============================ MACROFIED FUNCTIONS ===========================*/
90/*============================ TYPES =========================================*/
91/*============================ GLOBAL VARIABLES ==============================*/
92/*============================ LOCAL VARIABLES ===============================*/
93/*============================ PROTOTYPES ====================================*/
94
95
96
97/*============================ INCLUDES ======================================*/
98
99#if VSF_HAL_USE_GPIO == ENABLED
100# include "hal/driver/common/template/vsf_template_gpio.h"
101
102# define VSF_GPIO_CFG_DEC_PREFIX vsf_hw
103# define VSF_GPIO_CFG_DEC_UPCASE_PREFIX VSF_HW
104# include "hal/driver/common/gpio/gpio_template.h"
105#endif
106
107#if VSF_HAL_USE_ADC == ENABLED
108# include "hal/driver/common/template/vsf_template_adc.h"
109
110# define VSF_ADC_CFG_DEC_PREFIX vsf_hw
111# define VSF_ADC_CFG_DEC_UPCASE_PREFIX VSF_HW
112# include "hal/driver/common/adc/adc_template.h"
113#endif
114
115#if VSF_HAL_USE_FLASH == ENABLED
116# include "hal/driver/common/template/vsf_template_flash.h"
117
118# define VSF_FLASH_CFG_DEC_PREFIX vsf_hw
119# define VSF_FLASH_CFG_DEC_UPCASE_PREFIX VSF_HW
120# include "hal/driver/common/flash/flash_template.h"
121#endif
122
123#if VSF_HAL_USE_I2C == ENABLED
124# include "hal/driver/common/template/vsf_template_i2c.h"
125
126# define VSF_I2C_CFG_DEC_PREFIX vsf_hw
127# define VSF_I2C_CFG_DEC_UPCASE_PREFIX VSF_HW
128# include "hal/driver/common/i2c/i2c_template.h"
129#endif
130
131#if VSF_HAL_USE_PWM == ENABLED
132# include "hal/driver/common/template/vsf_template_pwm.h"
133
134# define VSF_PWM_CFG_DEC_PREFIX vsf_hw
135# define VSF_PWM_CFG_DEC_UPCASE_PREFIX VSF_HW
136# include "hal/driver/common/pwm/pwm_template.h"
137#endif
138
139#if VSF_HAL_USE_RTC == ENABLED
140# include "hal/driver/common/template/vsf_template_rtc.h"
141
142# define VSF_RTC_CFG_DEC_PREFIX vsf_hw
143# define VSF_RTC_CFG_DEC_UPCASE_PREFIX VSF_HW
144# include "hal/driver/common/rtc/rtc_template.h"
145#endif
146
147#if VSF_HAL_USE_SPI == ENABLED
148# include "hal/driver/common/template/vsf_template_spi.h"
149
150# define VSF_SPI_CFG_DEC_PREFIX vsf_hw
151# define VSF_SPI_CFG_DEC_UPCASE_PREFIX VSF_HW
152# include "hal/driver/common/spi/spi_template.h"
153
154// Optional: Add QSPI
155//# define VSF_SPI_CFG_DEC_DEVICE_PREFIX vsf_hw_qspi
156//# define VSF_SPI_CFG_DEC_DEVICE_UPCASE_PREFIX VSF_HW_QSPI
157//# define VSF_SPI_CFG_DEC_RENAME_DEVICE_PREFIX ENABLED
158//# include "hal/driver/common/spi/spi_template.h"
159#endif
160
161#if VSF_HAL_USE_TIMER == ENABLED
162# include "hal/driver/common/template/vsf_template_timer.h"
163
164# define VSF_TIMER_CFG_DEC_PREFIX vsf_hw
165# define VSF_TIMER_CFG_DEC_UPCASE_PREFIX VSF_HW
166# include "hal/driver/common/timer/timer_template.h"
167#endif
168
169#if VSF_HAL_USE_RNG == ENABLED
170# include "hal/driver/common/template/vsf_template_rng.h"
171
172# define VSF_RNG_CFG_DEC_PREFIX vsf_hw
173# define VSF_RNG_CFG_DEC_UPCASE_PREFIX VSF_HW
174# include "hal/driver/common/rng/rng_template.h"
175#endif
176
177#if VSF_HAL_USE_USART == ENABLED
178# include "hal/driver/common/template/vsf_template_usart.h"
179
180# define VSF_USART_CFG_DEC_PREFIX vsf_hw
181# define VSF_USART_CFG_DEC_UPCASE_PREFIX VSF_HW
182# include "hal/driver/common/usart/usart_template.h"
183#endif
184
185#if VSF_HAL_USE_WDT == ENABLED
186# include "hal/driver/common/template/vsf_template_wdt.h"
187
188# define VSF_WDT_CFG_DEC_PREFIX vsf_hw
189# define VSF_WDT_CFG_DEC_UPCASE_PREFIX VSF_HW
190# include "hal/driver/common/wdt/wdt_template.h"
191#endif
192
193#endif // __VSF_HAL_DRIVER_${VENDOR}_${DEVICE}_H__
194#endif // !__VSF_HEADER_ONLY_SHOW_ARCH_INFO__ && !__VSF_HAL_SHOW_VENDOR_INFO__
195/* EOF */
adc_template.h
flash_template.h
gpio_template.h
i2c_template.h
pwm_template.h
rng_template.h
rtc_template.h
spi_template.h
timer_template.h
usart_template.h
vsf_hal_cfg.h
vsf_swi_template.h
vsf_template_adc.h
vsf_template_flash.h
vsf_template_gpio.h
vsf_template_hal_driver.h
vsf_template_i2c.h
vsf_template_pwm.h
vsf_template_rng.h
vsf_template_rtc.h
vsf_template_spi.h
vsf_template_timer.h
vsf_template_usart.h
vsf_template_wdt.h
wdt_template.h
Generated from commit: vsfteam/vsf@0c4049f