types.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_COMPONENT_TYPES_HPP
#define M5_UNIT_COMPONENT_TYPES_HPP
 
#include <cstdint>
#include <type_traits>
#include "identify_functions.hpp"
#if defined(ESP_PLATFORM)
#if defined(M5_UNIT_UNIFIED_USING_RMT_V2)
#include <driver/rmt_types.h>
#else
#include <soc/rmt_struct.h>
#endif
#include <driver/gpio.h>
#endif  // ESP_PLATFORM
 
namespace m5 {
namespace unit {
namespace types {
 
enum class category_t {
    None,
    UnitLED,  
};
 
using uid_t          = uint32_t;       
using attr_t         = uint32_t;       
using elapsed_time_t = unsigned long;  
 
namespace attribute {
constexpr attr_t AccessI2C  = 0x00000001;  
constexpr attr_t AccessGPIO = 0x00000002;  
constexpr attr_t AccessUART = 0x00000004;  
constexpr attr_t AccessSPI  = 0x00000008;  
}  // namespace attribute
 
}  // namespace types
 
#if defined(ESP_PLATFORM)
namespace gpio {
enum class Mode : uint8_t {
    Input,
    Output,
    Pullup,
    InputPullup,
    Pulldown,
    InputPulldown,
    OpenDrain,
    OutputOpenDrain,
    Analog,
    // RMT access
    RmtRX = 0x80,
    RmtTX,
    RmtRXTX,
};
 
struct adapter_config_t {
    struct config_t {
        uint32_t tick_ns{};     
        gpio_num_t gpio_num{};  
        uint8_t mem_blocks{};   
        bool invert_signal{};   
        bool with_dma{};        
    };
 
    struct tx_config_t : config_t {
        uint16_t loop_count{1};      
        bool idle_output_enabled{};  
        bool idle_level_high{};      
        bool loop_enabled{};         
        //        bool carrier_enabled{};      ///< Enable carrier modulation (not commonly used)
    };
    struct rx_config_t : config_t {
        uint16_t ring_buffer_size{};        
        uint16_t filter_ticks_threshold{};  
        uint16_t idle_ticks_threshold{};    
        bool filter_enabled{};              
        //        bool eof_flag{};                    ///< Use RX EOF detection via timeout (v2 feature)
    };
 
    Mode mode{};       
    rx_config_t rx{};  
    tx_config_t tx{};  
};
 
// Alias
#if defined(M5_UNIT_UNIFIED_USING_RMT_V2)
using m5_rmt_item_t = rmt_symbol_word_t;  
#else
using m5_rmt_item_t = rmt_item32_t;  
#endif
 
}  // namespace gpio
#endif  // ESP_PLATFORM
 
}  // namespace unit
}  // namespace m5
#endif