summaryrefslogtreecommitdiffstats
path: root/private/os2/inc/iovector.h
blob: 6af7da38b1918212af9748c1e038f6af611393f2 (plain) (blame)
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528

/*  Type    -  OPEN -  SET  - QUERY - CLOSE -  DUP_ -  READ - WRITE
                      STATE   TYPE            HANDLE
   -----------------------------------------------------------------
    Nul     -   X   -   1   -  DEV  -  DEV  -  DEV  -   X   -   X
    Con     -   X   -   1   -  DEV  -  DEV  -  DEV  -   X   -  SCR
    Com     -   X   -   1   -  DEV  -  DEV  -  DEV  -   2   -   2
    Lpt     -   X   -   1   -  DEV  -  DEV  -  DEV  -   2   -   2
    Kbd     -   X   -   1   -  DEV  -   X   -   X   -   X   -  NUL
    Mouse   -   X   -   1   -  DEV  -   X   -   X   -   2   -   2
    Clock   -   X   -   1   -  DEV  -  DEV  -  DEV  -   2   -   2
    Screen  -   X   -   1   -  DEV  -  DEV  -  DEV  -  NUL  -   X
    Pointer -   X   -   1   -  DEV  -  DEV  -  DEV  -   2   -   2
    File    -   X   -   X   -   X   -   X   -   X   -   X   -   X
    Pipe    -  FIL  -  FIL  -  FIL  -  FIL  -  FIL  -  FIL  -   X
    Device  -  FIL  -   1   -   X   -  FIL  -  FIL  -  FIL  -  FIL
    Remote  -       -   X   -   X   -   X   -   X   -   X   -   X
    Monitor -       -   3   -   3   -   3   -   3   -   2   -   2

    other:  1 - NonFile,  2 - Tmp,  3 - NoSupp
*/


APIRET
NulOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
ConOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
ComOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
LptOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
KbdOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
MouseOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
ClockOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
ScreenOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
PointerOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
FileOpenRoutine(
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

APIRET
NonFileSetHandleStateRoutine(
    IN PFILE_HANDLE hFileRecord,
    IN ULONG OpenMode
    );

APIRET
FileSetHandleStateRoutine(
    IN PFILE_HANDLE hFileRecord,
    IN ULONG OpenMode
    );

APIRET
RemoteSetHandleStateRoutine(
    IN PFILE_HANDLE hFileRecord,
    IN ULONG OpenMode
    );

APIRET
NoSuppSetHandleStateRoutine(
    IN PFILE_HANDLE hFileRecord,
    IN ULONG OpenMode
    );

APIRET
FileQueryHTypeRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PULONG HandleType,
    OUT PULONG DeviceFlags
    );

APIRET
DeviceQueryHTypeRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PULONG HandleType,
    OUT PULONG DeviceFlags
    );

APIRET
RemoteQueryHTypeRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PULONG HandleType,
    OUT PULONG DeviceFlags
    );

APIRET
NoSuppQueryHTypeRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PULONG HandleType,
    OUT PULONG DeviceFlags
    );

APIRET
KbdCloseRoutine(
    IN PFILE_HANDLE hFileRecord
    );

APIRET
MouseCloseRoutine(
    IN PFILE_HANDLE hFileRecord
    );

APIRET
FileCloseRoutine(
    IN PFILE_HANDLE hFileRecord
    );

APIRET
DeviceCloseRoutine(
    IN PFILE_HANDLE hFileRecord
    );

APIRET
RemoteCloseRoutine(
    IN PFILE_HANDLE hFileRecord
    );

APIRET
NoSuppCloseRoutine(
    IN PFILE_HANDLE hFileRecord
    );

APIRET
ComCloseRoutine(
    IN PFILE_HANDLE hFileRecord
    );

APIRET
ComDupHandleRoutine(
    IN PFILE_HANDLE hOldFileRecord,
    IN PFILE_HANDLE hNewFileRecord
    );

APIRET
KbdDupHandleRoutine(
    IN PFILE_HANDLE hOldFileRecord,
    IN PFILE_HANDLE hNewFileRecord
    );

APIRET
MouseDupHandleRoutine(
    IN PFILE_HANDLE hOldFileRecord,
    IN PFILE_HANDLE hNewFileRecord
    );

APIRET
FileDupHandleRoutine(
    IN PFILE_HANDLE hOldFileRecord,
    IN PFILE_HANDLE hNewFileRecord
    );

APIRET
DeviceDupHandleRoutine(
    IN PFILE_HANDLE hOldFileRecord,
    IN PFILE_HANDLE hNewFileRecord
    );

APIRET
RemoteDupHandleRoutine(
    IN PFILE_HANDLE hOldFileRecord,
    IN PFILE_HANDLE hNewFileRecord
    );

APIRET
NoSuppDupHandleRoutine(
    IN PFILE_HANDLE hOldFileRecord,
    IN PFILE_HANDLE hNewFileRecord
    );

APIRET
NulReadRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesRead
    );

APIRET
ConReadRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesRead
    );

APIRET
KbdReadRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesRead
    );

APIRET
FileReadRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesRead
    );

APIRET
RemoteReadRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesRead
    );

APIRET
TmpReadRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesRead
    );

APIRET
ComReadRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesRead
    );

APIRET
NulWriteRoutine(
    IN PFILE_HANDLE hFileRecord,
    IN PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesWritten
    );

APIRET
ScreenWriteRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesWritten
    );

APIRET
FileWriteRoutine(
    IN PFILE_HANDLE hFileRecord,
    IN PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesWritten
    );

APIRET
RemoteWriteRoutine(
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesWritten
    );

APIRET
TmpWriteRoutine(
    IN PFILE_HANDLE hFileRecord,
    IN PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesWritten
    );

APIRET
ComWriteRoutine(
    IN PFILE_HANDLE hFileRecord,
    IN PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesWritten
    );

//
// This function is called to open an object.
//

typedef
APIRET
(*POS2OPEN_ROUTINE) (
    OUT PHANDLE FileHandle,
    IN ULONG DesiredAccess,
    IN POBJECT_ATTRIBUTES ObjectAttributes,
    IN PIO_STATUS_BLOCK IoStatus,
    IN ULONG CreateSize,
    OUT PULONG ActionTaken,
    IN ULONG FileAttributes,
    IN ULONG ShareAccess,
    IN ULONG CreateDisposition,
    IN ULONG CreateOptions,
    IN OUT PEAOP2 ExtendedFileAttr OPTIONAL,
    OUT PUSHORT FileType,
    OUT PUSHORT DeviceAttribute
    );

//
// This function is called to set the state of a handle (inherited,
// writethrough, etc)
//

typedef
APIRET
(*POS2SET_HANDLE_STATE_ROUTINE) (
    IN PFILE_HANDLE hFileRecord,
    IN ULONG OpenMode
    );

//
// This function is called to query the type of a handle (device, file, etc)
//

typedef
APIRET
(*POS2QUERY_HANDLE_TYPE_ROUTINE) (
    IN PFILE_HANDLE hFileRecord,
    OUT PULONG HandleType,
    OUT PULONG DeviceFlags
    );

//
// This function is called to close a handle.  it doesn't free the handle.
//

typedef
APIRET
(*POS2CLOSE_ROUTINE) (
    IN PFILE_HANDLE hFileRecord
    );

//
// This function is called to do a handle duplicate operation
//

typedef
APIRET
(*POS2DUP_HANDLE_ROUTINE) (
    IN PFILE_HANDLE hOldFileRecord,
    IN PFILE_HANDLE hNewFileRecord
    );

//
// This function is called to do a read operation
//

typedef
APIRET
(*POS2READ_ROUTINE) (
    IN PFILE_HANDLE hFileRecord,
    OUT PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesRead
    );

//
// This function is called to do a write operation
//

typedef
APIRET
(*POS2WRITE_ROUTINE) (
    IN PFILE_HANDLE hFileRecord,
    IN PVOID Buffer,
    IN ULONG Length,
    OUT PULONG BytesWritten
    );

typedef struct _OS2IO_VECTORS {
    POS2OPEN_ROUTINE OpenRoutine;
    POS2SET_HANDLE_STATE_ROUTINE SetHandleStateRoutine;
    POS2QUERY_HANDLE_TYPE_ROUTINE QueryHandleTypeRoutine;
    POS2CLOSE_ROUTINE CloseRoutine;
    POS2DUP_HANDLE_ROUTINE DupHandleRoutine;
    POS2READ_ROUTINE ReadRoutine;
    POS2WRITE_ROUTINE WriteRoutine;
} OS2IO_VECTORS, *POS2IO_VECTORS;