I2C.h

Go to the documentation of this file.

/* Copyright (c) 2022 Skyward Experimental Rocketry
 * Author: Emilio Corigliano
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include "I2CDriver.h"
 
namespace Boardcore
{
 
class I2C
{
public:
    I2C(I2C_TypeDef* i2c, const miosix::GpioPin& scl,
        const miosix::GpioPin& sda);
 
    I2C(const I2C&)            = delete;
    I2C& operator=(const I2C&) = delete;
    I2C(I2C&&)                 = delete;
    I2C& operator=(I2C&&)      = delete;
 
    [[nodiscard]] bool read(const I2CDriver::I2CSlaveConfig& slaveConfig,
                            void* buffer, const size_t nBytes);
 
    [[nodiscard]] bool write(const I2CDriver::I2CSlaveConfig& slaveConfig,
                             const void* buffer, const size_t nBytes);
 
    [[nodiscard]] bool readRegister(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, uint8_t& registerContent);
 
    [[nodiscard]] bool readRegister16(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, uint16_t& registerContent);
 
    [[nodiscard]] bool readRegister24(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, uint32_t& registerContent);
 
    [[nodiscard]] bool readRegister32(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, uint32_t& registerContent);
 
    [[nodiscard]] bool writeRegister(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, const uint8_t registerContent);
 
    [[nodiscard]] bool writeRegister16(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, const uint16_t registerContent);
 
    [[nodiscard]] bool writeRegister24(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, const uint32_t registerContent);
 
    [[nodiscard]] bool writeRegister32(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, const uint32_t registerContent);
 
    [[nodiscard]] bool readFromRegister(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, void* buffer, const size_t nBytes);
 
    [[nodiscard]] bool probe(const I2CDriver::I2CSlaveConfig& slaveConfig);
 
    uint16_t getLastError();
 
protected:
    I2CDriver i2c;  
};
 
class SyncedI2C : public I2C
{
public:
    SyncedI2C(I2C_TypeDef* i2c, const miosix::GpioPin& scl,
              const miosix::GpioPin& sda);
 
    SyncedI2C(const SyncedI2C&)            = delete;
    SyncedI2C& operator=(const SyncedI2C&) = delete;
    SyncedI2C(SyncedI2C&&)                 = delete;
    SyncedI2C& operator=(SyncedI2C&&)      = delete;
 
    [[nodiscard]] bool read(const I2CDriver::I2CSlaveConfig& slaveConfig,
                            void* buffer, const size_t nBytes);
 
    [[nodiscard]] bool write(const I2CDriver::I2CSlaveConfig& slaveConfig,
                             const void* buffer, const size_t nBytes);
 
    [[nodiscard]] bool readRegister(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, uint8_t& registerContent);
 
    [[nodiscard]] bool readRegister16(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, uint16_t& registerContent);
 
    [[nodiscard]] bool readRegister24(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, uint32_t& registerContent);
 
    [[nodiscard]] bool readRegister32(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, uint32_t& registerContent);
 
    [[nodiscard]] bool writeRegister(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, const uint8_t registerContent);
 
    [[nodiscard]] bool writeRegister16(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, const uint16_t registerContent);
 
    [[nodiscard]] bool writeRegister24(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, const uint32_t registerContent);
 
    [[nodiscard]] bool writeRegister32(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, const uint32_t registerContent);
 
    [[nodiscard]] bool readFromRegister(
        const I2CDriver::I2CSlaveConfig& slaveConfig,
        const uint8_t registerAddress, void* buffer, const size_t nBytes);
 
    [[nodiscard]] bool probe(const I2CDriver::I2CSlaveConfig& slaveConfig);
 
    uint16_t getLastError();
 
private:
    miosix::FastMutex mutex;  
};
 
}  // namespace Boardcore