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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** PIMA Class */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* COMPONENT DEFINITION RELEASE */
/* */
/* ux_host_class_pima.h PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file contains all the header and extern functions used by the */
/* USBX PIMA class. */
/* */
/**************************************************************************/
#ifndef UX_HOST_CLASS_PIMA_H
#define UX_HOST_CLASS_PIMA_H
/* Determine if a C++ compiler is being used. If so, ensure that standard
C is used to process the API information. */
#ifdef __cplusplus
/* Yes, C++ compiler is present. Use standard C. */
extern "C" {
#endif
/* Internal option: enable the basic USBX error checking. This define is typically used
while debugging application. */
#if defined(UX_ENABLE_ERROR_CHECKING) && !defined(UX_HOST_CLASS_PIMA_ENABLE_ERROR_CHECKING)
#define UX_HOST_CLASS_PIMA_ENABLE_ERROR_CHECKING
#endif
/* Define PIMA Class constants. */
#define UX_HOST_CLASS_PIMA_CLASS_TRANSFER_TIMEOUT 300000
#define UX_HOST_CLASS_PIMA_CLASS 0x06
#define UX_HOST_CLASS_PIMA_SUBCLASS 0X01
#define UX_HOST_CLASS_PIMA_PROTOCOL 0X01
#define UX_HOST_CLASS_PIMA_CS_INTERFACE 0x24
#define UX_HOST_CLASS_PIMA_MAGIC_NUMBER 0x50494D41
#define UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH 256
#define UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH 256
#define UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH 64
#define UX_HOST_CLASS_PIMA_MAX_STORAGE_IDS 64
#if (UX_OVERFLOW_CHECK_ADD_ULONG(UX_HOST_CLASS_PIMA_MAX_STORAGE_IDS, 1) || \
UX_OVERFLOW_CHECK_MULC_ULONG(UX_HOST_CLASS_PIMA_MAX_STORAGE_IDS + 1, 4))
#error UX_HOST_CLASS_PIMA_MAX_STORAGE_IDS too large, please decrease
#endif
#define UX_HOST_CLASS_PIMA_STORAGE_IDS_LENGTH ((UX_HOST_CLASS_PIMA_MAX_STORAGE_IDS + 1) * 4)
#define UX_HOST_CLASS_PIMA_MAX_PAYLOAD 1024
#define UX_HOST_CLASS_PIMA_ZLP_NONE 0
#define UX_HOST_CLASS_PIMA_ZLP_IN 1
#define UX_HOST_CLASS_PIMA_ZLP_OUT 2
/* Define PIMA data phases. */
#define UX_HOST_CLASS_PIMA_DATA_PHASE_NONE 0
#define UX_HOST_CLASS_PIMA_DATA_PHASE_IN 1
#define UX_HOST_CLASS_PIMA_DATA_PHASE_OUT 2
/* Define PIMA session states. */
#define UX_HOST_CLASS_PIMA_SESSION_STATE_CLOSED 0
#define UX_HOST_CLASS_PIMA_SESSION_STATE_OPENED 1
/* Define PIMA object and thumb states. */
#define UX_HOST_CLASS_PIMA_OBJECT_STATE_CLOSED 0
#define UX_HOST_CLASS_PIMA_OBJECT_STATE_OPENED 1
/* Define PIMA object and thumb transfer status. */
#define UX_HOST_CLASS_PIMA_OBJECT_TRANSFER_STATUS_INACTIVE 0
#define UX_HOST_CLASS_PIMA_OBJECT_TRANSFER_STATUS_ACTIVE 1
#define UX_HOST_CLASS_PIMA_OBJECT_TRANSFER_STATUS_COMPLETED 2
#define UX_HOST_CLASS_PIMA_OBJECT_TRANSFER_STATUS_ABORTED 3
/* Define PIMA Cancel Request equivalences. */
#define UX_HOST_CLASS_PIMA_REQUEST_CANCEL_COMMAND 0x64
#define UX_HOST_CLASS_PIMA_REQUEST_CANCEL_DATA_LENGTH 0x06
#define UX_HOST_CLASS_PIMA_REQUEST_CANCEL_CODE 0x04001
#define UX_HOST_CLASS_PIMA_REQUEST_CANCEL_OFFSET_CODE 0x00
#define UX_HOST_CLASS_PIMA_REQUEST_CANCEL_OFFSET_TRANSACTION_ID 0x02
/* Define PIMA Reset Request equivalences. */
#define UX_HOST_CLASS_PIMA_REQUEST_RESET_DEVICE 0x66
/* Define PIMA Status Request equivalences. */
#define UX_HOST_CLASS_PIMA_REQUEST_STATUS_COMMAND 0x67
#define UX_HOST_CLASS_PIMA_REQUEST_STATUS_DATA_LENGTH 0x40
#define UX_HOST_CLASS_PIMA_REQUEST_STATUS_OFFSET_LENGTH 0x00
#define UX_HOST_CLASS_PIMA_REQUEST_STATUS_OFFSET_CODE 0x02
#define UX_HOST_CLASS_PIMA_REQUEST_STATUS_COMMAND_COUNTER 16
#define UX_HOST_CLASS_PIMA_REQUEST_STATUS_COMMAND_DELAY 1000
/* Define PIMA command container type. */
#define UX_HOST_CLASS_PIMA_CT_UNDEFINED 0x00
#define UX_HOST_CLASS_PIMA_CT_COMMAND_BLOCK 0x01
#define UX_HOST_CLASS_PIMA_CT_DATA_BLOCK 0x02
#define UX_HOST_CLASS_PIMA_CT_RESPONSE_BLOCK 0x03
#define UX_HOST_CLASS_PIMA_CT_EVENT_BLOCK 0x04
/* Define PIMA Extended Event Data Request payload Format. */
#define UX_HOST_CLASS_PIMA_EEDR_EVENT_CODE 0x00
#define UX_HOST_CLASS_PIMA_EEDR_TRANSACTION_ID 0x02
#define UX_HOST_CLASS_PIMA_EEDR_NUMBER_PARAMETERS 0x06
#define UX_HOST_CLASS_PIMA_EEDR_SIZE_PARAMETER 0x08
/* Define PIMA Device Status Data Format. */
#define UX_HOST_CLASS_PIMA_DSD_LENGTH 0x00
#define UX_HOST_CLASS_PIMA_DSD_CODE 0x02
#define UX_HOST_CLASS_PIMA_DSD_PARAMETER 0x04
/* Define PIMA Command Header Format. */
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_LENGTH 0x00
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_TYPE 0x04
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_CODE 0x06
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_TRANSACTION_ID 0x08
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_PARAMETER_1 0x0C
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_PARAMETER_2 0x10
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_PARAMETER_3 0x14
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_PARAMETER_4 0x18
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_PARAMETER_5 0x1C
#define UX_HOST_CLASS_PIMA_COMMAND_HEADER_SIZE 0x0C
#define UX_HOST_CLASS_PIMA_CONTAINER_SIZE 0x40
#define UX_HOST_CLASS_PIMA_ALL_HEADER_SIZE 0x20
/* Define PIMA Data Header Format. */
#define UX_HOST_CLASS_PIMA_DATA_HEADER_LENGTH 0x00
#define UX_HOST_CLASS_PIMA_DATA_HEADER_TYPE 0x04
#define UX_HOST_CLASS_PIMA_DATA_HEADER_CODE 0x06
#define UX_HOST_CLASS_PIMA_DATA_HEADER_TRANSACTION_ID 0x08
#define UX_HOST_CLASS_PIMA_DATA_HEADER_SIZE 0x0C
/* Define PIMA Response Header Format. */
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_LENGTH 0x00
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_TYPE 0x04
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_CODE 0x06
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_TRANSACTION_ID 0x08
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_PARAMETER_1 0x0C
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_PARAMETER_2 0x10
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_PARAMETER_3 0x14
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_PARAMETER_4 0x18
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_PARAMETER_5 0x1C
#define UX_HOST_CLASS_PIMA_RESPONSE_HEADER_SIZE 0x20
/* Define PIMA Asynchronous Event Interrupt Data Format. */
#define UX_HOST_CLASS_PIMA_AEI_DATA_LENGTH 0x00
#define UX_HOST_CLASS_PIMA_AEI_TYPE 0x04
#define UX_HOST_CLASS_PIMA_AEI_EVENT_CODE 0x06
#define UX_HOST_CLASS_PIMA_AEI_TRANSACTION_ID 0x08
#define UX_HOST_CLASS_PIMA_AEI_PARAMETER_1 0x0C
#define UX_HOST_CLASS_PIMA_AEI_PARAMETER_2 0x10
#define UX_HOST_CLASS_PIMA_AEI_PARAMETER_3 0x14
#define UX_HOST_CLASS_PIMA_AEI_MAX_LENGTH 0x18
/* Define PIMA Operation Commands. */
#define UX_HOST_CLASS_PIMA_OC_UNDEFINED 0x1000
#define UX_HOST_CLASS_PIMA_OC_GET_DEVICE_INFO 0x1001
#define UX_HOST_CLASS_PIMA_OC_OPEN_SESSION 0x1002
#define UX_HOST_CLASS_PIMA_OC_CLOSE_SESSION 0x1003
#define UX_HOST_CLASS_PIMA_OC_GET_STORAGE_IDS 0x1004
#define UX_HOST_CLASS_PIMA_OC_GET_STORAGE_INFO 0x1005
#define UX_HOST_CLASS_PIMA_OC_GET_NUM_OBJECTS 0x1006
#define UX_HOST_CLASS_PIMA_OC_GET_OBJECT_HANDLES 0x1007
#define UX_HOST_CLASS_PIMA_OC_GET_OBJECT_INFO 0x1008
#define UX_HOST_CLASS_PIMA_OC_GET_OBJECT 0x1009
#define UX_HOST_CLASS_PIMA_OC_GET_THUMB 0x100A
#define UX_HOST_CLASS_PIMA_OC_DELETE_OBJECT 0x100B
#define UX_HOST_CLASS_PIMA_OC_SEND_OBJECT_INFO 0x100C
#define UX_HOST_CLASS_PIMA_OC_SEND_OBJECT 0x100D
#define UX_HOST_CLASS_PIMA_OC_INITIATE_CAPTURE 0x100E
#define UX_HOST_CLASS_PIMA_OC_FORMAT_STORE 0x100F
#define UX_HOST_CLASS_PIMA_OC_RESET_DEVICE 0x1010
#define UX_HOST_CLASS_PIMA_OC_SELF_TEST 0x1011
#define UX_HOST_CLASS_PIMA_OC_SET_OBJECT_PROTECTION 0x1012
#define UX_HOST_CLASS_PIMA_OC_POWER_DOWN 0x1013
#define UX_HOST_CLASS_PIMA_OC_GET_DEVICE_PROP_DESC 0x1014
#define UX_HOST_CLASS_PIMA_OC_GET_DEVICE_PROP_VALUE 0x1015
#define UX_HOST_CLASS_PIMA_OC_SET_DEVICE_PROP_VALUE 0x1016
#define UX_HOST_CLASS_PIMA_OC_RESET_DEVICE_PROP_VALUE 0x1017
#define UX_HOST_CLASS_PIMA_OC_TERMINATE_OPEN_CAPTURE 0x1018
#define UX_HOST_CLASS_PIMA_OC_MOVE_OBJECT 0x1019
#define UX_HOST_CLASS_PIMA_OC_COPY_OBJECT 0x101A
#define UX_HOST_CLASS_PIMA_OC_GET_PARTIAL_OBJECT 0x101B
#define UX_HOST_CLASS_PIMA_OC_INITIATE_OPEN_CAPTURE 0x101C
/* Define PIMA Response Codes. */
#define UX_HOST_CLASS_PIMA_RC_UNDEFINED 0x2000
#define UX_HOST_CLASS_PIMA_RC_OK 0x2001
#define UX_HOST_CLASS_PIMA_RC_GENERAL_ERROR 0x2002
#define UX_HOST_CLASS_PIMA_RC_SESSION_NOT_OPEN 0x2003
#define UX_HOST_CLASS_PIMA_RC_INVALID_TRANSACTION_ID 0x2004
#define UX_HOST_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED 0x2005
#define UX_HOST_CLASS_PIMA_RC_PARAMETER_NOT_SUPPORTED 0x2006
#define UX_HOST_CLASS_PIMA_RC_INCOMPLETE_TRANSFER 0x2007
#define UX_HOST_CLASS_PIMA_RC_INVALID_STORAGE_ID 0x2008
#define UX_HOST_CLASS_PIMA_RC_INVALID_OBJECT_HANDLE 0x2009
#define UX_HOST_CLASS_PIMA_RC_DEVICE_PROP_NOT_SUPPORTED 0x200A
#define UX_HOST_CLASS_PIMA_RC_INVALID_OBJECT_FORMAT_CODE 0x200B
#define UX_HOST_CLASS_PIMA_RC_STORE_FULL 0x200C
#define UX_HOST_CLASS_PIMA_RC_OBJECT_WRITE_PROTECTED 0x200D
#define UX_HOST_CLASS_PIMA_RC_STORE_READ_ONLY 0x200E
#define UX_HOST_CLASS_PIMA_RC_ACCESS_DENIED 0x200F
#define UX_HOST_CLASS_PIMA_RC_NO_THUMBNAIL_PRESENT 0x2010
#define UX_HOST_CLASS_PIMA_RC_SELF_TEST_FAILED 0x2011
#define UX_HOST_CLASS_PIMA_RC_PARTIAL_DELETION 0x2012
#define UX_HOST_CLASS_PIMA_RC_STORE_NOT_AVAILABLE 0x2013
#define UX_HOST_CLASS_PIMA_RC_FORMAT_UNSUPPORTED 0x2014
#define UX_HOST_CLASS_PIMA_RC_NO_VALID_OBJECT_INFO 0x2015
#define UX_HOST_CLASS_PIMA_RC_INVALID_CODE_FORMAT 0x2016
#define UX_HOST_CLASS_PIMA_RC_UNKNOWN_VENDOR_CODE 0x2017
#define UX_HOST_CLASS_PIMA_RC_CAPTURE_ALREADY_TERMINATED 0x2018
#define UX_HOST_CLASS_PIMA_RC_DEVICE_BUSY 0x2019
#define UX_HOST_CLASS_PIMA_RC_INVALID_PARENT_OBJECT 0x201A
#define UX_HOST_CLASS_PIMA_RC_INVALID_DEVICE_PROP_FORMAT 0x201B
#define UX_HOST_CLASS_PIMA_RC_INVALID_DEVICE_PROP_VALUE 0x201C
#define UX_HOST_CLASS_PIMA_RC_INVALID_PARAMETER 0x201D
#define UX_HOST_CLASS_PIMA_RC_SESSION_ALREADY_OPENED 0x201E
#define UX_HOST_CLASS_PIMA_RC_TRANSACTION_CANCELED 0x201F
#define UX_HOST_CLASS_PIMA_RC_DESTINATION_UNSUPPORTED 0x2020
#define UX_HOST_CLASS_PIMA_RC_OBJECT_ALREADY_OPENED 0x2021
#define UX_HOST_CLASS_PIMA_RC_OBJECT_ALREADY_CLOSED 0x2022
#define UX_HOST_CLASS_PIMA_RC_OBJECT_NOT_OPENED 0x2023
/* Define PIMA Event Codes. */
#define UX_HOST_CLASS_PIMA_EC_UNDEFINED 0x4000
#define UX_HOST_CLASS_PIMA_EC_CANCEL_TRANSACTION 0x4001
#define UX_HOST_CLASS_PIMA_EC_OBJECT_ADDED 0x4002
#define UX_HOST_CLASS_PIMA_EC_OBJECT_REMOVED 0x4003
#define UX_HOST_CLASS_PIMA_EC_STORE_ADDED 0x4004
#define UX_HOST_CLASS_PIMA_EC_STORE_REMOVED 0x4005
#define UX_HOST_CLASS_PIMA_EC_DEVICE_PROP_CHANGED 0x4006
#define UX_HOST_CLASS_PIMA_EC_OBJECT_INFO_CHANGED 0x4007
#define UX_HOST_CLASS_PIMA_EC_DEVICE_INFO_CHANGED 0x4008
#define UX_HOST_CLASS_PIMA_EC_REQUEST_OBJECT_TRANSFER 0x4009
#define UX_HOST_CLASS_PIMA_EC_STORE_FULL 0x400A
#define UX_HOST_CLASS_PIMA_EC_DEVICE_RESET 0x400B
#define UX_HOST_CLASS_PIMA_EC_STORAGE_INFO_CHANGED 0x400C
#define UX_HOST_CLASS_PIMA_EC_CAPTURE_COMPLETE 0x400D
#define UX_HOST_CLASS_PIMA_EC_UNREPORTED_STATUS 0x400E
/* Define PIMA Object Format Codes. */
#define UX_HOST_CLASS_PIMA_OFC_UNDEFINED 0x3000
#define UX_HOST_CLASS_PIMA_OFC_ASSOCIATION 0x3001
#define UX_HOST_CLASS_PIMA_OFC_SCRIPT 0x3002
#define UX_HOST_CLASS_PIMA_OFC_EXECUTABLE 0x3003
#define UX_HOST_CLASS_PIMA_OFC_TEXT 0x3004
#define UX_HOST_CLASS_PIMA_OFC_HTML 0x3005
#define UX_HOST_CLASS_PIMA_OFC_DPOF 0x3006
#define UX_HOST_CLASS_PIMA_OFC_AIFF 0x3007
#define UX_HOST_CLASS_PIMA_OFC_WAV 0x3008
#define UX_HOST_CLASS_PIMA_OFC_MP3 0x3009
#define UX_HOST_CLASS_PIMA_OFC_AVI 0x300A
#define UX_HOST_CLASS_PIMA_OFC_MPEG 0x300B
#define UX_HOST_CLASS_PIMA_OFC_ASF 0x300C
#define UX_HOST_CLASS_PIMA_OFC_QT 0x300D
#define UX_HOST_CLASS_PIMA_OFC_EXIF_JPEG 0x3801
#define UX_HOST_CLASS_PIMA_OFC_TIFF_EP 0x3802
#define UX_HOST_CLASS_PIMA_OFC_FLASHPIX 0x3803
#define UX_HOST_CLASS_PIMA_OFC_BMP 0x3804
#define UX_HOST_CLASS_PIMA_OFC_CIFF 0x3805
#define UX_HOST_CLASS_PIMA_OFC_GIF 0x3807
#define UX_HOST_CLASS_PIMA_OFC_JFIF 0x3808
#define UX_HOST_CLASS_PIMA_OFC_PCD 0x3809
#define UX_HOST_CLASS_PIMA_OFC_PICT 0x380A
#define UX_HOST_CLASS_PIMA_OFC_PNG 0x380B
#define UX_HOST_CLASS_PIMA_OFC_TIFF 0x380D
#define UX_HOST_CLASS_PIMA_OFC_TIFF_IT 0x380E
#define UX_HOST_CLASS_PIMA_OFC_JP2 0x380F
#define UX_HOST_CLASS_PIMA_OFC_JPX 0x3810
/* Define PIMA Object Protection Status Values. */
#define UX_HOST_CLASS_PIMA_OPS_NO_PROTECTION 0x0000
#define UX_HOST_CLASS_PIMA_OPS_READ_ONLY 0x0001
/* Define PIMA Storage Types Codes. */
#define UX_HOST_CLASS_PIMA_STC_UNDEFINED 0x0000
#define UX_HOST_CLASS_PIMA_STC_FIXED_ROM 0x0001
#define UX_HOST_CLASS_PIMA_STC_REMOVABLE_ROM 0x0002
#define UX_HOST_CLASS_PIMA_STC_FIXED_RAM 0x0003
#define UX_HOST_CLASS_PIMA_STC_REMOVABLE_RAM 0x0004
/* Define PIMA File System Types Codes. */
#define UX_HOST_CLASS_PIMA_FSTC_UNDEFINED 0x0000
#define UX_HOST_CLASS_PIMA_FSTC_GENERIC_FLAT 0x0001
#define UX_HOST_CLASS_PIMA_FSTC_GENERIC_HIERARCHICAL 0x0002
#define UX_HOST_CLASS_PIMA_FSTC_DCF 0x0003
/* Define PIMA event info structure. */
typedef struct UX_HOST_CLASS_PIMA_EVENT_STRUCT
{
struct UX_HOST_CLASS_PIMA_SESSION_STRUCT
*ux_host_class_pima_event_session;
struct UX_HOST_CLASS_PIMA_STRUCT
*ux_host_class_pima_event_pima_instance;
ULONG ux_host_class_pima_event_code;
ULONG ux_host_class_pima_event_session_id;
ULONG ux_host_class_pima_event_transaction_id;
ULONG ux_host_class_pima_event_parameter_1;
ULONG ux_host_class_pima_event_parameter_2;
ULONG ux_host_class_pima_event_parameter_3;
} UX_HOST_CLASS_PIMA_EVENT;
/* Define PIMA structure. */
typedef struct UX_HOST_CLASS_PIMA_STRUCT
{
struct UX_HOST_CLASS_PIMA_STRUCT
*ux_host_class_pima_next_instance;
UX_HOST_CLASS *ux_host_class_pima_class;
UX_DEVICE *ux_host_class_pima_device;
UX_INTERFACE *ux_host_class_pima_interface;
UX_ENDPOINT *ux_host_class_pima_bulk_out_endpoint;
UX_ENDPOINT *ux_host_class_pima_bulk_in_endpoint;
UX_ENDPOINT *ux_host_class_pima_interrupt_endpoint;
UINT ux_host_class_pima_state;
ULONG ux_host_class_pima_transaction_id;
ULONG ux_host_class_pima_operation_code;
ULONG ux_host_class_pima_event_code;
ULONG ux_host_class_pima_event_transaction_id;
ULONG ux_host_class_pima_event_session;
ULONG ux_host_class_pima_event_parameter_1;
ULONG ux_host_class_pima_event_parameter_2;
ULONG ux_host_class_pima_event_parameter_3;
UCHAR *ux_host_class_pima_event_buffer;
UCHAR *ux_host_class_pima_event_buffer_current_offset;
ULONG ux_host_class_pima_event_buffer_current_length;
ULONG ux_host_class_pima_event_buffer_expected_length;
struct UX_HOST_CLASS_PIMA_SESSION_STRUCT
*ux_host_class_pima_session;
UCHAR *ux_host_class_pima_container;
VOID *ux_host_class_pima_application;
ULONG ux_host_class_pima_zlp_flag;
} UX_HOST_CLASS_PIMA;
/* Define PIMA Session structure. */
typedef struct UX_HOST_CLASS_PIMA_SESSION_STRUCT
{
ULONG ux_host_class_pima_session_magic;
ALIGN_TYPE ux_host_class_pima_session_id;
ULONG ux_host_class_pima_session_state;
struct UX_HOST_CLASS_PIMA_STRUCT
*ux_host_class_pima_session_pima_instance;
ULONG ux_host_class_pima_session_nb_storage_ids;
ULONG ux_host_class_pima_session_nb_objects;
VOID (*ux_host_class_pima_session_event_callback)(struct UX_HOST_CLASS_PIMA_EVENT_STRUCT *pima_event);
} UX_HOST_CLASS_PIMA_SESSION;
/* Define PIMA command structure. */
typedef struct UX_HOST_CLASS_PIMA_COMMAND_STRUCT
{
ULONG ux_host_class_pima_command_nb_parameters;
ULONG ux_host_class_pima_command_operation_code;
ULONG ux_host_class_pima_command_parameter_1;
ULONG ux_host_class_pima_command_parameter_2;
ULONG ux_host_class_pima_command_parameter_3;
ULONG ux_host_class_pima_command_parameter_4;
ULONG ux_host_class_pima_command_parameter_5;
} UX_HOST_CLASS_PIMA_COMMAND;
/* Define PIMA object info structure. */
typedef struct UX_HOST_CLASS_PIMA_OBJECT_STRUCT
{
ULONG ux_host_class_pima_object_storage_id;
USHORT ux_host_class_pima_object_format;
USHORT ux_host_class_pima_object_protection_status;
ULONG ux_host_class_pima_object_compressed_size;
USHORT ux_host_class_pima_object_thumb_format;
USHORT _align_thumb_compressed_size;
ULONG ux_host_class_pima_object_thumb_compressed_size;
ULONG ux_host_class_pima_object_thumb_pix_width;
ULONG ux_host_class_pima_object_thumb_pix_height;
ULONG ux_host_class_pima_object_image_pix_width;
ULONG ux_host_class_pima_object_image_pix_height;
ULONG ux_host_class_pima_object_image_bit_depth;
ULONG ux_host_class_pima_object_parent_object;
USHORT ux_host_class_pima_object_association_type;
USHORT _align_association_desc;
ULONG ux_host_class_pima_object_association_desc;
ULONG ux_host_class_pima_object_sequence_number;
UCHAR ux_host_class_pima_object_filename[UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH]; /* Null terminated unicode string. */
UCHAR ux_host_class_pima_object_capture_date[UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH];
UCHAR ux_host_class_pima_object_modification_date[UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH];
UCHAR ux_host_class_pima_object_keywords[UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH]; /* Null terminated unicode string. */
ULONG ux_host_class_pima_object_state;
ULONG ux_host_class_pima_object_offset;
ULONG ux_host_class_pima_object_transfer_status;
ULONG ux_host_class_pima_object_handle_id;
ULONG ux_host_class_pima_object_length;
UCHAR *ux_host_class_pima_object_buffer;
} UX_HOST_CLASS_PIMA_OBJECT;
/* Define PIMA Object decompaction structure. */
#define UX_HOST_CLASS_PIMA_OBJECT_MAX_LENGTH 512
#define UX_HOST_CLASS_PIMA_OBJECT_VARIABLE_OFFSET 52
#define UX_HOST_CLASS_PIMA_OBJECT_ENTRIES 15
/* Define PIMA device info structure. */
typedef struct UX_HOST_CLASS_PIMA_DEVICE_STRUCT
{
ULONG ux_host_class_pima_device_standard_version;
ULONG ux_host_class_pima_device_vendor_extension_id;
ULONG ux_host_class_pima_device_vendor_extension_version;
UCHAR ux_host_class_pima_device_vendor_extension_desc[UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH]; /* Null terminated unicode string. */
ULONG ux_host_class_pima_device_functional_mode;
UCHAR ux_host_class_pima_device_operations_supported[UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH];
UCHAR ux_host_class_pima_device_events_supported[UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH];
UCHAR ux_host_class_pima_device_properties_supported[UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH];
UCHAR ux_host_class_pima_device_capture_formats[UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH];
UCHAR ux_host_class_pima_device_image_formats[UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH];
UCHAR ux_host_class_pima_device_manufacturer[UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH]; /* Null terminated unicode string. */
UCHAR ux_host_class_pima_device_model[UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH];
UCHAR ux_host_class_pima_device_version[UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH];
UCHAR ux_host_class_pima_device_serial_number[UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH]; /* Null terminated unicode string. */
} UX_HOST_CLASS_PIMA_DEVICE;
/* Define PIMA Device decompaction structure. */
#define UX_HOST_CLASS_PIMA_DEVICE_MAX_LENGTH 1024
#define UX_HOST_CLASS_PIMA_DEVICE_STANDARD_VERSION 0
#define UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_ID 2
#define UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_VERSION 6
#define UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_DESC 8
/* Define PIMA storage info structure. */
typedef struct UX_HOST_CLASS_PIMA_STORAGE_STRUCT
{
USHORT ux_host_class_pima_storage_type;
USHORT ux_host_class_pima_storage_file_system_type;
USHORT ux_host_class_pima_storage_access_capability;
USHORT _align_max_capacity_low;
ULONG ux_host_class_pima_storage_max_capacity_low;
ULONG ux_host_class_pima_storage_max_capacity_high;
ULONG ux_host_class_pima_storage_free_space_bytes_low;
ULONG ux_host_class_pima_storage_free_space_bytes_high;
ULONG ux_host_class_pima_storage_free_space_images;
UCHAR ux_host_class_pima_storage_description[UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH]; /* Null terminated unicode string. */
UCHAR ux_host_class_pima_storage_volume_label[UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH]; /* Null terminated unicode string. */
} UX_HOST_CLASS_PIMA_STORAGE;
/* Define PIMA storage decompaction structure. */
#define UX_HOST_CLASS_PIMA_STORAGE_MAX_LENGTH 512
#define UX_HOST_CLASS_PIMA_STORAGE_VARIABLE_OFFSET 26
#define UX_HOST_CLASS_PIMA_STORAGE_ENTRIES 8
/* Define Pima Class function prototypes. */
UINT _ux_host_class_pima_activate(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_pima_configure(UX_HOST_CLASS_PIMA *cdc_acm);
UINT _ux_host_class_pima_deactivate(UX_HOST_CLASS_COMMAND *command);
UINT _ux_host_class_pima_endpoints_get(UX_HOST_CLASS_PIMA *cdc_acm);
UINT _ux_host_class_pima_entry(UX_HOST_CLASS_COMMAND *command);
VOID _ux_host_class_pima_notification(UX_TRANSFER *transfer_request);
UINT _ux_host_class_pima_command(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_COMMAND *command,
ULONG direction, UCHAR *data_buffer, ULONG data_length,
ULONG max_payload_length);
UINT _ux_host_class_pima_device_reset(UX_HOST_CLASS_PIMA *pima);
UINT _ux_host_class_pima_num_objects_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG storage_id,
ULONG object_format_code);
UINT _ux_host_class_pima_object_copy(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle,
ULONG storage_id, ULONG parent_object_handle);
UINT _ux_host_class_pima_object_delete(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle);
UINT _ux_host_class_pima_object_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object,
UCHAR *object_buffer, ULONG object_buffer_length, ULONG *object_actual_length);
UINT _ux_host_class_pima_object_handles_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG *object_handles_array, ULONG object_handles_length, ULONG storage_id, ULONG object_format_code, ULONG object_handle_association);
UINT _ux_host_class_pima_object_info_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _ux_host_class_pima_object_info_send(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG storage_id, ULONG parent_object_id,
UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _ux_host_class_pima_object_move(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle, ULONG storage_id, ULONG parent_object_handle);
UINT _ux_host_class_pima_object_send(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, UX_HOST_CLASS_PIMA_OBJECT *object,
UCHAR *object_buffer, ULONG object_buffer_length);
UINT _ux_host_class_pima_read(UX_HOST_CLASS_PIMA *pima, UCHAR *data_pointer, ULONG data_length, ULONG max_payload_length);
UINT _ux_host_class_pima_session_close(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session);
UINT _ux_host_class_pima_session_open(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session);
UINT _ux_host_class_pima_storage_ids_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG *storage_ids_array, ULONG storage_id_length);
UINT _ux_host_class_pima_storage_info_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG storage_id, UX_HOST_CLASS_PIMA_STORAGE *storage);
UINT _ux_host_class_pima_thumb_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object,
UCHAR *thumb_buffer, ULONG thumb_buffer_length, ULONG *thumb_actual_length);
UINT _ux_host_class_pima_write(UX_HOST_CLASS_PIMA *pima, UCHAR *data_pointer, ULONG data_length, ULONG operation_code, ULONG max_payload_length);
UINT _ux_host_class_pima_request_cancel(UX_HOST_CLASS_PIMA *pima);
UINT _ux_host_class_pima_object_transfer_abort(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _ux_host_class_pima_object_close(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _ux_host_class_pima_object_open(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _ux_host_class_pima_device_info_get(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_DEVICE *pima_device);
UINT _uxe_host_class_pima_num_objects_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG storage_id,
ULONG object_format_code);
UINT _uxe_host_class_pima_object_delete(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle);
UINT _uxe_host_class_pima_object_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object,
UCHAR *object_buffer, ULONG object_buffer_length, ULONG *object_actual_length);
UINT _uxe_host_class_pima_object_handles_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG *object_handles_array, ULONG object_handles_length, ULONG storage_id, ULONG object_format_code, ULONG object_handle_association);
UINT _uxe_host_class_pima_object_info_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _uxe_host_class_pima_object_info_send(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG storage_id, ULONG parent_object_id,
UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _uxe_host_class_pima_object_send(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, UX_HOST_CLASS_PIMA_OBJECT *object,
UCHAR *object_buffer, ULONG object_buffer_length);
UINT _uxe_host_class_pima_session_close(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session);
UINT _uxe_host_class_pima_session_open(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session);
UINT _uxe_host_class_pima_storage_ids_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG *storage_ids_array, ULONG storage_id_length);
UINT _uxe_host_class_pima_storage_info_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG storage_id, UX_HOST_CLASS_PIMA_STORAGE *storage);
UINT _uxe_host_class_pima_thumb_get(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session, ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object,
UCHAR *thumb_buffer, ULONG thumb_buffer_length, ULONG *thumb_actual_length);
UINT _uxe_host_class_pima_object_transfer_abort(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _uxe_host_class_pima_object_close(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _uxe_host_class_pima_object_open(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG object_handle, UX_HOST_CLASS_PIMA_OBJECT *object);
UINT _uxe_host_class_pima_device_info_get(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_DEVICE *pima_device);
/* Define Device PIMA Class API prototypes. */
#if defined(UX_HOST_CLASS_PIMA_ENABLE_ERROR_CHECKING)
#define ux_host_class_pima_entry _ux_host_class_pima_entry
#define ux_host_class_pima_device_info_get _uxe_host_class_pima_device_info_get
#define ux_host_class_pima_object_info_send _uxe_host_class_pima_object_info_send
#define ux_host_class_pima_object_info_get _uxe_host_class_pima_object_info_get
#define ux_host_class_pima_object_open _uxe_host_class_pima_object_open
#define ux_host_class_pima_object_get _uxe_host_class_pima_object_get
#define ux_host_class_pima_thumb_get _uxe_host_class_pima_thumb_get
#define ux_host_class_pima_object_send _uxe_host_class_pima_object_send
#define ux_host_class_pima_object_delete _uxe_host_class_pima_object_delete
#define ux_host_class_pima_object_transfer_abort _uxe_host_class_pima_object_transfer_abort
#define ux_host_class_pima_object_close _uxe_host_class_pima_object_close
#define ux_host_class_pima_session_open _uxe_host_class_pima_session_open
#define ux_host_class_pima_session_close _uxe_host_class_pima_session_close
#define ux_host_class_pima_storage_ids_get _uxe_host_class_pima_storage_ids_get
#define ux_host_class_pima_storage_info_get _uxe_host_class_pima_storage_info_get
#define ux_host_class_pima_object_handles_get _uxe_host_class_pima_object_handles_get
#define ux_host_class_pima_num_objects_get _uxe_host_class_pima_num_objects_get
#else
#define ux_host_class_pima_entry _ux_host_class_pima_entry
#define ux_host_class_pima_device_info_get _ux_host_class_pima_device_info_get
#define ux_host_class_pima_object_info_send _ux_host_class_pima_object_info_send
#define ux_host_class_pima_object_info_get _ux_host_class_pima_object_info_get
#define ux_host_class_pima_object_open _ux_host_class_pima_object_open
#define ux_host_class_pima_object_get _ux_host_class_pima_object_get
#define ux_host_class_pima_thumb_get _ux_host_class_pima_thumb_get
#define ux_host_class_pima_object_send _ux_host_class_pima_object_send
#define ux_host_class_pima_object_delete _ux_host_class_pima_object_delete
#define ux_host_class_pima_object_transfer_abort _ux_host_class_pima_object_transfer_abort
#define ux_host_class_pima_object_close _ux_host_class_pima_object_close
#define ux_host_class_pima_session_open _ux_host_class_pima_session_open
#define ux_host_class_pima_session_close _ux_host_class_pima_session_close
#define ux_host_class_pima_storage_ids_get _ux_host_class_pima_storage_ids_get
#define ux_host_class_pima_storage_info_get _ux_host_class_pima_storage_info_get
#define ux_host_class_pima_object_handles_get _ux_host_class_pima_object_handles_get
#define ux_host_class_pima_num_objects_get _ux_host_class_pima_num_objects_get
#endif
/* Determine if a C++ compiler is being used. If so, complete the standard
C conditional started above. */
#ifdef __cplusplus
}
#endif
#endif
|
