16b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* 26b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * Gadget Function Driver for Android USB accessories 36b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 46b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * Copyright (C) 2011 Google, Inc. 56b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * Author: Mike Lockwood <lockwood@android.com> 66b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 76b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * This software is licensed under the terms of the GNU General Public 86b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * License version 2, as published by the Free Software Foundation, and 96b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * may be copied, distributed, and modified under those terms. 106b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 116b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * This program is distributed in the hope that it will be useful, 126b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * but WITHOUT ANY WARRANTY; without even the implied warranty of 136b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 146b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * GNU General Public License for more details. 156b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 166b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 176b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 186b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#ifndef __LINUX_USB_F_ACCESSORY_H 196b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define __LINUX_USB_F_ACCESSORY_H 206b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 216b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Use Google Vendor ID when in accessory mode */ 226b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define USB_ACCESSORY_VENDOR_ID 0x18D1 236b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 246b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 256b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Product ID to use when in accessory mode */ 266b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define USB_ACCESSORY_PRODUCT_ID 0x2D00 276b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 286b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Product ID to use when in accessory mode and adb is enabled */ 296b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define USB_ACCESSORY_ADB_PRODUCT_ID 0x2D01 306b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 316b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Indexes for strings sent by the host via ACCESSORY_SEND_STRING */ 326b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_STRING_MANUFACTURER 0 336b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_STRING_MODEL 1 346b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_STRING_DESCRIPTION 2 356b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_STRING_VERSION 3 366b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_STRING_URI 4 376b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_STRING_SERIAL 5 386b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 396b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Control request for retrieving device's protocol version 406b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 416b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * requestType: USB_DIR_IN | USB_TYPE_VENDOR 426b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * request: ACCESSORY_GET_PROTOCOL 436b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value: 0 446b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * index: 0 456b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * data version number (16 bits little endian) 466b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 1 for original accessory support 476b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 2 adds audio and HID support 486b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 496b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_GET_PROTOCOL 51 506b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 516b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Control request for host to send a string to the device 526b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 536b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * requestType: USB_DIR_OUT | USB_TYPE_VENDOR 546b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * request: ACCESSORY_SEND_STRING 556b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value: 0 566b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * index: string ID 576b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * data zero terminated UTF8 string 586b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 596b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * The device can later retrieve these strings via the 606b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * ACCESSORY_GET_STRING_* ioctls 616b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 626b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_SEND_STRING 52 636b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 646b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Control request for starting device in accessory mode. 656b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * The host sends this after setting all its strings to the device. 666b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 676b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * requestType: USB_DIR_OUT | USB_TYPE_VENDOR 686b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * request: ACCESSORY_START 696b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value: 0 706b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * index: 0 716b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * data none 726b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 736b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_START 53 746b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 756b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Control request for registering a HID device. 766b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * Upon registering, a unique ID is sent by the accessory in the 776b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value parameter. This ID will be used for future commands for 786b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * the device 796b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 806b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * requestType: USB_DIR_OUT | USB_TYPE_VENDOR 816b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * request: ACCESSORY_REGISTER_HID_DEVICE 826b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value: Accessory assigned ID for the HID device 836b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * index: total length of the HID report descriptor 846b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * data none 856b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 866b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_REGISTER_HID 54 876b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 886b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Control request for unregistering a HID device. 896b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 906b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * requestType: USB_DIR_OUT | USB_TYPE_VENDOR 916b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * request: ACCESSORY_REGISTER_HID 926b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value: Accessory assigned ID for the HID device 936b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * index: 0 946b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * data none 956b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 966b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_UNREGISTER_HID 55 976b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 986b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Control request for sending the HID report descriptor. 996b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * If the HID descriptor is longer than the endpoint zero max packet size, 1006b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * the descriptor will be sent in multiple ACCESSORY_SET_HID_REPORT_DESC 1016b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * commands. The data for the descriptor must be sent sequentially 1026b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * if multiple packets are needed. 1036b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 1046b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * requestType: USB_DIR_OUT | USB_TYPE_VENDOR 1056b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * request: ACCESSORY_SET_HID_REPORT_DESC 1066b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value: Accessory assigned ID for the HID device 1076b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * index: offset of data in descriptor 1086b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * (needed when HID descriptor is too big for one packet) 1096b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * data the HID report descriptor 1106b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 1116b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_SET_HID_REPORT_DESC 56 1126b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 1136b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Control request for sending HID events. 1146b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 1156b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * requestType: USB_DIR_OUT | USB_TYPE_VENDOR 1166b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * request: ACCESSORY_SEND_HID_EVENT 1176b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value: Accessory assigned ID for the HID device 1186b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * index: 0 1196b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * data the HID report for the event 1206b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 1216b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_SEND_HID_EVENT 57 1226b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 1236b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* Control request for setting the audio mode. 1246b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 1256b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * requestType: USB_DIR_OUT | USB_TYPE_VENDOR 1266b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * request: ACCESSORY_SET_AUDIO_MODE 1276b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * value: 0 - no audio 1286b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * 1 - device to host, 44100 16-bit stereo PCM 1296b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * index: 0 1306b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood * data the HID report for the event 1316b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood */ 1326b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_SET_AUDIO_MODE 58 1336b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 1346b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 1356b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 1366b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* ioctls for retrieving strings set by the host */ 1376b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_GET_STRING_MANUFACTURER _IOW('M', 1, char[256]) 1386b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_GET_STRING_MODEL _IOW('M', 2, char[256]) 1396b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_GET_STRING_DESCRIPTION _IOW('M', 3, char[256]) 1406b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_GET_STRING_VERSION _IOW('M', 4, char[256]) 1416b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_GET_STRING_URI _IOW('M', 5, char[256]) 1426b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_GET_STRING_SERIAL _IOW('M', 6, char[256]) 1436b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* returns 1 if there is a start request pending */ 1446b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_IS_START_REQUESTED _IO('M', 7) 1456b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood/* returns audio mode (set via the ACCESSORY_SET_AUDIO_MODE control request) */ 1466b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#define ACCESSORY_GET_AUDIO_MODE _IO('M', 8) 1476b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood 1486b524d9b4552f20e4e689178bdb954a94daf7ab8Mike Lockwood#endif /* __LINUX_USB_F_ACCESSORY_H */ 149