STM32BusIORegister.hpp

/*
 * STM32BusIORegister.hpp
 *
 * A single addressable SPI "register" read, built on top of STM32SPIDevice.
 *
 * Adapted from Adafruit_BusIO's Adafruit_BusIO_Register
 * (https://github.com/adafruit/Adafruit_BusIO, MIT License, Copyright (c)
 * 2017 Adafruit Industries) as a design reference -- this is an independent
 * STM32 HAL implementation, not a direct port. Only the SPI
 * ADDRBIT8_HIGH_TOREAD addressing mode and the read path are ported: the
 * I2C path, the other three SPI addressing modes
 * (AD8_HIGH_TOREAD_AD7_HIGH_TOINC, ADDRBIT8_HIGH_TOWRITE,
 * ADDRESSED_OPCODE_BIT0_LOW_TO_WRITE), and the write path are all omitted --
 * no driver on this site needs them yet; add them here if a future
 * Adafruit-derived tutorial does. Byte order is always MSB-first: the
 * reference library's LSBFIRST branch is not ported for the same reason.
 *
 *  Created on: Sep 15, 2026
 *      Author: johng
 */
 
#ifndef STM32BUSIO_STM32BUSIOREGISTER_HPP_
#define STM32BUSIO_STM32BUSIOREGISTER_HPP_
 
#include "STM32SPIDevice.hpp"
 
class STM32BusIORegister {
public:
    STM32BusIORegister(STM32SPIDevice *spiDevice, uint32_t regAddr, size_t width = 1, size_t addressWidth = 1);
 
    uint32_t read();
 
private:
    STM32SPIDevice *_spiDevice;
    uint32_t _regAddr;
    size_t _width;
    size_t _addressWidth;
};
 
#endif /* STM32BUSIO_STM32BUSIOREGISTER_HPP_ */