gpio.h File Reference

#include <stdarg.h>
#include <zrtos/error.h>
#include <zrtos/types.h>
#include <zrtos/arch.h>
#include <zrtos/assert.h>

Include dependency graph for gpio.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_zrtos_gpio_t

Macros
#define	ZRTOS_GPIO__VA_ARG_MODE(args)   ((zrtos_gpio_mode_t)va_arg(args,unsigned int))
#define	ZRTOS_GPIO__VA_ARG_PIN(args)   ((zrtos_gpio_pin_t)va_arg(args,unsigned int))
#define	ZRTOS_GPIO__VA_ARG_VALUE_DIGITAL(args)   ((zrtos_gpio_value_digital_t)va_arg(args,unsigned int))
#define	ZRTOS_GPIO__VA_ARG_VALUE_ANALOG(args)   ((zrtos_gpio_value_analog_t)va_arg(args,unsigned int))
#define	ZRTOS_GPIO__INIT(set_mode_, digital_read_, digital_write_, analog_read_, analog_write_)

Typedefs
typedef zrtos_arch_gpio_pin_t	zrtos_gpio_pin_t
typedef bool	zrtos_gpio_value_digital_t
typedef zrtos_arch_gpio_value_analog_t	zrtos_gpio_value_analog_t
typedef struct _zrtos_gpio_t	zrtos_gpio_t

Enumerations
enum	zrtos_gpio_mode_t {   ZRTOS_GPIO_MODE__INPUT = 0x0,   ZRTOS_GPIO_MODE__OUTPUT = 0x1,   ZRTOS_GPIO_MODE__PULLUP = 0x2 }

Functions
	ZRTOS_ASSERT__STATIC (sizeof(zrtos_gpio_value_digital_t)<=sizeof(unsigned int))
	ZRTOS_ASSERT__STATIC (sizeof(zrtos_gpio_mode_t)<=sizeof(unsigned int))
	ZRTOS_ASSERT__STATIC (sizeof(zrtos_gpio_pin_t)<=sizeof(unsigned int))
bool	zrtos_gpio__init (zrtos_gpio_t *thiz, zrtos_error_t(*set_mode)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_mode_t mode), zrtos_error_t(*digital_read)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_digital_t *val), zrtos_error_t(*digital_write)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_digital_t val), zrtos_error_t(*analog_read)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_analog_t *val), zrtos_error_t(*analog_write)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_analog_t val))
zrtos_error_t	zrtos_gpio__set_mode (zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_mode_t mode)
zrtos_error_t	zrtos_gpio__set_mode_va (zrtos_gpio_t *thiz, va_list args)
zrtos_error_t	zrtos_gpio__set_mode_ex (zrtos_gpio_t *thiz,...)
zrtos_error_t	zrtos_gpio__digital_read (zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_digital_t *val)
zrtos_error_t	zrtos_gpio__digital_read_va (zrtos_gpio_t *thiz, va_list args)
zrtos_error_t	zrtos_gpio__digital_read_ex (zrtos_gpio_t *thiz,...)
zrtos_error_t	zrtos_gpio__digital_write (zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_digital_t val)
zrtos_error_t	zrtos_gpio__digital_write_va (zrtos_gpio_t *thiz, va_list args)
zrtos_error_t	zrtos_gpio__digital_write_ex (zrtos_gpio_t *thiz,...)
zrtos_error_t	zrtos_gpio__set_high (zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin)
zrtos_error_t	zrtos_gpio__set_high_va (zrtos_gpio_t *thiz, va_list args)
zrtos_error_t	zrtos_gpio__set_high_ex (zrtos_gpio_t *thiz,...)
zrtos_error_t	zrtos_gpio__set_low (zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin)
zrtos_error_t	zrtos_gpio__set_low_va (zrtos_gpio_t *thiz, va_list args)
zrtos_error_t	zrtos_gpio__set_low_ex (zrtos_gpio_t *thiz,...)
zrtos_error_t	zrtos_gpio__analog_read (zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_analog_t *val)
zrtos_error_t	zrtos_gpio__analog_read_va (zrtos_gpio_t *thiz, va_list args)
zrtos_error_t	zrtos_gpio__analog_read_ex (zrtos_gpio_t *thiz,...)
zrtos_error_t	zrtos_gpio__analog_write (zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_analog_t val)
zrtos_error_t	zrtos_gpio__analog_write_va (zrtos_gpio_t *thiz, va_list args)
zrtos_error_t	zrtos_gpio__analog_write_ex (zrtos_gpio_t *thiz,...)
uint8_t	zrtos_gpio__shift_in (zrtos_gpio_t *thiz, zrtos_gpio_pin_t dataPin, zrtos_gpio_pin_t clockPin, bool is_lsb)
zrtos_error_t	zrtos_gpio__shift_out (zrtos_gpio_t *thiz, zrtos_gpio_pin_t dataPin, zrtos_gpio_pin_t clockPin, bool is_lsb, uint8_t value)
void	zrtos_gpio__delay_microseconds (uint16_t us)
void	zrtos_gpio__delay_milliseconds (uint16_t ms)

Macro Definition Documentation

ZRTOS_GPIO__INIT

#define ZRTOS_GPIO__INIT	(		set_mode_,
			digital_read_,
			digital_write_,
			analog_read_,
			analog_write_
	)

Value:

{\
         .set_mode = set_mode_\
        ,.digital_read = digital_read_\
        ,.digital_write = digital_write_\
        ,.analog_read = analog_read_\
        ,.analog_write = analog_write_\
    }

Definition at line 78 of file gpio.h.

ZRTOS_GPIO__VA_ARG_MODE

#define ZRTOS_GPIO__VA_ARG_MODE

(

args

)

((zrtos_gpio_mode_t)va_arg(args,unsigned int))

Definition at line 37 of file gpio.h.

ZRTOS_GPIO__VA_ARG_PIN

#define ZRTOS_GPIO__VA_ARG_PIN

(

args

)

((zrtos_gpio_pin_t)va_arg(args,unsigned int))

Definition at line 39 of file gpio.h.

ZRTOS_GPIO__VA_ARG_VALUE_ANALOG

#define ZRTOS_GPIO__VA_ARG_VALUE_ANALOG

(

args

)

((zrtos_gpio_value_analog_t)va_arg(args,unsigned int))

Definition at line 43 of file gpio.h.

ZRTOS_GPIO__VA_ARG_VALUE_DIGITAL

#define ZRTOS_GPIO__VA_ARG_VALUE_DIGITAL

(

args

)

((zrtos_gpio_value_digital_t)va_arg(args,unsigned int))

Definition at line 41 of file gpio.h.

Typedef Documentation

zrtos_gpio_pin_t

typedef zrtos_arch_gpio_pin_t zrtos_gpio_pin_t

Definition at line 22 of file gpio.h.

zrtos_gpio_t

typedef struct _zrtos_gpio_t zrtos_gpio_t

zrtos_gpio_value_analog_t

typedef zrtos_arch_gpio_value_analog_t zrtos_gpio_value_analog_t

Definition at line 31 of file gpio.h.

zrtos_gpio_value_digital_t

typedef bool zrtos_gpio_value_digital_t

Definition at line 30 of file gpio.h.

Enumeration Type Documentation

zrtos_gpio_mode_t

enum zrtos_gpio_mode_t

Enumerator
ZRTOS_GPIO_MODE__INPUT
ZRTOS_GPIO_MODE__OUTPUT
ZRTOS_GPIO_MODE__PULLUP

Definition at line 24 of file gpio.h.

            {
     ZRTOS_GPIO_MODE__INPUT  = 0x0
    ,ZRTOS_GPIO_MODE__OUTPUT = 0x1
    ,ZRTOS_GPIO_MODE__PULLUP = 0x2
}zrtos_gpio_mode_t;

Function Documentation

ZRTOS_ASSERT__STATIC() [1/3]

ZRTOS_ASSERT__STATIC

(

sizeof(zrtos_gpio_value_digital_t)<=sizeof(unsigned int)

)

ZRTOS_ASSERT__STATIC() [2/3]

ZRTOS_ASSERT__STATIC

(

sizeof(zrtos_gpio_mode_t)<=sizeof(unsigned int)

)

ZRTOS_ASSERT__STATIC() [3/3]

ZRTOS_ASSERT__STATIC

(

sizeof(zrtos_gpio_pin_t)<=sizeof(unsigned int)

)

zrtos_gpio__analog_read()

zrtos_error_t zrtos_gpio__analog_read	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	pin,
		zrtos_gpio_value_analog_t *	val
	)

Definition at line 365 of file gpio.h.

 {
    return thiz->analog_read(thiz,pin,val);
}

Here is the caller graph for this function:

zrtos_gpio__analog_read_ex()

zrtos_error_t zrtos_gpio__analog_read_ex	(	zrtos_gpio_t *	thiz,
			...
	)

Definition at line 395 of file gpio.h.

 {
    zrtos_error_t ret;
    va_list       args;

    va_start(args,thiz);
    ret = zrtos_gpio__analog_read_ex(
         thiz
        ,args
    );
    va_end(args);

    return ret;
}

zrtos_gpio__analog_read_va()

zrtos_error_t zrtos_gpio__analog_read_va	(	zrtos_gpio_t *	thiz,
		va_list	args
	)

Definition at line 373 of file gpio.h.

 {
    zrtos_error_t             ret = ZRTOS_ERROR__SUCCESS;
    zrtos_gpio_pin_t          pin;
    zrtos_gpio_value_analog_t *val;
    size_t                    len = va_arg(args,size_t);

    while(len-- && zrtos_error__is_success(ret)){
        pin = ZRTOS_GPIO__VA_ARG_PIN(args);
        val = va_arg(args,zrtos_gpio_value_analog_t*);
        ret = zrtos_gpio__analog_read(
             thiz
            ,pin
            ,val
        );
    }

    return ret;
}

Here is the call graph for this function:

zrtos_gpio__analog_write()

zrtos_error_t zrtos_gpio__analog_write	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	pin,
		zrtos_gpio_value_analog_t	val
	)

Definition at line 412 of file gpio.h.

 {
    return thiz->analog_write(thiz,pin,val);
}

Here is the caller graph for this function:

zrtos_gpio__analog_write_ex()

zrtos_error_t zrtos_gpio__analog_write_ex	(	zrtos_gpio_t *	thiz,
			...
	)

Definition at line 442 of file gpio.h.

 {
    zrtos_error_t ret;
    va_list       args;

    va_start(args,thiz);
    ret = zrtos_gpio__analog_write_va(
         thiz
        ,args
    );
    va_end(args);

    return ret;
}

Here is the call graph for this function:

zrtos_gpio__analog_write_va()

zrtos_error_t zrtos_gpio__analog_write_va	(	zrtos_gpio_t *	thiz,
		va_list	args
	)

Definition at line 420 of file gpio.h.

 {
    zrtos_error_t             ret = ZRTOS_ERROR__SUCCESS;
    zrtos_gpio_pin_t          pin;
    zrtos_gpio_value_analog_t val;
    size_t                    len = va_arg(args,size_t);

    while(len-- && zrtos_error__is_success(ret)){
        pin = ZRTOS_GPIO__VA_ARG_PIN(args);
        val = ZRTOS_GPIO__VA_ARG_VALUE_ANALOG(args);
        ret = zrtos_gpio__analog_write(
             thiz
            ,pin
            ,val
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__delay_microseconds()

void zrtos_gpio__delay_microseconds

(

uint16_t

us

)

Definition at line 508 of file gpio.h.

                                                {
    zrtos_arch__delay_microseconds(us);
}

Here is the call graph for this function:

zrtos_gpio__delay_milliseconds()

void zrtos_gpio__delay_milliseconds

(

uint16_t

ms

)

Definition at line 512 of file gpio.h.

                                                {
    zrtos_arch__delay_milliseconds(ms);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__digital_read()

zrtos_error_t zrtos_gpio__digital_read	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	pin,
		zrtos_gpio_value_digital_t *	val
	)

Definition at line 177 of file gpio.h.

 {
    return thiz->digital_read(thiz,pin,val);
}

Here is the caller graph for this function:

zrtos_gpio__digital_read_ex()

zrtos_error_t zrtos_gpio__digital_read_ex	(	zrtos_gpio_t *	thiz,
			...
	)

Definition at line 207 of file gpio.h.

 {
    zrtos_error_t ret;
    va_list       args;

    va_start(args,thiz);
    ret = zrtos_gpio__digital_read_va(
         thiz
        ,args
    );
    va_end(args);

    return ret;
}

Here is the call graph for this function:

zrtos_gpio__digital_read_va()

zrtos_error_t zrtos_gpio__digital_read_va	(	zrtos_gpio_t *	thiz,
		va_list	args
	)

Definition at line 185 of file gpio.h.

 {
    zrtos_error_t              ret = ZRTOS_ERROR__SUCCESS;
    zrtos_gpio_pin_t           pin;
    zrtos_gpio_value_digital_t *val;
    size_t                     len = va_arg(args,size_t);

    while(len-- && zrtos_error__is_success(ret)){
        pin = ZRTOS_GPIO__VA_ARG_PIN(args);
        val = va_arg(args,zrtos_gpio_value_digital_t*);
        ret = zrtos_gpio__digital_read(
             thiz
            ,pin
            ,val
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__digital_write()

zrtos_error_t zrtos_gpio__digital_write	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	pin,
		zrtos_gpio_value_digital_t	val
	)

Definition at line 224 of file gpio.h.

 {
    return thiz->digital_write(thiz,pin,val);
}

Here is the caller graph for this function:

zrtos_gpio__digital_write_ex()

zrtos_error_t zrtos_gpio__digital_write_ex	(	zrtos_gpio_t *	thiz,
			...
	)

Definition at line 254 of file gpio.h.

 {
    zrtos_error_t ret;
    va_list       args;

    va_start(args,thiz);
    ret = zrtos_gpio__digital_write_va(
         thiz
        ,args
    );
    va_end(args);

    return ret;
}

Here is the call graph for this function:

zrtos_gpio__digital_write_va()

zrtos_error_t zrtos_gpio__digital_write_va	(	zrtos_gpio_t *	thiz,
		va_list	args
	)

Definition at line 232 of file gpio.h.

 {
    zrtos_error_t              ret = ZRTOS_ERROR__SUCCESS;
    zrtos_gpio_pin_t           pin;
    zrtos_gpio_value_digital_t val;
    size_t                     len = va_arg(args,size_t);

    while(len-- && zrtos_error__is_success(ret)){
        pin = ZRTOS_GPIO__VA_ARG_PIN(args);
        val = ZRTOS_GPIO__VA_ARG_VALUE_DIGITAL(args);
        ret = zrtos_gpio__digital_write(
             thiz
            ,pin
            ,val
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__init()

bool zrtos_gpio__init	(	zrtos_gpio_t *	thiz,
		zrtos_error_t(*)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_mode_t mode)	set_mode,
		zrtos_error_t(*)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_digital_t *val)	digital_read,
		zrtos_error_t(*)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_digital_t val)	digital_write,
		zrtos_error_t(*)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_analog_t *val)	analog_read,
		zrtos_error_t(*)(struct _zrtos_gpio_t *thiz, zrtos_gpio_pin_t pin, zrtos_gpio_value_analog_t val)	analog_write
	)

Definition at line 93 of file gpio.h.

 {
    thiz->set_mode = set_mode;
    thiz->digital_read = digital_read;
    thiz->digital_write = digital_write;
    thiz->analog_read = analog_read;
    thiz->analog_write = analog_write;

    return true;
}

zrtos_gpio__set_high()

zrtos_error_t zrtos_gpio__set_high	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	pin
	)

Definition at line 271 of file gpio.h.

 {
    return zrtos_gpio__digital_write(
         thiz
        ,pin
        ,true
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__set_high_ex()

zrtos_error_t zrtos_gpio__set_high_ex	(	zrtos_gpio_t *	thiz,
			...
	)

Definition at line 301 of file gpio.h.

 {
    zrtos_error_t ret;
    va_list       args;

    va_start(args,thiz);
    ret = zrtos_gpio__set_high_va(
         thiz
        ,args
    );
    va_end(args);

    return ret;
}

Here is the call graph for this function:

zrtos_gpio__set_high_va()

zrtos_error_t zrtos_gpio__set_high_va	(	zrtos_gpio_t *	thiz,
		va_list	args
	)

Definition at line 282 of file gpio.h.

 {
    zrtos_error_t    ret = ZRTOS_ERROR__SUCCESS;
    zrtos_gpio_pin_t pin;
    size_t           len = va_arg(args,size_t);

    while(len-- && zrtos_error__is_success(ret)){
        pin = ZRTOS_GPIO__VA_ARG_PIN(args);
        ret = zrtos_gpio__set_high(
             thiz
            ,pin
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__set_low()

zrtos_error_t zrtos_gpio__set_low	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	pin
	)

Definition at line 318 of file gpio.h.

 {
    return thiz->digital_write(
         thiz
        ,pin
        ,false
    );
}

Here is the caller graph for this function:

zrtos_gpio__set_low_ex()

zrtos_error_t zrtos_gpio__set_low_ex	(	zrtos_gpio_t *	thiz,
			...
	)

Definition at line 348 of file gpio.h.

 {
    zrtos_error_t ret;
    va_list args;

    va_start(args,thiz);
    ret = zrtos_gpio__set_low_va(
         thiz
        ,args
    );
    va_end(args);

    return ret;
}

Here is the call graph for this function:

zrtos_gpio__set_low_va()

zrtos_error_t zrtos_gpio__set_low_va	(	zrtos_gpio_t *	thiz,
		va_list	args
	)

Definition at line 329 of file gpio.h.

 {
    zrtos_error_t    ret = ZRTOS_ERROR__SUCCESS;
    zrtos_gpio_pin_t pin;
    size_t           len = va_arg(args,size_t);

    while(len-- && zrtos_error__is_success(ret)){
        pin = ZRTOS_GPIO__VA_ARG_PIN(args);
        ret = zrtos_gpio__set_low(
             thiz
            ,pin
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__set_mode()

zrtos_error_t zrtos_gpio__set_mode	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	pin,
		zrtos_gpio_mode_t	mode
	)

Definition at line 130 of file gpio.h.

 {
    return thiz->set_mode(thiz,pin,mode);
}

Here is the caller graph for this function:

zrtos_gpio__set_mode_ex()

zrtos_error_t zrtos_gpio__set_mode_ex	(	zrtos_gpio_t *	thiz,
			...
	)

Definition at line 160 of file gpio.h.

 {
    zrtos_error_t ret;
    va_list       args;

    va_start(args,thiz);
    ret = zrtos_gpio__set_mode_va(
         thiz
        ,args
    );
    va_end(args);

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__set_mode_va()

zrtos_error_t zrtos_gpio__set_mode_va	(	zrtos_gpio_t *	thiz,
		va_list	args
	)

Definition at line 138 of file gpio.h.

 {
    zrtos_error_t     ret = ZRTOS_ERROR__SUCCESS;
    zrtos_gpio_pin_t  pin;
    zrtos_gpio_mode_t val;
    size_t            len = va_arg(args,size_t);

    while(len-- && zrtos_error__is_success(ret)){
        pin = ZRTOS_GPIO__VA_ARG_PIN(args);
        val = ZRTOS_GPIO__VA_ARG_MODE(args);
        ret = zrtos_gpio__set_mode(
             thiz
            ,pin
            ,val
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_gpio__shift_in()

uint8_t zrtos_gpio__shift_in	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	dataPin,
		zrtos_gpio_pin_t	clockPin,
		bool	is_lsb
	)

Definition at line 459 of file gpio.h.

 {
    uint8_t value = 0;
    size_t i;
    zrtos_gpio_value_digital_t val;

    for (i = 0; i < 8; ++i) {
        zrtos_gpio__set_high(thiz,clockPin);
        zrtos_gpio__digital_read(thiz,dataPin,&val);
        if(is_lsb){
            value |= val << i;
        }else{
            value |= val << (7 - i);
        }
        zrtos_gpio__set_low(thiz,clockPin);
    }
    return value;
}

Here is the call graph for this function:

zrtos_gpio__shift_out()

zrtos_error_t zrtos_gpio__shift_out	(	zrtos_gpio_t *	thiz,
		zrtos_gpio_pin_t	dataPin,
		zrtos_gpio_pin_t	clockPin,
		bool	is_lsb,
		uint8_t	value
	)

Definition at line 482 of file gpio.h.

 {
    size_t i;
    zrtos_gpio_value_digital_t val;

    for(i = 0; i < 8; i++){
        if(is_lsb){
            val = (value & 1);
            value >>= 1;
        } else {
            val = ((value & 128) != 0);
            value <<= 1;
        }
        zrtos_gpio__digital_write(thiz,dataPin,val);
        zrtos_gpio__set_high(thiz,clockPin);
        zrtos_gpio__set_low(thiz,clockPin);
    }

    return ZRTOS_ERROR__SUCCESS;
}

Here is the call graph for this function: