BlackLib::errorSPI Struct Reference

Holds BlackSPI errors. More...

#include <BlackErr.h>

Public Member Functions

 errorSPI ()
 errorSPI struct's constructor. More...
 
 errorSPI (errorCore *base)
 errorSPI struct's constructor with errorCore pointer parameter. More...
 

Public Attributes

errorCorecoreErrors
 Pointer of errorCore struct, which stores errors of BlackCore class. More...
 
bool dtError
 Device tree loading error. More...
 
bool openError
 TTY file opening error. More...
 
bool closeError
 TTY file closing error. More...
 
bool portPathError
 TTY file path finding error. More...
 
bool transferError
 SPI data transfer error. More...
 
bool modeError
 SPI's mode property setting error. More...
 
bool speedError
 SPI's speed property setting error. More...
 
bool bitSizeError
 SPI's bit size property setting error. More...
 

Detailed Description

Holds BlackSPI errors.

This struct holds SPI errors and includes pointer of errorCore struct.

Constructor & Destructor Documentation

BlackLib::errorSPI::errorSPI ( )
inline

errorSPI struct's constructor.

This function clears all flags and initializes errorCore struct.

BlackLib::errorSPI::errorSPI ( errorCore base)
inline

errorSPI struct's constructor with errorCore pointer parameter.

Parameters
[in]*basepointer of errorCore struct.

This function clears all flags and assigns input parameter to coreErrors variable.

Member Data Documentation

bool BlackLib::errorSPI::bitSizeError

SPI's bit size property setting error.

Its value can change, when setting spi's bit size property, at

  • setBitsPerWord()
  • getBitsPerWord()
  • setProperties()
  • getProperties()

functions in BlackSPI class.

See also
BlackSPI::setBitsPerWord()
BlackSPI::getBitsPerWord()
BlackSPI::setProperties()
BlackSPI::getProperties()
bool BlackLib::errorSPI::closeError

TTY file closing error.

Its value can change, when closing spi's tty file, at

  • close()

function in BlackSPI class.

See also
BlackSPI::close()
errorCore* BlackLib::errorSPI::coreErrors

Pointer of errorCore struct, which stores errors of BlackCore class.

This struct initializes at constructor in BlackSPI class.
Its value can set with

  • getErrorsFromCore()

function in BlackSPI class.

See also
BlackSPI::BlackSPI()
BlackCore::getErrorsFromCore()
bool BlackLib::errorSPI::dtError

Device tree loading error.

Its value can change, when loading spi overlay to device tree, at

  • loadDeviceTree()

function in BlackSPI class.

See also
BlackSPI::loadDeviceTree()
bool BlackLib::errorSPI::modeError

SPI's mode property setting error.

Its value can change, when setting spi's mode property, at

  • setMode()
  • getMode()
  • setProperties()
  • getProperties()

functions in BlackSPI class.

See also
BlackSPI::setMode()
BlackSPI::getMode()
BlackSPI::setProperties()
BlackSPI::getProperties()
bool BlackLib::errorSPI::openError

TTY file opening error.

Its value can change, when opening spi's tty file, at

  • open()

function in BlackSPI class.

See also
BlackSPI::open()
bool BlackLib::errorSPI::portPathError

TTY file path finding error.

Its value can change, when finding spi's tty file path, at

  • findPortPath()

function in BlackSPI class.

See also
BlackSPI::findPortPath()
bool BlackLib::errorSPI::speedError

SPI's speed property setting error.

Its value can change, when setting spi's speed property, at

  • setMaximumSpeed()
  • getMaximumSpeed()
  • setProperties()
  • getProperties()

functions in BlackSPI class.

See also
BlackSPI::setMaximumSpeed()
BlackSPI::getMaximumSpeed()
BlackSPI::setProperties()
BlackSPI::getProperties()
bool BlackLib::errorSPI::transferError

SPI data transfer error.

Its value can change, when transfering data between master and slave, at

  • transfer()
  • operator<<()

function in BlackSPI class.

See also
BlackSPI::transfer(uint8_t, uint16_t)
BlackSPI::transfer(uint8_t*, uint8_t*, size_t, uint16_t)

The documentation for this struct was generated from the following file: