sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget)/translations/zh_CN/driver-api/usb/gadgetmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget)/translations/zh_TW/driver-api/usb/gadgetmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget)/translations/it_IT/driver-api/usb/gadgetmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget)/translations/ja_JP/driver-api/usb/gadgetmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget)/translations/ko_KR/driver-api/usb/gadgetmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget)/translations/pt_BR/driver-api/usb/gadgetmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget)/translations/sp_SP/driver-api/usb/gadgetmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(hUSB Gadget API for Linuxh]hUSB Gadget API for Linux}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhC/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget.rsthKubh field_list)}(hhh](hfield)}(hhh](h field_name)}(hAuthorh]hAuthor}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhKubh field_body)}(hDavid Brownellh]h paragraph)}(hhh]hDavid Brownell}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhubah}(h]h ]h"]h$]h&]uh1hhhubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(hDateh]hDate}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhKubh)}(h20 August 2004 h]h)}(h20 August 2004h]h20 August 2004}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubeh}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Introductionh]h Introduction}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;hhhhhK ubh)}(hXKThis document presents a Linux-USB "Gadget" kernel mode API, for use within peripherals and other USB devices that embed Linux. It provides an overview of the API structure, and shows how that fits into a system development project. This is the first such API released on Linux to address a number of important problems, including:h]hXOThis document presents a Linux-USB “Gadget” kernel mode API, for use within peripherals and other USB devices that embed Linux. It provides an overview of the API structure, and shows how that fits into a system development project. This is the first such API released on Linux to address a number of important problems, including:}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hj;hhubh bullet_list)}(hhh](h list_item)}(hfSupports USB 2.0, for high speed devices which can stream data at several dozen megabytes per second. h]h)}(heSupports USB 2.0, for high speed devices which can stream data at several dozen megabytes per second.h]heSupports USB 2.0, for high speed devices which can stream data at several dozen megabytes per second.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjaubah}(h]h ]h"]h$]h&]uh1j_hj\hhhhhNubj`)}(hHandles devices with dozens of endpoints just as well as ones with just two fixed-function ones. Gadget drivers can be written so they're easy to port to new hardware. h]h)}(hHandles devices with dozens of endpoints just as well as ones with just two fixed-function ones. Gadget drivers can be written so they're easy to port to new hardware.h]hHandles devices with dozens of endpoints just as well as ones with just two fixed-function ones. Gadget drivers can be written so they’re easy to port to new hardware.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjyubah}(h]h ]h"]h$]h&]uh1j_hj\hhhhhNubj`)}(hFlexible enough to expose more complex USB device capabilities such as multiple configurations, multiple interfaces, composite devices, and alternate interface settings. h]h)}(hFlexible enough to expose more complex USB device capabilities such as multiple configurations, multiple interfaces, composite devices, and alternate interface settings.h]hFlexible enough to expose more complex USB device capabilities such as multiple configurations, multiple interfaces, composite devices, and alternate interface settings.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hj\hhhhhNubj`)}(hWUSB "On-The-Go" (OTG) support, in conjunction with updates to the Linux-USB host side. h]h)}(hVUSB "On-The-Go" (OTG) support, in conjunction with updates to the Linux-USB host side.h]hZUSB “On-The-Go” (OTG) support, in conjunction with updates to the Linux-USB host side.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hj\hhhhhNubj`)}(hSharing data structures and API models with the Linux-USB host side API. This helps the OTG support, and looks forward to more-symmetric frameworks (where the same I/O model is used by both host and device side drivers). h]h)}(hSharing data structures and API models with the Linux-USB host side API. This helps the OTG support, and looks forward to more-symmetric frameworks (where the same I/O model is used by both host and device side drivers).h]hSharing data structures and API models with the Linux-USB host side API. This helps the OTG support, and looks forward to more-symmetric frameworks (where the same I/O model is used by both host and device side drivers).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hj\hhhhhNubj`)}(hMinimalist, so it's easier to support new device controller hardware. I/O processing doesn't imply large demands for memory or CPU resources. h]h)}(hMinimalist, so it's easier to support new device controller hardware. I/O processing doesn't imply large demands for memory or CPU resources.h]hMinimalist, so it’s easier to support new device controller hardware. I/O processing doesn’t imply large demands for memory or CPU resources.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK$hjubah}(h]h ]h"]h$]h&]uh1j_hj\hhhhhNubeh}(h]h ]h"]h$]h&]bullet-uh1jZhhhKhj;hhubh)}(hXSMost Linux developers will not be able to use this API, since they have USB ``host`` hardware in a PC, workstation, or server. Linux users with embedded systems are more likely to have USB peripheral hardware. To distinguish drivers running inside such hardware from the more familiar Linux "USB device drivers", which are host side proxies for the real USB devices, a different term is used: the drivers inside the peripherals are "USB gadget drivers". In USB protocol interactions, the device driver is the master (or "client driver") and the gadget driver is the slave (or "function driver").h](hLMost Linux developers will not be able to use this API, since they have USB }(hjhhhNhNubhliteral)}(h``host``h]hhost}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX hardware in a PC, workstation, or server. Linux users with embedded systems are more likely to have USB peripheral hardware. To distinguish drivers running inside such hardware from the more familiar Linux “USB device drivers”, which are host side proxies for the real USB devices, a different term is used: the drivers inside the peripherals are “USB gadget drivers”. In USB protocol interactions, the device driver is the master (or “client driver”) and the gadget driver is the slave (or “function driver”).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK(hj;hhubh)}(hXThe gadget API resembles the host side Linux-USB API in that both use queues of request objects to package I/O buffers, and those requests may be submitted or canceled. They share common definitions for the standard USB *Chapter 9* messages, structures, and constants. Also, both APIs bind and unbind drivers to devices. The APIs differ in detail, since the host side's current URB framework exposes a number of implementation details and assumptions that are inappropriate for a gadget API. While the model for control transfers and configuration management is necessarily different (one side is a hardware-neutral master, the other is a hardware-aware slave), the endpoint I/0 API used here should also be usable for an overhead-reduced host side API.h](hThe gadget API resembles the host side Linux-USB API in that both use queues of request objects to package I/O buffers, and those requests may be submitted or canceled. They share common definitions for the standard USB }(hjhhhNhNubhemphasis)}(h *Chapter 9*h]h Chapter 9}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubhX  messages, structures, and constants. Also, both APIs bind and unbind drivers to devices. The APIs differ in detail, since the host side’s current URB framework exposes a number of implementation details and assumptions that are inappropriate for a gadget API. While the model for control transfers and configuration management is necessarily different (one side is a hardware-neutral master, the other is a hardware-aware slave), the endpoint I/0 API used here should also be usable for an overhead-reduced host side API.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK2hj;hhubeh}(h] introductionah ]h"] introductionah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hStructure of Gadget Driversh]hStructure of Gadget Drivers}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjEhhhhhK?ubh)}(hX'A system running inside a USB peripheral normally has at least three layers inside the kernel to handle USB protocol processing, and may have additional layers in user space code. The ``gadget`` API is used by the middle layer to interact with the lowest level (which directly handles hardware).h](hA system running inside a USB peripheral normally has at least three layers inside the kernel to handle USB protocol processing, and may have additional layers in user space code. The }(hjVhhhNhNubj)}(h ``gadget``h]hgadget}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjVubhe API is used by the middle layer to interact with the lowest level (which directly handles hardware).}(hjVhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKAhjEhhubh)}(h/In Linux, from the bottom up, these layers are:h]h/In Linux, from the bottom up, these layers are:}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKGhjEhhubhdefinition_list)}(hhh](hdefinition_list_item)}(hX*USB Controller Driver* This is the lowest software level. It is the only layer that talks to hardware, through registers, fifos, dma, irqs, and the like. The ```` API abstracts the peripheral controller endpoint hardware. That hardware is exposed through endpoint objects, which accept streams of IN/OUT buffers, and through callbacks that interact with gadget drivers. Since normal USB devices only have one upstream port, they only have one of these drivers. The controller driver can support any number of different gadget drivers, but only one of them can be used at a time. Examples of such controller hardware include the PCI-based NetChip 2280 USB 2.0 high speed controller, the SA-11x0 or PXA-25x UDC (found within many PDAs), and a variety of other products. h](hterm)}(h*USB Controller Driver*h]j$)}(hjh]hUSB Controller Driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubah}(h]h ]h"]h$]h&]uh1jhhhKVhjubh definition)}(hhh](h)}(hX?This is the lowest software level. It is the only layer that talks to hardware, through registers, fifos, dma, irqs, and the like. The ```` API abstracts the peripheral controller endpoint hardware. That hardware is exposed through endpoint objects, which accept streams of IN/OUT buffers, and through callbacks that interact with gadget drivers. Since normal USB devices only have one upstream port, they only have one of these drivers. The controller driver can support any number of different gadget drivers, but only one of them can be used at a time.h](hThis is the lowest software level. It is the only layer that talks to hardware, through registers, fifos, dma, irqs, and the like. The }(hjhhhNhNubj)}(h````h]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX API abstracts the peripheral controller endpoint hardware. That hardware is exposed through endpoint objects, which accept streams of IN/OUT buffers, and through callbacks that interact with gadget drivers. Since normal USB devices only have one upstream port, they only have one of these drivers. The controller driver can support any number of different gadget drivers, but only one of them can be used at a time.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKJhjubh)}(hExamples of such controller hardware include the PCI-based NetChip 2280 USB 2.0 high speed controller, the SA-11x0 or PXA-25x UDC (found within many PDAs), and a variety of other products.h]hExamples of such controller hardware include the PCI-based NetChip 2280 USB 2.0 high speed controller, the SA-11x0 or PXA-25x UDC (found within many PDAs), and a variety of other products.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKThjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKVhjubj)}(hX*Gadget Driver* The lower boundary of this driver implements hardware-neutral USB functions, using calls to the controller driver. Because such hardware varies widely in capabilities and restrictions, and is used in embedded environments where space is at a premium, the gadget driver is often configured at compile time to work with endpoints supported by one particular controller. Gadget drivers may be portable to several different controllers, using conditional compilation. (Recent kernels substantially simplify the work involved in supporting new hardware, by *autoconfiguring* endpoints automatically for many bulk-oriented drivers.) Gadget driver responsibilities include: - handling setup requests (ep0 protocol responses) possibly including class-specific functionality - returning configuration and string descriptors - (re)setting configurations and interface altsettings, including enabling and configuring endpoints - handling life cycle events, such as managing bindings to hardware, USB suspend/resume, remote wakeup, and disconnection from the USB host. - managing IN and OUT transfers on all currently enabled endpoints Such drivers may be modules of proprietary code, although that approach is discouraged in the Linux community. h](j)}(h*Gadget Driver*h]j$)}(hjh]h Gadget Driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubah}(h]h ]h"]h$]h&]uh1jhhhKthjubj)}(hhh](h)}(hXThe lower boundary of this driver implements hardware-neutral USB functions, using calls to the controller driver. Because such hardware varies widely in capabilities and restrictions, and is used in embedded environments where space is at a premium, the gadget driver is often configured at compile time to work with endpoints supported by one particular controller. Gadget drivers may be portable to several different controllers, using conditional compilation. (Recent kernels substantially simplify the work involved in supporting new hardware, by *autoconfiguring* endpoints automatically for many bulk-oriented drivers.) Gadget driver responsibilities include:h](hX(The lower boundary of this driver implements hardware-neutral USB functions, using calls to the controller driver. Because such hardware varies widely in capabilities and restrictions, and is used in embedded environments where space is at a premium, the gadget driver is often configured at compile time to work with endpoints supported by one particular controller. Gadget drivers may be portable to several different controllers, using conditional compilation. (Recent kernels substantially simplify the work involved in supporting new hardware, by }(hjhhhNhNubj$)}(h*autoconfiguring*h]hautoconfiguring}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubha endpoints automatically for many bulk-oriented drivers.) Gadget driver responsibilities include:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKYhjubj[)}(hhh](j`)}(hahandling setup requests (ep0 protocol responses) possibly including class-specific functionality h]h)}(h`handling setup requests (ep0 protocol responses) possibly including class-specific functionalityh]h`handling setup requests (ep0 protocol responses) possibly including class-specific functionality}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKehj(ubah}(h]h ]h"]h$]h&]uh1j_hj%ubj`)}(h/returning configuration and string descriptors h]h)}(h.returning configuration and string descriptorsh]h.returning configuration and string descriptors}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhj@ubah}(h]h ]h"]h$]h&]uh1j_hj%ubj`)}(hc(re)setting configurations and interface altsettings, including enabling and configuring endpoints h]h)}(hb(re)setting configurations and interface altsettings, including enabling and configuring endpointsh]hb(re)setting configurations and interface altsettings, including enabling and configuring endpoints}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKjhjXubah}(h]h ]h"]h$]h&]uh1j_hj%ubj`)}(hhandling life cycle events, such as managing bindings to hardware, USB suspend/resume, remote wakeup, and disconnection from the USB host. h]h)}(hhandling life cycle events, such as managing bindings to hardware, USB suspend/resume, remote wakeup, and disconnection from the USB host.h]hhandling life cycle events, such as managing bindings to hardware, USB suspend/resume, remote wakeup, and disconnection from the USB host.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKmhjpubah}(h]h ]h"]h$]h&]uh1j_hj%ubj`)}(hAmanaging IN and OUT transfers on all currently enabled endpoints h]h)}(h@managing IN and OUT transfers on all currently enabled endpointsh]h@managing IN and OUT transfers on all currently enabled endpoints}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKqhjubah}(h]h ]h"]h$]h&]uh1j_hj%ubeh}(h]h ]h"]h$]h&]jjuh1jZhhhKehjubh)}(hnSuch drivers may be modules of proprietary code, although that approach is discouraged in the Linux community.h]hnSuch drivers may be modules of proprietary code, although that approach is discouraged in the Linux community.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKshjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKthjhhubj)}(hX*Upper Level* Most gadget drivers have an upper boundary that connects to some Linux driver or framework in Linux. Through that boundary flows the data which the gadget driver produces and/or consumes through protocol transfers over USB. Examples include: - user mode code, using generic (gadgetfs) or application specific files in ``/dev`` - networking subsystem (for network gadgets, like the CDC Ethernet Model gadget driver) - data capture drivers, perhaps video4Linux or a scanner driver; or test and measurement hardware. - input subsystem (for HID gadgets) - sound subsystem (for audio gadgets) - file system (for PTP gadgets) - block i/o subsystem (for usb-storage gadgets) - ... and more h](j)}(h *Upper Level*h]j$)}(hjh]h Upper Level}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh](h)}(hMost gadget drivers have an upper boundary that connects to some Linux driver or framework in Linux. Through that boundary flows the data which the gadget driver produces and/or consumes through protocol transfers over USB. Examples include:h]hMost gadget drivers have an upper boundary that connects to some Linux driver or framework in Linux. Through that boundary flows the data which the gadget driver produces and/or consumes through protocol transfers over USB. Examples include:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKwhjubj[)}(hhh](j`)}(hSuser mode code, using generic (gadgetfs) or application specific files in ``/dev`` h]h)}(hRuser mode code, using generic (gadgetfs) or application specific files in ``/dev``h](hJuser mode code, using generic (gadgetfs) or application specific files in }(hjhhhNhNubj)}(h``/dev``h]h/dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1hhhhK|hjubah}(h]h ]h"]h$]h&]uh1j_hjubj`)}(hVnetworking subsystem (for network gadgets, like the CDC Ethernet Model gadget driver) h]h)}(hUnetworking subsystem (for network gadgets, like the CDC Ethernet Model gadget driver)h]hUnetworking subsystem (for network gadgets, like the CDC Ethernet Model gadget driver)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubj`)}(hadata capture drivers, perhaps video4Linux or a scanner driver; or test and measurement hardware. h]h)}(h`data capture drivers, perhaps video4Linux or a scanner driver; or test and measurement hardware.h]h`data capture drivers, perhaps video4Linux or a scanner driver; or test and measurement hardware.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj-ubah}(h]h ]h"]h$]h&]uh1j_hjubj`)}(h"input subsystem (for HID gadgets) h]h)}(h!input subsystem (for HID gadgets)h]h!input subsystem (for HID gadgets)}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjEubah}(h]h ]h"]h$]h&]uh1j_hjubj`)}(h$sound subsystem (for audio gadgets) h]h)}(h#sound subsystem (for audio gadgets)h]h#sound subsystem (for audio gadgets)}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj]ubah}(h]h ]h"]h$]h&]uh1j_hjubj`)}(hfile system (for PTP gadgets) h]h)}(hfile system (for PTP gadgets)h]hfile system (for PTP gadgets)}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjuubah}(h]h ]h"]h$]h&]uh1j_hjubj`)}(h.block i/o subsystem (for usb-storage gadgets) h]h)}(h-block i/o subsystem (for usb-storage gadgets)h]h-block i/o subsystem (for usb-storage gadgets)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubj`)}(h ... and more h]h)}(h ... and moreh]h ... and more}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]jjuh1jZhhhK|hjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(hX*Additional Layers* Other layers may exist. These could include kernel layers, such as network protocol stacks, as well as user mode applications building on standard POSIX system call APIs such as ``open()``, ``close()``, ``read()`` and ``write()``. On newer systems, POSIX Async I/O calls may be an option. Such user mode code will not necessarily be subject to the GNU General Public License (GPL). h](j)}(h*Additional Layers*h]j$)}(hjh]hAdditional Layers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hX}Other layers may exist. These could include kernel layers, such as network protocol stacks, as well as user mode applications building on standard POSIX system call APIs such as ``open()``, ``close()``, ``read()`` and ``write()``. On newer systems, POSIX Async I/O calls may be an option. Such user mode code will not necessarily be subject to the GNU General Public License (GPL).h](hOther layers may exist. These could include kernel layers, such as network protocol stacks, as well as user mode applications building on standard POSIX system call APIs such as }(hjhhhNhNubj)}(h ``open()``h]hopen()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h ``close()``h]hclose()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h ``read()``h]hread()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h ``write()``h]hwrite()}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. On newer systems, POSIX Async I/O calls may be an option. Such user mode code will not necessarily be subject to the GNU General Public License (GPL).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubeh}(h]h ]h"]h$]h&]uh1jhjEhhhhhNubh)}(hXoOTG-capable systems will also need to include a standard Linux-USB host side stack, with ``usbcore``, one or more *Host Controller Drivers* (HCDs), *USB Device Drivers* to support the OTG "Targeted Peripheral List", and so forth. There will also be an *OTG Controller Driver*, which is visible to gadget and device driver developers only indirectly. That helps the host and device side USB controllers implement the two new OTG protocols (HNP and SRP). Roles switch (host to peripheral, or vice versa) using HNP during USB suspend processing, and SRP can be viewed as a more battery-friendly kind of device wakeup protocol.h](hYOTG-capable systems will also need to include a standard Linux-USB host side stack, with }(hjUhhhNhNubj)}(h ``usbcore``h]husbcore}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubh, one or more }(hjUhhhNhNubj$)}(h*Host Controller Drivers*h]hHost Controller Drivers}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjUubh (HCDs), }(hjUhhhNhNubj$)}(h*USB Device Drivers*h]hUSB Device Drivers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjUubhX to support the OTG “Targeted Peripheral List”, and so forth. There will also be an }(hjUhhhNhNubj$)}(h*OTG Controller Driver*h]hOTG Controller Driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjUubhX\, which is visible to gadget and device driver developers only indirectly. That helps the host and device side USB controllers implement the two new OTG protocols (HNP and SRP). Roles switch (host to peripheral, or vice versa) using HNP during USB suspend processing, and SRP can be viewed as a more battery-friendly kind of device wakeup protocol.}(hjUhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjEhhubh)}(hXOver time, reusable utilities are evolving to help make some gadget driver tasks simpler. For example, building configuration descriptors from vectors of descriptors for the configurations interfaces and endpoints is now automated, and many drivers now use autoconfiguration to choose hardware endpoints and initialize their descriptors. A potential example of particular interest is code implementing standard USB-IF protocols for HID, networking, storage, or audio classes. Some developers are interested in KDB or KGDB hooks, to let target hardware be remotely debugged. Most such USB protocol code doesn't need to be hardware-specific, any more than network protocols like X11, HTTP, or NFS are. Such gadget-side interface drivers should eventually be combined, to implement composite devices.h]hXOver time, reusable utilities are evolving to help make some gadget driver tasks simpler. For example, building configuration descriptors from vectors of descriptors for the configurations interfaces and endpoints is now automated, and many drivers now use autoconfiguration to choose hardware endpoints and initialize their descriptors. A potential example of particular interest is code implementing standard USB-IF protocols for HID, networking, storage, or audio classes. Some developers are interested in KDB or KGDB hooks, to let target hardware be remotely debugged. Most such USB protocol code doesn’t need to be hardware-specific, any more than network protocols like X11, HTTP, or NFS are. Such gadget-side interface drivers should eventually be combined, to implement composite devices.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjEhhubeh}(h]structure-of-gadget-driversah ]h"]structure of gadget driversah$]h&]uh1hhhhhhhhK?ubh)}(hhh](h)}(hKernel Mode Gadget APIh]hKernel Mode Gadget API}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hXGadget drivers declare themselves through a struct :c:type:`usb_gadget_driver`, which is responsible for most parts of enumeration for a struct usb_gadget. The response to a set_configuration usually involves enabling one or more of the struct usb_ep objects exposed by the gadget, and submitting one or more struct usb_request buffers to transfer data. Understand those four data types, and their operations, and you will understand how this API works.h](h3Gadget drivers declare themselves through a struct }(hjhhhNhNubh)}(h:c:type:`usb_gadget_driver`h]j)}(hjh]husb_gadget_driver}(hjhhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocdriver-api/usb/gadget refdomainjreftypetype refexplicitrefwarn reftargetusb_gadget_driveruh1hhhhKhjubhXw, which is responsible for most parts of enumeration for a struct usb_gadget. The response to a set_configuration usually involves enabling one or more of the struct usb_ep objects exposed by the gadget, and submitting one or more struct usb_request buffers to transfer data. Understand those four data types, and their operations, and you will understand how this API works.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubhnote)}(hX;Other than the "Chapter 9" data types, most of the significant data types and functions are described here. However, some relevant information is likely omitted from what you are reading. One example of such information is endpoint autoconfiguration. You'll have to read the header file, and use example source code (such as that for "Gadget Zero"), to fully understand the API. The part of the API implementing some basic driver capabilities is specific to the version of the Linux kernel that's in use. The 2.6 and upper kernel versions include a *driver model* framework that has no analogue on earlier kernels; so those parts of the gadget API are not fully portable. (They are implemented on 2.4 kernels, but in a different way.) The driver model state is another part of this API that is ignored by the kerneldoc tools.h](h)}(hkOther than the "Chapter 9" data types, most of the significant data types and functions are described here.h]hoOther than the “Chapter 9” data types, most of the significant data types and functions are described here.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hXHowever, some relevant information is likely omitted from what you are reading. One example of such information is endpoint autoconfiguration. You'll have to read the header file, and use example source code (such as that for "Gadget Zero"), to fully understand the API.h]hXHowever, some relevant information is likely omitted from what you are reading. One example of such information is endpoint autoconfiguration. You’ll have to read the header file, and use example source code (such as that for “Gadget Zero”), to fully understand the API.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh)}(hXThe part of the API implementing some basic driver capabilities is specific to the version of the Linux kernel that's in use. The 2.6 and upper kernel versions include a *driver model* framework that has no analogue on earlier kernels; so those parts of the gadget API are not fully portable. (They are implemented on 2.4 kernels, but in a different way.) The driver model state is another part of this API that is ignored by the kerneldoc tools.h](hThe part of the API implementing some basic driver capabilities is specific to the version of the Linux kernel that’s in use. The 2.6 and upper kernel versions include a }(hj)hhhNhNubj$)}(h*driver model*h]h driver model}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1j#hj)ubhX framework that has no analogue on earlier kernels; so those parts of the gadget API are not fully portable. (They are implemented on 2.4 kernels, but in a different way.) The driver model state is another part of this API that is ignored by the kerneldoc tools.}(hj)hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1jhjhhhhhNubh)}(hX The core API does not expose every possible hardware feature, only the most widely available ones. There are significant hardware features, such as device-to-device DMA (without temporary storage in a memory buffer) that would be added using hardware-specific APIs.h]hX The core API does not expose every possible hardware feature, only the most widely available ones. There are significant hardware features, such as device-to-device DMA (without temporary storage in a memory buffer) that would be added using hardware-specific APIs.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hXGThis API allows drivers to use conditional compilation to handle endpoint capabilities of different hardware, but doesn't require that. Hardware tends to have arbitrary restrictions, relating to transfer types, addressing, packet sizes, buffering, and availability. As a rule, such differences only matter for "endpoint zero" logic that handles device configuration and management. The API supports limited run-time detection of capabilities, through naming conventions for endpoints. Many drivers will be able to at least partially autoconfigure themselves. In particular, driver init sections will often have endpoint autoconfiguration logic that scans the hardware's list of endpoints to find ones matching the driver requirements (relying on those conventions), to eliminate some of the most common reasons for conditional compilation.h]hXOThis API allows drivers to use conditional compilation to handle endpoint capabilities of different hardware, but doesn’t require that. Hardware tends to have arbitrary restrictions, relating to transfer types, addressing, packet sizes, buffering, and availability. As a rule, such differences only matter for “endpoint zero” logic that handles device configuration and management. The API supports limited run-time detection of capabilities, through naming conventions for endpoints. Many drivers will be able to at least partially autoconfigure themselves. In particular, driver init sections will often have endpoint autoconfiguration logic that scans the hardware’s list of endpoints to find ones matching the driver requirements (relying on those conventions), to eliminate some of the most common reasons for conditional compilation.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hXLike the Linux-USB host side API, this API exposes the "chunky" nature of USB messages: I/O requests are in terms of one or more "packets", and packet boundaries are visible to drivers. Compared to RS-232 serial protocols, USB resembles synchronous protocols like HDLC (N bytes per frame, multipoint addressing, host as the primary station and devices as secondary stations) more than asynchronous ones (tty style: 8 data bits per frame, no parity, one stop bit). So for example the controller drivers won't buffer two single byte writes into a single two-byte USB IN packet, although gadget drivers may do so when they implement protocols where packet boundaries (and "short packets") are not significant.h]hXLike the Linux-USB host side API, this API exposes the “chunky” nature of USB messages: I/O requests are in terms of one or more “packets”, and packet boundaries are visible to drivers. Compared to RS-232 serial protocols, USB resembles synchronous protocols like HDLC (N bytes per frame, multipoint addressing, host as the primary station and devices as secondary stations) more than asynchronous ones (tty style: 8 data bits per frame, no parity, one stop bit). So for example the controller drivers won’t buffer two single byte writes into a single two-byte USB IN packet, although gadget drivers may do so when they implement protocols where packet boundaries (and “short packets”) are not significant.}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hhh](h)}(hDriver Life Cycleh]hDriver Life Cycle}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhhhhhKubh)}(hGadget drivers make endpoint I/O requests to hardware without needing to know many details of the hardware, but driver setup/configuration code needs to handle some differences. Use the API like this:h]hGadget drivers make endpoint I/O requests to hardware without needing to know many details of the hardware, but driver setup/configuration code needs to handle some differences. Use the API like this:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjyhhubhenumerated_list)}(hhh](j`)}(hXRegister a driver for the particular device side usb controller hardware, such as the net2280 on PCI (USB 2.0), sa11x0 or pxa25x as found in Linux PDAs, and so on. At this point the device is logically in the USB ch9 initial state (``attached``), drawing no power and not usable (since it does not yet support enumeration). Any host should not see the device, since it's not activated the data line pullup used by the host to detect a device, even if VBUS power is available. h]h)}(hXRegister a driver for the particular device side usb controller hardware, such as the net2280 on PCI (USB 2.0), sa11x0 or pxa25x as found in Linux PDAs, and so on. At this point the device is logically in the USB ch9 initial state (``attached``), drawing no power and not usable (since it does not yet support enumeration). Any host should not see the device, since it's not activated the data line pullup used by the host to detect a device, even if VBUS power is available.h](hRegister a driver for the particular device side usb controller hardware, such as the net2280 on PCI (USB 2.0), sa11x0 or pxa25x as found in Linux PDAs, and so on. At this point the device is logically in the USB ch9 initial state (}(hjhhhNhNubj)}(h ``attached``h]hattached}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh), drawing no power and not usable (since it does not yet support enumeration). Any host should not see the device, since it’s not activated the data line pullup used by the host to detect a device, even if VBUS power is available.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hRegister a gadget driver that implements some higher level device function. That will then bind() to a :c:type:`usb_gadget`, which activates the data line pullup sometime after detecting VBUS. h]h)}(hRegister a gadget driver that implements some higher level device function. That will then bind() to a :c:type:`usb_gadget`, which activates the data line pullup sometime after detecting VBUS.h](hgRegister a gadget driver that implements some higher level device function. That will then bind() to a }(hjhhhNhNubh)}(h:c:type:`usb_gadget`h]j)}(hjh]h usb_gadget}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj usb_gadgetuh1hhhhKhjubhE, which activates the data line pullup sometime after detecting VBUS.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hXThe hardware driver can now start enumerating. The steps it handles are to accept USB ``power`` and ``set_address`` requests. Other steps are handled by the gadget driver. If the gadget driver module is unloaded before the host starts to enumerate, steps before step 7 are skipped. h]h)}(hXThe hardware driver can now start enumerating. The steps it handles are to accept USB ``power`` and ``set_address`` requests. Other steps are handled by the gadget driver. If the gadget driver module is unloaded before the host starts to enumerate, steps before step 7 are skipped.h](hVThe hardware driver can now start enumerating. The steps it handles are to accept USB }(hjhhhNhNubj)}(h ``power``h]hpower}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h``set_address``h]h set_address}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh requests. Other steps are handled by the gadget driver. If the gadget driver module is unloaded before the host starts to enumerate, steps before step 7 are skipped.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hXPThe gadget driver's ``setup()`` call returns usb descriptors, based both on what the bus interface hardware provides and on the functionality being implemented. That can involve alternate settings or configurations, unless the hardware prevents such operation. For OTG devices, each configuration descriptor includes an OTG descriptor. h]h)}(hXOThe gadget driver's ``setup()`` call returns usb descriptors, based both on what the bus interface hardware provides and on the functionality being implemented. That can involve alternate settings or configurations, unless the hardware prevents such operation. For OTG devices, each configuration descriptor includes an OTG descriptor.h](hThe gadget driver’s }(hjBhhhNhNubj)}(h ``setup()``h]hsetup()}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubhX0 call returns usb descriptors, based both on what the bus interface hardware provides and on the functionality being implemented. That can involve alternate settings or configurations, unless the hardware prevents such operation. For OTG devices, each configuration descriptor includes an OTG descriptor.}(hjBhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj>ubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hX)The gadget driver handles the last step of enumeration, when the USB host issues a ``set_configuration`` call. It enables all endpoints used in that configuration, with all interfaces in their default settings. That involves using a list of the hardware's endpoints, enabling each endpoint according to its descriptor. It may also involve using ``usb_gadget_vbus_draw`` to let more power be drawn from VBUS, as allowed by that configuration. For OTG devices, setting a configuration may also involve reporting HNP capabilities through a user interface. h]h)}(hX(The gadget driver handles the last step of enumeration, when the USB host issues a ``set_configuration`` call. It enables all endpoints used in that configuration, with all interfaces in their default settings. That involves using a list of the hardware's endpoints, enabling each endpoint according to its descriptor. It may also involve using ``usb_gadget_vbus_draw`` to let more power be drawn from VBUS, as allowed by that configuration. For OTG devices, setting a configuration may also involve reporting HNP capabilities through a user interface.h](hSThe gadget driver handles the last step of enumeration, when the USB host issues a }(hjlhhhNhNubj)}(h``set_configuration``h]hset_configuration}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubh call. It enables all endpoints used in that configuration, with all interfaces in their default settings. That involves using a list of the hardware’s endpoints, enabling each endpoint according to its descriptor. It may also involve using }(hjlhhhNhNubj)}(h``usb_gadget_vbus_draw``h]husb_gadget_vbus_draw}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubh to let more power be drawn from VBUS, as allowed by that configuration. For OTG devices, setting a configuration may also involve reporting HNP capabilities through a user interface.}(hjlhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hjhubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hXgDo real work and perform data transfers, possibly involving changes to interface settings or switching to new configurations, until the device is disconnect()ed from the host. Queue any number of transfer requests to each endpoint. It may be suspended and resumed several times before being disconnected. On disconnect, the drivers go back to step 3 (above). h]h)}(hXfDo real work and perform data transfers, possibly involving changes to interface settings or switching to new configurations, until the device is disconnect()ed from the host. Queue any number of transfer requests to each endpoint. It may be suspended and resumed several times before being disconnected. On disconnect, the drivers go back to step 3 (above).h]hXfDo real work and perform data transfers, possibly involving changes to interface settings or switching to new configurations, until the device is disconnect()ed from the host. Queue any number of transfer requests to each endpoint. It may be suspended and resumed several times before being disconnected. On disconnect, the drivers go back to step 3 (above).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hWhen the gadget driver module is being unloaded, the driver unbind() callback is issued. That lets the controller driver be unloaded. h]h)}(hWhen the gadget driver module is being unloaded, the driver unbind() callback is issued. That lets the controller driver be unloaded.h]hWhen the gadget driver module is being unloaded, the driver unbind() callback is issued. That lets the controller driver be unloaded.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1jhjyhhhhhKubh)}(hXDrivers will normally be arranged so that just loading the gadget driver module (or statically linking it into a Linux kernel) allows the peripheral device to be enumerated, but some drivers will defer enumeration until some higher level component (like a user mode daemon) enables it. Note that at this lowest level there are no policies about how ep0 configuration logic is implemented, except that it should obey USB specifications. Such issues are in the domain of gadget drivers, including knowing about implementation constraints imposed by some USB controllers or understanding that composite devices might happen to be built by integrating reusable components.h]hXDrivers will normally be arranged so that just loading the gadget driver module (or statically linking it into a Linux kernel) allows the peripheral device to be enumerated, but some drivers will defer enumeration until some higher level component (like a user mode daemon) enables it. Note that at this lowest level there are no policies about how ep0 configuration logic is implemented, except that it should obey USB specifications. Such issues are in the domain of gadget drivers, including knowing about implementation constraints imposed by some USB controllers or understanding that composite devices might happen to be built by integrating reusable components.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjyhhubh)}(hXNote that the lifecycle above can be slightly different for OTG devices. Other than providing an additional OTG descriptor in each configuration, only the HNP-related differences are particularly visible to driver code. They involve reporting requirements during the ``SET_CONFIGURATION`` request, and the option to invoke HNP during some suspend callbacks. Also, SRP changes the semantics of ``usb_gadget_wakeup`` slightly.h](hX Note that the lifecycle above can be slightly different for OTG devices. Other than providing an additional OTG descriptor in each configuration, only the HNP-related differences are particularly visible to driver code. They involve reporting requirements during the }(hjhhhNhNubj)}(h``SET_CONFIGURATION``h]hSET_CONFIGURATION}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhi request, and the option to invoke HNP during some suspend callbacks. Also, SRP changes the semantics of }(hjhhhNhNubj)}(h``usb_gadget_wakeup``h]husb_gadget_wakeup}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh slightly.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM(hjyhhubeh}(h]driver-life-cycleah ]h"]driver life cycleah$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(h%USB 2.0 Chapter 9 Types and Constantsh]h%USB 2.0 Chapter 9 Types and Constants}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj'hhhhhM0ubh)}(hGadget drivers rely on common USB structures and constants defined in the :ref:`linux/usb/ch9.h ` header file, which is standard in Linux 2.6+ kernels. These are the same types and constants used by host side drivers (and usbcore).h](hJGadget drivers rely on common USB structures and constants defined in the }(hj8hhhNhNubh)}(h%:ref:`linux/usb/ch9.h `h]hinline)}(hjBh]hlinux/usb/ch9.h}(hjFhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jDhj@ubah}(h]h ]h"]h$]h&]refdocj refdomainjPreftyperef refexplicitrefwarnj usb_chapter9uh1hhhhM2hj8ubh header file, which is standard in Linux 2.6+ kernels. These are the same types and constants used by host side drivers (and usbcore).}(hj8hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM2hj'hhubeh}(h]%usb-2-0-chapter-9-types-and-constantsah ]h"]%usb 2.0 chapter 9 types and constantsah$]h&]uh1hhjhhhhhM0ubh)}(hhh](h)}(hCore Objects and Methodsh]hCore Objects and Methods}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjthhhhhM8ubh)}(hThese are declared in ````, and are used by gadget drivers to interact with USB peripheral controller drivers.h](hThese are declared in }(hjhhhNhNubj)}(h````h]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhT, and are used by gadget drivers to interact with USB peripheral controller drivers.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM:hjthhubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](singleusb_request (C struct) c.usb_requesthNtauh1jhjthhhNhNubhdesc)}(hhh](hdesc_signature)}(h usb_requesth]hdesc_signature_line)}(hstruct usb_requesth](hdesc_sig_keyword)}(hstructh]hstruct}(hjhhhNhNubah}(h]h ]kah"]h$]h&]uh1jhjhhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKubhdesc_sig_space)}(h h]h }(hjhhhNhNubah}(h]h ]wah"]h$]h&]uh1jhjhhhjhKubh desc_name)}(h usb_requesth]h desc_sig_name)}(hjh]h usb_request}(hjhhhNhNubah}(h]h ]nah"]h$]h&]uh1jhjubah}(h]h ](sig-namedescnameeh"]h$]h&] xml:spacepreserveuh1jhjhhhjhKubeh}(h]h ]h"]h$]h&]j j add_permalinkuh1jsphinx_line_type declaratorhjhhhjhKubah}(h]jah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1jhjhKhjhhubh desc_content)}(hhh]h)}(hdescribes one i/o requesth]hdescribes one i/o request}(hj# hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK#hj hhubah}(h]h ]h"]h$]h&]uh1j hjhhhjhKubeh}(h]h ](jstructeh"]h$]h&]domainjobjtypej; desctypej; noindex noindexentrynocontentsentryuh1jhhhjthNhNubh container)}(hX[ **Definition**:: struct usb_request { struct usb_ep *ep; void *buf; unsigned length; dma_addr_t dma; struct scatterlist *sg; unsigned num_sgs; unsigned num_mapped_sgs; unsigned stream_id:16; unsigned is_last:1; unsigned no_interrupt:1; unsigned zero:1; unsigned short_not_ok:1; unsigned dma_mapped:1; unsigned sg_was_mapped:1; void (*complete)(struct usb_ep *ep, struct usb_request *req); void *context; struct list_head list; unsigned frame_number; int status; unsigned actual; }; **Members** ``ep`` The associated endpoint set by usb_ep_alloc_request(). ``buf`` Buffer used for data. Always provide this; some controllers only use PIO, or don't use DMA for some endpoints. ``length`` Length of that data ``dma`` DMA address corresponding to 'buf'. If you don't set this field, and the usb controller needs one, it is responsible for mapping and unmapping the buffer. ``sg`` a scatterlist for SG-capable controllers. ``num_sgs`` number of SG entries ``num_mapped_sgs`` number of SG entries mapped to DMA (internal) ``stream_id`` The stream id, when USB3.0 bulk streams are being used ``is_last`` Indicates if this is the last request of a stream_id before switching to a different stream (required for DWC3 controllers). ``no_interrupt`` If true, hints that no completion irq is needed. Helpful sometimes with deep request queues that are handled directly by DMA controllers. ``zero`` If true, when writing data, makes the last packet be "short" by adding a zero length packet as needed; ``short_not_ok`` When reading data, makes short packets be treated as errors (queue stops advancing till cleanup). ``dma_mapped`` Indicates if request has been mapped to DMA (internal) ``sg_was_mapped`` Set if the scatterlist has been mapped before the request ``complete`` Function called when request completes, so this request and its buffer may be re-used. The function will always be called with interrupts disabled, and it must not sleep. Reads terminate with a short packet, or when the buffer fills, whichever comes first. When writes terminate, some data bytes will usually still be in flight (often in a hardware fifo). Errors (for reads or writes) stop the queue from advancing until the completion function returns, so that any transfers invalidated by the error may first be dequeued. ``context`` For use by the completion callback ``list`` For use by the gadget driver. ``frame_number`` Reports the interval number in (micro)frame in which the isochronous transfer was transmitted or received. ``status`` Reports completion code, zero or a negative errno. Normally, faults block the transfer queue from advancing until the completion callback returns. Code "-ESHUTDOWN" indicates completion caused by device disconnect, or when the driver disabled the endpoint. ``actual`` Reports bytes transferred to/from the buffer. For reads (OUT transfers) this may be less than the requested length. If the short_not_ok flag is set, short reads are treated as errors even when status otherwise indicates successful completion. Note that for writes (IN transfers) some data bytes may still reside in a device-side FIFO when the request is reported as complete.h](h)}(h**Definition**::h](hstrong)}(h**Definition**h]h Definition}(hjQ hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjK ubh:}(hjK hhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK'hjG ubh literal_block)}(hX6struct usb_request { struct usb_ep *ep; void *buf; unsigned length; dma_addr_t dma; struct scatterlist *sg; unsigned num_sgs; unsigned num_mapped_sgs; unsigned stream_id:16; unsigned is_last:1; unsigned no_interrupt:1; unsigned zero:1; unsigned short_not_ok:1; unsigned dma_mapped:1; unsigned sg_was_mapped:1; void (*complete)(struct usb_ep *ep, struct usb_request *req); void *context; struct list_head list; unsigned frame_number; int status; unsigned actual; };h]hX6struct usb_request { struct usb_ep *ep; void *buf; unsigned length; dma_addr_t dma; struct scatterlist *sg; unsigned num_sgs; unsigned num_mapped_sgs; unsigned stream_id:16; unsigned is_last:1; unsigned no_interrupt:1; unsigned zero:1; unsigned short_not_ok:1; unsigned dma_mapped:1; unsigned sg_was_mapped:1; void (*complete)(struct usb_ep *ep, struct usb_request *req); void *context; struct list_head list; unsigned frame_number; int status; unsigned actual; };}hjl sbah}(h]h ]h"]h$]h&]j j uh1jj ha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK)hjG ubh)}(h **Members**h]jP )}(hj} h]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj{ ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK@hjG ubj)}(hhh](j)}(h>``ep`` The associated endpoint set by usb_ep_alloc_request(). h](j)}(h``ep``h]j)}(hj h]hep}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK%hj ubj)}(hhh]h)}(h6The associated endpoint set by usb_ep_alloc_request().h]h6The associated endpoint set by usb_ep_alloc_request().}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hK%hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK%hj ubj)}(hx``buf`` Buffer used for data. Always provide this; some controllers only use PIO, or don't use DMA for some endpoints. h](j)}(h``buf``h]j)}(hj h]hbuf}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK'hj ubj)}(hhh]h)}(hoBuffer used for data. Always provide this; some controllers only use PIO, or don't use DMA for some endpoints.h]hqBuffer used for data. Always provide this; some controllers only use PIO, or don’t use DMA for some endpoints.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK&hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK'hj ubj)}(h``length`` Length of that data h](j)}(h ``length``h]j)}(hj h]hlength}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK.hj ubj)}(hhh]h)}(hLength of that datah]hLength of that data}(hj( hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$ hK.hj% ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj$ hK.hj ubj)}(h``dma`` DMA address corresponding to 'buf'. If you don't set this field, and the usb controller needs one, it is responsible for mapping and unmapping the buffer. h](j)}(h``dma``h]j)}(hjH h]hdma}(hjJ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjF ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK*hjB ubj)}(hhh]h)}(hDMA address corresponding to 'buf'. If you don't set this field, and the usb controller needs one, it is responsible for mapping and unmapping the buffer.h]hDMA address corresponding to ‘buf’. If you don’t set this field, and the usb controller needs one, it is responsible for mapping and unmapping the buffer.}(hja hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK(hj^ ubah}(h]h ]h"]h$]h&]uh1jhjB ubeh}(h]h ]h"]h$]h&]uh1jhj] hK*hj ubj)}(h1``sg`` a scatterlist for SG-capable controllers. h](j)}(h``sg``h]j)}(hj h]hsg}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK+hj| ubj)}(hhh]h)}(h)a scatterlist for SG-capable controllers.h]h)a scatterlist for SG-capable controllers.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hK+hj ubah}(h]h ]h"]h$]h&]uh1jhj| ubeh}(h]h ]h"]h$]h&]uh1jhj hK+hj ubj)}(h!``num_sgs`` number of SG entries h](j)}(h ``num_sgs``h]j)}(hj h]hnum_sgs}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK,hj ubj)}(hhh]h)}(hnumber of SG entriesh]hnumber of SG entries}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hK,hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK,hj ubj)}(hA``num_mapped_sgs`` number of SG entries mapped to DMA (internal) h](j)}(h``num_mapped_sgs``h]j)}(hj h]hnum_mapped_sgs}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK-hj ubj)}(hhh]h)}(h-number of SG entries mapped to DMA (internal)h]h-number of SG entries mapped to DMA (internal)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hK-hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK-hj ubj)}(hE``stream_id`` The stream id, when USB3.0 bulk streams are being used h](j)}(h ``stream_id``h]j)}(hj- h]h stream_id}(hj/ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK/hj' ubj)}(hhh]h)}(h6The stream id, when USB3.0 bulk streams are being usedh]h6The stream id, when USB3.0 bulk streams are being used}(hjF hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjB hK/hjC ubah}(h]h ]h"]h$]h&]uh1jhj' ubeh}(h]h ]h"]h$]h&]uh1jhjB hK/hj ubj)}(h``is_last`` Indicates if this is the last request of a stream_id before switching to a different stream (required for DWC3 controllers). h](j)}(h ``is_last``h]j)}(hjf h]his_last}(hjh hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjd ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK1hj` ubj)}(hhh]h)}(h|Indicates if this is the last request of a stream_id before switching to a different stream (required for DWC3 controllers).h]h|Indicates if this is the last request of a stream_id before switching to a different stream (required for DWC3 controllers).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK0hj| ubah}(h]h ]h"]h$]h&]uh1jhj` ubeh}(h]h ]h"]h$]h&]uh1jhj{ hK1hj ubj)}(h``no_interrupt`` If true, hints that no completion irq is needed. Helpful sometimes with deep request queues that are handled directly by DMA controllers. h](j)}(h``no_interrupt``h]j)}(hj h]h no_interrupt}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK4hj ubj)}(hhh]h)}(hIf true, hints that no completion irq is needed. Helpful sometimes with deep request queues that are handled directly by DMA controllers.h]hIf true, hints that no completion irq is needed. Helpful sometimes with deep request queues that are handled directly by DMA controllers.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK2hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK4hj ubj)}(hp``zero`` If true, when writing data, makes the last packet be "short" by adding a zero length packet as needed; h](j)}(h``zero``h]j)}(hj h]hzero}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK6hj ubj)}(hhh]h)}(hfIf true, when writing data, makes the last packet be "short" by adding a zero length packet as needed;h]hjIf true, when writing data, makes the last packet be “short” by adding a zero length packet as needed;}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK5hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK6hj ubj)}(hs``short_not_ok`` When reading data, makes short packets be treated as errors (queue stops advancing till cleanup). h](j)}(h``short_not_ok``h]j)}(hj h]h short_not_ok}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK8hj ubj)}(hhh]h)}(haWhen reading data, makes short packets be treated as errors (queue stops advancing till cleanup).h]haWhen reading data, makes short packets be treated as errors (queue stops advancing till cleanup).}(hj- hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK7hj* ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj) hK8hj ubj)}(hF``dma_mapped`` Indicates if request has been mapped to DMA (internal) h](j)}(h``dma_mapped``h]j)}(hjN h]h dma_mapped}(hjP hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjL ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK9hjH ubj)}(hhh]h)}(h6Indicates if request has been mapped to DMA (internal)h]h6Indicates if request has been mapped to DMA (internal)}(hjg hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjc hK9hjd ubah}(h]h ]h"]h$]h&]uh1jhjH ubeh}(h]h ]h"]h$]h&]uh1jhjc hK9hj ubj)}(hL``sg_was_mapped`` Set if the scatterlist has been mapped before the request h](j)}(h``sg_was_mapped``h]j)}(hj h]h sg_was_mapped}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK:hj ubj)}(hhh]h)}(h9Set if the scatterlist has been mapped before the requesth]h9Set if the scatterlist has been mapped before the request}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hK:hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hK:hj ubj)}(hX``complete`` Function called when request completes, so this request and its buffer may be re-used. The function will always be called with interrupts disabled, and it must not sleep. Reads terminate with a short packet, or when the buffer fills, whichever comes first. When writes terminate, some data bytes will usually still be in flight (often in a hardware fifo). Errors (for reads or writes) stop the queue from advancing until the completion function returns, so that any transfers invalidated by the error may first be dequeued. h](j)}(h ``complete``h]j)}(hj h]hcomplete}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKChj ubj)}(hhh]h)}(hX Function called when request completes, so this request and its buffer may be re-used. The function will always be called with interrupts disabled, and it must not sleep. Reads terminate with a short packet, or when the buffer fills, whichever comes first. When writes terminate, some data bytes will usually still be in flight (often in a hardware fifo). Errors (for reads or writes) stop the queue from advancing until the completion function returns, so that any transfers invalidated by the error may first be dequeued.h]hX Function called when request completes, so this request and its buffer may be re-used. The function will always be called with interrupts disabled, and it must not sleep. Reads terminate with a short packet, or when the buffer fills, whichever comes first. When writes terminate, some data bytes will usually still be in flight (often in a hardware fifo). Errors (for reads or writes) stop the queue from advancing until the completion function returns, so that any transfers invalidated by the error may first be dequeued.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK;hj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKChj ubj)}(h/``context`` For use by the completion callback h](j)}(h ``context``h]j)}(hj h]hcontext}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKDhj ubj)}(hhh]h)}(h"For use by the completion callbackh]h"For use by the completion callback}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKDhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKDhj ubj)}(h'``list`` For use by the gadget driver. h](j)}(h``list``h]j)}(hj3 h]hlist}(hj5 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1 ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKEhj- ubj)}(hhh]h)}(hFor use by the gadget driver.h]hFor use by the gadget driver.}(hjL hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjH hKEhjI ubah}(h]h ]h"]h$]h&]uh1jhj- ubeh}(h]h ]h"]h$]h&]uh1jhjH hKEhj ubj)}(h|``frame_number`` Reports the interval number in (micro)frame in which the isochronous transfer was transmitted or received. h](j)}(h``frame_number``h]j)}(hjl h]h frame_number}(hjn hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKGhjf ubj)}(hhh]h)}(hjReports the interval number in (micro)frame in which the isochronous transfer was transmitted or received.h]hjReports the interval number in (micro)frame in which the isochronous transfer was transmitted or received.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKFhj ubah}(h]h ]h"]h$]h&]uh1jhjf ubeh}(h]h ]h"]h$]h&]uh1jhj hKGhj ubj)}(hX ``status`` Reports completion code, zero or a negative errno. Normally, faults block the transfer queue from advancing until the completion callback returns. Code "-ESHUTDOWN" indicates completion caused by device disconnect, or when the driver disabled the endpoint. h](j)}(h ``status``h]j)}(hj h]hstatus}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKLhj ubj)}(hhh]h)}(hXReports completion code, zero or a negative errno. Normally, faults block the transfer queue from advancing until the completion callback returns. Code "-ESHUTDOWN" indicates completion caused by device disconnect, or when the driver disabled the endpoint.h]hXReports completion code, zero or a negative errno. Normally, faults block the transfer queue from advancing until the completion callback returns. Code “-ESHUTDOWN” indicates completion caused by device disconnect, or when the driver disabled the endpoint.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKHhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKLhj ubj)}(hX``actual`` Reports bytes transferred to/from the buffer. For reads (OUT transfers) this may be less than the requested length. If the short_not_ok flag is set, short reads are treated as errors even when status otherwise indicates successful completion. Note that for writes (IN transfers) some data bytes may still reside in a device-side FIFO when the request is reported as complete.h](j)}(h ``actual``h]j)}(hj h]hactual}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKRhj ubj)}(hhh]h)}(hXyReports bytes transferred to/from the buffer. For reads (OUT transfers) this may be less than the requested length. If the short_not_ok flag is set, short reads are treated as errors even when status otherwise indicates successful completion. Note that for writes (IN transfers) some data bytes may still reside in a device-side FIFO when the request is reported as complete.h]hXyReports bytes transferred to/from the buffer. For reads (OUT transfers) this may be less than the requested length. If the short_not_ok flag is set, short reads are treated as errors even when status otherwise indicates successful completion. Note that for writes (IN transfers) some data bytes may still reside in a device-side FIFO when the request is reported as complete.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKMhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKRhj ubeh}(h]h ]h"]h$]h&]uh1jhjG ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubh)}(h**Description**h]jP )}(hj#h]h Description}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj!ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKVhjthhubh)}(hThese are allocated/freed through the endpoint they're used with. The hardware's driver can add extra per-request data to the memory it returns, which often avoids separate memory allocations (potential failures), later when the request is queued.h]hThese are allocated/freed through the endpoint they’re used with. The hardware’s driver can add extra per-request data to the memory it returns, which often avoids separate memory allocations (potential failures), later when the request is queued.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKShjthhubh)}(hXARequest flags affect request handling, such as whether a zero length packet is written (the "zero" flag), whether a short read should be treated as an error (blocking request queue advance, the "short_not_ok" flag), or hinting that an interrupt is not required (the "no_interrupt" flag, for use with deep request queues).h]hXMRequest flags affect request handling, such as whether a zero length packet is written (the “zero” flag), whether a short read should be treated as an error (blocking request queue advance, the “short_not_ok” flag), or hinting that an interrupt is not required (the “no_interrupt” flag, for use with deep request queues).}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKXhjthhubh)}(hBulk endpoints can use any size buffers, and can also be used for interrupt transfers. interrupt-only endpoints can be much less functional.h]hBulk endpoints can use any size buffers, and can also be used for interrupt transfers. interrupt-only endpoints can be much less functional.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhK^hjthhubh)}(h**NOTE**h]jP )}(hjhh]hNOTE}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjfubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKahjthhubh)}(hnthis is analogous to 'struct urb' on the host side, except that it's thinner and promotes more pre-allocation.h]htthis is analogous to ‘struct urb’ on the host side, except that it’s thinner and promotes more pre-allocation.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKbhjthhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_ep_caps (C struct) c.usb_ep_capshNtauh1jhjthhhNhNubj)}(hhh](j)}(h usb_ep_capsh]j)}(hstruct usb_ep_capsh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhKhubj)}(h usb_ep_capsh]j)}(hjh]h usb_ep_caps}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j j eh"]h$]h&]j j uh1jhjhhhjhKhubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjhhhjhKhubah}(h]jah ](j j eh"]h$]h&]j j )j huh1jhjhKhhjhhubj )}(hhh]h)}(h!endpoint capabilities descriptionh]h!endpoint capabilities description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjhhubah}(h]h ]h"]h$]h&]uh1j hjhhhjhKhubeh}(h]h ](jstructeh"]h$]h&]j? jj@ jjA jjB jC jD uh1jhhhjthNhNubjF )}(hX&**Definition**:: struct usb_ep_caps { unsigned type_control:1; unsigned type_iso:1; unsigned type_bulk:1; unsigned type_int:1; unsigned dir_in:1; unsigned dir_out:1; }; **Members** ``type_control`` Endpoint supports control type (reserved for ep0). ``type_iso`` Endpoint supports isochronous transfers. ``type_bulk`` Endpoint supports bulk transfers. ``type_int`` Endpoint supports interrupt transfers. ``dir_in`` Endpoint supports IN direction. ``dir_out`` Endpoint supports OUT direction.h](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubjk )}(hstruct usb_ep_caps { unsigned type_control:1; unsigned type_iso:1; unsigned type_bulk:1; unsigned type_int:1; unsigned dir_in:1; unsigned dir_out:1; };h]hstruct usb_ep_caps { unsigned type_control:1; unsigned type_iso:1; unsigned type_bulk:1; unsigned type_int:1; unsigned dir_in:1; unsigned dir_out:1; };}hj%sbah}(h]h ]h"]h$]h&]j j uh1jj ha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubh)}(h **Members**h]jP )}(hj6h]hMembers}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj4ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh](j)}(hD``type_control`` Endpoint supports control type (reserved for ep0). h](j)}(h``type_control``h]j)}(hjUh]h type_control}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjOubj)}(hhh]h)}(h2Endpoint supports control type (reserved for ep0).h]h2Endpoint supports control type (reserved for ep0).}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjjhKhjkubah}(h]h ]h"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]uh1jhjjhKhjLubj)}(h6``type_iso`` Endpoint supports isochronous transfers. h](j)}(h ``type_iso``h]j)}(hjh]htype_iso}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(h(Endpoint supports isochronous transfers.h]h(Endpoint supports isochronous transfers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjLubj)}(h0``type_bulk`` Endpoint supports bulk transfers. h](j)}(h ``type_bulk``h]j)}(hjh]h type_bulk}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(h!Endpoint supports bulk transfers.h]h!Endpoint supports bulk transfers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjLubj)}(h4``type_int`` Endpoint supports interrupt transfers. h](j)}(h ``type_int``h]j)}(hjh]htype_int}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(h&Endpoint supports interrupt transfers.h]h&Endpoint supports interrupt transfers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjLubj)}(h+``dir_in`` Endpoint supports IN direction. h](j)}(h ``dir_in``h]j)}(hj9h]hdir_in}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhj3ubj)}(hhh]h)}(hEndpoint supports IN direction.h]hEndpoint supports IN direction.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNhKhjOubah}(h]h ]h"]h$]h&]uh1jhj3ubeh}(h]h ]h"]h$]h&]uh1jhjNhKhjLubj)}(h,``dir_out`` Endpoint supports OUT direction.h](j)}(h ``dir_out``h]j)}(hjrh]hdir_out}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjlubj)}(hhh]h)}(h Endpoint supports OUT direction.h]h Endpoint supports OUT direction.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjlubeh}(h]h ]h"]h$]h&]uh1jhjhKhjLubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_ep (C struct)c.usb_ephNtauh1jhjthhhNhNubj)}(hhh](j)}(husb_eph]j)}(h struct usb_eph](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhKubj)}(husb_eph]j)}(hjh]husb_ep}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j j eh"]h$]h&]j j uh1jhjhhhjhKubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjhhhjhKubah}(h]jah ](j j eh"]h$]h&]j j )j huh1jhjhKhjhhubj )}(hhh]h)}(h*device side representation of USB endpointh]h*device side representation of USB endpoint}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhj hhubah}(h]h ]h"]h$]h&]uh1j hjhhhjhKubeh}(h]h ](jstructeh"]h$]h&]j? jj@ j&jA j&jB jC jD uh1jhhhjthNhNubjF )}(hX**Definition**:: struct usb_ep { void *driver_data; const char *name; const struct usb_ep_ops *ops; const struct usb_endpoint_descriptor *desc; const struct usb_ss_ep_comp_descriptor *comp_desc; struct list_head ep_list; struct usb_ep_caps caps; bool claimed; bool enabled; unsigned mult:2; unsigned maxburst:5; u8 address; u16 maxpacket; u16 maxpacket_limit; u16 max_streams; }; **Members** ``driver_data`` for use by the gadget driver. ``name`` identifier for the endpoint, such as "ep-a" or "ep9in-bulk" ``ops`` Function pointers used to access hardware-specific operations. ``desc`` endpoint descriptor. This pointer is set before the endpoint is enabled and remains valid until the endpoint is disabled. ``comp_desc`` In case of SuperSpeed support, this is the endpoint companion descriptor that is used to configure the endpoint ``ep_list`` the gadget's ep_list holds all of its endpoints ``caps`` The structure describing types and directions supported by endpoint. ``claimed`` True if this endpoint is claimed by a function. ``enabled`` The current endpoint enabled/disabled state. ``mult`` multiplier, 'mult' value for SS Isoc EPs ``maxburst`` the maximum number of bursts supported by this EP (for usb3) ``address`` used to identify the endpoint when finding descriptor that matches connection speed ``maxpacket`` The maximum packet size used on this endpoint. The initial value can sometimes be reduced (hardware allowing), according to the endpoint descriptor used to configure the endpoint. ``maxpacket_limit`` The maximum packet size value which can be handled by this endpoint. It's set once by UDC driver when endpoint is initialized, and should not be changed. Should not be confused with maxpacket. ``max_streams`` The maximum number of streams supported by this EP (0 - 16, actual number is 2^n)h](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj.ubh:}(hj.hhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhj*ubjk )}(hXstruct usb_ep { void *driver_data; const char *name; const struct usb_ep_ops *ops; const struct usb_endpoint_descriptor *desc; const struct usb_ss_ep_comp_descriptor *comp_desc; struct list_head ep_list; struct usb_ep_caps caps; bool claimed; bool enabled; unsigned mult:2; unsigned maxburst:5; u8 address; u16 maxpacket; u16 maxpacket_limit; u16 max_streams; };h]hXstruct usb_ep { void *driver_data; const char *name; const struct usb_ep_ops *ops; const struct usb_endpoint_descriptor *desc; const struct usb_ss_ep_comp_descriptor *comp_desc; struct list_head ep_list; struct usb_ep_caps caps; bool claimed; bool enabled; unsigned mult:2; unsigned maxburst:5; u8 address; u16 maxpacket; u16 maxpacket_limit; u16 max_streams; };}hjKsbah}(h]h ]h"]h$]h&]j j uh1jj ha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhj*ubh)}(h **Members**h]jP )}(hj\h]hMembers}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjZubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhj*ubj)}(hhh](j)}(h.``driver_data`` for use by the gadget driver. h](j)}(h``driver_data``h]j)}(hj{h]h driver_data}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjyubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjuubj)}(hhh]h)}(hfor use by the gadget driver.h]hfor use by the gadget driver.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjuubeh}(h]h ]h"]h$]h&]uh1jhjhKhjrubj)}(hE``name`` identifier for the endpoint, such as "ep-a" or "ep9in-bulk" h](j)}(h``name``h]j)}(hjh]hname}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(h;identifier for the endpoint, such as "ep-a" or "ep9in-bulk"h]hCidentifier for the endpoint, such as “ep-a” or “ep9in-bulk”}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjrubj)}(hG``ops`` Function pointers used to access hardware-specific operations. h](j)}(h``ops``h]j)}(hjh]hops}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(h>Function pointers used to access hardware-specific operations.h]h>Function pointers used to access hardware-specific operations.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjrubj)}(h``desc`` endpoint descriptor. This pointer is set before the endpoint is enabled and remains valid until the endpoint is disabled. h](j)}(h``desc``h]j)}(hj&h]hdesc}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhj ubj)}(hhh]h)}(hzendpoint descriptor. This pointer is set before the endpoint is enabled and remains valid until the endpoint is disabled.h]hzendpoint descriptor. This pointer is set before the endpoint is enabled and remains valid until the endpoint is disabled.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhj<ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj;hKhjrubj)}(h~``comp_desc`` In case of SuperSpeed support, this is the endpoint companion descriptor that is used to configure the endpoint h](j)}(h ``comp_desc``h]j)}(hj`h]h comp_desc}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjZubj)}(hhh]h)}(hoIn case of SuperSpeed support, this is the endpoint companion descriptor that is used to configure the endpointh]hoIn case of SuperSpeed support, this is the endpoint companion descriptor that is used to configure the endpoint}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjvubah}(h]h ]h"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]uh1jhjuhKhjrubj)}(h<``ep_list`` the gadget's ep_list holds all of its endpoints h](j)}(h ``ep_list``h]j)}(hjh]hep_list}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(h/the gadget's ep_list holds all of its endpointsh]h1the gadget’s ep_list holds all of its endpoints}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjrubj)}(hN``caps`` The structure describing types and directions supported by endpoint. h](j)}(h``caps``h]j)}(hjh]hcaps}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(hDThe structure describing types and directions supported by endpoint.h]hDThe structure describing types and directions supported by endpoint.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjrubj)}(h<``claimed`` True if this endpoint is claimed by a function. h](j)}(h ``claimed``h]j)}(hj h]hclaimed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(h/True if this endpoint is claimed by a function.h]h/True if this endpoint is claimed by a function.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hKhj"ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj!hKhjrubj)}(h9``enabled`` The current endpoint enabled/disabled state. h](j)}(h ``enabled``h]j)}(hjEh]henabled}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhj?ubj)}(hhh]h)}(h,The current endpoint enabled/disabled state.h]h,The current endpoint enabled/disabled state.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjZhKhj[ubah}(h]h ]h"]h$]h&]uh1jhj?ubeh}(h]h ]h"]h$]h&]uh1jhjZhKhjrubj)}(h2``mult`` multiplier, 'mult' value for SS Isoc EPs h](j)}(h``mult``h]j)}(hj~h]hmult}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjxubj)}(hhh]h)}(h(multiplier, 'mult' value for SS Isoc EPsh]h,multiplier, ‘mult’ value for SS Isoc EPs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]uh1jhjhKhjrubj)}(hJ``maxburst`` the maximum number of bursts supported by this EP (for usb3) h](j)}(h ``maxburst``h]j)}(hjh]hmaxburst}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjubj)}(hhh]h)}(hep_list. the control endpoint (gadget->ep0) is not in that list, and is accessed only in response to a driver setup() callback.h]hthe bus controller driver lists all the general purpose endpoints in gadget->ep_list. the control endpoint (gadget->ep0) is not in that list, and is accessed only in response to a driver setup() callback.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhKhjthhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jfree_usb_request (C function)c.free_usb_requesthNtauh1jhjthhhNhNubj)}(hhh](j)}(h/void free_usb_request (struct usb_request *req)h]j)}(h.void free_usb_request(struct usb_request *req)h](hdesc_sig_keyword_type)}(hvoidh]hvoid}(hj hhhNhNubah}(h]h ]ktah"]h$]h&]uh1jhjhhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM*ubj)}(h h]h }(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhj/hM*ubj)}(hfree_usb_requesth]j)}(hfree_usb_requesth]hfree_usb_request}(hjBhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubah}(h]h ](j j eh"]h$]h&]j j uh1jhjhhhj/hM*ubhdesc_parameterlist)}(h(struct usb_request *req)h]hdesc_parameter)}(hstruct usb_request *reqh](j)}(hjh]hstruct}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubj)}(h h]h }(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubh)}(hhh]j)}(h usb_requesth]h usb_request}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&] refdomainjreftype identifier reftargetjmodnameN classnameN c:parent_keysphinx.domains.c LookupKey)}data]j ASTIdentifier)}jjDsbc.free_usb_requestasbuh1hhj^ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubhdesc_sig_punctuation)}(h*h]h*}(hjhhhNhNubah}(h]h ]pah"]h$]h&]uh1jhj^ubj)}(hreqh]hreq}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjXubah}(h]h ]h"]h$]h&]j j uh1jVhjhhhj/hM*ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjhhhj/hM*ubah}(h]jah ](j j eh"]h$]h&]j j )j huh1jhj/hM*hjhhubj )}(hhh]h)}(h)frees a usb_request object and its bufferh]h)frees a usb_request object and its buffer}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM*hjhhubah}(h]h ]h"]h$]h&]uh1j hjhhhj/hM*ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j jA j jB jC jD uh1jhhhjthNhNubjF )}(hXG**Parameters** ``struct usb_request *req`` the request being freed **Description** This helper function frees both the request's buffer and the request object itself by calling usb_ep_free_request(). Its signature is designed to be used with DEFINE_FREE() to enable automatic, scope-based cleanup for usb_request pointers.h](h)}(h**Parameters**h]jP )}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM.hj ubj)}(hhh]j)}(h4``struct usb_request *req`` the request being freed h](j)}(h``struct usb_request *req``h]j)}(hj2h]hstruct usb_request *req}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj0ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM+hj,ubj)}(hhh]h)}(hthe request being freedh]hthe request being freed}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjGhM+hjHubah}(h]h ]h"]h$]h&]uh1jhj,ubeh}(h]h ]h"]h$]h&]uh1jhjGhM+hj)ubah}(h]h ]h"]h$]h&]uh1jhj ubh)}(h**Description**h]jP )}(hjmh]h Description}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjkubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM-hj ubh)}(hThis helper function frees both the request's buffer and the request object itself by calling usb_ep_free_request(). Its signature is designed to be used with DEFINE_FREE() to enable automatic, scope-based cleanup for usb_request pointers.h]hThis helper function frees both the request’s buffer and the request object itself by calling usb_ep_free_request(). Its signature is designed to be used with DEFINE_FREE() to enable automatic, scope-based cleanup for usb_request pointers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM,hj ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_gadget (C struct) c.usb_gadgethNtauh1jhjthhhNhNubj)}(hhh](j)}(h usb_gadgeth]j)}(hstruct usb_gadgeth](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM4ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhM4ubj)}(h usb_gadgeth]j)}(hjh]h usb_gadget}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j j eh"]h$]h&]j j uh1jhjhhhjhM4ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjhhhjhM4ubah}(h]jah ](j j eh"]h$]h&]j j )j huh1jhjhM4hjhhubj )}(hhh]h)}(hrepresents a usb deviceh]hrepresents a usb device}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMlhjhhubah}(h]h ]h"]h$]h&]uh1j hjhhhjhM4ubeh}(h]h ](jstructeh"]h$]h&]j? jj@ j jA j jB jC jD uh1jhhhjthNhNubjF )}(hX**Definition**:: struct usb_gadget { struct work_struct work; struct usb_udc *udc; const struct usb_gadget_ops *ops; struct usb_ep *ep0; struct list_head ep_list; enum usb_device_speed speed; enum usb_device_speed max_speed; enum usb_ssp_rate ssp_rate; enum usb_ssp_rate max_ssp_rate; enum usb_device_state state; spinlock_t state_lock; bool teardown; const char *name; struct device dev; unsigned isoch_delay; unsigned out_epnum; unsigned in_epnum; unsigned mA; struct usb_otg_caps *otg_caps; unsigned sg_supported:1; unsigned is_otg:1; unsigned is_a_peripheral:1; unsigned b_hnp_enable:1; unsigned a_hnp_support:1; unsigned a_alt_hnp_support:1; unsigned hnp_polling_support:1; unsigned host_request_flag:1; unsigned quirk_ep_out_aligned_size:1; unsigned quirk_altset_not_supp:1; unsigned quirk_stall_not_supp:1; unsigned quirk_zlp_not_supp:1; unsigned quirk_avoids_skb_reserve:1; unsigned is_selfpowered:1; unsigned deactivated:1; unsigned connected:1; unsigned lpm_capable:1; unsigned wakeup_capable:1; unsigned wakeup_armed:1; int irq; int id_number; }; **Members** ``work`` (internal use) Workqueue to be used for sysfs_notify() ``udc`` struct usb_udc pointer for this gadget ``ops`` Function pointers used to access hardware-specific operations. ``ep0`` Endpoint zero, used when reading or writing responses to driver setup() requests ``ep_list`` List of other endpoints supported by the device. ``speed`` Speed of current connection to USB host. ``max_speed`` Maximal speed the UDC can handle. UDC must support this and all slower speeds. ``ssp_rate`` Current connected SuperSpeed Plus signaling rate and lane count. ``max_ssp_rate`` Maximum SuperSpeed Plus signaling rate and lane count the UDC can handle. The UDC must support this and all slower speeds and lower number of lanes. ``state`` the state we are now (attached, suspended, configured, etc) ``state_lock`` Spinlock protecting the `state` and `teardown` members. ``teardown`` True if the device is undergoing teardown, used to prevent new work from being scheduled during cleanup. ``name`` Identifies the controller hardware type. Used in diagnostics and sometimes configuration. ``dev`` Driver model state for this abstract device. ``isoch_delay`` value from Set Isoch Delay request. Only valid on SS/SSP ``out_epnum`` last used out ep number ``in_epnum`` last used in ep number ``mA`` last set mA value ``otg_caps`` OTG capabilities of this gadget. ``sg_supported`` true if we can handle scatter-gather ``is_otg`` True if the USB device port uses a Mini-AB jack, so that the gadget driver must provide a USB OTG descriptor. ``is_a_peripheral`` False unless is_otg, the "A" end of a USB cable is in the Mini-AB jack, and HNP has been used to switch roles so that the "A" device currently acts as A-Peripheral, not A-Host. ``b_hnp_enable`` OTG device feature flag, indicating that the A-Host enabled HNP support. ``a_hnp_support`` OTG device feature flag, indicating that the A-Host supports HNP at this port. ``a_alt_hnp_support`` OTG device feature flag, indicating that the A-Host only supports HNP on a different root port. ``hnp_polling_support`` OTG device feature flag, indicating if the OTG device in peripheral mode can support HNP polling. ``host_request_flag`` OTG device feature flag, indicating if A-Peripheral or B-Peripheral wants to take host role. ``quirk_ep_out_aligned_size`` epout requires buffer size to be aligned to MaxPacketSize. ``quirk_altset_not_supp`` UDC controller doesn't support alt settings. ``quirk_stall_not_supp`` UDC controller doesn't support stalling. ``quirk_zlp_not_supp`` UDC controller doesn't support ZLP. ``quirk_avoids_skb_reserve`` udc/platform wants to avoid skb_reserve() in u_ether.c to improve performance. ``is_selfpowered`` if the gadget is self-powered. ``deactivated`` True if gadget is deactivated - in deactivated state it cannot be connected. ``connected`` True if gadget is connected. ``lpm_capable`` If the gadget max_speed is FULL or HIGH, this flag indicates that it supports LPM as per the LPM ECN & errata. ``wakeup_capable`` True if gadget is capable of sending remote wakeup. ``wakeup_armed`` True if gadget is armed by the host for remote wakeup. ``irq`` the interrupt number for device controller. ``id_number`` a unique ID number for ensuring that gadget names are distincth](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMphjubjk )}(hX`struct usb_gadget { struct work_struct work; struct usb_udc *udc; const struct usb_gadget_ops *ops; struct usb_ep *ep0; struct list_head ep_list; enum usb_device_speed speed; enum usb_device_speed max_speed; enum usb_ssp_rate ssp_rate; enum usb_ssp_rate max_ssp_rate; enum usb_device_state state; spinlock_t state_lock; bool teardown; const char *name; struct device dev; unsigned isoch_delay; unsigned out_epnum; unsigned in_epnum; unsigned mA; struct usb_otg_caps *otg_caps; unsigned sg_supported:1; unsigned is_otg:1; unsigned is_a_peripheral:1; unsigned b_hnp_enable:1; unsigned a_hnp_support:1; unsigned a_alt_hnp_support:1; unsigned hnp_polling_support:1; unsigned host_request_flag:1; unsigned quirk_ep_out_aligned_size:1; unsigned quirk_altset_not_supp:1; unsigned quirk_stall_not_supp:1; unsigned quirk_zlp_not_supp:1; unsigned quirk_avoids_skb_reserve:1; unsigned is_selfpowered:1; unsigned deactivated:1; unsigned connected:1; unsigned lpm_capable:1; unsigned wakeup_capable:1; unsigned wakeup_armed:1; int irq; int id_number; };h]hX`struct usb_gadget { struct work_struct work; struct usb_udc *udc; const struct usb_gadget_ops *ops; struct usb_ep *ep0; struct list_head ep_list; enum usb_device_speed speed; enum usb_device_speed max_speed; enum usb_ssp_rate ssp_rate; enum usb_ssp_rate max_ssp_rate; enum usb_device_state state; spinlock_t state_lock; bool teardown; const char *name; struct device dev; unsigned isoch_delay; unsigned out_epnum; unsigned in_epnum; unsigned mA; struct usb_otg_caps *otg_caps; unsigned sg_supported:1; unsigned is_otg:1; unsigned is_a_peripheral:1; unsigned b_hnp_enable:1; unsigned a_hnp_support:1; unsigned a_alt_hnp_support:1; unsigned hnp_polling_support:1; unsigned host_request_flag:1; unsigned quirk_ep_out_aligned_size:1; unsigned quirk_altset_not_supp:1; unsigned quirk_stall_not_supp:1; unsigned quirk_zlp_not_supp:1; unsigned quirk_avoids_skb_reserve:1; unsigned is_selfpowered:1; unsigned deactivated:1; unsigned connected:1; unsigned lpm_capable:1; unsigned wakeup_capable:1; unsigned wakeup_armed:1; int irq; int id_number; };}hj1sbah}(h]h ]h"]h$]h&]j j uh1jj ha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMrhjubh)}(h **Members**h]jP )}(hjBh]hMembers}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj@ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh](j)}(h@``work`` (internal use) Workqueue to be used for sysfs_notify() h](j)}(h``work``h]j)}(hjah]hwork}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMnhj[ubj)}(hhh]h)}(h6(internal use) Workqueue to be used for sysfs_notify()h]h6(internal use) Workqueue to be used for sysfs_notify()}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjvhMnhjwubah}(h]h ]h"]h$]h&]uh1jhj[ubeh}(h]h ]h"]h$]h&]uh1jhjvhMnhjXubj)}(h/``udc`` struct usb_udc pointer for this gadget h](j)}(h``udc``h]j)}(hjh]hudc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMohjubj)}(hhh]h)}(h&struct usb_udc pointer for this gadgeth]h&struct usb_udc pointer for this gadget}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMohjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMohjXubj)}(hG``ops`` Function pointers used to access hardware-specific operations. h](j)}(h``ops``h]j)}(hjh]hops}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMphjubj)}(hhh]h)}(h>Function pointers used to access hardware-specific operations.h]h>Function pointers used to access hardware-specific operations.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMphjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMphjXubj)}(hY``ep0`` Endpoint zero, used when reading or writing responses to driver setup() requests h](j)}(h``ep0``h]j)}(hj h]hep0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMrhjubj)}(hhh]h)}(hPEndpoint zero, used when reading or writing responses to driver setup() requestsh]hPEndpoint zero, used when reading or writing responses to driver setup() requests}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMqhj"ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj!hMrhjXubj)}(h=``ep_list`` List of other endpoints supported by the device. h](j)}(h ``ep_list``h]j)}(hjFh]hep_list}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMshj@ubj)}(hhh]h)}(h0List of other endpoints supported by the device.h]h0List of other endpoints supported by the device.}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[hMshj\ubah}(h]h ]h"]h$]h&]uh1jhj@ubeh}(h]h ]h"]h$]h&]uh1jhj[hMshjXubj)}(h3``speed`` Speed of current connection to USB host. h](j)}(h ``speed``h]j)}(hjh]hspeed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMthjyubj)}(hhh]h)}(h(Speed of current connection to USB host.h]h(Speed of current connection to USB host.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMthjubah}(h]h ]h"]h$]h&]uh1jhjyubeh}(h]h ]h"]h$]h&]uh1jhjhMthjXubj)}(h^``max_speed`` Maximal speed the UDC can handle. UDC must support this and all slower speeds. h](j)}(h ``max_speed``h]j)}(hjh]h max_speed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMvhjubj)}(hhh]h)}(hOMaximal speed the UDC can handle. UDC must support this and all slower speeds.h]hOMaximal speed the UDC can handle. UDC must support this and all slower speeds.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMuhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMvhjXubj)}(hN``ssp_rate`` Current connected SuperSpeed Plus signaling rate and lane count. h](j)}(h ``ssp_rate``h]j)}(hjh]hssp_rate}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMwhjubj)}(hhh]h)}(h@Current connected SuperSpeed Plus signaling rate and lane count.h]h@Current connected SuperSpeed Plus signaling rate and lane count.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMwhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMwhjXubj)}(h``max_ssp_rate`` Maximum SuperSpeed Plus signaling rate and lane count the UDC can handle. The UDC must support this and all slower speeds and lower number of lanes. h](j)}(h``max_ssp_rate``h]j)}(hj+h]h max_ssp_rate}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMzhj%ubj)}(hhh]h)}(hMaximum SuperSpeed Plus signaling rate and lane count the UDC can handle. The UDC must support this and all slower speeds and lower number of lanes.h]hMaximum SuperSpeed Plus signaling rate and lane count the UDC can handle. The UDC must support this and all slower speeds and lower number of lanes.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMxhjAubah}(h]h ]h"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]uh1jhj@hMzh jXubj)}(hF``state`` the state we are now (attached, suspended, configured, etc) h](j)}(h ``state``h]j)}(hjeh]hstate}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM{hj_ubj)}(hhh]h)}(h;the state we are now (attached, suspended, configured, etc)h]h;the state we are now (attached, suspended, configured, etc)}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjzhM{hj{ubah}(h]h ]h"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]uh1jhjzhM{hjXubj)}(hG``state_lock`` Spinlock protecting the `state` and `teardown` members. h](j)}(h``state_lock``h]j)}(hjh]h state_lock}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM|hjubj)}(hhh]h)}(h7Spinlock protecting the `state` and `teardown` members.h](hSpinlock protecting the }(hjhhhNhNubhtitle_reference)}(h`state`h]hstate}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h `teardown`h]hteardown}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh members.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhM|hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhM|hjXubj)}(hv``teardown`` True if the device is undergoing teardown, used to prevent new work from being scheduled during cleanup. h](j)}(h ``teardown``h]j)}(hjh]hteardown}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM~hjubj)}(hhh]h)}(hhTrue if the device is undergoing teardown, used to prevent new work from being scheduled during cleanup.h]hhTrue if the device is undergoing teardown, used to prevent new work from being scheduled during cleanup.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM}hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhM~hjXubj)}(hd``name`` Identifies the controller hardware type. Used in diagnostics and sometimes configuration. h](j)}(h``name``h]j)}(hj7h]hname}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj1ubj)}(hhh]h)}(hZIdentifies the controller hardware type. Used in diagnostics and sometimes configuration.h]hZIdentifies the controller hardware type. Used in diagnostics and sometimes configuration.}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjMubah}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]uh1jhjLhMhjXubj)}(h5``dev`` Driver model state for this abstract device. h](j)}(h``dev``h]j)}(hjqh]hdev}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjoubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjkubj)}(hhh]h)}(h,Driver model state for this abstract device.h]h,Driver model state for this abstract device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjkubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(hI``isoch_delay`` value from Set Isoch Delay request. Only valid on SS/SSP h](j)}(h``isoch_delay``h]j)}(hjh]h isoch_delay}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h8value from Set Isoch Delay request. Only valid on SS/SSPh]h8value from Set Isoch Delay request. Only valid on SS/SSP}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h&``out_epnum`` last used out ep number h](j)}(h ``out_epnum``h]j)}(hjh]h out_epnum}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(hlast used out ep numberh]hlast used out ep number}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h$``in_epnum`` last used in ep number h](j)}(h ``in_epnum``h]j)}(hjh]hin_epnum}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(hlast used in ep numberh]hlast used in ep number}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMhj2ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj1hMhjXubj)}(h``mA`` last set mA value h](j)}(h``mA``h]j)}(hjUh]hmA}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjOubj)}(hhh]h)}(hlast set mA valueh]hlast set mA value}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjjhMhjkubah}(h]h ]h"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]uh1jhjjhMhjXubj)}(h.``otg_caps`` OTG capabilities of this gadget. h](j)}(h ``otg_caps``h]j)}(hjh]hotg_caps}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h OTG capabilities of this gadget.h]h OTG capabilities of this gadget.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h6``sg_supported`` true if we can handle scatter-gather h](j)}(h``sg_supported``h]j)}(hjh]h sg_supported}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h$true if we can handle scatter-gatherh]h$true if we can handle scatter-gather}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(hy``is_otg`` True if the USB device port uses a Mini-AB jack, so that the gadget driver must provide a USB OTG descriptor. h](j)}(h ``is_otg``h]j)}(hjh]his_otg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(hmTrue if the USB device port uses a Mini-AB jack, so that the gadget driver must provide a USB OTG descriptor.h]hmTrue if the USB device port uses a Mini-AB jack, so that the gadget driver must provide a USB OTG descriptor.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h``is_a_peripheral`` False unless is_otg, the "A" end of a USB cable is in the Mini-AB jack, and HNP has been used to switch roles so that the "A" device currently acts as A-Peripheral, not A-Host. h](j)}(h``is_a_peripheral``h]j)}(hj:h]his_a_peripheral}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj4ubj)}(hhh]h)}(hFalse unless is_otg, the "A" end of a USB cable is in the Mini-AB jack, and HNP has been used to switch roles so that the "A" device currently acts as A-Peripheral, not A-Host.h]hFalse unless is_otg, the “A” end of a USB cable is in the Mini-AB jack, and HNP has been used to switch roles so that the “A” device currently acts as A-Peripheral, not A-Host.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjPubah}(h]h ]h"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]uh1jhjOhMhjXubj)}(hZ``b_hnp_enable`` OTG device feature flag, indicating that the A-Host enabled HNP support. h](j)}(h``b_hnp_enable``h]j)}(hjth]h b_hnp_enable}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjnubj)}(hhh]h)}(hHOTG device feature flag, indicating that the A-Host enabled HNP support.h]hHOTG device feature flag, indicating that the A-Host enabled HNP support.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjnubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(ha``a_hnp_support`` OTG device feature flag, indicating that the A-Host supports HNP at this port. h](j)}(h``a_hnp_support``h]j)}(hjh]h a_hnp_support}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(hNOTG device feature flag, indicating that the A-Host supports HNP at this port.h]hNOTG device feature flag, indicating that the A-Host supports HNP at this port.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(hv``a_alt_hnp_support`` OTG device feature flag, indicating that the A-Host only supports HNP on a different root port. h](j)}(h``a_alt_hnp_support``h]j)}(hjh]ha_alt_hnp_support}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h_OTG device feature flag, indicating that the A-Host only supports HNP on a different root port.h]h_OTG device feature flag, indicating that the A-Host only supports HNP on a different root port.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(hz``hnp_polling_support`` OTG device feature flag, indicating if the OTG device in peripheral mode can support HNP polling. h](j)}(h``hnp_polling_support``h]j)}(hj"h]hhnp_polling_support}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(haOTG device feature flag, indicating if the OTG device in peripheral mode can support HNP polling.h]haOTG device feature flag, indicating if the OTG device in peripheral mode can support HNP polling.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj8ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj7hMhjXubj)}(hs``host_request_flag`` OTG device feature flag, indicating if A-Peripheral or B-Peripheral wants to take host role. h](j)}(h``host_request_flag``h]j)}(hj\h]hhost_request_flag}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjVubj)}(hhh]h)}(h\OTG device feature flag, indicating if A-Peripheral or B-Peripheral wants to take host role.h]h\OTG device feature flag, indicating if A-Peripheral or B-Peripheral wants to take host role.}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjrubah}(h]h ]h"]h$]h&]uh1jhjVubeh}(h]h ]h"]h$]h&]uh1jhjqhMhjXubj)}(hY``quirk_ep_out_aligned_size`` epout requires buffer size to be aligned to MaxPacketSize. h](j)}(h``quirk_ep_out_aligned_size``h]j)}(hjh]hquirk_ep_out_aligned_size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h:epout requires buffer size to be aligned to MaxPacketSize.h]h:epout requires buffer size to be aligned to MaxPacketSize.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(hG``quirk_altset_not_supp`` UDC controller doesn't support alt settings. h](j)}(h``quirk_altset_not_supp``h]j)}(hjh]hquirk_altset_not_supp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h,UDC controller doesn't support alt settings.h]h.UDC controller doesn’t support alt settings.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(hB``quirk_stall_not_supp`` UDC controller doesn't support stalling. h](j)}(h``quirk_stall_not_supp``h]j)}(hj h]hquirk_stall_not_supp}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h(UDC controller doesn't support stalling.h]h*UDC controller doesn’t support stalling.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h;``quirk_zlp_not_supp`` UDC controller doesn't support ZLP. h](j)}(h``quirk_zlp_not_supp``h]j)}(hjBh]hquirk_zlp_not_supp}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj<ubj)}(hhh]h)}(h#UDC controller doesn't support ZLP.h]h%UDC controller doesn’t support ZLP.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjWhMhjXubah}(h]h ]h"]h$]h&]uh1jhj<ubeh}(h]h ]h"]h$]h&]uh1jhjWhMhjXubj)}(hl``quirk_avoids_skb_reserve`` udc/platform wants to avoid skb_reserve() in u_ether.c to improve performance. h](j)}(h``quirk_avoids_skb_reserve``h]j)}(hj{h]hquirk_avoids_skb_reserve}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjyubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjuubj)}(hhh]h)}(hNudc/platform wants to avoid skb_reserve() in u_ether.c to improve performance.h]hNudc/platform wants to avoid skb_reserve() in u_ether.c to improve performance.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjuubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h2``is_selfpowered`` if the gadget is self-powered. h](j)}(h``is_selfpowered``h]j)}(hjh]his_selfpowered}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(hif the gadget is self-powered.h]hif the gadget is self-powered.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h]``deactivated`` True if gadget is deactivated - in deactivated state it cannot be connected. h](j)}(h``deactivated``h]j)}(hjh]h deactivated}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(hLTrue if gadget is deactivated - in deactivated state it cannot be connected.h]hLTrue if gadget is deactivated - in deactivated state it cannot be connected.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h+``connected`` True if gadget is connected. h](j)}(h ``connected``h]j)}(hj(h]h connected}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj&ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj"ubj)}(hhh]h)}(hTrue if gadget is connected.h]hTrue if gadget is connected.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hMhj>ubah}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1jhj=hMhjXubj)}(h``lpm_capable`` If the gadget max_speed is FULL or HIGH, this flag indicates that it supports LPM as per the LPM ECN & errata. h](j)}(h``lpm_capable``h]j)}(hjah]h lpm_capable}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj[ubj)}(hhh]h)}(hnIf the gadget max_speed is FULL or HIGH, this flag indicates that it supports LPM as per the LPM ECN & errata.h]hnIf the gadget max_speed is FULL or HIGH, this flag indicates that it supports LPM as per the LPM ECN & errata.}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjwubah}(h]h ]h"]h$]h&]uh1jhj[ubeh}(h]h ]h"]h$]h&]uh1jhjvhMhjXubj)}(hG``wakeup_capable`` True if gadget is capable of sending remote wakeup. h](j)}(h``wakeup_capable``h]j)}(hjh]hwakeup_capable}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h3True if gadget is capable of sending remote wakeup.h]h3True if gadget is capable of sending remote wakeup.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(hH``wakeup_armed`` True if gadget is armed by the host for remote wakeup. h](j)}(h``wakeup_armed``h]j)}(hjh]h wakeup_armed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjubj)}(hhh]h)}(h6True if gadget is armed by the host for remote wakeup.h]h6True if gadget is armed by the host for remote wakeup.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjXubj)}(h4``irq`` the interrupt number for device controller. h](j)}(h``irq``h]j)}(hj h]hirq}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj ubj)}(hhh]h)}(h+the interrupt number for device controller.h]h+the interrupt number for device controller.}(hj& hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj" hMhj# ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj" hMhjXubj)}(hL``id_number`` a unique ID number for ensuring that gadget names are distincth](j)}(h ``id_number``h]j)}(hjF h]h id_number}(hjH hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjD ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj@ ubj)}(hhh]h)}(h>a unique ID number for ensuring that gadget names are distincth]h>a unique ID number for ensuring that gadget names are distinct}(hj_ hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj\ ubah}(h]h ]h"]h$]h&]uh1jhj@ ubeh}(h]h ]h"]h$]h&]uh1jhj[ hMhjXubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubh)}(h**Description**h]jP )}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hXGadgets have a mostly-portable "gadget driver" implementing device functions, handling all usb configurations and interfaces. Gadget drivers talk to hardware-specific code indirectly, through ops vectors. That insulates the gadget driver from hardware details, and packages the hardware endpoints through generic i/o queues. The "usb_gadget" and "usb_ep" interfaces provide that insulation from the hardware.h]hXGadgets have a mostly-portable “gadget driver” implementing device functions, handling all usb configurations and interfaces. Gadget drivers talk to hardware-specific code indirectly, through ops vectors. That insulates the gadget driver from hardware details, and packages the hardware endpoints through generic i/o queues. The “usb_gadget” and “usb_ep” interfaces provide that insulation from the hardware.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hXExcept for the driver data, all fields in this structure are read-only to the gadget driver. That driver data is part of the "driver model" infrastructure in 2.6 (and later) kernels, and for earlier systems is grouped in a similar structure that's not known to the rest of the kernel.h]hX#Except for the driver data, all fields in this structure are read-only to the gadget driver. That driver data is part of the “driver model” infrastructure in 2.6 (and later) kernels, and for earlier systems is grouped in a similar structure that’s not known to the rest of the kernel.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hXValues of the three OTG device feature flags are updated before the setup() call corresponding to USB_REQ_SET_CONFIGURATION, and before driver suspend() calls. They are valid only when is_otg, and when the device is acting as a B-Peripheral (so is_a_peripheral is false).h]hXValues of the three OTG device feature flags are updated before the setup() call corresponding to USB_REQ_SET_CONFIGURATION, and before driver suspend() calls. They are valid only when is_otg, and when the device is acting as a B-Peripheral (so is_a_peripheral is false).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_ep_align (C function)c.usb_ep_alignhNtauh1jhjthhhNhNubj)}(hhh](j)}(h3size_t usb_ep_align (struct usb_ep *ep, size_t len)h]j)}(h2size_t usb_ep_align(struct usb_ep *ep, size_t len)h](h)}(hhh]j)}(hsize_th]hsize_t}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj modnameN classnameNjj)}j]j)}j usb_ep_alignsbc.usb_ep_alignasbuh1hhj hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMubj)}(h h]h }(hj !hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj hhhj !hMubj)}(h usb_ep_alignh]j)}(hj!h]h usb_ep_align}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj hhhj !hMubjW)}(h(struct usb_ep *ep, size_t len)h](j])}(hstruct usb_ep *eph](j)}(hjh]hstruct}(hj7!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3!ubj)}(h h]h }(hjD!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3!ubh)}(hhh]j)}(husb_eph]husb_ep}(hjU!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjR!ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjW!modnameN classnameNjj)}j]j!c.usb_ep_alignasbuh1hhj3!ubj)}(h h]h }(hjs!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3!ubj)}(hjh]h*}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3!ubj)}(heph]hep}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3!ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj/!ubj])}(h size_t lenh](h)}(hhh]j)}(hsize_th]hsize_t}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj!modnameN classnameNjj)}j]j!c.usb_ep_alignasbuh1hhj!ubj)}(h h]h }(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubj)}(hlenh]hlen}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj/!ubeh}(h]h ]h"]h$]h&]j j uh1jVhj hhhj !hMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj hhhj !hMubah}(h]j ah ](j j eh"]h$]h&]j j )j huh1jhj !hMhj hhubj )}(hhh]h)}(h.returns **len** aligned to ep's maxpacketsize.h](hreturns }(hj"hhhNhNubjP )}(h**len**h]hlen}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj"ubh! aligned to ep’s maxpacketsize.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj!hhubah}(h]h ]h"]h$]h&]uh1j hj hhhj !hMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j*"jA j*"jB jC jD uh1jhhhjthNhNubjF )}(hX**Parameters** ``struct usb_ep *ep`` the endpoint whose maxpacketsize is used to align **len** ``size_t len`` buffer size's length to align to **ep**'s maxpacketsize **Description** This helper is used to align buffer's size to an ep's maxpacketsize.h](h)}(h**Parameters**h]jP )}(hj4"h]h Parameters}(hj6"hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj2"ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj."ubj)}(hhh](j)}(hP``struct usb_ep *ep`` the endpoint whose maxpacketsize is used to align **len** h](j)}(h``struct usb_ep *ep``h]j)}(hjS"h]hstruct usb_ep *ep}(hjU"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQ"ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjM"ubj)}(hhh]h)}(h9the endpoint whose maxpacketsize is used to align **len**h](h2the endpoint whose maxpacketsize is used to align }(hjl"hhhNhNubjP )}(h**len**h]hlen}(hjt"hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjl"ubeh}(h]h ]h"]h$]h&]uh1hhjh"hMhji"ubah}(h]h ]h"]h$]h&]uh1jhjM"ubeh}(h]h ]h"]h$]h&]uh1jhjh"hMhjJ"ubj)}(hG``size_t len`` buffer size's length to align to **ep**'s maxpacketsize h](j)}(h``size_t len``h]j)}(hj"h]h size_t len}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj"ubj)}(hhh]h)}(h7buffer size's length to align to **ep**'s maxpacketsizeh](h#buffer size’s length to align to }(hj"hhhNhNubjP )}(h**ep**h]hep}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj"ubh’s maxpacketsize}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj"hMhj"ubah}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1jhj"hMhjJ"ubeh}(h]h ]h"]h$]h&]uh1jhj."ubh)}(h**Description**h]jP )}(hj"h]h Description}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj"ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj."ubh)}(hDThis helper is used to align buffer's size to an ep's maxpacketsize.h]hHThis helper is used to align buffer’s size to an ep’s maxpacketsize.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj."ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_ep_align_maybe (C function)c.usb_ep_align_maybehNtauh1jhjthhhNhNubj)}(hhh](j)}(hOsize_t usb_ep_align_maybe (struct usb_gadget *g, struct usb_ep *ep, size_t len)h]j)}(hNsize_t usb_ep_align_maybe(struct usb_gadget *g, struct usb_ep *ep, size_t len)h](h)}(hhh]j)}(hsize_th]hsize_t}(hj/#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,#ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj1#modnameN classnameNjj)}j]j)}jusb_ep_align_maybesbc.usb_ep_align_maybeasbuh1hhj(#hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMubj)}(h h]h }(hjQ#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(#hhhjP#hMubj)}(husb_ep_align_maybeh]j)}(hjM#h]husb_ep_align_maybe}(hjc#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_#ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj(#hhhjP#hMubjW)}(h5(struct usb_gadget *g, struct usb_ep *ep, size_t len)h](j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hj~#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjz#ubj)}(h h]h }(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjz#ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj#modnameN classnameNjj)}j]jK#c.usb_ep_align_maybeasbuh1hhjz#ubj)}(h h]h }(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjz#ubj)}(hjh]h*}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjz#ubj)}(hgh]hg}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjz#ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjv#ubj])}(hstruct usb_ep *eph](j)}(hjh]hstruct}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubj)}(h h]h }(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubh)}(hhh]j)}(husb_eph]husb_ep}(hj $hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj $ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj$modnameN classnameNjj)}j]jK#c.usb_ep_align_maybeasbuh1hhj#ubj)}(h h]h }(hj*$hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubj)}(hjh]h*}(hj8$hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubj)}(heph]hep}(hjE$hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjv#ubj])}(h size_t lenh](h)}(hhh]j)}(hsize_th]hsize_t}(hja$hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^$ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjc$modnameN classnameNjj)}j]jK#c.usb_ep_align_maybeasbuh1hhjZ$ubj)}(h h]h }(hj$hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZ$ubj)}(hlenh]hlen}(hj$hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZ$ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjv#ubeh}(h]h ]h"]h$]h&]j j uh1jVhj(#hhhjP#hMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj$#hhhjP#hMubah}(h]j#ah ](j j eh"]h$]h&]j j )j huh1jhjP#hMhj!#hhubj )}(hhh]h)}(hrreturns **len** aligned to ep's maxpacketsize if gadget requires quirk_ep_out_aligned_size, otherwise returns len.h](hreturns }(hj$hhhNhNubjP )}(h**len**h]hlen}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj$ubhe aligned to ep’s maxpacketsize if gadget requires quirk_ep_out_aligned_size, otherwise returns len.}(hj$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj$hhubah}(h]h ]h"]h$]h&]uh1j hj!#hhhjP#hMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j$jA j$jB jC jD uh1jhhhjthNhNubjF )}(hXq**Parameters** ``struct usb_gadget *g`` controller to check for quirk ``struct usb_ep *ep`` the endpoint whose maxpacketsize is used to align **len** ``size_t len`` buffer size's length to align to **ep**'s maxpacketsize **Description** This helper is used in case it's required for any reason to check and maybe align buffer's size to an ep's maxpacketsize.h](h)}(h**Parameters**h]jP )}(hj$h]h Parameters}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj$ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM hj$ubj)}(hhh](j)}(h7``struct usb_gadget *g`` controller to check for quirk h](j)}(h``struct usb_gadget *g``h]j)}(hj %h]hstruct usb_gadget *g}(hj %hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj%ubj)}(hhh]h)}(hcontroller to check for quirkh]hcontroller to check for quirk}(hj#%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hMhj %ubah}(h]h ]h"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]uh1jhj%hMhj%ubj)}(hP``struct usb_ep *ep`` the endpoint whose maxpacketsize is used to align **len** h](j)}(h``struct usb_ep *ep``h]j)}(hjC%h]hstruct usb_ep *ep}(hjE%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjA%ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj=%ubj)}(hhh]h)}(h9the endpoint whose maxpacketsize is used to align **len**h](h2the endpoint whose maxpacketsize is used to align }(hj\%hhhNhNubjP )}(h**len**h]hlen}(hjd%hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj\%ubeh}(h]h ]h"]h$]h&]uh1hhjX%hMhjY%ubah}(h]h ]h"]h$]h&]uh1jhj=%ubeh}(h]h ]h"]h$]h&]uh1jhjX%hMhj%ubj)}(hG``size_t len`` buffer size's length to align to **ep**'s maxpacketsize h](j)}(h``size_t len``h]j)}(hj%h]h size_t len}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM hj%ubj)}(hhh]h)}(h7buffer size's length to align to **ep**'s maxpacketsizeh](h#buffer size’s length to align to }(hj%hhhNhNubjP )}(h**ep**h]hep}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj%ubh’s maxpacketsize}(hj%hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hM hj%ubah}(h]h ]h"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]uh1jhj%hM hj%ubeh}(h]h ]h"]h$]h&]uh1jhj$ubh)}(h**Description**h]jP )}(hj%h]h Description}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj%ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM"hj$ubh)}(hyThis helper is used in case it's required for any reason to check and maybe align buffer's size to an ep's maxpacketsize.h]hThis helper is used in case it’s required for any reason to check and maybe align buffer’s size to an ep’s maxpacketsize.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM!hj$ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'gadget_is_altset_supported (C function)c.gadget_is_altset_supportedhNtauh1jhjthhhNhNubj)}(hhh](j)}(h5int gadget_is_altset_supported (struct usb_gadget *g)h]j)}(h4int gadget_is_altset_supported(struct usb_gadget *g)h](j)}(hinth]hint}(hj&hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj&hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM,ubj)}(h h]h }(hj+&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&hhhj*&hM,ubj)}(hgadget_is_altset_supportedh]j)}(hgadget_is_altset_supportedh]hgadget_is_altset_supported}(hj=&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj9&ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj&hhhj*&hM,ubjW)}(h(struct usb_gadget *g)h]j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hjY&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU&ubj)}(h h]h }(hjf&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU&ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hjw&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjt&ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjy&modnameN classnameNjj)}j]j)}jj?&sbc.gadget_is_altset_supportedasbuh1hhjU&ubj)}(h h]h }(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU&ubj)}(hjh]h*}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU&ubj)}(hj#h]hg}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU&ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjQ&ubah}(h]h ]h"]h$]h&]j j uh1jVhj&hhhj*&hM,ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj&hhhj*&hM,ubah}(h]j&ah ](j j eh"]h$]h&]j j )j huh1jhj*&hM,hj&hhubj )}(hhh]h)}(h1return true iff the hardware supports altsettingsh]h1return true iff the hardware supports altsettings}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM,hj&hhubah}(h]h ]h"]h$]h&]uh1j hj&hhhj*&hM,ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j&jA j&jB jC jD uh1jhhhjthNhNubjF )}(hH**Parameters** ``struct usb_gadget *g`` controller to check for quirkh](h)}(h**Parameters**h]jP )}(hj&h]h Parameters}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj&ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM0hj&ubj)}(hhh]j)}(h6``struct usb_gadget *g`` controller to check for quirkh](j)}(h``struct usb_gadget *g``h]j)}(hj'h]hstruct usb_gadget *g}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM2hj'ubj)}(hhh]h)}(hcontroller to check for quirkh]hcontroller to check for quirk}(hj5'hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM.hj2'ubah}(h]h ]h"]h$]h&]uh1jhj'ubeh}(h]h ]h"]h$]h&]uh1jhj1'hM2hj'ubah}(h]h ]h"]h$]h&]uh1jhj&ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&gadget_is_stall_supported (C function)c.gadget_is_stall_supportedhNtauh1jhjthhhNhNubj)}(hhh](j)}(h4int gadget_is_stall_supported (struct usb_gadget *g)h]j)}(h3int gadget_is_stall_supported(struct usb_gadget *g)h](j)}(hinth]hint}(hjv'hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjr'hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM6ubj)}(h h]h }(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjr'hhhj'hM6ubj)}(hgadget_is_stall_supportedh]j)}(hgadget_is_stall_supportedh]hgadget_is_stall_supported}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubah}(h]h ](j j eh"]h$]h&]j j uh1jhjr'hhhj'hM6ubjW)}(h(struct usb_gadget *g)h]j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubj)}(h h]h }(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj'modnameN classnameNjj)}j]j)}jj'sbc.gadget_is_stall_supportedasbuh1hhj'ubj)}(h h]h }(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubj)}(hjh]h*}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubj)}(hj#h]hg}(hj (hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj'ubah}(h]h ]h"]h$]h&]j j uh1jVhjr'hhhj'hM6ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjn'hhhj'hM6ubah}(h]ji'ah ](j j eh"]h$]h&]j j )j huh1jhj'hM6hjk'hhubj )}(hhh]h)}(h.return true iff the hardware supports stallingh]h.return true iff the hardware supports stalling}(hj5(hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM6hj2(hhubah}(h]h ]h"]h$]h&]uh1j hjk'hhhj'hM6ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jM(jA jM(jB jC jD uh1jhhhjthNhNubjF )}(hH**Parameters** ``struct usb_gadget *g`` controller to check for quirkh](h)}(h**Parameters**h]jP )}(hjW(h]h Parameters}(hjY(hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjU(ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM:hjQ(ubj)}(hhh]j)}(h6``struct usb_gadget *g`` controller to check for quirkh](j)}(h``struct usb_gadget *g``h]j)}(hjv(h]hstruct usb_gadget *g}(hjx(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjt(ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM<hjp(ubj)}(hhh]h)}(hcontroller to check for quirkh]hcontroller to check for quirk}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM7hj(ubah}(h]h ]h"]h$]h&]uh1jhjp(ubeh}(h]h ]h"]h$]h&]uh1jhj(hM<hjm(ubah}(h]h ]h"]h$]h&]uh1jhjQ(ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$gadget_is_zlp_supported (C function)c.gadget_is_zlp_supportedhNtauh1jhjthhhNhNubj)}(hhh](j)}(h2int gadget_is_zlp_supported (struct usb_gadget *g)h]j)}(h1int gadget_is_zlp_supported(struct usb_gadget *g)h](j)}(hinth]hint}(hj(hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj(hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM?ubj)}(h h]h }(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(hhhj(hM?ubj)}(hgadget_is_zlp_supportedh]j)}(hgadget_is_zlp_supportedh]hgadget_is_zlp_supported}(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj(hhhj(hM?ubjW)}(h(struct usb_gadget *g)h]j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hj )hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj )ubj)}(h h]h }(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj )ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hj+)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj()ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj-)modnameN classnameNjj)}j]j)}jj(sbc.gadget_is_zlp_supportedasbuh1hhj )ubj)}(h h]h }(hjK)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj )ubj)}(hjh]h*}(hjY)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj )ubj)}(hj#h]hg}(hjf)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj )ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj)ubah}(h]h ]h"]h$]h&]j j uh1jVhj(hhhj(hM?ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj(hhhj(hM?ubah}(h]j(ah ](j j eh"]h$]h&]j j )j huh1jhj(hM?hj(hhubj )}(hhh]h)}(h)return true iff the hardware supports zlph]h)return true iff the hardware supports zlp}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM?hj)hhubah}(h]h ]h"]h$]h&]uh1j hj(hhhj(hM?ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j)jA j)jB jC jD uh1jhhhjthNhNubjF )}(hH**Parameters** ``struct usb_gadget *g`` controller to check for quirkh](h)}(h**Parameters**h]jP )}(hj)h]h Parameters}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj)ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMChj)ubj)}(hhh]j)}(h6``struct usb_gadget *g`` controller to check for quirkh](j)}(h``struct usb_gadget *g``h]j)}(hj)h]hstruct usb_gadget *g}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMEhj)ubj)}(hhh]h)}(hcontroller to check for quirkh]hcontroller to check for quirk}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM@hj)ubah}(h]h ]h"]h$]h&]uh1jhj)ubeh}(h]h ]h"]h$]h&]uh1jhj)hMEhj)ubah}(h]h ]h"]h$]h&]uh1jhj)ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&gadget_avoids_skb_reserve (C function)c.gadget_avoids_skb_reservehNtauh1jhjthhhNhNubj)}(hhh](j)}(h4int gadget_avoids_skb_reserve (struct usb_gadget *g)h]j)}(h3int gadget_avoids_skb_reserve(struct usb_gadget *g)h](j)}(hinth]hint}(hj**hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj&*hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMHubj)}(h h]h }(hj9*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&*hhhj8*hMHubj)}(hgadget_avoids_skb_reserveh]j)}(hgadget_avoids_skb_reserveh]hgadget_avoids_skb_reserve}(hjK*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjG*ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj&*hhhj8*hMHubjW)}(h(struct usb_gadget *g)h]j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hjg*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjc*ubj)}(h h]h }(hjt*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjc*ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj*modnameN classnameNjj)}j]j)}jjM*sbc.gadget_avoids_skb_reserveasbuh1hhjc*ubj)}(h h]h }(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjc*ubj)}(hjh]h*}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjc*ubj)}(hj#h]hg}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjc*ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj_*ubah}(h]h ]h"]h$]h&]j j uh1jVhj&*hhhj8*hMHubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj"*hhhj8*hMHubah}(h]j*ah ](j j eh"]h$]h&]j j )j huh1jhj8*hMHhj*hhubj )}(hhh]h)}(hTreturn true iff the hardware would like to avoid skb_reserve to improve performance.h]hTreturn true iff the hardware would like to avoid skb_reserve to improve performance.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMHhj*hhubah}(h]h ]h"]h$]h&]uh1j hj*hhhj8*hMHubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j+jA j+jB jC jD uh1jhhhjthNhNubjF )}(hH**Parameters** ``struct usb_gadget *g`` controller to check for quirkh](h)}(h**Parameters**h]jP )}(hj +h]h Parameters}(hj +hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj +ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMLhj+ubj)}(hhh]j)}(h6``struct usb_gadget *g`` controller to check for quirkh](j)}(h``struct usb_gadget *g``h]j)}(hj*+h]hstruct usb_gadget *g}(hj,+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(+ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMNhj$+ubj)}(hhh]h)}(hcontroller to check for quirkh]hcontroller to check for quirk}(hjC+hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMJhj@+ubah}(h]h ]h"]h$]h&]uh1jhj$+ubeh}(h]h ]h"]h$]h&]uh1jhj?+hMNhj!+ubah}(h]h ]h"]h$]h&]uh1jhj+ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j gadget_is_dualspeed (C function)c.gadget_is_dualspeedhNtauh1jhjthhhNhNubj)}(hhh](j)}(h.int gadget_is_dualspeed (struct usb_gadget *g)h]j)}(h-int gadget_is_dualspeed(struct usb_gadget *g)h](j)}(hinth]hint}(hj+hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj+hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMRubj)}(h h]h }(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+hhhj+hMRubj)}(hgadget_is_dualspeedh]j)}(hgadget_is_dualspeedh]hgadget_is_dualspeed}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj+hhhj+hMRubjW)}(h(struct usb_gadget *g)h]j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubj)}(h h]h }(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj+modnameN classnameNjj)}j]j)}jj+sbc.gadget_is_dualspeedasbuh1hhj+ubj)}(h h]h }(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubj)}(hjh]h*}(hj ,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubj)}(hj#h]hg}(hj,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj+ubah}(h]h ]h"]h$]h&]j j uh1jVhj+hhhj+hMRubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj|+hhhj+hMRubah}(h]jw+ah ](j j eh"]h$]h&]j j )j huh1jhj+hMRhjy+hhubj )}(hhh]h)}(h/return true iff the hardware handles high speedh]h/return true iff the hardware handles high speed}(hjC,hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMRhj@,hhubah}(h]h ]h"]h$]h&]uh1j hjy+hhhj+hMRubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j[,jA j[,jB jC jD uh1jhhhjthNhNubjF )}(hb**Parameters** ``struct usb_gadget *g`` controller that might support both high and full speedsh](h)}(h**Parameters**h]jP )}(hje,h]h Parameters}(hjg,hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjc,ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMVhj_,ubj)}(hhh]j)}(hP``struct usb_gadget *g`` controller that might support both high and full speedsh](j)}(h``struct usb_gadget *g``h]j)}(hj,h]hstruct usb_gadget *g}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMXhj~,ubj)}(hhh]h)}(h7controller that might support both high and full speedsh]h7controller that might support both high and full speeds}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMShj,ubah}(h]h ]h"]h$]h&]uh1jhj~,ubeh}(h]h ]h"]h$]h&]uh1jhj,hMXhj{,ubah}(h]h ]h"]h$]h&]uh1jhj_,ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!gadget_is_superspeed (C function)c.gadget_is_superspeedhNtauh1jhjthhhNhNubj)}(hhh](j)}(h/int gadget_is_superspeed (struct usb_gadget *g)h]j)}(h.int gadget_is_superspeed(struct usb_gadget *g)h](j)}(hinth]hint}(hj,hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj,hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM[ubj)}(h h]h }(hj,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,hhhj,hM[ubj)}(hgadget_is_superspeedh]j)}(hgadget_is_superspeedh]hgadget_is_superspeed}(hj,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj,hhhj,hM[ubjW)}(h(struct usb_gadget *g)h]j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hj-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-ubj)}(h h]h }(hj(-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hj9-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6-ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj;-modnameN classnameNjj)}j]j)}jj-sbc.gadget_is_superspeedasbuh1hhj-ubj)}(h h]h }(hjY-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-ubj)}(hjh]h*}(hjg-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-ubj)}(hj#h]hg}(hjt-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj-ubah}(h]h ]h"]h$]h&]j j uh1jVhj,hhhj,hM[ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj,hhhj,hM[ubah}(h]j,ah ](j j eh"]h$]h&]j j )j huh1jhj,hM[hj,hhubj )}(hhh]h)}(h.return true if the hardware handles superspeedh]h.return true if the hardware handles superspeed}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM[hj-hhubah}(h]h ]h"]h$]h&]uh1j hj,hhhj,hM[ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j-jA j-jB jC jD uh1jhhhjthNhNubjF )}(hS**Parameters** ``struct usb_gadget *g`` controller that might support superspeedh](h)}(h**Parameters**h]jP )}(hj-h]h Parameters}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj-ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM_hj-ubj)}(hhh]j)}(hA``struct usb_gadget *g`` controller that might support superspeedh](j)}(h``struct usb_gadget *g``;h]j)}(hj-h]hstruct usb_gadget *g}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMahj-ubj)}(hhh]h)}(h(controller that might support superspeedh]h(controller that might support superspeed}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM\hj-ubah}(h]h ]h"]h$]h&]uh1jhj-ubeh}(h]h ]h"]h$]h&]uh1jhj-hMahj-ubah}(h]h ]h"]h$]h&]uh1jhj-ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&gadget_is_superspeed_plus (C function)c.gadget_is_superspeed_plushNtauh1jhjthhhNhNubj)}(hhh](j)}(h4int gadget_is_superspeed_plus (struct usb_gadget *g)h]j)}(h3int gadget_is_superspeed_plus(struct usb_gadget *g)h](j)}(hinth]hint}(hj8.hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj4.hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMdubj)}(h h]h }(hjG.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4.hhhjF.hMdubj)}(hgadget_is_superspeed_plush]j)}(hgadget_is_superspeed_plush]hgadget_is_superspeed_plus}(hjY.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU.ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj4.hhhjF.hMdubjW)}(h(struct usb_gadget *g)h]j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hju.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq.ubj)}(h h]h }(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq.ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj.modnameN classnameNjj)}j]j)}jj[.sbc.gadget_is_superspeed_plusasbuh1hhjq.ubj)}(h h]h }(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq.ubj)}(hjh]h*}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq.ubj)}(hj#h]hg}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq.ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjm.ubah}(h]h ]h"]h$]h&]j j uh1jVhj4.hhhjF.hMdubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj0.hhhjF.hMdubah}(h]j+.ah ](j j eh"]h$]h&]j j )j huh1jhjF.hMdhj-.hhubj )}(hhh]h)}(h3return true if the hardware handles superspeed plush]h3return true if the hardware handles superspeed plus}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMdhj.hhubah}(h]h ]h"]h$]h&]uh1j hj-.hhhjF.hMdubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j/jA j/jB jC jD uh1jhhhjthNhNubjF )}(hX**Parameters** ``struct usb_gadget *g`` controller that might support superspeed plush](h)}(h**Parameters**h]jP )}(hj/h]h Parameters}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj/ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhhj/ubj)}(hhh]j)}(hF``struct usb_gadget *g`` controller that might support superspeed plush](j)}(h``struct usb_gadget *g``h]j)}(hj8/h]hstruct usb_gadget *g}(hj:/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6/ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMjhj2/ubj)}(hhh]h)}(h-controller that might support superspeed plush]h-controller that might support superspeed plus}(hjQ/hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMfhjN/ubah}(h]h ]h"]h$]h&]uh1jhj2/ubeh}(h]h ]h"]h$]h&]uh1jhjM/hMjhj//ubah}(h]h ]h"]h$]h&]uh1jhj/ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jgadget_is_otg (C function)c.gadget_is_otghNtauh1jhjthhhNhNubj)}(hhh](j)}(h(int gadget_is_otg (struct usb_gadget *g)h]j)}(h'int gadget_is_otg(struct usb_gadget *g)h](j)}(hinth]hint}(hj/hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj/hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMnubj)}(h h]h }(hj/hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/hhhj/hMnubj)}(h gadget_is_otgh]j)}(h gadget_is_otgh]h gadget_is_otg}(hj/hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj/hhhj/hMnubjW)}(h(struct usb_gadget *g)h]j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hj/hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubj)}(h h]h }(hj/hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hj/hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj/modnameN classnameNjj)}j]j)}jj/sbc.gadget_is_otgasbuh1hhj/ubj)}(h h]h }(hj 0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubj)}(hjh]h*}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubj)}(hj#h]hg}(hj(0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj/ubah}(h]h ]h"]h$]h&]j j uh1jVhj/hhhj/hMnubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj/hhhj/hMnubah}(h]j/ah ](j j eh"]h$]h&]j j )j huh1jhj/hMnhj/hhubj )}(hhh]h)}(h)return true iff the hardware is OTG-readyh]h)return true iff the hardware is OTG-ready}(hjQ0hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMnhjN0hhubah}(h]h ]h"]h$]h&]uh1j hj/hhhj/hMnubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ ji0jA ji0jB jC jD uh1jhhhjthNhNubjF )}(h**Parameters** ``struct usb_gadget *g`` controller that might have a Mini-AB connector **Description** This is a runtime test, since kernels with a USB-OTG stack sometimes run on boards which only have a Mini-B (or Mini-A) connector.h](h)}(h**Parameters**h]jP )}(hjs0h]h Parameters}(hju0hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjq0ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMrhjm0ubj)}(hhh]j)}(hH``struct usb_gadget *g`` controller that might have a Mini-AB connector h](j)}(h``struct usb_gadget *g``h]j)}(hj0h]hstruct usb_gadget *g}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj0ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMohj0ubj)}(hhh]h)}(h.controller that might have a Mini-AB connectorh]h.controller that might have a Mini-AB connector}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0hMohj0ubah}(h]h ]h"]h$]h&]uh1jhj0ubeh}(h]h ]h"]h$]h&]uh1jhj0hMohj0ubah}(h]h ]h"]h$]h&]uh1jhjm0ubh)}(h**Description**h]jP )}(hj0h]h Description}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj0ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMqhjm0ubh)}(hThis is a runtime test, since kernels with a USB-OTG stack sometimes run on boards which only have a Mini-B (or Mini-A) connector.h]hThis is a runtime test, since kernels with a USB-OTG stack sometimes run on boards which only have a Mini-B (or Mini-A) connector.}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMphjm0ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_gadget_driver (C struct)c.usb_gadget_driverhNtauh1jhjthhhNhNubj)}(hhh](j)}(husb_gadget_driverh]j)}(hstruct usb_gadget_driverh](j)}(hjh]hstruct}(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj1hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMvubj)}(h h]h }(hj 1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj1hhhj1hMvubj)}(husb_gadget_driverh]j)}(hj 1h]husb_gadget_driver}(hj21hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.1ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj1hhhj1hMvubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj 1hhhj1hMvubah}(h]j1ah ](j j eh"]h$]h&]j j )j huh1jhj1hMvhj1hhubj )}(hhh]h)}(hdriver for usb gadget devicesh]hdriver for usb gadget devices}(hjT1hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjQ1hhubah}(h]h ]h"]h$]h&]uh1j hj1hhhj1hMvubeh}(h]h ](jstructeh"]h$]h&]j? jj@ jl1jA jl1jB jC jD uh1jhhhjthNhNubjF )}(hXh**Definition**:: struct usb_gadget_driver { char *function; enum usb_device_speed max_speed; int (*bind)(struct usb_gadget *gadget, struct usb_gadget_driver *driver); void (*unbind)(struct usb_gadget *); int (*setup)(struct usb_gadget *, const struct usb_ctrlrequest *); void (*disconnect)(struct usb_gadget *); void (*suspend)(struct usb_gadget *); void (*resume)(struct usb_gadget *); void (*reset)(struct usb_gadget *); struct device_driver driver; char *udc_name; unsigned match_existing_only:1; bool is_bound:1; }; **Members** ``function`` String describing the gadget's function ``max_speed`` Highest speed the driver handles. ``bind`` the driver's bind callback ``unbind`` Invoked when the driver is unbound from a gadget, usually from rmmod (after a disconnect is reported). Called in a context that permits sleeping. ``setup`` Invoked for ep0 control requests that aren't handled by the hardware level driver. Most calls must be handled by the gadget driver, including descriptor and configuration management. The 16 bit members of the setup data are in USB byte order. Called in_interrupt; this may not sleep. Driver queues a response to ep0, or returns negative to stall. ``disconnect`` Invoked after all transfers have been stopped, when the host is disconnected. May be called in_interrupt; this may not sleep. Some devices can't detect disconnect, so this might not be called except as part of controller shutdown. ``suspend`` Invoked on USB suspend. May be called in_interrupt. ``resume`` Invoked on USB resume. May be called in_interrupt. ``reset`` Invoked on USB bus reset. It is mandatory for all gadget drivers and should be called in_interrupt. ``driver`` Driver model state for this driver. ``udc_name`` A name of UDC this driver should be bound to. If udc_name is NULL, this driver will be bound to any available UDC. ``match_existing_only`` If udc is not found, return an error and fail the driver registration ``is_bound`` Allow a driver to be bound to only one gadgeth](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hjx1hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjt1ubh:}(hjt1hhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjp1ubjk )}(hX/struct usb_gadget_driver { char *function; enum usb_device_speed max_speed; int (*bind)(struct usb_gadget *gadget, struct usb_gadget_driver *driver); void (*unbind)(struct usb_gadget *); int (*setup)(struct usb_gadget *, const struct usb_ctrlrequest *); void (*disconnect)(struct usb_gadget *); void (*suspend)(struct usb_gadget *); void (*resume)(struct usb_gadget *); void (*reset)(struct usb_gadget *); struct device_driver driver; char *udc_name; unsigned match_existing_only:1; bool is_bound:1; };h]hX/struct usb_gadget_driver { char *function; enum usb_device_speed max_speed; int (*bind)(struct usb_gadget *gadget, struct usb_gadget_driver *driver); void (*unbind)(struct usb_gadget *); int (*setup)(struct usb_gadget *, const struct usb_ctrlrequest *); void (*disconnect)(struct usb_gadget *); void (*suspend)(struct usb_gadget *); void (*resume)(struct usb_gadget *); void (*reset)(struct usb_gadget *); struct device_driver driver; char *udc_name; unsigned match_existing_only:1; bool is_bound:1; };}hj1sbah}(h]h ]h"]h$]h&]j j uh1jj ha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjp1ubh)}(h **Members**h]jP )}(hj1h]hMembers}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj1ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjp1ubj)}(hhh](j)}(h5``function`` String describing the gadget's function h](j)}(h ``function``h]j)}(hj1h]hfunction}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj1ubj)}(hhh]h)}(h'String describing the gadget's functionh]h)String describing the gadget’s function}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMhj1ubah}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]uh1jhj1hMhj1ubj)}(h0``max_speed`` Highest speed the driver handles. h](j)}(h ``max_speed``h]j)}(hj1h]h max_speed}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj1ubj)}(hhh]h)}(h!Highest speed the driver handles.h]h!Highest speed the driver handles.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2hMhj2ubah}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]uh1jhj2hMhj1ubj)}(h$``bind`` the driver's bind callback h](j)}(h``bind``h]j)}(hj32h]hbind}(hj52hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj12ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj-2ubj)}(hhh]h)}(hthe driver's bind callbackh]hthe driver’s bind callback}(hjL2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjH2hMhjI2ubah}(h]h ]h"]h$]h&]uh1jhj-2ubeh}(h]h ]h"]h$]h&]uh1jhjH2hMhj1ubj)}(h``unbind`` Invoked when the driver is unbound from a gadget, usually from rmmod (after a disconnect is reported). Called in a context that permits sleeping. h](j)}(h ``unbind``h]j)}(hjl2h]hunbind}(hjn2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjj2ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjf2ubj)}(hhh]h)}(hInvoked when the driver is unbound from a gadget, usually from rmmod (after a disconnect is reported). Called in a context that permits sleeping.h]hInvoked when the driver is unbound from a gadget, usually from rmmod (after a disconnect is reported). Called in a context that permits sleeping.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj2ubah}(h]h ]h"]h$]h&]uh1jhjf2ubeh}(h]h ]h"]h$]h&]uh1jhj2hMhj1ubj)}(hXg``setup`` Invoked for ep0 control requests that aren't handled by the hardware level driver. Most calls must be handled by the gadget driver, including descriptor and configuration management. The 16 bit members of the setup data are in USB byte order. Called in_interrupt; this may not sleep. Driver queues a response to ep0, or returns negative to stall. h](j)}(h ``setup``h]j)}(hj2h]hsetup}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj2ubj)}(hhh]h)}(hX\Invoked for ep0 control requests that aren't handled by the hardware level driver. Most calls must be handled by the gadget driver, including descriptor and configuration management. The 16 bit members of the setup data are in USB byte order. Called in_interrupt; this may not sleep. Driver queues a response to ep0, or returns negative to stall.h]hX^Invoked for ep0 control requests that aren’t handled by the hardware level driver. Most calls must be handled by the gadget driver, including descriptor and configuration management. The 16 bit members of the setup data are in USB byte order. Called in_interrupt; this may not sleep. Driver queues a response to ep0, or returns negative to stall.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj2ubah}(h]h ]h"]h$]h&]uh1jhj2ubeh}(h]h ]h"]h$]h&]uh1jhj2hMhj1ubj)}(h``disconnect`` Invoked after all transfers have been stopped, when the host is disconnected. May be called in_interrupt; this may not sleep. Some devices can't detect disconnect, so this might not be called except as part of controller shutdown. h](j)}(h``disconnect``h]j)}(hj2h]h disconnect}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj2ubj)}(hhh]h)}(hInvoked after all transfers have been stopped, when the host is disconnected. May be called in_interrupt; this may not sleep. Some devices can't detect disconnect, so this might not be called except as part of controller shutdown.h]hInvoked after all transfers have been stopped, when the host is disconnected. May be called in_interrupt; this may not sleep. Some devices can’t detect disconnect, so this might not be called except as part of controller shutdown.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj2ubah}(h]h ]h"]h$]h&]uh1jhj2ubeh}(h]h ]h"]h$]h&]uh1jhj2hMhj1ubj)}(hA``suspend`` Invoked on USB suspend. May be called in_interrupt. h](j)}(h ``suspend``h]j)}(hj3h]hsuspend}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj3ubj)}(hhh]h)}(h4Invoked on USB suspend. May be called in_interrupt.h]h4Invoked on USB suspend. May be called in_interrupt.}(hj33hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/3hMhj03ubah}(h]h ]h"]h$]h&]uh1jhj3ubeh}(h]h ]h"]h$]h&]uh1jhj/3hMhj1ubj)}(h?``resume`` Invoked on USB resume. May be called in_interrupt. h](j)}(h ``resume``h]j)}(hjS3h]hresume}(hjU3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQ3ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjM3ubj)}(hhh]h)}(h3Invoked on USB resume. May be called in_interrupt.h]h3Invoked on USB resume. May be called in_interrupt.}(hjl3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjh3hMhji3ubah}(h]h ]h"]h$]h&]uh1jhjM3ubeh}(h]h ]h"]h$]h&]uh1jhjh3hMhj1ubj)}(hn``reset`` Invoked on USB bus reset. It is mandatory for all gadget drivers and should be called in_interrupt. h](j)}(h ``reset``h]j)}(hj3h]hreset}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj3ubj)}(hhh]h)}(hcInvoked on USB bus reset. It is mandatory for all gadget drivers and should be called in_interrupt.h]hcInvoked on USB bus reset. It is mandatory for all gadget drivers and should be called in_interrupt.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj3ubah}(h]h ]h"]h$]h&]uh1jhj3ubeh}(h]h ]h"]h$]h&]uh1jhj3hMhj1ubj)}(h/``driver`` Driver model state for this driver. h](j)}(h ``driver``h]j)}(hj3h]hdriver}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj3ubj)}(hhh]h)}(h#Driver model state for this driver.h]h#Driver model state for this driver.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3hMhj3ubah}(h]h ]h"]h$]h&]uh1jhj3ubeh}(h]h ]h"]h$]h&]uh1jhj3hMhj1ubj)}(h``udc_name`` A name of UDC this driver should be bound to. If udc_name is NULL, this driver will be bound to any available UDC. h](j)}(h ``udc_name``h]j)}(hj3h]hudc_name}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj3ubj)}(hhh]h)}(hrA name of UDC this driver should be bound to. If udc_name is NULL, this driver will be bound to any available UDC.h]hrA name of UDC this driver should be bound to. If udc_name is NULL, this driver will be bound to any available UDC.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj4ubah}(h]h ]h"]h$]h&]uh1jhj3ubeh}(h]h ]h"]h$]h&]uh1jhj4hMhj1ubj)}(h^``match_existing_only`` If udc is not found, return an error and fail the driver registration h](j)}(h``match_existing_only``h]j)}(hj94h]hmatch_existing_only}(hj;4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj74ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj34ubj)}(hhh]h)}(hEIf udc is not found, return an error and fail the driver registrationh]hEIf udc is not found, return an error and fail the driver registration}(hjR4hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjO4ubah}(h]h ]h"]h$]h&]uh1jhj34ubeh}(h]h ]h"]h$]h&]uh1jhjN4hMhj1ubj)}(h:``is_bound`` Allow a driver to be bound to only one gadgeth](j)}(h ``is_bound``h]j)}(hjs4h]his_bound}(hju4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjq4ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjm4ubj)}(hhh]h)}(h-Allow a driver to be bound to only one gadgeth]h-Allow a driver to be bound to only one gadget}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj4ubah}(h]h ]h"]h$]h&]uh1jhjm4ubeh}(h]h ]h"]h$]h&]uh1jhj4hMhj1ubeh}(h]h ]h"]h$]h&]uh1jhjp1ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubh)}(h**Description**h]jP )}(hj4h]h Description}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj4ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hDevices are disabled till a gadget driver successfully bind()s, which means the driver will handle setup() requests needed to enumerate (and meet "chapter 9" requirements) then do some useful work.h]hDevices are disabled till a gadget driver successfully bind()s, which means the driver will handle setup() requests needed to enumerate (and meet “chapter 9” requirements) then do some useful work.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hXIf gadget->is_otg is true, the gadget driver must provide an OTG descriptor during enumeration, or else fail the bind() call. In such cases, no USB traffic may flow until both bind() returns without having called usb_gadget_disconnect(), and the USB host stack has initialized.h]hXIf gadget->is_otg is true, the gadget driver must provide an OTG descriptor during enumeration, or else fail the bind() call. In such cases, no USB traffic may flow until both bind() returns without having called usb_gadget_disconnect(), and the USB host stack has initialized.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hDrivers use hardware-specific knowledge to configure the usb hardware. endpoint addressing is only one of several hardware characteristics that are in descriptors the ep0 implementation returns from setup() calls.h]hDrivers use hardware-specific knowledge to configure the usb hardware. endpoint addressing is only one of several hardware characteristics that are in descriptors the ep0 implementation returns from setup() calls.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hExcept for ep0 implementation, most driver code shouldn't need change to run on top of different usb controllers. It'll use endpoints set up by that ep0 implementation.h]hExcept for ep0 implementation, most driver code shouldn’t need change to run on top of different usb controllers. It’ll use endpoints set up by that ep0 implementation.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hThe usb controller driver handles a few standard usb requests. Those include set_address, and feature flags for devices, interfaces, and endpoints (the get_status, set_feature, and clear_feature requests).h]hThe usb controller driver handles a few standard usb requests. Those include set_address, and feature flags for devices, interfaces, and endpoints (the get_status, set_feature, and clear_feature requests).}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hXZAccordingly, the driver's setup() callback must always implement all get_descriptor requests, returning at least a device descriptor and a configuration descriptor. Drivers must make sure the endpoint descriptors match any hardware constraints. Some hardware also constrains other descriptors. (The pxa250 allows only configurations 1, 2, or 3).h]hX\Accordingly, the driver’s setup() callback must always implement all get_descriptor requests, returning at least a device descriptor and a configuration descriptor. Drivers must make sure the endpoint descriptors match any hardware constraints. Some hardware also constrains other descriptors. (The pxa250 allows only configurations 1, 2, or 3).}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hThe driver's setup() callback must also implement set_configuration, and should also implement set_interface, get_configuration, and get_interface. Setting a configuration (or interface) is where endpoints should be activated or (config 0) shut down.h]hThe driver’s setup() callback must also implement set_configuration, and should also implement set_interface, get_configuration, and get_interface. Setting a configuration (or interface) is where endpoints should be activated or (config 0) shut down.}(hj&5hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hXThe gadget driver's setup() callback does not have to queue a response to ep0 within the setup() call, the driver can do it after setup() returns. The UDC driver must wait until such a response is queued before proceeding with the data/status stages of the control transfer.h]hXThe gadget driver’s setup() callback does not have to queue a response to ep0 within the setup() call, the driver can do it after setup() returns. The UDC driver must wait until such a response is queued before proceeding with the data/status stages of the control transfer.}(hj55hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(h**NOTE**h]jP )}(hjF5h]hNOTE}(hjH5hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjD5ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hCurrently, a number of UDC drivers rely on USB_GADGET_DELAYED_STATUS being returned from the setup() callback, which is a bug. See the comment next to USB_GADGET_DELAYED_STATUS for details.h]hCurrently, a number of UDC drivers rely on USB_GADGET_DELAYED_STATUS being returned from the setup() callback, which is a bug. See the comment next to USB_GADGET_DELAYED_STATUS for details.}(hj\5hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(h(Note that only the default control endpoint is supported. Neither hosts nor devices generally support control traffic except to ep0.)h]h(Note that only the default control endpoint is supported. Neither hosts nor devices generally support control traffic except to ep0.)}(hjk5hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubh)}(hXMost devices will ignore USB suspend/resume operations, and so will not provide those callbacks. However, some may need to change modes when the host is not longer directing those activities. For example, local controls (buttons, dials, etc) may need to be re-enabled since the (remote) host can't do that any longer; or an error state might be cleared, to make the device behave identically whether or not power is maintained.h]hXMost devices will ignore USB suspend/resume operations, and so will not provide those callbacks. However, some may need to change modes when the host is not longer directing those activities. For example, local controls (buttons, dials, etc) may need to be re-enabled since the (remote) host can’t do that any longer; or an error state might be cleared, to make the device behave identically whether or not power is maintained.}(hjz5hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjthhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_gadget_register_driver_owner (C function)"c.usb_gadget_register_driver_ownerhNtauh1jhjthhhNhNubj)}(hhh](j)}(hsint usb_gadget_register_driver_owner (struct usb_gadget_driver *driver, struct module *owner, const char *mod_name)h]j)}(hrint usb_gadget_register_driver_owner(struct usb_gadget_driver *driver, struct module *owner, const char *mod_name)h](j)}(hinth]hint}(hj5hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj5hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMubj)}(h h]h }(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5hhhj5hMubj)}(h usb_gadget_register_driver_ownerh]j)}(h usb_gadget_register_driver_ownerh]h usb_gadget_register_driver_owner}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj5hhhj5hMubjW)}(hN(struct usb_gadget_driver *driver, struct module *owner, const char *mod_name)h](j])}(h struct usb_gadget_driver *driverh](j)}(hjh]hstruct}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubj)}(h h]h }(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubh)}(hhh]j)}(husb_gadget_driverh]husb_gadget_driver}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj5modnameN classnameNjj)}j]j)}jj5sb"c.usb_gadget_register_driver_ownerasbuh1hhj5ubj)}(h h]h }(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubj)}(hjh]h*}(hj+6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubj)}(hdriverh]hdriver}(hj86hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj5ubj])}(hstruct module *ownerh](j)}(hjh]hstruct}(hjQ6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjM6ubj)}(h h]h }(hj^6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjM6ubh)}(hhh]j)}(hmoduleh]hmodule}(hjo6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjl6ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjq6modnameN classnameNjj)}j]j6"c.usb_gadget_register_driver_ownerasbuh1hhjM6ubj)}(h h]h }(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjM6ubj)}(hjh]h*}(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjM6ubj)}(hownerh]howner}(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjM6ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj5ubj])}(hconst char *mod_nameh](j)}(hconsth]hconst}(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubj)}(h h]h }(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubj)}(hcharh]hchar}(hj6hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj6ubj)}(h h]h }(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubj)}(hjh]h*}(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubj)}(hmod_nameh]hmod_name}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj5ubeh}(h]h ]h"]h$]h&]j j uh1jVhj5hhhj5hMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj5hhhj5hMubah}(h]j5ah ](j j eh"]h$]h&]j j )j huh1jhj5hMhj5hhubj )}(hhh]h)}(hregister a gadget driverh]hregister a gadget driver}(hj07hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj-7hhubah}(h]h ]h"]h$]h&]uh1j hj5hhhj5hMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jH7jA jH7jB jC jD uh1jhhhjthNhNubjF )}(hXU**Parameters** ``struct usb_gadget_driver *driver`` the driver being registered ``struct module *owner`` the driver module ``const char *mod_name`` the driver module's build name **Context** can sleep **Description** Call this in your gadget driver's module initialization function, to tell the underlying UDC controller driver about your driver. The **bind\(\)** function will be called to bind it to a gadget before this registration call returns. It's expected that the **bind\(\)** function will be in init sections. Use the macro defined below instead of calling this directly.h](h)}(h**Parameters**h]jP )}(hjR7h]h Parameters}(hjT7hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjP7ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM"hjL7ubj)}(hhh](j)}(hA``struct usb_gadget_driver *driver`` the driver being registered h](j)}(h$``struct usb_gadget_driver *driver``h]j)}(hjq7h]h struct usb_gadget_driver *driver}(hjs7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjo7ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhjk7ubj)}(hhh]h)}(hthe driver being registeredh]hthe driver being registered}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hMhj7ubah}(h]h ]h"]h$]h&]uh1jhjk7ubeh}(h]h ]h"]h$]h&]uh1jhj7hMhjh7ubj)}(h+``struct module *owner`` the driver module h](j)}(h``struct module *owner``h]j)}(hj7h]hstruct module *owner}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM hj7ubj)}(hhh]h)}(hthe driver moduleh]hthe driver module}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hM hj7ubah}(h]h ]h"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]uh1jhj7hM hjh7ubj)}(h8``const char *mod_name`` the driver module's build name h](j)}(h``const char *mod_name``h]j)}(hj7h]hconst char *mod_name}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM!hj7ubj)}(hhh]h)}(hthe driver module's build nameh]h the driver module’s build name}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hM!hj7ubah}(h]h ]h"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]uh1jhj7hM!hjh7ubeh}(h]h ]h"]h$]h&]uh1jhjL7ubh)}(h **Context**h]jP )}(hj8h]hContext}(hj 8hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj8ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM#hjL7ubh)}(h can sleeph]h can sleep}(hj48hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM"hjL7ubh)}(h**Description**h]jP )}(hjE8h]h Description}(hjG8hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjC8ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM$hjL7ubh)}(hX0Call this in your gadget driver's module initialization function, to tell the underlying UDC controller driver about your driver. The **bind\(\)** function will be called to bind it to a gadget before this registration call returns. It's expected that the **bind\(\)** function will be in init sections.h](hCall this in your gadget driver’s module initialization function, to tell the underlying UDC controller driver about your driver. The }(hj[8hhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjc8hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj[8ubhq function will be called to bind it to a gadget before this registration call returns. It’s expected that the }(hj[8hhhNhNubjP )}(h **bind\(\)**h]hbind()}(hju8hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj[8ubh# function will be in init sections.}(hj[8hhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM#hjL7ubh)}(h=Use the macro defined below instead of calling this directly.h]h=Use the macro defined below instead of calling this directly.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM)hjL7ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j)usb_gadget_unregister_driver (C function)c.usb_gadget_unregister_driverhNtauh1jhjthhhNhNubj)}(hhh](j)}(hCint usb_gadget_unregister_driver (struct usb_gadget_driver *driver)h]j)}(hBint usb_gadget_unregister_driver(struct usb_gadget_driver *driver)h](j)}(hinth]hint}(hj8hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj8hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM4ubj)}(h h]h }(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8hhhj8hM4ubj)}(husb_gadget_unregister_driverh]j)}(husb_gadget_unregister_driverh]husb_gadget_unregister_driver}(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj8hhhj8hM4ubjW)}(h"(struct usb_gadget_driver *driver)h]j])}(h struct usb_gadget_driver *driverh](j)}(hjh]hstruct}(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubj)}(h h]h }(hj9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubh)}(hhh]j)}(husb_gadget_driverh]husb_gadget_driver}(hj9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj9modnameN classnameNjj)}j]j)}jj8sbc.usb_gadget_unregister_driverasbuh1hhj8ubj)}(h h]h }(hj89hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubj)}(hjh]h*}(hjF9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubj)}(hdriverh]hdriver}(hjS9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj8ubah}(h]h ]h"]h$]h&]j j uh1jVhj8hhhj8hM4ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj8hhhj8hM4ubah}(h]j8ah ](j j eh"]h$]h&]j j )j huh1jhj8hM4hj8hhubj )}(hhh]h)}(hunregister a gadget driverh]hunregister a gadget driver}(hj}9hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM4hjz9hhubah}(h]h ]h"]h$]h&]uh1j hj8hhhj8hM4ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j9jA j9jB jC jD uh1jhhhjthNhNubjF )}(hX%**Parameters** ``struct usb_gadget_driver *driver`` the driver being unregistered **Context** can sleep **Description** Call this in your gadget driver's module cleanup function, to tell the underlying usb controller that your driver is going away. If the controller is connected to a USB host, it will first disconnect(). The driver is also requested to unbind() and clean up any device state, before this procedure finally returns. It's expected that the unbind() functions will be in exit sections, so may not be linked in some kernels.h](h)}(h**Parameters**h]jP )}(hj9h]h Parameters}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj9ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM8hj9ubj)}(hhh]j)}(hC``struct usb_gadget_driver *driver`` the driver being unregistered h](j)}(h$``struct usb_gadget_driver *driver``h]j)}(hj9h]h struct usb_gadget_driver *driver}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM5hj9ubj)}(hhh]h)}(hthe driver being unregisteredh]hthe driver being unregistered}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hM5hj9ubah}(h]h ]h"]h$]h&]uh1jhj9ubeh}(h]h ]h"]h$]h&]uh1jhj9hM5hj9ubah}(h]h ]h"]h$]h&]uh1jhj9ubh)}(h **Context**h]jP )}(hj9h]hContext}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj9ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM7hj9ubh)}(h can sleeph]h can sleep}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM6hj9ubh)}(h**Description**h]jP )}(hj :h]h Description}(hj":hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj:ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM8hj9ubh)}(hXCall this in your gadget driver's module cleanup function, to tell the underlying usb controller that your driver is going away. If the controller is connected to a USB host, it will first disconnect(). The driver is also requested to unbind() and clean up any device state, before this procedure finally returns. It's expected that the unbind() functions will be in exit sections, so may not be linked in some kernels.h]hXCall this in your gadget driver’s module cleanup function, to tell the underlying usb controller that your driver is going away. If the controller is connected to a USB host, it will first disconnect(). The driver is also requested to unbind() and clean up any device state, before this procedure finally returns. It’s expected that the unbind() functions will be in exit sections, so may not be linked in some kernels.}(hj6:hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM7hj9ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_string (C struct) c.usb_stringhNtauh1jhjthhhNhNubj)}(hhh](j)}(h usb_stringh]j)}(hstruct usb_stringh](j)}(hjh]hstruct}(hje:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhja:hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMBubj)}(h h]h }(hjs:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhja:hhhjr:hMBubj)}(h usb_stringh]j)}(hj_:h]h usb_string}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubah}(h]h ](j j eh"]h$]h&]j j uh1jhja:hhhjr:hMBubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj]:hhhjr:hMBubah}(h]jX:ah ](j j eh"]h$]h&]j j )j huh1jhjr:hMBhjZ:hhubj )}(hhh]h)}(hwraps a C string and its USB idh]hwraps a C string and its USB id}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMGhj:hhubah}(h]h ]h"]h$]h&]uh1j hjZ:hhhjr:hMBubeh}(h]h ](jstructeh"]h$]h&]j? jj@ j:jA j:jB jC jD uh1jhhhjthNhNubjF )}(h**Definition**:: struct usb_string { u8 id; const char *s; }; **Members** ``id`` the (nonzero) ID for this string ``s`` the string, in UTF-8 encodingh](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj:ubh:}(hj:hhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMKhj:ubjk )}(hAstruct usb_string { u8 id; const char *s; };h]hAstruct usb_string { u8 id; const char *s; };}hj:sbah}(h]h ]h"]h$]h&]j j uh1jj ha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMMhj:ubh)}(h **Members**h]jP )}(hj:h]hMembers}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj:ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMRhj:ubj)}(hhh](j)}(h(``id`` the (nonzero) ID for this string h](j)}(h``id``h]j)}(hj;h]hid}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMIhj;ubj)}(hhh]h)}(h the (nonzero) ID for this stringh]h the (nonzero) ID for this string}(hj-;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj);hMIhj*;ubah}(h]h ]h"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]uh1jhj);hMIhj ;ubj)}(h#``s`` the string, in UTF-8 encodingh](j)}(h``s``h]j)}(hjM;h]hs}(hjO;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjK;ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMIhjG;ubj)}(hhh]h)}(hthe string, in UTF-8 encodingh]hthe string, in UTF-8 encoding}(hjf;hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMJhjc;ubah}(h]h ]h"]h$]h&]uh1jhjG;ubeh}(h]h ]h"]h$]h&]uh1jhjb;hMIhj ;ubeh}(h]h ]h"]h$]h&]uh1jhj:ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubh)}(h**Description**h]jP )}(hj;h]h Description}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj;ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMMhjthhubh)}(hXIf you're using usb_gadget_get_string(), use this to wrap a string together with its ID.h]hZIf you’re using usb_gadget_get_string(), use this to wrap a string together with its ID.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMJhjthhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_gadget_strings (C struct)c.usb_gadget_stringshNtauh1jhjthhhNhNubj)}(hhh](j)}(husb_gadget_stringsh]j)}(hstruct usb_gadget_stringsh](j)}(hjh]hstruct}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;hhha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMPubj)}(h h]h }(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;hhhj;hMPubj)}(husb_gadget_stringsh]j)}(hj;h]husb_gadget_strings}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj;hhhj;hMPubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj;hhhj;hMPubah}(h]j;ah ](j j eh"]h$]h&]j j )j huh1jhj;hMPhj;hhubj )}(hhh]h)}(h(a set of USB strings in a given languageh]h(a set of USB strings in a given language}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMThj <hhubah}(h]h ]h"]h$]h&]uh1j hj;hhhj;hMPubeh}(h]h ](jstructeh"]h$]h&]j? jj@ j(<jA j(<jB jC jD uh1jhhhjthNhNubjF )}(h**Definition**:: struct usb_gadget_strings { u16 language; struct usb_string *strings; }; **Members** ``language`` identifies the strings' language (0x0409 for en-us) ``strings`` array of strings with their idsh](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hj4<hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj0<ubh:}(hj0<hhhNhNubeh}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMXhj,<ubjk )}(hVstruct usb_gadget_strings { u16 language; struct usb_string *strings; };h]hVstruct usb_gadget_strings { u16 language; struct usb_string *strings; };}hjM<sbah}(h]h ]h"]h$]h&]j j uh1jj ha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMZhj,<ubh)}(h **Members**h]jP )}(hj^<h]hMembers}(hj`<hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj\<ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhM_hj,<ubj)}(hhh](j)}(hA``language`` identifies the strings' language (0x0409 for en-us) h](j)}(h ``language``h]j)}(hj}<h]hlanguage}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{<ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMVhjw<ubj)}(hhh]h)}(h3identifies the strings' language (0x0409 for en-us)h]h5identifies the strings’ language (0x0409 for en-us)}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj<hMVhj<ubah}(h]h ]h"]h$]h&]uh1jhjw<ubeh}(h]h ]h"]h$]h&]uh1jhj<hMVhjt<ubj)}(h+``strings`` array of strings with their idsh](j)}(h ``strings``h]j)}(hj<h]hstrings}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMVhj<ubj)}(hhh]h)}(harray of strings with their idsh]harray of strings with their ids}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMWhj<ubah}(h]h ]h"]h$]h&]uh1jhj<ubeh}(h]h ]h"]h$]h&]uh1jhj<hMVhjt<ubeh}(h]h ]h"]h$]h&]uh1jhj,<ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubh)}(h**Description**h]jP )}(hj<h]h Description}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj<ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMZhjthhubh)}(h_If you're using usb_gadget_get_string(), use this to wrap all the strings for a given language.h]haIf you’re using usb_gadget_get_string(), use this to wrap all the strings for a given language.}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMWhjthhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!usb_free_descriptors (C function)c.usb_free_descriptorshNtauh1jhjthhhNhNubj)}(hhh](j)}(hhhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj>hhubah}(h]h ]h"]h$]h&]uh1j hj,=hhhjE=hMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j>jA j>jB jC jD uh1jhhhjthNhNubjF )}(hL**Parameters** ``struct usb_descriptor_header **v`` vector of descriptorsh](h)}(h**Parameters**h]jP )}(hj&>h]h Parameters}(hj(>hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj$>ubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj >ubj)}(hhh]j)}(h:``struct usb_descriptor_header **v`` vector of descriptorsh](j)}(h$``struct usb_descriptor_header **v``h]j)}(hjE>h]h struct usb_descriptor_header **v}(hjG>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjC>ubah}(h]h ]h"]h$]h&]uh1jha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj?>ubj)}(hhh]h)}(hvector of descriptorsh]hvector of descriptors}(hj^>hhhNhNubah}(h]h ]h"]h$]h&]uh1hha/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:317: ./include/linux/usb/gadget.hhMhj[>ubah}(h]h ]h"]h$]h&]uh1jhj?>ubeh}(h]h ]h"]h$]h&]uh1jhjZ>hMhj<>ubah}(h]h ]h"]h$]h&]uh1jhj >ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjthhhNhNubeh}(h]core-objects-and-methodsah ]h"]core objects and methodsah$]h&]uh1hhjhhhhhM8ubh)}(hhh](h)}(hOptional Utilitiesh]hOptional Utilities}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hhhhhMAubh)}(hThe core API is sufficient for writing a USB Gadget Driver, but some optional utilities are provided to simplify common tasks. These utilities include endpoint autoconfiguration.h]hThe core API is sufficient for writing a USB Gadget Driver, but some optional utilities are provided to simplify common tasks. These utilities include endpoint autoconfiguration.}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMChj>hhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"usb_gadget_get_string (C function)c.usb_gadget_get_stringhNtauh1jhj>hhhNhNubj)}(hhh](j)}(hSint usb_gadget_get_string (const struct usb_gadget_strings *table, int id, u8 *buf)h]j)}(hRint usb_gadget_get_string(const struct usb_gadget_strings *table, int id, u8 *buf)h](j)}(hinth]hint}(hj>hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj>hhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKubj)}(h h]h }(hj>hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>hhhj>hKubj)}(husb_gadget_get_stringh]j)}(husb_gadget_get_stringh]husb_gadget_get_string}(hj>hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj>hhhj>hKubjW)}(h9(const struct usb_gadget_strings *table, int id, u8 *buf)h](j])}(h&const struct usb_gadget_strings *tableh](j)}(hj6h]hconst}(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubj)}(h h]h }(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubj)}(hjh]hstruct}(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubj)}(h h]h }(hj+?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubh)}(hhh]j)}(husb_gadget_stringsh]husb_gadget_strings}(hj?modnameN classnameNjj)}j]j)}jj>sbc.usb_gadget_get_stringasbuh1hhj>ubj)}(h h]h }(hj\?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubj)}(hjh]h*}(hjj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubj)}(htableh]htable}(hjw?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj>ubj])}(hint idh](j)}(hinth]hint}(hj?hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj?ubj)}(h h]h }(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubj)}(hidh]hid}(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj>ubj])}(hu8 *bufh](h)}(hhh]j)}(hu8h]hu8}(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj?modnameN classnameNjj)}j]jX?c.usb_gadget_get_stringasbuh1hhj?ubj)}(h h]h }(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubj)}(hjh]h*}(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubj)}(hbufh]hbuf}(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj>ubeh}(h]h ]h"]h$]h&]j j uh1jVhj>hhhj>hKubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj>hhhj>hKubah}(h]j>ah ](j j eh"]h$]h&]j j )j huh1jhj>hKhj>hhubj )}(hhh]h)}(hfill out a string descriptorh]hfill out a string descriptor}(hj+@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKhj(@hhubah}(h]h ]h"]h$]h&]uh1j hj>hhhj>hKubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jC@jA jC@jB jC jD uh1jhhhj>hNhNubjF )}(hX**Parameters** ``const struct usb_gadget_strings *table`` of c strings encoded using UTF-8 ``int id`` string id, from low byte of wValue in get string descriptor ``u8 *buf`` at least 256 bytes, must be 16-bit aligned **Description** Finds the UTF-8 string matching the ID, and converts it into a string descriptor in utf16-le. Returns length of descriptor (always even) or negative errno If your driver needs stings in multiple languages, you'll probably "switch (wIndex) { ... }" in your ep0 string descriptor logic, using this routine after choosing which set of UTF-8 strings to use. Note that US-ASCII is a strict subset of UTF-8; any string bytes with the eighth bit set will be multibyte UTF-8 characters, not ISO-8859/1 characters (which are also widely used in C strings).h](h)}(h**Parameters**h]jP )}(hjM@h]h Parameters}(hjO@hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjK@ubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKhjG@ubj)}(hhh](j)}(hL``const struct usb_gadget_strings *table`` of c strings encoded using UTF-8 h](j)}(h*``const struct usb_gadget_strings *table``h]j)}(hjl@h]h&const struct usb_gadget_strings *table}(hjn@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjj@ubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKhjf@ubj)}(hhh]h)}(h of c strings encoded using UTF-8h]h of c strings encoded using UTF-8}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@hKhj@ubah}(h]h ]h"]h$]h&]uh1jhjf@ubeh}(h]h ]h"]h$]h&]uh1jhj@hKhjc@ubj)}(hG``int id`` string id, from low byte of wValue in get string descriptor h](j)}(h ``int id``h]j)}(hj@h]hint id}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKhj@ubj)}(hhh]h)}(h;string id, from low byte of wValue in get string descriptorh]h;string id, from low byte of wValue in get string descriptor}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@hKhj@ubah}(h]h ]h"]h$]h&]uh1jhj@ubeh}(h]h ]h"]h$]h&]uh1jhj@hKhjc@ubj)}(h7``u8 *buf`` at least 256 bytes, must be 16-bit aligned h](j)}(h ``u8 *buf``h]j)}(hj@h]hu8 *buf}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKhj@ubj)}(hhh]h)}(h*at least 256 bytes, must be 16-bit alignedh]h*at least 256 bytes, must be 16-bit aligned}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@hKhj@ubah}(h]h ]h"]h$]h&]uh1jhj@ubeh}(h]h ]h"]h$]h&]uh1jhj@hKhjc@ubeh}(h]h ]h"]h$]h&]uh1jhjG@ubh)}(h**Description**h]jP )}(hjAh]h Description}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjAubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKhjG@ubh)}(hFinds the UTF-8 string matching the ID, and converts it into a string descriptor in utf16-le. Returns length of descriptor (always even) or negative errnoh]hFinds the UTF-8 string matching the ID, and converts it into a string descriptor in utf16-le. Returns length of descriptor (always even) or negative errno}(hj/AhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKhjG@ubh)}(hXIf your driver needs stings in multiple languages, you'll probably "switch (wIndex) { ... }" in your ep0 string descriptor logic, using this routine after choosing which set of UTF-8 strings to use. Note that US-ASCII is a strict subset of UTF-8; any string bytes with the eighth bit set will be multibyte UTF-8 characters, not ISO-8859/1 characters (which are also widely used in C strings).h]hXIf your driver needs stings in multiple languages, you’ll probably “switch (wIndex) { ... }” in your ep0 string descriptor logic, using this routine after choosing which set of UTF-8 strings to use. Note that US-ASCII is a strict subset of UTF-8; any string bytes with the eighth bit set will be multibyte UTF-8 characters, not ISO-8859/1 characters (which are also widely used in C strings).}(hj>AhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKhjG@ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hj>hhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j usb_validate_langid (C function)c.usb_validate_langidhNtauh1jhj>hhhNhNubj)}(hhh](j)}(h%bool usb_validate_langid (u16 langid)h]j)}(h$bool usb_validate_langid(u16 langid)h](j)}(hboolh]hbool}(hjmAhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjiAhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKFubj)}(h h]h }(hj|AhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiAhhhj{AhKFubj)}(husb_validate_langidh]j)}(husb_validate_langidh]husb_validate_langid}(hjAhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjAubah}(h]h ](j j eh"]h$]h&]j j uh1jhjiAhhhj{AhKFubjW)}(h (u16 langid)h]j])}(h u16 langidh](h)}(hhh]j)}(hu16h]hu16}(hjAhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjAmodnameN classnameNjj)}j]j)}jjAsbc.usb_validate_langidasbuh1hhjAubj)}(h h]h }(hjAhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjAubj)}(hlangidh]hlangid}(hjAhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjAubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjAubah}(h]h ]h"]h$]h&]j j uh1jVhjiAhhhj{AhKFubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjeAhhhj{AhKFubah}(h]j`Aah ](j j eh"]h$]h&]j j )j huh1jhj{AhKFhjbAhhubj )}(hhh]h)}(h!validate usb language identifiersh]h!validate usb language identifiers}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKFhjBhhubah}(h]h ]h"]h$]h&]uh1j hjbAhhhj{AhKFubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jBjA jBjB jC jD uh1jhhhj>hNhNubjF )}(h**Parameters** ``u16 langid`` usb language identifier **Description** Returns true for valid language identifier, otherwise false.h](h)}(h**Parameters**h]jP )}(hj'Bh]h Parameters}(hj)BhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj%Bubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKJhj!Bubj)}(hhh]j)}(h'``u16 langid`` usb language identifier h](j)}(h``u16 langid``h]j)}(hjFBh]h u16 langid}(hjHBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDBubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKGhj@Bubj)}(hhh]h)}(husb language identifierh]husb language identifier}(hj_BhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[BhKGhj\Bubah}(h]h ]h"]h$]h&]uh1jhj@Bubeh}(h]h ]h"]h$]h&]uh1jhj[BhKGhj=Bubah}(h]h ]h"]h$]h&]uh1jhj!Bubh)}(h**Description**h]jP )}(hjBh]h Description}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjBubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:327: ./drivers/usb/gadget/usbstring.chKIhj!Bubh)}(hhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#usb_descriptor_fillbuf (C function)c.usb_descriptor_fillbufhNtauh1jhj>hhhNhNubj)}(hhh](j)}(haint usb_descriptor_fillbuf (void *buf, unsigned buflen, const struct usb_descriptor_header **src)h]j)}(h`int usb_descriptor_fillbuf(void *buf, unsigned buflen, const struct usb_descriptor_header **src)h](j)}(hinth]hint}(hjBhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjBhhhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKubj)}(h h]h }(hjBhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjBhhhjBhKubj)}(husb_descriptor_fillbufh]j)}(husb_descriptor_fillbufh]husb_descriptor_fillbuf}(hjBhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjBubah}(h]h ](j j eh"]h$]h&]j j uh1jhjBhhhjBhKubjW)}(hF(void *buf, unsigned buflen, const struct usb_descriptor_header **src)h](j])}(h void *bufh](j)}(hvoidh]hvoid}(hjChhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjBubj)}(h h]h }(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjBubj)}(hjh]h*}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjBubj)}(hbufh]hbuf}(hj,ChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjBubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjBubj])}(hunsigned buflenh](j)}(hunsignedh]hunsigned}(hjEChhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjACubj)}(h h]h }(hjSChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjACubj)}(hbuflenh]hbuflen}(hjaChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjACubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjBubj])}(h(const struct usb_descriptor_header **srch](j)}(hj6h]hconst}(hjzChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvCubj)}(h h]h }(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvCubj)}(hjh]hstruct}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvCubj)}(h h]h }(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvCubh)}(hhh]j)}(husb_descriptor_headerh]husb_descriptor_header}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjCmodnameN classnameNjj)}j]j)}jjBsbc.usb_descriptor_fillbufasbuh1hhjvCubj)}(h h]h }(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvCubj)}(hjh]h*}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvCubj)}(hjh]h*}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvCubj)}(hsrch]hsrc}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvCubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjBubeh}(h]h ]h"]h$]h&]j j uh1jVhjBhhhjBhKubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjBhhhjBhKubah}(h]jBah ](j j eh"]h$]h&]j j )j huh1jhjBhKhjBhhubj )}(hhh]h)}(hfill buffer with descriptorsh]hfill buffer with descriptors}(hj%DhhhNhNubah}(h]h ]h"]h$]h&]uh1hhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKhj"Dhhubah}(h]h ]h"]h$]h&]uh1j hjBhhhjBhKubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ j=DjA j=DjB jC jD uh1jhhhj>hNhNubjF )}(hX**Parameters** ``void *buf`` Buffer to be filled ``unsigned buflen`` Size of buf ``const struct usb_descriptor_header **src`` Array of descriptor pointers, terminated by null pointer. **Description** Copies descriptors into the buffer, returning the length or a negative error code if they can't all be copied. Useful when assembling descriptors for an associated set of interfaces used as part of configuring a composite device; or in other cases where sets of descriptors need to be marshaled.h](h)}(h**Parameters**h]jP )}(hjGDh]h Parameters}(hjIDhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjEDubah}(h]h ]h"]h$]h&]uh1hhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKhjADubj)}(hhh](j)}(h"``void *buf`` Buffer to be filled h](j)}(h ``void *buf``h]j)}(hjfDh]h void *buf}(hjhDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjdDubah}(h]h ]h"]h$]h&]uh1jhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKhj`Dubj)}(hhh]h)}(hBuffer to be filledh]hBuffer to be filled}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{DhKhj|Dubah}(h]h ]h"]h$]h&]uh1jhj`Dubeh}(h]h ]h"]h$]h&]uh1jhj{DhKhj]Dubj)}(h ``unsigned buflen`` Size of buf h](j)}(h``unsigned buflen``h]j)}(hjDh]hunsigned buflen}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1jhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKhjDubj)}(hhh]h)}(h Size of bufh]h Size of buf}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhKhjDubah}(h]h ]h"]h$]h&]uh1jhjDubeh}(h]h ]h"]h$]h&]uh1jhjDhKhj]Dubj)}(hg``const struct usb_descriptor_header **src`` Array of descriptor pointers, terminated by null pointer. h](j)}(h,``const struct usb_descriptor_header **src``h]j)}(hjDh]h(const struct usb_descriptor_header **src}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1jhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKhjDubj)}(hhh]h)}(h9Array of descriptor pointers, terminated by null pointer.h]h9Array of descriptor pointers, terminated by null pointer.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhKhjDubah}(h]h ]h"]h$]h&]uh1jhjDubeh}(h]h ]h"]h$]h&]uh1jhjDhKhj]Dubeh}(h]h ]h"]h$]h&]uh1jhjADubh)}(h**Description**h]jP )}(hjEh]h Description}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjEubah}(h]h ]h"]h$]h&]uh1hhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKhjADubh)}(hX(Copies descriptors into the buffer, returning the length or a negative error code if they can't all be copied. Useful when assembling descriptors for an associated set of interfaces used as part of configuring a composite device; or in other cases where sets of descriptors need to be marshaled.h]hX*Copies descriptors into the buffer, returning the length or a negative error code if they can’t all be copied. Useful when assembling descriptors for an associated set of interfaces used as part of configuring a composite device; or in other cases where sets of descriptors need to be marshaled.}(hj)EhhhNhNubah}(h]h ]h"]h$]h&]uh1hhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKhjADubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hj>hhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!usb_copy_descriptors (C function)c.usb_copy_descriptorshNtauh1jhj>hhhNhNubj)}(hhh](j)}(hYstruct usb_descriptor_header ** usb_copy_descriptors (struct usb_descriptor_header **src)h]j)}(hWstruct usb_descriptor_header **usb_copy_descriptors(struct usb_descriptor_header **src)h](j)}(hjh]hstruct}(hjXEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTEhhhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chK9ubj)}(h h]h }(hjfEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTEhhhjeEhK9ubh)}(hhh]j)}(husb_descriptor_headerh]husb_descriptor_header}(hjwEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjtEubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjyEmodnameN classnameNjj)}j]j)}jusb_copy_descriptorssbc.usb_copy_descriptorsasbuh1hhjTEhhhjeEhK9ubj)}(h h]h }(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTEhhhjeEhK9ubj)}(hjh]h*}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTEhhhjeEhK9ubj)}(hjh]h*}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTEhhhjeEhK9ubj)}(husb_copy_descriptorsh]j)}(hjEh]husb_copy_descriptors}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubah}(h]h ](j j eh"]h$]h&]j j uh1jhjTEhhhjeEhK9ubjW)}(h$(struct usb_descriptor_header **src)h]j])}(h"struct usb_descriptor_header **srch](j)}(hjh]hstruct}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj)}(h h]h }(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubh)}(hhh]j)}(husb_descriptor_headerh]husb_descriptor_header}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjEmodnameN classnameNjj)}j]jEc.usb_copy_descriptorsasbuh1hhjEubj)}(h h]h }(hjFhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj)}(hjh]h*}(hj)FhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj)}(hjh]h*}(hj6FhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj)}(hsrch]hsrc}(hjCFhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjEubah}(h]h ]h"]h$]h&]j j uh1jVhjTEhhhjeEhK9ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjPEhhhjeEhK9ubah}(h]jKEah ](j j eh"]h$]h&]j j )j huh1jhjeEhK9hjMEhhubj )}(hhh]h)}(h copy a vector of USB descriptorsh]h copy a vector of USB descriptors}(hjmFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chK9hjjFhhubah}(h]h ]h"]h$]h&]uh1j hjMEhhhjeEhK9ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jFjA jFjB jC jD uh1jhhhj>hNhNubjF )}(hX **Parameters** ``struct usb_descriptor_header **src`` null-terminated vector to copy **Context** initialization code, which may sleep **Description** This makes a copy of a vector of USB descriptors. Its primary use is to support usb_function objects which can have multiple copies, each needing different descriptors. Functions may have static tables of descriptors, which are used as templates and customized with identifiers (for interfaces, strings, endpoints, and more) as needed by a given function instance.h](h)}(h**Parameters**h]jP )}(hjFh]h Parameters}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjFubah}(h]h ]h"]h$]h&]uh1hhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chK=hjFubj)}(hhh]j)}(hF``struct usb_descriptor_header **src`` null-terminated vector to copy h](j)}(h&``struct usb_descriptor_header **src``h]j)}(hjFh]h"struct usb_descriptor_header **src}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1jhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chK:hjFubj)}(hhh]h)}(hnull-terminated vector to copyh]hnull-terminated vector to copy}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhK:hjFubah}(h]h ]h"]h$]h&]uh1jhjFubeh}(h]h ]h"]h$]h&]uh1jhjFhK:hjFubah}(h]h ]h"]h$]h&]uh1jhjFubh)}(h **Context**h]jP )}(hjFh]hContext}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjFubah}(h]h ]h"]h$]h&]uh1hhb/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:330: ./drivers/usb/gadget/config.chKhhhNhNubeh}(h]optional-utilitiesah ]h"]optional utilitiesah$]h&]uh1hhjhhhhhMAubh)}(hhh](h)}(hComposite Device Frameworkh]hComposite Device Framework}(hjGGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDGhhhhhMNubh)}(hXTThe core API is sufficient for writing drivers for composite USB devices (with more than one function in a given configuration), and also multi-configuration devices (also more than one function, but not necessarily sharing a given configuration). There is however an optional framework which makes it easier to reuse and combine functions.h]hXTThe core API is sufficient for writing drivers for composite USB devices (with more than one function in a given configuration), and also multi-configuration devices (also more than one function, but not necessarily sharing a given configuration). There is however an optional framework which makes it easier to reuse and combine functions.}(hjUGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMPhjDGhhubh)}(hXsDevices using this framework provide a struct usb_composite_driver, which in turn provides one or more struct usb_configuration instances. Each such configuration includes at least one struct :c:type:`usb_function`, which packages a user visible role such as "network link" or "mass storage device". Management functions may also exist, such as "Device Firmware Upgrade".h](hDevices using this framework provide a struct usb_composite_driver, which in turn provides one or more struct usb_configuration instances. Each such configuration includes at least one struct }(hjcGhhhNhNubh)}(h:c:type:`usb_function`h]j)}(hjmGh]h usb_function}(hjoGhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjkGubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjj)}j]sbj usb_functionuh1hhhhMVhjcGubh, which packages a user visible role such as “network link” or “mass storage device”. Management functions may also exist, such as “Device Firmware Upgrade”.}(hjcGhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMVhjDGhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_os_desc_ext_prop (C struct)c.usb_os_desc_ext_prophNtauh1jhjDGhhhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhNubj)}(hhh](j)}(husb_os_desc_ext_proph]j)}(hstruct usb_os_desc_ext_proph](j)}(hjh]hstruct}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGhhhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKubj)}(h h]h }(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGhhhjGhKubj)}(husb_os_desc_ext_proph]j)}(hjGh]husb_os_desc_ext_prop}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGubah}(h]h ](j j eh"]h$]h&]j j uh1jhjGhhhjGhKubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjGhhhjGhKubah}(h]jGah ](j j eh"]h$]h&]j j )j huh1jhjGhKhjGhhubj )}(hhh]h)}(h!describes one "Extended Property"h]h%describes one “Extended Property”}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK;hjGhhubah}(h]h ]h"]h$]h&]uh1j hjGhhhjGhKubeh}(h]h ](jstructeh"]h$]h&]j? jj@ j HjA j HjB jC jD uh1jhhhjDGhjGhNubjF )}(hXd**Definition**:: struct usb_os_desc_ext_prop { struct list_head entry; u8 type; int name_len; char *name; int data_len; char *data; struct config_item item; }; **Members** ``entry`` used to keep a list of extended properties ``type`` Extended Property type ``name_len`` Extended Property unicode name length, including terminating '\0' ``name`` Extended Property name ``data_len`` Length of Extended Property blob (for unicode store double len) ``data`` Extended Property blob ``item`` Represents this Extended Property in configfsh](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjHubh:}(hjHhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK?hjHubjk )}(hstruct usb_os_desc_ext_prop { struct list_head entry; u8 type; int name_len; char *name; int data_len; char *data; struct config_item item; };h]hstruct usb_os_desc_ext_prop { struct list_head entry; u8 type; int name_len; char *name; int data_len; char *data; struct config_item item; };}hj0Hsbah}(h]h ]h"]h$]h&]j j uh1jj hd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKAhjHubh)}(h **Members**h]jP )}(hjAHh]hMembers}(hjCHhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj?Hubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKKhjHubj)}(hhh](j)}(h5``entry`` used to keep a list of extended properties h](j)}(h ``entry``h]j)}(hj`Hh]hentry}(hjbHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^Hubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK=hjZHubj)}(hhh]h)}(h*used to keep a list of extended propertiesh]h*used to keep a list of extended properties}(hjyHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjuHhK=hjvHubah}(h]h ]h"]h$]h&]uh1jhjZHubeh}(h]h ]h"]h$]h&]uh1jhjuHhK=hjWHubj)}(h ``type`` Extended Property type h](j)}(h``type``h]j)}(hjHh]htype}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjHubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK>hjHubj)}(hhh]h)}(hExtended Property typeh]hExtended Property type}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHhK>hjHubah}(h]h ]h"]h$]h&]uh1jhjHubeh}(h]h ]h"]h$]h&]uh1jhjHhK>hjWHubj)}(hO``name_len`` Extended Property unicode name length, including terminating '\0' h](j)}(h ``name_len``h]j)}(hjHh]hname_len}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjHubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK?hjHubj)}(hhh]h)}(hAExtended Property unicode name length, including terminating '\0'h]hEExtended Property unicode name length, including terminating ‘0’}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHhK?hjHubah}(h]h ]h"]h$]h&]uh1jhjHubeh}(h]h ]h"]h$]h&]uh1jhjHhK?hjWHubj)}(h ``name`` Extended Property name h](j)}(h``name``h]j)}(hj Ih]hname}(hj IhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj Iubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK@hjIubj)}(hhh]h)}(hExtended Property nameh]hExtended Property name}(hj$IhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj IhK@hj!Iubah}(h]h ]h"]h$]h&]uh1jhjIubeh}(h]h ]h"]h$]h&]uh1jhj IhK@hjWHubj)}(hM``data_len`` Length of Extended Property blob (for unicode store double len) h](j)}(h ``data_len``h]j)}(hjDIh]hdata_len}(hjFIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBIubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKAhj>Iubj)}(hhh]h)}(h?Length of Extended Property blob (for unicode store double len)h]h?Length of Extended Property blob (for unicode store double len)}(hj]IhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYIhKAhjZIubah}(h]h ]h"]h$]h&]uh1jhj>Iubeh}(h]h ]h"]h$]h&]uh1jhjYIhKAhjWHubj)}(h ``data`` Extended Property blob h](j)}(h``data``h]j)}(hj}Ih]hdata}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{Iubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKBhjwIubj)}(hhh]h)}(hExtended Property blobh]hExtended Property blob}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjIhKBhjIubah}(h]h ]h"]h$]h&]uh1jhjwIubeh}(h]h ]h"]h$]h&]uh1jhjIhKBhjWHubj)}(h6``item`` Represents this Extended Property in configfsh](j)}(h``item``h]j)}(hjIh]hitem}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKBhjIubj)}(hhh]h)}(h-Represents this Extended Property in configfsh]h-Represents this Extended Property in configfs}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKChjIubah}(h]h ]h"]h$]h&]uh1jhjIubeh}(h]h ]h"]h$]h&]uh1jhjIhKBhjWHubeh}(h]h ]h"]h$]h&]uh1jhjHubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhjGhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_os_desc (C struct) c.usb_os_deschNtauh1jhjDGhhhjGhNubj)}(hhh](j)}(h usb_os_desch]j)}(hstruct usb_os_desch](j)}(hjh]hstruct}(hjJhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj Jhhhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKIubj)}(h h]h }(hjJhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj JhhhjJhKIubj)}(h usb_os_desch]j)}(hj Jh]h usb_os_desc}(hj0JhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,Jubah}(h]h ](j j eh"]h$]h&]j j uh1jhj JhhhjJhKIubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjJhhhjJhKIubah}(h]jJah ](j j eh"]h$]h&]j j )j huh1jhjJhKIhjJhhubj )}(hhh]h)}(h6describes OS descriptors associated with one interfaceh]h6describes OS descriptors associated with one interface}(hjRJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKOhjOJhhubah}(h]h ]h"]h$]h&]uh1j hjJhhhjJhKIubeh}(h]h ](jstructeh"]h$]h&]j? jj@ jjJjA jjJjB jC jD uh1jhhhjDGhjGhNubjF )}(hX**Definition**:: struct usb_os_desc { char *ext_compat_id; struct list_head ext_prop; int ext_prop_len; int ext_prop_count; struct mutex *opts_mutex; struct config_group group; struct module *owner; }; **Members** ``ext_compat_id`` 16 bytes of "Compatible ID" and "Subcompatible ID" ``ext_prop`` Extended Properties list ``ext_prop_len`` Total length of Extended Properties blobs ``ext_prop_count`` Number of Extended Properties ``opts_mutex`` Optional mutex protecting config data of a usb_function_instance ``group`` Represents OS descriptors associated with an interface in configfs ``owner`` Module associated with this OS descriptorh](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hjvJhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjrJubh:}(hjrJhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKShjnJubjk )}(hstruct usb_os_desc { char *ext_compat_id; struct list_head ext_prop; int ext_prop_len; int ext_prop_count; struct mutex *opts_mutex; struct config_group group; struct module *owner; };h]hstruct usb_os_desc { char *ext_compat_id; struct list_head ext_prop; int ext_prop_len; int ext_prop_count; struct mutex *opts_mutex; struct config_group group; struct module *owner; };}hjJsbah}(h]h ]h"]h$]h&]j j uh1jj hd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKUhjnJubh)}(h **Members**h]jP )}(hjJh]hMembers}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjJubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK_hjnJubj)}(hhh](j)}(hE``ext_compat_id`` 16 bytes of "Compatible ID" and "Subcompatible ID" h](j)}(h``ext_compat_id``h]j)}(hjJh]h ext_compat_id}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKQhjJubj)}(hhh]h)}(h216 bytes of "Compatible ID" and "Subcompatible ID"h]h:16 bytes of “Compatible ID” and “Subcompatible ID”}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhKQhjJubah}(h]h ]h"]h$]h&]uh1jhjJubeh}(h]h ]h"]h$]h&]uh1jhjJhKQhjJubj)}(h&``ext_prop`` Extended Properties list h](j)}(h ``ext_prop``h]j)}(hjJh]hext_prop}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKRhjJubj)}(hhh]h)}(hExtended Properties listh]hExtended Properties list}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj KhKRhjKubah}(h]h ]h"]h$]h&]uh1jhjJubeh}(h]h ]h"]h$]h&]uh1jhj KhKRhjJubj)}(h;``ext_prop_len`` Total length of Extended Properties blobs h](j)}(h``ext_prop_len``h]j)}(hj1Kh]h ext_prop_len}(hj3KhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/Kubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKShj+Kubj)}(hhh]h)}(h)Total length of Extended Properties blobsh]h)Total length of Extended Properties blobs}(hjJKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFKhKShjGKubah}(h]h ]h"]h$]h&]uh1jhj+Kubeh}(h]h ]h"]h$]h&]uh1jhjFKhKShjJubj)}(h1``ext_prop_count`` Number of Extended Properties h](j)}(h``ext_prop_count``h]j)}(hjjKh]hext_prop_count}(hjlKhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhKubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKThjdKubj)}(hhh]h)}(hNumber of Extended Propertiesh]hNumber of Extended Properties}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjKhKThjKubah}(h]h ]h"]h$]h&]uh1jhjdKubeh}(h]h ]h"]h$]h&]uh1jhjKhKThjJubj)}(hP``opts_mutex`` Optional mutex protecting config data of a usb_function_instance h](j)}(h``opts_mutex``h]j)}(hjKh]h opts_mutex}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjKubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKUhjKubj)}(hhh]h)}(h@Optional mutex protecting config data of a usb_function_instanceh]h@Optional mutex protecting config data of a usb_function_instance}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjKhKUhjKubah}(h]h ]h"]h$]h&]uh1jhjKubeh}(h]h ]h"]h$]h&]uh1jhjKhKUhjJubj)}(hM``group`` Represents OS descriptors associated with an interface in configfs h](j)}(h ``group``h]j)}(hjKh]hgroup}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjKubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKVhjKubj)}(hhh]h)}(hBRepresents OS descriptors associated with an interface in configfsh]hBRepresents OS descriptors associated with an interface in configfs}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjKhKVhjKubah}(h]h ]h"]h$]h&]uh1jhjKubeh}(h]h ]h"]h$]h&]uh1jhjKhKVhjJubj)}(h3``owner`` Module associated with this OS descriptorh](j)}(h ``owner``h]j)}(hjLh]howner}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKVhjLubj)}(hhh]h)}(h)Module associated with this OS descriptorh]h)Module associated with this OS descriptor}(hj.LhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKWhj+Lubah}(h]h ]h"]h$]h&]uh1jhjLubeh}(h]h ]h"]h$]h&]uh1jhj*LhKVhjJubeh}(h]h ]h"]h$]h&]uh1jhjnJubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhjGhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_os_desc_table (C struct)c.usb_os_desc_tablehNtauh1jhjDGhhhjGhNubj)}(hhh](j)}(husb_os_desc_tableh]j)}(hstruct usb_os_desc_tableh](j)}(hjh]hstruct}(hjoLhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjkLhhhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK]ubj)}(h h]h }(hj}LhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjkLhhhj|LhK]ubj)}(husb_os_desc_tableh]j)}(hjiLh]husb_os_desc_table}(hjLhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjLubah}(h]h ](j j eh"]h$]h&]j j uh1jhjkLhhhj|LhK]ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjgLhhhj|LhK]ubah}(h]jbLah ](j j eh"]h$]h&]j j )j huh1jhj|LhK]hjdLhhubj )}(hhh]h)}(hHdescribes OS descriptors associated with one interface of a usb_functionh]hHdescribes OS descriptors associated with one interface of a usb_function}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKchjLhhubah}(h]h ]h"]h$]h&]uh1j hjdLhhhj|LhK]ubeh}(h]h ](jstructeh"]h$]h&]j? jj@ jLjA jLjB jC jD uh1jhhhjDGhjGhNubjF )}(h**Definition**:: struct usb_os_desc_table { int if_id; struct usb_os_desc *os_desc; }; **Members** ``if_id`` Interface id ``os_desc`` "Extended Compatibility ID" and "Extended Properties" of the interfaceh](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjLubh:}(hjLhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKghjLubjk )}(hRstruct usb_os_desc_table { int if_id; struct usb_os_desc *os_desc; };h]hRstruct usb_os_desc_table { int if_id; struct usb_os_desc *os_desc; };}hjLsbah}(h]h ]h"]h$]h&]j j uh1jj hd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKihjLubh)}(h **Members**h]jP )}(hjLh]hMembers}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjLubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKnhjLubj)}(hhh](j)}(h``if_id`` Interface id h](j)}(h ``if_id``h]j)}(hjMh]hif_id}(hj MhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKfhjMubj)}(hhh]h)}(h Interface idh]h Interface id}(hj7MhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3MhKfhj4Mubah}(h]h ]h"]h$]h&]uh1jhjMubeh}(h]h ]h"]h$]h&]uh1jhj3MhKfhjMubj)}(hR``os_desc`` "Extended Compatibility ID" and "Extended Properties" of the interfaceh](j)}(h ``os_desc``h]j)}(hjWMh]hos_desc}(hjYMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUMubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKghjQMubj)}(hhh]h)}(hF"Extended Compatibility ID" and "Extended Properties" of the interfaceh]hN“Extended Compatibility ID” and “Extended Properties” of the interface}(hjpMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjlMhKghjmMubah}(h]h ]h"]h$]h&]uh1jhjQMubeh}(h]h ]h"]h$]h&]uh1jhjlMhKghjMubeh}(h]h ]h"]h$]h&]uh1jhjLubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhjGhNubh)}(h**Description**h]jP )}(hjMh]h Description}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjMubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKkhjDGhhubh)}(hfEach interface can have at most one "Extended Compatibility ID" and a number of "Extended Properties".h]hnEach interface can have at most one “Extended Compatibility ID” and a number of “Extended Properties”.}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhhjDGhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_function (C struct)c.usb_functionhNtauh1jhjDGhhhjGhNubj)}(hhh](j)}(h usb_functionh]j)}(hstruct usb_functionh](j)}(hjh]hstruct}(hjMhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjMhhhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKnubj)}(h h]h }(hjMhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjMhhhjMhKnubj)}(h usb_functionh]j)}(hjMh]h usb_function}(hjMhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjMubah}(h]h ](j j eh"]h$]h&]j j uh1jhjMhhhjMhKnubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjMhhhjMhKnubah}(h]jMah ](j j eh"]h$]h&]j j )j huh1jhjMhKnhjMhhubj )}(hhh]h)}(h)describes one function of a configurationh]h)describes one function of a configuration}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKrhjNhhubah}(h]h ]h"]h$]h&]uh1j hjMhhhjMhKnubeh}(h]h ](jstructeh"]h$]h&]j? jj@ j1NjA j1NjB jC jD uh1jhhhjDGhjGhNubjF )}(hX**Definition**:: struct usb_function { const char *name; struct usb_gadget_strings **strings; struct usb_descriptor_header **fs_descriptors; struct usb_descriptor_header **hs_descriptors; struct usb_descriptor_header **ss_descriptors; struct usb_descriptor_header **ssp_descriptors; struct usb_configuration *config; struct usb_os_desc_table *os_desc_table; unsigned os_desc_n; int (*bind)(struct usb_configuration *, struct usb_function *); void (*unbind)(struct usb_configuration *, struct usb_function *); void (*free_func)(struct usb_function *f); struct module *mod; int (*set_alt)(struct usb_function *, unsigned interface, unsigned alt); int (*get_alt)(struct usb_function *, unsigned interface); void (*disable)(struct usb_function *); int (*setup)(struct usb_function *, const struct usb_ctrlrequest *); bool (*req_match)(struct usb_function *, const struct usb_ctrlrequest *, bool config0); void (*suspend)(struct usb_function *); void (*resume)(struct usb_function *); int (*get_status)(struct usb_function *); int (*func_suspend)(struct usb_function *, u8 suspend_opt); bool func_suspended; bool func_wakeup_armed; }; **Members** ``name`` For diagnostics, identifies the function. ``strings`` tables of strings, keyed by identifiers assigned during bind() and by language IDs provided in control requests ``fs_descriptors`` Table of full (or low) speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null, the function will not be available at full speed (or at low speed). ``hs_descriptors`` Table of high speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null, the function will not be available at high speed. ``ss_descriptors`` Table of super speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null after initiation, the function will not be available at super speed. ``ssp_descriptors`` Table of super speed plus descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null after initiation, the function will not be available at super speed plus. ``config`` assigned when **usb_add_function\(\)** is called; this is the configuration with which this function is associated. ``os_desc_table`` Table of (interface id, os descriptors) pairs. The function can expose more than one interface. If an interface is a member of an IAD, only the first interface of IAD has its entry in the table. ``os_desc_n`` Number of entries in os_desc_table ``bind`` Before the gadget can register, all of its functions bind() to the available resources including string and interface identifiers used in interface or class descriptors; endpoints; I/O buffers; and so on. ``unbind`` Reverses **bind**; called as a side effect of unregistering the driver which added this function. ``free_func`` free the struct usb_function. ``mod`` (internal) points to the module that created this structure. ``set_alt`` (REQUIRED) Reconfigures altsettings; function drivers may initialize usb_ep.driver data at this time (when it is used). Note that setting an interface to its current altsetting resets interface state, and that all interfaces have a disabled state. ``get_alt`` Returns the active altsetting. If this is not provided, then only altsetting zero is supported. ``disable`` (REQUIRED) Indicates the function should be disabled. Reasons include host resetting or reconfiguring the gadget, and disconnection. ``setup`` Used for interface-specific control requests. ``req_match`` Tests if a given class request can be handled by this function. ``suspend`` Notifies functions when the host stops sending USB traffic. ``resume`` Notifies functions when the host restarts USB traffic. ``get_status`` Returns function status as a reply to GetStatus() request when the recipient is Interface. ``func_suspend`` callback to be called when SetFeature(FUNCTION_SUSPEND) is reseived ``func_suspended`` Indicates whether the function is in function suspend state. ``func_wakeup_armed`` Indicates whether the function is armed by the host for wakeup signaling.h](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hj=NhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj9Nubh:}(hj9NhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKvhj5Nubjk )}(hXstruct usb_function { const char *name; struct usb_gadget_strings **strings; struct usb_descriptor_header **fs_descriptors; struct usb_descriptor_header **hs_descriptors; struct usb_descriptor_header **ss_descriptors; struct usb_descriptor_header **ssp_descriptors; struct usb_configuration *config; struct usb_os_desc_table *os_desc_table; unsigned os_desc_n; int (*bind)(struct usb_configuration *, struct usb_function *); void (*unbind)(struct usb_configuration *, struct usb_function *); void (*free_func)(struct usb_function *f); struct module *mod; int (*set_alt)(struct usb_function *, unsigned interface, unsigned alt); int (*get_alt)(struct usb_function *, unsigned interface); void (*disable)(struct usb_function *); int (*setup)(struct usb_function *, const struct usb_ctrlrequest *); bool (*req_match)(struct usb_function *, const struct usb_ctrlrequest *, bool config0); void (*suspend)(struct usb_function *); void (*resume)(struct usb_function *); int (*get_status)(struct usb_function *); int (*func_suspend)(struct usb_function *, u8 suspend_opt); bool func_suspended; bool func_wakeup_armed; };h]hXstruct usb_function { const char *name; struct usb_gadget_strings **strings; struct usb_descriptor_header **fs_descriptors; struct usb_descriptor_header **hs_descriptors; struct usb_descriptor_header **ss_descriptors; struct usb_descriptor_header **ssp_descriptors; struct usb_configuration *config; struct usb_os_desc_table *os_desc_table; unsigned os_desc_n; int (*bind)(struct usb_configuration *, struct usb_function *); void (*unbind)(struct usb_configuration *, struct usb_function *); void (*free_func)(struct usb_function *f); struct module *mod; int (*set_alt)(struct usb_function *, unsigned interface, unsigned alt); int (*get_alt)(struct usb_function *, unsigned interface); void (*disable)(struct usb_function *); int (*setup)(struct usb_function *, const struct usb_ctrlrequest *); bool (*req_match)(struct usb_function *, const struct usb_ctrlrequest *, bool config0); void (*suspend)(struct usb_function *); void (*resume)(struct usb_function *); int (*get_status)(struct usb_function *); int (*func_suspend)(struct usb_function *, u8 suspend_opt); bool func_suspended; bool func_wakeup_armed; };}hjVNsbah}(h]h ]h"]h$]h&]j j uh1jj hd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKxhj5Nubh)}(h **Members**h]jP )}(hjgNh]hMembers}(hjiNhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjeNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhj5Nubj)}(hhh](j)}(h3``name`` For diagnostics, identifies the function. h](j)}(h``name``h]j)}(hjNh]hname}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKthjNubj)}(hhh]h)}(h)For diagnostics, identifies the function.h]h)For diagnostics, identifies the function.}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNhKthjNubah}(h]h ]h"]h$]h&]uh1jhjNubeh}(h]h ]h"]h$]h&]uh1jhjNhKthj}Nubj)}(h|``strings`` tables of strings, keyed by identifiers assigned during bind() and by language IDs provided in control requests h](j)}(h ``strings``h]j)}(hjNh]hstrings}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKvhjNubj)}(hhh]h)}(hotables of strings, keyed by identifiers assigned during bind() and by language IDs provided in control requestsh]hotables of strings, keyed by identifiers assigned during bind() and by language IDs provided in control requests}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKuhjNubah}(h]h ]h"]h$]h&]uh1jhjNubeh}(h]h ]h"]h$]h&]uh1jhjNhKvhj}Nubj)}(h``fs_descriptors`` Table of full (or low) speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null, the function will not be available at full speed (or at low speed). h](j)}(h``fs_descriptors``h]j)}(hjNh]hfs_descriptors}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKyhjNubj)}(hhh]h)}(hTable of full (or low) speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null, the function will not be available at full speed (or at low speed).h](haTable of full (or low) speed descriptors, using interface and string identifiers assigned during }(hjOhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjOubh_. If this pointer is null, the function will not be available at full speed (or at low speed).}(hjOhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKwhjOubah}(h]h ]h"]h$]h&]uh1jhjNubeh}(h]h ]h"]h$]h&]uh1jhjOhKyhj}Nubj)}(h``hs_descriptors`` Table of high speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null, the function will not be available at high speed. h](j)}(h``hs_descriptors``h]j)}(hjEOh]hhs_descriptors}(hjGOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCOubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK|hj?Oubj)}(hhh]h)}(hTable of high speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null, the function will not be available at high speed.h](hXTable of high speed descriptors, using interface and string identifiers assigned during }(hj^OhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjfOhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj^OubhM. If this pointer is null, the function will not be available at high speed.}(hj^OhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKzhj[Oubah}(h]h ]h"]h$]h&]uh1jhj?Oubeh}(h]h ]h"]h$]h&]uh1jhjZOhK|hj}Nubj)}(h``ss_descriptors`` Table of super speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null after initiation, the function will not be available at super speed. h](j)}(h``ss_descriptors``h]j)}(hjOh]hss_descriptors}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjOubj)}(hhh]h)}(hTable of super speed descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null after initiation, the function will not be available at super speed.h](hYTable of super speed descriptors, using interface and string identifiers assigned during }(hjOhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjOubh^. If this pointer is null after initiation, the function will not be available at super speed.}(hjOhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhK}hjOubah}(h]h ]h"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]uh1jhjOhKhj}Nubj)}(h``ssp_descriptors`` Table of super speed plus descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null after initiation, the function will not be available at super speed plus. h](j)}(h``ssp_descriptors``h]j)}(hjOh]hssp_descriptors}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjOubj)}(hhh]h)}(hTable of super speed plus descriptors, using interface and string identifiers assigned during **bind\(\)**. If this pointer is null after initiation, the function will not be available at super speed plus.h](h^Table of super speed plus descriptors, using interface and string identifiers assigned during }(hjOhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjOubhc. If this pointer is null after initiation, the function will not be available at super speed plus.}(hjOhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjOubah}(h]h ]h"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]uh1jhjOhKhj}Nubj)}(h``config`` assigned when **usb_add_function\(\)** is called; this is the configuration with which this function is associated. h](j)}(h ``config``h]j)}(hj)Ph]hconfig}(hj+PhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'Pubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhj#Pubj)}(hhh]h)}(hsassigned when **usb_add_function\(\)** is called; this is the configuration with which this function is associated.h](hassigned when }(hjBPhhhNhNubjP )}(h**usb_add_function\(\)**h]husb_add_function()}(hjJPhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjBPubhM is called; this is the configuration with which this function is associated.}(hjBPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhj?Pubah}(h]h ]h"]h$]h&]uh1jhj#Pubeh}(h]h ]h"]h$]h&]uh1jhj>PhKhj}Nubj)}(h``os_desc_table`` Table of (interface id, os descriptors) pairs. The function can expose more than one interface. If an interface is a member of an IAD, only the first interface of IAD has its entry in the table. h](j)}(h``os_desc_table``h]j)}(hjuPh]h os_desc_table}(hjwPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsPubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjoPubj)}(hhh]h)}(hTable of (interface id, os descriptors) pairs. The function can expose more than one interface. If an interface is a member of an IAD, only the first interface of IAD has its entry in the table.h]hTable of (interface id, os descriptors) pairs. The function can expose more than one interface. If an interface is a member of an IAD, only the first interface of IAD has its entry in the table.}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjPubah}(h]h ]h"]h$]h&]uh1jhjoPubeh}(h]h ]h"]h$]h&]uh1jhjPhKhj}Nubj)}(h1``os_desc_n`` Number of entries in os_desc_table h](j)}(h ``os_desc_n``h]j)}(hjPh]h os_desc_n}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjPubj)}(hhh]h)}(h"Number of entries in os_desc_tableh]h"Number of entries in os_desc_table}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjPhKhjPubah}(h]h ]h"]h$]h&]uh1jhjPubeh}(h]h ]h"]h$]h&]uh1jhjPhKhj}Nubj)}(h``bind`` Before the gadget can register, all of its functions bind() to the available resources including string and interface identifiers used in interface or class descriptors; endpoints; I/O buffers; and so on. h](j)}(h``bind``h]j)}(hjPh]hbind}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjPubj)}(hhh]h)}(hBefore the gadget can register, all of its functions bind() to the available resources including string and interface identifiers used in interface or class descriptors; endpoints; I/O buffers; and so on.h]hBefore the gadget can register, all of its functions bind() to the available resources including string and interface identifiers used in interface or class descriptors; endpoints; I/O buffers; and so on.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjPubah}(h]h ]h"]h$]h&]uh1jhjPubeh}(h]h ]h"]h$]h&]uh1jhjPhKhj}Nubj)}(hm``unbind`` Reverses **bind**; called as a side effect of unregistering the driver which added this function. h](j)}(h ``unbind``h]j)}(hj"Qh]hunbind}(hj$QhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj Qubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjQubj)}(hhh]h)}(haReverses **bind**; called as a side effect of unregistering the driver which added this function.h](h Reverses }(hj;QhhhNhNubjP )}(h**bind**h]hbind}(hjCQhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj;QubhP; called as a side effect of unregistering the driver which added this function.}(hj;QhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhj8Qubah}(h]h ]h"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]uh1jhj7QhKhj}Nubj)}(h,``free_func`` free the struct usb_function. h](j)}(h ``free_func``h]j)}(hjnQh]h free_func}(hjpQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlQubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjhQubj)}(hhh]h)}(hfree the struct usb_function.h]hfree the struct usb_function.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQhKhjQubah}(h]h ]h"]h$]h&]uh1jhjhQubeh}(h]h ]h"]h$]h&]uh1jhjQhKhj}Nubj)}(hE``mod`` (internal) points to the module that created this structure. h](j)}(h``mod``h]j)}(hjQh]hmod}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjQubj)}(hhh]h)}(h<(internal) points to the module that created this structure.h]h<(internal) points to the module that created this structure.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQhKhjQubah}(h]h ]h"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]uh1jhjQhKhj}Nubj)}(hX``set_alt`` (REQUIRED) Reconfigures altsettings; function drivers may initialize usb_ep.driver data at this time (when it is used). Note that setting an interface to its current altsetting resets interface state, and that all interfaces have a disabled state. h](j)}(h ``set_alt``h]j)}(hjQh]hset_alt}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjQubj)}(hhh]h)}(h(REQUIRED) Reconfigures altsettings; function drivers may initialize usb_ep.driver data at this time (when it is used). Note that setting an interface to its current altsetting resets interface state, and that all interfaces have a disabled state.h]h(REQUIRED) Reconfigures altsettings; function drivers may initialize usb_ep.driver data at this time (when it is used). Note that setting an interface to its current altsetting resets interface state, and that all interfaces have a disabled state.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjQubah}(h]h ]h"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]uh1jhjQhKhj}Nubj)}(hm``get_alt`` Returns the active altsetting. If this is not provided, then only altsetting zero is supported. h](j)}(h ``get_alt``h]j)}(hjRh]hget_alt}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjRubj)}(hhh]h)}(h`Returns the active altsetting. If this is not provided, then only altsetting zero is supported.h]h`Returns the active altsetting. If this is not provided, then only altsetting zero is supported.}(hj3RhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhj0Rubah}(h]h ]h"]h$]h&]uh1jhjRubeh}(h]h ]h"]h$]h&]uh1jhj/RhKhj}Nubj)}(h``disable`` (REQUIRED) Indicates the function should be disabled. Reasons include host resetting or reconfiguring the gadget, and disconnection. h](j)}(h ``disable``h]j)}(hjTRh]hdisable}(hjVRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRRubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjNRubj)}(hhh]h)}(h(REQUIRED) Indicates the function should be disabled. Reasons include host resetting or reconfiguring the gadget, and disconnection.h]h(REQUIRED) Indicates the function should be disabled. Reasons include host resetting or reconfiguring the gadget, and disconnection.}(hjmRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjjRubah}(h]h ]h"]h$]h&]uh1jhjNRubeh}(h]h ]h"]h$]h&]uh1jhjiRhKhj}Nubj)}(h8``setup`` Used for interface-specific control requests. h](j)}(h ``setup``h]j)}(hjRh]hsetup}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjRubj)}(hhh]h)}(h-Used for interface-specific control requests.h]h-Used for interface-specific control requests.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhKhjRubah}(h]h ]h"]h$]h&]uh1jhjRubeh}(h]h ]h"]h$]h&]uh1jhjRhKhj}Nubj)}(hN``req_match`` Tests if a given class request can be handled by this function. h](j)}(h ``req_match``h]j)}(hjRh]h req_match}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjRubj)}(hhh]h)}(h?Tests if a given class request can be handled by this function.h]h?Tests if a given class request can be handled by this function.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhKhjRubah}(h]h ]h"]h$]h&]uh1jhjRubeh}(h]h ]h"]h$]h&]uh1jhjRhKhj}Nubj)}(hH``suspend`` Notifies functions when the host stops sending USB traffic. h](j)}(h ``suspend``h]j)}(hjSh]hsuspend}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjRubj)}(hhh]h)}(h;Notifies functions when the host stops sending USB traffic.h]h;Notifies functions when the host stops sending USB traffic.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjShKhjSubah}(h]h ]h"]h$]h&]uh1jhjRubeh}(h]h ]h"]h$]h&]uh1jhjShKhj}Nubj)}(hB``resume`` Notifies functions when the host restarts USB traffic. h](j)}(h ``resume``h]j)}(hj9Sh]hresume}(hj;ShhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7Subah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhj3Subj)}(hhh]h)}(h6Notifies functions when the host restarts USB traffic.h]h6Notifies functions when the host restarts USB traffic.}(hjRShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNShKhjOSubah}(h]h ]h"]h$]h&]uh1jhj3Subeh}(h]h ]h"]h$]h&]uh1jhjNShKhj}Nubj)}(hj``get_status`` Returns function status as a reply to GetStatus() request when the recipient is Interface. h](j)}(h``get_status``h]j)}(hjrSh]h get_status}(hjtShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpSubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjlSubj)}(hhh]h)}(hZReturns function status as a reply to GetStatus() request when the recipient is Interface.h]hZReturns function status as a reply to GetStatus() request when the recipient is Interface.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjSubah}(h]h ]h"]h$]h&]uh1jhjlSubeh}(h]h ]h"]h$]h&]uh1jhjShKhj}Nubj)}(hU``func_suspend`` callback to be called when SetFeature(FUNCTION_SUSPEND) is reseived h](j)}(h``func_suspend``h]j)}(hjSh]h func_suspend}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjSubj)}(hhh]h)}(hCcallback to be called when SetFeature(FUNCTION_SUSPEND) is reseivedh]hCcallback to be called when SetFeature(FUNCTION_SUSPEND) is reseived}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjSubah}(h]h ]h"]h$]h&]uh1jhjSubeh}(h]h ]h"]h$]h&]uh1jhjShKhj}Nubj)}(hP``func_suspended`` Indicates whether the function is in function suspend state. h](j)}(h``func_suspended``h]j)}(hjSh]hfunc_suspended}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhKhjSubj)}(hhh]h)}(h``bConfigurationValue`` Copied into configuration descriptor. h](j)}(h``bConfigurationValue``h]j)}(hjWh]hbConfigurationValue}(hj WhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjWubj)}(hhh]h)}(h%Copied into configuration descriptor.h]h%Copied into configuration descriptor.}(hj!WhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjWhMhjWubah}(h]h ]h"]h$]h&]uh1jhjWubeh}(h]h ]h"]h$]h&]uh1jhjWhMhjUubj)}(h9``iConfiguration`` Copied into configuration descriptor. h](j)}(h``iConfiguration``h]j)}(hjAWh]hiConfiguration}(hjCWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?Wubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj;Wubj)}(hhh]h)}(h%Copied into configuration descriptor.h]h%Copied into configuration descriptor.}(hjZWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVWhMhjWWubah}(h]h ]h"]h$]h&]uh1jhj;Wubeh}(h]h ]h"]h$]h&]uh1jhjVWhMhjUubj)}(h7``bmAttributes`` Copied into configuration descriptor. h](j)}(h``bmAttributes``h]j)}(hjzWh]h bmAttributes}(hj|WhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjxWubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjtWubj)}(hhh]h)}(h%Copied into configuration descriptor.h]h%Copied into configuration descriptor.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjWhMhjWubah}(h]h ]h"]h$]h&]uh1jhjtWubeh}(h]h ]h"]h$]h&]uh1jhjWhMhjUubj)}(h``MaxPower`` Power consumption in mA. Used to compute bMaxPower in the configuration descriptor after considering the bus speed. h](j)}(h ``MaxPower``h]j)}(hjWh]hMaxPower}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjWubj)}(hhh]h)}(hsPower consumption in mA. Used to compute bMaxPower in the configuration descriptor after considering the bus speed.h]hsPower consumption in mA. Used to compute bMaxPower in the configuration descriptor after considering the bus speed.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjWubah}(h]h ]h"]h$]h&]uh1jhjWubeh}(h]h ]h"]h$]h&]uh1jhjWhMhjUubj)}(h``cdev`` assigned by **usb_add_config\(\)** before calling **bind\(\)**; this is the device associated with this configuration.h](j)}(h``cdev``h]j)}(hjWh]hcdev}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjWubj)}(hhh]h)}(hvassigned by **usb_add_config\(\)** before calling **bind\(\)**; this is the device associated with this configuration.h](h assigned by }(hjXhhhNhNubjP )}(h**usb_add_config\(\)**h]husb_add_config()}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjXubh before calling }(hjXhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hj XhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjXubh8; this is the device associated with this configuration.}(hjXhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjXhMhjXubah}(h]h ]h"]h$]h&]uh1jhjWubeh}(h]h ]h"]h$]h&]uh1jhjXhMhjUubeh}(h]h ]h"]h$]h&]uh1jhjrUubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhjGhNubh)}(h**Description**h]jP )}(hjSXh]h Description}(hjUXhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjQXubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjDGhhubh)}(hXConfigurations are building blocks for gadget drivers structured around function drivers. Simple USB gadgets require only one function and one configuration, and handle dual-speed hardware by always providing the same functionality. Slightly more complex gadgets may have more than one single-function configuration at a given speed; or have configurations that only work at one speed.h]hXConfigurations are building blocks for gadget drivers structured around function drivers. Simple USB gadgets require only one function and one configuration, and handle dual-speed hardware by always providing the same functionality. Slightly more complex gadgets may have more than one single-function configuration at a given speed; or have configurations that only work at one speed.}(hjiXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjDGhhubh)}(hdComposite devices are, by definition, ones with configurations which include more than one function.h]hdComposite devices are, by definition, ones with configurations which include more than one function.}(hjxXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjDGhhubh)}(hXKThe lifecycle of a usb_configuration includes allocation, initialization of the fields described above, and calling **usb_add_config\(\)** to set up internal data and bind it to a specific device. The configuration's **bind\(\)** method is then used to initialize all the functions and then call **usb_add_function\(\)** for them.h](htThe lifecycle of a usb_configuration includes allocation, initialization of the fields described above, and calling }(hjXhhhNhNubjP )}(h**usb_add_config\(\)**h]husb_add_config()}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjXubhR to set up internal data and bind it to a specific device. The configuration’s }(hjXhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjXubhC method is then used to initialize all the functions and then call }(hjXhhhNhNubjP )}(h**usb_add_function\(\)**h]husb_add_function()}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjXubh for them.}(hjXhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhM!hjDGhhubh)}(hXnThose functions would normally be independent of each other, but that's not mandatory. CDC WMC devices are an example where functions often depend on other functions, with some functions subsidiary to others. Such interdependency may be managed in any way, so long as all of the descriptors complete by the time the composite driver returns from its bind() routine.h]hXpThose functions would normally be independent of each other, but that’s not mandatory. CDC WMC devices are an example where functions often depend on other functions, with some functions subsidiary to others. Such interdependency may be managed in any way, so long as all of the descriptors complete by the time the composite driver returns from its bind() routine.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhM'hjDGhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_composite_driver (C struct)c.usb_composite_driverhNtauh1jhjDGhhhjGhNubj)}(hhh](j)}(husb_composite_driverh]j)}(hstruct usb_composite_driverh](j)}(hjh]hstruct}(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXhhhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhM1ubj)}(h h]h }(hjYhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXhhhjYhM1ubj)}(husb_composite_driverh]j)}(hjXh]husb_composite_driver}(hjYhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjYubah}(h]h ](j j eh"]h$]h&]j j uh1jhjXhhhjYhM1ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjXhhhjYhM1ubah}(h]jXah ](j j eh"]h$]h&]j j )j huh1jhjYhM1hjXhhubj )}(hhh]h)}(h#groups configurations into a gadgeth]h#groups configurations into a gadget}(hj6YhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhM_hj3Yhhubah}(h]h ]h"]h$]h&]uh1j hjXhhhjYhM1ubeh}(h]h ](jstructeh"]h$]h&]j? jj@ jNYjA jNYjB jC jD uh1jhhhjDGhjGhNubjF )}(hXU**Definition**:: struct usb_composite_driver { const char *name; const struct usb_device_descriptor *dev; struct usb_gadget_strings **strings; enum usb_device_speed max_speed; unsigned needs_serial:1; int (*bind)(struct usb_composite_dev *cdev); int (*unbind)(struct usb_composite_dev *); void (*disconnect)(struct usb_composite_dev *); void (*suspend)(struct usb_composite_dev *); void (*resume)(struct usb_composite_dev *); struct usb_gadget_driver gadget_driver; }; **Members** ``name`` For diagnostics, identifies the driver. ``dev`` Template descriptor for the device, including default device identifiers. ``strings`` tables of strings, keyed by identifiers assigned during **bind** and language IDs provided in control requests. Note: The first entries are predefined. The first entry that may be used is USB_GADGET_FIRST_AVAIL_IDX ``max_speed`` Highest speed the driver supports. ``needs_serial`` set to 1 if the gadget needs userspace to provide a serial number. If one is not provided, warning will be printed. ``bind`` (REQUIRED) Used to allocate resources that are shared across the whole device, such as string IDs, and add its configurations using **usb_add_config\(\)**. This may fail by returning a negative errno value; it should return zero on successful initialization. ``unbind`` Reverses **bind**; called as a side effect of unregistering this driver. ``disconnect`` optional driver disconnect method ``suspend`` Notifies when the host stops sending USB traffic, after function notifications ``resume`` Notifies configuration when the host restarts USB traffic, before function notifications ``gadget_driver`` Gadget driver controlling this driverh](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hjZYhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjVYubh:}(hjVYhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMchjRYubjk )}(hX@struct usb_composite_driver { const char *name; const struct usb_device_descriptor *dev; struct usb_gadget_strings **strings; enum usb_device_speed max_speed; unsigned needs_serial:1; int (*bind)(struct usb_composite_dev *cdev); int (*unbind)(struct usb_composite_dev *); void (*disconnect)(struct usb_composite_dev *); void (*suspend)(struct usb_composite_dev *); void (*resume)(struct usb_composite_dev *); struct usb_gadget_driver gadget_driver; };h]hX@struct usb_composite_driver { const char *name; const struct usb_device_descriptor *dev; struct usb_gadget_strings **strings; enum usb_device_speed max_speed; unsigned needs_serial:1; int (*bind)(struct usb_composite_dev *cdev); int (*unbind)(struct usb_composite_dev *); void (*disconnect)(struct usb_composite_dev *); void (*suspend)(struct usb_composite_dev *); void (*resume)(struct usb_composite_dev *); struct usb_gadget_driver gadget_driver; };}hjsYsbah}(h]h ]h"]h$]h&]j j uh1jj hd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMehjRYubh)}(h **Members**h]jP )}(hjYh]hMembers}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjYubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMshjRYubj)}(hhh](j)}(h1``name`` For diagnostics, identifies the driver. h](j)}(h``name``h]j)}(hjYh]hname}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMahjYubj)}(hhh]h)}(h'For diagnostics, identifies the driver.h]h'For diagnostics, identifies the driver.}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYhMahjYubah}(h]h ]h"]h$]h&]uh1jhjYubeh}(h]h ]h"]h$]h&]uh1jhjYhMahjYubj)}(hR``dev`` Template descriptor for the device, including default device identifiers. h](j)}(h``dev``h]j)}(hjYh]hdev}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMchjYubj)}(hhh]h)}(hITemplate descriptor for the device, including default device identifiers.h]hITemplate descriptor for the device, including default device identifiers.}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMbhjYubah}(h]h ]h"]h$]h&]uh1jhjYubeh}(h]h ]h"]h$]h&]uh1jhjYhMchjYubj)}(h``strings`` tables of strings, keyed by identifiers assigned during **bind** and language IDs provided in control requests. Note: The first entries are predefined. The first entry that may be used is USB_GADGET_FIRST_AVAIL_IDX h](j)}(h ``strings``h]j)}(hjZh]hstrings}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMghjZubj)}(hhh]h)}(htables of strings, keyed by identifiers assigned during **bind** and language IDs provided in control requests. Note: The first entries are predefined. The first entry that may be used is USB_GADGET_FIRST_AVAIL_IDXh](h8tables of strings, keyed by identifiers assigned during }(hj/ZhhhNhNubjP )}(h**bind**h]hbind}(hj7ZhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj/Zubh and language IDs provided in control requests. Note: The first entries are predefined. The first entry that may be used is USB_GADGET_FIRST_AVAIL_IDX}(hj/ZhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMdhj,Zubah}(h]h ]h"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]uh1jhj+ZhMghjYubj)}(h1``max_speed`` Highest speed the driver supports. h](j)}(h ``max_speed``h]j)}(hjbZh]h max_speed}(hjdZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`Zubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhhj\Zubj)}(hhh]h)}(h"Highest speed the driver supports.h]h"Highest speed the driver supports.}(hj{ZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwZhMhhjxZubah}(h]h ]h"]h$]h&]uh1jhj\Zubeh}(h]h ]h"]h$]h&]uh1jhjwZhMhhjYubj)}(h``needs_serial`` set to 1 if the gadget needs userspace to provide a serial number. If one is not provided, warning will be printed. h](j)}(h``needs_serial``h]j)}(hjZh]h needs_serial}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMjhjZubj)}(hhh]h)}(htset to 1 if the gadget needs userspace to provide a serial number. If one is not provided, warning will be printed.h]htset to 1 if the gadget needs userspace to provide a serial number. If one is not provided, warning will be printed.}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMihjZubah}(h]h ]h"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]uh1jhjZhMjhjYubj)}(hX ``bind`` (REQUIRED) Used to allocate resources that are shared across the whole device, such as string IDs, and add its configurations using **usb_add_config\(\)**. This may fail by returning a negative errno value; it should return zero on successful initialization. h](j)}(h``bind``h]j)}(hjZh]hbind}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMnhjZubj)}(hhh]h)}(hX(REQUIRED) Used to allocate resources that are shared across the whole device, such as string IDs, and add its configurations using **usb_add_config\(\)**. This may fail by returning a negative errno value; it should return zero on successful initialization.h](h(REQUIRED) Used to allocate resources that are shared across the whole device, such as string IDs, and add its configurations using }(hjZhhhNhNubjP )}(h**usb_add_config\(\)**h]husb_add_config()}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjZubhh. This may fail by returning a negative errno value; it should return zero on successful initialization.}(hjZhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMkhjZubah}(h]h ]h"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]uh1jhjZhMnhjYubj)}(hT``unbind`` Reverses **bind**; called as a side effect of unregistering this driver. h](j)}(h ``unbind``h]j)}(hj![h]hunbind}(hj#[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj[ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMphjbj)}(hhh]h)}(hHReverses **bind**; called as a side effect of unregistering this driver.h](h Reverses }(hj:[hhhNhNubjP )}(h**bind**h]hbind}(hjB[hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj:[ubh7; called as a side effect of unregistering this driver.}(hj:[hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMohj7[ubah}(h]h ]h"]h$]h&]uh1jhjbeh}(h]h ]h"]h$]h&]uh1jhj6[hMphjYubj)}(h1``disconnect`` optional driver disconnect method h](j)}(h``disconnect``h]j)}(hjm[h]h disconnect}(hjo[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjk[ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMqhjg[ubj)}(hhh]h)}(h!optional driver disconnect methodh]h!optional driver disconnect method}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[hMqhj[ubah}(h]h ]h"]h$]h&]uh1jhjg[ubeh}(h]h ]h"]h$]h&]uh1jhj[hMqhjYubj)}(h[``suspend`` Notifies when the host stops sending USB traffic, after function notifications h](j)}(h ``suspend``h]j)}(hj[h]hsuspend}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj[ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMshj[ubj)}(hhh]h)}(hNNotifies when the host stops sending USB traffic, after function notificationsh]hNNotifies when the host stops sending USB traffic, after function notifications}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMrhj[ubah}(h]h ]h"]h$]h&]uh1jhj[ubeh}(h]h ]h"]h$]h&]uh1jhj[hMshjYubj)}(hd``resume`` Notifies configuration when the host restarts USB traffic, before function notifications h](j)}(h ``resume``h]j)}(hj[h]hresume}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj[ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMuhj[ubj)}(hhh]h)}(hXNotifies configuration when the host restarts USB traffic, before function notificationsh]hXNotifies configuration when the host restarts USB traffic, before function notifications}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMthj[ubah}(h]h ]h"]h$]h&]uh1jhj[ubeh}(h]h ]h"]h$]h&]uh1jhj[hMuhjYubj)}(h7``gadget_driver`` Gadget driver controlling this driverh](j)}(h``gadget_driver``h]j)}(hj\h]h gadget_driver}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMuhj\ubj)}(hhh]h)}(h%Gadget driver controlling this driverh]h%Gadget driver controlling this driver}(hj3\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMvhj0\ubah}(h]h ]h"]h$]h&]uh1jhj\ubeh}(h]h ]h"]h$]h&]uh1jhj/\hMuhjYubeh}(h]h ]h"]h$]h&]uh1jhjRYubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhjGhNubh)}(h**Description**h]jP )}(hj]\h]h Description}(hj_\hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj[\ubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMyhjDGhhubh)}(hDevices default to reporting self powered operation. Devices which rely on bus powered operation should report this in their **bind** method.h](h~Devices default to reporting self powered operation. Devices which rely on bus powered operation should report this in their }(hjs\hhhNhNubjP )}(h**bind**h]hbind}(hj{\hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjs\ubh method.}(hjs\hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMvhjDGhhubh)}(hXBefore returning from **bind**, various fields in the template descriptor may be overridden. These include the idVendor/idProduct/bcdDevice values normally to bind the appropriate host side driver, and the three strings (iManufacturer, iProduct, iSerialNumber) normally used to provide user meaningful device identifiers. (The strings will not be defined unless they are defined in **dev** and **strings**.) The correct ep0 maxpacket size is also reported, as defined by the underlying controller driver.h](hBefore returning from }(hj\hhhNhNubjP )}(h**bind**h]hbind}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj\ubhXb, various fields in the template descriptor may be overridden. These include the idVendor/idProduct/bcdDevice values normally to bind the appropriate host side driver, and the three strings (iManufacturer, iProduct, iSerialNumber) normally used to provide user meaningful device identifiers. (The strings will not be defined unless they are defined in }(hj\hhhNhNubjP )}(h**dev**h]hdev}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj\ubh and }(hj\hhhNhNubjP )}(h **strings**h]hstrings}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj\ubhd.) The correct ep0 maxpacket size is also reported, as defined by the underlying controller driver.}(hj\hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMyhjDGhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j%module_usb_composite_driver (C macro)c.module_usb_composite_driverhNtauh1jhjDGhhhjGhNubj)}(hhh](j)}(hmodule_usb_composite_driverh]j)}(hmodule_usb_composite_driverh]j)}(hmodule_usb_composite_driverh]j)}(hj\h]hmodule_usb_composite_driver}(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj\hhhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMubah}(h]h ]h"]h$]h&]j j j uh1jj j hj\hhhj ]hMubah}(h]j\ah ](j j eh"]h$]h&]j j )j huh1jhj ]hMhj\hhubj )}(hhh]h}(h]h ]h"]h$]h&]uh1j hj\hhhj ]hMubeh}(h]h ](jmacroeh"]h$]h&]j? jj@ j"]jA j"]jB jC jD uh1jhhhjDGhjGhNubh)}(h8``module_usb_composite_driver (__usb_composite_driver)``h]j)}(hj(]h]h4module_usb_composite_driver (__usb_composite_driver)}(hj*]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj&]ubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjDGhhubh block_quote)}(h;Helper macro for registering a USB gadget composite driver h]h)}(h:Helper macro for registering a USB gadget composite driverh]h:Helper macro for registering a USB gadget composite driver}(hjD]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj@]ubah}(h]h ]h"]h$]h&]uh1j>]hjR]hMhjDGhhubjF )}(hXF**Parameters** ``__usb_composite_driver`` usb_composite_driver struct **Description** Helper macro for USB gadget composite drivers which do not do anything special in module init/exit. This eliminates a lot of boilerplate. Each module may only use this macro once, and calling it replaces module_init() and module_exit()h](h)}(h**Parameters**h]jP )}(hj_]h]h Parameters}(hja]hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj]]ubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjY]ubj)}(hhh]j)}(h7``__usb_composite_driver`` usb_composite_driver struct h](j)}(h``__usb_composite_driver``h]j)}(hj~]h]h__usb_composite_driver}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj|]ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjx]ubj)}(hhh]h)}(husb_composite_driver structh]husb_composite_driver struct}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]hMhj]ubah}(h]h ]h"]h$]h&]uh1jhjx]ubeh}(h]h ]h"]h$]h&]uh1jhj]hMhju]ubah}(h]h ]h"]h$]h&]uh1jhjY]ubh)}(h**Description**h]jP )}(hj]h]h Description}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj]ubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjY]ubh)}(hHelper macro for USB gadget composite drivers which do not do anything special in module init/exit. This eliminates a lot of boilerplate. Each module may only use this macro once, and calling it replaces module_init() and module_exit()h]hHelper macro for USB gadget composite drivers which do not do anything special in module init/exit. This eliminates a lot of boilerplate. Each module may only use this macro once, and calling it replaces module_init() and module_exit()}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjY]ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhjGhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_composite_dev (C struct)c.usb_composite_devhNtauh1jhjDGhhhjGhNubj)}(hhh](j)}(husb_composite_devh]j)}(hstruct usb_composite_devh](j)}(hjh]hstruct}(hj]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]hhhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMubj)}(h h]h }(hj ^hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]hhhj ^hMubj)}(husb_composite_devh]j)}(hj]h]husb_composite_dev}(hj^hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubah}(h]h ](j j eh"]h$]h&]j j uh1jhj]hhhj ^hMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj]hhhj ^hMubah}(h]j]ah ](j j eh"]h$]h&]j j )j huh1jhj ^hMhj]hhubj )}(hhh]h)}(h#represents one composite usb gadgeth]h#represents one composite usb gadget}(hj@^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj=^hhubah}(h]h ]h"]h$]h&]uh1j hj]hhhj ^hMubeh}(h]h ](jstructeh"]h$]h&]j? jj@ jX^jA jX^jB jC jD uh1jhhhjDGhjGhNubjF )}(hXg**Definition**:: struct usb_composite_dev { struct usb_gadget *gadget; struct usb_request *req; struct usb_request *os_desc_req; struct usb_configuration *config; u8 qw_sign[OS_STRING_QW_SIGN_LEN]; u8 b_vendor_code; struct usb_configuration *os_desc_config; unsigned int use_os_string:1; u16 bcd_webusb_version; u8 b_webusb_vendor_code; char landing_page[WEBUSB_URL_RAW_MAX_LENGTH]; unsigned int use_webusb:1; unsigned int setup_pending:1; unsigned int os_desc_pending:1; }; **Members** ``gadget`` read-only, abstracts the gadget's usb peripheral controller ``req`` used for control responses; buffer is pre-allocated ``os_desc_req`` used for OS descriptors responses; buffer is pre-allocated ``config`` the currently active configuration ``qw_sign`` qwSignature part of the OS string ``b_vendor_code`` bMS_VendorCode part of the OS string ``os_desc_config`` the configuration to be used with OS descriptors ``use_os_string`` false by default, interested gadgets set it ``bcd_webusb_version`` 0x0100 by default, WebUSB specification version ``b_webusb_vendor_code`` 0x0 by default, vendor code for WebUSB ``landing_page`` empty by default, landing page to announce in WebUSB ``use_webusb`` false by default, interested gadgets set it ``setup_pending`` true when setup request is queued but not completed ``os_desc_pending`` true when os_desc request is queued but not completedh](h)}(h**Definition**::h](jP )}(h**Definition**h]h Definition}(hjd^hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj`^ubh:}(hj`^hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj\^ubjk )}(hXstruct usb_composite_dev { struct usb_gadget *gadget; struct usb_request *req; struct usb_request *os_desc_req; struct usb_configuration *config; u8 qw_sign[OS_STRING_QW_SIGN_LEN]; u8 b_vendor_code; struct usb_configuration *os_desc_config; unsigned int use_os_string:1; u16 bcd_webusb_version; u8 b_webusb_vendor_code; char landing_page[WEBUSB_URL_RAW_MAX_LENGTH]; unsigned int use_webusb:1; unsigned int setup_pending:1; unsigned int os_desc_pending:1; };h]hXstruct usb_composite_dev { struct usb_gadget *gadget; struct usb_request *req; struct usb_request *os_desc_req; struct usb_configuration *config; u8 qw_sign[OS_STRING_QW_SIGN_LEN]; u8 b_vendor_code; struct usb_configuration *os_desc_config; unsigned int use_os_string:1; u16 bcd_webusb_version; u8 b_webusb_vendor_code; char landing_page[WEBUSB_URL_RAW_MAX_LENGTH]; unsigned int use_webusb:1; unsigned int setup_pending:1; unsigned int os_desc_pending:1; };}hj}^sbah}(h]h ]h"]h$]h&]j j uh1jj hd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj\^ubh)}(h **Members**h]jP )}(hj^h]hMembers}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj^ubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj\^ubj)}(hhh](j)}(hG``gadget`` read-only, abstracts the gadget's usb peripheral controller h](j)}(h ``gadget``h]j)}(hj^h]hgadget}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj^ubj)}(hhh]h)}(h;read-only, abstracts the gadget's usb peripheral controllerh]h=read-only, abstracts the gadget’s usb peripheral controller}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^hMhj^ubah}(h]h ]h"]h$]h&]uh1jhj^ubeh}(h]h ]h"]h$]h&]uh1jhj^hMhj^ubj)}(h<``req`` used for control responses; buffer is pre-allocated h](j)}(h``req``h]j)}(hj^h]hreq}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj^ubj)}(hhh]h)}(h3used for control responses; buffer is pre-allocatedh]h3used for control responses; buffer is pre-allocated}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^hMhj^ubah}(h]h ]h"]h$]h&]uh1jhj^ubeh}(h]h ]h"]h$]h&]uh1jhj^hMhj^ubj)}(hK``os_desc_req`` used for OS descriptors responses; buffer is pre-allocated h](j)}(h``os_desc_req``h]j)}(hj_h]h os_desc_req}(hj!_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj_ubj)}(hhh]h)}(h:used for OS descriptors responses; buffer is pre-allocatedh]h:used for OS descriptors responses; buffer is pre-allocated}(hj8_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4_hMhj5_ubah}(h]h ]h"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]uh1jhj4_hMhj^ubj)}(h.``config`` the currently active configuration h](j)}(h ``config``h]j)}(hjX_h]hconfig}(hjZ_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjV_ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjR_ubj)}(hhh]h)}(h"the currently active configurationh]h"the currently active configuration}(hjq_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjm_hMhjn_ubah}(h]h ]h"]h$]h&]uh1jhjR_ubeh}(h]h ]h"]h$]h&]uh1jhjm_hMhj^ubj)}(h.``qw_sign`` qwSignature part of the OS string h](j)}(h ``qw_sign``h]j)}(hj_h]hqw_sign}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj_ubj)}(hhh]h)}(h!qwSignature part of the OS stringh]h!qwSignature part of the OS string}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_hMhj_ubah}(h]h ]h"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]uh1jhj_hMhj^ubj)}(h7``b_vendor_code`` bMS_VendorCode part of the OS string h](j)}(h``b_vendor_code``h]j)}(hj_h]h b_vendor_code}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj_ubj)}(hhh]h)}(h$bMS_VendorCode part of the OS stringh]h$bMS_VendorCode part of the OS string}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_hMhj_ubah}(h]h ]h"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]uh1jhj_hMhj^ubj)}(hD``os_desc_config`` the configuration to be used with OS descriptors h](j)}(h``os_desc_config``h]j)}(hj`h]hos_desc_config}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj_ubj)}(hhh]h)}(h0the configuration to be used with OS descriptorsh]h0the configuration to be used with OS descriptors}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hMhj`ubah}(h]h ]h"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]uh1jhj`hMhj^ubj)}(h>``use_os_string`` false by default, interested gadgets set it h](j)}(h``use_os_string``h]j)}(hj<`h]h use_os_string}(hj>`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj:`ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj6`ubj)}(hhh]h)}(h+false by default, interested gadgets set ith]h+false by default, interested gadgets set it}(hjU`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQ`hMhjR`ubah}(h]h ]h"]h$]h&]uh1jhj6`ubeh}(h]h ]h"]h$]h&]uh1jhjQ`hMhj^ubj)}(hG``bcd_webusb_version`` 0x0100 by default, WebUSB specification version h](j)}(h``bcd_webusb_version``h]j)}(hju`h]hbcd_webusb_version}(hjw`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjs`ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjo`ubj)}(hhh]h)}(h/0x0100 by default, WebUSB specification versionh]h/0x0100 by default, WebUSB specification version}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hMhj`ubah}(h]h ]h"]h$]h&]uh1jhjo`ubeh}(h]h ]h"]h$]h&]uh1jhj`hMhj^ubj)}(h@``b_webusb_vendor_code`` 0x0 by default, vendor code for WebUSB h](j)}(h``b_webusb_vendor_code``h]j)}(hj`h]hb_webusb_vendor_code}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj`ubj)}(hhh]h)}(h&0x0 by default, vendor code for WebUSBh]h&0x0 by default, vendor code for WebUSB}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hMhj`ubah}(h]h ]h"]h$]h&]uh1jhj`ubeh}(h]h ]h"]h$]h&]uh1jhj`hMhj^ubj)}(hF``landing_page`` empty by default, landing page to announce in WebUSB h](j)}(h``landing_page``h]j)}(hj`h]h landing_page}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhj`ubj)}(hhh]h)}(h4empty by default, landing page to announce in WebUSBh]h4empty by default, landing page to announce in WebUSB}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hMhj`ubah}(h]h ]h"]h$]h&]uh1jhj`ubeh}(h]h ]h"]h$]h&]uh1jhj`hMhj^ubj)}(h;``use_webusb`` false by default, interested gadgets set it h](j)}(h``use_webusb``h]j)}(hj ah]h use_webusb}(hj"ahhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjaubj)}(hhh]h)}(h+false by default, interested gadgets set ith]h+false by default, interested gadgets set it}(hj9ahhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ahMhj6aubah}(h]h ]h"]h$]h&]uh1jhjaubeh}(h]h ]h"]h$]h&]uh1jhj5ahMhj^ubj)}(hF``setup_pending`` true when setup request is queued but not completed h](j)}(h``setup_pending``h]j)}(hjYah]h setup_pending}(hj[ahhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWaubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjSaubj)}(hhh]h)}(h3true when setup request is queued but not completedh]h3true when setup request is queued but not completed}(hjrahhhNhNubah}(h]h ]h"]h$]h&]uh1hhjnahMhjoaubah}(h]h ]h"]h$]h&]uh1jhjSaubeh}(h]h ]h"]h$]h&]uh1jhjnahMhj^ubj)}(hI``os_desc_pending`` true when os_desc request is queued but not completedh](j)}(h``os_desc_pending``h]j)}(hjah]hos_desc_pending}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]uh1jhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjaubj)}(hhh]h)}(h5true when os_desc request is queued but not completedh]h5true when os_desc request is queued but not completed}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjaubah}(h]h ]h"]h$]h&]uh1jhjaubeh}(h]h ]h"]h$]h&]uh1jhjahMhj^ubeh}(h]h ]h"]h$]h&]uh1jhj\^ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhjGhNubh)}(h**Description**h]jP )}(hjah]h Description}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjaubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjDGhhubh)}(hiOne of these devices is allocated and initialized before the associated device driver's bind() is called.h]hkOne of these devices is allocated and initialized before the associated device driver’s bind() is called.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhd/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:349: ./include/linux/usb/composite.hhMhjDGhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'config_ep_by_speed_and_alt (C function)c.config_ep_by_speed_and_althNtauh1jhjDGhhhNhNubj)}(hhh](j)}(hiint config_ep_by_speed_and_alt (struct usb_gadget *g, struct usb_function *f, struct usb_ep *_ep, u8 alt)h]j)}(hhint config_ep_by_speed_and_alt(struct usb_gadget *g, struct usb_function *f, struct usb_ep *_ep, u8 alt)h](j)}(hinth]hint}(hjbhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjbhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKubj)}(h h]h }(hj"bhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbhhhj!bhKubj)}(hconfig_ep_by_speed_and_alth]j)}(hconfig_ep_by_speed_and_alth]hconfig_ep_by_speed_and_alt}(hj4bhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0bubah}(h]h ](j j eh"]h$]h&]j j uh1jhjbhhhj!bhKubjW)}(hJ(struct usb_gadget *g, struct usb_function *f, struct usb_ep *_ep, u8 alt)h](j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hjPbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjLbubj)}(h h]h }(hj]bhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjLbubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hjnbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjkbubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjpbmodnameN classnameNjj)}j]j)}jj6bsbc.config_ep_by_speed_and_altasbuh1hhjLbubj)}(h h]h }(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjLbubj)}(hjh]h*}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjLbubj)}(hj#h]hg}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjLbubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjHbubj])}(hstruct usb_function *fh](j)}(hjh]hstruct}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubj)}(h h]h }(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubh)}(hhh]j)}(h usb_functionh]h usb_function}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjbmodnameN classnameNjj)}j]jbc.config_ep_by_speed_and_altasbuh1hhjbubj)}(h h]h }(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubj)}(hjh]h*}(hj chhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubj)}(hfh]hf}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjHbubj])}(hstruct usb_ep *_eph](j)}(hjh]hstruct}(hj1chhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-cubj)}(h h]h }(hj>chhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-cubh)}(hhh]j)}(husb_eph]husb_ep}(hjOchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjLcubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjQcmodnameN classnameNjj)}j]jbc.config_ep_by_speed_and_altasbuh1hhj-cubj)}(h h]h }(hjmchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-cubj)}(hjh]h*}(hj{chhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-cubj)}(h_eph]h_ep}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj-cubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjHbubj])}(hu8 alth](h)}(hhh]j)}(hu8h]hu8}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjcmodnameN classnameNjj)}j]jbc.config_ep_by_speed_and_altasbuh1hhjcubj)}(h h]h }(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjcubj)}(halth]halt}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjcubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjHbubeh}(h]h ]h"]h$]h&]j j uh1jVhjbhhhj!bhKubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj bhhhj!bhKubah}(h]jbah ](j j eh"]h$]h&]j j )j huh1jhj!bhKhjbhhubj )}(hhh]h)}(h8configures the given endpoint according to gadget speed.h]h8configures the given endpoint according to gadget speed.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjchhubah}(h]h ]h"]h$]h&]uh1j hjbhhhj!bhKubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jdjA jdjB jC jD uh1jhhhjDGhNhNubjF )}(hX**Parameters** ``struct usb_gadget *g`` pointer to the gadget ``struct usb_function *f`` usb function ``struct usb_ep *_ep`` the endpoint to configure ``u8 alt`` alternate setting number **Return** error code, 0 on success **Description** This function chooses the right descriptors for a given endpoint according to gadget speed and saves it in the endpoint desc field. If the endpoint already has a descriptor assigned to it - overwrites it with currently corresponding descriptor. The endpoint maxpacket field is updated according to the chosen descriptor. **Note** the supplied function should hold all the descriptors for supported speedsh](h)}(h**Parameters**h]jP )}(hjdh]h Parameters}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjdubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubj)}(hhh](j)}(h/``struct usb_gadget *g`` pointer to the gadget h](j)}(h``struct usb_gadget *g``h]j)}(hj;dh]hstruct usb_gadget *g}(hj=dhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9dubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhj5dubj)}(hhh]h)}(hpointer to the gadgeth]hpointer to the gadget}(hjTdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjPdhKhjQdubah}(h]h ]h"]h$]h&]uh1jhj5dubeh}(h]h ]h"]h$]h&]uh1jhjPdhKhj2dubj)}(h(``struct usb_function *f`` usb function h](j)}(h``struct usb_function *f``h]j)}(hjtdh]hstruct usb_function *f}(hjvdhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrdubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjndubj)}(hhh]h)}(h usb functionh]h usb function}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjdhKhjdubah}(h]h ]h"]h$]h&]uh1jhjndubeh}(h]h ]h"]h$]h&]uh1jhjdhKhj2dubj)}(h1``struct usb_ep *_ep`` the endpoint to configure h](j)}(h``struct usb_ep *_ep``h]j)}(hjdh]hstruct usb_ep *_ep}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjdubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubj)}(hhh]h)}(hthe endpoint to configureh]hthe endpoint to configure}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjdhKhjdubah}(h]h ]h"]h$]h&]uh1jhjdubeh}(h]h ]h"]h$]h&]uh1jhjdhKhj2dubj)}(h$``u8 alt`` alternate setting number h](j)}(h ``u8 alt``h]j)}(hjdh]hu8 alt}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjdubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubj)}(hhh]h)}(halternate setting numberh]halternate setting number}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjdhKhjdubah}(h]h ]h"]h$]h&]uh1jhjdubeh}(h]h ]h"]h$]h&]uh1jhjdhKhj2dubeh}(h]h ]h"]h$]h&]uh1jhjdubh)}(h **Return**h]jP )}(hj!eh]hReturn}(hj#ehhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjeubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubh)}(herror code, 0 on successh]herror code, 0 on success}(hj7ehhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubh)}(h**Description**h]jP )}(hjHeh]h Description}(hjJehhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjFeubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubh)}(hX@This function chooses the right descriptors for a given endpoint according to gadget speed and saves it in the endpoint desc field. If the endpoint already has a descriptor assigned to it - overwrites it with currently corresponding descriptor. The endpoint maxpacket field is updated according to the chosen descriptor.h]hX@This function chooses the right descriptors for a given endpoint according to gadget speed and saves it in the endpoint desc field. If the endpoint already has a descriptor assigned to it - overwrites it with currently corresponding descriptor. The endpoint maxpacket field is updated according to the chosen descriptor.}(hj^ehhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubh)}(h**Note**h]jP )}(hjoeh]hNote}(hjqehhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjmeubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubh)}(hJthe supplied function should hold all the descriptors for supported speedsh]hJthe supplied function should hold all the descriptors for supported speeds}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chKhjdubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jconfig_ep_by_speed (C function)c.config_ep_by_speedhNtauh1jhjDGhhhNhNubj)}(hhh](j)}(hYint config_ep_by_speed (struct usb_gadget *g, struct usb_function *f, struct usb_ep *_ep)h]j)}(hXint config_ep_by_speed(struct usb_gadget *g, struct usb_function *f, struct usb_ep *_ep)h](j)}(hinth]hint}(hjehhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjehhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMubj)}(h h]h }(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjehhhjehMubj)}(hconfig_ep_by_speedh]j)}(hconfig_ep_by_speedh]hconfig_ep_by_speed}(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubah}(h]h ](j j eh"]h$]h&]j j uh1jhjehhhjehMubjW)}(hB(struct usb_gadget *g, struct usb_function *f, struct usb_ep *_ep)h](j])}(hstruct usb_gadget *gh](j)}(hjh]hstruct}(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubj)}(h h]h }(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubh)}(hhh]j)}(h usb_gadgeth]h usb_gadget}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj fubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjfmodnameN classnameNjj)}j]j)}jjesbc.config_ep_by_speedasbuh1hhjeubj)}(h h]h }(hj/fhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubj)}(hjh]h*}(hj=fhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubj)}(hj#h]hg}(hjJfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjeubj])}(hstruct usb_function *fh](j)}(hjh]hstruct}(hjbfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^fubj)}(h h]h }(hjofhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^fubh)}(hhh]j)}(h usb_functionh]h usb_function}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}fubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjfmodnameN classnameNjj)}j]j+fc.config_ep_by_speedasbuh1hhj^fubj)}(h h]h }(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^fubj)}(hjh]h*}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^fubj)}(hjch]hf}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^fubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjeubj])}(hstruct usb_ep *_eph](j)}(hjh]hstruct}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfubj)}(h h]h }(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfubh)}(hhh]j)}(husb_eph]husb_ep}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjfmodnameN classnameNjj)}j]j+fc.config_ep_by_speedasbuh1hhjfubj)}(h h]h }(hj ghhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfubj)}(hjh]h*}(hjghhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfubj)}(h_eph]h_ep}(hj(ghhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjeubeh}(h]h ]h"]h$]h&]j j uh1jVhjehhhjehMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjehhhjehMubah}(h]jeah ](j j eh"]h$]h&]j j )j huh1jhjehMhjehhubj )}(hhh]h)}(h8configures the given endpoint according to gadget speed.h]h8configures the given endpoint according to gadget speed.}(hjRghhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjOghhubah}(h]h ]h"]h$]h&]uh1j hjehhhjehMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jjgjA jjgjB jC jD uh1jhhhjDGhNhNubjF )}(hXn**Parameters** ``struct usb_gadget *g`` pointer to the gadget ``struct usb_function *f`` usb function ``struct usb_ep *_ep`` the endpoint to configure **Return** error code, 0 on success **Description** This function chooses the right descriptors for a given endpoint according to gadget speed and saves it in the endpoint desc field. If the endpoint already has a descriptor assigned to it - overwrites it with currently corresponding descriptor. The endpoint maxpacket field is updated according to the chosen descriptor. **Note** the supplied function should hold all the descriptors for supported speedsh](h)}(h**Parameters**h]jP )}(hjtgh]h Parameters}(hjvghhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjrgubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjngubj)}(hhh](j)}(h/``struct usb_gadget *g`` pointer to the gadget h](j)}(h``struct usb_gadget *g``h]j)}(hjgh]hstruct usb_gadget *g}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjgubj)}(hhh]h)}(hpointer to the gadgeth]hpointer to the gadget}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhjghMhjgubah}(h]h ]h"]h$]h&]uh1jhjgubeh}(h]h ]h"]h$]h&]uh1jhjghMhjgubj)}(h(``struct usb_function *f`` usb function h](j)}(h``struct usb_function *f``h]j)}(hjgh]hstruct usb_function *f}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjgubj)}(hhh]h)}(h usb functionh]h usb function}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhjghMhjgubah}(h]h ]h"]h$]h&]uh1jhjgubeh}(h]h ]h"]h$]h&]uh1jhjghMhjgubj)}(h1``struct usb_ep *_ep`` the endpoint to configure h](j)}(h``struct usb_ep *_ep``h]j)}(hjhh]hstruct usb_ep *_ep}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjgubj)}(hhh]h)}(hthe endpoint to configureh]hthe endpoint to configure}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhMhjhubah}(h]h ]h"]h$]h&]uh1jhjgubeh}(h]h ]h"]h$]h&]uh1jhjhhMhjgubeh}(h]h ]h"]h$]h&]uh1jhjngubh)}(h **Return**h]jP )}(hj@hh]hReturn}(hjBhhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj>hubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjngubh)}(herror code, 0 on successh]herror code, 0 on success}(hjVhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjngubh)}(h**Description**h]jP )}(hjghh]h Description}(hjihhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjehubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjngubh)}(hX@This function chooses the right descriptors for a given endpoint according to gadget speed and saves it in the endpoint desc field. If the endpoint already has a descriptor assigned to it - overwrites it with currently corresponding descriptor. The endpoint maxpacket field is updated according to the chosen descriptor.h]hX@This function chooses the right descriptors for a given endpoint according to gadget speed and saves it in the endpoint desc field. If the endpoint already has a descriptor assigned to it - overwrites it with currently corresponding descriptor. The endpoint maxpacket field is updated according to the chosen descriptor.}(hj}hhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjngubh)}(h**Note**h]jP )}(hjhh]hNote}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjhubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjngubh)}(hJthe supplied function should hold all the descriptors for supported speedsh]hJthe supplied function should hold all the descriptors for supported speeds}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjngubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_add_function (C function)c.usb_add_functionhNtauh1jhjDGhhhNhNubj)}(hhh](j)}(hVint usb_add_function (struct usb_configuration *config, struct usb_function *function)h]j)}(hUint usb_add_function(struct usb_configuration *config, struct usb_function *function)h](j)}(hinth]hint}(hjhhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjhhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM)ubj)}(h h]h }(hjhhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhhjhhM)ubj)}(husb_add_functionh]j)}(husb_add_functionh]husb_add_function}(hjhhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhubah}(h]h ](j j eh"]h$]h&]j j uh1jhjhhhhjhhM)ubjW)}(hA(struct usb_configuration *config, struct usb_function *function)h](j])}(h struct usb_configuration *configh](j)}(hjh]hstruct}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj iubj)}(h h]h }(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj iubh)}(hhh]j)}(husb_configurationh]husb_configuration}(hj.ihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+iubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj0imodnameN classnameNjj)}j]j)}jjhsbc.usb_add_functionasbuh1hhj iubj)}(h h]h }(hjNihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj iubj)}(hjh]h*}(hj\ihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj iubj)}(hconfigh]hconfig}(hjiihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj iubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjiubj])}(hstruct usb_function *functionh](j)}(hjh]hstruct}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~iubj)}(h h]h }(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~iubh)}(hhh]j)}(h usb_functionh]h usb_function}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjimodnameN classnameNjj)}j]jJic.usb_add_functionasbuh1hhj~iubj)}(h h]h }(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~iubj)}(hjh]h*}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~iubj)}(hfunctionh]hfunction}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~iubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjiubeh}(h]h ]h"]h$]h&]j j uh1jVhjhhhhjhhM)ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjhhhhjhhM)ubah}(h]jhah ](j j eh"]h$]h&]j j )j huh1jhjhhM)hjhhhubj )}(hhh]h)}(h!add a function to a configurationh]h!add a function to a configuration}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM)hjjhhubah}(h]h ]h"]h$]h&]uh1j hjhhhhjhhM)ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jjjA jjjB jC jD uh1jhhhjDGhNhNubjF )}(hX**Parameters** ``struct usb_configuration *config`` the configuration ``struct usb_function *function`` the function being added **Context** single threaded during gadget setup **Description** After initialization, each configuration must have one or more functions added to it. Adding a function involves calling its **bind\(\)** method to allocate resources such as interface and string identifiers and endpoints. This function returns the value of the function's bind(), which is zero for success else a negative errno value.h](h)}(h**Parameters**h]jP )}(hj%jh]h Parameters}(hj'jhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj#jubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM-hjjubj)}(hhh](j)}(h7``struct usb_configuration *config`` the configuration h](j)}(h$``struct usb_configuration *config``h]j)}(hjDjh]h struct usb_configuration *config}(hjFjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBjubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM*hj>jubj)}(hhh]h)}(hthe configurationh]hthe configuration}(hj]jhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYjhM*hjZjubah}(h]h ]h"]h$]h&]uh1jhj>jubeh}(h]h ]h"]h$]h&]uh1jhjYjhM*hj;jubj)}(h;``struct usb_function *function`` the function being added h](j)}(h!``struct usb_function *function``h]j)}(hj}jh]hstruct usb_function *function}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{jubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM+hjwjubj)}(hhh]h)}(hthe function being addedh]hthe function being added}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjjhM+hjjubah}(h]h ]h"]h$]h&]uh1jhjwjubeh}(h]h ]h"]h$]h&]uh1jhjjhM+hj;jubeh}(h]h ]h"]h$]h&]uh1jhjjubh)}(h **Context**h]jP )}(hjjh]hContext}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjjubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM-hjjubh)}(h#single threaded during gadget setuph]h#single threaded during gadget setup}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM,hjjubh)}(h**Description**h]jP )}(hjjh]h Description}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjjubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM.hjjubh)}(hAfter initialization, each configuration must have one or more functions added to it. Adding a function involves calling its **bind\(\)** method to allocate resources such as interface and string identifiers and endpoints.h](h~After initialization, each configuration must have one or more functions added to it. Adding a function involves calling its }(hjjhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjjubhU method to allocate resources such as interface and string identifiers and endpoints.}(hjjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM-hjjubh)}(hpThis function returns the value of the function's bind(), which is zero for success else a negative errno value.h]hrThis function returns the value of the function’s bind(), which is zero for success else a negative errno value.}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM2hjjubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$usb_function_deactivate (C function)c.usb_function_deactivatehNtauh1jhjDGhhhNhNubj)}(hhh](j)}(h;int usb_function_deactivate (struct usb_function *function)h]j)}(h:int usb_function_deactivate(struct usb_function *function)h](j)}(hinth]hint}(hjEkhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjAkhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM{ubj)}(h h]h }(hjTkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjAkhhhjSkhM{ubj)}(husb_function_deactivateh]j)}(husb_function_deactivateh]husb_function_deactivate}(hjfkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbkubah}(h]h ](j j eh"]h$]h&]j j uh1jhjAkhhhjSkhM{ubjW)}(h(struct usb_function *function)h]j])}(hstruct usb_function *functionh](j)}(hjh]hstruct}(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~kubj)}(h h]h }(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~kubh)}(hhh]j)}(h usb_functionh]h usb_function}(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjkmodnameN classnameNjj)}j]j)}jjhksbc.usb_function_deactivateasbuh1hhj~kubj)}(h h]h }(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~kubj)}(hjh]h*}(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~kubj)}(hfunctionh]hfunction}(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~kubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjzkubah}(h]h ]h"]h$]h&]j j uh1jVhjAkhhhjSkhM{ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj=khhhjSkhM{ubah}(h]j8kah ](j j eh"]h$]h&]j j )j huh1jhjSkhM{hj:khhubj )}(hhh]h)}(h'prevent function and gadget enumerationh]h'prevent function and gadget enumeration}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM{hjlhhubah}(h]h ]h"]h$]h&]uh1j hj:khhhjSkhM{ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jljA jljB jC jD uh1jhhhjDGhNhNubjF )}(hX**Parameters** ``struct usb_function *function`` the function that isn't yet ready to respond **Description** Blocks response of the gadget driver to host enumeration by preventing the data line pullup from being activated. This is normally called during **bind\(\)** processing to change from the initial "ready to respond" state, or when a required resource becomes available. For example, drivers that serve as a passthrough to a userspace daemon can block enumeration unless that daemon (such as an OBEX, MTP, or print server) is ready to handle host requests. Not all systems support software control of their USB peripheral data pullups. Returns zero on success, else negative errno.h](h)}(h**Parameters**h]jP )}(hj'lh]h Parameters}(hj)lhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj%lubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj!lubj)}(hhh]j)}(hO``struct usb_function *function`` the function that isn't yet ready to respond h](j)}(h!``struct usb_function *function``h]j)}(hjFlh]hstruct usb_function *function}(hjHlhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDlubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM|hj@lubj)}(hhh]h)}(h,the function that isn't yet ready to respondh]h.the function that isn’t yet ready to respond}(hj_lhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[lhM|hj\lubah}(h]h ]h"]h$]h&]uh1jhj@lubeh}(h]h ]h"]h$]h&]uh1jhj[lhM|hj=lubah}(h]h ]h"]h$]h&]uh1jhj!lubh)}(h**Description**h]jP )}(hjlh]h Description}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjlubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM~hj!lubh)}(hX Blocks response of the gadget driver to host enumeration by preventing the data line pullup from being activated. This is normally called during **bind\(\)** processing to change from the initial "ready to respond" state, or when a required resource becomes available.h](hBlocks response of the gadget driver to host enumeration by preventing the data line pullup from being activated. This is normally called during }(hjlhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjlubhs processing to change from the initial “ready to respond” state, or when a required resource becomes available.}(hjlhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM}hj!lubh)}(hFor example, drivers that serve as a passthrough to a userspace daemon can block enumeration unless that daemon (such as an OBEX, MTP, or print server) is ready to handle host requests.h]hFor example, drivers that serve as a passthrough to a userspace daemon can block enumeration unless that daemon (such as an OBEX, MTP, or print server) is ready to handle host requests.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj!lubh)}(hNNot all systems support software control of their USB peripheral data pullups.h]hNNot all systems support software control of their USB peripheral data pullups.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj!lubh)}(h-Returns zero on success, else negative errno.h]h-Returns zero on success, else negative errno.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj!lubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"usb_function_activate (C function)c.usb_function_activatehNtauh1jhjDGhhhNhNubj)}(hhh](j)}(h9int usb_function_activate (struct usb_function *function)h]j)}(h8int usb_function_activate(struct usb_function *function)h](j)}(hinth]hint}(hjmhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjmhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMubj)}(h h]h }(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjmhhhjmhMubj)}(husb_function_activateh]j)}(husb_function_activateh]husb_function_activate}(hj&mhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"mubah}(h]h ](j j eh"]h$]h&]j j uh1jhjmhhhjmhMubjW)}(h(struct usb_function *function)h]j])}(hstruct usb_function *functionh](j)}(hjh]hstruct}(hjBmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>mubj)}(h h]h }(hjOmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>mubh)}(hhh]j)}(h usb_functionh]h usb_function}(hj`mhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]mubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjbmmodnameN classnameNjj)}j]j)}jj(msbc.usb_function_activateasbuh1hhj>mubj)}(h h]h }(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>mubj)}(hjh]h*}(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>mubj)}(hfunctionh]hfunction}(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>mubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj:mubah}(h]h ]h"]h$]h&]j j uh1jVhjmhhhjmhMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjlhhhjmhMubah}(h]jlah ](j j eh"]h$]h&]j j )j huh1jhjmhMhjlhhubj )}(hhh]h)}(h%allow function and gadget enumerationh]h%allow function and gadget enumeration}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjmhhubah}(h]h ]h"]h$]h&]uh1j hjlhhhjmhMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jmjA jmjB jC jD uh1jhhhjDGhNhNubjF )}(hXK**Parameters** ``struct usb_function *function`` function on which usb_function_activate() was called **Description** Reverses effect of usb_function_deactivate(). If no more functions are delaying their activation, the gadget driver will respond to host enumeration procedures. Returns zero on success, else negative errno.h](h)}(h**Parameters**h]jP )}(hjmh]h Parameters}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjmubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjmubj)}(hhh]j)}(hW``struct usb_function *function`` function on which usb_function_activate() was called h](j)}(h!``struct usb_function *function``h]j)}(hjnh]hstruct usb_function *function}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjnubj)}(hhh]h)}(h4function on which usb_function_activate() was calledh]h4function on which usb_function_activate() was called}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjnhMhjnubah}(h]h ]h"]h$]h&]uh1jhjnubeh}(h]h ]h"]h$]h&]uh1jhjnhMhjmubah}(h]h ]h"]h$]h&]uh1jhjmubh)}(h**Description**h]jP )}(hjAnh]h Description}(hjCnhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj?nubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjmubh)}(hReverses effect of usb_function_deactivate(). If no more functions are delaying their activation, the gadget driver will respond to host enumeration procedures.h]hReverses effect of usb_function_deactivate(). If no more functions are delaying their activation, the gadget driver will respond to host enumeration procedures.}(hjWnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjmubh)}(h-Returns zero on success, else negative errno.h]h-Returns zero on success, else negative errno.}(hjfnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjmubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_interface_id (C function)c.usb_interface_idhNtauh1jhjDGhhhNhNubj)}(hhh](j)}(hVint usb_interface_id (struct usb_configuration *config, struct usb_function *function)h]j)}(hUint usb_interface_id(struct usb_configuration *config, struct usb_function *function)h](j)}(hinth]hint}(hjnhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjnhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMubj)}(h h]h }(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnhhhjnhMubj)}(husb_interface_idh]j)}(husb_interface_idh]husb_interface_id}(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubah}(h]h ](j j eh"]h$]h&]j j uh1jhjnhhhjnhMubjW)}(hA(struct usb_configuration *config, struct usb_function *function)h](j])}(h struct usb_configuration *configh](j)}(hjh]hstruct}(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubj)}(h h]h }(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubh)}(hhh]j)}(husb_configurationh]husb_configuration}(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjnmodnameN classnameNjj)}j]j)}jjnsbc.usb_interface_idasbuh1hhjnubj)}(h h]h }(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubj)}(hjh]h*}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubj)}(hconfigh]hconfig}(hj+ohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjnubj])}(hstruct usb_function *functionh](j)}(hjh]hstruct}(hjDohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@oubj)}(h h]h }(hjQohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@oubh)}(hhh]j)}(h usb_functionh]h usb_function}(hjbohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_oubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjdomodnameN classnameNjj)}j]j oc.usb_interface_idasbuh1hhj@oubj)}(h h]h }(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@oubj)}(hjh]h*}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@oubj)}(hfunctionh]hfunction}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@oubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjnubeh}(h]h ]h"]h$]h&]j j uh1jVhjnhhhjnhMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjnhhhjnhMubah}(h]jnah ](j j eh"]h$]h&]j j )j huh1jhjnhMhjnhhubj )}(hhh]h)}(hallocate an unused interface IDh]hallocate an unused interface ID}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjohhubah}(h]h ]h"]h$]h&]uh1j hjnhhhjnhMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jojA jojB jC jD uh1jhhhjDGhNhNubjF )}(hX_**Parameters** ``struct usb_configuration *config`` configuration associated with the interface ``struct usb_function *function`` function handling the interface **Context** single threaded during gadget setup **Description** usb_interface_id() is called from usb_function.bind() callbacks to allocate new interface IDs. The function driver will then store that ID in interface, association, CDC union, and other descriptors. It will also handle any control requests targeted at that interface, particularly changing its altsetting via set_alt(). There may also be class-specific or vendor-specific requests to handle. All interface identifier should be allocated using this routine, to ensure that for example different functions don't wrongly assign different meanings to the same identifier. Note that since interface identifiers are configuration-specific, functions used in more than one configuration (or more than once in a given configuration) need multiple versions of the relevant descriptors. Returns the interface ID which was allocated; or -ENODEV if no more interface IDs can be allocated.h](h)}(h**Parameters**h]jP )}(hjoh]h Parameters}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjoubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjoubj)}(hhh](j)}(hQ``struct usb_configuration *config`` configuration associated with the interface h](j)}(h$``struct usb_configuration *config``h]j)}(hjph]h struct usb_configuration *config}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjpubj)}(hhh]h)}(h+configuration associated with the interfaceh]h+configuration associated with the interface}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhjphMhjpubah}(h]h ]h"]h$]h&]uh1jhjpubeh}(h]h ]h"]h$]h&]uh1jhjphMhjoubj)}(hB``struct usb_function *function`` function handling the interface h](j)}(h!``struct usb_function *function``h]j)}(hj?ph]hstruct usb_function *function}(hjAphhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=pubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj9pubj)}(hhh]h)}(hfunction handling the interfaceh]hfunction handling the interface}(hjXphhhNhNubah}(h]h ]h"]h$]h&]uh1hhjTphMhjUpubah}(h]h ]h"]h$]h&]uh1jhj9pubeh}(h]h ]h"]h$]h&]uh1jhjTphMhjoubeh}(h]h ]h"]h$]h&]uh1jhjoubh)}(h **Context**h]jP )}(hjzph]hContext}(hj|phhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjxpubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjoubh)}(h#single threaded during gadget setuph]h#single threaded during gadget setup}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjoubh)}(h**Description**h]jP )}(hjph]h Description}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjpubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjoubh)}(hXusb_interface_id() is called from usb_function.bind() callbacks to allocate new interface IDs. The function driver will then store that ID in interface, association, CDC union, and other descriptors. It will also handle any control requests targeted at that interface, particularly changing its altsetting via set_alt(). There may also be class-specific or vendor-specific requests to handle.h]hXusb_interface_id() is called from usb_function.bind() callbacks to allocate new interface IDs. The function driver will then store that ID in interface, association, CDC union, and other descriptors. It will also handle any control requests targeted at that interface, particularly changing its altsetting via set_alt(). There may also be class-specific or vendor-specific requests to handle.}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjoubh)}(hXAll interface identifier should be allocated using this routine, to ensure that for example different functions don't wrongly assign different meanings to the same identifier. Note that since interface identifiers are configuration-specific, functions used in more than one configuration (or more than once in a given configuration) need multiple versions of the relevant descriptors.h]hXAll interface identifier should be allocated using this routine, to ensure that for example different functions don’t wrongly assign different meanings to the same identifier. Note that since interface identifiers are configuration-specific, functions used in more than one configuration (or more than once in a given configuration) need multiple versions of the relevant descriptors.}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjoubh)}(hcReturns the interface ID which was allocated; or -ENODEV if no more interface IDs can be allocated.h]hcReturns the interface ID which was allocated; or -ENODEV if no more interface IDs can be allocated.}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjoubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_func_wakeup (C function)c.usb_func_wakeuphNtauh1jhjDGhhhNhNubj)}(hhh](j)}(h/int usb_func_wakeup (struct usb_function *func)h]j)}(h.int usb_func_wakeup(struct usb_function *func)h](j)}(hinth]hint}(hjqhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjqhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMubj)}(h h]h }(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjqhhhjqhMubj)}(husb_func_wakeuph]j)}(husb_func_wakeuph]husb_func_wakeup}(hj%qhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!qubah}(h]h ](j j eh"]h$]h&]j j uh1jhjqhhhjqhMubjW)}(h(struct usb_function *func)h]j])}(hstruct usb_function *funch](j)}(hjh]hstruct}(hjAqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=qubj)}(h h]h }(hjNqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=qubh)}(hhh]j)}(h usb_functionh]h usb_function}(hj_qhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\qubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjaqmodnameN classnameNjj)}j]j)}jj'qsbc.usb_func_wakeupasbuph1hhj=qubj)}(h h]h }(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=qubj)}(hjh]h*}(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=qubj)}(hfunch]hfunc}(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=qubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj9qubah}(h]h ]h"]h$]h&]j j uh1jVhjqhhhjqhMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjphhhjqhMubah}(h]jpah ](j j eh"]h$]h&]j j )j huh1jhjqhMhjphhubj )}(hhh]h)}(h-sends function wake notification to the host.h]h-sends function wake notification to the host.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjqhhubah}(h]h ]h"]h$]h&]uh1j hjphhhjqhMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jqjA jqjB jC jD uh1jhhhjDGhNhNubjF )}(hX}**Parameters** ``struct usb_function *func`` function that sends the remote wakeup notification. **Description** Applicable to devices operating at enhanced superspeed when usb functions are put in function suspend state and armed for function remote wakeup. On completion, function wake notification is sent. If the device is in low power state it tries to bring the device to active state before sending the wake notification. Since it is a synchronous call, caller must take care of not calling it in interrupt context. For devices operating at lower speeds returns negative errno. Returns zero on success, else negative errno.h](h)}(h**Parameters**h]jP )}(hjqh]h Parameters}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjqubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjqubj)}(hhh]j)}(hR``struct usb_function *func`` function that sends the remote wakeup notification. h](j)}(h``struct usb_function *func``h]j)}(hjrh]hstruct usb_function *func}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjqubj)}(hhh]h)}(h3function that sends the remote wakeup notification.h]h3function that sends the remote wakeup notification.}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjrhMhjrubah}(h]h ]h"]h$]h&]uh1jhjqubeh}(h]h ]h"]h$]h&]uh1jhjrhMhjqubah}(h]h ]h"]h$]h&]uh1jhjqubh)}(h**Description**h]jP )}(hj@rh]h Description}(hjBrhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj>rubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjqubh)}(hXApplicable to devices operating at enhanced superspeed when usb functions are put in function suspend state and armed for function remote wakeup. On completion, function wake notification is sent. If the device is in low power state it tries to bring the device to active state before sending the wake notification. Since it is a synchronous call, caller must take care of not calling it in interrupt context. For devices operating at lower speeds returns negative errno.h]hXApplicable to devices operating at enhanced superspeed when usb functions are put in function suspend state and armed for function remote wakeup. On completion, function wake notification is sent. If the device is in low power state it tries to bring the device to active state before sending the wake notification. Since it is a synchronous call, caller must take care of not calling it in interrupt context. For devices operating at lower speeds returns negative errno.}(hjVrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjqubh)}(h-Returns zero on success, else negative errno.h]h-Returns zero on success, else negative errno.}(hjerhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjqubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_add_config (C function)c.usb_add_confighNtauh1jhjDGhhhNhNubj)}(hhh](j)}(h~int usb_add_config (struct usb_composite_dev *cdev, struct usb_configuration *config, int (*bind)(struct usb_configuration *))h]j)}(h|int usb_add_config(struct usb_composite_dev *cdev, struct usb_configuration *config, int (*bind)(struct usb_configuration*))h](j)}(hinth]hint}(hjrhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjrhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMCubj)}(h h]h }(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrhhhjrhMCubj)}(husb_add_configh]j)}(husb_add_configh]husb_add_config}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubah}(h]h ](j j eh"]h$]h&]j j uh1jhjrhhhjrhMCubjW)}(hj(struct usb_composite_dev *cdev, struct usb_configuration *config, int (*bind)(struct usb_configuration*))h](j])}(hstruct usb_composite_dev *cdevh](j)}(hjh]hstruct}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubj)}(h h]h }(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubh)}(hhh]j)}(husb_composite_devh]husb_composite_dev}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjrmodnameN classnameNjj)}j]j)}jjrsbc.usb_add_configasbuh1hhjrubj)}(h h]h }(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubj)}(hjh]h*}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubj)}(hcdevh]hcdev}(hj*shhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjrubj])}(h struct usb_configuration *configh](j)}(hjh]hstruct}(hjCshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?subj)}(h h]h }(hjPshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?subh)}(hhh]j)}(husb_configurationh]husb_configuration}(hjashhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^subah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjcsmodnameN classnameNjj)}j]j sc.usb_add_configasbuh1hhj?subj)}(h h]h }(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?subj)}(hjh]h*}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?subj)}(hconfigh]hconfig}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?subeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjrubj])}(h&int (*bind)(struct usb_configuration*)h](j)}(hinth]hint}(hjshhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjsubj)}(h h]h }(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubj)}(h(h]h(}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubj)}(hjh]h*}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubj)}(hbindh]hbind}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubj)}(h)h]h)}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubj)}(hjsh]h(}(hjthhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubj)}(hjh]hstruct}(hjthhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubj)}(h h]h }(hj thhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubh)}(hhh]j)}(husb_configurationh]husb_configuration}(hj1thhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.tubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj3tmodnameN classnameNjj)}j]j sc.usb_add_configasbuh1hhjsubj)}(hjh]h*}(hjOthhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubj)}(hjsh]h)}(hj\thhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjrubeh}(h]h ]h"]h$]h&]j j uh1jVhjrhhhjrhMCubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjrhhhjrhMCubah}(h]jrah ](j j eh"]h$]h&]j j )j huh1jhjrhMChjrhhubj )}(hhh]h)}(h add a configuration to a device.h]h add a configuration to a device.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMChjthhubah}(h]h ]h"]h$]h&]uh1j hjrhhhjrhMCubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jtjA jtjB jC jD uh1jhhhjDGhNhNubjF )}(hX**Parameters** ``struct usb_composite_dev *cdev`` wraps the USB gadget ``struct usb_configuration *config`` the configuration, with bConfigurationValue assigned ``int (*bind)(struct usb_configuration *)`` the configuration's bind function **Context** single threaded during gadget setup **Description** One of the main tasks of a composite **bind\(\)** routine is to add each of the configurations it supports, using this routine. This function returns the value of the configuration's **bind\(\)**, which is zero for success else a negative errno value. Binding configurations assigns global resources including string IDs, and per-configuration resources such as interface IDs and endpoints.h](h)}(h**Parameters**h]jP )}(hjth]h Parameters}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjtubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMGhjtubj)}(hhh](j)}(h8``struct usb_composite_dev *cdev`` wraps the USB gadget h](j)}(h"``struct usb_composite_dev *cdev``h]j)}(hjth]hstruct usb_composite_dev *cdev}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMDhjtubj)}(hhh]h)}(hwraps the USB gadgeth]hwraps the USB gadget}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhjthMDhjtubah}(h]h ]h"]h$]h&]uh1jhjtubeh}(h]h ]h"]h$]h&]uh1jhjthMDhjtubj)}(hZ``struct usb_configuration *config`` the configuration, with bConfigurationValue assigned h](j)}(h$``struct usb_configuration *config``h]j)}(hjth]h struct usb_configuration *config}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMEhjtubj)}(hhh]h)}(h4the configuration, with bConfigurationValue assignedh]h4the configuration, with bConfigurationValue assigned}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjuhMEhjuubah}(h]h ]h"]h$]h&]uh1jhjtubeh}(h]h ]h"]h$]h&]uh1jhjuhMEhjtubj)}(hN``int (*bind)(struct usb_configuration *)`` the configuration's bind function h](j)}(h+``int (*bind)(struct usb_configuration *)``h]j)}(hj8uh]h'int (*bind)(struct usb_configuration *)}(hj:uhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6uubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMFhj2uubj)}(hhh]h)}(h!the configuration's bind functionh]h#the configuration’s bind function}(hjQuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjMuhMFhjNuubah}(h]h ]h"]h$]h&]uh1jhj2uubeh}(h]h ]h"]h$]h&]uh1jhjMuhMFhjtubeh}(h]h ]h"]h$]h&]uh1jhjtubh)}(h **Context**h]jP )}(hjsuh]hContext}(hjuuhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjquubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMHhjtubh)}(h#single threaded during gadget setuph]h#single threaded during gadget setup}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMGhjtubh)}(h**Description**h]jP )}(hjuh]h Description}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjuubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMIhjtubh)}(hOne of the main tasks of a composite **bind\(\)** routine is to add each of the configurations it supports, using this routine.h](h%One of the main tasks of a composite }(hjuhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjuubhN routine is to add each of the configurations it supports, using this routine.}(hjuhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMHhjtubh)}(hXThis function returns the value of the configuration's **bind\(\)**, which is zero for success else a negative errno value. Binding configurations assigns global resources including string IDs, and per-configuration resources such as interface IDs and endpoints.h](h9This function returns the value of the configuration’s }(hjuhhhNhNubjP )}(h **bind\(\)**h]hbind()}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjuubh, which is zero for success else a negative errno value. Binding configurations assigns global resources including string IDs, and per-configuration resources such as interface IDs and endpoints.}(hjuhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMKhjtubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_string_id (C function)c.usb_string_idhNtauh1jhjDGhhhNhNubj)}(hhh](j)}(h2int usb_string_id (struct usb_composite_dev *cdev)h]j)}(h1int usb_string_id(struct usb_composite_dev *cdev)h](j)}(hinth]hint}(hjvhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjvhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMCubj)}(h h]h }(hj!vhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvhhhj vhMCubj)}(h usb_string_idh]j)}(h usb_string_idh]h usb_string_id}(hj3vhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/vubah}(h]h ](j j eh"]h$]h&]j j uh1jhjvhhhj vhMCubjW)}(h (struct usb_composite_dev *cdev)h]j])}(hstruct usb_composite_dev *cdevh](j)}(hjh]hstruct}(hjOvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjKvubj)}(h h]h }(hj\vhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjKvubh)}(hhh]j)}(husb_composite_devh]husb_composite_dev}(hjmvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjjvubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjovmodnameN classnameNjj)}j]j)}jj5vsbc.usb_string_idasbuh1hhjKvubj)}(h h]h }(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjKvubj)}(hjh]h*}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjKvubj)}(hcdevh]hcdev}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjKvubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjGvubah}(h]h ]h"]h$]h&]j j uh1jVhjvhhhj vhMCubeh}(h]h ]h"]h$]h&]j j j uh1jj j hj vhhhj vhMCubah}(h]jvah ](j j eh"]h$]h&]j j )j huh1jhj vhMChjvhhubj )}(hhh]h)}(hallocate an unused string IDh]hallocate an unused string ID}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMChjvhhubah}(h]h ]h"]h$]h&]uh1j hjvhhhj vhMCubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jvjA jvjB jC jD uh1jhhhjDGhNhNubjF )}(hXc**Parameters** ``struct usb_composite_dev *cdev`` the device whose string descriptor IDs are being allocated **Context** single threaded during gadget setup **Description** **usb_string_id\(\)** is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then store that ID in the appropriate descriptors and string table. All string identifier should be allocated using this, **usb_string_ids_tab\(\)** or **usb_string_ids_n\(\)** routine, to ensure that for example different functions don't wrongly assign different meanings to the same identifier.h](h)}(h**Parameters**h]jP )}(hjvh]h Parameters}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjvubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMGhjvubj)}(hhh]j)}(h^``struct usb_composite_dev *cdev`` the device whose string descriptor IDs are being allocated h](j)}(h"``struct usb_composite_dev *cdev``h]j)}(hjwh]hstruct usb_composite_dev *cdev}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMDhj wubj)}(hhh]h)}(h:the device whose string descriptor IDs are being allocatedh]h:the device whose string descriptor IDs are being allocated}(hj,whhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(whMDhj)wubah}(h]h ]h"]h$]h&]uh1jhj wubeh}(h]h ]h"]h$]h&]uh1jhj(whMDhj wubah}(h]h ]h"]h$]h&]uh1jhjvubh)}(h **Context**h]jP )}(hjNwh]hContext}(hjPwhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjLwubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMFhjvubh)}(h#single threaded during gadget setuph]h#single threaded during gadget setup}(hjdwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMEhjvubh)}(h**Description**h]jP )}(hjuwh]h Description}(hjwwhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjswubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMGhjvubh)}(h**usb_string_id\(\)** is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then store that ID in the appropriate descriptors and string table.h](jP )}(h**usb_string_id\(\)**h]husb_string_id()}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjwubh is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then store that ID in the appropriate descriptors and string table.}(hjwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMFhjvubh)}(hAll string identifier should be allocated using this, **usb_string_ids_tab\(\)** or **usb_string_ids_n\(\)** routine, to ensure that for example different functions don't wrongly assign different meanings to the same identifier.h](h6All string identifier should be allocated using this, }(hjwhhhNhNubjP )}(h**usb_string_ids_tab\(\)**h]husb_string_ids_tab()}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjwubh or }(hjwhhhNhNubjP )}(h**usb_string_ids_n\(\)**h]husb_string_ids_n()}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjwubhz routine, to ensure that for example different functions don’t wrongly assign different meanings to the same identifier.}(hjwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMJhjvubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_string_ids_tab (C function)c.usb_string_ids_tabhNtauh1jhjDGhhhNhNubj)}(hhh](j)}(hOint usb_string_ids_tab (struct usb_composite_dev *cdev, struct usb_string *str)h]j)}(hNint usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str)h](j)}(hinth]hint}(hjwhhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjwhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM^ubj)}(h h]h }(hj xhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjwhhhj xhM^ubj)}(husb_string_ids_tabh]j)}(husb_string_ids_tabh]husb_string_ids_tab}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubah}(h]h ](j j eh"]h$]h&]j j uh1jhjwhhhj xhM^ubjW)}(h8(struct usb_composite_dev *cdev, struct usb_string *str)h](j])}(hstruct usb_composite_dev *cdevh](j)}(hjh]hstruct}(hj8xhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4xubj)}(h h]h }(hjExhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4xubh)}(hhh]j)}(husb_composite_devh]husb_composite_dev}(hjVxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjSxubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjXxmodnameN classnameNjj)}j]j)}jjxsbc.usb_string_ids_tabasbuh1hhj4xubj)}(h h]h }(hjvxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4xubj)}(hjh]h*}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4xubj)}(hcdevh]hcdev}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4xubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj0xubj])}(hstruct usb_string *strh](j)}(hjh]hstruct}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubj)}(h h]h }(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubh)}(hhh]j)}(h usb_stringh]h usb_string}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjxmodnameN classnameNjj)}j]jrxc.usb_string_ids_tabasbuh1hhjxubj)}(h h]h }(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubj)}(hjh]h*}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubj)}(hstrh]hstr}(hjyhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj0xubeh}(h]h ]h"]h$]h&]j j uh1jVhjwhhhj xhM^ubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjwhhhj xhM^ubah}(h]jwah ](j j eh"]h$]h&]j j )j huh1jhj xhM^hjwhhubj )}(hhh]h)}(h#allocate unused string IDs in batchh]h#allocate unused string IDs in batch}(hj+yhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM^hj(yhhubah}(h]h ]h"]h$]h&]uh1j hjwhhhj xhM^ubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jCyjA jCyjB jC jD uh1jhhhjDGhNhNubjF )}(hX**Parameters** ``struct usb_composite_dev *cdev`` the device whose string descriptor IDs are being allocated ``struct usb_string *str`` an array of usb_string objects to assign numbers to **Context** single threaded during gadget setup **Description** **usb_string_ids\(\)** is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then copy IDs from the string table to the appropriate descriptors and string table for other languages. All string identifier should be allocated using this, **usb_string_id\(\)** or **usb_string_ids_n\(\)** routine, to ensure that for example different functions don't wrongly assign different meanings to the same identifier.h](h)}(h**Parameters**h]jP )}(hjMyh]h Parameters}(hjOyhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjKyubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMbhjGyubj)}(hhh](j)}(h^``struct usb_composite_dev *cdev`` the device whose string descriptor IDs are being allocated h](j)}(h"``struct usb_composite_dev *cdev``h]j)}(hjlyh]hstruct usb_composite_dev *cdev}(hjnyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjjyubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM_hjfyubj)}(hhh]h)}(h:the device whose string descriptor IDs are being allocatedh]h:the device whose string descriptor IDs are being allocated}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhM_hjyubah}(h]h ]h"]h$]h&]uh1jhjfyubeh}(h]h ]h"]h$]h&]uh1jhjyhM_hjcyubj)}(hO``struct usb_string *str`` an array of usb_string objects to assign numbers to h](j)}(h``struct usb_string *str``h]j)}(hjyh]hstruct usb_string *str}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjyubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM`hjyubj)}(hhh]h)}(h3an array of usb_string objects to assign numbers toh]h3an array of usb_string objects to assign numbers to}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhM`hjyubah}(h]h ]h"]h$]h&]uh1jhjyubeh}(h]h ]h"]h$]h&]uh1jhjyhM`hjcyubeh}(h]h ]h"]h$]h&]uh1jhjGyubh)}(h **Context**h]jP )}(hjyh]hContext}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjyubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMbhjGyubh)}(h#single threaded during gadget setuph]h#single threaded during gadget setup}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMahjGyubh)}(h**Description**h]jP )}(hjzh]h Description}(hj zhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjzubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMchjGyubh)}(h**usb_string_ids\(\)** is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then copy IDs from the string table to the appropriate descriptors and string table for other languages.h](jP )}(h**usb_string_ids\(\)**h]husb_string_ids()}(hj!zhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjzubh is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then copy IDs from the string table to the appropriate descriptors and string table for other languages.}(hjzhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMbhjGyubh)}(hAll string identifier should be allocated using this, **usb_string_id\(\)** or **usb_string_ids_n\(\)** routine, to ensure that for example different functions don't wrongly assign different meanings to the same identifier.h](h6All string identifier should be allocated using this, }(hj:zhhhNhNubjP )}(h**usb_string_id\(\)**h]husb_string_id()}(hjBzhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj:zubh or }(hj:zhhhNhNubjP )}(h**usb_string_ids_n\(\)**h]husb_string_ids_n()}(hjTzhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj:zubhz routine, to ensure that for example different functions don’t wrongly assign different meanings to the same identifier.}(hj:zhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMghjGyubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j usb_gstrings_attach (C function)c.usb_gstrings_attachhNtauh1jhjDGhhhNhNubj)}(hhh](j)}(h|struct usb_string * usb_gstrings_attach (struct usb_composite_dev *cdev, struct usb_gadget_strings **sp, unsigned n_strings)h]j)}(hzstruct usb_string *usb_gstrings_attach(struct usb_composite_dev *cdev, struct usb_gadget_strings **sp, unsigned n_strings)h](j)}(hjh]hstruct}(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzhhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMubj)}(h h]h }(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzhhhjzhMubh)}(hhh]j)}(h usb_stringh]h usb_string}(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjzmodnameN classnameNjj)}j]j)}jusb_gstrings_attachsbc.usb_gstrings_attachasbuh1hhjzhhhjzhMubj)}(h h]h }(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzhhhjzhMubj)}(hjh]h*}(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzhhhjzhMubj)}(husb_gstrings_attachh]j)}(hjzh]husb_gstrings_attach}(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzubah}(h]h ](j j eh"]h$]h&]j j uh1jhjzhhhjzhMubjW)}(hT(struct usb_composite_dev *cdev, struct usb_gadget_strings **sp, unsigned n_strings)h](j])}(hstruct usb_composite_dev *cdevh](j)}(hjh]hstruct}(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubj)}(h h]h }(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubh)}(hhh]j)}(husb_composite_devh]husb_composite_dev}(hj%{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"{ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj'{modnameN classnameNjj)}j]jzc.usb_gstrings_attachasbuh1hhj{ubj)}(h h]h }(hjC{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubj)}(hjh]h*}(hjQ{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubj)}(hcdevh]hcdev}(hj^{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjzubj])}(hstruct usb_gadget_strings **sph](j)}(hjh]hstruct}(hjw{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjs{ubj)}(h h]h }(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjs{ubh)}(hhh]j)}(husb_gadget_stringsh]husb_gadget_strings}(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj{modnameN classnameNjj)}j]jzc.usb_gstrings_attachasbuh1hhjs{ubj)}(h h]h }(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjs{ubj)}(hjh]h*}(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjs{ubj)}(hjh]h*}(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjs{ubj)}(hsph]hsp}(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjs{ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjzubj])}(hunsigned n_stringsh](j)}(hunsignedh]hunsigned}(hj{hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj{ubj)}(h h]h }(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubj)}(h n_stringsh]h n_strings}(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hjzubeh}(h]h ]h"]h$]h&]j j uh1jVhjzhhhjzhMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjzhhhjzhMubah}(h]jzah ](j j eh"]h$]h&]j j )j huh1jhjzhMhjzhhubj )}(hhh]h)}(h.attach gadget strings to a cdev and assign idsh]h.attach gadget strings to a cdev and assign ids}(hj:|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj7|hhubah}(h]h ]h"]h$]h&]uh1j hjzhhhjzhMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jR|jA jR|jB jC jD uh1jhhhjDGhNhNubjF )}(hX**Parameters** ``struct usb_composite_dev *cdev`` the device whose string descriptor IDs are being allocated and attached. ``struct usb_gadget_strings **sp`` an array of usb_gadget_strings to attach. ``unsigned n_strings`` number of entries in each usb_strings array (sp[]->strings) **Description** This function will create a deep copy of usb_gadget_strings and usb_string and attach it to the cdev. The actual string (usb_string.s) will not be copied but only a referenced will be made. The struct usb_gadget_strings array may contain multiple languages and should be NULL terminated. The ->language pointer of each struct usb_gadget_strings has to contain the same amount of entries. For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first usb_string entry of es-ES contains the translation of the first usb_string entry of en-US. Therefore both entries become the same id assign.h](h)}(h**Parameters**h]jP )}(hj\|h]h Parameters}(hj^|hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjZ|ubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjV|ubj)}(hhh](j)}(hl``struct usb_composite_dev *cdev`` the device whose string descriptor IDs are being allocated and attached. h](j)}(h"``struct usb_composite_dev *cdev``h]j)}(hj{|h]hstruct usb_composite_dev *cdev}(hj}|hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjy|ubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhju|ubj)}(hhh]h)}(hHthe device whose string descriptor IDs are being allocated and attached.h]hHthe device whose string descriptor IDs are being allocated and attached.}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj|ubah}(h]h ]h"]h$]h&]uh1jhju|ubeh}(h]h ]h"]h$]h&]uh1jhj|hMhjr|ubj)}(hM``struct usb_gadget_strings **sp`` an array of usb_gadget_strings to attach. h](j)}(h"``struct usb_gadget_strings **sp``h]j)}(hj|h]hstruct usb_gadget_strings **sp}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj|ubj)}(hhh]h)}(h)an array of usb_gadget_strings to attach.h]h)an array of usb_gadget_strings to attach.}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj|hMhj|ubah}(h]h ]h"]h$]h&]uh1jhj|ubeh}(h]h ]h"]h$]h&]uh1jhj|hMhjr|ubj)}(hS``unsigned n_strings`` number of entries in each usb_strings array (sp[]->strings) h](j)}(h``unsigned n_strings``h]j)}(hj|h]hunsigned n_strings}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj|ubj)}(hhh]h)}(h;number of entries in each usb_strings array (sp[]->strings)h]h;number of entries in each usb_strings array (sp[]->strings)}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj}hMhj}ubah}(h]h ]h"]h$]h&]uh1jhj|ubeh}(h]h ]h"]h$]h&]uh1jhj}hMhjr|ubeh}(h]h ]h"]h$]h&]uh1jhjV|ubh)}(h**Description**h]jP )}(hj)}h]h Description}(hj+}hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj'}ubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjV|ubh)}(hX\This function will create a deep copy of usb_gadget_strings and usb_string and attach it to the cdev. The actual string (usb_string.s) will not be copied but only a referenced will be made. The struct usb_gadget_strings array may contain multiple languages and should be NULL terminated. The ->language pointer of each struct usb_gadget_strings has to contain the same amount of entries. For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first usb_string entry of es-ES contains the translation of the first usb_string entry of en-US. Therefore both entries become the same id assign.h]hX\This function will create a deep copy of usb_gadget_strings and usb_string and attach it to the cdev. The actual string (usb_string.s) will not be copied but only a referenced will be made. The struct usb_gadget_strings array may contain multiple languages and should be NULL terminated. The ->language pointer of each struct usb_gadget_strings has to contain the same amount of entries. For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first usb_string entry of es-ES contains the translation of the first usb_string entry of en-US. Therefore both entries become the same id assign.}(hj?}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhjV|ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_string_ids_n (C function)c.usb_string_ids_nhNtauh1jhjDGhhhNhNubj)}(hhh](j)}(h>int usb_string_ids_n (struct usb_composite_dev *c, unsigned n)h]j)}(h=int usb_string_ids_n(struct usb_composite_dev *c, unsigned n)h](j)}(hinth]hint}(hjn}hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhjj}hhhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMubj)}(h h]h }(hj}}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjj}hhhj|}hMubj)}(husb_string_ids_nh]j)}(husb_string_ids_nh]husb_string_ids_n}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubah}(h]h ](j j eh"]h$]h&]j j uh1jhjj}hhhj|}hMubjW)}(h)(struct usb_composite_dev *c, unsigned n)h](j])}(hstruct usb_composite_dev *ch](j)}(hjh]hstruct}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubj)}(h h]h }(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubh)}(hhh]j)}(husb_composite_devh]husb_composite_dev}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj}modnameN classnameNjj)}j]j)}jj}sbc.usb_string_ids_nasbuh1hhj}ubj)}(h h]h }(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubj)}(hjh]h*}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubj)}(hjh]hc}(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj}ubj])}(h unsigned nh](j)}(hunsignedh]hunsigned}(hj~hhhNhNubah}(h]h ]j+ah"]h$]h&]uh1jhj~ubj)}(h h]h }(hj*~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~ubj)}(hjh]hn}(hj8~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~ubeh}(h]h ]h"]h$]h&]noemphj j uh1j\hj}ubeh}(h]h ]h"]h$]h&]j j uh1jVhjj}hhhj|}hMubeh}(h]h ]h"]h$]h&]j j j uh1jj j hjf}hhhj|}hMubah}(h]ja}ah ](j j eh"]h$]h&]j j )j huh1jhj|}hMhjc}hhubj )}(hhh]h)}(h#allocate unused string IDs in batchh]h#allocate unused string IDs in batch}(hja~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj^~hhubah}(h]h ]h"]h$]h&]uh1j hjc}hhhj|}hMubeh}(h]h ](jfunctioneh"]h$]h&]j? jj@ jy~jA jy~jB jC jD uh1jhhhjDGhNhNubjF )}(hX_**Parameters** ``struct usb_composite_dev *c`` the device whose string descriptor IDs are being allocated ``unsigned n`` number of string IDs to allocate **Context** single threaded during gadget setup **Description** Returns the first requested ID. This ID and next **n**-1 IDs are now valid IDs. At least provided that **n** is non-zero because if it is, returns last requested ID which is now very useful information. **usb_string_ids_n\(\)** is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then store that ID in the appropriate descriptors and string table. All string identifier should be allocated using this, **usb_string_id\(\)** or **usb_string_ids_n\(\)** routine, to ensure that for example different functions don't wrongly assign different meanings to the same identifier.h](h)}(h**Parameters**h]jP )}(hj~h]h Parameters}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj~ubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj}~ubj)}(hhh](j)}(h[``struct usb_composite_dev *c`` the device whose string descriptor IDs are being allocated h](j)}(h``struct usb_composite_dev *c``h]j)}(hj~h]hstruct usb_composite_dev *c}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj~ubj)}(hhh]h)}(h:the device whose string descriptor IDs are being allocatedh]h:the device whose string descriptor IDs are being allocated}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~hMhj~ubah}(h]h ]h"]h$]h&]uh1jhj~ubeh}(h]h ]h"]h$]h&]uh1jhj~hMhj~ubj)}(h0``unsigned n`` number of string IDs to allocate h](j)}(h``unsigned n``h]j)}(hj~h]h unsigned n}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ubah}(h]h ]h"]h$]h&]uh1jhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj~ubj)}(hhh]h)}(h number of string IDs to allocateh]h number of string IDs to allocate}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~hMhj~ubah}(h]h ]h"]h$]h&]uh1jhj~ubeh}(h]h ]h"]h$]h&]uh1jhj~hMhj~ubeh}(h]h ]h"]h$]h&]uh1jhj}~ubh)}(h **Context**h]jP )}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj}~ubh)}(h#single threaded during gadget setuph]h#single threaded during gadget setup}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj}~ubh)}(h**Description**h]jP )}(hj=h]h Description}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hj;ubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj}~ubh)}(hReturns the first requested ID. This ID and next **n**-1 IDs are now valid IDs. At least provided that **n** is non-zero because if it is, returns last requested ID which is now very useful information.h](h2Returns the first requested ID. This ID and next }(hjShhhNhNubjP )}(h**n**h]hn}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjSubh2-1 IDs are now valid IDs. At least provided that }(hjShhhNhNubjP )}(h**n**h]hn}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjSubh^ is non-zero because if it is, returns last requested ID which is now very useful information.}(hjShhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj}~ubh)}(h**usb_string_ids_n\(\)** is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then store that ID in the appropriate descriptors and string table.h](jP )}(h**usb_string_ids_n\(\)**h]husb_string_ids_n()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjubh is called from bind() callbacks to allocate string IDs. Drivers for functions, configurations, or gadgets will then store that ID in the appropriate descriptors and string table.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj}~ubh)}(hAll string identifier should be allocated using this, **usb_string_id\(\)** or **usb_string_ids_n\(\)** routine, to ensure that for example different functions don't wrongly assign different meanings to the same identifier.h](h6All string identifier should be allocated using this, }(hjhhhNhNubjP )}(h**usb_string_id\(\)**h]husb_string_id()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjubh or }(hjhhhNhNubjP )}(h**usb_string_ids_n\(\)**h]husb_string_ids_n()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjubhz routine, to ensure that for example different functions don’t wrongly assign different meanings to the same identifier.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chMhj}~ubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j usb_composite_probe (C function)c.usb_composite_probehNtauh1jhjDGhhhNhNubj)}(hhh](j)}(h=int usb_composite_probe (struct usb_composite_driver *driver)h]j)}(hthe composite device who’s control transfer was kept waiting}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVhM hjWubah}(h]h ]h"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]uh1jhjVhM hj8ubah}(h]h ]h"]h$]h&]uh1jhjubh)}(h**Description**h]jP )}(hj|h]h Description}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jO hjzubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM hjubh)}(hXWThis function must be called by the USB function driver to continue with the control transfer's data/status stage in case it had requested to delay the data/status stages. A USB function's setup handler (e.g. set_alt()) can request the composite framework to delay the setup request's data/status stages by returning USB_GADGET_DELAYED_STATUS.h]hX]This function must be called by the USB function driver to continue with the control transfer’s data/status stage in case it had requested to delay the data/status stages. A USB function’s setup handler (e.g. set_alt()) can request the composite framework to delay the setup request’s data/status stages by returning USB_GADGET_DELAYED_STATUS.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhe/var/lib/git/docbuild/linux/Documentation/driver-api/usb/gadget:352: ./drivers/usb/gadget/composite.chM hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jE hjDGhhhNhNubeh}(h]composite-device-frameworkah ]h"]composite device frameworkah$]h&]uh1hhjhhhhhMNubh)}(hhh](h)}(hComposite Device Functionsh]hComposite Device Functions}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMdubh)}(hAt this writing, a few of the current gadget drivers have been converted to this framework. Near-term plans include converting all of them, except for ``gadgetfs``.h](hAt this writing, a few of the current gadget drivers have been converted to this framework. Near-term plans include converting all of them, except for }(hjhhhNhNubj)}(h ``gadgetfs``h]hgadgetfs}(hjɄhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMfhjhhubeh}(h]composite-device-functionsah ]h"]composite device functionsah$]h&]uh1hhjhhhhhMdubeh}(h]kernel-mode-gadget-apiah ]h"]kernel mode gadget apiah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hPeripheral Controller Driversh]hPeripheral Controller Drivers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMkubh)}(hX)The first hardware supporting this API was the NetChip 2280 controller, which supports USB 2.0 high speed and is based on PCI. This is the ``net2280`` driver module. The driver supports Linux kernel versions 2.4 and 2.6; contact NetChip Technologies for development boards and product information.h](hThe first hardware supporting this API was the NetChip 2280 controller, which supports USB 2.0 high speed and is based on PCI. This is the }(hjhhhNhNubj)}(h ``net2280``h]hnet2280}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh driver module. The driver supports Linux kernel versions 2.4 and 2.6; contact NetChip Technologies for development boards and product information.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMmhjhhubh)}(hXOther hardware working in the ``gadget`` framework includes: Intel's PXA 25x and IXP42x series processors (``pxa2xx_udc``), Toshiba TC86c001 "Goku-S" (``goku_udc``), Renesas SH7705/7727 (``sh_udc``), MediaQ 11xx (``mq11xx_udc``), Hynix HMS30C7202 (``h7202_udc``), National 9303/4 (``n9604_udc``), Texas Instruments OMAP (``omap_udc``), Sharp LH7A40x (``lh7a40x_udc``), and more. Most of those are full speed controllers.h](hOther hardware working in the }(hj"hhhNhNubj)}(h ``gadget``h]hgadget}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubhE framework includes: Intel’s PXA 25x and IXP42x series processors (}(hj"hhhNhNubj)}(h``pxa2xx_udc``h]h pxa2xx_udc}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh"), Toshiba TC86c001 “Goku-S” (}(hj"hhhNhNubj)}(h ``goku_udc``h]hgoku_udc}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh), Renesas SH7705/7727 (}(hj"hhhNhNubj)}(h ``sh_udc``h]hsh_udc}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh), MediaQ 11xx (}(hj"hhhNhNubj)}(h``mq11xx_udc``h]h mq11xx_udc}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh), Hynix HMS30C7202 (}(hj"hhhNhNubj)}(h ``h7202_udc``h]h h7202_udc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh), National 9303/4 (}(hj"hhhNhNubj)}(h ``n9604_udc``h]h n9604_udc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh), Texas Instruments OMAP (}(hj"hhhNhNubj)}(h ``omap_udc``h]homap_udc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh), Sharp LH7A40x (}(hj"hhhNhNubj)}(h``lh7a40x_udc``h]h lh7a40x_udc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh6), and more. Most of those are full speed controllers.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMshjhhubh)}(hAt this writing, there are people at work on drivers in this framework for several other USB device controllers, with plans to make many of them be widely available.h]hAt this writing, there are people at work on drivers in this framework for several other USB device controllers, with plans to make many of them be widely available.}(hj҅hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMzhjhhubh)}(hXA partial USB simulator, the ``dummy_hcd`` driver, is available. It can act like a net2280, a pxa25x, or an sa11x0 in terms of available endpoints and device speeds; and it simulates control, bulk, and to some extent interrupt transfers. That lets you develop some parts of a gadget driver on a normal PC, without any special hardware, and perhaps with the assistance of tools such as GDB running with User Mode Linux. At least one person has expressed interest in adapting that approach, hooking it up to a simulator for a microcontroller. Such simulators can help debug subsystems where the runtime hardware is unfriendly to software development, or is not yet available.h](hA partial USB simulator, the }(hjhhhNhNubj)}(h ``dummy_hcd``h]h dummy_hcd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhXw driver, is available. It can act like a net2280, a pxa25x, or an sa11x0 in terms of available endpoints and device speeds; and it simulates control, bulk, and to some extent interrupt transfers. That lets you develop some parts of a gadget driver on a normal PC, without any special hardware, and perhaps with the assistance of tools such as GDB running with User Mode Linux. At least one person has expressed interest in adapting that approach, hooking it up to a simulator for a microcontroller. Such simulators can help debug subsystems where the runtime hardware is unfriendly to software development, or is not yet available.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM~hjhhubh)}(hvSupport for other controllers is expected to be developed and contributed over time, as this driver framework evolves.h]hvSupport for other controllers is expected to be developed and contributed over time, as this driver framework evolves.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]peripheral-controller-driversah ]h"]peripheral controller driversah$]h&]uh1hhhhhhhhMkubh)}(hhh](h)}(hGadget Driversh]hGadget Drivers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hIn addition to *Gadget Zero* (used primarily for testing and development with drivers for usb controller hardware), other gadget drivers exist.h](hIn addition to }(hj'hhhNhNubj$)}(h *Gadget Zero*h]h Gadget Zero}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1j#hj'ubhs (used primarily for testing and development with drivers for usb controller hardware), other gadget drivers exist.}(hj'hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXThere's an ``ethernet`` gadget driver, which implements one of the most useful *Communications Device Class* (CDC) models. One of the standards for cable modem interoperability even specifies the use of this ethernet model as one of two mandatory options. Gadgets using this code look to a USB host as if they're an Ethernet adapter. It provides access to a network where the gadget's CPU is one host, which could easily be bridging, routing, or firewalling access to other networks. Since some hardware can't fully implement the CDC Ethernet requirements, this driver also implements a "good parts only" subset of CDC Ethernet. (That subset doesn't advertise itself as CDC Ethernet, to avoid creating problems.)h](h There’s an }(hjGhhhNhNubj)}(h ``ethernet``h]hethernet}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGubh8 gadget driver, which implements one of the most useful }(hjGhhhNhNubj$)}(h*Communications Device Class*h]hCommunications Device Class}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjGubhXh (CDC) models. One of the standards for cable modem interoperability even specifies the use of this ethernet model as one of two mandatory options. Gadgets using this code look to a USB host as if they’re an Ethernet adapter. It provides access to a network where the gadget’s CPU is one host, which could easily be bridging, routing, or firewalling access to other networks. Since some hardware can’t fully implement the CDC Ethernet requirements, this driver also implements a “good parts only” subset of CDC Ethernet. (That subset doesn’t advertise itself as CDC Ethernet, to avoid creating problems.)}(hjGhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXSupport for Microsoft's ``RNDIS`` protocol has been contributed by Pengutronix and Auerswald GmbH. This is like CDC Ethernet, but it runs on more slightly USB hardware (but less than the CDC subset). However, its main claim to fame is being able to connect directly to recent versions of Windows, using drivers that Microsoft bundles and supports, making it much simpler to network with Windows.h](hSupport for Microsoft’s }(hjyhhhNhNubj)}(h ``RNDIS``h]hRNDIS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjyubhXj protocol has been contributed by Pengutronix and Auerswald GmbH. This is like CDC Ethernet, but it runs on more slightly USB hardware (but less than the CDC subset). However, its main claim to fame is being able to connect directly to recent versions of Windows, using drivers that Microsoft bundles and supports, making it much simpler to network with Windows.}(hjyhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hX=There is also support for user mode gadget drivers, using ``gadgetfs``. This provides a *User Mode API* that presents each endpoint as a single file descriptor. I/O is done using normal ``read()`` and ``read()`` calls. Familiar tools like GDB and pthreads can be used to develop and debug user mode drivers, so that once a robust controller driver is available many applications for it won't require new kernel mode software. Linux 2.6 *Async I/O (AIO)* support is available, so that user mode software can stream data with only slightly more overhead than a kernel driver.h](h:There is also support for user mode gadget drivers, using }(hjhhhNhNubj)}(h ``gadgetfs``h]hgadgetfs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. This provides a }(hjhhhNhNubj$)}(h*User Mode API*h]h User Mode API}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubhS that presents each endpoint as a single file descriptor. I/O is done using normal }(hjhhhNhNubj)}(h ``read()``h]hread()}(hjņhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h ``read()``h]hread()}(hj׆hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh calls. Familiar tools like GDB and pthreads can be used to develop and debug user mode drivers, so that once a robust controller driver is available many applications for it won’t require new kernel mode software. Linux 2.6 }(hjhhhNhNubj$)}(h*Async I/O (AIO)*h]hAsync I/O (AIO)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubhx support is available, so that user mode software can stream data with only slightly more overhead than a kernel driver.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXThere's a USB Mass Storage class driver, which provides a different solution for interoperability with systems such as MS-Windows and MacOS. That *Mass Storage* driver uses a file or block device as backing store for a drive, like the ``loop`` driver. The USB host uses the BBB, CB, or CBI versions of the mass storage class specification, using transparent SCSI commands to access the data from the backing store.h](hThere’s a USB Mass Storage class driver, which provides a different solution for interoperability with systems such as MS-Windows and MacOS. That }(hjhhhNhNubj$)}(h*Mass Storage*h]h Mass Storage}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubhK driver uses a file or block device as backing store for a drive, like the }(hjhhhNhNubj)}(h``loop``h]hloop}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh driver. The USB host uses the BBB, CB, or CBI versions of the mass storage class specification, using transparent SCSI commands to access the data from the backing store.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hX~There's a "serial line" driver, useful for TTY style operation over USB. The latest version of that driver supports CDC ACM style operation, like a USB modem, and so on most hardware it can interoperate easily with MS-Windows. One interesting use of that driver is in boot firmware (like a BIOS), which can sometimes use that model with very small systems without real serial lines.h]hXThere’s a “serial line” driver, useful for TTY style operation over USB. The latest version of that driver supports CDC ACM style operation, like a USB modem, and so on most hardware it can interoperate easily with MS-Windows. One interesting use of that driver is in boot firmware (like a BIOS), which can sometimes use that model with very small systems without real serial lines.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hzSupport for other kinds of gadget is expected to be developed and contributed over time, as this driver framework evolves.h]hzSupport for other kinds of gadget is expected to be developed and contributed over time, as this driver framework evolves.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]gadget-driversah ]h"]gadget driversah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hUSB On-The-GO (OTG)h]hUSB On-The-GO (OTG)}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjWhhhhhMubh)}(hUSB OTG support on Linux 2.6 was initially developed by Texas Instruments for `OMAP `__ 16xx and 17xx series processors. Other OTG systems should work in similar ways, but the hardware level details could be very different.h](hNUSB OTG support on Linux 2.6 was initially developed by Texas Instruments for }(hjhhhhNhNubh reference)}(h`OMAP `__h]hOMAP}(hjrhhhNhNubah}(h]h ]h"]h$]h&]nameOMAPrefurihttp://www.omap.comuh1jphjhubh 16xx and 17xx series processors. Other OTG systems should work in similar ways, but the hardware level details could be very different.}(hjhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjWhhubh)}(hX)Systems need specialized hardware support to implement OTG, notably including a special *Mini-AB* jack and associated transceiver to support *Dual-Role* operation: they can act either as a host, using the standard Linux-USB host side driver stack, or as a peripheral, using this ``gadget`` framework. To do that, the system software relies on small additions to those programming interfaces, and on a new internal component (here called an "OTG Controller") affecting which driver stack connects to the OTG port. In each role, the system can reuse the existing pool of hardware-neutral drivers, layered on top of the controller driver interfaces (:c:type:`usb_bus` or :c:type:`usb_gadget`). Such drivers need at most minor changes, and most of the calls added to support OTG can also benefit non-OTG products.h](hXSystems need specialized hardware support to implement OTG, notably including a special }(hjhhhNhNubj$)}(h *Mini-AB*h]hMini-AB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubh, jack and associated transceiver to support }(hjhhhNhNubj$)}(h *Dual-Role*h]h Dual-Role}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j#hjubh operation: they can act either as a host, using the standard Linux-USB host side driver stack, or as a peripheral, using this }(hjhhhNhNubj)}(h ``gadget``h]hgadget}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhXj framework. To do that, the system software relies on small additions to those programming interfaces, and on a new internal component (here called an “OTG Controller”) affecting which driver stack connects to the OTG port. In each role, the system can reuse the existing pool of hardware-neutral drivers, layered on top of the controller driver interfaces (}(hjhhhNhNubh)}(h:c:type:`usb_bus`h]j)}(hj·h]husb_bus}(hjЇhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhj̇ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjGjusb_busuh1hhhhMhjubh or }(hjhhhNhNubh)}(h:c:type:`usb_gadget`h]j)}(hjh]h usb_gadget}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjGj usb_gadgetuh1hhhhMhjubhy). Such drivers need at most minor changes, and most of the calls added to support OTG can also benefit non-OTG products.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjWhhubj[)}(hhh](j`)}(hGadget drivers test the ``is_otg`` flag, and use it to determine whether or not to include an OTG descriptor in each of their configurations. h]h)}(hGadget drivers test the ``is_otg`` flag, and use it to determine whether or not to include an OTG descriptor in each of their configurations.h](hGadget drivers test the }(hjhhhNhNubj)}(h ``is_otg``h]his_otg}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhk flag, and use it to determine whether or not to include an OTG descriptor in each of their configurations.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hXGadget drivers may need changes to support the two new OTG protocols, exposed in new gadget attributes such as ``b_hnp_enable`` flag. HNP support should be reported through a user interface (two LEDs could suffice), and is triggered in some cases when the host suspends the peripheral. SRP support can be user-initiated just like remote wakeup, probably by pressing the same button. h]h)}(hX~Gadget drivers may need changes to support the two new OTG protocols, exposed in new gadget attributes such as ``b_hnp_enable`` flag. HNP support should be reported through a user interface (two LEDs could suffice), and is triggered in some cases when the host suspends the peripheral. SRP support can be user-initiated just like remote wakeup, probably by pressing the same button.h](hoGadget drivers may need changes to support the two new OTG protocols, exposed in new gadget attributes such as }(hjIhhhNhNubj)}(h``b_hnp_enable``h]h b_hnp_enable}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubh flag. HNP support should be reported through a user interface (two LEDs could suffice), and is triggered in some cases when the host suspends the peripheral. SRP support can be user-initiated just like remote wakeup, probably by pressing the same button.}(hjIhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjEubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hOn the host side, USB device drivers need to be taught to trigger HNP at appropriate moments, using ``usb_suspend_device()``. That also conserves battery power, which is useful even for non-OTG configurations. h]h)}(hOn the host side, USB device drivers need to be taught to trigger HNP at appropriate moments, using ``usb_suspend_device()``. That also conserves battery power, which is useful even for non-OTG configurations.h](hdOn the host side, USB device drivers need to be taught to trigger HNP at appropriate moments, using }(hjshhhNhNubj)}(h``usb_suspend_device()``h]husb_suspend_device()}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsubhU. That also conserves battery power, which is useful even for non-OTG configurations.}(hjshhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjoubah}(h]h ]h"]h$]h&]uh1j_hjhhhhhNubj`)}(hXXAlso on the host side, a driver must support the OTG "Targeted Peripheral List". That's just a whitelist, used to reject peripherals not supported with a given Linux OTG host. *This whitelist is product-specific; each product must modify* ``otg_whitelist.h`` *to match its interoperability specification.* Non-OTG Linux hosts, like PCs and workstations, normally have some solution for adding drivers, so that peripherals that aren't recognized can eventually be supported. That approach is unreasonable for consumer products that may never have their firmware upgraded, and where it's usually unrealistic to expect traditional PC/workstation/server kinds of support model to work. For example, it's often impractical to change device firmware once the product has been distributed, so driver bugs can't normally be fixed if they're found after shipment. h](h)}(hX1Also on the host side, a driver must support the OTG "Targeted Peripheral List". That's just a whitelist, used to reject peripherals not supported with a given Linux OTG host. *This whitelist is product-specific; each product must modify* ``otg_whitelist.h`` *to match its interoperability specification.*h](hAlso on the host side, a driver must support the OTG “Targeted Peripheral List”. That’s just a whitelist, used to reject peripherals not supported with a given Linux OTG host. }(hjhhhNhNubj$)}(h>*This whitelist is product-specific; each product must modify*h]hj>jAGj>GjjjjjjjTjQjbj_u nametypes}(jjjBjjj$jqj>jAGjjjjTjbuh}(jghj?j;jjEjjj!jyjnj'j>jtjjjjjjjjjjj j j#j$#j&j&ji'jn'j(j(j*j"*jw+j|+j,j,j+.j0.j/j/j1j 1j5j5j8j8jX:j]:j;j;j*=j/=j>Gj>j>j>j`AjeAjBjBjKEjPEjjDGjGjGjJjJjbLjgLjMjMjUj UjXjXj\j\j]j]jbj bjejejhjhj8kj=kjljljnjnjpjpjrjrjvj vjwjwjzjzja}jf}jjjjj3j8jjjjjQjj_jWu footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.