PmacCommand.h

Go to the documentation of this file.

#ifndef PMACCOMMAND_H
#define PMACCOMMAND_H

#include <string>

// Required C header files from the array control code

#include "gcp/control/code/unix/libunix_src/common/regmap.h" // RegMapBlock

// The hard limit -- pmac can't process more than this in a single
// message

#define PMAC_DATA_MAX_LEN 1400

namespace gcp {
  namespace antenna {
    namespace control {
      
      
      class PmacComms;
      
      class PmacCommand {
      public:
    
    enum RequestType {
      UPLOAD   = 0xC0, // An input wrt the pmac
      DOWNLOAD = 0x40  // An output command wrt to the pmac
    };
    
    enum Request {
      INVALID          = 0x0,  // Default which will be used to
      // indicate that a command has not
      // been initialized
      CTRL_RESPONSE    = 0xC4,
      FWDOWNLOAD       = 0xCB,
      IPADDRESS        = 0xE0,
      PMAC_FLUSH       = 0xB3,
      PMAC_GETBUFFER   = 0xC5,
      PMAC_GETLINE     = 0xB1,
      PMAC_GETMEM      = 0xB4,
      PMAC_GETRESPONSE = 0xBF,
      PMAC_PORT        = 0xBE,
      PMAC_READREADY   = 0xC2,
      PMAC_SENDLINE    = 0xB0,
      PMAC_SETMEM      = 0xB5,
      PMAC_SETBIT      = 0xBA,
      PMAC_SETBITS     = 0xBB,
      PMAC_WRITEBUFFER = 0xC6,
      PMAC_WRITEERROR  = 0xC7
    };
    
    struct EthCmdInfo {
      unsigned char  requestType_;
      unsigned char  request_;
      unsigned short wValue_;
      unsigned short wIndex_;
      unsigned short wLength_;
    };
    
    struct EthCmd {
      EthCmdInfo info_;
      unsigned char sendData_[PMAC_DATA_MAX_LEN];
    };
    
    PmacCommand();
    
    ~PmacCommand();
    
    void packCtrlResponseCmd();
    
    void packFwDownLoadCmd();
    
    void packIpAddress();
    
    void packIpAddress(unsigned int address);
    
    void packPmacFlushCmd();
    
    void packPmacGetBufferCmd();
    
    void packPmacGetLineCmd();
    
    void packPmacGetMemCmd(unsigned short offset, 
                   unsigned short length);
    
    void packPmacGetResponseCmd(std::string outString);
    
    void packPmacPortCmd(unsigned char port);
    
    void packPmacPortCmd();
    
    void packPmacReadReadyCmd();
    
    void packPmacSendCtrlCharCmd(char outch);
    
    void packPmacSendLineCmd(std::string line);
    
    void packPmacSetBitCmd(unsigned short bitNo, bool on);
    
    void packPmacSetBitsCmd(unsigned int mask);
    
    void packPmacSetMemCmd(unsigned short offset, 
                   unsigned short length,
                   unsigned char* data);
    
    void packPmacWriteBufferCmd(unsigned int* data, unsigned int len);
    
    //------------------------------------------------------------
    // Derived command types.  These are built on top of the
    // primitive command types supported by the pmac interface.
    //------------------------------------------------------------
    
    void packWriteRegCmd(RegMapBlock* blk, 
                 unsigned int first, unsigned int nreg, 
                 unsigned int* value);
    
    void packReadRegCmd(RegMapBlock* blk, 
                unsigned int first, unsigned int nreg);
    
    //------------------------------------------------------------
    // Methods to do with reading responses back from the pmac.
    //------------------------------------------------------------
    
    void* readData();
    
    size_t responseLength();
    
    void readRegResponse(RegMapBlock *blk, 
                      unsigned int first, unsigned int nreg,
                      unsigned int* response);

    unsigned int* readRegResponse(RegMapBlock *blk, 
                      unsigned int first, unsigned int nreg);
    
      private:
    
    friend class PmacComms;
    
    EthCmd cmd_;
    
    unsigned short cmdSize_; 
    
    bool expectsResponse_;    
    
    unsigned short responseLength_; 
    
    unsigned char readData_[PMAC_DATA_MAX_LEN];

    unsigned char tmpBuffer_[PMAC_DATA_MAX_LEN];
    
    //------------------------------------------------------------
    // Methods for accessing private members.
    //------------------------------------------------------------
    
    Request request();
    
    const void* cmd();
    
    size_t size();
    
    const void* sendData();
    
      }; // End class PmacCommand
      
    }; // End namespace control
  }; // End namespace antenna
}; // End namespace gcp

#endif // End #ifndef