VSF Documented
Macros | Functions
driver.h File Reference
#include "hal/vsf_hal_cfg.h"
#include "utilities/vsf_utilities.h"
#include <VSF_DRIVER_HEADER>
#include "./common/common.h"
#include "./vsf/driver.h"

Go to the source code of this file.

Macros

#define VSF_DRIVER_HEADER   "./unknown/driver.h"
 
#define __HAL_DRIVER_H__
 you don't have to implement a driver in your system.
 

Functions

bool vsf_driver_init (void)
 common hal drivers
 
bool vsf_driver_poll (void)
 driver polling service for f1c100s
 

Macro Definition Documentation

◆ VSF_DRIVER_HEADER

#define VSF_DRIVER_HEADER   "./unknown/driver.h"
Note
User can define VSF_DRIVER_HEADER to specify the target device driver ! header file. If it is not specified, this driver abstraction header ! file will use predefined device-specific macros to decide which device ! driver header file should be included.

◆ __HAL_DRIVER_H__

#define __HAL_DRIVER_H__

you don't have to implement a driver in your system.

Function Documentation

◆ vsf_driver_init()

bool vsf_driver_init ( void  )
extern

common hal drivers

software emulated hal drivers

Note
initialize drivers
Parameters
none
Return values
trueinitialization succeeded.
falseinitialization failed
Note
initialize device driver
Parameters
none
Return values
trueinitialization succeeded.
falseinitialization failed

common hal drivers

Note
initialize device driver
Parameters
none
Return values
trueinitialization succeeded.
falseinitialization failed

initialise interrupt controller;

\tagpll_init[]

\endpll_init[]

\tag::configure_clk_sys[]

\end::configure_clk_sys[]

◆ vsf_driver_poll()

bool vsf_driver_poll ( void  )
extern

driver polling service for f1c100s

Note
common entry for upper layer to poll driver service
Parameters
none
Return values
trueit is safe to enter sleep mode
falsepolling work is on going, please keep calling the function
Parameters
none
Return values
trueit is safe to enter sleep mode
falsepolling work is on going, please keep calling the function
Note
example about how to put poll functions for each instance of peripherals ! even if the function doesn't exist, the compilation would not be ! affected as long as the corresponding macro ! VSF_HAL_DRV_CFG_XXXX_POLL_MODE_EN is set to DISABLED, i.e. 0