1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
|
/*
* 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 static android.hardware.usb.UsbPortStatus.DATA_STATUS_DISABLED_FORCE;
import android.Manifest;
import android.annotation.IntDef;
import android.annotation.LongDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresFeature;
import android.annotation.RequiresPermission;
import android.annotation.SdkConstant;
import android.annotation.SdkConstant.SdkConstantType;
import android.annotation.SystemApi;
import android.annotation.SystemService;
import android.app.PendingIntent;
import android.compat.annotation.UnsupportedAppUsage;
import android.content.ComponentName;
import android.content.Context;
import android.content.pm.PackageManager;
import android.content.pm.PackageManager.NameNotFoundException;
import android.hardware.usb.gadget.V1_0.GadgetFunction;
import android.hardware.usb.gadget.V1_2.UsbSpeed;
import android.os.Binder;
import android.os.Build;
import android.os.Bundle;
import android.os.ParcelFileDescriptor;
import android.os.Process;
import android.os.RemoteException;
import android.util.Log;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.StringJoiner;
import java.util.concurrent.atomic.AtomicInteger;
/**
* 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.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about communicating with USB hardware, read the
* <a href="{@docRoot}guide/topics/connectivity/usb/index.html">USB developer guide</a>.</p>
* </div>
*/
@SystemService(Context.USB_SERVICE)
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_HOST_CONNECTED} boolean indicating whether USB is connected or
* disconnected as host.
* <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_ACCESSORY} 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>
* If the sticky intent has not been found, that indicates USB is disconnected,
* USB is not configued, MTP function is enabled, and all the other functions are disabled.
*
* @hide
*/
@SystemApi
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.
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_USB)
public static final String ACTION_USB_PORT_CHANGED =
"android.hardware.usb.action.USB_PORT_CHANGED";
/**
* Activity intent sent when user attaches a USB device.
*
* 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>
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
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>
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_USB_DEVICE_DETACHED =
"android.hardware.usb.action.USB_DEVICE_DETACHED";
/**
* Activity intent sent when user attaches a USB accessory.
*
* <ul>
* <li> {@link #EXTRA_ACCESSORY} containing the {@link android.hardware.usb.UsbAccessory}
* for the attached accessory
* </ul>
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
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>
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_USB_ACCESSORY_DETACHED =
"android.hardware.usb.action.USB_ACCESSORY_DETACHED";
/**
* Broadcast Action: A broadcast for USB accessory handshaking information delivery
*
* This intent is sent when a USB accessory connect attempt
*
* <p>For more information about communicating with USB accessory handshake, refer to
* <a href="https://source.android.com/devices/accessories/aoa">AOA</a> developer guide.</p>
*
* @hide
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_USB)
public static final String ACTION_USB_ACCESSORY_HANDSHAKE =
"android.hardware.usb.action.USB_ACCESSORY_HANDSHAKE";
/**
* Boolean extra indicating whether USB is connected or disconnected.
* Used in extras for the {@link #ACTION_USB_STATE} broadcast.
*
* @hide
*/
@SystemApi
public static final String USB_CONNECTED = "connected";
/**
* Boolean extra indicating whether USB is connected or disconnected as host.
* Used in extras for the {@link #ACTION_USB_STATE} broadcast.
*
* @hide
*/
public static final String USB_HOST_CONNECTED = "host_connected";
/**
* Boolean extra indicating whether USB is configured.
* Used in extras for the {@link #ACTION_USB_STATE} broadcast.
*
* @hide
*/
@SystemApi
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
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public static final String USB_DATA_UNLOCKED = "unlocked";
/**
* A placeholder indicating that no USB function is being specified.
* Used for compatibility with old init scripts to indicate no functions vs. charging function.
*
* @hide
*/
@UnsupportedAppUsage
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
*/
@SystemApi
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 the NCM USB function.
* Used in extras for the {@link #ACTION_USB_STATE} broadcast
*
* @hide
*/
@SystemApi
public static final String USB_FUNCTION_NCM = "ncm";
/**
* Name of Gadget Hal Not Present;
*
* @hide
*/
public static final String GADGET_HAL_UNKNOWN = "unknown";
/**
* Name of the USB Gadget Hal Version v1.0;
*
* @hide
*/
public static final String GADGET_HAL_VERSION_1_0 = "V1_0";
/**
* Name of the USB Gadget Hal Version v1.1;
*
* @hide
*/
public static final String GADGET_HAL_VERSION_1_1 = "V1_1";
/**
* Name of the USB Gadget Hal Version v1.2;
*
* @hide
*/
public static final String GADGET_HAL_VERSION_1_2 = "V1_2";
/**
* Name of the USB Gadget Hal Version v2.0;
*
* @hide
*/
public static final String GADGET_HAL_VERSION_2_0 = "V2_0";
/**
* 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";
/**
* A long extra indicating ms from boot to get get_protocol UEvent
* This is obtained with SystemClock.elapsedRealtime()
* Used in extras for {@link #ACTION_USB_ACCESSORY_HANDSHAKE} broadcasts.
*
* @hide
*/
@SystemApi
public static final String EXTRA_ACCESSORY_UEVENT_TIME =
"android.hardware.usb.extra.ACCESSORY_UEVENT_TIME";
/**
* An integer extra indicating numbers of send string during handshake
* Used in extras for {@link #ACTION_USB_ACCESSORY_HANDSHAKE} broadcasts
*
* <p>For more information about control request with identifying string information
* between communicating with USB accessory handshake, refer to
* <a href="https://source.android.com/devices/accessories/aoa">AOA</a> developer guide.</p>
*
* @hide
*/
@SystemApi
public static final String EXTRA_ACCESSORY_STRING_COUNT =
"android.hardware.usb.extra.ACCESSORY_STRING_COUNT";
/**
* Boolean extra indicating whether got start accessory or not
* Used in extras for {@link #ACTION_USB_ACCESSORY_HANDSHAKE} broadcasts.
*
* @hide
*/
@SystemApi
public static final String EXTRA_ACCESSORY_START =
"android.hardware.usb.extra.ACCESSORY_START";
/**
* A long extra indicating the timestamp just before
* sending {@link #ACTION_USB_ACCESSORY_HANDSHAKE}.
* Used in extras for {@link #ACTION_USB_ACCESSORY_HANDSHAKE} broadcasts.
*
* @hide
*/
@SystemApi
public static final String EXTRA_ACCESSORY_HANDSHAKE_END =
"android.hardware.usb.extra.ACCESSORY_HANDSHAKE_END";
/**
* 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";
/**
* Name of extra added to start systemui.usb.UsbPermissionActivity
* containing package name of the app which requests USB permission.
*
* @hide
*/
public static final String EXTRA_PACKAGE = "android.hardware.usb.extra.PACKAGE";
/**
* Name of extra added to start systemui.usb.UsbPermissionActivity
* containing the whether the app which requests USB permission can be set as default handler
* for USB device attach event or USB accessory attach event or not.
*
* @hide
*/
public static final String EXTRA_CAN_BE_DEFAULT = "android.hardware.usb.extra.CAN_BE_DEFAULT";
/**
* The Value for USB gadget hal is not presented.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int GADGET_HAL_NOT_SUPPORTED = -1;
/**
* Value for Gadget Hal Version v1.0.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int GADGET_HAL_V1_0 = 10;
/**
* Value for Gadget Hal Version v1.1.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int GADGET_HAL_V1_1 = 11;
/**
* Value for Gadget Hal Version v1.2.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int GADGET_HAL_V1_2 = 12;
/**
* Value for Gadget Hal Version v2.0.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int GADGET_HAL_V2_0 = 20;
/**
* Value for USB_STATE is not configured.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_DATA_TRANSFER_RATE_UNKNOWN = -1;
/**
* Value for USB Transfer Rate of Low Speed in Mbps (real value is 1.5Mbps).
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_DATA_TRANSFER_RATE_LOW_SPEED = 2;
/**
* Value for USB Transfer Rate of Full Speed in Mbps.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_DATA_TRANSFER_RATE_FULL_SPEED = 12;
/**
* Value for USB Transfer Rate of High Speed in Mbps.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_DATA_TRANSFER_RATE_HIGH_SPEED = 480;
/**
* Value for USB Transfer Rate of Super Speed in Mbps.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_DATA_TRANSFER_RATE_5G = 5 * 1024;
/**
* Value for USB Transfer Rate of 10G.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_DATA_TRANSFER_RATE_10G = 10 * 1024;
/**
* Value for USB Transfer Rate of 20G.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_DATA_TRANSFER_RATE_20G = 20 * 1024;
/**
* Value for USB Transfer Rate of 40G.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_DATA_TRANSFER_RATE_40G = 40 * 1024;
/**
* Returned when the client has to retry querying the version.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_HAL_RETRY = -2;
/**
* The Value for USB hal is not presented.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_HAL_NOT_SUPPORTED = -1;
/**
* Value for USB Hal Version v1.0.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_HAL_V1_0 = 10;
/**
* Value for USB Hal Version v1.1.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_HAL_V1_1 = 11;
/**
* Value for USB Hal Version v1.2.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_HAL_V1_2 = 12;
/**
* Value for USB Hal Version v1.3.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_HAL_V1_3 = 13;
/**
* Value for USB Hal Version v2.0.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public static final int USB_HAL_V2_0 = 20;
/**
* Code for the charging usb function. Passed into {@link #setCurrentFunctions(long)}
* @hide
*/
@SystemApi
public static final long FUNCTION_NONE = 0;
/**
* Code for the mtp usb function. Passed as a mask into {@link #setCurrentFunctions(long)}
* @hide
*/
@SystemApi
public static final long FUNCTION_MTP = GadgetFunction.MTP;
/**
* Code for the ptp usb function. Passed as a mask into {@link #setCurrentFunctions(long)}
* @hide
*/
@SystemApi
public static final long FUNCTION_PTP = GadgetFunction.PTP;
/**
* Code for the rndis usb function. Passed as a mask into {@link #setCurrentFunctions(long)}
* @hide
*/
@SystemApi
public static final long FUNCTION_RNDIS = GadgetFunction.RNDIS;
/**
* Code for the midi usb function. Passed as a mask into {@link #setCurrentFunctions(long)}
* @hide
*/
@SystemApi
public static final long FUNCTION_MIDI = GadgetFunction.MIDI;
/**
* Code for the accessory usb function.
* @hide
*/
@SystemApi
public static final long FUNCTION_ACCESSORY = GadgetFunction.ACCESSORY;
/**
* Code for the audio source usb function.
* @hide
*/
@SystemApi
public static final long FUNCTION_AUDIO_SOURCE = GadgetFunction.AUDIO_SOURCE;
/**
* Code for the adb usb function.
* @hide
*/
@SystemApi
public static final long FUNCTION_ADB = GadgetFunction.ADB;
/**
* Code for the ncm source usb function.
* @hide
*/
@SystemApi
public static final long FUNCTION_NCM = 1 << 10;
private static final long SETTABLE_FUNCTIONS = FUNCTION_MTP | FUNCTION_PTP | FUNCTION_RNDIS
| FUNCTION_MIDI | FUNCTION_NCM;
private static final Map<String, Long> FUNCTION_NAME_TO_CODE = new HashMap<>();
/**
* Counter for tracking UsbOperation operations.
*/
private static final AtomicInteger sUsbOperationCount = new AtomicInteger();
static {
FUNCTION_NAME_TO_CODE.put(UsbManager.USB_FUNCTION_MTP, FUNCTION_MTP);
FUNCTION_NAME_TO_CODE.put(UsbManager.USB_FUNCTION_PTP, FUNCTION_PTP);
FUNCTION_NAME_TO_CODE.put(UsbManager.USB_FUNCTION_RNDIS, FUNCTION_RNDIS);
FUNCTION_NAME_TO_CODE.put(UsbManager.USB_FUNCTION_MIDI, FUNCTION_MIDI);
FUNCTION_NAME_TO_CODE.put(UsbManager.USB_FUNCTION_ACCESSORY, FUNCTION_ACCESSORY);
FUNCTION_NAME_TO_CODE.put(UsbManager.USB_FUNCTION_AUDIO_SOURCE, FUNCTION_AUDIO_SOURCE);
FUNCTION_NAME_TO_CODE.put(UsbManager.USB_FUNCTION_ADB, FUNCTION_ADB);
FUNCTION_NAME_TO_CODE.put(UsbManager.USB_FUNCTION_NCM, FUNCTION_NCM);
}
/** @hide */
@LongDef(flag = true, prefix = { "FUNCTION_" }, value = {
FUNCTION_NONE,
FUNCTION_MTP,
FUNCTION_PTP,
FUNCTION_RNDIS,
FUNCTION_MIDI,
FUNCTION_ACCESSORY,
FUNCTION_AUDIO_SOURCE,
FUNCTION_ADB,
FUNCTION_NCM,
})
public @interface UsbFunctionMode {}
/** @hide */
@IntDef(prefix = { "GADGET_HAL_" }, value = {
GADGET_HAL_NOT_SUPPORTED,
GADGET_HAL_V1_0,
GADGET_HAL_V1_1,
GADGET_HAL_V1_2,
GADGET_HAL_V2_0,
})
public @interface UsbGadgetHalVersion {}
/** @hide */
@IntDef(prefix = { "USB_HAL_" }, value = {
USB_HAL_NOT_SUPPORTED,
USB_HAL_V1_0,
USB_HAL_V1_1,
USB_HAL_V1_2,
USB_HAL_V1_3,
USB_HAL_V2_0,
})
public @interface UsbHalVersion {}
private final Context mContext;
private final IUsbManager mService;
/**
* @hide
*/
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
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.
*/
@RequiresFeature(PackageManager.FEATURE_USB_HOST)
public HashMap<String,UsbDevice> getDeviceList() {
HashMap<String,UsbDevice> result = new HashMap<String,UsbDevice>();
if (mService == null) {
return result;
}
Bundle bundle = new Bundle();
try {
mService.getDeviceList(bundle);
for (String name : bundle.keySet()) {
result.put(name, (UsbDevice)bundle.get(name));
}
return result;
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* 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
*/
@RequiresFeature(PackageManager.FEATURE_USB_HOST)
public UsbDeviceConnection openDevice(UsbDevice device) {
try {
String deviceName = device.getDeviceName();
ParcelFileDescriptor pfd = mService.openDevice(deviceName, mContext.getPackageName());
if (pfd != null) {
UsbDeviceConnection connection = new UsbDeviceConnection(device);
boolean result = connection.open(deviceName, pfd, mContext);
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.
*/
@RequiresFeature(PackageManager.FEATURE_USB_ACCESSORY)
public UsbAccessory[] getAccessoryList() {
if (mService == null) {
return null;
}
try {
UsbAccessory accessory = mService.getCurrentAccessory();
if (accessory == null) {
return null;
} else {
return new UsbAccessory[] { accessory };
}
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Opens a file descriptor for reading and writing data to the USB accessory.
*
* <p>If data is read from the {@link java.io.InputStream} created from this file descriptor all
* data of a USB transfer should be read at once. If only a partial request is read the rest of
* the transfer is dropped.
*
* @param accessory the USB accessory to open
* @return file descriptor, or null if the accessory could not be opened.
*/
@RequiresFeature(PackageManager.FEATURE_USB_ACCESSORY)
public ParcelFileDescriptor openAccessory(UsbAccessory accessory) {
try {
return mService.openAccessory(accessory);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Gets the functionfs control file descriptor for the given function, with
* the usb descriptors and strings already written. The file descriptor is used
* by the function implementation to handle events and control requests.
*
* @param function to get control fd for. Currently {@link #FUNCTION_MTP} and
* {@link #FUNCTION_PTP} are supported.
* @return A ParcelFileDescriptor holding the valid fd, or null if the fd was not found.
*
* @hide
*/
public ParcelFileDescriptor getControlFd(long function) {
try {
return mService.getControlFd(function);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* 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.
* Permission for USB devices of class {@link UsbConstants#USB_CLASS_VIDEO} for clients that
* target SDK {@link android.os.Build.VERSION_CODES#P} and above can be granted only if they
* have additionally the {@link android.Manifest.permission#CAMERA} permission.
*
* @param device to check permissions for
* @return true if caller has permission
*/
@RequiresFeature(PackageManager.FEATURE_USB_HOST)
public boolean hasPermission(UsbDevice device) {
if (mService == null) {
return false;
}
try {
return mService.hasDevicePermission(device, mContext.getPackageName());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* 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
*/
@RequiresFeature(PackageManager.FEATURE_USB_ACCESSORY)
public boolean hasPermission(UsbAccessory accessory) {
if (mService == null) {
return false;
}
try {
return mService.hasAccessoryPermission(accessory);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* 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>
*
* Permission for USB devices of class {@link UsbConstants#USB_CLASS_VIDEO} for clients that
* target SDK {@link android.os.Build.VERSION_CODES#P} and above can be granted only if they
* have additionally the {@link android.Manifest.permission#CAMERA} permission.
*
* @param device to request permissions for
* @param pi PendingIntent for returning result
*/
@RequiresFeature(PackageManager.FEATURE_USB_HOST)
public void requestPermission(UsbDevice device, PendingIntent pi) {
try {
mService.requestDevicePermission(device, mContext.getPackageName(), pi);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* 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
*/
@RequiresFeature(PackageManager.FEATURE_USB_ACCESSORY)
public void requestPermission(UsbAccessory accessory, PendingIntent pi) {
try {
mService.requestAccessoryPermission(accessory, mContext.getPackageName(), pi);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Grants permission for USB device without showing system dialog.
* Only system components can call this function.
* @param device to request permissions for
*
* @hide
*/
public void grantPermission(UsbDevice device) {
grantPermission(device, Process.myUid());
}
/**
* Grants permission for USB device to given uid without showing system dialog.
* Only system components can call this function.
* @param device to request permissions for
* @uid uid to give permission
*
* @hide
*/
public void grantPermission(UsbDevice device, int uid) {
try {
mService.grantDevicePermission(device, uid);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Grants permission to specified package for USB device without showing system dialog.
* Only system components can call this function, as it requires the MANAGE_USB permission.
* @param device to request permissions for
* @param packageName of package to grant permissions
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_USB)
public void grantPermission(UsbDevice device, String packageName) {
try {
int uid = mContext.getPackageManager()
.getPackageUidAsUser(packageName, mContext.getUserId());
grantPermission(device, uid);
} catch (NameNotFoundException e) {
Log.e(TAG, "Package " + packageName + " not found.", 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>
*
* @deprecated use getCurrentFunctions() instead.
* @param function name of the USB function
* @return true if the USB function is enabled
*
* @hide
*/
@Deprecated
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
public boolean isFunctionEnabled(String function) {
try {
return mService.isFunctionEnabled(function);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Sets the current USB functions 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>
* An argument of 0 indicates that the device is charging, and can pick any
* appropriate function for that purpose.
* </p><p>
* Note: This function is asynchronous and may fail silently without applying
* the requested changes.
* </p>
*
* @param functions the USB function(s) to set, as a bitwise mask.
* Must satisfy {@link UsbManager#areSettableFunctions}
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_USB)
public void setCurrentFunctions(@UsbFunctionMode long functions) {
int operationId = sUsbOperationCount.incrementAndGet() + Binder.getCallingUid();
try {
mService.setCurrentFunctions(functions, operationId);
} catch (RemoteException e) {
Log.e(TAG, "setCurrentFunctions: failed to call setCurrentFunctions. functions:"
+ functions + ", opId:" + operationId, e);
throw e.rethrowFromSystemServer();
}
}
/**
* Sets the current USB functions when in device mode.
*
* @deprecated use setCurrentFunctions(long) instead.
* @param functions the USB function(s) to set.
* @param usbDataUnlocked unused
* @hide
*/
@Deprecated
@UnsupportedAppUsage
public void setCurrentFunction(String functions, boolean usbDataUnlocked) {
int operationId = sUsbOperationCount.incrementAndGet() + Binder.getCallingUid();
try {
mService.setCurrentFunction(functions, usbDataUnlocked, operationId);
} catch (RemoteException e) {
Log.e(TAG, "setCurrentFunction: failed to call setCurrentFunction. functions:"
+ functions + ", opId:" + operationId, e);
throw e.rethrowFromSystemServer();
}
}
/**
* Returns the current USB functions in device mode.
* <p>
* This function returns the state of primary USB functions and can return a
* mask containing any usb function(s) except for ADB.
* </p>
*
* @return The currently enabled functions, in a bitwise mask.
* A zero mask indicates that the current function is the charging function.
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_USB)
public long getCurrentFunctions() {
try {
return mService.getCurrentFunctions();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Sets the screen unlocked functions, which are persisted and set as the current functions
* whenever the screen is unlocked.
* <p>
* A zero mask has the effect of switching off this feature, so functions
* no longer change on screen unlock.
* </p><p>
* Note: When the screen is on, this method will apply given functions as current functions,
* which is asynchronous and may fail silently without applying the requested changes.
* </p>
*
* @param functions functions to set, in a bitwise mask.
* Must satisfy {@link UsbManager#areSettableFunctions}
*
* @hide
*/
public void setScreenUnlockedFunctions(long functions) {
try {
mService.setScreenUnlockedFunctions(functions);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Gets the current screen unlocked functions.
*
* @return The currently set screen enabled functions.
* A zero mask indicates that the screen unlocked functions feature is not enabled.
*
* @hide
*/
public long getScreenUnlockedFunctions() {
try {
return mService.getScreenUnlockedFunctions();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Get the Current USB Bandwidth.
* <p>
* This function returns the current USB bandwidth through USB Gadget HAL.
* It should be used when Android device is in USB peripheral mode and
* connects to a USB host. If USB state is not configued, API will return
* {@value #USB_DATA_TRANSFER_RATE_UNKNOWN}. In addition, the unit of the
* return value is Mbps.
* </p>
*
* @return The value of currently USB Bandwidth.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
@RequiresPermission(Manifest.permission.MANAGE_USB)
public int getUsbBandwidthMbps() {
int usbSpeed;
try {
usbSpeed = mService.getCurrentUsbSpeed();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
return usbSpeedToBandwidth(usbSpeed);
}
/**
* Get the Current Gadget Hal Version.
* <p>
* This function returns the current Gadget Hal Version.
* </p>
*
* @return a integer {@code GADGET_HAL_*} represent hal version.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
@RequiresPermission(Manifest.permission.MANAGE_USB)
public @UsbGadgetHalVersion int getGadgetHalVersion() {
try {
return mService.getGadgetHalVersion();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Get the Current USB Hal Version.
* <p>
* This function returns the current USB Hal Version.
* </p>
*
* @return a integer {@code USB_HAL_*} represent hal version.
*
* @hide
*/
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
@RequiresPermission(Manifest.permission.MANAGE_USB)
public @UsbHalVersion int getUsbHalVersion() {
try {
return mService.getUsbHalVersion();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Resets the USB Gadget.
* <p>
* Performs USB data stack reset through USB Gadget HAL.
* It will force USB data connection reset. The connection will disconnect and reconnect.
* </p>
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_USB)
public void resetUsbGadget() {
try {
mService.resetUsbGadget();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Enable/Disable the USB data signaling.
* <p>
* Enables/Disables USB data path of all USB ports.
* It will force to stop or restore USB data signaling.
* </p>
*
* @param enable enable or disable USB data signaling
* @return true enable or disable USB data successfully
* false if something wrong
*
* @hide
*/
@RequiresPermission(Manifest.permission.MANAGE_USB)
public boolean enableUsbDataSignal(boolean enable) {
return setUsbDataSignal(getPorts(), !enable, /* revertOnFailure= */ true);
}
private boolean setUsbDataSignal(List<UsbPort> usbPorts, boolean disable,
boolean revertOnFailure) {
List<UsbPort> changedPorts = new ArrayList<>();
for (int i = 0; i < usbPorts.size(); i++) {
UsbPort port = usbPorts.get(i);
if (isPortDisabled(port) != disable) {
changedPorts.add(port);
if (port.enableUsbData(!disable) != UsbPort.ENABLE_USB_DATA_SUCCESS
&& revertOnFailure) {
Log.e(TAG, "Failed to set usb data signal for portID(" + port.getId() + ")");
setUsbDataSignal(changedPorts, !disable, /* revertOnFailure= */ false);
return false;
}
}
}
return true;
}
private boolean isPortDisabled(UsbPort usbPort) {
return (getPortStatus(usbPort).getUsbDataStatus() & DATA_STATUS_DISABLED_FORCE)
== DATA_STATUS_DISABLED_FORCE;
}
/**
* 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
*
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.MANAGE_USB)
public @NonNull List<UsbPort> getPorts() {
if (mService == null) {
return Collections.emptyList();
}
List<ParcelableUsbPort> parcelablePorts;
try {
parcelablePorts = mService.getPorts();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
if (parcelablePorts == null) {
return Collections.emptyList();
} else {
int numPorts = parcelablePorts.size();
ArrayList<UsbPort> ports = new ArrayList<>(numPorts);
for (int i = 0; i < numPorts; i++) {
ports.add(parcelablePorts.get(i).getUsbPort(this));
}
return ports;
}
}
/**
* Should only be called by {@link UsbPort#getStatus}.
*
* @hide
*/
UsbPortStatus getPortStatus(UsbPort port) {
try {
return mService.getPortStatus(port.getId());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Should only be called by {@link UsbPort#setRoles}.
*
* @hide
*/
void setPortRoles(UsbPort port, int powerRole, int dataRole) {
Log.d(TAG, "setPortRoles Package:" + mContext.getPackageName());
try {
mService.setPortRoles(port.getId(), powerRole, dataRole);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Enables USB port contaminant detection algorithm.
*
* @hide
*/
@RequiresPermission(Manifest.permission.MANAGE_USB)
void enableContaminantDetection(@NonNull UsbPort port, boolean enable) {
try {
mService.enableContaminantDetection(port.getId(), enable);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Should only be called by {@link UsbPort#enableLimitPowerTransfer}.
* <p>
* limits or restores power transfer in and out of USB port.
*
* @param port USB port for which power transfer has to be limited or restored.
* @param limit limit power transfer when true.
* relax power transfer restrictions when false.
* @param operationId operationId for the request.
* @param callback callback object to be invoked when the operation is complete.
*
* @hide
*/
@RequiresPermission(Manifest.permission.MANAGE_USB)
void enableLimitPowerTransfer(@NonNull UsbPort port, boolean limit, int operationId,
IUsbOperationInternal callback) {
Objects.requireNonNull(port, "enableLimitPowerTransfer:port must not be null. opId:"
+ operationId);
try {
mService.enableLimitPowerTransfer(port.getId(), limit, operationId, callback);
} catch (RemoteException e) {
Log.e(TAG, "enableLimitPowerTransfer failed. opId:" + operationId, e);
try {
callback.onOperationComplete(UsbOperationInternal.USB_OPERATION_ERROR_INTERNAL);
} catch (RemoteException r) {
Log.e(TAG, "enableLimitPowerTransfer failed to call onOperationComplete. opId:"
+ operationId, r);
}
throw e.rethrowFromSystemServer();
}
}
/**
* Should only be called by {@link UsbPort#resetUsbPort}.
* <p>
* Disable and then re-enable USB data signaling.
*
* Reset USB first port..
* It will force to stop and restart USB data signaling.
* Call UsbPort API if the device has more than one UsbPort.
* </p>
*
* @param port reset the USB Port
* @return true enable or disable USB data successfully
* false if something wrong
*
* Should only be called by {@link UsbPort#resetUsbPort}.
*
* @hide
*/
@RequiresPermission(Manifest.permission.MANAGE_USB)
void resetUsbPort(@NonNull UsbPort port, int operationId,
IUsbOperationInternal callback) {
Objects.requireNonNull(port, "resetUsbPort: port must not be null. opId:" + operationId);
try {
mService.resetUsbPort(port.getId(), operationId, callback);
} catch (RemoteException e) {
Log.e(TAG, "resetUsbPort: failed. ", e);
try {
callback.onOperationComplete(UsbOperationInternal.USB_OPERATION_ERROR_INTERNAL);
} catch (RemoteException r) {
Log.e(TAG, "resetUsbPort: failed to call onOperationComplete. opId:"
+ operationId, r);
}
throw e.rethrowFromSystemServer();
}
}
/**
* Should only be called by {@link UsbPort#enableUsbData}.
* <p>
* Enables or disables USB data on the specific port.
*
* @param port USB port for which USB data needs to be enabled or disabled.
* @param enable Enable USB data when true.
* Disable USB data when false.
* @param operationId operationId for the request.
* @param callback callback object to be invoked when the operation is complete.
* @return True when the operation is asynchronous. The caller must therefore call
* {@link UsbOperationInternal#waitForOperationComplete} for processing
* the result.
* False when the operation is synchronous. Caller can proceed reading the result
* through {@link UsbOperationInternal#getStatus}
* @hide
*/
@RequiresPermission(Manifest.permission.MANAGE_USB)
boolean enableUsbData(@NonNull UsbPort port, boolean enable, int operationId,
IUsbOperationInternal callback) {
Objects.requireNonNull(port, "enableUsbData: port must not be null. opId:" + operationId);
try {
return mService.enableUsbData(port.getId(), enable, operationId, callback);
} catch (RemoteException e) {
Log.e(TAG, "enableUsbData: failed. opId:" + operationId, e);
try {
callback.onOperationComplete(UsbOperationInternal.USB_OPERATION_ERROR_INTERNAL);
} catch (RemoteException r) {
Log.e(TAG, "enableUsbData: failed to call onOperationComplete. opId:"
+ operationId, r);
}
throw e.rethrowFromSystemServer();
}
}
/**
* Should only be called by {@link UsbPort#enableUsbDataWhileDocked}.
* <p>
* Enables or disables USB data when disabled due to docking event.
*
* @param port USB port for which USB data needs to be enabled.
* @param operationId operationId for the request.
* @param callback callback object to be invoked when the operation is complete.
* @hide
*/
@RequiresPermission(Manifest.permission.MANAGE_USB)
void enableUsbDataWhileDocked(@NonNull UsbPort port, int operationId,
IUsbOperationInternal callback) {
Objects.requireNonNull(port, "enableUsbDataWhileDocked: port must not be null. opId:"
+ operationId);
try {
mService.enableUsbDataWhileDocked(port.getId(), operationId, callback);
} catch (RemoteException e) {
Log.e(TAG, "enableUsbDataWhileDocked: failed. opId:" + operationId, e);
try {
callback.onOperationComplete(UsbOperationInternal.USB_OPERATION_ERROR_INTERNAL);
} catch (RemoteException r) {
Log.e(TAG, "enableUsbDataWhileDocked: failed to call onOperationComplete. opId:"
+ operationId, r);
}
throw e.rethrowFromSystemServer();
}
}
/**
* Sets the component that will handle USB device connection.
* <p>
* Setting component allows to specify external USB host manager to handle use cases, where
* selection dialog for an activity that will handle USB device is undesirable.
* Only system components can call this function, as it requires the MANAGE_USB permission.
*
* @param usbDeviceConnectionHandler The component to handle usb connections,
* {@code null} to unset.
*
* @hide
*/
public void setUsbDeviceConnectionHandler(@Nullable ComponentName usbDeviceConnectionHandler) {
try {
mService.setUsbDeviceConnectionHandler(usbDeviceConnectionHandler);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Returns whether the given functions are valid inputs to UsbManager.
* Currently the empty functions or any of MTP, PTP, RNDIS, MIDI, NCM are accepted.
*
* Only one function may be set at a time, except for RNDIS and NCM, which can be set together
* because from a user perspective they are the same function (tethering).
*
* @return Whether the mask is settable.
*
* @hide
*/
public static boolean areSettableFunctions(long functions) {
return functions == FUNCTION_NONE
|| ((~SETTABLE_FUNCTIONS & functions) == 0
&& ((Long.bitCount(functions) == 1)
|| (functions == (FUNCTION_RNDIS | FUNCTION_NCM))));
}
/**
* Converts the given function mask to string. Maintains ordering with respect to init scripts.
*
* @return String representation of given mask
*
* @hide
*/
public static String usbFunctionsToString(long functions) {
StringJoiner joiner = new StringJoiner(",");
if ((functions & FUNCTION_MTP) != 0) {
joiner.add(UsbManager.USB_FUNCTION_MTP);
}
if ((functions & FUNCTION_PTP) != 0) {
joiner.add(UsbManager.USB_FUNCTION_PTP);
}
if ((functions & FUNCTION_RNDIS) != 0) {
joiner.add(UsbManager.USB_FUNCTION_RNDIS);
}
if ((functions & FUNCTION_MIDI) != 0) {
joiner.add(UsbManager.USB_FUNCTION_MIDI);
}
if ((functions & FUNCTION_ACCESSORY) != 0) {
joiner.add(UsbManager.USB_FUNCTION_ACCESSORY);
}
if ((functions & FUNCTION_AUDIO_SOURCE) != 0) {
joiner.add(UsbManager.USB_FUNCTION_AUDIO_SOURCE);
}
if ((functions & FUNCTION_NCM) != 0) {
joiner.add(UsbManager.USB_FUNCTION_NCM);
}
if ((functions & FUNCTION_ADB) != 0) {
joiner.add(UsbManager.USB_FUNCTION_ADB);
}
return joiner.toString();
}
/**
* Parses a string of usb functions that are comma separated.
*
* @return A mask of all valid functions in the string
*
* @hide
*/
public static long usbFunctionsFromString(String functions) {
if (functions == null || functions.equals(USB_FUNCTION_NONE)) {
return FUNCTION_NONE;
}
long ret = 0;
for (String function : functions.split(",")) {
if (FUNCTION_NAME_TO_CODE.containsKey(function)) {
ret |= FUNCTION_NAME_TO_CODE.get(function);
} else if (function.length() > 0) {
throw new IllegalArgumentException("Invalid usb function " + functions);
}
}
return ret;
}
/**
* Converts the given integer of USB speed to corresponding bandwidth.
*
* @return a value of USB bandwidth
*
* @hide
*/
public static int usbSpeedToBandwidth(int speed) {
switch (speed) {
case UsbSpeed.USB4_GEN3_40Gb:
return USB_DATA_TRANSFER_RATE_40G;
case UsbSpeed.USB4_GEN3_20Gb:
return USB_DATA_TRANSFER_RATE_20G;
case UsbSpeed.USB4_GEN2_20Gb:
return USB_DATA_TRANSFER_RATE_20G;
case UsbSpeed.USB4_GEN2_10Gb:
return USB_DATA_TRANSFER_RATE_10G;
case UsbSpeed.SUPERSPEED_20Gb:
return USB_DATA_TRANSFER_RATE_20G;
case UsbSpeed.SUPERSPEED_10Gb:
return USB_DATA_TRANSFER_RATE_10G;
case UsbSpeed.SUPERSPEED:
return USB_DATA_TRANSFER_RATE_5G;
case UsbSpeed.HIGHSPEED:
return USB_DATA_TRANSFER_RATE_HIGH_SPEED;
case UsbSpeed.FULLSPEED:
return USB_DATA_TRANSFER_RATE_FULL_SPEED;
case UsbSpeed.LOWSPEED:
return USB_DATA_TRANSFER_RATE_LOW_SPEED;
default:
return USB_DATA_TRANSFER_RATE_UNKNOWN;
}
}
/**
* Converts the given usb gadgdet hal version to String
*
* @return String representation of Usb Gadget Hal Version
*
* @hide
*/
public static @NonNull String usbGadgetHalVersionToString(int version) {
String halVersion;
if (version == GADGET_HAL_V2_0) {
halVersion = GADGET_HAL_VERSION_2_0;
} else if (version == GADGET_HAL_V1_2) {
halVersion = GADGET_HAL_VERSION_1_2;
} else if (version == GADGET_HAL_V1_1) {
halVersion = GADGET_HAL_VERSION_1_1;
} else if (version == GADGET_HAL_V1_0) {
halVersion = GADGET_HAL_VERSION_1_0;
} else {
halVersion = GADGET_HAL_UNKNOWN;
}
return halVersion;
}
}
|