IoProvider.hpp

/*
 * Copyright 2021 Marcus Behel
 *
 * This file is part of ArPiRobot-CoreLib.
 * 
 * ArPiRobot-CoreLib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * ArPiRobot-CoreLib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with ArPiRobot-CoreLib.  If not, see <https://www.gnu.org/licenses/>. 
 */
 
 
#pragma once
 
 
#include <string>
#include <vector>
#include <mutex>
 
namespace arpirobot {
    
    class IoProvider{
    public:
        IoProvider(const IoProvider &other) = delete;
        IoProvider &operator=(const IoProvider &other) = delete;
        virtual ~IoProvider() = default;
 
        const static unsigned int GPIO_OUT = 0;
        const static unsigned int GPIO_IN = 1;
        const static unsigned int GPIO_LOW = 0;
        const static unsigned int GPIO_HIGH = 1;
 
    protected:
 
        // Protected default constructor ensures direct instantiation is not possible
        IoProvider() = default;
 
        virtual void gpioMode(unsigned int pin, unsigned int mode) = 0;
 
        virtual void gpioWrite(unsigned int pin, unsigned int state) = 0;
 
        virtual unsigned int gpioRead(unsigned int pin) = 0;
 
        virtual void gpioSetPwmFrequency(unsigned int pin, unsigned int frequency) = 0;
 
        virtual unsigned int gpioGetPwmFrequency(unsigned int pin) = 0;
 
        virtual void gpioPwm(unsigned int pin, unsigned int value) = 0;
 
 
        virtual unsigned int i2cOpen(unsigned int bus, unsigned int address) = 0;
 
        virtual void i2cClose(unsigned int handle) = 0;
 
        virtual void i2cWriteByte(unsigned int handle, uint8_t data) = 0;
 
        virtual uint8_t i2cReadByte(unsigned int handle) = 0;
 
        virtual void i2cWriteBytes(unsigned int handle, char *buf, unsigned int count) = 0;
 
        virtual unsigned int i2cReadBytes(unsigned int handle, char *buf, unsigned int count) = 0;
 
        virtual void i2cWriteReg8(unsigned int handle, uint8_t reg, uint8_t value) = 0;
 
        virtual uint8_t i2cReadReg8(unsigned int handle, uint8_t reg) = 0;
 
        virtual void i2cWriteReg16(unsigned int handle, uint8_t reg, uint16_t value) = 0;
 
        virtual uint16_t i2cReadReg16(unsigned int handle, uint8_t reg) = 0;
 
 
        
        // Bus = spi bus 
        // Channel = which builtin CS pin
        // Mode = SPI Mode (0, 1, 2, 3) 
        virtual unsigned int spiOpen(unsigned int bus, unsigned int channel, unsigned int baud, unsigned int mode) = 0;
 
        virtual void spiClose(unsigned int handle) = 0;
 
        virtual void spiWrite(unsigned int handle, char *buf, unsigned int count) = 0;
 
        virtual unsigned int spiRead(unsigned int handle, char *buf, unsigned int count) = 0;
 
 
        
        virtual unsigned int uartOpen(char *port, unsigned int baud) = 0;
    
        virtual void uartClose(unsigned int handle) = 0;
 
        virtual unsigned int uartAvailable(unsigned int handle) = 0;
 
        virtual void uartWrite(unsigned int handle, char* buf, unsigned int count) = 0;
 
        virtual unsigned int uartRead(unsigned int handle, char *buf, unsigned int count) = 0;
 
        virtual void uartWriteByte(unsigned int handle, uint8_t b) = 0;
 
        virtual uint8_t uartReadByte(unsigned int handle) = 0;
 
        friend class Io;
    };
 
}