EspTypes_UART.h

Go to the documentation of this file.

 
#pragma once
 
#include "BaseUart.h" // For hf_uart_err_t
#include "EspTypes_Base.h"
#include "HardwareTypes.h" // For basic hardware types
#include "McuSelect.h"     // Central MCU platform selection (includes all ESP-IDF)
 
//==============================================================================
// ESP32 UART TYPE MAPPINGS
//==============================================================================
 
// Direct ESP-IDF type usage - no unnecessary aliases
// These types are used internally by EspUart implementation
 
//==============================================================================
// ESP32 UART CONSTANTS
//==============================================================================
 
static constexpr hf_pin_num_t HF_UART_IO_UNUSED = 0xFFFFFFFF;
static constexpr uint32_t HF_UART_BREAK_MIN_DURATION = 1;    
static constexpr uint32_t HF_UART_BREAK_MAX_DURATION = 1000; 
 
// ESP32 UART port limits
#ifdef HF_MCU_ESP32C6
static constexpr uint8_t HF_ESP32_UART_MAX_PORTS = 3; // ESP32-C6 has 3 UART ports
#elif defined(HF_MCU_ESP32) || defined(HF_MCU_ESP32S2) || defined(HF_MCU_ESP32S3)
static constexpr uint8_t HF_ESP32_UART_MAX_PORTS = 3; // ESP32 Classic/S2/S3 have 3 UART ports
#elif defined(HF_MCU_ESP32C3) || defined(HF_MCU_ESP32C2) || defined(HF_MCU_ESP32H2)
static constexpr uint8_t HF_ESP32_UART_MAX_PORTS = 2; // ESP32-C3/C2/H2 have 2 UART ports
#else
static constexpr uint8_t HF_ESP32_UART_MAX_PORTS = 3; // Default fallback
#endif
 
//==============================================================================
// ESP32 UART ENUMS
//==============================================================================
 
enum class hf_uart_mode_t : uint8_t {
  HF_UART_MODE_UART = 0,  
  HF_UART_MODE_RS485 = 1, 
  HF_UART_MODE_IRDA = 2   
};
 
enum class hf_uart_data_bits_t : uint8_t {
  HF_UART_DATA_5_BITS = 0, 
  HF_UART_DATA_6_BITS = 1, 
  HF_UART_DATA_7_BITS = 2, 
  HF_UART_DATA_8_BITS = 3  
};
 
enum class hf_uart_parity_t : uint8_t {
  HF_UART_PARITY_DISABLE = 0, 
  HF_UART_PARITY_EVEN = 1,    
  HF_UART_PARITY_ODD = 2      
};
 
enum class hf_uart_stop_bits_t : uint8_t {
  HF_UART_STOP_BITS_1 = 1,   
  HF_UART_STOP_BITS_1_5 = 2, 
  HF_UART_STOP_BITS_2 = 3    
};
 
enum class hf_uart_flow_ctrl_t : uint8_t {
  HF_UART_HW_FLOWCTRL_DISABLE = 0, 
  HF_UART_HW_FLOWCTRL_RTS = 1,     
  HF_UART_HW_FLOWCTRL_CTS = 2,     
  HF_UART_HW_FLOWCTRL_CTS_RTS = 3  
};
 
enum class hf_uart_operating_mode_t : uint8_t {
  HF_UART_MODE_POLLING = 0,   
  HF_UART_MODE_INTERRUPT = 1, 
  HF_UART_MODE_DMA = 2        
};
 
//==============================================================================
// ESP32 UART CONFIGURATION STRUCTURES
//==============================================================================
 
struct hf_uart_config_t {
  hf_port_num_t port_number;               
  hf_baud_rate_t baud_rate;                
  hf_uart_data_bits_t data_bits;           
  hf_uart_parity_t parity;                 
  hf_uart_stop_bits_t stop_bits;           
  hf_uart_flow_ctrl_t flow_control;        
  hf_pin_num_t tx_pin;                     
  hf_pin_num_t rx_pin;                     
  hf_pin_num_t rts_pin;                    
  hf_pin_num_t cts_pin;                    
  uint16_t tx_buffer_size;                 
  uint16_t rx_buffer_size;                 
  uint8_t event_queue_size;                
  hf_uart_operating_mode_t operating_mode; 
  hf_timeout_ms_t timeout_ms;              
  bool enable_pattern_detection;           
  bool enable_wakeup;                      
  bool enable_loopback;                    
 
  hf_uart_config_t() noexcept
      : port_number(0), baud_rate(115200), data_bits(hf_uart_data_bits_t::HF_UART_DATA_8_BITS),
        parity(hf_uart_parity_t::HF_UART_PARITY_DISABLE),
        stop_bits(hf_uart_stop_bits_t::HF_UART_STOP_BITS_1),
        flow_control(hf_uart_flow_ctrl_t::HF_UART_HW_FLOWCTRL_DISABLE), tx_pin(HF_UART_IO_UNUSED),
        rx_pin(HF_UART_IO_UNUSED), rts_pin(HF_UART_IO_UNUSED), cts_pin(HF_UART_IO_UNUSED),
        tx_buffer_size(1024), rx_buffer_size(1024), event_queue_size(10),
        operating_mode(hf_uart_operating_mode_t::HF_UART_MODE_POLLING), timeout_ms(1000),
        enable_pattern_detection(false), enable_wakeup(false), enable_loopback(false) {}
};
 
struct hf_uart_flow_config_t {
  bool enable_hw_flow_control;  
  bool enable_sw_flow_control;  
  uint8_t xon_char;             
  uint8_t xoff_char;            
  uint16_t rx_flow_ctrl_thresh; 
  uint16_t tx_flow_ctrl_thresh; 
  bool auto_rts;                
  bool auto_cts;                
 
  hf_uart_flow_config_t() noexcept
      : enable_hw_flow_control(false), enable_sw_flow_control(false), xon_char(0x11),
        xoff_char(0x13), rx_flow_ctrl_thresh(122), tx_flow_ctrl_thresh(80), auto_rts(false),
        auto_cts(false) {}
};
 
struct hf_uart_power_config_t {
  bool sleep_retention_enable;  
  bool allow_pd_in_light_sleep; 
  bool allow_pd_in_deep_sleep;  
  bool wakeup_enable;           
  uint8_t wakeup_threshold;     
  uint32_t wakeup_timeout_ms;   
 
  hf_uart_power_config_t() noexcept
      : sleep_retention_enable(true), allow_pd_in_light_sleep(true), allow_pd_in_deep_sleep(false),
        wakeup_enable(false), wakeup_threshold(3), wakeup_timeout_ms(1000) {}
};
 
struct hf_uart_pattern_config_t {
  bool enable_pattern_detection; 
  char pattern_char;             
  uint8_t pattern_char_num;      
  uint16_t char_timeout;         
  uint16_t post_idle;            
  uint16_t pre_idle;             
 
  hf_uart_pattern_config_t() noexcept
      : enable_pattern_detection(false), pattern_char('+'), pattern_char_num(1), char_timeout(5),
        post_idle(5), pre_idle(5) {}
};
 
struct hf_uart_rs485_config_t {
  hf_uart_mode_t mode;           
  bool enable_collision_detect;  
  bool enable_echo_suppression;  
  bool auto_rts_control;         
  uint32_t rts_delay_ms;         
  uint32_t rts_timeout_ms;       
  uint32_t collision_timeout_ms; 
 
  hf_uart_rs485_config_t() noexcept
      : mode(hf_uart_mode_t::HF_UART_MODE_UART), enable_collision_detect(false),
        enable_echo_suppression(false), auto_rts_control(false), rts_delay_ms(0), rts_timeout_ms(0),
        collision_timeout_ms(0) {}
};
 
struct hf_uart_irda_config_t {
  bool enable_irda;   
  bool invert_tx;     
  bool invert_rx;     
  uint8_t duty_cycle; 
 
  hf_uart_irda_config_t() noexcept
      : enable_irda(false), invert_tx(false), invert_rx(false), duty_cycle(50) {}
};
 
struct hf_uart_wakeup_config_t {
  bool enable_wakeup;       
  uint8_t wakeup_threshold; 
  bool use_ref_tick;        
 
  hf_uart_wakeup_config_t() noexcept
      : enable_wakeup(false), wakeup_threshold(3), use_ref_tick(false) {}
};
 
//==============================================================================
// ESP32 UART CALLBACK TYPES
//==============================================================================
 
enum class hf_uart_event_type_t : uint8_t {
  HF_UART_DATA = 0,        
  HF_UART_FIFO_OVF = 1,    
  HF_UART_BUFFER_FULL = 2, 
  HF_UART_BREAK = 3,       
  HF_UART_PARITY_ERR = 4,  
  HF_UART_FRAME_ERR = 5,   
  HF_UART_PATTERN_DET = 6, 
  HF_UART_EVENT_MAX = 7    
};
 
struct hf_uart_event_t {
  hf_uart_event_type_t type; 
  size_t size;               
  uint8_t timeout_flag;      
};
 
using hf_uart_event_callback_t = bool (*)(const hf_uart_event_t* event, void* user_data);
 
using hf_uart_break_callback_t = bool (*)(uint32_t break_duration, void* user_data);
 
//==============================================================================
// END OF ESPUART TYPES - MINIMAL AND ESSENTIAL ONLY
//==============================================================================
 
//==============================================================================
// ESP32 UART PIN MAP DEFINITIONS
//==============================================================================
 
// ESP32-C6 UART Pin Mappings
#ifdef HF_MCU_ESP32C6
struct hf_uart_pin_map_esp32c6_t {
  static constexpr hf_pin_num_t UART0_TX_PIN = 21;  // GPIO21
  static constexpr hf_pin_num_t UART0_RX_PIN = 20;  // GPIO20
  static constexpr hf_pin_num_t UART0_RTS_PIN = 19; // GPIO19
  static constexpr hf_pin_num_t UART0_CTS_PIN = 18; // GPIO18
 
  static constexpr hf_pin_num_t UART1_TX_PIN = 6;  // GPIO6
  static constexpr hf_pin_num_t UART1_RX_PIN = 7;  // GPIO7
  static constexpr hf_pin_num_t UART1_RTS_PIN = 8; // GPIO8
  static constexpr hf_pin_num_t UART1_CTS_PIN = 9; // GPIO9
 
  static constexpr hf_pin_num_t UART2_TX_PIN = 16;  // GPIO16
  static constexpr hf_pin_num_t UART2_RX_PIN = 17;  // GPIO17
  static constexpr hf_pin_num_t UART2_RTS_PIN = 14; // GPIO14
  static constexpr hf_pin_num_t UART2_CTS_PIN = 15; // GPIO15
};
#endif
 
// ESP32 Classic UART Pin Mappings
#ifdef HF_MCU_ESP32
struct hf_uart_pin_map_esp32_t {
  static constexpr hf_pin_num_t UART0_TX_PIN = 1;   // GPIO1 (UART0_TXD)
  static constexpr hf_pin_num_t UART0_RX_PIN = 3;   // GPIO3 (UART0_RXD)
  static constexpr hf_pin_num_t UART0_RTS_PIN = 19; // GPIO19
  static constexpr hf_pin_num_t UART0_CTS_PIN = 22; // GPIO22
 
  static constexpr hf_pin_num_t UART1_TX_PIN = 10;  // GPIO10
  static constexpr hf_pin_num_t UART1_RX_PIN = 9;   // GPIO9
  static constexpr hf_pin_num_t UART1_RTS_PIN = 11; // GPIO11
  static constexpr hf_pin_num_t UART1_CTS_PIN = 6;  // GPIO6
 
  static constexpr hf_pin_num_t UART2_TX_PIN = 17;  // GPIO17
  static constexpr hf_pin_num_t UART2_RX_PIN = 16;  // GPIO16
  static constexpr hf_pin_num_t UART2_RTS_PIN = 18; // GPIO18
  static constexpr hf_pin_num_t UART2_CTS_PIN = 23; // GPIO23
};
#endif
 
// ESP32-S2 UART Pin Mappings
#ifdef HF_MCU_ESP32S2
struct hf_uart_pin_map_esp32s2_t {
  static constexpr hf_pin_num_t UART0_TX_PIN = 43;  // GPIO43
  static constexpr hf_pin_num_t UART0_RX_PIN = 44;  // GPIO44
  static constexpr hf_pin_num_t UART0_RTS_PIN = 45; // GPIO45
  static constexpr hf_pin_num_t UART0_CTS_PIN = 46; // GPIO46
 
  static constexpr hf_pin_num_t UART1_TX_PIN = 17;  // GPIO17
  static constexpr hf_pin_num_t UART1_RX_PIN = 18;  // GPIO18
  static constexpr hf_pin_num_t UART1_RTS_PIN = 19; // GPIO19
  static constexpr hf_pin_num_t UART1_CTS_PIN = 20; // GPIO20
 
  static constexpr hf_pin_num_t UART2_TX_PIN = 21;  // GPIO21
  static constexpr hf_pin_num_t UART2_RX_PIN = 22;  // GPIO22
  static constexpr hf_pin_num_t UART2_RTS_PIN = 23; // GPIO23
  static constexpr hf_pin_num_t UART2_CTS_PIN = 24; // GPIO24
};
#endif
 
// ESP32-S3 UART Pin Mappings
#ifdef HF_MCU_ESP32S3
struct hf_uart_pin_map_esp32s3_t {
  static constexpr hf_pin_num_t UART0_TX_PIN = 43;  // GPIO43
  static constexpr hf_pin_num_t UART0_RX_PIN = 44;  // GPIO44
  static constexpr hf_pin_num_t UART0_RTS_PIN = 45; // GPIO45
  static constexpr hf_pin_num_t UART0_CTS_PIN = 46; // GPIO46
 
  static constexpr hf_pin_num_t UART1_TX_PIN = 17;  // GPIO17
  static constexpr hf_pin_num_t UART1_RX_PIN = 18;  // GPIO18
  static constexpr hf_pin_num_t UART1_RTS_PIN = 19; // GPIO19
  static constexpr hf_pin_num_t UART1_CTS_PIN = 20; // GPIO20
 
  static constexpr hf_pin_num_t UART2_TX_PIN = 21;  // GPIO21
  static constexpr hf_pin_num_t UART2_RX_PIN = 22;  // GPIO22
  static constexpr hf_pin_num_t UART2_RTS_PIN = 23; // GPIO23
  static constexpr hf_pin_num_t UART2_CTS_PIN = 24; // GPIO24
};
#endif
 
// ESP32-C3 UART Pin Mappings
#ifdef HF_MCU_ESP32C3
struct hf_uart_pin_map_esp32c3_t {
  static constexpr hf_pin_num_t UART0_TX_PIN = 21;  // GPIO21
  static constexpr hf_pin_num_t UART0_RX_PIN = 20;  // GPIO20
  static constexpr hf_pin_num_t UART0_RTS_PIN = 19; // GPIO19
  static constexpr hf_pin_num_t UART0_CTS_PIN = 18; // GPIO18
 
  static constexpr hf_pin_num_t UART1_TX_PIN = 6;  // GPIO6
  static constexpr hf_pin_num_t UART1_RX_PIN = 7;  // GPIO7
  static constexpr hf_pin_num_t UART1_RTS_PIN = 8; // GPIO8
  static constexpr hf_pin_num_t UART1_CTS_PIN = 9; // GPIO9
};
#endif
 
// ESP32-C2 UART Pin Mappings
#ifdef HF_MCU_ESP32C2
struct hf_uart_pin_map_esp32c2_t {
  static constexpr hf_pin_num_t UART0_TX_PIN = 21;  // GPIO21
  static constexpr hf_pin_num_t UART0_RX_PIN = 20;  // GPIO20
  static constexpr hf_pin_num_t UART0_RTS_PIN = 19; // GPIO19
  static constexpr hf_pin_num_t UART0_CTS_PIN = 18; // GPIO18
 
  static constexpr hf_pin_num_t UART1_TX_PIN = 6;  // GPIO6
  static constexpr hf_pin_num_t UART1_RX_PIN = 7;  // GPIO7
  static constexpr hf_pin_num_t UART1_RTS_PIN = 8; // GPIO8
  static constexpr hf_pin_num_t UART1_CTS_PIN = 9; // GPIO9
};
#endif
 
// ESP32-H2 UART Pin Mappings
#ifdef HF_MCU_ESP32H2
struct hf_uart_pin_map_esp32h2_t {
  static constexpr hf_pin_num_t UART0_TX_PIN = 21;  // GPIO21
  static constexpr hf_pin_num_t UART0_RX_PIN = 20;  // GPIO20
  static constexpr hf_pin_num_t UART0_RTS_PIN = 19; // GPIO19
  static constexpr hf_pin_num_t UART0_CTS_PIN = 18; // GPIO18
 
  static constexpr hf_pin_num_t UART1_TX_PIN = 6;  // GPIO6
  static constexpr hf_pin_num_t UART1_RX_PIN = 7;  // GPIO7
  static constexpr hf_pin_num_t UART1_RTS_PIN = 8; // GPIO8
  static constexpr hf_pin_num_t UART1_CTS_PIN = 9; // GPIO9
};
#endif