vsf_led_scan.h File Reference

#include "component/vsf_component_cfg.h"
#include "hal/vsf_hal.h"
#include "kernel/vsf_kernel.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
struct	vsf_led_scan_pin_t
struct	vsf_led_scan_hw_t
class	vsf_led_scan_t

Macros
#define	__describe_led_scan_led(__pin_set, __pin_clr)    { .pin_set = (__pin_set), .pin_clr = (__pin_clr) }
#define	describe_led_scan_led(__pin_set, __pin_clr)    __describe_led_scan_led((__pin_set), (__pin_clr))
#define	__describe_led_scan_hw(__name, __io_mapper, __led_num, ...)
#define	describe_led_scan_hw(__name, __io_mapper, __led_num, ...)    __describe_led_scan_hw(__name, (__io_mapper), (__led_num), __VA_ARGS__)
#define	__describe_led_scan(__name, __io_mapper, __led_num, ...)
#define	describe_led_scan(__name, __io_mapper, __led_num, ...)    __describe_led_scan(__name, (__io_mapper), (__led_num), __VA_ARGS__)

Typedefs
typedef struct vsf_led_scan_pin_t	vsf_led_scan_pin_t
typedef struct vsf_led_scan_hw_t	vsf_led_scan_hw_t

Functions
void	vsf_led_scan_config_pin (vsf_led_scan_t *scan, uint32_t pin_mask, uint32_t feature)
void	vsf_led_scan_set_direction (vsf_led_scan_t *scan, uint32_t pin_mask, uint32_t direction_mask)
uint32_t	vsf_led_scan_get_direction (vsf_led_scan_t *scan, uint32_t pin_mask)
void	vsf_led_scan_switch_direction (vsf_led_scan_t *scan, uint32_t pin_mask)
void	vsf_led_scan_set_input (vsf_led_scan_t *scan, uint32_t pin_mask)
void	vsf_led_scan_set_output (vsf_led_scan_t *scan, uint32_t pin_mask)
uint32_t	vsf_led_scan_read (vsf_led_scan_t *scan)
void	vsf_led_scan_write (vsf_led_scan_t *scan, uint32_t value, uint32_t pin_mask)
void	vsf_led_scan_set (vsf_led_scan_t *scan, uint32_t pin_mask)
void	vsf_led_scan_clear (vsf_led_scan_t *scan, uint32_t pin_mask)
void	vsf_led_scan_toggle (vsf_led_scan_t *scan, uint32_t pin_mask)

Macro Definition Documentation

__describe_led_scan_led

#define __describe_led_scan_led	(		__pin_set,
			__pin_clr
	)		{ .pin_set = (__pin_set), .pin_clr = (__pin_clr) }

describe_led_scan_led

#define describe_led_scan_led	(		__pin_set,
			__pin_clr
	)		__describe_led_scan_led((__pin_set), (__pin_clr))

__describe_led_scan_hw

#define __describe_led_scan_hw	(		__name,
			__io_mapper,
			__led_num,
			...
	)

Value:

    typedef struct VSF_MCONNECT(__, __name, _hw_t) {                            \
        const vsf_io_mapper_t *io_mapper;                                       \
        uint8_t led_num;                                                        \
        vsf_led_scan_pin_t __pins[(__led_num)];                                 \
    } VSF_MCONNECT(__, __name, _hw_t);                                          \
    const VSF_MCONNECT(__, __name, _hw_t) VSF_MCONNECT(__, __name, _hw) = {     \
        .io_mapper      = (const vsf_io_mapper_t *)(__io_mapper),               \
        .led_num        = (__led_num),                                          \
        .__pins         = {                                                     \
            __VA_ARGS__                                                         \
        },                                                                      \
    };

describe_led_scan_hw

#define describe_led_scan_hw	(		__name,
			__io_mapper,
			__led_num,
			...
	)		__describe_led_scan_hw(__name, (__io_mapper), (__led_num), __VA_ARGS__)

__describe_led_scan

#define __describe_led_scan	(		__name,
			__io_mapper,
			__led_num,
			...
	)

Value:

    describe_led_scan_hw(__name, (__io_mapper), (__led_num), __VA_ARGS__)       \
    vsf_led_scan_t __name = {                                                   \
        .hw             = (const vsf_led_scan_hw_t *)&VSF_MCONNECT(__, __name, _hw),\
    };

describe_led_scan

#define describe_led_scan	(		__name,
			__io_mapper,
			__led_num,
			...
	)		__describe_led_scan(__name, (__io_mapper), (__led_num), __VA_ARGS__)

Typedef Documentation

vsf_led_scan_pin_t

typedef struct vsf_led_scan_pin_t vsf_led_scan_pin_t

vsf_led_scan_hw_t

typedef struct vsf_led_scan_hw_t vsf_led_scan_hw_t

Function Documentation

vsf_led_scan_config_pin()

void vsf_led_scan_config_pin ( vsf_led_scan_t *  scan, uint32_t  pin_mask, uint32_t  feature  )

extern

vsf_led_scan_set_direction()

void vsf_led_scan_set_direction ( vsf_led_scan_t *  scan, uint32_t  pin_mask, uint32_t  direction_mask  )

extern

vsf_led_scan_get_direction()

uint32_t vsf_led_scan_get_direction ( vsf_led_scan_t *  scan, uint32_t  pin_mask  )

extern

vsf_led_scan_switch_direction()

void vsf_led_scan_switch_direction ( vsf_led_scan_t *  scan, uint32_t  pin_mask  )

extern

vsf_led_scan_set_input()

void vsf_led_scan_set_input ( vsf_led_scan_t *  scan, uint32_t  pin_mask  )

extern

vsf_led_scan_set_output()

void vsf_led_scan_set_output ( vsf_led_scan_t *  scan, uint32_t  pin_mask  )

extern

vsf_led_scan_read()

uint32_t vsf_led_scan_read ( vsf_led_scan_t *  scan )

extern

vsf_led_scan_write()

void vsf_led_scan_write ( vsf_led_scan_t *  scan, uint32_t  value, uint32_t  pin_mask  )

extern

vsf_led_scan_set()

void vsf_led_scan_set ( vsf_led_scan_t *  scan, uint32_t  pin_mask  )

extern

vsf_led_scan_clear()

void vsf_led_scan_clear ( vsf_led_scan_t *  scan, uint32_t  pin_mask  )

extern

vsf_led_scan_toggle()

void vsf_led_scan_toggle ( vsf_led_scan_t *  scan, uint32_t  pin_mask  )

extern