Linus Walleij | 0dd71e9 | 2006-05-04 18:47:07 +0000 | [diff] [blame] | 1 | Building and Installing |
| 2 | ----------------------- |
Linus Walleij | 6fd2f08 | 2006-03-28 07:19:22 +0000 | [diff] [blame] | 3 | |
Linus Walleij | 0dd71e9 | 2006-05-04 18:47:07 +0000 | [diff] [blame] | 4 | See the "INSTALL" file. |
| 5 | |
| 6 | |
| 7 | Heritage |
| 8 | -------- |
| 9 | |
| 10 | libmtp is based on several ancestors: |
| 11 | |
| 12 | * libptp2 by Mariusz Woloszyn was the starting point used |
| 13 | by Richard A. Low for the initial starter port. You can |
| 14 | find it at http://libptp.sourceforge.net/ |
| 15 | |
| 16 | * libgphoto2 by Mariusz Woloszyn and Marcus Meissner was |
| 17 | used at a later stage since it was (is) more actively |
| 18 | maintained. libmtp tracks the PTP implementation in |
| 19 | libgphoto2 and considers it an upstream project. We will |
| 20 | try to submit anything generally useful back to libgphoto2 |
| 21 | and not make double efforts. In practice this means we |
| 22 | use ptp.c, ptp.h and ptp-pack.c verbatim from the libgphoto2 |
| 23 | source code. If you need to change things in these files, |
| 24 | make sure it is so general that libgphoto2 will want to |
| 25 | merge it to their codebase too. You find libgphoto2 as part |
| 26 | of gPhoto: http://gphoto.sourceforge.net/ |
| 27 | |
| 28 | * libnjb was a project that Richard and Linus were working |
Linus Walleij | fcf8891 | 2006-06-05 13:23:33 +0000 | [diff] [blame] | 29 | on before libmtp. When Linus took Richards initial port |
Linus Walleij | 0dd71e9 | 2006-05-04 18:47:07 +0000 | [diff] [blame] | 30 | and made an generic C API he re-used the philosophy and |
| 31 | much code from libnjb. Many of the sample programs are for |
| 32 | example taken quite literally from libnjb. You find it here: |
| 33 | http://libnjb.sourceforge.net/ |
| 34 | |
| 35 | |
| 36 | Compiling programs for libmtp |
| 37 | ----------------------------- |
| 38 | |
| 39 | libmtp has support for the pkg-config script by adding a libmtp.pc |
| 40 | entry in $(prefix)/lib/pkgconfig. To compile a libmtp program, |
| 41 | "just" write: |
| 42 | |
| 43 | gcc -o foo `pkg-config --cflags --libs libmtp` foo.c |
| 44 | |
| 45 | This also simplifies compilation using autoconf and pkg-config: just |
| 46 | write e.g. |
| 47 | |
| 48 | PKG_CHECK_MODULES(MTP, libmtp) |
| 49 | AC_SUBST(MTP_CFLAGS) |
| 50 | AC_SUBST(MTP_LIBS) |
| 51 | |
| 52 | To have libmtp LIBS and CFLAGS defined. Needless to say, this will |
| 53 | only work if you have pkgconfig installed on your system, but most |
| 54 | people have nowadays. |
| 55 | |
| 56 | If your library is installed in e.g. /usr/local you may have to tell |
| 57 | this to pkgconfig by setting the PKG_CONFIG_PATH thus: |
| 58 | |
| 59 | export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig |
| 60 | |
| 61 | |
| 62 | Documentation |
| 63 | ------------- |
| 64 | |
| 65 | Read the API documentation that can be generated with doxygen. |
| 66 | It will be output in doc/html if you have Doxygen properly |
| 67 | installed. (It will not be created unless you have Doxygen!) |
| 68 | |
| 69 | For information about the Media Transfer Protocol, see: |
| 70 | http://en.wikipedia.org/wiki/Media_Transfer_Protocol |
| 71 | |
Linus Walleij | 7a83e55 | 2008-07-29 21:30:43 +0000 | [diff] [blame] | 72 | The official 1.0 specification for MTP was released by the |
| 73 | USB Implementers Forum in may, 2008. Prior to this, only a |
| 74 | proprietary Microsoft version was available, and quite a few |
| 75 | devices out there still use some aspects of the Microsoft |
| 76 | version, which deviates from the specified standard. You can |
| 77 | find the official specification here: |
| 78 | http://www.usb.org/developers/devclass_docs/MTP_1.0.zip |
Linus Walleij | 0dd71e9 | 2006-05-04 18:47:07 +0000 | [diff] [blame] | 79 | |
Linus Walleij | 1b91ca6 | 2008-10-17 07:07:56 +0000 | [diff] [blame] | 80 | |
| 81 | The Examples |
| 82 | ------------ |
| 83 | |
| 84 | In the subdirectory "examples" you find a number of |
| 85 | command-line tools, illustrating the use of libmtp in very |
| 86 | simple terms. |
| 87 | |
| 88 | Please do not complain about the usability or documentation |
| 89 | of these examples, they look like they do for two reasons: |
| 90 | |
| 91 | 1. They are examples, not tools. If they were intended for |
| 92 | day-to-day usage by commandline freaks, I would have |
| 93 | called them "tools" not "examples". |
| 94 | |
| 95 | 2. The MTP usage paradigm is that a daemon should hook |
| 96 | the device upon connection, and that it should be |
| 97 | released by unplugging. GUI tools utilizing HAL (hald) |
| 98 | and D-Bus do this much better than any commandline |
| 99 | program ever can. (See below on bugs.) Specificationwise |
| 100 | this is a bug, however it is present in many, many |
| 101 | devices. |
| 102 | |
| 103 | That said, if you want to pick up and maintain the examples, |
| 104 | please volunteer. |
| 105 | |
| 106 | |
Linus Walleij | 0dd71e9 | 2006-05-04 18:47:07 +0000 | [diff] [blame] | 107 | Contributing |
| 108 | ------------ |
| 109 | |
| 110 | See the project page at http://libmtp.sourceforge.net/ |
Linus Walleij | ee73ef2 | 2006-08-27 19:56:00 +0000 | [diff] [blame] | 111 | We always need your help. There is a mailinglist and a |
| 112 | bug report system there. |
Linus Walleij | 6fd2f08 | 2006-03-28 07:19:22 +0000 | [diff] [blame] | 113 | |
Linus Walleij | a1b66f2 | 2007-05-10 20:02:16 +0000 | [diff] [blame] | 114 | |
| 115 | New Devices |
| 116 | ----------- |
| 117 | |
Linus Walleij | fcf8891 | 2006-06-05 13:23:33 +0000 | [diff] [blame] | 118 | If you happen upon a device which libmtp claims it cannot |
| 119 | autodetect, please submit the vendor ID and device ID |
Linus Walleij | 9ee2940 | 2007-10-31 20:24:48 +0000 | [diff] [blame] | 120 | (these can be obtained from the "lsusb" and "lsusb -n" |
| 121 | commands run as root) as a bug, patch or feature request |
| 122 | on the Sourceforge bug tracker at our homepage. If it |
| 123 | gives a sensible output from "mtp-detect" then please attach |
| 124 | the result as well as it teach us some stuff about your |
| 125 | device. If you've done some additional hacking, join our |
| 126 | mailinglist and post your experiences there. |
Linus Walleij | da558be | 2007-03-10 21:42:25 +0000 | [diff] [blame] | 127 | |
Linus Walleij | a1b66f2 | 2007-05-10 20:02:16 +0000 | [diff] [blame] | 128 | If you want to be able to hack some more and you're not |
| 129 | afraid of C hacking, add an entry for your device's |
| 130 | vendor/product ID and a descriptive string to the database |
Linus Walleij | 6dc0168 | 2007-11-15 21:23:46 +0000 | [diff] [blame] | 131 | in the file src/music-players.h. |
Linus Walleij | a1b66f2 | 2007-05-10 20:02:16 +0000 | [diff] [blame] | 132 | |
| 133 | If you want to poke around to see if your device has some |
| 134 | special pecularities, you can test some special device |
Linus Walleij | 6dc0168 | 2007-11-15 21:23:46 +0000 | [diff] [blame] | 135 | flags (defined in src/device-flags.h) by inserting them |
| 136 | together with your device entry in src/music-players.h. |
Linus Walleij | a1b66f2 | 2007-05-10 20:02:16 +0000 | [diff] [blame] | 137 | Flags can be tested in isolation or catenated with "|" |
| 138 | (binary OR). If relatives to your device use a certain |
| 139 | flag, chances are high that a new device will need it |
| 140 | too, typically from the same manufacturer. |
| 141 | |
| 142 | The most common flag that needs to be set is the |
| 143 | DEVICE_FLAG_UNLOAD_DRIVER that detach any Linux kernel |
| 144 | drivers that may have attached to the device making |
Linus Walleij | 94f23d5 | 2007-08-04 19:37:28 +0000 | [diff] [blame] | 145 | MTP access impossible. This is however not expected to |
| 146 | really work: this is a problem being tracked as of |
| 147 | now (2007-08-04). See the "last resort" solutions below |
| 148 | if you really need to get your dual-mode device to work |
| 149 | with MTP. |
Linus Walleij | a1b66f2 | 2007-05-10 20:02:16 +0000 | [diff] [blame] | 150 | |
Linus Walleij | cc2cf97 | 2007-11-22 20:23:43 +0000 | [diff] [blame] | 151 | Another flag which is easy to identify is the |
| 152 | DEVICE_FLAG_NO_ZERO_READS, which remedies connection |
| 153 | timeouts when getting files, and some timeouts on e.g. |
| 154 | successive "mtp-connect" calls. |
| 155 | |
Linus Walleij | 91fb028 | 2007-09-03 21:16:08 +0000 | [diff] [blame] | 156 | If you are a device vendor, please consider assigning one |
| 157 | of your employees as a contact person for libmtp, have them |
| 158 | sign up to the libmtp development list and answer questions |
| 159 | and post new device ID:s as they are released to our |
| 160 | mailing list. By the way: do you have spare devices you |
| 161 | can give us? Send them to Richard (Mac support) or Linus |
| 162 | (Linux support). (So far nobody did that except for Microsoft |
| 163 | who sent us a Zune by proxy!) |
| 164 | |
Linus Walleij | a1b66f2 | 2007-05-10 20:02:16 +0000 | [diff] [blame] | 165 | If your device is very problematic we are curious of how it |
Linus Walleij | da558be | 2007-03-10 21:42:25 +0000 | [diff] [blame] | 166 | works under Windows, so we enjoy reading USB packet sniffs |
| 167 | that reveal the low-level traffic carried out between |
| 168 | Windows Media Player and your device. This can be done |
Linus Walleij | 61c2568 | 2007-09-04 14:46:21 +0000 | [diff] [blame] | 169 | using e.g.: |
| 170 | |
| 171 | * USBsnoop: |
| 172 | http://benoit.papillault.free.fr/usbsnoop/ |
| 173 | |
| 174 | * The trial version of HHD Softwares software-only |
| 175 | USB monitor. You need to get a copy of version 2.37 since |
| 176 | the newer trial versions won't let you carry out the |
| 177 | needed packet sniffs. (As of 2007-03-10 a copy can be found |
| 178 | at: http://www.cobbleware.com/files/usb-monitor-237.exe) |
| 179 | |
Linus Walleij | da558be | 2007-03-10 21:42:25 +0000 | [diff] [blame] | 180 | There are other USB monitors as well, some more expensive |
| 181 | alternatives use hardware and even measure electronic |
| 182 | characteristics of the traffic (which is far too much |
| 183 | detail for us). |
| 184 | |
Linus Walleij | 91fb028 | 2007-09-03 21:16:08 +0000 | [diff] [blame] | 185 | Device sniffs are an easy read since the PTP/MTP protocol |
| 186 | is nicely structured. All commands will have a structure such |
| 187 | as this in the log, we examplify with a object list request: |
| 188 | |
| 189 | PTP REQEUST: |
| 190 | 000120: Bulk or Interrupt Transfer (UP), 03.09.2007 12:49:25.9843750 +0.0 |
| 191 | Pipe Handle: 0x863ce234 (Endpoint Address: 0x2) |
| 192 | Send 0x20 bytes to the device: |
| 193 | 20 00 00 00 01 00 05 98 23 00 00 00 27 03 00 10 ......?#...'... |
| 194 | Length TYPE CMD Trans# Param1 |
| 195 | |
| 196 | 00 00 00 00 02 DC 00 00 00 00 00 00 00 00 00 00 .....Ü.......... |
| 197 | Param2 Param3 Param4 Param5 |
| 198 | |
| 199 | [OPTIONAL] DATA PHASE: |
| 200 | 000121: Bulk or Interrupt Transfer (UP), 03.09.2007 12:49:26.0 +0.0156250 |
| 201 | Pipe Handle: 0x863ce214 (Endpoint Address: 0x81) |
| 202 | Get 0x1a bytes from the device: |
| 203 | 1A 00 00 00 02 00 05 98 23 00 00 00 01 00 00 00 .......?#....... |
| 204 | Length TYPE CMD Trans# DATA |
| 205 | |
| 206 | 27 03 00 10 02 DC 04 00 00 30 '....Ü...0 |
| 207 | |
| 208 | RESPONSE: |
| 209 | 000122: Bulk or Interrupt Transfer (UP), 03.09.2007 12:49:26.0 +0.0 |
| 210 | Pipe Handle: 0x863ce214 (Endpoint Address: 0x81) |
| 211 | Get 0xc bytes from the device: |
| 212 | 0C 00 00 00 03 00 01 20 23 00 00 00 ....... #... |
| 213 | Length TYPE CODE Trans# |
| 214 | |
| 215 | * One send (OUT to the device), two reads (IN from the device). |
| 216 | |
| 217 | * All three byte chunks commands are |
| 218 | sent/recieved/recieeved by the function ptp_transaction() |
| 219 | in the file ptp.c. |
| 220 | |
| 221 | * It boils down to ptp_usb_sendreq(), optionally ptp_usb_senddata() |
| 222 | or ptp_usb_getdata() and finally ptp_usb_getresp() in the file |
| 223 | libusb-glue.c. Notice ptp_usb_sendreq() and ptp_usb_getresp() |
| 224 | are ALWAYS called. The TYPE field correspond to this, so the |
| 225 | TYPES in this case are "COMMAND" (0x0001), "DATA" (0x0002), |
| 226 | and "RESPONSE" (0x0003). |
| 227 | |
| 228 | * Notice that the byte order is little endian, so you need to read |
| 229 | each field from right to left. |
| 230 | |
| 231 | * This COMMAND has: |
| 232 | CMD 0x99805, we see in ptp.h that this is PTP_OC_MTP_GetObjPropList. |
| 233 | Transaction# 0x00000023. |
| 234 | REQUEST parameters 0x10000327, 0x00000000, 0x0000DC02, 0x00000000 |
| 235 | 0x00000000, in this case it means "get props for object 0x10000327", |
| 236 | "any format", "property 0xDC02" (PTP_OPC_ObjectFormat), then two |
| 237 | parameters that are always zero (no idea what they mean or their |
| 238 | use). |
| 239 | |
| 240 | * The DATA has: |
| 241 | CMD 0x99805, we see in ptp.h that this is PTP_OC_MTP_GetObjPropList. |
| 242 | Transaction# 0x00000023. |
| 243 | Then comes data 0x00000001, 0x10000327, 0xDC02, 0x0004, 0x3000 |
| 244 | Which means in this case, (and this is the tricky part) "here |
| 245 | you have 1 property", "for object 0x10000327", "it is property |
| 246 | 0xDC02" (PTP_OPC_ObjectFormat), "which is of type 0x0004" |
| 247 | (PTP_DTC_UINT16), "and set to 0x3000" (PTP_OFC_Undefined, it |
| 248 | is perfectly valid to have undefined object formats, since it |
| 249 | is a legal value defining this). |
| 250 | |
| 251 | * This RESPONSE has: |
| 252 | CMD 0x99805, we see in ptp.h that this is PTP_OC_MTP_GetObjPropList. |
| 253 | Return Code ("RC") = 0x2001, PTP_RC_OK, all went fine. |
| 254 | Transaction# 0x00000023. |
Linus Walleij | fcf8891 | 2006-06-05 13:23:33 +0000 | [diff] [blame] | 255 | |
Linus Walleij | d05fce6 | 2007-09-29 20:17:23 +0000 | [diff] [blame] | 256 | If you want to compare the Windows behaviour with a similar |
Linus Walleij | 6dc0168 | 2007-11-15 21:23:46 +0000 | [diff] [blame] | 257 | operation using libmtp you can go into the src/libusb-glue.c |
| 258 | file and uncomment the row that reads: |
Linus Walleij | d05fce6 | 2007-09-29 20:17:23 +0000 | [diff] [blame] | 259 | |
| 260 | //#define ENABLE_USB_BULK_DEBUG |
| 261 | |
| 262 | (I.e. remove the two //.) |
| 263 | |
| 264 | This will make libmtp print out a hex dump of every bulk USB |
| 265 | transaction. The bulk transactions contain all the PTP/MTP layer |
| 266 | data, which is usually where the problems appear. |
| 267 | |
Linus Walleij | 6fd2f08 | 2006-03-28 07:19:22 +0000 | [diff] [blame] | 268 | |
Linus Walleij | bd7624c | 2007-05-28 10:48:54 +0000 | [diff] [blame] | 269 | Devices does not work - last resort: |
| 270 | ------------------------------------ |
| 271 | |
| 272 | Some devices that are dual-mode are simply impossible to get |
| 273 | to work under Linux because the usb-storage(.ko) kernel |
| 274 | module hook them first, and refuse to release them, even |
Linus Walleij | 94f23d5 | 2007-08-04 19:37:28 +0000 | [diff] [blame] | 275 | when we specify the DEVICE_FLAG_UNLOAD_DRIVER flag. (Maybe |
| 276 | it DOES release it but the device will immediately be probed |
| 277 | at the USB mass storage interface AGAIN because it |
| 278 | enumerates.) |
Linus Walleij | bd7624c | 2007-05-28 10:48:54 +0000 | [diff] [blame] | 279 | |
Linus Walleij | e20abaf | 2007-12-10 11:20:34 +0000 | [diff] [blame] | 280 | Linux: Try this, if you have a recent 2.6.x Linux kernel, |
Linus Walleij | 584eb8d | 2007-09-05 19:51:27 +0000 | [diff] [blame] | 281 | run (as root) something like: |
| 282 | |
| 283 | > rmmod usb_storage ; mtp-detect |
| 284 | |
| 285 | You can run most any command or a client like gnomad2 or |
| 286 | Amarok immediately after the rmmod command. This works |
| 287 | sometimes. Another way: |
Linus Walleij | bd7624c | 2007-05-28 10:48:54 +0000 | [diff] [blame] | 288 | |
Linus Walleij | 94f23d5 | 2007-08-04 19:37:28 +0000 | [diff] [blame] | 289 | * Edit /etc/modprobe.d/blacklist |
Linus Walleij | bd7624c | 2007-05-28 10:48:54 +0000 | [diff] [blame] | 290 | |
| 291 | * Add the line "blacklist usb-storage" |
| 292 | |
| 293 | * Reboot. |
| 294 | |
| 295 | Now none of you USB disks, flash memory sticks etc will be |
| 296 | working (you just disabled them all). However you *can* try |
| 297 | your device, and it might have started working because there |
| 298 | is no longer a USB mass storage driver that tries to hook onto |
| 299 | the mass storage interface of your device. |
| 300 | |
Linus Walleij | 94f23d5 | 2007-08-04 19:37:28 +0000 | [diff] [blame] | 301 | If not even blacklisting works (check with |
| 302 | "lsmod | grep usb-storage"), there is some problem with |
| 303 | something else and you may need to remove or rename the file |
| 304 | /lib/modules/<VERSION>/kernel/drivers/usb/storage/usb-storage.ko |
| 305 | manually. |
| 306 | |
Linus Walleij | bd7624c | 2007-05-28 10:48:54 +0000 | [diff] [blame] | 307 | If you find the PerfectSolution(TM) to this dilemma, so you |
| 308 | can properly switch for individual devices whether to use it |
| 309 | as USB mass storage or not, please tell us how you did it. We |
| 310 | know we cannot use udev, because udev is called after-the-fact: |
| 311 | the device is already configured for USB mass storage when |
| 312 | udev is called. |
| 313 | |
Linus Walleij | e20abaf | 2007-12-10 11:20:34 +0000 | [diff] [blame] | 314 | On Mac OS there is another ugly hack: |
| 315 | |
| 316 | 1. Open up a terminal window |
| 317 | 2. Type: |
| 318 | sudo mv /System/Library/Extensions/IOUSBMassStorageClass.kext |
| 319 | /System/Library/Extensions/IOUSBMassStorageClass.kext.disabled |
| 320 | |
| 321 | and when prompted enter your password. |
| 322 | |
| 323 | 3. Restart. |
| 324 | |
| 325 | To reverse this change, just reverse the filenames: |
| 326 | |
| 327 | sudo mv /System/Library/Extensions/ |
| 328 | IOUSBMassStorageClass.kext.disabled /System/Library/Extensions/ |
| 329 | IOUSBMassStorageClass.kext |
| 330 | |
| 331 | and restart. |
| 332 | |
Linus Walleij | bd7624c | 2007-05-28 10:48:54 +0000 | [diff] [blame] | 333 | |
Linus Walleij | 15def33 | 2006-09-19 14:27:02 +0000 | [diff] [blame] | 334 | Calendar and contact support: |
| 335 | ----------------------------- |
Linus Walleij | d3bdf76 | 2006-02-20 22:21:56 +0000 | [diff] [blame] | 336 | |
Linus Walleij | 3c16fe4 | 2006-04-30 07:53:41 +0000 | [diff] [blame] | 337 | The Creative Zen series can read VCALENDAR2 (.ics) files |
Linus Walleij | 15def33 | 2006-09-19 14:27:02 +0000 | [diff] [blame] | 338 | and VCard (.vcf) files from programs like for example |
| 339 | Evolution with the following limitations/conditions: |
Linus Walleij | d3bdf76 | 2006-02-20 22:21:56 +0000 | [diff] [blame] | 340 | |
Linus Walleij | 3c16fe4 | 2006-04-30 07:53:41 +0000 | [diff] [blame] | 341 | - The file must be in DOS (CR/LF) format, use the unix2dos |
| 342 | program to convert if needed |
Linus Walleij | 15def33 | 2006-09-19 14:27:02 +0000 | [diff] [blame] | 343 | |
| 344 | - Repeat events in calendar files do not seem to be supported, |
| 345 | entries will only appear once. |
| 346 | |
| 347 | - Calendar (.ics) files should be stored in the folder "My Organizer" |
| 348 | when sent to the device (this directory should be autodetected |
Linus Walleij | 80b2c72 | 2006-06-22 17:57:17 +0000 | [diff] [blame] | 349 | for use with calendar files, otherwise use the option |
Linus Walleij | 15def33 | 2006-09-19 14:27:02 +0000 | [diff] [blame] | 350 | -f "My Organizer" to sendfile for this) Apparently this file can |
| 351 | also contain tasklists. |
| 352 | |
| 353 | - Contact (.vcf) files should be stored in the folder "My Contacts" |
| 354 | when sent to the device. (-f "My Contacts") |
| 355 | |
| 356 | - Some devices are picky about the name of the calendar and |
| 357 | contact files. For example the Zen Microphoto wants: |
| 358 | |
Linus Walleij | b1318d1 | 2006-09-25 14:59:26 +0000 | [diff] [blame] | 359 | Calendar: My Organizer/6651416.ics |
| 360 | Contacts: My Organizer/6651416.vcf |
| 361 | |
| 362 | |
| 363 | Syncing in with Evolution and Creative Devices |
| 364 | ---------------------------------------------- |
| 365 | |
| 366 | Evolution can easily export .ics an .vcf files, but you currently |
| 367 | need some command-line hacking to get you stuff copied over in |
| 368 | one direction host -> device. The examples/ directory contains a script |
| 369 | created for the Creative Zen Microphoto by Nicolas Tetreault. |
| 370 | |
Linus Walleij | 6e8cef4 | 2006-12-03 20:45:04 +0000 | [diff] [blame] | 371 | |
| 372 | It's Not Our Bug! |
| 373 | ----------------- |
| 374 | |
| 375 | Some MTP devices have strange pecularities. We try to work around |
| 376 | these whenever we can, sometimes we cannot work around it or we |
| 377 | cannot test your solution. |
| 378 | |
Linus Walleij | 67038b9 | 2008-04-16 15:01:40 +0000 | [diff] [blame] | 379 | * Generic MTP/PTP disconnect misbehaviour: we have noticed that |
| 380 | Windows Media Player apparently never close the session to an MTP |
| 381 | device. There is a daemon in Windows that "hooks" the device |
| 382 | by opening a PTP session to any MTP device, whenever it is |
| 383 | plugged in. This daemon proxies any subsequent transactions |
| 384 | to/from the device and will never close the session, thus |
| 385 | Windows simply does not close sessions at all. |
| 386 | |
| 387 | This means that device manufacturers doesn't notice any problems |
| 388 | with devices that do not correctly handle closing PTP/MTP |
| 389 | sessions, since Windows never do it. The proper way of closing |
| 390 | a session in Windows is to unplug the device, simply put. |
| 391 | |
| 392 | Since libmtp actually tries to close sessions, some devices |
| 393 | may fail since the close session functionality has never been |
| 394 | properly tested, and "it works with Windows" is sort of the |
| 395 | testing criteria at some companies. |
| 396 | |
| 397 | You can get Windows-like behaviour on Linux by running a HAL-aware |
| 398 | libmtp GUI client like Rhythmbox or Gnomad2, which will "hook" |
| 399 | the device when you plug it in, and "release" it if you unplug |
| 400 | it. |
| 401 | |
| 402 | If this bug in your device annoys you, contact your device |
| 403 | manufacturer and ask them to test their product with some libmtp |
| 404 | program. |
| 405 | |
Linus Walleij | b715ba6 | 2008-02-12 23:41:49 +0000 | [diff] [blame] | 406 | * Generic USB misbehaviour: some devices behave badly under MTP |
| 407 | and USB mass storage alike, even down to the lowest layers |
| 408 | of USB. You can always discuss such issues at the linux-usb |
| 409 | mailing list if you're using Linux: |
| 410 | http://www.linux-usb.org/mailing.html |
| 411 | |
Linus Walleij | 76b185d | 2008-02-12 23:46:14 +0000 | [diff] [blame] | 412 | If you have a problem specific to USB mass storage mode, there |
| 413 | is a list of strange behaving devices in the Linux kernel: |
| 414 | http://lxr.linux.no/linux/drivers/usb/storage/unusual_devs.h |
Linus Walleij | f7d8df1 | 2008-02-13 00:02:17 +0000 | [diff] [blame] | 415 | You can discuss this too on the mentioned list, for understanding |
| 416 | the quirks, see: |
| 417 | http://www2.one-eyed-alien.net/~mdharm/linux-usb/target_offenses.txt |
Linus Walleij | 76b185d | 2008-02-12 23:46:14 +0000 | [diff] [blame] | 418 | |
Linus Walleij | deddc34 | 2008-08-16 23:52:06 +0000 | [diff] [blame] | 419 | * Kernel bug on Linux. Linux 2.6.16 is generally speaking required |
| 420 | to use any MTP device under USB 2.0. This is because the EHCI |
| 421 | driver previously did not support zero-length writes to endpoints. |
| 422 | It should work in most cases however, or if you connect it |
| 423 | to an UHCI/OHCI port instead (yielding lower speed). But |
| 424 | please just use a recent kernel. |
| 425 | |
Linus Walleij | 07bb538 | 2008-07-31 20:21:09 +0000 | [diff] [blame] | 426 | * Zen models AVI file seeking problem: the Zens cannot parse the |
| 427 | files for the runlength metadata. Do not transfer file with e.g. |
| 428 | mtp-sendfile, use mtp-sendtr and set the length of the track to |
| 429 | the apropriate number of seconds and it will work. In graphical |
| 430 | clients, use a "track transfer" function to send these AVI files, |
| 431 | the Zens need the metadata associated with tracks to play back |
| 432 | movies properly. Movies are considered "tracks" in the MTP world. |
| 433 | |
Linus Walleij | 64e2e98 | 2008-08-01 21:51:13 +0000 | [diff] [blame] | 434 | * Some devices that disregard the metadata sent with the MTP |
| 435 | commands will parse the files for e.g. ID3 metadata. Some still |
| 436 | of these devices expect only ID3v2.3 metadata and will fail with |
| 437 | a modern ID3v2,4 tag writer, like many of those found in Linux |
| 438 | applications. Windows Media Player use ID3v2.3 only, so many |
| 439 | manufacturers only test this version. |
| 440 | |
Linus Walleij | 6e8cef4 | 2006-12-03 20:45:04 +0000 | [diff] [blame] | 441 | * The Zen Vision:M (possibly more Creative Zens) has a firmware bug |
| 442 | that makes it drop the last two characters off a playlist name. |
| 443 | It is fixed in later firmware. |
| 444 | |
Linus Walleij | c41f2e8 | 2007-03-12 22:26:00 +0000 | [diff] [blame] | 445 | * For Creative Technology devices, there are hard limits on how |
| 446 | many files can be put onto the device. For a 30 GiB device (like |
| 447 | the Zen Xtra) the limit is 6000, for a 60 GiB device the limit |
| 448 | is 15000 files. For further Creative pecularities, see the |
| 449 | FAQ sections at www.nomadness.net. |
| 450 | |
Linus Walleij | d24a7ab | 2007-03-07 21:48:43 +0000 | [diff] [blame] | 451 | * Sandisk sansa c150 and probably several other Sandisk devices |
| 452 | (and possibly devices from other manufacturers) have a dual |
| 453 | mode with MTP and USB mass storage. The device will initially |
| 454 | claim to be mass storage so udev will capture is and make the |
Linus Walleij | da558be | 2007-03-10 21:42:25 +0000 | [diff] [blame] | 455 | use of MTP mode impossible. One way of avoiding it could be to |
Linus Walleij | d24a7ab | 2007-03-07 21:48:43 +0000 | [diff] [blame] | 456 | be to blacklist the "usb-storage" module in |
| 457 | /etc/modprobe.c/blacklist with a row like this: |
Linus Walleij | da558be | 2007-03-10 21:42:25 +0000 | [diff] [blame] | 458 | "blacklist usb-storage". Some have even removed the |
| 459 | "usb-storage.ko" (kernel module file) to avoid loading. |
Linus Walleij | d24a7ab | 2007-03-07 21:48:43 +0000 | [diff] [blame] | 460 | |
Linus Walleij | da558be | 2007-03-10 21:42:25 +0000 | [diff] [blame] | 461 | * The iriver devices (possibly all of them) cannot handle the |
Linus Walleij | 6e8cef4 | 2006-12-03 20:45:04 +0000 | [diff] [blame] | 462 | enhanced GetObjectPropList MTP command (0x9805) properly. So |
| 463 | they have been banned from using it. |
| 464 | |
Linus Walleij | da558be | 2007-03-10 21:42:25 +0000 | [diff] [blame] | 465 | * iriver devices have problems with older versions of libmtp and |
Linus Walleij | 8226522 | 2007-03-04 19:47:08 +0000 | [diff] [blame] | 466 | with new devices libmtp does not know of as of yet, since it |
| 467 | has an oldstyle USB device controller that cannot handle zero |
Linus Walleij | da558be | 2007-03-10 21:42:25 +0000 | [diff] [blame] | 468 | writes. (Register your device with us!) All their devices are |
| 469 | likely to need a special device flag in the src/libusb-glue.c |
| 470 | database. |
Linus Walleij | 8226522 | 2007-03-04 19:47:08 +0000 | [diff] [blame] | 471 | |
Linus Walleij | 6e8cef4 | 2006-12-03 20:45:04 +0000 | [diff] [blame] | 472 | * The Samsung Yepp T9 has several strange characteristics, some |
| 473 | that we've managed to work around. (For example it will return |
| 474 | multiple PTP packages in a single transaction.) |
| 475 | |
Linus Walleij | f2711b3 | 2007-02-26 20:18:40 +0000 | [diff] [blame] | 476 | * The early firmware for Philips HDD players is known to be |
| 477 | problematic. Please upgrade to as new firmware as you can get. |
| 478 | (Yes this requires some kind of Windows Installation I think.) |
| 479 | |
Linus Walleij | b5a4f92 | 2008-05-11 20:15:00 +0000 | [diff] [blame] | 480 | * Philips HDD 1630/16 or 1630/17 etc may lock themselves up, |
| 481 | turning inresponsive due to internal corruption. This typically |
| 482 | gives an error in opening the PTP session. Apparently you can |
| 483 | do a "repair" with the firmware utility (Windows only) which |
| 484 | will often fix this problem and make the device responsive |
| 485 | again. |
| 486 | |
Linus Walleij | 9340aac | 2007-10-01 10:02:05 +0000 | [diff] [blame] | 487 | * Some devices that implement GetObjectPropList (0x9805) will |
| 488 | not return the entire object list if you request a list for object |
| 489 | 0xffffffffu. (But they should.) So they may need the special |
| 490 | DEVICE_FLAG_BROKEN_MTPGETOBJPROPLIST_ALL. |
| 491 | |
| 492 | * Some (smaller) subset of devices cannot even get all the |
| 493 | properties for a single object in one go, these need the |
| 494 | DEVICE_FLAG_BROKEN_MTPGETOBJPROPLIST. Currently only the |
| 495 | iriver devices seem to have this bug. |
| 496 | |
| 497 | * The Toshiba Gigabeat S (and probably its sibling the |
| 498 | Microsoft Zune and other Toshiba devices) will only display |
| 499 | album information tags for a song in case there is also |
| 500 | an abstract album (created with the album interface) with |
| 501 | the exact same name. |
Linus Walleij | d132d8e | 2007-04-03 23:24:54 +0000 | [diff] [blame] | 502 | |
Linus Walleij | 265b9d6 | 2007-11-25 20:08:15 +0000 | [diff] [blame] | 503 | * The Zen Vision:M has an older firmware which is very corrupt, |
| 504 | it is incompatible with the Linux USB stack altogether. The |
| 505 | kernel dmesg will look something like this, and you have to |
| 506 | upgrade the firmware using Windows: |
| 507 | usb 4-5: new high speed USB device using ehci_hcd and address 5 |
| 508 | usb 4-5: configuration #1 chosen from 1 choice |
| 509 | usb 4-5: can't set config #1, error -110 |
Linus Walleij | d132d8e | 2007-04-03 23:24:54 +0000 | [diff] [blame] | 510 | |
Linus Walleij | 103a78e | 2008-08-25 20:48:52 +0000 | [diff] [blame] | 511 | * The Sirus Stiletto does not seem to allow you to copy any files |
| 512 | off the device. This may be someone's idea of copy protection. |
Linus Walleij | b715ba6 | 2008-02-12 23:41:49 +0000 | [diff] [blame] | 513 | |
Linus Walleij | 1b91ca6 | 2008-10-17 07:07:56 +0000 | [diff] [blame] | 514 | |
Linus Walleij | d132d8e | 2007-04-03 23:24:54 +0000 | [diff] [blame] | 515 | Lost symbols |
| 516 | ------------ |
| 517 | |
| 518 | Shared libraries can be troublesome to users not experienced with |
| 519 | them. The following is a condensed version of a generic question |
| 520 | that has appeared on the libmtp mailing list from time to time. |
| 521 | |
| 522 | > PTP: Opening session |
| 523 | > Queried Creative Zen Vision:M |
| 524 | > gnomad2: relocation error: gnomad2: undefined symbol: |
| 525 | > LIBMTP_Get_Storageinfo |
| 526 | > (...) |
| 527 | > Are these type of errors related to libmtp or something else? |
| 528 | |
| 529 | The problem is of a generic nature, and related to dynamic library |
| 530 | loading. It is colloquially known as "dependency hell". |
| 531 | (http://en.wikipedia.org/wiki/Dependency_hell) |
| 532 | |
| 533 | The gnomad2 application calls upon the dynamic linker in Linux to |
| 534 | resolve the symbol "LIBMTP_Get_Storageinfo" or any other symbol |
| 535 | (ELF symbol, or link point or whatever you want to call them, a |
| 536 | symbol is a label on a memory address that the linker shall |
| 537 | resolve from label to actual address.) |
| 538 | For generic information on this subject see the INSTALL file and |
| 539 | this Wikipedia page: |
| 540 | |
| 541 | http://en.wikipedia.org/wiki/Library_(computing) |
| 542 | |
| 543 | When Linux /lib/ld-linux.so.X is called to link the symbols compiled |
| 544 | into gnomad2 (or any other executable using libmtp), it examines the |
| 545 | ELF file for the libmtp.so.X file it finds first and cannot resolve |
| 546 | the symbol "LIBMTP_Get_Storageinfo" (or whichever symbol you have a |
| 547 | problem witj) from it, since it's probably not there. There are many |
| 548 | possible causes of this symbol breakage: |
| 549 | |
| 550 | 1) You installed precompiled libmtp and gnomad2 packages (RPMs, debs |
| 551 | whatever) that do not match up. Typical cause: your gnomad2 package was |
| 552 | built against a newer version of libmtp than what's installed on your |
| 553 | machine. Another typical cause: you installed a package you found on |
| 554 | the web, somewhere, the dependency resolution system did not protest |
| 555 | properly (as it should) or you forced it to install anyway, ignoring |
| 556 | some warnings. |
| 557 | |
| 558 | 2) You compiled libmtp and/or gnomad2 from source, installing both or |
| 559 | either in /usr/local/lib and /usr/local/bin. This means at compile-time |
| 560 | gnomad2 finds the libmtp library in /usr/local/lib but at runtime, it |
| 561 | depends on the Linux system wide library loader (/lib/ld-linux.so.X) in |
| 562 | order to resolve the symbols. This loader will look into the file |
| 563 | /etc/ld.so.conf and/or the folder /etc/ld.so.conf.d in order to find |
| 564 | paths to libraries to be used for resolving the symbols. If you have |
| 565 | some older version of libmtp in e.g. /usr/lib (typically installed by a |
| 566 | package manager) it will take precedence over the new version you just |
| 567 | installed in /usr/local/lib and the newly compiled library in |
| 568 | /usr/local/lib will *not* be used, resulting in this error message. |
| 569 | |
| 570 | 3) You really did install the very latest versions (as of writing libmtp |
| 571 | 0.1.5 and gnomad2 2.8.11) from source and there really is no |
| 572 | pre-installed package of either on your machine. In that case I'm |
| 573 | totally lost, I have no idea what's causing this. |
| 574 | |
| 575 | Typical remedies: |
| 576 | |
| 577 | 1) If you don't want to mess around with your system and risk these |
| 578 | situations, only use pre-packaged software that came with the |
| 579 | distribution or its official support channels. If it still breaks, |
| 580 | blame your distribution, they're not packaging correctly. Relying on |
| 581 | properly packaged software and not installing things yourself *is* the |
| 582 | Linux solution to the "dependency hell" problem. |
| 583 | |
| 584 | 2) Read about dynamically linked library handling until the stuff I wrote |
| 585 | about in the previous list sounds like music to your ears, inspect |
| 586 | your /lib, /usr/lib, /usr/local/lib, /etc/ld.so.conf and the |
| 587 | /etc/ld.so.conf.d, remove all pre-packed versions using RPM, APT, |
| 588 | YaST or whatever your distribution uses, compile libmtp and gnomad2 |
| 589 | (or whatever) from source only and you will be enlighted. |
| 590 | |
| 591 | I don't know if this helps you, it's the best answer we can give. |
Linus Walleij | 387e37a | 2008-10-29 17:22:22 +0000 | [diff] [blame^] | 592 | |
| 593 | |
| 594 | API is obscure - I want plain files! |
| 595 | ------------------------------------ |
| 596 | |
| 597 | PTP/MTP devices does not actually contain "files", they contain |
| 598 | objects. These objects have file names, but that is actually |
| 599 | just a name tag on the object. |
| 600 | |
| 601 | Folders/directories aren't really such entities: they are just |
| 602 | objects too, albeit objects that can act as parent to other |
| 603 | objects. They are called "association and are created in atomic |
| 604 | fashion and even though there is an MTP command to get all the |
| 605 | associations of an association, this command is optional so it is |
| 606 | perfectly possible (and most common, actually) to create devices |
| 607 | where the "folders" (which are actually associations) have no idea |
| 608 | whatsoever of what files they are associated as parents to |
| 609 | (i.e. which files they contain). This is very easy for device |
| 610 | manufacturers to implement, all the association has to be done by |
| 611 | the MTP Initiator / host computer. |
| 612 | |
| 613 | Moving a file to a new folder is for example very simple in a |
| 614 | "real" file system. In PTP/MTP devices it is often not even possible, |
| 615 | some devices *may* be able to do that. But actually the only |
| 616 | reliable way of doing that is to upload the file to the host, |
| 617 | download it with the new parent, then scratch the old file. |
| 618 | We have played with the idea of implementing this time consuming |
| 619 | function, perhaps we will. |
| 620 | |
| 621 | Playlists and albums aren't really files, thinking about |
| 622 | them as files like the hacks in libgphoto2 is really backwards. They are |
| 623 | called associations and are more like a symbolic link that links in a |
| 624 | star-shaped pattern to all the files that are part of the album/playlist. |
| 625 | Some devices (Samsung) thought that was too complicated and have a |
| 626 | different way of storing playlists in an UTF-16 encoded .spl-like file |
| 627 | instead! This is why playlists/albums must have their own structs and |
| 628 | functions. |
| 629 | |
| 630 | |
| 631 | I Want Streaming! |
| 632 | ----------------- |
| 633 | |
| 634 | Streaming reads is easy. Just connect the output file descriptor from |
| 635 | LIBMTP_Get_File_To_File_Descriptor() (and a similar function for tracks) |
| 636 | wherever you want. |
| 637 | |
| 638 | People have connected this to TCP sockets for streaming web servers |
| 639 | etc, works like a charm. Some devices will even survive if the callback |
| 640 | functions return non-zero and cancel the download. Some devices will |
| 641 | lock up and even require a reset if you do that. Devices are poorly |
| 642 | implemented so that's life. If you want to stream off a device, the |
| 643 | best idea is always to stream the entire file and discard the stuff |
| 644 | at the end you don't want. It will incur a delay if you e.g. want to |
| 645 | skip between tracks, sadly. |
| 646 | |
| 647 | Then we get to the complicated things: streaming WRITES... |
| 648 | |
| 649 | There is a function: |
| 650 | LIBMTP_Send_File_From_File_Descriptor() (and similar for tracks) |
| 651 | which will write a file to a device from a file descriptor, which may |
| 652 | be a socket or whatever. |
| 653 | |
| 654 | HOWEVER: this requires a piece of metadata with the .filesize properly |
| 655 | set first. |
| 656 | |
| 657 | This is not because we think it is funny to require that, the protocol |
| 658 | requires it. The reason is that PTP/MTP is a transactional file system |
| 659 | and it wants to be able to deny file transfer if the file won't fit on |
| 660 | the device, so the transaction never even starts, it's impossible to |
| 661 | start a transaction without giving file length. |
| 662 | |
| 663 | People really want streaming so I tried a lot of hacks to see if they |
| 664 | would work, such as setting file size to 0xffffffffU or something other |
| 665 | unnaturally big and then aborting the file transfer when the stream ends. |
| 666 | It doesn't work: either the device crashes or the file simply disappears |
| 667 | since the device rolls back all failed transactions. |
| 668 | |
| 669 | So this is an inherent limitation of the PTP/MTP protocol. |