CArcSystem.h

// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcSystem.h  ( GenIV )                                                                                  |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the class that contains system dependent device driver method calls.                 |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: June 07, 2021                                                               |
// |                                                                                                                  |
// |  Copyright 2021 Astronomical Research Cameras, Inc. All rights reserved.                                         |
// +------------------------------------------------------------------------------------------------------------------+
#pragma once
 
#ifdef _WINDOWS
 
    #include <windows.h>
 
#elif defined( __APPLE__ )
 
    #include <IOKit/IOKitLib.h>
    #include <ApplicationServices/ApplicationServices.h>
    #include <IOKit/usb/IOUSBLib.h>
 
#else
 
    #include <sys/mman.h>
    #include <sys/ioctl.h>
 
#endif
 
#include <memory>
 
#include <CArcDeviceDllMain.h>
#include <CArcBase.h>
 
 
 
namespace arc
{
    namespace gen4
    {
 
        // +=========================================================================================================+
        // |  WINDOWS DEFINITIONS                                                                                    |
        // +=========================================================================================================+
        #ifdef _WINDOWS
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Data Types                                                                                         |
            // +-----------------------------------------------------------------------------------------------------+
    
            using arcDevHandle_t =                          HANDLE;
 
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Constants                                                                                          |
            // +-----------------------------------------------------------------------------------------------------+
 
            constexpr auto ARC_CTRL_ID                      = 33460;            
            constexpr auto MAP_FAILED                       = ( uint8_t* )0;    
            constexpr auto ARC_MAX_PATH                     = _MAX_PATH;        
        // +=========================================================================================================+
        // |  MAC OS X DEFINITIONS                                                                                   |
        // +=========================================================================================================+
        #elif defined( __APPLE__ )
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Data Types                                                                                         |
            // +-----------------------------------------------------------------------------------------------------+
 
            using arcDevHandle_t =                          io_connect_t;
 
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Constants                                                                                          |
            // +-----------------------------------------------------------------------------------------------------+
 
            constexpr auto INVALID_HANDLE_VALUE             = IO_OBJECT_NULL;
            constexpr auto MAX_IOCTL_IN_COUNT               = 4;
            constexpr auto MAX_IOCTL_OUT_COUNT              = 2;
            constexpr auto ARC_MAX_PATH                     = 512;
 
            constexpr auto kARC460ClassName                 = "com_arc_gen4_ARC460";
 
            enum
            {
                kArcOpenUserClient,
                kArcCloseUserClient,
                kArcIOCtlUserClient,
                kArcNumberOfMethods // Must be last 
            };
 
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Macros                                                                                             |
            // +-----------------------------------------------------------------------------------------------------+
    
            #define MKCMD( cmd )                            ( 0x41524300 | cmd )
 
 
        // +=========================================================================================================+
        // |  LINUX DEFINITIONS                                                                                      |
        // +=========================================================================================================+
        #else
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Data Types                                                                                         |
            // +-----------------------------------------------------------------------------------------------------+
 
            using arcDevHandle_t =                          int;
            
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Constants                                                                                          |
            // +-----------------------------------------------------------------------------------------------------+
 
            constexpr auto INVALID_HANDLE_VALUE             = int( -1 );        
            constexpr auto ARC_MAX_PATH                     = 512;              
            constexpr auto DEVICE_DIR                       = "/dev/";          
            constexpr auto DEVICE_NAME                      = "Arc460";         
            // +-----------------------------------------------------------------------------------------------------+
            // |  Macros                                                                                             |
            // +-----------------------------------------------------------------------------------------------------+
 
            #define MKCMD( cmd )            ( 0x41524300 | cmd )                
        #endif
 
 
        // +----------------------------------------------------------------------------------------------------------+
        // |  Device Entry Type                                                                                       |
        // +----------------------------------------------------------------------------------------------------------+
        struct arcDev_t
        {
            std::string         sName;
 
            #ifdef __APPLE__
                io_service_t    tService;
            #endif
        };
 
 
        // +-------------------------------------------------------------------------------------------------------+
        // |  CArcSystem Class                                                                                     |
        // +-------------------------------------------------------------------------------------------------------+
 
        class GEN4_CARCDEVICE_API CArcSystem : public CArcBase
        {
            public:
 
                static bool open( arc::gen4::arcDevHandle_t& hDevice, const arcDev_t& tDevice, std::uint64_t uiFlags = 0 ) noexcept;
 
                static bool close( arc::gen4::arcDevHandle_t& hDevice ) noexcept;
 
                static bool write( arc::gen4::arcDevHandle_t hDevice, const std::uint8_t* pBuffer, const std::uint32_t uiBufferSize, std::uint32_t* pBytesWritten = nullptr ) noexcept;
 
                static bool read( arc::gen4::arcDevHandle_t hDevice, std::uint8_t* pBuffer, const std::uint32_t uiBufferSize, std::uint32_t* pBytesRead = nullptr ) noexcept;
 
                static bool ioctl( arc::gen4::arcDevHandle_t hDevice, const std::uint32_t uiCommand, void* pIn, std::uint32_t uiInSize, void* pOut = nullptr, std::uint32_t uiOutSize = 0 ) noexcept;
 
                static void* mmap( arc::gen4::arcDevHandle_t hDevice, const std::int32_t iMapCommand, const std::size_t uiSize ) noexcept;
 
                static bool munmap( arc::gen4::arcDevHandle_t hDevice, const std::int32_t iMapCommand, void* pAddress, const std::size_t uiSize ) noexcept;
        
        protected:
 
                CArcSystem( void ) = default;
 
                ~CArcSystem( void ) = default;
        };
 
 
    }       // end gen4
}           // end arc