The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2007 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 | |
Yabin Cui | aed3c61 | 2015-09-22 15:52:57 -0700 | [diff] [blame] | 17 | #define TRACE_TAG TRANSPORT |
Dan Albert | 3313426 | 2015-03-19 15:21:08 -0700 | [diff] [blame] | 18 | |
| 19 | #include "sysdeps.h" |
| 20 | #include "transport.h" |
| 21 | |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 22 | #include <stdio.h> |
| 23 | #include <stdlib.h> |
| 24 | #include <string.h> |
| 25 | |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 26 | #include "adb.h" |
| 27 | |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 28 | #if ADB_HOST |
| 29 | |
Josh Gao | 801048c | 2017-12-06 15:06:14 -0800 | [diff] [blame] | 30 | #if defined(__APPLE__) |
| 31 | #define CHECK_PACKET_OVERFLOW 0 |
| 32 | #else |
| 33 | #define CHECK_PACKET_OVERFLOW 1 |
| 34 | #endif |
| 35 | |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 36 | // Call usb_read using a buffer having a multiple of usb_get_max_packet_size() bytes |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 37 | // to avoid overflow. See http://libusb.sourceforge.net/api-1.0/packetoverflow.html. |
| 38 | static int UsbReadMessage(usb_handle* h, amessage* msg) { |
| 39 | D("UsbReadMessage"); |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 40 | |
Josh Gao | 801048c | 2017-12-06 15:06:14 -0800 | [diff] [blame] | 41 | #if CHECK_PACKET_OVERFLOW |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 42 | size_t usb_packet_size = usb_get_max_packet_size(h); |
Josh Gao | e467209 | 2017-08-28 14:43:24 -0700 | [diff] [blame] | 43 | CHECK_GE(usb_packet_size, sizeof(*msg)); |
| 44 | CHECK_LT(usb_packet_size, 4096ULL); |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 45 | |
| 46 | char buffer[4096]; |
| 47 | int n = usb_read(h, buffer, usb_packet_size); |
| 48 | if (n != sizeof(*msg)) { |
| 49 | D("usb_read returned unexpected length %d (expected %zu)", n, sizeof(*msg)); |
| 50 | return -1; |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 51 | } |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 52 | memcpy(msg, buffer, sizeof(*msg)); |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 53 | return n; |
Josh Gao | 801048c | 2017-12-06 15:06:14 -0800 | [diff] [blame] | 54 | #else |
| 55 | return usb_read(h, msg, sizeof(*msg)); |
| 56 | #endif |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 57 | } |
| 58 | |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 59 | // Call usb_read using a buffer having a multiple of usb_get_max_packet_size() bytes |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 60 | // to avoid overflow. See http://libusb.sourceforge.net/api-1.0/packetoverflow.html. |
| 61 | static int UsbReadPayload(usb_handle* h, apacket* p) { |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 62 | D("UsbReadPayload(%d)", p->msg.data_length); |
| 63 | |
Josh Gao | f571fcb | 2018-02-05 18:49:10 -0800 | [diff] [blame] | 64 | if (p->msg.data_length > MAX_PAYLOAD) { |
Josh Gao | 5caaebd | 2018-02-02 14:38:04 -0800 | [diff] [blame] | 65 | return -1; |
| 66 | } |
| 67 | |
Josh Gao | 801048c | 2017-12-06 15:06:14 -0800 | [diff] [blame] | 68 | #if CHECK_PACKET_OVERFLOW |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 69 | size_t usb_packet_size = usb_get_max_packet_size(h); |
Josh Gao | ef3d343 | 2017-05-02 15:01:09 -0700 | [diff] [blame] | 70 | |
| 71 | // Round the data length up to the nearest packet size boundary. |
| 72 | // The device won't send a zero packet for packet size aligned payloads, |
| 73 | // so don't read any more packets than needed. |
| 74 | size_t len = p->msg.data_length; |
| 75 | size_t rem_size = len % usb_packet_size; |
| 76 | if (rem_size) { |
| 77 | len += usb_packet_size - rem_size; |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 78 | } |
Josh Gao | f571fcb | 2018-02-05 18:49:10 -0800 | [diff] [blame] | 79 | |
| 80 | p->payload.resize(len); |
| 81 | int rc = usb_read(h, &p->payload[0], p->payload.size()); |
| 82 | if (rc != static_cast<int>(p->msg.data_length)) { |
| 83 | return -1; |
| 84 | } |
| 85 | |
| 86 | p->payload.resize(rc); |
| 87 | return rc; |
Josh Gao | 801048c | 2017-12-06 15:06:14 -0800 | [diff] [blame] | 88 | #else |
Josh Gao | f571fcb | 2018-02-05 18:49:10 -0800 | [diff] [blame] | 89 | p->payload.resize(p->msg.data_length); |
| 90 | return usb_read(h, &p->payload[0], p->payload.size()); |
Josh Gao | 801048c | 2017-12-06 15:06:14 -0800 | [diff] [blame] | 91 | #endif |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 92 | } |
| 93 | |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 94 | static int remote_read(apacket* p, usb_handle* usb) { |
| 95 | int n = UsbReadMessage(usb, &p->msg); |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 96 | if (n < 0) { |
| 97 | D("remote usb: read terminated (message)"); |
| 98 | return -1; |
| 99 | } |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 100 | if (static_cast<size_t>(n) != sizeof(p->msg)) { |
| 101 | D("remote usb: read received unexpected header length %d", n); |
| 102 | return -1; |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 103 | } |
| 104 | if (p->msg.data_length) { |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 105 | n = UsbReadPayload(usb, p); |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 106 | if (n < 0) { |
| 107 | D("remote usb: terminated (data)"); |
| 108 | return -1; |
| 109 | } |
| 110 | if (static_cast<uint32_t>(n) != p->msg.data_length) { |
| 111 | D("remote usb: read payload failed (need %u bytes, give %d bytes), skip it", |
| 112 | p->msg.data_length, n); |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 113 | return -1; |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 114 | } |
| 115 | } |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 116 | return 0; |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | #else |
| 120 | |
| 121 | // On Android devices, we rely on the kernel to provide buffered read. |
| 122 | // So we can recover automatically from EOVERFLOW. |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 123 | static int remote_read(apacket* p, usb_handle* usb) { |
| 124 | if (usb_read(usb, &p->msg, sizeof(amessage))) { |
Josh Gao | 184f571 | 2017-07-26 11:06:55 -0700 | [diff] [blame] | 125 | PLOG(ERROR) << "remote usb: read terminated (message)"; |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 126 | return -1; |
| 127 | } |
| 128 | |
Josh Gao | 36dadca | 2017-05-16 15:02:45 -0700 | [diff] [blame] | 129 | if (p->msg.data_length) { |
Josh Gao | f571fcb | 2018-02-05 18:49:10 -0800 | [diff] [blame] | 130 | if (p->msg.data_length > MAX_PAYLOAD) { |
Josh Gao | 5caaebd | 2018-02-02 14:38:04 -0800 | [diff] [blame] | 131 | PLOG(ERROR) << "remote usb: read overflow (data length = " << p->msg.data_length << ")"; |
| 132 | return -1; |
| 133 | } |
| 134 | |
Josh Gao | f571fcb | 2018-02-05 18:49:10 -0800 | [diff] [blame] | 135 | p->payload.resize(p->msg.data_length); |
| 136 | if (usb_read(usb, &p->payload[0], p->payload.size())) { |
Josh Gao | 184f571 | 2017-07-26 11:06:55 -0700 | [diff] [blame] | 137 | PLOG(ERROR) << "remote usb: terminated (data)"; |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 138 | return -1; |
| 139 | } |
| 140 | } |
| 141 | |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 142 | return 0; |
| 143 | } |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 144 | #endif |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 145 | |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 146 | UsbConnection::~UsbConnection() { |
| 147 | usb_close(handle_); |
| 148 | } |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 149 | |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 150 | bool UsbConnection::Read(apacket* packet) { |
| 151 | int rc = remote_read(packet, handle_); |
| 152 | return rc == 0; |
| 153 | } |
| 154 | |
| 155 | bool UsbConnection::Write(apacket* packet) { |
| 156 | unsigned size = packet->msg.data_length; |
| 157 | |
| 158 | if (usb_write(handle_, &packet->msg, sizeof(packet->msg)) != 0) { |
Josh Gao | 184f571 | 2017-07-26 11:06:55 -0700 | [diff] [blame] | 159 | PLOG(ERROR) << "remote usb: 1 - write terminated"; |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 160 | return false; |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 161 | } |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 162 | |
Josh Gao | f571fcb | 2018-02-05 18:49:10 -0800 | [diff] [blame] | 163 | if (packet->msg.data_length != 0 && usb_write(handle_, packet->payload.data(), size) != 0) { |
Josh Gao | 184f571 | 2017-07-26 11:06:55 -0700 | [diff] [blame] | 164 | PLOG(ERROR) << "remote usb: 2 - write terminated"; |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 165 | return false; |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 166 | } |
| 167 | |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 168 | return true; |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 169 | } |
| 170 | |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 171 | void UsbConnection::Close() { |
| 172 | usb_kick(handle_); |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 173 | } |
| 174 | |
Yabin Cui | b5e1141 | 2017-03-10 16:01:01 -0800 | [diff] [blame] | 175 | void init_usb_transport(atransport* t, usb_handle* h) { |
Yabin Cui | 7a3f8d6 | 2015-09-02 17:44:28 -0700 | [diff] [blame] | 176 | D("transport: usb"); |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 177 | t->connection.reset(new UsbConnection(h)); |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 178 | t->sync_token = 1; |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 179 | t->type = kTransportUsb; |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 180 | } |
| 181 | |
Josh Gao | b800d88 | 2018-01-28 20:32:46 -0800 | [diff] [blame] | 182 | int is_adb_interface(int usb_class, int usb_subclass, int usb_protocol) { |
Elliott Hughes | 5566490 | 2014-11-19 22:07:34 -0800 | [diff] [blame] | 183 | return (usb_class == ADB_CLASS && usb_subclass == ADB_SUBCLASS && usb_protocol == ADB_PROTOCOL); |
The Android Open Source Project | dd7bc33 | 2009-03-03 19:32:55 -0800 | [diff] [blame] | 184 | } |
Josh Gao | 5d1756c | 2017-02-22 17:07:01 -0800 | [diff] [blame] | 185 | |
| 186 | bool should_use_libusb() { |
Josh Gao | 9425996 | 2017-12-08 13:05:40 -0800 | [diff] [blame] | 187 | #if !ADB_HOST |
Josh Gao | 5d1756c | 2017-02-22 17:07:01 -0800 | [diff] [blame] | 188 | return false; |
| 189 | #else |
Josh Gao | 969110c | 2017-06-26 12:16:30 -0700 | [diff] [blame] | 190 | static bool enable = getenv("ADB_LIBUSB") && strcmp(getenv("ADB_LIBUSB"), "1") == 0; |
| 191 | return enable; |
Josh Gao | 5d1756c | 2017-02-22 17:07:01 -0800 | [diff] [blame] | 192 | #endif |
| 193 | } |