foe_error_codes.h

Go to the documentation of this file.

#pragma once
 
#include <algorithm>
#include <array>
#include <cstdint>
#include <nlohmann/json_fwd.hpp>
#include <string_view>
 
namespace mm::comm {
 
struct FoeErrorCode {
  uint32_t code = 0;             
  std::string_view name;         
  std::string_view description;  
};
 
void to_json(nlohmann::json& j, const FoeErrorCode& e);
 
inline constexpr auto kFoeErrorCodes = std::to_array<FoeErrorCode>({
    {0x00000000, "Undefined", "Unspecified or vendor-specific FoE error"},
    {0x00008000, "Not defined", "General FoE error with no further classification"},
    {0x00008001, "Not found", "The requested file was not found on the slave"},
    {0x00008002, "Access denied", "Access to the requested file is denied"},
    {0x00008003, "Disk full", "The slave has insufficient storage to complete the transfer"},
    {0x00008004, "Illegal", "Illegal FoE operation"},
    {0x00008005, "Packet number wrong",
     "Received a data packet with an unexpected sequence number"},  // NOLINT
    {0x00008006, "Already exists", "The file already exists on the slave"},
    {0x00008007, "No user", "No user is logged in; authentication required"},
    {0x00008008, "Bootstrap only", "This operation is only available in Bootstrap state"},
    {0x00008009, "Not Bootstrap", "This operation is not available in Bootstrap state"},
    {0x0000800A, "No rights", "Insufficient rights to perform the requested operation"},
    {0x0000800B, "Program error", "A program error occurred on the slave"},
});
 
constexpr std::string_view foeErrorCodeName(uint32_t code) {
  const auto it = std::find_if(kFoeErrorCodes.begin(), kFoeErrorCodes.end(),
                               [code](const FoeErrorCode& e) { return e.code == code; });
  return it != kFoeErrorCodes.end() ? it->name : std::string_view{};
}
 
}  // namespace mm::comm