1 /**************************************************************************/
2 /*                                                                        */
3 /*       Copyright (c) Microsoft Corporation. All rights reserved.        */
4 /*                                                                        */
5 /*       This software is licensed under the Microsoft Software License   */
6 /*       Terms for Microsoft Azure RTOS. Full text of the license can be  */
7 /*       found in the LICENSE file at https://aka.ms/AzureRTOS_EULA       */
8 /*       and in the root directory of this software.                      */
9 /*                                                                        */
10 /**************************************************************************/
11 
12 
13 /**************************************************************************/
14 /**************************************************************************/
15 /**                                                                       */
16 /** USBX Component                                                        */
17 /**                                                                       */
18 /**   PIMA Class                                                          */
19 /**                                                                       */
20 /**************************************************************************/
21 /**************************************************************************/
22 
23 
24 /**************************************************************************/
25 /*                                                                        */
26 /*  COMPONENT DEFINITION                                   RELEASE        */
27 /*                                                                        */
28 /*    ux_device_class_pima.h                              PORTABLE C      */
29 /*                                                           6.1.11       */
30 /*  AUTHOR                                                                */
31 /*                                                                        */
32 /*    Chaoqiong Xiao, Microsoft Corporation                               */
33 /*                                                                        */
34 /*  DESCRIPTION                                                           */
35 /*                                                                        */
36 /*    This file contains all the header and extern functions used by the  */
37 /*    USBX PIMA class.                                                    */
38 /*                                                                        */
39 /*  RELEASE HISTORY                                                       */
40 /*                                                                        */
41 /*    DATE              NAME                      DESCRIPTION             */
42 /*                                                                        */
43 /*  05-19-2020     Chaoqiong Xiao           Initial Version 6.0           */
44 /*  09-30-2020     Chaoqiong Xiao           Modified comment(s),          */
45 /*                                            used UX prefix to refer to  */
46 /*                                            TX symbols instead of using */
47 /*                                            them directly,              */
48 /*                                            resulting in version 6.1    */
49 /*  08-02-2021     Wen Wang                 Modified comment(s),          */
50 /*                                            added extern "C" keyword    */
51 /*                                            for compatibility with C++, */
52 /*                                            resulting in version 6.1.8  */
53 /*  01-31-2022     Chaoqiong Xiao           Modified comment(s),          */
54 /*                                            updated definitions,        */
55 /*                                            improved internal function, */
56 /*                                            added cancel callback,      */
57 /*                                            resulting in version 6.1.10 */
58 /*  04-25-2022     Chaoqiong Xiao           Modified comment(s),          */
59 /*                                            fixed standalone compile,   */
60 /*                                            resulting in version 6.1.11 */
61 /*                                                                        */
62 /**************************************************************************/
63 
64 #ifndef UX_DEVICE_CLASS_PIMA_H
65 #define UX_DEVICE_CLASS_PIMA_H
66 
67 /* Determine if a C++ compiler is being used.  If so, ensure that standard
68    C is used to process the API information.  */
69 
70 #ifdef   __cplusplus
71 
72 /* Yes, C++ compiler is present.  Use standard C.  */
73 extern   "C" {
74 
75 #endif
76 
77 /* Define PIMA Class constants.  */
78 
79 #define UX_DEVICE_CLASS_PIMA_TRANSFER_BUFFER_LENGTH                                 UX_SLAVE_REQUEST_DATA_MAX_LENGTH
80 #define UX_DEVICE_CLASS_PIMA_MAX_PAYLOAD                                            (UX_DEVICE_CLASS_PIMA_TRANSFER_BUFFER_LENGTH - UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE)
81 #define UX_DEVICE_CLASS_PIMA_OBJECT_INFO_BUFFER_SIZE                                (UX_DEVICE_CLASS_PIMA_MAX_PAYLOAD)
82 #define UX_DEVICE_CLASS_PIMA_DEVICE_INFO_BUFFER_SIZE                                (UX_DEVICE_CLASS_PIMA_MAX_PAYLOAD)
83 #define UX_DEVICE_CLASS_PIMA_STORAGE_INFO_BUFFER_SIZE                               (UX_DEVICE_CLASS_PIMA_MAX_PAYLOAD)
84 #define UX_DEVICE_CLASS_PIMA_ARRAY_BUFFER_SIZE                                      (UX_DEVICE_CLASS_PIMA_MAX_PAYLOAD)
85 #define UX_DEVICE_CLASS_PIMA_DEVICE_PROP_VALUE_BUFFER_SIZE                          (UX_DEVICE_CLASS_PIMA_MAX_PAYLOAD)
86 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_VALUE_BUFFER_SIZE                          (UX_DEVICE_CLASS_PIMA_MAX_PAYLOAD)
87 
88 #define UX_DEVICE_CLASS_PIMA_CLASS_TRANSFER_TIMEOUT                                 300000
89 #define UX_DEVICE_CLASS_PIMA_CLASS                                                  0x06
90 #define UX_DEVICE_CLASS_PIMA_SUBCLASS                                               0X01
91 #define UX_DEVICE_CLASS_PIMA_PROTOCOL                                               0X01
92 #define UX_DEVICE_CLASS_PIMA_MAGIC_NUMBER                                           0x50494D41
93 #define UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH                                     256
94 #define UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH                            64
95 #define UX_DEVICE_CLASS_PIMA_MAX_EVENTS_QUEUE                                       16
96 #define UX_DEVICE_CLASS_PIMA_MAX_STORAGE_IDS                                        1
97 #define UX_DEVICE_CLASS_PIMA_ARRAY_MAX_LENGTH                                       256
98 #define UX_DEVICE_CLASS_PIMA_DEVICE_PROPERTIES_ARRAY_MAX_ITEMS                      32
99 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROPERTIES_ARRAY_MAX_ITEMS                      128
100 #define UX_DEVICE_CLASS_PIMA_PROP_VALUE_SIZE                                        256
101 #define UX_DEVICE_CLASS_PIMA_MICROSOFT_VENDOR_COMMAND_CODE                          0x54
102 
103 /* Define PIMA versions.  */
104 #define UX_DEVICE_CLASS_PIMA_STANDARD_VERSION                                       100
105 #define UX_DEVICE_CLASS_PIMA_VENDOR_EXTENSION_ID                                    6
106 #define UX_DEVICE_CLASS_PIMA_EXTENSION_VERSION                                      100
107 #define UX_DEVICE_CLASS_PIMA_STANDARD_MODE                                          0
108 
109 
110 /* Define PIMA phases.  */
111 
112 #define UX_DEVICE_CLASS_PIMA_PHASE_IDLE                                             0
113 #define UX_DEVICE_CLASS_PIMA_PHASE_COMMAND                                          1
114 #define UX_DEVICE_CLASS_PIMA_PHASE_RESPONSE                                         2
115 #define UX_DEVICE_CLASS_PIMA_PHASE_DATA_IN                                          3
116 #define UX_DEVICE_CLASS_PIMA_PHASE_DATA_OUT                                         4
117 
118 /* Define PIMA data phases.  */
119 
120 #define UX_DEVICE_CLASS_PIMA_DATA_PHASE_NONE                                        0
121 #define UX_DEVICE_CLASS_PIMA_DATA_PHASE_IN                                          1
122 #define UX_DEVICE_CLASS_PIMA_DATA_PHASE_OUT                                         2
123 
124 /* Define PIMA session states.  */
125 
126 #define UX_DEVICE_CLASS_PIMA_SESSION_STATE_CLOSED                                   0
127 #define UX_DEVICE_CLASS_PIMA_SESSION_STATE_OPENED                                   1
128 
129 /* Define PIMA object and thumb states.  */
130 
131 #define UX_DEVICE_CLASS_PIMA_OBJECT_STATE_CLOSED                                    0
132 #define UX_DEVICE_CLASS_PIMA_OBJECT_STATE_OPENED                                    1
133 
134 /* Define PIMA object and thumb transfer status.  */
135 
136 #define UX_DEVICE_CLASS_PIMA_OBJECT_TRANSFER_STATUS_INACTIVE                        0
137 #define UX_DEVICE_CLASS_PIMA_OBJECT_TRANSFER_STATUS_ACTIVE                          1
138 #define UX_DEVICE_CLASS_PIMA_OBJECT_TRANSFER_STATUS_COMPLETED                       2
139 #define UX_DEVICE_CLASS_PIMA_OBJECT_TRANSFER_STATUS_ABORTED                         3
140 
141 /* Define PIMA object and thumb transfer phase.  */
142 
143 #define UX_DEVICE_CLASS_PIMA_OBJECT_TRANSFER_PHASE_ACTIVE                           0
144 #define UX_DEVICE_CLASS_PIMA_OBJECT_TRANSFER_PHASE_COMPLETED                        1
145 #define UX_DEVICE_CLASS_PIMA_OBJECT_TRANSFER_PHASE_COMPLETED_ERROR                  2
146 
147 
148 /* Define PIMA Cancel Request equivalences.  */
149 
150 #define UX_DEVICE_CLASS_PIMA_REQUEST_CANCEL_COMMAND                                 0x64
151 #define UX_DEVICE_CLASS_PIMA_REQUEST_CANCEL_DATA_LENGTH                             0x06
152 #define UX_DEVICE_CLASS_PIMA_REQUEST_CANCEL_CODE                                    0x04001
153 #define UX_DEVICE_CLASS_PIMA_REQUEST_CANCEL_OFFSET_CODE                             0x00
154 #define UX_DEVICE_CLASS_PIMA_REQUEST_CANCEL_OFFSET_TRANSACTION_ID                   0x02
155 
156 /* Define PIMA Reset Request equivalences.  */
157 
158 #define UX_DEVICE_CLASS_PIMA_REQUEST_RESET_DEVICE                                   0x66
159 
160 /* Define PIMA Status Request equivalences.  */
161 
162 #define UX_DEVICE_CLASS_PIMA_REQUEST_STATUS_COMMAND                                 0x67
163 #define UX_DEVICE_CLASS_PIMA_REQUEST_STATUS_DATA_LENGTH                             0x40
164 #define UX_DEVICE_CLASS_PIMA_REQUEST_STATUS_OFFSET_LENGTH                           0x00
165 #define UX_DEVICE_CLASS_PIMA_REQUEST_STATUS_OFFSET_CODE                             0x02
166 #define UX_DEVICE_CLASS_PIMA_REQUEST_STATUS_COMMAND_COUNTER                         16
167 #define UX_DEVICE_CLASS_PIMA_REQUEST_STATUS_COMMAND_DELAY                           (1 * UX_PERIODIC_RATE)
168 
169 /* Define PIMA command container type.  */
170 
171 #define UX_DEVICE_CLASS_PIMA_CT_UNDEFINED                                           0x00
172 #define UX_DEVICE_CLASS_PIMA_CT_COMMAND_BLOCK                                       0x01
173 #define UX_DEVICE_CLASS_PIMA_CT_DATA_BLOCK                                          0x02
174 #define UX_DEVICE_CLASS_PIMA_CT_RESPONSE_BLOCK                                      0x03
175 #define UX_DEVICE_CLASS_PIMA_CT_EVENT_BLOCK                                         0x04
176 
177 /* Define PIMA Extended Event Data Request payload Format.  */
178 
179 #define UX_DEVICE_CLASS_PIMA_EEDR_EVENT_CODE                                        0x00
180 #define UX_DEVICE_CLASS_PIMA_EEDR_TRANSACTION_ID                                    0x02
181 #define UX_DEVICE_CLASS_PIMA_EEDR_NUMBER_PARAMETERS                                 0x06
182 #define UX_DEVICE_CLASS_PIMA_EEDR_SIZE_PARAMETER                                    0x08
183 
184 /* Define PIMA Device Status Data Format.  */
185 
186 #define UX_DEVICE_CLASS_PIMA_DSD_LENGTH                                             0x00
187 #define UX_DEVICE_CLASS_PIMA_DSD_CODE                                               0x02
188 #define UX_DEVICE_CLASS_PIMA_DSD_PARAMETER                                          0x04
189 
190 /* Define PIMA Command Header Format.  */
191 
192 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_LENGTH                                  0x00
193 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_TYPE                                    0x04
194 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_CODE                                    0x06
195 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_TRANSACTION_ID                          0x08
196 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_PARAMETER_1                             0x0C
197 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_PARAMETER_2                             0x10
198 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_PARAMETER_3                             0x14
199 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_PARAMETER_4                             0x18
200 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_PARAMETER_5                             0x1C
201 
202 #define UX_DEVICE_CLASS_PIMA_COMMAND_HEADER_SIZE                                    0x0C
203 #define UX_DEVICE_CLASS_PIMA_CONTAINER_SIZE                                         0x40
204 #define UX_DEVICE_CLASS_PIMA_ALL_HEADER_SIZE                                        0x20
205 
206 /* Define PIMA Data Header Format.  */
207 
208 #define UX_DEVICE_CLASS_PIMA_DATA_HEADER_LENGTH                                     0x00
209 #define UX_DEVICE_CLASS_PIMA_DATA_HEADER_TYPE                                       0x04
210 #define UX_DEVICE_CLASS_PIMA_DATA_HEADER_CODE                                       0x06
211 #define UX_DEVICE_CLASS_PIMA_DATA_HEADER_TRANSACTION_ID                             0x08
212 #define UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE                                       0x0C
213 
214 
215 /* Define PIMA Response Header Format.  */
216 
217 #define UX_DEVICE_CLASS_PIMA_RESPONSE_HEADER_LENGTH                                 0x00
218 #define UX_DEVICE_CLASS_PIMA_RESPONSE_HEADER_TYPE                                   0x04
219 #define UX_DEVICE_CLASS_PIMA_RESPONSE_HEADER_CODE                                   0x06
220 #define UX_DEVICE_CLASS_PIMA_RESPONSE_HEADER_TRANSACTION_ID                         0x08
221 #define UX_DEVICE_CLASS_PIMA_RESPONSE_HEADER_PARAMETERS                             0x0C
222 #define UX_DEVICE_CLASS_PIMA_RESPONSE_HEADER_SIZE                                   0x0C
223 
224 /* Define PIMA Asynchronous Event Interrupt Data Format.  */
225 
226 #define UX_DEVICE_CLASS_PIMA_AEI_DATA_LENGTH                                        0x00
227 #define UX_DEVICE_CLASS_PIMA_AEI_TYPE                                               0x04
228 #define UX_DEVICE_CLASS_PIMA_AEI_EVENT_CODE                                         0x06
229 #define UX_DEVICE_CLASS_PIMA_AEI_TRANSACTION_ID                                     0x08
230 #define UX_DEVICE_CLASS_PIMA_AEI_PARAMETER_1                                        0x0C
231 #define UX_DEVICE_CLASS_PIMA_AEI_PARAMETER_2                                        0x10
232 #define UX_DEVICE_CLASS_PIMA_AEI_PARAMETER_3                                        0x14
233 #define UX_DEVICE_CLASS_PIMA_AEI_MAX_LENGTH                                         0x18
234 
235 /* Define PIMA Operation Commands.  */
236 
237 #define UX_DEVICE_CLASS_PIMA_OC_UNDEFINED                                           0x1000
238 #define UX_DEVICE_CLASS_PIMA_OC_GET_DEVICE_INFO                                     0x1001
239 #define UX_DEVICE_CLASS_PIMA_OC_OPEN_SESSION                                        0x1002
240 #define UX_DEVICE_CLASS_PIMA_OC_CLOSE_SESSION                                       0x1003
241 #define UX_DEVICE_CLASS_PIMA_OC_GET_STORAGE_IDS                                     0x1004
242 #define UX_DEVICE_CLASS_PIMA_OC_GET_STORAGE_INFO                                    0x1005
243 #define UX_DEVICE_CLASS_PIMA_OC_GET_NUM_OBJECTS                                     0x1006
244 #define UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT_HANDLES                                  0x1007
245 #define UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT_INFO                                     0x1008
246 #define UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT                                          0x1009
247 #define UX_DEVICE_CLASS_PIMA_OC_GET_THUMB                                           0x100A
248 #define UX_DEVICE_CLASS_PIMA_OC_DELETE_OBJECT                                       0x100B
249 #define UX_DEVICE_CLASS_PIMA_OC_SEND_OBJECT_INFO                                    0x100C
250 #define UX_DEVICE_CLASS_PIMA_OC_SEND_OBJECT                                         0x100D
251 #define UX_DEVICE_CLASS_PIMA_OC_INITIATE_CAPTURE                                    0x100E
252 #define UX_DEVICE_CLASS_PIMA_OC_FORMAT_STORE                                        0x100F
253 #define UX_DEVICE_CLASS_PIMA_OC_RESET_DEVICE                                        0x1010
254 #define UX_DEVICE_CLASS_PIMA_OC_SELF_TEST                                           0x1011
255 #define UX_DEVICE_CLASS_PIMA_OC_SET_OBJECT_PROTECTION                               0x1012
256 #define UX_DEVICE_CLASS_PIMA_OC_POWER_DOWN                                          0x1013
257 #define UX_DEVICE_CLASS_PIMA_OC_GET_DEVICE_PROP_DESC                                0x1014
258 #define UX_DEVICE_CLASS_PIMA_OC_GET_DEVICE_PROP_VALUE                               0x1015
259 #define UX_DEVICE_CLASS_PIMA_OC_SET_DEVICE_PROP_VALUE                               0x1016
260 #define UX_DEVICE_CLASS_PIMA_OC_RESET_DEVICE_PROP_VALUE                             0x1017
261 #define UX_DEVICE_CLASS_PIMA_OC_TERMINATE_OPEN_CAPTURE                              0x1018
262 #define UX_DEVICE_CLASS_PIMA_OC_MOVE_OBJECT                                         0x1019
263 #define UX_DEVICE_CLASS_PIMA_OC_COPY_OBJECT                                         0x101A
264 #define UX_DEVICE_CLASS_PIMA_OC_GET_PARTIAL_OBJECT                                  0x101B
265 #define UX_DEVICE_CLASS_PIMA_OC_INITIATE_OPEN_CAPTURE                               0x101C
266 #define UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT_PROPS_SUPPORTED                          0x9801
267 #define UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT_PROP_DESC                                0x9802
268 #define UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT_PROP_VALUE                               0x9803
269 #define UX_DEVICE_CLASS_PIMA_OC_SET_OBJECT_PROP_VALUE                               0x9804
270 #define UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT_REFERENCES                               0x9810
271 #define UX_DEVICE_CLASS_PIMA_OC_SET_OBJECT_REFERENCES                               0x9811
272 
273 /* Define PIMA Response Codes.  */
274 
275 #define UX_DEVICE_CLASS_PIMA_RC_UNDEFINED                                           0x2000
276 #define UX_DEVICE_CLASS_PIMA_RC_OK                                                  0x2001
277 #define UX_DEVICE_CLASS_PIMA_RC_GENERAL_ERROR                                       0x2002
278 #define UX_DEVICE_CLASS_PIMA_RC_SESSION_NOT_OPEN                                    0x2003
279 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_TRANSACTION_ID                              0x2004
280 #define UX_DEVICE_CLASS_PIMA_RC_OPERATION_NOT_SUPPORTED                             0x2005
281 #define UX_DEVICE_CLASS_PIMA_RC_PARAMETER_NOT_SUPPORTED                             0x2006
282 #define UX_DEVICE_CLASS_PIMA_RC_INCOMPLETE_TRANSFER                                 0x2007
283 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_STORAGE_ID                                  0x2008
284 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_OBJECT_HANDLE                               0x2009
285 #define UX_DEVICE_CLASS_PIMA_RC_DEVICE_PROP_NOT_SUPPORTED                           0x200A
286 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_OBJECT_FORMAT_CODE                          0x200B
287 #define UX_DEVICE_CLASS_PIMA_RC_STORE_FULL                                          0x200C
288 #define UX_DEVICE_CLASS_PIMA_RC_OBJECT_WRITE_PROTECTED                              0x200D
289 #define UX_DEVICE_CLASS_PIMA_RC_STORE_READ_ONLY                                     0x200E
290 #define UX_DEVICE_CLASS_PIMA_RC_ACCESS_DENIED                                       0x200F
291 #define UX_DEVICE_CLASS_PIMA_RC_NO_THUMBNAIL_PRESENT                                0x2010
292 #define UX_DEVICE_CLASS_PIMA_RC_SELF_TEST_FAILED                                    0x2011
293 #define UX_DEVICE_CLASS_PIMA_RC_PARTIAL_DELETION                                    0x2012
294 #define UX_DEVICE_CLASS_PIMA_RC_STORE_NOT_AVAILABLE                                 0x2013
295 #define UX_DEVICE_CLASS_PIMA_RC_FORMAT_UNSUPPORTED                                  0x2014
296 #define UX_DEVICE_CLASS_PIMA_RC_NO_VALID_OBJECT_INFO                                0x2015
297 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_CODE_FORMAT                                 0x2016
298 #define UX_DEVICE_CLASS_PIMA_RC_UNKNOWN_VENDOR_CODE                                 0x2017
299 #define UX_DEVICE_CLASS_PIMA_RC_CAPTURE_ALREADY_TERMINATED                          0x2018
300 #define UX_DEVICE_CLASS_PIMA_RC_DEVICE_BUSY                                         0x2019
301 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_PARENT_OBJECT                               0x201A
302 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_DEVICE_PROP_FORMAT                          0x201B
303 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_DEVICE_PROP_VALUE                           0x201C
304 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_PARAMETER                                   0x201D
305 #define UX_DEVICE_CLASS_PIMA_RC_SESSION_ALREADY_OPENED                              0x201E
306 #define UX_DEVICE_CLASS_PIMA_RC_TRANSACTION_CANCELED                                0x201F
307 #define UX_DEVICE_CLASS_PIMA_RC_DESTINATION_UNSUPPORTED                             0x2020
308 #define UX_DEVICE_CLASS_PIMA_RC_OBJECT_ALREADY_OPENED                               0x2021
309 #define UX_DEVICE_CLASS_PIMA_RC_OBJECT_ALREADY_CLOSED                               0x2022
310 #define UX_DEVICE_CLASS_PIMA_RC_OBJECT_NOT_OPENED                                   0x2023
311 
312 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_OBJECT_PROP_CODE                            0xA801
313 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_OBJECT_PROP_FORMAT                          0xA802
314 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_OBJECT_PROP_VALUE                           0xA803
315 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_OBJECT_REFERENCE                            0xA804
316 #define UX_DEVICE_CLASS_PIMA_RC_INVALID_DATASET                                     0xA806
317 #define UX_DEVICE_CLASS_PIMA_RC_SPECIFICATION_BY_GROUP_UNSUPPORTED                  0xA807
318 #define UX_DEVICE_CLASS_PIMA_RC_SPECIFICATION_BY_DEPTH_UNSUPPORTED                  0xA808
319 #define UX_DEVICE_CLASS_PIMA_RC_OBJECT_TOO_LARGE                                    0xA809
320 #define UX_DEVICE_CLASS_PIMA_RC_OBJECT_PROP_NOT_SUPPORTED                           0xA80A
321 
322 /* Define PIMA Event Codes.  */
323 
324 #define UX_DEVICE_CLASS_PIMA_EC_UNDEFINED                                           0x4000
325 #define UX_DEVICE_CLASS_PIMA_EC_CANCEL_TRANSACTION                                  0x4001
326 #define UX_DEVICE_CLASS_PIMA_EC_OBJECT_ADDED                                        0x4002
327 #define UX_DEVICE_CLASS_PIMA_EC_OBJECT_REMOVED                                      0x4003
328 #define UX_DEVICE_CLASS_PIMA_EC_STORE_ADDED                                         0x4004
329 #define UX_DEVICE_CLASS_PIMA_EC_STORE_REMOVED                                       0x4005
330 #define UX_DEVICE_CLASS_PIMA_EC_DEVICE_PROP_CHANGED                                 0x4006
331 #define UX_DEVICE_CLASS_PIMA_EC_OBJECT_INFO_CHANGED                                 0x4007
332 #define UX_DEVICE_CLASS_PIMA_EC_DEVICE_INFO_CHANGED                                 0x4008
333 #define UX_DEVICE_CLASS_PIMA_EC_REQUEST_OBJECT_TRANSFER                             0x4009
334 #define UX_DEVICE_CLASS_PIMA_EC_STORE_FULL                                          0x400A
335 #define UX_DEVICE_CLASS_PIMA_EC_DEVICE_RESET                                        0x400B
336 #define UX_DEVICE_CLASS_PIMA_EC_STORAGE_INFO_CHANGED                                0x400C
337 #define UX_DEVICE_CLASS_PIMA_EC_CAPTURE_COMPLETE                                    0x400D
338 #define UX_DEVICE_CLASS_PIMA_EC_UNREPORTED_STATUS                                   0x400E
339 
340 /* Define PIMA Object Format Codes.  */
341 
342 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED                                          0x3000
343 #define UX_DEVICE_CLASS_PIMA_OFC_ASSOCIATION                                        0x3001
344 #define UX_DEVICE_CLASS_PIMA_OFC_SCRIPT                                             0x3002
345 #define UX_DEVICE_CLASS_PIMA_OFC_EXECUTABLE                                         0x3003
346 #define UX_DEVICE_CLASS_PIMA_OFC_TEXT                                               0x3004
347 #define UX_DEVICE_CLASS_PIMA_OFC_HTML                                               0x3005
348 #define UX_DEVICE_CLASS_PIMA_OFC_DPOF                                               0x3006
349 #define UX_DEVICE_CLASS_PIMA_OFC_AIFF                                               0x3007
350 #define UX_DEVICE_CLASS_PIMA_OFC_WAV                                                0x3008
351 #define UX_DEVICE_CLASS_PIMA_OFC_MP3                                                0x3009
352 #define UX_DEVICE_CLASS_PIMA_OFC_AVI                                                0x300A
353 #define UX_DEVICE_CLASS_PIMA_OFC_MPEG                                               0x300B
354 #define UX_DEVICE_CLASS_PIMA_OFC_ASF                                                0x300C
355 #define UX_DEVICE_CLASS_PIMA_OFC_DEFINED                                            0x3800
356 #define UX_DEVICE_CLASS_PIMA_OFC_EXIF_JPEG                                          0x3801
357 #define UX_DEVICE_CLASS_PIMA_OFC_TIFF_EP                                            0x3802
358 #define UX_DEVICE_CLASS_PIMA_OFC_FLASHPIX                                           0x3803
359 #define UX_DEVICE_CLASS_PIMA_OFC_BMP                                                0x3804
360 #define UX_DEVICE_CLASS_PIMA_OFC_CIFF                                               0x3805
361 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_2                                        0x3806
362 #define UX_DEVICE_CLASS_PIMA_OFC_GIF                                                0x3807
363 #define UX_DEVICE_CLASS_PIMA_OFC_JFIF                                               0x3808
364 #define UX_DEVICE_CLASS_PIMA_OFC_CD                                                 0x3809
365 #define UX_DEVICE_CLASS_PIMA_OFC_PICT                                               0x380A
366 #define UX_DEVICE_CLASS_PIMA_OFC_PNG                                                0x380B
367 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_3                                        0x380C
368 #define UX_DEVICE_CLASS_PIMA_OFC_TIFF                                               0x380D
369 #define UX_DEVICE_CLASS_PIMA_OFC_TIFF_IT                                            0x380E
370 #define UX_DEVICE_CLASS_PIMA_OFC_JP2                                                0x380F
371 #define UX_DEVICE_CLASS_PIMA_OFC_JPX                                                0x3810
372 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_FIRMWARE                                 0xB802
373 #define UX_DEVICE_CLASS_PIMA_OFC_WINDOWS_IMAGE_FORMAT                               0xB881
374 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_AUDIO                                    0xB900
375 #define UX_DEVICE_CLASS_PIMA_OFC_WMA                                                0xB901
376 #define UX_DEVICE_CLASS_PIMA_OFC_OGG                                                0xB902
377 #define UX_DEVICE_CLASS_PIMA_OFC_AAC                                                0xB903
378 #define UX_DEVICE_CLASS_PIMA_OFC_AUDIBLE                                            0xB904
379 #define UX_DEVICE_CLASS_PIMA_OFC_FLAC                                               0xB906
380 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_VIDEO                                    0xB980
381 #define UX_DEVICE_CLASS_PIMA_OFC_WMV                                                0xB981
382 #define UX_DEVICE_CLASS_PIMA_OFC_MP4_CONTAINER                                      0xB982
383 #define UX_DEVICE_CLASS_PIMA_OFC_MP2                                                0xB983
384 #define UX_DEVICE_CLASS_PIMA_OFC_3GP_CONTAINER                                      0xB984
385 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_COLLECTION                               0xBA00
386 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_MULTIMEDIA_ALBUM                          0xBA01
387 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_IMAGE_ALBUM                               0xBA02
388 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_AUDIO_ALBUM                               0xBA03
389 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_VIDEO_ALBUM                               0xBA04
390 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_AUDIO_AND_VIDEO_PLAYLIST                  0xBA05
391 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_CONTACT_GROUP                             0xBA06
392 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_MESSAGE_FOLDER                            0xBA07
393 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_CHAPTERED_PRODUCTION                      0xBA08
394 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_AUDIO_PLAYLIST                            0xBA09
395 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_VIDEO_PLAYLIST                            0xBA0A
396 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_MEDIACAST                                 0xBA0B
397 #define UX_DEVICE_CLASS_PIMA_OFC_WPL_PLAYLIST                                       0xBA10
398 #define UX_DEVICE_CLASS_PIMA_OFC_M3U_PLAYLIST                                       0xBA11
399 #define UX_DEVICE_CLASS_PIMA_OFC_MPL_PLAYLIST                                       0xBA12
400 #define UX_DEVICE_CLASS_PIMA_OFC_ASX_PLAYLIST                                       0xBA13
401 #define UX_DEVICE_CLASS_PIMA_OFC_PLS_PLAYLIST                                       0xBA14
402 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_DOCUMENT                                 0xBA80
403 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_DOCUMENT                                  0xBA81
404 #define UX_DEVICE_CLASS_PIMA_OFC_XML_DOCUMENT                                       0xBA82
405 #define UX_DEVICE_CLASS_PIMA_OFC_MICROSOFT_WORD_DOCUMENT                            0xBA83
406 #define UX_DEVICE_CLASS_PIMA_OFC_MHT_COMPILED_HTML_DOCUMENT                         0xBA84
407 #define UX_DEVICE_CLASS_PIMA_OFC_MICROSOFT_EXCEL_SPREADSHEET                        0xBA85
408 #define UX_DEVICE_CLASS_PIMA_OFC_MICROSOFT_POWERPOINT_PRESENTATION                  0xBA86
409 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_MESSAGE                                  0xBB00
410 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_MESSAGE                                   0xBB01
411 #define UX_DEVICE_CLASS_PIMA_OFC_UNDEFINED_CONTACT                                  0xBB80
412 #define UX_DEVICE_CLASS_PIMA_OFC_ABSTRACT_CONTACT                                   0xBB81
413 #define UX_DEVICE_CLASS_PIMA_OFC_VCARD2                                             0xBB82
414 
415 /* Define PIMA Device Format Codes.  */
416 
417 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_UNDEFINED                                     0x5000
418 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_BATTERY_LEVEL                                 0x5001
419 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_FUNCTIONAL_MODE                               0x5002
420 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_IMAGE_SIZE                                    0x5003
421 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_COMPRESSION_SETTING                           0x5004
422 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_WHITE_BALANCE                                 0x5005
423 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_RGB_GAIN                                      0x5006
424 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_F_NUMBER                                      0x5007
425 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_FOCAL_LENGTH                                  0x5008
426 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_FOCUS_DISTANCE                                0x5009
427 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_FOCUS_MODE                                    0x500A
428 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_EXPOSURE_METERING_MODE                        0x500B
429 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_FLASH_MODE                                    0x500C
430 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_EXPOSURE_TIME                                 0x500D
431 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_EXPOSURE_PROGRAM_MODE                         0x500E
432 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_EXPOSURE_INDEX                                0x500F
433 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_EXPOSURE_BIAS_COMPENSATION                    0x5010
434 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_DATE_TIME                                     0x5011
435 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_CAPTURE_DELAY                                 0x5012
436 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_STILL_CAPTURE_MODE                            0x5013
437 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_CONTRAST                                      0x5014
438 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_SHARPNESS                                     0x5015
439 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_DIGITAL_ZOOM                                  0x5016
440 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_EFFECT_MODE                                   0x5017
441 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_BURST_NUMBER                                  0x5018
442 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_BURST_INTERVAL                                0x5019
443 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_TIME_LAPSE_NUMBER                             0x501A
444 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_TIME_LAPSE_INTERVAL                           0x501B
445 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_FOCUS_METERING_MODE                           0x501C
446 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_UPLOAD_URL                                    0x501D
447 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_ARTIST                                        0x501E
448 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_COPYRIGHT_INFO                                0x501F
449 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_SYNCHRONIZATION_PARTNER                       0xD401
450 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_DEVICE_FRIENDLY_NAME                          0xD402
451 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_VOLUME                                        0xD403
452 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_SUPPORTED_FORMATS_ORDERED                     0xD404
453 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_DEVICE_ICON                                   0xD405
454 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_PLAYBACK_RATE                                 0xD410
455 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_PLAYBACK_OBJECT                               0xD411
456 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_PLAYBACK_CONTAINER                            0xD412
457 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_SESSION_INITIATOR_VERSION_INFO                0xD406
458 #define UX_DEVICE_CLASS_PIMA_DEV_PROP_PERCEIVED_DEVICE_TYPE                         0xD407
459 
460 /* Define PIMA Object Format Codes.  */
461 
462 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_STORAGEID                                  0xDC01
463 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_OBJECT_FORMAT                              0xDC02
464 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PROTECTION_STATUS                          0xDC03
465 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_OBJECT_SIZE                                0xDC04
466 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ASSOCIATION_TYPE                           0xDC05
467 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ASSOCIATION_DESC                           0xDC06
468 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_OBJECT_FILE_NAME                           0xDC07
469 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_DATE_CREATED                               0xDC08
470 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_DATE_MODIFIED                              0xDC09
471 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_KEYWORDS                                   0xDC0A
472 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PARENT_OBJECT                              0xDC0B
473 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ALLOWED_FOLDER_CONTENTS                    0xDC0C
474 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_HIDDEN                                     0xDC0D
475 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SYSTEM_OBJECT                              0xDC0E
476 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PERSISTENT_UNIQUE_OBJECT_IDENTIFIER        0xDC41
477 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SYNCID                                     0xDC42
478 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PROPERTY_BAG                               0xDC43
479 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_NAME                                       0xDC44
480 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_CREATED_BY                                 0xDC45
481 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ARTIST                                     0xDC46
482 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_DATE_AUTHORED                              0xDC47
483 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_DESCRIPTION                                0xDC48
484 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_URL_REFERENCE                              0xDC49
485 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_LANGUAGE_LOCALE                            0xDC4A
486 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_COPYRIGHT_INFORMATION                      0xDC4B
487 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SOURCE                                     0xDC4C
488 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ORIGIN_LOCATION                            0xDC4D
489 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_DATE_ADDED                                 0xDC4E
490 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_NON_CONSUMABLE                             0xDC4F
491 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_CORRUPT_UNPLAYABLE                         0xDC50
492 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PRODUCER_SERIA_LNUMBER                     0xDC51
493 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_REPRESENTATIVE_SAMPLE_FORMAT               0xDC81
494 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_REPRESENTATIVE_SAMPLE_SIZE                 0xDC82
495 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_REPRESENTATIVE_SAMPLE_HEIGHT               0xDC83
496 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_REPRESENTATIVE_SAMPLE_WIDTH                0xDC84
497 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_REPRESENTATIVE_SAMPLE_DURATION             0xDC85
498 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_REPRESENTATIVE_SAMPLE_DATA                 0xDC86
499 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_WIDTH                                      0xDC87
500 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_HEIGHT                                     0xDC88
501 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_DURATION                                   0xDC89
502 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_RATING                                     0xDC8A
503 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_TRACK                                      0xDC8B
504 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_GENRE                                      0xDC8C
505 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_CREDITS                                    0xDC8D
506 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_LYRICS                                     0xDC8E
507 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SUBSCRIPTION_CONTENT_ID                    0xDC8F
508 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PRODUCED_BY                                0xDC90
509 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_USE_COUNT                                  0xDC91
510 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SKIP_COUNT                                 0xDC92
511 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_LAST_ACCESSED                              0xDC93
512 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PARENTAL_RATING                            0xDC94
513 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_META_GENRE                                 0xDC95
514 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_COMPOSER                                   0xDC96
515 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EFFECTIVE_RATING                           0xDC97
516 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SUBTITLE                                   0xDC98
517 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ORIGINAL_RELEASE_DATE                      0xDC99
518 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ALBUM_NAME                                 0xDC9A
519 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ALBUM_ARTIST                               0xDC9B
520 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MOOD                                       0xDC9C
521 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_DRM_STATUS                                 0xDC9D
522 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SUB_DESCRIPTION                            0xDC9E
523 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_IS_CROPPED                                 0xDCD1
524 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_IS_COLOUR_CORRECTED                        0xDCD2
525 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_IMAGE_BIT_DEPTH                            0xDCD3
526 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_FNUMBER                                    0xDCD4
527 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EXPOSURE_TIME                              0xDCD5
528 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EXPOSURE_INDEX                             0xDCD6
529 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_TOTAL_BITRATE                              0xDE91
530 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_BITRATE_TYPE                               0xDE92
531 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SAMPLE_RATE                                0xDE93
532 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_NUMBER_OF_CHANNELS                         0xDE94
533 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_AUDIO_BITDEPTH                             0xDE95
534 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SCAN_TYPE                                  0xDE97
535 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_AUDIO_WAVE_CODEC                           0xDE99
536 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_AUDIO_BITRATE                              0xDE9A
537 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_VIDEO_FOURCC_CODEC                         0xDE9B
538 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_VIDEO_BITRATE                              0xDE9C
539 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_FRAMES_PER_THOUSAND_SECONDS                0xDE9D
540 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_KEYFRAME_DISTANCE                          0xDE9E
541 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_BUFFER_SIZE                                0xDE9F
542 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ENCODING_QUALITY                           0xDEA0
543 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ENCODING_PROFILE                           0xDEA1
544 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_DISPLAY_NAME                               0xDCE0
545 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_BODY_TEXT                                  0xDCE1
546 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SUBJECT                                    0xDCE2
547 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PRIORITY                                   0xDCE3
548 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_GIVEN_NAME                                 0xDD00
549 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MIDDLE_NAMES                               0xDD01
550 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_FAMILY_NAME                                0xDD02
551 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PREFIX                                     0xDD03
552 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_SUFFIX                                     0xDD04
553 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONETIC_GIVEN_NAME                        0xDD05
554 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONETIC_FAMILY_NAME                       0xDD06
555 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EMAIL_PRIMARY                              0xDD07
556 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EMAIL_PERSONAL_1                           0xDD08
557 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EMAIL_PERSONAL_2                           0xDD09
558 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EMAIL_BUSINESS_1                           0xDD0A
559 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EMAIL_BUSINESS_2                           0xDD0B
560 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EMAIL_OTHERS                               0xDD0C
561 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONE_NUMBER_PRIMARY                       0xDD0D
562 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONE_NUMBER_PERSONAL                      0xDD0E
563 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONE_NUMBER_PERSONAL_2                    0xDD0F
564 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONE_NUMBER_BUSINESS                      0xDD10
565 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONE_NUMBER_BUSINESS_2                    0xDD11
566 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONE_NUMBER_MOBILE                        0xDD12
567 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONE_NUMBER_MOBILE_2                      0xDD13
568 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_FAX_NUMBER_PRIMARY                         0xDD14
569 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_FAX_NUMBER_PERSONAL                        0xDD15
570 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_FAX_NUMBER_BUSINESS                        0xDD16
571 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PAGER_NUMBER                               0xDD17
572 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONE_NUMBER_OTHERS                        0xDD18
573 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PRIMARY_WEB_ADDRESS                        0xDD19
574 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PERSONAL_WEB_ADDRESS                       0xDD1A
575 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_BUSINESS_WEB_ADDRESS                       0xDD1B
576 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_INSTANT_MESSENGER_ADDRESS                  0xDD1C
577 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_INSTANT_MESSENGER_ADDRESS_2                0xDD1D
578 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_INSTANT_MESSENGER_ADDRESS_3                0xDD1E
579 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_PERSONAL_FULL               0xDD1F
580 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_PERSONAL_LINE_1             0xDD20
581 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_PERSONAL_LINE_2             0xDD21
582 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_PERSONAL_CITY               0xDD22
583 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_PERSONAL_REGION             0xDD23
584 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_PERSONAL_POSTAL_CODE        0xDD24
585 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_PERSONAL_COUNTRY            0xDD25
586 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_BUSINESS_FULL               0xDD26
587 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_BUSINESS_LINE_1             0xDD27
588 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_BUSINESS_LINE_2             0xDD28
589 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_BUSINESS_CITY               0xDD29
590 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_BUSINESS_REGION             0xDD2A
591 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_BUSINESS_POSTAL_CODE        0xDD2B
592 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_BUSINESS_COUNTRY            0xDD2C
593 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_OTHER_FULL                  0xDD2D
594 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_OTHER_LINE_1                0xDD2E
595 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_OTHER_LINE_2                0xDD2F
596 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_OTHER_CITY                  0xDD30
597 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_OTHER_REGION                0xDD31
598 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_OTHER_POSTAL_CODE           0xDD32
599 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_POSTAL_ADDRESS_OTHER_COUNTRY               0xDD33
600 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ORGANIZATION_NAME                          0xDD34
601 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_PHONETIC_ORGANIZATION_NAME                 0xDD35
602 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ROLE                                       0xDD36
603 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_BIRTHDATE                                  0xDD37
604 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MESSAGE_TO                                 0xDD40
605 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MESSAGE_CC                                 0xDD41
606 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MESSAGE_BCC                                0xDD42
607 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MESSAGE_READ                               0xDD43
608 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MESSAGE_RECEIVED_TIME                      0xDD44
609 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MESSAGE_SENDER                             0xDD45
610 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ACTIVITY_BEGIN_TIME                        0xDD50
611 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ACTIVITY_END_TIME                          0xDD51
612 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ACTIVITY_LOCATION                          0xDD52
613 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ACTIVITY_REQUIRED_ATTENDEES                0xDD54
614 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ACTIVITY_OPTIONAL_ATTENDEES                0xDD55
615 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ACTIVITY_RESOURCES                         0xDD56
616 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_ACTIVITY_ACCEPTED                          0xDD57
617 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_OWNER                                      0xDD5D
618 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_EDITOR                                     0xDD5E
619 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_WEBMASTER                                  0xDD5F
620 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_URL_SOURCE                                 0xDD60
621 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_URL_DESTINATION                            0xDD61
622 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_TIME_BOOKMARK                              0xDD62
623 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_OBJECT_BOOKMARK                            0xDD63
624 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_BYTE_BOOKMARK                              0xDD64
625 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_LAST_BUILD_DATE                            0xDD70
626 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_TIME_TO_LIVE                               0xDD71
627 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROP_MEDIA_GUID                                 0xDD72
628 
629 /* Define PIMA Object Protection Status Values.  */
630 
631 #define UX_DEVICE_CLASS_PIMA_OPS_NO_PROTECTION                                      0x0000
632 #define UX_DEVICE_CLASS_PIMA_OPS_READ_ONLY                                          0x0001
633 
634 /* Define PIMA Storage Types Codes.  */
635 
636 #define UX_DEVICE_CLASS_PIMA_STC_UNDEFINED                                          0x0000
637 #define UX_DEVICE_CLASS_PIMA_STC_FIXED_ROM                                          0x0001
638 #define UX_DEVICE_CLASS_PIMA_STC_REMOVABLE_ROM                                      0x0002
639 #define UX_DEVICE_CLASS_PIMA_STC_FIXED_RAM                                          0x0003
640 #define UX_DEVICE_CLASS_PIMA_STC_REMOVABLE_RAM                                      0x0004
641 
642 /* Define PIMA File System Types Codes.  */
643 
644 #define UX_DEVICE_CLASS_PIMA_FSTC_UNDEFINED                                         0x0000
645 #define UX_DEVICE_CLASS_PIMA_FSTC_GENERIC_FLAT                                      0x0001
646 #define UX_DEVICE_CLASS_PIMA_FSTC_GENERIC_HIERARCHICAL                              0x0002
647 #define UX_DEVICE_CLASS_PIMA_FSTC_DCF                                               0x0003
648 
649 /* Define PIMA File System Access Types Codes.  */
650 
651 #define UX_DEVICE_CLASS_PIMA_AC_READ_WRITE                                          0x0000
652 #define UX_DEVICE_CLASS_PIMA_AC_RO_WITHOUT_OBJECT_DELETION                          0x0001
653 #define UX_DEVICE_CLASS_PIMA_AC_RO_WITH_OBJECT_DELETION                             0x0002
654 
655 /* Define PIMA types.  */
656 #define UX_DEVICE_CLASS_PIMA_TYPES_INT8                                             0x0001
657 #define UX_DEVICE_CLASS_PIMA_TYPES_UINT8                                            0x0002
658 #define UX_DEVICE_CLASS_PIMA_TYPES_INT16                                            0x0003
659 #define UX_DEVICE_CLASS_PIMA_TYPES_UINT16                                           0x0004
660 #define UX_DEVICE_CLASS_PIMA_TYPES_INT32                                            0x0005
661 #define UX_DEVICE_CLASS_PIMA_TYPES_UINT32                                           0x0006
662 #define UX_DEVICE_CLASS_PIMA_TYPES_INT64                                            0x0007
663 #define UX_DEVICE_CLASS_PIMA_TYPES_UINT64                                           0x0008
664 #define UX_DEVICE_CLASS_PIMA_TYPES_INT128                                           0x0009
665 #define UX_DEVICE_CLASS_PIMA_TYPES_UINT128                                          0x000A
666 #define UX_DEVICE_CLASS_PIMA_TYPES_AINT8                                            0x4001
667 #define UX_DEVICE_CLASS_PIMA_TYPES_AUINT8                                           0x4002
668 #define UX_DEVICE_CLASS_PIMA_TYPES_AINT16                                           0x4003
669 #define UX_DEVICE_CLASS_PIMA_TYPES_AUINT16                                          0x4004
670 #define UX_DEVICE_CLASS_PIMA_TYPES_AINT32                                           0x4005
671 #define UX_DEVICE_CLASS_PIMA_TYPES_AUINT32                                          0x4006
672 #define UX_DEVICE_CLASS_PIMA_TYPES_AINT64                                           0x4007
673 #define UX_DEVICE_CLASS_PIMA_TYPES_AUINT64                                          0x4008
674 #define UX_DEVICE_CLASS_PIMA_TYPES_AINT128                                          0x4009
675 #define UX_DEVICE_CLASS_PIMA_TYPES_AUINT128                                         0x400A
676 #define UX_DEVICE_CLASS_PIMA_TYPES_STR                                              0xFFFF
677 
678 /* Define PIMA Device Info fields.  */
679 
680 #define UX_DEVICE_CLASS_PIMA_DEVICE_INFO_STANDARD_VERSION               (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 0x0000)
681 #define UX_DEVICE_CLASS_PIMA_DEVICE_INFO_VENDOR_EXTENSION_ID            (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 0x0002)
682 #define UX_DEVICE_CLASS_PIMA_DEVICE_INFO_VENDOR_EXTENSION_VERSION       (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 0x0006)
683 #define UX_DEVICE_CLASS_PIMA_DEVICE_INFO_VENDOR_EXTENSION_DESC          (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 0x0008)
684 
685 /* Define PIMA MTP OBJECT PROPERTY DATASET.  */
686 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROPERTY_DATASET_CODE                           0x0000
687 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROPERTY_DATASET_DATATYPE                       0x0002
688 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROPERTY_DATASET_GETSET                         0x0004
689 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROPERTY_DATASET_VALUE                          0x0005
690 
691 /* Define PIMA Dataset equivalences.  */
692 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROPERTY_DATASET_VALUE_GET                      0x00
693 #define UX_DEVICE_CLASS_PIMA_OBJECT_PROPERTY_DATASET_VALUE_GETSET                   0x01
694 
695 /* Define PIMA event info structure.  */
696 
697 typedef struct UX_SLAVE_CLASS_PIMA_EVENT_STRUCT
698 {
699     ULONG                   ux_device_class_pima_event_code;
700     ULONG                   ux_device_class_pima_event_session_id;
701     ULONG                   ux_device_class_pima_event_transaction_id;
702     ULONG                   ux_device_class_pima_event_parameter_1;
703     ULONG                   ux_device_class_pima_event_parameter_2;
704     ULONG                   ux_device_class_pima_event_parameter_3;
705 
706 } UX_SLAVE_CLASS_PIMA_EVENT;
707 
708 /* Define PIMA object info structure.  */
709 
710 typedef struct UX_SLAVE_CLASS_PIMA_OBJECT_STRUCT
711 {
712 
713     ULONG                   ux_device_class_pima_object_storage_id;
714     ULONG                   ux_device_class_pima_object_format;
715     ULONG                   ux_device_class_pima_object_protection_status;
716     ULONG                   ux_device_class_pima_object_compressed_size;
717     ULONG                   ux_device_class_pima_object_thumb_format;
718     ULONG                   ux_device_class_pima_object_thumb_compressed_size;
719     ULONG                   ux_device_class_pima_object_thumb_pix_width;
720     ULONG                   ux_device_class_pima_object_thumb_pix_height;
721     ULONG                   ux_device_class_pima_object_image_pix_width;
722     ULONG                   ux_device_class_pima_object_image_pix_height;
723     ULONG                   ux_device_class_pima_object_image_bit_depth;
724     ULONG                   ux_device_class_pima_object_parent_object;
725     ULONG                   ux_device_class_pima_object_association_type;
726     ULONG                   ux_device_class_pima_object_association_desc;
727     ULONG                   ux_device_class_pima_object_sequence_number;
728     UCHAR                   ux_device_class_pima_object_filename[UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH];
729     UCHAR                   ux_device_class_pima_object_capture_date[UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH];
730     UCHAR                   ux_device_class_pima_object_modification_date[UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH];
731     UCHAR                   ux_device_class_pima_object_keywords[UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH];
732     ULONG                   ux_device_class_pima_object_state;
733     ULONG                   ux_device_class_pima_object_offset;
734     ULONG                   ux_device_class_pima_object_transfer_status;
735     ULONG                   ux_device_class_pima_object_handle_id;
736     ULONG                   ux_device_class_pima_object_length;
737     UCHAR                   *ux_device_class_pima_object_buffer;
738 
739 } UX_SLAVE_CLASS_PIMA_OBJECT;
740 
741 #define UX_SLAVE_CLASS_PIMA_OBJECT_DATA_LENGTH ((15 * sizeof(ULONG)) + \
742                                                     UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH + \
743                                                     UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH + \
744                                                     UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH + \
745                                                     UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH)
746 
747 /* Define PIMA session info structure.  Not used in the device. Here for structure compatibility. */
748 
749 typedef struct UX_SLAVE_CLASS_PIMA_SESSION_STRUCT
750 {
751 
752     ULONG                   ux_device_class_pima_session_id;
753 
754 } UX_SLAVE_CLASS_PIMA_SESSION;
755 
756 /* Define PIMA device info structure.  */
757 
758 typedef struct UX_SLAVE_CLASS_PIMA_DEVICE_STRUCT
759 {
760 
761     ULONG                   ux_device_class_pima_device_standard_version;
762     ULONG                   ux_device_class_pima_device_vendor_extension_id;
763     ULONG                   ux_device_class_pima_device_vendor_extension_version;
764     UCHAR                   ux_device_class_pima_device_vendor_extension_desc[UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH];
765     ULONG                   ux_device_class_pima_device_functional_mode;
766     UCHAR                   ux_device_class_pima_device_operations_supported[UX_DEVICE_CLASS_PIMA_ARRAY_MAX_LENGTH];
767     UCHAR                   ux_device_class_pima_device_events_supported[UX_DEVICE_CLASS_PIMA_ARRAY_MAX_LENGTH];
768     UCHAR                   ux_device_class_pima_device_properties_supported[UX_DEVICE_CLASS_PIMA_ARRAY_MAX_LENGTH];
769     UCHAR                   ux_device_class_pima_device_capture_formats[UX_DEVICE_CLASS_PIMA_ARRAY_MAX_LENGTH];
770     UCHAR                   ux_device_class_pima_device_image_formats[UX_DEVICE_CLASS_PIMA_ARRAY_MAX_LENGTH];
771     UCHAR                   ux_device_class_pima_device_manufacturer[UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH];
772     UCHAR                   ux_device_class_pima_device_model[UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH];
773     UCHAR                   ux_device_class_pima_device_version[UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH];
774     UCHAR                   ux_device_class_pima_device_serial_number[UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH];
775 
776 } UX_SLAVE_CLASS_PIMA_DEVICE;
777 
778 /* Define PIMA storage info structure.  */
779 
780 typedef struct UX_SLAVE_CLASS_PIMA_STORAGE_STRUCT
781 {
782 
783     ULONG                   ux_device_class_pima_storage_type;
784     ULONG                   ux_device_class_pima_storage_file_system_type;
785     ULONG                   ux_device_class_pima_storage_access_capability;
786     ULONG                   ux_device_class_pima_storage_max_capacity_low;
787     ULONG                   ux_device_class_pima_storage_max_capacity_high;
788     ULONG                   ux_device_class_pima_storage_free_space_bytes_low;
789     ULONG                   ux_device_class_pima_storage_free_space_bytes_high;
790     ULONG                   ux_device_class_pima_storage_free_space_images;
791     UCHAR                   ux_device_class_pima_storage_description[UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH];
792     UCHAR                   ux__class_pima_storage_volume_label[UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH];
793 
794 } UX_SLAVE_CLASS_PIMA_STORAGE;
795 
796 /* Define PIMA structure.  */
797 
798 typedef struct UX_SLAVE_CLASS_PIMA_STRUCT
799 {
800 
801     UX_SLAVE_INTERFACE      *ux_slave_class_pima_interface;
802     UX_SLAVE_ENDPOINT       *ux_device_class_pima_bulk_in_endpoint;
803     UX_SLAVE_ENDPOINT       *ux_device_class_pima_bulk_out_endpoint;
804     UX_SLAVE_ENDPOINT       *ux_device_class_pima_interrupt_endpoint;
805     UINT                    ux_device_class_pima_state;
806     USHORT                  ux_device_class_pima_device_status;
807     ULONG                   ux_device_class_pima_session_id;
808     ULONG                   ux_device_class_pima_current_object_handle;
809     ULONG                   ux_device_class_pima_transaction_id;
810     UCHAR                   *ux_device_class_pima_manufacturer;
811     UCHAR                   *ux_device_class_pima_model;
812     UCHAR                   *ux_device_class_pima_device_version;
813     UCHAR                   *ux_device_class_pima_serial_number;
814     ULONG                   ux_device_class_pima_storage_id;
815     ULONG                   ux_device_class_pima_storage_type;
816     ULONG                   ux_device_class_pima_storage_file_system_type;
817     ULONG                   ux_device_class_pima_storage_access_capability;
818     ULONG                   ux_device_class_pima_storage_max_capacity_low;
819     ULONG                   ux_device_class_pima_storage_max_capacity_high;
820     ULONG                   ux_device_class_pima_storage_free_space_low;
821     ULONG                   ux_device_class_pima_storage_free_space_high;
822     ULONG                   ux_device_class_pima_storage_free_space_image;
823     UCHAR                   *ux_device_class_pima_storage_description;
824     UCHAR                   *ux_device_class_pima_storage_volume_label;
825 #if !defined(UX_DEVICE_STANDALONE)
826     UX_SEMAPHORE            ux_device_class_pima_semaphore;
827     UX_THREAD               ux_device_class_pima_interrupt_thread;
828     UCHAR                   *ux_device_class_pima_interrupt_thread_stack;
829     UX_SEMAPHORE            ux_device_class_pima_interrupt_thread_semaphore;
830 #endif
831     UX_SLAVE_CLASS_PIMA_EVENT
832                             *ux_device_class_pima_event_array;
833     UX_SLAVE_CLASS_PIMA_EVENT
834                             *ux_device_class_pima_event_array_head;
835     UX_SLAVE_CLASS_PIMA_EVENT
836                             *ux_device_class_pima_event_array_tail;
837     UX_SLAVE_CLASS_PIMA_EVENT
838                             *ux_device_class_pima_event_array_end;
839     USHORT                  *ux_device_class_pima_device_properties_list;
840     USHORT                  *ux_device_class_pima_supported_capture_formats_list;
841     USHORT                  *ux_device_class_pima_supported_image_formats_list;
842     USHORT                  *ux_device_class_pima_object_properties_list;
843     UINT                    (*ux_device_class_pima_cancel)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima);
844     UINT                    (*ux_device_class_pima_device_reset)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima);
845 
846     UINT                    (*ux_device_class_pima_device_prop_desc_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG device_property, UCHAR **device_prop_dataset, ULONG *device_prop_dataset_length);
847     UINT                    (*ux_device_class_pima_device_prop_value_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG device_property, UCHAR **device_prop_value, ULONG *device_prop_value_length);
848     UINT                    (*ux_device_class_pima_device_prop_value_set)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG device_property, UCHAR *device_prop_value, ULONG device_prop_value_length);
849 
850     UINT                    (*ux_device_class_pima_storage_format)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG storage_id);
851     UINT                    (*ux_device_class_pima_storage_info_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG storage_id);
852     UINT                    (*ux_device_class_pima_object_number_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_format_code, ULONG object_association, ULONG *object_number);
853     UINT                    (*ux_device_class_pima_object_handles_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handles_format_code,
854                                                                         ULONG object_handles_association,
855                                                                         ULONG *object_handles_array,
856                                                                         ULONG object_handles_max_number);
857     UINT                    (*ux_device_class_pima_object_info_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, UX_SLAVE_CLASS_PIMA_OBJECT **object);
858     UINT                    (*ux_device_class_pima_object_data_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, UCHAR *object_buffer, ULONG object_offset,
859                                                                 ULONG object_length_requested, ULONG *object_actual_length);
860     UINT                    (*ux_device_class_pima_object_info_send)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, UX_SLAVE_CLASS_PIMA_OBJECT *object, ULONG storage_id, ULONG parent_object_handle, ULONG *object_handle);
861     UINT                    (*ux_device_class_pima_object_data_send)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, ULONG phase, UCHAR *object_buffer, ULONG object_offset,
862                                                                 ULONG object_length);
863     UINT                    (*ux_device_class_pima_object_delete)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle);
864     UINT                    (*ux_device_class_pima_object_prop_desc_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_property, ULONG object_format_code, UCHAR **object_prop_value_dataset, ULONG *object_prop_value_dataset_length);
865     UINT                    (*ux_device_class_pima_object_prop_value_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, ULONG object_property, UCHAR **object_prop_value, ULONG *object_prop_value_length);
866     UINT                    (*ux_device_class_pima_object_prop_value_set)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, ULONG object_property, UCHAR *object_prop_value, ULONG object_prop_value_length);
867     UINT                    (*ux_device_class_pima_object_references_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, UCHAR **object_handle_array, ULONG *object_handle_array_length);
868     UINT                    (*ux_device_class_pima_object_references_set)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, UCHAR *object_handle_array, ULONG object_handle_array_length);
869     VOID                    *ux_device_class_pima_application;
870     VOID                    (*ux_device_class_pima_instance_activate)(VOID *);
871     VOID                    (*ux_device_class_pima_instance_deactivate)(VOID *);
872 
873 
874 } UX_SLAVE_CLASS_PIMA;
875 
876 /* Define PIMA initialization command structure.  */
877 
878 typedef struct UX_SLAVE_CLASS_PIMA_PARAMETER_STRUCT
879 {
880 
881     VOID                    (*ux_device_class_pima_instance_activate)(VOID *);
882     VOID                    (*ux_device_class_pima_instance_deactivate)(VOID *);
883     UCHAR                   *ux_device_class_pima_parameter_manufacturer;
884     UCHAR                   *ux_device_class_pima_parameter_model;
885     UCHAR                   *ux_device_class_pima_parameter_device_version;
886     UCHAR                   *ux_device_class_pima_parameter_serial_number;
887     ULONG                   ux_device_class_pima_parameter_storage_id;
888     ULONG                   ux_device_class_pima_parameter_storage_type;
889     ULONG                   ux_device_class_pima_parameter_storage_file_system_type;
890     ULONG                   ux_device_class_pima_parameter_storage_access_capability;
891     ULONG                   ux_device_class_pima_parameter_storage_max_capacity_low;
892     ULONG                   ux_device_class_pima_parameter_storage_max_capacity_high;
893     ULONG                   ux_device_class_pima_parameter_storage_free_space_low;
894     ULONG                   ux_device_class_pima_parameter_storage_free_space_high;
895     ULONG                   ux_device_class_pima_parameter_storage_free_space_image;
896     UCHAR                   *ux_device_class_pima_parameter_storage_description;
897     UCHAR                   *ux_device_class_pima_parameter_storage_volume_label;
898     USHORT                  *ux_device_class_pima_parameter_device_properties_list;
899     USHORT                  *ux_device_class_pima_parameter_supported_capture_formats_list;
900     USHORT                  *ux_device_class_pima_parameter_supported_image_formats_list;
901     USHORT                  *ux_device_class_pima_parameter_object_properties_list;
902 
903     /* PIMA callbacks, return UX success, or PIMA RC code.  */
904     UINT                    (*ux_device_class_pima_parameter_cancel)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima);
905     UINT                    (*ux_device_class_pima_parameter_device_reset)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima);
906     UINT                    (*ux_device_class_pima_parameter_device_prop_desc_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG device_property, UCHAR **device_prop_dataset, ULONG *device_prop_dataset_length);
907     UINT                    (*ux_device_class_pima_parameter_device_prop_value_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG device_property, UCHAR **device_prop_value, ULONG *device_prop_value_length);
908     UINT                    (*ux_device_class_pima_parameter_device_prop_value_set)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG device_property, UCHAR *device_prop_value, ULONG device_prop_value_length);
909     UINT                    (*ux_device_class_pima_parameter_storage_format)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG storage_id);
910     UINT                    (*ux_device_class_pima_parameter_storage_info_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG storage_id);
911     UINT                    (*ux_device_class_pima_parameter_object_number_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_format_code, ULONG object_association, ULONG *object_number);
912     UINT                    (*ux_device_class_pima_parameter_object_handles_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handles_format_code,
913                                                                         ULONG object_handles_association,
914                                                                         ULONG *object_handles_array,
915                                                                         ULONG object_handles_max_number);
916     UINT                    (*ux_device_class_pima_parameter_object_info_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, UX_SLAVE_CLASS_PIMA_OBJECT **object);
917     UINT                    (*ux_device_class_pima_parameter_object_data_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, UCHAR *object_buffer, ULONG object_offset,
918                                                                 ULONG object_length_requested, ULONG *object_actual_length);
919 
920     UINT                    (*ux_device_class_pima_parameter_object_info_send)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, UX_SLAVE_CLASS_PIMA_OBJECT *object, ULONG storage_id, ULONG parent_object_handle, ULONG *object_handle);
921     UINT                    (*ux_device_class_pima_parameter_object_data_send)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, ULONG phase ,UCHAR *object_buffer, ULONG object_offset,
922                                                                 ULONG object_length);
923     UINT                    (*ux_device_class_pima_parameter_object_delete)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle);
924     UINT                    (*ux_device_class_pima_parameter_object_prop_desc_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, ULONG object_property, UCHAR **object_prop_dataset, ULONG *object_prop_dataset_length);
925     UINT                    (*ux_device_class_pima_parameter_object_prop_value_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, ULONG object_property, UCHAR **object_prop_value, ULONG *object_prop_value_length);
926     UINT                    (*ux_device_class_pima_parameter_object_prop_value_set)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, ULONG object_property, UCHAR *object_prop_value, ULONG object_prop_value_length);
927     UINT                    (*ux_device_class_pima_parameter_object_references_get)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, UCHAR **object_handle_array, ULONG *object_handle_array_length);
928     UINT                    (*ux_device_class_pima_parameter_object_references_set)(struct UX_SLAVE_CLASS_PIMA_STRUCT *pima, ULONG object_handle, UCHAR *object_handle_array, ULONG object_handle_array_length);
929     VOID                    *ux_device_class_pima_parameter_application;
930 
931 
932 } UX_SLAVE_CLASS_PIMA_PARAMETER;
933 
934 
935 /* Define PIMA Object decompaction structure.  */
936 
937 #define UX_DEVICE_CLASS_PIMA_OBJECT_MAX_LENGTH                              512
938 #define UX_DEVICE_CLASS_PIMA_OBJECT_VARIABLE_OFFSET                         52
939 #define UX_DEVICE_CLASS_PIMA_OBJECT_ENTRIES                                 15
940 
941 
942 /* Define PIMA storage decompaction structure.  */
943 
944 #define UX_DEVICE_CLASS_PIMA_STORAGE_TYPE                                   (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 0 )
945 #define UX_DEVICE_CLASS_PIMA_STORAGE_FILE_SYSTEM_TYPE                       (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 2 )
946 #define UX_DEVICE_CLASS_PIMA_STORAGE_ACCESS_CAPABILITY                      (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 4 )
947 #define UX_DEVICE_CLASS_PIMA_STORAGE_MAX_CAPACITY_LOW                       (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 6 )
948 #define UX_DEVICE_CLASS_PIMA_STORAGE_MAX_CAPACITY_HIGH                      (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 10)
949 #define UX_DEVICE_CLASS_PIMA_STORAGE_FREE_SPACE_LOW                         (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 14)
950 #define UX_DEVICE_CLASS_PIMA_STORAGE_FREE_SPACE_HIGH                        (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 18)
951 #define UX_DEVICE_CLASS_PIMA_STORAGE_FREE_SPACE_IMAGE                       (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 22)
952 #define UX_DEVICE_CLASS_PIMA_STORAGE_FREE_STORAGE_DESCRIPTION               (UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + 26)
953 
954 /* Define Pima Class function prototypes.  */
955 UINT  _ux_device_class_pima_initialize(UX_SLAVE_CLASS_COMMAND *command);
956 UINT  _ux_device_class_pima_activate(UX_SLAVE_CLASS_COMMAND *command);
957 UINT  _ux_device_class_pima_deactivate(UX_SLAVE_CLASS_COMMAND *command);
958 UINT  _ux_device_class_pima_control_request(UX_SLAVE_CLASS_COMMAND *command);
959 UINT  _ux_device_class_pima_device_info_send(UX_SLAVE_CLASS_PIMA *pima);
960 UINT  _ux_device_class_pima_entry(UX_SLAVE_CLASS_COMMAND *command);
961 UINT  _ux_device_class_pima_event_get(UX_SLAVE_CLASS_PIMA *pima,
962                                       UX_SLAVE_CLASS_PIMA_EVENT *pima_event);
963 UINT  _ux_device_class_pima_event_set(UX_SLAVE_CLASS_PIMA *pima,
964                                       UX_SLAVE_CLASS_PIMA_EVENT *pima_event);
965 VOID  _ux_device_class_pima_interrupt_thread(ULONG pima_class);
966 UINT  _ux_device_class_pima_response_send(UX_SLAVE_CLASS_PIMA *pima, ULONG response_code,
967                                             ULONG number_parameters,
968                                             ULONG parameter_1, ULONG parameter_2, ULONG paramater_3);
969 VOID  _ux_device_class_pima_thread(ULONG pima_class);
970 UINT  _ux_device_class_pima_object_handles_send(UX_SLAVE_CLASS_PIMA *pima,
971                                                     ULONG storage_id,
972                                                     ULONG object_format_code,
973                                                     ULONG object_association);
974 UINT  _ux_device_class_pima_objects_number_send(UX_SLAVE_CLASS_PIMA *pima,
975                                                     ULONG storage_id,
976                                                     ULONG object_format_code,
977                                                     ULONG object_association);
978 
979 UINT  _ux_device_class_pima_device_prop_desc_get(UX_SLAVE_CLASS_PIMA *pima, ULONG device_property_code);
980 UINT  _ux_device_class_pima_device_prop_value_get(UX_SLAVE_CLASS_PIMA *pima, ULONG device_property_code);
981 UINT  _ux_device_class_pima_device_prop_value_set(UX_SLAVE_CLASS_PIMA *pima, ULONG device_property_code);
982 UINT  _ux_device_class_pima_object_info_get(UX_SLAVE_CLASS_PIMA *pima, ULONG object_handle);
983 UINT  _ux_device_class_pima_object_info_send(UX_SLAVE_CLASS_PIMA *pima, ULONG storage_id, ULONG parent_object_handle);
984 UINT  _ux_device_class_pima_object_data_get(UX_SLAVE_CLASS_PIMA *pima, ULONG object_handle);
985 UINT  _ux_device_class_pima_object_data_send(UX_SLAVE_CLASS_PIMA *pima);
986 UINT  _ux_device_class_pima_object_delete(UX_SLAVE_CLASS_PIMA *pima, ULONG object_handle, ULONG object_format);
987 UINT  _ux_device_class_pima_object_add(UX_SLAVE_CLASS_PIMA *pima, ULONG object_handle);
988 UINT  _ux_device_class_pima_partial_object_data_get(UX_SLAVE_CLASS_PIMA *pima,
989                                                     ULONG object_handle,
990                                                     ULONG offset_requested,
991                                                     ULONG length_requested);
992 
993 UINT  _ux_device_class_pima_storage_id_send(UX_SLAVE_CLASS_PIMA *pima);
994 UINT  _ux_device_class_pima_storage_info_get(UX_SLAVE_CLASS_PIMA *pima, ULONG storage_id);
995 UINT  _ux_device_class_pima_object_props_supported_get(UX_SLAVE_CLASS_PIMA *pima,
996                                                     ULONG object_format_code);
997 UINT  _ux_device_class_pima_object_prop_value_get(UX_SLAVE_CLASS_PIMA *pima,
998                                                     ULONG object_handle,
999                                                     ULONG object_property_code);
1000 UINT  _ux_device_class_pima_object_prop_value_set(UX_SLAVE_CLASS_PIMA *pima,
1001                                                     ULONG object_handle,
1002                                                     ULONG object_property_code);
1003 UINT  _ux_device_class_pima_object_prop_desc_get(UX_SLAVE_CLASS_PIMA *pima,
1004                                                     ULONG object_property,
1005                                                     ULONG object_format_code);
1006 UINT  _ux_device_class_pima_object_references_get(UX_SLAVE_CLASS_PIMA *pima,
1007                                                     ULONG object_handle);
1008 UINT  _ux_device_class_pima_object_references_set(UX_SLAVE_CLASS_PIMA *pima,
1009                                                     ULONG object_handle);
1010 UINT  _ux_device_class_pima_object_prop_value_get(UX_SLAVE_CLASS_PIMA *pima,
1011                                                     ULONG object_handle,
1012                                                     ULONG object_property_code);
1013 UINT  _ux_device_class_pima_object_prop_value_set(UX_SLAVE_CLASS_PIMA *pima,
1014                                                     ULONG object_handle,
1015                                                     ULONG object_property_code);
1016 UINT  _ux_device_class_pima_storage_format(UX_SLAVE_CLASS_PIMA *pima, ULONG storage_id);
1017 UINT  _ux_device_class_pima_device_reset(UX_SLAVE_CLASS_PIMA *pima);
1018 
1019 /* Define Device PIMA Class API prototypes.  */
1020 
1021 #define ux_device_class_pima_initialize         _ux_device_class_pima_initialize
1022 #define ux_device_class_pima_activate           _ux_device_class_pima_activate
1023 #define ux_device_class_pima_dectivate          _ux_device_class_pima_dectivate
1024 #define ux_device_class_pima_entry              _ux_device_class_pima_entry
1025 #define ux_device_class_pima_control_request    _ux_device_class_pima_control_request
1026 #define ux_device_class_pima_object_add         _ux_device_class_pima_object_add
1027 
1028 /* Define Pima Class data prototypes.  */
1029 
1030 extern UCHAR  _ux_device_class_pima_vendor_extension_descriptor[];
1031 extern USHORT _ux_device_class_pima_supported_operations[];
1032 extern USHORT _ux_device_class_pima_supported_events[];
1033 extern USHORT _ux_device_class_pima_supported_capture_formats[];
1034 extern USHORT _ux_device_class_pima_supported_image_formats[];
1035 extern USHORT _ux_device_class_pima_device_prop_supported[];
1036 
1037 
1038 
1039 /* Determine if a C++ compiler is being used.  If so, complete the standard
1040    C conditional started above.  */
1041 #ifdef __cplusplus
1042 }
1043 #endif
1044 
1045 #endif
1046