CArcPCIBase.h

Go to the documentation of this file.

// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcPCIBase.h                                                                                            |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the PCI/PCIe device base class.                                                      |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: ?                                                                           |
// |                                                                                                                  |
// |  Copyright Astronomical Research Cameras, Inc. All rights reserved.                                              |
// +------------------------------------------------------------------------------------------------------------------+
#pragma once
 
 
#ifdef _WINDOWS
    #pragma warning( disable: 4251 )
#endif
 
#include <iostream>
#include <vector>
#include <string>
#include <memory>
 
#include <CArcDeviceDllMain.h>
#include <CArcStringList.h>
#include <CArcDevice.h>
#include <CArcBase.h>
 
 
 
namespace arc
{
    namespace gen3
    {
 
        using pCStrList_t = std::unique_ptr<arc::gen3::CArcStringList>;
 
        struct PCIRegData
        {
            pCStrList_t     pBitList;   
            std::string     sName;      
            std::uint32_t   uiValue;    
            std::uint32_t   uiAddr;     
        };
 
        using pPCIRegData_t = std::shared_ptr<PCIRegData>;
 
        using PCIRegList_t  = std::vector<pPCIRegData_t>;
 
 
        // +-------------------------------------------------------------------+
        // |  PCI configuration space register bar item ( used to name and     |
        // |  contain a set of local gen3 configuration registers; if they     |
        // |  exist )                                                          |
        // +-------------------------------------------------------------------+
 
        using pPCIRegList_t = std::unique_ptr<PCIRegList_t>;
 
        struct PCIBarData
        {
            std::string     sName;      
            pPCIRegList_t   pList;      
        };
 
        using pPCIBarData_t = std::shared_ptr<PCIBarData>;
 
        using PCIBarList_t  = std::vector<pPCIBarData_t>;
 
 
        class GEN3_CARCDEVICE_API CArcPCIBase : public CArcDevice
        {
            public:
 
                CArcPCIBase( void ) = default;
 
                virtual ~CArcPCIBase( void );
 
                virtual std::uint32_t getCfgSpByte( const std::uint32_t uiOffset )  = 0;
 
                virtual std::uint32_t getCfgSpWord( const std::uint32_t uiOffset )  = 0;
 
                virtual std::uint32_t getCfgSpDWord( const std::uint32_t uiOffset ) = 0;
 
                virtual void setCfgSpByte( const std::uint32_t uiOffset, const std::uint32_t uiValue )  = 0;
 
                virtual void setCfgSpWord( const std::uint32_t uiOffset, const std::uint32_t uiValue )  = 0;
 
                virtual void setCfgSpDWord( const std::uint32_t uiOffset, const std::uint32_t uiValue ) = 0;
 
                virtual void getCfgSp( void );
 
                virtual void getBarSp( void );
 
                std::uint32_t getCfgSpCount( void );
 
                std::uint32_t getCfgSpAddr( const std::uint32_t uiIndex );
 
                std::uint32_t getCfgSpValue( const std::uint32_t uiIndex );
 
                const std::string getCfgSpName( const std::uint32_t uiIndex );
 
                const std::string* getCfgSpBitList( const std::uint32_t uiIndex, std::uint32_t& pCount );
 
                std::uint32_t getBarCount( void );
 
                const std::string getBarName( const std::uint32_t dIndex );
 
                std::uint32_t getBarRegCount( const std::uint32_t dIndex );
 
                std::uint32_t getBarRegAddr( const std::uint32_t dIndex, const std::uint32_t dRegIndex );
 
                std::uint32_t getBarRegValue( const std::uint32_t dIndex, const std::uint32_t dRegIndex );
 
                const std::string getBarRegName( const std::uint32_t dIndex, const std::uint32_t dRegIndex );
 
                std::uint32_t getBarRegBitListCount( const std::uint32_t dIndex, const std::uint32_t dRegIndex );
 
                const std::string getBarRegBitListDef( const std::uint32_t dIndex, const std::uint32_t dRegIndex, const std::uint32_t dBitListIndex );
 
                void printCfgSp( std::ostream& os = std::cout );
 
                void printBars( std::ostream& os = std::cout );
 
            protected:
 
                void addRegItem( arc::gen3::PCIRegList_t* pvDataList, const std::uint32_t uiAddr, const std::string& sName, const std::uint32_t uiValue, arc::gen3::CArcStringList* pBitList = nullptr );
 
                void addBarItem( const std::string& sName, PCIRegList_t* pList );
 
                std::unique_ptr<arc::gen3::CArcStringList> getDevVenBitList( const std::uint32_t uiData, bool bDrawSeparator = false );
 
                std::unique_ptr<arc::gen3::CArcStringList> getCommandBitList( const std::uint32_t uiData, bool bDrawSeparator = false );
 
                std::unique_ptr<arc::gen3::CArcStringList> getStatusBitList( const std::uint32_t uiData, bool bDrawSeparator = false );
 
                std::unique_ptr<arc::gen3::CArcStringList> getClassRevBitList( const std::uint32_t uiData, bool bDrawSeparator = false );
 
                std::unique_ptr<arc::gen3::CArcStringList> getBistHeaderLatencyCache( const std::uint32_t uiData, bool bDrawSeparator = false );
 
                std::unique_ptr<arc::gen3::CArcStringList> getBaseAddressBitList( const std::uint32_t uiData, bool bDrawSeparator = false );
 
                std::unique_ptr<arc::gen3::CArcStringList> getSubSysBitList( const std::uint32_t uiData, bool bDrawSeparator = false );
 
                std::unique_ptr<arc::gen3::CArcStringList> getMaxLatGntIntBitList( const std::uint32_t uiData, bool bDrawSeparator = false );
 
                struct VectorDeleter
                {
                    void operator()( PCIRegList_t* p ) const
                    {
                        if ( p != nullptr )
                        {
                            p->clear();
 
                            delete p;
                        }
                    }
                };
 
                std::shared_ptr<PCIRegList_t> m_pCfgSpList;
 
                std::shared_ptr<PCIBarList_t> m_pBarList;
 
                std::shared_ptr<std::string> m_pTmpCfgBitList;
 
                std::shared_ptr<std::string> m_pTmpBarBitList;
        };
 
    }   // end gen3 namespace
}   // end arc namespace