blob: bcf83c0a6e62b340899ea661955de89bbfc9df11 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#
2# USB Gadget support on a system involves
3# (a) a peripheral controller, and
4# (b) the gadget driver using it.
5#
6# NOTE: Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !!
7#
8# - Host systems (like PCs) need CONFIG_USB (with "A" jacks).
9# - Peripherals (like PDAs) need CONFIG_USB_GADGET (with "B" jacks).
Matt LaPlantecab00892006-10-03 22:36:44 +020010# - Some systems have both kinds of controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#
12# With help from a special transceiver and a "Mini-AB" jack, systems with
13# both kinds of controller can also support "USB On-the-Go" (CONFIG_USB_OTG).
14#
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
Denis Chengb75be4a2008-01-24 16:36:31 +080016menuconfig USB_GADGET
17 tristate "USB Gadget Support"
Alan Stern86dc2432011-11-17 16:42:24 -050018 select NLS
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 help
20 USB is a master/slave protocol, organized with one master
21 host (such as a PC) controlling up to 127 peripheral devices.
22 The USB hardware is asymmetric, which makes it easier to set up:
23 you can't connect a "to-the-host" connector to a peripheral.
24
25 Linux can run in the host, or in the peripheral. In both cases
26 you need a low level bus controller driver, and some software
27 talking to it. Peripheral controllers are often discrete silicon,
28 or are integrated with the CPU in a microcontroller. The more
Jules Villarde113f292006-08-22 22:40:15 +020029 familiar host side controllers have names like "EHCI", "OHCI",
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 or "UHCI", and are usually integrated into southbridges on PC
31 motherboards.
32
33 Enable this configuration option if you want to run Linux inside
34 a USB peripheral device. Configure one hardware driver for your
35 peripheral/device side bus controller, and a "gadget driver" for
36 your peripheral protocol. (If you use modular gadget drivers,
37 you may configure more than one.)
38
39 If in doubt, say "N" and don't enable these drivers; most people
40 don't have this kind of hardware (except maybe inside Linux PDAs).
41
42 For more information, see <http://www.linux-usb.org/gadget> and
43 the kernel DocBook documentation for this API.
44
Denis Chengb75be4a2008-01-24 16:36:31 +080045if USB_GADGET
46
David Brownell70790f62007-07-01 17:35:28 -070047config USB_GADGET_DEBUG
Christoph Jaeger6341e622014-12-20 15:41:11 -050048 bool "Debugging messages (DEVELOPMENT)"
David Brownell36e893d2008-09-12 09:39:06 -070049 depends on DEBUG_KERNEL
David Brownell70790f62007-07-01 17:35:28 -070050 help
51 Many controller and gadget drivers will print some debugging
52 messages if you use this option to ask for those messages.
53
54 Avoid enabling these messages, even if you're actively
55 debugging such a driver. Many drivers will emit so many
56 messages that the driver timings are affected, which will
57 either create new failure modes or remove the one you're
58 trying to track down. Never enable these messages for a
59 production build.
60
Andreas Larssoncd108692013-10-11 08:07:00 +020061config USB_GADGET_VERBOSE
62 bool "Verbose debugging Messages (DEVELOPMENT)"
63 depends on USB_GADGET_DEBUG
64 help
65 Many controller and gadget drivers will print verbose debugging
66 messages if you use this option to ask for those messages.
67
68 Avoid enabling these messages, even if you're actively
69 debugging such a driver. Many drivers will emit so many
70 messages that the driver timings are affected, which will
71 either create new failure modes or remove the one you're
72 trying to track down. Never enable these messages for a
73 production build.
74
Linus Torvalds1da177e2005-04-16 15:20:36 -070075config USB_GADGET_DEBUG_FILES
Christoph Jaeger6341e622014-12-20 15:41:11 -050076 bool "Debugging information files (DEVELOPMENT)"
David Brownell36e893d2008-09-12 09:39:06 -070077 depends on PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 help
79 Some of the drivers in the "gadget" framework can expose
80 debugging information in files such as /proc/driver/udc
81 (for a peripheral controller). The information in these
82 files may help when you're troubleshooting or bringing up a
83 driver on a new board. Enable these files by choosing "Y"
84 here. If in doubt, or to conserve kernel memory, say "N".
85
Haavard Skinnemoen914a3f32007-10-10 02:29:43 -070086config USB_GADGET_DEBUG_FS
Christoph Jaeger6341e622014-12-20 15:41:11 -050087 bool "Debugging information files in debugfs (DEVELOPMENT)"
David Brownell36e893d2008-09-12 09:39:06 -070088 depends on DEBUG_FS
Haavard Skinnemoen914a3f32007-10-10 02:29:43 -070089 help
90 Some of the drivers in the "gadget" framework can expose
91 debugging information in files under /sys/kernel/debug/.
92 The information in these files may help when you're
93 troubleshooting or bringing up a driver on a new board.
94 Enable these files by choosing "Y" here. If in doubt, or
95 to conserve kernel memory, say "N".
96
David Brownell36e893d2008-09-12 09:39:06 -070097config USB_GADGET_VBUS_DRAW
98 int "Maximum VBUS Power usage (2-500 mA)"
99 range 2 500
100 default 2
101 help
102 Some devices need to draw power from USB when they are
103 configured, perhaps to operate circuitry or to recharge
104 batteries. This is in addition to any local power supply,
105 such as an AC adapter or batteries.
106
107 Enter the maximum power your device draws through USB, in
108 milliAmperes. The permitted range of values is 2 - 500 mA;
109 0 mA would be legal, but can make some hosts misbehave.
110
111 This value will be used except for system-specific gadget
112 drivers that have more specific information.
113
Per Forlin6532c7f2011-08-19 21:21:27 +0200114config USB_GADGET_STORAGE_NUM_BUFFERS
115 int "Number of storage pipeline buffers"
116 range 2 4
117 default 2
118 help
119 Usually 2 buffers are enough to establish a good buffering
120 pipeline. The number may be increased in order to compensate
121 for a bursty VFS behaviour. For instance there may be CPU wake up
122 latencies that makes the VFS to appear bursty in a system with
123 an CPU on-demand governor. Especially if DMA is doing IO to
124 offload the CPU. In this case the CPU will go into power
125 save often and spin up occasionally to move data within VFS.
126 If selecting USB_GADGET_DEBUG_FILES this value may be set by
127 a module parameter as well.
128 If unsure, say 2.
129
Andrzej Pietrasiewicz90fccb52014-07-15 13:09:45 +0200130source "drivers/usb/gadget/udc/Kconfig"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132#
133# USB Gadget Drivers
134#
Sebastian Andrzej Siewiora84d9e52012-09-06 20:11:09 +0200135
136# composite based drivers
137config USB_LIBCOMPOSITE
138 tristate
Sebastian Andrzej Siewior88af8bb2012-12-23 21:10:24 +0100139 select CONFIGFS_FS
Sebastian Andrzej Siewiora84d9e52012-09-06 20:11:09 +0200140 depends on USB_GADGET
141
Sebastian Andrzej Siewiorff47f592012-12-23 21:10:07 +0100142config USB_F_ACM
143 tristate
144
Sebastian Andrzej Siewiorcf9a08a2012-12-23 21:10:01 +0100145config USB_F_SS_LB
146 tristate
147
Sebastian Andrzej Siewior3249ca22012-12-23 21:10:04 +0100148config USB_U_SERIAL
149 tristate
150
Andrzej Pietrasiewiczf1a18232013-05-23 09:22:03 +0200151config USB_U_ETHER
152 tristate
153
Andrzej Pietrasiewicz60540ea2013-03-18 09:52:57 +0100154config USB_F_SERIAL
155 tristate
156
Andrzej Pietrasiewicz1d8fc252013-03-21 15:33:42 +0100157config USB_F_OBEX
158 tristate
159
Andrzej Pietrasiewicz40d133d2013-05-23 09:22:06 +0200160config USB_F_NCM
161 tristate
162
Andrzej Pietrasiewiczfee562a2013-05-23 10:32:03 +0200163config USB_F_ECM
164 tristate
165
Andrzej Pietrasiewiczfcbdf122013-05-23 10:51:11 +0200166config USB_F_PHONET
167 tristate
168
Andrzej Pietrasiewiczb29002a2013-05-28 09:15:47 +0200169config USB_F_EEM
170 tristate
171
Andrzej Pietrasiewicz8cedba72013-05-28 09:15:53 +0200172config USB_F_SUBSET
173 tristate
174
Andrzej Pietrasiewiczf466c632013-05-28 09:15:57 +0200175config USB_F_RNDIS
176 tristate
177
Andrzej Pietrasiewicze5eaa0d2013-10-09 10:06:01 +0200178config USB_F_MASS_STORAGE
179 tristate
180
Andrzej Pietrasiewicz5920cda2013-12-03 15:15:33 +0100181config USB_F_FS
182 tristate
183
Andrzej Pietrasiewiczf3a34062014-07-22 19:58:38 +0200184config USB_F_UAC1
185 tristate
186
Andrzej Pietrasiewiczf8f93d22014-07-22 19:58:30 +0200187config USB_F_UAC2
188 tristate
189
Andrzej Pietrasiewicz6d11ed72014-09-09 02:02:10 +0300190config USB_F_UVC
191 tristate
192
Andrzej Pietrasiewiczb85e9de2014-10-16 13:33:27 +0200193config USB_F_MIDI
194 tristate
195
Andrzej Pietrasiewiczcb382532014-11-06 11:11:59 +0100196config USB_F_HID
197 tristate
198
Andrzej Pietrasiewiczb26394b2015-03-03 10:52:28 +0100199config USB_F_PRINTER
200 tristate
201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202choice
203 tristate "USB Gadget Drivers"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 default USB_ETH
205 help
206 A Linux "Gadget Driver" talks to the USB Peripheral Controller
207 driver through the abstract "gadget" API. Some other operating
208 systems call these "client" drivers, of which "class drivers"
209 are a subset (implementing a USB device class specification).
210 A gadget driver implements one or more USB functions using
211 the peripheral hardware.
212
213 Gadget drivers are hardware-neutral, or "platform independent",
214 except that they sometimes must understand quirks or limitations
215 of the particular controllers they work with. For example, when
216 a controller doesn't support alternate configurations or provide
217 enough of the right types of endpoints, the gadget driver might
218 not be able work with that controller, or might need to implement
219 a less common variant of a device class protocol.
220
221# this first set of drivers all depend on bulk-capable hardware.
222
Andrzej Pietrasiewiczd1c02452013-06-13 10:37:24 +0200223config USB_CONFIGFS
224 tristate "USB functions configurable through configfs"
225 select USB_LIBCOMPOSITE
226 help
227 A Linux USB "gadget" can be set up through configfs.
228 If this is the case, the USB functions (which from the host's
229 perspective are seen as interfaces) and configurations are
230 specified simply by creating appropriate directories in configfs.
231 Associating functions with configurations is done by creating
232 appropriate symbolic links.
Philippe De Swert9c1d6962013-08-18 13:51:43 +0300233 For more information see Documentation/usb/gadget_configfs.txt.
Andrzej Pietrasiewiczd1c02452013-06-13 10:37:24 +0200234
235config USB_CONFIGFS_SERIAL
Christoph Jaeger6341e622014-12-20 15:41:11 -0500236 bool "Generic serial bulk in/out"
Andrzej Pietrasiewiczd1c02452013-06-13 10:37:24 +0200237 depends on USB_CONFIGFS
238 depends on TTY
239 select USB_U_SERIAL
240 select USB_F_SERIAL
241 help
242 The function talks to the Linux-USB generic serial driver.
243
244config USB_CONFIGFS_ACM
Christoph Jaeger6341e622014-12-20 15:41:11 -0500245 bool "Abstract Control Model (CDC ACM)"
Andrzej Pietrasiewiczd1c02452013-06-13 10:37:24 +0200246 depends on USB_CONFIGFS
247 depends on TTY
248 select USB_U_SERIAL
249 select USB_F_ACM
250 help
251 ACM serial link. This function can be used to interoperate with
252 MS-Windows hosts or with the Linux-USB "cdc-acm" driver.
253
254config USB_CONFIGFS_OBEX
Christoph Jaeger6341e622014-12-20 15:41:11 -0500255 bool "Object Exchange Model (CDC OBEX)"
Andrzej Pietrasiewiczd1c02452013-06-13 10:37:24 +0200256 depends on USB_CONFIGFS
257 depends on TTY
258 select USB_U_SERIAL
259 select USB_F_OBEX
260 help
261 You will need a user space OBEX server talking to /dev/ttyGS*,
262 since the kernel itself doesn't implement the OBEX protocol.
263
264config USB_CONFIGFS_NCM
Christoph Jaeger6341e622014-12-20 15:41:11 -0500265 bool "Network Control Model (CDC NCM)"
Andrzej Pietrasiewiczd1c02452013-06-13 10:37:24 +0200266 depends on USB_CONFIGFS
267 depends on NET
268 select USB_U_ETHER
269 select USB_F_NCM
270 help
271 NCM is an advanced protocol for Ethernet encapsulation, allows
272 grouping of several ethernet frames into one USB transfer and
273 different alignment possibilities.
274
275config USB_CONFIGFS_ECM
Christoph Jaeger6341e622014-12-20 15:41:11 -0500276 bool "Ethernet Control Model (CDC ECM)"
Andrzej Pietrasiewiczd1c02452013-06-13 10:37:24 +0200277 depends on USB_CONFIGFS
278 depends on NET
279 select USB_U_ETHER
280 select USB_F_ECM
281 help
282 The "Communication Device Class" (CDC) Ethernet Control Model.
283 That protocol is often avoided with pure Ethernet adapters, in
284 favor of simpler vendor-specific hardware, but is widely
285 supported by firmware for smart network devices.
286
Andrzej Pietrasiewicz02832e52013-05-28 09:15:56 +0200287config USB_CONFIGFS_ECM_SUBSET
Christoph Jaeger6341e622014-12-20 15:41:11 -0500288 bool "Ethernet Control Model (CDC ECM) subset"
Andrzej Pietrasiewicz02832e52013-05-28 09:15:56 +0200289 depends on USB_CONFIGFS
290 depends on NET
291 select USB_U_ETHER
292 select USB_F_SUBSET
293 help
294 On hardware that can't implement the full protocol,
295 a simple CDC subset is used, placing fewer demands on USB.
296
Andrzej Pietrasiewiczb3df2fa2013-05-28 09:16:01 +0200297config USB_CONFIGFS_RNDIS
298 bool "RNDIS"
299 depends on USB_CONFIGFS
300 depends on NET
301 select USB_U_ETHER
302 select USB_F_RNDIS
303 help
304 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
305 and Microsoft provides redistributable binary RNDIS drivers for
306 older versions of Windows.
307
308 To make MS-Windows work with this, use Documentation/usb/linux.inf
309 as the "driver info file". For versions of MS-Windows older than
310 XP, you'll need to download drivers from Microsoft's website; a URL
311 is given in comments found in that info file.
312
Andrzej Pietrasiewicz17b80972013-05-28 09:15:51 +0200313config USB_CONFIGFS_EEM
314 bool "Ethernet Emulation Model (EEM)"
315 depends on USB_CONFIGFS
316 depends on NET
317 select USB_U_ETHER
318 select USB_F_EEM
319 help
320 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
321 and therefore can be supported by more hardware. Technically ECM and
322 EEM are designed for different applications. The ECM model extends
323 the network interface to the target (e.g. a USB cable modem), and the
324 EEM model is for mobile devices to communicate with hosts using
325 ethernet over USB. For Linux gadgets, however, the interface with
326 the host is the same (a usbX device), so the differences are minimal.
327
Andrzej Pietrasiewicz83408742013-05-23 10:51:15 +0200328config USB_CONFIGFS_PHONET
Christoph Jaeger6341e622014-12-20 15:41:11 -0500329 bool "Phonet protocol"
Andrzej Pietrasiewicz83408742013-05-23 10:51:15 +0200330 depends on USB_CONFIGFS
331 depends on NET
332 depends on PHONET
333 select USB_U_ETHER
334 select USB_F_PHONET
335 help
336 The Phonet protocol implementation for USB device.
337
Andrzej Pietrasiewiczef0aa4b2013-10-09 10:06:05 +0200338config USB_CONFIGFS_MASS_STORAGE
Christoph Jaeger6341e622014-12-20 15:41:11 -0500339 bool "Mass storage"
Andrzej Pietrasiewiczef0aa4b2013-10-09 10:06:05 +0200340 depends on USB_CONFIGFS
Andrzej Pietrasiewiczbc912b02013-11-04 13:46:17 +0100341 depends on BLOCK
Andrzej Pietrasiewiczef0aa4b2013-10-09 10:06:05 +0200342 select USB_F_MASS_STORAGE
343 help
344 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
345 As its storage repository it can use a regular file or a block
346 device (in much the same way as the "loop" device driver),
347 specified as a module parameter or sysfs option.
348
Andrzej Pietrasiewicz25d80152013-11-07 08:41:28 +0100349config USB_CONFIGFS_F_LB_SS
Christoph Jaeger6341e622014-12-20 15:41:11 -0500350 bool "Loopback and sourcesink function (for testing)"
Andrzej Pietrasiewiczc0501f42013-11-07 08:41:27 +0100351 depends on USB_CONFIGFS
352 select USB_F_SS_LB
353 help
Andrzej Pietrasiewicz25d80152013-11-07 08:41:28 +0100354 Loopback function loops back a configurable number of transfers.
355 Sourcesink function either sinks and sources bulk data.
Andrzej Pietrasiewiczc0501f42013-11-07 08:41:27 +0100356 It also implements control requests, for "chapter 9" conformance.
357 Make this be the first driver you try using on top of any new
358 USB peripheral controller driver. Then you can use host-side
359 test software, like the "usbtest" driver, to put your hardware
360 and its driver through a basic set of functional tests.
361
Andrzej Pietrasiewiczb6584992013-12-03 15:15:36 +0100362config USB_CONFIGFS_F_FS
Christoph Jaeger6341e622014-12-20 15:41:11 -0500363 bool "Function filesystem (FunctionFS)"
Andrzej Pietrasiewiczb6584992013-12-03 15:15:36 +0100364 depends on USB_CONFIGFS
365 select USB_F_FS
366 help
367 The Function Filesystem (FunctionFS) lets one create USB
368 composite functions in user space in the same way GadgetFS
369 lets one create USB gadgets in user space. This allows creation
370 of composite gadgets such that some of the functions are
371 implemented in kernel space (for instance Ethernet, serial or
372 mass storage) and other are implemented in user space.
373
Andrzej Pietrasiewiczcb0a59f2014-10-16 13:16:28 +0200374config USB_CONFIGFS_F_UAC1
Christoph Jaeger6341e622014-12-20 15:41:11 -0500375 bool "Audio Class 1.0"
Andrzej Pietrasiewiczcb0a59f2014-10-16 13:16:28 +0200376 depends on USB_CONFIGFS
377 depends on SND
378 select USB_LIBCOMPOSITE
379 select SND_PCM
380 select USB_F_UAC1
381 help
382 This Audio function implements 1 AudioControl interface,
383 1 AudioStreaming Interface each for USB-OUT and USB-IN.
384 This driver requires a real Audio codec to be present
385 on the device.
386
387config USB_CONFIGFS_F_UAC2
Christoph Jaeger6341e622014-12-20 15:41:11 -0500388 bool "Audio Class 2.0"
Andrzej Pietrasiewiczcb0a59f2014-10-16 13:16:28 +0200389 depends on USB_CONFIGFS
390 depends on SND
391 select USB_LIBCOMPOSITE
392 select SND_PCM
393 select USB_F_UAC2
394 help
395 This Audio function is compatible with USB Audio Class
396 specification 2.0. It implements 1 AudioControl interface,
397 1 AudioStreaming Interface each for USB-OUT and USB-IN.
398 This driver doesn't expect any real Audio codec to be present
399 on the device - the audio streams are simply sinked to and
400 sourced from a virtual ALSA sound card created. The user-space
401 application may choose to do whatever it wants with the data
402 received from the USB Host and choose to provide whatever it
403 wants as audio data to the USB Host.
404
Andrzej Pietrasiewicz6f1de342014-10-16 13:33:31 +0200405config USB_CONFIGFS_F_MIDI
Christoph Jaeger6341e622014-12-20 15:41:11 -0500406 bool "MIDI function"
Andrzej Pietrasiewicz6f1de342014-10-16 13:33:31 +0200407 depends on USB_CONFIGFS
408 depends on SND
409 select USB_LIBCOMPOSITE
410 select SND_RAWMIDI
411 select USB_F_MIDI
412 help
413 The MIDI Function acts as a USB Audio device, with one MIDI
414 input and one MIDI output. These MIDI jacks appear as
415 a sound "card" in the ALSA sound system. Other MIDI
416 connections can then be made on the gadget system, using
417 ALSA's aconnect utility etc.
418
Andrzej Pietrasiewicz21a94762014-11-06 11:12:03 +0100419config USB_CONFIGFS_F_HID
Christoph Jaeger6341e622014-12-20 15:41:11 -0500420 bool "HID function"
Andrzej Pietrasiewicz21a94762014-11-06 11:12:03 +0100421 depends on USB_CONFIGFS
422 select USB_F_HID
423 help
424 The HID function driver provides generic emulation of USB
425 Human Interface Devices (HID).
426
427 For more information, see Documentation/usb/gadget_hid.txt.
428
Andrzej Pietrasiewicz46919a22014-12-10 12:34:02 +0100429config USB_CONFIGFS_F_UVC
Christoph Jaeger8333d3c2015-02-02 10:00:03 -0500430 bool "USB Webcam function"
Andrzej Pietrasiewicz46919a22014-12-10 12:34:02 +0100431 depends on USB_CONFIGFS
432 depends on VIDEO_DEV
433 select VIDEOBUF2_VMALLOC
434 select USB_F_UVC
435 help
436 The Webcam function acts as a composite USB Audio and Video Class
437 device. It provides a userspace API to process UVC control requests
438 and stream video data to the host.
439
Andrzej Pietrasiewiczee1cd512015-03-03 10:52:32 +0100440config USB_CONFIGFS_F_PRINTER
441 bool "Printer function"
442 select USB_F_PRINTER
Andrzej Pietrasiewiczf4b49762015-03-24 10:58:16 +0100443 depends on USB_CONFIGFS
Andrzej Pietrasiewiczee1cd512015-03-03 10:52:32 +0100444 help
445 The Printer function channels data between the USB host and a
446 userspace program driving the print engine. The user space
447 program reads and writes the device file /dev/g_printer<X> to
448 receive or send printer data. It can use ioctl calls to
449 the device file to get or set printer status.
450
451 For more information, see Documentation/usb/gadget_printer.txt
452 which includes sample code for accessing the device file.
453
Andrzej Pietrasiewicz8443f2d2014-07-15 13:09:44 +0200454source "drivers/usb/gadget/legacy/Kconfig"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
456endchoice
457
Denis Chengb75be4a2008-01-24 16:36:31 +0800458endif # USB_GADGET