mac.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include <idfxx/error>
 
#include <array>
#include <cstdint>
#include <esp_mac.h>
#include <soc/soc_caps.h>
#include <string>
 
namespace idfxx {
 
enum class mac_type : int {
    // clang-format off
    wifi_sta       = 0, 
    wifi_softap    = 1, 
    bt             = 2, 
    ethernet       = 3, 
#if SOC_IEEE802154_SUPPORTED
    ieee802154     = 4, 
#endif
    base           = 5, 
    efuse_factory  = 6, 
    efuse_custom   = 7, 
#if SOC_IEEE802154_SUPPORTED
    efuse_ext      = 8, 
#endif
    // clang-format on
};
 
class mac_address {
public:
    constexpr mac_address() noexcept = default;
 
    constexpr explicit mac_address(std::array<uint8_t, 6> bytes) noexcept
        : _bytes(bytes) {}
 
    constexpr mac_address(uint8_t b0, uint8_t b1, uint8_t b2, uint8_t b3, uint8_t b4, uint8_t b5) noexcept
        : _bytes{b0, b1, b2, b3, b4, b5} {}
 
    [[nodiscard]] constexpr const std::array<uint8_t, 6>& bytes() const noexcept { return _bytes; }
 
    [[nodiscard]] constexpr const uint8_t* data() const noexcept { return _bytes.data(); }
 
    [[nodiscard]] constexpr uint8_t* data() noexcept { return _bytes.data(); }
 
    [[nodiscard]] constexpr uint8_t operator[](std::size_t i) const noexcept { return _bytes[i]; }
 
    [[nodiscard]] constexpr bool operator==(const mac_address&) const noexcept = default;
 
private:
    std::array<uint8_t, 6> _bytes{};
};
 
[[nodiscard]] std::string to_string(const mac_address& addr);
 
// =============================================================================
// MAC address reading
// =============================================================================
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
[[nodiscard]] mac_address read_mac(mac_type type);
 
[[nodiscard]] mac_address base_mac_address();
#endif
 
[[nodiscard]] result<mac_address> try_read_mac(mac_type type);
 
[[nodiscard]] result<mac_address> try_base_mac_address();
 
// =============================================================================
// MAC address configuration
// =============================================================================
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
void set_base_mac_address(const mac_address& addr);
 
void set_interface_mac_address(const mac_address& addr, mac_type type);
#endif
 
[[nodiscard]] result<void> try_set_base_mac_address(const mac_address& addr);
 
[[nodiscard]] result<void> try_set_interface_mac_address(const mac_address& addr, mac_type type);
 
// =============================================================================
// eFuse MAC helpers
// =============================================================================
 
[[nodiscard]] result<mac_address> try_default_mac();
 
[[nodiscard]] result<mac_address> try_custom_mac();
 
[[nodiscard]] result<mac_address> try_derive_local_mac(const mac_address& universal_mac);
 
 
} // namespace idfxx
 
#include "sdkconfig.h"
#ifdef CONFIG_IDFXX_STD_FORMAT
#include <algorithm>
#include <format>
namespace std {
template<>
struct formatter<idfxx::mac_address> {
    constexpr auto parse(format_parse_context& ctx) { return ctx.begin(); }
 
    template<typename FormatContext>
    auto format(const idfxx::mac_address& addr, FormatContext& ctx) const {
        auto s = to_string(addr);
        return std::copy(s.begin(), s.end(), ctx.out());
    }
};
} // namespace std
#endif // CONFIG_IDFXX_STD_FORMAT