cinosprocessimagevalues.h

Go to the documentation of this file.

//******************************************************************************
//******************************************************************************
 
#ifndef INC_CINOSPROCESSIMAGEVALUES_H
#define INC_CINOSPROCESSIMAGEVALUES_H
 
//------------------------------------------------------------------------------
// defines
//------------------------------------------------------------------------------
//
// --- process image value CONFIG ----------------------------------------------
// 
// masks
#define DF_INOS_IMAGE_VALUE_CFG_MASK_SYSTEM 0xFFFF0000  // config system area
#define DF_INOS_IMAGE_VALUE_CFG_MASK_INP    0x000F0000  // config input
#define DF_INOS_IMAGE_VALUE_CFG_MASK_OUT    0x00F00000  // config output
#define DF_INOS_IMAGE_VALUE_CFG_MASK_USER   0x0000FFFF  // config user area
//
// patterns
#define DF_INOS_IMAGE_VALUE_CFG_ENABLED     0x80000000  // config enabled
#define DF_INOS_IMAGE_VALUE_CFG_OVERWRITE   0x40000000  // config overwrite mode
#define DF_INOS_IMAGE_VALUE_CFG_ERROR       0x20000000  // config error
#define DF_INOS_IMAGE_VALUE_CFG_WARNING     0x10000000  // config warning   
// config linked channel (e.g. DAC channel belonging to POS channel)
#define DF_INOS_IMAGE_VALUE_CFG_LINKED      0x10000000  
#define DF_INOS_IMAGE_VALUE_CFG_SIMULATED   0x08000000  // config simulated
#define DF_INOS_IMAGE_VALUE_CFG_OFFLINE     0x04000000  // config channel offline
//
// bit numbers
#define DF_INOS_IMAGE_VALUE_NBR_ENABLED     31          // config enabled
#define DF_INOS_IMAGE_VALUE_NBR_OVERWRITE   30          // config overwrite mode
#define DF_INOS_IMAGE_VALUE_NBR_ERROR       29          // config error
#define DF_INOS_IMAGE_VALUE_NBR_WARNING     28          // config warning
#define DF_INOS_IMAGE_VALUE_NBR_LINKED      28          // config linked
#define DF_INOS_IMAGE_VALUE_NBR_SIMULATED   27          // config simulated
//
//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
//
// system
//
// C++
//
// project
//
//------------------------------------------------------------------------------
// class definition
//------------------------------------------------------------------------------
//
class CINOSBusPortHandler;
class CINOSProcessImageValues : public CINOSProcessImage
{
    //--- user interface ---------------------------------------------------
 
    // public member functions
    public :
        #if defined(INOS_PROCESSIMAGE_OVERWRITE)
        virtual void SetOverwrite(bool abValue) override;
            //; change the whole process image from real to overwrite mode if
            //; abValue = true or vice versa
        virtual bool GetOverwrite() override;
            //; get actual overwrite mode of the whole process image
        virtual void SetOverwrite(uint16 auNumber, bool abValue) override;
            //; change the channel 'auNumber' from real to overwrite mode if
            //; abValue = true or vice versa
        ICACHE virtual bool GetOverwrite(uint16 auNumber) override;
            //; get actual overwrite mode of channel 'auNumber'
        #endif
 
        virtual void SetEnabled(bool abValue) override;
            //; enable whole process image if abValue = true or vice versa
        virtual bool GetEnabled() override;
            //; return true if the whole process image is enabled
        virtual void SetEnabled(uint16 auNumber, bool abValue) override;
            //; enable the channel 'auNumber' if abValue = true or vice versa
        virtual bool GetEnabled(uint16 auNumber) override;
            //; return true if channel 'auNumber' is enabled
 
        virtual void SetSimulated(uint16 auNumber, bool abValue) override;
            //; set simulated state of channel auNumber
        virtual bool GetSimulated(uint16 auNumber) override;
            //; get simulated state of channel auNumber
 
        virtual void SetConfig(uint16 auNumber, uint32 auConfig, uint32 auMask,
            uint32 auOffset=0) override;
            //; set config of channel 'auNumber' to auConfig (only bits set in 
            //; auMask are affected)
        virtual uint32 GetConfig(uint16 auNumber, uint32 auOffset=0) override;
            //; get config of channel 'auNumber'
        virtual void* GetConfigAdr(uint16 auNumber, uint32 auOffset=0) override;
            //; get config address of channel 'auNumber'
 
        virtual void* GetConfigBaseAddress() override;
            //; get base address of process image config 
        
        virtual uint16 GetCycleNumber(uint16 auNumber) override;
            //; return bus subcycle number the channel is updated (needed to be
            //; able to register bus hook in the correct subcycle)
        virtual void SetCycleNumber(uint16 auNumber, uint16 auCycleNumber, uint8 auBusId = CINOSBus::GetFirstBus()->GetId(),
            CINOSBusJob* apBusJob = 0) override;
            //; set bus id and subcycle number the channel is updated (the field bus 
            //; driver has to set this number to inform all others who are 
            //; interested in)
        virtual uint16 GetCycleId(uint16 auNumber) override;
            //; return bus cycle id the channel is updated (needed to be
            //; able to register bus hook in the correct cycle/core)
        virtual void SetCycleId(uint16 auNumber, uint16 auCycleId, uint8 auBusId,
            CINOSBusPortHandler* apBusPortHandler) override;
            //; set bus id and cycle id the channel is updated (the field bus 
            //; driver has to set this number to inform all others who are 
            //; interested in)
        virtual void UpdateCycleId(uint16 auNumber, uint16 auCycleId) override;
            //; update cycle id the channel is updated (this method is usually called
            //; from axis controllers to inform about downsampled controlling and possible
            //; other cores)
        virtual uint8 GetBusId(uint16 auNumber) override;
            //; return bus id the channel belongs to (needed to be
            //; able to register bus hook)
        virtual CINOSBusJob* GetBusJob(uint16 auNumber) override;
            //; return pointer to the according bus job (or 0 if not available)
        virtual CINOSBusPortHandler* GetBusPortHandler(uint16 auNumber) override;
            //; return pointer to the according bus port (or 0 if not available)
 
        virtual void SetBusPortHandler(uint16 auNumber, CINOSBusPortHandler* apPortHandler);
 
 
    //--- internals --------------------------------------------------------
 
    friend class CINOSProcessImageValue;
 
    // constructor / destructor
    public :
        CINOSProcessImageValues (char* apName, uint32 auNumber, void* apImage);
            //; object constructor
 
    // public member functions but just for internal use
    public :
        #if defined(INOS_PROCESSIMAGE_OVERWRITE)
        ICACHE virtual void Set(uint16 auChannel, void* apValue, 
            bool abOverwrite = false) override;
            //; set channel to apValue 
            //; (abOverwrite=true -> value always set, abOverwrite=false -> value
            //; set if channel is NOT in overwrite mode)
        ICACHE virtual void Set64(uint16 auChannel, void* apValue, 
            bool abOverwrite = false);
            //; set channel to apValue 
            //; (abOverwrite=true -> value always set, abOverwrite=false -> value
            //; set if channel is NOT in overwrite mode)
        #else
        ICACHE virtual void Set(uint16 auChannel, void* apValue) override;
            //; set channel to apValue
        ICACHE virtual void Set64(uint16 auChannel, void* apValue);
            //; set channel to apValue
        #endif
        virtual void MoveChannel(uint16 auOldNumber, uint16 auNewNumber) override;
            //; move channel auOldNumber to auNewNumber
 
    // public members but just for internal use
    public :
        uint32* m_pLatched;
            //; pointer to latched data
        uint32* m_pConfig;
            //; pointer to config data
        uint16* m_pCycleNumber;
            //; pointer to cycle number data
        uint8* m_pBusId;
            //; pointer to bus id data
        void** m_pBusJobOrPortHandler;
            //; pointer to either bus job or bus port handler
};
 
//
//------------------------------------------------------------------------------
// global variables
//------------------------------------------------------------------------------
//
//
//------------------------------------------------------------------------------
// end of file
//------------------------------------------------------------------------------
 
#endif  // INC_CINOSPROCESSIMAGEVALUES_H