usb_mtp.h 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682
  1. /*
  2. * Copyright (C) 2010 The Android Open Source Project
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. /*
  17. * Copyright (c) 2025, sakumisu
  18. *
  19. * SPDX-License-Identifier: Apache-2.0
  20. */
  21. #ifndef USB_MTP_H
  22. #define USB_MTP_H
  23. // clang-format off
  24. #define MTP_STANDARD_VERSION 100
  25. // Container Types
  26. #define MTP_CONTAINER_TYPE_UNDEFINED 0
  27. #define MTP_CONTAINER_TYPE_COMMAND 1
  28. #define MTP_CONTAINER_TYPE_DATA 2
  29. #define MTP_CONTAINER_TYPE_RESPONSE 3
  30. #define MTP_CONTAINER_TYPE_EVENT 4
  31. // Container Offsets
  32. #define MTP_CONTAINER_LENGTH_OFFSET 0
  33. #define MTP_CONTAINER_TYPE_OFFSET 4
  34. #define MTP_CONTAINER_CODE_OFFSET 6
  35. #define MTP_CONTAINER_TRANSACTION_ID_OFFSET 8
  36. #define MTP_CONTAINER_PARAMETER_OFFSET 12
  37. #define MTP_CONTAINER_HEADER_SIZE 12
  38. // Maximum buffer size for a MTP packet.
  39. #define MTP_BUFFER_SIZE 16384
  40. // MTP Data Types
  41. #define MTP_TYPE_UNDEFINED 0x0000 // Undefined
  42. #define MTP_TYPE_INT8 0x0001 // Signed 8-bit integer
  43. #define MTP_TYPE_UINT8 0x0002 // Unsigned 8-bit integer
  44. #define MTP_TYPE_INT16 0x0003 // Signed 16-bit integer
  45. #define MTP_TYPE_UINT16 0x0004 // Unsigned 16-bit integer
  46. #define MTP_TYPE_INT32 0x0005 // Signed 32-bit integer
  47. #define MTP_TYPE_UINT32 0x0006 // Unsigned 32-bit integer
  48. #define MTP_TYPE_INT64 0x0007 // Signed 64-bit integer
  49. #define MTP_TYPE_UINT64 0x0008 // Unsigned 64-bit integer
  50. #define MTP_TYPE_INT128 0x0009 // Signed 128-bit integer
  51. #define MTP_TYPE_UINT128 0x000A // Unsigned 128-bit integer
  52. #define MTP_TYPE_AINT8 0x4001 // Array of signed 8-bit integers
  53. #define MTP_TYPE_AUINT8 0x4002 // Array of unsigned 8-bit integers
  54. #define MTP_TYPE_AINT16 0x4003 // Array of signed 16-bit integers
  55. #define MTP_TYPE_AUINT16 0x4004 // Array of unsigned 16-bit integers
  56. #define MTP_TYPE_AINT32 0x4005 // Array of signed 32-bit integers
  57. #define MTP_TYPE_AUINT32 0x4006 // Array of unsigned 32-bit integers
  58. #define MTP_TYPE_AINT64 0x4007 // Array of signed 64-bit integers
  59. #define MTP_TYPE_AUINT64 0x4008 // Array of unsigned 64-bit integers
  60. #define MTP_TYPE_AINT128 0x4009 // Array of signed 128-bit integers
  61. #define MTP_TYPE_AUINT128 0x400A // Array of unsigned 128-bit integers
  62. #define MTP_TYPE_STR 0xFFFF // Variable-length Unicode string
  63. // MTP Format Codes
  64. #define MTP_FORMAT_UNDEFINED 0x3000 // Undefined object
  65. #define MTP_FORMAT_ASSOCIATION 0x3001 // Association (for example, a folder)
  66. #define MTP_FORMAT_SCRIPT 0x3002 // Device model-specific script
  67. #define MTP_FORMAT_EXECUTABLE 0x3003 // Device model-specific binary executable
  68. #define MTP_FORMAT_TEXT 0x3004 // Text file
  69. #define MTP_FORMAT_HTML 0x3005 // Hypertext Markup Language file (text)
  70. #define MTP_FORMAT_DPOF 0x3006 // Digital Print Order Format file (text)
  71. #define MTP_FORMAT_AIFF 0x3007 // Audio clip
  72. #define MTP_FORMAT_WAV 0x3008 // Audio clip
  73. #define MTP_FORMAT_MP3 0x3009 // Audio clip
  74. #define MTP_FORMAT_AVI 0x300A // Video clip
  75. #define MTP_FORMAT_MPEG 0x300B // Video clip
  76. #define MTP_FORMAT_ASF 0x300C // Microsoft Advanced Streaming Format (video)
  77. #define MTP_FORMAT_DEFINED 0x3800 // Unknown image object
  78. #define MTP_FORMAT_EXIF_JPEG 0x3801 // Exchangeable File Format, JEIDA standard
  79. #define MTP_FORMAT_TIFF_EP 0x3802 // Tag Image File Format for Electronic Photography
  80. #define MTP_FORMAT_FLASHPIX 0x3803 // Structured Storage Image Format
  81. #define MTP_FORMAT_BMP 0x3804 // Microsoft Windows Bitmap file
  82. #define MTP_FORMAT_CIFF 0x3805 // Canon Camera Image File Format
  83. #define MTP_FORMAT_GIF 0x3807 // Graphics Interchange Format
  84. #define MTP_FORMAT_JFIF 0x3808 // JPEG File Interchange Format
  85. #define MTP_FORMAT_CD 0x3809 // PhotoCD Image Pac
  86. #define MTP_FORMAT_PICT 0x380A // Quickdraw Image Format
  87. #define MTP_FORMAT_PNG 0x380B // Portable Network Graphics
  88. #define MTP_FORMAT_TIFF 0x380D // Tag Image File Format
  89. #define MTP_FORMAT_TIFF_IT 0x380E // Tag Image File Format for Information Technology (graphic arts)
  90. #define MTP_FORMAT_JP2 0x380F // JPEG2000 Baseline File Format
  91. #define MTP_FORMAT_JPX 0x3810 // JPEG2000 Extended File Format
  92. #define MTP_FORMAT_DNG 0x3811 // Digital Negative
  93. #define MTP_FORMAT_HEIF 0x3812 // HEIF images
  94. #define MTP_FORMAT_UNDEFINED_FIRMWARE 0xB802
  95. #define MTP_FORMAT_WINDOWS_IMAGE_FORMAT 0xB881
  96. #define MTP_FORMAT_UNDEFINED_AUDIO 0xB900
  97. #define MTP_FORMAT_WMA 0xB901
  98. #define MTP_FORMAT_OGG 0xB902
  99. #define MTP_FORMAT_AAC 0xB903
  100. #define MTP_FORMAT_AUDIBLE 0xB904
  101. #define MTP_FORMAT_FLAC 0xB906
  102. #define MTP_FORMAT_UNDEFINED_VIDEO 0xB980
  103. #define MTP_FORMAT_WMV 0xB981
  104. #define MTP_FORMAT_MP4_CONTAINER 0xB982 // ISO 14496-1
  105. #define MTP_FORMAT_MP2 0xB983
  106. #define MTP_FORMAT_3GP_CONTAINER 0xB984 // 3GPP file format. Details: http://www.3gpp.org/ftp/Specs/html-info/26244.htm (page title - \u201cTransparent end-to-end packet switched streaming service, 3GPP file format\u201d).
  107. #define MTP_FORMAT_UNDEFINED_COLLECTION 0xBA00
  108. #define MTP_FORMAT_ABSTRACT_MULTIMEDIA_ALBUM 0xBA01
  109. #define MTP_FORMAT_ABSTRACT_IMAGE_ALBUM 0xBA02
  110. #define MTP_FORMAT_ABSTRACT_AUDIO_ALBUM 0xBA03
  111. #define MTP_FORMAT_ABSTRACT_VIDEO_ALBUM 0xBA04
  112. #define MTP_FORMAT_ABSTRACT_AV_PLAYLIST 0xBA05
  113. #define MTP_FORMAT_ABSTRACT_CONTACT_GROUP 0xBA06
  114. #define MTP_FORMAT_ABSTRACT_MESSAGE_FOLDER 0xBA07
  115. #define MTP_FORMAT_ABSTRACT_CHAPTERED_PRODUCTION 0xBA08
  116. #define MTP_FORMAT_ABSTRACT_AUDIO_PLAYLIST 0xBA09
  117. #define MTP_FORMAT_ABSTRACT_VIDEO_PLAYLIST 0xBA0A
  118. #define MTP_FORMAT_ABSTRACT_MEDIACAST 0xBA0B // For use with mediacasts; references multimedia enclosures of RSS feeds or episodic content
  119. #define MTP_FORMAT_WPL_PLAYLIST 0xBA10
  120. #define MTP_FORMAT_M3U_PLAYLIST 0xBA11
  121. #define MTP_FORMAT_MPL_PLAYLIST 0xBA12
  122. #define MTP_FORMAT_ASX_PLAYLIST 0xBA13
  123. #define MTP_FORMAT_PLS_PLAYLIST 0xBA14
  124. #define MTP_FORMAT_UNDEFINED_DOCUMENT 0xBA80
  125. #define MTP_FORMAT_ABSTRACT_DOCUMENT 0xBA81
  126. #define MTP_FORMAT_XML_DOCUMENT 0xBA82
  127. #define MTP_FORMAT_MS_WORD_DOCUMENT 0xBA83
  128. #define MTP_FORMAT_MHT_COMPILED_HTML_DOCUMENT 0xBA84
  129. #define MTP_FORMAT_MS_EXCEL_SPREADSHEET 0xBA85
  130. #define MTP_FORMAT_MS_POWERPOINT_PRESENTATION 0xBA86
  131. #define MTP_FORMAT_UNDEFINED_MESSAGE 0xBB00
  132. #define MTP_FORMAT_ABSTRACT_MESSSAGE 0xBB01
  133. #define MTP_FORMAT_UNDEFINED_CONTACT 0xBB80
  134. #define MTP_FORMAT_ABSTRACT_CONTACT 0xBB81
  135. #define MTP_FORMAT_VCARD_2 0xBB82
  136. // MTP Object Property Codes
  137. #define MTP_PROPERTY_STORAGE_ID 0xDC01
  138. #define MTP_PROPERTY_OBJECT_FORMAT 0xDC02
  139. #define MTP_PROPERTY_PROTECTION_STATUS 0xDC03
  140. #define MTP_PROPERTY_OBJECT_SIZE 0xDC04
  141. #define MTP_PROPERTY_ASSOCIATION_TYPE 0xDC05
  142. #define MTP_PROPERTY_ASSOCIATION_DESC 0xDC06
  143. #define MTP_PROPERTY_OBJECT_FILE_NAME 0xDC07
  144. #define MTP_PROPERTY_DATE_CREATED 0xDC08
  145. #define MTP_PROPERTY_DATE_MODIFIED 0xDC09
  146. #define MTP_PROPERTY_KEYWORDS 0xDC0A
  147. #define MTP_PROPERTY_PARENT_OBJECT 0xDC0B
  148. #define MTP_PROPERTY_ALLOWED_FOLDER_CONTENTS 0xDC0C
  149. #define MTP_PROPERTY_HIDDEN 0xDC0D
  150. #define MTP_PROPERTY_SYSTEM_OBJECT 0xDC0E
  151. #define MTP_PROPERTY_PERSISTENT_UID 0xDC41
  152. #define MTP_PROPERTY_SYNC_ID 0xDC42
  153. #define MTP_PROPERTY_PROPERTY_BAG 0xDC43
  154. #define MTP_PROPERTY_NAME 0xDC44
  155. #define MTP_PROPERTY_CREATED_BY 0xDC45
  156. #define MTP_PROPERTY_ARTIST 0xDC46
  157. #define MTP_PROPERTY_DATE_AUTHORED 0xDC47
  158. #define MTP_PROPERTY_DESCRIPTION 0xDC48
  159. #define MTP_PROPERTY_URL_REFERENCE 0xDC49
  160. #define MTP_PROPERTY_LANGUAGE_LOCALE 0xDC4A
  161. #define MTP_PROPERTY_COPYRIGHT_INFORMATION 0xDC4B
  162. #define MTP_PROPERTY_SOURCE 0xDC4C
  163. #define MTP_PROPERTY_ORIGIN_LOCATION 0xDC4D
  164. #define MTP_PROPERTY_DATE_ADDED 0xDC4E
  165. #define MTP_PROPERTY_NON_CONSUMABLE 0xDC4F
  166. #define MTP_PROPERTY_CORRUPT_UNPLAYABLE 0xDC50
  167. #define MTP_PROPERTY_PRODUCER_SERIAL_NUMBER 0xDC51
  168. #define MTP_PROPERTY_REPRESENTATIVE_SAMPLE_FORMAT 0xDC81
  169. #define MTP_PROPERTY_REPRESENTATIVE_SAMPLE_SIZE 0xDC82
  170. #define MTP_PROPERTY_REPRESENTATIVE_SAMPLE_HEIGHT 0xDC83
  171. #define MTP_PROPERTY_REPRESENTATIVE_SAMPLE_WIDTH 0xDC84
  172. #define MTP_PROPERTY_REPRESENTATIVE_SAMPLE_DURATION 0xDC85
  173. #define MTP_PROPERTY_REPRESENTATIVE_SAMPLE_DATA 0xDC86
  174. #define MTP_PROPERTY_WIDTH 0xDC87
  175. #define MTP_PROPERTY_HEIGHT 0xDC88
  176. #define MTP_PROPERTY_DURATION 0xDC89
  177. #define MTP_PROPERTY_RATING 0xDC8A
  178. #define MTP_PROPERTY_TRACK 0xDC8B
  179. #define MTP_PROPERTY_GENRE 0xDC8C
  180. #define MTP_PROPERTY_CREDITS 0xDC8D
  181. #define MTP_PROPERTY_LYRICS 0xDC8E
  182. #define MTP_PROPERTY_SUBSCRIPTION_CONTENT_ID 0xDC8F
  183. #define MTP_PROPERTY_PRODUCED_BY 0xDC90
  184. #define MTP_PROPERTY_USE_COUNT 0xDC91
  185. #define MTP_PROPERTY_SKIP_COUNT 0xDC92
  186. #define MTP_PROPERTY_LAST_ACCESSED 0xDC93
  187. #define MTP_PROPERTY_PARENTAL_RATING 0xDC94
  188. #define MTP_PROPERTY_META_GENRE 0xDC95
  189. #define MTP_PROPERTY_COMPOSER 0xDC96
  190. #define MTP_PROPERTY_EFFECTIVE_RATING 0xDC97
  191. #define MTP_PROPERTY_SUBTITLE 0xDC98
  192. #define MTP_PROPERTY_ORIGINAL_RELEASE_DATE 0xDC99
  193. #define MTP_PROPERTY_ALBUM_NAME 0xDC9A
  194. #define MTP_PROPERTY_ALBUM_ARTIST 0xDC9B
  195. #define MTP_PROPERTY_MOOD 0xDC9C
  196. #define MTP_PROPERTY_DRM_STATUS 0xDC9D
  197. #define MTP_PROPERTY_SUB_DESCRIPTION 0xDC9E
  198. #define MTP_PROPERTY_IS_CROPPED 0xDCD1
  199. #define MTP_PROPERTY_IS_COLOUR_CORRECTED 0xDCD2
  200. #define MTP_PROPERTY_IMAGE_BIT_DEPTH 0xDCD3
  201. #define MTP_PROPERTY_F_NUMBER 0xDCD4
  202. #define MTP_PROPERTY_EXPOSURE_TIME 0xDCD5
  203. #define MTP_PROPERTY_EXPOSURE_INDEX 0xDCD6
  204. #define MTP_PROPERTY_TOTAL_BITRATE 0xDE91
  205. #define MTP_PROPERTY_BITRATE_TYPE 0xDE92
  206. #define MTP_PROPERTY_SAMPLE_RATE 0xDE93
  207. #define MTP_PROPERTY_NUMBER_OF_CHANNELS 0xDE94
  208. #define MTP_PROPERTY_AUDIO_BIT_DEPTH 0xDE95
  209. #define MTP_PROPERTY_SCAN_TYPE 0xDE97
  210. #define MTP_PROPERTY_AUDIO_WAVE_CODEC 0xDE99
  211. #define MTP_PROPERTY_AUDIO_BITRATE 0xDE9A
  212. #define MTP_PROPERTY_VIDEO_FOURCC_CODEC 0xDE9B
  213. #define MTP_PROPERTY_VIDEO_BITRATE 0xDE9C
  214. #define MTP_PROPERTY_FRAMES_PER_THOUSAND_SECONDS 0xDE9D
  215. #define MTP_PROPERTY_KEYFRAME_DISTANCE 0xDE9E
  216. #define MTP_PROPERTY_BUFFER_SIZE 0xDE9F
  217. #define MTP_PROPERTY_ENCODING_QUALITY 0xDEA0
  218. #define MTP_PROPERTY_ENCODING_PROFILE 0xDEA1
  219. #define MTP_PROPERTY_DISPLAY_NAME 0xDCE0
  220. #define MTP_PROPERTY_BODY_TEXT 0xDCE1
  221. #define MTP_PROPERTY_SUBJECT 0xDCE2
  222. #define MTP_PROPERTY_PRIORITY 0xDCE3
  223. #define MTP_PROPERTY_GIVEN_NAME 0xDD00
  224. #define MTP_PROPERTY_MIDDLE_NAMES 0xDD01
  225. #define MTP_PROPERTY_FAMILY_NAME 0xDD02
  226. #define MTP_PROPERTY_PREFIX 0xDD03
  227. #define MTP_PROPERTY_SUFFIX 0xDD04
  228. #define MTP_PROPERTY_PHONETIC_GIVEN_NAME 0xDD05
  229. #define MTP_PROPERTY_PHONETIC_FAMILY_NAME 0xDD06
  230. #define MTP_PROPERTY_EMAIL_PRIMARY 0xDD07
  231. #define MTP_PROPERTY_EMAIL_PERSONAL_1 0xDD08
  232. #define MTP_PROPERTY_EMAIL_PERSONAL_2 0xDD09
  233. #define MTP_PROPERTY_EMAIL_BUSINESS_1 0xDD0A
  234. #define MTP_PROPERTY_EMAIL_BUSINESS_2 0xDD0B
  235. #define MTP_PROPERTY_EMAIL_OTHERS 0xDD0C
  236. #define MTP_PROPERTY_PHONE_NUMBER_PRIMARY 0xDD0D
  237. #define MTP_PROPERTY_PHONE_NUMBER_PERSONAL 0xDD0E
  238. #define MTP_PROPERTY_PHONE_NUMBER_PERSONAL_2 0xDD0F
  239. #define MTP_PROPERTY_PHONE_NUMBER_BUSINESS 0xDD10
  240. #define MTP_PROPERTY_PHONE_NUMBER_BUSINESS_2 0xDD11
  241. #define MTP_PROPERTY_PHONE_NUMBER_MOBILE 0xDD12
  242. #define MTP_PROPERTY_PHONE_NUMBER_MOBILE_2 0xDD13
  243. #define MTP_PROPERTY_FAX_NUMBER_PRIMARY 0xDD14
  244. #define MTP_PROPERTY_FAX_NUMBER_PERSONAL 0xDD15
  245. #define MTP_PROPERTY_FAX_NUMBER_BUSINESS 0xDD16
  246. #define MTP_PROPERTY_PAGER_NUMBER 0xDD17
  247. #define MTP_PROPERTY_PHONE_NUMBER_OTHERS 0xDD18
  248. #define MTP_PROPERTY_PRIMARY_WEB_ADDRESS 0xDD19
  249. #define MTP_PROPERTY_PERSONAL_WEB_ADDRESS 0xDD1A
  250. #define MTP_PROPERTY_BUSINESS_WEB_ADDRESS 0xDD1B
  251. #define MTP_PROPERTY_INSTANT_MESSANGER_ADDRESS 0xDD1C
  252. #define MTP_PROPERTY_INSTANT_MESSANGER_ADDRESS_2 0xDD1D
  253. #define MTP_PROPERTY_INSTANT_MESSANGER_ADDRESS_3 0xDD1E
  254. #define MTP_PROPERTY_POSTAL_ADDRESS_PERSONAL_FULL 0xDD1F
  255. #define MTP_PROPERTY_POSTAL_ADDRESS_PERSONAL_LINE_1 0xDD20
  256. #define MTP_PROPERTY_POSTAL_ADDRESS_PERSONAL_LINE_2 0xDD21
  257. #define MTP_PROPERTY_POSTAL_ADDRESS_PERSONAL_CITY 0xDD22
  258. #define MTP_PROPERTY_POSTAL_ADDRESS_PERSONAL_REGION 0xDD23
  259. #define MTP_PROPERTY_POSTAL_ADDRESS_PERSONAL_POSTAL_CODE 0xDD24
  260. #define MTP_PROPERTY_POSTAL_ADDRESS_PERSONAL_COUNTRY 0xDD25
  261. #define MTP_PROPERTY_POSTAL_ADDRESS_BUSINESS_FULL 0xDD26
  262. #define MTP_PROPERTY_POSTAL_ADDRESS_BUSINESS_LINE_1 0xDD27
  263. #define MTP_PROPERTY_POSTAL_ADDRESS_BUSINESS_LINE_2 0xDD28
  264. #define MTP_PROPERTY_POSTAL_ADDRESS_BUSINESS_CITY 0xDD29
  265. #define MTP_PROPERTY_POSTAL_ADDRESS_BUSINESS_REGION 0xDD2A
  266. #define MTP_PROPERTY_POSTAL_ADDRESS_BUSINESS_POSTAL_CODE 0xDD2B
  267. #define MTP_PROPERTY_POSTAL_ADDRESS_BUSINESS_COUNTRY 0xDD2C
  268. #define MTP_PROPERTY_POSTAL_ADDRESS_OTHER_FULL 0xDD2D
  269. #define MTP_PROPERTY_POSTAL_ADDRESS_OTHER_LINE_1 0xDD2E
  270. #define MTP_PROPERTY_POSTAL_ADDRESS_OTHER_LINE_2 0xDD2F
  271. #define MTP_PROPERTY_POSTAL_ADDRESS_OTHER_CITY 0xDD30
  272. #define MTP_PROPERTY_POSTAL_ADDRESS_OTHER_REGION 0xDD31
  273. #define MTP_PROPERTY_POSTAL_ADDRESS_OTHER_POSTAL_CODE 0xDD32
  274. #define MTP_PROPERTY_POSTAL_ADDRESS_OTHER_COUNTRY 0xDD33
  275. #define MTP_PROPERTY_ORGANIZATION_NAME 0xDD34
  276. #define MTP_PROPERTY_PHONETIC_ORGANIZATION_NAME 0xDD35
  277. #define MTP_PROPERTY_ROLE 0xDD36
  278. #define MTP_PROPERTY_BIRTHDATE 0xDD37
  279. #define MTP_PROPERTY_MESSAGE_TO 0xDD40
  280. #define MTP_PROPERTY_MESSAGE_CC 0xDD41
  281. #define MTP_PROPERTY_MESSAGE_BCC 0xDD42
  282. #define MTP_PROPERTY_MESSAGE_READ 0xDD43
  283. #define MTP_PROPERTY_MESSAGE_RECEIVED_TIME 0xDD44
  284. #define MTP_PROPERTY_MESSAGE_SENDER 0xDD45
  285. #define MTP_PROPERTY_ACTIVITY_BEGIN_TIME 0xDD50
  286. #define MTP_PROPERTY_ACTIVITY_END_TIME 0xDD51
  287. #define MTP_PROPERTY_ACTIVITY_LOCATION 0xDD52
  288. #define MTP_PROPERTY_ACTIVITY_REQUIRED_ATTENDEES 0xDD54
  289. #define MTP_PROPERTY_ACTIVITY_OPTIONAL_ATTENDEES 0xDD55
  290. #define MTP_PROPERTY_ACTIVITY_RESOURCES 0xDD56
  291. #define MTP_PROPERTY_ACTIVITY_ACCEPTED 0xDD57
  292. #define MTP_PROPERTY_ACTIVITY_TENTATIVE 0xDD58
  293. #define MTP_PROPERTY_ACTIVITY_DECLINED 0xDD59
  294. #define MTP_PROPERTY_ACTIVITY_REMAINDER_TIME 0xDD5A
  295. #define MTP_PROPERTY_ACTIVITY_OWNER 0xDD5B
  296. #define MTP_PROPERTY_ACTIVITY_STATUS 0xDD5C
  297. #define MTP_PROPERTY_OWNER 0xDD5D
  298. #define MTP_PROPERTY_EDITOR 0xDD5E
  299. #define MTP_PROPERTY_WEBMASTER 0xDD5F
  300. #define MTP_PROPERTY_URL_SOURCE 0xDD60
  301. #define MTP_PROPERTY_URL_DESTINATION 0xDD61
  302. #define MTP_PROPERTY_TIME_BOOKMARK 0xDD62
  303. #define MTP_PROPERTY_OBJECT_BOOKMARK 0xDD63
  304. #define MTP_PROPERTY_BYTE_BOOKMARK 0xDD64
  305. #define MTP_PROPERTY_LAST_BUILD_DATE 0xDD70
  306. #define MTP_PROPERTY_TIME_TO_LIVE 0xDD71
  307. #define MTP_PROPERTY_MEDIA_GUID 0xDD72
  308. // MTP Device Property Codes
  309. #define MTP_DEVICE_PROPERTY_UNDEFINED 0x5000
  310. #define MTP_DEVICE_PROPERTY_BATTERY_LEVEL 0x5001
  311. #define MTP_DEVICE_PROPERTY_FUNCTIONAL_MODE 0x5002
  312. #define MTP_DEVICE_PROPERTY_IMAGE_SIZE 0x5003
  313. #define MTP_DEVICE_PROPERTY_COMPRESSION_SETTING 0x5004
  314. #define MTP_DEVICE_PROPERTY_WHITE_BALANCE 0x5005
  315. #define MTP_DEVICE_PROPERTY_RGB_GAIN 0x5006
  316. #define MTP_DEVICE_PROPERTY_F_NUMBER 0x5007
  317. #define MTP_DEVICE_PROPERTY_FOCAL_LENGTH 0x5008
  318. #define MTP_DEVICE_PROPERTY_FOCUS_DISTANCE 0x5009
  319. #define MTP_DEVICE_PROPERTY_FOCUS_MODE 0x500A
  320. #define MTP_DEVICE_PROPERTY_EXPOSURE_METERING_MODE 0x500B
  321. #define MTP_DEVICE_PROPERTY_FLASH_MODE 0x500C
  322. #define MTP_DEVICE_PROPERTY_EXPOSURE_TIME 0x500D
  323. #define MTP_DEVICE_PROPERTY_EXPOSURE_PROGRAM_MODE 0x500E
  324. #define MTP_DEVICE_PROPERTY_EXPOSURE_INDEX 0x500F
  325. #define MTP_DEVICE_PROPERTY_EXPOSURE_BIAS_COMPENSATION 0x5010
  326. #define MTP_DEVICE_PROPERTY_DATETIME 0x5011
  327. #define MTP_DEVICE_PROPERTY_CAPTURE_DELAY 0x5012
  328. #define MTP_DEVICE_PROPERTY_STILL_CAPTURE_MODE 0x5013
  329. #define MTP_DEVICE_PROPERTY_CONTRAST 0x5014
  330. #define MTP_DEVICE_PROPERTY_SHARPNESS 0x5015
  331. #define MTP_DEVICE_PROPERTY_DIGITAL_ZOOM 0x5016
  332. #define MTP_DEVICE_PROPERTY_EFFECT_MODE 0x5017
  333. #define MTP_DEVICE_PROPERTY_BURST_NUMBER 0x5018
  334. #define MTP_DEVICE_PROPERTY_BURST_INTERVAL 0x5019
  335. #define MTP_DEVICE_PROPERTY_TIMELAPSE_NUMBER 0x501A
  336. #define MTP_DEVICE_PROPERTY_TIMELAPSE_INTERVAL 0x501B
  337. #define MTP_DEVICE_PROPERTY_FOCUS_METERING_MODE 0x501C
  338. #define MTP_DEVICE_PROPERTY_UPLOAD_URL 0x501D
  339. #define MTP_DEVICE_PROPERTY_ARTIST 0x501E
  340. #define MTP_DEVICE_PROPERTY_COPYRIGHT_INFO 0x501F
  341. #define MTP_DEVICE_PROPERTY_SYNCHRONIZATION_PARTNER 0xD401
  342. #define MTP_DEVICE_PROPERTY_DEVICE_FRIENDLY_NAME 0xD402
  343. #define MTP_DEVICE_PROPERTY_VOLUME 0xD403
  344. #define MTP_DEVICE_PROPERTY_SUPPORTED_FORMATS_ORDERED 0xD404
  345. #define MTP_DEVICE_PROPERTY_DEVICE_ICON 0xD405
  346. #define MTP_DEVICE_PROPERTY_PLAYBACK_RATE 0xD410
  347. #define MTP_DEVICE_PROPERTY_PLAYBACK_OBJECT 0xD411
  348. #define MTP_DEVICE_PROPERTY_PLAYBACK_CONTAINER_INDEX 0xD412
  349. #define MTP_DEVICE_PROPERTY_SESSION_INITIATOR_VERSION_INFO 0xD406
  350. #define MTP_DEVICE_PROPERTY_PERCEIVED_DEVICE_TYPE 0xD407
  351. // MTP Operation Codes
  352. #define MTP_OPERATION_GET_DEVICE_INFO 0x1001
  353. #define MTP_OPERATION_OPEN_SESSION 0x1002
  354. #define MTP_OPERATION_CLOSE_SESSION 0x1003
  355. #define MTP_OPERATION_GET_STORAGE_IDS 0x1004
  356. #define MTP_OPERATION_GET_STORAGE_INFO 0x1005
  357. #define MTP_OPERATION_GET_NUM_OBJECTS 0x1006
  358. #define MTP_OPERATION_GET_OBJECT_HANDLES 0x1007
  359. #define MTP_OPERATION_GET_OBJECT_INFO 0x1008
  360. #define MTP_OPERATION_GET_OBJECT 0x1009
  361. #define MTP_OPERATION_GET_THUMB 0x100A
  362. #define MTP_OPERATION_DELETE_OBJECT 0x100B
  363. #define MTP_OPERATION_SEND_OBJECT_INFO 0x100C
  364. #define MTP_OPERATION_SEND_OBJECT 0x100D
  365. #define MTP_OPERATION_INITIATE_CAPTURE 0x100E
  366. #define MTP_OPERATION_FORMAT_STORE 0x100F
  367. #define MTP_OPERATION_RESET_DEVICE 0x1010
  368. #define MTP_OPERATION_SELF_TEST 0x1011
  369. #define MTP_OPERATION_SET_OBJECT_PROTECTION 0x1012
  370. #define MTP_OPERATION_POWER_DOWN 0x1013
  371. #define MTP_OPERATION_GET_DEVICE_PROP_DESC 0x1014
  372. #define MTP_OPERATION_GET_DEVICE_PROP_VALUE 0x1015
  373. #define MTP_OPERATION_SET_DEVICE_PROP_VALUE 0x1016
  374. #define MTP_OPERATION_RESET_DEVICE_PROP_VALUE 0x1017
  375. #define MTP_OPERATION_TERMINATE_OPEN_CAPTURE 0x1018
  376. #define MTP_OPERATION_MOVE_OBJECT 0x1019
  377. #define MTP_OPERATION_COPY_OBJECT 0x101A
  378. #define MTP_OPERATION_GET_PARTIAL_OBJECT 0x101B
  379. #define MTP_OPERATION_INITIATE_OPEN_CAPTURE 0x101C
  380. #define MTP_OPERATION_GET_OBJECT_PROPS_SUPPORTED 0x9801
  381. #define MTP_OPERATION_GET_OBJECT_PROP_DESC 0x9802
  382. #define MTP_OPERATION_GET_OBJECT_PROP_VALUE 0x9803
  383. #define MTP_OPERATION_SET_OBJECT_PROP_VALUE 0x9804
  384. #define MTP_OPERATION_GET_OBJECT_PROP_LIST 0x9805
  385. #define MTP_OPERATION_SET_OBJECT_PROP_LIST 0x9806
  386. #define MTP_OPERATION_GET_INTERDEPENDENT_PROP_DESC 0x9807
  387. #define MTP_OPERATION_SEND_OBJECT_PROP_LIST 0x9808
  388. #define MTP_OPERATION_GET_OBJECT_REFERENCES 0x9810
  389. #define MTP_OPERATION_SET_OBJECT_REFERENCES 0x9811
  390. #define MTP_OPERATION_SKIP 0x9820
  391. // Android extensions for direct file IO
  392. // Same as GetPartialObject, but with 64 bit offset
  393. #define MTP_OPERATION_GET_PARTIAL_OBJECT_64 0x95C1
  394. // Same as GetPartialObject64, but copying host to device
  395. #define MTP_OPERATION_SEND_PARTIAL_OBJECT 0x95C2
  396. // Truncates file to 64 bit length
  397. #define MTP_OPERATION_TRUNCATE_OBJECT 0x95C3
  398. // Must be called before using SendPartialObject and TruncateObject
  399. #define MTP_OPERATION_BEGIN_EDIT_OBJECT 0x95C4
  400. // Called to commit changes made by SendPartialObject and TruncateObject
  401. #define MTP_OPERATION_END_EDIT_OBJECT 0x95C5
  402. // MTP Response Codes
  403. #define MTP_RESPONSE_UNDEFINED 0x2000
  404. #define MTP_RESPONSE_OK 0x2001
  405. #define MTP_RESPONSE_GENERAL_ERROR 0x2002
  406. #define MTP_RESPONSE_SESSION_NOT_OPEN 0x2003
  407. #define MTP_RESPONSE_INVALID_TRANSACTION_ID 0x2004
  408. #define MTP_RESPONSE_OPERATION_NOT_SUPPORTED 0x2005
  409. #define MTP_RESPONSE_PARAMETER_NOT_SUPPORTED 0x2006
  410. #define MTP_RESPONSE_INCOMPLETE_TRANSFER 0x2007
  411. #define MTP_RESPONSE_INVALID_STORAGE_ID 0x2008
  412. #define MTP_RESPONSE_INVALID_OBJECT_HANDLE 0x2009
  413. #define MTP_RESPONSE_DEVICE_PROP_NOT_SUPPORTED 0x200A
  414. #define MTP_RESPONSE_INVALID_OBJECT_FORMAT_CODE 0x200B
  415. #define MTP_RESPONSE_STORAGE_FULL 0x200C
  416. #define MTP_RESPONSE_OBJECT_WRITE_PROTECTED 0x200D
  417. #define MTP_RESPONSE_STORE_READ_ONLY 0x200E
  418. #define MTP_RESPONSE_ACCESS_DENIED 0x200F
  419. #define MTP_RESPONSE_NO_THUMBNAIL_PRESENT 0x2010
  420. #define MTP_RESPONSE_SELF_TEST_FAILED 0x2011
  421. #define MTP_RESPONSE_PARTIAL_DELETION 0x2012
  422. #define MTP_RESPONSE_STORE_NOT_AVAILABLE 0x2013
  423. #define MTP_RESPONSE_SPECIFICATION_BY_FORMAT_UNSUPPORTED 0x2014
  424. #define MTP_RESPONSE_NO_VALID_OBJECT_INFO 0x2015
  425. #define MTP_RESPONSE_INVALID_CODE_FORMAT 0x2016
  426. #define MTP_RESPONSE_UNKNOWN_VENDOR_CODE 0x2017
  427. #define MTP_RESPONSE_CAPTURE_ALREADY_TERMINATED 0x2018
  428. #define MTP_RESPONSE_DEVICE_BUSY 0x2019
  429. #define MTP_RESPONSE_INVALID_PARENT_OBJECT 0x201A
  430. #define MTP_RESPONSE_INVALID_DEVICE_PROP_FORMAT 0x201B
  431. #define MTP_RESPONSE_INVALID_DEVICE_PROP_VALUE 0x201C
  432. #define MTP_RESPONSE_INVALID_PARAMETER 0x201D
  433. #define MTP_RESPONSE_SESSION_ALREADY_OPEN 0x201E
  434. #define MTP_RESPONSE_TRANSACTION_CANCELLED 0x201F
  435. #define MTP_RESPONSE_SPECIFICATION_OF_DESTINATION_UNSUPPORTED 0x2020
  436. #define MTP_RESPONSE_INVALID_OBJECT_PROP_CODE 0xA801
  437. #define MTP_RESPONSE_INVALID_OBJECT_PROP_FORMAT 0xA802
  438. #define MTP_RESPONSE_INVALID_OBJECT_PROP_VALUE 0xA803
  439. #define MTP_RESPONSE_INVALID_OBJECT_REFERENCE 0xA804
  440. #define MTP_RESPONSE_GROUP_NOT_SUPPORTED 0xA805
  441. #define MTP_RESPONSE_INVALID_DATASET 0xA806
  442. #define MTP_RESPONSE_SPECIFICATION_BY_GROUP_UNSUPPORTED 0xA807
  443. #define MTP_RESPONSE_SPECIFICATION_BY_DEPTH_UNSUPPORTED 0xA808
  444. #define MTP_RESPONSE_OBJECT_TOO_LARGE 0xA809
  445. #define MTP_RESPONSE_OBJECT_PROP_NOT_SUPPORTED 0xA80A
  446. #define MTP_RESPONSE_NO_RESPONSE 0xFFFF
  447. // MTP Event Codes
  448. #define MTP_EVENT_UNDEFINED 0x4000
  449. #define MTP_EVENT_CANCEL_TRANSACTION 0x4001
  450. #define MTP_EVENT_OBJECT_ADDED 0x4002
  451. #define MTP_EVENT_OBJECT_REMOVED 0x4003
  452. #define MTP_EVENT_STORE_ADDED 0x4004
  453. #define MTP_EVENT_STORE_REMOVED 0x4005
  454. #define MTP_EVENT_DEVICE_PROP_CHANGED 0x4006
  455. #define MTP_EVENT_OBJECT_INFO_CHANGED 0x4007
  456. #define MTP_EVENT_DEVICE_INFO_CHANGED 0x4008
  457. #define MTP_EVENT_REQUEST_OBJECT_TRANSFER 0x4009
  458. #define MTP_EVENT_STORE_FULL 0x400A
  459. #define MTP_EVENT_DEVICE_RESET 0x400B
  460. #define MTP_EVENT_STORAGE_INFO_CHANGED 0x400C
  461. #define MTP_EVENT_CAPTURE_COMPLETE 0x400D
  462. #define MTP_EVENT_UNREPORTED_STATUS 0x400E
  463. #define MTP_EVENT_OBJECT_PROP_CHANGED 0xC801
  464. #define MTP_EVENT_OBJECT_PROP_DESC_CHANGED 0xC802
  465. #define MTP_EVENT_OBJECT_REFERENCES_CHANGED 0xC803
  466. // Storage Type
  467. #define MTP_STORAGE_FIXED_ROM 0x0001
  468. #define MTP_STORAGE_REMOVABLE_ROM 0x0002
  469. #define MTP_STORAGE_FIXED_RAM 0x0003
  470. #define MTP_STORAGE_REMOVABLE_RAM 0x0004
  471. // Storage File System
  472. #define MTP_STORAGE_FILESYSTEM_FLAT 0x0001
  473. #define MTP_STORAGE_FILESYSTEM_HIERARCHICAL 0x0002
  474. #define MTP_STORAGE_FILESYSTEM_DCF 0x0003
  475. // Storage Access Capability
  476. #define MTP_STORAGE_READ_WRITE 0x0000
  477. #define MTP_STORAGE_READ_ONLY_WITHOUT_DELETE 0x0001
  478. #define MTP_STORAGE_READ_ONLY_WITH_DELETE 0x0002
  479. // Association Type
  480. #define MTP_ASSOCIATION_TYPE_UNDEFINED 0x0000
  481. #define MTP_ASSOCIATION_TYPE_GENERIC_FOLDER 0x0001
  482. // MTP class reqeusts
  483. #define MTP_REQUEST_CANCEL 0x64
  484. #define MTP_REQUEST_GET_EXT_EVENT_DATA 0x65
  485. #define MTP_REQUEST_RESET 0x66
  486. #define MTP_REQUEST_GET_DEVICE_STATUS 0x67
  487. // clang-format on
  488. #define USB_MTP_CLASS 0x06
  489. #define USB_MTP_SUB_CLASS 0x01U
  490. #define USB_MTP_PROTOCOL 0x01U
  491. struct mtp_header {
  492. uint32_t conlen;
  493. uint16_t contype;
  494. uint16_t code;
  495. uint32_t trans_id;
  496. uint32_t param[];
  497. };
  498. struct mtp_string {
  499. uint8_t len;
  500. uint16_t string[255];
  501. };
  502. struct mtp_device_info {
  503. uint16_t StandardVersion;
  504. uint32_t VendorExtensionID;
  505. uint16_t VendorExtensionVersion;
  506. uint8_t VendorExtensionDesc_len;
  507. uint16_t VendorExtensionDesc[255];
  508. uint16_t FunctionalMode;
  509. uint32_t OperationsSupported_len;
  510. uint16_t OperationsSupported[255];
  511. uint32_t EventsSupported_len;
  512. uint16_t EventsSupported[255];
  513. uint32_t DevicePropertiesSupported_len;
  514. uint16_t DevicePropertiesSupported[255];
  515. uint32_t CaptureFormats_len;
  516. uint16_t CaptureFormats[255];
  517. uint32_t ImageFormats_len;
  518. uint16_t ImageFormats[255];
  519. uint8_t Manufacturer_len;
  520. uint16_t Manufacturer[255];
  521. uint8_t Model_len;
  522. uint16_t Model[255];
  523. uint8_t DeviceVersion_len;
  524. uint16_t DeviceVersion[255];
  525. uint8_t SerialNumber_len;
  526. uint16_t SerialNumber[255];
  527. } __PACKED;
  528. struct mtp_object_props_support {
  529. uint32_t ObjectPropCode_len;
  530. uint16_t ObjectPropCode[255];
  531. } __PACKED;
  532. struct mtp_device_prop_desc {
  533. uint16_t DevicePropertyCode;
  534. uint16_t DataType;
  535. uint8_t GetSet;
  536. uint16_t DefaultValue[1];
  537. uint16_t CurrentValue[1];
  538. uint8_t FormFlag;
  539. } __PACKED;
  540. struct mtp_storage_id {
  541. uint32_t StorageIDS_len;
  542. uint32_t StorageIDS[255];
  543. } __PACKED;
  544. struct mtp_storage_info {
  545. uint16_t StorageType;
  546. uint16_t FilesystemType;
  547. uint16_t AccessCapability;
  548. uint64_t MaxCapability;
  549. uint64_t FreeSpaceInBytes;
  550. uint32_t FreeSpaceInObjects;
  551. uint8_t StorageDescription_len;
  552. uint8_t StorageDescription[255];
  553. uint8_t VolumeIdentifier_len;
  554. uint8_t VolumeIdentifier[255];
  555. } __PACKED;
  556. struct mtp_object_handles {
  557. uint32_t ObjectHandle_len;
  558. uint32_t ObjectHandle[255];
  559. } __PACKED;
  560. struct mtp_object_prop_desc {
  561. uint16_t ObjectPropertyCode;
  562. uint16_t DataType;
  563. uint8_t GetSet;
  564. uint8_t DefValue[16];
  565. uint32_t GroupCode;
  566. uint8_t FormFlag;
  567. } __PACKED;
  568. struct mtp_object_prop_element {
  569. uint32_t ObjectHandle;
  570. uint16_t PropertyCode;
  571. uint16_t Datatype;
  572. uint8_t value[8];
  573. } __PACKED;
  574. struct mtp_object_prop_list {
  575. uint32_t element_len;
  576. struct mtp_object_prop_element element[1];
  577. } __PACKED;
  578. struct mtp_object_info {
  579. uint32_t StorageId;
  580. uint16_t ObjectFormat;
  581. uint16_t ProtectionStatus;
  582. uint32_t ObjectCompressedSize;
  583. uint16_t ThumbFormat;
  584. uint32_t ThumbCompressedSize;
  585. uint32_t ThumbPixWidth;
  586. uint32_t ThumbPixHeight;
  587. uint32_t ImagePixWidth;
  588. uint32_t ImagePixHeight;
  589. uint32_t ImageBitDepth;
  590. uint32_t ParentObject;
  591. uint16_t AssociationType;
  592. uint32_t AssociationDesc;
  593. uint32_t SequenceNumber;
  594. uint8_t Filename_len;
  595. uint16_t Filename[CONFIG_USBDEV_MTP_MAX_PATHNAME];
  596. uint8_t CaptureDate[6];
  597. uint8_t ModificationDate[6];
  598. } __PACKED;
  599. struct mtp_object {
  600. uint32_t storage_id;
  601. uint32_t handle;
  602. uint32_t parent_handle;
  603. uint16_t format;
  604. bool is_dir;
  605. bool is_readonly;
  606. bool is_hidden;
  607. uint32_t file_size;
  608. uint32_t file_full_name_length;
  609. char file_full_name[CONFIG_USBDEV_MTP_MAX_PATHNAME];
  610. bool in_use;
  611. };
  612. /*Length of template descriptor: 30 bytes*/
  613. #define MTP_DESCRIPTOR_LEN (9 + 7 + 7 + 7)
  614. // clang-format off
  615. #define MTP_DESCRIPTOR_INIT(bFirstInterface, out_ep, in_ep, int_ep, wMaxPacketSize, str_idx) \
  616. /* Interface */ \
  617. 0x09, /* bLength */ \
  618. USB_DESCRIPTOR_TYPE_INTERFACE, /* bDescriptorType */ \
  619. bFirstInterface, /* bInterfaceNumber */ \
  620. 0x00, /* bAlternateSetting */ \
  621. 0x03, /* bNumEndpoints */ \
  622. USB_DEVICE_CLASS_IMAGE, /* bInterfaceClass */ \
  623. USB_MTP_SUB_CLASS, /* bInterfaceSubClass */ \
  624. USB_MTP_PROTOCOL, /* bInterfaceProtocol */ \
  625. str_idx, /* iInterface */ \
  626. 0x07, /* bLength */ \
  627. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  628. out_ep, /* bEndpointAddress */ \
  629. 0x02, /* bmAttributes */ \
  630. WBVAL(wMaxPacketSize), /* wMaxPacketSize */ \
  631. 0x00, /* bInterval */ \
  632. 0x07, /* bLength */ \
  633. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  634. in_ep, /* bEndpointAddress */ \
  635. 0x02, /* bmAttributes */ \
  636. WBVAL(wMaxPacketSize), /* wMaxPacketSize */ \
  637. 0x00, /* bInterval */ \
  638. 0x07, /* bLength */ \
  639. USB_DESCRIPTOR_TYPE_ENDPOINT, /* bDescriptorType */ \
  640. int_ep, /* bEndpointAddress */ \
  641. 0x03, /* bmAttributes */ \
  642. WBVAL(0x1c), /* wMaxPacketSize */ \
  643. 0x06 /* bInterval */
  644. // clang-format on
  645. #endif