summaryrefslogtreecommitdiffstats
path: root/LibOVR/Src/OVR_HIDDeviceImpl.h
blob: f9d0922225632a2f418c7b3773f7a65843be67f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/************************************************************************************

Filename    :   OVR_HIDDeviceImpl.h
Content     :   Implementation of HIDDevice.
Created     :   March 7, 2013
Authors     :   Lee Cooper

Copyright   :   Copyright 2013 Oculus VR, Inc. All Rights reserved.

Use of this software is subject to the terms of the Oculus license
agreement provided at the time of installation or download, or which
otherwise accompanies this software in either electronic or hard copy form.

*************************************************************************************/

#ifndef OVR_HIDDeviceImpl_h
#define OVR_HIDDeviceImpl_h

//#include "OVR_Device.h"
#include "OVR_DeviceImpl.h"

namespace OVR {

//-------------------------------------------------------------------------------------
class HIDDeviceCreateDesc : public DeviceCreateDesc
{
public:
    HIDDeviceCreateDesc(DeviceFactory* factory, DeviceType type, const HIDDeviceDesc& hidDesc)
        : DeviceCreateDesc(factory, type), HIDDesc(hidDesc) { }
    HIDDeviceCreateDesc(const HIDDeviceCreateDesc& other)
        : DeviceCreateDesc(other.pFactory, other.Type), HIDDesc(other.HIDDesc) { }

    virtual bool MatchDevice(const String& path)
    {
        // should it be case insensitive?
        return HIDDesc.Path.CompareNoCase(path) == 0;
    }

    HIDDeviceDesc HIDDesc;
};

//-------------------------------------------------------------------------------------
template<class B>
class HIDDeviceImpl : public DeviceImpl<B>, public HIDDevice::HIDHandler
{
public:
    HIDDeviceImpl(HIDDeviceCreateDesc* createDesc, DeviceBase* parent)
     :  DeviceImpl<B>(createDesc, parent)        
    {
    }

    // HIDDevice::Handler interface.
    virtual void OnDeviceMessage(HIDDeviceMessageType messageType)
    {
        MessageType handlerMessageType;
        switch (messageType) {
            case HIDDeviceMessage_DeviceAdded:
                handlerMessageType = Message_DeviceAdded;
                break;

            case HIDDeviceMessage_DeviceRemoved:
                handlerMessageType = Message_DeviceRemoved;
                break;

            default: OVR_ASSERT(0); return;
        }

        // Do device notification.
        {
            Lock::Locker scopeLock(this->HandlerRef.GetLock());

            if (this->HandlerRef.GetHandler())
            {
                MessageDeviceStatus status(handlerMessageType, this, OVR::DeviceHandle(this->pCreateDesc));
                this->HandlerRef.GetHandler()->OnMessage(status);
            }
        }

        // Do device manager notification.
        DeviceManagerImpl*   manager = this->GetManagerImpl();
        switch (handlerMessageType) {
            case Message_DeviceAdded:
                manager->CallOnDeviceAdded(this->pCreateDesc);
                break;
                
            case Message_DeviceRemoved:
                manager->CallOnDeviceRemoved(this->pCreateDesc);
                break;
                
            default:;
        }
    }

    virtual bool Initialize(DeviceBase* parent)
    {
        // Open HID device.
        HIDDeviceDesc&		hidDesc = *getHIDDesc();
        HIDDeviceManager*   pManager = GetHIDDeviceManager();


        HIDDevice* device = pManager->Open(hidDesc.Path);
        if (!device)
        {
            return false;
        }

        InternalDevice = *device;
        InternalDevice->SetHandler(this);

        // AddRef() to parent, forcing chain to stay alive.
        DeviceImpl<B>::pParent = parent;

        return true;
    }

    virtual void Shutdown()
    {   
        InternalDevice->SetHandler(NULL);

        // Remove the handler, if any.
        this->HandlerRef.SetHandler(0);

        DeviceImpl<B>::pParent.Clear();
    }

    DeviceManager* GetDeviceManager()
    {
        return DeviceImpl<B>::pCreateDesc->GetManagerImpl();
    }

    HIDDeviceManager* GetHIDDeviceManager()
    {
        return DeviceImpl<B>::pCreateDesc->GetManagerImpl()->GetHIDDeviceManager();
    }


    struct WriteData
    {
        enum { BufferSize = 64 };
        UByte Buffer[64];
        UPInt Size;

        WriteData(UByte* data, UPInt size) : Size(size)
        {
            OVR_ASSERT(size <= BufferSize);
            memcpy(Buffer, data, size);
        }
    };

    bool SetFeatureReport(UByte* data, UInt32 length)
    { 
        WriteData writeData(data, length);

        // Push call with wait.
        bool result = false;

		ThreadCommandQueue* pQueue = this->GetManagerImpl()->GetThreadQueue();
        if (!pQueue->PushCallAndWaitResult(this, &HIDDeviceImpl::setFeatureReport, &result, writeData))
            return false;

        return result;
    }

    bool setFeatureReport(const WriteData& data)
    {
        return InternalDevice->SetFeatureReport((UByte*) data.Buffer, (UInt32) data.Size);
    }

    bool GetFeatureReport(UByte* data, UInt32 length)
    { 
        bool result = false;

		ThreadCommandQueue* pQueue = this->GetManagerImpl()->GetThreadQueue();
        if (!pQueue->PushCallAndWaitResult(this, &HIDDeviceImpl::getFeatureReport, &result, data, length))
            return false;

        return result;
    }

    bool getFeatureReport(UByte* data, UInt32 length)
    {
        return InternalDevice->GetFeatureReport(data, length);
    }

protected:
    HIDDevice* GetInternalDevice() const
    {
        return InternalDevice;
    }

    HIDDeviceDesc* getHIDDesc() const
    { return &getCreateDesc()->HIDDesc; }

    HIDDeviceCreateDesc* getCreateDesc() const
    { return (HIDDeviceCreateDesc*) &(*DeviceImpl<B>::pCreateDesc); }

private:
    Ptr<HIDDevice> InternalDevice;
};

} // namespace OVR

#endif