106 lines
3.3 KiB
C
106 lines
3.3 KiB
C
|
#ifndef Adafruit_BusIO_Register_h
|
||
|
|
#define Adafruit_BusIO_Register_h
|
||
|
|
|
||
|
|
#include <Arduino.h>
|
||
|
|
|
||
|
|
#if !defined(SPI_INTERFACES_COUNT) || \
|
||
|
|
(defined(SPI_INTERFACES_COUNT) && (SPI_INTERFACES_COUNT > 0))
|
||
|
|
|
||
|
|
#include <Adafruit_I2CDevice.h>
|
||
|
|
#include <Adafruit_SPIDevice.h>
|
||
|
|
|
||
|
|
typedef enum _Adafruit_BusIO_SPIRegType {
|
||
|
|
ADDRBIT8_HIGH_TOREAD = 0,
|
||
|
|
/*!<
|
||
|
|
* ADDRBIT8_HIGH_TOREAD
|
||
|
|
* When reading a register you must actually send the value 0x80 + register
|
||
|
|
* address to the device. e.g. To read the register 0x0B the register value
|
||
|
|
* 0x8B is sent and to write 0x0B is sent.
|
||
|
|
*/
|
||
|
|
AD8_HIGH_TOREAD_AD7_HIGH_TOINC = 1,
|
||
|
|
|
||
|
|
/*!<
|
||
|
|
* ADDRBIT8_HIGH_TOWRITE
|
||
|
|
* When writing to a register you must actually send the value 0x80 +
|
||
|
|
* the register address to the device. e.g. To write to the register 0x19 the
|
||
|
|
* register value 0x99 is sent and to read 0x19 is sent.
|
||
|
|
*/
|
||
|
|
ADDRBIT8_HIGH_TOWRITE = 2,
|
||
|
|
|
||
|
|
/*!<
|
||
|
|
* ADDRESSED_OPCODE_LOWBIT_TO_WRITE
|
||
|
|
* Used by the MCP23S series, we send 0x40 |'rd with the opcode
|
||
|
|
* Then set the lowest bit to write
|
||
|
|
*/
|
||
|
|
ADDRESSED_OPCODE_BIT0_LOW_TO_WRITE = 3,
|
||
|
|
|
||
|
|
} Adafruit_BusIO_SPIRegType;
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief The class which defines a device register (a location to read/write
|
||
|
|
* data from)
|
||
|
|
*/
|
||
|
|
class Adafruit_BusIO_Register {
|
||
|
|
public:
|
||
|
|
Adafruit_BusIO_Register(Adafruit_I2CDevice *i2cdevice, uint16_t reg_addr,
|
||
|
|
uint8_t width = 1, uint8_t byteorder = LSBFIRST,
|
||
|
|
uint8_t address_width = 1);
|
||
|
|
|
||
|
|
Adafruit_BusIO_Register(Adafruit_SPIDevice *spidevice, uint16_t reg_addr,
|
||
|
|
Adafruit_BusIO_SPIRegType type, uint8_t width = 1,
|
||
|
|
uint8_t byteorder = LSBFIRST,
|
||
|
|
uint8_t address_width = 1);
|
||
|
|
|
||
|
|
Adafruit_BusIO_Register(Adafruit_I2CDevice *i2cdevice,
|
||
|
|
Adafruit_SPIDevice *spidevice,
|
||
|
|
Adafruit_BusIO_SPIRegType type, uint16_t reg_addr,
|
||
|
|
uint8_t width = 1, uint8_t byteorder = LSBFIRST,
|
||
|
|
uint8_t address_width = 1);
|
||
|
|
|
||
|
|
bool read(uint8_t *buffer, uint8_t len);
|
||
|
|
bool read(uint8_t *value);
|
||
|
|
bool read(uint16_t *value);
|
||
|
|
uint32_t read(void);
|
||
|
|
uint32_t readCached(void);
|
||
|
|
bool write(uint8_t *buffer, uint8_t len);
|
||
|
|
bool write(uint32_t value, uint8_t numbytes = 0);
|
||
|
|
|
||
|
|
uint8_t width(void);
|
||
|
|
|
||
|
|
void setWidth(uint8_t width);
|
||
|
|
void setAddress(uint16_t address);
|
||
|
|
void setAddressWidth(uint16_t address_width);
|
||
|
|
|
||
|
|
void print(Stream *s = &Serial);
|
||
|
|
void println(Stream *s = &Serial);
|
||
|
|
|
||
|
|
private:
|
||
|
|
Adafruit_I2CDevice *_i2cdevice;
|
||
|
|
Adafruit_SPIDevice *_spidevice;
|
||
|
|
Adafruit_BusIO_SPIRegType _spiregtype;
|
||
|
|
uint16_t _address;
|
||
|
|
uint8_t _width, _addrwidth, _byteorder;
|
||
|
|
uint8_t _buffer[4]; // we won't support anything larger than uint32 for
|
||
|
|
// non-buffered read
|
||
|
|
uint32_t _cached = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
/*!
|
||
|
|
* @brief The class which defines a slice of bits from within a device register
|
||
|
|
* (a location to read/write data from)
|
||
|
|
*/
|
||
|
|
class Adafruit_BusIO_RegisterBits {
|
||
|
|
public:
|
||
|
|
Adafruit_BusIO_RegisterBits(Adafruit_BusIO_Register *reg, uint8_t bits,
|
||
|
|
uint8_t shift);
|
||
|
|
bool write(uint32_t value);
|
||
|
|
uint32_t read(void);
|
||
|
|
|
||
|
|
private:
|
||
|
|
Adafruit_BusIO_Register *_register;
|
||
|
|
uint8_t _bits, _shift;
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif // SPI exists
|
||
|
|
#endif // BusIO_Register_h
|