chip.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include <idfxx/flags>
 
#include <cstdint>
#include <esp_chip_info.h>
#include <string>
 
namespace idfxx {
 
enum class chip_model : int {
    // clang-format off
    esp32   = 1,  
    esp32s2 = 2,  
    esp32s3 = 9,  
    esp32c3 = 5,  
    esp32c2 = 12, 
    esp32c6 = 13, 
    esp32h2 = 16, 
    esp32p4 = 18, 
    esp32c5 = 23, 
    esp32c61 = 20, 
    // clang-format on
};
 
[[nodiscard]] std::string to_string(chip_model m);
 
enum class chip_feature : uint32_t {
    // clang-format off
    embedded_flash  = 1u << 0,  
    wifi            = 1u << 1,  
    ble             = 1u << 4,  
    bt_classic      = 1u << 5,  
    ieee802154      = 1u << 6,  
    embedded_psram  = 1u << 7,  
    // clang-format on
};
 
} // namespace idfxx
 
template<>
inline constexpr bool idfxx::enable_flags_operators<idfxx::chip_feature> = true;
 
namespace idfxx {
 
class chip_info {
public:
    [[nodiscard]] static chip_info get() noexcept;
 
    [[nodiscard]] chip_model model() const noexcept { return static_cast<chip_model>(_info.model); }
 
    [[nodiscard]] flags<chip_feature> features() const noexcept {
        return flags<chip_feature>(static_cast<std::underlying_type_t<chip_feature>>(_info.features));
    }
 
    [[nodiscard]] uint8_t cores() const noexcept { return _info.cores; }
 
    [[nodiscard]] uint16_t revision() const noexcept { return _info.revision; }
 
    [[nodiscard]] uint8_t major_revision() const noexcept { return _info.revision / 100; }
 
    [[nodiscard]] uint8_t minor_revision() const noexcept { return _info.revision % 100; }
 
private:
    esp_chip_info_t _info{};
};
 
 
} // namespace idfxx
 
#include "sdkconfig.h"
#ifdef CONFIG_IDFXX_STD_FORMAT
#include <algorithm>
#include <format>
namespace std {
template<>
struct formatter<idfxx::chip_model> {
    constexpr auto parse(format_parse_context& ctx) { return ctx.begin(); }
 
    template<typename FormatContext>
    auto format(idfxx::chip_model m, FormatContext& ctx) const {
        auto s = to_string(m);
        return std::copy(s.begin(), s.end(), ctx.out());
    }
};
} // namespace std
#endif // CONFIG_IDFXX_STD_FORMAT