pnpimpl.cpp

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#include "ajabase/pnp/mac/pnpimpl.h"
#include "ajabase/common/common.h"
#include "ajabase/system/debug.h"
#include "devicenotifier.h"     //  For now use NTV2 DeviceNotifier facility
#include <sstream>
#include <iostream>
#include <iomanip>


using namespace std;

//  Logging Macros

#define HEX2(__x__)             "0x" << hex << setw(2)  << setfill('0') << (0x00FF     & uint16_t(__x__)) << dec
#define HEX4(__x__)             "0x" << hex << setw(4)  << setfill('0') << (0xFFFF     & uint16_t(__x__)) << dec
#define HEX8(__x__)             "0x" << hex << setw(8)  << setfill('0') << (0xFFFFFFFF & uint32_t(__x__)) << dec
#define HEX16(__x__)            "0x" << hex << setw(16) << setfill('0') <<               uint64_t(__x__)  << dec
#define KR(_kr_)                "kernErr=" << HEX8(_kr_) << "(" << ::GetKernErrStr(_kr_) << ")"
#define INST(__p__)             "Ins-" << hex << setw(16) << setfill('0') << uint64_t(__p__) << dec
#define THRD(__t__)             "Thr-" << hex << setw(16) << setfill('0') << uint64_t(__t__) << dec

#define PNPLOGS(__lvl__, __x__) AJA_sREPORT(AJA_DebugUnit_PnP, (__lvl__),   __func__ << ": " << __x__)


// static
bool sOnline = false;
void PCIDeviceNotifierCallback (unsigned long message, void *refcon);



AJAPnpImpl::AJAPnpImpl() : mRefCon(nullptr), mCallback(nullptr), mDevices(0), mPciDevices(nullptr)
{
}


AJAPnpImpl::~AJAPnpImpl()
{
    Uninstall();
}


AJAStatus AJAPnpImpl::Install (AJAPnpCallback callback, void* refCon, uint32_t deviceKinds)
{
    mCallback = callback;
    mRefCon   = refCon;
    mDevices  = deviceKinds;

    if (!mCallback)
        {PNPLOGS(AJA_DebugSeverity_Error, "NULL callback specified");  return AJA_STATUS_NULL;}

    //  MacOS only handles PCIe devices
    size_t numFails(0);
    if (mDevices & AJA_Pnp_PciVideoDevices) //  PCIe devices requested?
    {
        if (!mPciDevices)
            mPciDevices = new KonaNotifier(PCIDeviceNotifierCallback, this);
        if (mPciDevices)                    //  DeviceNotifier or KonaNotifier exists?
            if (!mPciDevices->Install())    //  DeviceNotifier/KonaNotifier install successful?
                numFails++;
    }
    if (mDevices & AJA_Pnp_UsbSerialDevices)//  USB/serial devices?
    {   //  TBD
        PNPLOGS(AJA_DebugSeverity_Warning, "USB/Serial devices requested but unsupported");
    }
    if (mDevices & AJA_Pnp_FireWireDevices) //  FireWire devices?
    {   //  Retired long ago
        PNPLOGS(AJA_DebugSeverity_Warning, "FireWire devices requested but unsupported");
    }
    if (numFails)
        Uninstall();
    return numFails ? AJA_STATUS_FAIL : AJA_STATUS_SUCCESS;
}
    

AJAStatus AJAPnpImpl::Uninstall (void)
{
    mCallback = NULL;
    mRefCon = NULL;
    mDevices = 0;
    if (mPciDevices)
    {
        mPciDevices->Uninstall();
        delete mPciDevices;
        mPciDevices = nullptr;
    }
    return AJA_STATUS_SUCCESS;
}


// static - translate a PCIDeviceNotifierCallback/message to a AJAPnpCallback/message
void PCIDeviceNotifierCallback  (unsigned long message, void *refcon)
{
//  PNPLOGS(AJA_DebugSeverity_Debug, "msg=" << HEX8(message));

    AJAPnpImpl* pnpObj = (AJAPnpImpl*) refcon;
    if (!pnpObj)
    {
        PNPLOGS(AJA_DebugSeverity_Error, "NULL refcon, msg=" << HEX8(message));
        return;
    }
    
    AJAPnpCallback callback = pnpObj->GetCallback();
    if (!callback)
    {
        PNPLOGS(AJA_DebugSeverity_Error, "NULL callback, msg=" << HEX8(message));
        return;
    }

    switch (message)
    {
        case kAJADeviceInitialOpen:
            PNPLOGS(AJA_DebugSeverity_Info, "kAJADeviceInitialOpen, AJA_Pnp_DeviceAdded");
            (callback)(AJA_Pnp_DeviceAdded, pnpObj->GetRefCon());
            break;
            
        case kAJADeviceTerminate:
            PNPLOGS(AJA_DebugSeverity_Info, "kAJADeviceTerminate, AJA_Pnp_DeviceRemoved");
            (callback)(AJA_Pnp_DeviceRemoved, pnpObj->GetRefCon());
            break;
            
        default:
            break;
    }
}