FluxPlatformBind.h

Go to the documentation of this file.

 
#ifndef FLUX_BSP_PLATFORM_BIND_H_
#define FLUX_BSP_PLATFORM_BIND_H_
 
#include <cstddef>
#include <cstdint>
 
#include "core/hf-core-drivers/internal/hf-internal-interface-wrap/inc/base/BaseAdc.h"
#include "core/hf-core-drivers/internal/hf-internal-interface-wrap/inc/base/BaseCan.h"
#include "core/hf-core-drivers/internal/hf-internal-interface-wrap/inc/base/BaseGpio.h"
#include "core/hf-core-drivers/internal/hf-internal-interface-wrap/inc/base/BaseNvs.h"
#include "core/hf-core-drivers/internal/hf-internal-interface-wrap/inc/base/BaseSpi.h"
#include "core/hf-core-drivers/internal/hf-internal-interface-wrap/inc/base/BaseTemperature.h"
#include "core/hf-core-drivers/internal/hf-internal-interface-wrap/inc/base/BaseUart.h"
#include "core/hf-core-drivers/internal/hf-internal-interface-wrap/inc/base/BaseUsbSerialJtag.h"
 
namespace flux::bsp {
 
//==============================================================================
// CAPACITIES — every binding sizes its static storage from these
//==============================================================================
 
inline constexpr size_t kMaxGpioSlots          = 64;  
inline constexpr size_t kMaxSpiBuses           = 2;   
inline constexpr size_t kMaxSpiDevicesPerBus   = 4;   
inline constexpr size_t kMaxUartPorts          = 3;   
inline constexpr size_t kMaxNvsRegions         = 3;   
inline constexpr uint8_t kMaxInternalAdcChannels = 16; 
 
//==============================================================================
// GPIO
//==============================================================================
 
struct GpioSpec {
    hf_pin_num_t           pin;           
    hf_gpio_direction_t    direction;     
    hf_gpio_active_state_t active_state;  
    hf_gpio_output_mode_t  output_mode;   
    hf_gpio_pull_mode_t    pull_mode;     
};
 
BaseGpio* CreateGpio(size_t slot, const GpioSpec& spec) noexcept;
 
void DestroyGpio(size_t slot) noexcept;
 
//==============================================================================
// MCU ADC AND DIE TEMPERATURE
//==============================================================================
 
uint8_t InternalAdcChannelCount() noexcept;
 
BaseAdc* CreateInternalAdc(uint8_t unit, uint32_t channel_mask) noexcept;
 
void DestroyInternalAdc() noexcept;
 
BaseTemperature* CreateDieTemperature() noexcept;
 
void DestroyDieTemperature() noexcept;
 
//==============================================================================
// NVS
//==============================================================================
 
BaseNvs& NvsRegion(size_t slot, const char* name_space) noexcept;
 
//==============================================================================
// SPI
//==============================================================================
 
struct SpiBusSpec {
    uint8_t      controller;  
    hf_pin_num_t miso;        
    hf_pin_num_t mosi;        
    hf_pin_num_t sclk;        
    bool         use_iomux;   
    uint32_t     timeout_ms;  
};
 
struct SpiDeviceSpec {
    hf_pin_num_t cs;          
    uint32_t     clock_hz;    
    uint8_t      mode;        
};
 
bool CreateSpiBus(size_t bus, const SpiBusSpec& spec) noexcept;
 
BaseSpi* CreateSpiDevice(size_t bus, const SpiDeviceSpec& spec) noexcept;
 
void DestroySpiBus(size_t bus) noexcept;
 
//==============================================================================
// CAN
//==============================================================================
 
struct CanSpec {
    hf_pin_num_t tx;          
    hf_pin_num_t rx;          
    uint32_t     bitrate;     
};
 
BaseCan* CreateCan(const CanSpec& spec) noexcept;
 
void DestroyCan() noexcept;
 
//==============================================================================
// UART AND USB SERIAL/JTAG
//==============================================================================
 
struct UartSpec {
    uint8_t      port;            
    hf_pin_num_t tx;              
    hf_pin_num_t rx;              
    hf_pin_num_t rts;             
    hf_pin_num_t cts;             
    uint32_t     baud;            
    uint16_t     tx_buffer_size;  
    uint16_t     rx_buffer_size;  
};
 
BaseUart* CreateUart(const UartSpec& spec, bool* rs485) noexcept;
 
void DestroyUart(uint8_t port) noexcept;
 
BaseUsbSerialJtag* AcquireUsbSerialJtag(const hf_usb_serial_jtag_config_t& cfg) noexcept;
 
//==============================================================================
// STATUS LED STRIP
//==============================================================================
 
struct LedStripSpec {
    hf_pin_num_t pin;         
    uint8_t      channel;     
    uint16_t     count;       
};
 
bool LedStripBegin(const LedStripSpec& spec) noexcept;
 
void LedStripSetPixel(uint16_t index, uint32_t rgb) noexcept;
 
void LedStripSetBrightness(uint8_t brightness) noexcept;
 
bool LedStripShow() noexcept;
 
void LedStripEnd() noexcept;
 
//==============================================================================
// SYSTEM
//==============================================================================
 
uint32_t LastResetReason() noexcept;
 
[[noreturn]] void SystemRestart() noexcept;
 
uint32_t FreeHeapBytes() noexcept;
 
uint32_t LargestFreeHeapBlock() noexcept;
 
}  // namespace flux::bsp
 
#endif  // FLUX_BSP_PLATFORM_BIND_H_