summaryrefslogtreecommitdiff
path: root/usb/kmdf_fx2/driver/osrusbfx2.man
blob: 176dfc896e07b8ffbcda25a1c426efbb4b3f218b (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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<?xml version='1.0' encoding='utf-8' standalone='yes'?>
<instrumentationManifest
    xmlns="http://schemas.microsoft.com/win/2004/08/events"
    xmlns:win="http://manifests.microsoft.com/win/2004/08/windows/events"
    xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://schemas.microsoft.com/win/2004/08/events eventman.xsd"
    >
  <instrumentation>
    <events>
      <provider
          guid="{69cd60e3-430f-4da4-b1b3-e3bdaf945875}"
          messageFileName="%Systemroot%\System32\drivers\osrusbfx2.SYS"
          name="OSRUSBFX2"
          resourceFileName="%SystemRoot%\System32\drivers\osrusbfx2.SYS"
          symbol="OSRUSBFX2_PROVIDER"
          >
        <channels>
          <channel
              chid="Analytic"
              enabled="false"
              name="OsrUsbfx2/Analytic"
              symbol="OSRUSBFX2_ANALYTIC"
              type="Analytic"
              />
          <channel
              chid="operational"
              enabled="true"
              isolation="System"
              message="$(string.OSRUSBFX2_OPERATIONAL.Name)"
              name="OsrUsbFx2/Operational"
              symbol="OSRUSBFX2_OPERATIONAL"
              type="Operational"
              />
        </channels>
        <keywords>
          <keyword
              mask="0x0000000000000010"
              message="$(string.OSRUSBFX2_DEVICE_INFO_KEYWORD.message)"
              name="deviceinfo"
              symbol="OSRUSBFX2_DEVICE_INFO_KEYWORD"
              />
          <keyword
              mask="0x0000000000000040"
              message="$(string.OSRUSBFX2_READ_WRITE_KEYWORD.message)"
              name="readwrite"
              symbol="OSRUSBFX2_READ_WRITE_KEYWORD"
              />
        </keywords>
        <opcodes>
          <!-- Defining our own custom opcode instead of using standard opcodes defined by winmeta.xml -->
          <opcode
              name="add"
              symbol="OSRUSBFX2_DEVICE_ADD"
              value="10"
              />
          <opcode
              name="fail"
              symbol="OSRUSBFX2_FAIL"
              value="11"
              />
        </opcodes>
        <tasks>
          <!-- Support for XP and W2K3 : MC.exe will create a MOF file -->
          <!--  Requires an associated eventGUID attribute for each task that is defined  -->
          <!--  For the MOF file : -->
          <!--  Semantically, the event GUID represents a set of logical events that are logged by the provider. -->
          <task
              eventGUID="{872c3c43-6899-4f1d-89b8-51a82f6db657}"
              name="deviceInit"
              symbol="OSRUSBFX2_DEVICE_INIT"
              value="1"
              />
          <task
              eventGUID="{872c3c45-6899-4f1d-89b8-51a82f6db657}"
              name="read"
              symbol="OSRUSBFX2_READ"
              value="2"
              />
          <task
              eventGUID="{872c3c46-6899-4f1d-89b8-51a82f6db657}"
              name="write"
              symbol="OSRUSBFX2_WRITE"
              value="3"
              />
        </tasks>
        <templates>
          <template tid="tid_DeviceStatus">
              <data
                  inType="win:UnicodeString"
                  name="FriendlyName"
                  outType="xs:string"
                  />
              <data
                  inType="win:UnicodeString"
                  name="Location"
                  outType="xs:string"
                  />
              <data
                  inType="win:UInt32"
                  name="NTStatus"
                  outType="xs:HexInt32"
                  />
          </template>
          <template tid="tid_ReadWrite">
            <data
                inType="win:Pointer"
                name="Device"
                outType="win:HexInt64"
                />
            <data
                inType="win:UInt32"
                name="Length"
                outType="xs:unsignedInt"
                />
          </template>
          <template tid="tid_ReadWriteFail">
            <data
                inType="win:Pointer"
                name="Device"
                outType="win:HexInt64"
                />
            <data
                inType="win:UInt32"
                name="NTStatus"
                outType="xs:HexInt32"
                />
          </template>
          <template tid="tid_ReadWriteCompletion">
            <data
                inType="win:Pointer"
                name="Device"
                outType="win:HexInt64"
                />
            <data
                inType="win:UInt32"
                name="Length"
                outType="xs:unsignedInt"
                />
            <data
                inType="win:UInt32"
                name="NTStatus"
                outType="xs:HexInt32"
                />
            <data
                inType="win:UInt32"
                name="UsbdStatus"
                outType="xs:unsignedInt"
                />
          </template>
        </templates>
        <events>
           <event
              channel="Analytic"
              keywords="readwrite"
              message="$(string.ReadStart.EventMessage)"
              level="win:Informational"
              opcode="win:Start"
              symbol="ReadStart"
              task="read"
              template="tid_ReadWrite"
              value="1"
              />
           <event
              channel="Analytic"
              keywords="readwrite"
              message="$(string.ReadStop.EventMessage)"
              level="win:Informational"
              opcode="win:Stop"
              symbol="ReadStop"
              task="read"
              template="tid_ReadWriteCompletion"
              value="2"
              />
           <event
              channel="Analytic"
              keywords="readwrite"
              message="$(string.ReadFail.EventMessage)"
              level="win:Error"
              opcode="fail"
              symbol="ReadFail"
              task="read"
              template="tid_ReadWriteFail"
              value="3"
              />
           <event
              channel="Analytic"
              keywords="readwrite"
              message="$(string.WriteStart.EventMessage)"
              level="win:Informational"
              opcode="win:Start"
              symbol="WriteStart"
              task="write"
              template="tid_ReadWrite"
              value="4"
              />
           <event
              channel="Analytic"
              keywords="readwrite"
              message="$(string.WriteStop.EventMessage)"
              level="win:Informational"
              opcode="win:Stop"
              symbol="WriteStop"
              task="write"
              template="tid_ReadWriteCompletion"
              value="5"
              />
           <event
              channel="Analytic"
              keywords="readwrite"
              message="$(string.WriteFail.EventMessage)"
              level="win:Error"
              opcode="fail"
              symbol="WriteFail"
              task="write"
              template="tid_ReadWriteFail"
              value="6"
              />
           <event
              channel="operational"
              keywords="deviceinfo"
              level="win:Error"
              message="$(string.DeviceFailAdd.EventMessage)"
              opcode="add"
              symbol="FailAddDevice"
              task="deviceInit"
              template="tid_DeviceStatus"
              value="100"
              />
           <event
              channel="operational"
              keywords="deviceinfo"
              message="$(string.DeviceReenumerated.EventMessage)"
              opcode="win:Start"
              symbol="DeviceReenumerated"
              task="deviceInit"
              template="tid_DeviceStatus"
              value="101"
              />
            <event
              channel="operational"
              keywords="deviceinfo"
              level="win:Error"
              message="$(string.SelectConfigFailure.Message)"
              opcode="fail"
              symbol="SelectConfigFailure"
              task="deviceInit"
              template="tid_DeviceStatus"
              value="102"
              />
        </events>
      </provider>
    </events>
  </instrumentation>
  <localization xmlns="http://schemas.microsoft.com/win/2004/08/events">
    <resources culture="en-US">
      <stringTable>
        <string
            id="OSRUSBFX2_DEVICE_INFO_KEYWORD.message"
            value="Device events: fail to load, reenumerate"
            />
        <string
            id="OSRUSBFX2_READ_WRITE_KEYWORD.message"
            value="Read, Write events"
            />
        <string
            id="OSRUSBFX2_OPERATIONAL.Name"
            value="Operational channel eventlog"
            />
        <string
            id="ReadStart.EventMessage"
            value="Read.  Device = %1, Length = %2"
            />
        <string
            id="ReadStop.EventMessage"
            value="Read complete.  Device = %1, Length = %2, Status = %3, UsbStatus = %4"
            />
        <string
            id="ReadFail.EventMessage"
            value="Read error.  Device = %1, Status = %2"
            />
        <string
            id="WriteStart.EventMessage"
            value="Write.  Device = %1, Length = %2"
            />
        <string
            id="WriteStop.EventMessage"
            value="Write complete.  Device = %1, Length = %2, Status = %3, UsbStatus = %4"
            />
        <string
            id="WriteFail.EventMessage"
            value="Write error.  Device = %1, Status = %2"
            />
        <string
            id="DeviceReenumerated.EventMessage"
            value="Device %1 (location %2) was reenumerated"
            />
        <string
            id="DeviceFailAdd.EventMessage"
            value="Fail to add device %1 (location %2), status %3"
            />
        <string
            id="SelectConfigFailure.Message"
            value="This error occurs when an OSR USB Fx2 board is attached to a USB 1.1 port on a machine running Windows Vista.  This error occurs because the OSR USB Fx2 board's Interrupt end-point descriptor does not conform to the USB specification.  Windows Vista detects this and returns an error.  You should plug the device into a USB 2.0 (or higher) port."
            />
      </stringTable>
    </resources>
  </localization>
</instrumentationManifest>