driver.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
/*============================ INCLUDES ======================================*/
 
#include "hal/vsf_hal_cfg.h"
 
#if !defined(__VSF_HEADER_ONLY_SHOW_ARCH_INFO__) && !defined(__VSF_HAL_SHOW_VENDOR_INFO__)
#   include "utilities/vsf_utilities.h"
#endif
 
#ifndef VSF_DRIVER_HEADER
 
#   if      defined(__VSF_APPLET__)
// no hw driver for __VSF_APPLET__
#   elif    defined(__Emulation__)
#       define  VSF_DRIVER_HEADER       "./Emulation/driver.h"
#   elif    defined(__STMicro__)
#       define  VSF_DRIVER_HEADER       "./ST/driver.h"
#   elif    defined(__NXP__)
#       define  VSF_DRIVER_HEADER       "./NXP/driver.h"
#   elif    defined(__MicroChip__)
#       define  VSF_DRIVER_HEADER       "./MicroChip/driver.h"
#   elif    defined(__Nuvoton__)
#       define  VSF_DRIVER_HEADER       "./Nuvoton/driver.h"
#   elif    defined(__WinnerMicro__)
#       define  VSF_DRIVER_HEADER       "./WinnerMicro/driver.h"
#   elif    defined(__CPU_X86__) || defined(__CPU_X64__) || defined(__CPU_WEBASSEMBLY__)
#       define  VSF_DRIVER_HEADER       "./x86/driver.h"
#   elif    defined(__SiliconLabs__)
#       define  VSF_DRIVER_HEADER       "./SiliconLabs/driver.h"
#   elif    defined(__GigaDevice__)
#       define  VSF_DRIVER_HEADER       "./GigaDevice/driver.h"
#   elif    defined(__TI__)
#       define  VSF_DRIVER_HEADER       "./TI/driver.h"
#   elif    defined(__ST__)
#       define  VSF_DRIVER_HEADER       "./ST/driver.h"
#   elif    defined(__WCH__)
#       define  VSF_DRIVER_HEADER       "./WCH/driver.h"
#   elif    defined(__Allwinner__)
#       define  VSF_DRIVER_HEADER       "./Allwinner/driver.h"
#   elif    defined(__Espressif__)
#       define  VSF_DRIVER_HEADER       "./Espressif/driver.h"
#   elif    defined(__AIC__)
#       define  VSF_DRIVER_HEADER       "./AIC/driver.h"
#   elif    defined(__Hercules__)
#       define  VSF_DRIVER_HEADER       "./hercules/driver.h"
#   elif    defined(__HPM__)
#       define  VSF_DRIVER_HEADER       "./HPM/driver.h"
#   elif    defined(__Geehy__)
#       define  VSF_DRIVER_HEADER       "./Geehy/driver.h"
#   elif    defined(__Artery__)
#       define  VSF_DRIVER_HEADER       "./Artery/driver.h"
#   elif    defined(__BouffaloLab__)
#       define  VSF_DRIVER_HEADER       "./BouffaloLab/driver.h"
#   elif    defined(__Luat__)
#       define  VSF_DRIVER_HEADER       "./Luat/driver.h"
#   elif    defined(__RaspberryPi__)
#       define  VSF_DRIVER_HEADER       "./RaspberryPi/driver.h"
#   elif    defined(__SiFli__)
#       define  VSF_DRIVER_HEADER       "./SiFli/driver.h"
#   elif    defined(__Nations__)
#       define  VSF_DRIVER_HEADER       "./Nations/driver.h"
/* example
#   elif    defined(__COMPANY_NAME_A__)
#       define  VSF_DRIVER_HEADER       "./company_name_a/driver.h"
#   elif    defined(__COMPANY_NAME_B__)
#       define  VSF_DRIVER_HEADER       "./company_name_b/driver.h"
*/
#   elif    defined(__ARM__) || defined(__arm__)
#       define  VSF_DRIVER_HEADER       "./arm/driver.h"
#   elif    defined(__CPU_GENERIC__)
#       define  VSF_DRIVER_HEADER       "./generic/driver.h"
 
#   elif    defined(__UNKOWN_VENDOR__)
#       define  VSF_DRIVER_HEADER       "./unknown/driver.h"
#   else
#       define  VSF_DRIVER_HEADER       "./unknown/driver.h"
#   endif
#endif
 
#ifdef VSF_DRIVER_HEADER
/* include specified device driver header file */
#   include    VSF_DRIVER_HEADER
#endif
 
#if !defined(__HAL_DRIVER_H__) && !defined(__VSF_HEADER_ONLY_SHOW_ARCH_INFO__) && !defined(__VSF_HAL_SHOW_VENDOR_INFO__)
#define __HAL_DRIVER_H__
 
#include "./common/common.h"
 
#include "./vsf/driver.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ LOCAL VARIABLES ===============================*/
/*============================ PROTOTYPES ====================================*/
 
extern bool vsf_driver_init(void);
 
extern bool vsf_driver_poll(void);
 
#ifdef __cplusplus
}
#endif
 
#endif
/* EOF */