Circuit d'entrées-sorties universel ChipIo

Detailed Description

Ce module fournit les fonctions permettant de contrôler un circuit d'entrées-sorties universel ChipIo.

Collaboration diagram for Circuit d'entrées-sorties universel ChipIo:

Modules
	Convertisseur analogique-numérique
	Liaison série

Functions
int	iChipIoAvailableOptions (xChipIo *chip)
int	iChipIoClose (xChipIo *chip)
int	iChipIoReadReg16 (xChipIo *chip, uint8_t reg)
	Lecture d'un registre 16 bits. More...
int	iChipIoReadReg8 (xChipIo *chip, uint8_t reg)
	Lecture d'un registre 8 bits. More...
int	iChipIoReadRegBlock (xChipIo *chip, uint8_t reg, uint8_t *buffer, uint8_t size)
	Lecture d'un bloc de registres. More...
int	iChipIoRevisionMajor (xChipIo *chip)
int	iChipIoRevisionMinor (xChipIo *chip)
int	iChipIoWriteReg16 (xChipIo *chip, uint8_t reg, uint16_t data)
	Ecriture d'un registre 16 bits. More...
int	iChipIoWriteReg8 (xChipIo *chip, uint8_t reg, uint8_t data)
	Ecriture d'un registre 8 bits. More...
int	iChipIoWriteRegBlock (xChipIo *chip, uint8_t reg, const uint8_t *buffer, uint8_t size)
	Ecriture d'un bloc de registres. More...
xChipIo *	xChipIoOpen (const char *sI2cBus, int iSlaveAddr)

Typedefs
typedef struct xChipIo	xChipIo

Enumerations
enum	eChipIoOptions {   eChipIoOptionLcd = 0x01, eChipIoOptionAdc = 0x02, eChipIoOptionSerial = 0x04, eChipIoOptionSerialIrq = 0x40,   eChipIoOptionLcdSplashScreen = 0x80 }

Typedef Documentation

typedef struct xChipIo xChipIo

#include <chipio.h>

Objet ChipIo

Structure opaque pour l'utilisateur

Definition at line 43 of file chipio.h.

Enumeration Type Documentation

enum eChipIoOptions

#include <chipio.h>

Options disponibles

Definition at line 29 of file chipio.h.

             {
  eChipIoOptionLcd              = 0x01,
  eChipIoOptionAdc              = 0x02,
  eChipIoOptionSerial           = 0x04,
  eChipIoOptionSerialIrq        = 0x40,
  eChipIoOptionLcdSplashScreen  = 0x80
} eChipIoOptions;

Function Documentation

int iChipIoAvailableOptions

(

xChipIo *

chip

)

#include <chipio.h>

Retourne les options disponibles du circuit ChipIo

Parameters

chip	Pointeur sur le ChipIo ouvert

Returns

le majeur comme un unsigned, -1 si erreur

int iChipIoClose

(

xChipIo *

chip

)

#include <chipio.h>

Fermeture du port série

Parameters

chip	Pointeur sur le ChipIo ouvert

Returns

0, -1 si erreur

int iChipIoReadReg16	(	xChipIo *	chip,
		uint8_t	reg
	)

#include <chipio.h>

Lecture d'un registre 16 bits.

Cette fonction réalise une transmission de l'adresse du registre à lire, suivie d'une lecture de 2 octets

Note

Les accès i2c au ChipIo sont protégés par un mutex.

Parameters

chip	Pointeur sur le ChipIo ouvert
reg	adresse du registre (ou octet de contrôle)

Returns

la valeur du mot comme un unsigned, -1 si erreur

int iChipIoReadReg8	(	xChipIo *	chip,
		uint8_t	reg
	)

#include <chipio.h>

Lecture d'un registre 8 bits.

Cette fonction réalise une transmission de l'adresse du registre à lire, suivie d'une lecture d'un octet.

Note

Les accès i2c au ChipIo sont protégés par un mutex.

Parameters

chip	Pointeur sur le ChipIo ouvert
reg	adresse du registre (ou octet de contrôle)

Returns

la valeur de l'octet comme un unsigned, -1 si erreur

int iChipIoReadRegBlock	(	xChipIo *	chip,
		uint8_t	reg,
		uint8_t *	buffer,
		uint8_t	size
	)

#include <chipio.h>

Lecture d'un bloc de registres.

Taille maximal du bloc 32 octets.

Note

Les accès i2c au ChipIo sont protégés par un mutex.

Parameters

chip	Pointeur sur le ChipIo ouvert
reg	adresse du premier registre (ou octet de contrôle)
buffer	pointeur vers la zone de stockage des octets, la taille doit être suffisante pour y stocker le nombre d'octets demandés.
size	nombre de registres à lire

Returns

le nombre d'octets lus, -1 si erreur

int iChipIoRevisionMajor

(

xChipIo *

chip

)

#include <chipio.h>

Retourne le numéro majeur de la revision du circuit ChipIo

Parameters

chip	Pointeur sur le ChipIo ouvert

Returns

le majeur comme un unsigned, -1 si erreur

int iChipIoRevisionMinor

(

xChipIo *

chip

)

#include <chipio.h>

Retourne le numéro mineur de la revision du circuit ChipIo

Parameters

chip	Pointeur sur le ChipIo ouvert

Returns

le mineur comme un unsigned, -1 si erreur

int iChipIoWriteReg16	(	xChipIo *	chip,
		uint8_t	reg,
		uint16_t	data
	)

#include <chipio.h>

Ecriture d'un registre 16 bits.

Note

Les accès i2c au ChipIo sont protégés par un mutex.

Parameters

chip	Pointeur sur le ChipIo ouvert
reg	adresse du registre (ou octet de contrôle)
data	valeur du mot

Returns

0, -1 si erreur

int iChipIoWriteReg8	(	xChipIo *	chip,
		uint8_t	reg,
		uint8_t	data
	)

#include <chipio.h>

Ecriture d'un registre 8 bits.

Note

Les accès i2c au ChipIo sont protégés par un mutex.

Parameters

chip	Pointeur sur le ChipIo ouvert
reg	adresse du registre (ou octet de contrôle)
data	valeur de l'octet

Returns

0, -1 si erreur

int iChipIoWriteRegBlock	(	xChipIo *	chip,
		uint8_t	reg,
		const uint8_t *	buffer,
		uint8_t	size
	)

#include <chipio.h>

Ecriture d'un bloc de registres.

Taille maximal du bloc 32 octets.

Note

Les accès i2c au ChipIo sont protégés par un mutex.

Parameters

chip	Pointeur sur le ChipIo ouvert
reg	adresse du premier registre (ou octet de contrôle)
buffer	pointeur vers la zone de stockage des octets
size	nombre d'octets à écrire

Returns

0, -1 si erreur

xChipIo* xChipIoOpen	(	const char *	sI2cBus,
		int	iSlaveAddr
	)

#include <chipio.h>

Ouverture d'un ChipIo sur le port I²C

Parameters

sI2cBus	nom du bus I2C (par exemple /dev/i2c-1)
iSlaveAddr	adresse du circuit I2C (alignée à droite)

Returns

l'objet intialisé et ouvert, NULL si erreur