descriptor.hxx

// dawn/include/dawn/common/descriptor.hxx
//
// SPDX-License-Identifier: Apache-2.0
//
 
#pragma once
 
#include <functional>
#include <vector>
 
#include "dawn/common/descobject.hxx"
#include "dawn/common/handler.hxx"
#include "dawn/common/object.hxx"
#include "dawn/porting/config.hxx"
 
namespace dawn
{
class CDescriptor
{
public:
  constexpr static uint32_t DAWN_DESCRIPTOR_HDR = 0x0d0a0302;
 
  constexpr static uint32_t DAWN_DESCRIPTOR_FOOT = 0x02030a0d;
 
  struct
  {
    uint32_t magic;          // Header magic (0x0d0a0302)
    uint32_t size : 16;      // Number of objects
    uint32_t _reserved : 16; // Reserved
  } typedef SDescriptorBinHdr;
 
  struct
  {
    uint32_t magic; // Footer magic (0x02030a0d)
    uint32_t sum;   // CRC32 checksum
  } typedef SDescriptorBinFtr;
 
  struct
  {
    SDescriptorBinHdr hdr;              // Header (8 bytes)
    SObjectCfg::SObjectCfgData objects; // Objects
  } typedef SDescriptorBin;
 
  enum
  {
    DESC_CFG_FIRST = 0,
    DESC_CFG_VERSION = 1,
    DESC_CFG_STRING = 2,
    DESC_CFG_NO_IDLE_QUIT = 3,
    DESC_CFG_LAST = 31
  };
 
  constexpr static SObjectId::ObjectId objectId(uint16_t inst)
  {
    return SObjectId::objectId(SObjectId::OBJTYPE_ANY, 0, SObjectId::OBJTYPE_ANY, 0, inst);
  }
 
  constexpr static SObjectCfg::ObjectCfgId cfgId(bool rw, uint8_t dtype, uint8_t size, uint8_t id)
  {
    return SObjectCfg::objectCfg(SObjectId::OBJTYPE_ANY, 0, dtype, rw, size, id);
  }
 
  constexpr static SObjectCfg::ObjectCfgId cfgIdVersion(bool rw = false)
  {
    return CDescriptor::cfgId(rw, SObjectId::DTYPE_UINT32, 1, DESC_CFG_VERSION);
  }
 
  constexpr static SObjectCfg::ObjectCfgId cfgIdString(uint16_t size, bool rw = false)
  {
    return CDescriptor::cfgId(rw, SObjectId::DTYPE_CHAR, size, DESC_CFG_STRING);
  }
 
  constexpr static SObjectCfg::ObjectCfgId cfgIdNoIdleQuit()
  {
    return CDescriptor::cfgId(false, SObjectId::DTYPE_UINT8, 1, DESC_CFG_NO_IDLE_QUIT);
  }
 
  CDescriptor()
    : bindesc(nullptr)
    , bindescLen(0)
    , noIdleQuit(false)
  {
  }
 
  bool getNoIdleQuit() const
  {
    return noIdleQuit;
  }
 
  ~CDescriptor();
 
  int loadBin(uint32_t *bin, size_t len, bool force_valid = false, bool dump = false);
 
  void reset();
 
  SDescriptorBin *getBin();
 
  size_t getBinLen();
 
  typedef std::function<void(CHandler &obj, CDescObject &desc)> allocobj_func_t;
  void alloc_objects(CHandler &h, const allocobj_func_t &func);
 
  SObjectCfg::SObjectCfgData *objectCfgAtOffset(size_t offset);
 
  SObjectCfg::UObjectCfgId *objectCfgIdAtOffset(size_t offset);
 
  static void binDump(const uint32_t *bin, size_t len);
 
  static int binValid(const uint32_t *bin, size_t len);
 
  static bool binCheckValid(const uint32_t *bin, size_t len);
 
  static int binCheckFill(uint32_t *bin, size_t len);
 
private:
  SDescriptorBin *bindesc;            // Pointer to loaded descriptor binary structure
  std::vector<CDescObject *> vobjcfg; // Vector of CDescObject wrappers
  size_t bindescLen;                  // Length of loaded descriptor in 32-bit words
  bool noIdleQuit;                    // no quit from idle flag
 
  void parseMeta();
  size_t objectWords() const;
  bool objectWordAt(size_t offset, uint32_t *value) const;
};
} // Namespace dawn