Version:  2.0.40 2.2.26 2.4.37 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18

Linux/drivers/usb/gadget/Kconfig

  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 
 16 menuconfig 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 
 45 if USB_GADGET
 46 
 47 config 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 
 61 config 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 
 75 config 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 
 86 config 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 
 97 config 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 
114 config 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 
130 source "drivers/usb/gadget/udc/Kconfig"
131 
132 #
133 # USB Gadget Drivers
134 #
135 
136 # composite based drivers
137 config USB_LIBCOMPOSITE
138         tristate
139         select CONFIGFS_FS
140         depends on USB_GADGET
141 
142 config USB_F_ACM
143         tristate
144 
145 config USB_F_SS_LB
146         tristate
147 
148 config USB_U_SERIAL
149         tristate
150 
151 config USB_U_ETHER
152         tristate
153 
154 config USB_F_SERIAL
155         tristate
156 
157 config USB_F_OBEX
158         tristate
159 
160 config USB_F_NCM
161         tristate
162 
163 config USB_F_ECM
164         tristate
165 
166 config USB_F_PHONET
167         tristate
168 
169 config USB_F_EEM
170         tristate
171 
172 config USB_F_SUBSET
173         tristate
174 
175 config USB_F_RNDIS
176         tristate
177 
178 config USB_F_MASS_STORAGE
179         tristate
180 
181 config USB_F_FS
182         tristate
183 
184 config USB_F_UAC1
185         tristate
186 
187 config USB_F_UAC2
188         tristate
189 
190 config USB_F_UVC
191         tristate
192 
193 choice
194         tristate "USB Gadget Drivers"
195         default USB_ETH
196         help
197           A Linux "Gadget Driver" talks to the USB Peripheral Controller
198           driver through the abstract "gadget" API.  Some other operating
199           systems call these "client" drivers, of which "class drivers"
200           are a subset (implementing a USB device class specification).
201           A gadget driver implements one or more USB functions using
202           the peripheral hardware.
203 
204           Gadget drivers are hardware-neutral, or "platform independent",
205           except that they sometimes must understand quirks or limitations
206           of the particular controllers they work with.  For example, when
207           a controller doesn't support alternate configurations or provide
208           enough of the right types of endpoints, the gadget driver might
209           not be able work with that controller, or might need to implement
210           a less common variant of a device class protocol.
211 
212 # this first set of drivers all depend on bulk-capable hardware.
213 
214 config USB_CONFIGFS
215         tristate "USB functions configurable through configfs"
216         select USB_LIBCOMPOSITE
217         help
218           A Linux USB "gadget" can be set up through configfs.
219           If this is the case, the USB functions (which from the host's
220           perspective are seen as interfaces) and configurations are
221           specified simply by creating appropriate directories in configfs.
222           Associating functions with configurations is done by creating
223           appropriate symbolic links.
224           For more information see Documentation/usb/gadget_configfs.txt.
225 
226 config USB_CONFIGFS_SERIAL
227         boolean "Generic serial bulk in/out"
228         depends on USB_CONFIGFS
229         depends on TTY
230         select USB_U_SERIAL
231         select USB_F_SERIAL
232         help
233           The function talks to the Linux-USB generic serial driver.
234 
235 config USB_CONFIGFS_ACM
236         boolean "Abstract Control Model (CDC ACM)"
237         depends on USB_CONFIGFS
238         depends on TTY
239         select USB_U_SERIAL
240         select USB_F_ACM
241         help
242           ACM serial link.  This function can be used to interoperate with
243           MS-Windows hosts or with the Linux-USB "cdc-acm" driver.
244 
245 config USB_CONFIGFS_OBEX
246         boolean "Object Exchange Model (CDC OBEX)"
247         depends on USB_CONFIGFS
248         depends on TTY
249         select USB_U_SERIAL
250         select USB_F_OBEX
251         help
252           You will need a user space OBEX server talking to /dev/ttyGS*,
253           since the kernel itself doesn't implement the OBEX protocol.
254 
255 config USB_CONFIGFS_NCM
256         boolean "Network Control Model (CDC NCM)"
257         depends on USB_CONFIGFS
258         depends on NET
259         select USB_U_ETHER
260         select USB_F_NCM
261         help
262           NCM is an advanced protocol for Ethernet encapsulation, allows
263           grouping of several ethernet frames into one USB transfer and
264           different alignment possibilities.
265 
266 config USB_CONFIGFS_ECM
267         boolean "Ethernet Control Model (CDC ECM)"
268         depends on USB_CONFIGFS
269         depends on NET
270         select USB_U_ETHER
271         select USB_F_ECM
272         help
273           The "Communication Device Class" (CDC) Ethernet Control Model.
274           That protocol is often avoided with pure Ethernet adapters, in
275           favor of simpler vendor-specific hardware, but is widely
276           supported by firmware for smart network devices.
277 
278 config USB_CONFIGFS_ECM_SUBSET
279         boolean "Ethernet Control Model (CDC ECM) subset"
280         depends on USB_CONFIGFS
281         depends on NET
282         select USB_U_ETHER
283         select USB_F_SUBSET
284         help
285           On hardware that can't implement the full protocol,
286           a simple CDC subset is used, placing fewer demands on USB.
287 
288 config USB_CONFIGFS_RNDIS
289         bool "RNDIS"
290         depends on USB_CONFIGFS
291         depends on NET
292         select USB_U_ETHER
293         select USB_F_RNDIS
294         help
295            Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
296            and Microsoft provides redistributable binary RNDIS drivers for
297            older versions of Windows.
298 
299            To make MS-Windows work with this, use Documentation/usb/linux.inf
300            as the "driver info file".  For versions of MS-Windows older than
301            XP, you'll need to download drivers from Microsoft's website; a URL
302            is given in comments found in that info file.
303 
304 config USB_CONFIGFS_EEM
305         bool "Ethernet Emulation Model (EEM)"
306         depends on USB_CONFIGFS
307         depends on NET
308         select USB_U_ETHER
309         select USB_F_EEM
310         help
311           CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
312           and therefore can be supported by more hardware.  Technically ECM and
313           EEM are designed for different applications.  The ECM model extends
314           the network interface to the target (e.g. a USB cable modem), and the
315           EEM model is for mobile devices to communicate with hosts using
316           ethernet over USB.  For Linux gadgets, however, the interface with
317           the host is the same (a usbX device), so the differences are minimal.
318 
319 config USB_CONFIGFS_PHONET
320         boolean "Phonet protocol"
321         depends on USB_CONFIGFS
322         depends on NET
323         depends on PHONET
324         select USB_U_ETHER
325         select USB_F_PHONET
326         help
327           The Phonet protocol implementation for USB device.
328 
329 config USB_CONFIGFS_MASS_STORAGE
330         boolean "Mass storage"
331         depends on USB_CONFIGFS
332         depends on BLOCK
333         select USB_F_MASS_STORAGE
334         help
335           The Mass Storage Gadget acts as a USB Mass Storage disk drive.
336           As its storage repository it can use a regular file or a block
337           device (in much the same way as the "loop" device driver),
338           specified as a module parameter or sysfs option.
339 
340 config USB_CONFIGFS_F_LB_SS
341         boolean "Loopback and sourcesink function (for testing)"
342         depends on USB_CONFIGFS
343         select USB_F_SS_LB
344         help
345           Loopback function loops back a configurable number of transfers.
346           Sourcesink function either sinks and sources bulk data.
347           It also implements control requests, for "chapter 9" conformance.
348           Make this be the first driver you try using on top of any new
349           USB peripheral controller driver.  Then you can use host-side
350           test software, like the "usbtest" driver, to put your hardware
351           and its driver through a basic set of functional tests.
352 
353 config USB_CONFIGFS_F_FS
354         boolean "Function filesystem (FunctionFS)"
355         depends on USB_CONFIGFS
356         select USB_F_FS
357         help
358           The Function Filesystem (FunctionFS) lets one create USB
359           composite functions in user space in the same way GadgetFS
360           lets one create USB gadgets in user space.  This allows creation
361           of composite gadgets such that some of the functions are
362           implemented in kernel space (for instance Ethernet, serial or
363           mass storage) and other are implemented in user space.
364 
365 source "drivers/usb/gadget/legacy/Kconfig"
366 
367 endchoice
368 
369 endif # USB_GADGET

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us