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