Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 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 | |
Mike Lockwood | c4308f0 | 2011-03-01 08:04:54 -0800 | [diff] [blame] | 17 | package android.hardware.usb; |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 18 | |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 19 | import android.annotation.NonNull; |
| 20 | import android.annotation.Nullable; |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 21 | import android.app.ActivityThread; |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 22 | import android.os.Parcel; |
| 23 | import android.os.Parcelable; |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 24 | import android.os.RemoteException; |
| 25 | |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 26 | import com.android.internal.util.Preconditions; |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 27 | |
| 28 | /** |
Mike Lockwood | 11dd5ae | 2011-04-01 14:00:08 -0400 | [diff] [blame] | 29 | * A class representing a USB accessory, which is an external hardware component |
| 30 | * that communicates with an android application over USB. |
| 31 | * The accessory is the USB host and android the device side of the USB connection. |
| 32 | * |
| 33 | * <p>When the accessory connects, it reports its manufacturer and model names, |
| 34 | * the version of the accessory, and a user visible description of the accessory to the device. |
| 35 | * The manufacturer, model and version strings are used by the USB Manager to choose |
| 36 | * an appropriate application for the accessory. |
| 37 | * The accessory may optionally provide a unique serial number |
| 38 | * and a URL to for the accessory's website to the device as well. |
| 39 | * |
| 40 | * <p>An instance of this class is sent to the application via the |
| 41 | * {@link UsbManager#ACTION_USB_ACCESSORY_ATTACHED} Intent. |
| 42 | * The application can then call {@link UsbManager#openAccessory} to open a file descriptor |
| 43 | * for reading and writing data to and from the accessory. |
Joe Fernandez | 3aef8e1d | 2011-12-20 10:38:34 -0800 | [diff] [blame] | 44 | * |
| 45 | * <div class="special reference"> |
| 46 | * <h3>Developer Guides</h3> |
| 47 | * <p>For more information about communicating with USB hardware, read the |
| 48 | * <a href="{@docRoot}guide/topics/usb/index.html">USB</a> developer guide.</p> |
| 49 | * </div> |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 50 | */ |
Mike Lockwood | c4308f0 | 2011-03-01 08:04:54 -0800 | [diff] [blame] | 51 | public class UsbAccessory implements Parcelable { |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 52 | |
| 53 | private static final String TAG = "UsbAccessory"; |
| 54 | |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 55 | private final @NonNull String mManufacturer; |
| 56 | private final @NonNull String mModel; |
| 57 | private final @Nullable String mDescription; |
| 58 | private final @Nullable String mVersion; |
| 59 | private final @Nullable String mUri; |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 60 | private final @NonNull IUsbSerialReader mSerialNumberReader; |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 61 | |
Mike Lockwood | 166b05e | 2012-04-24 10:45:18 -0700 | [diff] [blame] | 62 | /** @hide */ |
| 63 | public static final int MANUFACTURER_STRING = 0; |
| 64 | /** @hide */ |
| 65 | public static final int MODEL_STRING = 1; |
| 66 | /** @hide */ |
| 67 | public static final int DESCRIPTION_STRING = 2; |
| 68 | /** @hide */ |
| 69 | public static final int VERSION_STRING = 3; |
| 70 | /** @hide */ |
| 71 | public static final int URI_STRING = 4; |
| 72 | /** @hide */ |
| 73 | public static final int SERIAL_STRING = 5; |
| 74 | |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 75 | /** |
| 76 | * UsbAccessory should only be instantiated by UsbService implementation |
| 77 | * @hide |
| 78 | */ |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 79 | public UsbAccessory(@NonNull String manufacturer, @NonNull String model, |
| 80 | @Nullable String description, @Nullable String version, @Nullable String uri, |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 81 | @NonNull IUsbSerialReader serialNumberReader) { |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 82 | mManufacturer = Preconditions.checkNotNull(manufacturer); |
| 83 | mModel = Preconditions.checkNotNull(model); |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 84 | mDescription = description; |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 85 | mVersion = version; |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 86 | mUri = uri; |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 87 | mSerialNumberReader = serialNumberReader; |
| 88 | |
| 89 | // Make sure the binder belongs to the system |
| 90 | if (ActivityThread.isSystem()) { |
| 91 | Preconditions.checkArgument(mSerialNumberReader instanceof IUsbSerialReader.Stub); |
| 92 | } |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | /** |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 96 | * DO NOT USE. Only for backwards compatibility with |
| 97 | * {@link com.android.future.usb.UsbAccessory}. |
| 98 | * |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 99 | * @hide |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 100 | * @deprecated use {@link UsbAccessory#UsbAccessory(String, String, String, String, String, |
| 101 | * IUsbSerialReader) instead} |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 102 | */ |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 103 | @Deprecated |
| 104 | public UsbAccessory(@NonNull String manufacturer, @NonNull String model, |
| 105 | @Nullable String description, @Nullable String version, @Nullable String uri, |
| 106 | @Nullable String serialNumber) { |
| 107 | this(manufacturer, model, description, version, uri, new IUsbSerialReader.Stub() { |
| 108 | @Override |
| 109 | public String getSerial(String packageName) { |
| 110 | return serialNumber; |
| 111 | } |
| 112 | }); |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 113 | } |
| 114 | |
| 115 | /** |
Mike Lockwood | 11dd5ae | 2011-04-01 14:00:08 -0400 | [diff] [blame] | 116 | * Returns the manufacturer name of the accessory. |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 117 | * |
| 118 | * @return the accessory manufacturer |
| 119 | */ |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 120 | public @NonNull String getManufacturer() { |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 121 | return mManufacturer; |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Returns the model name of the accessory. |
| 126 | * |
| 127 | * @return the accessory model |
| 128 | */ |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 129 | public @NonNull String getModel() { |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 130 | return mModel; |
| 131 | } |
| 132 | |
| 133 | /** |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 134 | * Returns a user visible description of the accessory. |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 135 | * |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 136 | * @return the accessory description, or {@code null} if not set |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 137 | */ |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 138 | public @Nullable String getDescription() { |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 139 | return mDescription; |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Returns the version of the accessory. |
| 144 | * |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 145 | * @return the accessory version, or {@code null} if not set |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 146 | */ |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 147 | public @Nullable String getVersion() { |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 148 | return mVersion; |
| 149 | } |
| 150 | |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 151 | /** |
| 152 | * Returns the URI for the accessory. |
| 153 | * This is an optional URI that might show information about the accessory |
| 154 | * or provide the option to download an application for the accessory |
| 155 | * |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 156 | * @return the accessory URI, or {@code null} if not set |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 157 | */ |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 158 | public @Nullable String getUri() { |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 159 | return mUri; |
| 160 | } |
| 161 | |
Mike Lockwood | 015b1ec | 2011-03-14 18:24:35 -0400 | [diff] [blame] | 162 | /** |
| 163 | * Returns the unique serial number for the accessory. |
| 164 | * This is an optional serial number that can be used to differentiate |
| 165 | * between individual accessories of the same model and manufacturer |
| 166 | * |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 167 | * @return the unique serial number, or {@code null} if not set |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 168 | * |
| 169 | * @throws SecurityException if the app targets SDK >= {@value android.os.Build.VERSION_CODES#Q} |
| 170 | * and the app does not have permission to read from the accessory. |
Mike Lockwood | 015b1ec | 2011-03-14 18:24:35 -0400 | [diff] [blame] | 171 | */ |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 172 | public @Nullable String getSerial() { |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 173 | try { |
| 174 | return mSerialNumberReader.getSerial(ActivityThread.currentPackageName()); |
| 175 | } catch (RemoteException e) { |
| 176 | e.rethrowFromSystemServer(); |
| 177 | return null; |
| 178 | } |
Mike Lockwood | 015b1ec | 2011-03-14 18:24:35 -0400 | [diff] [blame] | 179 | } |
| 180 | |
Mike Lockwood | 02eb874 | 2011-02-27 09:10:37 -0800 | [diff] [blame] | 181 | private static boolean compare(String s1, String s2) { |
| 182 | if (s1 == null) return (s2 == null); |
| 183 | return s1.equals(s2); |
| 184 | } |
| 185 | |
| 186 | @Override |
| 187 | public boolean equals(Object obj) { |
| 188 | if (obj instanceof UsbAccessory) { |
| 189 | UsbAccessory accessory = (UsbAccessory)obj; |
| 190 | return (compare(mManufacturer, accessory.getManufacturer()) && |
| 191 | compare(mModel, accessory.getModel()) && |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 192 | compare(mDescription, accessory.getDescription()) && |
| 193 | compare(mVersion, accessory.getVersion()) && |
Mike Lockwood | 015b1ec | 2011-03-14 18:24:35 -0400 | [diff] [blame] | 194 | compare(mUri, accessory.getUri()) && |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 195 | compare(getSerial(), accessory.getSerial())); |
Mike Lockwood | 02eb874 | 2011-02-27 09:10:37 -0800 | [diff] [blame] | 196 | } |
| 197 | return false; |
| 198 | } |
| 199 | |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 200 | @Override |
Mike Lockwood | c6f23e8 | 2011-03-09 12:05:20 -0500 | [diff] [blame] | 201 | public int hashCode() { |
Philip P. Moltmann | f2d83ed | 2016-10-17 12:14:41 -0700 | [diff] [blame] | 202 | return mManufacturer.hashCode() ^ mModel.hashCode() ^ |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 203 | (mDescription == null ? 0 : mDescription.hashCode()) ^ |
| 204 | (mVersion == null ? 0 : mVersion.hashCode()) ^ |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 205 | (mUri == null ? 0 : mUri.hashCode()); |
Mike Lockwood | c6f23e8 | 2011-03-09 12:05:20 -0500 | [diff] [blame] | 206 | } |
| 207 | |
| 208 | @Override |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 209 | public String toString() { |
| 210 | return "UsbAccessory[mManufacturer=" + mManufacturer + |
| 211 | ", mModel=" + mModel + |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 212 | ", mDescription=" + mDescription + |
| 213 | ", mVersion=" + mVersion + |
Mike Lockwood | 015b1ec | 2011-03-14 18:24:35 -0400 | [diff] [blame] | 214 | ", mUri=" + mUri + |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 215 | ", mSerialNumberReader=" + mSerialNumberReader + "]"; |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 216 | } |
| 217 | |
| 218 | public static final Parcelable.Creator<UsbAccessory> CREATOR = |
| 219 | new Parcelable.Creator<UsbAccessory>() { |
| 220 | public UsbAccessory createFromParcel(Parcel in) { |
| 221 | String manufacturer = in.readString(); |
| 222 | String model = in.readString(); |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 223 | String description = in.readString(); |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 224 | String version = in.readString(); |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 225 | String uri = in.readString(); |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 226 | IUsbSerialReader serialNumberReader = IUsbSerialReader.Stub.asInterface( |
| 227 | in.readStrongBinder()); |
| 228 | |
| 229 | return new UsbAccessory(manufacturer, model, description, version, uri, |
| 230 | serialNumberReader); |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 231 | } |
| 232 | |
| 233 | public UsbAccessory[] newArray(int size) { |
| 234 | return new UsbAccessory[size]; |
| 235 | } |
| 236 | }; |
| 237 | |
| 238 | public int describeContents() { |
| 239 | return 0; |
| 240 | } |
| 241 | |
| 242 | public void writeToParcel(Parcel parcel, int flags) { |
| 243 | parcel.writeString(mManufacturer); |
| 244 | parcel.writeString(mModel); |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 245 | parcel.writeString(mDescription); |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 246 | parcel.writeString(mVersion); |
Mike Lockwood | ac36d7c | 2011-03-09 22:03:57 -0500 | [diff] [blame] | 247 | parcel.writeString(mUri); |
Philip P. Moltmann | a2c6eea | 2018-08-24 09:50:40 -0700 | [diff] [blame] | 248 | parcel.writeStrongBinder(mSerialNumberReader.asBinder()); |
Mike Lockwood | 9182d3c | 2011-02-15 09:50:22 -0500 | [diff] [blame] | 249 | } |
| 250 | } |