Add Serial and UART interface files.

Author: SFE-Brudnerd

src/sfTk/sfTkISerial.h

@@ -0,0 +1,115 @@
+/**
+ * @file sfTkISerial.h
+ * @brief Header file for the SparkFun Toolkit Base Serial Interface Definition.
+ * 
+ * This file contains the interface declaration for basic serial read/write.
+ * 
+ * @author SparkFun Electronics
+ * @date 2025
+ * @copyright Copyright (c) 2025, SparkFun Electronics Inc. This project is released under the MIT License.
+ *
+ * SPDX-License-Identifier: MIT 
+ */
+
+#pragma once
+#include "sfTkError.h"
+#include <cstdint>
+
+/**
+ * @brief A base value for serial errors. All serial errors are greater than this value, in the 2000 range
+ * 
+ */
+const sfTkError_t ksfTkErrBaseSerial = 0x2000;
+
+/**
+ * @brief Error code for when a serial system is not initalized.
+ */
+const sfTkError_t ksfTkErrSerialNotInit = ksfTkErrFail * (ksfTkErrBaseSerial + 1);
+
+/**
+ * @brief Returned when a serial interface times out.
+ * 
+ */
+const sfTkError_t ksfTkErrSerialTimeout = ksfTkErrFail * (ksfTkErrBaseSerial + 2);
+
+/**
+ * @brief Returned when a serial interface does not respond.
+ * 
+ */
+const sfTkError_t ksfTkErrSerialNoResponse = ksfTkErrFail * (ksfTkErrBaseSerial + 3);
+
+/**
+ * @brief Returned when the data to be sent is too long or received is too short.
+ * 
+ */
+const sfTkError_t ksfTkErrSerialDataTooLong = ksfTkErrFail * (ksfTkErrBaseSerial + 4);
+
+/**
+ * @brief Returned when the serial settings are null, invalid, or on set/initialized.
+ * 
+ */
+const sfTkError_t ksfTkErrSerialNullSettings = ksfTkErrFail * (ksfTkErrBaseSerial + 5);
+
+/**
+ * @brief Returned when the buffer is null or invalid.
+ * 
+ */
+const sfTkError_t ksfTkErrSerialNullBuffer = ksfTkErrFail * (ksfTkErrBaseSerial + 6);
+
+/**
+ * @brief Returned when the bus is under read. Warning.
+ * 
+ */
+const sfTkError_t ksfTkErrSerialUnderRead = ksfTkErrBaseSerial + 7;
+
+
+class sfTkISerial
+{
+  public:
+    sfTkISerial() = default;
+    virtual ~sfTkISerial() = default;
+
+    /**
+     * @brief Writes an array of bytes to the serial interface.
+     * 
+     * @param data The data to write
+     * @param length The length of the data buffer
+     * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
+     */
+    virtual sfTkError_t write(const uint8_t *data, size_t length) = 0;
+
+    /**
+     * @brief Writes a single byte to the serial interface.
+     * 
+     * @param data The data to write
+     * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
+     */
+    virtual sfTkError_t write(const uint8_t data)
+    {
+        return write(&data, 1);
+    }
+
+    /**
+     * @brief Reads an array of bytes from the serial interface
+     * 
+     * @param data The data buffer to read into
+     * @param length The length of the data buffer
+     * @param readBytes[out] The number of bytes read
+     * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
+     */
+    virtual sfTkError_t read(uint8_t *data, size_t length, size_t &readBytes) = 0;
+    
+    /**
+     * @brief Read a single byte from the serial interface
+     * 
+     * @param data Byte to be read
+     * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
+     */
+    virtual sfTkError_t read(uint8_t &data)
+    {
+        size_t nRead;
+        
+        return read(&data, sizeof(data), nRead);
+    }
+
+};

src/sfTk/sfTkISerialBus.h

@@ -0,0 +1,114 @@
+/**
+ * @file sfTkISerialBus.h
+ * @brief Header file for the SparkFun Toolkit Base Serial Bus Interface Definition.
+ * 
+ * This file contains the interface declaration for connecting sfTkISerial to the sfTkIBus.
+ * 
+ * @author SparkFun Electronics
+ * @date 2025
+ * @copyright Copyright (c) 2025, SparkFun Electronics Inc. This project is released under the MIT License.
+ *
+ * SPDX-License-Identifier: MIT 
+ */
+
+#pragma once
+#include "sfTkError.h"
+#include "sfTkIBus.h"
+#include "sfTkISerial.h"
+#include <cstdint>
+
+const uint8_t ksfTkBusTypeSerialBus = 0x03;
+
+class sfTkISerialBus : sfTkIBus
+{
+  public:
+    /**
+     * @brief Constructor for the serial bus
+     * 
+     */
+    sfTkISerialBus()
+    {
+    }
+    
+    virtual ~sfTkISerialBus() = default;
+
+    /**
+     * @brief Writes an array of bytes to the serial interface.
+     * 
+     * @param data The data to write
+     * @param length The length of the data buffer
+     * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
+     */
+    virtual sfTkError_t write(const uint8_t *data, size_t length) = 0;
+    
+    /**
+     * @brief Writes an array of bytes to a register on the target address. Supports any address size
+     * 
+     * @param devReg The device's register's address - can be any size, If nullptr, address is not sent
+     * @param regLength The length of the register address. If 0, address is not sent
+     * @param data The data to write
+     * @param length The length of the data buffer
+     * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
+     */
+    virtual sfTkError_t writeRegister(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length) override
+    {
+
+        // Do we have a register? If so write it, else skip.
+        if (devReg != nullptr && regLength > 0)
+            write(devReg, regLength);
+
+        // Write the data.
+        return write(data, length);
+    }
+
+    /**
+     * @brief Read an array of bytes from the serial interface
+     * 
+     * @param data The data buffer to read into
+     * @param length The length of the data buffer
+     * @param readBytes[out] The number of bytes read
+     * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
+     */
+    virtual sfTkError_t read(uint8_t *data, size_t length, size_t &readBytes) = 0;
+
+    /**
+     * @brief Reads an array of bytes to a register on the target address. Supports any address size
+     * 
+     * @param devReg The device's register's address - can be any size
+     * @param regLength The length of the register address
+     * @param data The data to buffer to read into
+     * @param numBytes The length of the data buffer
+     * @param readBytes[out] The number of bytes read
+     * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
+     */
+    virtual sfTkError_t readRegister(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes) override
+    {
+        // Buffer valid?
+        if (!data)
+            return ksfTkErrBusNullBuffer;
+
+        sfTkError_t retVal = ksfTkErrOk;
+
+        // Do we have a register? If so, write it, else skip.
+        if (devReg != nullptr && regLength > 0)
+            retVal = write(devReg, regLength);
+
+        if(retVal != ksfTkErrOk)
+            return retVal;
+
+        // Read the data.
+        retVal = read(data, numBytes, readBytes);
+
+        return retVal;
+    }
+
+    /**
+     * @brief Get the type of the object
+     * 
+     * @return uint8_t The type of the object
+     */
+    virtual uint8_t type(void) override
+    {
+        return ksfTkBusTypeSerialBus;
+    }
+};