pwm.hxx

// dawn/include/dawn/io/pwm.hxx
//
// SPDX-License-Identifier: Apache-2.0
//
 
#pragma once
 
#include "dawn/io/common.hxx"
#include "dawn/porting/config.hxx"
#include "dawn/porting/pwm.hxx"
 
namespace dawn
{
class CIOPwm : public CIOCommon
{
public:
  enum
  {
    IO_PWM_CFG_FIRST = 0, 
    IO_PWM_CFG_FREQ = 1,  
    IO_PWM_CFG_DT = 2,    
    IO_PWM_CFG_POL = 3,   
    IO_PWM_CFG_LAST = 31  
  };
 
  explicit CIOPwm(CDescObject &desc)
    : CIOCommon(desc)
    , path()
    , fd(-1)
    , channels(CONFIG_PWM_NCHANNELS)
    , freq(CONFIG_DAWN_IO_PWM_DEFAULT_FREQ)
    , info(nullptr)
  {
  }
 
  ~CIOPwm() override;
 
#ifdef CONFIG_DAWN_OBJECT_HAS_NAME
  const char *getClassNameStr() const override
  {
    return "pwm";
  }
#endif
 
  int configure() override;
  int init() override;
  int deinit() override;
  int setDataImpl(IODataCmn &data) override;
  int doStart() override;
  int doStop() override;
  int trigger(uint8_t cmd) override;
  size_t getDataSize() const override;
  size_t getDataDim() const override;
 
  bool isRead() const override
  {
    return false;
  };
 
  bool isWrite() const override
  {
    return true;
  };
 
  bool isNotify() const override
  {
    return false;
  };
 
  bool isBatch() const override
  {
    return false;
  };
 
  using ObjectIdHelper = CIOCommon::IOObjectIdHelper<IO_CLASS_PWM, SObjectId::DTYPE_UINT32>;
 
  constexpr static SObjectId::ObjectId objectId(bool ts, uint16_t inst)
  {
    return ObjectIdHelper::create(ts, inst);
  }
 
  constexpr static SObjectCfg::ObjectCfgId cfgId(bool rw, uint8_t dtype, uint8_t size, uint8_t id)
  {
    return SObjectCfg::objectCfg(
      SObjectId::OBJTYPE_IO, CIOCommon::IO_CLASS_PWM, dtype, rw, size, id);
  }
 
  constexpr static SObjectCfg::ObjectCfgId cfgIdFreq(bool rw = false)
  {
    return CIOPwm::cfgId(rw, SObjectId::DTYPE_UINT32, 1, IO_PWM_CFG_FREQ);
  }
 
protected:
  int onSetObjConfig(SObjectCfg::ObjectCfgId objcfg, uint32_t *data, size_t len) override;
 
private:
  char path[PATH_MAX];              
  int fd;                           
  uint8_t channels;                 
  uint32_t freq;                    
#ifdef CONFIG_DAWN_IO_TIMESTAMP
  uint64_t ts;                      
#endif
  dawn::porting::pwm_write_s *info; 
 
  int configureDesc(const CDescObject &desc);
};
} // Namespace dawn