summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 12 insertions, 14 deletions
diff --git a/README b/README
index 7e5c2bb..430f217 100644
--- a/README
+++ b/README
@@ -8,22 +8,18 @@ command/response payloads instead of binary blobs. The outer binary protocol is
8still the same used but now the only command/response format is 8 (plist). 8still the same used but now the only command/response format is 8 (plist).
9 9
10The server is under the usbmuxd directory. You'll need CMake and libusb 1.0 to 10The server is under the usbmuxd directory. You'll need CMake and libusb 1.0 to
11build it. In addition, you need to apply the libusb patch in the patches/ 11build it. Due to a bug in zero-length packet handling, you'll need either the
12directory. If you want to debug using valgrind, apply the valgrind patch to 12git version of libusb or 1.0.3, whenever it comes out.
13improve the handling of the USB device filesystem ioctls.
14 13
15There is a Python client library in the python-client directory. It should be 14There is a Python client library in the python-client directory. It should be
16compatible with Windows, Linux, and OSX (using the Apple usbmuxd on Win and OSX) 15compatible with Windows, Linux, and OSX (using the Apple usbmuxd on Win and OSX)
17tcprelay.py implements a TCP connection forwarder that lets you pipe TCP 16tcprelay.py implements a TCP connection forwarder that lets you pipe TCP
18connections to localhost to the phone. Run it with --help for usage. Note that 17connections to localhost to the phone. Run it with --help for usage. The Python
19under OSX you'll have to change the socket path from /tmp/usbmuxd to 18client lib is also compatible with the new plist-based protocol and should
20/var/run/usbmuxd (there is no socket path on Windows, only a TCP connection to 19automatically select it if it sees such a server. However, you need Python 2.6
21localhost). The Python client lib is also compatible with the new plist-based 20for Windows and Linux in this case, since the plistlib module doesn't come with
22protocol and should automatically select it if it sees such a server. However, 21older versions under these OSes (not that you'll have a server that supports
23you need Python 2.6 for Windows and Linux in this case, since the plistlib 22this protocol under Linux. TODO: does Windows iTunes use this yet?)
24module doesn't come with older versions under these OSes (not that you'll have a
25server that supports this protocol under Linux. TODO: does Windows iTunes even
26use this yet?)
27 23
28ARCHITECTURE 24ARCHITECTURE
29 25
@@ -100,7 +96,9 @@ GOTCHAS AND ANNOYANCES
100The usbmuxd CONNECT request port field is byte-swapped (network-endian). This is 96The usbmuxd CONNECT request port field is byte-swapped (network-endian). This is
101even more annoying for the plist based protocol, since it's even true there 97even more annoying for the plist based protocol, since it's even true there
102(where the field is plain text). So even for the plain text int, you need to 98(where the field is plain text). So even for the plain text int, you need to
103swap the bytes (port 22 becomes <integer>5632</integer>). 99swap the bytes (port 22 becomes <integer>5632</integer>). I have no clue if this
100is the case on the new plist protocol on PPC macs (is the newer iTunes available
101for those?)
104 102
105There are a bunch of gotchas due to the USB framing, and this is even worse 103There are a bunch of gotchas due to the USB framing, and this is even worse
106because implementations tend to get it wrong (i.e. libusb, and this is the 104because implementations tend to get it wrong (i.e. libusb, and this is the
@@ -135,7 +133,7 @@ is normally not an issue, but it's annoying for debugging because lost packets
135gets out of sync and then might crash and burn dozens of packets later. 133gets out of sync and then might crash and burn dozens of packets later.
136 134
137The server needs a proper front-end (i.e. daemonizing, commandline options, 135The server needs a proper front-end (i.e. daemonizing, commandline options,
138etc), a lot of testing, and some optimizing. 136etc), more testing, and some optimizing.
139 137
140Someone should probably do some edge-case testing on the TCP stuff. 138Someone should probably do some edge-case testing on the TCP stuff.
141 139