VortexBoardBind.h

Go to the documentation of this file.

 
#ifndef VORTEX_BOARD_BIND_H_
#define VORTEX_BOARD_BIND_H_
 
#include <cstddef>
#include <cstdint>
 
#include "base/BaseCan.h"
#include "base/BaseGpio.h"
#include "base/BaseI2c.h"
#include "base/BaseNvs.h"
#include "base/BaseSpi.h"
#include "base/BaseTemperature.h"
#include "base/BaseUart.h"
#include "core/hf-core-drivers/internal/hf-pincfg/src/hf_functional_pin_config_vortex_v1.hpp"
 
namespace vortex::bsp {
 
//==============================================================================
// Bus specifications (MCU-neutral; the binding maps them to its own driver config)
//==============================================================================
 
struct UartSpec {
    uint8_t port{1};
    uint32_t baud{115200};
    int tx_pin{-1};
    int rx_pin{-1};
    uint16_t tx_buffer_bytes{256};
    uint16_t rx_buffer_bytes{512};
    uint32_t timeout_ms{100};
};
 
struct SpiBusSpec {
    uint8_t host{1};  
    int miso_pin{-1};
    int mosi_pin{-1};
    int sclk_pin{-1};
    uint32_t timeout_ms{1000};
};
 
struct SpiDeviceSpec {
    int cs_pin{-1};
    uint32_t clock_hz{10'000'000};
    uint8_t mode{0};  
};
 
struct I2cBusSpec {
    uint8_t port{0};
    int sda_pin{-1};
    int scl_pin{-1};
    bool internal_pullups{false};
};
 
struct I2cDeviceSpec {
    uint16_t address{0};
    uint32_t scl_hz{100'000};
    uint32_t scl_wait_us{0};  
};
 
struct CanSpec {
    int tx_pin{-1};
    int rx_pin{-1};
    uint32_t bitrate{500'000};
};
 
//==============================================================================
// UART
//==============================================================================
 
BaseUart* UartOpen(const UartSpec& spec) noexcept;
void UartClose() noexcept;
 
//==============================================================================
// SPI
//==============================================================================
 
bool SpiOpen(const SpiBusSpec& spec) noexcept;
int SpiAddDevice(const SpiDeviceSpec& spec) noexcept;
BaseSpi* SpiDevice(int index) noexcept;
void SpiClose() noexcept;
 
//==============================================================================
// I2C
//==============================================================================
 
bool I2cOpen(const I2cBusSpec& spec) noexcept;
int I2cAddDevice(const I2cDeviceSpec& spec) noexcept;
BaseI2c* I2cDevice(int index) noexcept;
bool I2cRemoveDevice(int index) noexcept;
bool I2cProbe(uint8_t address, uint32_t timeout_ms) noexcept;
size_t I2cScan(uint8_t* out, size_t max, uint8_t first, uint8_t last, uint32_t timeout_ms) noexcept;
bool I2cReset() noexcept;
void I2cClose() noexcept;
 
//==============================================================================
// CAN
//==============================================================================
 
BaseCan* CanOpen(const CanSpec& spec) noexcept;
void CanClose() noexcept;
 
//==============================================================================
// MCU GPIO (pins of the pin map whose chip is the host MCU)
//==============================================================================
 
BaseGpio* McuGpioOpen(HfFunctionalGpioPin pin, hf_gpio_direction_t direction, hf_gpio_active_state_t active,
                      hf_gpio_output_mode_t output_mode, hf_gpio_pull_mode_t pull) noexcept;
void McuGpioCloseAll() noexcept;
 
//==============================================================================
// NVS (three fixed namespaces)
//==============================================================================
 
enum class NvsRegion : uint8_t {
    App = 0,      
    Calibration,  
    Config,       
    Count
};
 
[[nodiscard]] constexpr const char* NvsNamespace(NvsRegion region) noexcept {
    switch (region) {
        case NvsRegion::App:         return "vortex";
        case NvsRegion::Calibration: return "vortex_cal";
        case NvsRegion::Config:      return "vortex_cfg";
        default:                     return "";
    }
}
 
BaseNvs& Nvs(NvsRegion region) noexcept;
 
//==============================================================================
// MCU die temperature
//==============================================================================
 
BaseTemperature* McuTemperature() noexcept;
 
//==============================================================================
// Time
//==============================================================================
 
uint64_t MonotonicMicros() noexcept;
 
//==============================================================================
// Status LED (one WS2812 on Vortex V1)
//==============================================================================
 
bool StatusLedOpen(int data_pin, uint32_t led_count) noexcept;
bool StatusLedShow(const uint32_t* rgb, uint32_t count, uint8_t brightness) noexcept;
void StatusLedClose() noexcept;
 
}  // namespace vortex::bsp
 
#endif  // VORTEX_BOARD_BIND_H_