object.hxx

// dawn/include/dawn/common/object.hxx
//
// SPDX-License-Identifier: Apache-2.0
//
 
#pragma once
 
#include <cstdint>
 
#include "dawn/common/descobject.hxx"
#include "dawn/common/objectcfg.hxx"
#include "dawn/common/objectid.hxx"
#include "dawn/porting/config.hxx"
 
#ifndef CONFIG_DAWN_OBJECT_NAME_SIZE
#  define CONFIG_DAWN_OBJECT_NAME_SIZE 16
#endif
 
namespace dawn
{
class CObject
{
public:
  enum
  {
    STATE_STOPPED = 0, 
    STATE_RUNNING = 1  
  } typedef EObjectState;
 
  enum
  {
    CMD_RESET = 0,    
    CMD_TRIGGER1 = 1, 
    CMD_TRIGGER2 = 2, 
    CMD_TRIGGER3 = 3  
  };
 
  explicit CObject(CDescObject &desc)
    : started(false)
    , objdesc(desc)
    , uobjid(desc.getObjectId())
  {
  }
 
  virtual ~CObject() = default;
 
  virtual int configure()
  {
    return OK;
  };
 
  virtual int init()
  {
    return OK;
  };
 
  virtual int deinit()
  {
    return OK;
  };
 
  int start()
  {
    int ret;
 
    if (started)
      {
        return OK;
      }
 
    ret = doStart();
    if (ret == OK)
      {
        started = true;
      }
 
    return ret;
  };
 
  int stop()
  {
    int ret;
 
    if (!started)
      {
        return OK;
      }
 
    ret = doStop();
    started = false;
    return ret;
  };
 
  virtual bool hasThread() const
  {
    return false;
  }
 
  virtual EObjectState getState() const
  {
    return started ? STATE_RUNNING : STATE_STOPPED;
  }
 
  virtual int trigger(uint8_t cmd)
  {
    UNUSED(cmd);
    return -ENOTSUP;
  }
 
  SObjectId::UObjectId getId() const;
 
  SObjectId::ObjectId getIdV() const;
 
  bool getCfgFlag() const;
 
  uint8_t getType() const;
 
  uint16_t getCls() const;
 
  uint8_t getDtype() const;
 
  uint8_t getFlags() const;
 
  uint16_t getPriv() const;
 
  CDescObject &getDesc();
 
  size_t getDtypeSize() const;
 
  int setObjConfig(SObjectCfg::ObjectCfgId objcfg, uint32_t *data, size_t len);
 
  int getObjConfig(SObjectCfg::ObjectCfgId objcfg, uint32_t *data, size_t len);
 
  enum
  {
    DESCVALID_ERR_LEN_ALIGN = -1,
    DESCVALID_ERR_NO_OBJSIZE = -2,
    DESCVALID_ERR_NO_CFG_HEADER = -3,
    DESCVALID_ERR_CFG_TRUNCATED = -4,
    DESCVALID_ERR_CFG_DATA = -6
  };
 
  static int descValidDefault(const uint32_t *data, size_t len);
 
  static int validateDesc(const uint32_t *desc, size_t len);
 
#ifdef CONFIG_DAWN_OBJECT_HAS_NAME
  virtual const char *getClassNameStr() const = 0;
 
  const char *getName() const;
#endif // CONFIG_DAWN_OBJECT_HAS_NAME
 
protected:
  virtual int onSetObjConfig(SObjectCfg::ObjectCfgId objcfg, uint32_t *data, size_t len)
  {
    UNUSED(objcfg);
    UNUSED(data);
    UNUSED(len);
    return OK;
  }
 
  virtual int doStart()
  {
    return OK;
  }
 
  virtual int doStop()
  {
    return OK;
  }
 
#ifdef CONFIG_DAWN_OBJECT_HAS_NAME
  mutable char name[CONFIG_DAWN_OBJECT_NAME_SIZE] = {};
#endif
 
private:
  bool started; // Operational started state, set by start()/stop() wrappers.
  CDescObject &objdesc;
  SObjectId::UObjectId uobjid;
};
 
} // Namespace dawn