nxscope.hxx

// dawn/include/dawn/proto/nxscope/nxscope.hxx
//
// SPDX-License-Identifier: Apache-2.0
//
 
#pragma once
 
#include "dawn/common/thread.hxx"
#include "dawn/porting/config.hxx"
#include "dawn/proto/common.hxx"
#include "logging/nxscope/nxscope.h"
#include <cstddef>
#include <mutex>
#include <semaphore.h>
 
// Recv is non blocking and uses usleep.
// TODO: blocking recv doesn't work for some reason - investigate per
//       transport (UDP/serial). Until resolved, NXSCOPE_RECV_NONBLOCK is
//       required to keep threadRecv() responsive to stop requests.
 
#define NXSCOPE_RECV_NONBLOCK (1)
 
// GET_IO response header: objid (u32 LE) + size (u16 LE)
 
#define NXSCOPE_USER_DATA_HDR (6)
 
namespace dawn
{
// Forward declaration
 
class IIOCommon;
class CIOCommon;
struct io_ddata_t;
 
class CProtoNxscope : public CProtoCommon
{
public:
  struct
  {
    SObjectId::UObjectId objid; 
  } typedef SProtoNxscopeIOBind;
 
  struct
  {
    const char name[12]; 
  } typedef SProtoNxscopeNames;
 
  struct
  {
    SProtoNxscopeIOBind bind; 
    SProtoNxscopeNames name;  
  } typedef SProtoNxscopeIOBind2;
 
  explicit CProtoNxscope(CDescObject &desc)
    : CProtoCommon(desc)
    , nxsIntf()
    , threadRecvMember()
#ifdef CONFIG_DAWN_PROTO_NXSCOPE_SAMPLE_THREAD
    , threadSampleMember()
#endif
    , nxs()
    , nxsCfg()
    , nxsProto()
    , nxsCbs()
    , userTxBuf(nullptr)
    , userTxLen(0)
  {
#ifdef CONFIG_DAWN_IO_NOTIFY
    sem_init(&streamSem, 0, 0);
#endif
  }
 
  ~CProtoNxscope() override;
 
  int configure() override;
  int init() override;
  int deinit() override;
  int doStart() override;
  int doStop() override;
  bool hasThread() const override;
 
protected:
  struct nxscope_intf_s nxsIntf; 
 
  int allocObject(SProtoNxscopeIOBind *alloc);
  int allocNames(size_t j, SProtoNxscopeNames *names);
  int configureNxscope();
 
  virtual int initPriv() = 0;
  virtual int deinitPriv() = 0;
  virtual int startPriv() = 0;
  virtual int stopPriv() = 0;
 
private:
#ifdef CONFIG_DAWN_IO_NOTIFY
  typedef int (*nxscope_put_cb_t)(struct nxscope_s *nxs,
                                  uint8_t chan,
                                  io_ddata_t *data,
                                  uint8_t dim);
#endif
 
#ifdef CONFIG_DAWN_PROTO_NXSCOPE_SAMPLE_THREAD
  struct proto_nxscope_iochan_s;
 
  typedef int (*nxscope_sample_cb_t)(CProtoNxscope *obj, struct proto_nxscope_iochan_s *iochan);
#endif
 
  struct proto_nxscope_iochan_s
  {
    uint8_t chan;         
    uint8_t dim;          
    bool stream;          
    CIOCommon *io;        
    CProtoNxscope *obj;   
    io_ddata_t *setData;  
    io_ddata_t *getData;  
 
#ifdef CONFIG_DAWN_IO_NOTIFY
    nxscope_put_cb_t put; 
#endif
 
#ifdef CONFIG_DAWN_PROTO_NXSCOPE_SAMPLE_THREAD
    nxscope_sample_cb_t sample; 
    io_ddata_t *data;           
#endif
  } typedef SProtoNxscopeIochan;
 
  enum
  {
    NXSCOPE_USER_SET_IO = NXSCOPE_HDRID_USER,
    NXSCOPE_USER_SET_IO_SEEK = NXSCOPE_HDRID_USER + 1,
    NXSCOPE_USER_GET_IO = NXSCOPE_HDRID_USER + 2,
    NXSCOPE_USER_GET_IO_SEEK = NXSCOPE_HDRID_USER + 3
  };
 
  CThreadedObject threadRecvMember;   
 
#ifdef CONFIG_DAWN_PROTO_NXSCOPE_SAMPLE_THREAD
  CThreadedObject threadSampleMember; 
#endif
 
  struct nxscope_s nxs;
  struct nxscope_cfg_s nxsCfg;
  struct nxscope_proto_s nxsProto;
  struct nxscope_callbacks_s nxsCbs;
 
  std::recursive_mutex streamLock;
 
#ifdef CONFIG_DAWN_IO_NOTIFY
  sem_t streamSem;
#endif
 
  uint8_t *userTxBuf;                                 
  size_t userTxLen;                                   
 
  std::vector<const SProtoNxscopeIOBind *> vchannels; 
  std::vector<const SProtoNxscopeNames *> vnames;     
  std::vector<SProtoNxscopeIochan> vio;               
  bool hasStreamChannels = false;                     
 
  SProtoNxscopeIochan *findIochan(SObjectId::ObjectId objid);
 
  int handleUserCommand(uint8_t id, uint8_t *buff);
  int userSetIO(uint8_t *buff);
  int userSetIOSeek(uint8_t *buff);
  int userGetIO(uint8_t *buff);
  int userGetIOSeek(uint8_t *buff);
  int sendAck(int ret);
  int sendUserData(SObjectId::ObjectId objid, const void *data, uint16_t size);
 
  static int userIdCb(void *priv, uint8_t id, uint8_t *buff);
 
#ifdef CONFIG_DAWN_IO_NOTIFY
  static int ioNotifierCb(void *priv, io_ddata_t *data);
#endif
 
  uint8_t getChannelDim(const CIOCommon &io);
  uint8_t getChannelDtype(const CIOCommon &io);
  int nxscopeChannelsCreate();
  int bindChannelCallbacks(SProtoNxscopeIochan &iochan, uint8_t dtype);
 
  template<typename T>
  using nxscope_put_t = int (*)(struct nxscope_s *, uint8_t, T *, uint8_t);
 
  template<typename T, nxscope_put_t<T> Put>
  void bindTyped(SProtoNxscopeIochan &iochan);
 
#ifdef CONFIG_DAWN_IO_NOTIFY
  template<typename T, nxscope_put_t<T> Put>
  static int putBatch(struct nxscope_s *nxs, uint8_t chan, io_ddata_t *data, uint8_t dim);
#endif
 
#ifdef CONFIG_DAWN_PROTO_NXSCOPE_SAMPLE_THREAD
  void getAndPut(SProtoNxscopeIochan *iochan);
 
  template<typename T, nxscope_put_t<T> Put>
  static int sampleTyped(CProtoNxscope *obj, SProtoNxscopeIochan *iochan);
#endif
 
  void threadRecv();
 
#ifdef CONFIG_DAWN_PROTO_NXSCOPE_SAMPLE_THREAD
  void threadSample();
#endif
};
} // Namespace dawn