port_serial.h

Go to the documentation of this file.

// Copyright 2021-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/cfgbus_core.h>
#include <satcat5/cfgbus_i2c.h>
 
namespace satcat5 {
    namespace port {
        class SerialGeneric {
        public:
            SerialGeneric(satcat5::cfg::ConfigBus* cfg, unsigned devaddr);
 
            u8 status();
 
        protected:
            struct ctrl_reg;
            satcat5::cfg::Register m_ctrl;
        };
 
        class SerialAuto : public SerialGeneric {
        public:
            using SerialGeneric::SerialGeneric;
            void config_mode(u8 mode);
            void config_spi(u8 mode, u8 gfilt=1);
            void config_uart(unsigned baud, bool ignore_cts=false);
            u8 read_mode();
 
            static constexpr u8 MODE_AUTO   = 0;
            static constexpr u8 MODE_SPI    = 1;
            static constexpr u8 MODE_UART1  = 2;
            static constexpr u8 MODE_UART2  = 3;
        };
 
        class SerialI2cController : public SerialGeneric {
        public:
            using SerialGeneric::SerialGeneric;
            void config_i2c(const satcat5::util::I2cAddr& devaddr, unsigned baud=100000);
        };
 
        class SerialI2cPeripheral : public SerialGeneric {
        public:
            using SerialGeneric::SerialGeneric;
            void config_i2c(const satcat5::util::I2cAddr& devaddr);
        };
 
        class SerialSpiController : public SerialGeneric {
        public:
            using SerialGeneric::SerialGeneric;
            void config_spi(unsigned baud, u8 mode);
        };
 
        class SerialSpiPeripheral : public SerialGeneric {
        public:
            using SerialGeneric::SerialGeneric;
            void config_spi(u8 mode, u8 gfilt=1);
        };
 
        class SerialUart : public SerialGeneric {
        public:
            using SerialGeneric::SerialGeneric;
            void config_uart(unsigned baud, bool ignore_cts=false);
        };
    }
}