i2c_io_api.h File Reference

#include "juno/status.h"
#include "juno/module.h"
#include "juno/time/time_api.h"
#include <stdbool.h>
#include <stdint.h>

Include dependency graph for i2c_io_api.h:

Go to the source code of this file.

Data Structures
struct	JUNO_I2C_IO_MSG_HDR_TAG
struct	JUNO_I2C_IO_MSG_R_TAG
struct	JUNO_I2C_IO_MSG_W_TAG
union	JUNO_I2C_IO_MSG_TAG
struct	JUNO_I2C_IO_API_TAG

Macros
#define	ReadMsg(iAddr, pcBuff, zBuffSize)
#define	WriteMsg(iAddr, pvBuff, zBuffSize)
#define	JUNO_I2C_IO_TRANSFER(...)   (JUNO_I2C_IO_MSG_T[]){__VA_ARGS__}

Typedefs
typedef struct JUNO_I2C_IO_API_TAG	JUNO_I2C_IO_API_T
typedef struct JUNO_I2C_IO_MSG_R_TAG	JUNO_I2C_IO_MSG_R_T
typedef struct JUNO_I2C_IO_MSG_W_TAG	JUNO_I2C_IO_MSG_W_T
typedef struct JUNO_I2C_IO_MSG_HDR_TAG	JUNO_I2C_IO_MSG_HDR_T
typedef union JUNO_I2C_IO_MSG_TAG	JUNO_I2C_IO_MSG_T
typedef enum JUNO_I2C_IO_MSG_TYPE_TAG	JUNO_I2C_IO_MSG_TYPE_T

Enumerations
enum	JUNO_I2C_IO_MSG_TYPE_TAG { JUNO_I2C_IO_MSG_TYPE_RESERVED = 0 , JUNO_I2C_IO_MSG_TYPE_W = 1 , JUNO_I2C_IO_MSG_TYPE_R = 2 }

Functions
	JUNO_MODULE_DECLARE (JUNO_I2C_IO_T)
	JUNO_MODULE_BASE_DECLARE (JUNO_I2C_IO_BASE_T)
	JUNO_MODULE_BASE (JUNO_I2C_IO_BASE_T, JUNO_I2C_IO_API_T, JUNO_MODULE_EMPTY)

Macro Definition Documentation

JUNO_I2C_IO_TRANSFER

#define JUNO_I2C_IO_TRANSFER

(

...

)

(JUNO_I2C_IO_MSG_T[]){__VA_ARGS__}

ReadMsg

#define ReadMsg	(		iAddr,
			pcBuff,
			zBuffSize
	)

Value:

(JUNO_I2C_IO_MSG_T) \
{ \
    .tRead = (JUNO_I2C_IO_MSG_R_T) \
    { \
        .tHdr = {JUNO_I2C_IO_MSG_TYPE_R, iAddr}, \
        .ptReadBuff = pcBuff, \
        .zReadBuffSize = zBuffSize \
    } \
}

WriteMsg

#define WriteMsg	(		iAddr,
			pvBuff,
			zBuffSize
	)

Value:

(JUNO_I2C_IO_MSG_T) \
{ \
    .tWrite = (JUNO_I2C_IO_MSG_W_T) \
    { \
        .tHdr = {JUNO_I2C_IO_MSG_TYPE_W, iAddr}, \
        .ptWriteBuff = pvBuff, \
        .zWriteBuffSize = zBuffSize \
    } \
}

Typedef Documentation

JUNO_I2C_IO_API_T

typedef struct JUNO_I2C_IO_API_TAG JUNO_I2C_IO_API_T

This API has been generated by LibJuno: https://www.robinonsay.com/libjuno/ This header contains the io library API

Author

JUNO_I2C_IO_MSG_HDR_T

typedef struct JUNO_I2C_IO_MSG_HDR_TAG JUNO_I2C_IO_MSG_HDR_T

JUNO_I2C_IO_MSG_R_T

typedef struct JUNO_I2C_IO_MSG_R_TAG JUNO_I2C_IO_MSG_R_T

JUNO_I2C_IO_MSG_T

typedef union JUNO_I2C_IO_MSG_TAG JUNO_I2C_IO_MSG_T

JUNO_I2C_IO_MSG_TYPE_T

typedef enum JUNO_I2C_IO_MSG_TYPE_TAG JUNO_I2C_IO_MSG_TYPE_T

JUNO_I2C_IO_MSG_W_T

typedef struct JUNO_I2C_IO_MSG_W_TAG JUNO_I2C_IO_MSG_W_T

Enumeration Type Documentation

JUNO_I2C_IO_MSG_TYPE_TAG

enum JUNO_I2C_IO_MSG_TYPE_TAG

Enumerator
JUNO_I2C_IO_MSG_TYPE_RESERVED
JUNO_I2C_IO_MSG_TYPE_W
JUNO_I2C_IO_MSG_TYPE_R

Function Documentation

JUNO_MODULE_BASE()

JUNO_MODULE_BASE	(	JUNO_I2C_IO_BASE_T	,
		JUNO_I2C_IO_API_T	,
		JUNO_MODULE_EMPTY
	)

JUNO_MODULE_BASE_DECLARE()

JUNO_MODULE_BASE_DECLARE

(

JUNO_I2C_IO_BASE_T

)

JUNO_MODULE_DECLARE()

JUNO_MODULE_DECLARE

(

JUNO_I2C_IO_T

)