summaryrefslogtreecommitdiff
path: root/general/echo/umdf/Queue.h
blob: c4b28c976cf6f31ded982280261b46b366ec3d91 (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
204
205
206
207
208
209
210
211
212
213
/*++

Copyright (c) Microsoft Corporation, All Rights Reserved

Module Name:

    queue.h

Abstract:

    This file defines the queue callback interface.

Environment:

    Windows User-Mode Driver Framework (WUDF)

--*/

#pragma once

// Set max write length for testing
#define MAX_WRITE_LENGTH (40*1024)

// Set timer period in ms
#define TIMER_PERIOD     100

//
// Queue Callback Object.
//

class CMyQueue : 
    public IQueueCallbackDeviceIoControl,
    public IQueueCallbackRead,
    public IQueueCallbackWrite,
    public CUnknown
{
    PVOID           m_Buffer;           // Current buffer
    ULONG           m_Length;           // Length of the buffer
    SIZE_T          m_XferredBytes;     // Amount of bytes transferred for the current request
    IWDFIoRequest2  *m_CurrentRequest;  // Current request
    CRITICAL_SECTION m_Crit;            // Lock to protect updates to CMyQueue fields
    BOOLEAN         m_ExitThread;       // If TRUE Terminate thread.
    BOOLEAN         m_InitCritSec;      // If TRUE lock initialized

    IWDFIoQueue     *m_FxQueue;

    CMyQueue() : 
        m_Buffer(NULL), 
        m_Length (0),
        m_CurrentRequest(NULL),
        m_XferredBytes(0),
        m_ExitThread(FALSE),
        m_InitCritSec(FALSE),
        m_FxQueue(NULL)
    {
    }

    virtual ~CMyQueue();

    _Acquires_lock_(this->m_Crit)
    __inline 
    void
    Lock(
        )
    {
        ::EnterCriticalSection(&m_Crit);
    }

    _Releases_lock_(this->m_Crit)
    __inline 
    void
    Unlock(
        )
    {
        ::LeaveCriticalSection(&m_Crit);
    }

    HRESULT
    Initialize(
        _In_ IWDFDevice *FxDevice
        );

public:

    //
    // Completion thread routine.
    //

    static DWORD CompletionThread( PVOID ThreadParameter);

    //
    // Sets the flag to make thread exit
    //
    
    void
    SetExitThread()
    {
        m_ExitThread = TRUE;
    }

    static 
    HRESULT 
    CreateInstance( 
        _In_ IWDFDevice *FxDevice,
        _Out_ PCMyQueue *Queue
        );

    HRESULT
    Configure(
        VOID
        )
    {
        return S_OK;
    }

   
    IQueueCallbackDeviceIoControl *
    QueryIQueueCallbackDeviceIoControl(
        VOID
        )
    {
        AddRef();
        return static_cast<IQueueCallbackDeviceIoControl *>(this);
    }
    
    IQueueCallbackRead *
    QueryIQueueCallbackRead(
        VOID
        )
    {
        AddRef();
        return static_cast<IQueueCallbackRead *>(this);
    }

    IQueueCallbackWrite *
    QueryIQueueCallbackWrite(
        VOID
        )
    {
        AddRef();
        return static_cast<IQueueCallbackWrite *>(this);
    }

    //
    // IUnknown
    //

    virtual
    ULONG 
    STDMETHODCALLTYPE
    AddRef(
        VOID
        ) {
        return CUnknown::AddRef();
    }
    
    _At_(this, __drv_freesMem(object))
    virtual
    ULONG
    STDMETHODCALLTYPE
    Release(
        VOID
        ) {
        return CUnknown::Release();
    }

    virtual
    HRESULT
    STDMETHODCALLTYPE
    QueryInterface(
        _In_ REFIID InterfaceId, 
        _Out_ PVOID *Object
        );

    //
    // Wdf Callbacks
    //
    
    // IQueueCallbackDeviceIoControl
    //
    virtual
    VOID
    STDMETHODCALLTYPE
    OnDeviceIoControl( 
        _In_ IWDFIoQueue *pWdfQueue,
        _In_ IWDFIoRequest *pWdfRequest,
        _In_ ULONG ControlCode,
        _In_ SIZE_T InputBufferSizeInBytes,
        _In_ SIZE_T OutputBufferSizeInBytes
        );

    // IQueueCallbackWrite
    //
    virtual
    VOID
    STDMETHODCALLTYPE
    OnWrite( 
        _In_ IWDFIoQueue *pWdfQueue,
        _In_ IWDFIoRequest *pWdfRequest,
        _In_ SIZE_T NumOfBytesToWrite
        );

    // IQueueCallbackRead
    //
    virtual
    VOID
    STDMETHODCALLTYPE
    OnRead( 
        _In_ IWDFIoQueue *pWdfQueue,
        _In_ IWDFIoRequest *pWdfRequest,
        _In_ SIZE_T NumOfBytesToRead
        );
};