ntv2baremetaldriverinterface.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef NTV2BAREMETALDRIVERINTERFACE_H
#define NTV2BAREMETALDRIVERINTERFACE_H

#include "ntv2driverinterface.h"
#include <assert.h>
#include <stdio.h>
#include <string.h>
#include <string>

#define CopyMemory(a,b,c) memcpy((a),(b),(c))

// oem dma: save locked pages in a stl::vector
#include <vector>
typedef std::vector<ULWord *> DMA_LOCKED_VEC;

class CNTV2BareMetalDriverInterface : public CNTV2DriverInterface
{
    public:
                            CNTV2BareMetalDriverInterface();
        AJA_VIRTUAL         ~CNTV2BareMetalDriverInterface();

        AJA_VIRTUAL bool    WriteRegister (const ULWord inRegNum, const ULWord inValue, const ULWord inMask = 0xFFFFFFFF, const ULWord inShift = 0);
        AJA_VIRTUAL bool    ReadRegister (const ULWord inRegNum,  ULWord & outValue,  const ULWord inMask = 0xFFFFFFFF, const ULWord inShift = 0);

        AJA_VIRTUAL bool    RestoreHardwareProcampRegisters (void);

        AJA_VIRTUAL bool    DmaTransfer (const NTV2DMAEngine    inDMAEngine,
                                        const bool              inIsRead,
                                        const ULWord            inFrameNumber,
                                        ULWord *                pFrameBuffer,
                                        const ULWord            inCardOffsetBytes,
                                        const ULWord            inTotalByteCount,
                                        const bool              inSynchronous = true);

        AJA_VIRTUAL bool    DmaTransfer (const NTV2DMAEngine    inDMAEngine,
                                        const bool              inIsRead,
                                        const ULWord            inFrameNumber,
                                        ULWord *                pFrameBuffer,
                                        const ULWord            inCardOffsetBytes,
                                        const ULWord            inTotalByteCount,
                                        const ULWord            inNumSegments,
                                        const ULWord            inHostPitchPerSeg,
                                        const ULWord            inCardPitchPerSeg,
                                        const bool              inSynchronous = true);

    AJA_VIRTUAL bool        DmaTransfer (const NTV2DMAEngine        inDMAEngine,
                                        const NTV2Channel           inDMAChannel,
                                        const bool                  inTarget,
                                        const ULWord                inFrameNumber,
                                        const ULWord                inCardOffsetBytes,
                                        const ULWord                inByteCount,
                                        const ULWord                inNumSegments,
                                        const ULWord                inSegmentHostPitch,
                                        const ULWord                inSegmentCardPitch,
                                        const PCHANNEL_P2P_STRUCT & inP2PData);

    AJA_VIRTUAL bool ConfigureSubscription (const bool bSubscribe, const INTERRUPT_ENUMS eInterruptType, PULWord & hSubcription)
                                            {(void)bSubscribe; (void)eInterruptType; (void)hSubcription; return true;}
    AJA_VIRTUAL bool ConfigureInterrupt (const bool bEnable, const INTERRUPT_ENUMS eInterruptType);
    AJA_VIRTUAL bool GetInterruptCount (const INTERRUPT_ENUMS eInterrupt, ULWord & outCount);
    AJA_VIRTUAL bool WaitForInterrupt (INTERRUPT_ENUMS eInterrupt, ULWord timeOutMs = 68);  // default of 68 ms timeout is enough time for 2K at 14.98 HZ

    AJA_VIRTUAL bool AutoCirculate (AUTOCIRCULATE_DATA &autoCircData);
    AJA_VIRTUAL bool NTV2Message (NTV2_HEADER * pInOutMessage);
    AJA_VIRTUAL bool ControlDriverDebugMessages(NTV2_DriverDebugMessageSet msgSet, bool enable);

    AJA_VIRTUAL bool SetupBoard(void);

    // User allocated buffer methods.  Not as fast as driverbuffer methods, but no kernel patch required.
    AJA_VIRTUAL bool DmaWriteWithOffsets (NTV2DMAEngine DMAEngine, ULWord frameNumber, ULWord * pFrameBuffer,
                                                                    ULWord offsetSrc, ULWord offsetDest, ULWord bytes);
    AJA_VIRTUAL bool DmaReadWithOffsets (NTV2DMAEngine DMAEngine, ULWord frameNumber, ULWord * pFrameBuffer,
                                                                    ULWord offsetSrc, ULWord offsetDest, ULWord bytes);

public:
#if !defined(NTV2_DEPRECATE_16_0)
    AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetStreamingApplication(ULWord & outAppType, int32_t & outPID))    {return CNTV2DriverInterface::GetStreamingApplication(outAppType,outPID);}  
    AJA_VIRTUAL inline NTV2_DEPRECATED_16_0(bool GetStreamingApplication(ULWord * pAppType, int32_t * pPID))        {return pAppType && pPID ? CNTV2DriverInterface::GetStreamingApplication(*pAppType,*pPID) : false;} 
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapFrameBuffers(void));       
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool UnmapFrameBuffers(void)); 
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapRegisters(void));          
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool UnmapRegisters(void));        
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetBA0MemorySize(ULWord* memSize));   
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetBA1MemorySize(ULWord* memSize));   
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetBA2MemorySize(ULWord* memSize));   
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetBA4MemorySize(ULWord* memSize));   
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapXena2Flash(void)); 
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool UnmapXena2Flash(void));   
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapDNXRegisters(void));   
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool UnmapDNXRegisters(void));
    // Driver allocated buffer (DMA performance enhancement, requires bigphysarea patch to kernel)
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool MapDMADriverBuffer());
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool UnmapDMADriverBuffer());

    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool DmaReadFrameDriverBuffer (NTV2DMAEngine DMAEngine, ULWord frameNumber, unsigned long dmaBufferFrame,
                                                                            ULWord bytes, ULWord downSample, ULWord linePitch, ULWord poll));

    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool DmaReadFrameDriverBuffer (NTV2DMAEngine DMAEngine, ULWord frameNumber, unsigned long dmaBufferFrame,
                                                                            ULWord offsetSrc, ULWord offsetDest, ULWord bytes,
                                                                            ULWord downSample, ULWord linePitch, ULWord poll));

    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool DmaWriteFrameDriverBuffer (NTV2DMAEngine DMAEngine, ULWord frameNumber, unsigned long dmaBufferFrame,
                                                                        ULWord bytes, ULWord poll));
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool DmaWriteFrameDriverBuffer (NTV2DMAEngine DMAEngine, ULWord frameNumber, unsigned long dmaBufferFrame,
                                                                        ULWord offsetSrc, ULWord offsetDest, ULWord bytes, ULWord poll));
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetDMADriverBufferPhysicalAddress(ULWord* physAddr));
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetDMADriverBufferAddress(ULWord** pDMADriverBuffer));
    AJA_VIRTUAL NTV2_DEPRECATED_16_0(bool GetDMANumDriverBuffers(ULWord* pNumDmaDriverBuffers));
#endif  //  defined(NTV2_DRIVER_ALLOCATED_BUFFERS)
#if !defined(NTV2_DEPRECATE_17_6)
    AJA_VIRTUAL inline bool NTV2_DEPRECATED_17_6(HevcSendMessage(HevcMessageHeader* pMsg))  {(void)pMsg; return false;} 
#endif
    AJA_VIRTUAL bool SetAudioOutputMode(NTV2_GlobalAudioPlaybackMode mode); // Supported!
    AJA_VIRTUAL bool GetAudioOutputMode(NTV2_GlobalAudioPlaybackMode* mode);// Supported!

#if !defined(NTV2_NULL_DEVICE)
protected:  //  PRIVATE METHODS
    AJA_VIRTUAL bool    OpenLocalPhysical (const UWord inDeviceIndex);  
    AJA_VIRTUAL bool    CloseLocalPhysical  (void);
#endif  //  !defined(NTV2_NULL_DEVICE)

protected:  //  INSTANCE DATA
    std::string     _bitfileDirectory;
    HANDLE          _hDevice;
#if !defined(NTV2_DEPRECATE_16_0)
    ULWord *        _pDMADriverBufferAddress;
    ULWord          _BA0MemorySize;
    ULWord *        _pDNXRegisterBaseAddress;
    ULWord          _BA2MemorySize;
    ULWord          _BA4MemorySize;          // XENA2 only
#endif  //  !defined(NTV2_DEPRECATE_16_0)
};  //  CNTV2BareMetalDriverInterface

#endif  //  NTV2BAREMETALDRIVERINTERFACE_H