| /* |
| * Copyright (C) 2010 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| |
| package android.hardware.usb; |
| |
| import com.android.internal.util.Preconditions; |
| |
| import android.app.PendingIntent; |
| import android.content.Context; |
| import android.os.Bundle; |
| import android.os.ParcelFileDescriptor; |
| import android.os.RemoteException; |
| import android.util.Log; |
| |
| import java.util.HashMap; |
| |
| /** |
| * This class allows you to access the state of USB and communicate with USB devices. |
| * Currently only host mode is supported in the public API. |
| * |
| * <p>You can obtain an instance of this class by calling |
| * {@link android.content.Context#getSystemService(java.lang.String) Context.getSystemService()}. |
| * |
| * {@samplecode |
| * UsbManager manager = (UsbManager) getSystemService(Context.USB_SERVICE);} |
| * |
| * <div class="special reference"> |
| * <h3>Developer Guides</h3> |
| * <p>For more information about communicating with USB hardware, read the |
| * <a href="{@docRoot}guide/topics/usb/index.html">USB</a> developer guide.</p> |
| * </div> |
| */ |
| public class UsbManager { |
| private static final String TAG = "UsbManager"; |
| |
| /** |
| * Broadcast Action: A sticky broadcast for USB state change events when in device mode. |
| * |
| * This is a sticky broadcast for clients that includes USB connected/disconnected state, |
| * <ul> |
| * <li> {@link #USB_CONNECTED} boolean indicating whether USB is connected or disconnected. |
| * <li> {@link #USB_CONFIGURED} boolean indicating whether USB is configured. |
| * currently zero if not configured, one for configured. |
| * <li> {@link #USB_FUNCTION_ADB} boolean extra indicating whether the |
| * adb function is enabled |
| * <li> {@link #USB_FUNCTION_RNDIS} boolean extra indicating whether the |
| * RNDIS ethernet function is enabled |
| * <li> {@link #USB_FUNCTION_MTP} boolean extra indicating whether the |
| * MTP function is enabled |
| * <li> {@link #USB_FUNCTION_PTP} boolean extra indicating whether the |
| * PTP function is enabled |
| * <li> {@link #USB_FUNCTION_PTP} boolean extra indicating whether the |
| * accessory function is enabled |
| * <li> {@link #USB_FUNCTION_AUDIO_SOURCE} boolean extra indicating whether the |
| * audio source function is enabled |
| * <li> {@link #USB_FUNCTION_MIDI} boolean extra indicating whether the |
| * MIDI function is enabled |
| * </ul> |
| * |
| * {@hide} |
| */ |
| public static final String ACTION_USB_STATE = |
| "android.hardware.usb.action.USB_STATE"; |
| |
| /** |
| * Broadcast Action: A broadcast for USB port changes. |
| * |
| * This intent is sent when a USB port is added, removed, or changes state. |
| * <ul> |
| * <li> {@link #EXTRA_PORT} containing the {@link android.hardware.usb.UsbPort} |
| * for the port. |
| * <li> {@link #EXTRA_PORT_STATUS} containing the {@link android.hardware.usb.UsbPortStatus} |
| * for the port, or null if the port has been removed |
| * </ul> |
| * |
| * @hide |
| */ |
| public static final String ACTION_USB_PORT_CHANGED = |
| "android.hardware.usb.action.USB_PORT_CHANGED"; |
| |
| /** |
| * Broadcast Action: A broadcast for USB device attached event. |
| * |
| * This intent is sent when a USB device is attached to the USB bus when in host mode. |
| * <ul> |
| * <li> {@link #EXTRA_DEVICE} containing the {@link android.hardware.usb.UsbDevice} |
| * for the attached device |
| * </ul> |
| */ |
| public static final String ACTION_USB_DEVICE_ATTACHED = |
| "android.hardware.usb.action.USB_DEVICE_ATTACHED"; |
| |
| /** |
| * Broadcast Action: A broadcast for USB device detached event. |
| * |
| * This intent is sent when a USB device is detached from the USB bus when in host mode. |
| * <ul> |
| * <li> {@link #EXTRA_DEVICE} containing the {@link android.hardware.usb.UsbDevice} |
| * for the detached device |
| * </ul> |
| */ |
| public static final String ACTION_USB_DEVICE_DETACHED = |
| "android.hardware.usb.action.USB_DEVICE_DETACHED"; |
| |
| /** |
| * Broadcast Action: A broadcast for USB accessory attached event. |
| * |
| * This intent is sent when a USB accessory is attached. |
| * <ul> |
| * <li> {@link #EXTRA_ACCESSORY} containing the {@link android.hardware.usb.UsbAccessory} |
| * for the attached accessory |
| * </ul> |
| */ |
| public static final String ACTION_USB_ACCESSORY_ATTACHED = |
| "android.hardware.usb.action.USB_ACCESSORY_ATTACHED"; |
| |
| /** |
| * Broadcast Action: A broadcast for USB accessory detached event. |
| * |
| * This intent is sent when a USB accessory is detached. |
| * <ul> |
| * <li> {@link #EXTRA_ACCESSORY} containing the {@link UsbAccessory} |
| * for the attached accessory that was detached |
| * </ul> |
| */ |
| public static final String ACTION_USB_ACCESSORY_DETACHED = |
| "android.hardware.usb.action.USB_ACCESSORY_DETACHED"; |
| |
| /** |
| * Boolean extra indicating whether USB is connected or disconnected. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast. |
| * |
| * {@hide} |
| */ |
| public static final String USB_CONNECTED = "connected"; |
| |
| /** |
| * Boolean extra indicating whether USB is configured. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast. |
| * |
| * {@hide} |
| */ |
| public static final String USB_CONFIGURED = "configured"; |
| |
| /** |
| * Boolean extra indicating whether confidential user data, such as photos, should be |
| * made available on the USB connection. This variable will only be set when the user |
| * has explicitly asked for this data to be unlocked. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast. |
| * |
| * {@hide} |
| */ |
| public static final String USB_DATA_UNLOCKED = "unlocked"; |
| |
| /** |
| * A placeholder indicating that no USB function is being specified. |
| * Used to distinguish between selecting no function vs. the default function in |
| * {@link #setCurrentFunction(String)}. |
| * |
| * {@hide} |
| */ |
| public static final String USB_FUNCTION_NONE = "none"; |
| |
| /** |
| * Name of the adb USB function. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast |
| * |
| * {@hide} |
| */ |
| public static final String USB_FUNCTION_ADB = "adb"; |
| |
| /** |
| * Name of the RNDIS ethernet USB function. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast |
| * |
| * {@hide} |
| */ |
| public static final String USB_FUNCTION_RNDIS = "rndis"; |
| |
| /** |
| * Name of the MTP USB function. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast |
| * |
| * {@hide} |
| */ |
| public static final String USB_FUNCTION_MTP = "mtp"; |
| |
| /** |
| * Name of the PTP USB function. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast |
| * |
| * {@hide} |
| */ |
| public static final String USB_FUNCTION_PTP = "ptp"; |
| |
| /** |
| * Name of the audio source USB function. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast |
| * |
| * {@hide} |
| */ |
| public static final String USB_FUNCTION_AUDIO_SOURCE = "audio_source"; |
| |
| /** |
| * Name of the MIDI USB function. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast |
| * |
| * {@hide} |
| */ |
| public static final String USB_FUNCTION_MIDI = "midi"; |
| |
| /** |
| * Name of the Accessory USB function. |
| * Used in extras for the {@link #ACTION_USB_STATE} broadcast |
| * |
| * {@hide} |
| */ |
| public static final String USB_FUNCTION_ACCESSORY = "accessory"; |
| |
| /** |
| * Name of extra for {@link #ACTION_USB_PORT_CHANGED} |
| * containing the {@link UsbPort} object for the port. |
| * |
| * @hide |
| */ |
| public static final String EXTRA_PORT = "port"; |
| |
| /** |
| * Name of extra for {@link #ACTION_USB_PORT_CHANGED} |
| * containing the {@link UsbPortStatus} object for the port, or null if the port |
| * was removed. |
| * |
| * @hide |
| */ |
| public static final String EXTRA_PORT_STATUS = "portStatus"; |
| |
| /** |
| * Name of extra for {@link #ACTION_USB_DEVICE_ATTACHED} and |
| * {@link #ACTION_USB_DEVICE_DETACHED} broadcasts |
| * containing the {@link UsbDevice} object for the device. |
| */ |
| public static final String EXTRA_DEVICE = "device"; |
| |
| /** |
| * Name of extra for {@link #ACTION_USB_ACCESSORY_ATTACHED} and |
| * {@link #ACTION_USB_ACCESSORY_DETACHED} broadcasts |
| * containing the {@link UsbAccessory} object for the accessory. |
| */ |
| public static final String EXTRA_ACCESSORY = "accessory"; |
| |
| /** |
| * Name of extra added to the {@link android.app.PendingIntent} |
| * passed into {@link #requestPermission(UsbDevice, PendingIntent)} |
| * or {@link #requestPermission(UsbAccessory, PendingIntent)} |
| * containing a boolean value indicating whether the user granted permission or not. |
| */ |
| public static final String EXTRA_PERMISSION_GRANTED = "permission"; |
| |
| private final Context mContext; |
| private final IUsbManager mService; |
| |
| /** |
| * {@hide} |
| */ |
| public UsbManager(Context context, IUsbManager service) { |
| mContext = context; |
| mService = service; |
| } |
| |
| /** |
| * Returns a HashMap containing all USB devices currently attached. |
| * USB device name is the key for the returned HashMap. |
| * The result will be empty if no devices are attached, or if |
| * USB host mode is inactive or unsupported. |
| * |
| * @return HashMap containing all connected USB devices. |
| */ |
| public HashMap<String,UsbDevice> getDeviceList() { |
| Bundle bundle = new Bundle(); |
| try { |
| mService.getDeviceList(bundle); |
| HashMap<String,UsbDevice> result = new HashMap<String,UsbDevice>(); |
| for (String name : bundle.keySet()) { |
| result.put(name, (UsbDevice)bundle.get(name)); |
| } |
| return result; |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in getDeviceList", e); |
| return null; |
| } |
| } |
| |
| /** |
| * Opens the device so it can be used to send and receive |
| * data using {@link android.hardware.usb.UsbRequest}. |
| * |
| * @param device the device to open |
| * @return a {@link UsbDeviceConnection}, or {@code null} if open failed |
| */ |
| public UsbDeviceConnection openDevice(UsbDevice device) { |
| try { |
| String deviceName = device.getDeviceName(); |
| ParcelFileDescriptor pfd = mService.openDevice(deviceName); |
| if (pfd != null) { |
| UsbDeviceConnection connection = new UsbDeviceConnection(device); |
| boolean result = connection.open(deviceName, pfd); |
| pfd.close(); |
| if (result) { |
| return connection; |
| } |
| } |
| } catch (Exception e) { |
| Log.e(TAG, "exception in UsbManager.openDevice", e); |
| } |
| return null; |
| } |
| |
| /** |
| * Returns a list of currently attached USB accessories. |
| * (in the current implementation there can be at most one) |
| * |
| * @return list of USB accessories, or null if none are attached. |
| */ |
| public UsbAccessory[] getAccessoryList() { |
| try { |
| UsbAccessory accessory = mService.getCurrentAccessory(); |
| if (accessory == null) { |
| return null; |
| } else { |
| return new UsbAccessory[] { accessory }; |
| } |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in getAccessoryList", e); |
| return null; |
| } |
| } |
| |
| /** |
| * Opens a file descriptor for reading and writing data to the USB accessory. |
| * |
| * @param accessory the USB accessory to open |
| * @return file descriptor, or null if the accessor could not be opened. |
| */ |
| public ParcelFileDescriptor openAccessory(UsbAccessory accessory) { |
| try { |
| return mService.openAccessory(accessory); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in openAccessory", e); |
| return null; |
| } |
| } |
| |
| /** |
| * Returns true if the caller has permission to access the device. |
| * Permission might have been granted temporarily via |
| * {@link #requestPermission(UsbDevice, PendingIntent)} or |
| * by the user choosing the caller as the default application for the device. |
| * |
| * @param device to check permissions for |
| * @return true if caller has permission |
| */ |
| public boolean hasPermission(UsbDevice device) { |
| try { |
| return mService.hasDevicePermission(device); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in hasPermission", e); |
| return false; |
| } |
| } |
| |
| /** |
| * Returns true if the caller has permission to access the accessory. |
| * Permission might have been granted temporarily via |
| * {@link #requestPermission(UsbAccessory, PendingIntent)} or |
| * by the user choosing the caller as the default application for the accessory. |
| * |
| * @param accessory to check permissions for |
| * @return true if caller has permission |
| */ |
| public boolean hasPermission(UsbAccessory accessory) { |
| try { |
| return mService.hasAccessoryPermission(accessory); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in hasPermission", e); |
| return false; |
| } |
| } |
| |
| /** |
| * Requests temporary permission for the given package to access the device. |
| * This may result in a system dialog being displayed to the user |
| * if permission had not already been granted. |
| * Success or failure is returned via the {@link android.app.PendingIntent} pi. |
| * If successful, this grants the caller permission to access the device only |
| * until the device is disconnected. |
| * |
| * The following extras will be added to pi: |
| * <ul> |
| * <li> {@link #EXTRA_DEVICE} containing the device passed into this call |
| * <li> {@link #EXTRA_PERMISSION_GRANTED} containing boolean indicating whether |
| * permission was granted by the user |
| * </ul> |
| * |
| * @param device to request permissions for |
| * @param pi PendingIntent for returning result |
| */ |
| public void requestPermission(UsbDevice device, PendingIntent pi) { |
| try { |
| mService.requestDevicePermission(device, mContext.getPackageName(), pi); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in requestPermission", e); |
| } |
| } |
| |
| /** |
| * Requests temporary permission for the given package to access the accessory. |
| * This may result in a system dialog being displayed to the user |
| * if permission had not already been granted. |
| * Success or failure is returned via the {@link android.app.PendingIntent} pi. |
| * If successful, this grants the caller permission to access the accessory only |
| * until the device is disconnected. |
| * |
| * The following extras will be added to pi: |
| * <ul> |
| * <li> {@link #EXTRA_ACCESSORY} containing the accessory passed into this call |
| * <li> {@link #EXTRA_PERMISSION_GRANTED} containing boolean indicating whether |
| * permission was granted by the user |
| * </ul> |
| * |
| * @param accessory to request permissions for |
| * @param pi PendingIntent for returning result |
| */ |
| public void requestPermission(UsbAccessory accessory, PendingIntent pi) { |
| try { |
| mService.requestAccessoryPermission(accessory, mContext.getPackageName(), pi); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in requestPermission", e); |
| } |
| } |
| |
| /** |
| * Returns true if the specified USB function is currently enabled when in device mode. |
| * <p> |
| * USB functions represent interfaces which are published to the host to access |
| * services offered by the device. |
| * </p> |
| * |
| * @param function name of the USB function |
| * @return true if the USB function is enabled |
| * |
| * {@hide} |
| */ |
| public boolean isFunctionEnabled(String function) { |
| try { |
| return mService.isFunctionEnabled(function); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in setCurrentFunction", e); |
| return false; |
| } |
| } |
| |
| /** |
| * Sets the current USB function when in device mode. |
| * <p> |
| * USB functions represent interfaces which are published to the host to access |
| * services offered by the device. |
| * </p><p> |
| * This method is intended to select among primary USB functions. The system may |
| * automatically activate additional functions such as {@link #USB_FUNCTION_ADB} |
| * or {@link #USB_FUNCTION_ACCESSORY} based on other settings and states. |
| * </p><p> |
| * The allowed values are: {@link #USB_FUNCTION_NONE}, {@link #USB_FUNCTION_AUDIO_SOURCE}, |
| * {@link #USB_FUNCTION_MIDI}, {@link #USB_FUNCTION_MTP}, {@link #USB_FUNCTION_PTP}, |
| * or {@link #USB_FUNCTION_RNDIS}. |
| * </p><p> |
| * Note: This function is asynchronous and may fail silently without applying |
| * the requested changes. |
| * </p> |
| * |
| * @param function name of the USB function, or null to restore the default function |
| * |
| * {@hide} |
| */ |
| public void setCurrentFunction(String function) { |
| try { |
| mService.setCurrentFunction(function); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in setCurrentFunction", e); |
| } |
| } |
| |
| /** |
| * Sets whether USB data (for example, MTP exposed pictures) should be made available |
| * on the USB connection when in device mode. Unlocking usb data should only be done with |
| * user involvement, since exposing pictures or other data could leak sensitive |
| * user information. |
| * |
| * {@hide} |
| */ |
| public void setUsbDataUnlocked(boolean unlocked) { |
| try { |
| mService.setUsbDataUnlocked(unlocked); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in setUsbDataUnlocked", e); |
| } |
| } |
| |
| /** |
| * Returns a list of physical USB ports on the device. |
| * <p> |
| * This list is guaranteed to contain all dual-role USB Type C ports but it might |
| * be missing other ports depending on whether the kernel USB drivers have been |
| * updated to publish all of the device's ports through the new "dual_role_usb" |
| * device class (which supports all types of ports despite its name). |
| * </p> |
| * |
| * @return The list of USB ports, or null if none. |
| * |
| * @hide |
| */ |
| public UsbPort[] getPorts() { |
| try { |
| return mService.getPorts(); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in getPorts", e); |
| } |
| return null; |
| } |
| |
| /** |
| * Gets the status of the specified USB port. |
| * |
| * @param port The port to query. |
| * @return The status of the specified USB port, or null if unknown. |
| * |
| * @hide |
| */ |
| public UsbPortStatus getPortStatus(UsbPort port) { |
| Preconditions.checkNotNull(port, "port must not be null"); |
| |
| try { |
| return mService.getPortStatus(port.getId()); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in getPortStatus", e); |
| } |
| return null; |
| } |
| |
| /** |
| * Sets the desired role combination of the port. |
| * <p> |
| * The supported role combinations depend on what is connected to the port and may be |
| * determined by consulting |
| * {@link UsbPortStatus#isRoleCombinationSupported UsbPortStatus.isRoleCombinationSupported}. |
| * </p><p> |
| * Note: This function is asynchronous and may fail silently without applying |
| * the requested changes. If this function does cause a status change to occur then |
| * a {@link #ACTION_USB_PORT_CHANGED} broadcast will be sent. |
| * </p> |
| * |
| * @param powerRole The desired power role: {@link UsbPort#POWER_ROLE_SOURCE} |
| * or {@link UsbPort#POWER_ROLE_SINK}, or 0 if no power role. |
| * @param dataRole The desired data role: {@link UsbPort#DATA_ROLE_HOST} |
| * or {@link UsbPort#DATA_ROLE_DEVICE}, or 0 if no data role. |
| * |
| * @hide |
| */ |
| public void setPortRoles(UsbPort port, int powerRole, int dataRole) { |
| Preconditions.checkNotNull(port, "port must not be null"); |
| UsbPort.checkRoles(powerRole, dataRole); |
| |
| try { |
| mService.setPortRoles(port.getId(), powerRole, dataRole); |
| } catch (RemoteException e) { |
| Log.e(TAG, "RemoteException in setPortRole", e); |
| } |
| } |
| |
| /** @hide */ |
| public static String addFunction(String functions, String function) { |
| if ("none".equals(functions)) { |
| return function; |
| } |
| if (!containsFunction(functions, function)) { |
| if (functions.length() > 0) { |
| functions += ","; |
| } |
| functions += function; |
| } |
| return functions; |
| } |
| |
| /** @hide */ |
| public static String removeFunction(String functions, String function) { |
| String[] split = functions.split(","); |
| for (int i = 0; i < split.length; i++) { |
| if (function.equals(split[i])) { |
| split[i] = null; |
| } |
| } |
| if (split.length == 1 && split[0] == null) { |
| return "none"; |
| } |
| StringBuilder builder = new StringBuilder(); |
| for (int i = 0; i < split.length; i++) { |
| String s = split[i]; |
| if (s != null) { |
| if (builder.length() > 0) { |
| builder.append(","); |
| } |
| builder.append(s); |
| } |
| } |
| return builder.toString(); |
| } |
| |
| /** @hide */ |
| public static boolean containsFunction(String functions, String function) { |
| int index = functions.indexOf(function); |
| if (index < 0) return false; |
| if (index > 0 && functions.charAt(index - 1) != ',') return false; |
| int charAfter = index + function.length(); |
| if (charAfter < functions.length() && functions.charAt(charAfter) != ',') return false; |
| return true; |
| } |
| } |
