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#include "./hostos_driver.h"
21
22#if defined(__VSF_HEADER_ONLY_SHOW_ARCH_INFO__) || defined(__VSF_HAL_SHOW_VENDOR_INFO__)
23
24# include "./device.h"
25
26#else
27
28#ifndef __VSF_HAL_DRIVER_EMULATION_DISTBUS_H__
29#define __VSF_HAL_DRIVER_EMULATION_DISTBUS_H__
30
31/*============================ INCLUDES ======================================*/
32
33# include "hal/vsf_hal_cfg.h"
34# include "./device.h"
35
36// for common hal structure/enum/etc, include before user driver headers below.
37# include "hal/driver/common/template/vsf_template_hal_driver.h"
38
39/*============================ MACROS ========================================*/
40/*============================ MACROFIED FUNCTIONS ===========================*/
41/*============================ TYPES =========================================*/
42/*============================ GLOBAL VARIABLES ==============================*/
43/*============================ LOCAL VARIABLES ===============================*/
44/*============================ PROTOTYPES ====================================*/
45/*============================ INCLUDES ======================================*/
46
47#if VSF_HAL_USE_GPIO == ENABLED
48# include "hal/driver/common/template/vsf_template_gpio.h"
49
50# define VSF_GPIO_CFG_DEC_PREFIX vsf_hw
51# define VSF_GPIO_CFG_DEC_UPCASE_PREFIX VSF_HW
52# include "hal/driver/common/gpio/gpio_template.h"
53#endif
54
55#if VSF_HAL_USE_ADC == ENABLED
56# include "hal/driver/common/template/vsf_template_adc.h"
57
58# define VSF_ADC_CFG_DEC_PREFIX vsf_hw
59# define VSF_ADC_CFG_DEC_UPCASE_PREFIX VSF_HW
60# include "hal/driver/common/adc/adc_template.h"
61#endif
62
63#if VSF_HAL_USE_FLASH == ENABLED
64# include "hal/driver/common/template/vsf_template_flash.h"
65
66# define VSF_FLASH_CFG_DEC_PREFIX vsf_hw
67# define VSF_FLASH_CFG_DEC_UPCASE_PREFIX VSF_HW
68# include "hal/driver/common/flash/flash_template.h"
69#endif
70
71#if VSF_HAL_USE_I2C == ENABLED
72# include "hal/driver/common/template/vsf_template_i2c.h"
73
74# define VSF_I2C_CFG_DEC_PREFIX vsf_hw
75# define VSF_I2C_CFG_DEC_UPCASE_PREFIX VSF_HW
76# include "hal/driver/common/i2c/i2c_template.h"
77#endif
78
79#if VSF_HAL_USE_PWM == ENABLED
80# include "hal/driver/common/template/vsf_template_pwm.h"
81
82# define VSF_PWM_CFG_DEC_PREFIX vsf_hw
83# define VSF_PWM_CFG_DEC_UPCASE_PREFIX VSF_HW
84# include "hal/driver/common/pwm/pwm_template.h"
85#endif
86
87#if VSF_HAL_USE_RTC == ENABLED
88# include "hal/driver/common/template/vsf_template_rtc.h"
89
90# define VSF_RTC_CFG_DEC_PREFIX vsf_hw
91# define VSF_RTC_CFG_DEC_UPCASE_PREFIX VSF_HW
92# include "hal/driver/common/rtc/rtc_template.h"
93#endif
94
95#if VSF_HAL_USE_SPI == ENABLED
96# include "hal/driver/common/template/vsf_template_spi.h"
97
98# define VSF_SPI_CFG_DEC_PREFIX vsf_hw
99# define VSF_SPI_CFG_DEC_UPCASE_PREFIX VSF_HW
100# include "hal/driver/common/spi/spi_template.h"
101
102// Optional: Add QSPI
103//# define VSF_SPI_CFG_DEC_DEVICE_PREFIX vsf_hw_qspi
104//# define VSF_SPI_CFG_DEC_DEVICE_UPCASE_PREFIX VSF_HW_QSPI
105//# define VSF_SPI_CFG_DEC_RENAME_DEVICE_PREFIX ENABLED
106//# include "hal/driver/common/spi/spi_template.h"
107#endif
108
109#if VSF_HAL_USE_SDIO == ENABLED
110# include "hal/driver/common/template/vsf_template_sdio.h"
111
112# define VSF_SDIO_CFG_DEC_PREFIX vsf_hw
113# define VSF_SDIO_CFG_DEC_UPCASE_PREFIX VSF_HW
114# include "hal/driver/common/sdio/sdio_template.h"
115#endif
116
117#if VSF_HAL_USE_TIMER == ENABLED
118# include "hal/driver/common/template/vsf_template_timer.h"
119
120# define VSF_TIMER_CFG_DEC_PREFIX vsf_hw
121# define VSF_TIMER_CFG_DEC_UPCASE_PREFIX VSF_HW
122# include "hal/driver/common/timer/timer_template.h"
123#endif
124
125#if VSF_HAL_USE_RNG == ENABLED
126# include "hal/driver/common/template/vsf_template_rng.h"
127
128# define VSF_RNG_CFG_DEC_PREFIX vsf_hw
129# define VSF_RNG_CFG_DEC_UPCASE_PREFIX VSF_HW
130# include "hal/driver/common/rng/rng_template.h"
131#endif
132
133#if VSF_HAL_USE_USART == ENABLED
134# include "hal/driver/common/template/vsf_template_usart.h"
135
136# define VSF_USART_CFG_DEC_PREFIX vsf_hw
137# define VSF_USART_CFG_DEC_UPCASE_PREFIX VSF_HW
138# include "hal/driver/common/usart/usart_template.h"
139#endif
140
141#if VSF_HAL_USE_WDT == ENABLED
142# include "hal/driver/common/template/vsf_template_wdt.h"
143
144# define VSF_WDT_CFG_DEC_PREFIX vsf_hw
145# define VSF_WDT_CFG_DEC_UPCASE_PREFIX VSF_HW
146# include "hal/driver/common/wdt/wdt_template.h"
147#endif
148
149#endif // __VSF_HAL_DRIVER_EMULATION_DISTBUS_H__
150#endif // !__VSF_HEADER_ONLY_SHOW_ARCH_INFO__ && !__VSF_HAL_SHOW_VENDOR_INFO__
151/* EOF */
adc_template.h
flash_template.h
gpio_template.h
hostos_driver.h
i2c_template.h
pwm_template.h
rng_template.h
rtc_template.h
sdio_template.h
spi_template.h
timer_template.h
usart_template.h
vsf_hal_cfg.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_sdio.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@74aa6ce