Qt4Pi

Class CSPIDevice

La classe CSPIDevice représente un périphérique générique SPI et exporte toutes les fonctions nécessaires aux communications avec ce composant.

Pour des exemples et informations sur l'utilisation des bus I2C et SPI, se reporter à la rubrique : Exemples I2C et SPI avec cpp2835.

Fonctions publiques

	CSPIDevice(CSPIBus* pSPIBus, const GPIO_PIN& eSpiCSPin, const SPI_CS_POLARITY& eSpiCSPolarity, const SPI_BIT_ORDER& eSpiBitOrder, const SPI_CLOCK_DIVIDER& eSpiClockDivider, const SPI_DATA_MODE& eSpiDataMode)
bool	ChipSelect()
bool	ChipUnselect()
bool	Initialize()
bool	SetBusParameters()
bool	Transfer(const uint8_t& bVal)
bool	TransferBuffer(uint8_t* pbVal, const uint32_t& uLen)
bool	Write(const uchar& cVal)
bool	WriteBuffer(const char* pcVal, const uint32_t& uLen)
bool	WriteRead(const uchar& cVal, uchar* pcValRet)
bool	WriteReadBuffer(char* const pcVal, char* pcValRet, const uint32_t& uLen)

CSPIDevice::CSPIDevice(CSPIBus* pSPIBus, const GPIO_PIN& eSpiCSPin, const SPI_CS_POLARITY& eSpiCSPolarity, const SPI_BIT_ORDER& eSpiBitOrder, const SPI_CLOCK_DIVIDER& eSpiClockDivider, const SPI_DATA_MODE& eSpiDataMode)

Description : Contructeur. Instancie un objet de la classe CSPIDevice et applique les paramètres passés à ce constructeur.

Paramètre : pSPIBus - type CSPIBus* - Pointeur vers l'objet CSPIBus auquel est relié ce périphérique.

Paramètre : eGpioPin - type GPIO_PIN - Ligne GPIO attribuée au signal CS du bus SPI.

Paramètre : eSpiCSPolarity - type SPI_CS_POLARITY - Polarité de la ligne CS.

Paramètre : eSpiBitOrder - type SPI_BIT_ORDER - Réglage des l'odre des bit.

Paramètre : eSpiClockDivider - type SPI_CLOCK_DIVIDER - Diviseur de l'horloge SPI permettant d'ajuster la fréquence du bus.

Paramètre : eSpiDataMode - type SPI_DATA_MODE - Réglage du mode SPI.

bool CSPIDevice::ChipSelect()

Description : Asserte la ligne CS attribuée à ce périphérique.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::ChipUnselect()

Description : Déasserte la ligne CS attribuée à ce périphérique.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::Initialize()

Description : Applique la ligne CS et sa polarité à ce préiphérique.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::SetBusParameters()

Description : Applique les paramètres de fréquence, mode et ordre des bit à ce périphérique.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::Open(const SPI_BIT_ORDER& eSpiBitOrder, const SPI_CLOCK_DIVIDER& eSpiClockDivider, const SPI_DATA_MODE& eSpiDataMode)

Description : Ouvre l'accès au bus SPI. Cette fonction doit être appelée avant toute autre fonction de lecture ou écriture sur le bus SPI.

Paramètre : eSpiBitOrder - type SPI_BIT_ORDER - Réglage des l'ordre des bit.

Paramètre : eSpiClockDivider - type SPI_CLOCK_DIVIDER - Diviseur de l'horloge SPI permettant d'ajuster la fréquence du bus.

Paramètre : eSpiDataMode - type SPI_DATA_MODE - Réglage du mode SPI.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::SetBusParameters(const SPI_BIT_ORDER& eSpiBitOrder, const SPI_CLOCK_DIVIDER& eSpiClockDivider, const SPI_DATA_MODE& eSpiDataMode)

Description : Modifie les paramètres du bus SPI.

Paramètre : eSpiBitOrder - type SPI_BIT_ORDER - Réglage des l'ordre des bit.

Paramètre : eSpiClockDivider - type SPI_CLOCK_DIVIDER - Diviseur de l'horloge SPI permettant d'ajuster la fréquence du bus.

Paramètre : eSpiDataMode - type SPI_DATA_MODE - Réglage du mode SPI.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::Transfer(const uint8_t& bVal)

Description : Emet l'octet bVal sur le bus SPI.

Paramètre : bVal - type uint8_t - Octet à émettre.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::TransferBuffer(uint8_t* pbVal, const uint32_t& uLen)

Description : Emet le buffer pbVal de longueur uLen sur le bus SPI.

Paramètre : pbVal - type uint8_t* - Pointeur vers le buffer d'octets à émettre.

Paramètre : uLen - type uint32_t - Taille du buffer d'octets à émettre.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::Write(const uchar& cVal)

Description : Ecrit un octet sur le bus SPI.

Paramètre : cVal - type uchar - Octet à écrire sur le bus.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::WriteBuffer(const char* pcVal, const uint32_t& uLen)

Description : Ecrit un buffer d'octets sur le bus SPI.

Paramètre : pcVal - type char* - Buffer d'octets à écrire sur le bus.

Paramètre : uLen - type uint32_t - Taille du buffer d'octets à émettre.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::WriteRead(const uchar& cVal, uchar* pcValRet)

Description : Ecrit un octet puis lit un octet sur le bus SPI.

Paramètre : cVal - type uchar - Octet à écrire sur le bus.

Paramètre de sortie : pcValRet - type uchar* - Pointeur vers l'octet reçu.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool CSPIDevice::WriteReadBuffer(char* const pcVal, char* pcValRet, const uint32_t& uLen)

Description : Ecrit un buffer d'octets puis lit un buffer d'octets de taile uLen sur le bus SPI.

Paramètre : pcVal - type char* - Buffer d'octet à écrire sur le bus.

Paramètre de sortie : pcValRet - type char* - Pointeur vers le buffer d'octets reçus.

Paramètre : uLen - type uint32_t - Nombre d'octets à lire.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.