1#
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).
10#  - Some systems have both kinds of controllers.
11#
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#
15
16menuconfig USB_GADGET
17	tristate "USB Gadget Support"
18	select NLS
19	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
29	   familiar host side controllers have names like "EHCI", "OHCI",
30	   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
45if USB_GADGET
46
47config USB_GADGET_DEBUG
48	boolean "Debugging messages (DEVELOPMENT)"
49	depends on DEBUG_KERNEL
50	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
61config 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
75config USB_GADGET_DEBUG_FILES
76	boolean "Debugging information files (DEVELOPMENT)"
77	depends on PROC_FS
78	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
86config USB_GADGET_DEBUG_FS
87	boolean "Debugging information files in debugfs (DEVELOPMENT)"
88	depends on DEBUG_FS
89	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
97config 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
114config 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
130source "drivers/usb/gadget/udc/Kconfig"
131
132#
133# USB Gadget Drivers
134#
135
136# composite based drivers
137config USB_LIBCOMPOSITE
138	tristate
139	select CONFIGFS_FS
140	depends on USB_GADGET
141
142config USB_F_ACM
143	tristate
144
145config USB_F_SS_LB
146	tristate
147
148config USB_U_SERIAL
149	tristate
150
151config USB_U_ETHER
152	tristate
153
154config USB_F_SERIAL
155	tristate
156
157config USB_F_OBEX
158	tristate
159
160config USB_F_NCM
161	tristate
162
163config USB_F_ECM
164	tristate
165
166config USB_F_PHONET
167	tristate
168
169config USB_F_EEM
170	tristate
171
172config USB_F_SUBSET
173	tristate
174
175config USB_F_RNDIS
176	tristate
177
178config USB_F_MASS_STORAGE
179	tristate
180
181config USB_F_FS
182	tristate
183
184config USB_F_UAC1
185	tristate
186 
187config USB_F_UAC2
188	tristate
189
190config USB_F_UVC
191	tristate
192
193config USB_F_MTP
194	tristate
195
196config USB_F_PTP
197        tristate
198
199config USB_F_AUDIO_SRC
200	tristate
201
202config USB_F_ACC
203	tristate
204
205config USB_F_MIDI
206	tristate
207
208choice
209	tristate "USB Gadget Drivers"
210	default USB_ETH
211	help
212	  A Linux "Gadget Driver" talks to the USB Peripheral Controller
213	  driver through the abstract "gadget" API.  Some other operating
214	  systems call these "client" drivers, of which "class drivers"
215	  are a subset (implementing a USB device class specification).
216	  A gadget driver implements one or more USB functions using
217	  the peripheral hardware.
218
219	  Gadget drivers are hardware-neutral, or "platform independent",
220	  except that they sometimes must understand quirks or limitations
221	  of the particular controllers they work with.  For example, when
222	  a controller doesn't support alternate configurations or provide
223	  enough of the right types of endpoints, the gadget driver might
224	  not be able work with that controller, or might need to implement
225	  a less common variant of a device class protocol.
226
227# this first set of drivers all depend on bulk-capable hardware.
228
229config USB_CONFIGFS
230	tristate "USB functions configurable through configfs"
231	select USB_LIBCOMPOSITE
232	help
233	  A Linux USB "gadget" can be set up through configfs.
234	  If this is the case, the USB functions (which from the host's
235	  perspective are seen as interfaces) and configurations are
236	  specified simply by creating appropriate directories in configfs.
237	  Associating functions with configurations is done by creating
238	  appropriate symbolic links.
239	  For more information see Documentation/usb/gadget_configfs.txt.
240
241config USB_CONFIGFS_SERIAL
242	boolean "Generic serial bulk in/out"
243	depends on USB_CONFIGFS
244	depends on TTY
245	select USB_U_SERIAL
246	select USB_F_SERIAL
247	help
248	  The function talks to the Linux-USB generic serial driver.
249
250config USB_CONFIGFS_ACM
251	boolean "Abstract Control Model (CDC ACM)"
252	depends on USB_CONFIGFS
253	depends on TTY
254	select USB_U_SERIAL
255	select USB_F_ACM
256	help
257	  ACM serial link.  This function can be used to interoperate with
258	  MS-Windows hosts or with the Linux-USB "cdc-acm" driver.
259
260config USB_CONFIGFS_OBEX
261	boolean "Object Exchange Model (CDC OBEX)"
262	depends on USB_CONFIGFS
263	depends on TTY
264	select USB_U_SERIAL
265	select USB_F_OBEX
266	help
267	  You will need a user space OBEX server talking to /dev/ttyGS*,
268	  since the kernel itself doesn't implement the OBEX protocol.
269
270config USB_CONFIGFS_NCM
271	boolean "Network Control Model (CDC NCM)"
272	depends on USB_CONFIGFS
273	depends on NET
274	select USB_U_ETHER
275	select USB_F_NCM
276	help
277	  NCM is an advanced protocol for Ethernet encapsulation, allows
278	  grouping of several ethernet frames into one USB transfer and
279	  different alignment possibilities.
280
281config USB_CONFIGFS_ECM
282	boolean "Ethernet Control Model (CDC ECM)"
283	depends on USB_CONFIGFS
284	depends on NET
285	select USB_U_ETHER
286	select USB_F_ECM
287	help
288	  The "Communication Device Class" (CDC) Ethernet Control Model.
289	  That protocol is often avoided with pure Ethernet adapters, in
290	  favor of simpler vendor-specific hardware, but is widely
291	  supported by firmware for smart network devices.
292
293config USB_CONFIGFS_ECM_SUBSET
294	boolean "Ethernet Control Model (CDC ECM) subset"
295	depends on USB_CONFIGFS
296	depends on NET
297	select USB_U_ETHER
298	select USB_F_SUBSET
299	help
300	  On hardware that can't implement the full protocol,
301	  a simple CDC subset is used, placing fewer demands on USB.
302
303config USB_CONFIGFS_RNDIS
304	bool "RNDIS"
305	depends on USB_CONFIGFS
306	depends on NET
307	select USB_U_ETHER
308	select USB_F_RNDIS
309	help
310	   Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
311	   and Microsoft provides redistributable binary RNDIS drivers for
312	   older versions of Windows.
313
314	   To make MS-Windows work with this, use Documentation/usb/linux.inf
315	   as the "driver info file".  For versions of MS-Windows older than
316	   XP, you'll need to download drivers from Microsoft's website; a URL
317	   is given in comments found in that info file.
318
319config USB_CONFIGFS_EEM
320	bool "Ethernet Emulation Model (EEM)"
321	depends on USB_CONFIGFS
322	depends on NET
323	select USB_U_ETHER
324	select USB_F_EEM
325	help
326	  CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
327	  and therefore can be supported by more hardware.  Technically ECM and
328	  EEM are designed for different applications.  The ECM model extends
329	  the network interface to the target (e.g. a USB cable modem), and the
330	  EEM model is for mobile devices to communicate with hosts using
331	  ethernet over USB.  For Linux gadgets, however, the interface with
332	  the host is the same (a usbX device), so the differences are minimal.
333
334config USB_CONFIGFS_PHONET
335	boolean "Phonet protocol"
336	depends on USB_CONFIGFS
337	depends on NET
338	depends on PHONET
339	select USB_U_ETHER
340	select USB_F_PHONET
341	help
342	  The Phonet protocol implementation for USB device.
343
344config USB_CONFIGFS_MASS_STORAGE
345	boolean "Mass storage"
346	depends on USB_CONFIGFS
347	depends on BLOCK
348	select USB_F_MASS_STORAGE
349	help
350	  The Mass Storage Gadget acts as a USB Mass Storage disk drive.
351	  As its storage repository it can use a regular file or a block
352	  device (in much the same way as the "loop" device driver),
353	  specified as a module parameter or sysfs option.
354
355config USB_CONFIGFS_F_LB_SS
356	boolean "Loopback and sourcesink function (for testing)"
357	depends on USB_CONFIGFS
358	select USB_F_SS_LB
359	help
360	  Loopback function loops back a configurable number of transfers.
361	  Sourcesink function either sinks and sources bulk data.
362	  It also implements control requests, for "chapter 9" conformance.
363	  Make this be the first driver you try using on top of any new
364	  USB peripheral controller driver.  Then you can use host-side
365	  test software, like the "usbtest" driver, to put your hardware
366	  and its driver through a basic set of functional tests.
367
368config USB_CONFIGFS_F_FS
369	boolean "Function filesystem (FunctionFS)"
370	depends on USB_CONFIGFS
371	select USB_F_FS
372	help
373	  The Function Filesystem (FunctionFS) lets one create USB
374	  composite functions in user space in the same way GadgetFS
375	  lets one create USB gadgets in user space.  This allows creation
376	  of composite gadgets such that some of the functions are
377	  implemented in kernel space (for instance Ethernet, serial or
378	  mass storage) and other are implemented in user space.
379
380config USB_CONFIGFS_F_MTP
381        boolean "MTP gadget"
382        depends on USB_CONFIGFS
383        select USB_F_MTP
384        help
385          USB gadget MTP support
386
387config USB_CONFIGFS_F_PTP
388        boolean "PTP gadget"
389        depends on USB_CONFIGFS && USB_CONFIGFS_F_MTP
390        select USB_F_PTP
391        help
392          USB gadget PTP support
393
394config USB_CONFIGFS_F_ACC
395	boolean "Accessory gadget"
396	depends on USB_CONFIGFS
397	select USB_F_ACC
398	help
399	  USB gadget Accessory support
400
401config USB_CONFIGFS_F_AUDIO_SRC
402	boolean "Audio Source gadget"
403	depends on USB_CONFIGFS && USB_CONFIGFS_F_ACC
404	select USB_F_AUDIO_SRC
405	help
406	  USB gadget Audio Source support
407
408config USB_CONFIGFS_UEVENT
409	boolean "Uevent notification of Gadget state"
410	depends on USB_CONFIGFS
411	help
412	  Enable uevent notifications to userspace when the gadget
413	  state changes. The gadget can be in any of the following
414	  three states: "CONNECTED/DISCONNECTED/CONFIGURED"
415
416config USB_G_ANDROID
417	boolean "Android Composite Gadget"
418	select USB_F_ACM
419	select USB_LIBCOMPOSITE
420	select USB_U_SERIAL
421	help
422	  The Android Composite Gadget supports multiple USB
423	  functions: adb, acm, mass storage, mtp, accessory
424	  and rndis.
425	  Each function can be configured and enabled/disabled
426	  dynamically from userspace through a sysfs interface.
427
428config USB_ANDROID_RNDIS_DWORD_ALIGNED
429	boolean "Use double word aligned"
430	depends on USB_G_ANDROID
431	help
432		Provides dword aligned for DMA controller.
433
434config USB_CONFIGFS_F_MIDI
435	boolean "MIDI function"
436	depends on USB_CONFIGFS
437	depends on SND
438	select USB_LIBCOMPOSITE
439	select SND_RAWMIDI
440	select USB_F_MIDI
441	help
442	  The MIDI Function acts as a USB Audio device, with one MIDI
443	  input and one MIDI output. These MIDI jacks appear as
444	  a sound "card" in the ALSA sound system. Other MIDI
445	  connections can then be made on the gadget system, using
446	  ALSA's aconnect utility etc.
447
448source "drivers/usb/gadget/legacy/Kconfig"
449
450endchoice
451
452endif # USB_GADGET
453