/home/kopmann/git-mirror/fdhwlib/fdhwlib/hw4/baseregister.h

Go to the documentation of this file.

/***************************************************************************
    baseregister.h  -  description

    begin                : Thu Jun 29 2000
    copyright            : (C) 2000 by Andreas Kopmann
    email                : kopmann@hpe.fzk.de
 ***************************************************************************/


#ifndef _HW4_BASEREGISTER_H_INCLUDED
#define _HW4_BASEREGISTER_H_INCLUDED


#include <Pbus/Pbus.h>

#include <hw4/baseregisteritem.h>

namespace hw4 {

class BaseRegister : public Pbus {
public:
  BaseRegister(const char * name, int slotID, unsigned int regID, int r, int w, 
              int len = 1, int addrShift = 0, int blockLen = 1, bool useCache = true);

  virtual ~BaseRegister();

  virtual unsigned long read();

  virtual unsigned long read(int elem);

  virtual unsigned long read(int elem, int line); // TODO: Lesen mit Line= 0?

  virtual int getActiveBits(int elem = 0, unsigned long mask = 0xffffffff);

  virtual void readBlock(unsigned long * data);

  virtual void readBlock(unsigned long * data, unsigned long blockLen);

  virtual void readBlock(unsigned long * data,  unsigned long start, unsigned long blockLen);

  virtual void readBlock(int elem, unsigned long * data);

  virtual void readBlock(int elem, unsigned long * data, unsigned long blockLen);

  virtual void readBlock(int elem, unsigned long * data, unsigned long start, unsigned long blockLen);

  virtual void readElements(int elem0, int elem1, unsigned long * data);

  virtual void readElements(unsigned long * data = 0);

 
  virtual void write(unsigned long data);
  
  virtual void write(int elem, unsigned long data);

  virtual void write(int elem, int line, unsigned long data);
  
  virtual void write(unsigned long *data);

  virtual void writeBits(unsigned long data, unsigned long mask, int shift);

  virtual void writeBits(int elem, unsigned long data, unsigned long mask, int shift);

  virtual void writeBits(int elem, int line, unsigned long data, unsigned long mask, int shift);

  virtual void setBitsToHigh(unsigned long mask);

  virtual void setBitsToHigh(int elem, unsigned long mask);

  virtual void setBitsToLow(unsigned long mask);

  virtual void setBitsToLow(int elem, unsigned long mask);

  unsigned long getCache(int elem = 0, int line = 0);
  
  void getCache(unsigned long *data);
  
  void setCache(unsigned long data);

  void setCache(int elem, unsigned long data);

  //void setCache(unsigned long *data);


  virtual void setCacheBits(unsigned long data, unsigned long mask, int shift);

  virtual void setCacheBits(int elem, unsigned long data, unsigned long mask, int shift);
  
  virtual void writeCache();

  virtual void writeCache(int elem);

  virtual void writeCache(int elem , int line);


  virtual int writeBitsByName(char *name, unsigned long data);
  
  //TODO: HJ proposed a better way to handle the itemList (advantage: the number of items itemN
  //TODO: will always be correct because it is computed during creation of item list; and
  //TODO: itemList[.] is still available). -tb-
  //TODO: std::vector<hw4:BaseRegisterItem*> itemList;
  //TODO: example of creating register items:
  //TODO: itemList.push_back( triggerEnable = new BaseRegisterItem(this, "TriggerEnable", 0, 6) );
  //TODO: .. and replace itemN by unsigned int getNItems() {   return itemList.size(); }
  BaseRegisterItem **itemList;
  
  int itemN;  

  const char * getName();

  bool isReadable();

  bool isWriteable();

  unsigned long getAddr();
  
  virtual int getLength();
  
  int getBlockLength();
  
  unsigned long getAddrShift();
  
  bool isCacheEnabled();
  
//private:
protected:
  unsigned long addr;
  
  unsigned long addrShift;
  
  int len;

  int blockLen; 

  const char * name;

  bool readable;

  bool writeable;
  
  bool useCache;
  
  bool hasCBWOBits; //TODO: this will be needed in the future to implement handling of CBWO (cleared by writing 1) bits -tb-
  
  bool isMemory;
  
  unsigned long *cache;
};

} // namespace hw4
        
#endif // _HW4_BASEREGISTER_H_INCLUDED