summaryrefslogtreecommitdiff
path: root/.pio/libdeps/esp32-s3-n16r8/Adafruit BusIO/Adafruit_GenericDevice.h
blob: d5cb3268ac806e8895e125868e33849672dfd079 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#ifndef ADAFRUIT_GENERICDEVICE_H
#define ADAFRUIT_GENERICDEVICE_H

#include <Arduino.h>

typedef bool (*busio_genericdevice_read_t)(void *obj, uint8_t *buffer,
                                           size_t len);
typedef bool (*busio_genericdevice_write_t)(void *obj, const uint8_t *buffer,
                                            size_t len);
typedef bool (*busio_genericdevice_readreg_t)(void *obj, uint8_t *addr_buf,
                                              uint8_t addrsiz, uint8_t *data,
                                              uint16_t datalen);
typedef bool (*busio_genericdevice_writereg_t)(void *obj, uint8_t *addr_buf,
                                               uint8_t addrsiz,
                                               const uint8_t *data,
                                               uint16_t datalen);

/*!
 * @brief Class for communicating with a device via generic read/write functions
 */
class Adafruit_GenericDevice {
public:
  Adafruit_GenericDevice(
      void *obj, busio_genericdevice_read_t read_func,
      busio_genericdevice_write_t write_func,
      busio_genericdevice_readreg_t readreg_func = nullptr,
      busio_genericdevice_writereg_t writereg_func = nullptr);

  bool begin(void);
  void end(void);

  bool read(uint8_t *buffer, size_t len);
  bool write(const uint8_t *buffer, size_t len);
  bool readRegister(uint8_t *addr_buf, uint8_t addrsiz, uint8_t *buf,
                    uint16_t bufsiz);
  bool writeRegister(uint8_t *addr_buf, uint8_t addrsiz, const uint8_t *buf,
                     uint16_t bufsiz);

protected:
  /*! @brief Function pointer for reading raw data from the device */
  busio_genericdevice_read_t _read_func;
  /*! @brief Function pointer for writing raw data to the device */
  busio_genericdevice_write_t _write_func;
  /*! @brief Function pointer for reading a 'register' from the device */
  busio_genericdevice_readreg_t _readreg_func;
  /*! @brief Function pointer for writing a 'register' to the device */
  busio_genericdevice_writereg_t _writereg_func;

  bool _begun; ///< whether we have initialized yet (in case the function needs
               ///< to do something)

private:
  void *_obj; ///< Pointer to object instance
};

#endif // ADAFRUIT_GENERICDEVICE_H