device_intf.h

Go to the documentation of this file.

 
#ifndef _ADTF_UCOM_ANT_DEVICE_INTERFACE_INCLUDES_HEADER_
#define _ADTF_UCOM_ANT_DEVICE_INTERFACE_INCLUDES_HEADER_
 
namespace adtf
{
namespace ucom
{
namespace ant
{

class DOEXPORT IDevice : public IObject
{
public:
    ADTF_IID(IDevice, "device.ant.ucom.adtf.iid");
 
public:
    typedef struct
    {
        char           strIdentifier[128];

        uint32_t         ui32Flags;
    } tDeviceInfo;

    typedef enum : uint16_t
    {
        IOCTL_Unknown                 = 0,

        IOCTL_GetDeviceInfo           = 1,

        IOCTL_RegisterHandler         = 2,

        IOCTL_UnregisterHandler       = 3,

        IOCTL_GetDataSize             = 4,

        IOCTL_GetDataTime             = 5,

        IOCTL_Start                   = 6,

        IOCTL_Stop                    = 7,

        IOCTL_Pause                   = 8,

        IOCTL_GetConfig               = 9,

        IOCTL_SetConfig               = 10,

        IOCTL_BusWakeup               = 11,

        IOCTL_BusSleep                = 12,

        IOCTL_User                    = 0x0100
    } tIOCTL_Command;

    typedef struct
    {
        const char* strConfigName;

        const void* pvValue;

        int   szValueSize;
    } tDeviceConfig;

    typedef enum : uint8_t
    {
        DM_Unknown                  = 0,

        DM_Read                     = 1,

        DM_Write                    = 2,

        DM_ReadWrite                = 3
    } tDeviceMode;

    typedef enum
    {
        DF_None                     = 0x00,

        DF_AsyncIO                  = 0x01
    } tDeviceFlags;
 
public:
    virtual tResult Open(const char* strDeviceName, int nMode=0) = 0;

    virtual tResult Close() = 0;

    virtual int Read(void* pvBuffer, int nBufferSize) = 0;

    virtual int Write(const void* pvBuffer, int nBufferSize) = 0;

    virtual int IOCtl(int nCommand, void* pvData=NULL, int nDataSize=0) = 0;
 
protected:
    ~IDevice() = default;
};
 
}//namespace ant

using IDevice = ant::IDevice;
 
}//namespace ucom
}//namespace adtf
 
//*************************************************************************************************
#endif //_ADTF_UCOM_ANT_DEVICE_INTERFACE_INCLUDES_HEADER_