CArcSystem.h

Go to the documentation of this file.

// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcSystem.h                                                                                             |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the standard ARC operating system class and definitions.                             |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: ?                                                                           |
// |                                                                                                                  |
// |  Copyright 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>
 
#elif defined( __linux )
 
    #include <sys/mman.h>
    #include <sys/ioctl.h>
 
#endif
 
#include <memory>
 
#include <CArcDeviceDllMain.h>
#include <CArcBase.h>
 
 
 
namespace arc
{
    namespace gen3
    {
 
        // +=========================================================================================================+
        // |  WINDOWS DEFINITIONS                                                                                    |
        // +=========================================================================================================+
        #ifdef _WINDOWS
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Data Types                                                                                         |
            // +-----------------------------------------------------------------------------------------------------+
            using arcDevHandle_t = HANDLE;
 
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Constants                                                                                          |
            // +-----------------------------------------------------------------------------------------------------+
            constexpr auto ARC_CTRL_ID      = 33000;    // Used as part of DeviceIoCtrl
            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;
 
            enum
            {
                kArcOpenUserClient,
                kArcCloseUserClient,
                kArcIOCtlUserClient,
                kArcNumberOfMethods // Must be last 
            };
 
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Macros                                                                                             |
            // +-----------------------------------------------------------------------------------------------------+
            auto constexpr MKCMD( std::uint32_t uiCmd ) { return ( 0x41524300 | uiCmd ); }
 
 
    // +=========================================================================================================+
    // |  LINUX DEFINITIONS                                                                                      |
    // +=========================================================================================================+
        #else
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Data Types                                                                                         |
            // +-----------------------------------------------------------------------------------------------------+
            using arcDevHandle_t = int;
 
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Constants                                                                                          |
            // +-----------------------------------------------------------------------------------------------------+
            constexpr auto INVALID_HANDLE_VALUE     = int( -1 );
            constexpr auto ARC_MAX_PATH             = 512;
 
 
            // +-----------------------------------------------------------------------------------------------------+
            // |  Macros                                                                                             |
            // +-----------------------------------------------------------------------------------------------------+
            auto constexpr MKCMD( std::uint32_t uiCmd ) { return ( 0x41524300 | uiCmd ); }
 
        #endif
 
 
        // +----------------------------------------------------------------------------------------------------------+
        // |  Device Entry Type                                                                                       |
        // +----------------------------------------------------------------------------------------------------------+
        typedef struct ArcDevType
        {
            std::string         sName;          
            #ifdef __APPLE__
                io_service_t    tService;       
            #endif
        } arcDev_t;
 
 
        // +-------------------------------------------------------------------------------------------------------+
        // |  CArcSystem Class                                                                                     |
        // +-------------------------------------------------------------------------------------------------------+
 
        class GEN3_CARCDEVICE_API CArcSystem : public CArcBase
        {
            public:
 
                static bool open( arc::gen3::arcDevHandle_t& hDevice, const arcDev_t& tDevice, const std::uint64_t uiFlags = 0 ) noexcept;
 
                static bool close( arc::gen3::arcDevHandle_t& hDevice ) noexcept;
 
                static bool ioctl( const arcDevHandle_t hDevice, const std::uint32_t uiCommand, void* pIn, const std::uint32_t uiInSize, void* pOut = nullptr, const std::uint32_t uiOutSize = 0 ) noexcept;
 
                static void* mmap( const arcDevHandle_t hDevice, const std::int32_t iMapCommand, const std::uint32_t uiSize ) noexcept;
 
                static bool munmap( const arcDevHandle_t hDevice, const std::int32_t iMapCommand, void* pAddress, const std::size_t uiSize ) noexcept;
 
            protected:
 
                CArcSystem( void ) = default;
 
                ~CArcSystem( void ) = default;
        };
 
 
    }       // end gen3
}           // end arc