vsf_template_hal_driver.h File Reference

#include "utilities/vsf_utilities.h"
#include "vsf_template_static_assert_unique.h"

Go to the source code of this file.

Data Structures
struct	vsf_hal_device_t
struct	vsf_peripheral_status_t
struct	vsf_peripheral_capability_t

Macros
#define	VSF_HAL_TEMPLATE_API_OP(__prefix_name, __return, __module__, __name, __first_args, ...)
#define	VSF_HAL_TEMPLATE_API_FP(__prefix_name, __return, __module__, __name, __first_args, ...)
#define	VSF_HAL_TEMPLATE_API_EXTERN(__prefix_name, __return, __module__, __name, __first_args, ...)
#define	VSF_HAL_TEMPLATE_API_DEFINE(__prefix_name, __return, __module__, __name, __first_args, ...)
#define	__VSF_HAL_COUNT_TO_MASK(__CNT)
#define	VSF_HAL_COUNT_TO_MASK(__CNT)
#define	__VSF_HAL_MASK_TO_COUNT(__MASK)
#define	VSF_HAL_MASK_TO_COUNT(__MASK)

Typedefs
typedef struct vsf_hal_device_t	vsf_hal_device_t
typedef struct vsf_peripheral_status_t	vsf_peripheral_status_t
typedef struct vsf_peripheral_capability_t	vsf_peripheral_capability_t

Variables
uint_fast32_t	size
vsf_err_t(*	fn_Cancel )(void)
	cancel on going communication
int_fast32_t(*	fn_GetTransferredCount )(void)
	get transferred count

interface: i_peripheral_t
vsf_peripheral_capability_t(*	fn_Capability )(void)
fsm_rt_t(*	fn_Uninit )(void)
union {
fsm_rt_t(*   fn_Enable )(void)
fsm_rt_t(*   fn_Open )(void)
};
union {
fsm_rt_t(*   fn_Disable )(void)
fsm_rt_t(*   fn_Close )(void)
};
	def_interface (i_peripheral_t) vsf_peripheral_status_t(*fn_Status)(void)

Macro Definition Documentation

VSF_HAL_TEMPLATE_API_OP

#define VSF_HAL_TEMPLATE_API_OP	(		__prefix_name,
			__return,
			__module__,
			__name,
			__first_args,
			... )

Value:

    .__name = (__return (*)( VSF_MCONNECT(vsf, _, __module__, _t) *, ##__VA_ARGS__ ))& VSF_MCONNECT(__prefix_name, _, __name),

VSF_HAL_TEMPLATE_API_FP

#define VSF_HAL_TEMPLATE_API_FP	(		__prefix_name,
			__return,
			__module__,
			__name,
			__first_args,
			... )

Value:

    __return (* __name )( __first_args, ##__VA_ARGS__ );

VSF_HAL_TEMPLATE_API_EXTERN

#define VSF_HAL_TEMPLATE_API_EXTERN	(		__prefix_name,
			__return,
			__module__,
			__name,
			__first_args,
			... )

Value:

    extern __return VSF_MCONNECT(__prefix_name, _, __name)( __first_args, ##__VA_ARGS__ );

VSF_HAL_TEMPLATE_API_DEFINE

#define VSF_HAL_TEMPLATE_API_DEFINE	(		__prefix_name,
			__return,
			__module__,
			__name,
			__first_args,
			... )

Value:

    __return VSF_MCONNECT(__prefix_name, _, __name)( __first_args, ##__VA_ARGS__ )

__VSF_HAL_COUNT_TO_MASK

#define __VSF_HAL_COUNT_TO_MASK

(

__CNT

)

VSF_HAL_COUNT_TO_MASK

#define VSF_HAL_COUNT_TO_MASK

(

__CNT

)

Value:

    __VSF_HAL_COUNT_TO_MASK(__CNT)

__VSF_HAL_MASK_TO_COUNT

#define __VSF_HAL_MASK_TO_COUNT

(

__MASK

)

VSF_HAL_MASK_TO_COUNT

#define VSF_HAL_MASK_TO_COUNT

(

__MASK

)

Value:

    __VSF_HAL_MASK_TO_COUNT(__MASK)

Typedef Documentation

vsf_hal_device_t

typedef struct vsf_hal_device_t vsf_hal_device_t

vsf_peripheral_status_t

typedef struct vsf_peripheral_status_t vsf_peripheral_status_t

vsf_peripheral_capability_t

typedef struct vsf_peripheral_capability_t vsf_peripheral_capability_t

Function Documentation

def_interface()

def_interface

(

i_peripheral_t

)

Variable Documentation

fn_Capability

vsf_peripheral_capability_t(* fn_Capability) (void)

(

void

)

fn_Uninit

fsm_rt_t(* fn_Uninit) (void)

(

void

)

fn_Enable

fsm_rt_t(* fn_Enable) (void)

(

void

)

fn_Open

fsm_rt_t(* fn_Open) (void)

(

void

)

[union]

union { ... }

fn_Disable

fsm_rt_t(* fn_Disable) (void)

(

void

)

fn_Close

fsm_rt_t(* fn_Close) (void)

(

void

)

[union]

union { ... }

size

uint_fast32_t size

fn_Cancel

vsf_err_t(* fn_Cancel) (void)

(

void

)

cancel on going communication

fn_GetTransferredCount

int_fast32_t(* fn_GetTransferredCount) (void)

(

void

)

get transferred count