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