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/usbmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/zh_TW/driver-api/usb/usbmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/it_IT/driver-api/usb/usbmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/ja_JP/driver-api/usb/usbmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/ko_KR/driver-api/usb/usbmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/pt_BR/driver-api/usb/usbmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget&/translations/sp_SP/driver-api/usb/usbmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhtarget)}(h.. _usb-hostside-api:h]h}(h]h ]h"]h$]h&]refidusb-hostside-apiuh1hhKhhhhh@/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb.rstubhsection)}(hhh](htitle)}(hThe Linux-USB Host Side APIh]hThe Linux-USB Host Side API}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hIntroduction to USB on Linuxh]hIntroduction to USB on Linux}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hXA Universal Serial Bus (USB) is used to connect a host, such as a PC or workstation, to a number of peripheral devices. USB uses a tree structure, with the host as the root (the system's master), hubs as interior nodes, and peripherals as leaves (and slaves). Modern PCs support several such trees of USB devices, usually a few USB 3.0 (5 GBit/s) or USB 3.1 (10 GBit/s) and some legacy USB 2.0 (480 MBit/s) buses just in case.h]hXA Universal Serial Bus (USB) is used to connect a host, such as a PC or workstation, to a number of peripheral devices. USB uses a tree structure, with the host as the root (the system’s master), hubs as interior nodes, and peripherals as leaves (and slaves). Modern PCs support several such trees of USB devices, usually a few USB 3.0 (5 GBit/s) or USB 3.1 (10 GBit/s) and some legacy USB 2.0 (480 MBit/s) buses just in case.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hXvThat master/slave asymmetry was designed-in for a number of reasons, one being ease of use. It is not physically possible to mistake upstream and downstream or it does not matter with a type C plug (or they are built into the peripheral). Also, the host software doesn't need to deal with distributed auto-configuration since the pre-designated master node manages all that.h]hXxThat master/slave asymmetry was designed-in for a number of reasons, one being ease of use. It is not physically possible to mistake upstream and downstream or it does not matter with a type C plug (or they are built into the peripheral). Also, the host software doesn’t need to deal with distributed auto-configuration since the pre-designated master node manages all that.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXXKernel developers added USB support to Linux early in the 2.2 kernel series and have been developing it further since then. Besides support for each new generation of USB, various host controllers gained support, new drivers for peripherals have been added and advanced features for latency measurement and improved power management introduced.h]hXXKernel developers added USB support to Linux early in the 2.2 kernel series and have been developing it further since then. Besides support for each new generation of USB, various host controllers gained support, new drivers for peripherals have been added and advanced features for latency measurement and improved power management introduced.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hX,Linux can run inside USB devices as well as on the hosts that control the devices. But USB device drivers running inside those peripherals don't do the same things as the ones running inside hosts, so they've been given a different name: *gadget drivers*. This document does not cover gadget drivers.h](hLinux can run inside USB devices as well as on the hosts that control the devices. But USB device drivers running inside those peripherals don’t do the same things as the ones running inside hosts, so they’ve been given a different name: }(hjhhhNhNubhemphasis)}(h*gadget drivers*h]hgadget drivers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.. This document does not cover gadget drivers.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubeh}(h]introduction-to-usb-on-linuxah ]h"]introduction to usb on linuxah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hUSB Host-Side API Modelh]hUSB Host-Side API Model}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@hhhhhK&ubh)}(hXHost-side drivers for USB devices talk to the "usbcore" APIs. There are two. One is intended for *general-purpose* drivers (exposed through driver frameworks), and the other is for drivers that are *part of the core*. Such core drivers include the *hub* driver (which manages trees of USB devices) and several different kinds of *host controller drivers*, which control individual buses.h](heHost-side drivers for USB devices talk to the “usbcore” APIs. There are two. One is intended for }(hjQhhhNhNubj)}(h*general-purpose*h]hgeneral-purpose}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubhT drivers (exposed through driver frameworks), and the other is for drivers that are }(hjQhhhNhNubj)}(h*part of the core*h]hpart of the core}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubh . Such core drivers include the }(hjQhhhNhNubj)}(h*hub*h]hhub}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubhL driver (which manages trees of USB devices) and several different kinds of }(hjQhhhNhNubj)}(h*host controller drivers*h]hhost controller drivers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubh!, which control individual buses.}(hjQhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK(hj@hhubh)}(h;The device model seen by USB drivers is relatively complex.h]h;The device model seen by USB drivers is relatively complex.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK/hj@hhubh bullet_list)}(hhh](h list_item)}(hUSB supports four kinds of data transfers (control, bulk, interrupt, and isochronous). Two of them (control and bulk) use bandwidth as it's available, while the other two (interrupt and isochronous) are scheduled to provide guaranteed bandwidth. h]h)}(hUSB supports four kinds of data transfers (control, bulk, interrupt, and isochronous). Two of them (control and bulk) use bandwidth as it's available, while the other two (interrupt and isochronous) are scheduled to provide guaranteed bandwidth.h]hUSB supports four kinds of data transfers (control, bulk, interrupt, and isochronous). Two of them (control and bulk) use bandwidth as it’s available, while the other two (interrupt and isochronous) are scheduled to provide guaranteed bandwidth.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK1hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubj)}(hX!The device description model includes one or more "configurations" per device, only one of which is active at a time. Devices are supposed to be capable of operating at lower than their top speeds and may provide a BOS descriptor showing the lowest speed they remain fully operational at. h]h)}(hX The device description model includes one or more "configurations" per device, only one of which is active at a time. Devices are supposed to be capable of operating at lower than their top speeds and may provide a BOS descriptor showing the lowest speed they remain fully operational at.h]hX$The device description model includes one or more “configurations” per device, only one of which is active at a time. Devices are supposed to be capable of operating at lower than their top speeds and may provide a BOS descriptor showing the lowest speed they remain fully operational at.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK6hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubj)}(hFrom USB 3.0 on configurations have one or more "functions", which provide a common functionality and are grouped together for purposes of power management. h]h)}(hFrom USB 3.0 on configurations have one or more "functions", which provide a common functionality and are grouped together for purposes of power management.h]hFrom USB 3.0 on configurations have one or more “functions”, which provide a common functionality and are grouped together for purposes of power management.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKenum usb_ssp_rate usb_get_maximum_ssp_rate(struct device *dev)h](j1)}(hjh]henum}(hjS hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjO hhh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKubjC)}(h h]h }(hja hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjO hhhj` hKubh)}(hhh]j)}(h usb_ssp_rateh]h usb_ssp_rate}(hjr hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjo ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjt modnameN classnameNjLjO)}jR]jU)}jHusb_get_maximum_ssp_ratesbc.usb_get_maximum_ssp_rateasbuh1hhjO hhhj` hKubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjO hhhj` hKubj)}(husb_get_maximum_ssp_rateh]j)}(hj h]husb_get_maximum_ssp_rate}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjO hhhj` hKubj)}(h(struct device *dev)h]j)}(hstruct device *devh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(hdeviceh]hdevice}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR]j c.usb_get_maximum_ssp_rateasbuh1hhj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(hdevh]hdev}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubah}(h]h ]h"]h$]h&]jjuh1jhjO hhhj` hKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjK hhhj` hKubah}(h]jF ah ](jjeh"]h$]h&]jj)jhuh1j$hj` hKhjH hhubj)}(hhh]h)}(hUGet the signaling rate generation and lane count of a SuperSpeed Plus capable device.h]hUGet the signaling rate generation and lane count of a SuperSpeed Plus capable device.}(hjA hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj> hhubah}(h]h ]h"]h$]h&]uh1jhjH hhhj` hKubeh}(h]h ](jfunctioneh"]h$]h&]jjjjY jjY j j!j"uh1jhhhjhNhNubj$)}(hX/**Parameters** ``struct device *dev`` Pointer to the given USB controller device **Description** If the string from "maximum-speed" property is super-speed-plus-genXxY where 'X' is the generation number and 'Y' is the number of lanes, then this function returns the corresponding enum usb_ssp_rate.h](h)}(h**Parameters**h]j.)}(hjc h]h Parameters}(hje hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hja ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj] ubjD)}(hhh]jI)}(hB``struct device *dev`` Pointer to the given USB controller device h](jO)}(h``struct device *dev``h]j)}(hj h]hstruct device *dev}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj| ubji)}(hhh]h)}(h*Pointer to the given USB controller deviceh]h*Pointer to the given USB controller device}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKhj ubah}(h]h ]h"]h$]h&]uh1jhhj| ubeh}(h]h ]h"]h$]h&]uh1jHhj hKhjy ubah}(h]h ]h"]h$]h&]uh1jChj] ubh)}(h**Description**h]j.)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj] ubh)}(hIf the string from "maximum-speed" property is super-speed-plus-genXxY where 'X' is the generation number and 'Y' is the number of lanes, then this function returns the corresponding enum usb_ssp_rate.h]hIf the string from “maximum-speed” property is super-speed-plus-genXxY where ‘X’ is the generation number and ‘Y’ is the number of lanes, then this function returns the corresponding enum usb_ssp_rate.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj] ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_state_string (C function)c.usb_state_stringhNtauh1jhjhhhNhNubj )}(hhh](j%)}(h;const char * usb_state_string (enum usb_device_state state)h]j+)}(h9const char *usb_state_string(enum usb_device_state state)h](j1)}(hj4h]hconst}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj hhh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj hhhj hKubjT)}(hcharh]hchar}(hj hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj hhhj hKubjC)}(h h]h }(hj, hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj hhhj hKubjs)}(hjvh]h*}(hj: hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj hhhj hKubj)}(husb_state_stringh]j)}(husb_state_stringh]husb_state_string}(hjK hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjG ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj hhhj hKubj)}(h(enum usb_device_state state)h]j)}(henum usb_device_state stateh](j1)}(hjh]henum}(hjg hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjc ubjC)}(h h]h }(hjt hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjc ubh)}(hhh]j)}(husb_device_stateh]husb_device_state}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR]jU)}jHjM sbc.usb_state_stringasbuh1hhjc ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjc ubj)}(hstateh]hstate}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjc ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ ubah}(h]h ]h"]h$]h&]jjuh1jhj hhhj hKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj hhhj hKubah}(h]j ah ](jjeh"]h$]h&]jj)jhuh1j$hj hKhj hhubj)}(hhh]h)}(h*Returns human readable name for the state.h]h*Returns human readable name for the state.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj hhubah}(h]h ]h"]h$]h&]uh1jhj hhhj hKubeh}(h]h ](jfunctioneh"]h$]h&]jjjj jj j j!j"uh1jhhhjhNhNubj$)}(h**Parameters** ``enum usb_device_state state`` The state to return a human-readable name for. If it's not any of the states devices in usb_device_state_string enum, the string UNKNOWN will be returned.h](h)}(h**Parameters**h]j.)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj ubjD)}(hhh]jI)}(h``enum usb_device_state state`` The state to return a human-readable name for. If it's not any of the states devices in usb_device_state_string enum, the string UNKNOWN will be returned.h](jO)}(h``enum usb_device_state state``h]j)}(hj h]henum usb_device_state state}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj ubji)}(hhh]h)}(hThe state to return a human-readable name for. If it's not any of the states devices in usb_device_state_string enum, the string UNKNOWN will be returned.h]hThe state to return a human-readable name for. If it’s not any of the states devices in usb_device_state_string enum, the string UNKNOWN will be returned.}(hj7 hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj4 ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj3 hKhj ubah}(h]h ]h"]h$]h&]uh1jChj ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_get_role_switch_default_mode (C function)"c.usb_get_role_switch_default_modehNtauh1jhjhhhNhNubj )}(hhh](j%)}(hFenum usb_dr_mode usb_get_role_switch_default_mode (struct device *dev)h]j+)}(hEenum usb_dr_mode usb_get_role_switch_default_mode(struct device *dev)h](j1)}(hjh]henum}(hjx hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjt hhh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjt hhhj hKubh)}(hhh]j)}(h usb_dr_modeh]h usb_dr_mode}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR]jU)}jH usb_get_role_switch_default_modesb"c.usb_get_role_switch_default_modeasbuh1hhjt hhhj hKubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjt hhhj hKubj)}(h usb_get_role_switch_default_modeh]j)}(hj h]h usb_get_role_switch_default_mode}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjt hhhj hKubj)}(h(struct device *dev)h]j)}(hstruct device *devh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(hdeviceh]hdevice}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR]j "c.usb_get_role_switch_default_modeasbuh1hhj ubjC)}(h h]h }(hj! hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hj/ hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(hdevh]hdev}(hj< hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubah}(h]h ]h"]h$]h&]jjuh1jhjt hhhj hKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjp hhhj hKubah}(h]jk ah ](jjeh"]h$]h&]jj)jhuh1j$hj hKhjm hhubj)}(hhh]h)}(h!Get default mode for given deviceh]h!Get default mode for given device}(hjf hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhjc hhubah}(h]h ]h"]h$]h&]uh1jhjm hhhj hKubeh}(h]h ](jfunctioneh"]h$]h&]jjjj~ jj~ j j!j"uh1jhhhjhNhNubj$)}(h**Parameters** ``struct device *dev`` Pointer to the given device **Description** The function gets string from property 'role-switch-default-mode', and returns the corresponding enum usb_dr_mode.h](h)}(h**Parameters**h]j.)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj ubjD)}(hhh]jI)}(h3``struct device *dev`` Pointer to the given device h](jO)}(h``struct device *dev``h]j)}(hj h]hstruct device *dev}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj ubji)}(hhh]h)}(hPointer to the given deviceh]hPointer to the given device}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKhj ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj hKhj ubah}(h]h ]h"]h$]h&]uh1jChj ubh)}(h**Description**h]j.)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj ubh)}(hrThe function gets string from property 'role-switch-default-mode', and returns the corresponding enum usb_dr_mode.h]hvThe function gets string from property ‘role-switch-default-mode’, and returns the corresponding enum usb_dr_mode.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j usb_decode_interval (C function)c.usb_decode_intervalhNtauh1jhjhhhNhNubj )}(hhh](j%)}(hiunsigned int usb_decode_interval (const struct usb_endpoint_descriptor *epd, enum usb_device_speed speed)h]j+)}(hhunsigned int usb_decode_interval(const struct usb_endpoint_descriptor *epd, enum usb_device_speed speed)h](jT)}(hunsignedh]hunsigned}(hj'hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj#hhh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKubjC)}(h h]h }(hj6hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj#hhhj5hKubjT)}(hinth]hint}(hjDhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj#hhhj5hKubjC)}(h h]h }(hjRhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj#hhhj5hKubj)}(husb_decode_intervalh]j)}(husb_decode_intervalh]husb_decode_interval}(hjdhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj#hhhj5hKubj)}(hH(const struct usb_endpoint_descriptor *epd, enum usb_device_speed speed)h](j)}(h)const struct usb_endpoint_descriptor *epdh](j1)}(hj4h]hconst}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj|ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj|ubj1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj|ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj|ubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jU)}jHjfsbc.usb_decode_intervalasbuh1hhj|ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj|ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj|ubj)}(hepdh]hepd}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjxubj)}(henum usb_device_speed speedh](j1)}(hjh]henum}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(husb_device_speedh]husb_device_speed}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj-modnameN classnameNjLjO)}jR]jc.usb_decode_intervalasbuh1hhj ubjC)}(h h]h }(hjIhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubj)}(hspeedh]hspeed}(hjWhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjxubeh}(h]h ]h"]h$]h&]jjuh1jhj#hhhj5hKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj5hKubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hj5hKhjhhubj)}(hhh]h)}(h4Decode bInterval into the time expressed in 1us unith]h4Decode bInterval into the time expressed in 1us unit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhj~hhubah}(h]h ]h"]h$]h&]uh1jhjhhhj5hKubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjhNhNubj$)}(hX**Parameters** ``const struct usb_endpoint_descriptor *epd`` The descriptor of the endpoint ``enum usb_device_speed speed`` The speed that the endpoint works as **Description** Function returns the interval expressed in 1us unit for servicing endpoint for data transfers.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhjubjD)}(hhh](jI)}(hM``const struct usb_endpoint_descriptor *epd`` The descriptor of the endpoint h](jO)}(h-``const struct usb_endpoint_descriptor *epd``h]j)}(hjh]h)const struct usb_endpoint_descriptor *epd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhjubji)}(hhh]h)}(hThe descriptor of the endpointh]hThe descriptor of the endpoint}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(hE``enum usb_device_speed speed`` The speed that the endpoint works as h](jO)}(h``enum usb_device_speed speed``h]j)}(hjh]henum usb_device_speed speed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhjubji)}(hhh]h)}(h$The speed that the endpoint works ash]h$The speed that the endpoint works as}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hj6h]h Description}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj4ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhjubh)}(h^Function returns the interval expressed in 1us unit for servicing endpoint for data transfers.h]h^Function returns the interval expressed in 1us unit for servicing endpoint for data transfers.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chKhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&of_usb_get_dr_mode_by_phy (C function)c.of_usb_get_dr_mode_by_phyhNtauh1jhjhhhNhNubj )}(hhh](j%)}(hMenum usb_dr_mode of_usb_get_dr_mode_by_phy (struct device_node *np, int arg0)h]j+)}(hLenum usb_dr_mode of_usb_get_dr_mode_by_phy(struct device_node *np, int arg0)h](j1)}(hjh]henum}(hj{hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjwhhh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjwhhhjhMubh)}(hhh]j)}(h usb_dr_modeh]h usb_dr_mode}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jU)}jHof_usb_get_dr_mode_by_physbc.of_usb_get_dr_mode_by_phyasbuh1hhjwhhhjhMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjwhhhjhMubj)}(hof_usb_get_dr_mode_by_phyh]j)}(hjh]hof_usb_get_dr_mode_by_phy}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjwhhhjhMubj)}(h"(struct device_node *np, int arg0)h](j)}(hstruct device_node *nph](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h device_nodeh]h device_node}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jc.of_usb_get_dr_mode_by_phyasbuh1hhjubjC)}(h h]h }(hj$hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj2hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hnph]hnp}(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hint arg0h](jT)}(hinth]hint}(hjXhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjTubjC)}(h h]h }(hjfhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjTubj)}(harg0h]harg0}(hjthhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjwhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjshhhjhMubah}(h]jnah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjphhubj)}(hhh]h)}(h_Get dual role mode for the controller device which is associated with the given phy device_nodeh]h_Get dual role mode for the controller device which is associated with the given phy device_node}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjphhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjhNhNubj$)}(hX**Parameters** ``struct device_node *np`` Pointer to the given phy device_node ``int arg0`` phandle args[0] for phy's with #phy-cells >= 1, or -1 for phys which do not have phy-cells **Description** In dts a usb controller associates with phy devices. The function gets the string from property 'dr_mode' of the controller associated with the given phy device node, and returns the correspondig enum usb_dr_mode.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhjubjD)}(hhh](jI)}(h@``struct device_node *np`` Pointer to the given phy device_node h](jO)}(h``struct device_node *np``h]j)}(hjh]hstruct device_node *np}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.c hMhjubji)}(hhh]h)}(h$Pointer to the given phy device_nodeh]h$Pointer to the given phy device_node}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubjI)}(hh``int arg0`` phandle args[0] for phy's with #phy-cells >= 1, or -1 for phys which do not have phy-cells h](jO)}(h ``int arg0``h]j)}(hjh]hint arg0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhjubji)}(hhh]h)}(hZphandle args[0] for phy's with #phy-cells >= 1, or -1 for phys which do not have phy-cellsh]h\phandle args[0] for phy’s with #phy-cells >= 1, or -1 for phys which do not have phy-cells}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhj.ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj-hMhjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjTh]h Description}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjRubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhjubh)}(hIn dts a usb controller associates with phy devices. The function gets the string from property 'dr_mode' of the controller associated with the given phy device node, and returns the correspondig enum usb_dr_mode.h]hIn dts a usb controller associates with phy devices. The function gets the string from property ‘dr_mode’ of the controller associated with the given phy device node, and returns the correspondig enum usb_dr_mode.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$of_usb_host_tpl_support (C function)c.of_usb_host_tpl_supporthNtauh1jhjhhhNhNubj )}(hhh](j%)}(h5bool of_usb_host_tpl_support (struct device_node *np)h]j+)}(h4bool of_usb_host_tpl_support(struct device_node *np)h](jT)}(hboolh]hbool}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMOubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMOubj)}(hof_usb_host_tpl_supporth]j)}(hof_usb_host_tpl_supporth]hof_usb_host_tpl_support}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMOubj)}(h(struct device_node *np)h]j)}(hstruct device_node *nph](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h device_nodeh]h device_node}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jU)}jHjsbc.of_usb_host_tpl_supportasbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hnph]hnp}(hj/hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMOubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMOubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMOhjhhubj)}(hhh]h)}(hWto get if Targeted Peripheral List is supported for given targeted hosts (non-PC hosts)h]hWto get if Targeted Peripheral List is supported for given targeted hosts (non-PC hosts)}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMOhjVhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMOubeh}(h]h ](jfunctioneh"]h$]h&]jjjjqjjqj j!j"uh1jhhhjhNhNubj$)}(h**Parameters** ``struct device_node *np`` Pointer to the given device_node **Description** The function gets if the targeted hosts support TPL or noth](h)}(h**Parameters**h]j.)}(hj{h]h Parameters}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjyubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMShjuubjD)}(hhh]jI)}(h<``struct device_node *np`` Pointer to the given device_node h](jO)}(h``struct device_node *np``h]j)}(hjh]hstruct device_node *np}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMQhjubji)}(hhh]h)}(h Pointer to the given device_nodeh]h Pointer to the given device_node}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMQhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMQhjubah}(h]h ]h"]h$]h&]uh1jChjuubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMShjuubh)}(h:The function gets if the targeted hosts support TPL or noth]h:The function gets if the targeted hosts support TPL or not}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMRhjuubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#of_usb_update_otg_caps (C function)c.of_usb_update_otg_capshNtauh1jhjhhhNhNubj )}(hhh](j%)}(hRint of_usb_update_otg_caps (struct device_node *np, struct usb_otg_caps *otg_caps)h]j+)}(hQint of_usb_update_otg_caps(struct device_node *np, struct usb_otg_caps *otg_caps)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chM\ubjC)}(h h]h }(hj)hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj(hM\ubj)}(hof_usb_update_otg_capsh]j)}(hof_usb_update_otg_capsh]hof_usb_update_otg_caps}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj7ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhj(hM\ubj)}(h7(struct device_node *np, struct usb_otg_caps *otg_caps)h](j)}(hstruct device_node *nph](j1)}(hjh]hstruct}(hjWhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjSubjC)}(h h]h }(hjdhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjSubh)}(hhh]j)}(h device_nodeh]h device_node}(hjuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjwmodnameN classnameNjLjO)}jR]jU)}jHj=sbc.of_usb_update_otg_capsasbuh1hhjSubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjSubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjSubj)}(hnph]hnp}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjSubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjOubj)}(hstruct usb_otg_caps *otg_capsh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_otg_capsh]h usb_otg_caps}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jc.of_usb_update_otg_capsasbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hotg_capsh]hotg_caps}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjOubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhj(hM\ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj(hM\ubah}(h]j ah ](jjeh"]h$]h&]jj)jhuh1j$hj(hM\hjhhubj)}(hhh]h)}(hHto update usb otg capabilities according to the passed properties in DT.h]hHto update usb otg capabilities according to the passed properties in DT.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chM\hjGhhubah}(h]h ]h"]h$]h&]uh1jhjhhhj(hM\ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjbjjbj j!j"uh1jhhhjhNhNubj$)}(h**Parameters** ``struct device_node *np`` Pointer to the given device_node ``struct usb_otg_caps *otg_caps`` Pointer to the target usb_otg_caps to be set **Description** The function updates the otg capabilitiesh](h)}(h**Parameters**h]j.)}(hjlh]h Parameters}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chM`hjfubjD)}(hhh](jI)}(h<``struct device_node *np`` Pointer to the given device_node h](jO)}(h``struct device_node *np``h]j)}(hjh]hstruct device_node *np}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chM^hjubji)}(hhh]h)}(h Pointer to the given device_nodeh]h Pointer to the given device_node}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM^hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM^hjubjI)}(hO``struct usb_otg_caps *otg_caps`` Pointer to the target usb_otg_caps to be set h](jO)}(h!``struct usb_otg_caps *otg_caps``h]j)}(hjh]hstruct usb_otg_caps *otg_caps}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chM_hjubji)}(hhh]h)}(h,Pointer to the target usb_otg_caps to be seth]h,Pointer to the target usb_otg_caps to be set}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM_hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM_hjubeh}(h]h ]h"]h$]h&]uh1jChjfubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMahjfubh)}(h)The function updates the otg capabilitiesh]h)The function updates the otg capabilities}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chM`hjfubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j%usb_of_get_companion_dev (C function)c.usb_of_get_companion_devhNtauh1jhjhhhNhNubj )}(hhh](j%)}(h=struct device * usb_of_get_companion_dev (struct device *dev)h]j+)}(h;struct device *usb_of_get_companion_dev(struct device *dev)h](j1)}(hjh]hstruct}(hjDhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj@hhh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMubjC)}(h h]h }(hjRhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj@hhhjQhMubh)}(hhh]j)}(hdeviceh]hdevice}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjemodnameN classnameNjLjO)}jR]jU)}jHusb_of_get_companion_devsbc.usb_of_get_companion_devasbuh1hhj@hhhjQhMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj@hhhjQhMubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj@hhhjQhMubj)}(husb_of_get_companion_devh]j)}(hjh]husb_of_get_companion_dev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhj@hhhjQhMubj)}(h(struct device *dev)h]j)}(hstruct device *devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(hdeviceh]hdevice}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jc.usb_of_get_companion_devasbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdevh]hdev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhj@hhhjQhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj<hhhjQhMubah}(h]j7ah ](jjeh"]h$]h&]jj)jhuh1j$hjQhMhj9hhubj)}(hhh]h)}(hFind the companion deviceh]hFind the companion device}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhj<hhubah}(h]h ]h"]h$]h&]uh1jhj9hhhjQhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjWjjWj j!j"uh1jhhhjhNhNubj$)}(hX5**Parameters** ``struct device *dev`` the device pointer to find a companion **Description** Find the companion device from platform bus. Takes a reference to the returned struct device which needs to be dropped after use. **Return** On success, a pointer to the companion device, ``NULL`` on failure.h](h)}(h**Parameters**h]j.)}(hjah]h Parameters}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj_ubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhj[ubjD)}(hhh]jI)}(h>``struct device *dev`` the device pointer to find a companion h](jO)}(h``struct device *dev``h]j)}(hjh]hstruct device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ubah}(h]h ]h"]h$]h&]uh1jNh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhjzubji)}(hhh]h)}(h&the device pointer to find a companionh]h&the device pointer to find a companion}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjzubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjwubah}(h]h ]h"]h$]h&]uh1jChj[ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhj[ubh)}(h,Find the companion device from platform bus.h]h,Find the companion device from platform bus.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhj[ubh)}(hTTakes a reference to the returned struct device which needs to be dropped after use.h]hTTakes a reference to the returned struct device which needs to be dropped after use.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhj[ubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhj[ubh)}(hCOn success, a pointer to the companion device, ``NULL`` on failure.h](h/On success, a pointer to the companion device, }(hjhhhNhNubj)}(h``NULL``h]hNULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh on failure.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh_/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:120: ./drivers/usb/common/common.chMhj[ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjhhhNhNubh)}(hoIn addition, some functions useful for creating debugging output are defined in ``drivers/usb/common/debug.c``.h](hPIn addition, some functions useful for creating debugging output are defined in }(hj/hhhNhNubj)}(h``drivers/usb/common/debug.c``h]hdrivers/usb/common/debug.c}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubh.}(hj/hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK{hjhhubh)}(h.. _usb_header:h]h}(h]h ]h"]h$]h&]h usb-headeruh1hhK~hjhhhhubeh}(h](usb-standard-typesjeh ]h"](usb-standard types usb_chapter9eh$]h&]uh1hhhhhhhhKnexpect_referenced_by_name}j`jsexpect_referenced_by_id}jjsubh)}(hhh](h)}(hHost-Side Data Types and Macrosh]hHost-Side Data Types and Macros}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjghhhhhKubh)}(hX The host side API exposes several layers to drivers, some of which are more necessary than others. These support lifecycle models for host side drivers and devices, and support passing buffers through usbcore to some HCD that performs the I/O for the device driver.h]hX The host side API exposes several layers to drivers, some of which are more necessary than others. These support lifecycle models for host side drivers and devices, and support passing buffers through usbcore to some HCD that performs the I/O for the device driver.}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_host_endpoint (C struct)c.usb_host_endpointhNtauh1jhjghhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhNubj )}(hhh](j%)}(husb_host_endpointh]j+)}(hstruct usb_host_endpointh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhKubj)}(husb_host_endpointh]j)}(hjh]husb_host_endpoint}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhKubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhKhjhhubj)}(hhh]h)}(h'host-side endpoint descriptor and queueh]h'host-side endpoint descriptor and queue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK3hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhKubeh}(h]h ](jstructeh"]h$]h&]jjjjjjj j!j"uh1jhhhjghjhNubj$)}(hXj**Definition**:: struct usb_host_endpoint { struct usb_endpoint_descriptor desc; struct usb_ss_ep_comp_descriptor ss_ep_comp; struct usb_ssp_isoc_ep_comp_descriptor ssp_isoc_ep_comp; struct usb_eusb2_isoc_ep_comp_descriptor eusb2_isoc_ep_comp; struct list_head urb_list; void *hcpriv; struct ep_device *ep_dev; unsigned char *extra; int extralen; int enabled; int streams; }; **Members** ``desc`` descriptor for this endpoint, wMaxPacketSize in native byteorder ``ss_ep_comp`` SuperSpeed companion descriptor for this endpoint ``ssp_isoc_ep_comp`` SuperSpeedPlus isoc companion descriptor for this endpoint ``eusb2_isoc_ep_comp`` eUSB2 isoc companion descriptor for this endpoint ``urb_list`` urbs queued to this endpoint; maintained by usbcore ``hcpriv`` for use by HCD; typically holds hardware dma queue head (QH) with one or more transfer descriptors (TDs) per urb; must be preserved by core while BW is allocated for the endpoint ``ep_dev`` ep_device for sysfs info ``extra`` descriptors following this endpoint in the configuration ``extralen`` how many bytes of "extra" are valid ``enabled`` URBs may be submitted to this endpoint ``streams`` number of USB-3 streams allocated on the endpointh](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK7hjubh literal_block)}(hXstruct usb_host_endpoint { struct usb_endpoint_descriptor desc; struct usb_ss_ep_comp_descriptor ss_ep_comp; struct usb_ssp_isoc_ep_comp_descriptor ssp_isoc_ep_comp; struct usb_eusb2_isoc_ep_comp_descriptor eusb2_isoc_ep_comp; struct list_head urb_list; void *hcpriv; struct ep_device *ep_dev; unsigned char *extra; int extralen; int enabled; int streams; };h]hXstruct usb_host_endpoint { struct usb_endpoint_descriptor desc; struct usb_ss_ep_comp_descriptor ss_ep_comp; struct usb_ssp_isoc_ep_comp_descriptor ssp_isoc_ep_comp; struct usb_eusb2_isoc_ep_comp_descriptor eusb2_isoc_ep_comp; struct list_head urb_list; void *hcpriv; struct ep_device *ep_dev; unsigned char *extra; int extralen; int enabled; int streams; };}hj!sbah}(h]h ]h"]h$]h&]jjuh1jhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK9hjubh)}(h **Members**h]j.)}(hj2h]hMembers}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj0ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKGhjubjD)}(hhh](jI)}(hJ``desc`` descriptor for this endpoint, wMaxPacketSize in native byteorder h](jO)}(h``desc``h]j)}(hjQh]hdesc}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK5hjKubji)}(hhh]h)}(h@descriptor for this endpoint, wMaxPacketSize in native byteorderh]h@descriptor for this endpoint, wMaxPacketSize in native byteorder}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfhK5hjgubah}(h]h ]h"]h$]h&]uh1jhhjKubeh}(h]h ]h"]h$]h&]uh1jHhjfhK5hjHubjI)}(hA``ss_ep_comp`` SuperSpeed companion descriptor for this endpoint h](jO)}(h``ss_ep_comp``h]j)}(hjh]h ss_ep_comp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK6hjubji)}(hhh]h)}(h1SuperSpeed companion descriptor for this endpointh]h1SuperSpeed companion descriptor for this endpoint}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK6hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhK6hjHubjI)}(hP``ssp_isoc_ep_comp`` SuperSpeedPlus isoc companion descriptor for this endpoint h](jO)}(h``ssp_isoc_ep_comp``h]j)}(hjh]hssp_isoc_ep_comp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK7hjubji)}(hhh]h)}(h:SuperSpeedPlus isoc companion descriptor for this endpointh]h:SuperSpeedPlus isoc companion descriptor for this endpoint}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK7hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhK7hjHubjI)}(hI``eusb2_isoc_ep_comp`` eUSB2 isoc companion descriptor for this endpoint h](jO)}(h``eusb2_isoc_ep_comp``h]j)}(hjh]heusb2_isoc_ep_comp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK8hjubji)}(hhh]h)}(h1eUSB2 isoc companion descriptor for this endpointh]h1eUSB2 isoc companion descriptor for this endpoint}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK8hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhK8hjHubjI)}(hA``urb_list`` urbs queued to this endpoint; maintained by usbcore h](jO)}(h ``urb_list``h]j)}(hj5h]hurb_list}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK9hj/ubji)}(hhh]h)}(h3urbs queued to this endpoint; maintained by usbcoreh]h3urbs queued to this endpoint; maintained by usbcore}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhK9hjKubah}(h]h ]h"]h$]h&]uh1jhhj/ubeh}(h]h ]h"]h$]h&]uh1jHhjJhK9hjHubjI)}(h``hcpriv`` for use by HCD; typically holds hardware dma queue head (QH) with one or more transfer descriptors (TDs) per urb; must be preserved by core while BW is allocated for the endpoint h](jO)}(h ``hcpriv``h]j)}(hjnh]hhcpriv}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(h8descriptors following this endpoint in the configurationh]h8descriptors following this endpoint in the configuration}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK>hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhK>hjHubjI)}(h1``extralen`` how many bytes of "extra" are valid h](jO)}(h ``extralen``h]j)}(hjh]hextralen}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK?hjubji)}(hhh]h)}(h#how many bytes of "extra" are validh]h'how many bytes of “extra” are valid}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hK?hj0ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj/hK?hjHubjI)}(h3``enabled`` URBs may be submitted to this endpoint h](jO)}(h ``enabled``h]j)}(hjSh]henabled}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK@hjMubji)}(hhh]h)}(h&URBs may be submitted to this endpointh]h&URBs may be submitted to this endpoint}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhK@hjiubah}(h]h ]h"]h$]h&]uh1jhhjMubeh}(h]h ]h"]h$]h&]uh1jHhjhhK@hjHubjI)}(h=``streams`` number of USB-3 streams allocated on the endpointh](jO)}(h ``streams``h]j)}(hjh]hstreams}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhK@hjubji)}(hhh]h)}(h1number of USB-3 streams allocated on the endpointh]h1number of USB-3 streams allocated on the endpoint}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKAhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhK@hjHubeh}(h]h ]h"]h$]h&]uh1jChjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKDhjghhubh)}(hUSB requests are always queued to a given endpoint, identified by a descriptor within an active interface in a given USB configuration.h]hUSB requests are always queued to a given endpoint, identified by a descriptor within an active interface in a given USB configuration.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKAhjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_interface (C struct)c.usb_interfacehNtauh1jhjghhhjhNubj )}(hhh](j%)}(h usb_interfaceh]j+)}(hstruct usb_interfaceh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKGubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj hhhjhKGubj)}(h usb_interfaceh]j)}(hjh]h usb_interface}(hj-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj hhhjhKGubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhKGubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhKGhjhhubj)}(hhh]h)}(hwhat usb device drivers talk toh]hwhat usb device drivers talk to}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjLhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhKGubeh}(h]h ](jstructeh"]h$]h&]jjjjgjjgj j!j"uh1jhhhjghjhNubj$)}(hX **Definition**:: struct usb_interface { struct usb_host_interface *altsetting; struct usb_host_interface *cur_altsetting; unsigned num_altsetting; struct usb_interface_assoc_descriptor *intf_assoc; int minor; enum usb_interface_condition condition; unsigned sysfs_files_created:1; unsigned ep_devs_created:1; unsigned unregistering:1; unsigned needs_remote_wakeup:1; unsigned needs_altsetting0:1; unsigned needs_binding:1; unsigned resetting_device:1; unsigned authorized:1; enum usb_wireless_status wireless_status; struct work_struct wireless_status_work; struct device dev; struct device *usb_dev; struct work_struct reset_ws; }; **Members** ``altsetting`` array of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will be in no particular order. ``cur_altsetting`` the current altsetting. ``num_altsetting`` number of altsettings defined. ``intf_assoc`` interface association descriptor ``minor`` the minor number assigned to this interface, if this interface is bound to a driver that uses the USB major number. If this interface does not use the USB major, this field should be unused. The driver should set this value in the probe() function of the driver, after it has been assigned a minor number from the USB core by calling usb_register_dev(). ``condition`` binding state of the interface: not bound, binding (in probe()), bound to a driver, or unbinding (in disconnect()) ``sysfs_files_created`` sysfs attributes exist ``ep_devs_created`` endpoint child pseudo-devices exist ``unregistering`` flag set when the interface is being unregistered ``needs_remote_wakeup`` flag set when the driver requires remote-wakeup capability during autosuspend. ``needs_altsetting0`` flag set when a set-interface request for altsetting 0 has been deferred. ``needs_binding`` flag set when the driver should be re-probed or unbound following a reset or suspend operation it doesn't support. ``resetting_device`` USB core reset the device, so use alt setting 0 as current; needs bandwidth alloc after reset. ``authorized`` This allows to (de)authorize individual interfaces instead a whole device in contrast to the device authorization. ``wireless_status`` if the USB device uses a receiver/emitter combo, whether the emitter is connected. ``wireless_status_work`` Used for scheduling wireless status changes from atomic context. ``dev`` driver model's view of this device ``usb_dev`` if an interface is bound to the USB major, this will point to the sysfs representation for that device. ``reset_ws`` Used for scheduling resets from atomic context.h](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjoubh:}(hjohhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjkubj )}(hXstruct usb_interface { struct usb_host_interface *altsetting; struct usb_host_interface *cur_altsetting; unsigned num_altsetting; struct usb_interface_assoc_descriptor *intf_assoc; int minor; enum usb_interface_condition condition; unsigned sysfs_files_created:1; unsigned ep_devs_created:1; unsigned unregistering:1; unsigned needs_remote_wakeup:1; unsigned needs_altsetting0:1; unsigned needs_binding:1; unsigned resetting_device:1; unsigned authorized:1; enum usb_wireless_status wireless_status; struct work_struct wireless_status_work; struct device dev; struct device *usb_dev; struct work_struct reset_ws; };h]hXstruct usb_interface { struct usb_host_interface *altsetting; struct usb_host_interface *cur_altsetting; unsigned num_altsetting; struct usb_interface_assoc_descriptor *intf_assoc; int minor; enum usb_interface_condition condition; unsigned sysfs_files_created:1; unsigned ep_devs_created:1; unsigned unregistering:1; unsigned needs_remote_wakeup:1; unsigned needs_altsetting0:1; unsigned needs_binding:1; unsigned resetting_device:1; unsigned authorized:1; enum usb_wireless_status wireless_status; struct work_struct wireless_status_work; struct device dev; struct device *usb_dev; struct work_struct reset_ws; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjkubh)}(h **Members**h]j.)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjkubjD)}(hhh](jI)}(h``altsetting`` array of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will be in no particular order. h](jO)}(h``altsetting``h]j)}(hjh]h altsetting}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(harray of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will be in no particular order.h]harray of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will be in no particular order.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(h+``cur_altsetting`` the current altsetting. h](jO)}(h``cur_altsetting``h]j)}(hjh]hcur_altsetting}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(hthe current altsetting.h]hthe current altsetting.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKhj ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj hKhjubjI)}(h2``num_altsetting`` number of altsettings defined. h](jO)}(h``num_altsetting``h]j)}(hj/h]hnum_altsetting}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhj)ubji)}(hhh]h)}(hnumber of altsettings defined.h]hnumber of altsettings defined.}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhKhjEubah}(h]h ]h"]h$]h&]uh1jhhj)ubeh}(h]h ]h"]h$]h&]uh1jHhjDhKhjubjI)}(h0``intf_assoc`` interface association descriptor h](jO)}(h``intf_assoc``h]j)}(hjhh]h intf_assoc}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjfubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjbubji)}(hhh]h)}(h interface association descriptorh]h interface association descriptor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj}hKhj~ubah}(h]h ]h"]h$]h&]uh1jhhjbubeh}(h]h ]h"]h$]h&]uh1jHhj}hKhjubjI)}(hXm``minor`` the minor number assigned to this interface, if this interface is bound to a driver that uses the USB major number. If this interface does not use the USB major, this field should be unused. The driver should set this value in the probe() function of the driver, after it has been assigned a minor number from the USB core by calling usb_register_dev(). h](jO)}(h ``minor``h]j)}(hjh]hminor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(hXbthe minor number assigned to this interface, if this interface is bound to a driver that uses the USB major number. If this interface does not use the USB major, this field should be unused. The driver should set this value in the probe() function of the driver, after it has been assigned a minor number from the USB core by calling usb_register_dev().h]hXbthe minor number assigned to this interface, if this interface is bound to a driver that uses the USB major number. If this interface does not use the USB major, this field should be unused. The driver should set this value in the probe() function of the driver, after it has been assigned a minor number from the USB core by calling usb_register_dev().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(h``condition`` binding state of the interface: not bound, binding (in probe()), bound to a driver, or unbinding (in disconnect()) h](jO)}(h ``condition``h]j)}(hjh]h condition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(hrbinding state of the interface: not bound, binding (in probe()), bound to a driver, or unbinding (in disconnect())h]hrbinding state of the interface: not bound, binding (in probe()), bound to a driver, or unbinding (in disconnect())}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(h/``sysfs_files_created`` sysfs attributes exist h](jO)}(h``sysfs_files_created``h]j)}(hjh]hsysfs_files_created}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(hsysfs attributes existh]hsysfs attributes exist}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hKhj+ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj*hKhjubjI)}(h8``ep_devs_created`` endpoint child pseudo-devices exist h](jO)}(h``ep_devs_created``h]j)}(hjNh]hep_devs_created}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjHubji)}(hhh]h)}(h#endpoint child pseudo-devices existh]h#endpoint child pseudo-devices exist}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhjchKhjdubah}(h]h ]h"]h$]h&]uh1jhhjHubeh}(h]h ]h"]h$]h&]uh1jHhjchKhjubjI)}(hD``unregistering`` flag set when the interface is being unregistered h](jO)}(h``unregistering``h]j)}(hjh]h unregistering}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(h1flag set when the interface is being unregisteredh]h1flag set when the interface is being unregistered}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(hg``needs_remote_wakeup`` flag set when the driver requires remote-wakeup capability during autosuspend. h](jO)}(h``needs_remote_wakeup``h]j)}(hjh]hneeds_remote_wakeup}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(hNflag set when the driver requires remote-wakeup capability during autosuspend.h]hNflag set when the driver requires remote-wakeup capability during autosuspend.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(h```needs_altsetting0`` flag set when a set-interface request for altsetting 0 has been deferred. h](jO)}(h``needs_altsetting0``h]j)}(hjh]hneeds_altsetting0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(hIflag set when a set-interface request for altsetting 0 has been deferred.h]hIflag set when a set-interface request for altsetting 0 has been deferred.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(h``needs_binding`` flag set when the driver should be re-probed or unbound following a reset or suspend operation it doesn't support. h](jO)}(h``needs_binding``h]j)}(hj4h]h needs_binding}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhj.ubji)}(hhh]h)}(hrflag set when the driver should be re-probed or unbound following a reset or suspend operation it doesn't support.h]htflag set when the driver should be re-probed or unbound following a reset or suspend operation it doesn’t support.}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjJubah}(h]h ]h"]h$]h&]uh1jhhj.ubeh}(h]h ]h"]h$]h&]uh1jHhjIhKhjubjI)}(ht``resetting_device`` USB core reset the device, so use alt setting 0 as current; needs bandwidth alloc after reset. h](jO)}(h``resetting_device``h]j)}(hjnh]hresetting_device}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjhubji)}(hhh]h)}(h^USB core reset the device, so use alt setting 0 as current; needs bandwidth alloc after reset.h]h^USB core reset the device, so use alt setting 0 as current; needs bandwidth alloc after reset.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubah}(h]h ]h"]h$]h&]uh1jhhjhubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(h``authorized`` This allows to (de)authorize individual interfaces instead a whole device in contrast to the device authorization. h](jO)}(h``authorized``h]j)}(hjh]h authorized}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(hrThis allows to (de)authorize individual interfaces instead a whole device in contrast to the device authorization.h]hrThis allows to (de)authorize individual interfaces instead a whole device in contrast to the device authorization.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(hg``wireless_status`` if the USB device uses a receiver/emitter combo, whether the emitter is connected. h](jO)}(h``wireless_status``h]j)}(hjh]hwireless_status}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubji)}(hhh]h)}(hRif the USB device uses a receiver/emitter combo, whether the emitter is connected.h]hRif the USB device uses a receiver/emitter combo, whether the emitter is connected.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(hZ``wireless_status_work`` Used for scheduling wireless status changes from atomic context. h](jO)}(h``wireless_status_work``h]j)}(hj h]hwireless_status_work}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhj ubji)}(hhh]h)}(h@Used for scheduling wireless status changes from atomic context.h]h@Used for scheduling wireless status changes from atomic context.}(hj5 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhj2 ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj1 hKhjubjI)}(h+``dev`` driver model's view of this device h](jO)}(h``dev``h]j)}(hjV h]hdev}(hjX hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjT ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjP ubji)}(hhh]h)}(h"driver model's view of this deviceh]h$driver model’s view of this device}(hjo hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjk hKhjl ubah}(h]h ]h"]h$]h&]uh1jhhjP ubeh}(h]h ]h"]h$]h&]uh1jHhjk hKhjubjI)}(ht``usb_dev`` if an interface is bound to the USB major, this will point to the sysfs representation for that device. h](jO)}(h ``usb_dev``h]j)}(hj h]husb_dev}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhj ubji)}(hhh]h)}(hgif an interface is bound to the USB major, this will point to the sysfs representation for that device.h]hgif an interface is bound to the USB major, this will point to the sysfs representation for that device.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj hKhjubjI)}(h<``reset_ws`` Used for scheduling resets from atomic context.h](jO)}(h ``reset_ws``h]j)}(hj h]hreset_ws}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhj ubji)}(hhh]h)}(h/Used for scheduling resets from atomic context.h]h/Used for scheduling resets from atomic context.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj hKhjubeh}(h]h ]h"]h$]h&]uh1jChjkubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h**Description**h]j.)}(hj !h]h Description}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj !ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjghhubh)}(hXUSB device drivers attach to interfaces on a physical device. Each interface encapsulates a single high level function, such as feeding an audio stream to a speaker or reporting a change in a volume control. Many USB devices only have one interface. The protocol used to talk to an interface's endpoints can be defined in a usb "class" specification, or by a product's vendor. The (default) control endpoint is part of every interface, but is never listed among the interface's descriptors.h]hXUSB device drivers attach to interfaces on a physical device. Each interface encapsulates a single high level function, such as feeding an audio stream to a speaker or reporting a change in a volume control. Many USB devices only have one interface. The protocol used to talk to an interface’s endpoints can be defined in a usb “class” specification, or by a product’s vendor. The (default) control endpoint is part of every interface, but is never listed among the interface’s descriptors.}(hj"!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjghhubh)}(hThe driver that is bound to the interface can use standard driver model calls such as dev_get_drvdata() on the dev member of this structure.h]hThe driver that is bound to the interface can use standard driver model calls such as dev_get_drvdata() on the dev member of this structure.}(hj1!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjghhubh)}(hXEach interface may have alternate settings. The initial configuration of a device sets altsetting 0, but the device driver can change that setting using usb_set_interface(). Alternate settings are often used to control the use of periodic endpoints, such as by having different endpoints use different amounts of reserved USB bandwidth. All standards-conformant USB devices that use isochronous endpoints will use them in non-default settings.h]hXEach interface may have alternate settings. The initial configuration of a device sets altsetting 0, but the device driver can change that setting using usb_set_interface(). Alternate settings are often used to control the use of periodic endpoints, such as by having different endpoints use different amounts of reserved USB bandwidth. All standards-conformant USB devices that use isochronous endpoints will use them in non-default settings.}(hj@!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjghhubh)}(hXaThe USB specification says that alternate setting numbers must run from 0 to one less than the total number of alternate settings. But some devices manage to mess this up, and the structures aren't necessarily stored in numerical order anyhow. Use usb_altnum_to_altsetting() to look up an alternate setting in the altsetting array based on its number.h]hXcThe USB specification says that alternate setting numbers must run from 0 to one less than the total number of alternate settings. But some devices manage to mess this up, and the structures aren’t necessarily stored in numerical order anyhow. Use usb_altnum_to_altsetting() to look up an alternate setting in the altsetting array based on its number.}(hjO!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhKhjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_set_intfdata (C function)c.usb_set_intfdatahNtauh1jhjghhhjhNubj )}(hhh](j%)}(h>void usb_set_intfdata (struct usb_interface *intf, void *data)h]j+)}(h=void usb_set_intfdata(struct usb_interface *intf, void *data)h](jT)}(hvoidh]hvoid}(hjw!hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjs!hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hj!hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjs!hhhj!hMubj)}(husb_set_intfdatah]j)}(husb_set_intfdatah]husb_set_intfdata}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjs!hhhj!hMubj)}(h((struct usb_interface *intf, void *data)h](j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hj!hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj!ubjC)}(h h]h }(hj!hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj!ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj!modnameN classnameNjLjO)}jR]jU)}jHj!sbc.usb_set_intfdataasbuh1hhj!ubjC)}(h h]h }(hj!hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj!ubjs)}(hjvh]h*}(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj!ubj)}(hintfh]hintf}(hj "hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj!ubj)}(h void *datah](jT)}(hvoidh]hvoid}(hj&"hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj""ubjC)}(h h]h }(hj4"hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj""ubjs)}(hjvh]h*}(hjB"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj""ubj)}(hdatah]hdata}(hjO"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj""ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj!ubeh}(h]h ]h"]h$]h&]jjuh1jhjs!hhhj!hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjo!hhhj!hMubah}(h]jj!ah ](jjeh"]h$]h&]jj)jhuh1j$hj!hMhjl!hhubj)}(hhh]h)}(h0associate driver-specific data with an interfaceh]h0associate driver-specific data with an interface}(hjy"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjv"hhubah}(h]h ]h"]h$]h&]uh1jhjl!hhhj!hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj"jj"j j!j"uh1jhhhjghjhNubj$)}(hXq**Parameters** ``struct usb_interface *intf`` USB interface ``void *data`` driver data **Description** Drivers can use this function in their probe() callbacks to associate driver-specific data with an interface. Note that there is generally no need to clear the driver-data pointer even if some drivers do so for historical or implementation-specific reasons.h](h)}(h**Parameters**h]j.)}(hj"h]h Parameters}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj"ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM!hj"ubjD)}(hhh](jI)}(h-``struct usb_interface *intf`` USB interface h](jO)}(h``struct usb_interface *intf``h]j)}(hj"h]hstruct usb_interface *intf}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj"ubji)}(hhh]h)}(h USB interfaceh]h USB interface}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hMhj"ubah}(h]h ]h"]h$]h&]uh1jhhj"ubeh}(h]h ]h"]h$]h&]uh1jHhj"hMhj"ubjI)}(h``void *data`` driver data h](jO)}(h``void *data``h]j)}(hj"h]h void *data}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj"ubji)}(hhh]h)}(h driver datah]h driver data}(hj #hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hMhj #ubah}(h]h ]h"]h$]h&]uh1jhhj"ubeh}(h]h ]h"]h$]h&]uh1jHhj#hMhj"ubeh}(h]h ]h"]h$]h&]uh1jChj"ubh)}(h**Description**h]j.)}(hj.#h]h Description}(hj0#hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj,#ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM!hj"ubh)}(hmDrivers can use this function in their probe() callbacks to associate driver-specific data with an interface.h]hmDrivers can use this function in their probe() callbacks to associate driver-specific data with an interface.}(hjD#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM hj"ubh)}(hNote that there is generally no need to clear the driver-data pointer even if some drivers do so for historical or implementation-specific reasons.h]hNote that there is generally no need to clear the driver-data pointer even if some drivers do so for historical or implementation-specific reasons.}(hjS#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM#hj"ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_interface_cache (C struct)c.usb_interface_cachehNtauh1jhjghhhjhNubj )}(hhh](j%)}(husb_interface_cacheh]j+)}(hstruct usb_interface_cacheh](j1)}(hjh]hstruct}(hj#hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj~#hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM)ubjC)}(h h]h }(hj#hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj~#hhhj#hM)ubj)}(husb_interface_cacheh]j)}(hj|#h]husb_interface_cache}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj~#hhhj#hM)ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjz#hhhj#hM)ubah}(h]ju#ah ](jjeh"]h$]h&]jj)jhuh1j$hj#hM)hjw#hhubj)}(hhh]h)}(h.long-term representation of a device interfaceh]h.long-term representation of a device interface}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMUhj#hhubah}(h]h ]h"]h$]h&]uh1jhjw#hhhj#hM)ubeh}(h]h ](jstructeh"]h$]h&]jjjj#jj#j j!j"uh1jhhhjghjhNubj$)}(hX**Definition**:: struct usb_interface_cache { unsigned num_altsetting; struct kref ref; struct usb_host_interface altsetting[]; }; **Members** ``num_altsetting`` number of altsettings defined. ``ref`` reference counter. ``altsetting`` variable-length array of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will be in no particular order.h](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj#ubh:}(hj#hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMYhj#ubj )}(h}struct usb_interface_cache { unsigned num_altsetting; struct kref ref; struct usb_host_interface altsetting[]; };h]h}struct usb_interface_cache { unsigned num_altsetting; struct kref ref; struct usb_host_interface altsetting[]; };}hj$sbah}(h]h ]h"]h$]h&]jjuh1jhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM[hj#ubh)}(h **Members**h]j.)}(hj$h]hMembers}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj$ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMahj#ubjD)}(hhh](jI)}(h2``num_altsetting`` number of altsettings defined. h](jO)}(h``num_altsetting``h]j)}(hj1$h]hnum_altsetting}(hj3$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/$ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMWhj+$ubji)}(hhh]h)}(hnumber of altsettings defined.h]hnumber of altsettings defined.}(hjJ$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjF$hMWhjG$ubah}(h]h ]h"]h$]h&]uh1jhhj+$ubeh}(h]h ]h"]h$]h&]uh1jHhjF$hMWhj($ubjI)}(h``ref`` reference counter. h](jO)}(h``ref``h]j)}(hjj$h]href}(hjl$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjh$ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMXhjd$ubji)}(hhh]h)}(hreference counter.h]hreference counter.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hMXhj$ubah}(h]h ]h"]h$]h&]uh1jhhjd$ubeh}(h]h ]h"]h$]h&]uh1jHhj$hMXhj($ubjI)}(h``altsetting`` variable-length array of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will be in no particular order.h](jO)}(h``altsetting``h]j)}(hj$h]h altsetting}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMZhj$ubji)}(hhh]h)}(hvariable-length array of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will be in no particular order.h]hvariable-length array of interface structures, one for each alternate setting that may be selected. Each one includes a set of endpoint configurations. They will be in no particular order.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMYhj$ubah}(h]h ]h"]h$]h&]uh1jhhj$ubeh}(h]h ]h"]h$]h&]uh1jHhj$hMZhj($ubeh}(h]h ]h"]h$]h&]uh1jChj#ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h**Description**h]j.)}(hj$h]h Description}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj$ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM^hjghhubh)}(hXUThese structures persist for the lifetime of a usb_device, unlike struct usb_interface (which persists only as long as its configuration is installed). The altsetting arrays can be accessed through these structures at any time, permitting comparison of configurations and providing support for the /sys/kernel/debug/usb/devices pseudo-file.h]hXUThese structures persist for the lifetime of a usb_device, unlike struct usb_interface (which persists only as long as its configuration is installed). The altsetting arrays can be accessed through these structures at any time, permitting comparison of configurations and providing support for the /sys/kernel/debug/usb/devices pseudo-file.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM[hjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_host_config (C struct)c.usb_host_confighNtauh1jhjghhhjhNubj )}(hhh](j%)}(husb_host_configh]j+)}(hstruct usb_host_configh](j1)}(hjh]hstruct}(hj$%hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj %hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMdubjC)}(h h]h }(hj2%hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj %hhhj1%hMdubj)}(husb_host_configh]j)}(hj%h]husb_host_config}(hjD%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@%ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj %hhhj1%hMdubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj%hhhj1%hMdubah}(h]j%ah ](jjeh"]h$]h&]jj)jhuh1j$hj1%hMdhj%hhubj)}(hhh]h)}(h*representation of a device's configurationh]h,representation of a device’s configuration}(hjf%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMphjc%hhubah}(h]h ]h"]h$]h&]uh1jhj%hhhj1%hMdubeh}(h]h ](jstructeh"]h$]h&]jjjj~%jj~%j j!j"uh1jhhhjghjhNubj$)}(hX**Definition**:: struct usb_host_config { struct usb_config_descriptor desc; char *string; struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS]; struct usb_interface *interface[USB_MAXINTERFACES]; struct usb_interface_cache *intf_cache[USB_MAXINTERFACES]; unsigned char *extra; int extralen; }; **Members** ``desc`` the device's configuration descriptor. ``string`` pointer to the cached version of the iConfiguration string, if present for this configuration. ``intf_assoc`` list of any interface association descriptors in this config ``interface`` array of pointers to usb_interface structures, one for each interface in the configuration. The number of interfaces is stored in desc.bNumInterfaces. These pointers are valid only while the configuration is active. ``intf_cache`` array of pointers to usb_interface_cache structures, one for each interface in the configuration. These structures exist for the entire life of the device. ``extra`` pointer to buffer containing all extra descriptors associated with this configuration (those preceding the first interface descriptor). ``extralen`` length of the extra descriptors buffer.h](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj%ubh:}(hj%hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMthj%ubj )}(hX>struct usb_host_config { struct usb_config_descriptor desc; char *string; struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS]; struct usb_interface *interface[USB_MAXINTERFACES]; struct usb_interface_cache *intf_cache[USB_MAXINTERFACES]; unsigned char *extra; int extralen; };h]hX>struct usb_host_config { struct usb_config_descriptor desc; char *string; struct usb_interface_assoc_descriptor *intf_assoc[USB_MAXIADS]; struct usb_interface *interface[USB_MAXINTERFACES]; struct usb_interface_cache *intf_cache[USB_MAXINTERFACES]; unsigned char *extra; int extralen; };}hj%sbah}(h]h ]h"]h$]h&]jjuh1jhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMvhj%ubh)}(h **Members**h]j.)}(hj%h]hMembers}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj%ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj%ubjD)}(hhh](jI)}(h0``desc`` the device's configuration descriptor. h](jO)}(h``desc``h]j)}(hj%h]hdesc}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMrhj%ubji)}(hhh]h)}(h&the device's configuration descriptor.h]h(the device’s configuration descriptor.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hMrhj%ubah}(h]h ]h"]h$]h&]uh1jhhj%ubeh}(h]h ]h"]h$]h&]uh1jHhj%hMrhj%ubjI)}(hj``string`` pointer to the cached version of the iConfiguration string, if present for this configuration. h](jO)}(h ``string``h]j)}(hj &h]hstring}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj &ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMthj&ubji)}(hhh]h)}(h^pointer to the cached version of the iConfiguration string, if present for this configuration.h]h^pointer to the cached version of the iConfiguration string, if present for this configuration.}(hj%&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMshj"&ubah}(h]h ]h"]h$]h&]uh1jhhj&ubeh}(h]h ]h"]h$]h&]uh1jHhj!&hMthj%ubjI)}(hL``intf_assoc`` list of any interface association descriptors in this config h](jO)}(h``intf_assoc``h]j)}(hjF&h]h intf_assoc}(hjH&hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjD&ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMuhj@&ubji)}(hhh]h)}(hhub_delay + wHubDelay + tTPTransmissionDelay (40ns) Will be used as wValue for SetIsochDelay requests. ``use_generic_driver`` ask driver core to reprobe using the generic driver.h](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hj2(hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj.(ubh:}(hj.(hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMIhj*(ubj )}(hXstruct usb_device { int devnum; char devpath[16]; u32 route; enum usb_device_state state; enum usb_device_speed speed; unsigned int rx_lanes; unsigned int tx_lanes; enum usb_ssp_rate ssp_rate; struct usb_tt *tt; int ttport; unsigned int toggle[2]; struct usb_device *parent; struct usb_bus *bus; struct usb_host_endpoint ep0; struct device dev; struct usb_device_descriptor descriptor; struct usb_host_bos *bos; struct usb_host_config *config; struct usb_host_config *actconfig; struct usb_host_endpoint *ep_in[16]; struct usb_host_endpoint *ep_out[16]; char **rawdescriptors; unsigned short bus_mA; u8 portnum; u8 level; u8 devaddr; unsigned can_submit:1; unsigned persist_enabled:1; unsigned reset_in_progress:1; unsigned have_langid:1; unsigned authorized:1; unsigned authenticated:1; unsigned lpm_capable:1; unsigned lpm_devinit_allow:1; unsigned usb2_hw_lpm_capable:1; unsigned usb2_hw_lpm_besl_capable:1; unsigned usb2_hw_lpm_enabled:1; unsigned usb2_hw_lpm_allowed:1; unsigned usb3_lpm_u1_enabled:1; unsigned usb3_lpm_u2_enabled:1; int string_langid; char *product; char *manufacturer; char *serial; struct list_head filelist; int maxchild; u32 quirks; atomic_t urbnum; unsigned long active_duration; unsigned long connect_time; unsigned do_remote_wakeup:1; unsigned reset_resume:1; unsigned port_is_suspended:1; unsigned offload_pm_locked:1; int offload_usage; spinlock_t offload_lock; enum usb_link_tunnel_mode tunnel_mode; struct device_link *usb4_link; int slot_id; struct usb2_lpm_parameters l1_params; struct usb3_lpm_parameters u1_params; struct usb3_lpm_parameters u2_params; unsigned lpm_disable_count; u16 hub_delay; unsigned use_generic_driver:1; };h]hXstruct usb_device { int devnum; char devpath[16]; u32 route; enum usb_device_state state; enum usb_device_speed speed; unsigned int rx_lanes; unsigned int tx_lanes; enum usb_ssp_rate ssp_rate; struct usb_tt *tt; int ttport; unsigned int toggle[2]; struct usb_device *parent; struct usb_bus *bus; struct usb_host_endpoint ep0; struct device dev; struct usb_device_descriptor descriptor; struct usb_host_bos *bos; struct usb_host_config *config; struct usb_host_config *actconfig; struct usb_host_endpoint *ep_in[16]; struct usb_host_endpoint *ep_out[16]; char **rawdescriptors; unsigned short bus_mA; u8 portnum; u8 level; u8 devaddr; unsigned can_submit:1; unsigned persist_enabled:1; unsigned reset_in_progress:1; unsigned have_langid:1; unsigned authorized:1; unsigned authenticated:1; unsigned lpm_capable:1; unsigned lpm_devinit_allow:1; unsigned usb2_hw_lpm_capable:1; unsigned usb2_hw_lpm_besl_capable:1; unsigned usb2_hw_lpm_enabled:1; unsigned usb2_hw_lpm_allowed:1; unsigned usb3_lpm_u1_enabled:1; unsigned usb3_lpm_u2_enabled:1; int string_langid; char *product; char *manufacturer; char *serial; struct list_head filelist; int maxchild; u32 quirks; atomic_t urbnum; unsigned long active_duration; unsigned long connect_time; unsigned do_remote_wakeup:1; unsigned reset_resume:1; unsigned port_is_suspended:1; unsigned offload_pm_locked:1; int offload_usage; spinlock_t offload_lock; enum usb_link_tunnel_mode tunnel_mode; struct device_link *usb4_link; int slot_id; struct usb2_lpm_parameters l1_params; struct usb3_lpm_parameters u1_params; struct usb3_lpm_parameters u2_params; unsigned lpm_disable_count; u16 hub_delay; unsigned use_generic_driver:1; };}hjK(sbah}(h]h ]h"]h$]h&]jjuh1jhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMKhj*(ubh)}(h **Members**h]j.)}(hj\(h]hMembers}(hj^(hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjZ(ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj*(ubjD)}(hhh](jI)}(h/``devnum`` device number; address on a USB bus h](jO)}(h ``devnum``h]j)}(hj{(h]hdevnum}(hj}(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjy(ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMGhju(ubji)}(hhh]h)}(h#device number; address on a USB bush]h#device number; address on a USB bus}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hMGhj(ubah}(h]h ]h"]h$]h&]uh1jhhju(ubeh}(h]h ]h"]h$]h&]uh1jHhj(hMGhjr(ubjI)}(hC``devpath`` device ID string for use in messages (e.g., /port/...) h](jO)}(h ``devpath``h]j)}(hj(h]hdevpath}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMHhj(ubji)}(hhh]h)}(h6device ID string for use in messages (e.g., /port/...)h]h6device ID string for use in messages (e.g., /port/...)}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hMHhj(ubah}(h]h ]h"]h$]h&]uh1jhhj(ubeh}(h]h ]h"]h$]h&]uh1jHhj(hMHhjr(ubjI)}(h5``route`` tree topology hex string for use with xHCI h](jO)}(h ``route``h]j)}(hj(h]hroute}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMIhj(ubji)}(hhh]h)}(h*tree topology hex string for use with xHCIh]h*tree topology hex string for use with xHCI}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hMIhj)ubah}(h]h ]h"]h$]h&]uh1jhhj(ubeh}(h]h ]h"]h$]h&]uh1jHhj)hMIhjr(ubjI)}(h7``state`` device state: configured, not attached, etc. h](jO)}(h ``state``h]j)}(hj&)h]hstate}(hj()hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$)ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMJhj )ubji)}(hhh]h)}(h,device state: configured, not attached, etc.h]h,device state: configured, not attached, etc.}(hj?)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;)hMJhj<)ubah}(h]h ]h"]h$]h&]uh1jhhj )ubeh}(h]h ]h"]h$]h&]uh1jHhj;)hMJhjr(ubjI)}(h1``speed`` device speed: high/full/low (or error) h](jO)}(h ``speed``h]j)}(hj_)h]hspeed}(hja)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj])ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMKhjY)ubji)}(hhh]h)}(h&device speed: high/full/low (or error)h]h&device speed: high/full/low (or error)}(hjx)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjt)hMKhju)ubah}(h]h ]h"]h$]h&]uh1jhhjY)ubeh}(h]h ]h"]h$]h&]uh1jHhjt)hMKhjr(ubjI)}(hG``rx_lanes`` number of rx lanes in use, USB 3.2 adds dual-lane support h](jO)}(h ``rx_lanes``h]j)}(hj)h]hrx_lanes}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMLhj)ubji)}(hhh]h)}(h9number of rx lanes in use, USB 3.2 adds dual-lane supporth]h9number of rx lanes in use, USB 3.2 adds dual-lane support}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hMLhj)ubah}(h]h ]h"]h$]h&]uh1jhhj)ubeh}(h]h ]h"]h$]h&]uh1jHhj)hMLhjr(ubjI)}(hG``tx_lanes`` number of tx lanes in use, USB 3.2 adds dual-lane support h](jO)}(h ``tx_lanes``h]j)}(hj)h]htx_lanes}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMMhj)ubji)}(hhh]h)}(h9number of tx lanes in use, USB 3.2 adds dual-lane supporth]h9number of tx lanes in use, USB 3.2 adds dual-lane support}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hMMhj)ubah}(h]h ]h"]h$]h&]uh1jhhj)ubeh}(h]h ]h"]h$]h&]uh1jHhj)hMMhjr(ubjI)}(h?``ssp_rate`` SuperSpeed Plus phy signaling rate and lane count h](jO)}(h ``ssp_rate``h]j)}(hj *h]hssp_rate}(hj *hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMNhj*ubji)}(hhh]h)}(h1SuperSpeed Plus phy signaling rate and lane counth]h1SuperSpeed Plus phy signaling rate and lane count}(hj#*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hMNhj *ubah}(h]h ]h"]h$]h&]uh1jhhj*ubeh}(h]h ]h"]h$]h&]uh1jHhj*hMNhjr(ubjI)}(hP``tt`` Transaction Translator info; used with low/full speed dev, highspeed hub h](jO)}(h``tt``h]j)}(hjC*h]htt}(hjE*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjA*ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMOhj=*ubji)}(hhh]h)}(hHTransaction Translator info; used with low/full speed dev, highspeed hubh]hHTransaction Translator info; used with low/full speed dev, highspeed hub}(hj\*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjX*hMOhjY*ubah}(h]h ]h"]h$]h&]uh1jhhj=*ubeh}(h]h ]h"]h$]h&]uh1jHhjX*hMOhjr(ubjI)}(h&``ttport`` device port on that tt hub h](jO)}(h ``ttport``h]j)}(hj|*h]httport}(hj~*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjz*ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMPhjv*ubji)}(hhh]h)}(hdevice port on that tt hubh]hdevice port on that tt hub}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hMPhj*ubah}(h]h ]h"]h$]h&]uh1jhhjv*ubeh}(h]h ]h"]h$]h&]uh1jHhj*hMPhjr(ubjI)}(hK``toggle`` one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints h](jO)}(h ``toggle``h]j)}(hj*h]htoggle}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMQhj*ubji)}(hhh]h)}(h?one bit for each endpoint, with ([0] = IN, [1] = OUT) endpointsh]h?one bit for each endpoint, with ([0] = IN, [1] = OUT) endpoints}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hMQhj*ubah}(h]h ]h"]h$]h&]uh1jhhj*ubeh}(h]h ]h"]h$]h&]uh1jHhj*hMQhjr(ubjI)}(h*``parent`` our hub, unless we're the root h](jO)}(h ``parent``h]j)}(hj*h]hparent}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMRhj*ubji)}(hhh]h)}(hour hub, unless we're the rooth]h our hub, unless we’re the root}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hMRhj+ubah}(h]h ]h"]h$]h&]uh1jhhj*ubeh}(h]h ]h"]h$]h&]uh1jHhj+hMRhjr(ubjI)}(h``bus`` bus we're part of h](jO)}(h``bus``h]j)}(hj'+h]hbus}(hj)+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%+ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMShj!+ubji)}(hhh]h)}(hbus we're part ofh]hbus we’re part of}(hj@+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj<+hMShj=+ubah}(h]h ]h"]h$]h&]uh1jhhj!+ubeh}(h]h ]h"]h$]h&]uh1jHhj<+hMShjr(ubjI)}(h/``ep0`` endpoint 0 data (default control pipe) h](jO)}(h``ep0``h]j)}(hj`+h]hep0}(hjb+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^+ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMThjZ+ubji)}(hhh]h)}(h&endpoint 0 data (default control pipe)h]h&endpoint 0 data (default control pipe)}(hjy+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhju+hMThjv+ubah}(h]h ]h"]h$]h&]uh1jhhjZ+ubeh}(h]h ]h"]h$]h&]uh1jHhju+hMThjr(ubjI)}(h!``dev`` generic device interface h](jO)}(h``dev``h]j)}(hj+h]hdev}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMUhj+ubji)}(hhh]h)}(hgeneric device interfaceh]hgeneric device interface}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hMUhj+ubah}(h]h ]h"]h$]h&]uh1jhhj+ubeh}(h]h ]h"]h$]h&]uh1jHhj+hMUhjr(ubjI)}(h%``descriptor`` USB device descriptor h](jO)}(h``descriptor``h]j)}(hj+h]h descriptor}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMVhj+ubji)}(hhh]h)}(hUSB device descriptorh]hUSB device descriptor}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hMVhj+ubah}(h]h ]h"]h$]h&]uh1jhhj+ubeh}(h]h ]h"]h$]h&]uh1jHhj+hMVhjr(ubjI)}(h&``bos`` USB device BOS descriptor set h](jO)}(h``bos``h]j)}(hj ,h]hbos}(hj ,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ,ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMWhj,ubji)}(hhh]h)}(hUSB device BOS descriptor seth]hUSB device BOS descriptor set}(hj$,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ,hMWhj!,ubah}(h]h ]h"]h$]h&]uh1jhhj,ubeh}(h]h ]h"]h$]h&]uh1jHhj ,hMWhjr(ubjI)}(h'``config`` all of the device's configs h](jO)}(h ``config``h]j)}(hjD,h]hconfig}(hjF,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjB,ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMXhj>,ubji)}(hhh]h)}(hall of the device's configsh]hall of the device’s configs}(hj],hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjY,hMXhjZ,ubah}(h]h ]h"]h$]h&]uh1jhhj>,ubeh}(h]h ]h"]h$]h&]uh1jHhjY,hMXhjr(ubjI)}(h'``actconfig`` the active configuration h](jO)}(h ``actconfig``h]j)}(hj},h]h actconfig}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{,ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMYhjw,ubji)}(hhh]h)}(hthe active configurationh]hthe active configuration}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMYhj,ubah}(h]h ]h"]h$]h&]uh1jhhjw,ubeh}(h]h ]h"]h$]h&]uh1jHhj,hMYhjr(ubjI)}(h ``ep_in`` array of IN endpoints h](jO)}(h ``ep_in``h]j)}(hj,h]hep_in}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMZhj,ubji)}(hhh]h)}(harray of IN endpointsh]harray of IN endpoints}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMZhj,ubah}(h]h ]h"]h$]h&]uh1jhhj,ubeh}(h]h ]h"]h$]h&]uh1jHhj,hMZhjr(ubjI)}(h"``ep_out`` array of OUT endpoints h](jO)}(h ``ep_out``h]j)}(hj,h]hep_out}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM[hj,ubji)}(hhh]h)}(harray of OUT endpointsh]harray of OUT endpoints}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-hM[hj-ubah}(h]h ]h"]h$]h&]uh1jhhj,ubeh}(h]h ]h"]h$]h&]uh1jHhj-hM[hjr(ubjI)}(h3``rawdescriptors`` raw descriptors for each config h](jO)}(h``rawdescriptors``h]j)}(hj(-h]hrawdescriptors}(hj*-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj&-ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM\hj"-ubji)}(hhh]h)}(hraw descriptors for each configh]hraw descriptors for each config}(hjA-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=-hM\hj>-ubah}(h]h ]h"]h$]h&]uh1jhhj"-ubeh}(h]h ]h"]h$]h&]uh1jHhj=-hM\hjr(ubjI)}(h*``bus_mA`` Current available from the bus h](jO)}(h ``bus_mA``h]j)}(hja-h]hbus_mA}(hjc-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_-ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM]hj[-ubji)}(hhh]h)}(hCurrent available from the bush]hCurrent available from the bus}(hjz-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjv-hM]hjw-ubah}(h]h ]h"]h$]h&]uh1jhhj[-ubeh}(h]h ]h"]h$]h&]uh1jHhjv-hM]hjr(ubjI)}(h*``portnum`` parent port number (origin 1) h](jO)}(h ``portnum``h]j)}(hj-h]hportnum}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM^hj-ubji)}(hhh]h)}(hparent port number (origin 1)h]hparent port number (origin 1)}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-hM^hj-ubah}(h]h ]h"]h$]h&]uh1jhhj-ubeh}(h]h ]h"]h$]h&]uh1jHhj-hM^hjr(ubjI)}(h&``level`` number of USB hub ancestors h](jO)}(h ``level``h]j)}(hj-h]hlevel}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM_hj-ubji)}(hhh]h)}(hnumber of USB hub ancestorsh]hnumber of USB hub ancestors}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-hM_hj-ubah}(h]h ]h"]h$]h&]uh1jhhj-ubeh}(h]h ]h"]h$]h&]uh1jHhj-hM_hjr(ubjI)}(hI``devaddr`` device address, XHCI: assigned by HW, others: same as devnum h](jO)}(h ``devaddr``h]j)}(hj .h]hdevaddr}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj .ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM`hj.ubji)}(hhh]h)}(h/hMihjr(ubjI)}(h/``authenticated`` Crypto authentication passed h](jO)}(h``authenticated``h]j)}(hjc/h]h authenticated}(hje/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhja/ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMjhj]/ubji)}(hhh]h)}(hCrypto authentication passedh]hCrypto authentication passed}(hj|/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjx/hMjhjy/ubah}(h]h ]h"]h$]h&]uh1jhhj]/ubeh}(h]h ]h"]h$]h&]uh1jHhjx/hMjhjr(ubjI)}(h$``lpm_capable`` device supports LPM h](jO)}(h``lpm_capable``h]j)}(hj/h]h lpm_capable}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMmhj/ubji)}(hhh]h)}(hdevice supports LPMh]hdevice supports LPM}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hMmhj/ubah}(h]h ]h"]h$]h&]uh1jhhj/ubeh}(h]h ]h"]h$]h&]uh1jHhj/hMmhjr(ubjI)}(hP``lpm_devinit_allow`` Allow USB3 device initiated LPM, exit latency is in range h](jO)}(h``lpm_devinit_allow``h]j)}(hj/h]hlpm_devinit_allow}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMnhj/ubji)}(hhh]h)}(h9Allow USB3 device initiated LPM, exit latency is in rangeh]h9Allow USB3 device initiated LPM, exit latency is in range}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hMnhj/ubah}(h]h ]h"]h$]h&]uh1jhhj/ubeh}(h]h ]h"]h$]h&]uh1jHhj/hMnhjr(ubjI)}(h=``usb2_hw_lpm_capable`` device can perform USB2 hardware LPM h](jO)}(h``usb2_hw_lpm_capable``h]j)}(hj0h]husb2_hw_lpm_capable}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj 0ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMohj0ubji)}(hhh]h)}(h$device can perform USB2 hardware LPMh]h$device can perform USB2 hardware LPM}(hj'0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#0hMohj$0ubah}(h]h ]h"]h$]h&]uh1jhhj0ubeh}(h]h ]h"]h$]h&]uh1jHhj#0hMohjr(ubjI)}(hG``usb2_hw_lpm_besl_capable`` device can perform USB2 hardware BESL LPM h](jO)}(h``usb2_hw_lpm_besl_capable``h]j)}(hjG0h]husb2_hw_lpm_besl_capable}(hjI0hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjE0ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMphjA0ubji)}(hhh]h)}(h)device can perform USB2 hardware BESL LPMh]h)device can perform USB2 hardware BESL LPM}(hj`0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\0hMphj]0ubah}(h]h ]h"]h$]h&]uh1jhhjA0ubeh}(h]h ]h"]h$]h&]uh1jHhj\0hMphjr(ubjI)}(h5``usb2_hw_lpm_enabled`` USB2 hardware LPM is enabled h](jO)}(h``usb2_hw_lpm_enabled``h]j)}(hj0h]husb2_hw_lpm_enabled}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~0ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMqhjz0ubji)}(hhh]h)}(hUSB2 hardware LPM is enabledh]hUSB2 hardware LPM is enabled}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0hMqhj0ubah}(h]h ]h"]h$]h&]uh1jhhjz0ubeh}(h]h ]h"]h$]h&]uh1jHhj0hMqhjr(ubjI)}(hC``usb2_hw_lpm_allowed`` Userspace allows USB 2.0 LPM to be enabled h](jO)}(h``usb2_hw_lpm_allowed``h]j)}(hj0h]husb2_hw_lpm_allowed}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj0ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMrhj0ubji)}(hhh]h)}(h*Userspace allows USB 2.0 LPM to be enabledh]h*Userspace allows USB 2.0 LPM to be enabled}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0hMrhj0ubah}(h]h ]h"]h$]h&]uh1jhhj0ubeh}(h]h ]h"]h$]h&]uh1jHhj0hMrhjr(ubjI)}(h5``usb3_lpm_u1_enabled`` USB3 hardware U1 LPM enabled h](jO)}(h``usb3_lpm_u1_enabled``h]j)}(hj0h]husb3_lpm_u1_enabled}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj0ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMshj0ubji)}(hhh]h)}(hUSB3 hardware U1 LPM enabledh]hUSB3 hardware U1 LPM enabled}(hj 1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMshj1ubah}(h]h ]h"]h$]h&]uh1jhhj0ubeh}(h]h ]h"]h$]h&]uh1jHhj1hMshjr(ubjI)}(h5``usb3_lpm_u2_enabled`` USB3 hardware U2 LPM enabled h](jO)}(h``usb3_lpm_u2_enabled``h]j)}(hj+1h]husb3_lpm_u2_enabled}(hj-1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)1ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMthj%1ubji)}(hhh]h)}(hUSB3 hardware U2 LPM enabledh]hUSB3 hardware U2 LPM enabled}(hjD1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@1hMthjA1ubah}(h]h ]h"]h$]h&]uh1jhhj%1ubeh}(h]h ]h"]h$]h&]uh1jHhj@1hMthjr(ubjI)}(h*``string_langid`` language ID for strings h](jO)}(h``string_langid``h]j)}(hjd1h]h string_langid}(hjf1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjb1ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMuhj^1ubji)}(hhh]h)}(hlanguage ID for stringsh]hlanguage ID for strings}(hj}1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjy1hMuhjz1ubah}(h]h ]h"]h$]h&]uh1jhhj^1ubeh}(h]h ]h"]h$]h&]uh1jHhjy1hMuhjr(ubjI)}(h1``product`` iProduct string, if present (static) h](jO)}(h ``product``h]j)}(hj1h]hproduct}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMvhj1ubji)}(hhh]h)}(h$iProduct string, if present (static)h]h$iProduct string, if present (static)}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMvhj1ubah}(h]h ]h"]h$]h&]uh1jhhj1ubeh}(h]h ]h"]h$]h&]uh1jHhj1hMvhjr(ubjI)}(h;``manufacturer`` iManufacturer string, if present (static) h](jO)}(h``manufacturer``h]j)}(hj1h]h manufacturer}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMwhj1ubji)}(hhh]h)}(h)iManufacturer string, if present (static)h]h)iManufacturer string, if present (static)}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMwhj1ubah}(h]h ]h"]h$]h&]uh1jhhj1ubeh}(h]h ]h"]h$]h&]uh1jHhj1hMwhjr(ubjI)}(h5``serial`` iSerialNumber string, if present (static) h](jO)}(h ``serial``h]j)}(hj2h]hserial}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj 2ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMxhj 2ubji)}(hhh]h)}(h)iSerialNumber string, if present (static)h]h)iSerialNumber string, if present (static)}(hj(2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$2hMxhj%2ubah}(h]h ]h"]h$]h&]uh1jhhj 2ubeh}(h]h ]h"]h$]h&]uh1jHhj$2hMxhjr(ubjI)}(h6``filelist`` usbfs files that are open to this device h](jO)}(h ``filelist``h]j)}(hjH2h]hfilelist}(hjJ2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjF2ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMyhjB2ubji)}(hhh]h)}(h(usbfs files that are open to this deviceh]h(usbfs files that are open to this device}(hja2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]2hMyhj^2ubah}(h]h ]h"]h$]h&]uh1jhhjB2ubeh}(h]h ]h"]h$]h&]uh1jHhj]2hMyhjr(ubjI)}(h$``maxchild`` number of ports if hub h](jO)}(h ``maxchild``h]j)}(hj2h]hmaxchild}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMzhj{2ubji)}(hhh]h)}(hnumber of ports if hubh]hnumber of ports if hub}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2hMzhj2ubah}(h]h ]h"]h$]h&]uh1jhhj{2ubeh}(h]h ]h"]h$]h&]uh1jHhj2hMzhjr(ubjI)}(h&``quirks`` quirks of the whole device h](jO)}(h ``quirks``h]j)}(hj2h]hquirks}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM{hj2ubji)}(hhh]h)}(hquirks of the whole device h]hquirks of the whole device}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2hM{hj2ubah}(h]h ]h"]h$]h&]uh1jhhj2ubeh}(h]h ]h"]h$]h&]uh1jHhj2hM{hjr(ubjI)}(h9``urbnum`` number of URBs submitted for the whole device h](jO)}(h ``urbnum``h]j)}(hj2h]hurbnum}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM|hj2ubji)}(hhh]h)}(h-number of URBs submitted for the whole deviceh]h-number of URBs submitted for the whole device}(hj 3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3hM|hj 3ubah}(h]h ]h"]h$]h&]uh1jhhj2ubeh}(h]h ]h"]h$]h&]uh1jHhj3hM|hjr(ubjI)}(h7``active_duration`` total time device is not suspended h](jO)}(h``active_duration``h]j)}(hj,3h]hactive_duration}(hj.3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*3ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM}hj&3ubji)}(hhh]h)}(h"total time device is not suspendedh]h"total time device is not suspended}(hjE3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjA3hM}hjB3ubah}(h]h ]h"]h$]h&]uh1jhhj&3ubeh}(h]h ]h"]h$]h&]uh1jHhjA3hM}hjr(ubjI)}(h1``connect_time`` time device was first connected h](jO)}(h``connect_time``h]j)}(hje3h]h connect_time}(hjg3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjc3ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM~hj_3ubji)}(hhh]h)}(htime device was first connectedh]htime device was first connected}(hj~3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjz3hM~hj{3ubah}(h]h ]h"]h$]h&]uh1jhhj_3ubeh}(h]h ]h"]h$]h&]uh1jHhjz3hM~hjr(ubjI)}(h5``do_remote_wakeup`` remote wakeup should be enabled h](jO)}(h``do_remote_wakeup``h]j)}(hj3h]hdo_remote_wakeup}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj3ubji)}(hhh]h)}(hremote wakeup should be enabledh]hremote wakeup should be enabled}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3hMhj3ubah}(h]h ]h"]h$]h&]uh1jhhj3ubeh}(h]h ]h"]h$]h&]uh1jHhj3hMhjr(ubjI)}(h/``reset_resume`` needs reset instead of resume h](jO)}(h``reset_resume``h]j)}(hj3h]h reset_resume}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj3ubji)}(hhh]h)}(hneeds reset instead of resumeh]hneeds reset instead of resume}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3hMhj3ubah}(h]h ]h"]h$]h&]uh1jhhj3ubeh}(h]h ]h"]h$]h&]uh1jHhj3hMhjr(ubjI)}(h@``port_is_suspended`` the upstream port is suspended (L2 or U3) h](jO)}(h``port_is_suspended``h]j)}(hj4h]hport_is_suspended}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj 4ubji)}(hhh]h)}(h)the upstream port is suspended (L2 or U3)h]h)the upstream port is suspended (L2 or U3)}(hj)4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%4hMhj&4ubah}(h]h ]h"]h$]h&]uh1jhhj 4ubeh}(h]h ]h"]h$]h&]uh1jHhj%4hMhjr(ubjI)}(hL``offload_pm_locked`` prevents offload_usage changes during PM transitions. h](jO)}(h``offload_pm_locked``h]j)}(hjI4h]hoffload_pm_locked}(hjK4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjG4ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjC4ubji)}(hhh]h)}(h5prevents offload_usage changes during PM transitions.h]h5prevents offload_usage changes during PM transitions.}(hjb4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^4hMhj_4ubah}(h]h ]h"]h$]h&]uh1jhhjC4ubeh}(h]h ]h"]h$]h&]uh1jHhj^4hMhjr(ubjI)}(hM``offload_usage`` number of offload activities happening on this usb device. h](jO)}(h``offload_usage``h]j)}(hj4h]h offload_usage}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj|4ubji)}(hhh]h)}(h:number of offload activities happening on this usb device.h]h:number of offload activities happening on this usb device.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4hMhj4ubah}(h]h ]h"]h$]h&]uh1jhhj|4ubeh}(h]h ]h"]h$]h&]uh1jHhj4hMhjr(ubjI)}(h>``offload_lock`` protects offload_usage and offload_pm_locked h](jO)}(h``offload_lock``h]j)}(hj4h]h offload_lock}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj4ubji)}(hhh]h)}(h,protects offload_usage and offload_pm_lockedh]h,protects offload_usage and offload_pm_locked}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4hMhj4ubah}(h]h ]h"]h$]h&]uh1jhhj4ubeh}(h]h ]h"]h$]h&]uh1jHhj4hMhjr(ubjI)}(h8``tunnel_mode`` Connection native or tunneled over USB4 h](jO)}(h``tunnel_mode``h]j)}(hj4h]h tunnel_mode}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMkhj4ubji)}(hhh]h)}(h'Connection native or tunneled over USB4h]h'Connection native or tunneled over USB4}(hj 5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj 5hMkhj 5ubah}(h]h ]h"]h$]h&]uh1jhhj4ubeh}(h]h ]h"]h$]h&]uh1jHhj 5hMkhjr(ubjI)}(h5``usb4_link`` device link to the USB4 host interface h](jO)}(h ``usb4_link``h]j)}(hj-5h]h usb4_link}(hj/5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+5ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMlhj'5ubji)}(hhh]h)}(h&device link to the USB4 host interfaceh]h&device link to the USB4 host interface}(hjF5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjB5hMlhjC5ubah}(h]h ]h"]h$]h&]uh1jhhj'5ubeh}(h]h ]h"]h$]h&]uh1jHhjB5hMlhjr(ubjI)}(h%``slot_id`` Slot ID assigned by xHCI h](jO)}(h ``slot_id``h]j)}(hjf5h]hslot_id}(hjh5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjd5ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj`5ubji)}(hhh]h)}(hSlot ID assigned by xHCIh]hSlot ID assigned by xHCI}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{5hMhj|5ubah}(h]h ]h"]h$]h&]uh1jhhj`5ubeh}(h]h ]h"]h$]h&]uh1jHhj{5hMhjr(ubjI)}(hP``l1_params`` best effor service latency for USB2 L1 LPM state, and L1 timeout. h](jO)}(h ``l1_params``h]j)}(hj5h]h l1_params}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj5ubji)}(hhh]h)}(hAbest effor service latency for USB2 L1 LPM state, and L1 timeout.h]hAbest effor service latency for USB2 L1 LPM state, and L1 timeout.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hMhj5ubah}(h]h ]h"]h$]h&]uh1jhhj5ubeh}(h]h ]h"]h$]h&]uh1jHhj5hMhjr(ubjI)}(hO``u1_params`` exit latencies for USB3 U1 LPM state, and hub-initiated timeout. h](jO)}(h ``u1_params``h]j)}(hj5h]h u1_params}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj5ubji)}(hhh]h)}(h@exit latencies for USB3 U1 LPM state, and hub-initiated timeout.h]h@exit latencies for USB3 U1 LPM state, and hub-initiated timeout.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hMhj5ubah}(h]h ]h"]h$]h&]uh1jhhj5ubeh}(h]h ]h"]h$]h&]uh1jHhj5hMhjr(ubjI)}(hO``u2_params`` exit latencies for USB3 U2 LPM state, and hub-initiated timeout. h](jO)}(h ``u2_params``h]j)}(hj6h]h u2_params}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj 6ubji)}(hhh]h)}(h@exit latencies for USB3 U2 LPM state, and hub-initiated timeout.h]h@exit latencies for USB3 U2 LPM state, and hub-initiated timeout.}(hj*6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&6hMhj'6ubah}(h]h ]h"]h$]h&]uh1jhhj 6ubeh}(h]h ]h"]h$]h&]uh1jHhj&6hMhjr(ubjI)}(hX$``lpm_disable_count`` Ref count used by usb_disable_lpm() and usb_enable_lpm() to keep track of the number of functions that require USB 3.0 Link Power Management to be disabled for this usb_device. This count should only be manipulated by those functions, with the bandwidth_mutex is held. h](jO)}(h``lpm_disable_count``h]j)}(hjJ6h]hlpm_disable_count}(hjL6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjH6ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjD6ubji)}(hhh]h)}(hX Ref count used by usb_disable_lpm() and usb_enable_lpm() to keep track of the number of functions that require USB 3.0 Link Power Management to be disabled for this usb_device. This count should only be manipulated by those functions, with the bandwidth_mutex is held.h]hX Ref count used by usb_disable_lpm() and usb_enable_lpm() to keep track of the number of functions that require USB 3.0 Link Power Management to be disabled for this usb_device. This count should only be manipulated by those functions, with the bandwidth_mutex is held.}(hjc6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj`6ubah}(h]h ]h"]h$]h&]uh1jhhjD6ubeh}(h]h ]h"]h$]h&]uh1jHhj_6hMhjr(ubjI)}(h``hub_delay`` cached value consisting of: parent->hub_delay + wHubDelay + tTPTransmissionDelay (40ns) Will be used as wValue for SetIsochDelay requests. h](jO)}(h ``hub_delay``h]j)}(hj6h]h hub_delay}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj~6ubji)}(hhh]h)}(hcached value consisting of: parent->hub_delay + wHubDelay + tTPTransmissionDelay (40ns) Will be used as wValue for SetIsochDelay requests.h]hcached value consisting of: parent->hub_delay + wHubDelay + tTPTransmissionDelay (40ns) Will be used as wValue for SetIsochDelay requests.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj6ubah}(h]h ]h"]h$]h&]uh1jhhj~6ubeh}(h]h ]h"]h$]h&]uh1jHhj6hMhjr(ubjI)}(hK``use_generic_driver`` ask driver core to reprobe using the generic driver.h](jO)}(h``use_generic_driver``h]j)}(hj6h]huse_generic_driver}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj6ubji)}(hhh]h)}(h4ask driver core to reprobe using the generic driver.h]h4ask driver core to reprobe using the generic driver.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj6ubah}(h]h ]h"]h$]h&]uh1jhhj6ubeh}(h]h ]h"]h$]h&]uh1jHhj6hMhjr(ubeh}(h]h ]h"]h$]h&]uh1jChj*(ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h **Notes**h]j.)}(hj7h]hNotes}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj6ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(h[Usbcore drivers should not set usbdev->state directly. Instead use usb_set_device_state().h]h[Usbcore drivers should not set usbdev->state directly. Instead use usb_set_device_state().}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j usb_hub_for_each_child (C macro)c.usb_hub_for_each_childhNtauh1jhjghhhjhNubj )}(hhh](j%)}(husb_hub_for_each_childh]j+)}(husb_hub_for_each_childh]j)}(husb_hub_for_each_childh]j)}(hj97h]husb_hub_for_each_child}(hjC7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?7ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj;7hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubah}(h]h ]h"]h$]h&]jjjuh1j*jjhj77hhhjV7hMubah}(h]j27ah ](jjeh"]h$]h&]jj)jhuh1j$hjV7hMhj47hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj47hhhjV7hMubeh}(h]h ](jmacroeh"]h$]h&]jjjjo7jjo7j j!j"uh1jhhhjghjhNubh)}(h/``usb_hub_for_each_child (hdev, port1, child)``h]j)}(hju7h]h+usb_hub_for_each_child (hdev, port1, child)}(hjw7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjs7ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh block_quote)}(h*iterate over all child devices on the hub h]h)}(h)iterate over all child devices on the hubh]h)iterate over all child devices on the hub}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj7ubah}(h]h ]h"]h$]h&]uh1j7hj7hMhjghhubj$)}(h**Parameters** ``hdev`` USB device belonging to the usb hub ``port1`` portnum associated with child device ``child`` child device pointerh](h)}(h**Parameters**h]j.)}(hj7h]h Parameters}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj7ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj7ubjD)}(hhh](jI)}(h-``hdev`` USB device belonging to the usb hub h](jO)}(h``hdev``h]j)}(hj7h]hhdev}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj7ubji)}(hhh]h)}(h#USB device belonging to the usb hubh]h#USB device belonging to the usb hub}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7hMhj7ubah}(h]h ]h"]h$]h&]uh1jhhj7ubeh}(h]h ]h"]h$]h&]uh1jHhj7hMhj7ubjI)}(h/``port1`` portnum associated with child device h](jO)}(h ``port1``h]j)}(hj8h]hport1}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj7ubji)}(hhh]h)}(h$portnum associated with child deviceh]h$portnum associated with child device}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8hMhj8ubah}(h]h ]h"]h$]h&]uh1jhhj7ubeh}(h]h ]h"]h$]h&]uh1jHhj8hMhj7ubjI)}(h``child`` child device pointerh](jO)}(h ``child``h]j)}(hj=8h]hchild}(hj?8hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;8ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj78ubji)}(hhh]h)}(hchild device pointerh]hchild device pointer}(hjV8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjS8ubah}(h]h ]h"]h$]h&]uh1jhhj78ubeh}(h]h ]h"]h$]h&]uh1jHhjR8hMhj7ubeh}(h]h ]h"]h$]h&]uh1jChj7ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"usb_interface_claimed (C function)c.usb_interface_claimedhNtauh1jhjghhhjhNubj )}(hhh](j%)}(h7int usb_interface_claimed (struct usb_interface *iface)h]j+)}(h6int usb_interface_claimed(struct usb_interface *iface)h](jT)}(hinth]hint}(hj8hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj8hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hj8hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj8hhhj8hMubj)}(husb_interface_claimedh]j)}(husb_interface_claimedh]husb_interface_claimed}(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj8hhhj8hMubj)}(h(struct usb_interface *iface)h]j)}(hstruct usb_interface *ifaceh](j1)}(hjh]hstruct}(hj8hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj8ubjC)}(h h]h }(hj8hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj8ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj8modnameN classnameNjLjO)}jR]jU)}jHj8sbc.usb_interface_claimedasbuh1hhj8ubjC)}(h h]h }(hj9hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj8ubjs)}(hjvh]h*}(hj 9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj8ubj)}(hifaceh]hiface}(hj-9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj8ubah}(h]h ]h"]h$]h&]jjuh1jhj8hhhj8hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj8hhhj8hMubah}(h]j8ah ](jjeh"]h$]h&]jj)jhuh1j$hj8hMhj8hhubj)}(hhh]h)}(h(returns true iff an interface is claimedh]h(returns true iff an interface is claimed}(hjW9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjT9hhubah}(h]h ]h"]h$]h&]uh1jhj8hhhj8hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjo9jjo9j j!j"uh1jhhhjghjhNubj$)}(hXX**Parameters** ``struct usb_interface *iface`` the interface being checked **Return** ``true`` (nonzero) iff the interface is claimed, else ``false`` (zero). **Note** Callers must own the driver model's usb bus readlock. So driver probe() entries don't need extra locking, but other call contexts may need to explicitly claim that lock.h](h)}(h**Parameters**h]j.)}(hjy9h]h Parameters}(hj{9hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjw9ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjs9ubjD)}(hhh]jI)}(h<``struct usb_interface *iface`` the interface being checked h](jO)}(h``struct usb_interface *iface``h]j)}(hj9h]hstruct usb_interface *iface}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj9ubji)}(hhh]h)}(hthe interface being checkedh]hthe interface being checked}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hMhj9ubah}(h]h ]h"]h$]h&]uh1jhhj9ubeh}(h]h ]h"]h$]h&]uh1jHhj9hMhj9ubah}(h]h ]h"]h$]h&]uh1jChjs9ubh)}(h **Return**h]j.)}(hj9h]hReturn}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj9ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjs9ubh)}(hG``true`` (nonzero) iff the interface is claimed, else ``false`` (zero).h](j)}(h``true``h]htrue}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubh. (nonzero) iff the interface is claimed, else }(hj9hhhNhNubj)}(h ``false``h]hfalse}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubh (zero).}(hj9hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjs9ubh)}(h**Note**h]j.)}(hj:h]hNote}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj:ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjs9ubh)}(hCallers must own the driver model's usb bus readlock. So driver probe() entries don't need extra locking, but other call contexts may need to explicitly claim that lock.h]hCallers must own the driver model’s usb bus readlock. So driver probe() entries don’t need extra locking, but other call contexts may need to explicitly claim that lock.}(hj0:hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjs9ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_make_path (C function)c.usb_make_pathhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hBint usb_make_path (struct usb_device *dev, char *buf, size_t size)h]j+)}(hAint usb_make_path(struct usb_device *dev, char *buf, size_t size)h](jT)}(hinth]hint}(hj_:hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj[:hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hjn:hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj[:hhhjm:hMubj)}(h usb_make_pathh]j)}(h usb_make_pathh]h usb_make_path}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|:ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj[:hhhjm:hMubj)}(h0(struct usb_device *dev, char *buf, size_t size)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hj:hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj:ubjC)}(h h]h }(hj:hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj:ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj:modnameN classnameNjLjO)}jR]jU)}jHj:sbc.usb_make_pathasbuh1hhj:ubjC)}(h h]h }(hj:hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj:ubjs)}(hjvh]h*}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj:ubj)}(hdevh]hdev}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubj)}(h char *bufh](jT)}(hcharh]hchar}(hj;hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj ;ubjC)}(h h]h }(hj;hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ;ubjs)}(hjvh]h*}(hj*;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ;ubj)}(hbufh]hbuf}(hj7;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ;ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubj)}(h size_t sizeh](h)}(hhh]j)}(hsize_th]hsize_t}(hjS;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjP;ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjU;modnameN classnameNjLjO)}jR]j:c.usb_make_pathasbuh1hhjL;ubjC)}(h h]h }(hjq;hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjL;ubj)}(hsizeh]hsize}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjL;ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubeh}(h]h ]h"]h$]h&]jjuh1jhj[:hhhjm:hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjW:hhhjm:hMubah}(h]jR:ah ](jjeh"]h$]h&]jj)jhuh1j$hjm:hMhjT:hhubj)}(hhh]h)}(h*returns stable device path in the usb treeh]h*returns stable device path in the usb tree}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;hhubah}(h]h ]h"]h$]h&]uh1jhjT:hhhjm:hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj;jj;j j!j"uh1jhhhjghjhNubj$)}(hX**Parameters** ``struct usb_device *dev`` the device whose path is being constructed ``char *buf`` where to put the string ``size_t size`` how big is "buf"? **Return** Length of the string (> 0) or negative if size was too small. **Note** This identifier is intended to be "stable", reflecting physical paths in hardware such as physical bus addresses for host controllers or ports on USB hubs. That makes it stay the same until systems are physically reconfigured, by re-cabling a tree of USB devices or by moving USB host controllers. Adding and removing devices, including virtual root hubs in host controller driver modules, does not change these path identifiers; neither does rebooting or re-enumerating. These are more useful identifiers than changeable ("unstable") ones like bus numbers or device addresses. With a partial exception for devices connected to USB 2.0 root hubs, these identifiers are also predictable. So long as the device tree isn't changed, plugging any USB device into a given hub port always gives it the same path. Because of the use of "companion" controllers, devices connected to ports on USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are high speed, and a different one if they are full or low speed.h](h)}(h**Parameters**h]j.)}(hj;h]h Parameters}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj;ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;ubjD)}(hhh](jI)}(hF``struct usb_device *dev`` the device whose path is being constructed h](jO)}(h``struct usb_device *dev``h]j)}(hj;h]hstruct usb_device *dev}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;ubji)}(hhh]h)}(h*the device whose path is being constructedh]h*the device whose path is being constructed}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;hMhj<ubah}(h]h ]h"]h$]h&]uh1jhhj;ubeh}(h]h ]h"]h$]h&]uh1jHhj;hMhj;ubjI)}(h&``char *buf`` where to put the string h](jO)}(h ``char *buf``h]j)}(hj#<h]h char *buf}(hj%<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!<ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj<ubji)}(hhh]h)}(hwhere to put the stringh]hwhere to put the string}(hj<<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8<hMhj9<ubah}(h]h ]h"]h$]h&]uh1jhhj<ubeh}(h]h ]h"]h$]h&]uh1jHhj8<hMhj;ubjI)}(h"``size_t size`` how big is "buf"? h](jO)}(h``size_t size``h]j)}(hj\<h]h size_t size}(hj^<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZ<ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjV<ubji)}(hhh]h)}(hhow big is "buf"?h]hhow big is “buf”?}(hju<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjq<hMhjr<ubah}(h]h ]h"]h$]h&]uh1jhhjV<ubeh}(h]h ]h"]h$]h&]uh1jHhjq<hMhj;ubeh}(h]h ]h"]h$]h&]uh1jChj;ubh)}(h **Return**h]j.)}(hj<h]hReturn}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj<ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;ubh)}(h=Length of the string (> 0) or negative if size was too small.h]h=Length of the string (> 0) or negative if size was too small.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;ubh)}(h**Note**h]j.)}(hj<h]hNote}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj<ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;ubh)}(hXDThis identifier is intended to be "stable", reflecting physical paths in hardware such as physical bus addresses for host controllers or ports on USB hubs. That makes it stay the same until systems are physically reconfigured, by re-cabling a tree of USB devices or by moving USB host controllers. Adding and removing devices, including virtual root hubs in host controller driver modules, does not change these path identifiers; neither does rebooting or re-enumerating. These are more useful identifiers than changeable ("unstable") ones like bus numbers or device addresses.h]hXLThis identifier is intended to be “stable”, reflecting physical paths in hardware such as physical bus addresses for host controllers or ports on USB hubs. That makes it stay the same until systems are physically reconfigured, by re-cabling a tree of USB devices or by moving USB host controllers. Adding and removing devices, including virtual root hubs in host controller driver modules, does not change these path identifiers; neither does rebooting or re-enumerating. These are more useful identifiers than changeable (“unstable”) ones like bus numbers or device addresses.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;ubh)}(hXWith a partial exception for devices connected to USB 2.0 root hubs, these identifiers are also predictable. So long as the device tree isn't changed, plugging any USB device into a given hub port always gives it the same path. Because of the use of "companion" controllers, devices connected to ports on USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are high speed, and a different one if they are full or low speed.h]hXWith a partial exception for devices connected to USB 2.0 root hubs, these identifiers are also predictable. So long as the device tree isn’t changed, plugging any USB device into a given hub port always gives it the same path. Because of the use of “companion” controllers, devices connected to ports on USB 2.0 root hubs (EHCI host controllers) will get one path ID if they are high speed, and a different one if they are full or low speed.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jUSB_DEVICE (C macro) c.USB_DEVICEhNtauh1jhjghhhjhNubj )}(hhh](j%)}(h USB_DEVICEh]j+)}(h USB_DEVICEh]j)}(h USB_DEVICEh]j)}(hj =h]h USB_DEVICE}(hj=hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj=hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubah}(h]h ]h"]h$]h&]jjjuh1j*jjhj =hhhj)=hMubah}(h]j=ah ](jjeh"]h$]h&]jj)jhuh1j$hj)=hMhj=hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj=hhhj)=hMubeh}(h]h ](jmacroeh"]h$]h&]jjjjB=jjB=j j!j"uh1jhhhjghjhNubh)}(h``USB_DEVICE (vend, prod)``h]j)}(hjH=h]hUSB_DEVICE (vend, prod)}(hjJ=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjF=ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubj7)}(h-macro used to describe a specific usb device h]h)}(h,macro used to describe a specific usb deviceh]h,macro used to describe a specific usb device}(hjb=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj^=ubah}(h]h ]h"]h$]h&]uh1j7hjp=hMhjghhubj$)}(h**Parameters** ``vend`` the 16 bit USB Vendor ID ``prod`` the 16 bit USB Product ID **Description** This macro is used to create a struct usb_device_id that matches a specific device.h](h)}(h**Parameters**h]j.)}(hj}=h]h Parameters}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj{=ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjw=ubjD)}(hhh](jI)}(h"``vend`` the 16 bit USB Vendor ID h](jO)}(h``vend``h]j)}(hj=h]hvend}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj=ubji)}(hhh]h)}(hthe 16 bit USB Vendor IDh]hthe 16 bit USB Vendor ID}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hMhj=ubah}(h]h ]h"]h$]h&]uh1jhhj=ubeh}(h]h ]h"]h$]h&]uh1jHhj=hMhj=ubjI)}(h#``prod`` the 16 bit USB Product ID h](jO)}(h``prod``h]j)}(hj=h]hprod}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj=ubji)}(hhh]h)}(hthe 16 bit USB Product IDh]hthe 16 bit USB Product ID}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hMhj=ubah}(h]h ]h"]h$]h&]uh1jhhj=ubeh}(h]h ]h"]h$]h&]uh1jHhj=hMhj=ubeh}(h]h ]h"]h$]h&]uh1jChjw=ubh)}(h**Description**h]j.)}(hj>h]h Description}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj>ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjw=ubh)}(hSThis macro is used to create a struct usb_device_id that matches a specific device.h]hSThis macro is used to create a struct usb_device_id that matches a specific device.}(hj&>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjw=ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jUSB_DEVICE_VER (C macro)c.USB_DEVICE_VERhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hUSB_DEVICE_VERh]j+)}(hUSB_DEVICE_VERh]j)}(hUSB_DEVICE_VERh]j)}(hjO>h]hUSB_DEVICE_VER}(hjY>hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU>ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjQ>hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubah}(h]h ]h"]h$]h&]jjjuh1j*jjhjM>hhhjl>hMubah}(h]jH>ah ](jjeh"]h$]h&]jj)jhuh1j$hjl>hMhjJ>hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjJ>hhhjl>hMubeh}(h]h ](jmacroeh"]h$]h&]jjjj>jj>j j!j"uh1jhhhjghjhNubh)}(h'``USB_DEVICE_VER (vend, prod, lo, hi)``h]j)}(hj>h]h#USB_DEVICE_VER (vend, prod, lo, hi)}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubj7)}(h4describe a specific usb device with a version range h]h)}(h3describe a specific usb device with a version rangeh]h3describe a specific usb device with a version range}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj>ubah}(h]h ]h"]h$]h&]uh1j7hj>hMhjghhubj$)}(hX**Parameters** ``vend`` the 16 bit USB Vendor ID ``prod`` the 16 bit USB Product ID ``lo`` the bcdDevice_lo value ``hi`` the bcdDevice_hi value **Description** This macro is used to create a struct usb_device_id that matches a specific device, with a version range.h](h)}(h**Parameters**h]j.)}(hj>h]h Parameters}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj>ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj>ubjD)}(hhh](jI)}(h"``vend`` the 16 bit USB Vendor ID h](jO)}(h``vend``h]j)}(hj>h]hvend}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj>ubji)}(hhh]h)}(hthe 16 bit USB Vendor IDh]hthe 16 bit USB Vendor ID}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hMhj>ubah}(h]h ]h"]h$]h&]uh1jhhj>ubeh}(h]h ]h"]h$]h&]uh1jHhj>hMhj>ubjI)}(h#``prod`` the 16 bit USB Product ID h](jO)}(h``prod``h]j)}(hj?h]hprod}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj?ubji)}(hhh]h)}(hthe 16 bit USB Product IDh]hthe 16 bit USB Product ID}(hj1?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-?hMhj.?ubah}(h]h ]h"]h$]h&]uh1jhhj?ubeh}(h]h ]h"]h$]h&]uh1jHhj-?hMhj>ubjI)}(h``lo`` the bcdDevice_lo value h](jO)}(h``lo``h]j)}(hjQ?h]hlo}(hjS?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjO?ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjK?ubji)}(hhh]h)}(hthe bcdDevice_lo valueh]hthe bcdDevice_lo value}(hjj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjf?hMhjg?ubah}(h]h ]h"]h$]h&]uh1jhhjK?ubeh}(h]h ]h"]h$]h&]uh1jHhjf?hMhj>ubjI)}(h``hi`` the bcdDevice_hi value h](jO)}(h``hi``h]j)}(hj?h]hhi}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj?ubji)}(hhh]h)}(hthe bcdDevice_hi valueh]hthe bcdDevice_hi value}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj?hMhj?ubah}(h]h ]h"]h$]h&]uh1jhhj?ubeh}(h]h ]h"]h$]h&]uh1jHhj?hMhj>ubeh}(h]h ]h"]h$]h&]uh1jChj>ubh)}(h**Description**h]j.)}(hj?h]h Description}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj?ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj>ubh)}(hiThis macro is used to create a struct usb_device_id that matches a specific device, with a version range.h]hiThis macro is used to create a struct usb_device_id that matches a specific device, with a version range.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj>ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$USB_DEVICE_INTERFACE_CLASS (C macro)c.USB_DEVICE_INTERFACE_CLASShNtauh1jhjghhhjhNubj )}(hhh](j%)}(hUSB_DEVICE_INTERFACE_CLASSh]j+)}(hUSB_DEVICE_INTERFACE_CLASSh]j)}(hUSB_DEVICE_INTERFACE_CLASSh]j)}(hj@h]hUSB_DEVICE_INTERFACE_CLASS}(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj @ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj@hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM ubah}(h]h ]h"]h$]h&]jjjuh1j*jjhj@hhhj!@hM ubah}(h]j?ah ](jjeh"]h$]h&]jj)jhuh1j$hj!@hM hj?hhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj?hhhj!@hM ubeh}(h]h ](jmacroeh"]h$]h&]jjjj:@jj:@j j!j"uh1jhhhjghjhNubh)}(h/``USB_DEVICE_INTERFACE_CLASS (vend, prod, cl)``h]j)}(hj@@h]h+USB_DEVICE_INTERFACE_CLASS (vend, prod, cl)}(hjB@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>@ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubj7)}(h6describe a usb device with a specific interface class h]h)}(h5describe a usb device with a specific interface classh]h5describe a usb device with a specific interface class}(hjZ@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM hjV@ubah}(h]h ]h"]h$]h&]uh1j7hjh@hM hjghhubj$)}(h**Parameters** ``vend`` the 16 bit USB Vendor ID ``prod`` the 16 bit USB Product ID ``cl`` bInterfaceClass value **Description** This macro is used to create a struct usb_device_id that matches a specific interface class of devices.h](h)}(h**Parameters**h]j.)}(hju@h]h Parameters}(hjw@hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjs@ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjo@ubjD)}(hhh](jI)}(h"``vend`` the 16 bit USB Vendor ID h](jO)}(h``vend``h]j)}(hj@h]hvend}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj@ubji)}(hhh]h)}(hthe 16 bit USB Vendor IDh]hthe 16 bit USB Vendor ID}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@hMhj@ubah}(h]h ]h"]h$]h&]uh1jhhj@ubeh}(h]h ]h"]h$]h&]uh1jHhj@hMhj@ubjI)}(h#``prod`` the 16 bit USB Product ID h](jO)}(h``prod``h]j)}(hj@h]hprod}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj@ubji)}(hhh]h)}(hthe 16 bit USB Product IDh]hthe 16 bit USB Product ID}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@hMhj@ubah}(h]h ]h"]h$]h&]uh1jhhj@ubeh}(h]h ]h"]h$]h&]uh1jHhj@hMhj@ubjI)}(h``cl`` bInterfaceClass value h](jO)}(h``cl``h]j)}(hjAh]hcl}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjAubji)}(hhh]h)}(hbInterfaceClass valueh]hbInterfaceClass value}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhMhjAubah}(h]h ]h"]h$]h&]uh1jhhjAubeh}(h]h ]h"]h$]h&]uh1jHhjAhMhj@ubeh}(h]h ]h"]h$]h&]uh1jChjo@ubh)}(h**Description**h]j.)}(hjAAh]h Description}(hjCAhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj?Aubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjo@ubh)}(hgThis macro is used to create a struct usb_device_id that matches a specific interface class of devices.h]hgThis macro is used to create a struct usb_device_id that matches a specific interface class of devices.}(hjWAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjo@ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'USB_DEVICE_INTERFACE_PROTOCOL (C macro)c.USB_DEVICE_INTERFACE_PROTOCOLhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hUSB_DEVICE_INTERFACE_PROTOCOLh]j+)}(hUSB_DEVICE_INTERFACE_PROTOCOLh]j)}(hUSB_DEVICE_INTERFACE_PROTOCOLh]j)}(hjAh]hUSB_DEVICE_INTERFACE_PROTOCOL}(hjAhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjAubah}(h]h ](jjeh"]h$]h&]jjuh1jhjAhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubah}(h]h ]h"]h$]h&]jjjuh1j*jjhj~AhhhjAhMubah}(h]jyAah ](jjeh"]h$]h&]jj)jhuh1j$hjAhMhj{Ahhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhj{AhhhjAhMubeh}(h]h ](jmacroeh"]h$]h&]jjjjAjjAj j!j"uh1jhhhjghjhNubh)}(h2``USB_DEVICE_INTERFACE_PROTOCOL (vend, prod, pr)``h]j)}(hjAh]h.USB_DEVICE_INTERFACE_PROTOCOL (vend, prod, pr)}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubj7)}(h9describe a usb device with a specific interface protocol h]h)}(h8describe a usb device with a specific interface protocolh]h8describe a usb device with a specific interface protocol}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjAubah}(h]h ]h"]h$]h&]uh1j7hjAhMhjghhubj$)}(h**Parameters** ``vend`` the 16 bit USB Vendor ID ``prod`` the 16 bit USB Product ID ``pr`` bInterfaceProtocol value **Description** This macro is used to create a struct usb_device_id that matches a specific interface protocol of devices.h](h)}(h**Parameters**h]j.)}(hjAh]h Parameters}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjAubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM!hjAubjD)}(hhh](jI)}(h"``vend`` the 16 bit USB Vendor ID h](jO)}(h``vend``h]j)}(hjBh]hvend}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj Bubji)}(hhh]h)}(hthe 16 bit USB Vendor IDh]hthe 16 bit USB Vendor ID}(hj)BhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%BhMhj&Bubah}(h]h ]h"]h$]h&]uh1jhhj Bubeh}(h]h ]h"]h$]h&]uh1jHhj%BhMhjBubjI)}(h#``prod`` the 16 bit USB Product ID h](jO)}(h``prod``h]j)}(hjIBh]hprod}(hjKBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGBubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjCBubji)}(hhh]h)}(hthe 16 bit USB Product IDh]hthe 16 bit USB Product ID}(hjbBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^BhMhj_Bubah}(h]h ]h"]h$]h&]uh1jhhjCBubeh}(h]h ]h"]h$]h&]uh1jHhj^BhMhjBubjI)}(h ``pr`` bInterfaceProtocol value h](jO)}(h``pr``h]j)}(hjBh]hpr}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM hj|Bubji)}(hhh]h)}(hbInterfaceProtocol valueh]hbInterfaceProtocol value}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjBhM hjBubah}(h]h ]h"]h$]h&]uh1jhhj|Bubeh}(h]h ]h"]h$]h&]uh1jHhjBhM hjBubeh}(h]h ]h"]h$]h&]uh1jChjAubh)}(h**Description**h]j.)}(hjBh]h Description}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjBubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM"hjAubh)}(hjThis macro is used to create a struct usb_device_id that matches a specific interface protocol of devices.h]hjThis macro is used to create a struct usb_device_id that matches a specific interface protocol of devices.}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM!hjAubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j%USB_DEVICE_INTERFACE_NUMBER (C macro)c.USB_DEVICE_INTERFACE_NUMBERhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hUSB_DEVICE_INTERFACE_NUMBERh]j+)}(hUSB_DEVICE_INTERFACE_NUMBERh]j)}(hUSB_DEVICE_INTERFACE_NUMBERh]j)}(hjBh]hUSB_DEVICE_INTERFACE_NUMBER}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCubah}(h]h ](jjeh"]h$]h&]jjuh1jhjBhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM-ubah}(h]h ]h"]h$]h&]jjjuh1j*jjhjBhhhjChM-ubah}(h]jBah ](jjeh"]h$]h&]jj)jhuh1j$hjChM-hjBhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjBhhhjChM-ubeh}(h]h ](jmacroeh"]h$]h&]jjjj2Cjj2Cj j!j"uh1jhhhjghjhNubh)}(h1``USB_DEVICE_INTERFACE_NUMBER (vend, prod, num)``h]j)}(hj8Ch]h-USB_DEVICE_INTERFACE_NUMBER (vend, prod, num)}(hj:ChhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6Cubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM/hjghhubj7)}(h7describe a usb device with a specific interface number h]h)}(h6describe a usb device with a specific interface numberh]h6describe a usb device with a specific interface number}(hjRChhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM-hjNCubah}(h]h ]h"]h$]h&]uh1j7hj`ChM-hjghhubj$)}(h**Parameters** ``vend`` the 16 bit USB Vendor ID ``prod`` the 16 bit USB Product ID ``num`` bInterfaceNumber value **Description** This macro is used to create a struct usb_device_id that matches a specific interface number of devices.h](h)}(h**Parameters**h]j.)}(hjmCh]h Parameters}(hjoChhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjkCubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM1hjgCubjD)}(hhh](jI)}(h"``vend`` the 16 bit USB Vendor ID h](jO)}(h``vend``h]j)}(hjCh]hvend}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM.hjCubji)}(hhh]h)}(hthe 16 bit USB Vendor IDh]hthe 16 bit USB Vendor ID}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhjChM.hjCubah}(h]h ]h"]h$]h&]uh1jhhjCubeh}(h]h ]h"]h$]h&]uh1jHhjChM.hjCubjI)}(h#``prod`` the 16 bit USB Product ID h](jO)}(h``prod``h]j)}(hjCh]hprod}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM/hjCubji)}(hhh]h)}(hthe 16 bit USB Product IDh]hthe 16 bit USB Product ID}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhjChM/hjCubah}(h]h ]h"]h$]h&]uh1jhhjCubeh}(h]h ]h"]h$]h&]uh1jHhjChM/hjCubjI)}(h``num`` bInterfaceNumber value h](jO)}(h``num``h]j)}(hjCh]hnum}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM0hjCubji)}(hhh]h)}(hbInterfaceNumber valueh]hbInterfaceNumber value}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhM0hjDubah}(h]h ]h"]h$]h&]uh1jhhjCubeh}(h]h ]h"]h$]h&]uh1jHhjDhM0hjCubeh}(h]h ]h"]h$]h&]uh1jChjgCubh)}(h**Description**h]j.)}(hj9Dh]h Description}(hj;DhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj7Dubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM2hjgCubh)}(hhThis macro is used to create a struct usb_device_id that matches a specific interface number of devices.h]hhThis macro is used to create a struct usb_device_id that matches a specific interface number of devices.}(hjODhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM1hjgCubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jUSB_DEVICE_INFO (C macro)c.USB_DEVICE_INFOhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hUSB_DEVICE_INFOh]j+)}(hUSB_DEVICE_INFOh]j)}(hUSB_DEVICE_INFOh]j)}(hjxDh]hUSB_DEVICE_INFO}(hjDhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~Dubah}(h]h ](jjeh"]h$]h&]jjuh1jhjzDhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM=ubah}(h]h ]h"]h$]h&]jjjuh1j*jjhjvDhhhjDhM=ubah}(h]jqDah ](jjeh"]h$]h&]jj)jhuh1j$hjDhM=hjsDhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjsDhhhjDhM=ubeh}(h]h ](jmacroeh"]h$]h&]jjjjDjjDj j!j"uh1jhhhjghjhNubh)}(h ``USB_DEVICE_INFO (cl, sc, pr)``h]j)}(hjDh]hUSB_DEVICE_INFO (cl, sc, pr)}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM?hjghhubj7)}(h.macro used to describe a class of usb devices h]h)}(h-macro used to describe a class of usb devicesh]h-macro used to describe a class of usb devices}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM=hjDubah}(h]h ]h"]h$]h&]uh1j7hjDhM=hjghhubj$)}(h**Parameters** ``cl`` bDeviceClass value ``sc`` bDeviceSubClass value ``pr`` bDeviceProtocol value **Description** This macro is used to create a struct usb_device_id that matches a specific class of devices.h](h)}(h**Parameters**h]j.)}(hjDh]h Parameters}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjDubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMAhjDubjD)}(hhh](jI)}(h``cl`` bDeviceClass value h](jO)}(h``cl``h]j)}(hjEh]hcl}(hj EhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjEubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM>hjEubji)}(hhh]h)}(hbDeviceClass valueh]hbDeviceClass value}(hj!EhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjEhM>hjEubah}(h]h ]h"]h$]h&]uh1jhhjEubeh}(h]h ]h"]h$]h&]uh1jHhjEhM>hjDubjI)}(h``sc`` bDeviceSubClass value h](jO)}(h``sc``h]j)}(hjAEh]hsc}(hjCEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?Eubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM?hj;Eubji)}(hhh]h)}(hbDeviceSubClass valueh]hbDeviceSubClass value}(hjZEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVEhM?hjWEubah}(h]h ]h"]h$]h&]uh1jhhj;Eubeh}(h]h ]h"]h$]h&]uh1jHhjVEhM?hjDubjI)}(h``pr`` bDeviceProtocol value h](jO)}(h``pr``h]j)}(hjzEh]hpr}(hj|EhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjxEubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM@hjtEubji)}(hhh]h)}(hbDeviceProtocol valueh]hbDeviceProtocol value}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjEhM@hjEubah}(h]h ]h"]h$]h&]uh1jhhjtEubeh}(h]h ]h"]h$]h&]uh1jHhjEhM@hjDubeh}(h]h ]h"]h$]h&]uh1jChjDubh)}(h**Description**h]j.)}(hjEh]h Description}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjEubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMBhjDubh)}(h]This macro is used to create a struct usb_device_id that matches a specific class of devices.h]h]This macro is used to create a struct usb_device_id that matches a specific class of devices.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMAhjDubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jUSB_INTERFACE_INFO (C macro)c.USB_INTERFACE_INFOhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hUSB_INTERFACE_INFOh]j+)}(hUSB_INTERFACE_INFOh]j)}(hUSB_INTERFACE_INFOh]j)}(hjEh]hUSB_INTERFACE_INFO}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubah}(h]h ](jjeh"]h$]h&]jjuh1jhjEhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMLubah}(h]h ]h"]h$]h&]jjjuh1j*jjhjEhhhjFhMLubah}(h]jEah ](jjeh"]h$]h&]jj)jhuh1j$hjFhMLhjEhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjEhhhjFhMLubeh}(h]h ](jmacroeh"]h$]h&]jjjj*Fjj*Fj j!j"uh1jhhhjghjhNubh)}(h#``USB_INTERFACE_INFO (cl, sc, pr)``h]j)}(hj0Fh]hUSB_INTERFACE_INFO (cl, sc, pr)}(hj2FhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.Fubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMNhjghhubj7)}(h1macro used to describe a class of usb interfaces h]h)}(h0macro used to describe a class of usb interfacesh]h0macro used to describe a class of usb interfaces}(hjJFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMLhjFFubah}(h]h ]h"]h$]h&]uh1j7hjXFhMLhjghhubj$)}(h**Parameters** ``cl`` bInterfaceClass value ``sc`` bInterfaceSubClass value ``pr`` bInterfaceProtocol value **Description** This macro is used to create a struct usb_device_id that matches a specific class of interfaces.h](h)}(h**Parameters**h]j.)}(hjeFh]h Parameters}(hjgFhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjcFubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMPhj_FubjD)}(hhh](jI)}(h``cl`` bInterfaceClass value h](jO)}(h``cl``h]j)}(hjFh]hcl}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMMhj~Fubji)}(hhh]h)}(hbInterfaceClass valueh]hbInterfaceClass value}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhMMhjFubah}(h]h ]h"]h$]h&]uh1jhhj~Fubeh}(h]h ]h"]h$]h&]uh1jHhjFhMMhj{FubjI)}(h ``sc`` bInterfaceSubClass value h](jO)}(h``sc``h]j)}(hjFh]hsc}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMNhjFubji)}(hhh]h)}(hbInterfaceSubClass valueh]hbInterfaceSubClass value}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhMNhjFubah}(h]h ]h"]h$]h&]uh1jhhjFubeh}(h]h ]h"]h$]h&]uh1jHhjFhMNhj{FubjI)}(h ``pr`` bInterfaceProtocol value h](jO)}(h``pr``h]j)}(hjFh]hpr}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMOhjFubji)}(hhh]h)}(hbInterfaceProtocol valueh]hbInterfaceProtocol value}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj GhMOhj Gubah}(h]h ]h"]h$]h&]uh1jhhjFubeh}(h]h ]h"]h$]h&]uh1jHhj GhMOhj{Fubeh}(h]h ]h"]h$]h&]uh1jChj_Fubh)}(h**Description**h]j.)}(hj1Gh]h Description}(hj3GhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj/Gubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMQhj_Fubh)}(h`This macro is used to create a struct usb_device_id that matches a specific class of interfaces.h]h`This macro is used to create a struct usb_device_id that matches a specific class of interfaces.}(hjGGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMPhj_Fubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'USB_DEVICE_AND_INTERFACE_INFO (C macro)c.USB_DEVICE_AND_INTERFACE_INFOhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hUSB_DEVICE_AND_INTERFACE_INFOh]j+)}(hUSB_DEVICE_AND_INTERFACE_INFOh]j)}(hUSB_DEVICE_AND_INTERFACE_INFOh]j)}(hjpGh]hUSB_DEVICE_AND_INTERFACE_INFO}(hjzGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvGubah}(h]h ](jjeh"]h$]h&]jjuh1jhjrGhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM[ubah}(h]h ]h"]h$]h&]jjjuh1j*jjhjnGhhhjGhM[ubah}(h]jiGah ](jjeh"]h$]h&]jj)jhuh1j$hjGhM[hjkGhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjkGhhhjGhM[ubeh}(h]h ](jmacroeh"]h$]h&]jjjjGjjGj j!j"uh1jhhhjghjhNubh)}(h:``USB_DEVICE_AND_INTERFACE_INFO (vend, prod, cl, sc, pr)``h]j)}(hjGh]h6USB_DEVICE_AND_INTERFACE_INFO (vend, prod, cl, sc, pr)}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM]hjghhubj7)}(h>describe a specific usb device with a class of usb interfaces h]h)}(h=describe a specific usb device with a class of usb interfacesh]h=describe a specific usb device with a class of usb interfaces}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM[hjGubah}(h]h ]h"]h$]h&]uh1j7hjGhM[hjghhubj$)}(hX**Parameters** ``vend`` the 16 bit USB Vendor ID ``prod`` the 16 bit USB Product ID ``cl`` bInterfaceClass value ``sc`` bInterfaceSubClass value ``pr`` bInterfaceProtocol value **Description** This macro is used to create a struct usb_device_id that matches a specific device with a specific class of interfaces. This is especially useful when explicitly matching devices that have vendor specific bDeviceClass values, but standards-compliant interfaces.h](h)}(h**Parameters**h]j.)}(hjGh]h Parameters}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjGubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM_hjGubjD)}(hhh](jI)}(h"``vend`` the 16 bit USB Vendor ID h](jO)}(h``vend``h]j)}(hjHh]hvend}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM\hjGubji)}(hhh]h)}(hthe 16 bit USB Vendor IDh]hthe 16 bit USB Vendor ID}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHhM\hjHubah}(h]h ]h"]h$]h&]uh1jhhjGubeh}(h]h ]h"]h$]h&]uh1jHhjHhM\hjGubjI)}(h#``prod`` the 16 bit USB Product ID h](jO)}(h``prod``h]j)}(hj9Hh]hprod}(hj;HhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7Hubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM]hj3Hubji)}(hhh]h)}(hthe 16 bit USB Product IDh]hthe 16 bit USB Product ID}(hjRHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNHhM]hjOHubah}(h]h ]h"]h$]h&]uh1jhhj3Hubeh}(h]h ]h"]h$]h&]uh1jHhjNHhM]hjGubjI)}(h``cl`` bInterfaceClass value h](jO)}(h``cl``h]j)}(hjrHh]hcl}(hjtHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpHubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM^hjlHubji)}(hhh]h)}(hbInterfaceClass valueh]hbInterfaceClass value}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHhM^hjHubah}(h]h ]h"]h$]h&]uh1jhhjlHubeh}(h]h ]h"]h$]h&]uh1jHhjHhM^hjGubjI)}(h ``sc`` bInterfaceSubClass value h](jO)}(h``sc``h]j)}(hjHh]hsc}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjHubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM_hjHubji)}(hhh]h)}(hbInterfaceSubClass valueh]hbInterfaceSubClass value}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHhM_hjHubah}(h]h ]h"]h$]h&]uh1jhhjHubeh}(h]h ]h"]h$]h&]uh1jHhjHhM_hjGubjI)}(h ``pr`` bInterfaceProtocol value h](jO)}(h``pr``h]j)}(hjHh]hpr}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjHubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM`hjHubji)}(hhh]h)}(hbInterfaceProtocol valueh]hbInterfaceProtocol value}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHhM`hjHubah}(h]h ]h"]h$]h&]uh1jhhjHubeh}(h]h ]h"]h$]h&]uh1jHhjHhM`hjGubeh}(h]h ]h"]h$]h&]uh1jChjGubh)}(h**Description**h]j.)}(hjIh]h Description}(hj!IhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjIubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMbhjGubh)}(hwThis macro is used to create a struct usb_device_id that matches a specific device with a specific class of interfaces.h]hwThis macro is used to create a struct usb_device_id that matches a specific device with a specific class of interfaces.}(hj5IhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMahjGubh)}(hThis is especially useful when explicitly matching devices that have vendor specific bDeviceClass values, but standards-compliant interfaces.h]hThis is especially useful when explicitly matching devices that have vendor specific bDeviceClass values, but standards-compliant interfaces.}(hjDIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMdhjGubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'USB_VENDOR_AND_INTERFACE_INFO (C macro)c.USB_VENDOR_AND_INTERFACE_INFOhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hUSB_VENDOR_AND_INTERFACE_INFOh]j+)}(hUSB_VENDOR_AND_INTERFACE_INFOh]j)}(hUSB_VENDOR_AND_INTERFACE_INFOh]j)}(hjmIh]hUSB_VENDOR_AND_INTERFACE_INFO}(hjwIhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsIubah}(h]h ](jjeh"]h$]h&]jjuh1jhjoIhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMrubah}(h]h ]h"]h$]h&]jjjuh1j*jjhjkIhhhjIhMrubah}(h]jfIah ](jjeh"]h$]h&]jj)jhuh1j$hjIhMrhjhIhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjhIhhhjIhMrubeh}(h]h ](jmacroeh"]h$]h&]jjjjIjjIj j!j"uh1jhhhjghjhNubh)}(h4``USB_VENDOR_AND_INTERFACE_INFO (vend, cl, sc, pr)``h]j)}(hjIh]h0USB_VENDOR_AND_INTERFACE_INFO (vend, cl, sc, pr)}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMthjghhubj7)}(h>describe a specific usb vendor with a class of usb interfaces h]h)}(h=describe a specific usb vendor with a class of usb interfacesh]h=describe a specific usb vendor with a class of usb interfaces}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMrhjIubah}(h]h ]h"]h$]h&]uh1j7hjIhMrhjghhubj$)}(hX**Parameters** ``vend`` the 16 bit USB Vendor ID ``cl`` bInterfaceClass value ``sc`` bInterfaceSubClass value ``pr`` bInterfaceProtocol value **Description** This macro is used to create a struct usb_device_id that matches a specific vendor with a specific class of interfaces. This is especially useful when explicitly matching devices that have vendor specific bDeviceClass values, but standards-compliant interfaces.h](h)}(h**Parameters**h]j.)}(hjIh]h Parameters}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjIubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMvhjIubjD)}(hhh](jI)}(h"``vend`` the 16 bit USB Vendor ID h](jO)}(h``vend``h]j)}(hjIh]hvend}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMshjIubji)}(hhh]h)}(hthe 16 bit USB Vendor IDh]hthe 16 bit USB Vendor ID}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhMshjJubah}(h]h ]h"]h$]h&]uh1jhhjIubeh}(h]h ]h"]h$]h&]uh1jHhjJhMshjIubjI)}(h``cl`` bInterfaceClass value h](jO)}(h``cl``h]j)}(hj6Jh]hcl}(hj8JhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4Jubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMthj0Jubji)}(hhh]h)}(hbInterfaceClass valueh]hbInterfaceClass value}(hjOJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjKJhMthjLJubah}(h]h ]h"]h$]h&]uh1jhhj0Jubeh}(h]h ]h"]h$]h&]uh1jHhjKJhMthjIubjI)}(h ``sc`` bInterfaceSubClass value h](jO)}(h``sc``h]j)}(hjoJh]hsc}(hjqJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmJubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMuhjiJubji)}(hhh]h)}(hbInterfaceSubClass valueh]hbInterfaceSubClass value}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhMuhjJubah}(h]h ]h"]h$]h&]uh1jhhjiJubeh}(h]h ]h"]h$]h&]uh1jHhjJhMuhjIubjI)}(h ``pr`` bInterfaceProtocol value h](jO)}(h``pr``h]j)}(hjJh]hpr}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMvhjJubji)}(hhh]h)}(hbInterfaceProtocol valueh]hbInterfaceProtocol value}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhMvhjJubah}(h]h ]h"]h$]h&]uh1jhhjJubeh}(h]h ]h"]h$]h&]uh1jHhjJhMvhjIubeh}(h]h ]h"]h$]h&]uh1jChjIubh)}(h**Description**h]j.)}(hjJh]h Description}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjJubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMxhjIubh)}(hwThis macro is used to create a struct usb_device_id that matches a specific vendor with a specific class of interfaces.h]hwThis macro is used to create a struct usb_device_id that matches a specific vendor with a specific class of interfaces.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMwhjIubh)}(hThis is especially useful when explicitly matching devices that have vendor specific bDeviceClass values, but standards-compliant interfaces.h]hThis is especially useful when explicitly matching devices that have vendor specific bDeviceClass values, but standards-compliant interfaces.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMzhjIubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_driver (C struct) c.usb_driverhNtauh1jhjghhhjhNubj )}(hhh](j%)}(h usb_driverh]j+)}(hstruct usb_driverh](j1)}(hjh]hstruct}(hj7KhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj3KhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hjEKhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj3KhhhjDKhMubj)}(h usb_driverh]j)}(hj1Kh]h usb_driver}(hjWKhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjSKubah}(h]h ](jjeh"]h$]h&]jjuh1jhj3KhhhjDKhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj/KhhhjDKhMubah}(h]j*Kah ](jjeh"]h$]h&]jj)jhuh1j$hjDKhMhj,Khhubj)}(hhh]h)}(h*identifies USB interface driver to usbcoreh]h*identifies USB interface driver to usbcore}(hjyKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjvKhhubah}(h]h ]h"]h$]h&]uh1jhj,KhhhjDKhMubeh}(h]h ](jstructeh"]h$]h&]jjjjKjjKj j!j"uh1jhhhjghjhNubj$)}(hXw**Definition**:: struct usb_driver { const char *name; int (*probe) (struct usb_interface *intf, const struct usb_device_id *id); void (*disconnect) (struct usb_interface *intf); int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code, void *buf); int (*suspend) (struct usb_interface *intf, pm_message_t message); int (*resume) (struct usb_interface *intf); int (*reset_resume)(struct usb_interface *intf); int (*pre_reset)(struct usb_interface *intf); int (*post_reset)(struct usb_interface *intf); void (*shutdown)(struct usb_interface *intf); const struct usb_device_id *id_table; const struct attribute_group **dev_groups; struct usb_dynids dynids; struct device_driver driver; unsigned int no_dynamic_id:1; unsigned int supports_autosuspend:1; unsigned int disable_hub_initiated_lpm:1; unsigned int soft_unbind:1; }; **Members** ``name`` The driver name should be unique among USB drivers, and should normally be the same as the module name. ``probe`` Called to see if the driver is willing to manage a particular interface on a device. If it is, probe returns zero and uses usb_set_intfdata() to associate driver-specific data with the interface. It may also use usb_set_interface() to specify the appropriate altsetting. If unwilling to manage the interface, return -ENODEV, if genuine IO errors occurred, an appropriate negative errno value. The usb_device_id parameter is only valid during probe. ``disconnect`` Called when the interface is no longer accessible, usually because its device has been (or is being) disconnected or the driver module is being unloaded. ``unlocked_ioctl`` Used for drivers that want to talk to userspace through the "usbfs" filesystem. This lets devices provide ways to expose information to user space regardless of where they do (or don't) show up otherwise in the filesystem. ``suspend`` Called when the device is going to be suspended by the system either from system sleep or runtime suspend context. The return value will be ignored in system sleep context, so do NOT try to continue using the device if suspend fails in this case. Instead, let the resume or reset-resume routine recover from the failure. ``resume`` Called when the device is being resumed by the system. ``reset_resume`` Called when the suspended device has been reset instead of being resumed. ``pre_reset`` Called by usb_reset_device() when the device is about to be reset. This routine must not return until the driver has no active URBs for the device, and no more URBs may be submitted until the post_reset method is called. ``post_reset`` Called by usb_reset_device() after the device has been reset ``shutdown`` Called at shut-down time to quiesce the device. ``id_table`` USB drivers use ID table to support hotplugging. Export this with MODULE_DEVICE_TABLE(usb,...). This must be set or your driver's probe function will never get called. ``dev_groups`` Attributes attached to the device that will be created once it is bound to the driver. ``dynids`` used internally to hold the list of dynamically added device ids for this driver. ``driver`` The driver-model core driver structure. ``no_dynamic_id`` if set to 1, the USB core will not allow dynamic ids to be added to this driver by preventing the sysfs file from being created. ``supports_autosuspend`` if set to 0, the USB core will not allow autosuspend for interfaces bound to this driver. ``disable_hub_initiated_lpm`` if set to 1, the USB core will not allow hubs to initiate lower power link state transitions when an idle timeout occurs. Device-initiated USB 3.0 link PM will still be allowed. ``soft_unbind`` if set to 1, the USB core will not kill URBs and disable endpoints before calling the driver's disconnect method.h](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjKubh:}(hjKhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjKubj )}(hXzstruct usb_driver { const char *name; int (*probe) (struct usb_interface *intf, const struct usb_device_id *id); void (*disconnect) (struct usb_interface *intf); int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code, void *buf); int (*suspend) (struct usb_interface *intf, pm_message_t message); int (*resume) (struct usb_interface *intf); int (*reset_resume)(struct usb_interface *intf); int (*pre_reset)(struct usb_interface *intf); int (*post_reset)(struct usb_interface *intf); void (*shutdown)(struct usb_interface *intf); const struct usb_device_id *id_table; const struct attribute_group **dev_groups; struct usb_dynids dynids; struct device_driver driver; unsigned int no_dynamic_id:1; unsigned int supports_autosuspend:1; unsigned int disable_hub_initiated_lpm:1; unsigned int soft_unbind:1; };h]hXzstruct usb_driver { const char *name; int (*probe) (struct usb_interface *intf, const struct usb_device_id *id); void (*disconnect) (struct usb_interface *intf); int (*unlocked_ioctl) (struct usb_interface *intf, unsigned int code, void *buf); int (*suspend) (struct usb_interface *intf, pm_message_t message); int (*resume) (struct usb_interface *intf); int (*reset_resume)(struct usb_interface *intf); int (*pre_reset)(struct usb_interface *intf); int (*post_reset)(struct usb_interface *intf); void (*shutdown)(struct usb_interface *intf); const struct usb_device_id *id_table; const struct attribute_group **dev_groups; struct usb_dynids dynids; struct device_driver driver; unsigned int no_dynamic_id:1; unsigned int supports_autosuspend:1; unsigned int disable_hub_initiated_lpm:1; unsigned int soft_unbind:1; };}hjKsbah}(h]h ]h"]h$]h&]jjuh1jhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjKubh)}(h **Members**h]j.)}(hjKh]hMembers}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjKubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjKubjD)}(hhh](jI)}(hq``name`` The driver name should be unique among USB drivers, and should normally be the same as the module name. h](jO)}(h``name``h]j)}(hjKh]hname}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjKubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjKubji)}(hhh]h)}(hgThe driver name should be unique among USB drivers, and should normally be the same as the module name.h]hgThe driver name should be unique among USB drivers, and should normally be the same as the module name.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjKubah}(h]h ]h"]h$]h&]uh1jhhjKubeh}(h]h ]h"]h$]h&]uh1jHhjKhMhjKubjI)}(hX``probe`` Called to see if the driver is willing to manage a particular interface on a device. If it is, probe returns zero and uses usb_set_intfdata() to associate driver-specific data with the interface. It may also use usb_set_interface() to specify the appropriate altsetting. If unwilling to manage the interface, return -ENODEV, if genuine IO errors occurred, an appropriate negative errno value. The usb_device_id parameter is only valid during probe. h](jO)}(h ``probe``h]j)}(hj Lh]hprobe}(hj"LhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjLubji)}(hhh]h)}(hXCalled to see if the driver is willing to manage a particular interface on a device. If it is, probe returns zero and uses usb_set_intfdata() to associate driver-specific data with the interface. It may also use usb_set_interface() to specify the appropriate altsetting. If unwilling to manage the interface, return -ENODEV, if genuine IO errors occurred, an appropriate negative errno value. The usb_device_id parameter is only valid during probe.h]hXCalled to see if the driver is willing to manage a particular interface on a device. If it is, probe returns zero and uses usb_set_intfdata() to associate driver-specific data with the interface. It may also use usb_set_interface() to specify the appropriate altsetting. If unwilling to manage the interface, return -ENODEV, if genuine IO errors occurred, an appropriate negative errno value. The usb_device_id parameter is only valid during probe.}(hj9LhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj6Lubah}(h]h ]h"]h$]h&]uh1jhhjLubeh}(h]h ]h"]h$]h&]uh1jHhj5LhMhjKubjI)}(h``disconnect`` Called when the interface is no longer accessible, usually because its device has been (or is being) disconnected or the driver module is being unloaded. h](jO)}(h``disconnect``h]j)}(hjZLh]h disconnect}(hj\LhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjXLubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjTLubji)}(hhh]h)}(hCalled when the interface is no longer accessible, usually because its device has been (or is being) disconnected or the driver module is being unloaded.h]hCalled when the interface is no longer accessible, usually because its device has been (or is being) disconnected or the driver module is being unloaded.}(hjsLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjpLubah}(h]h ]h"]h$]h&]uh1jhhjTLubeh}(h]h ]h"]h$]h&]uh1jHhjoLhMhjKubjI)}(h``unlocked_ioctl`` Used for drivers that want to talk to userspace through the "usbfs" filesystem. This lets devices provide ways to expose information to user space regardless of where they do (or don't) show up otherwise in the filesystem. h](jO)}(h``unlocked_ioctl``h]j)}(hjLh]hunlocked_ioctl}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjLubji)}(hhh]h)}(hUsed for drivers that want to talk to userspace through the "usbfs" filesystem. This lets devices provide ways to expose information to user space regardless of where they do (or don't) show up otherwise in the filesystem.h]hUsed for drivers that want to talk to userspace through the “usbfs” filesystem. This lets devices provide ways to expose information to user space regardless of where they do (or don’t) show up otherwise in the filesystem.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjLubah}(h]h ]h"]h$]h&]uh1jhhjLubeh}(h]h ]h"]h$]h&]uh1jHhjLhMhjKubjI)}(hXM``suspend`` Called when the device is going to be suspended by the system either from system sleep or runtime suspend context. The return value will be ignored in system sleep context, so do NOT try to continue using the device if suspend fails in this case. Instead, let the resume or reset-resume routine recover from the failure. h](jO)}(h ``suspend``h]j)}(hjLh]hsuspend}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjLubji)}(hhh]h)}(hX@Called when the device is going to be suspended by the system either from system sleep or runtime suspend context. The return value will be ignored in system sleep context, so do NOT try to continue using the device if suspend fails in this case. Instead, let the resume or reset-resume routine recover from the failure.h]hX@Called when the device is going to be suspended by the system either from system sleep or runtime suspend context. The return value will be ignored in system sleep context, so do NOT try to continue using the device if suspend fails in this case. Instead, let the resume or reset-resume routine recover from the failure.}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjLubah}(h]h ]h"]h$]h&]uh1jhhjLubeh}(h]h ]h"]h$]h&]uh1jHhjLhMhjKubjI)}(hB``resume`` Called when the device is being resumed by the system. h](jO)}(h ``resume``h]j)}(hjMh]hresume}(hj MhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjMubji)}(hhh]h)}(h6Called when the device is being resumed by the system.h]h6Called when the device is being resumed by the system.}(hj!MhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjMhMhjMubah}(h]h ]h"]h$]h&]uh1jhhjMubeh}(h]h ]h"]h$]h&]uh1jHhjMhMhjKubjI)}(h[``reset_resume`` Called when the suspended device has been reset instead of being resumed. h](jO)}(h``reset_resume``h]j)}(hjAMh]h reset_resume}(hjCMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?Mubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;Mubji)}(hhh]h)}(hICalled when the suspended device has been reset instead of being resumed.h]hICalled when the suspended device has been reset instead of being resumed.}(hjZMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjWMubah}(h]h ]h"]h$]h&]uh1jhhj;Mubeh}(h]h ]h"]h$]h&]uh1jHhjVMhMhjKubjI)}(h``pre_reset`` Called by usb_reset_device() when the device is about to be reset. This routine must not return until the driver has no active URBs for the device, and no more URBs may be submitted until the post_reset method is called. h](jO)}(h ``pre_reset``h]j)}(hj{Mh]h pre_reset}(hj}MhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjyMubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjuMubji)}(hhh]h)}(hCalled by usb_reset_device() when the device is about to be reset. This routine must not return until the driver has no active URBs for the device, and no more URBs may be submitted until the post_reset method is called.h]hCalled by usb_reset_device() when the device is about to be reset. This routine must not return until the driver has no active URBs for the device, and no more URBs may be submitted until the post_reset method is called.}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjMubah}(h]h ]h"]h$]h&]uh1jhhjuMubeh}(h]h ]h"]h$]h&]uh1jHhjMhMhjKubjI)}(hL``post_reset`` Called by usb_reset_device() after the device has been reset h](jO)}(h``post_reset``h]j)}(hjMh]h post_reset}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjMubji)}(hhh]h)}(hNubah}(h]h ]h"]h$]h&]uh1jhhj"Nubeh}(h]h ]h"]h$]h&]uh1jHhj=NhMhjKubjI)}(hf``dev_groups`` Attributes attached to the device that will be created once it is bound to the driver. h](jO)}(h``dev_groups``h]j)}(hjbNh]h dev_groups}(hjdNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`Nubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj\Nubji)}(hhh]h)}(hVAttributes attached to the device that will be created once it is bound to the driver.h]hVAttributes attached to the device that will be created once it is bound to the driver.}(hj{NhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjxNubah}(h]h ]h"]h$]h&]uh1jhhj\Nubeh}(h]h ]h"]h$]h&]uh1jHhjwNhMhjKubjI)}(h]``dynids`` used internally to hold the list of dynamically added device ids for this driver. h](jO)}(h ``dynids``h]j)}(hjNh]hdynids}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjNubji)}(hhh]h)}(hQused internally to hold the list of dynamically added device ids for this driver.h]hQused internally to hold the list of dynamically added device ids for this driver.}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjNubah}(h]h ]h"]h$]h&]uh1jhhjNubeh}(h]h ]h"]h$]h&]uh1jHhjNhMhjKubjI)}(h3``driver`` The driver-model core driver structure. h](jO)}(h ``driver``h]j)}(hjNh]hdriver}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjNubji)}(hhh]h)}(h'The driver-model core driver structure.h]h'The driver-model core driver structure.}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNhMhjNubah}(h]h ]h"]h$]h&]uh1jhhjNubeh}(h]h ]h"]h$]h&]uh1jHhjNhMhjKubjI)}(h``no_dynamic_id`` if set to 1, the USB core will not allow dynamic ids to be added to this driver by preventing the sysfs file from being created. h](jO)}(h``no_dynamic_id``h]j)}(hjOh]h no_dynamic_id}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj Oubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj Oubji)}(hhh]h)}(hif set to 1, the USB core will not allow dynamic ids to be added to this driver by preventing the sysfs file from being created.h]hif set to 1, the USB core will not allow dynamic ids to be added to this driver by preventing the sysfs file from being created.}(hj(OhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj%Oubah}(h]h ]h"]h$]h&]uh1jhhj Oubeh}(h]h ]h"]h$]h&]uh1jHhj$OhMhjKubjI)}(hs``supports_autosuspend`` if set to 0, the USB core will not allow autosuspend for interfaces bound to this driver. h](jO)}(h``supports_autosuspend``h]j)}(hjIOh]hsupports_autosuspend}(hjKOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGOubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjCOubji)}(hhh]h)}(hYif set to 0, the USB core will not allow autosuspend for interfaces bound to this driver.h]hYif set to 0, the USB core will not allow autosuspend for interfaces bound to this driver.}(hjbOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj_Oubah}(h]h ]h"]h$]h&]uh1jhhjCOubeh}(h]h ]h"]h$]h&]uh1jHhj^OhMhjKubjI)}(h``disable_hub_initiated_lpm`` if set to 1, the USB core will not allow hubs to initiate lower power link state transitions when an idle timeout occurs. Device-initiated USB 3.0 link PM will still be allowed. h](jO)}(h``disable_hub_initiated_lpm``h]j)}(hjOh]hdisable_hub_initiated_lpm}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj}Oubji)}(hhh]h)}(hif set to 1, the USB core will not allow hubs to initiate lower power link state transitions when an idle timeout occurs. Device-initiated USB 3.0 link PM will still be allowed.h]hif set to 1, the USB core will not allow hubs to initiate lower power link state transitions when an idle timeout occurs. Device-initiated USB 3.0 link PM will still be allowed.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjOubah}(h]h ]h"]h$]h&]uh1jhhj}Oubeh}(h]h ]h"]h$]h&]uh1jHhjOhMhjKubjI)}(h``soft_unbind`` if set to 1, the USB core will not kill URBs and disable endpoints before calling the driver's disconnect method.h](jO)}(h``soft_unbind``h]j)}(hjOh]h soft_unbind}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjOubji)}(hhh]h)}(hqif set to 1, the USB core will not kill URBs and disable endpoints before calling the driver's disconnect method.h]hsif set to 1, the USB core will not kill URBs and disable endpoints before calling the driver’s disconnect method.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhMhjOubah}(h]h ]h"]h$]h&]uh1jhhjOubeh}(h]h ]h"]h$]h&]uh1jHhjOhMhjKubeh}(h]h ]h"]h$]h&]uh1jChjKubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h**Description**h]j.)}(hjOh]h Description}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjOubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hUSB interface drivers must provide a name, probe() and disconnect() methods, and an id_table. Other driver fields are optional.h]hUSB interface drivers must provide a name, probe() and disconnect() methods, and an id_table. Other driver fields are optional.}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hThe id_table is used in hotplugging. It holds a set of descriptors, and specialized data may be associated with each entry. That table is used by both user and kernel mode hotplugging support.h]hThe id_table is used in hotplugging. It holds a set of descriptors, and specialized data may be associated with each entry. That table is used by both user and kernel mode hotplugging support.}(hj$PhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hXThe probe() and disconnect() methods are called in a context where they can sleep, but they should avoid abusing the privilege. Most work to connect to a device should be done when the device is opened, and undone at the last close. The disconnect code needs to address concurrency issues with respect to open() and close() methods, as well as forcing all pending I/O requests to complete (by unlinking them as necessary, and blocking until the unlinks complete).h]hXThe probe() and disconnect() methods are called in a context where they can sleep, but they should avoid abusing the privilege. Most work to connect to a device should be done when the device is opened, and undone at the last close. The disconnect code needs to address concurrency issues with respect to open() and close() methods, as well as forcing all pending I/O requests to complete (by unlinking them as necessary, and blocking until the unlinks complete).}(hj3PhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_device_driver (C struct)c.usb_device_driverhNtauh1jhjghhhjhNubj )}(hhh](j%)}(husb_device_driverh]j+)}(hstruct usb_device_driverh](j1)}(hjh]hstruct}(hj[PhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjWPhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hjiPhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjWPhhhjhPhMubj)}(husb_device_driverh]j)}(hjUPh]husb_device_driver}(hj{PhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjwPubah}(h]h ](jjeh"]h$]h&]jjuh1jhjWPhhhjhPhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjSPhhhjhPhMubah}(h]jNPah ](jjeh"]h$]h&]jj)jhuh1j$hjhPhMhjPPhhubj)}(hhh]h)}(h'identifies USB device driver to usbcoreh]h'identifies USB device driver to usbcore}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjPhhubah}(h]h ]h"]h$]h&]uh1jhjPPhhhjhPhMubeh}(h]h ](jstructeh"]h$]h&]jjjjPjjPj j!j"uh1jhhhjghjhNubj$)}(hX**Definition**:: struct usb_device_driver { const char *name; bool (*match) (struct usb_device *udev); int (*probe) (struct usb_device *udev); void (*disconnect) (struct usb_device *udev); int (*suspend) (struct usb_device *udev, pm_message_t message); int (*resume) (struct usb_device *udev, pm_message_t message); int (*choose_configuration) (struct usb_device *udev); const struct attribute_group **dev_groups; struct device_driver driver; const struct usb_device_id *id_table; unsigned int supports_autosuspend:1; unsigned int generic_subclass:1; }; **Members** ``name`` The driver name should be unique among USB drivers, and should normally be the same as the module name. ``match`` If set, used for better device/driver matching. ``probe`` Called to see if the driver is willing to manage a particular device. If it is, probe returns zero and uses dev_set_drvdata() to associate driver-specific data with the device. If unwilling to manage the device, return a negative errno value. ``disconnect`` Called when the device is no longer accessible, usually because it has been (or is being) disconnected or the driver's module is being unloaded. ``suspend`` Called when the device is going to be suspended by the system. ``resume`` Called when the device is being resumed by the system. ``choose_configuration`` If non-NULL, called instead of the default usb_choose_configuration(). If this returns an error then we'll go on to call the normal usb_choose_configuration(). ``dev_groups`` Attributes attached to the device that will be created once it is bound to the driver. ``driver`` The driver-model core driver structure. ``id_table`` used with **match\(\)** to select better matching driver at probe() time. ``supports_autosuspend`` if set to 0, the USB core will not allow autosuspend for devices bound to this driver. ``generic_subclass`` if set to 1, the generic USB driver's probe, disconnect, resume and suspend functions will be called in addition to the driver's own, so this part of the setup does not need to be replicated.h](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjPubh:}(hjPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjPubj )}(hXHstruct usb_device_driver { const char *name; bool (*match) (struct usb_device *udev); int (*probe) (struct usb_device *udev); void (*disconnect) (struct usb_device *udev); int (*suspend) (struct usb_device *udev, pm_message_t message); int (*resume) (struct usb_device *udev, pm_message_t message); int (*choose_configuration) (struct usb_device *udev); const struct attribute_group **dev_groups; struct device_driver driver; const struct usb_device_id *id_table; unsigned int supports_autosuspend:1; unsigned int generic_subclass:1; };h]hXHstruct usb_device_driver { const char *name; bool (*match) (struct usb_device *udev); int (*probe) (struct usb_device *udev); void (*disconnect) (struct usb_device *udev); int (*suspend) (struct usb_device *udev, pm_message_t message); int (*resume) (struct usb_device *udev, pm_message_t message); int (*choose_configuration) (struct usb_device *udev); const struct attribute_group **dev_groups; struct device_driver driver; const struct usb_device_id *id_table; unsigned int supports_autosuspend:1; unsigned int generic_subclass:1; };}hjPsbah}(h]h ]h"]h$]h&]jjuh1jhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjPubh)}(h **Members**h]j.)}(hjPh]hMembers}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjPubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjPubjD)}(hhh](jI)}(hq``name`` The driver name should be unique among USB drivers, and should normally be the same as the module name. h](jO)}(h``name``h]j)}(hj Qh]hname}(hj QhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjQubji)}(hhh]h)}(hgThe driver name should be unique among USB drivers, and should normally be the same as the module name.h]hgThe driver name should be unique among USB drivers, and should normally be the same as the module name.}(hj#QhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj Qubah}(h]h ]h"]h$]h&]uh1jhhjQubeh}(h]h ]h"]h$]h&]uh1jHhjQhMhjQubjI)}(h:``match`` If set, used for better device/driver matching. h](jO)}(h ``match``h]j)}(hjDQh]hmatch}(hjFQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBQubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj>Qubji)}(hhh]h)}(h/If set, used for better device/driver matching.h]h/If set, used for better device/driver matching.}(hj]QhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYQhMhjZQubah}(h]h ]h"]h$]h&]uh1jhhj>Qubeh}(h]h ]h"]h$]h&]uh1jHhjYQhMhjQubjI)}(h``probe`` Called to see if the driver is willing to manage a particular device. If it is, probe returns zero and uses dev_set_drvdata() to associate driver-specific data with the device. If unwilling to manage the device, return a negative errno value. h](jO)}(h ``probe``h]j)}(hj}Qh]hprobe}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{Qubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjwQubji)}(hhh]h)}(hCalled to see if the driver is willing to manage a particular device. If it is, probe returns zero and uses dev_set_drvdata() to associate driver-specific data with the device. If unwilling to manage the device, return a negative errno value.h]hCalled to see if the driver is willing to manage a particular device. If it is, probe returns zero and uses dev_set_drvdata() to associate driver-specific data with the device. If unwilling to manage the device, return a negative errno value.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjQubah}(h]h ]h"]h$]h&]uh1jhhjwQubeh}(h]h ]h"]h$]h&]uh1jHhjQhMhjQubjI)}(h``disconnect`` Called when the device is no longer accessible, usually because it has been (or is being) disconnected or the driver's module is being unloaded. h](jO)}(h``disconnect``h]j)}(hjQh]h disconnect}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM hjQubji)}(hhh]h)}(hCalled when the device is no longer accessible, usually because it has been (or is being) disconnected or the driver's module is being unloaded.h]hCalled when the device is no longer accessible, usually because it has been (or is being) disconnected or the driver’s module is being unloaded.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjQubah}(h]h ]h"]h$]h&]uh1jhhjQubeh}(h]h ]h"]h$]h&]uh1jHhjQhM hjQubjI)}(hK``suspend`` Called when the device is going to be suspended by the system. h](jO)}(h ``suspend``h]j)}(hjQh]hsuspend}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM hjQubji)}(hhh]h)}(h>Called when the device is going to be suspended by the system.h]h>Called when the device is going to be suspended by the system.}(hj RhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhM hjRubah}(h]h ]h"]h$]h&]uh1jhhjQubeh}(h]h ]h"]h$]h&]uh1jHhjRhM hjQubjI)}(hB``resume`` Called when the device is being resumed by the system. h](jO)}(h ``resume``h]j)}(hj*Rh]hresume}(hj,RhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(Rubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM hj$Rubji)}(hhh]h)}(h6Called when the device is being resumed by the system.h]h6Called when the device is being resumed by the system.}(hjCRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj?RhM hj@Rubah}(h]h ]h"]h$]h&]uh1jhhj$Rubeh}(h]h ]h"]h$]h&]uh1jHhj?RhM hjQubjI)}(h``choose_configuration`` If non-NULL, called instead of the default usb_choose_configuration(). If this returns an error then we'll go on to call the normal usb_choose_configuration(). h](jO)}(h``choose_configuration``h]j)}(hjcRh]hchoose_configuration}(hjeRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaRubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj]Rubji)}(hhh]h)}(hIf non-NULL, called instead of the default usb_choose_configuration(). If this returns an error then we'll go on to call the normal usb_choose_configuration().h]hIf non-NULL, called instead of the default usb_choose_configuration(). If this returns an error then we’ll go on to call the normal usb_choose_configuration().}(hj|RhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM hjyRubah}(h]h ]h"]h$]h&]uh1jhhj]Rubeh}(h]h ]h"]h$]h&]uh1jHhjxRhMhjQubjI)}(hf``dev_groups`` Attributes attached to the device that will be created once it is bound to the driver. h](jO)}(h``dev_groups``h]j)}(hjRh]h dev_groups}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjRubji)}(hhh]h)}(hVAttributes attached to the device that will be created once it is bound to the driver.h]hVAttributes attached to the device that will be created once it is bound to the driver.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjRubah}(h]h ]h"]h$]h&]uh1jhhjRubeh}(h]h ]h"]h$]h&]uh1jHhjRhMhjQubjI)}(h3``driver`` The driver-model core driver structure. h](jO)}(h ``driver``h]j)}(hjRh]hdriver}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjRubji)}(hhh]h)}(h'The driver-model core driver structure.h]h'The driver-model core driver structure.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhMhjRubah}(h]h ]h"]h$]h&]uh1jhhjRubeh}(h]h ]h"]h$]h&]uh1jHhjRhMhjQubjI)}(hW``id_table`` used with **match\(\)** to select better matching driver at probe() time. h](jO)}(h ``id_table``h]j)}(hjSh]hid_table}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj Subji)}(hhh]h)}(hIused with **match\(\)** to select better matching driver at probe() time.h](h used with }(hj)ShhhNhNubj.)}(h **match\(\)**h]h match()}(hj1ShhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj)Subh2 to select better matching driver at probe() time.}(hj)ShhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj&Subah}(h]h ]h"]h$]h&]uh1jhhj Subeh}(h]h ]h"]h$]h&]uh1jHhj%ShMhjQubjI)}(hp``supports_autosuspend`` if set to 0, the USB core will not allow autosuspend for devices bound to this driver. h](jO)}(h``supports_autosuspend``h]j)}(hj\Sh]hsupports_autosuspend}(hj^ShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZSubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjVSubji)}(hhh]h)}(hVif set to 0, the USB core will not allow autosuspend for devices bound to this driver.h]hVif set to 0, the USB core will not allow autosuspend for devices bound to this driver.}(hjuShhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjrSubah}(h]h ]h"]h$]h&]uh1jhhjVSubeh}(h]h ]h"]h$]h&]uh1jHhjqShMhjQubjI)}(h``generic_subclass`` if set to 1, the generic USB driver's probe, disconnect, resume and suspend functions will be called in addition to the driver's own, so this part of the setup does not need to be replicated.h](jO)}(h``generic_subclass``h]j)}(hjSh]hgeneric_subclass}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjSubji)}(hhh]h)}(hif set to 1, the generic USB driver's probe, disconnect, resume and suspend functions will be called in addition to the driver's own, so this part of the setup does not need to be replicated.h]hif set to 1, the generic USB driver’s probe, disconnect, resume and suspend functions will be called in addition to the driver’s own, so this part of the setup does not need to be replicated.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjSubah}(h]h ]h"]h$]h&]uh1jhhjSubeh}(h]h ]h"]h$]h&]uh1jHhjShMhjQubeh}(h]h ]h"]h$]h&]uh1jChjPubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h**Description**h]j.)}(hjSh]h Description}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjSubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hIUSB device drivers must provide a name, other driver fields are optional.h]hIUSB device drivers must provide a name, other driver fields are optional.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_class_driver (C struct)c.usb_class_driverhNtauh1jhjghhhjhNubj )}(hhh](j%)}(husb_class_driverh]j+)}(hstruct usb_class_driverh](j1)}(hjh]hstruct}(hjThhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjThhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hj%ThhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjThhhj$ThMubj)}(husb_class_driverh]j)}(hjTh]husb_class_driver}(hj7ThhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3Tubah}(h]h ](jjeh"]h$]h&]jjuh1jhjThhhj$ThMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjThhhj$ThMubah}(h]j Tah ](jjeh"]h$]h&]jj)jhuh1j$hj$ThMhj Thhubj)}(hhh]h)}(h>identifies a USB driver that wants to use the USB major numberh]h>identifies a USB driver that wants to use the USB major number}(hjYThhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM1hjVThhubah}(h]h ]h"]h$]h&]uh1jhj Thhhj$ThMubeh}(h]h ](jstructeh"]h$]h&]jjjjqTjjqTj j!j"uh1jhhhjghjhNubj$)}(hX**Definition**:: struct usb_class_driver { char *name; char *(*devnode)(const struct device *dev, umode_t *mode); const struct file_operations *fops; int minor_base; }; **Members** ``name`` the usb class device name for this driver. Will show up in sysfs. ``devnode`` Callback to provide a naming hint for a possible device node to create. ``fops`` pointer to the struct file_operations of this driver. ``minor_base`` the start of the minor range for this driver.h](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hj}ThhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjyTubh:}(hjyThhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM5hjuTubj )}(hstruct usb_class_driver { char *name; char *(*devnode)(const struct device *dev, umode_t *mode); const struct file_operations *fops; int minor_base; };h]hstruct usb_class_driver { char *name; char *(*devnode)(const struct device *dev, umode_t *mode); const struct file_operations *fops; int minor_base; };}hjTsbah}(h]h ]h"]h$]h&]jjuh1jhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM7hjuTubh)}(h **Members**h]j.)}(hjTh]hMembers}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjTubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM>hjuTubjD)}(hhh](jI)}(hL``name`` the usb class device name for this driver. Will show up in sysfs. h](jO)}(h``name``h]j)}(hjTh]hname}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM3hjTubji)}(hhh]h)}(hBthe usb class device name for this driver. Will show up in sysfs.h]hBthe usb class device name for this driver. Will show up in sysfs.}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhjThM3hjTubah}(h]h ]h"]h$]h&]uh1jhhjTubeh}(h]h ]h"]h$]h&]uh1jHhjThM3hjTubjI)}(hT``devnode`` Callback to provide a naming hint for a possible device node to create. h](jO)}(h ``devnode``h]j)}(hjTh]hdevnode}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM5hjTubji)}(hhh]h)}(hGCallback to provide a naming hint for a possible device node to create.h]hGCallback to provide a naming hint for a possible device node to create.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM4hjUubah}(h]h ]h"]h$]h&]uh1jhhjTubeh}(h]h ]h"]h$]h&]uh1jHhjUhM5hjTubjI)}(h?``fops`` pointer to the struct file_operations of this driver. h](jO)}(h``fops``h]j)}(hj9Uh]hfops}(hj;UhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7Uubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM6hj3Uubji)}(hhh]h)}(h5pointer to the struct file_operations of this driver.h]h5pointer to the struct file_operations of this driver.}(hjRUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNUhM6hjOUubah}(h]h ]h"]h$]h&]uh1jhhj3Uubeh}(h]h ]h"]h$]h&]uh1jHhjNUhM6hjTubjI)}(h<``minor_base`` the start of the minor range for this driver.h](jO)}(h``minor_base``h]j)}(hjrUh]h minor_base}(hjtUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpUubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM6hjlUubji)}(hhh]h)}(h-the start of the minor range for this driver.h]h-the start of the minor range for this driver.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM7hjUubah}(h]h ]h"]h$]h&]uh1jhhjlUubeh}(h]h ]h"]h$]h&]uh1jHhjUhM6hjTubeh}(h]h ]h"]h$]h&]uh1jChjuTubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h**Description**h]j.)}(hjUh]h Description}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjUubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM:hjghhubh)}(hThis structure is used for the usb_register_dev() and usb_deregister_dev() functions, to consolidate a number of the parameters used for them.h]hThis structure is used for the usb_register_dev() and usb_deregister_dev() functions, to consolidate a number of the parameters used for them.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM7hjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jmodule_usb_driver (C macro)c.module_usb_driverhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hmodule_usb_driverh]j+)}(hmodule_usb_driverh]j)}(hmodule_usb_driverh]j)}(hjUh]hmodule_usb_driver}(hjUhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjUubah}(h]h ](jjeh"]h$]h&]jjuh1jhjUhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMQubah}(h]h ]h"]h$]h&]jjjuh1j*jjhjUhhhj VhMQubah}(h]jUah ](jjeh"]h$]h&]jj)jhuh1j$hj VhMQhjUhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjUhhhj VhMQubeh}(h]h ](jmacroeh"]h$]h&]jjjj#Vjj#Vj j!j"uh1jhhhjghjhNubh)}(h$``module_usb_driver (__usb_driver)``h]j)}(hj)Vh]h module_usb_driver (__usb_driver)}(hj+VhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'Vubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMShjghhubj7)}(h*Helper macro for registering a USB driver h]h)}(h)Helper macro for registering a USB driverh]h)Helper macro for registering a USB driver}(hjCVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMQhj?Vubah}(h]h ]h"]h$]h&]uh1j7hjQVhMQhjghhubj$)}(hX!**Parameters** ``__usb_driver`` usb_driver struct **Description** Helper macro for USB 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]j.)}(hj^Vh]h Parameters}(hj`VhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj\Vubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMUhjXVubjD)}(hhh]jI)}(h#``__usb_driver`` usb_driver struct h](jO)}(h``__usb_driver``h]j)}(hj}Vh]h __usb_driver}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{Vubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMRhjwVubji)}(hhh]h)}(husb_driver structh]husb_driver struct}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVhMRhjVubah}(h]h ]h"]h$]h&]uh1jhhjwVubeh}(h]h ]h"]h$]h&]uh1jHhjVhMRhjtVubah}(h]h ]h"]h$]h&]uh1jChjXVubh)}(h**Description**h]j.)}(hjVh]h Description}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjVubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMThjXVubh)}(hHelper macro for USB 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 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()}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMShjXVubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jurb (C struct)c.urbhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hurbh]j+)}(h struct urbh](j1)}(hjh]hstruct}(hjVhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjVhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMZubjC)}(h h]h }(hj WhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjVhhhj WhMZubj)}(hurbh]j)}(hjVh]hurb}(hjWhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjWubah}(h]h ](jjeh"]h$]h&]jjuh1jhjVhhhj WhMZubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjVhhhj WhMZubah}(h]jVah ](jjeh"]h$]h&]jj)jhuh1j$hj WhMZhjVhhubj)}(hhh]h)}(hUSB Request Blockh]hUSB Request Block}(hj?WhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj\h]hnumber_of_packets}(hj@\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<\ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj8\ubji)}(hhh]h)}(h)Lists the number of ISO transfer buffers.h]h)Lists the number of ISO transfer buffers.}(hjW\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjS\hMhjT\ubah}(h]h ]h"]h$]h&]uh1jhhj8\ubeh}(h]h ]h"]h$]h&]uh1jHhjS\hMhjWubjI)}(h``interval`` Specifies the polling interval for interrupt or isochronous transfers. The units are frames (milliseconds) for full and low speed devices, and microframes (1/8 millisecond) for highspeed and SuperSpeed devices. h](jO)}(h ``interval``h]j)}(hjw\h]hinterval}(hjy\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhju\ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjq\ubji)}(hhh]h)}(hSpecifies the polling interval for interrupt or isochronous transfers. The units are frames (milliseconds) for full and low speed devices, and microframes (1/8 millisecond) for highspeed and SuperSpeed devices.h]hSpecifies the polling interval for interrupt or isochronous transfers. The units are frames (milliseconds) for full and low speed devices, and microframes (1/8 millisecond) for highspeed and SuperSpeed devices.}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj\ubah}(h]h ]h"]h$]h&]uh1jhhjq\ubeh}(h]h ]h"]h$]h&]uh1jHhj\hMhjWubjI)}(hJ``error_count`` Returns the number of ISO transfers that reported errors. h](jO)}(h``error_count``h]j)}(hj\h]h error_count}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj\ubji)}(hhh]h)}(h9Returns the number of ISO transfers that reported errors.h]h9Returns the number of ISO transfers that reported errors.}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\hMhj\ubah}(h]h ]h"]h$]h&]uh1jhhj\ubeh}(h]h ]h"]h$]h&]uh1jHhj\hMhjWubjI)}(hg``context`` For use in completion functions. This normally points to request-specific driver context. h](jO)}(h ``context``h]j)}(hj\h]hcontext}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj\ubji)}(hhh]h)}(hZFor use in completion functions. This normally points to request-specific driver context.h]hZFor use in completion functions. This normally points to request-specific driver context.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj]ubah}(h]h ]h"]h$]h&]uh1jhhj\ubeh}(h]h ]h"]h$]h&]uh1jHhj\hMhjWubjI)}(h``complete`` Completion handler. This URB is passed as the parameter to the completion function. The completion function may then do what it likes with the URB, including resubmitting or freeing it. h](jO)}(h ``complete``h]j)}(hj$]h]hcomplete}(hj&]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"]ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj]ubji)}(hhh]h)}(hCompletion handler. This URB is passed as the parameter to the completion function. The completion function may then do what it likes with the URB, including resubmitting or freeing it.h]hCompletion handler. This URB is passed as the parameter to the completion function. The completion function may then do what it likes with the URB, including resubmitting or freeing it.}(hj=]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj:]ubah}(h]h ]h"]h$]h&]uh1jhhj]ubeh}(h]h ]h"]h$]h&]uh1jHhj9]hMhjWubjI)}(hu``iso_frame_desc`` Used to provide arrays of ISO transfer buffers and to collect the transfer status for each buffer.h](jO)}(h``iso_frame_desc``h]j)}(hj^]h]hiso_frame_desc}(hj`]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\]ubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjX]ubji)}(hhh]h)}(hbUsed to provide arrays of ISO transfer buffers and to collect the transfer status for each buffer.h]hbUsed to provide arrays of ISO transfer buffers and to collect the transfer status for each buffer.}(hjw]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjs]hMhjt]ubah}(h]h ]h"]h$]h&]uh1jhhjX]ubeh}(h]h ]h"]h$]h&]uh1jHhjs]hMhjWubeh}(h]h ]h"]h$]h&]uh1jChj[Wubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h**Description**h]j.)}(hj]h]h Description}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj]ubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hXLThis structure identifies USB transfer requests. URBs must be allocated by calling usb_alloc_urb() and freed with a call to usb_free_urb(). Initialization may be done using various usb_fill_*_urb() functions. URBs are submitted using usb_submit_urb(), and pending requests may be canceled using usb_unlink_urb() or usb_kill_urb().h]hXLThis structure identifies USB transfer requests. URBs must be allocated by calling usb_alloc_urb() and freed with a call to usb_free_urb(). Initialization may be done using various usb_fill_*_urb() functions. URBs are submitted using usb_submit_urb(), and pending requests may be canceled using usb_unlink_urb() or usb_kill_urb().}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hData Transfer Buffers:h]hData Transfer Buffers:}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hXNormally drivers provide I/O buffers allocated with kmalloc() or otherwise taken from the general page pool. That is provided by transfer_buffer (control requests also use setup_packet), and host controller drivers perform a dma mapping (and unmapping) for each buffer transferred. Those mapping operations can be expensive on some platforms (perhaps using a dma bounce buffer or talking to an IOMMU), although they're cheap on commodity x86 and ppc hardware.h]hXNormally drivers provide I/O buffers allocated with kmalloc() or otherwise taken from the general page pool. That is provided by transfer_buffer (control requests also use setup_packet), and host controller drivers perform a dma mapping (and unmapping) for each buffer transferred. Those mapping operations can be expensive on some platforms (perhaps using a dma bounce buffer or talking to an IOMMU), although they’re cheap on commodity x86 and ppc hardware.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hXAlternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag, which tells the host controller driver that no such mapping is needed for the transfer_buffer since the device driver is DMA-aware. For example, a device driver might allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map(). When this transfer flag is provided, host controller drivers will attempt to use the dma address found in the transfer_dma field rather than determining a dma address themselves.h]hXAlternatively, drivers may pass the URB_NO_TRANSFER_DMA_MAP transfer flag, which tells the host controller driver that no such mapping is needed for the transfer_buffer since the device driver is DMA-aware. For example, a device driver might allocate a DMA buffer with usb_alloc_coherent() or call usb_buffer_map(). When this transfer flag is provided, host controller drivers will attempt to use the dma address found in the transfer_dma field rather than determining a dma address themselves.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hXNote that transfer_buffer must still be set if the controller does not support DMA (as indicated by hcd_uses_dma()) and when talking to root hub. If you have to transfer between highmem zone and the device on such controller, create a bounce buffer or bail out with an error. If transfer_buffer cannot be set (is in highmem) and the controller is DMA capable, assign NULL to it, so that usbmon knows not to use the value. The setup_packet must always be set, so it cannot be located in highmem.h]hXNote that transfer_buffer must still be set if the controller does not support DMA (as indicated by hcd_uses_dma()) and when talking to root hub. If you have to transfer between highmem zone and the device on such controller, create a bounce buffer or bail out with an error. If transfer_buffer cannot be set (is in highmem) and the controller is DMA capable, assign NULL to it, so that usbmon knows not to use the value. The setup_packet must always be set, so it cannot be located in highmem.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hInitialization:h]hInitialization:}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hXGAll URBs submitted must initialize the dev, pipe, transfer_flags (may be zero), and complete fields. All URBs must also initialize transfer_buffer and transfer_buffer_length. They may provide the URB_SHORT_NOT_OK transfer flag, indicating that short reads are to be treated as errors; that flag is invalid for write requests.h]hXGAll URBs submitted must initialize the dev, pipe, transfer_flags (may be zero), and complete fields. All URBs must also initialize transfer_buffer and transfer_buffer_length. They may provide the URB_SHORT_NOT_OK transfer flag, indicating that short reads are to be treated as errors; that flag is invalid for write requests.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hBulk URBs may use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers should always terminate with a short packet, even if it means adding an extra zero length packet.h]hBulk URBs may use the URB_ZERO_PACKET transfer flag, indicating that bulk OUT transfers should always terminate with a short packet, even if it means adding an extra zero length packet.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hControl URBs must provide a valid pointer in the setup_packet field. Unlike the transfer_buffer, the setup_packet may not be mapped for DMA beforehand.h]hControl URBs must provide a valid pointer in the setup_packet field. Unlike the transfer_buffer, the setup_packet may not be mapped for DMA beforehand.}(hj.^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hXInterrupt URBs must provide an interval, saying how often (in milliseconds or, for highspeed devices, 125 microsecond units) to poll for transfers. After the URB has been submitted, the interval field reflects how the transfer was actually scheduled. The polling interval may be more frequent than requested. For example, some controllers have a maximum interval of 32 milliseconds, while others support intervals of up to 1024 milliseconds. Isochronous URBs also have transfer intervals. (Note that for isochronous endpoints, as well as high speed interrupt endpoints, the encoding of the transfer interval in the endpoint descriptor is logarithmic. Device drivers must convert that value to linear units themselves.)h]hXInterrupt URBs must provide an interval, saying how often (in milliseconds or, for highspeed devices, 125 microsecond units) to poll for transfers. After the URB has been submitted, the interval field reflects how the transfer was actually scheduled. The polling interval may be more frequent than requested. For example, some controllers have a maximum interval of 32 milliseconds, while others support intervals of up to 1024 milliseconds. Isochronous URBs also have transfer intervals. (Note that for isochronous endpoints, as well as high speed interrupt endpoints, the encoding of the transfer interval in the endpoint descriptor is logarithmic. Device drivers must convert that value to linear units themselves.)}(hj=^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM!hjghhubh)}(hXIf an isochronous endpoint queue isn't already running, the host controller will schedule a new URB to start as soon as bandwidth utilization allows. If the queue is running then a new URB will be scheduled to start in the first transfer slot following the end of the preceding URB, if that slot has not already expired. If the slot has expired (which can happen when IRQ delivery is delayed for a long time), the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag is clear then the URB will be scheduled to start in the expired slot, implying that some of its packets will not be transferred; if the flag is set then the URB will be scheduled in the first unexpired slot, breaking the queue's synchronization. Upon URB completion, the start_frame field will be set to the (micro)frame number in which the transfer was scheduled. Ranges for frame counter values are HC-specific and can go from as low as 256 to as high as 65536 frames.h]hXIf an isochronous endpoint queue isn’t already running, the host controller will schedule a new URB to start as soon as bandwidth utilization allows. If the queue is running then a new URB will be scheduled to start in the first transfer slot following the end of the preceding URB, if that slot has not already expired. If the slot has expired (which can happen when IRQ delivery is delayed for a long time), the scheduling behavior depends on the URB_ISO_ASAP flag. If the flag is clear then the URB will be scheduled to start in the expired slot, implying that some of its packets will not be transferred; if the flag is set then the URB will be scheduled in the first unexpired slot, breaking the queue’s synchronization. Upon URB completion, the start_frame field will be set to the (micro)frame number in which the transfer was scheduled. Ranges for frame counter values are HC-specific and can go from as low as 256 to as high as 65536 frames.}(hjL^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM-hjghhubh)}(hX4Isochronous URBs have a different data transfer model, in part because the quality of service is only "best effort". Callers provide specially allocated URBs, with number_of_packets worth of iso_frame_desc structures at the end. Each such packet is an individual ISO transfer. Isochronous URBs are normally queued, submitted by drivers to arrange that transfers are at least double buffered, and then explicitly resubmitted in completion handlers, so that data (such as audio or video) streams at as constant a rate as the host controller scheduler can support.h]hX8Isochronous URBs have a different data transfer model, in part because the quality of service is only “best effort”. Callers provide specially allocated URBs, with number_of_packets worth of iso_frame_desc structures at the end. Each such packet is an individual ISO transfer. Isochronous URBs are normally queued, submitted by drivers to arrange that transfers are at least double buffered, and then explicitly resubmitted in completion handlers, so that data (such as audio or video) streams at as constant a rate as the host controller scheduler can support.}(hj[^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM<hjghhubh)}(hCompletion Callbacks:h]hCompletion Callbacks:}(hjj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMFhjghhubh)}(hXQThe completion callback is made in_interrupt(), and one of the first things that a completion handler should do is check the status field. The status field is provided for all URBs. It is used to report unlinked URBs, and status for all non-ISO transfers. It should not be examined before the URB is returned to the completion handler.h]hXQThe completion callback is made in_interrupt(), and one of the first things that a completion handler should do is check the status field. The status field is provided for all URBs. It is used to report unlinked URBs, and status for all non-ISO transfers. It should not be examined before the URB is returned to the completion handler.}(hjy^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMHhjghhubh)}(h]The context field is normally used to link URBs back to the relevant driver or request state.h]h]The context field is normally used to link URBs back to the relevant driver or request state.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMNhjghhubh)}(hWhen the completion callback is invoked for non-isochronous URBs, the actual_length field tells how many bytes were transferred. This field is updated even when the URB terminated with an error or was unlinked.h]hWhen the completion callback is invoked for non-isochronous URBs, the actual_length field tells how many bytes were transferred. This field is updated even when the URB terminated with an error or was unlinked.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMQhjghhubh)}(hXISO transfer status is reported in the status and actual_length fields of the iso_frame_desc array, and the number of errors is reported in error_count. Completion callbacks for ISO transfers will normally (re)submit URBs to ensure a constant transfer rate.h]hXISO transfer status is reported in the status and actual_length fields of the iso_frame_desc array, and the number of errors is reported in error_count. Completion callbacks for ISO transfers will normally (re)submit URBs to ensure a constant transfer rate.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMUhjghhubh)}(hNote that even fields marked "public" should not be touched by the driver when the urb is owned by the hcd, that is, since the call to usb_submit_urb() till the entry into the completion routine.h]hNote that even fields marked “public” should not be touched by the driver when the urb is owned by the hcd, that is, since the call to usb_submit_urb() till the entry into the completion routine.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMZhjghhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!usb_fill_control_urb (C function)c.usb_fill_control_urbhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hvoid usb_fill_control_urb (struct urb *urb, struct usb_device *dev, unsigned int pipe, unsigned char *setup_packet, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context)h]j+)}(hvoid usb_fill_control_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe, unsigned char *setup_packet, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context)h](jT)}(hvoidh]hvoid}(hj^hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj^hhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hj^hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj^hhhj^hMubj)}(husb_fill_control_urbh]j)}(husb_fill_control_urbh]husb_fill_control_urb}(hj^hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj^hhhj^hMubj)}(h(struct urb *urb, struct usb_device *dev, unsigned int pipe, unsigned char *setup_packet, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context)h](j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hj_hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj_ubjC)}(h h]h }(hj'_hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_ubh)}(hhh]j)}(hurbh]hurb}(hj8_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5_ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj:_modnameN classnameNjLjO)}jR]jU)}jHj_sbc.usb_fill_control_urbasbuh1hhj_ubjC)}(h h]h }(hjX_hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_ubjs)}(hjvh]h*}(hjf_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj_ubj)}(hurbh]hurb}(hjs_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ubj)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hj_hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj_ubjC)}(h h]h }(hj_hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj_modnameN classnameNjLjO)}jR]jT_c.usb_fill_control_urbasbuh1hhj_ubjC)}(h h]h }(hj_hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_ubjs)}(hjvh]h*}(hj_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj_ubj)}(hdevh]hdev}(hj_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ubj)}(hunsigned int pipeh](jT)}(hunsignedh]hunsigned}(hj_hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj_ubjC)}(h h]h }(hj `hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_ubjT)}(hinth]hint}(hj`hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj_ubjC)}(h h]h }(hj&`hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_ubj)}(hpipeh]hpipe}(hj4`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ubj)}(hunsigned char *setup_packeth](jT)}(hunsignedh]hunsigned}(hjM`hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjI`ubjC)}(h h]h }(hj[`hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjI`ubjT)}(hcharh]hchar}(hji`hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjI`ubjC)}(h h]h }(hjw`hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjI`ubjs)}(hjvh]h*}(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjI`ubj)}(h setup_packeth]h setup_packet}(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjI`ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ubj)}(hvoid *transfer_bufferh](jT)}(hvoidh]hvoid}(hj`hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj`ubjC)}(h h]h }(hj`hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj`ubjs)}(hjvh]h*}(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj`ubj)}(htransfer_bufferh]htransfer_buffer}(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ubj)}(hint buffer_lengthh](jT)}(hinth]hint}(hj`hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj`ubjC)}(h h]h }(hj`hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj`ubj)}(h buffer_lengthh]h buffer_length}(hj ahhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ubj)}(husb_complete_t complete_fnh](h)}(hhh]j)}(husb_complete_th]husb_complete_t}(hj%ahhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"aubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj'amodnameN classnameNjLjO)}jR]jT_c.usb_fill_control_urbasbuh1hhjaubjC)}(h h]h }(hjCahhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjaubj)}(h complete_fnh]h complete_fn}(hjQahhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjaubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ubj)}(h void *contexth](jT)}(hvoidh]hvoid}(hjjahhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjfaubjC)}(h h]h }(hjxahhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjfaubjs)}(hjvh]h*}(hjahhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjfaubj)}(hcontexth]hcontext}(hjahhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfaubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj_ubeh}(h]h ]h"]h$]h&]jjuh1jhj^hhhj^hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj^hhhj^hMubah}(h]j^ah ](jjeh"]h$]h&]jj)jhuh1j$hj^hMhj^hhubj)}(hhh]h)}(hinitializes a control urbh]hinitializes a control urb}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjahhubah}(h]h ]h"]h$]h&]uh1jhj^hhhj^hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjajjaj j!j"uh1jhhhjghjhNubj$)}(hX**Parameters** ``struct urb *urb`` pointer to the urb to initialize. ``struct usb_device *dev`` pointer to the struct usb_device for this urb. ``unsigned int pipe`` the endpoint pipe ``unsigned char *setup_packet`` pointer to the setup_packet buffer. The buffer must be suitable for DMA. ``void *transfer_buffer`` pointer to the transfer buffer. The buffer must be suitable for DMA. ``int buffer_length`` length of the transfer buffer ``usb_complete_t complete_fn`` pointer to the usb_complete_t function ``void *context`` what to set the urb context to. **Description** Initializes a control urb with the proper information needed to submit it to a device. The transfer buffer and the setup_packet buffer will most likely be filled or read via DMA. The simplest way to get a buffer that can be DMAed to is allocating it via kmalloc() or equivalent, even for very small buffers. If the buffers are embedded in a bigger structure, there is a risk that the buffer itself, the previous fields and/or the next fields are corrupted due to cache incoherencies; or slowed down if they are evicted from the cache. For more information, check :c:type:`struct urb `.h](h)}(h**Parameters**h]j.)}(hjah]h Parameters}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjaubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjaubjD)}(hhh](jI)}(h6``struct urb *urb`` pointer to the urb to initialize. h](jO)}(h``struct urb *urb``h]j)}(hjah]hstruct urb *urb}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjaubji)}(hhh]h)}(h!pointer to the urb to initialize.h]h!pointer to the urb to initialize.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjbhMhjbubah}(h]h ]h"]h$]h&]uh1jhhjaubeh}(h]h ]h"]h$]h&]uh1jHhjbhMhjaubjI)}(hJ``struct usb_device *dev`` pointer to the struct usb_device for this urb. h](jO)}(h``struct usb_device *dev``h]j)}(hj7bh]hstruct usb_device *dev}(hj9bhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5bubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj1bubji)}(hhh]h)}(h.pointer to the struct usb_device for this urb.h]h.pointer to the struct usb_device for this urb.}(hjPbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLbhMhjMbubah}(h]h ]h"]h$]h&]uh1jhhj1bubeh}(h]h ]h"]h$]h&]uh1jHhjLbhMhjaubjI)}(h(``unsigned int pipe`` the endpoint pipe h](jO)}(h``unsigned int pipe``h]j)}(hjpbh]hunsigned int pipe}(hjrbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnbubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjjbubji)}(hhh]h)}(hthe endpoint pipeh]hthe endpoint pipe}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjbhMhjbubah}(h]h ]h"]h$]h&]uh1jhhjjbubeh}(h]h ]h"]h$]h&]uh1jHhjbhMhjaubjI)}(hi``unsigned char *setup_packet`` pointer to the setup_packet buffer. The buffer must be suitable for DMA. h](jO)}(h``unsigned char *setup_packet``h]j)}(hjbh]hunsigned char *setup_packet}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjbubji)}(hhh]h)}(hHpointer to the setup_packet buffer. The buffer must be suitable for DMA.h]hHpointer to the setup_packet buffer. The buffer must be suitable for DMA.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjbubah}(h]h ]h"]h$]h&]uh1jhhjbubeh}(h]h ]h"]h$]h&]uh1jHhjbhMhjaubjI)}(h_``void *transfer_buffer`` pointer to the transfer buffer. The buffer must be suitable for DMA. h](jO)}(h``void *transfer_buffer``h]j)}(hjbh]hvoid *transfer_buffer}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjbubji)}(hhh]h)}(hDpointer to the transfer buffer. The buffer must be suitable for DMA.h]hDpointer to the transfer buffer. The buffer must be suitable for DMA.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjbubah}(h]h ]h"]h$]h&]uh1jhhjbubeh}(h]h ]h"]h$]h&]uh1jHhjbhMhjaubjI)}(h4``int buffer_length`` length of the transfer buffer h](jO)}(h``int buffer_length``h]j)}(hjch]hint buffer_length}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjcubji)}(hhh]h)}(hlength of the transfer bufferh]hlength of the transfer buffer}(hj6chhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2chMhj3cubah}(h]h ]h"]h$]h&]uh1jhhjcubeh}(h]h ]h"]h$]h&]uh1jHhj2chMhjaubjI)}(hF``usb_complete_t complete_fn`` pointer to the usb_complete_t function h](jO)}(h``usb_complete_t complete_fn``h]j)}(hjVch]husb_complete_t complete_fn}(hjXchhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTcubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjPcubji)}(hhh]h)}(h&pointer to the usb_complete_t functionh]h&pointer to the usb_complete_t function}(hjochhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkchMhjlcubah}(h]h ]h"]h$]h&]uh1jhhjPcubeh}(h]h ]h"]h$]h&]uh1jHhjkchMhjaubjI)}(h2``void *context`` what to set the urb context to. h](jO)}(h``void *context``h]j)}(hjch]h void *context}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjcubji)}(hhh]h)}(hwhat to set the urb context to.h]hwhat to set the urb context to.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhjchMhjcubah}(h]h ]h"]h$]h&]uh1jhhjcubeh}(h]h ]h"]h$]h&]uh1jHhjchMhjaubeh}(h]h ]h"]h$]h&]uh1jChjaubh)}(h**Description**h]j.)}(hjch]h Description}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjcubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjaubh)}(hVInitializes a control urb with the proper information needed to submit it to a device.h]hVInitializes a control urb with the proper information needed to submit it to a device.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjaubh)}(hXThe transfer buffer and the setup_packet buffer will most likely be filled or read via DMA. The simplest way to get a buffer that can be DMAed to is allocating it via kmalloc() or equivalent, even for very small buffers. If the buffers are embedded in a bigger structure, there is a risk that the buffer itself, the previous fields and/or the next fields are corrupted due to cache incoherencies; or slowed down if they are evicted from the cache. For more information, check :c:type:`struct urb `.h](hXThe transfer buffer and the setup_packet buffer will most likely be filled or read via DMA. The simplest way to get a buffer that can be DMAed to is allocating it via kmalloc() or equivalent, even for very small buffers. If the buffers are embedded in a bigger structure, there is a risk that the buffer itself, the previous fields and/or the next fields are corrupted due to cache incoherencies; or slowed down if they are evicted from the cache. For more information, check }(hjchhhNhNubh)}(h:c:type:`struct urb `h]j)}(hjch]h struct urb}(hjchhhNhNubah}(h]h ](xrefjc-typeeh"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&]refdocdriver-api/usb/usb refdomainjreftypetype refexplicitrefwarnjLjO)}jR]sb reftargeturbuh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjcubh.}(hjchhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjdhMhjaubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_fill_bulk_urb (C function)c.usb_fill_bulk_urbhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hvoid usb_fill_bulk_urb (struct urb *urb, struct usb_device *dev, unsigned int pipe, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context)h]j+)}(hvoid usb_fill_bulk_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context)h](jT)}(hvoidh]hvoid}(hjGdhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjCdhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hjVdhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjCdhhhjUdhMubj)}(husb_fill_bulk_urbh]j)}(husb_fill_bulk_urbh]husb_fill_bulk_urb}(hjhdhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjddubah}(h]h ](jjeh"]h$]h&]jjuh1jhjCdhhhjUdhMubj)}(h(struct urb *urb, struct usb_device *dev, unsigned int pipe, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context)h](j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjdhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjdubjC)}(h h]h }(hjdhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjdubh)}(hhh]j)}(hurbh]hurb}(hjdhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjdubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjdmodnameN classnameNjLjO)}jR]jU)}jHjjdsbc.usb_fill_bulk_urbasbuh1hhjdubjC)}(h h]h }(hjdhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjdubjs)}(hjvh]h*}(hjdhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjdubj)}(hurbh]hurb}(hjdhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjdubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|dubj)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjdhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjdubjC)}(h h]h }(hjehhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjdubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjemodnameN classnameNjLjO)}jR]jdc.usb_fill_bulk_urbasbuh1hhjdubjC)}(h h]h }(hj2ehhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjdubjs)}(hjvh]h*}(hj@ehhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjdubj)}(hdevh]hdev}(hjMehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjdubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|dubj)}(hunsigned int pipeh](jT)}(hunsignedh]hunsigned}(hjfehhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjbeubjC)}(h h]h }(hjtehhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjbeubjT)}(hinth]hint}(hjehhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjbeubjC)}(h h]h }(hjehhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjbeubj)}(hpipeh]hpipe}(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbeubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|dubj)}(hvoid *transfer_bufferh](jT)}(hvoidh]hvoid}(hjehhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjeubjC)}(h h]h }(hjehhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjeubjs)}(hjvh]h*}(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjeubj)}(htransfer_bufferh]htransfer_buffer}(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|dubj)}(hint buffer_lengthh](jT)}(hinth]hint}(hjehhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjeubjC)}(h h]h }(hjfhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjeubj)}(h buffer_lengthh]h buffer_length}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|dubj)}(husb_complete_t complete_fnh](h)}(hhh]j)}(husb_complete_th]husb_complete_t}(hj1fhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.fubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj3fmodnameN classnameNjLjO)}jR]jdc.usb_fill_bulk_urbasbuh1hhj*fubjC)}(h h]h }(hjOfhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj*fubj)}(h complete_fnh]h complete_fn}(hj]fhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*fubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|dubj)}(h void *contexth](jT)}(hvoidh]hvoid}(hjvfhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjrfubjC)}(h h]h }(hjfhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjrfubjs)}(hjvh]h*}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjrfubj)}(hcontexth]hcontext}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrfubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|dubeh}(h]h ]h"]h$]h&]jjuh1jhjCdhhhjUdhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj?dhhhjUdhMubah}(h]j:dah ](jjeh"]h$]h&]jj)jhuh1j$hjUdhMhjhubah}(h]h ]h"]h$]h&]uh1jhhj"hubeh}(h]h ]h"]h$]h&]uh1jHhj=hhMhjgubjI)}(h2``void *context`` what to set the urb context to. h](jO)}(h``void *context``h]j)}(hjahh]h void *context}(hjchhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_hubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj[hubji)}(hhh]h)}(hwhat to set the urb context to.h]hwhat to set the urb context to.}(hjzhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjvhhMhjwhubah}(h]h ]h"]h$]h&]uh1jhhj[hubeh}(h]h ]h"]h$]h&]uh1jHhjvhhMhjgubeh}(h]h ]h"]h$]h&]uh1jChjfubh)}(h**Description**h]j.)}(hjhh]h Description}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjhubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjfubh)}(hSInitializes a bulk urb with the proper information needed to submit it to a device.h]hSInitializes a bulk urb with the proper information needed to submit it to a device.}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjfubh)}(hZRefer to usb_fill_control_urb() for a description of the requirements for transfer_buffer.h]hZRefer to usb_fill_control_urb() for a description of the requirements for transfer_buffer.}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjfubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_fill_int_urb (C function)c.usb_fill_int_urbhNtauh1jhjghhhjhNubj )}(hhh](j%)}(hvoid usb_fill_int_urb (struct urb *urb, struct usb_device *dev, unsigned int pipe, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context, int interval)h]j+)}(hvoid usb_fill_int_urb(struct urb *urb, struct usb_device *dev, unsigned int pipe, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context, int interval)h](jT)}(hvoidh]hvoid}(hjhhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMubjC)}(h h]h }(hjhhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhhjhhMubj)}(husb_fill_int_urbh]j)}(husb_fill_int_urbh]husb_fill_int_urb}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj iubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhhjhhMubj)}(h(struct urb *urb, struct usb_device *dev, unsigned int pipe, void *transfer_buffer, int buffer_length, usb_complete_t complete_fn, void *context, int interval)h](j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hj-ihhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj)iubjC)}(h h]h }(hj:ihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj)iubh)}(hhh]j)}(hurbh]hurb}(hjKihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjHiubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjMimodnameN classnameNjLjO)}jR]jU)}jHjisbc.usb_fill_int_urbasbuh1hhj)iubjC)}(h h]h }(hjkihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj)iubjs)}(hjvh]h*}(hjyihhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj)iubj)}(hurbh]hurb}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)iubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj%iubj)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjihhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjiubjC)}(h h]h }(hjihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjiubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjimodnameN classnameNjLjO)}jR]jgic.usb_fill_int_urbasbuh1hhjiubjC)}(h h]h }(hjihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjiubjs)}(hjvh]h*}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjiubj)}(hdevh]hdev}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj%iubj)}(hunsigned int pipeh](jT)}(hunsignedh]hunsigned}(hjjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj jubjC)}(h h]h }(hjjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj jubjT)}(hinth]hint}(hj+jhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj jubjC)}(h h]h }(hj9jhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj jubj)}(hpipeh]hpipe}(hjGjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj jubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj%iubj)}(hvoid *transfer_bufferh](jT)}(hvoidh]hvoid}(hj`jhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj\jubjC)}(h h]h }(hjnjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj\jubjs)}(hjvh]h*}(hj|jhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj\jubj)}(htransfer_bufferh]htransfer_buffer}(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\jubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj%iubj)}(hint buffer_lengthh](jT)}(hinth]hint}(hjjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjjubjC)}(h h]h }(hjjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjjubj)}(h buffer_lengthh]h buffer_length}(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj%iubj)}(husb_complete_t complete_fnh](h)}(hhh]j)}(husb_complete_th]husb_complete_t}(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjjmodnameN classnameNjLjO)}jR]jgic.usb_fill_int_urbasbuh1hhjjubjC)}(h h]h }(hjjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjjubj)}(h complete_fnh]h complete_fn}(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj%iubj)}(h void *contexth](jT)}(hvoidh]hvoid}(hjkhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjkubjC)}(h h]h }(hj-khhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjkubjs)}(hjvh]h*}(hj;khhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjkubj)}(hcontexth]hcontext}(hjHkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjkubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj%iubj)}(h int intervalh](jT)}(hinth]hint}(hjakhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj]kubjC)}(h h]h }(hjokhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj]kubj)}(hintervalh]hinterval}(hj}khhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]kubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj%iubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhhjhhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhhjhhMubah}(h]jhah ](jjeh"]h$]h&]jj)jhuh1j$hjhhMhjhhhubj)}(hhh]h)}(h(macro to help initialize a interrupt urbh]h(macro to help initialize a interrupt urb}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjkhhubah}(h]h ]h"]h$]h&]uh1jhjhhhhjhhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjkjjkj j!j"uh1jhhhjghjhNubj$)}(hX**Parameters** ``struct urb *urb`` pointer to the urb to initialize. ``struct usb_device *dev`` pointer to the struct usb_device for this urb. ``unsigned int pipe`` the endpoint pipe ``void *transfer_buffer`` pointer to the transfer buffer. The buffer must be suitable for DMA. ``int buffer_length`` length of the transfer buffer ``usb_complete_t complete_fn`` pointer to the usb_complete_t function ``void *context`` what to set the urb context to. ``int interval`` what to set the urb interval to, encoded like the endpoint descriptor's bInterval value. **Description** Initializes a interrupt urb with the proper information needed to submit it to a device. Refer to usb_fill_control_urb() for a description of the requirements for transfer_buffer. Note that High Speed and SuperSpeed(+) interrupt endpoints use a logarithmic encoding of the endpoint interval, and express polling intervals in microframes (eight per millisecond) rather than in frames (one per millisecond).h](h)}(h**Parameters**h]j.)}(hjkh]h Parameters}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjkubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjkubjD)}(hhh](jI)}(h6``struct urb *urb`` pointer to the urb to initialize. h](jO)}(h``struct urb *urb``h]j)}(hjkh]hstruct urb *urb}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjkubji)}(hhh]h)}(h!pointer to the urb to initialize.h]h!pointer to the urb to initialize.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkhMhjkubah}(h]h ]h"]h$]h&]uh1jhhjkubeh}(h]h ]h"]h$]h&]uh1jHhjkhMhjkubjI)}(hJ``struct usb_device *dev`` pointer to the struct usb_device for this urb. h](jO)}(h``struct usb_device *dev``h]j)}(hj!lh]hstruct usb_device *dev}(hj#lhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjlubji)}(hhh]h)}(h.pointer to the struct usb_device for this urb.h]h.pointer to the struct usb_device for this urb.}(hj:lhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6lhMhj7lubah}(h]h ]h"]h$]h&]uh1jhhjlubeh}(h]h ]h"]h$]h&]uh1jHhj6lhMhjkubjI)}(h(``unsigned int pipe`` the endpoint pipe h](jO)}(h``unsigned int pipe``h]j)}(hjZlh]hunsigned int pipe}(hj\lhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjXlubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjTlubji)}(hhh]h)}(hthe endpoint pipeh]hthe endpoint pipe}(hjslhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjolhMhjplubah}(h]h ]h"]h$]h&]uh1jhhjTlubeh}(h]h ]h"]h$]h&]uh1jHhjolhMhjkubjI)}(h_``void *transfer_buffer`` pointer to the transfer buffer. The buffer must be suitable for DMA. h](jO)}(h``void *transfer_buffer``h]j)}(hjlh]hvoid *transfer_buffer}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjlubji)}(hhh]h)}(hDpointer to the transfer buffer. The buffer must be suitable for DMA.h]hDpointer to the transfer buffer. The buffer must be suitable for DMA.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjlubah}(h]h ]h"]h$]h&]uh1jhhjlubeh}(h]h ]h"]h$]h&]uh1jHhjlhMhjkubjI)}(h4``int buffer_length`` length of the transfer buffer h](jO)}(h``int buffer_length``h]j)}(hjlh]hint buffer_length}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjlubji)}(hhh]h)}(hlength of the transfer bufferh]hlength of the transfer buffer}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjlhMhjlubah}(h]h ]h"]h$]h&]uh1jhhjlubeh}(h]h ]h"]h$]h&]uh1jHhjlhMhjkubjI)}(hF``usb_complete_t complete_fn`` pointer to the usb_complete_t function h](jO)}(h``usb_complete_t complete_fn``h]j)}(hjmh]husb_complete_t complete_fn}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjmubji)}(hhh]h)}(h&pointer to the usb_complete_t functionh]h&pointer to the usb_complete_t function}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjmhMhjmubah}(h]h ]h"]h$]h&]uh1jhhjmubeh}(h]h ]h"]h$]h&]uh1jHhjmhMhjkubjI)}(h2``void *context`` what to set the urb context to. h](jO)}(h``void *context``h]j)}(hj?mh]h void *context}(hjAmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=mubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj9mubji)}(hhh]h)}(hwhat to set the urb context to.h]hwhat to set the urb context to.}(hjXmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjTmhMhjUmubah}(h]h ]h"]h$]h&]uh1jhhj9mubeh}(h]h ]h"]h$]h&]uh1jHhjTmhMhjkubjI)}(hj``int interval`` what to set the urb interval to, encoded like the endpoint descriptor's bInterval value. h](jO)}(h``int interval``h]j)}(hjxmh]h int interval}(hjzmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvmubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjrmubji)}(hhh]h)}(hXwhat to set the urb interval to, encoded like the endpoint descriptor's bInterval value.h]hZwhat to set the urb interval to, encoded like the endpoint descriptor’s bInterval value.}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjmubah}(h]h ]h"]h$]h&]uh1jhhjrmubeh}(h]h ]h"]h$]h&]uh1jHhjmhMhjkubeh}(h]h ]h"]h$]h&]uh1jChjkubh)}(h**Description**h]j.)}(hjmh]h Description}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjmubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjkubh)}(hXInitializes a interrupt urb with the proper information needed to submit it to a device.h]hXInitializes a interrupt urb with the proper information needed to submit it to a device.}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjkubh)}(hZRefer to usb_fill_control_urb() for a description of the requirements for transfer_buffer.h]hZRefer to usb_fill_control_urb() for a description of the requirements for transfer_buffer.}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjkubh)}(hNote that High Speed and SuperSpeed(+) interrupt endpoints use a logarithmic encoding of the endpoint interval, and express polling intervals in microframes (eight per millisecond) rather than in frames (one per millisecond).h]hNote that High Speed and SuperSpeed(+) interrupt endpoints use a logarithmic encoding of the endpoint interval, and express polling intervals in microframes (eight per millisecond) rather than in frames (one per millisecond).}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjkubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_urb_dir_in (C function)c.usb_urb_dir_inhNtauh1jhjghhhjhNubj )}(hhh](j%)}(h$int usb_urb_dir_in (struct urb *urb)h]j+)}(h#int usb_urb_dir_in(struct urb *urb)h](jT)}(hinth]hint}(hjnhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjnhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM$ubjC)}(h h]h }(hj&nhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjnhhhj%nhM$ubj)}(husb_urb_dir_inh]j)}(husb_urb_dir_inh]husb_urb_dir_in}(hj8nhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4nubah}(h]h ](jjeh"]h$]h&]jjuh1jhjnhhhj%nhM$ubj)}(h(struct urb *urb)h]j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjTnhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjPnubjC)}(h h]h }(hjanhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjPnubh)}(hhh]j)}(hurbh]hurb}(hjrnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjonubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjtnmodnameN classnameNjLjO)}jR]jU)}jHj:nsbc.usb_urb_dir_inasbuh1hhjPnubjC)}(h h]h }(hjnhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjPnubjs)}(hjvh]h*}(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjPnubj)}(hurbh]hurb}(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjPnubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjLnubah}(h]h ]h"]h$]h&]jjuh1jhjnhhhj%nhM$ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjnhhhj%nhM$ubah}(h]j nah ](jjeh"]h$]h&]jj)jhuh1j$hj%nhM$hj nhhubj)}(hhh]h)}(h(check if an URB describes an IN transferh]h(check if an URB describes an IN transfer}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM$hjnhhubah}(h]h ]h"]h$]h&]uh1jhj nhhhj%nhM$ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjnjjnj j!j"uh1jhhhjghjhNubj$)}(h**Parameters** ``struct urb *urb`` URB to be checked **Return** 1 if **urb** describes an IN transfer (device-to-host), otherwise 0.h](h)}(h**Parameters**h]j.)}(hjnh]h Parameters}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjnubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM(hjnubjD)}(hhh]jI)}(h&``struct urb *urb`` URB to be checked h](jO)}(h``struct urb *urb``h]j)}(hjoh]hstruct urb *urb}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jhjoubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM%hjoubji)}(hhh]h)}(hURB to be checkedh]hURB to be checked}(hj1ohhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-ohM%hj.oubah}(h]h ]h"]h$]h&]uh1jhhjoubeh}(h]h ]h"]h$]h&]uh1jHhj-ohM%hjoubah}(h]h ]h"]h$]h&]uh1jChjnubh)}(h **Return**h]j.)}(hjSoh]hReturn}(hjUohhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjQoubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM'hjnubh)}(hD1 if **urb** describes an IN transfer (device-to-host), otherwise 0.h](h1 if }(hjiohhhNhNubj.)}(h**urb**h]hurb}(hjqohhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjioubh8 describes an IN transfer (device-to-host), otherwise 0.}(hjiohhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM'hjnubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_urb_dir_out (C function)c.usb_urb_dir_outhNtauh1jhjghhhjhNubj )}(hhh](j%)}(h%int usb_urb_dir_out (struct urb *urb)h]j+)}(h$int usb_urb_dir_out(struct urb *urb)h](jT)}(hinth]hint}(hjohhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjohhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM0ubjC)}(h h]h }(hjohhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjohhhjohM0ubj)}(husb_urb_dir_outh]j)}(husb_urb_dir_outh]husb_urb_dir_out}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjoubah}(h]h ](jjeh"]h$]h&]jjuh1jhjohhhjohM0ubj)}(h(struct urb *urb)h]j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjohhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjoubjC)}(h h]h }(hjohhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjoubh)}(hhh]j)}(hurbh]hurb}(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjpmodnameN classnameNjLjO)}jR]jU)}jHjosbc.usb_urb_dir_outasbuh1hhjoubjC)}(h h]h }(hj%phhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjoubjs)}(hjvh]h*}(hj3phhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjoubj)}(hurbh]hurb}(hj@phhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjoubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjoubah}(h]h ]h"]h$]h&]jjuh1jhjohhhjohM0ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjohhhjohM0ubah}(h]joah ](jjeh"]h$]h&]jj)jhuh1j$hjohM0hjohhubj)}(hhh]h)}(h)check if an URB describes an OUT transferh]h)check if an URB describes an OUT transfer}(hjjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM0hjgphhubah}(h]h ]h"]h$]h&]uh1jhjohhhjohM0ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjpjjpj j!j"uh1jhhhjghjhNubj$)}(h**Parameters** ``struct urb *urb`` URB to be checked **Return** 1 if **urb** describes an OUT transfer (host-to-device), otherwise 0.h](h)}(h**Parameters**h]j.)}(hjph]h Parameters}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjpubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM4hjpubjD)}(hhh]jI)}(h&``struct urb *urb`` URB to be checked h](jO)}(h``struct urb *urb``h]j)}(hjph]hstruct urb *urb}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1jNhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM1hjpubji)}(hhh]h)}(hURB to be checkedh]hURB to be checked}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhjphM1hjpubah}(h]h ]h"]h$]h&]uh1jhhjpubeh}(h]h ]h"]h$]h&]uh1jHhjphM1hjpubah}(h]h ]h"]h$]h&]uh1jChjpubh)}(h **Return**h]j.)}(hjph]hReturn}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjpubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM3hjpubh)}(hE1 if **urb** describes an OUT transfer (host-to-device), otherwise 0.h](h1 if }(hjphhhNhNubj.)}(h**urb**h]hurb}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjpubh9 describes an OUT transfer (host-to-device), otherwise 0.}(hjphhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM3hjpubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_sg_request (C struct)c.usb_sg_requesthNtauh1jhjghhhjhNubj )}(hhh](j%)}(husb_sg_requesth]j+)}(hstruct usb_sg_requesth](j1)}(hjh]hstruct}(hj=qhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj9qhhhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhM9ubjC)}(h h]h }(hjKqhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj9qhhhjJqhM9ubj)}(husb_sg_requesth]j)}(hj7qh]husb_sg_request}(hj]qhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjYqubah}(h]h ](jjeh"]h$]h&]jjuh1jhj9qhhhjJqhM9ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj5qhhhjJqhM9ubah}(h]j0qah ](jjeh"]h$]h&]jj)jhuh1j$hjJqhM9hj2qhhubj)}(hhh]h)}(hsupport for scatter/gather I/Oh]hsupport for scatter/gather I/O}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj|qhhubah}(h]h ]h"]h$]h&]uh1jhj2qhhhjJqhM9ubeh}(h]h ](jstructeh"]h$]h&]jjjjqjjqj j!j"uh1jhhhjghjhNubj$)}(h**Definition**:: struct usb_sg_request { int status; size_t bytes; }; **Members** ``status`` zero indicates success, else negative errno ``bytes`` counts bytes transferred.h](h)}(h**Definition**::h](j.)}(h**Definition**h]h Definition}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjqubh:}(hjqhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjqubj )}(hrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhj;rubah}(h]h ]h"]h$]h&]uh1jhhjrubeh}(h]h ]h"]h$]h&]uh1jHhj:rhMhjqubeh}(h]h ]h"]h$]h&]uh1jChjqubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjghhhjhNubh)}(h**Description**h]j.)}(hjhrh]h Description}(hjjrhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjfrubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hThese requests are initialized using usb_sg_init(), and then are used as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most members of the request object aren't for driver access.h]hThese requests are initialized using usb_sg_init(), and then are used as request handles passed to usb_sg_wait() or usb_sg_cancel(). Most members of the request object aren’t for driver access.}(hj~rhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hThe status and bytecount values are valid only after usb_sg_wait() returns. If the status is zero, then the bytecount matches the total from the request.h]hThe status and bytecount values are valid only after usb_sg_wait() returns. If the status is zero, then the bytecount matches the total from the request.}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubh)}(hVAfter an error completion, drivers may need to clear a halt condition on the endpoint.h]hVAfter an error completion, drivers may need to clear a halt condition on the endpoint.}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhW/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:136: ./include/linux/usb.hhMhjghhubeh}(h](host-side-data-types-and-macrosjYeh ]h"](host-side data types and macros usb_headereh$]h&]uh1hhhhhhhhKjc}jrjOsje}jYjOsubh)}(hhh](h)}(h USB Core APIsh]h USB Core APIs}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjrhhhhhKubh)}(hX$There are two basic I/O models in the USB API. The most elemental one is asynchronous: drivers submit requests in the form of an URB, and the URB's completion callback handles the next step. All USB transfer types support that model, although there are special cases for control URBs (which always have setup and status stages, but may not have a data stage) and isochronous URBs (which allow large packets and include per-packet fault reports). Built on top of that is synchronous API support, where a driver calls a routine that allocates one or more URBs, submits them, and waits until they complete. There are synchronous wrappers for single-buffer control and bulk transfers (which are awkward to use in some driver disconnect scenarios), and for scatterlist based streaming i/o (bulk or interrupt).h]hX&There are two basic I/O models in the USB API. The most elemental one is asynchronous: drivers submit requests in the form of an URB, and the URB’s completion callback handles the next step. All USB transfer types support that model, although there are special cases for control URBs (which always have setup and status stages, but may not have a data stage) and isochronous URBs (which allow large packets and include per-packet fault reports). Built on top of that is synchronous API support, where a driver calls a routine that allocates one or more URBs, submits them, and waits until they complete. There are synchronous wrappers for single-buffer control and bulk transfers (which are awkward to use in some driver disconnect scenarios), and for scatterlist based streaming i/o (bulk or interrupt).}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjrhhubh)}(hX^USB drivers need to provide buffers that can be used for DMA, although they don't necessarily need to provide the DMA mapping themselves. There are APIs to use used when allocating DMA buffers, which can prevent use of bounce buffers on some systems. In some cases, drivers may be able to rely on 64bit DMA to eliminate another kind of bounce buffer.h]hX`USB drivers need to provide buffers that can be used for DMA, although they don’t necessarily need to provide the DMA mapping themselves. There are APIs to use used when allocating DMA buffers, which can prevent use of bounce buffers on some systems. In some cases, drivers may be able to rely on 64bit DMA to eliminate another kind of bounce buffer.}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjrhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_init_urb (C function)c.usb_init_urbhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h#void usb_init_urb (struct urb *urb)h]j+)}(h"void usb_init_urb(struct urb *urb)h](jT)}(hvoidh]hvoid}(hjrhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjrhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKubjC)}(h h]h }(hj shhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjrhhhj shKubj)}(h usb_init_urbh]j)}(h usb_init_urbh]h usb_init_urb}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsubah}(h]h ](jjeh"]h$]h&]jjuh1jhjrhhhj shKubj)}(h(struct urb *urb)h]j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hj9shhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj5subjC)}(h h]h }(hjFshhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj5subh)}(hhh]j)}(hurbh]hurb}(hjWshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTsubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjYsmodnameN classnameNjLjO)}jR]jU)}jHjssbc.usb_init_urbasbuh1hhj5subjC)}(h h]h }(hjwshhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj5subjs)}(hjvh]h*}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj5subj)}(hurbh]hurb}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5subeh}(h]h ]h"]h$]h&]noemphjjuh1jhj1subah}(h]h ]h"]h$]h&]jjuh1jhjrhhhj shKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjrhhhj shKubah}(h]jrah ](jjeh"]h$]h&]jj)jhuh1j$hj shKhjrhhubj)}(hhh]h)}(h8initializes a urb so that it can be used by a USB driverh]h8initializes a urb so that it can be used by a USB driver}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjshhubah}(h]h ]h"]h$]h&]uh1jhjrhhhj shKubeh}(h]h ](jfunctioneh"]h$]h&]jjjjsjjsj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct urb *urb`` pointer to the urb to initialize **Description** Initializes a urb so that the USB subsystem can use it properly. If a urb is created with a call to usb_alloc_urb() it is not necessary to call this function. Only use this if you allocate the space for a struct urb on your own. If you call this function, be careful when freeing the memory for your urb that it is no longer in use by the USB core. Only use this function if you _really_ understand what you are doing.h](h)}(h**Parameters**h]j.)}(hjsh]h Parameters}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjsubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK#hjsubjD)}(hhh]jI)}(h5``struct urb *urb`` pointer to the urb to initialize h](jO)}(h``struct urb *urb``h]j)}(hjsh]hstruct urb *urb}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK hjsubji)}(hhh]h)}(h pointer to the urb to initializeh]h pointer to the urb to initialize}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhjthK hjtubah}(h]h ]h"]h$]h&]uh1jhhjsubeh}(h]h ]h"]h$]h&]uh1jHhjthK hjsubah}(h]h ]h"]h$]h&]uh1jChjsubh)}(h**Description**h]j.)}(hj8th]h Description}(hj:thhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj6tubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK"hjsubh)}(h@Initializes a urb so that the USB subsystem can use it properly.h]h@Initializes a urb so that the USB subsystem can use it properly.}(hjNthhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK!hjsubh)}(hXIf a urb is created with a call to usb_alloc_urb() it is not necessary to call this function. Only use this if you allocate the space for a struct urb on your own. If you call this function, be careful when freeing the memory for your urb that it is no longer in use by the USB core.h]hXIf a urb is created with a call to usb_alloc_urb() it is not necessary to call this function. Only use this if you allocate the space for a struct urb on your own. If you call this function, be careful when freeing the memory for your urb that it is no longer in use by the USB core.}(hj]thhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK#hjsubh)}(hEOnly use this function if you _really_ understand what you are doing.h]hEOnly use this function if you _really_ understand what you are doing.}(hjlthhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK)hjsubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_alloc_urb (C function)c.usb_alloc_urbhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h=struct urb * usb_alloc_urb (int iso_packets, gfp_t mem_flags)h]j+)}(h;struct urb *usb_alloc_urb(int iso_packets, gfp_t mem_flags)h](j1)}(hjh]hstruct}(hjthhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjthhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK8ubjC)}(h h]h }(hjthhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjthhhjthK8ubh)}(hhh]j)}(hurbh]hurb}(hjthhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjtmodnameN classnameNjLjO)}jR]jU)}jH usb_alloc_urbsbc.usb_alloc_urbasbuh1hhjthhhjthK8ubjC)}(h h]h }(hjthhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjthhhjthK8ubjs)}(hjvh]h*}(hjthhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjthhhjthK8ubj)}(h usb_alloc_urbh]j)}(hjth]h usb_alloc_urb}(hjthhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjtubah}(h]h ](jjeh"]h$]h&]jjuh1jhjthhhjthK8ubj)}(h"(int iso_packets, gfp_t mem_flags)h](j)}(hint iso_packetsh](jT)}(hinth]hint}(hjuhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjuubjC)}(h h]h }(hj#uhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjuubj)}(h iso_packetsh]h iso_packets}(hj1uhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjuubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj uubj)}(hgfp_t mem_flagsh](h)}(hhh]j)}(hgfp_th]hgfp_t}(hjMuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJuubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjOumodnameN classnameNjLjO)}jR]jtc.usb_alloc_urbasbuh1hhjFuubjC)}(h h]h }(hjkuhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjFuubj)}(h mem_flagsh]h mem_flags}(hjyuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjFuubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj uubeh}(h]h ]h"]h$]h&]jjuh1jhjthhhjthK8ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjthhhjthK8ubah}(h]jtah ](jjeh"]h$]h&]jj)jhuh1j$hjthK8hjthhubj)}(hhh]h)}(h)creates a new urb for a USB driver to useh]h)creates a new urb for a USB driver to use}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK8hjuhhubah}(h]h ]h"]h$]h&]uh1jhjthhhjthK8ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjujjuj j!j"uh1jhhhjrhNhNubj$)}(hX^**Parameters** ``int iso_packets`` number of iso packets for this urb ``gfp_t mem_flags`` the type of memory to allocate, see kmalloc() for a list of valid options for this. **Description** Creates an urb for the USB driver to use, initializes a few internal structures, increments the usage counter, and returns a pointer to it. If the driver want to use this urb for interrupt, control, or bulk endpoints, pass '0' as the number of iso packets. The driver must call usb_free_urb() when it is finished with the urb. **Return** A pointer to the new urb, or ``NULL`` if no memory is available.h](h)}(h**Parameters**h]j.)}(hjuh]h Parameters}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjuubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chK``struct urb *urb`` pointer to the urb to modify, may be NULL h](jO)}(h``struct urb *urb``h]j)}(hjyh]hstruct urb *urb}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjyubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKfhjyubji)}(hhh]h)}(h)pointer to the urb to modify, may be NULLh]h)pointer to the urb to modify, may be NULL}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhKfhjyubah}(h]h ]h"]h$]h&]uh1jhhjyubeh}(h]h ]h"]h$]h&]uh1jHhjyhKfhjyubah}(h]h ]h"]h$]h&]uh1jChjyubh)}(h**Description**h]j.)}(hjzh]h Description}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjzubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhhjyubh)}(hThis must be called whenever a urb is transferred from a device driver to a host controller driver. This allows proper reference counting to happen for urbs.h]hThis must be called whenever a urb is transferred from a device driver to a host controller driver. This allows proper reference counting to happen for urbs.}(hj*zhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKghjyubh)}(h **Return**h]j.)}(hj;zh]hReturn}(hj=zhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj9zubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKkhjyubh)}(hinterval is modified to reflect the actual transfer period used (normally some power of two units). And for isochronous urbs, urb->start_frame is modified to reflect when the URB's transfers were scheduled to start. Not all isochronous transfer scheduling policies will work, but most host controller drivers should easily handle ISO queues going from now until 10-200 msec into the future. Drivers should try to keep at least one or two msec of data in the queue; many controllers require that new transfers start at least 1 msec in the future when they are added. If the driver is unable to keep up and the queue empties out, the behavior for new submissions is governed by the URB_ISO_ASAP flag. If the flag is set, or if the queue is idle, then the URB is always assigned to the first available (and not yet expired) slot in the endpoint's schedule. If the flag is not set and the queue is active then the URB is always assigned to the next slot in the schedule following the end of the endpoint's previous URB, even if that slot is in the past. When a packet is assigned in this way to a slot that has already expired, the packet is not transmitted and the corresponding usb_iso_packet_descriptor's status field will return -EXDEV. If this would happen to all the packets in the URB, submission fails with a -EXDEV error code. For control endpoints, the synchronous usb_control_msg() call is often used (in non-interrupt context) instead of this call. That is often used through convenience wrappers, for the requests that are standardized in the USB 2.0 specification. For bulk endpoints, a synchronous usb_bulk_msg() call is available. Request Queuing: URBs may be submitted to endpoints before previous ones complete, to minimize the impact of interrupt latencies and system overhead on data throughput. With that queuing policy, an endpoint's queue would never be empty. This is required for continuous isochronous data streams, and may also be required for some kinds of interrupt transfers. Such queuing also maximizes bandwidth utilization by letting USB controllers start work on later requests before driver software has finished the completion processing for earlier (successful) requests. As of Linux 2.6, all USB endpoint transfer queues support depths greater than one. This was previously a HCD-specific behavior, except for ISO transfers. Non-isochronous endpoint queues are inactive during cleanup after faults (transfer errors or cancellation). Reserved Bandwidth Transfers: Periodic transfers (interrupt or isochronous) are performed repeatedly, using the interval specified in the urb. Submitting the first urb to the endpoint reserves the bandwidth necessary to make those transfers. If the USB subsystem can't allocate sufficient bandwidth to perform the periodic request, submitting such a periodic request should fail. For devices under xHCI, the bandwidth is reserved at configuration time, or when the alt setting is selected. If there is not enough bus bandwidth, the configuration/alt setting request will fail. Therefore, submissions to periodic endpoints on devices under xHCI should never fail due to bandwidth constraints. Device drivers must explicitly request that repetition, by ensuring that some URB is always on the endpoint's queue (except possibly for short periods during completion callbacks). When there is no longer an urb queued, the endpoint's bandwidth reservation is canceled. This means drivers can use their completion handlers to ensure they keep bandwidth they need, by reinitializing and resubmitting the just-completed urb until the driver longer needs that periodic bandwidth. Memory Flags: The general rules for how to decide which mem_flags to use are the same as for kmalloc. There are four different possible values; GFP_KERNEL, GFP_NOFS, GFP_NOIO and GFP_ATOMIC. GFP_NOFS is not ever used, as it has not been implemented yet. GFP_ATOMIC is used when (a) you are inside a completion handler, an interrupt, bottom half, tasklet or timer, or (b) you are holding a spinlock or rwlock (does not apply to semaphores), or (c) current->state != TASK_RUNNING, this is the case only after you've changed it. GFP_NOIO is used in the block io path and error handling of storage devices. All other situations use GFP_KERNEL. Some more specific rules for mem_flags can be inferred, such as (1) start_xmit, timeout, and receive methods of network drivers must use GFP_ATOMIC (they are called with a spinlock held); (2) queuecommand methods of scsi drivers must use GFP_ATOMIC (also called with a spinlock held); (3) If you use a kernel thread with a network driver you must use GFP_NOIO, unless (b) or (c) apply; (4) after you have done a down() you can use GFP_KERNEL, unless (b) or (c) apply or your are in a storage driver's block io path; (5) USB probe and disconnect can use GFP_KERNEL unless (b) or (c) apply; and (6) changing firmware on a running storage or net device uses GFP_NOIO, unless b) or c) apply **Return** 0 on successful submissions. A negative error number otherwise.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjubjD)}(hhh](jI)}(h>``struct urb *urb`` pointer to the urb describing the request h](jO)}(h``struct urb *urb``h]j)}(hjh]hstruct urb *urb}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjubji)}(hhh]h)}(h)pointer to the urb describing the requesth]h)pointer to the urb describing the request}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0hKhj1ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj0hKhjubjI)}(hh``gfp_t mem_flags`` the type of memory to allocate, see kmalloc() for a list of valid options for this. h](jO)}(h``gfp_t mem_flags``h]j)}(hjTh]hgfp_t mem_flags}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjNubji)}(hhh]h)}(hSthe type of memory to allocate, see kmalloc() for a list of valid options for this.h]hSthe type of memory to allocate, see kmalloc() for a list of valid options for this.}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjjubah}(h]h ]h"]h$]h&]uh1jhhjNubeh}(h]h ]h"]h$]h&]uh1jHhjihKhjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjubh)}(hXLThis submits a transfer request, and transfers control of the URB describing that request to the USB subsystem. Request completion will be indicated later, asynchronously, by calling the completion handler. The three types of completion are success, error, and unlink (a software-induced fault, also called "request cancellation").h]hXPThis submits a transfer request, and transfers control of the URB describing that request to the USB subsystem. Request completion will be indicated later, asynchronously, by calling the completion handler. The three types of completion are success, error, and unlink (a software-induced fault, also called “request cancellation”).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjubh)}(h+URBs may be submitted in interrupt context.h]h+URBs may be submitted in interrupt context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjubh)}(hX)The caller must have correctly initialized the URB before submitting it. Functions such as usb_fill_bulk_urb() and usb_fill_control_urb() are available to ensure that most fields are correctly initialized, for the particular kind of transfer, although they will not initialize any transfer flags.h]hX)The caller must have correctly initialized the URB before submitting it. Functions such as usb_fill_bulk_urb() and usb_fill_control_urb() are available to ensure that most fields are correctly initialized, for the particular kind of transfer, although they will not initialize any transfer flags.}(hjăhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjubh)}(hXlIf the submission is successful, the complete() callback from the URB will be called exactly once, when the USB core and Host Controller Driver (HCD) are finished with the URB. When the completion function is called, control of the URB is returned to the device driver which issued the request. The completion handler may then immediately free or reuse that URB.h]hXlIf the submission is successful, the complete() callback from the URB will be called exactly once, when the USB core and Host Controller Driver (HCD) are finished with the URB. When the completion function is called, control of the URB is returned to the device driver which issued the request. The completion handler may then immediately free or reuse that URB.}(hjӃhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chKhjubh)}(hXWith few exceptions, USB device drivers should never access URB fields provided by usbcore or the HCD until its complete() is called. The exceptions relate to periodic transfer scheduling. For both interrupt and isochronous urbs, as part of successful URB submission urb->interval is modified to reflect the actual transfer period used (normally some power of two units). And for isochronous urbs, urb->start_frame is modified to reflect when the URB's transfers were scheduled to start.h]hXWith few exceptions, USB device drivers should never access URB fields provided by usbcore or the HCD until its complete() is called. The exceptions relate to periodic transfer scheduling. For both interrupt and isochronous urbs, as part of successful URB submission urb->interval is modified to reflect the actual transfer period used (normally some power of two units). And for isochronous urbs, urb->start_frame is modified to reflect when the URB’s transfers were scheduled to start.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hX`Not all isochronous transfer scheduling policies will work, but most host controller drivers should easily handle ISO queues going from now until 10-200 msec into the future. Drivers should try to keep at least one or two msec of data in the queue; many controllers require that new transfers start at least 1 msec in the future when they are added. If the driver is unable to keep up and the queue empties out, the behavior for new submissions is governed by the URB_ISO_ASAP flag. If the flag is set, or if the queue is idle, then the URB is always assigned to the first available (and not yet expired) slot in the endpoint's schedule. If the flag is not set and the queue is active then the URB is always assigned to the next slot in the schedule following the end of the endpoint's previous URB, even if that slot is in the past. When a packet is assigned in this way to a slot that has already expired, the packet is not transmitted and the corresponding usb_iso_packet_descriptor's status field will return -EXDEV. If this would happen to all the packets in the URB, submission fails with a -EXDEV error code.h]hXfNot all isochronous transfer scheduling policies will work, but most host controller drivers should easily handle ISO queues going from now until 10-200 msec into the future. Drivers should try to keep at least one or two msec of data in the queue; many controllers require that new transfers start at least 1 msec in the future when they are added. If the driver is unable to keep up and the queue empties out, the behavior for new submissions is governed by the URB_ISO_ASAP flag. If the flag is set, or if the queue is idle, then the URB is always assigned to the first available (and not yet expired) slot in the endpoint’s schedule. If the flag is not set and the queue is active then the URB is always assigned to the next slot in the schedule following the end of the endpoint’s previous URB, even if that slot is in the past. When a packet is assigned in this way to a slot that has already expired, the packet is not transmitted and the corresponding usb_iso_packet_descriptor’s status field will return -EXDEV. If this would happen to all the packets in the URB, submission fails with a -EXDEV error code.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM hjubh)}(hX7For control endpoints, the synchronous usb_control_msg() call is often used (in non-interrupt context) instead of this call. That is often used through convenience wrappers, for the requests that are standardized in the USB 2.0 specification. For bulk endpoints, a synchronous usb_bulk_msg() call is available.h]hX7For control endpoints, the synchronous usb_control_msg() call is often used (in non-interrupt context) instead of this call. That is often used through convenience wrappers, for the requests that are standardized in the USB 2.0 specification. For bulk endpoints, a synchronous usb_bulk_msg() call is available.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hRequest Queuing:h]hRequest Queuing:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM"hjubh)}(hX"URBs may be submitted to endpoints before previous ones complete, to minimize the impact of interrupt latencies and system overhead on data throughput. With that queuing policy, an endpoint's queue would never be empty. This is required for continuous isochronous data streams, and may also be required for some kinds of interrupt transfers. Such queuing also maximizes bandwidth utilization by letting USB controllers start work on later requests before driver software has finished the completion processing for earlier (successful) requests.h]hX$URBs may be submitted to endpoints before previous ones complete, to minimize the impact of interrupt latencies and system overhead on data throughput. With that queuing policy, an endpoint’s queue would never be empty. This is required for continuous isochronous data streams, and may also be required for some kinds of interrupt transfers. Such queuing also maximizes bandwidth utilization by letting USB controllers start work on later requests before driver software has finished the completion processing for earlier (successful) requests.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM$hjubh)}(hXAs of Linux 2.6, all USB endpoint transfer queues support depths greater than one. This was previously a HCD-specific behavior, except for ISO transfers. Non-isochronous endpoint queues are inactive during cleanup after faults (transfer errors or cancellation).h]hXAs of Linux 2.6, all USB endpoint transfer queues support depths greater than one. This was previously a HCD-specific behavior, except for ISO transfers. Non-isochronous endpoint queues are inactive during cleanup after faults (transfer errors or cancellation).}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM-hjubh)}(hReserved Bandwidth Transfers:h]hReserved Bandwidth Transfers:}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM2hjubh)}(hX^Periodic transfers (interrupt or isochronous) are performed repeatedly, using the interval specified in the urb. Submitting the first urb to the endpoint reserves the bandwidth necessary to make those transfers. If the USB subsystem can't allocate sufficient bandwidth to perform the periodic request, submitting such a periodic request should fail.h]hX`Periodic transfers (interrupt or isochronous) are performed repeatedly, using the interval specified in the urb. Submitting the first urb to the endpoint reserves the bandwidth necessary to make those transfers. If the USB subsystem can’t allocate sufficient bandwidth to perform the periodic request, submitting such a periodic request should fail.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM4hjubh)}(hX9For devices under xHCI, the bandwidth is reserved at configuration time, or when the alt setting is selected. If there is not enough bus bandwidth, the configuration/alt setting request will fail. Therefore, submissions to periodic endpoints on devices under xHCI should never fail due to bandwidth constraints.h]hX9For devices under xHCI, the bandwidth is reserved at configuration time, or when the alt setting is selected. If there is not enough bus bandwidth, the configuration/alt setting request will fail. Therefore, submissions to periodic endpoints on devices under xHCI should never fail due to bandwidth constraints.}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM:hjubh)}(hXDevice drivers must explicitly request that repetition, by ensuring that some URB is always on the endpoint's queue (except possibly for short periods during completion callbacks). When there is no longer an urb queued, the endpoint's bandwidth reservation is canceled. This means drivers can use their completion handlers to ensure they keep bandwidth they need, by reinitializing and resubmitting the just-completed urb until the driver longer needs that periodic bandwidth.h]hXDevice drivers must explicitly request that repetition, by ensuring that some URB is always on the endpoint’s queue (except possibly for short periods during completion callbacks). When there is no longer an urb queued, the endpoint’s bandwidth reservation is canceled. This means drivers can use their completion handlers to ensure they keep bandwidth they need, by reinitializing and resubmitting the just-completed urb until the driver longer needs that periodic bandwidth.}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM@hjubh)}(h Memory Flags:h]h Memory Flags:}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMHhjubh)}(hThe general rules for how to decide which mem_flags to use are the same as for kmalloc. There are four different possible values; GFP_KERNEL, GFP_NOFS, GFP_NOIO and GFP_ATOMIC.h]hThe general rules for how to decide which mem_flags to use are the same as for kmalloc. There are four different possible values; GFP_KERNEL, GFP_NOFS, GFP_NOIO and GFP_ATOMIC.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMJhjubh)}(h>GFP_NOFS is not ever used, as it has not been implemented yet.h]h>GFP_NOFS is not ever used, as it has not been implemented yet.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMOhjubjD)}(hhh]jI)}(hXGFP_ATOMIC is used when (a) you are inside a completion handler, an interrupt, bottom half, tasklet or timer, or (b) you are holding a spinlock or rwlock (does not apply to semaphores), or (c) current->state != TASK_RUNNING, this is the case only after you've changed it. h](jO)}(hGFP_ATOMIC is used whenh]hGFP_ATOMIC is used when}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMWhjubji)}(hhh]henumerated_list)}(hhh](j)}(hTyou are inside a completion handler, an interrupt, bottom half, tasklet or timer, orh]h)}(hTyou are inside a completion handler, an interrupt, bottom half, tasklet or timer, orh]hTyou are inside a completion handler, an interrupt, bottom half, tasklet or timer, or}(hjDŽhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMRhjÄubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hGyou are holding a spinlock or rwlock (does not apply to semaphores), orh]h)}(AhGyou are holding a spinlock or rwlock (does not apply to semaphores), orh]hGyou are holding a spinlock or rwlock (does not apply to semaphores), or}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMThj܄ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hOcurrent->state != TASK_RUNNING, this is the case only after you've changed it. h]h)}(hNcurrent->state != TASK_RUNNING, this is the case only after you've changed it.h]hPcurrent->state != TASK_RUNNING, this is the case only after you’ve changed it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMVhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]enumtype loweralphaprefix(suffix)uh1jhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMWhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(hLGFP_NOIO is used in the block io path and error handling of storage devices.h]hLGFP_NOIO is used in the block io path and error handling of storage devices.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMYhjubh)}(h$All other situations use GFP_KERNEL.h]h$All other situations use GFP_KERNEL.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM\hjubjD)}(hhh]jI)}(hXSome more specific rules for mem_flags can be inferred, such as (1) start_xmit, timeout, and receive methods of network drivers must use GFP_ATOMIC (they are called with a spinlock held); (2) queuecommand methods of scsi drivers must use GFP_ATOMIC (also called with a spinlock held); (3) If you use a kernel thread with a network driver you must use GFP_NOIO, unless (b) or (c) apply; (4) after you have done a down() you can use GFP_KERNEL, unless (b) or (c) apply or your are in a storage driver's block io path; (5) USB probe and disconnect can use GFP_KERNEL unless (b) or (c) apply; and (6) changing firmware on a running storage or net device uses GFP_NOIO, unless b) or c) apply h](jO)}(h?Some more specific rules for mem_flags can be inferred, such ash]h?Some more specific rules for mem_flags can be inferred, such as}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMihjMubji)}(hhh]j)}(hhh](j)}(hwstart_xmit, timeout, and receive methods of network drivers must use GFP_ATOMIC (they are called with a spinlock held);h]h)}(hwstart_xmit, timeout, and receive methods of network drivers must use GFP_ATOMIC (they are called with a spinlock held);h]hwstart_xmit, timeout, and receive methods of network drivers must use GFP_ATOMIC (they are called with a spinlock held);}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM_hjfubah}(h]h ]h"]h$]h&]uh1jhjcubj)}(h\queuecommand methods of scsi drivers must use GFP_ATOMIC (also called with a spinlock held);h]h)}(h\queuecommand methods of scsi drivers must use GFP_ATOMIC (also called with a spinlock held);h]h\queuecommand methods of scsi drivers must use GFP_ATOMIC (also called with a spinlock held);}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMahjubah}(h]h ]h"]h$]h&]uh1jhjcubj)}(h`If you use a kernel thread with a network driver you must use GFP_NOIO, unless (b) or (c) apply;h]h)}(h`If you use a kernel thread with a network driver you must use GFP_NOIO, unless (b) or (c) apply;h]h`If you use a kernel thread with a network driver you must use GFP_NOIO, unless (b) or (c) apply;}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMchjubah}(h]h ]h"]h$]h&]uh1jhjcubj)}(h}after you have done a down() you can use GFP_KERNEL, unless (b) or (c) apply or your are in a storage driver's block io path;h]h)}(h}after you have done a down() you can use GFP_KERNEL, unless (b) or (c) apply or your are in a storage driver's block io path;h]hafter you have done a down() you can use GFP_KERNEL, unless (b) or (c) apply or your are in a storage driver’s block io path;}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMehjubah}(h]h ]h"]h$]h&]uh1jhjcubj)}(hHUSB probe and disconnect can use GFP_KERNEL unless (b) or (c) apply; andh]h)}(hj̅h]hHUSB probe and disconnect can use GFP_KERNEL unless (b) or (c) apply; and}(hj΅hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMghjʅubah}(h]h ]h"]h$]h&]uh1jhjcubj)}(hZchanging firmware on a running storage or net device uses GFP_NOIO, unless b) or c) apply h]h)}(hYchanging firmware on a running storage or net device uses GFP_NOIO, unless b) or c) applyh]hYchanging firmware on a running storage or net device uses GFP_NOIO, unless b) or c) apply}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhhjubah}(h]h ]h"]h$]h&]uh1jhjcubeh}(h]h ]h"]h$]h&]jarabicjjjjuh1jhj`ubah}(h]h ]h"]h$]h&]uh1jhhjMubeh}(h]h ]h"]h$]h&]uh1jHhj_hMihjJubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMkhjubh)}(h?0 on successful submissions. A negative error number otherwise.h]h?0 on successful submissions. A negative error number otherwise.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM"hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_unlink_urb (C function)c.usb_unlink_urbhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h$int usb_unlink_urb (struct urb *urb)h]j+)}(h#int usb_unlink_urb(struct urb *urb)h](jT)}(hinth]hint}(hj[hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjWhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMQubjC)}(h h]h }(hjjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjWhhhjihMQubj)}(husb_unlink_urbh]j)}(husb_unlink_urbh]husb_unlink_urb}(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubah}(h]h ](jjeh"]h$]h&]jjuh1jhjWhhhjihMQubj)}(h(struct urb *urb)h]j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(hurbh]hurb}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jU)}jHj~sbc.usb_unlink_urbasbuh1hhjubjC)}(h h]h }(hjֆhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hurbh]hurb}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjWhhhjihMQubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjShhhjihMQubah}(h]jNah ](jjeh"]h$]h&]jj)jhuh1j$hjihMQhjPhhubj)}(hhh]h)}(h/abort/cancel a transfer request for an endpointh]h/abort/cancel a transfer request for an endpoint}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMQhjhhubah}(h]h ]h"]h$]h&]uh1jhjPhhhjihMQubeh}(h]h ](jfunctioneh"]h$]h&]jjjj3jj3j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct urb *urb`` pointer to urb describing a previously submitted request, may be NULL **Description** This routine cancels an in-progress request. URBs complete only once per submission, and may be canceled only once per submission. Successful cancellation means termination of **urb** will be expedited and the completion handler will be called with a status code indicating that the request has been canceled (rather than any other code). Drivers should not call this routine or related routines, such as usb_kill_urb(), after their disconnect method has returned. The disconnect function should synchronize with a driver's I/O routines to insure that all URB-related activity has completed before it returns. This request is asynchronous, however the HCD might call the ->complete() callback during unlink. Therefore when drivers call usb_unlink_urb(), they must not hold any locks that may be taken by the completion function. Success is indicated by returning -EINPROGRESS, at which time the URB will probably not yet have been given back to the device driver. When it is eventually called, the completion function will see **urb->status** == -ECONNRESET. Failure is indicated by usb_unlink_urb() returning any other value. Unlinking will fail when **urb** is not currently "linked" (i.e., it was never submitted, or it was unlinked before, or the hardware is already finished with it), even if the completion handler has not yet run. The URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB. Unlinking and Endpoint Queues: [The behaviors and guarantees described below do not apply to virtual root hubs but only to endpoint queues for physical USB devices.] Host Controller Drivers (HCDs) place all the URBs for a particular endpoint in a queue. Normally the queue advances as the controller hardware processes each request. But when an URB terminates with an error its queue generally stops (see below), at least until that URB's completion routine returns. It is guaranteed that a stopped queue will not restart until all its unlinked URBs have been fully retired, with their completion routines run, even if that's not until some time after the original completion handler returns. The same behavior and guarantee apply when an URB terminates because it was unlinked. Bulk and interrupt endpoint queues are guaranteed to stop whenever an URB terminates with any sort of error, including -ECONNRESET, -ENOENT, and -EREMOTEIO. Control endpoint queues behave the same way except that they are not guaranteed to stop for -EREMOTEIO errors. Queues for isochronous endpoints are treated differently, because they must advance at fixed rates. Such queues do not stop when an URB encounters an error or is unlinked. An unlinked isochronous URB may leave a gap in the stream of packets; it is undefined whether such gaps can be filled in. Note that early termination of an URB because a short packet was received will generate a -EREMOTEIO error if and only if the URB_SHORT_NOT_OK flag is set. By setting this flag, USB device drivers can build deep queues for large or complex bulk transfers and clean them up reliably after any sort of aborted transfer by unlinking all pending URBs at the first fault. When a control URB terminates with an error other than -EREMOTEIO, it is quite likely that the status stage of the transfer will not take place. **Return** -EINPROGRESS on success. See description for other values on failure.h](h)}(h**Parameters**h]j.)}(hj=h]h Parameters}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj;ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMUhj7ubjD)}(hhh]jI)}(hZ``struct urb *urb`` pointer to urb describing a previously submitted request, may be NULL h](jO)}(h``struct urb *urb``h]j)}(hj\h]hstruct urb *urb}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMShjVubji)}(hhh]h)}(hEpointer to urb describing a previously submitted request, may be NULLh]hEpointer to urb describing a previously submitted request, may be NULL}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMRhjrubah}(h]h ]h"]h$]h&]uh1jhhjVubeh}(h]h ]h"]h$]h&]uh1jHhjqhMShjSubah}(h]h ]h"]h$]h&]uh1jChj7ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMUhj7ubh)}(hXSThis routine cancels an in-progress request. URBs complete only once per submission, and may be canceled only once per submission. Successful cancellation means termination of **urb** will be expedited and the completion handler will be called with a status code indicating that the request has been canceled (rather than any other code).h](hThis routine cancels an in-progress request. URBs complete only once per submission, and may be canceled only once per submission. Successful cancellation means termination of }(hjhhhNhNubj.)}(h**urb**h]hurb}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh will be expedited and the completion handler will be called with a status code indicating that the request has been canceled (rather than any other code).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMThj7ubh)}(hXDrivers should not call this routine or related routines, such as usb_kill_urb(), after their disconnect method has returned. The disconnect function should synchronize with a driver's I/O routines to insure that all URB-related activity has completed before it returns.h]hXDrivers should not call this routine or related routines, such as usb_kill_urb(), after their disconnect method has returned. The disconnect function should synchronize with a driver’s I/O routines to insure that all URB-related activity has completed before it returns.}(hjχhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM[hj7ubh)}(hXThis request is asynchronous, however the HCD might call the ->complete() callback during unlink. Therefore when drivers call usb_unlink_urb(), they must not hold any locks that may be taken by the completion function. Success is indicated by returning -EINPROGRESS, at which time the URB will probably not yet have been given back to the device driver. When it is eventually called, the completion function will see **urb->status** == -ECONNRESET. Failure is indicated by usb_unlink_urb() returning any other value. Unlinking will fail when **urb** is not currently "linked" (i.e., it was never submitted, or it was unlinked before, or the hardware is already finished with it), even if the completion handler has not yet run.h](hXThis request is asynchronous, however the HCD might call the ->complete() callback during unlink. Therefore when drivers call usb_unlink_urb(), they must not hold any locks that may be taken by the completion function. Success is indicated by returning -EINPROGRESS, at which time the URB will probably not yet have been given back to the device driver. When it is eventually called, the completion function will see }(hjއhhhNhNubj.)}(h**urb->status**h]h urb->status}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjއubhn == -ECONNRESET. Failure is indicated by usb_unlink_urb() returning any other value. Unlinking will fail when }(hjއhhhNhNubj.)}(h**urb**h]hurb}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjއubh is not currently “linked” (i.e., it was never submitted, or it was unlinked before, or the hardware is already finished with it), even if the completion handler has not yet run.}(hjއhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM`hj7ubh)}(hThe URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.h]hThe URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMlhj7ubh)}(hUnlinking and Endpoint Queues:h]hUnlinking and Endpoint Queues:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMqhj7ubh)}(h[The behaviors and guarantees described below do not apply to virtual root hubs but only to endpoint queues for physical USB devices.]h]h[The behaviors and guarantees described below do not apply to virtual root hubs but only to endpoint queues for physical USB devices.]}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMshj7ubh)}(hXhHost Controller Drivers (HCDs) place all the URBs for a particular endpoint in a queue. Normally the queue advances as the controller hardware processes each request. But when an URB terminates with an error its queue generally stops (see below), at least until that URB's completion routine returns. It is guaranteed that a stopped queue will not restart until all its unlinked URBs have been fully retired, with their completion routines run, even if that's not until some time after the original completion handler returns. The same behavior and guarantee apply when an URB terminates because it was unlinked.h]hXlHost Controller Drivers (HCDs) place all the URBs for a particular endpoint in a queue. Normally the queue advances as the controller hardware processes each request. But when an URB terminates with an error its queue generally stops (see below), at least until that URB’s completion routine returns. It is guaranteed that a stopped queue will not restart until all its unlinked URBs have been fully retired, with their completion routines run, even if that’s not until some time after the original completion handler returns. The same behavior and guarantee apply when an URB terminates because it was unlinked.}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMvhj7ubh)}(hX5Bulk and interrupt endpoint queues are guaranteed to stop whenever an URB terminates with any sort of error, including -ECONNRESET, -ENOENT, and -EREMOTEIO. Control endpoint queues behave the same way except that they are not guaranteed to stop for -EREMOTEIO errors. Queues for isochronous endpoints are treated differently, because they must advance at fixed rates. Such queues do not stop when an URB encounters an error or is unlinked. An unlinked isochronous URB may leave a gap in the stream of packets; it is undefined whether such gaps can be filled in.h]hX5Bulk and interrupt endpoint queues are guaranteed to stop whenever an URB terminates with any sort of error, including -ECONNRESET, -ENOENT, and -EREMOTEIO. Control endpoint queues behave the same way except that they are not guaranteed to stop for -EREMOTEIO errors. Queues for isochronous endpoints are treated differently, because they must advance at fixed rates. Such queues do not stop when an URB encounters an error or is unlinked. An unlinked isochronous URB may leave a gap in the stream of packets; it is undefined whether such gaps can be filled in.}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj7ubh)}(hXoNote that early termination of an URB because a short packet was received will generate a -EREMOTEIO error if and only if the URB_SHORT_NOT_OK flag is set. By setting this flag, USB device drivers can build deep queues for large or complex bulk transfers and clean them up reliably after any sort of aborted transfer by unlinking all pending URBs at the first fault.h]hXoNote that early termination of an URB because a short packet was received will generate a -EREMOTEIO error if and only if the URB_SHORT_NOT_OK flag is set. By setting this flag, USB device drivers can build deep queues for large or complex bulk transfers and clean them up reliably after any sort of aborted transfer by unlinking all pending URBs at the first fault.}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj7ubh)}(hWhen a control URB terminates with an error other than -EREMOTEIO, it is quite likely that the status stage of the transfer will not take place.h]hWhen a control URB terminates with an error other than -EREMOTEIO, it is quite likely that the status stage of the transfer will not take place.}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj7ubh)}(h **Return**h]j.)}(hj|h]hReturn}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjzubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj7ubh)}(hE-EINPROGRESS on success. See description for other values on failure.h]hE-EINPROGRESS on success. See description for other values on failure.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMqhj7ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_kill_urb (C function)c.usb_kill_urbhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h#void usb_kill_urb (struct urb *urb)h]j+)}(h"void usb_kill_urb(struct urb *urb)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMubjC)}(h h]h }(hjЈhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjψhMubj)}(h usb_kill_urbh]j)}(h usb_kill_urbh]h usb_kill_urb}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjވubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjψhMubj)}(h(struct urb *urb)h]j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(hurbh]hurb}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jU)}jHjsbc.usb_kill_urbasbuh1hhjubjC)}(h h]h }(hj<hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjJhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hurbh]hurb}(hjWhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjψhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjψhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjψhMhjhhubj)}(hhh]h)}(h3cancel a transfer request and wait for it to finishh]h3cancel a transfer request and wait for it to finish}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj~hhubah}(h]h ]h"]h$]h&]uh1jhjhhhjψhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct urb *urb`` pointer to URB describing a previously submitted request, may be NULL **Description** This routine cancels an in-progress request. It is guaranteed that upon return all completion handlers will have finished and the URB will be totally idle and available for reuse. These features make this an ideal way to stop I/O in a disconnect() callback or close() function. If the request has not already finished or been unlinked the completion handler will see urb->status == -ENOENT. While the routine is running, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB's completion handler always tries to resubmit, it will not succeed and the URB will become idle. The URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB. This routine may not be used in an interrupt context (such as a bottom half or a completion handler), or when holding a spinlock, or in other situations where the caller can't schedule(). This routine should not be called by a driver after its disconnect method has returned.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubjD)}(hhh]jI)}(hZ``struct urb *urb`` pointer to URB describing a previously submitted request, may be NULL h](jO)}(h``struct urb *urb``h]j)}(hj‰h]hstruct urb *urb}(hjĉhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubji)}(hhh]h)}(hEpointer to URB describing a previously submitted request, may be NULLh]hEpointer to URB describing a previously submitted request, may be NULL}(hjۉhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj؉ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj׉hMhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hXThis routine cancels an in-progress request. It is guaranteed that upon return all completion handlers will have finished and the URB will be totally idle and available for reuse. These features make this an ideal way to stop I/O in a disconnect() callback or close() function. If the request has not already finished or been unlinked the completion handler will see urb->status == -ENOENT.h]hXThis routine cancels an in-progress request. It is guaranteed that upon return all completion handlers will have finished and the URB will be totally idle and available for reuse. These features make this an ideal way to stop I/O in a disconnect() callback or close() function. If the request has not already finished or been unlinked the completion handler will see urb->status == -ENOENT.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hWhile the routine is running, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB's completion handler always tries to resubmit, it will not succeed and the URB will become idle.h]hWhile the routine is running, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB’s completion handler always tries to resubmit, it will not succeed and the URB will become idle.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hThe URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.h]hThe URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hThis routine may not be used in an interrupt context (such as a bottom half or a completion handler), or when holding a spinlock, or in other situations where the caller can't schedule().h]hThis routine may not be used in an interrupt context (such as a bottom half or a completion handler), or when holding a spinlock, or in other situations where the caller can’t schedule().}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hWThis routine should not be called by a driver after its disconnect method has returned.h]hWThis routine should not be called by a driver after its disconnect method has returned.}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_poison_urb (C function)c.usb_poison_urbhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h%void usb_poison_urb (struct urb *urb)h]j+)}(h$void usb_poison_urb(struct urb *urb)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj{hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj{hhhjhMubj)}(husb_poison_urbh]j)}(husb_poison_urbh]husb_poison_urb}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhj{hhhjhMubj)}(h(struct urb *urb)h]j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjɊhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(hurbh]hurb}(hjڊhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj׊ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj܊modnameN classnameNjLjO)}jR]jU)}jHjsbc.usb_poison_urbasbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hurbh]hurb}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhj{hhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjwhhhjhMubah}(h]jrah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjthhubj)}(hhh]h)}(h:reliably kill a transfer and prevent further use of an URBh]h:reliably kill a transfer and prevent further use of an URB}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj<hhubah}(h]h ]h"]h$]h&]uh1jhjthhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjWjjWj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct urb *urb`` pointer to URB describing a previously submitted request, may be NULL **Description** This routine cancels an in-progress request. It is guaranteed that upon return all completion handlers will have finished and the URB will be totally idle and cannot be reused. These features make this an ideal way to stop I/O in a disconnect() callback. If the request has not already finished or been unlinked the completion handler will see urb->status == -ENOENT. After and while the routine runs, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB's completion handler always tries to resubmit, it will not succeed and the URB will become idle. The URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB. This routine may not be used in an interrupt context (such as a bottom half or a completion handler), or when holding a spinlock, or in other situations where the caller can't schedule(). This routine should not be called by a driver after its disconnect method has returned.h](h)}(h**Parameters**h]j.)}(hjah]h Parameters}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj_ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj[ubjD)}(hhh]jI)}(hZ``struct urb *urb`` pointer to URB describing a previously submitted request, may be NULL h](jO)}(h``struct urb *urb``h]j)}(hjh]hstruct urb *urb}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjzubji)}(hhh]h)}(hEpointer to URB describing a previously submitted request, may be NULLh]hEpointer to URB describing a previously submitted request, may be NULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubah}(h]h ]h"]h$]h&]uh1jhhjzubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjwubah}(h]h ]h"]h$]h&]uh1jChj[ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj[ubh)}(hXqThis routine cancels an in-progress request. It is guaranteed that upon return all completion handlers will have finished and the URB will be totally idle and cannot be reused. These features make this an ideal way to stop I/O in a disconnect() callback. If the request has not already finished or been unlinked the completion handler will see urb->status == -ENOENT.h]hXqThis routine cancels an in-progress request. It is guaranteed that upon return all completion handlers will have finished and the URB will be totally idle and cannot be reused. These features make this an ideal way to stop I/O in a disconnect() callback. If the request has not already finished or been unlinked the completion handler will see urb->status == -ENOENT.}(hjҋhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj[ubh)}(hAfter and while the routine runs, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB's completion handler always tries to resubmit, it will not succeed and the URB will become idle.h]hAfter and while the routine runs, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB’s completion handler always tries to resubmit, it will not succeed and the URB will become idle.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj[ubh)}(hThe URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.h]hThe URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj[ubh)}(hThis routine may not be used in an interrupt context (such as a bottom half or a completion handler), or when holding a spinlock, or in other situations where the caller can't schedule().h]hThis routine may not be used in an interrupt context (such as a bottom half or a completion handler), or when holding a spinlock, or in other situations where the caller can’t schedule().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj[ubh)}(hWThis routine should not be called by a driver after its disconnect method has returned.h]hWThis routine should not be called by a driver after its disconnect method has returned.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj[ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jusb_block_urb (C function)c.usb_block_urbhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h$void usb_block_urb (struct urb *urb)h]j+)}(h#void usb_block_urb(struct urb *urb)h](jT)}(hvoidh]hvoid}(hj=hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj9hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM ubjC)}(h h]h }(hjLhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj9hhhjKhM ubj)}(h usb_block_urbh]j)}(h usb_block_urbh]h usb_block_urb}(hj^hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubah}(h]h ](jjeh"]h$]h&]jjuh1jhj9hhhjKhM ubj)}(h(struct urb *urb)h]j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjzhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjvubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjvubh)}(hhh]j)}(hurbh]hurb}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jU)}jHj`sbc.usb_block_urbasbuh1hhjvubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjvubjs)}(hjvh]h*}(hjƌhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjvubj)}(hurbh]hurb}(hjӌhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjrubah}(h]h ]h"]h$]h&]jjuh1jhj9hhhjKhM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj5hhhjKhM ubah}(h]j0ah ](jjeh"]h$]h&]jj)jhuh1j$hjKhM hj2hhubj)}(hhh]h)}(h&reliably prevent further use of an URBh]h&reliably prevent further use of an URB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM hjhhubah}(h]h ]h"]h$]h&]uh1jhj2hhhjKhM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct urb *urb`` pointer to URB to be blocked, may be NULL **Description** After the routine has run, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB's completion handler always tries to resubmit, it will not succeed and the URB will become idle. The URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubjD)}(hhh]jI)}(h>``struct urb *urb`` pointer to URB to be blocked, may be NULL h](jO)}(h``struct urb *urb``h]j)}(hj>h]hstruct urb *urb}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj8ubji)}(hhh]h)}(h)pointer to URB to be blocked, may be NULLh]h)pointer to URB to be blocked, may be NULL}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjShMhjTubah}(h]h ]h"]h$]h&]uh1jhhj8ubeh}(h]h ]h"]h$]h&]uh1jHhjShMhj5ubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjyh]h Description}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjwubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hAfter the routine has run, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB's completion handler always tries to resubmit, it will not succeed and the URB will become idle.h]hAfter the routine has run, attempts to resubmit the URB will fail with error -EPERM. Thus even if the URB’s completion handler always tries to resubmit, it will not succeed and the URB will become idle.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hThe URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.h]hThe URB must not be deallocated while this routine is running. In particular, when a driver calls this routine, it must insure that the completion handler cannot deallocate the URB.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#usb_kill_anchored_urbs (C function)c.usb_kill_anchored_urbshNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h7void usb_kill_anchored_urbs (struct usb_anchor *anchor)h]j+)}(h6void usb_kill_anchored_urbs(struct usb_anchor *anchor)h](jT)}(hvoidh]hvoid}(hj͍hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjɍhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM"ubjC)}(h h]h }(hj܍hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjɍhhhjۍhM"ubj)}(husb_kill_anchored_urbsh]j)}(husb_kill_anchored_urbsh]husb_kill_anchored_urbs}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjɍhhhjۍhM"ubj)}(h(struct usb_anchor *anchor)h]j)}(hstruct usb_anchor *anchorh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_anchorh]h usb_anchor}(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj*modnameN classnameNjLjO)}jR]jU)}jHjsbc.usb_kill_anchored_urbsasbuh1hhjubjC)}(h h]h }(hjHhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hanchorh]hanchor}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjɍhhhjۍhM"ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjōhhhjۍhM"ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjۍhM"hjhhubj)}(hhh]h)}(h'kill all URBs associated with an anchorh]h'kill all URBs associated with an anchor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM"hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjۍhM"ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hXh**Parameters** ``struct usb_anchor *anchor`` anchor the requests are bound to **Description** This kills all outstanding URBs starting from the back of the queue, with guarantee that no completer callbacks will take place from the anchor after this function returns. This routine should not be called by a driver after its disconnect method has returned.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM&hjubjD)}(hhh]jI)}(h?``struct usb_anchor *anchor`` anchor the requests are bound to h](jO)}(h``struct usb_anchor *anchor``h]j)}(hjΎh]hstruct usb_anchor *anchor}(hjЎhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj̎ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM#hjȎubji)}(hhh]h)}(h anchor the requests are bound toh]h anchor the requests are bound to}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM#hjubah}(h]h ]h"]h$]h&]uh1jhhjȎubeh}(h]h ]h"]h$]h&]uh1jHhjhM#hjŎubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM%hjubh)}(hThis kills all outstanding URBs starting from the back of the queue, with guarantee that no completer callbacks will take place from the anchor after this function returns.h]hThis kills all outstanding URBs starting from the back of the queue, with guarantee that no completer callbacks will take place from the anchor after this function returns.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM$hjubh)}(hWThis routine should not be called by a driver after its disconnect method has returned.h]hWThis routine should not be called by a driver after its disconnect method has returned.}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chM(hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j%usb_poison_anchored_urbs (C function)c.usb_poison_anchored_urbshNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h9void usb_poison_anchored_urbs (struct usb_anchor *anchor)h]j+)}(h8void usb_poison_anchored_urbs(struct usb_anchor *anchor)h](jT)}(hvoidh]hvoid}(hj]hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjYhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMHubjC)}(h h]h }(hjlhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjYhhhjkhMHubj)}(husb_poison_anchored_urbsh]j)}(husb_poison_anchored_urbsh]husb_poison_anchored_urbs}(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzubah}(h]h ](jjeh"]h$]h&]jjuh1jhjYhhhjkhMHubj)}(h(struct usb_anchor *anchor)h]j)}(hstruct usb_anchor *anchorh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_anchorh]h usb_anchor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jU)}jHjsbc.usb_poison_anchored_urbsasbuh1hhjubjC)}(h h]h }(hj؏hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hanchorh]hanchor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjYhhhjkhMHubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjUhhhjkhMHubah}(h]jPah ](jjeh"]h$]h&]jj)jhuh1j$hjkhMHhjRhhubj)}(hhh]h)}(h cease all traffic from an anchorh]h cease all traffic from an anchor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMHhjhhubah}(h]h ]h"]h$]h&]uh1jhjRhhhjkhMHubeh}(h]h ](jfunctioneh"]h$]h&]jjjj5jj5j j!j"uh1jhhhjrhNhNubj$)}(hX7**Parameters** ``struct usb_anchor *anchor`` anchor the requests are bound to **Description** this allows all outstanding URBs to be poisoned starting from the back of the queue. Newly added URBs will also be poisoned This routine should not be called by a driver after its disconnect method has returned.h](h)}(h**Parameters**h]j.)}(hj?h]h Parameters}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj=ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMLhj9ubjD)}(hhh]jI)}(h?``struct usb_anchor *anchor`` anchor the requests are bound to h](jO)}(h``struct usb_anchor *anchor``h]j)}(hj^h]hstruct usb_anchor *anchor}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMIhjXubji)}(hhh]h)}(h anchor the requests are bound toh]h anchor the requests are bound to}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshMIhjtubah}(h]h ]h"]h$]h&]uh1jhhjXubeh}(h]h ]h"]h$]h&]uh1jHhjshMIhjUubah}(h]h ]h"]h$]h&]uh1jChj9ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMKhj9ubh)}(h{this allows all outstanding URBs to be poisoned starting from the back of the queue. Newly added URBs will also be poisonedh]h{this allows all outstanding URBs to be poisoned starting from the back of the queue. Newly added URBs will also be poisoned}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMJhj9ubh)}(hWThis routine should not be called by a driver after its disconnect method has returned.h]hWThis routine should not be called by a driver after its disconnect method has returned.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMNhj9ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_unpoison_anchored_urbs (C function)c.usb_unpoison_anchored_urbshNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h;void usb_unpoison_anchored_urbs (struct usb_anchor *anchor)h]j+)}(h:void usb_unpoison_anchored_urbs(struct usb_anchor *anchor)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMnubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMnubj)}(husb_unpoison_anchored_urbsh]j)}(husb_unpoison_anchored_urbsh]husb_unpoison_anchored_urbs}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMnubj)}(h(struct usb_anchor *anchor)h]j)}(hstruct usb_anchor *anchorh](j1)}(hjh]hstruct}(hj*hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj&ubjC)}(h h]h }(hj7hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj&ubh)}(hhh]j)}(h usb_anchorh]h usb_anchor}(hjHhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjJmodnameN classnameNjLjO)}jR]jU)}jHjsbc.usb_unpoison_anchored_urbsasbuh1hhj&ubjC)}(h h]h }(hjhhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj&ubjs)}(hjvh]h*}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj&ubj)}(hanchorh]hanchor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj"ubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMnubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMnubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMnhjhhubj)}(hhh]h)}(h(let an anchor be used successfully againh]h(let an anchor be used successfully again}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMnhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMnubeh}(h]h ](jfunctioneh"]h$]h&]jjjjőjjőj j!j"uh1jhhhjrhNhNubj$)}(h**Parameters** ``struct usb_anchor *anchor`` anchor the requests are bound to **Description** Reverses the effect of usb_poison_anchored_urbs the anchor can be used normally after it returnsh](h)}(h**Parameters**h]j.)}(hjϑh]h Parameters}(hjёhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj͑ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMrhjɑubjD)}(hhh]jI)}(h?``struct usb_anchor *anchor`` anchor the requests are bound to h](jO)}(h``struct usb_anchor *anchor``h]j)}(hjh]hstruct usb_anchor *anchor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMohjubji)}(hhh]h)}(h anchor the requests are bound toh]h anchor the requests are bound to}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMohjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMohjubah}(h]h ]h"]h$]h&]uh1jChjɑubh)}(h**Description**h]j.)}(hj)h]h Description}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj'ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMqhjɑubh)}(h`Reverses the effect of usb_poison_anchored_urbs the anchor can be used normally after it returnsh]h`Reverses the effect of usb_poison_anchored_urbs the anchor can be used normally after it returns}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMphjɑubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_anchor_suspend_wakeups (C function)c.usb_anchor_suspend_wakeupshNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h;void usb_anchor_suspend_wakeups (struct usb_anchor *anchor)h]j+)}(h:void usb_anchor_suspend_wakeups(struct usb_anchor *anchor)h](jT)}(hvoidh]hvoid}(hjnhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMubjC)}(h h]h }(hj}hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjjhhhj|hMubj)}(husb_anchor_suspend_wakeupsh]j)}(husb_anchor_suspend_wakeupsh]husb_anchor_suspend_wakeups}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjjhhhj|hMubj)}(h(struct usb_anchor *anchor)h]j)}(hstruct usb_anchor *anchorh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_anchorh]h usb_anchor}(hjɒhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjƒubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj˒modnameN classnameNjLjO)}jR]jU)}jHjsbc.usb_anchor_suspend_wakeupsasbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hanchorh]hanchor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjjhhhj|hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjfhhhj|hMubah}(h]jaah ](jjeh"]h$]h&]jj)jhuh1j$hj|hMhjchhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjchhhj|hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj7jj7j j!j"uh1jhhhjrhNhNubj$)}(hX@**Parameters** ``struct usb_anchor *anchor`` the anchor you want to suspend wakeups on **Description** Call this to stop the last urb being unanchored from waking up any usb_wait_anchor_empty_timeout waiters. This is used in the hcd urb give- back path to delay waking up until after the completion handler has run.h](h)}(h**Parameters**h]j.)}(hjAh]h Parameters}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj?ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj;ubjD)}(hhh]jI)}(hH``struct usb_anchor *anchor`` the anchor you want to suspend wakeups on h](jO)}(h``struct usb_anchor *anchor``h]j)}(hj`h]hstruct usb_anchor *anchor}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjZubji)}(hhh]h)}(h)the anchor you want to suspend wakeups onh]h)the anchor you want to suspend wakeups on}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjuhMhjvubah}(h]h ]h"]h$]h&]uh1jhhjZubeh}(h]h ]h"]h$]h&]uh1jHhjuhMhjWubah}(h]h ]h"]h$]h&]uh1jChj;ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj;ubh)}(hCall this to stop the last urb being unanchored from waking up any usb_wait_anchor_empty_timeout waiters. This is used in the hcd urb give- back path to delay waking up until after the completion handler has run.h]hCall this to stop the last urb being unanchored from waking up any usb_wait_anchor_empty_timeout waiters. This is used in the hcd urb give- back path to delay waking up until after the completion handler has run.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj;ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&usb_anchor_resume_wakeups (C function)c.usb_anchor_resume_wakeupshNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h:void usb_anchor_resume_wakeups (struct usb_anchor *anchor)h]j+)}(h9void usb_anchor_resume_wakeups(struct usb_anchor *anchor)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjܓhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjܓhhhjhMubj)}(husb_anchor_resume_wakeupsh]j)}(husb_anchor_resume_wakeupsh]husb_anchor_resume_wakeups}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjܓhhhjhMubj)}(h(struct usb_anchor *anchor)h]j)}(hstruct usb_anchor *anchorh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hj*hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_anchorh]h usb_anchor}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj=modnameN classnameNjLjO)}jR]jU)}jHjsbc.usb_anchor_resume_wakeupsasbuh1hhjubjC)}(h h]h }(hj[hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hanchorh]hanchor}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjܓhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjؓhhhjhMubah}(h]jӓah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjՓhhubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjՓhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(h**Parameters** ``struct usb_anchor *anchor`` the anchor you want to resume wakeups on **Description** Allow usb_wait_anchor_empty_timeout waiters to be woken up again, and wake up any current waiters if the anchor is empty.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubjD)}(hhh]jI)}(hG``struct usb_anchor *anchor`` the anchor you want to resume wakeups on h](jO)}(h``struct usb_anchor *anchor``h]j)}(hjҔh]hstruct usb_anchor *anchor}(hjԔhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjДubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj̔ubji)}(hhh]h)}(h(the anchor you want to resume wakeups onh]h(the anchor you want to resume wakeups on}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhj̔ubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjɔubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hj h]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hyAllow usb_wait_anchor_empty_timeout waiters to be woken up again, and wake up any current waiters if the anchor is empty.h]hyAllow usb_wait_anchor_empty_timeout waiters to be woken up again, and wake up any current waiters if the anchor is empty.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j*usb_wait_anchor_empty_timeout (C function)c.usb_wait_anchor_empty_timeouthNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hSint usb_wait_anchor_empty_timeout (struct usb_anchor *anchor, unsigned int timeout)h]j+)}(hRint usb_wait_anchor_empty_timeout(struct usb_anchor *anchor, unsigned int timeout)h](jT)}(hinth]hint}(hjRhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjNhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMubjC)}(h h]h }(hjahhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjNhhhj`hMubj)}(husb_wait_anchor_empty_timeouth]j)}(husb_wait_anchor_empty_timeouth]husb_wait_anchor_empty_timeout}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjoubah}(h]h ](jjeh"]h$]h&]jjuh1jhjNhhhj`hMubj)}(h1(struct usb_anchor *anchor, unsigned int timeout)h](j)}(hstruct usb_anchor *anchorh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_anchorh]h usb_anchor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR]jU)}jHjusbc.usb_wait_anchor_empty_timeoutasbuh1hhjubjC)}(h h]h }(hj͕hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjەhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hanchorh]hanchor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned int timeouth](jT)}(hunsignedh]hunsigned}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hj+hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(htimeouth]htimeout}(hj9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjNhhhj`hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjJhhhj`hMubah}(h]jEah ](jjeh"]h$]h&]jj)jhuh1j$hj`hMhjGhhubj)}(hhh]h)}(hwait for an anchor to be unusedh]hwait for an anchor to be unused}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhj`hhubah}(h]h ]h"]h$]h&]uh1jhjGhhhj`hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj{jj{j j!j"uh1jhhhjrhNhNubj$)}(hX;**Parameters** ``struct usb_anchor *anchor`` the anchor you want to become unused ``unsigned int timeout`` how long you are willing to wait in milliseconds **Description** Call this is you want to be sure all an anchor's URBs have finished **Return** Non-zero if the anchor became unused. Zero on timeout.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubjD)}(hhh](jI)}(hC``struct usb_anchor *anchor`` the anchor you want to become unused h](jO)}(h``struct usb_anchor *anchor``h]j)}(hjh]hstruct usb_anchor *anchor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubji)}(hhh]h)}(h$the anchor you want to become unusedh]h$the anchor you want to become unused}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubjI)}(hJ``unsigned int timeout`` how long you are willing to wait in milliseconds h](jO)}(h``unsigned int timeout``h]j)}(hjݖh]hunsigned int timeout}(hjߖhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjۖubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjזubji)}(hhh]h)}(h0how long you are willing to wait in millisecondsh]h0how long you are willing to wait in milliseconds}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjזubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(hCCall this is you want to be sure all an anchor's URBs have finishedh]hECall this is you want to be sure all an anchor’s URBs have finished}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(h **Return**h]j.)}(hj?h]hReturn}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj=ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubh)}(h6Non-zero if the anchor became unused. Zero on timeout.h]h6Non-zero if the anchor became unused. Zero on timeout.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:161: ./drivers/usb/core/urb.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j usb_get_from_anchor (C function)c.usb_get_from_anchorhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hh]h int timeout}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chKhj8ubji)}(hhh]h)}(hCtime in msecs to wait for the message to complete before timing outh]hCtime in msecs to wait for the message to complete before timing out}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjShKhjTubah}(h]h ]h"]h$]h&]uh1jhhj8ubeh}(h]h ]h"]h$]h&]uh1jHhjShKhjmubjI)}(h?``gfp_t memflags`` the flags for memory allocation for buffers h](jO)}(h``gfp_t memflags``h]j)}(hjwh]hgfp_t memflags}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chKhjqubji)}(hhh]h)}(h+the flags for memory allocation for buffersh]h+the flags for memory allocation for buffers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjqubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjmubeh}(h]h ]h"]h$]h&]uh1jChjQubh)}(h **Context**h]j.)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chKhjQubh)}(h!in_interrupt ()h]h!in_interrupt ()}(hjȮhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chKhjQubh)}(h**Description**h]j.)}(hjٮh]h Description}(hjۮhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj׮ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chKhjQubh)}(hThis function sends a control message to a specified endpoint that is expected to fill in a response (i.e. a "receive message") and waits for the message to complete, or timeout.h]hThis function sends a control message to a specified endpoint that is expected to fill in a response (i.e. a “receive message”) and waits for the message to complete, or timeout.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chKhjQubh)}(hXfDo not use this function from within an interrupt context. If you need an asynchronous message, or need to send a message from within interrupt context, use usb_submit_urb(). If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. Since you don't have a handle on the URB used, you can't cancel the request.h]hXjDo not use this function from within an interrupt context. If you need an asynchronous message, or need to send a message from within interrupt context, use usb_submit_urb(). If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. Since you don’t have a handle on the URB used, you can’t cancel the request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chKhjQubh)}(hX0The data pointer can be made to a reference on the stack, or anywhere else that can be successfully written to. This function does not have the restriction that usb_control_msg() has where the data pointer must be to dynamically allocated memory (i.e. memory that can be successfully DMAed to a device).h]hX0The data pointer can be made to a reference on the stack, or anywhere else that can be successfully written to. This function does not have the restriction that usb_control_msg() has where the data pointer must be to dynamically allocated memory (i.e. memory that can be successfully DMAed to a device).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjQubh)}(hXThe "whole" message must be properly received from the device in order for this function to be successful. If a device returns less than the expected amount of data, then the function will fail. Do not use this for messages where a variable amount of data might be returned.h]hXThe “whole” message must be properly received from the device in order for this function to be successful. If a device returns less than the expected amount of data, then the function will fail. Do not use this for messages where a variable amount of data might be returned.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM hjQubh)}(h **Return**h]j.)}(hj-h]hReturn}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj+ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjQubh)}(hAIf successful, 0 is returned, Otherwise, a negative error number.h]hAIf successful, 0 is returned, Otherwise, a negative error number.}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjQubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_core.usb_interrupt_msg (C function)c.usb_core.usb_interrupt_msghNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h{int usb_interrupt_msg (struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h]j+)}(hzint usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h](jT)}(hinth]hint}(hjrhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjnhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM7ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjnhhhjhM7ubj)}(husb_interrupt_msgh]j)}(husb_interrupt_msgh]husb_interrupt_msg}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjnhhhjhM7ubj)}(he(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h](j)}(hstruct usb_device *usb_devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjͯhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjʯubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjϯmodnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_interrupt_msgesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(husb_devh]husb_dev}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned int pipeh](jT)}(hunsignedh]hunsigned}(hj"hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hj0hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjT)}(hinth]hint}(hj>hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjLhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hpipeh]hpipe}(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h void *datah](jT)}(hvoidh]hvoid}(hjshhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjoubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjoubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjoubj)}(hdatah]hdata}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjoubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hint lenh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjðhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hlenh]hlen}(hjѰhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hint *actual_lengthh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(h actual_lengthh]h actual_length}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h int timeouth](jT)}(hinth]hint}(hj,hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj(ubjC)}(h h]h }(hj:hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj(ubj)}(htimeouth]htimeout}(hjHhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjnhhhjhM7ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjjhhhjhM7ubah}(h]jeah ](jjeh"]h$]h&]jj)jhuh1j$hjhM7hjghhubj)}(hhh]h)}(h>Builds an interrupt urb, sends it off and waits for completionh]h>Builds an interrupt urb, sends it off and waits for completion}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM7hjohhubah}(h]h ]h"]h$]h&]uh1jhjghhhjhM7ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hXp**Parameters** ``struct usb_device *usb_dev`` pointer to the usb device to send the message to ``unsigned int pipe`` endpoint "pipe" to send the message to ``void *data`` pointer to the data to send ``int len`` length in bytes of the data to send ``int *actual_length`` pointer to a location to put the actual length transferred in bytes ``int timeout`` time in msecs to wait for the message to complete before timing out **Context** task context, might sleep. **Description** This function sends a simple interrupt message to a specified endpoint and waits for the message to complete, or timeout. Don't use this function from within an interrupt context. If you need an asynchronous message, or need to send a message from within interrupt context, use usb_submit_urb() If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. Since you don't have a handle on the URB used, you can't cancel the request. **Return** If successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the **actual_length** parameter.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM;hjubjD)}(hhh](jI)}(hP``struct usb_device *usb_dev`` pointer to the usb device to send the message to h](jO)}(h``struct usb_device *usb_dev``h]j)}(hjh]hstruct usb_device *usb_dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM8hjubji)}(hhh]h)}(h0pointer to the usb device to send the message toh]h0pointer to the usb device to send the message to}(hj̱hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjȱhM8hjɱubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjȱhM8hjubjI)}(h=``unsigned int pipe`` endpoint "pipe" to send the message to h](jO)}(h``unsigned int pipe``h]j)}(hjh]hunsigned int pipe}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM9hjubji)}(hhh]h)}(h&endpoint "pipe" to send the message toh]h*endpoint “pipe” to send the message to}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM9hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM9hjubjI)}(h+``void *data`` pointer to the data to send h](jO)}(h``void *data``h]j)}(hj%h]h void *data}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM:hjubji)}(hhh]h)}(hpointer to the data to sendh]hpointer to the data to send}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj:hM:hj;ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj:hM:hjubjI)}(h0``int len`` length in bytes of the data to send h](jO)}(h ``int len``h]j)}(hj^h]hint len}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM;hjXubji)}(hhh]h)}(h#length in bytes of the data to sendh]h#length in bytes of the data to send}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshM;hjtubah}(h]h ]h"]h$]h&]uh1jhhjXubeh}(h]h ]h"]h$]h&]uh1jHhjshM;hjubjI)}(h[``int *actual_length`` pointer to a location to put the actual length transferred in bytes h](jO)}(h``int *actual_length``h]j)}(hjh]hint *actual_length}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM=hjubji)}(hhh]h)}(hCpointer to a location to put the actual length transferred in bytesh]hCpointer to a location to put the actual length transferred in bytes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM<hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM=hjubjI)}(hT``int timeout`` time in msecs to wait for the message to complete before timing out h](jO)}(h``int timeout``h]j)}(hjѲh]h int timeout}(hjӲhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjϲubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM>hj˲ubji)}(hhh]h)}(hCtime in msecs to wait for the message to complete before timing outh]hCtime in msecs to wait for the message to complete before timing out}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM>hjubah}(h]h ]h"]h$]h&]uh1jhhj˲ubeh}(h]h ]h"]h$]h&]uh1jHhjhM>hjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hj h]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM@hjubh)}(htask context, might sleep.h]htask context, might sleep.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM@hjubh)}(h**Description**h]j.)}(hj3h]h Description}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj1ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMBhjubh)}(hyThis function sends a simple interrupt message to a specified endpoint and waits for the message to complete, or timeout.h]hyThis function sends a simple interrupt message to a specified endpoint and waits for the message to complete, or timeout.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMAhjubh)}(hXdDon't use this function from within an interrupt context. If you need an asynchronous message, or need to send a message from within interrupt context, use usb_submit_urb() If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. Since you don't have a handle on the URB used, you can't cancel the request.h]hXjDon’t use this function from within an interrupt context. If you need an asynchronous message, or need to send a message from within interrupt context, use usb_submit_urb() If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. Since you don’t have a handle on the URB used, you can’t cancel the request.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMDhjubh)}(h **Return**h]j.)}(hjih]hReturn}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjgubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMJhjubh)}(hIf successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the **actual_length** parameter.h](hrIf successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the }(hjhhhNhNubj.)}(h**actual_length**h]h actual_length}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh parameter.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMKhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"usb_core.usb_bulk_msg (C function)c.usb_core.usb_bulk_msghNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hvint usb_bulk_msg (struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h]j+)}(huint usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMWubjC)}(h h]h }(hjϳhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjγhMWubj)}(h usb_bulk_msgh]j)}(h usb_bulk_msgh]h usb_bulk_msg}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjݳubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjγhMWubj)}(he(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h](j)}(hstruct usb_device *usb_devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_bulk_msgesbuh1hhjubjC)}(h h]h }(hj<hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjJhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(husb_devh]husb_dev}(hjWhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned int pipeh](jT)}(hunsignedh]hunsigned}(hjphhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjlubjC)}(h h]h }(hj~hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjlubjT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjlubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjlubj)}(hpipeh]hpipe}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjlubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h void *datah](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjϴhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjݴhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdatah]hdata}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hint lenh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hlenh]hlen}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hint *actual_lengthh](jT)}(hinth]hint}(hj8hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj4ubjC)}(h h]h }(hjFhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj4ubjs)}(hjvh]h*}(hjThhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj4ubj)}(h actual_lengthh]h actual_length}(hjahhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h int timeouth](jT)}(hinth]hint}(hjzhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjvubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjvubj)}(htimeouth]htimeout}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjγhMWubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjγhMWubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjγhMWhjhhubj)}(hhh]h)}(h8Builds a bulk urb, sends it off and waits for completionh]h8Builds a bulk urb, sends it off and waits for completion}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMWhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjγhMWubeh}(h]h ](jfunctioneh"]h$]h&]jjjjصjjصj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *usb_dev`` pointer to the usb device to send the message to ``unsigned int pipe`` endpoint "pipe" to send the message to ``void *data`` pointer to the data to send ``int len`` length in bytes of the data to send ``int *actual_length`` pointer to a location to put the actual length transferred in bytes ``int timeout`` time in msecs to wait for the message to complete before timing out **Context** task context, might sleep. **Description** This function sends a simple bulk message to a specified endpoint and waits for the message to complete, or timeout. Don't use this function from within an interrupt context. If you need an asynchronous message, or need to send a message from within interrupt context, use usb_submit_urb() If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. Since you don't have a handle on the URB used, you can't cancel the request. Because there is no usb_interrupt_msg() and no USBDEVFS_INTERRUPT ioctl, users are forced to abuse this routine by using it to submit URBs for interrupt endpoints. We will take the liberty of creating an interrupt URB (with the default interval) if the target is an interrupt endpoint. **Return** If successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the **actual_length** parameter.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM[hjܵubjD)}(hhh](jI)}(hP``struct usb_device *usb_dev`` pointer to the usb device to send the message to h](jO)}(h``struct usb_device *usb_dev``h]j)}(hjh]hstruct usb_device *usb_dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMXhjubji)}(hhh]h)}(h0pointer to the usb device to send the message toh]h0pointer to the usb device to send the message to}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMXhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMXhjubjI)}(h=``unsigned int pipe`` endpoint "pipe" to send the message to h](jO)}(h``unsigned int pipe``h]j)}(hj:h]hunsigned int pipe}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMYhj4ubji)}(hhh]h)}(h&endpoint "pipe" to send the message toh]h*endpoint “pipe” to send the message to}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhMYhjPubah}(h]h ]h"]h$]h&]uh1jhhj4ubeh}(h]h ]h"]h$]h&]uh1jHhjOhMYhjubjI)}(h+``void *data`` pointer to the data to send h](jO)}(h``void *data``h]j)}(hjsh]h void *data}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMZhjmubji)}(hhh]h)}(hpointer to the data to sendh]hpointer to the data to send}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMZhjubah}(h]h ]h"]h$]h&]uh1jhhjmubeh}(h]h ]h"]h$]h&]uh1jHhjhMZhjubjI)}(h0``int len`` length in bytes of the data to send h](jO)}(h ``int len``h]j)}(hjh]hint len}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM[hjubji)}(hhh]h)}(h#length in bytes of the data to sendh]h#length in bytes of the data to send}(hjŶhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM[hj¶ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM[hjubjI)}(h[``int *actual_length`` pointer to a location to put the actual length transferred in bytes h](jO)}(h``int *actual_length``h]j)}(hjh]hint *actual_length}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM]hj߶ubji)}(hhh]h)}(hCpointer to a location to put the actual length transferred in bytesh]hCpointer to a location to put the actual length transferred in bytes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM\hjubah}(h]h ]h"]h$]h&]uh1jhhj߶ubeh}(h]h ]h"]h$]h&]uh1jHhjhM]hjubjI)}(hT``int timeout`` time in msecs to wait for the message to complete before timing out h](jO)}(h``int timeout``h]j)}(hjh]h int timeout}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM^hjubji)}(hhh]h)}(hCtime in msecs to wait for the message to complete before timing outh]hCtime in msecs to wait for the message to complete before timing out}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4hM^hj5ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj4hM^hjubeh}(h]h ]h"]h$]h&]uh1jChjܵubh)}(h **Context**h]j.)}(hjZh]hContext}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjXubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM`hjܵubh)}(htask context, might sleep.h]htask context, might sleep.}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM`hjܵubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMbhjܵubh)}(htThis function sends a simple bulk message to a specified endpoint and waits for the message to complete, or timeout.h]htThis function sends a simple bulk message to a specified endpoint and waits for the message to complete, or timeout.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMahjܵubh)}(hXdDon't use this function from within an interrupt context. If you need an asynchronous message, or need to send a message from within interrupt context, use usb_submit_urb() If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. Since you don't have a handle on the URB used, you can't cancel the request.h]hXjDon’t use this function from within an interrupt context. If you need an asynchronous message, or need to send a message from within interrupt context, use usb_submit_urb() If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. Since you don’t have a handle on the URB used, you can’t cancel the request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMdhjܵubh)}(hXBecause there is no usb_interrupt_msg() and no USBDEVFS_INTERRUPT ioctl, users are forced to abuse this routine by using it to submit URBs for interrupt endpoints. We will take the liberty of creating an interrupt URB (with the default interval) if the target is an interrupt endpoint.h]hXBecause there is no usb_interrupt_msg() and no USBDEVFS_INTERRUPT ioctl, users are forced to abuse this routine by using it to submit URBs for interrupt endpoints. We will take the liberty of creating an interrupt URB (with the default interval) if the target is an interrupt endpoint.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMjhjܵubh)}(h **Return**h]j.)}(hjƷh]hReturn}(hjȷhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjķubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMohjܵubh)}(hIf successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the **actual_length** parameter.h](hrIf successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the }(hjܷhhhNhNubj.)}(h**actual_length**h]h actual_length}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjܷubh parameter.}(hjܷhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMphjܵubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j+usb_core.usb_bulk_msg_killable (C function) c.usb_core.usb_bulk_msg_killablehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hint usb_bulk_msg_killable (struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h]j+)}(h~int usb_bulk_msg_killable(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hj,hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj+hMubj)}(husb_bulk_msg_killableh]j)}(husb_bulk_msg_killableh]husb_bulk_msg_killable}(hj>hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhj+hMubj)}(he(struct usb_device *usb_dev, unsigned int pipe, void *data, int len, int *actual_length, int timeout)h](j)}(hstruct usb_device *usb_devh](j1)}(hjh]hstruct}(hjZhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjVubjC)}(h h]h }(hjghhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjVubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjzmodnameN classnameNjLjO)}jR](jNjU)}jHj@sb c.usb_core.usb_bulk_msg_killableesbuh1hhjVubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjVubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjVubj)}(husb_devh]husb_dev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjRubj)}(hunsigned int pipeh](jT)}(hunsignedh]hunsigned}(hj͸hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjɸubjC)}(h h]h }(hj۸hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjɸubjT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjɸubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjɸubj)}(hpipeh]hpipe}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjɸubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjRubj)}(h void *datah](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hj,hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdatah]hdata}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjRubj)}(hint lenh](jT)}(hinth]hint}(hj`hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj\ubjC)}(h h]h }(hjnhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj\ubj)}(hlenh]hlen}(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjRubj)}(hint *actual_lengthh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(h actual_lengthh]h actual_length}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjRubj)}(h int timeouth](jT)}(hinth]hint}(hj׹hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjӹubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjӹubj)}(htimeouth]htimeout}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjӹubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjRubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhj+hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj+hMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hj+hMhjhhubj)}(hhh]h)}(hLBuilds a bulk urb, sends it off and waits for completion in a killable stateh]hLBuilds a bulk urb, sends it off and waits for completion in a killable state}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhj+hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj5jj5j j!j"uh1jhhhjrhNhNubj$)}(hX=**Parameters** ``struct usb_device *usb_dev`` pointer to the usb device to send the message to ``unsigned int pipe`` endpoint "pipe" to send the message to ``void *data`` pointer to the data to send ``int len`` length in bytes of the data to send ``int *actual_length`` pointer to a location to put the actual length transferred in bytes ``int timeout`` time in msecs to wait for the message to complete before timing out (if <= 0, the wait is as long as possible) **Context** task context, might sleep. **Description** This function is just like usb_blk_msg(), except that it waits in a killable state and there is no limit on the timeout length. **Return** If successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the **actual_length** parameter.h](h)}(h**Parameters**h]j.)}(hj?h]h Parameters}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj=ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj9ubjD)}(hhh](jI)}(hP``struct usb_device *usb_dev`` pointer to the usb device to send the message to h](jO)}(h``struct usb_device *usb_dev``h]j)}(hj^h]hstruct usb_device *usb_dev}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjXubji)}(hhh]h)}(h0pointer to the usb device to send the message toh]h0pointer to the usb device to send the message to}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshMhjtubah}(h]h ]h"]h$]h&]uh1jhhjXubeh}(h]h ]h"]h$]h&]uh1jHhjshMhjUubjI)}(h=``unsigned int pipe`` endpoint "pipe" to send the message to h](jO)}(h``unsigned int pipe``h]j)}(hjh]hunsigned int pipe}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(h&endpoint "pipe" to send the message toh]h*endpoint “pipe” to send the message to}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjUubjI)}(h+``void *data`` pointer to the data to send h](jO)}(h``void *data``h]j)}(hjкh]h void *data}(hjҺhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjκubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjʺubji)}(hhh]h)}(hpointer to the data to sendh]hpointer to the data to send}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjʺubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjUubjI)}(h0``int len`` length in bytes of the data to send h](jO)}(h ``int len``h]j)}(hj h]hint len}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(h#length in bytes of the data to sendh]h#length in bytes of the data to send}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjUubjI)}(h[``int *actual_length`` pointer to a location to put the actual length transferred in bytes h](jO)}(h``int *actual_length``h]j)}(hjBh]hint *actual_length}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj<ubji)}(hhh]h)}(hCpointer to a location to put the actual length transferred in bytesh]hCpointer to a location to put the actual length transferred in bytes}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjXubah}(h]h ]h"]h$]h&]uh1jhhj<ubeh}(h]h ]h"]h$]h&]uh1jHhjWhMhjUubjI)}(h``int timeout`` time in msecs to wait for the message to complete before timing out (if <= 0, the wait is as long as possible) h](jO)}(h``int timeout``h]j)}(hj|h]h int timeout}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjvubji)}(hhh]h)}(hntime in msecs to wait for the message to complete before timing out (if <= 0, the wait is as long as possible)h]hntime in msecs to wait for the message to complete before timing out (if <= 0, the wait is as long as possible)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubah}(h]h ]h"]h$]h&]uh1jhhjvubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjUubeh}(h]h ]h"]h$]h&]uh1jChj9ubh)}(h **Context**h]j.)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj9ubh)}(htask context, might sleep.h]htask context, might sleep.}(hjλhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj9ubh)}(h**Description**h]j.)}(hj߻h]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjݻubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj9ubh)}(hThis function is just like usb_blk_msg(), except that it waits in a killable state and there is no limit on the timeout length.h]hThis function is just like usb_blk_msg(), except that it waits in a killable state and there is no limit on the timeout length.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj9ubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj9ubh)}(hIf successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the **actual_length** parameter.h](hrIf successful, 0. Otherwise a negative error number. The number of actual bytes transferred will be stored in the }(hjhhhNhNubj.)}(h**actual_length**h]h actual_length}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh parameter.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj9ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!usb_core.usb_sg_init (C function)c.usb_core.usb_sg_inithNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hint usb_sg_init (struct usb_sg_request *io, struct usb_device *dev, unsigned pipe, unsigned period, struct scatterlist *sg, int nents, size_t length, gfp_t mem_flags)h]j+)}(hint usb_sg_init(struct usb_sg_request *io, struct usb_device *dev, unsigned pipe, unsigned period, struct scatterlist *sg, int nents, size_t length, gfp_t mem_flags)h](jT)}(hinth]hint}(hj]hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjYhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hjlhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjYhhhjkhMubj)}(h usb_sg_inith]j)}(h usb_sg_inith]h usb_sg_init}(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzubah}(h]h ](jjeh"]h$]h&]jjuh1jhjYhhhjkhMubj)}(h(struct usb_sg_request *io, struct usb_device *dev, unsigned pipe, unsigned period, struct scatterlist *sg, int nents, size_t length, gfp_t mem_flags)h](j)}(hstruct usb_sg_request *ioh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(husb_sg_requesth]husb_sg_request}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_sg_initesbuh1hhjubjC)}(h h]h }(hjټhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hioh]hio}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj-modnameN classnameNjLjO)}jR](jNjռc.usb_core.usb_sg_initesbuh1hhj ubjC)}(h h]h }(hjJhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(hdevh]hdev}(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h unsigned pipeh](jT)}(hunsignedh]hunsigned}(hj~hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjzubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjzubj)}(hpipeh]hpipe}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned periodh](jT)}(hunsignedh]hunsigned}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hperiodh]hperiod}(hjϽhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hstruct scatterlist *sgh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h scatterlisth]h scatterlist}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjռc.usb_core.usb_sg_initesbuh1hhjubjC)}(h h]h }(hj%hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hsgh]hsg}(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h int nentsh](jT)}(hinth]hint}(hjYhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjUubjC)}(h h]h }(hjghhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjUubj)}(hnentsh]hnents}(hjuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjUubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h size_t lengthh](h)}(hhh]j)}(hsize_th]hsize_t}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjռc.usb_core.usb_sg_initesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hlengthh]hlength}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hgfp_t mem_flagsh](h)}(hhh]j)}(hgfp_th]hgfp_t}(hjھhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj׾ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjܾmodnameN classnameNjLjO)}jR](jNjռc.usb_core.usb_sg_initesbuh1hhjӾubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjӾubj)}(h mem_flagsh]h mem_flags}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjӾubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjYhhhjkhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjUhhhjkhMubah}(h]jPah ](jjeh"]h$]h&]jj)jhuh1j$hjkhMhjRhhubj)}(hhh]h)}(h8initializes scatterlist-based bulk/interrupt I/O requesth]h8initializes scatterlist-based bulk/interrupt I/O request}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj.hhubah}(h]h ]h"]h$]h&]uh1jhjRhhhjkhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjIjjIj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_sg_request *io`` request block being initialized. until usb_sg_wait() returns, treat this as a pointer to an opaque block of memory, ``struct usb_device *dev`` the usb device that will send or receive the data ``unsigned pipe`` endpoint "pipe" used to transfer the data ``unsigned period`` polling rate for interrupt endpoints, in frames or (for high speed endpoints) microframes; ignored for bulk ``struct scatterlist *sg`` scatterlist entries ``int nents`` how many entries in the scatterlist ``size_t length`` how many bytes to send from the scatterlist, or zero to send every byte identified in the list. ``gfp_t mem_flags`` SLAB_* flags affecting memory allocations in this call **Description** This initializes a scatter/gather request, allocating resources such as I/O mappings and urb memory (except maybe memory used by USB controller drivers). The request must be issued using usb_sg_wait(), which waits for the I/O to complete (or to be canceled) and then cleans up all resources allocated by usb_sg_init(). The request may be canceled with usb_sg_cancel(), either before or after usb_sg_wait() is called. **Return** Zero for success, else a negative errno value.h](h)}(h**Parameters**h]j.)}(hjSh]h Parameters}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjQubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjMubjD)}(hhh](jI)}(h``struct usb_sg_request *io`` request block being initialized. until usb_sg_wait() returns, treat this as a pointer to an opaque block of memory, h](jO)}(h``struct usb_sg_request *io``h]j)}(hjrh]hstruct usb_sg_request *io}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjlubji)}(hhh]h)}(htrequest block being initialized. until usb_sg_wait() returns, treat this as a pointer to an opaque block of memory,h]htrequest block being initialized. until usb_sg_wait() returns, treat this as a pointer to an opaque block of memory,}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubah}(h]h ]h"]h$]h&]uh1jhhjlubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjiubjI)}(hM``struct usb_device *dev`` the usb device that will send or receive the data h](jO)}(h``struct usb_device *dev``h]j)}(hjh]hstruct usb_device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(h1the usb device that will send or receive the datah]h1the usb device that will send or receive the data}(hjſhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhj¿ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjiubjI)}(h<``unsigned pipe`` endpoint "pipe" used to transfer the data h](jO)}(h``unsigned pipe``h]j)}(hjh]h unsigned pipe}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj߿ubji)}(hhh]h)}(h)endpoint "pipe" used to transfer the datah]h-endpoint “pipe” used to transfer the data}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhj߿ubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjiubjI)}(h``unsigned period`` polling rate for interrupt endpoints, in frames or (for high speed endpoints) microframes; ignored for bulk h](jO)}(h``unsigned period``h]j)}(hjh]hunsigned period}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(hkpolling rate for interrupt endpoints, in frames or (for high speed endpoints) microframes; ignored for bulkh]hkpolling rate for interrupt endpoints, in frames or (for high speed endpoints) microframes; ignored for bulk}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj4ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj3hMhjiubjI)}(h/``struct scatterlist *sg`` scatterlist entries h](jO)}(h``struct scatterlist *sg``h]j)}(hjXh]hstruct scatterlist *sg}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjVubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjRubji)}(hhh]h)}(hscatterlist entriesh]hscatterlist entries}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjmhMhjnubah}(h]h ]h"]h$]h&]uh1jhhjRubeh}(h]h ]h"]h$]h&]uh1jHhjmhMhjiubjI)}(h2``int nents`` how many entries in the scatterlist h](jO)}(h ``int nents``h]j)}(hjh]h int nents}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(h#how many entries in the scatterlisth]h#how many entries in the scatterlist}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjiubjI)}(hr``size_t length`` how many bytes to send from the scatterlist, or zero to send every byte identified in the list. h](jO)}(h``size_t length``h]j)}(hjh]h size_t length}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM hjubji)}(hhh]h)}(h_how many bytes to send from the scatterlist, or zero to send every byte identified in the list.h]h_how many bytes to send from the scatterlist, or zero to send every byte identified in the list.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM hjiubjI)}(hK``gfp_t mem_flags`` SLAB_* flags affecting memory allocations in this call h](jO)}(h``gfp_t mem_flags``h]j)}(hjh]hgfp_t mem_flags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM!hjubji)}(hhh]h)}(h6SLAB_* flags affecting memory allocations in this callh]h6SLAB_* flags affecting memory allocations in this call}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM!hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM!hjiubeh}(h]h ]h"]h$]h&]uh1jChjMubh)}(h**Description**h]j.)}(hj?h]h Description}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj=ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM#hjMubh)}(hThis initializes a scatter/gather request, allocating resources such as I/O mappings and urb memory (except maybe memory used by USB controller drivers).h]hThis initializes a scatter/gather request, allocating resources such as I/O mappings and urb memory (except maybe memory used by USB controller drivers).}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM"hjMubh)}(hThe request must be issued using usb_sg_wait(), which waits for the I/O to complete (or to be canceled) and then cleans up all resources allocated by usb_sg_init().h]hThe request must be issued using usb_sg_wait(), which waits for the I/O to complete (or to be canceled) and then cleans up all resources allocated by usb_sg_init().}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM&hjMubh)}(haThe request may be canceled with usb_sg_cancel(), either before or after usb_sg_wait() is called.h]haThe request may be canceled with usb_sg_cancel(), either before or after usb_sg_wait() is called.}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM*hjMubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM-hjMubh)}(h.Zero for success, else a negative errno value.h]h.Zero for success, else a negative errno value.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM.hjMubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!usb_core.usb_sg_wait (C function)c.usb_core.usb_sg_waithNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h,void usb_sg_wait (struct usb_sg_request *io)h]j+)}(h+void usb_sg_wait(struct usb_sg_request *io)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(h usb_sg_waith]j)}(h usb_sg_waith]h usb_sg_wait}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h(struct usb_sg_request *io)h]j)}(hstruct usb_sg_request *ioh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(husb_sg_requesth]husb_sg_request}(hj$hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj&modnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_sg_waitesbuh1hhjubjC)}(h h]h }(hjEhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjShhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hioh]hio}(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(h,synchronously execute scatter/gather requesth]h,synchronously execute scatter/gather request}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_sg_request *io`` request block handle, as initialized with usb_sg_init(). some fields become accessible when this call returns. **Context** task context, might sleep. **Description** This function blocks until the specified I/O operation completes. It leverages the grouping of the related I/O requests to get good transfer rates, by queueing the requests. At higher speeds, such queuing can significantly improve USB throughput. There are three kinds of completion for this function. (1) success, where io->status is zero. The number of io->bytes transferred is as requested. (2) error, where io->status is a negative errno value. The number of io->bytes transferred before the error is usually less than requested, and can be nonzero. (3) cancellation, a type of error with status -ECONNRESET that is initiated by usb_sg_cancel(). When this function returns, all memory allocated through usb_sg_init() or this call will have been freed. The request block parameter may still be passed to usb_sg_cancel(), or it may be freed. It could also be reinitialized and then reused. Data Transfer Rates: Bulk transfers are valid for full or high speed endpoints. The best full speed data rate is 19 packets of 64 bytes each per frame, or 1216 bytes per millisecond. The best high speed data rate is 13 packets of 512 bytes each per microframe, or 52 KBytes per millisecond. The reason to use interrupt transfers through this API would most likely be to reserve high speed bandwidth, where up to 24 KBytes per millisecond could be transferred. That capability is less useful for low or full speed interrupt endpoints, which allow at most one packet per millisecond, of at most 8 or 64 bytes (respectively). It is not necessary to call this function to reserve bandwidth for devices under an xHCI host controller, as the bandwidth is reserved when the configuration or interface alt setting is selected.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubjD)}(hhh]jI)}(h``struct usb_sg_request *io`` request block handle, as initialized with usb_sg_init(). some fields become accessible when this call returns. h](jO)}(h``struct usb_sg_request *io``h]j)}(hjh]hstruct usb_sg_request *io}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(hnrequest block handle, as initialized with usb_sg_init(). some fields become accessible when this call returns.h]hnrequest block handle, as initialized with usb_sg_init(). some fields become accessible when this call returns.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hjh]hContext}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(htask context, might sleep.h]htask context, might sleep.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h**Description**h]j.)}(hj.h]h Description}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj,ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hThis function blocks until the specified I/O operation completes. It leverages the grouping of the related I/O requests to get good transfer rates, by queueing the requests. At higher speeds, such queuing can significantly improve USB throughput.h]hThis function blocks until the specified I/O operation completes. It leverages the grouping of the related I/O requests to get good transfer rates, by queueing the requests. At higher speeds, such queuing can significantly improve USB throughput.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h6There are three kinds of completion for this function.h]h6There are three kinds of completion for this function.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubj)}(hhh](j)}(hXsuccess, where io->status is zero. The number of io->bytes transferred is as requested.h]h)}(hXsuccess, where io->status is zero. The number of io->bytes transferred is as requested.h]hXsuccess, where io->status is zero. The number of io->bytes transferred is as requested.}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjeubah}(h]h ]h"]h$]h&]uh1jhjbubj)}(herror, where io->status is a negative errno value. The number of io->bytes transferred before the error is usually less than requested, and can be nonzero.h]h)}(herror, where io->status is a negative errno value. The number of io->bytes transferred before the error is usually less than requested, and can be nonzero.h]herror, where io->status is a negative errno value. The number of io->bytes transferred before the error is usually less than requested, and can be nonzero.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj~ubah}(h]h ]h"]h$]h&]uh1jhjbubj)}(h\cancellation, a type of error with status -ECONNRESET that is initiated by usb_sg_cancel(). h]h)}(h[cancellation, a type of error with status -ECONNRESET that is initiated by usb_sg_cancel().h]h[cancellation, a type of error with status -ECONNRESET that is initiated by usb_sg_cancel().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubah}(h]h ]h"]h$]h&]uh1jhjbubeh}(h]h ]h"]h$]h&]jjjjjjuh1jhjubh)}(hWhen this function returns, all memory allocated through usb_sg_init() or this call will have been freed. The request block parameter may still be passed to usb_sg_cancel(), or it may be freed. It could also be reinitialized and then reused.h]hWhen this function returns, all memory allocated through usb_sg_init() or this call will have been freed. The request block parameter may still be passed to usb_sg_cancel(), or it may be freed. It could also be reinitialized and then reused.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hData Transfer Rates:h]hData Transfer Rates:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hX Bulk transfers are valid for full or high speed endpoints. The best full speed data rate is 19 packets of 64 bytes each per frame, or 1216 bytes per millisecond. The best high speed data rate is 13 packets of 512 bytes each per microframe, or 52 KBytes per millisecond.h]hX Bulk transfers are valid for full or high speed endpoints. The best full speed data rate is 19 packets of 64 bytes each per frame, or 1216 bytes per millisecond. The best high speed data rate is 13 packets of 512 bytes each per microframe, or 52 KBytes per millisecond.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hXLThe reason to use interrupt transfers through this API would most likely be to reserve high speed bandwidth, where up to 24 KBytes per millisecond could be transferred. That capability is less useful for low or full speed interrupt endpoints, which allow at most one packet per millisecond, of at most 8 or 64 bytes (respectively).h]hXLThe reason to use interrupt transfers through this API would most likely be to reserve high speed bandwidth, where up to 24 KBytes per millisecond could be transferred. That capability is less useful for low or full speed interrupt endpoints, which allow at most one packet per millisecond, of at most 8 or 64 bytes (respectively).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hIt is not necessary to call this function to reserve bandwidth for devices under an xHCI host controller, as the bandwidth is reserved when the configuration or interface alt setting is selected.h]hIt is not necessary to call this function to reserve bandwidth for devices under an xHCI host controller, as the bandwidth is reserved when the configuration or interface alt setting is selected.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#usb_core.usb_sg_cancel (C function)c.usb_core.usb_sg_cancelhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h.void usb_sg_cancel (struct usb_sg_request *io)h]j+)}(h-void usb_sg_cancel(struct usb_sg_request *io)h](jT)}(hvoidh]hvoid}(hj!hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hj0hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj/hMubj)}(h usb_sg_cancelh]j)}(h usb_sg_cancelh]h usb_sg_cancel}(hjBhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhj/hMubj)}(h(struct usb_sg_request *io)h]j)}(hstruct usb_sg_request *ioh](j1)}(hjh]hstruct}(hj^hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjZubjC)}(h h]h }(hjkhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjZubh)}(hhh]j)}(husb_sg_requesth]husb_sg_request}(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjyubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj~modnameN classnameNjLjO)}jR](jNjU)}jHjDsbc.usb_core.usb_sg_cancelesbuh1hhjZubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjZubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjZubj)}(hioh]hio}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjVubah}(h]h ]h"]h$]h&]jjuh1jhjhhhj/hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj/hMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hj/hMhjhhubj)}(hhh]h)}(h/stop scatter/gather i/o issued by usb_sg_wait()h]h/stop scatter/gather i/o issued by usb_sg_wait()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhj/hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX1**Parameters** ``struct usb_sg_request *io`` request block, initialized with usb_sg_init() **Description** This stops a request after it has been started by usb_sg_wait(). It can also prevents one initialized by usb_sg_init() from starting, so that call just frees resources allocated to the request.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubjD)}(hhh]jI)}(hL``struct usb_sg_request *io`` request block, initialized with usb_sg_init() h](jO)}(h``struct usb_sg_request *io``h]j)}(hj#h]hstruct usb_sg_request *io}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(h-request block, initialized with usb_sg_init()h]h-request block, initialized with usb_sg_init()}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8hMhj9ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj8hMhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hj^h]h Description}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj\ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hThis stops a request after it has been started by usb_sg_wait(). It can also prevents one initialized by usb_sg_init() from starting, so that call just frees resources allocated to the request.h]hThis stops a request after it has been started by usb_sg_wait(). It can also prevents one initialized by usb_sg_init() from starting, so that call just frees resources allocated to the request.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.usb_get_descriptor (C function)c.usb_core.usb_get_descriptorhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hmint usb_get_descriptor (struct usb_device *dev, unsigned char type, unsigned char index, void *buf, int size)h]j+)}(hlint usb_get_descriptor(struct usb_device *dev, unsigned char type, unsigned char index, void *buf, int size)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM1ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhM1ubj)}(husb_get_descriptorh]j)}(husb_get_descriptorh]husb_get_descriptor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhM1ubj)}(hV(struct usb_device *dev, unsigned char type, unsigned char index, void *buf, int size)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_get_descriptoresbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj-hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdevh]hdev}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned char typeh](jT)}(hunsignedh]hunsigned}(hjShhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjOubjC)}(h h]h }(hjahhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjOubjT)}(hcharh]hchar}(hjohhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjOubjC)}(h h]h }(hj}hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjOubj)}(htypeh]htype}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned char indexh](jT)}(hunsignedh]hunsigned}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjT)}(hcharh]hchar}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hindexh]hindex}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h void *bufh](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hbufh]hbuf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hint sizeh](jT)}(hinth]hint}(hj7hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj3ubjC)}(h h]h }(hjEhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj3ubj)}(hsizeh]hsize}(hjShhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhM1ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhM1ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhM1hjhhubj)}(hhh]h)}(h'issues a generic GET_DESCRIPTOR requesth]h'issues a generic GET_DESCRIPTOR request}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM1hjzhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhM1ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *dev`` the device whose descriptor is being retrieved ``unsigned char type`` the descriptor type (USB_DT_*) ``unsigned char index`` the number of the descriptor ``void *buf`` where to put the descriptor ``int size`` how big is "buf"? **Context** task context, might sleep. **Description** Gets a USB descriptor. Convenience functions exist to simplify getting some types of descriptors. Use usb_get_string() or usb_string() for USB_DT_STRING. Device (USB_DT_DEVICE) and configuration descriptors (USB_DT_CONFIG) are part of the device structure. In addition to a number of USB-standard descriptors, some devices also use class-specific or vendor-specific descriptors. This call is synchronous, and may not be used in an interrupt context. **Return** The number of bytes received on success, or else the status code returned by the underlying usb_control_msg() call.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM5hjubjD)}(hhh](jI)}(hJ``struct usb_device *dev`` the device whose descriptor is being retrieved h](jO)}(h``struct usb_device *dev``h]j)}(hjh]hstruct usb_device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM2hjubji)}(hhh]h)}(h.the device whose descriptor is being retrievedh]h.the device whose descriptor is being retrieved}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM2hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM2hjubjI)}(h6``unsigned char type`` the descriptor type (USB_DT_*) h](jO)}(h``unsigned char type``h]j)}(hjh]hunsigned char type}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM3hjubji)}(hhh]h)}(hthe descriptor type (USB_DT_*)h]hthe descriptor type (USB_DT_*)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hM3hj ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj hM3hjubjI)}(h5``unsigned char index`` the number of the descriptor h](jO)}(h``unsigned char index``h]j)}(hj0h]hunsigned char index}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM4hj*ubji)}(hhh]h)}(hthe number of the descriptorh]hthe number of the descriptor}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjEhM4hjFubah}(h]h ]h"]h$]h&]uh1jhhj*ubeh}(h]h ]h"]h$]h&]uh1jHhjEhM4hjubjI)}(h*``void *buf`` where to put the descriptor h](jO)}(h ``void *buf``h]j)}(hjih]h void *buf}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM5hjcubji)}(hhh]h)}(hwhere to put the descriptorh]hwhere to put the descriptor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~hM5hjubah}(h]h ]h"]h$]h&]uh1jhhjcubeh}(h]h ]h"]h$]h&]uh1jHhj~hM5hjubjI)}(h``int size`` how big is "buf"? h](jO)}(h ``int size``h]j)}(hjh]hint size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM6hjubji)}(hhh]h)}(hhow big is "buf"?h]hhow big is “buf”?}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM6hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM6hjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM8hjubh)}(htask context, might sleep.h]htask context, might sleep.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM8hjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM:hjubh)}(hX|Gets a USB descriptor. Convenience functions exist to simplify getting some types of descriptors. Use usb_get_string() or usb_string() for USB_DT_STRING. Device (USB_DT_DEVICE) and configuration descriptors (USB_DT_CONFIG) are part of the device structure. In addition to a number of USB-standard descriptors, some devices also use class-specific or vendor-specific descriptors.h]hX|Gets a USB descriptor. Convenience functions exist to simplify getting some types of descriptors. Use usb_get_string() or usb_string() for USB_DT_STRING. Device (USB_DT_DEVICE) and configuration descriptors (USB_DT_CONFIG) are part of the device structure. In addition to a number of USB-standard descriptors, some devices also use class-specific or vendor-specific descriptors.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM9hjubh)}(hFThis call is synchronous, and may not be used in an interrupt context.h]hFThis call is synchronous, and may not be used in an interrupt context.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMAhjubh)}(h **Return**h]j.)}(hj:h]hReturn}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj8ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMChjubh)}(hsThe number of bytes received on success, or else the status code returned by the underlying usb_control_msg() call.h]hsThe number of bytes received on success, or else the status code returned by the underlying usb_control_msg() call.}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMDhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j usb_core.usb_string (C function)c.usb_core.usb_stringhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hJint usb_string (struct usb_device *dev, int index, char *buf, size_t size)h]j+)}(hIint usb_string(struct usb_device *dev, int index, char *buf, size_t size)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj{hhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj{hhhjhMubj)}(h usb_stringh]j)}(h usb_stringh]h usb_string}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhj{hhhjhMubj)}(h;(struct usb_device *dev, int index, char *buf, size_t size)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_stringesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdevh]hdev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h int indexh](jT)}(hinth]hint}(hj/hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj+ubjC)}(h h]h }(hj=hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj+ubj)}(hindexh]hindex}(hjKhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h char *bufh](jT)}(hcharh]hchar}(hjdhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj`ubjC)}(h h]h }(hjrhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj`ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj`ubj)}(hbufh]hbuf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h size_t sizeh](h)}(hhh]j)}(hsize_th]hsize_t}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjc.usb_core.usb_stringesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hsizeh]hsize}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhj{hhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjwhhhjhMubah}(h]jrah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjthhubj)}(hhh]h)}(h,returns UTF-8 version of a string descriptorh]h,returns UTF-8 version of a string descriptor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjthhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *dev`` the device whose string descriptor is being retrieved ``int index`` the number of the descriptor ``char *buf`` where to put the string ``size_t size`` how big is "buf"? **Context** task context, might sleep. **Description** This converts the UTF-16LE encoded strings returned by devices, from usb_get_string_descriptor(), to null-terminated UTF-8 encoded ones that are more usable in most kernel contexts. Note that this function chooses strings in the first language supported by the device. This call is synchronous, and may not be used in an interrupt context. **Return** length of the string (>= 0) or usb_control_msg status (< 0).h](h)}(h**Parameters**h]j.)}(hj"h]h Parameters}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubjD)}(hhh](jI)}(hQ``struct usb_device *dev`` the device whose string descriptor is being retrieved h](jO)}(h``struct usb_device *dev``h]j)}(hjAh]hstruct usb_device *dev}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj;ubji)}(hhh]h)}(h5the device whose string descriptor is being retrievedh]h5the device whose string descriptor is being retrieved}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVhMhjWubah}(h]h ]h"]h$]h&]uh1jhhj;ubeh}(h]h ]h"]h$]h&]uh1jHhjVhMhj8ubjI)}(h+``int index`` the number of the descriptor h](jO)}(h ``int index``h]j)}(hjzh]h int index}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjxubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjtubji)}(hhh]h)}(hthe number of the descriptorh]hthe number of the descriptor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjtubeh}(h]h ]h"]h$]h&]uh1jHhjhMhj8ubjI)}(h&``char *buf`` where to put the string h](jO)}(h ``char *buf``h]j)}(hjh]h char *buf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(hwhere to put the stringh]hwhere to put the string}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhj8ubjI)}(h"``size_t size`` how big is "buf"? h](jO)}(h``size_t size``h]j)}(hjh]h size_t size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(hhow big is "buf"?h]hhow big is “buf”?}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhj8ubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hj'h]hContext}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj%ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(htask context, might sleep.h]htask context, might sleep.}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h**Description**h]j.)}(hjNh]h Description}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjLubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hX This converts the UTF-16LE encoded strings returned by devices, from usb_get_string_descriptor(), to null-terminated UTF-8 encoded ones that are more usable in most kernel contexts. Note that this function chooses strings in the first language supported by the device.h]hX This converts the UTF-16LE encoded strings returned by devices, from usb_get_string_descriptor(), to null-terminated UTF-8 encoded ones that are more usable in most kernel contexts. Note that this function chooses strings in the first language supported by the device.}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hFThis call is synchronous, and may not be used in an interrupt context.h]hFThis call is synchronous, and may not be used in an interrupt context.}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h= 0) or usb_control_msg status (< 0).h]h= 0) or usb_control_msg status (< 0).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&usb_core.usb_cache_string (C function)c.usb_core.usb_cache_stringhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h``int recip`` USB_RECIP_*; for device, interface, or endpoint h](jO)}(h ``int recip``h]j)}(hjh]h int recip}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(h/USB_RECIP_*; for device, interface, or endpointh]h/USB_RECIP_*; for device, interface, or endpoint}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hMhj ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj hMhjubjI)}(hA``int type`` USB_STATUS_TYPE_*; for standard or PTM status types h](jO)}(h ``int type``h]j)}(hj-h]hint type}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj'ubji)}(hhh]h)}(h3USB_STATUS_TYPE_*; for standard or PTM status typesh]h3USB_STATUS_TYPE_*; for standard or PTM status types}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjBhMhjCubah}(h]h ]h"]h$]h&]uh1jhhj'ubeh}(h]h ]h"]h$]h&]uh1jHhjBhMhjubjI)}(hD``int target`` zero (for device), else interface or endpoint number h](jO)}(h``int target``h]j)}(hjfh]h int target}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjdubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj`ubji)}(hhh]h)}(h4zero (for device), else interface or endpoint numberh]h4zero (for device), else interface or endpoint number}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{hMhj|ubah}(h]h ]h"]h$]h&]uh1jhhj`ubeh}(h]h ]h"]h$]h&]uh1jHhj{hMhjubjI)}(h3``void *data`` pointer to two bytes of bitmap data h](jO)}(h``void *data``h]j)}(hjh]h void *data}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(h#pointer to two bytes of bitmap datah]h#pointer to two bytes of bitmap data}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(htask context, might sleep.h]htask context, might sleep.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hReturns device, interface, or endpoint status. Normally only of interest to see if the device is self powered, or has enabled the remote wakeup facility; or whether a bulk or interrupt endpoint is halted ("stalled").h]hReturns device, interface, or endpoint status. Normally only of interest to see if the device is self powered, or has enabled the remote wakeup facility; or whether a bulk or interrupt endpoint is halted (“stalled”).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hBits in these status bitmaps are set using the SET_FEATURE request, and cleared using the CLEAR_FEATURE request. The usb_clear_halt() function should be used to clear halt ("stall") status.h]hBits in these status bitmaps are set using the SET_FEATURE request, and cleared using the CLEAR_FEATURE request. The usb_clear_halt() function should be used to clear halt (“stall”) status.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hFThis call is synchronous, and may not be used in an interrupt context.h]hFThis call is synchronous, and may not be used in an interrupt context.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hReturns 0 and the status value in ***data** (in host byte order) on success, or else the status code from the underlying usb_control_msg() call.h](h"Returns 0 and the status value in }(hjDhhhNhNubj.)}(h ***data**h]h*data}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjDubhe (in host byte order) on success, or else the status code from the underlying usb_control_msg() call.}(hjDhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$usb_core.usb_clear_halt (C function)c.usb_core.usb_clear_halthNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h5int usb_clear_halt (struct usb_device *dev, int pipe)h]j+)}(h4int usb_clear_halt(struct usb_device *dev, int pipe)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(husb_clear_halth]j)}(husb_clear_halth]husb_clear_halt}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h"(struct usb_device *dev, int pipe)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_clear_haltesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdevh]hdev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hint pipeh](jT)}(hinth]hint}(hj5hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj1ubjC)}(h h]h }(hjChhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj1ubj)}(hpipeh]hpipe}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj}hhhjhMubah}(h]jxah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjzhhubj)}(hhh]h)}(h3tells device to clear endpoint halt/stall conditionh]h3tells device to clear endpoint halt/stall condition}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjxhhubah}(h]h ]h"]h$]h&]uh1jhjzhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hXR**Parameters** ``struct usb_device *dev`` device whose endpoint is halted ``int pipe`` endpoint "pipe" being cleared **Context** task context, might sleep. **Description** This is used to clear halt conditions for bulk and interrupt endpoints, as reported by URB completion status. Endpoints that are halted are sometimes referred to as being "stalled". Such endpoints are unable to transmit or receive data until the halt status is cleared. Any URBs queued for such an endpoint should normally be unlinked by the driver before clearing the halt condition, as described in sections 5.7.5 and 5.8.5 of the USB 2.0 spec. Note that control and isochronous endpoints don't halt, although control endpoints report "protocol stall" (for unsupported requests) using the same status code used to report a true stall. This call is synchronous, and may not be used in an interrupt context. If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. **Return** Zero on success, or else the status code returned by the underlying usb_control_msg() call.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubjD)}(hhh](jI)}(h;``struct usb_device *dev`` device whose endpoint is halted h](jO)}(h``struct usb_device *dev``h]j)}(hjh]hstruct usb_device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(hdevice whose endpoint is haltedh]hdevice whose endpoint is halted}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubjI)}(h+``int pipe`` endpoint "pipe" being cleared h](jO)}(h ``int pipe``h]j)}(hjh]hint pipe}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(hendpoint "pipe" being clearedh]h!endpoint “pipe” being cleared}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hMhj ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj hMhjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hj0h]hContext}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj.ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(htask context, might sleep.h]htask context, might sleep.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h**Description**h]j.)}(hjWh]h Description}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjUubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hXThis is used to clear halt conditions for bulk and interrupt endpoints, as reported by URB completion status. Endpoints that are halted are sometimes referred to as being "stalled". Such endpoints are unable to transmit or receive data until the halt status is cleared. Any URBs queued for such an endpoint should normally be unlinked by the driver before clearing the halt condition, as described in sections 5.7.5 and 5.8.5 of the USB 2.0 spec.h]hXThis is used to clear halt conditions for bulk and interrupt endpoints, as reported by URB completion status. Endpoints that are halted are sometimes referred to as being “stalled”. Such endpoints are unable to transmit or receive data until the halt status is cleared. Any URBs queued for such an endpoint should normally be unlinked by the driver before clearing the halt condition, as described in sections 5.7.5 and 5.8.5 of the USB 2.0 spec.}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hNote that control and isochronous endpoints don't halt, although control endpoints report "protocol stall" (for unsupported requests) using the same status code used to report a true stall.h]hNote that control and isochronous endpoints don’t halt, although control endpoints report “protocol stall” (for unsupported requests) using the same status code used to report a true stall.}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hThis call is synchronous, and may not be used in an interrupt context. If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete.h]hThis call is synchronous, and may not be used in an interrupt context. If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h[Zero on success, or else the status code returned by the underlying usb_control_msg() call.h]h[Zero on success, or else the status code returned by the underlying usb_control_msg() call.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.usb_reset_endpoint (C function)c.usb_core.usb_reset_endpointhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hEvoid usb_reset_endpoint (struct usb_device *dev, unsigned int epaddr)h]j+)}(hDvoid usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM_ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhM_ubj)}(husb_reset_endpointh]j)}(husb_reset_endpointh]husb_reset_endpoint}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhM_ubj)}(h-(struct usb_device *dev, unsigned int epaddr)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hj+hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj>modnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_reset_endpointesbuh1hhjubjC)}(h h]h }(hj]hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdevh]hdev}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned int epaddrh](jT)}(hunsignedh]hunsigned}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hepaddrh]hepaddr}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhM_ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhM_ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhM_hjhhubj)}(hhh]h)}(hReset an endpoint's state.h]hReset an endpoint’s state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM_hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhM_ubeh}(h]h ](jfunctioneh"]h$]h&]jjjj jj j j!j"uh1jhhhjrhNhNubj$)}(hX?**Parameters** ``struct usb_device *dev`` the device whose endpoint is to be reset ``unsigned int epaddr`` the endpoint's address. Endpoint number for output, endpoint number + USB_DIR_IN for input **Description** Resets any host-side endpoint state such as the toggle bit, sequence number or current window.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMchjubjD)}(hhh](jI)}(hD``struct usb_device *dev`` the device whose endpoint is to be reset h](jO)}(h``struct usb_device *dev``h]j)}(hj4h]hstruct usb_device *dev}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM`hj.ubji)}(hhh]h)}(h(the device whose endpoint is to be reseth]h(the device whose endpoint is to be reset}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjIhM`hjJubah}(h]h ]h"]h$]h&]uh1jhhj.ubeh}(h]h ]h"]h$]h&]uh1jHhjIhM`hj+ubjI)}(ht``unsigned int epaddr`` the endpoint's address. Endpoint number for output, endpoint number + USB_DIR_IN for input h](jO)}(h``unsigned int epaddr``h]j)}(hjmh]hunsigned int epaddr}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMbhjgubji)}(hhh]h)}(h[the endpoint's address. Endpoint number for output, endpoint number + USB_DIR_IN for inputh]h]the endpoint’s address. Endpoint number for output, endpoint number + USB_DIR_IN for input}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMahjubah}(h]h ]h"]h$]h&]uh1jhhjgubeh}(h]h ]h"]h$]h&]uh1jHhjhMbhj+ubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMdhjubh)}(h^Resets any host-side endpoint state such as the toggle bit, sequence number or current window.h]h^Resets any host-side endpoint state such as the toggle bit, sequence number or current window.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMchjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_core.usb_set_interface (C function)c.usb_core.usb_set_interfacehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hLint usb_set_interface (struct usb_device *dev, int interface, int alternate)h]j+)}(hKint usb_set_interface(struct usb_device *dev, int interface, int alternate)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(husb_set_interfaceh]j)}(husb_set_interfaceh]husb_set_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h6(struct usb_device *dev, int interface, int alternate)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hj+hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj'ubjC)}(h h]h }(hj8hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj'ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjIhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjKmodnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_set_interfaceesbuh1hhj'ubjC)}(h h]h }(hjjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj'ubjs)}(hjvh]h*}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj'ubj)}(hdevh]hdev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj#ubj)}(h int interfaceh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(h interfaceh]h interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj#ubj)}(h int alternateh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(h alternateh]h alternate}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj#ubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(h/Makes a particular alternate setting be currenth]h/Makes a particular alternate setting be current}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj1jj1j j!j"uh1jhhhjrhNhNubj$)}(hXk**Parameters** ``struct usb_device *dev`` the device whose interface is being updated ``int interface`` the interface being updated ``int alternate`` the setting being chosen. **Context** task context, might sleep. **Description** This is used to enable data transfers on interfaces that may not be enabled by default. Not all devices support such configurability. Only the driver bound to an interface may change its setting. Within any given configuration, each interface may have several alternative settings. These are often used to control levels of bandwidth consumption. For example, the default setting for a high speed interrupt endpoint may not send more than 64 bytes per microframe, while interrupt transfers of up to 3KBytes per microframe are legal. Also, isochronous endpoints may never be part of an interface's default setting. To access such bandwidth, alternate interface settings must be made current. Note that in the Linux USB subsystem, bandwidth associated with an endpoint in a given alternate setting is not reserved until an URB is submitted that needs that bandwidth. Some other operating systems allocate bandwidth early, when a configuration is chosen. xHCI reserves bandwidth and configures the alternate setting in usb_hcd_alloc_bandwidth(). If it fails the original interface altsetting may be disabled. Drivers cannot rely on any particular alternate setting being in effect after a failure. This call is synchronous, and may not be used in an interrupt context. Also, drivers must not change altsettings while urbs are scheduled for endpoints in that interface; all such urbs must first be completed (perhaps forced by unlinking). If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete. **Return** Zero on success, or else the status code returned by the underlying usb_control_msg() call.h](h)}(h**Parameters**h]j.)}(hj;h]h Parameters}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj9ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj5ubjD)}(hhh](jI)}(hG``struct usb_device *dev`` the device whose interface is being updated h](jO)}(h``struct usb_device *dev``h]j)}(hjZh]hstruct usb_device *dev}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjXubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjTubji)}(hhh]h)}(h+the device whose interface is being updatedh]h+the device whose interface is being updated}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjohMhjpubah}(h]h ]h"]h$]h&]uh1jhhjTubeh}(h]h ]h"]h$]h&]uh1jHhjohMhjQubjI)}(h.``int interface`` the interface being updated h](jO)}(h``int interface``h]j)}(hjh]h int interface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(hthe interface being updatedh]hthe interface being updated}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjQubjI)}(h,``int alternate`` the setting being chosen. h](jO)}(h``int alternate``h]j)}(hjh]h int alternate}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(hthe setting being chosen.h]hthe setting being chosen.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjQubeh}(h]h ]h"]h$]h&]uh1jChj5ubh)}(h **Context**h]j.)}(hjh]hContext}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj5ubh)}(htask context, might sleep.h]htask context, might sleep.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj5ubh)}(h**Description**h]j.)}(hj.h]h Description}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj,ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj5ubh)}(hThis is used to enable data transfers on interfaces that may not be enabled by default. Not all devices support such configurability. Only the driver bound to an interface may change its setting.h]hThis is used to enable data transfers on interfaces that may not be enabled by default. Not all devices support such configurability. Only the driver bound to an interface may change its setting.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj5ubh)}(hXWithin any given configuration, each interface may have several alternative settings. These are often used to control levels of bandwidth consumption. For example, the default setting for a high speed interrupt endpoint may not send more than 64 bytes per microframe, while interrupt transfers of up to 3KBytes per microframe are legal. Also, isochronous endpoints may never be part of an interface's default setting. To access such bandwidth, alternate interface settings must be made current.h]hXWithin any given configuration, each interface may have several alternative settings. These are often used to control levels of bandwidth consumption. For example, the default setting for a high speed interrupt endpoint may not send more than 64 bytes per microframe, while interrupt transfers of up to 3KBytes per microframe are legal. Also, isochronous endpoints may never be part of an interface’s default setting. To access such bandwidth, alternate interface settings must be made current.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj5ubh)}(hXNote that in the Linux USB subsystem, bandwidth associated with an endpoint in a given alternate setting is not reserved until an URB is submitted that needs that bandwidth. Some other operating systems allocate bandwidth early, when a configuration is chosen.h]hXNote that in the Linux USB subsystem, bandwidth associated with an endpoint in a given alternate setting is not reserved until an URB is submitted that needs that bandwidth. Some other operating systems allocate bandwidth early, when a configuration is chosen.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM%hj5ubh)}(hxHCI reserves bandwidth and configures the alternate setting in usb_hcd_alloc_bandwidth(). If it fails the original interface altsetting may be disabled. Drivers cannot rely on any particular alternate setting being in effect after a failure.h]hxHCI reserves bandwidth and configures the alternate setting in usb_hcd_alloc_bandwidth(). If it fails the original interface altsetting may be disabled. Drivers cannot rely on any particular alternate setting being in effect after a failure.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM*hj5ubh)}(hXZThis call is synchronous, and may not be used in an interrupt context. Also, drivers must not change altsettings while urbs are scheduled for endpoints in that interface; all such urbs must first be completed (perhaps forced by unlinking). If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete.h]hXZThis call is synchronous, and may not be used in an interrupt context. Also, drivers must not change altsettings while urbs are scheduled for endpoints in that interface; all such urbs must first be completed (perhaps forced by unlinking). If a thread in your driver uses this call, make sure your disconnect() method can wait for it to complete.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM/hj5ubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM5hj5ubh)}(h[Zero on success, or else the status code returned by the underlying usb_control_msg() call.h]h[Zero on success, or else the status code returned by the underlying usb_control_msg() call.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM6hj5ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_core.usb_reset_configuration (C function)"c.usb_core.usb_reset_configurationhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h4int usb_reset_configuration (struct usb_device *dev)h]j+)}(h3int usb_reset_configuration(struct usb_device *dev)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(husb_reset_configurationh]j)}(husb_reset_configurationh]husb_reset_configuration}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h(struct usb_device *dev)h]j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj3modnameN classnameNjLjO)}jR](jNjU)}jHjsb"c.usb_core.usb_reset_configurationesbuh1hhjubjC)}(h h]h }(hjRhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdevh]hdev}(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(hlightweight device reseth]hlightweight device reset}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hXz**Parameters** ``struct usb_device *dev`` the device whose configuration is being reset **Description** This issues a standard SET_CONFIGURATION request to the device using the current configuration. The effect is to reset most USB-related state in the device, including interface altsettings (reset to zero), endpoint halts (cleared), and endpoint state (only for bulk and interrupt endpoints). Other usbcore state is unchanged, including bindings of usb device drivers to interfaces. Because this affects multiple interfaces, avoid using this with composite (multi-interface) devices. Instead, the driver for each interface may use usb_set_interface() on the interfaces it claims. Be careful though; some devices don't support the SET_INTERFACE request, and others won't reset all the interface state (notably endpoint state). Resetting the whole configuration would affect other drivers' interfaces. The caller must own the device lock. If this routine fails the device will probably be in an unusable state with endpoints disabled, and interfaces only partially enabled. **Return** Zero on success, else a negative error code.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubjD)}(hhh]jI)}(hI``struct usb_device *dev`` the device whose configuration is being reset h](jO)}(h``struct usb_device *dev``h]j)}(hjh]hstruct usb_device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubji)}(hhh]h)}(h-the device whose configuration is being reseth]h-the device whose configuration is being reset}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hXThis issues a standard SET_CONFIGURATION request to the device using the current configuration. The effect is to reset most USB-related state in the device, including interface altsettings (reset to zero), endpoint halts (cleared), and endpoint state (only for bulk and interrupt endpoints). Other usbcore state is unchanged, including bindings of usb device drivers to interfaces.h]hXThis issues a standard SET_CONFIGURATION request to the device using the current configuration. The effect is to reset most USB-related state in the device, including interface altsettings (reset to zero), endpoint halts (cleared), and endpoint state (only for bulk and interrupt endpoints). Other usbcore state is unchanged, including bindings of usb device drivers to interfaces.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hXBecause this affects multiple interfaces, avoid using this with composite (multi-interface) devices. Instead, the driver for each interface may use usb_set_interface() on the interfaces it claims. Be careful though; some devices don't support the SET_INTERFACE request, and others won't reset all the interface state (notably endpoint state). Resetting the whole configuration would affect other drivers' interfaces.h]hXBecause this affects multiple interfaces, avoid using this with composite (multi-interface) devices. Instead, the driver for each interface may use usb_set_interface() on the interfaces it claims. Be careful though; some devices don’t support the SET_INTERFACE request, and others won’t reset all the interface state (notably endpoint state). Resetting the whole configuration would affect other drivers’ interfaces.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h$The caller must own the device lock.h]h$The caller must own the device lock.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(hIf this routine fails the device will probably be in an unusable state with endpoints disabled, and interfaces only partially enabled.h]hIf this routine fails the device will probably be in an unusable state with endpoints disabled, and interfaces only partially enabled.}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h **Return**h]j.)}(hjgh]hReturn}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjeubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h,Zero on success, else a negative error code.h]h,Zero on success, else a negative error code.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_core.usb_set_wireless_status (C function)"c.usb_core.usb_set_wireless_statushNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hZint usb_set_wireless_status (struct usb_interface *iface, enum usb_wireless_status status)h]j+)}(hYint usb_set_wireless_status(struct usb_interface *iface, enum usb_wireless_status status)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(husb_set_wireless_statush]j)}(husb_set_wireless_statush]husb_set_wireless_status}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h>(struct usb_interface *iface, enum usb_wireless_status status)h](j)}(hstruct usb_interface *ifaceh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR](jNjU)}jHjsb"c.usb_core.usb_set_wireless_statusesbuh1hhjubjC)}(h h]h }(hj(hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hifaceh]hiface}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(henum usb_wireless_status statush](j1)}(hjh]henum}(hj\hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjXubjC)}(h h]h }(hjihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjXubh)}(hhh]j)}(husb_wireless_statush]husb_wireless_status}(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj|modnameN classnameNjLjO)}jR](jNj$"c.usb_core.usb_set_wireless_statusesbuh1hhjXubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjXubj)}(hstatush]hstatus}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(h&sets the wireless_status struct memberh]h&sets the wireless_status struct member}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX,**Parameters** ``struct usb_interface *iface`` the interface to modify ``enum usb_wireless_status status`` the new wireless status **Description** Set the wireless_status struct member to the new value, and emit sysfs changes as necessary. **Return** 0 on success, -EALREADY if already set.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubjD)}(hhh](jI)}(h8``struct usb_interface *iface`` the interface to modify h](jO)}(h``struct usb_interface *iface``h]j)}(hjh]hstruct usb_interface *iface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhj ubji)}(hhh]h)}(hthe interface to modifyh]hthe interface to modify}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj'hMhj(ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj'hMhj ubjI)}(h<``enum usb_wireless_status status`` the new wireless status h](jO)}(h#``enum usb_wireless_status status``h]j)}(hjKh]henum usb_wireless_status status}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjEubji)}(hhh]h)}(hthe new wireless statush]hthe new wireless status}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hMhjaubah}(h]h ]h"]h$]h&]uh1jhhjEubeh}(h]h ]h"]h$]h&]uh1jHhj`hMhj ubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h\Set the wireless_status struct member to the new value, and emit sysfs changes as necessary.h]h\Set the wireless_status struct member to the new value, and emit sysfs changes as necessary.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubh)}(h'0 on success, -EALREADY if already set.h]h'0 on success, -EALREADY if already set.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j2usb_core.usb_driver_set_configuration (C function)'c.usb_core.usb_driver_set_configurationhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hFint usb_driver_set_configuration (struct usb_device *udev, int config)h]j+)}(hEint usb_driver_set_configuration(struct usb_device *udev, int config)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhM ubj)}(husb_driver_set_configurationh]j)}(husb_driver_set_configurationh]husb_driver_set_configuration}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhM ubj)}(h%(struct usb_device *udev, int config)h](j)}(hstruct usb_device *udevh](j1)}(hjh]hstruct}(hj/hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj+ubjC)}(h h]h }(hj<hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj+ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjMhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjOmodnameN classnameNjLjO)}jR](jNjU)}jHjsb'c.usb_core.usb_driver_set_configurationesbuh1hhj+ubjC)}(h h]h }(hjnhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj+ubjs)}(hjvh]h*}(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj+ubj)}(hudevh]hudev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj'ubj)}(h int configh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hconfigh]hconfig}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj'ubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhM ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhM hjhhubj)}(hhh]h)}(h9Provide a way for drivers to change device configurationsh]h9Provide a way for drivers to change device configurations}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hXO**Parameters** ``struct usb_device *udev`` the device whose configuration is being updated ``int config`` the configuration being chosen. **Context** In process context, must be able to sleep **Description** Device interface drivers are not allowed to change device configurations. This is because changing configurations will destroy the interface the driver is bound to and create new ones; it would be like a floppy-disk driver telling the computer to replace the floppy-disk drive with a tape drive! Still, in certain specialized circumstances the need may arise. This routine gets around the normal restrictions by using a work thread to submit the change-config request. **Return** 0 if the request was successfully queued, error code otherwise. The caller has no way to know whether the queued request will eventually succeed.h](h)}(h**Parameters**h]j.)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM! hjubjD)}(hhh](jI)}(hL``struct usb_device *udev`` the device whose configuration is being updated h](jO)}(h``struct usb_device *udev``h]j)}(hj)h]hstruct usb_device *udev}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM hj#ubji)}(hhh]h)}(h/the device whose configuration is being updatedh]h/the device whose configuration is being updated}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hM hj?ubah}(h]h ]h"]h$]h&]uh1jhhj#ubeh}(h]h ]h"]h$]h&]uh1jHhj>hM hj ubjI)}(h/``int config`` the configuration being chosen. h](jO)}(h``int config``h]j)}(hjbh]h int config}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM hj\ubji)}(hhh]h)}(hthe configuration being chosen.h]hthe configuration being chosen.}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwhM hjxubah}(h]h ]h"]h$]h&]uh1jhhj\ubeh}(h]h ]h"]h$]h&]uh1jHhjwhM hj ubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM! hjubh)}(h)In process context, must be able to sleeph]h)In process context, must be able to sleep}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM hjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM" hjubh)}(hX'Device interface drivers are not allowed to change device configurations. This is because changing configurations will destroy the interface the driver is bound to and create new ones; it would be like a floppy-disk driver telling the computer to replace the floppy-disk drive with a tape drive!h]hX'Device interface drivers are not allowed to change device configurations. This is because changing configurations will destroy the interface the driver is bound to and create new ones; it would be like a floppy-disk driver telling the computer to replace the floppy-disk drive with a tape drive!}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM! hjubh)}(hStill, in certain specialized circumstances the need may arise. This routine gets around the normal restrictions by using a work thread to submit the change-config request.h]hStill, in certain specialized circumstances the need may arise. This routine gets around the normal restrictions by using a work thread to submit the change-config request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM' hjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM+ hjubh)}(h0 if the request was successfully queued, error code otherwise. The caller has no way to know whether the queued request will eventually succeed.h]h0 if the request was successfully queued, error code otherwise. The caller has no way to know whether the queued request will eventually succeed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chM, hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j*usb_core.cdc_parse_cdc_header (C function)c.usb_core.cdc_parse_cdc_headerhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hpint cdc_parse_cdc_header (struct usb_cdc_parsed_header *hdr, struct usb_interface *intf, u8 *buffer, int buflen)h]j+)}(hoint cdc_parse_cdc_header(struct usb_cdc_parsed_header *hdr, struct usb_interface *intf, u8 *buffer, int buflen)h](jT)}(hinth]hint}(hj?hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj;hhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMF ubjC)}(h h]h }(hjNhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj;hhhjMhMF ubj)}(hcdc_parse_cdc_headerh]j)}(hcdc_parse_cdc_headerh]hcdc_parse_cdc_header}(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj;hhhjMhMF ubj)}(hW(struct usb_cdc_parsed_header *hdr, struct usb_interface *intf, u8 *buffer, int buflen)h](j)}(h!struct usb_cdc_parsed_header *hdrh](j1)}(hjh]hstruct}(hj|hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjxubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjxubh)}(hhh]j)}(husb_cdc_parsed_headerh]husb_cdc_parsed_header}(hjhhhNhNubah}(h]h ]jah"]h$] h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjbsbc.usb_core.cdc_parse_cdc_headeresbuh1hhjxubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjxubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjxubj)}(hhdrh]hhdr}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjtubj)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjc.usb_core.cdc_parse_cdc_headeresbuh1hhjubjC)}(h h]h }(hj,hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hintfh]hintf}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjtubj)}(h u8 *bufferh](h)}(hhh]j)}(hu8h]hu8}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjemodnameN classnameNjLjO)}jR](jNjc.usb_core.cdc_parse_cdc_headeresbuh1hhj\ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj\ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj\ubj)}(hbufferh]hbuffer}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjtubj)}(h int buflenh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hbuflenh]hbuflen}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjtubeh}(h]h ]h"]h$]h&]jjuh1jhj;hhhjMhMF ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj7hhhjMhMF ubah}(h]j2ah ](jjeh"]h$]h&]jj)jhuh1j$hjMhMF hj4hhubj)}(hhh]h)}(h.parse the extra headers present in CDC devicesh]h.parse the extra headers present in CDC devices}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMF hjhhubah}(h]h ]h"]h$]h&]uh1jhj4hhhjMhMF ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX2**Parameters** ``struct usb_cdc_parsed_header *hdr`` the place to put the results of the parsing ``struct usb_interface *intf`` the interface for which parsing is requested ``u8 *buffer`` pointer to the extra headers to be parsed ``int buflen`` length of the extra headers **Description** This evaluates the extra headers present in CDC devices which bind the interfaces for data and control and provide details about the capabilities of the device. **Return** number of descriptors parsed or -EINVAL if the header is contradictory beyond salvageh](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMJ hjubjD)}(hhh](jI)}(hR``struct usb_cdc_parsed_header *hdr`` the place to put the results of the parsing h](jO)}(h%``struct usb_cdc_parsed_header *hdr``h]j)}(hj=h]h!struct usb_cdc_parsed_header *hdr}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMG hj7ubji)}(hhh]h)}(h+the place to put the results of the parsingh]h+the place to put the results of the parsing}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhMG hjSubah}(h]h ]h"]h$]h&]uh1jhhj7ubeh}(h]h ]h"]h$]h&]uh1jHhjRhMG hj4ubjI)}(hL``struct usb_interface *intf`` the interface for which parsing is requested h](jO)}(h``struct usb_interface *intf``h]j)}(hjvh]hstruct usb_interface *intf}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMH hjpubji)}(hhh]h)}(h,the interface for which parsing is requestedh]h,the interface for which parsing is requested}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMH hjubah}(h]h ]h"]h$]h&]uh1jhhjpubeh}(h]h ]h"]h$]h&]uh1jHhjhMH hj4ubjI)}(h9``u8 *buffer`` pointer to the extra headers to be parsed h](jO)}(h``u8 *buffer``h]j)}(hjh]h u8 *buffer}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMI hjubji)}(hhh]h)}(h)pointer to the extra headers to be parsedh]h)pointer to the extra headers to be parsed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMI hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMI hj4ubjI)}(h+``int buflen`` length of the extra headers h](jO)}(h``int buflen``h]j)}(hjh]h int buflen}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMJ hjubji)}(hhh]h)}(hlength of the extra headersh]hlength of the extra headers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMJ hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMJ hj4ubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hj#h]h Description}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj!ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chML hjubh)}(hThis evaluates the extra headers present in CDC devices which bind the interfaces for data and control and provide details about the capabilities of the device.h]hThis evaluates the extra headers present in CDC devices which bind the interfaces for data and control and provide details about the capabilities of the device.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMK hjubh)}(h **Return**h]j.)}(hjJh]hReturn}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjHubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMO hjubh)}(hUnumber of descriptors parsed or -EINVAL if the header is contradictory beyond salvageh]hUnumber of descriptors parsed or -EINVAL if the header is contradictory beyond salvage}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:165: ./drivers/usb/core/message.chMP hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&usb_core.usb_register_dev (C function)c.usb_core.usb_register_devhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hXint usb_register_dev (struct usb_interface *intf, struct usb_class_driver *class_driver)h]j+)}(hWint usb_register_dev(struct usb_interface *intf, struct usb_class_driver *class_driver)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chK\ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhK\ubj)}(husb_register_devh]j)}(husb_register_devh]husb_register_dev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhK\ubj)}(hC(struct usb_interface *intf, struct usb_class_driver *class_driver)h](j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_register_devesbuh1hhjubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hintfh]hintf}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h%struct usb_class_driver *class_driverh](j1)}(hjh]hstruct}(hj?hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj;ubjC)}(h h]h }(hjLhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj;ubh)}(hhh]j)}(husb_class_driverh]husb_class_driver}(hj]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj_modnameN classnameNjLjO)}jR](jNjc.usb_core.usb_register_devesbuh1hhj;ubjC)}(h h]h }(hj|hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj;ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj;ubj)}(h class_driverh]h class_driver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhK\ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhK\ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhK\hjhhubj)}(hhh]h)}(h1register a USB device, and ask for a minor numberh]h1register a USB device, and ask for a minor number}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chK\hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhK\ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX.**Parameters** ``struct usb_interface *intf`` pointer to the usb_interface that is being registered ``struct usb_class_driver *class_driver`` pointer to the usb_class_driver for this device **Description** This should be called by all USB drivers that use the USB major number. If CONFIG_USB_DYNAMIC_MINORS is enabled, the minor number will be dynamically allocated out of the list of available ones. If it is not enabled, the minor number will be based on the next available free minor, starting at the class_driver->minor_base. This function also creates a usb class device in the sysfs tree. usb_deregister_dev() must be called when the driver is done with the minor numbers given out by this function. **Return** -EINVAL if something bad happens with trying to register a device, and 0 on success.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chK`hjubjD)}(hhh](jI)}(hU``struct usb_interface *intf`` pointer to the usb_interface that is being registered h](jO)}(h``struct usb_interface *intf``h]j)}(hjh]hstruct usb_interface *intf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chK]hjubji)}(hhh]h)}(h5pointer to the usb_interface that is being registeredh]h5pointer to the usb_interface that is being registered}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK]hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhK]hjubjI)}(hZ``struct usb_class_driver *class_driver`` pointer to the usb_class_driver for this device h](jO)}(h)``struct usb_class_driver *class_driver``h]j)}(hj;h]h%struct usb_class_driver *class_driver}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]uh1jNh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chK^hj5ubji)}(hhh]h)}(h/pointer to the usb_class_driver for this deviceh]h/pointer to the usb_class_driver for this device}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhjPhK^hjQubah}(h]h ]h"]h$]h&]uh1jhhj5ubeh}(h]h ]h"]h$]h&]uh1jHhjPhK^hjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjvh]h Description}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjtubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chK`hjubh)}(hXDThis should be called by all USB drivers that use the USB major number. If CONFIG_USB_DYNAMIC_MINORS is enabled, the minor number will be dynamically allocated out of the list of available ones. If it is not enabled, the minor number will be based on the next available free minor, starting at the class_driver->minor_base.h]hXDThis should be called by all USB drivers that use the USB major number. If CONFIG_USB_DYNAMIC_MINORS is enabled, the minor number will be dynamically allocated out of the list of available ones. If it is not enabled, the minor number will be based on the next available free minor, starting at the class_driver->minor_base.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chK_hjubh)}(h@This function also creates a usb class device in the sysfs tree.h]h@This function also creates a usb class device in the sysfs tree.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKehjubh)}(hnusb_deregister_dev() must be called when the driver is done with the minor numbers given out by this function.h]hnusb_deregister_dev() must be called when the driver is done with the minor numbers given out by this function.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKghjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKjhjubh)}(hT-EINVAL if something bad happens with trying to register a device, and 0 on success.h]hT-EINVAL if something bad happens with trying to register a device, and 0 on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKkhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.usb_deregister_dev (C function)c.usb_core.usb_deregister_devhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h[void usb_deregister_dev (struct usb_interface *intf, struct usb_class_driver *class_driver)h]j+)}(hZvoid usb_deregister_dev(struct usb_interface *intf, struct usb_class_driver *class_driver)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhKubj)}(husb_deregister_devh]j)}(husb_deregister_devh]husb_deregister_dev}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhKubj)}(hC(struct usb_interface *intf, struct usb_class_driver *class_driver)h](j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hj=hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj9ubjC)}(h h]h }(hjJhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj9ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj[hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj]modnameN classnameNjLjO)}jR](jNjU)}jHj#sbc.usb_core.usb_deregister_devesbuh1hhj9ubjC)}(h h]h }(hj|hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj9ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj9ubj)}(hintfh]hintf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj9ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj5ubj)}(h%struct usb_class_driver *class_driverh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(husb_class_driverh]husb_class_driver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjxc.usb_core.usb_deregister_devesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(h class_driverh]h class_driver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj5ubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhKubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhKhjhhubj)}(hhh]h)}(h(deregister a USB device's dynamic minor.h]h*deregister a USB device’s dynamic minor.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKhj/hhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhKubeh}(h]h ](jfunctioneh"]h$]h&]jjjjJjjJj j!j"uh1jhhhjrhNhNubj$)}(hXC**Parameters** ``struct usb_interface *intf`` pointer to the usb_interface that is being deregistered ``struct usb_class_driver *class_driver`` pointer to the usb_class_driver for this device **Description** Used in conjunction with usb_register_dev(). This function is called when the USB driver is finished with the minor numbers gotten from a call to usb_register_dev() (usually when the device is disconnected from the system.) This function also removes the usb class device from the sysfs tree. This should be called by all drivers that use the USB major number.h](h)}(h**Parameters**h]j.)}(hjTh]h Parameters}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjRubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKhjNubjD)}(hhh](jI)}(hW``struct usb_interface *intf`` pointer to the usb_interface that is being deregistered h](jO)}(h``struct usb_interface *intf``h]j)}(hjsh]hstruct usb_interface *intf}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]uh1jNh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKhjmubji)}(hhh]h)}(h7pointer to the usb_interface that is being deregisteredh]h7pointer to the usb_interface that is being deregistered}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjmubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjjubjI)}(hZ``struct usb_class_driver *class_driver`` pointer to the usb_class_driver for this device h](jO)}(h)``struct usb_class_driver *class_driver``h]j)}(hjh]h%struct usb_class_driver *class_driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKhjubji)}(hhh]h)}(h/pointer to the usb_class_driver for this deviceh]h/pointer to the usb_class_driver for this device}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjjubeh}(h]h ]h"]h$]h&]uh1jChjNubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKhjNubh)}(hUsed in conjunction with usb_register_dev(). This function is called when the USB driver is finished with the minor numbers gotten from a call to usb_register_dev() (usually when the device is disconnected from the system.)h]hUsed in conjunction with usb_register_dev(). This function is called when the USB driver is finished with the minor numbers gotten from a call to usb_register_dev() (usually when the device is disconnected from the system.)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKhjNubh)}(hDThis function also removes the usb class device from the sysfs tree.h]hDThis function also removes the usb class device from the sysfs tree.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKhjNubh)}(hCThis should be called by all drivers that use the USB major number.h]hCThis should be called by all drivers that use the USB major number.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh[/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:168: ./drivers/usb/core/file.chKhjNubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j0usb_core.usb_driver_claim_interface (C function)%c.usb_core.usb_driver_claim_interfacehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hcint usb_driver_claim_interface (struct usb_driver *driver, struct usb_interface *iface, void *data)h]j+)}(hbint usb_driver_claim_interface(struct usb_driver *driver, struct usb_interface *iface, void *data)h](jT)}(hinth]hint}(hjJhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjFhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMubjC)}(h h]h }(hjYhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjFhhhjXhMubj)}(husb_driver_claim_interfaceh]j)}(husb_driver_claim_interfaceh]husb_driver_claim_interface}(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjgubah}(h]h ](jjeh"]h$]h&]jjuh1jhjFhhhjXhMubj)}(hD(struct usb_driver *driver, struct usb_interface *iface, void *data)h](j)}(hstruct usb_driver *driverh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_driverh]h usb_driver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjmsb%c.usb_core.usb_driver_claim_interfaceesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdriverh]hdriver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hstruct usb_interface *ifaceh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNj%c.usb_core.usb_driver_claim_interfaceesbuh1hhjubjC)}(h h]h }(hj7hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hifaceh]hiface}(hjRhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h void *datah](jT)}(hvoidh]hvoid}(hjkhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjgubjC)}(h h]h }(hjyhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjgubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjgubj)}(hdatah]hdata}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjgubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjFhhhjXhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjBhhhjXhMubah}(h]j=ah ](jjeh"]h$]h&]jj)jhuh1j$hjXhMhj?hhubj)}(hhh]h)}(hbind a driver to an interfaceh]hbind a driver to an interface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhj?hhhjXhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_driver *driver`` the driver to be bound ``struct usb_interface *iface`` the interface to which it will be bound; must be in the usb device's active configuration ``void *data`` driver data associated with that interface **Description** This is used by usb device drivers that need to claim more than one interface on a device when probing (audio and acm are current examples). No device driver should directly modify internal usb_interface or usb_device structure members. Callers must own the device lock, so driver probe() entries don't need extra locking, but other call contexts may need to explicitly claim that lock. **Return** 0 on success.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubjD)}(hhh](jI)}(h5``struct usb_driver *driver`` the driver to be bound h](jO)}(h``struct usb_driver *driver``h]j)}(hjh]hstruct usb_driver *driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubji)}(hhh]h)}(hthe driver to be boundh]hthe driver to be bound}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubjI)}(hz``struct usb_interface *iface`` the interface to which it will be bound; must be in the usb device's active configuration h](jO)}(h``struct usb_interface *iface``h]j)}(hj8h]hstruct usb_interface *iface}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj2ubji)}(hhh]h)}(hYthe interface to which it will be bound; must be in the usb device's active configurationh]h[the interface to which it will be bound; must be in the usb device’s active configuration}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjNubah}(h]h ]h"]h$]h&]uh1jhhj2ubeh}(h]h ]h"]h$]h&]uh1jHhjMhMhjubjI)}(h:``void *data`` driver data associated with that interface h](jO)}(h``void *data``h]j)}(hjrh]h void *data}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjlubji)}(hhh]h)}(h*driver data associated with that interfaceh]h*driver data associated with that interface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjlubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(hThis is used by usb device drivers that need to claim more than one interface on a device when probing (audio and acm are current examples). No device driver should directly modify internal usb_interface or usb_device structure members.h]hThis is used by usb device drivers that need to claim more than one interface on a device when probing (audio and acm are current examples). No device driver should directly modify internal usb_interface or usb_device structure members.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(hCallers must own the device lock, so driver probe() entries don't need extra locking, but other call contexts may need to explicitly claim that lock.h]hCallers must own the device lock, so driver probe() entries don’t need extra locking, but other call contexts may need to explicitly claim that lock.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM$hjubh)}(h 0 on success.h]h 0 on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM%hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j2usb_core.usb_driver_release_interface (C function)'c.usb_core.usb_driver_release_interfacehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hZvoid usb_driver_release_interface (struct usb_driver *driver, struct usb_interface *iface)h]j+)}(hYvoid usb_driver_release_interface(struct usb_driver *driver, struct usb_interface *iface)h](jT)}(hvoidh]hvoid}(hj(hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj$hhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMdubjC)}(h h]h }(hj7hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj$hhhj6hMdubj)}(husb_driver_release_interfaceh]j)}(husb_driver_release_interfaceh]husb_driver_release_interface}(hjIhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubah}(h]h ](jjeh"]h$]h&]jjuh1jhj$hhhj6hMdubj)}(h8(struct usb_driver *driver, struct usb_interface *iface)h](j)}(hstruct usb_driver *driverh](j1)}(hjh]hstruct}(hjehhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjaubjC)}(h h]h }(hjrhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjaubh)}(hhh]j)}(h usb_driverh]h usb_driver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjKsb'c.usb_core.usb_driver_release_interfaceesbuh1hhjaubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjaubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjaubj)}(hdriverh]hdriver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjaubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj]ubj)}(hstruct usb_interface *ifaceh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNj'c.usb_core.usb_driver_release_interfaceesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hifaceh]hiface}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj]ubeh}(h]h ]h"]h$]h&]jjuh1jhj$hhhj6hMdubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj hhhj6hMdubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hj6hMdhjhhubj)}(hhh]h)}(h!unbind a driver from an interfaceh]h!unbind a driver from an interface}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMdhjWhhubah}(h]h ]h"]h$]h&]uh1jhjhhhj6hMdubeh}(h]h ](jfunctioneh"]h$]h&]jjjjrjjrj j!j"uh1jhhhjrhNhNubj$)}(hXM**Parameters** ``struct usb_driver *driver`` the driver to be unbound ``struct usb_interface *iface`` the interface from which it will be unbound **Description** This can be used by drivers to release an interface without waiting for their disconnect() methods to be called. In typical cases this also causes the driver disconnect() method to be called. This call is synchronous, and may not be used in an interrupt context. Callers must own the device lock, so driver disconnect() entries don't need extra locking, but other call contexts may need to explicitly claim that lock.h](h)}(h**Parameters**h]j.)}(hj|h]h Parameters}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjzubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhhjvubjD)}(hhh](jI)}(h7``struct usb_driver *driver`` the driver to be unbound h](jO)}(h``struct usb_driver *driver``h]j)}(hjh]hstruct usb_driver *driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMehjubji)}(hhh]h)}(hthe driver to be unboundh]hthe driver to be unbound}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMehjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMehjubjI)}(hL``struct usb_interface *iface`` the interface from which it will be unbound h](jO)}(h``struct usb_interface *iface``h]j)}(hjh]hstruct usb_interface *iface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMfhjubji)}(hhh]h)}(h+the interface from which it will be unboundh]h+the interface from which it will be unbound}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMfhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMfhjubeh}(h]h ]h"]h$]h&]uh1jChjvubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhhjvubh)}(hThis can be used by drivers to release an interface without waiting for their disconnect() methods to be called. In typical cases this also causes the driver disconnect() method to be called.h]hThis can be used by drivers to release an interface without waiting for their disconnect() methods to be called. In typical cases this also causes the driver disconnect() method to be called.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMghjvubh)}(hThis call is synchronous, and may not be used in an interrupt context. Callers must own the device lock, so driver disconnect() entries don't need extra locking, but other call contexts may need to explicitly claim that lock.h]hThis call is synchronous, and may not be used in an interrupt context. Callers must own the device lock, so driver disconnect() entries don’t need extra locking, but other call contexts may need to explicitly claim that lock.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMkhjvubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"usb_core.usb_match_id (C function)c.usb_core.usb_match_idhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hkconst struct usb_device_id * usb_match_id (struct usb_interface *interface, const struct usb_device_id *id)h]j+)}(hiconst struct usb_device_id *usb_match_id(struct usb_interface *interface, const struct usb_device_id *id)h](j1)}(hj4h]hconst}(hjchhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj_hhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMubjC)}(h h]h }(hjqhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_hhhjphMubj1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj_hhhjphMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_hhhjphMubh)}(hhh]j)}(h usb_device_idh]h usb_device_id}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jH usb_match_idsbc.usb_core.usb_match_idesbuh1hhj_hhhjphMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_hhhjphMubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj_hhhjphMubj)}(h usb_match_idh]j)}(hjh]h usb_match_id}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhj_hhhjphMubj)}(hA(struct usb_interface *interface, const struct usb_device_id *id)h](j)}(hstruct usb_interface *interfaceh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjc.usb_core.usb_match_idesbuh1hhjubjC)}(h h]h }(hj6hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjDhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(h interfaceh]h interface}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hconst struct usb_device_id *idh](j1)}(hj4h]hconst}(hjjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjfubjC)}(h h]h }(hjwhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjfubj1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjfubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjfubh)}(hhh]j)}(h usb_device_idh]h usb_device_id}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjc.usb_core.usb_match_idesbuh1hhjfubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjfubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjfubj)}(hidh]hid}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhj_hhhjphMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj[hhhjphMubah}(h]jVah ](jjeh"]h$]h&]jj)jhuh1j$hjphMhjXhhubj)}(hhh]h)}(h5find first usb_device_id matching device or interfaceh]h5find first usb_device_id matching device or interface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjXhhhjphMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX **Parameters** ``struct usb_interface *interface`` the interface of interest ``const struct usb_device_id *id`` array of usb_device_id structures, terminated by zero entry **Description** usb_match_id searches an array of usb_device_id's and returns the first one matching the device or interface, or null. This is used when binding (or rebinding) a driver to an interface. Most USB device drivers will use this indirectly, through the usb core, but some layered driver frameworks use it directly. These device tables are exported with MODULE_DEVICE_TABLE, through modutils, to support the driver loading functionality of USB hotplugging. What Matches: The "match_flags" element in a usb_device_id controls which members are used. If the corresponding bit is set, the value in the device_id must match its corresponding member in the device or interface descriptor, or else the device_id does not match. "driver_info" is normally used only by device drivers, but you can create a wildcard "matches anything" usb_device_id as a driver's "modules.usbmap" entry if you provide an id with only a nonzero "driver_info" field. If you do this, the USB device driver's probe() routine should use additional intelligence to decide whether to bind to the specified interface. What Makes Good usb_device_id Tables: The match algorithm is very simple, so that intelligence in driver selection must come from smart driver id records. Unless you have good reasons to use another selection policy, provide match elements only in related groups, and order match specifiers from specific to general. Use the macros provided for that purpose if you can. The most specific match specifiers use device descriptor data. These are commonly used with product-specific matches; the USB_DEVICE macro lets you provide vendor and product IDs, and you can also match against ranges of product revisions. These are widely used for devices with application or vendor specific bDeviceClass values. Matches based on device class/subclass/protocol specifications are slightly more general; use the USB_DEVICE_INFO macro, or its siblings. These are used with single-function devices where bDeviceClass doesn't specify that each interface has its own class. Matches based on interface class/subclass/protocol are the most general; they let drivers bind to any interface on a multiple-function device. Use the USB_INTERFACE_INFO macro, or its siblings, to match class-per-interface style devices (as recorded in bInterfaceClass). Note that an entry created by USB_INTERFACE_INFO won't match any interface if the device class is set to Vendor-Specific. This is deliberate; according to the USB spec the meanings of the interface class/subclass/protocol for these devices are also vendor-specific, and hence matching against a standard product class wouldn't work anyway. If you really want to use an interface-based match for such a device, create a match record that also specifies the vendor ID. (Unforunately there isn't a standard macro for creating records like this.) Within those groups, remember that not all combinations are meaningful. For example, don't give a product version range without vendor and product IDs; or specify a protocol without its associated class and subclass. **Return** The first matching usb_device_id, or ``NULL``.h](h)}(h**Parameters**h]j.)}(hj)h]h Parameters}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj'ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubjD)}(hhh](jI)}(h>``struct usb_interface *interface`` the interface of interest h](jO)}(h#``struct usb_interface *interface``h]j)}(hjHh]hstruct usb_interface *interface}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjBubji)}(hhh]h)}(hthe interface of interesth]hthe interface of interest}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]hMhj^ubah}(h]h ]h"]h$]h&]uh1jhhjBubeh}(h]h ]h"]h$]h&]uh1jHhj]hMhj?ubjI)}(h_``const struct usb_device_id *id`` array of usb_device_id structures, terminated by zero entry h](jO)}(h"``const struct usb_device_id *id``h]j)}(hjh]hconst struct usb_device_id *id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj{ubji)}(hhh]h)}(h;array of usb_device_id structures, terminated by zero entryh]h;array of usb_device_id structures, terminated by zero entry}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhj{ubeh}(h]h ]h"]h$]h&]uh1jHhjhMhj?ubeh}(h]h ]h"]h$]h&]uh1jChj#ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(hXusb_match_id searches an array of usb_device_id's and returns the first one matching the device or interface, or null. This is used when binding (or rebinding) a driver to an interface. Most USB device drivers will use this indirectly, through the usb core, but some layered driver frameworks use it directly. These device tables are exported with MODULE_DEVICE_TABLE, through modutils, to support the driver loading functionality of USB hotplugging.h]hXusb_match_id searches an array of usb_device_id’s and returns the first one matching the device or interface, or null. This is used when binding (or rebinding) a driver to an interface. Most USB device drivers will use this indirectly, through the usb core, but some layered driver frameworks use it directly. These device tables are exported with MODULE_DEVICE_TABLE, through modutils, to support the driver loading functionality of USB hotplugging.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(h What Matches:h]h What Matches:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(hThe "match_flags" element in a usb_device_id controls which members are used. If the corresponding bit is set, the value in the device_id must match its corresponding member in the device or interface descriptor, or else the device_id does not match.h]hThe “match_flags” element in a usb_device_id controls which members are used. If the corresponding bit is set, the value in the device_id must match its corresponding member in the device or interface descriptor, or else the device_id does not match.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(hXj"driver_info" is normally used only by device drivers, but you can create a wildcard "matches anything" usb_device_id as a driver's "modules.usbmap" entry if you provide an id with only a nonzero "driver_info" field. If you do this, the USB device driver's probe() routine should use additional intelligence to decide whether to bind to the specified interface.h]hX~“driver_info” is normally used only by device drivers, but you can create a wildcard “matches anything” usb_device_id as a driver’s “modules.usbmap” entry if you provide an id with only a nonzero “driver_info” field. If you do this, the USB device driver’s probe() routine should use additional intelligence to decide whether to bind to the specified interface.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(h%What Makes Good usb_device_id Tables:h]h%What Makes Good usb_device_id Tables:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(hXLThe match algorithm is very simple, so that intelligence in driver selection must come from smart driver id records. Unless you have good reasons to use another selection policy, provide match elements only in related groups, and order match specifiers from specific to general. Use the macros provided for that purpose if you can.h]hXLThe match algorithm is very simple, so that intelligence in driver selection must come from smart driver id records. Unless you have good reasons to use another selection policy, provide match elements only in related groups, and order match specifiers from specific to general. Use the macros provided for that purpose if you can.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(hXKThe most specific match specifiers use device descriptor data. These are commonly used with product-specific matches; the USB_DEVICE macro lets you provide vendor and product IDs, and you can also match against ranges of product revisions. These are widely used for devices with application or vendor specific bDeviceClass values.h]hXKThe most specific match specifiers use device descriptor data. These are commonly used with product-specific matches; the USB_DEVICE macro lets you provide vendor and product IDs, and you can also match against ranges of product revisions. These are widely used for devices with application or vendor specific bDeviceClass values.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(hXMatches based on device class/subclass/protocol specifications are slightly more general; use the USB_DEVICE_INFO macro, or its siblings. These are used with single-function devices where bDeviceClass doesn't specify that each interface has its own class.h]hXMatches based on device class/subclass/protocol specifications are slightly more general; use the USB_DEVICE_INFO macro, or its siblings. These are used with single-function devices where bDeviceClass doesn’t specify that each interface has its own class.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(hXMatches based on interface class/subclass/protocol are the most general; they let drivers bind to any interface on a multiple-function device. Use the USB_INTERFACE_INFO macro, or its siblings, to match class-per-interface style devices (as recorded in bInterfaceClass).h]hXMatches based on interface class/subclass/protocol are the most general; they let drivers bind to any interface on a multiple-function device. Use the USB_INTERFACE_INFO macro, or its siblings, to match class-per-interface style devices (as recorded in bInterfaceClass).}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubh)}(hX Note that an entry created by USB_INTERFACE_INFO won't match any interface if the device class is set to Vendor-Specific. This is deliberate; according to the USB spec the meanings of the interface class/subclass/protocol for these devices are also vendor-specific, and hence matching against a standard product class wouldn't work anyway. If you really want to use an interface-based match for such a device, create a match record that also specifies the vendor ID. (Unforunately there isn't a standard macro for creating records like this.)h]hX&Note that an entry created by USB_INTERFACE_INFO won’t match any interface if the device class is set to Vendor-Specific. This is deliberate; according to the USB spec the meanings of the interface class/subclass/protocol for these devices are also vendor-specific, and hence matching against a standard product class wouldn’t work anyway. If you really want to use an interface-based match for such a device, create a match record that also specifies the vendor ID. (Unforunately there isn’t a standard macro for creating records like this.)}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM!hj#ubh)}(hWithin those groups, remember that not all combinations are meaningful. For example, don't give a product version range without vendor and product IDs; or specify a protocol without its associated class and subclass.h]hWithin those groups, remember that not all combinations are meaningful. For example, don’t give a product version range without vendor and product IDs; or specify a protocol without its associated class and subclass.}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM+hj#ubh)}(h **Return**h]j.)}(hjyh]hReturn}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjwubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM0hj#ubh)}(h.The first matching usb_device_id, or ``NULL``.h](h%The first matching usb_device_id, or }(hjhhhNhNubj)}(h``NULL``h]hNULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj#ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j0usb_core.usb_register_device_driver (C function)%c.usb_core.usb_register_device_driverhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h\int usb_register_device_driver (struct usb_device_driver *new_udriver, struct module *owner)h]j+)}(h[int usb_register_device_driver(struct usb_device_driver *new_udriver, struct module *owner)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(husb_register_device_driverh]j)}(husb_register_device_driverh]husb_register_device_driver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h=(struct usb_device_driver *new_udriver, struct module *owner)h](j)}(h%struct usb_device_driver *new_udriverh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(husb_device_driverh]husb_device_driver}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj-modnameN classnameNjLjO)}jR](jNjU)}jHjsb%c.usb_core.usb_register_device_driveresbuh1hhj ubjC)}(h h]h }(hjLhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(h new_udriverh]h new_udriver}(hjghhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hstruct module *ownerh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj|ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj|ubh)}(hhh]j)}(hmoduleh]hmodule}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjH%c.usb_core.usb_register_device_driveresbuh1hhj|ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj|ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj|ubj)}(hownerh]howner}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(h,register a USB device (not interface) driverh]h,register a USB device (not interface) driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device_driver *new_udriver`` USB operations for the device driver ``struct module *owner`` module owner of this driver. **Description** Registers a USB device driver with the USB core. The list of unattached devices will be rescanned whenever a new driver is added, allowing the new driver to attach to any recognized devices. **Return** A negative error code on failure and 0 on success.h](h)}(h**Parameters**h]j.)}(hj$h]h Parameters}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj"ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubjD)}(hhh](jI)}(hO``struct usb_device_driver *new_udriver`` USB operations for the device driver h](jO)}(h)``struct usb_device_driver *new_udriver``h]j)}(hjCh]h%struct usb_device_driver *new_udriver}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj=ubji)}(hhh]h)}(h$USB operations for the device driverh]h$USB operations for the device driver}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjXhMhjYubah}(h]h ]h"]h$]h&]uh1jhhj=ubeh}(h]h ]h"]h$]h&]uh1jHhjXhMhj:ubjI)}(h6``struct module *owner`` module owner of this driver. h](jO)}(h``struct module *owner``h]j)}(hj|h]hstruct module *owner}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjvubji)}(hhh]h)}(hmodule owner of this driver.h]hmodule owner of this driver.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjvubeh}(h]h ]h"]h$]h&]uh1jHhjhMhj:ubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(hRegisters a USB device driver with the USB core. The list of unattached devices will be rescanned whenever a new driver is added, allowing the new driver to attach to any recognized devices.h]hRegisters a USB device driver with the USB core. The list of unattached devices will be rescanned whenever a new driver is added, allowing the new driver to attach to any recognized devices.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(h2A negative error code on failure and 0 on success.h]h2A negative error code on failure and 0 on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j2usb_core.usb_deregister_device_driver (C function)'c.usb_core.usb_deregister_device_driverhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hEvoid usb_deregister_device_driver (struct usb_device_driver *udriver)h]j+)}(hDvoid usb_deregister_device_driver(struct usb_device_driver *udriver)h](jT)}(hvoidh]hvoid}(hj#hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM ubjC)}(h h]h }(hj2hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj1hM ubj)}(husb_deregister_device_driverh]j)}(husb_deregister_device_driverh]husb_deregister_device_driver}(hjDhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhj1hM ubj)}(h#(struct usb_device_driver *udriver)h]j)}(h!struct usb_device_driver *udriverh](j1)}(hjh]hstruct}(hj`hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj\ubjC)}(h h]h }(hjmhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj\ubh)}(hhh]j)}(husb_device_driverh]husb_device_driver}(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjFsb'c.usb_core.usb_deregister_device_driveresbuh1hhj\ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj\ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj\ubj)}(hudriverh]hudriver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjXubah}(h]h ]h"]h$]h&]jjuh1jhjhhhj1hM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj1hM ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hj1hM hjhhubj)}(hhh]h)}(h.unregister a USB device (not interface) driverh]h.unregister a USB device (not interface) driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhj1hM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(h**Parameters** ``struct usb_device_driver *udriver`` USB operations of the device driver to unregister **Context** must be able to sleep **Description** Unlinks the specified driver from the internal USB driver list.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjubjD)}(hhh]jI)}(hX``struct usb_device_driver *udriver`` USB operations of the device driver to unregister h](jO)}(h%``struct usb_device_driver *udriver``h]j)}(hj%h]h!struct usb_device_driver *udriver}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjubji)}(hhh]h)}(h1USB operations of the device driver to unregisterh]h1USB operations of the device driver to unregister}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj:hM hj;ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj:hM hjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hj`h]hContext}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj^ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjubh)}(hmust be able to sleeph]hmust be able to sleep}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjubh)}(h?Unlinks the specified driver from the internal USB driver list.h]h?Unlinks the specified driver from the internal USB driver list.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j)usb_core.usb_register_driver (C function)c.usb_core.usb_register_driverhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hcint usb_register_driver (struct usb_driver *new_driver, struct module *owner, const char *mod_name)h]j+)}(hbint usb_register_driver(struct usb_driver *new_driver, struct module *owner, const char *mod_name)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(husb_register_driverh]j)}(husb_register_driverh]husb_register_driver}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(hK(struct usb_driver *new_driver, struct module *owner, const char *mod_name)h](j)}(hstruct usb_driver *new_driverh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_driverh]h usb_driver}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj)modnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_register_driveresbuh1hhjubjC)}(h h]h }(hjHhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(h new_driverh]h new_driver}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hstruct module *ownerh](j1)}(hjh]hstruct}(hj|hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjxubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjxubh)}(hhh]j)}(hmoduleh]hmodule}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjDc.usb_core.usb_register_driveresbuh1hhjxubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjxubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjxubj)}(hownerh]howner}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hconst char *mod_nameh](j1)}(hj4h]hconst}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjT)}(hcharh]hchar}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj$hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hmod_nameh]hmod_name}(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(hregister a USB interface driverh]hregister a USB interface driver}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjXhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjsjjsj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_driver *new_driver`` USB operations for the interface driver ``struct module *owner`` module owner of this driver. ``const char *mod_name`` module name string **Description** Registers a USB interface driver with the USB core. The list of unattached interfaces will be rescanned whenever a new driver is added, allowing the new driver to attach to any recognized interfaces. **Return** A negative error code on failure and 0 on success. **NOTE** if you want your driver to use the USB major number, you must call usb_register_dev() to enable that functionality. This function no longer takes care of that.h](h)}(h**Parameters**h]j.)}(hj}h]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj{ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjwubjD)}(hhh](jI)}(hJ``struct usb_driver *new_driver`` USB operations for the interface driver h](jO)}(h!``struct usb_driver *new_driver``h]j)}(hjh]hstruct usb_driver *new_driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubji)}(hhh]h)}(h'USB operations for the interface driverh]h'USB operations for the interface driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubjI)}(h6``struct module *owner`` module owner of this driver. h](jO)}(h``struct module *owner``h]j)}(hjh]hstruct module *owner}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubji)}(hhh]h)}(hmodule owner of this driver.h]hmodule owner of this driver.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubjI)}(h,``const char *mod_name`` module name string h](jO)}(h``const char *mod_name``h]j)}(hjh]hconst char *mod_name}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubji)}(hhh]h)}(hmodule name stringh]hmodule name string}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hMhj$ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj#hMhjubeh}(h]h ]h"]h$]h&]uh1jChjwubh)}(h**Description**h]j.)}(hjIh]h Description}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjGubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjwubh)}(hRegisters a USB interface driver with the USB core. The list of unattached interfaces will be rescanned whenever a new driver is added, allowing the new driver to attach to any recognized interfaces.h]hRegisters a USB interface driver with the USB core. The list of unattached interfaces will be rescanned whenever a new driver is added, allowing the new driver to attach to any recognized interfaces.}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjwubh)}(h **Return**h]j.)}(hjph]hReturn}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjnubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM!hjwubh)}(h2A negative error code on failure and 0 on success.h]h2A negative error code on failure and 0 on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM"hjwubh)}(h**NOTE**h]j.)}(hjh]hNOTE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM$hjwubh)}(hif you want your driver to use the USB major number, you must call usb_register_dev() to enable that functionality. This function no longer takes care of that.h]hif you want your driver to use the USB major number, you must call usb_register_dev() to enable that functionality. This function no longer takes care of that.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM$hjwubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$usb_core.usb_deregister (C function)c.usb_core.usb_deregisterhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h/void usb_deregister (struct usb_driver *driver)h]j+)}(h.void usb_deregister(struct usb_driver *driver)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMQubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMQubj)}(husb_deregisterh]j)}(husb_deregisterh]husb_deregister}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMQubj)}(h(struct usb_driver *driver)h]j)}(hstruct usb_driver *driverh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hj&hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_driverh]h usb_driver}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj9modnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_deregisteresbuh1hhjubjC)}(h h]h }(hjXhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdriverh]hdriver}(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMQubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMQubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMQhjhhubj)}(hhh]h)}(h!unregister a USB interface driverh]h!unregister a USB interface driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMQhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMQubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_driver *driver`` USB operations of the interface driver to unregister **Context** must be able to sleep **Description** Unlinks the specified driver from the internal USB driver list. **NOTE** If you called usb_register_dev(), you still need to call usb_deregister_dev() to clean up your driver's allocated minor numbers, this * call will no longer do it for you.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMUhjubjD)}(hhh]jI)}(hS``struct usb_driver *driver`` USB operations of the interface driver to unregister h](jO)}(h``struct usb_driver *driver``h]j)}(hjh]hstruct usb_driver *driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMRhjubji)}(hhh]h)}(h4USB operations of the interface driver to unregisterh]h4USB operations of the interface driver to unregister}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMRhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMRhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMThjubh)}(hmust be able to sleeph]hmust be able to sleep}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMShjubh)}(h**Description**h]j.)}(hj@h]h Description}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj>ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMUhjubh)}(h?Unlinks the specified driver from the internal USB driver list.h]h?Unlinks the specified driver from the internal USB driver list.}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMThjubh)}(h**NOTE**h]j.)}(hjgh]hNOTE}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjeubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMVhjubh)}(hIf you called usb_register_dev(), you still need to call usb_deregister_dev() to clean up your driver's allocated minor numbers, this * call will no longer do it for you.h]hIf you called usb_register_dev(), you still need to call usb_deregister_dev() to clean up your driver’s allocated minor numbers, this * call will no longer do it for you.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMWhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j,usb_core.usb_enable_autosuspend (C function)!c.usb_core.usb_enable_autosuspendhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h5void usb_enable_autosuspend (struct usb_device *udev)h]j+)}(h4void usb_enable_autosuspend(struct usb_device *udev)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(husb_enable_autosuspendh]j)}(husb_enable_autosuspendh]husb_enable_autosuspend}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h(struct usb_device *udev)h]j)}(hstruct usb_device *udevh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR](jNjU)}jHjsb!c.usb_core.usb_enable_autosuspendesbuh1hhjubjC)}(h h]h }(hj(hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hudevh]hudev}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(h&allow a USB device to be autosuspendedh]h&allow a USB device to be autosuspended}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hXH**Parameters** ``struct usb_device *udev`` the USB device which may be autosuspended **Description** This routine allows **udev** to be autosuspended. An autosuspend won't take place until the autosuspend_delay has elapsed and all the other necessary conditions are satisfied. The caller must hold **udev**'s device lock.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubjD)}(hhh]jI)}(hF``struct usb_device *udev`` the USB device which may be autosuspended h](jO)}(h``struct usb_device *udev``h]j)}(hjh]hstruct usb_device *udev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubji)}(hhh]h)}(h)the USB device which may be autosuspendedh]h)the USB device which may be autosuspended}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(hThis routine allows **udev** to be autosuspended. An autosuspend won't take place until the autosuspend_delay has elapsed and all the other necessary conditions are satisfied.h](hThis routine allows }(hjhhhNhNubj.)}(h**udev**h]hudev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh to be autosuspended. An autosuspend won’t take place until the autosuspend_delay has elapsed and all the other necessary conditions are satisfied.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(h,The caller must hold **udev**'s device lock.h](hThe caller must hold }(hj hhhNhNubj.)}(h**udev**h]hudev}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubh’s device lock.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_core.usb_disable_autosuspend (C function)"c.usb_core.usb_disable_autosuspendhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h6void usb_disable_autosuspend (struct usb_device *udev)h]j+)}(h5void usb_disable_autosuspend(struct usb_device *udev)h](jT)}(hvoidh]hvoid}(hjahhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj]hhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMubjC)}(h h]h }(hjphhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj]hhhjohMubj)}(husb_disable_autosuspendh]j)}(husb_disable_autosuspendh]husb_disable_autosuspend}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj]hhhjohMubj)}(h(struct usb_device *udev)h]j)}(hstruct usb_device *udevh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsb"c.usb_core.usb_disable_autosuspendesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hudevh]hudev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhj]hhhjohMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjYhhhjohMubah}(h]jTah ](jjeh"]h$]h&]jj)jhuh1j$hjohMhjVhhubj)}(hhh]h)}(h-prevent a USB device from being autosuspendedh]h-prevent a USB device from being autosuspended}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjVhhhjohMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj:jj:j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *udev`` the USB device which may not be autosuspended **Description** This routine prevents **udev** from being autosuspended and wakes it up if it is already autosuspended. The caller must hold **udev**'s device lock.h](h)}(h**Parameters**h]j.)}(hjDh]h Parameters}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjBubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj>ubjD)}(hhh]jI)}(hJ``struct usb_device *udev`` the USB device which may not be autosuspended h](jO)}(h``struct usb_device *udev``h]j)}(hjch]hstruct usb_device *udev}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj]ubji)}(hhh]h)}(h-the USB device which may not be autosuspendedh]h-the USB device which may not be autosuspended}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjxhMhjyubah}(h]h ]h"]h$]h&]uh1jhhj]ubeh}(h]h ]h"]h$]h&]uh1jHhjxhMhjZubah}(h]h ]h"]h$]h&]uh1jChj>ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj>ubh)}(hgThis routine prevents **udev** from being autosuspended and wakes it up if it is already autosuspended.h](hThis routine prevents }(hjhhhNhNubj.)}(h**udev**h]hudev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubhI from being autosuspended and wakes it up if it is already autosuspended.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj>ubh)}(h,The caller must hold **udev**'s device lock.h](hThe caller must hold }(hjhhhNhNubj.)}(h**udev**h]hudev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh’s device lock.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhj>ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j.usb_core.usb_autopm_put_interface (C function)#c.usb_core.usb_autopm_put_interfacehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h:void usb_autopm_put_interface (struct usb_interface *intf)h]j+)}(h9void usb_autopm_put_interface(struct usb_interface *intf)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMubjC)}(h h]h }(hj%hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj$hMubj)}(husb_autopm_put_interfaceh]j)}(husb_autopm_put_interfaceh]husb_autopm_put_interface}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhj$hMubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hjShhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjOubjC)}(h h]h }(hj`hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjOubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjsmodnameN classnameNjLjO)}jR](jNjU)}jHj9sb#c.usb_core.usb_autopm_put_interfaceesbuh1hhjOubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjOubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjOubj)}(hintfh]hintf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjKubah}(h]h ]h"]h$]h&]jjuh1jhjhhhj$hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj$hMubah}(h]j ah ](jjeh"]h$]h&]jj)jhuh1j$hj$hMhj hhubj)}(hhh]h)}(h,decrement a USB interface's PM-usage counterh]h.decrement a USB interface’s PM-usage counter}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhj hhhj$hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX=**Parameters** ``struct usb_interface *intf`` the usb_interface whose counter should be decremented **Description** This routine should be called by an interface driver when it is finished using **intf** and wants to allow it to autosuspend. A typical example would be a character-device driver when its device file is closed. The routine decrements **intf**'s usage counter. When the counter reaches 0, a delayed autosuspend request for **intf**'s device is attempted. The attempt may fail (see autosuspend_check()). This routine can run only in process context.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubjD)}(hhh]jI)}(hU``struct usb_interface *intf`` the usb_interface whose counter should be decremented h](jO)}(h``struct usb_interface *intf``h]j)}(hjh]hstruct usb_interface *intf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubji)}(hhh]h)}(h5the usb_interface whose counter should be decrementedh]h5the usb_interface whose counter should be decremented}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-hMhj.ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj-hMhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjSh]h Description}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjQubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(hThis routine should be called by an interface driver when it is finished using **intf** and wants to allow it to autosuspend. A typical example would be a character-device driver when its device file is closed.h](hOThis routine should be called by an interface driver when it is finished using }(hjihhhNhNubj.)}(h**intf**h]hintf}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjiubh| and wants to allow it to autosuspend. A typical example would be a character-device driver when its device file is closed.}(hjihhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(hThe routine decrements **intf**'s usage counter. When the counter reaches 0, a delayed autosuspend request for **intf**'s device is attempted. The attempt may fail (see autosuspend_check()).h](hThe routine decrements }(hjhhhNhNubj.)}(h**intf**h]hintf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubhS’s usage counter. When the counter reaches 0, a delayed autosuspend request for }(hjhhhNhNubj.)}(h**intf**h]hintf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubhJ’s device is attempted. The attempt may fail (see autosuspend_check()).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(h-This routine can run only in process context.h]h-This routine can run only in process context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j4usb_core.usb_autopm_put_interface_async (C function))c.usb_core.usb_autopm_put_interface_asynchNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h@void usb_autopm_put_interface_async (struct usb_interface *intf)h]j+)}(h?void usb_autopm_put_interface_async(struct usb_interface *intf)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhM ubj)}(husb_autopm_put_interface_asynch]j)}(husb_autopm_put_interface_asynch]husb_autopm_put_interface_async}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhM ubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hj)hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj%ubjC)}(h h]h }(hj6hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj%ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjImodnameN classnameNjLjO)}jR](jNjU)}jHjsb)c.usb_core.usb_autopm_put_interface_asyncesbuh1hhj%ubjC)}(h h]h }(hjhhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj%ubjs)}(hjvh]h*}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj%ubj)}(hintfh]hintf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj!ubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjhM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhM ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhM hjhhubj)}(hhh]h)}(h,decrement a USB interface's PM-usage counterh]h.decrement a USB interface’s PM-usage counter}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hXU**Parameters** ``struct usb_interface *intf`` the usb_interface whose counter should be decremented **Description** This routine does much the same thing as usb_autopm_put_interface(): It decrements **intf**'s usage counter and schedules a delayed autosuspend request if the counter is <= 0. The difference is that it does not perform any synchronization; callers should hold a private lock and handle all synchronization issues themselves. Typically a driver would call this routine during an URB's completion handler, if no more URBs were pending. This routine can run in atomic context.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubjD)}(hhh]jI)}(hU``struct usb_interface *intf`` the usb_interface whose counter should be decremented h](jO)}(h``struct usb_interface *intf``h]j)}(hjh]hstruct usb_interface *intf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubji)}(hhh]h)}(h5the usb_interface whose counter should be decrementedh]h5the usb_interface whose counter should be decremented}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hj)h]h Description}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj'ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(hXEThis routine does much the same thing as usb_autopm_put_interface(): It decrements **intf**'s usage counter and schedules a delayed autosuspend request if the counter is <= 0. The difference is that it does not perform any synchronization; callers should hold a private lock and handle all synchronization issues themselves.h](hSThis routine does much the same thing as usb_autopm_put_interface(): It decrements }(hj?hhhNhNubj.)}(h**intf**h]hintf}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj?ubh’s usage counter and schedules a delayed autosuspend request if the counter is <= 0. The difference is that it does not perform any synchronization; callers should hold a private lock and handle all synchronization issues themselves.}(hj?hhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(hlTypically a driver would call this routine during an URB's completion handler, if no more URBs were pending.h]hnTypically a driver would call this routine during an URB’s completion handler, if no more URBs were pending.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubh)}(h'This routine can run in atomic context.h]h'This routine can run in atomic context.}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j9usb_core.usb_autopm_put_interface_no_suspend (C function).c.usb_core.usb_autopm_put_interface_no_suspendhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hEvoid usb_autopm_put_interface_no_suspend (struct usb_interface *intf)h]j+)}(hDvoid usb_autopm_put_interface_no_suspend(struct usb_interface *intf)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM'ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhM'ubj)}(h#usb_autopm_put_interface_no_suspendh]j)}(h#usb_autopm_put_interface_no_suspendh]h#usb_autopm_put_interface_no_suspend}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhM'ubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsb.c.usb_core.usb_autopm_put_interface_no_suspendesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hintfh]hintf}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjhhhjhM'ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhM'ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhM'hjhhubj)}(hhh]h)}(h,decrement a USB interface's PM-usage counterh]h.decrement a USB interface’s PM-usage counter}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM'hj\hhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhM'ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjwjjwj j!j"uh1jhhhjrhNhNubj$)}(h**Parameters** ``struct usb_interface *intf`` the usb_interface whose counter should be decremented **Description** This routine decrements **intf**'s usage counter but does not carry out an autosuspend. This routine can run in atomic context.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM+hj{ubjD)}(hhh]jI)}(hU``struct usb_interface *intf`` the usb_interface whose counter should be decremented h](jO)}(h``struct usb_interface *intf``h]j)}(hjh]hstruct usb_interface *intf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM(hjubji)}(hhh]h)}(h5the usb_interface whose counter should be decrementedh]h5the usb_interface whose counter should be decremented}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM(hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM(hjubah}(h]h ]h"]h$]h&]uh1jChj{ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM*hj{ubh)}(hWThis routine decrements **intf**'s usage counter but does not carry out an autosuspend.h](hThis routine decrements }(hjhhhNhNubj.)}(h**intf**h]hintf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh9’s usage counter but does not carry out an autosuspend.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM)hj{ubh)}(h'This routine can run in atomic context.h]h'This routine can run in atomic context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM,hj{ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j.usb_core.usb_autopm_get_interface (C function)#c.usb_core.usb_autopm_get_interfacehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h9int usb_autopm_get_interface (struct usb_interface *intf)h]j+)}(h8int usb_autopm_get_interface(struct usb_interface *intf)h](jT)}(hinth]hint}(hjAhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj=hhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM9ubjC)}(h h]h }(hjPhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj=hhhjOhM9ubj)}(husb_autopm_get_interfaceh]j)}(husb_autopm_get_interfaceh]husb_autopm_get_interface}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj=hhhjOhM9ubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hj~hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjzubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjzubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjdsb#c.usb_core.usb_autopm_get_interfaceesbuh1hhjzubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjzubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjzubj)}(hintfh]hintf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjvubah}(h]h ]h"]h$]h&]jjuh1jhj=hhhjOhM9ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj9hhhjOhM9ubah}(h]j4ah ](jjeh"]h$]h&]jj)jhuh1j$hjOhM9hj6hhubj)}(hhh]h)}(h,increment a USB interface's PM-usage counterh]h.increment a USB interface’s PM-usage counter}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM9hjhhubah}(h]h ]h"]h$]h&]uh1jhj6hhhjOhM9ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX.**Parameters** ``struct usb_interface *intf`` the usb_interface whose counter should be incremented **Description** This routine should be called by an interface driver when it wants to use **intf** and needs to guarantee that it is not suspended. In addition, the routine prevents **intf** from being autosuspended subsequently. (Note that this will not prevent suspend events originating in the PM core.) This prevention will persist until usb_autopm_put_interface() is called or **intf** is unbound. A typical example would be a character-device driver when its device file is opened. **intf**'s usage counter is incremented to prevent subsequent autosuspends. However if the autoresume fails then the counter is re-decremented. This routine can run only in process context. **Return** 0 on success.h](h)}(h**Parameters**h]j.)}(hj$h]h Parameters}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj"ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM=hjubjD)}(hhh]jI)}(hU``struct usb_interface *intf`` the usb_interface whose counter should be incremented h](jO)}(h``struct usb_interface *intf``h]j)}(hjCh]hstruct usb_interface *intf}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM:hj=ubji)}(hhh]h)}(h5the usb_interface whose counter should be incrementedh]h5the usb_interface whose counter should be incremented}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjXhM:hjYubah}(h]h ]h"]h$]h&]uh1jhhj=ubeh}(h]h ]h"]h$]h&]uh1jHhjXhM:hj:ubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hj~h]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj|ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM<hjubh)}(hXThis routine should be called by an interface driver when it wants to use **intf** and needs to guarantee that it is not suspended. In addition, the routine prevents **intf** from being autosuspended subsequently. (Note that this will not prevent suspend events originating in the PM core.) This prevention will persist until usb_autopm_put_interface() is called or **intf** is unbound. A typical example would be a character-device driver when its device file is opened.h](hJThis routine should be called by an interface driver when it wants to use }(hjhhhNhNubj.)}(h**intf**h]hintf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubhU and needs to guarantee that it is not suspended. In addition, the routine prevents }(hjhhhNhNubj.)}(h**intf**h]hintf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh from being autosuspended subsequently. (Note that this will not prevent suspend events originating in the PM core.) This prevention will persist until usb_autopm_put_interface() is called or }(hjhhhNhNubj.)}(h**intf**h]hintf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubhb is unbound. A typical example would be a character-device driver when its device file is opened.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM;hjubh)}(h**intf**'s usage counter is incremented to prevent subsequent autosuspends. However if the autoresume fails then the counter is re-decremented.h](j.)}(h**intf**h]hintf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh’s usage counter is incremented to prevent subsequent autosuspends. However if the autoresume fails then the counter is re-decremented.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMChjubh)}(h-This routine can run only in process context.h]h-This routine can run only in process context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMFhjubh)}(h **Return**h]j.)}(hjh]hReturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMHhjubh)}(h 0 on success.h]h 0 on success.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMIhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j4usb_core.usb_autopm_get_interface_async (C function))c.usb_core.usb_autopm_get_interface_asynchNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h?int usb_autopm_get_interface_async (struct usb_interface *intf)h]j+)}(h>int usb_autopm_get_interface_async(struct usb_interface *intf)h](jT)}(hinth]hint}(hjLhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjHhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMXubjC)}(h h]h }(hj[hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjHhhhjZhMXubj)}(husb_autopm_get_interface_asynch]j)}(husb_autopm_get_interface_asynch]husb_autopm_get_interface_async}(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubah}(h]h ](jjeh"]h$]h&]jjuh1jhjHhhhjZhMXubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjosb)c.usb_core.usb_autopm_get_interface_asyncesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hintfh]hintf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhjHhhhjZhMXubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjDhhhjZhMXubah}(h]j?ah ](jjeh"]h$]h&]jj)jhuh1j$hjZhMXhjAhhubj)}(hhh]h)}(h,increment a USB interface's PM-usage counterh]h.increment a USB interface’s PM-usage counter}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMXhj hhubah}(h]h ]h"]h$]h&]uh1jhjAhhhjZhMXubeh}(h]h ](jfunctioneh"]h$]h&]jjjj%jj%j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_interface *intf`` the usb_interface whose counter should be incremented **Description** This routine does much the same thing as usb_autopm_get_interface(): It increments **intf**'s usage counter and queues an autoresume request if the device is suspended. The differences are that it does not perform any synchronization (callers should hold a private lock and handle all synchronization issues themselves), and it does not autoresume the device directly (it only queues a request). After a successful call, the device may not yet be resumed. This routine can run in atomic context. **Return** 0 on success. A negative error code otherwise.h](h)}(h**Parameters**h]j.)}(hj/h]h Parameters}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj-ubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM\hj)ubjD)}(hhh]jI)}(hU``struct usb_interface *intf`` the usb_interface whose counter should be incremented h](jO)}(h``struct usb_interface *intf``h]j)}(hjNh]hstruct usb_interface *intf}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMYhjHubji)}(hhh]h)}(h5the usb_interface whose counter should be incrementedh]h5the usb_interface whose counter should be incremented}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhjchMYhjdubah}(h]h ]h"]h$]h&]uh1jhhjHubeh}(h]h ]h"]h$]h&]uh1jHhjchMYhjEubah}(h]h ]h"]h$]h&]uh1jChj)ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM[hj)ubh)}(hXThis routine does much the same thing as usb_autopm_get_interface(): It increments **intf**'s usage counter and queues an autoresume request if the device is suspended. The differences are that it does not perform any synchronization (callers should hold a private lock and handle all synchronization issues themselves), and it does not autoresume the device directly (it only queues a request). After a successful call, the device may not yet be resumed.h](hSThis routine does much the same thing as usb_autopm_get_interface(): It increments }(hjhhhNhNubj.)}(h**intf**h]hintf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubhXp’s usage counter and queues an autoresume request if the device is suspended. The differences are that it does not perform any synchronization (callers should hold a private lock and handle all synchronization issues themselves), and it does not autoresume the device directly (it only queues a request). After a successful call, the device may not yet be resumed.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMZhj)ubh)}(h'This routine can run in atomic context.h]h'This routine can run in atomic context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMchj)ubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMehj)ubh)}(h.0 on success. A negative error code otherwise.h]h.0 on success. A negative error code otherwise.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMfhj)ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j8usb_core.usb_autopm_get_interface_no_resume (C function)-c.usb_core.usb_autopm_get_interface_no_resumehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hDvoid usb_autopm_get_interface_no_resume (struct usb_interface *intf)h]j+)}(hCvoid usb_autopm_get_interface_no_resume(struct usb_interface *intf)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMyubjC)}(h h]h }(hj%hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj$hMyubj)}(h"usb_autopm_get_interface_no_resumeh]j)}(h"usb_autopm_get_interface_no_resumeh]h"usb_autopm_get_interface_no_resume}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhj$hMyubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hjShhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjOubjC)}(h h]h }(hj`hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjOubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjsmodnameN classnameNjLjO)}jR](jNjU)}jHj9sb-c.usb_core.usb_autopm_get_interface_no_resumeesbuh1hhjOubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjOubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjOubj)}(hintfh]hintf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjOubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjKubah}(h]h ]h"]h$]h&]jjuh1jhjhhhj$hMyubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj$hMyubah}(h]j ah ](jjeh"]h$]h&]jj)jhuh1j$hj$hMyhj hhubj)}(hhh]h)}(h,increment a USB interface's PM-usage counterh]h.increment a USB interface’s PM-usage counter}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMyhjhhubah}(h]h ]h"]h$]h&]uh1jhj hhhj$hMyubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(h**Parameters** ``struct usb_interface *intf`` the usb_interface whose counter should be incremented **Description** This routine increments **intf**'s usage counter but does not carry out an autoresume. This routine can run in atomic context.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM}hjubjD)}(hhh]jI)}(hU``struct usb_interface *intf`` the usb_interface whose counter should be incremented h](jO)}(h``struct usb_interface *intf``h]j)}(hjh]hstruct usb_interface *intf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chMzhjubji)}(hhh]h)}(h5the usb_interface whose counter should be incrementedh]h5the usb_interface whose counter should be incremented}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-hMzhj.ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj-hMzhjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjSh]h Description}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjQubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM|hjubh)}(hVThis routine increments **intf**'s usage counter but does not carry out an autoresume.h](hThis routine increments }(hjihhhNhNubj.)}(h**intf**h]hintf}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjiubh8’s usage counter but does not carry out an autoresume.}(hjihhhNhNubeh}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM{hjubh)}(h'This routine can run in atomic context.h]h'This routine can run in atomic context.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:171: ./drivers/usb/core/driver.chM~hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j/usb_core.usb_find_common_endpoints (C function)$c.usb_core.usb_find_common_endpointshNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hint usb_find_common_endpoints (struct usb_host_interface *alt, struct usb_endpoint_descriptor **bulk_in, struct usb_endpoint_descriptor **bulk_out, struct usb_endpoint_descriptor **int_in, struct usb_endpoint_descriptor **int_out)h]j+)}(hint usb_find_common_endpoints(struct usb_host_interface *alt, struct usb_endpoint_descriptor **bulk_in, struct usb_endpoint_descriptor **bulk_out, struct usb_endpoint_descriptor **int_in, struct usb_endpoint_descriptor **int_out)h](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKxubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhKxubj)}(husb_find_common_endpointsh]j)}(husb_find_common_endpointsh]husb_find_common_endpoints}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhKxubj)}(h(struct usb_host_interface *alt, struct usb_endpoint_descriptor **bulk_in, struct usb_endpoint_descriptor **bulk_out, struct usb_endpoint_descriptor **int_in, struct usb_endpoint_descriptor **int_out)h](j)}(hstruct usb_host_interface *alth](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(husb_host_interfaceh]husb_host_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjsb$c.usb_core.usb_find_common_endpointsesbuh1hhjubjC)}(h h]h }(hj5hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(halth]halt}(hjPhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h(struct usb_endpoint_descriptor **bulk_inh](j1)}(hjh]hstruct}(hjihhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjeubjC)}(h h]h }(hjvhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjeubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNj1$c.usb_core.usb_find_common_endpointsesbuh1hhjeubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjeubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjeubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjeubj)}(hbulk_inh]hbulk_in}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h)struct usb_endpoint_descriptor **bulk_outh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR](jNj1$c.usb_core.usb_find_common_endpointsesbuh1hhjubjC)}(h h]h }(hj$ hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj2 hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubjs)}(hjvh]h*}(hj? hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hbulk_outh]hbulk_out}(hjL hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h'struct usb_endpoint_descriptor **int_inh](j1)}(hjh]hstruct}(hje hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hja ubjC)}(h h]h }(hjr hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhja ubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR](jNj1$c.usb_core.usb_find_common_endpointsesbuh1hhja ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhja ubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhja ubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhja ubj)}(hint_inh]hint_in}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhja ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(h(struct usb_endpoint_descriptor **int_outh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR](jNj1$c.usb_core.usb_find_common_endpointsesbuh1hhj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hj. hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubjs)}(hjvh]h*}(hj; hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(hint_outh]hint_out}(hjH hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhKxubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhKxubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhKxhjhhubj)}(hhh]j)}(hhh]j)}(h#look up common endpoint descriptorsh]h)}(hjw h]h#look up common endpoint descriptors}(hjy hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKxhju ubah}(h]h ]h"]h$]h&]uh1jhjr hhhj hNubah}(h]h ]h"]h$]h&]jjuh1jhj hKxhjo hhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhKxubeh}(h]h ](jfunctioneh"]h$]h&]jjjj jj j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_host_interface *alt`` alternate setting to search ``struct usb_endpoint_descriptor **bulk_in`` pointer to descriptor pointer, or NULL ``struct usb_endpoint_descriptor **bulk_out`` pointer to descriptor pointer, or NULL ``struct usb_endpoint_descriptor **int_in`` pointer to descriptor pointer, or NULL ``struct usb_endpoint_descriptor **int_out`` pointer to descriptor pointer, or NULL **Description** Search the alternate setting's endpoint descriptors for the first bulk-in, bulk-out, interrupt-in and interrupt-out endpoints and return them in the provided pointers (unless they are NULL). If a requested endpoint is not found, the corresponding pointer is set to NULL. **Return** Zero if all requested descriptors were found, or -ENXIO otherwise.h](h)}(h**Parameters**h]j.)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chK|hj ubjD)}(hhh](jI)}(h?``struct usb_host_interface *alt`` alternate setting to search h](jO)}(h"``struct usb_host_interface *alt``h]j)}(hj h]hstruct usb_host_interface *alt}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKyhj ubji)}(hhh]h)}(halternate setting to searchh]halternate setting to search}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKyhj ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj hKyhj ubjI)}(hT``struct usb_endpoint_descriptor **bulk_in`` pointer to descriptor pointer, or NULL h](jO)}(h,``struct usb_endpoint_descriptor **bulk_in``h]j)}(hj h]h(struct usb_endpoint_descriptor **bulk_in}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKzhj ubji)}(hhh]h)}(h&pointer to descriptor pointer, or NULLh]h&pointer to descriptor pointer, or NULL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKzhj ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj hKzhj ubjI)}(hU``struct usb_endpoint_descriptor **bulk_out`` pointer to descriptor pointer, or NULL h](jO)}(h-``struct usb_endpoint_descriptor **bulk_out``h]j)}(hj7 h]h)struct usb_endpoint_descriptor **bulk_out}(hj9 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5 ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chK{hj1 ubji)}(hhh]h)}(h&pointer to descriptor pointer, or NULLh]h&pointer to descriptor pointer, or NULL}(hjP hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjL hK{hjM ubah}(h]h ]h"]h$]h&]uh1jhhj1 ubeh}(h]h ]h"]h$]h&]uh1jHhjL hK{hj ubjI)}(hS``struct usb_endpoint_descriptor **int_in`` pointer to descriptor pointer, or NULL h](jO)}(h+``struct usb_endpoint_descriptor **int_in``h]j)}(hjp h]h'struct usb_endpoint_descriptor **int_in}(hjr hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjn ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chK|hjj ubji)}(hhh]h)}(h&pointer to descriptor pointer, or NULLh]h&pointer to descriptor pointer, or NULL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hK|hj ubah}(h]h ]h"]h$]h&]uh1jhhjj ubeh}(h]h ]h"]h$]h&]uh1jHhj hK|hj ubjI)}(hT``struct usb_endpoint_descriptor **int_out`` pointer to descriptor pointer, or NULL h](jO)}(h,``struct usb_endpoint_descriptor **int_out``h]j)}(hj h]h(struct usb_endpoint_descriptor **int_out}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chK}hj ubji)}(hhh]h)}(h&pointer to descriptor pointer, or NULLh]h&pointer to descriptor pointer, or NULL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hK}hj ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj hK}hj ubeh}(h]h ]h"]h$]h&]uh1jChj ubh)}(h**Description**h]j.)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhj ubh)}(hSearch the alternate setting's endpoint descriptors for the first bulk-in, bulk-out, interrupt-in and interrupt-out endpoints and return them in the provided pointers (unless they are NULL).h]hSearch the alternate setting’s endpoint descriptors for the first bulk-in, bulk-out, interrupt-in and interrupt-out endpoints and return them in the provided pointers (unless they are NULL).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chK~hj ubh)}(hOIf a requested endpoint is not found, the corresponding pointer is set to NULL.h]hOIf a requested endpoint is not found, the corresponding pointer is set to NULL.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhj ubh)}(h **Return**h]j.)}(hj h]hReturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhj ubh)}(hBZero if all requested descriptors were found, or -ENXIO otherwise.h]hBZero if all requested descriptors were found, or -ENXIO otherwise.}(hj0 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j7usb_core.usb_find_common_endpoints_reverse (C function),c.usb_core.usb_find_common_endpoints_reversehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hint usb_find_common_endpoints_reverse (struct usb_host_interface *alt, struct usb_endpoint_descriptor **bulk_in, struct usb_endpoint_descriptor **bulk_out, struct usb_endpoint_descriptor **int_in, struct usb_endpoint_descriptor **int_out)h]j+)}(hint usb_find_common_endpoints_reverse(struct usb_host_interface *alt, struct usb_endpoint_descriptor **bulk_in, struct usb_endpoint_descriptor **bulk_out, struct usb_endpoint_descriptor **int_in, struct usb_endpoint_descriptor **int_out)h](jT)}(hinth]hint}(hj_ hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj[ hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKubjC)}(h h]h }(hjn hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj[ hhhjm hKubj)}(h!usb_find_common_endpoints_reverseh]j)}(h!usb_find_common_endpoints_reverseh]h!usb_find_common_endpoints_reverse}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj| ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj[ hhhjm hKubj)}(h(struct usb_host_interface *alt, struct usb_endpoint_descriptor **bulk_in, struct usb_endpoint_descriptor **bulk_out, struct usb_endpoint_descriptor **int_in, struct usb_endpoint_descriptor **int_out)h](j)}(hstruct usb_host_interface *alth](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(husb_host_interfaceh]husb_host_interface}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR](jNjU)}jHj sb,c.usb_core.usb_find_common_endpoints_reverseesbuh1hhj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(halth]halt}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubj)}(h(struct usb_endpoint_descriptor **bulk_inh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hj- hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj* ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj/ modnameN classnameNjLjO)}jR](jNj ,c.usb_core.usb_find_common_endpoints_reverseesbuh1hhj ubjC)}(h h]h }(hjL hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hjZ hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubjs)}(hjvh]h*}(hjg hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(hbulk_inh]hbulk_in}(hjt hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubj)}(h)struct usb_endpoint_descriptor **bulk_outh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR](jNj ,c.usb_core.usb_find_common_endpoints_reverseesbuh1hhj ubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(hbulk_outh]hbulk_out}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubj)}(h'struct usb_endpoint_descriptor **int_inh](j1)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj+modnameN classnameNjLjO)}jR](jNj ,c.usb_core.usb_find_common_endpoints_reverseesbuh1hhjubjC)}(h h]h }(hjHhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubjs)}(hjvh]h*}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hint_inh]hint_in}(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubj)}(h(struct usb_endpoint_descriptor **int_outh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(husb_endpoint_descriptorh]husb_endpoint_descriptor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNj ,c.usb_core.usb_find_common_endpoints_reverseesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hint_outh]hint_out}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubeh}(h]h ]h"]h$]h&]jjuh1jhj[ hhhjm hKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjW hhhjm hKubah}(h]jR ah ](jjeh"]h$]h&]jj)jhuh1j$hjm hKhjT hhubj)}(hhh]j)}(hhh]j)}(h#look up common endpoint descriptorsh]h)}(hjh]h#look up common endpoint descriptors}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjubah}(h]h ]h"]h$]h&]uh1jhjhhhj,hNubah}(h]h ]h"]h$]h&]jjuh1jhj,hKhjhhubah}(h]h ]h"]h$]h&]uh1jhjT hhhjm hKubeh}(h]h ](jfunctioneh"]h$]h&]jjjjBjjBj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_host_interface *alt`` alternate setting to search ``struct usb_endpoint_descriptor **bulk_in`` pointer to descriptor pointer, or NULL ``struct usb_endpoint_descriptor **bulk_out`` pointer to descriptor pointer, or NULL ``struct usb_endpoint_descriptor **int_in`` pointer to descriptor pointer, or NULL ``struct usb_endpoint_descriptor **int_out`` pointer to descriptor pointer, or NULL **Description** Search the alternate setting's endpoint descriptors for the last bulk-in, bulk-out, interrupt-in and interrupt-out endpoints and return them in the provided pointers (unless they are NULL). If a requested endpoint is not found, the corresponding pointer is set to NULL. **Return** Zero if all requested descriptors were found, or -ENXIO otherwise.h](h)}(h**Parameters**h]j.)}(hjLh]h Parameters}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjJubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjFubjD)}(hhh](jI)}(h?``struct usb_host_interface *alt`` alternate setting to search h](jO)}(h"``struct usb_host_interface *alt``h]j)}(hjkh]hstruct usb_host_interface *alt}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjeubji)}(hhh]h)}(halternate setting to searchh]halternate setting to search}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjeubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjbubjI)}(hT``struct usb_endpoint_descriptor **bulk_in`` pointer to descriptor pointer, or NULL h](jO)}(h,``struct usb_endpoint_descriptor **bulk_in``h]j)}(hjh]h(struct usb_endpoint_descriptor **bulk_in}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjubji)}(hhh]h)}(h&pointer to descriptor pointer, or NULLh]h&pointer to descriptor pointer, or NULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjbubjI)}(hU``struct usb_endpoint_descriptor **bulk_out`` pointer to descriptor pointer, or NULL h](jO)}(h-``struct usb_endpoint_descriptor **bulk_out``h]j)}(hjh]h)struct usb_endpoint_descriptor **bulk_out}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjubji)}(hhh]h)}(h&pointer to descriptor pointer, or NULLh]h&pointer to descriptor pointer, or NULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjbubjI)}(hS``struct usb_endpoint_descriptor **int_in`` pointer to descriptor pointer, or NULL h](jO)}(h+``struct usb_endpoint_descriptor **int_in``h]j)}(hjh]h'struct usb_endpoint_descriptor **int_in}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjubji)}(hhh]h)}(h&pointer to descriptor pointer, or NULLh]h&pointer to descriptor pointer, or NULL}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hKhj,ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj+hKhjbubjI)}(hT``struct usb_endpoint_descriptor **int_out`` pointer to descriptor pointer, or NULL h](jO)}(h,``struct usb_endpoint_descriptor **int_out``h]j)}(hjOh]h(struct usb_endpoint_descriptor **int_out}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjIubji)}(hhh]h)}(h&pointer to descriptor pointer, or NULLh]h&pointer to descriptor pointer, or NULL}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjdhKhjeubah}(h]h ]h"]h$]h&]uh1jhhjIubeh}(h]h ]h"]h$]h&]uh1jHhjdhKhjbubeh}(h]h ]h"]h$]h&]uh1jChjFubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjFubh)}(hSearch the alternate setting's endpoint descriptors for the last bulk-in, bulk-out, interrupt-in and interrupt-out endpoints and return them in the provided pointers (unless they are NULL).h]hSearch the alternate setting’s endpoint descriptors for the last bulk-in, bulk-out, interrupt-in and interrupt-out endpoints and return them in the provided pointers (unless they are NULL).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjFubh)}(hOIf a requested endpoint is not found, the corresponding pointer is set to NULL.h]hOIf a requested endpoint is not found, the corresponding pointer is set to NULL.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjFubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjFubh)}(hBZero if all requested descriptors were found, or -ENXIO otherwise.h]hBZero if all requested descriptors were found, or -ENXIO otherwise.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjFubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j.usb_core.usb_check_bulk_endpoints (C function)#c.usb_core.usb_check_bulk_endpointshNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hTbool usb_check_bulk_endpoints (const struct usb_interface *intf, const u8 *ep_addrs)h]j+)}(hSbool usb_check_bulk_endpoints(const struct usb_interface *intf, const u8 *ep_addrs)h](jT)}(hjh]hbool}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhKubj)}(husb_check_bulk_endpointsh]j)}(husb_check_bulk_endpointsh]husb_check_bulk_endpoints}(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhKubj)}(h6(const struct usb_interface *intf, const u8 *ep_addrs)h](j)}(h const struct usb_interface *intfh](j1)}(hj4h]hconst}(hjAhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj=ubjC)}(h h]h }(hjNhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj=ubj1)}(hjh]hstruct}(hj\hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj=ubjC)}(h h]h }(hjihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj=ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj|modnameN classnameNjLjO)}jR](jNjU)}jHj'sb#c.usb_core.usb_check_bulk_endpointsesbuh1hhj=ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj=ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj=ubj)}(hintfh]hintf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj9ubj)}(hconst u8 *ep_addrsh](j1)}(hj4h]hconst}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(hu8h]hu8}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNj#c.usb_core.usb_check_bulk_endpointsesbuh1hhjubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hep_addrsh]hep_addrs}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj9ubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhKubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhKhjhhubj)}(hhh]h)}(hjCheck whether an interface's current altsetting contains a set of bulk endpoints with the given addresses.h]hlCheck whether an interface’s current altsetting contains a set of bulk endpoints with the given addresses.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjNhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhKubeh}(h]h ](jfunctioneh"]h$]h&]jjjjijjij j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``const struct usb_interface *intf`` the interface whose current altsetting should be searched ``const u8 *ep_addrs`` 0-terminated array of the endpoint addresses (number and direction) to look for **Description** Search for endpoints with the specified addresses and check their types. **Return** ``true`` if all the endpoints are found and are bulk, ``false`` otherwise.h](h)}(h**Parameters**h]j.)}(hjsh]h Parameters}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjqubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjmubjD)}(hhh](jI)}(h_``const struct usb_interface *intf`` the interface whose current altsetting should be searched h](jO)}(h$``const struct usb_interface *intf``h]j)}(hjh]h const struct usb_interface *intf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjubji)}(hhh]h)}(h9the interface whose current altsetting should be searchedh]h9the interface whose current altsetting should be searched}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubjI)}(hg``const u8 *ep_addrs`` 0-terminated array of the endpoint addresses (number and direction) to look for h](jO)}(h``const u8 *ep_addrs``h]j)}(hjh]hconst u8 *ep_addrs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjubji)}(hhh]h)}(hO0-terminated array of the endpoint addresses (number and direction) to look forh]hO0-terminated array of the endpoint addresses (number and direction) to look for}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhKhjubeh}(h]h ]h"]h$]h&]uh1jChjmubh)}(h**Description**h]j.)}(hjh]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjmubh)}(hHSearch for endpoints with the specified addresses and check their types.h]hHSearch for endpoints with the specified addresses and check their types.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjmubh)}(h **Return**h]j.)}(hj.h]hReturn}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj,ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjmubh)}(hJ``true`` if all the endpoints are found and are bulk, ``false`` otherwise.h](j)}(h``true``h]htrue}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubh. if all the endpoints are found and are bulk, }(hjDhhhNhNubj)}(h ``false``h]hfalse}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubh otherwise.}(hjDhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chKhjmubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_core.usb_check_int_endpoints (C function)"c.usb_core.usb_check_int_endpointshNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hSbool usb_check_int_endpoints (const struct usb_interface *intf, const u8 *ep_addrs)h]j+)}(hRbool usb_check_int_endpoints(const struct usb_interface *intf, const u8 *ep_addrs)h](jT)}(hjh]hbool}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubj)}(husb_check_int_endpointsh]j)}(husb_check_int_endpointsh]husb_check_int_endpoints}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h6(const struct usb_interface *intf, const u8 *ep_addrs)h](j)}(h const struct usb_interface *intfh](j1)}(hj4h]hconst}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj modnameN classnameNjLjO)}jR](jNjU)}jHjsb"c.usb_core.usb_check_int_endpointsesbuh1hhjubjC)}(h h]h }(hj)hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hintfh]hintf}(hjDhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hconst u8 *ep_addrsh](j1)}(hj4h]hconst}(hj]hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjYubjC)}(h h]h }(hjjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjYubh)}(hhh]j)}(hu8h]hu8}(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj}modnameN classnameNjLjO)}jR](jNj%"c.usb_core.usb_check_int_endpointsesbuh1hhjYubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjYubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjYubj)}(hep_addrsh]hep_addrs}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjYubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(hoCheck whether an interface's current altsetting contains a set of interrupt endpoints with the given addresses.h]hqCheck whether an interface’s current altsetting contains a set of interrupt endpoints with the given addresses.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``const struct usb_interface *intf`` the interface whose current altsetting should be searched ``const u8 *ep_addrs`` 0-terminated array of the endpoint addresses (number and direction) to look for **Description** Search for endpoints with the specified addresses and check their types. **Return** ``true`` if all the endpoints are found and are interrupt, ``false`` otherwise.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM hjubjD)}(hhh](jI)}(h_``const struct usb_interface *intf`` the interface whose current altsetting should be searched h](jO)}(h$``const struct usb_interface *intf``h]j)}(hj h]h const struct usb_interface *intf}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjubji)}(hhh]h)}(h9the interface whose current altsetting should be searchedh]h9the interface whose current altsetting should be searched}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hMhj6ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj5hMhjubjI)}(hg``const u8 *ep_addrs`` 0-terminated array of the endpoint addresses (number and direction) to look for h](jO)}(h``const u8 *ep_addrs``h]j)}(hjYh]hconst u8 *ep_addrs}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM hjSubji)}(hhh]h)}(hO0-terminated array of the endpoint addresses (number and direction) to look forh]hO0-terminated array of the endpoint addresses (number and direction) to look for}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM hjoubah}(h]h ]h"]h$]h&]uh1jhhjSubeh}(h]h ]h"]h$]h&]uh1jHhjnhM hjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM hjubh)}(hHSearch for endpoints with the specified addresses and check their types.h]hHSearch for endpoints with the specified addresses and check their types.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM hjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM hjubh)}(hO``true`` if all the endpoints are found and are interrupt, ``false`` otherwise.h](j)}(h``true``h]htrue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh3 if all the endpoints are found and are interrupt, }(hjhhhNhNubj)}(h ``false``h]hfalse}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh otherwise.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j*usb_core.usb_find_alt_setting (C function)c.usb_core.usb_find_alt_settinghNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hstruct usb_host_interface * usb_find_alt_setting (struct usb_host_config *config, unsigned int iface_num, unsigned int alt_num)h]j+)}(h}struct usb_host_interface *usb_find_alt_setting(struct usb_host_config *config, unsigned int iface_num, unsigned int alt_num)h](j1)}(hjh]hstruct}(hj!hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM ubjC)}(h h]h }(hj/hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj.hM ubh)}(hhh]j)}(husb_host_interfaceh]husb_host_interface}(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjBmodnameN classnameNjLjO)}jR](jNjU)}jHusb_find_alt_settingsbc.usb_core.usb_find_alt_settingesbuh1hhjhhhj.hM ubjC)}(h h]h }(hjbhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj.hM ubjs)}(hjvh]h*}(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjhhhj.hM ubj)}(husb_find_alt_settingh]j)}(hj_h]husb_find_alt_setting}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhj.hM ubj)}(hN(struct usb_host_config *config, unsigned int iface_num, unsigned int alt_num)h](j)}(hstruct usb_host_config *configh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(husb_host_configh]husb_host_config}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNj]c.usb_core.usb_find_alt_settingesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hconfigh]hconfig}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned int iface_numh](jT)}(hunsignedh]hunsigned}(hj hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjT)}(hinth]hint}(hj)hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj ubjC)}(h h]h }(hj7hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubj)}(h iface_numh]h iface_num}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned int alt_numh](jT)}(hunsignedh]hunsigned}(hj^hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjZubjC)}(h h]h }(hjlhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjZubjT)}(hinth]hint}(hjzhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjZubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjZubj)}(halt_numh]halt_num}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhj.hM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj.hM ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hj.hM hjhhubj)}(hhh]h)}(hJGiven a configuration, find the alternate setting for the given interface.h]hJGiven a configuration, find the alternate setting for the given interface.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhj.hM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_host_config *config`` the configuration to search (not necessarily the current config). ``unsigned int iface_num`` interface number to search in ``unsigned int alt_num`` alternate interface setting number to search for. **Description** Search the configuration's interface cache for the given alt setting. **Return** The alternate setting, if found. ``NULL`` otherwise.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM$hjubjD)}(hhh](jI)}(he``struct usb_host_config *config`` the configuration to search (not necessarily the current config). h](jO)}(h"``struct usb_host_config *config``h]j)}(hjh]hstruct usb_host_config *config}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM"hjubji)}(hhh]h)}(hAthe configuration to search (not necessarily the current config).h]hAthe configuration to search (not necessarily the current config).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM"hjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhM"hjubjI)}(h9``unsigned int iface_num`` interface number to search in h](jO)}(h``unsigned int iface_num``h]j)}(hj:h]hunsigned int iface_num}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM#hj4ubji)}(hhh]h)}(hinterface number to search inh]hinterface number to search in}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhM#hjPubah}(h]h ]h"]h$]h&]uh1jhhj4ubeh}(h]h ]h"]h$]h&]uh1jHhjOhM#hjubjI)}(hK``unsigned int alt_num`` alternate interface setting number to search for. h](jO)}(h``unsigned int alt_num``h]j)}(hjsh]hunsigned int alt_num}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM$hjmubji)}(hhh]h)}(h1alternate interface setting number to search for.h]h1alternate interface setting number to search for.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM$hjubah}(h]h ]h"]h$]h&]uh1jhhjmubeh}(h]h ]h"]h$]h&]uh1jHhjhM$hjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM&hjubh)}(hESearch the configuration's interface cache for the given alt setting.h]hGSearch the configuration’s interface cache for the given alt setting.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM%hjubh)}(h **Return**h]j.)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM'hjubh)}(h4The alternate setting, if found. ``NULL`` otherwise.h](h!The alternate setting, if found. }(hjhhhNhNubj)}(h``NULL``h]hNULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh otherwise.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM(hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j%usb_core.usb_ifnum_to_if (C function)c.usb_core.usb_ifnum_to_ifhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hUstruct usb_interface * usb_ifnum_to_if (const struct usb_device *dev, unsigned ifnum)h]j+)}(hSstruct usb_interface *usb_ifnum_to_if(const struct usb_device *dev, unsigned ifnum)h](j1)}(hjh]hstruct}(hj,hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj(hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMIubjC)}(h h]h }(hj:hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj(hhhj9hMIubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjKhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjHubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjMmodnameN classnameNjLjO)}jR](jNjU)}jHusb_ifnum_to_ifsbc.usb_core.usb_ifnum_to_ifesbuh1hhj(hhhj9hMIubjC)}(h h]h }(hjmhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj(hhhj9hMIubjs)}(hjvh]h*}(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj(hhhj9hMIubj)}(husb_ifnum_to_ifh]j)}(hjjh]husb_ifnum_to_if}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhj(hhhj9hMIubj)}(h.(const struct usb_device *dev, unsigned ifnum)h](j)}(hconst struct usb_device *devh](j1)}(hj4h]hconst}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjhc.usb_core.usb_ifnum_to_ifesbuh1hhjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjubj)}(hdevh]hdev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubj)}(hunsigned ifnumh](jT)}(hunsignedh]hunsigned}(hj3hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj/ubjC)}(h h]h }(hjAhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj/ubj)}(hifnumh]hifnum}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhj(hhhj9hMIubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj$hhhj9hMIubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hj9hMIhj!hhubj)}(hhh]h)}(h6get the interface object with a given interface numberh]h6get the interface object with a given interface number}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMIhjvhhubah}(h]h ]h"]h$]h&]uh1jhj!hhhj9hMIubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``const struct usb_device *dev`` the device whose current configuration is considered ``unsigned ifnum`` the desired interface **Description** This walks the device descriptor for the currently active configuration to find the interface object with the particular interface number. Note that configuration descriptors are not required to assign interface numbers sequentially, so that it would be incorrect to assume that the first interface in that descriptor corresponds to interface zero. This routine helps device drivers avoid such mistakes. However, you should make sure that you do the right thing with any alternate settings available for this interfaces. Don't call this function unless you are bound to one of the interfaces on this device or you have locked the device! **Return** A pointer to the interface that has **ifnum** as interface number, if found. ``NULL`` otherwise.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMMhjubjD)}(hhh](jI)}(hV``const struct usb_device *dev`` the device whose current configuration is considered h](jO)}(h ``const struct usb_device *dev``h]j)}(hjh]hconst struct usb_device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMJhjubji)}(hhh]h)}(h4the device whose current configuration is consideredh]h4the device whose current configuration is considered}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMJhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMJhjubjI)}(h)``unsigned ifnum`` the desired interface h](jO)}(h``unsigned ifnum``h]j)}(hjh]hunsigned ifnum}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMKhjubji)}(hhh]h)}(hthe desired interfaceh]hthe desired interface}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMKhj ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMKhjubeh}(h]h ]h"]h$]h&]uh1jChjubh)}(h**Description**h]j.)}(hj.h]h Description}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj,ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMMhjubh)}(hThis walks the device descriptor for the currently active configuration to find the interface object with the particular interface number.h]hThis walks the device descriptor for the currently active configuration to find the interface object with the particular interface number.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMLhjubh)}(hX}Note that configuration descriptors are not required to assign interface numbers sequentially, so that it would be incorrect to assume that the first interface in that descriptor corresponds to interface zero. This routine helps device drivers avoid such mistakes. However, you should make sure that you do the right thing with any alternate settings available for this interfaces.h]hX}Note that configuration descriptors are not required to assign interface numbers sequentially, so that it would be incorrect to assume that the first interface in that descriptor corresponds to interface zero. This routine helps device drivers avoid such mistakes. However, you should make sure that you do the right thing with any alternate settings available for this interfaces.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMOhjubh)}(htDon't call this function unless you are bound to one of the interfaces on this device or you have locked the device!h]hvDon’t call this function unless you are bound to one of the interfaces on this device or you have locked the device!}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMVhjubh)}(h **Return**h]j.)}(hjsh]hReturn}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjqubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMYhjubh)}(h`A pointer to the interface that has **ifnum** as interface number, if found. ``NULL`` otherwise.h](h$A pointer to the interface that has }(hjhhhNhNubj.)}(h **ifnum**h]hifnum}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubh as interface number, if found. }(hjhhhNhNubj)}(h``NULL``h]hNULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh otherwise.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMZhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j.usb_core.usb_altnum_to_altsetting (C function)#c.usb_core.usb_altnum_to_altsettinghNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hlstruct usb_host_interface * usb_altnum_to_altsetting (const struct usb_interface *intf, unsigned int altnum)h]j+)}(hjstruct usb_host_interface *usb_altnum_to_altsetting(const struct usb_interface *intf, unsigned int altnum)h](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMoubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMoubh)}(hhh]j)}(husb_host_interfaceh]husb_host_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHusb_altnum_to_altsettingsb#c.usb_core.usb_altnum_to_altsettingesbuh1hhjhhhjhMoubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMoubjs)}(hjvh]h*}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjhhhjhMoubj)}(husb_altnum_to_altsettingh]j)}(hjh]husb_altnum_to_altsetting}(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMoubj)}(h7(const struct usb_interface *intf, unsigned int altnum)h](j)}(h const struct usb_interface *intfh](j1)}(hj4h]hconst}(hjWhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjSubjC)}(h h]h }(hjdhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjSubj1)}(hjh]hstruct}(hjrhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjSubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjSubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNj#c.usb_core.usb_altnum_to_altsettingesbuh1hhjSubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjSubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjSubj)}(hintfh]hintf}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjSubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjOubj)}(hunsigned int altnumh](jT)}(hunsignedh]hunsigned}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubjT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hj hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(haltnumh]haltnum}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjOubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMoubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMoubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMohjhhubj)}(hhh]h)}(hCget the altsetting structure with a given alternate setting number.h]hCget the altsetting structure with a given alternate setting number.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMohjBhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMoubeh}(h]h ](jfunctioneh"]h$]h&]jjjj]jj]j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``const struct usb_interface *intf`` the interface containing the altsetting in question ``unsigned int altnum`` the desired alternate setting number **Description** This searches the altsetting array of the specified interface for an entry with the correct bAlternateSetting value. Note that altsettings need not be stored sequentially by number, so it would be incorrect to assume that the first altsetting entry in the array corresponds to altsetting zero. This routine helps device drivers avoid such mistakes. Don't call this function unless you are bound to the intf interface or you have locked the device! **Return** A pointer to the entry of the altsetting array of **intf** that has **altnum** as the alternate setting number. ``NULL`` if not found.h](h)}(h**Parameters**h]j.)}(hjgh]h Parameters}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjeubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMshjaubjD)}(hhh](jI)}(hY``const struct usb_interface *intf`` the interface containing the altsetting in question h](jO)}(h$``const struct usb_interface *intf``h]j)}(hjh]h const struct usb_interface *intf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMphjubji)}(hhh]h)}(h3the interface containing the altsetting in questionh]h3the interface containing the altsetting in question}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMphjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMphj}ubjI)}(h=``unsigned int altnum`` the desired alternate setting number h](jO)}(h``unsigned int altnum``h]j)}(hjh]hunsigned int altnum}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMqhjubji)}(hhh]h)}(h$the desired alternate setting numberh]h$the desired alternate setting number}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMqhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhjhMqhj}ubeh}(h]h ]h"]h$]h&]uh1jChjaubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMshjaubh)}(htThis searches the altsetting array of the specified interface for an entry with the correct bAlternateSetting value.h]htThis searches the altsetting array of the specified interface for an entry with the correct bAlternateSetting value.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMrhjaubh)}(hNote that altsettings need not be stored sequentially by number, so it would be incorrect to assume that the first altsetting entry in the array corresponds to altsetting zero. This routine helps device drivers avoid such mistakes.h]hNote that altsettings need not be stored sequentially by number, so it would be incorrect to assume that the first altsetting entry in the array corresponds to altsetting zero. This routine helps device drivers avoid such mistakes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMuhjaubh)}(hbDon't call this function unless you are bound to the intf interface or you have locked the device!h]hdDon’t call this function unless you are bound to the intf interface or you have locked the device!}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMzhjaubh)}(h **Return**h]j.)}(hj?h]hReturn}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj=ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM}hjaubh)}(hA pointer to the entry of the altsetting array of **intf** that has **altnum** as the alternate setting number. ``NULL`` if not found.h](h2A pointer to the entry of the altsetting array of }(hjUhhhNhNubj.)}(h**intf**h]hintf}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjUubh that has }(hjUhhhNhNubj.)}(h **altnum**h]haltnum}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjUubh" as the alternate setting number. }(hjUhhhNhNubj)}(h``NULL``h]hNULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubh if not found.}(hjUhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM~hjaubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.usb_find_interface (C function)c.usb_core.usb_find_interfacehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hMstruct usb_interface * usb_find_interface (struct usb_driver *drv, int minor)h]j+)}(hKstruct usb_interface *usb_find_interface(struct usb_driver *drv, int minor)h](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHusb_find_interfacesbc.usb_core.usb_find_interfaceesbuh1hhjhhhjhMubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhjhMubjs)}(hjvh]h*}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjhhhjhMubj)}(husb_find_interfaceh]j)}(hjh]husb_find_interface}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhjhMubj)}(h#(struct usb_driver *drv, int minor)h](j)}(hstruct usb_driver *drvh](j1)}(hjh]hstruct}(hj5hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj1ubjC)}(h h]h }(hjBhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj1ubh)}(hhh]j)}(h usb_driverh]h usb_driver}(hjShhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjPubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjUmodnameN classnameNjLjO)}jR](jNjc.usb_core.usb_find_interfaceesbuh1hhj1ubjC)}(h h]h }(hjrhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj1ubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj1ubj)}(hdrvh]hdrv}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj-ubj)}(h int minorh](jT)}(hinth]hint}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjubj)}(hminorh]hminor}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj-ubeh}(h]h ]h"]h$]h&]jjuh1jhjhhhjhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhMubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhMhjhhubj)}(hhh]h)}(h0find usb_interface pointer for driver and deviceh]h0find usb_interface pointer for driver and device}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj jj j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_driver *drv`` the driver whose current configuration is considered ``int minor`` the minor number of the desired device **Description** This walks the bus device list and returns a pointer to the interface with the matching minor and driver. Note, this only works for devices that share the USB major number. **Return** A pointer to the interface with the matching major and **minor**.h](h)}(h**Parameters**h]j.)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj ubjD)}(hhh](jI)}(hP``struct usb_driver *drv`` the driver whose current configuration is considered h](jO)}(h``struct usb_driver *drv``h]j)}(hj- h]hstruct usb_driver *drv}(hj/ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj' ubji)}(hhh]h)}(h4the driver whose current configuration is consideredh]h4the driver whose current configuration is considered}(hjF hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjB hMhjC ubah}(h]h ]h"]h$]h&]uh1jhhj' ubeh}(h]h ]h"]h$]h&]uh1jHhjB hMhj$ ubjI)}(h5``int minor`` the minor number of the desired device h](jO)}(h ``int minor``h]j)}(hjf h]h int minor}(hjh hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjd ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj` ubji)}(hhh]h)}(h&the minor number of the desired deviceh]h&the minor number of the desired device}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{ hMhj| ubah}(h]h ]h"]h$]h&]uh1jhhj` ubeh}(h]h ]h"]h$]h&]uh1jHhj{ hMhj$ ubeh}(h]h ]h"]h$]h&]uh1jChj ubh)}(h**Description**h]j.)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj ubh)}(hThis walks the bus device list and returns a pointer to the interface with the matching minor and driver. Note, this only works for devices that share the USB major number.h]hThis walks the bus device list and returns a pointer to the interface with the matching minor and driver. Note, this only works for devices that share the USB major number.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj ubh)}(h **Return**h]j.)}(hj h]hReturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj ubh)}(hAA pointer to the interface with the matching major and **minor**.h](h7A pointer to the interface with the matching major and }(hj hhhNhNubj.)}(h **minor**h]hminor}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&usb_core.usb_for_each_dev (C function)c.usb_core.usb_for_each_devhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hIint usb_for_each_dev (void *data, int (*fn)(struct usb_device *, void *))h]j+)}(hFint usb_for_each_dev(void *data, int (*fn)(struct usb_device*, void*))h](jT)}(hinth]hint}(hj!hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj!hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMubjC)}(h h]h }(hj.!hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj!hhhj-!hMubj)}(husb_for_each_devh]j)}(husb_for_each_devh]husb_for_each_dev}(hj@!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj:*ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj)ubh)}(hMust be called when a user of a device is finished with it. When the last user of the device calls this function, the memory of the device is freed.h]hMust be called when a user of a device is finished with it. When the last user of the device calls this function, the memory of the device is freed.}(hjR*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj)ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"usb_core.usb_get_intf (C function)c.usb_core.usb_get_intfhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h@struct usb_interface * usb_get_intf (struct usb_interface *intf)h]j+)}(h>struct usb_interface *usb_get_intf(struct usb_interface *intf)h](j1)}(hjh]hstruct}(hj*hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj}*hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMubjC)}(h h]h }(hj*hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj}*hhhj*hMubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj*modnameN classnameNjLjO)}jR](jNjU)}jH usb_get_intfsbc.usb_core.usb_get_intfesbuh1hhj}*hhhj*hMubjC)}(h h]h }(hj*hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj}*hhhj*hMubjs)}(hjvh]h*}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj}*hhhj*hMubj)}(h usb_get_intfh]j)}(hj*h]h usb_get_intf}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj}*hhhj*hMubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hj*hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj*ubjC)}(h h]h }(hj +hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj*ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj+modnameN classnameNjLjO)}jR](jNj*c.usb_core.usb_get_intfesbuh1hhj*ubjC)}(h h]h }(hj9+hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj*ubjs)}(hjvh]h*}(hjG+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj*ubj)}(hintfh]hintf}(hjT+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj*ubah}(h]h ]h"]h$]h&]jjuh1jhj}*hhhj*hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjy*hhhj*hMubah}(h]jt*ah ](jjeh"]h$]h&]jj)jhuh1j$hj*hMhjv*hhubj)}(hhh]h)}(h=increments the reference count of the usb interface structureh]h=increments the reference count of the usb interface structure}(hj~+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj{+hhubah}(h]h ]h"]h$]h&]uh1jhjv*hhhj*hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj+jj+j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_interface *intf`` the interface being referenced **Description** Each live reference to a interface must be refcounted. Drivers for USB interfaces should normally record such references in their probe() methods, when they bind to an interface, and release them by calling usb_put_intf(), in their disconnect() methods. However, if a driver does not access the usb_interface structure after its disconnect() method returns then refcounting is not necessary, because the USB core guarantees that a usb_interface will not be deallocated until after its driver has been unbound. **Return** A pointer to the interface with the incremented reference counter.h](h)}(h**Parameters**h]j.)}(hj+h]h Parameters}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj+ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj+ubjD)}(hhh]jI)}(h>``struct usb_interface *intf`` the interface being referenced h](jO)}(h``struct usb_interface *intf``h]j)}(hj+h]hstruct usb_interface *intf}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj+ubji)}(hhh]h)}(hthe interface being referencedh]hthe interface being referenced}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hMhj+ubah}(h]h ]h"]h$]h&]uh1jhhj+ubeh}(h]h ]h"]h$]h&]uh1jHhj+hMhj+ubah}(h]h ]h"]h$]h&]uh1jChj+ubh)}(h**Description**h]j.)}(hj+h]h Description}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj+ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj+ubh)}(h6Each live reference to a interface must be refcounted.h]h6Each live reference to a interface must be refcounted.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj+ubh)}(hXDrivers for USB interfaces should normally record such references in their probe() methods, when they bind to an interface, and release them by calling usb_put_intf(), in their disconnect() methods. However, if a driver does not access the usb_interface structure after its disconnect() method returns then refcounting is not necessary, because the USB core guarantees that a usb_interface will not be deallocated until after its driver has been unbound.h]hXDrivers for USB interfaces should normally record such references in their probe() methods, when they bind to an interface, and release them by calling usb_put_intf(), in their disconnect() methods. However, if a driver does not access the usb_interface structure after its disconnect() method returns then refcounting is not necessary, because the USB core guarantees that a usb_interface will not be deallocated until after its driver has been unbound.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj+ubh)}(h **Return**h]j.)}(hj0,h]hReturn}(hj2,hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj.,ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM'hj+ubh)}(hBA pointer to the interface with the incremented reference counter.h]hBA pointer to the interface with the incremented reference counter.}(hjF,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM(hj+ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"usb_core.usb_put_intf (C function)c.usb_core.usb_put_intfhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h.void usb_put_intf (struct usb_interface *intf)h]j+)}(h-void usb_put_intf(struct usb_interface *intf)h](jT)}(hvoidh]hvoid}(hju,hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjq,hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM3ubjC)}(h h]h }(hj,hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjq,hhhj,hM3ubj)}(h usb_put_intfh]j)}(h usb_put_intfh]h usb_put_intf}(hj,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjq,hhhj,hM3ubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hj,hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj,ubjC)}(h h]h }(hj,hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj,ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj,modnameN classnameNjLjO)}jR](jNjU)}jHj,sbc.usb_core.usb_put_intfesbuh1hhj,ubjC)}(h h]h }(hj,hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj,ubjs)}(hjvh]h*}(hj,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj,ubj)}(hintfh]hintf}(hj -hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj,ubah}(h]h ]h"]h$]h&]jjuh1jhjq,hhhj,hM3ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjm,hhhj,hM3ubah}(h]jh,ah ](jjeh"]h$]h&]jj)jhuh1j$hj,hM3hjj,hhubj)}(hhh]h)}(h,release a use of the usb interface structureh]h,release a use of the usb interface structure}(hj6-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM3hj3-hhubah}(h]h ]h"]h$]h&]uh1jhjj,hhhj,hM3ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjN-jjN-j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_interface *intf`` interface that's been decremented **Description** Must be called when a user of an interface is finished with it. When the last user of the interface calls this function, the memory of the interface is freed.h](h)}(h**Parameters**h]j.)}(hjX-h]h Parameters}(hjZ-hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjV-ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM7hjR-ubjD)}(hhh]jI)}(hA``struct usb_interface *intf`` interface that's been decremented h](jO)}(h``struct usb_interface *intf``h]j)}(hjw-h]hstruct usb_interface *intf}(hjy-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhju-ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM4hjq-ubji)}(hhh]h)}(h!interface that's been decrementedh]h#interface that’s been decremented}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-hM4hj-ubah}(h]h ]h"]h$]h&]uh1jhhjq-ubeh}(h]h ]h"]h$]h&]uh1jHhj-hM4hjn-ubah}(h]h ]h"]h$]h&]uh1jChjR-ubh)}(h**Description**h]j.)}(hj-h]h Description}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj-ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM6hjR-ubh)}(hMust be called when a user of an interface is finished with it. When the last user of the interface calls this function, the memory of the interface is freed.h]hMust be called when a user of an interface is finished with it. When the last user of the interface calls this function, the memory of the interface is freed.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM5hjR-ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_core.usb_intf_get_dma_device (C function)"c.usb_core.usb_intf_get_dma_devicehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hDstruct device * usb_intf_get_dma_device (struct usb_interface *intf)h]j+)}(hBstruct device *usb_intf_get_dma_device(struct usb_interface *intf)h](j1)}(hjh]hstruct}(hj-hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj-hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMBubjC)}(h h]h }(hj.hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj-hhhj.hMBubh)}(hhh]j)}(hdeviceh]hdevice}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj.modnameN classnameNjLjO)}jR](jNjU)}jHusb_intf_get_dma_devicesb"c.usb_core.usb_intf_get_dma_deviceesbuh1hhj-hhhj.hMBubjC)}(h h]h }(hj8.hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj-hhhj.hMBubjs)}(hjvh]h*}(hjF.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj-hhhj.hMBubj)}(husb_intf_get_dma_deviceh]j)}(hj5.h]husb_intf_get_dma_device}(hjW.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjS.ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj-hhhj.hMBubj)}(h(struct usb_interface *intf)h]j)}(hstruct usb_interface *intfh](j1)}(hjh]hstruct}(hjr.hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjn.ubjC)}(h h]h }(hj.hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjn.ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj.modnameN classnameNjLjO)}jR](jNj3."c.usb_core.usb_intf_get_dma_deviceesbuh1hhjn.ubjC)}(h h]h }(hj.hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjn.ubjs)}(hjvh]h*}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjn.ubj)}(hintfh]hintf}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjn.ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjj.ubah}(h]h ]h"]h$]h&]jjuh1jhj-hhhj.hMBubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj-hhhj.hMBubah}(h]j-ah ](jjeh"]h$]h&]jj)jhuh1j$hj.hMBhj-hhubj)}(hhh]h)}(h7acquire a reference on the usb interface's DMA endpointh]h9acquire a reference on the usb interface’s DMA endpoint}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMBhj.hhubah}(h]h ]h"]h$]h&]uh1jhj-hhhj.hMBubeh}(h]h ](jfunctioneh"]h$]h&]jjjj /jj /j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_interface *intf`` the usb interface **Description** While a USB device cannot perform DMA operations by itself, many USB controllers can. A call to usb_intf_get_dma_device() returns the DMA endpoint for the given USB interface, if any. The returned device structure must be released with put_device(). See also usb_get_dma_device(). **Return** A reference to the usb interface's DMA endpoint; or NULL if none exists.h](h)}(h**Parameters**h]j.)}(hj/h]h Parameters}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj/ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMFhj/ubjD)}(hhh]jI)}(h1``struct usb_interface *intf`` the usb interface h](jO)}(h``struct usb_interface *intf``h]j)}(hj5/h]hstruct usb_interface *intf}(hj7/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3/ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMChj//ubji)}(hhh]h)}(hthe usb interfaceh]hthe usb interface}(hjN/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJ/hMChjK/ubah}(h]h ]h"]h$]h&]uh1jhhj//ubeh}(h]h ]h"]h$]h&]uh1jHhjJ/hMChj,/ubah}(h]h ]h"]h$]h&]uh1jChj/ubh)}(h**Description**h]j.)}(hjp/h]h Description}(hjr/hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjn/ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMEhj/ubh)}(hWhile a USB device cannot perform DMA operations by itself, many USB controllers can. A call to usb_intf_get_dma_device() returns the DMA endpoint for the given USB interface, if any. The returned device structure must be released with put_device().h]hWhile a USB device cannot perform DMA operations by itself, many USB controllers can. A call to usb_intf_get_dma_device() returns the DMA endpoint for the given USB interface, if any. The returned device structure must be released with put_device().}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMDhj/ubh)}(hSee also usb_get_dma_device().h]hSee also usb_get_dma_device().}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMIhj/ubh)}(h **Return**h]j.)}(hj/h]hReturn}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj/ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMKhj/ubh)}(hHA reference to the usb interface's DMA endpoint; or NULL if none exists.h]hJA reference to the usb interface’s DMA endpoint; or NULL if none exists.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMLhj/ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j/usb_core.usb_lock_device_for_reset (C function)$c.usb_core.usb_lock_device_for_resethNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hZint usb_lock_device_for_reset (struct usb_device *udev, const struct usb_interface *iface)h]j+)}(hYint usb_lock_device_for_reset(struct usb_device *udev, const struct usb_interface *iface)h](jT)}(hinth]hint}(hj/hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj/hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMrubjC)}(h h]h }(hj/hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj/hhhj/hMrubj)}(husb_lock_device_for_reseth]j)}(husb_lock_device_for_reseth]husb_lock_device_for_reset}(hj 0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj/hhhj/hMrubj)}(h<(struct usb_device *udev, const struct usb_interface *iface)h](j)}(hstruct usb_device *udevh](j1)}(hjh]hstruct}(hj(0hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj$0ubjC)}(h h]h }(hj50hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj$0ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjF0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjC0ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjH0modnameN classnameNjLjO)}jR](jNjU)}jHj0sb$c.usb_core.usb_lock_device_for_resetesbuh1hhj$0ubjC)}(h h]h }(hjg0hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj$0ubjs)}(hjvh]h*}(hju0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj$0ubj)}(hudevh]hudev}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj$0ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj 0ubj)}(h!const struct usb_interface *ifaceh](j1)}(hj4h]hconst}(hj0hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj0ubjC)}(h h]h }(hj0hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj0ubj1)}(hjh]hstruct}(hj0hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj0ubjC)}(h h]h }(hj0hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj0ubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj0modnameN classnameNjLjO)}jR](jNjc0$c.usb_core.usb_lock_device_for_resetesbuh1hhj0ubjC)}(h h]h }(hj0hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj0ubjs)}(hjvh]h*}(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj0ubj)}(hifaceh]hiface}(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj 0ubeh}(h]h ]h"]h$]h&]jjuh1jhj/hhhj/hMrubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj/hhhj/hMrubah}(h]j/ah ](jjeh"]h$]h&]jj)jhuh1j$hj/hMrhj/hhubj)}(hhh]h)}(h6cautiously acquire the lock for a usb device structureh]h6cautiously acquire the lock for a usb device structure}(hj81hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMrhj51hhubah}(h]h ]h"]h$]h&]uh1jhj/hhhj/hMrubeh}(h]h ](jfunctioneh"]h$]h&]jjjjP1jjP1j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *udev`` device that's being locked ``const struct usb_interface *iface`` interface bound to the driver making the request (optional) **Description** Attempts to acquire the device lock, but fails if the device is NOTATTACHED or SUSPENDED, or if iface is specified and the interface is neither BINDING nor BOUND. Rather than sleeping to wait for the lock, the routine polls repeatedly. This is to prevent deadlock with disconnect; in some drivers (such as usb-storage) the disconnect() or suspend() method will block waiting for a device reset to complete. **Return** A negative error code for failure, otherwise 0.h](h)}(h**Parameters**h]j.)}(hjZ1h]h Parameters}(hj\1hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjX1ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMvhjT1ubjD)}(hhh](jI)}(h7``struct usb_device *udev`` device that's being locked h](jO)}(h``struct usb_device *udev``h]j)}(hjy1h]hstruct usb_device *udev}(hj{1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjw1ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMshjs1ubji)}(hhh]h)}(hdevice that's being lockedh]hdevice that’s being locked}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMshj1ubah}(h]h ]h"]h$]h&]uh1jhhjs1ubeh}(h]h ]h"]h$]h&]uh1jHhj1hMshjp1ubjI)}(hb``const struct usb_interface *iface`` interface bound to the driver making the request (optional) h](jO)}(h%``const struct usb_interface *iface``h]j)}(hj1h]h!const struct usb_interface *iface}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMthj1ubji)}(hhh]h)}(h;interface bound to the driver making the request (optional)h]h;interface bound to the driver making the request (optional)}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hMthj1ubah}(h]h ]h"]h$]h&]uh1jhhj1ubeh}(h]h ]h"]h$]h&]uh1jHhj1hMthjp1ubeh}(h]h ]h"]h$]h&]uh1jChjT1ubh)}(h**Description**h]j.)}(hj1h]h Description}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj1ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMvhjT1ubh)}(hXAttempts to acquire the device lock, but fails if the device is NOTATTACHED or SUSPENDED, or if iface is specified and the interface is neither BINDING nor BOUND. Rather than sleeping to wait for the lock, the routine polls repeatedly. This is to prevent deadlock with disconnect; in some drivers (such as usb-storage) the disconnect() or suspend() method will block waiting for a device reset to complete.h]hXAttempts to acquire the device lock, but fails if the device is NOTATTACHED or SUSPENDED, or if iface is specified and the interface is neither BINDING nor BOUND. Rather than sleeping to wait for the lock, the routine polls repeatedly. This is to prevent deadlock with disconnect; in some drivers (such as usb-storage) the disconnect() or suspend() method will block waiting for a device reset to complete.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMuhjT1ubh)}(h **Return**h]j.)}(hj2h]hReturn}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj2ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM|hjT1ubh)}(h/A negative error code for failure, otherwise 0.h]h/A negative error code for failure, otherwise 0.}(hj*2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM}hjT1ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j2usb_core.usb_get_current_frame_number (C function)'c.usb_core.usb_get_current_frame_numberhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h9int usb_get_current_frame_number (struct usb_device *dev)h]j+)}(h8int usb_get_current_frame_number(struct usb_device *dev)h](jT)}(hinth]hint}(hjY2hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjU2hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMubjC)}(h h]h }(hjh2hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjU2hhhjg2hMubj)}(husb_get_current_frame_numberh]j)}(husb_get_current_frame_numberh]husb_get_current_frame_number}(hjz2hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjv2ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjU2hhhjg2hMubj)}(h(struct usb_device *dev)h]j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hj2hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj2ubjC)}(h h]h }(hj2hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj2ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj2hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj2modnameN classnameNjLjO)}jR](jNjU)}jHj|2sb'c.usb_core.usb_get_current_frame_numberesbuh1hhj2ubjC)}(h h]h }(hj2hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj2ubjs)}(hjvh]h*}(hj2hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj2ubj)}(hdevh]hdev}(hj2hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj2ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj2ubah}(h]h ]h"]h$]h&]jjuh1jhjU2hhhjg2hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjQ2hhhjg2hMubah}(h]jL2ah ](jjeh"]h$]h&]jj)jhuh1j$hjg2hMhjN2hhubj)}(hhh]h)}(hreturn current bus frame numberh]hreturn current bus frame number}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj3hhubah}(h]h ]h"]h$]h&]uh1jhjN2hhhjg2hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj23jj23j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *dev`` the device whose bus is being queried **Return** The current frame number for the USB host controller used with the given USB device. This can be used when scheduling isochronous requests. **Note** Different kinds of host controller have different "scheduling horizons". While one type might support scheduling only 32 frames into the future, others could support scheduling up to 1024 frames into the future.h](h)}(h**Parameters**h]j.)}(hj<3h]h Parameters}(hj>3hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj:3ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj63ubjD)}(hhh]jI)}(hA``struct usb_device *dev`` the device whose bus is being queried h](jO)}(h``struct usb_device *dev``h]j)}(hj[3h]hstruct usb_device *dev}(hj]3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjY3ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjU3ubji)}(hhh]h)}(h%the device whose bus is being queriedh]h%the device whose bus is being queried}(hjt3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjp3hMhjq3ubah}(h]h ]h"]h$]h&]uh1jhhjU3ubeh}(h]h ]h"]h$]h&]uh1jHhjp3hMhjR3ubah}(h]h ]h"]h$]h&]uh1jChj63ubh)}(h **Return**h]j.)}(hj3h]hReturn}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj3ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj63ubh)}(hThe current frame number for the USB host controller used with the given USB device. This can be used when scheduling isochronous requests.h]hThe current frame number for the USB host controller used with the given USB device. This can be used when scheduling isochronous requests.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj63ubh)}(h**Note**h]j.)}(hj3h]hNote}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj3ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj63ubh)}(hDifferent kinds of host controller have different "scheduling horizons". While one type might support scheduling only 32 frames into the future, others could support scheduling up to 1024 frames into the future.h]hDifferent kinds of host controller have different “scheduling horizons”. While one type might support scheduling only 32 frames into the future, others could support scheduling up to 1024 frames into the future.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj63ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.usb_alloc_coherent (C function)c.usb_core.usb_alloc_coherenthNtauh1jhjrhhhNhNubj )}(hhh](j%)}(havoid * usb_alloc_coherent (struct usb_device *dev, size_t size, gfp_t mem_flags, dma_addr_t *dma)h]j+)}(h_void *usb_alloc_coherent(struct usb_device *dev, size_t size, gfp_t mem_flags, dma_addr_t *dma)h](jT)}(hvoidh]hvoid}(hj4hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj3hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMubjC)}(h h]h }(hj4hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj3hhhj4hMubjs)}(hjvh]h*}(hj4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj3hhhj4hMubj)}(husb_alloc_coherenth]j)}(husb_alloc_coherenth]husb_alloc_coherent}(hj04hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,4ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj3hhhj4hMubj)}(hG(struct usb_device *dev, size_t size, gfp_t mem_flags, dma_addr_t *dma)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjL4hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjH4ubjC)}(h h]h }(hjY4hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjH4ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjj4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjg4ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjl4modnameN classnameNjLjO)}jR](jNjU)}jHj24sbc.usb_core.usb_alloc_coherentesbuh1hhjH4ubjC)}(h h]h }(hj4hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjH4ubjs)}(hjvh]h*}(hj4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjH4ubj)}(hdevh]hdev}(hj4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjH4ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjD4ubj)}(h size_t sizeh](h)}(hhh]j)}(hsize_th]hsize_t}(hj4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj4modnameN classnameNjLjO)}jR](jNj4c.usb_core.usb_alloc_coherentesbuh1hhj4ubjC)}(h h]h }(hj4hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj4ubj)}(hsizeh]hsize}(hj4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjD4ubj)}(hgfp_t mem_flagsh](h)}(hhh]j)}(hgfp_th]hgfp_t}(hj 5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj 5modnameN classnameNjLjO)}jR](jNj4c.usb_core.usb_alloc_coherentesbuh1hhj5ubjC)}(h h]h }(hj*5hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj5ubj)}(h mem_flagsh]h mem_flags}(hj85hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjD4ubj)}(hdma_addr_t *dmah](h)}(hhh]j)}(h dma_addr_th]h dma_addr_t}(hjT5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQ5ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjV5modnameN classnameNjLjO)}jR](jNj4c.usb_core.usb_alloc_coherentesbuh1hhjM5ubjC)}(h h]h }(hjs5hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjM5ubjs)}(hjvh]h*}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjM5ubj)}(hdmah]hdma}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjM5ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjD4ubeh}(h]h ]h"]h$]h&]jjuh1jhj3hhhj4hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj3hhhj4hMubah}(h]j3ah ](jjeh"]h$]h&]jj)jhuh1j$hj4hMhj3hhubj)}(hhh]h)}(h5allocate dma-consistent buffer for URB_NO_xxx_DMA_MAPh]h5allocate dma-consistent buffer for URB_NO_xxx_DMA_MAP}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj5hhubah}(h]h ]h"]h$]h&]uh1jhj3hhhj4hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj5jj5j j!j"uh1jhhhjrhNhNubj$)}(hX!**Parameters** ``struct usb_device *dev`` device the buffer will be used with ``size_t size`` requested buffer size ``gfp_t mem_flags`` affect whether allocation may block ``dma_addr_t *dma`` used to return DMA address of buffer **Return** Either null (indicating no buffer could be allocated), or the cpu-space pointer to a buffer that may be used to perform DMA to the specified device. Such cpu-space buffers are returned along with the DMA address (through the pointer provided). **Note** These buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags to avoid behaviors like using "DMA bounce buffers", or thrashing IOMMU hardware during URB completion/resubmit. The implementation varies between platforms, depending on details of how DMA will work to this device. Using these buffers also eliminates cacheline sharing problems on architectures where CPU caches are not DMA-coherent. On systems without bus-snooping caches, these buffers are uncached. When the buffer is no longer used, free it with usb_free_coherent().h](h)}(h**Parameters**h]j.)}(hj5h]h Parameters}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj5ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj5ubjD)}(hhh](jI)}(h?``struct usb_device *dev`` device the buffer will be used with h](jO)}(h``struct usb_device *dev``h]j)}(hj5h]hstruct usb_device *dev}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj5ubji)}(hhh]h)}(h#device the buffer will be used withh]h#device the buffer will be used with}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hMhj6ubah}(h]h ]h"]h$]h&]uh1jhhj5ubeh}(h]h ]h"]h$]h&]uh1jHhj6hMhj5ubjI)}(h&``size_t size`` requested buffer size h](jO)}(h``size_t size``h]j)}(hj26h]h size_t size}(hj46hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj06ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj,6ubji)}(hhh]h)}(hrequested buffer sizeh]hrequested buffer size}(hjK6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjG6hMhjH6ubah}(h]h ]h"]h$]h&]uh1jhhj,6ubeh}(h]h ]h"]h$]h&]uh1jHhjG6hMhj5ubjI)}(h8``gfp_t mem_flags`` affect whether allocation may block h](jO)}(h``gfp_t mem_flags``h]j)}(hjk6h]hgfp_t mem_flags}(hjm6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhji6ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhje6ubji)}(hhh]h)}(h#affect whether allocation may blockh]h#affect whether allocation may block}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hMhj6ubah}(h]h ]h"]h$]h&]uh1jhhje6ubeh}(h]h ]h"]h$]h&]uh1jHhj6hMhj5ubjI)}(h9``dma_addr_t *dma`` used to return DMA address of buffer h](jO)}(h``dma_addr_t *dma``h]j)}(hj6h]hdma_addr_t *dma}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj6ubji)}(hhh]h)}(h$used to return DMA address of bufferh]h$used to return DMA address of buffer}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hMhj6ubah}(h]h ]h"]h$]h&]uh1jhhj6ubeh}(h]h ]h"]h$]h&]uh1jHhj6hMhj5ubeh}(h]h ]h"]h$]h&]uh1jChj5ubh)}(h **Return**h]j.)}(hj6h]hReturn}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj6ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj5ubh)}(hEither null (indicating no buffer could be allocated), or the cpu-space pointer to a buffer that may be used to perform DMA to the specified device. Such cpu-space buffers are returned along with the DMA address (through the pointer provided).h]hEither null (indicating no buffer could be allocated), or the cpu-space pointer to a buffer that may be used to perform DMA to the specified device. Such cpu-space buffers are returned along with the DMA address (through the pointer provided).}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj5ubh)}(h**Note**h]j.)}(hj7h]hNote}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj7ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj5ubh)}(hXThese buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags to avoid behaviors like using "DMA bounce buffers", or thrashing IOMMU hardware during URB completion/resubmit. The implementation varies between platforms, depending on details of how DMA will work to this device. Using these buffers also eliminates cacheline sharing problems on architectures where CPU caches are not DMA-coherent. On systems without bus-snooping caches, these buffers are uncached.h]hXThese buffers are used with URB_NO_xxx_DMA_MAP set in urb->transfer_flags to avoid behaviors like using “DMA bounce buffers”, or thrashing IOMMU hardware during URB completion/resubmit. The implementation varies between platforms, depending on details of how DMA will work to this device. Using these buffers also eliminates cacheline sharing problems on architectures where CPU caches are not DMA-coherent. On systems without bus-snooping caches, these buffers are uncached.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj5ubh)}(hDWhen the buffer is no longer used, free it with usb_free_coherent().h]hDWhen the buffer is no longer used, free it with usb_free_coherent().}(hj+7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj5ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_core.usb_free_coherent (C function)c.usb_core.usb_free_coherenthNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hXvoid usb_free_coherent (struct usb_device *dev, size_t size, void *addr, dma_addr_t dma)h]j+)}(hWvoid usb_free_coherent(struct usb_device *dev, size_t size, void *addr, dma_addr_t dma)h](jT)}(hvoidh]hvoid}(hjZ7hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjV7hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMubjC)}(h h]h }(hji7hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjV7hhhjh7hMubj)}(husb_free_coherenth]j)}(husb_free_coherenth]husb_free_coherent}(hj{7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjw7ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjV7hhhjh7hMubj)}(hA(struct usb_device *dev, size_t size, void *addr, dma_addr_t dma)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hj7hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj7ubjC)}(h h]h }(hj7hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj7ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj7modnameN classnameNjLjO)}jR](jNjU)}jHj}7sbc.usb_core.usb_free_coherentesbuh1hhj7ubjC)}(h h]h }(hj7hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj7ubjs)}(hjvh]h*}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj7ubj)}(hdevh]hdev}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj7ubj)}(h size_t sizeh](h)}(hhh]j)}(hsize_th]hsize_t}(hj 8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 8ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj8modnameN classnameNjLjO)}jR](jNj7c.usb_core.usb_free_coherentesbuh1hhj8ubjC)}(h h]h }(hj,8hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj8ubj)}(hsizeh]hsize}(hj:8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj7ubj)}(h void *addrh](jT)}(hvoidh]hvoid}(hjS8hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjO8ubjC)}(h h]h }(hja8hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjO8ubjs)}(hjvh]h*}(hjo8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjO8ubj)}(haddrh]haddr}(hj|8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjO8ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj7ubj)}(hdma_addr_t dmah](h)}(hhh]j)}(h dma_addr_th]h dma_addr_t}(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj8modnameN classnameNjLjO)}jR](jNj7c.usb_core.usb_free_coherentesbuh1hhj8ubjC)}(h h]h }(hj8hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj8ubj)}(hdmah]hdma}(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj7ubeh}(h]h ]h"]h$]h&]jjuh1jhjV7hhhjh7hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjR7hhhjh7hMubah}(h]jM7ah ](jjeh"]h$]h&]jj)jhuh1j$hjh7hMhjO7hhubj)}(hhh]h)}(h/free memory allocated with usb_alloc_coherent()h]h/free memory allocated with usb_alloc_coherent()}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj8hhubah}(h]h ]h"]h$]h&]uh1jhjO7hhhjh7hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj9jj9j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *dev`` device the buffer was used with ``size_t size`` requested buffer size ``void *addr`` CPU address of buffer ``dma_addr_t dma`` DMA address of buffer **Description** This reclaims an I/O buffer, letting it be reused. The memory must have been allocated using usb_alloc_coherent(), and the parameters must match those provided in that allocation request.h](h)}(h**Parameters**h]j.)}(hj9h]h Parameters}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj9ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj 9ubjD)}(hhh](jI)}(h;``struct usb_device *dev`` device the buffer was used with h](jO)}(h``struct usb_device *dev``h]j)}(hj09h]hstruct usb_device *dev}(hj29hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.9ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj*9ubji)}(hhh]h)}(hdevice the buffer was used withh]hdevice the buffer was used with}(hjI9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjE9hMhjF9ubah}(h]h ]h"]h$]h&]uh1jhhj*9ubeh}(h]h ]h"]h$]h&]uh1jHhjE9hMhj'9ubjI)}(h&``size_t size`` requested buffer size h](jO)}(h``size_t size``h]j)}(hji9h]h size_t size}(hjk9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjg9ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjc9ubji)}(hhh]h)}(hrequested buffer sizeh]hrequested buffer size}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~9hMhj9ubah}(h]h ]h"]h$]h&]uh1jhhjc9ubeh}(h]h ]h"]h$]h&]uh1jHhj~9hMhj'9ubjI)}(h%``void *addr`` CPU address of buffer h](jO)}(h``void *addr``h]j)}(hj9h]h void *addr}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj9ubji)}(hhh]h)}(hCPU address of bufferh]hCPU address of buffer}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hMhj9ubah}(h]h ]h"]h$]h&]uh1jhhj9ubeh}(h]h ]h"]h$]h&]uh1jHhj9hMhj'9ubjI)}(h)``dma_addr_t dma`` DMA address of buffer h](jO)}(h``dma_addr_t dma``h]j)}(hj9h]hdma_addr_t dma}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj9ubji)}(hhh]h)}(hDMA address of bufferh]hDMA address of buffer}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hMhj9ubah}(h]h ]h"]h$]h&]uh1jhhj9ubeh}(h]h ]h"]h$]h&]uh1jHhj9hMhj'9ubeh}(h]h ]h"]h$]h&]uh1jChj 9ubh)}(h**Description**h]j.)}(hj:h]h Description}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj:ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj 9ubh)}(hThis reclaims an I/O buffer, letting it be reused. The memory must have been allocated using usb_alloc_coherent(), and the parameters must match those provided in that allocation request.h]hThis reclaims an I/O buffer, letting it be reused. The memory must have been allocated using usb_alloc_coherent(), and the parameters must match those provided in that allocation request.}(hj,:hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj 9ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j+usb_core.usb_alloc_noncoherent (C function) c.usb_core.usb_alloc_noncoherenthNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hvoid * usb_alloc_noncoherent (struct usb_device *dev, size_t size, gfp_t mem_flags, dma_addr_t *dma, enum dma_data_direction dir, struct sg_table **table)h]j+)}(hvoid *usb_alloc_noncoherent(struct usb_device *dev, size_t size, gfp_t mem_flags, dma_addr_t *dma, enum dma_data_direction dir, struct sg_table **table)h](jT)}(hvoidh]hvoid}(hj[:hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjW:hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMubjC)}(h h]h }(hjj:hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjW:hhhji:hMubjs)}(hjvh]h*}(hjx:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjW:hhhji:hMubj)}(husb_alloc_noncoherenth]j)}(husb_alloc_noncoherenth]husb_alloc_noncoherent}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjW:hhhji:hMubj)}(h}(struct usb_device *dev, size_t size, gfp_t mem_flags, dma_addr_t *dma, enum dma_data_direction dir, struct sg_table **table)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hj:hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj:ubjC)}(h h]h }(hj:hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj:ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj:modnameN classnameNjLjO)}jR](jNjU)}jHj:sb c.usb_core.usb_alloc_noncoherentesbuh1hhj:ubjC)}(h h]h }(hj:hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj:ubjs)}(hjvh]h*}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj:ubj)}(hdevh]hdev}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubj)}(h size_t sizeh](h)}(hhh]j)}(hsize_th]hsize_t}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj;modnameN classnameNjLjO)}jR](jNj: c.usb_core.usb_alloc_noncoherentesbuh1hhj;ubjC)}(h h]h }(hj:;hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj;ubj)}(hsizeh]hsize}(hjH;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubj)}(hgfp_t mem_flagsh](h)}(hhh]j)}(hgfp_th]hgfp_t}(hjd;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhja;ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjf;modnameN classnameNjLjO)}jR](jNj: c.usb_core.usb_alloc_noncoherentesbuh1hhj];ubjC)}(h h]h }(hj;hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj];ubj)}(h mem_flagsh]h mem_flags}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj];ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubj)}(hdma_addr_t *dmah](h)}(hhh]j)}(h dma_addr_th]h dma_addr_t}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj;modnameN classnameNjLjO)}jR](jNj: c.usb_core.usb_alloc_noncoherentesbuh1hhj;ubjC)}(h h]h }(hj;hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj;ubjs)}(hjvh]h*}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj;ubj)}(hdmah]hdma}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubj)}(henum dma_data_direction dirh](j1)}(hjh]henum}(hj<hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj;ubjC)}(h h]h }(hj <hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj;ubh)}(hhh]j)}(hdma_data_directionh]hdma_data_direction}(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj <modnameN classnameNjLjO)}jR](jNj: c.usb_core.usb_alloc_noncoherentesbuh1hhj;ubjC)}(h h]h }(hj=<hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj;ubj)}(hdirh]hdir}(hjK<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubj)}(hstruct sg_table **tableh](j1)}(hjh]hstruct}(hjd<hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj`<ubjC)}(h h]h }(hjq<hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj`<ubh)}(hhh]j)}(hsg_tableh]hsg_table}(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj<modnameN classnameNjLjO)}jR](jNj: c.usb_core.usb_alloc_noncoherentesbuh1hhj`<ubjC)}(h h]h }(hj<hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj`<ubjs)}(hjvh]h*}(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj`<ubjs)}(hjvh]h*}(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj`<ubj)}(htableh]htable}(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`<ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:ubeh}(h]h ]h"]h$]h&]jjuh1jhjW:hhhji:hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjS:hhhji:hMubah}(h]jN:ah ](jjeh"]h$]h&]jj)jhuh1j$hji:hMhjP:hhubj)}(hhh]h)}(h6allocate dma-noncoherent buffer for URB_NO_xxx_DMA_MAPh]h6allocate dma-noncoherent buffer for URB_NO_xxx_DMA_MAP}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj<hhubah}(h]h ]h"]h$]h&]uh1jhjP:hhhji:hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj =jj =j j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *dev`` device the buffer will be used with ``size_t size`` requested buffer size ``gfp_t mem_flags`` affect whether allocation may block ``dma_addr_t *dma`` used to return DMA address of buffer ``enum dma_data_direction dir`` DMA transfer direction ``struct sg_table **table`` used to return sg_table of allocated memory **Description** To explicit manage the memory ownership for the kernel vs the device by USB core, the user needs save sg_table to urb->sgt. Then USB core will do DMA sync for CPU and device properly. When the buffer is no longer used, free it with usb_free_noncoherent(). **Return** Either null (indicating no buffer could be allocated), or the cpu-space pointer to a buffer that may be used to perform DMA to the specified device. Such cpu-space buffers are returned along with the DMA address (through the pointer provided).h](h)}(h**Parameters**h]j.)}(hj=h]h Parameters}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj=ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj=ubjD)}(hhh](jI)}(h?``struct usb_device *dev`` device the buffer will be used with h](jO)}(h``struct usb_device *dev``h]j)}(hj4=h]hstruct usb_device *dev}(hj6=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2=ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj.=ubji)}(hhh]h)}(h#device the buffer will be used withh]h#device the buffer will be used with}(hjM=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjI=hMhjJ=ubah}(h]h ]h"]h$]h&]uh1jhhj.=ubeh}(h]h ]h"]h$]h&]uh1jHhjI=hMhj+=ubjI)}(h&``size_t size`` requested buffer size h](jO)}(h``size_t size``h]j)}(hjm=h]h size_t size}(hjo=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjk=ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjg=ubji)}(hhh]h)}(hrequested buffer sizeh]hrequested buffer size}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hMhj=ubah}(h]h ]h"]h$]h&]uh1jhhjg=ubeh}(h]h ]h"]h$]h&]uh1jHhj=hMhj+=ubjI)}(h8``gfp_t mem_flags`` affect whether allocation may block h](jO)}(h``gfp_t mem_flags``h]j)}(hj=h]hgfp_t mem_flags}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj=ubji)}(hhh]h)}(h#affect whether allocation may blockh]h#affect whether allocation may block}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hMhj=ubah}(h]h ]h"]h$]h&]uh1jhhj=ubeh}(h]h ]h"]h$]h&]uh1jHhj=hMhj+=ubjI)}(h9``dma_addr_t *dma`` used to return DMA address of buffer h](jO)}(h``dma_addr_t *dma``h]j)}(hj=h]hdma_addr_t *dma}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj=ubji)}(hhh]h)}(h$used to return DMA address of bufferh]h$used to return DMA address of buffer}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hMhj=ubah}(h]h ]h"]h$]h&]uh1jhhj=ubeh}(h]h ]h"]h$]h&]uh1jHhj=hMhj+=ubjI)}(h7``enum dma_data_direction dir`` DMA transfer direction h](jO)}(h``enum dma_data_direction dir``h]j)}(hj>h]henum dma_data_direction dir}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj>ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj>ubji)}(hhh]h)}(hDMA transfer directionh]hDMA transfer direction}(hj1>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj->hMhj.>ubah}(h]h ]h"]h$]h&]uh1jhhj>ubeh}(h]h ]h"]h$]h&]uh1jHhj->hMhj+=ubjI)}(hH``struct sg_table **table`` used to return sg_table of allocated memory h](jO)}(h``struct sg_table **table``h]j)}(hjQ>h]hstruct sg_table **table}(hjS>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjO>ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjK>ubji)}(hhh]h)}(h+used to return sg_table of allocated memoryh]h+used to return sg_table of allocated memory}(hjj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjf>hMhjg>ubah}(h]h ]h"]h$]h&]uh1jhhjK>ubeh}(h]h ]h"]h$]h&]uh1jHhjf>hMhj+=ubeh}(h]h ]h"]h$]h&]uh1jChj=ubh)}(h**Description**h]j.)}(hj>h]h Description}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj>ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj=ubh)}(hTo explicit manage the memory ownership for the kernel vs the device by USB core, the user needs save sg_table to urb->sgt. Then USB core will do DMA sync for CPU and device properly.h]hTo explicit manage the memory ownership for the kernel vs the device by USB core, the user needs save sg_table to urb->sgt. Then USB core will do DMA sync for CPU and device properly.}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj=ubh)}(hGWhen the buffer is no longer used, free it with usb_free_noncoherent().h]hGWhen the buffer is no longer used, free it with usb_free_noncoherent().}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj=ubh)}(h **Return**h]j.)}(hj>h]hReturn}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj>ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj=ubh)}(hEither null (indicating no buffer could be allocated), or the cpu-space pointer to a buffer that may be used to perform DMA to the specified device. Such cpu-space buffers are returned along with the DMA address (through the pointer provided).h]hEither null (indicating no buffer could be allocated), or the cpu-space pointer to a buffer that may be used to perform DMA to the specified device. Such cpu-space buffers are returned along with the DMA address (through the pointer provided).}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhj=ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j*usb_core.usb_free_noncoherent (C function)c.usb_core.usb_free_noncoherenthNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hvoid usb_free_noncoherent (struct usb_device *dev, size_t size, void *addr, enum dma_data_direction dir, struct sg_table *table)h]j+)}(hvoid usb_free_noncoherent(struct usb_device *dev, size_t size, void *addr, enum dma_data_direction dir, struct sg_table *table)h](jT)}(hvoidh]hvoid}(hj?hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj?hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMAubjC)}(h h]h }(hj?hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj?hhhj?hMAubj)}(husb_free_noncoherenth]j)}(husb_free_noncoherenth]husb_free_noncoherent}(hj(?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj$?ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj?hhhj?hMAubj)}(hf(struct usb_device *dev, size_t size, void *addr, enum dma_data_direction dir, struct sg_table *table)h](j)}(hstruct usb_device *devh](j1)}(hjh]hstruct}(hjD?hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj@?ubjC)}(h h]h }(hjQ?hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj@?ubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjb?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_?ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjd?modnameN classnameNjLjO)}jR](jNjU)}jHj*?sbc.usb_core.usb_free_noncoherentesbuh1hhj@?ubjC)}(h h]h }(hj?hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj@?ubjs)}(hjvh]h*}(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj@?ubj)}(hdevh]hdev}(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@?ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj@ubjC)}(h h]h }(hjO@hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj>@ubh)}(hhh]j)}(hdma_data_directionh]hdma_data_direction}(hj`@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]@ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjb@modnameN classnameNjLjO)}jR](jNj?c.usb_core.usb_free_noncoherentesbuh1hhj>@ubjC)}(h h]h }(hj@hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj>@ubj)}(hdirh]hdir}(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>@ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjhhhj?hMAubah}(h]j>ah ](jjeh"]h$]h&]jj)jhuh1j$hj?hMAhj>hhubj)}(hhh]h)}(h2free memory allocated with usb_alloc_noncoherent()h]h2free memory allocated with usb_alloc_noncoherent()}(hj(AhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMAhj%Ahhubah}(h]h ]h"]h$]h&]uh1jhj>hhhj?hMAubeh}(h]h ](jfunctioneh"]h$]h&]jjjj@Ajj@Aj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *dev`` device the buffer was used with ``size_t size`` requested buffer size ``void *addr`` CPU address of buffer ``enum dma_data_direction dir`` DMA transfer direction ``struct sg_table *table`` describe the allocated and DMA mapped memory, **Description** This reclaims an I/O buffer, letting it be reused. The memory must have been allocated using usb_alloc_noncoherent(), and the parameters must match those provided in that allocation request.h](h)}(h**Parameters**h]j.)}(hjJAh]h Parameters}(hjLAhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjHAubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMEhjDAubjD)}(hhh](jI)}(h;``struct usb_device *dev`` device the buffer was used with h](jO)}(h``struct usb_device *dev``h]j)}(hjiAh]hstruct usb_device *dev}(hjkAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgAubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMBhjcAubji)}(hhh]h)}(hdevice the buffer was used withh]hdevice the buffer was used with}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~AhMBhjAubah}(h]h ]h"]h$]h&]uh1jhhjcAubeh}(h]h ]h"]h$]h&]uh1jHhj~AhMBhj`AubjI)}(h&``size_t size`` requested buffer size h](jO)}(h``size_t size``h]j)}(hjAh]h size_t size}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMChjAubji)}(hhh]h)}(hrequested buffer sizeh]hrequested buffer size}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhMChjAubah}(h]h ]h"]h$]h&]uh1jhhjAubeh}(h]h ]h"]h$]h&]uh1jHhjAhMChj`AubjI)}(h%``void *addr`` CPU address of buffer h](jO)}(h``void *addr``h]j)}(hjAh]h void *addr}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMDhjAubji)}(hhh]h)}(hCPU address of bufferh]hCPU address of buffer}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhMDhjAubah}(h]h ]h"]h$]h&]uh1jhhjAubeh}(h]h ]h"]h$]h&]uh1jHhjAhMDhj`AubjI)}(h7``enum dma_data_direction dir`` DMA transfer direction h](jO)}(h``enum dma_data_direction dir``h]j)}(hjBh]henum dma_data_direction dir}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMEhjBubji)}(hhh]h)}(hDMA transfer directionh]hDMA transfer direction}(hj-BhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)BhMEhj*Bubah}(h]h ]h"]h$]h&]uh1jhhjBubeh}(h]h ]h"]h$]h&]uh1jHhj)BhMEhj`AubjI)}(hI``struct sg_table *table`` describe the allocated and DMA mapped memory, h](jO)}(h``struct sg_table *table``h]j)}(hjMBh]hstruct sg_table *table}(hjOBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjKBubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMFhjGBubji)}(hhh]h)}(h-describe the allocated and DMA mapped memory,h]h-describe the allocated and DMA mapped memory,}(hjfBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjbBhMFhjcBubah}(h]h ]h"]h$]h&]uh1jhhjGBubeh}(h]h ]h"]h$]h&]uh1jHhjbBhMFhj`Aubeh}(h]h ]h"]h$]h&]uh1jChjDAubh)}(h**Description**h]j.)}(hjBh]h Description}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjBubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMHhjDAubh)}(hThis reclaims an I/O buffer, letting it be reused. The memory must have been allocated using usb_alloc_noncoherent(), and the parameters must match those provided in that allocation request.h]hThis reclaims an I/O buffer, letting it be reused. The memory must have been allocated using usb_alloc_noncoherent(), and the parameters must match those provided in that allocation request.}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMGhjDAubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j7usb_core.usb_endpoint_max_periodic_payload (C function),c.usb_core.usb_endpoint_max_periodic_payloadhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hcu32 usb_endpoint_max_periodic_payload (struct usb_device *udev, const struct usb_host_endpoint *ep)h]j+)}(hbu32 usb_endpoint_max_periodic_payload(struct usb_device *udev, const struct usb_host_endpoint *ep)h](h)}(hhh]j)}(hu32h]hu32}(hjBhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjBmodnameN classnameNjLjO)}jR](jNjU)}jH!usb_endpoint_max_periodic_payloadsb,c.usb_core.usb_endpoint_max_periodic_payloadesbuh1hhjBhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM^ubjC)}(h h]h }(hjBhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjBhhhjBhM^ubj)}(h!usb_endpoint_max_periodic_payloadh]j)}(hjBh]h!usb_endpoint_max_periodic_payload}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCubah}(h]h ](jjeh"]h$]h&]jjuh1jhjBhhhjBhM^ubj)}(h=(struct usb_device *udev, const struct usb_host_endpoint *ep)h](j)}(hstruct usb_device *udevh](j1)}(hjh]hstruct}(hj ChhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjCubjC)}(h h]h }(hj-ChhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjCubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj>ChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;Cubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj@CmodnameN classnameNjLjO)}jR](jNjB,c.usb_core.usb_endpoint_max_periodic_payloadesbuh1hhjCubjC)}(h h]h }(hj]ChhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjCubjs)}(hjvh]h*}(hjkChhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjCubj)}(hudevh]hudev}(hjxChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjCubj)}(h"const struct usb_host_endpoint *eph](j1)}(hj4h]hconst}(hjChhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjCubjC)}(h h]h }(hjChhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjCubj1)}(hjh]hstruct}(hjChhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjCubjC)}(h h]h }(hjChhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjCubh)}(hhh]j)}(husb_host_endpointh]husb_host_endpoint}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjCmodnameN classnameNjLjO)}jR](jNjB,c.usb_core.usb_endpoint_max_periodic_payloadesbuh1hhjCubjC)}(h h]h }(hjChhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjCubjs)}(hjvh]h*}(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjCubj)}(heph]hep}(hjDhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjCubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjCubeh}(h]h ]h"]h$]h&]jjuh1jhjBhhhjBhM^ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjBhhhjBhM^ubah}(h]jBah ](jjeh"]h$]h&]jj)jhuh1j$hjBhM^hjBhhubj)}(hhh]h)}(h.Get maximum payload bytes per service intervalh]h.Get maximum payload bytes per service interval}(hj.DhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM^hj+Dhhubah}(h]h ]h"]h$]h&]uh1jhjBhhhjBhM^ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjFDjjFDj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *udev`` The USB device ``const struct usb_host_endpoint *ep`` The endpoint **Return** the maximum number of bytes isochronous or interrupt endpoint **ep** can transfer during a service interval, or 0 for other endpoints.h](h)}(h**Parameters**h]j.)}(hjPDh]h Parameters}(hjRDhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjNDubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMbhjJDubjD)}(hhh](jI)}(h+``struct usb_device *udev`` The USB device h](jO)}(h``struct usb_device *udev``h]j)}(hjoDh]hstruct usb_device *udev}(hjqDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmDubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM`hjiDubji)}(hhh]h)}(hThe USB deviceh]hThe USB device}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhM`hjDubah}(h]h ]h"]h$]h&]uh1jhhjiDubeh}(h]h ]h"]h$]h&]uh1jHhjDhM`hjfDubjI)}(h4``const struct usb_host_endpoint *ep`` The endpoint h](jO)}(h&``const struct usb_host_endpoint *ep``h]j)}(hjDh]h"const struct usb_host_endpoint *ep}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMahjDubji)}(hhh]h)}(h The endpointh]h The endpoint}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhMahjDubah}(h]h ]h"]h$]h&]uh1jhhjDubeh}(h]h ]h"]h$]h&]uh1jHhjDhMahjfDubeh}(h]h ]h"]h$]h&]uh1jChjJDubh)}(h **Return**h]j.)}(hjDh]hReturn}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjDubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMchjJDubh)}(hthe maximum number of bytes isochronous or interrupt endpoint **ep** can transfer during a service interval, or 0 for other endpoints.h](h>the maximum number of bytes isochronous or interrupt endpoint }(hjDhhhNhNubj.)}(h**ep**h]hep}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjDubhB can transfer during a service interval, or 0 for other endpoints.}(hjDhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMchjJDubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j4usb_core.usb_endpoint_is_hs_isoc_double (C function))c.usb_core.usb_endpoint_is_hs_isoc_doublehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(habool usb_endpoint_is_hs_isoc_double (struct usb_device *udev, const struct usb_host_endpoint *ep)h]j+)}(h`bool usb_endpoint_is_hs_isoc_double(struct usb_device *udev, const struct usb_host_endpoint *ep)h](jT)}(hjh]hbool}(hj:EhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj6EhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM}ubjC)}(h h]h }(hjHEhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj6EhhhjGEhM}ubj)}(husb_endpoint_is_hs_isoc_doubleh]j)}(husb_endpoint_is_hs_isoc_doubleh]husb_endpoint_is_hs_isoc_double}(hjZEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVEubah}(h]h ](jjeh"]h$]h&]jjuh1jhj6EhhhjGEhM}ubj)}(h=(struct usb_device *udev, const struct usb_host_endpoint *ep)h](j)}(hstruct usb_device *udevh](j1)}(hjh]hstruct}(hjvEhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjrEubjC)}(h h]h }(hjEhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjrEubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjEmodnameN classnameNjLjO)}jR](jNjU)}jHj\Esb)c.usb_core.usb_endpoint_is_hs_isoc_doubleesbuh1hhjrEubjC)}(h h]h }(hjEhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjrEubjs)}(hjvh]h*}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjrEubj)}(hudevh]hudev}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrEubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjnEubj)}(h"const struct usb_host_endpoint *eph](j1)}(hj4h]hconst}(hjEhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjEubjC)}(h h]h }(hjEhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjEubj1)}(hjh]hstruct}(hjFhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjEubjC)}(h h]h }(hjFhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjEubh)}(hhh]j)}(husb_host_endpointh]husb_host_endpoint}(hj"FhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj$FmodnameN classnameNjLjO)}jR](jNjE)c.usb_core.usb_endpoint_is_hs_isoc_doubleesbuh1hhjEubjC)}(h h]h }(hjAFhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjEubjs)}(hjvh]h*}(hjOFhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjEubj)}(heph]hep}(hj\FhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjnEubeh}(h]h ]h"]h$]h&]jjuh1jhj6EhhhjGEhM}ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj2EhhhjGEhM}ubah}(h]j-Eah ](jjeh"]h$]h&]jj)jhuh1j$hjGEhM}hj/Ehhubj)}(hhh]h)}(hCTell whether an endpoint uses USB 2 Isochronous Double IN Bandwidthh]hCTell whether an endpoint uses USB 2 Isochronous Double IN Bandwidth}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chM}hjFhhubah}(h]h ]h"]h$]h&]uh1jhj/EhhhjGEhM}ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjFjjFj j!j"uh1jhhhjrhNhNubj$)}(h**Parameters** ``struct usb_device *udev`` The USB device ``const struct usb_host_endpoint *ep`` The endpoint **Return** true if an endpoint **ep** conforms to USB 2 Isochronous Double IN Bandwidth ECN, false otherwise.h](h)}(h**Parameters**h]j.)}(hjFh]h Parameters}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjFubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjFubjD)}(hhh](jI)}(h+``struct usb_device *udev`` The USB device h](jO)}(h``struct usb_device *udev``h]j)}(hjFh]hstruct usb_device *udev}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjFubji)}(hhh]h)}(hThe USB deviceh]hThe USB device}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhMhjFubah}(h]h ]h"]h$]h&]uh1jhhjFubeh}(h]h ]h"]h$]h&]uh1jHhjFhMhjFubjI)}(h4``const struct usb_host_endpoint *ep`` The endpoint h](jO)}(h&``const struct usb_host_endpoint *ep``h]j)}(hjGh]h"const struct usb_host_endpoint *ep}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjFubji)}(hhh]h)}(h The endpointh]h The endpoint}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjGhMhjGubah}(h]h ]h"]h$]h&]uh1jhhjFubeh}(h]h ]h"]h$]h&]uh1jHhjGhMhjFubeh}(h]h ]h"]h$]h&]uh1jChjFubh)}(h **Return**h]j.)}(hj;Gh]hReturn}(hj=GhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj9Gubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjFubh)}(hbtrue if an endpoint **ep** conforms to USB 2 Isochronous Double IN Bandwidth ECN, false otherwise.h](htrue if an endpoint }(hjQGhhhNhNubj.)}(h**ep**h]hep}(hjYGhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjQGubhH conforms to USB 2 Isochronous Double IN Bandwidth ECN, false otherwise.}(hjQGhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:174: ./drivers/usb/core/usb.chMhjFubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_core.usb_hub_clear_tt_buffer (C function)"c.usb_core.usb_hub_clear_tt_bufferhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h-int usb_hub_clear_tt_buffer (struct urb *urb)h]j+)}(h,int usb_hub_clear_tt_buffer(struct urb *urb)h](jT)}(hinth]hint}(hjGhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjGhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMubjC)}(h h]h }(hjGhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjGhhhjGhMubj)}(husb_hub_clear_tt_bufferh]j)}(husb_hub_clear_tt_bufferh]husb_hub_clear_tt_buffer}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGubah}(h]h ](jjeh"]h$]h&]jjuh1jhjGhhhjGhMubj)}(h(struct urb *urb)h]j)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjGhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjGubjC)}(h h]h }(hjGhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjGubh)}(hhh]j)}(hurbh]hurb}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjGmodnameN classnameNjLjO)}jR](jNjU)}jHjGsb"c.usb_core.usb_hub_clear_tt_bufferesbuh1hhjGubjC)}(h h]h }(hjHhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjGubjs)}(hjvh]h*}(hjHhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjGubj)}(hurbh]hurb}(hj)HhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjGubah}(h]h ]h"]h$]h&]jjuh1jhjGhhhjGhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjGhhhjGhMubah}(h]jGah ](jjeh"]h$]h&]jj)jhuh1j$hjGhMhjGhhubj)}(hhh]h)}(h-clear control/bulk TT state in high speed hubh]h-clear control/bulk TT state in high speed hub}(hjSHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjPHhhubah}(h]h ]h"]h$]h&]uh1jhjGhhhjGhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjkHjjkHj j!j"uh1jhhhjrhNhNubj$)}(hX+**Parameters** ``struct urb *urb`` an URB associated with the failed or incomplete split transaction **Description** High speed HCDs use this to tell the hub driver that some split control or bulk transaction failed in a way that requires clearing internal state of a transaction translator. This is normally detected (and reported) from interrupt context. It may not be possible for that hub to handle additional full (or low) speed transactions until that state is fully cleared out. **Return** 0 if successful. A negative error code otherwise.h](h)}(h**Parameters**h]j.)}(hjuHh]h Parameters}(hjwHhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjsHubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjoHubjD)}(hhh]jI)}(hV``struct urb *urb`` an URB associated with the failed or incomplete split transaction h](jO)}(h``struct urb *urb``h]j)}(hjHh]hstruct urb *urb}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjHubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjHubji)}(hhh]h)}(hAan URB associated with the failed or incomplete split transactionh]hAan URB associated with the failed or incomplete split transaction}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHhMhjHubah}(h]h ]h"]h$]h&]uh1jhhjHubeh}(h]h ]h"]h$]h&]uh1jHhjHhMhjHubah}(h]h ]h"]h$]h&]uh1jChjoHubh)}(h**Description**h]j.)}(hjHh]h Description}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjHubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjoHubh)}(hHigh speed HCDs use this to tell the hub driver that some split control or bulk transaction failed in a way that requires clearing internal state of a transaction translator. This is normally detected (and reported) from interrupt context.h]hHigh speed HCDs use this to tell the hub driver that some split control or bulk transaction failed in a way that requires clearing internal state of a transaction translator. This is normally detected (and reported) from interrupt context.}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjoHubh)}(hIt may not be possible for that hub to handle additional full (or low) speed transactions until that state is fully cleared out.h]hIt may not be possible for that hub to handle additional full (or low) speed transactions until that state is fully cleared out.}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjoHubh)}(h **Return**h]j.)}(hjIh]hReturn}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjIubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjoHubh)}(h10 if successful. A negative error code otherwise.h]h10 if successful. A negative error code otherwise.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjoHubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j*usb_core.usb_set_device_state (C function)c.usb_core.usb_set_device_statehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hTvoid usb_set_device_state (struct usb_device *udev, enum usb_device_state new_state)h]j+)}(hSvoid usb_set_device_state(struct usb_device *udev, enum usb_device_state new_state)h](jT)}(hvoidh]hvoid}(hjJIhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjFIhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMubjC)}(h h]h }(hjYIhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjFIhhhjXIhMubj)}(husb_set_device_stateh]j)}(husb_set_device_stateh]husb_set_device_state}(hjkIhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjgIubah}(h]h ](jjeh"]h$]h&]jjuh1jhjFIhhhjXIhMubj)}(h:(struct usb_device *udev, enum usb_device_state new_state)h](j)}(hstruct usb_device *udevh](j1)}(hjh]hstruct}(hjIhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjIubjC)}(h h]h }(hjIhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjIubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjIhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjImodnameN classnameNjLjO)}jR](jNjU)}jHjmIsbc.usb_core.usb_set_device_stateesbuh1hhjIubjC)}(h h]h }(hjIhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjIubjs)}(hjvh]h*}(hjIhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjIubj)}(hudevh]hudev}(hjIhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjIubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjIubj)}(henum usb_device_state new_stateh](j1)}(hjh]henum}(hjIhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjIubjC)}(h h]h }(hjJhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjIubh)}(hhh]j)}(husb_device_stateh]husb_device_state}(hjJhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjJmodnameN classnameNjLjO)}jR](jNjIc.usb_core.usb_set_device_stateesbuh1hhjIubjC)}(h h]h }(hj7JhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjIubj)}(h new_stateh]h new_state}(hjEJhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjIubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjIubeh}(h]h ]h"]h$]h&]jjuh1jhjFIhhhjXIhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjBIhhhjXIhMubah}(h]j=Iah ](jjeh"]h$]h&]jj)jhuh1j$hjXIhMhj?Ihhubj)}(hhh]h)}(h/change a device's current state (usbcore, hcds)h]h1change a device’s current state (usbcore, hcds)}(hjoJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjlJhhubah}(h]h ]h"]h$]h&]uh1jhj?IhhhjXIhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjJjjJj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *udev`` pointer to device whose state should be changed ``enum usb_device_state new_state`` new state value to be stored **Description** udev->state is _not_ fully protected by the device lock. Although most transitions are made only while holding the lock, the state can can change to USB_STATE_NOTATTACHED at almost any time. This is so that devices can be marked as disconnected as soon as possible, without having to wait for any semaphores to be released. As a result, all changes to any device's state must be protected by the device_state_lock spinlock. Once a device has been added to the device tree, all changes to its state should be made using this routine. The state should _not_ be set directly. If udev->state is already USB_STATE_NOTATTACHED then no change is made. Otherwise udev->state is set to new_state, and if new_state is USB_STATE_NOTATTACHED then all of udev's descendants' states are also set to USB_STATE_NOTATTACHED.h](h)}(h**Parameters**h]j.)}(hjJh]h Parameters}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjJubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjJubjD)}(hhh](jI)}(hL``struct usb_device *udev`` pointer to device whose state should be changed h](jO)}(h``struct usb_device *udev``h]j)}(hjJh]hstruct usb_device *udev}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjJubji)}(hhh]h)}(h/pointer to device whose state should be changedh]h/pointer to device whose state should be changed}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhMhjJubah}(h]h ]h"]h$]h&]uh1jhhjJubeh}(h]h ]h"]h$]h&]uh1jHhjJhMhjJubjI)}(hA``enum usb_device_state new_state`` new state value to be stored h](jO)}(h#``enum usb_device_state new_state``h]j)}(hjJh]henum usb_device_state new_state}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjJubji)}(hhh]h)}(hnew state value to be storedh]hnew state value to be stored}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhMhjJubah}(h]h ]h"]h$]h&]uh1jhhjJubeh}(h]h ]h"]h$]h&]uh1jHhjJhMhjJubeh}(h]h ]h"]h$]h&]uh1jChjJubh)}(h**Description**h]j.)}(hj$Kh]h Description}(hj&KhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj"Kubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjJubh)}(hXudev->state is _not_ fully protected by the device lock. Although most transitions are made only while holding the lock, the state can can change to USB_STATE_NOTATTACHED at almost any time. This is so that devices can be marked as disconnected as soon as possible, without having to wait for any semaphores to be released. As a result, all changes to any device's state must be protected by the device_state_lock spinlock.h]hXudev->state is _not_ fully protected by the device lock. Although most transitions are made only while holding the lock, the state can can change to USB_STATE_NOTATTACHED at almost any time. This is so that devices can be marked as disconnected as soon as possible, without having to wait for any semaphores to be released. As a result, all changes to any device’s state must be protected by the device_state_lock spinlock.}(hj:KhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjJubh)}(hOnce a device has been added to the device tree, all changes to its state should be made using this routine. The state should _not_ be set directly.h]hOnce a device has been added to the device tree, all changes to its state should be made using this routine. The state should _not_ be set directly.}(hjIKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjJubh)}(hIf udev->state is already USB_STATE_NOTATTACHED then no change is made. Otherwise udev->state is set to new_state, and if new_state is USB_STATE_NOTATTACHED then all of udev's descendants' states are also set to USB_STATE_NOTATTACHED.h]hIf udev->state is already USB_STATE_NOTATTACHED then no change is made. Otherwise udev->state is set to new_state, and if new_state is USB_STATE_NOTATTACHED then all of udev’s descendants’ states are also set to USB_STATE_NOTATTACHED.}(hjXKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjJubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_core.usb_root_hub_lost_power (C function)"c.usb_core.usb_root_hub_lost_powerhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h7void usb_root_hub_lost_power (struct usb_device *rhdev)h]j+)}(h6void usb_root_hub_lost_power(struct usb_device *rhdev)h](jT)}(hvoidh]hvoid}(hjKhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjKhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMubjC)}(h h]h }(hjKhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjKhhhjKhMubj)}(husb_root_hub_lost_powerh]j)}(husb_root_hub_lost_powerh]husb_root_hub_lost_power}(hjKhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjKubah}(h]h ](jjeh"]h$]h&]jjuh1jhjKhhhjKhMubj)}(h(struct usb_device *rhdev)h]j)}(hstruct usb_device *rhdevh](j1)}(hjh]hstruct}(hjKhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjKubjC)}(h h]h }(hjKhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjKubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjKhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjKubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjKmodnameN classnameNjLjO)}jR](jNjU)}jHjKsb"c.usb_core.usb_root_hub_lost_poweresbuh1hhjKubjC)}(h h]h }(hjLhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjKubjs)}(hjvh]h*}(hjLhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjKubj)}(hrhdevh]hrhdev}(hjLhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjKubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjKubah}(h]h ]h"]h$]h&]jjuh1jhjKhhhjKhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjKhhhjKhMubah}(h]jzKah ](jjeh"]h$]h&]jj)jhuh1j$hjKhMhj|Khhubj)}(hhh]h)}(h-called by HCD if the root hub lost Vbus powerh]h-called by HCD if the root hub lost Vbus power}(hjHLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjELhhubah}(h]h ]h"]h$]h&]uh1jhj|KhhhjKhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj`Ljj`Lj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *rhdev`` struct usb_device for the root hub **Description** The USB host controller driver calls this function when its root hub is resumed and Vbus power has been interrupted or the controller has been reset. The routine marks **rhdev** as having lost power. When the hub driver is resumed it will take notice and carry out power-session recovery for all the "USB-PERSIST"-enabled child devices; the others will be disconnected.h](h)}(h**Parameters**h]j.)}(hjjLh]h Parameters}(hjlLhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjhLubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjdLubjD)}(hhh]jI)}(h@``struct usb_device *rhdev`` struct usb_device for the root hub h](jO)}(h``struct usb_device *rhdev``h]j)}(hjLh]hstruct usb_device *rhdev}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjLubji)}(hhh]h)}(h"struct usb_device for the root hubh]h"struct usb_device for the root hub}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLhMhjLubah}(h]h ]h"]h$]h&]uh1jhhjLubeh}(h]h ]h"]h$]h&]uh1jHhjLhMhjLubah}(h]h ]h"]h$]h&]uh1jChjdLubh)}(h**Description**h]j.)}(hjLh]h Description}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjLubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjdLubh)}(hXrThe USB host controller driver calls this function when its root hub is resumed and Vbus power has been interrupted or the controller has been reset. The routine marks **rhdev** as having lost power. When the hub driver is resumed it will take notice and carry out power-session recovery for all the "USB-PERSIST"-enabled child devices; the others will be disconnected.h](hThe USB host controller driver calls this function when its root hub is resumed and Vbus power has been interrupted or the controller has been reset. The routine marks }(hjLhhhNhNubj.)}(h **rhdev**h]hrhdev}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjLubh as having lost power. When the hub driver is resumed it will take notice and carry out power-session recovery for all the “USB-PERSIST”-enabled child devices; the others will be disconnected.}(hjLhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjdLubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&usb_core.usb_reset_device (C function)c.usb_core.usb_reset_devicehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h.int usb_reset_device (struct usb_device *udev)h]j+)}(h-int usb_reset_device(struct usb_device *udev)h](jT)}(hinth]hint}(hjMhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjMhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMubjC)}(h h]h }(hj*MhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjMhhhj)MhMubj)}(husb_reset_deviceh]j)}(husb_reset_deviceh]husb_reset_device}(hjMsbc.usb_core.usb_reset_deviceesbuh1hhjTMubjC)}(h h]h }(hjMhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjTMubjs)}(hjvh]h*}(hjMhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjTMubj)}(hudevh]hudev}(hjMhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTMubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjPMubah}(h]h ]h"]h$]h&]jjuh1jhjMhhhj)MhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjMhhhj)MhMubah}(h]jMah ](jjeh"]h$]h&]jj)jhuh1j$hj)MhMhjMhhubj)}(hhh]h)}(h3warn interface drivers and perform a USB port reseth]h3warn interface drivers and perform a USB port reset}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMhhubah}(h]h ]h"]h$]h&]uh1jhjMhhhj)MhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjMjjMj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_device *udev`` device to reset (not in NOTATTACHED state) **Description** Warns all drivers bound to registered interfaces (using their pre_reset method), performs the port reset, and then lets the drivers know that the reset is over (using their post_reset method). **Return** The same as for usb_reset_and_verify_device(). However, if a reset is already in progress (for instance, if a driver doesn't have pre_reset() or post_reset() callbacks, and while being unbound or re-bound during the ongoing reset its disconnect() or probe() routine tries to perform a second, nested reset), the routine returns -EINPROGRESS. **Note** The caller must own the device lock. For example, it's safe to use this from a driver probe() routine after downloading new firmware. For calls that might not occur during probe(), drivers should lock the device using usb_lock_device_for_reset(). If an interface is currently being probed or disconnected, we assume its driver knows how to handle resets. For all other interfaces, if the driver doesn't have pre_reset and post_reset methods then we attempt to unbind it and rebind afterward.h](h)}(h**Parameters**h]j.)}(hjMh]h Parameters}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjMubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMubjD)}(hhh]jI)}(hG``struct usb_device *udev`` device to reset (not in NOTATTACHED state) h](jO)}(h``struct usb_device *udev``h]j)}(hjNh]hstruct usb_device *udev}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjNubji)}(hhh]h)}(h*device to reset (not in NOTATTACHED state)h]h*device to reset (not in NOTATTACHED state)}(hj6NhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2NhMhj3Nubah}(h]h ]h"]h$]h&]uh1jhhjNubeh}(h]h ]h"]h$]h&]uh1jHhj2NhMhjNubah}(h]h ]h"]h$]h&]uh1jChjMubh)}(h**Description**h]j.)}(hjXNh]h Description}(hjZNhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjVNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMubh)}(hWarns all drivers bound to registered interfaces (using their pre_reset method), performs the port reset, and then lets the drivers know that the reset is over (using their post_reset method).h]hWarns all drivers bound to registered interfaces (using their pre_reset method), performs the port reset, and then lets the drivers know that the reset is over (using their post_reset method).}(hjnNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMubh)}(h **Return**h]j.)}(hjNh]hReturn}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj}Nubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMubh)}(hXUThe same as for usb_reset_and_verify_device(). However, if a reset is already in progress (for instance, if a driver doesn't have pre_reset() or post_reset() callbacks, and while being unbound or re-bound during the ongoing reset its disconnect() or probe() routine tries to perform a second, nested reset), the routine returns -EINPROGRESS.h]hXWThe same as for usb_reset_and_verify_device(). However, if a reset is already in progress (for instance, if a driver doesn’t have pre_reset() or post_reset() callbacks, and while being unbound or re-bound during the ongoing reset its disconnect() or probe() routine tries to perform a second, nested reset), the routine returns -EINPROGRESS.}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMubh)}(h**Note**h]j.)}(hjNh]hNote}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMubh)}(hThe caller must own the device lock. For example, it's safe to use this from a driver probe() routine after downloading new firmware. For calls that might not occur during probe(), drivers should lock the device using usb_lock_device_for_reset().h]hThe caller must own the device lock. For example, it’s safe to use this from a driver probe() routine after downloading new firmware. For calls that might not occur during probe(), drivers should lock the device using usb_lock_device_for_reset().}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMubh)}(hIf an interface is currently being probed or disconnected, we assume its driver knows how to handle resets. For all other interfaces, if the driver doesn't have pre_reset and post_reset methods then we attempt to unbind it and rebind afterward.h]hIf an interface is currently being probed or disconnected, we assume its driver knows how to handle resets. For all other interfaces, if the driver doesn’t have pre_reset and post_reset methods then we attempt to unbind it and rebind afterward.}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhjMubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j,usb_core.usb_queue_reset_device (C function)!c.usb_core.usb_queue_reset_devicehNtauh1jhjrhhhNhNubj )}(hhh](j%)}(h9void usb_queue_reset_device (struct usb_interface *iface)h]j+)}(h8void usb_queue_reset_device(struct usb_interface *iface)h](jT)}(hvoidh]hvoid}(hjNhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjNhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chM?ubjC)}(h h]h }(hj OhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjNhhhjOhM?ubj)}(husb_queue_reset_deviceh]j)}(husb_queue_reset_deviceh]husb_queue_reset_device}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjOubah}(h]h ](jjeh"]h$]h&]jjuh1jhjNhhhjOhM?ubj)}(h(struct usb_interface *iface)h]j)}(hstruct usb_interface *ifaceh](j1)}(hjh]hstruct}(hj7OhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj3OubjC)}(h h]h }(hjDOhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj3Oubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjUOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjROubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjWOmodnameN classnameNjLjO)}jR](jNjU)}jHjOsb!c.usb_core.usb_queue_reset_deviceesbuh1hhj3OubjC)}(h h]h }(hjvOhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj3Oubjs)}(hjvh]h*}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj3Oubj)}(hifaceh]hiface}(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3Oubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj/Oubah}(h]h ]h"]h$]h&]jjuh1jhjNhhhjOhM?ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjNhhhjOhM?ubah}(h]jNah ](jjeh"]h$]h&]jj)jhuh1j$hjOhM?hjNhhubj)}(hhh]h)}(h)Reset a USB device from an atomic contexth]h)Reset a USB device from an atomic context}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chM?hjOhhubah}(h]h ]h"]h$]h&]uh1jhjNhhhjOhM?ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjOjjOj j!j"uh1jhhhjrhNhNubj$)}(hX**Parameters** ``struct usb_interface *iface`` USB interface belonging to the device to reset **Description** This function can be used to reset a USB device from an atomic context, where usb_reset_device() won't work (as it blocks). Doing a reset via this method is functionally equivalent to calling usb_reset_device(), except for the fact that it is delayed to a workqueue. This means that any drivers bound to other interfaces might be unbound, as well as users from usbfs in user space. Corner cases: - Scheduling two resets at the same time from two different drivers attached to two different interfaces of the same device is possible; depending on how the driver attached to each interface handles ->pre_reset(), the second reset might happen or not. - If the reset is delayed so long that the interface is unbound from its driver, the reset will be skipped. - This function can be called during .probe(). It can also be called during .disconnect(), but doing so is pointless because the reset will not occur. If you really want to reset the device during .disconnect(), call usb_reset_device() directly -- but watch out for nested unbinding issues!h](h)}(h**Parameters**h]j.)}(hjOh]h Parameters}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjOubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMChjOubjD)}(hhh]jI)}(hO``struct usb_interface *iface`` USB interface belonging to the device to reset h](jO)}(h``struct usb_interface *iface``h]j)}(hjOh]hstruct usb_interface *iface}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjOubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chM@hjOubji)}(hhh]h)}(h.USB interface belonging to the device to reseth]h.USB interface belonging to the device to reset}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjPhM@hjPubah}(h]h ]h"]h$]h&]uh1jhhjOubeh}(h]h ]h"]h$]h&]uh1jHhjPhM@hjOubah}(h]h ]h"]h$]h&]uh1jChjOubh)}(h**Description**h]j.)}(hj7Ph]h Description}(hj9PhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj5Pubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMBhjOubh)}(h{This function can be used to reset a USB device from an atomic context, where usb_reset_device() won't work (as it blocks).h]h}This function can be used to reset a USB device from an atomic context, where usb_reset_device() won’t work (as it blocks).}(hjMPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMAhjOubh)}(hXDoing a reset via this method is functionally equivalent to calling usb_reset_device(), except for the fact that it is delayed to a workqueue. This means that any drivers bound to other interfaces might be unbound, as well as users from usbfs in user space.h]hXDoing a reset via this method is functionally equivalent to calling usb_reset_device(), except for the fact that it is delayed to a workqueue. This means that any drivers bound to other interfaces might be unbound, as well as users from usbfs in user space.}(hj\PhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMDhjOubh)}(h Corner cases:h]h Corner cases:}(hjkPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMIhjOubj)}(hhh](j)}(hScheduling two resets at the same time from two different drivers attached to two different interfaces of the same device is possible; depending on how the driver attached to each interface handles ->pre_reset(), the second reset might happen or not. h]h)}(hScheduling two resets at the same time from two different drivers attached to two different interfaces of the same device is possible; depending on how the driver attached to each interface handles ->pre_reset(), the second reset might happen or not.h]hScheduling two resets at the same time from two different drivers attached to two different interfaces of the same device is possible; depending on how the driver attached to each interface handles ->pre_reset(), the second reset might happen or not.}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMKhj}Pubah}(h]h ]h"]h$]h&]uh1jhjzPubj)}(hjIf the reset is delayed so long that the interface is unbound from its driver, the reset will be skipped. h]h)}(hiIf the reset is delayed so long that the interface is unbound from its driver, the reset will be skipped.h]hiIf the reset is delayed so long that the interface is unbound from its driver, the reset will be skipped.}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMPhjPubah}(h]h ]h"]h$]h&]uh1jhjzPubj)}(hX"This function can be called during .probe(). It can also be called during .disconnect(), but doing so is pointless because the reset will not occur. If you really want to reset the device during .disconnect(), call usb_reset_device() directly -- but watch out for nested unbinding issues!h]h)}(hX"This function can be called during .probe(). It can also be called during .disconnect(), but doing so is pointless because the reset will not occur. If you really want to reset the device during .disconnect(), call usb_reset_device() directly -- but watch out for nested unbinding issues!h]hX"This function can be called during .probe(). It can also be called during .disconnect(), but doing so is pointless because the reset will not occur. If you really want to reset the device during .disconnect(), call usb_reset_device() directly -- but watch out for nested unbinding issues!}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMShjPubah}(h]h ]h"]h$]h&]uh1jhjzPubeh}(h]h ]h"]h$]h&]jjuh1jhjPhMKhjOubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.usb_hub_find_child (C function)c.usb_core.usb_hub_find_childhNtauh1jhjrhhhNhNubj )}(hhh](j%)}(hKstruct usb_device * usb_hub_find_child (struct usb_device *hdev, int port1)h]j+)}(hIstruct usb_device *usb_hub_find_child(struct usb_device *hdev, int port1)h](j1)}(hjh]hstruct}(hjPhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjPhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMbubjC)}(h h]h }(hjPhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjPhhhjPhMbubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hj QhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj Qubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjQmodnameN classnameNjLjO)}jR](jNjU)}jHusb_hub_find_childsbc.usb_core.usb_hub_find_childesbuh1hhjPhhhjPhMbubjC)}(h h]h }(hj/QhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjPhhhjPhMbubjs)}(hjvh]h*}(hj=QhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjPhhhjPhMbubj)}(husb_hub_find_childh]j)}(hj,Qh]husb_hub_find_child}(hjNQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjJQubah}(h]h ](jjeh"]h$]h&]jjuh1jhjPhhhjPhMbubj)}(h$(struct usb_device *hdev, int port1)h](j)}(hstruct usb_device *hdevh](j1)}(hjh]hstruct}(hjiQhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjeQubjC)}(h h]h }(hjvQhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjeQubh)}(hhh]j)}(h usb_deviceh]h usb_device}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjQmodnameN classnameNjLjO)}jR](jNj*Qc.usb_core.usb_hub_find_childesbuh1hhjeQubjC)}(h h]h }(hjQhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjeQubjs)}(hjvh]h*}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjeQubj)}(hhdevh]hhdev}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeQubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjaQubj)}(h int port1h](jT)}(hinth]hint}(hjQhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjQubjC)}(h h]h }(hjQhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjQubj)}(hport1h]hport1}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjaQubeh}(h]h ]h"]h$]h&]jjuh1jhjPhhhjPhMbubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjPhhhjPhMbubah}(h]jPah ](jjeh"]h$]h&]jj)jhuh1j$hjPhMbhjPhhubj)}(hhh]h)}(hUGet the pointer of child device attached to the port which is specified by **port1**.h](hKGet the pointer of child device attached to the port which is specified by }(hj RhhhNhNubj.)}(h **port1**h]hport1}(hj(RhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj Rubh.}(hj RhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMbhjRhhubah}(h]h ]h"]h$]h&]uh1jhjPhhhjPhMbubeh}(h]h ](jfunctioneh"]h$]h&]jjjjJRjjJRj j!j"uh1jhhhjrhNhNubj$)}(hXU**Parameters** ``struct usb_device *hdev`` USB device belonging to the usb hub ``int port1`` port num to indicate which port the child device is attached to. **Description** USB drivers call this function to get hub's child device pointer. **Return** ``NULL`` if input param is invalid and child's usb_device pointer if non-NULL.h](h)}(h**Parameters**h]j.)}(hjTRh]h Parameters}(hjVRhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjRRubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMfhjNRubjD)}(hhh](jI)}(h@``struct usb_device *hdev`` USB device belonging to the usb hub h](jO)}(h``struct usb_device *hdev``h]j)}(hjsRh]hstruct usb_device *hdev}(hjuRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqRubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMdhjmRubji)}(hhh]h)}(h#USB device belonging to the usb hubh]h#USB device belonging to the usb hub}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhMdhjRubah}(h]h ]h"]h$]h&]uh1jhhjmRubeh}(h]h ]h"]h$]h&]uh1jHhjRhMdhjjRubjI)}(hO``int port1`` port num to indicate which port the child device is attached to. h](jO)}(h ``int port1``h]j)}(hjRh]h int port1}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMfhjRubji)}(hhh]h)}(h@port num to indicate which port the child device is attached to.h]h@port num to indicate which port the child device is attached to.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMehjRubah}(h]h ]h"]h$]h&]uh1jhhjRubeh}(h]h ]h"]h$]h&]uh1jHhjRhMfhjjRubeh}(h]h ]h"]h$]h&]uh1jChjNRubh)}(h**Description**h]j.)}(hjRh]h Description}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjRubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMhhjNRubh)}(hAUSB drivers call this function to get hub's child device pointer.h]hCUSB drivers call this function to get hub’s child device pointer.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMghjNRubh)}(h **Return**h]j.)}(hjSh]hReturn}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj Subah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMjhjNRubh)}(hN``NULL`` if input param is invalid and child's usb_device pointer if non-NULL.h](j)}(h``NULL``h]hNULL}(hj)ShhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%SubhH if input param is invalid and child’s usb_device pointer if non-NULL.}(hj%ShhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:177: ./drivers/usb/core/hub.chMkhjNRubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjrhhhNhNubeh}(h] usb-core-apisah ]h"] usb core apisah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hHost Controller APIsh]hHost Controller APIs}(hjTShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQShhhhhKubh)}(hXzThese APIs are only for use by host controller drivers, most of which implement standard register interfaces such as XHCI, EHCI, OHCI, or UHCI. UHCI was one of the first interfaces, designed by Intel and also used by VIA; it doesn't do much in hardware. OHCI was designed later, to have the hardware do more work (bigger transfers, tracking protocol state, and so on). EHCI was designed with USB 2.0; its design has features that resemble OHCI (hardware does much more work) as well as UHCI (some parts of ISO support, TD list processing). XHCI was designed with USB 3.0. It continues to shift support for functionality into hardware.h]hX|These APIs are only for use by host controller drivers, most of which implement standard register interfaces such as XHCI, EHCI, OHCI, or UHCI. UHCI was one of the first interfaces, designed by Intel and also used by VIA; it doesn’t do much in hardware. OHCI was designed later, to have the hardware do more work (bigger transfers, tracking protocol state, and so on). EHCI was designed with USB 2.0; its design has features that resemble OHCI (hardware does much more work) as well as UHCI (some parts of ISO support, TD list processing). XHCI was designed with USB 3.0. It continues to shift support for functionality into hardware.}(hjbShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjQShhubh)}(hX There are host controllers other than the "big three", although most PCI based controllers (and a few non-PCI based ones) use one of those interfaces. Not all host controllers use DMA; some use PIO, and there is also a simulator and a virtual host controller to pipe USB over the network.h]hX$There are host controllers other than the “big three”, although most PCI based controllers (and a few non-PCI based ones) use one of those interfaces. Not all host controllers use DMA; some use PIO, and there is also a simulator and a virtual host controller to pipe USB over the network.}(hjpShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjQShhubh)}(hXThe same basic APIs are available to drivers for all those controllers. For historical reasons they are in two layers: :c:type:`struct usb_bus ` is a rather thin layer that became available in the 2.2 kernels, while :c:type:`struct usb_hcd ` is a more featureful layer that lets HCDs share common code, to shrink driver size and significantly reduce hcd-specific behaviors.h](hwThe same basic APIs are available to drivers for all those controllers. For historical reasons they are in two layers: }(hj~ShhhNhNubh)}(h":c:type:`struct usb_bus `h]j)}(hjSh]hstruct usb_bus}(hjShhhNhNubah}(h]h ](jdjc-typeeh"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]refdocjd refdomainjreftypetype refexplicitrefwarnjLjO)}jR]jNasbjdusb_busuh1hhhhKhj~SubhH is a rather thin layer that became available in the 2.2 kernels, while }(hj~ShhhNhNubh)}(h":c:type:`struct usb_hcd `h]j)}(hjSh]hstruct usb_hcd}(hjShhhNhNubah}(h]h ](jdjc-typeeh"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]refdocjd refdomainjreftypetype refexplicitrefwarnjLjSjdusb_hcduh1hhhhKhj~Subh is a more featureful layer that lets HCDs share common code, to shrink driver size and significantly reduce hcd-specific behaviors.}(hj~ShhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjQShhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_core.usb_calc_bus_time (C function)c.usb_core.usb_calc_bus_timehNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hIlong usb_calc_bus_time (int speed, int is_input, int isoc, int bytecount)h]j+)}(hHlong usb_calc_bus_time(int speed, int is_input, int isoc, int bytecount)h](jT)}(hlongh]hlong}(hjShhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjShhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMubjC)}(h h]h }(hjShhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjShhhjShMubj)}(husb_calc_bus_timeh]j)}(husb_calc_bus_timeh]husb_calc_bus_time}(hjThhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj Tubah}(h]h ](jjeh"]h$]h&]jjuh1jhjShhhjShMubj)}(h2(int speed, int is_input, int isoc, int bytecount)h](j)}(h int speedh](jT)}(hinth]hint}(hj,ThhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj(TubjC)}(h h]h }(hj:ThhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj(Tubj)}(hspeedh]hspeed}(hjHThhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(Tubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj$Tubj)}(h int is_inputh](jT)}(hinth]hint}(hjaThhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj]TubjC)}(h h]h }(hjoThhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj]Tubj)}(his_inputh]his_input}(hj}ThhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]Tubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj$Tubj)}(hint isoch](jT)}(hinth]hint}(hjThhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjTubjC)}(h h]h }(hjThhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjTubj)}(hisoch]hisoc}(hjThhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj$Tubj)}(h int bytecounth](jT)}(hinth]hint}(hjThhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjTubjC)}(h h]h }(hjThhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjTubj)}(h bytecounth]h bytecount}(hjThhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj$Tubeh}(h]h ]h"]h$]h&]jjuh1jhjShhhjShMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjShhhjShMubah}(h]jSah ](jjeh"]h$]h&]jj)jhuh1j$hjShMhjShhubj)}(hhh]h)}(h4approximate periodic transaction time in nanosecondsh]h4approximate periodic transaction time in nanoseconds}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjUhhubah}(h]h ]h"]h$]h&]uh1jhjShhhjShMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj)Ujj)Uj j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``int speed`` from dev->speed; USB_SPEED_{LOW,FULL,HIGH} ``int is_input`` true iff the transaction sends data to the host ``int isoc`` true for isochronous transactions, false for interrupt ones ``int bytecount`` how many bytes in the transaction. **Return** Approximate bus time in nanoseconds for a periodic transaction. **Note** See USB 2.0 spec section 5.11.3; only periodic transfers need to be scheduled in software, this function is only used for such scheduling.h](h)}(h**Parameters**h]j.)}(hj3Uh]h Parameters}(hj5UhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj1Uubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM#hj-UubjD)}(hhh](jI)}(h9``int speed`` from dev->speed; USB_SPEED_{LOW,FULL,HIGH} h](jO)}(h ``int speed``h]j)}(hjRUh]h int speed}(hjTUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPUubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjLUubji)}(hhh]h)}(h*from dev->speed; USB_SPEED_{LOW,FULL,HIGH}h]h*from dev->speed; USB_SPEED_{LOW,FULL,HIGH}}(hjkUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjgUhM hjhUubah}(h]h ]h"]h$]h&]uh1jhhjLUubeh}(h]h ]h"]h$]h&]uh1jHhjgUhM hjIUubjI)}(hA``int is_input`` true iff the transaction sends data to the host h](jO)}(h``int is_input``h]j)}(hjUh]h int is_input}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM!hjUubji)}(hhh]h)}(h/true iff the transaction sends data to the hosth]h/true iff the transaction sends data to the host}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjUhM!hjUubah}(h]h ]h"]h$]h&]uh1jhhjUubeh}(h]h ]h"]h$]h&]uh1jHhjUhM!hjIUubjI)}(hI``int isoc`` true for isochronous transactions, false for interrupt ones h](jO)}(h ``int isoc``h]j)}(hjUh]hint isoc}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM"hjUubji)}(hhh]h)}(h;true for isochronous transactions, false for interrupt onesh]h;true for isochronous transactions, false for interrupt ones}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjUhM"hjUubah}(h]h ]h"]h$]h&]uh1jhhjUubeh}(h]h ]h"]h$]h&]uh1jHhjUhM"hjIUubjI)}(h5``int bytecount`` how many bytes in the transaction. h](jO)}(h``int bytecount``h]j)}(hjUh]h int bytecount}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM#hjUubji)}(hhh]h)}(h"how many bytes in the transaction.h]h"how many bytes in the transaction.}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVhM#hjVubah}(h]h ]h"]h$]h&]uh1jhhjUubeh}(h]h ]h"]h$]h&]uh1jHhjVhM#hjIUubeh}(h]h ]h"]h$]h&]uh1jChj-Uubh)}(h **Return**h]j.)}(hj8Vh]hReturn}(hj:VhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj6Vubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM%hj-Uubh)}(h?Approximate bus time in nanoseconds for a periodic transaction.h]h?Approximate bus time in nanoseconds for a periodic transaction.}(hjNVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM%hj-Uubh)}(h**Note**h]j.)}(hj_Vh]hNote}(hjaVhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj]Vubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM'hj-Uubh)}(hSee USB 2.0 spec section 5.11.3; only periodic transfers need to be scheduled in software, this function is only used for such scheduling.h]hSee USB 2.0 spec section 5.11.3; only periodic transfers need to be scheduled in software, this function is only used for such scheduling.}(hjuVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM'hj-Uubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j,usb_core.usb_hcd_link_urb_to_ep (C function)!c.usb_core.usb_hcd_link_urb_to_ephNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hAint usb_hcd_link_urb_to_ep (struct usb_hcd *hcd, struct urb *urb)h]j+)}(h@int usb_hcd_link_urb_to_ep(struct usb_hcd *hcd, struct urb *urb)h](jT)}(hinth]hint}(hjVhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjVhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMXubjC)}(h h]h }(hjVhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjVhhhjVhMXubj)}(husb_hcd_link_urb_to_eph]j)}(husb_hcd_link_urb_to_eph]husb_hcd_link_urb_to_ep}(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVubah}(h]h ](jjeh"]h$]h&]jjuh1jhjVhhhjVhMXubj)}(h&(struct usb_hcd *hcd, struct urb *urb)h](j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hjVhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjVubjC)}(h h]h }(hjVhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjVubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjWmodnameN classnameNjLjO)}jR](jNjU)}jHjVsb!c.usb_core.usb_hcd_link_urb_to_epesbuh1hhjVubjC)}(h h]h }(hj WhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjVubjs)}(hjvh]h*}(hj.WhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjVubj)}(hhcdh]hhcd}(hj;WhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjVubj)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjTWhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjPWubjC)}(h h]h }(hjaWhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjPWubh)}(hhh]j)}(hurbh]hurb}(hjrWhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjoWubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjtWmodnameN classnameNjLjO)}jR](jNjW!c.usb_core.usb_hcd_link_urb_to_epesbuh1hhjPWubjC)}(h h]h }(hjWhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjPWubjs)}(hjvh]h*}(hjWhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjPWubj)}(hurbh]hurb}(hjWhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjPWubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjVubeh}(h]h ]h"]h$]h&]jjuh1jhjVhhhjVhMXubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjVhhhjVhMXubah}(h]jVah ](jjeh"]h$]h&]jj)jhuh1j$hjVhMXhjVhhubj)}(hhh]h)}(h add an URB to its endpoint queueh]h add an URB to its endpoint queue}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMXhjWhhubah}(h]h ]h"]h$]h&]uh1jhjVhhhjVhMXubeh}(h]h ](jfunctioneh"]h$]h&]jjjjWjjWj j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct usb_hcd *hcd`` host controller to which **urb** was submitted ``struct urb *urb`` URB being submitted **Description** Host controller drivers should call this routine in their enqueue() method. The HCD's private spinlock must be held and interrupts must be disabled. The actions carried out here are required for URB submission, as well as for endpoint shutdown and for usb_kill_urb. **Return** 0 for no error, otherwise a negative error code (in which case the enqueue() method must fail). If no error occurs but enqueue() fails anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing the private spinlock and returning.h](h)}(h**Parameters**h]j.)}(hjWh]h Parameters}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjWubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM\hjWubjD)}(hhh](jI)}(hG``struct usb_hcd *hcd`` host controller to which **urb** was submitted h](jO)}(h``struct usb_hcd *hcd``h]j)}(hjXh]hstruct usb_hcd *hcd}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjXubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMYhjXubji)}(hhh]h)}(h.host controller to which **urb** was submittedh](hhost controller to which }(hj0XhhhNhNubj.)}(h**urb**h]hurb}(hj8XhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj0Xubh was submitted}(hj0XhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj,XhMYhj-Xubah}(h]h ]h"]h$]h&]uh1jhhjXubeh}(h]h ]h"]h$]h&]uh1jHhj,XhMYhjXubjI)}(h(``struct urb *urb`` URB being submitted h](jO)}(h``struct urb *urb``h]j)}(hjbXh]hstruct urb *urb}(hjdXhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`Xubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMZhj\Xubji)}(hhh]h)}(hURB being submittedh]hURB being submitted}(hj{XhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwXhMZhjxXubah}(h]h ]h"]h$]h&]uh1jhhj\Xubeh}(h]h ]h"]h$]h&]uh1jHhjwXhMZhjXubeh}(h]h ]h"]h$]h&]uh1jChjWubh)}(h**Description**h]j.)}(hjXh]h Description}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjXubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM\hjWubh)}(hX Host controller drivers should call this routine in their enqueue() method. The HCD's private spinlock must be held and interrupts must be disabled. The actions carried out here are required for URB submission, as well as for endpoint shutdown and for usb_kill_urb.h]hX Host controller drivers should call this routine in their enqueue() method. The HCD’s private spinlock must be held and interrupts must be disabled. The actions carried out here are required for URB submission, as well as for endpoint shutdown and for usb_kill_urb.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM[hjWubh)}(h **Return**h]j.)}(hjXh]hReturn}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjXubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM`hjWubh)}(h0 for no error, otherwise a negative error code (in which case the enqueue() method must fail). If no error occurs but enqueue() fails anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing the private spinlock and returning.h]h0 for no error, otherwise a negative error code (in which case the enqueue() method must fail). If no error occurs but enqueue() fails anyway, it must call usb_hcd_unlink_urb_from_ep() before releasing the private spinlock and returning.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMahjWubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j.usb_core.usb_hcd_check_unlink_urb (C function)#c.usb_core.usb_hcd_check_unlink_urbhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hOint usb_hcd_check_unlink_urb (struct usb_hcd *hcd, struct urb *urb, int status)h]j+)}(hNint usb_hcd_check_unlink_urb(struct usb_hcd *hcd, struct urb *urb, int status)h](jT)}(hinth]hint}(hj YhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjYhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMubjC)}(h h]h }(hjYhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjYhhhjYhMubj)}(husb_hcd_check_unlink_urbh]j)}(husb_hcd_check_unlink_urbh]husb_hcd_check_unlink_urb}(hj*YhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&Yubah}(h]h ](jjeh"]h$]h&]jjuh1jhjYhhhjYhMubj)}(h2(struct usb_hcd *hcd, struct urb *urb, int status)h](j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hjFYhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjBYubjC)}(h h]h }(hjSYhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjBYubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjdYhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjaYubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjfYmodnameN classnameNjLjO)}jR](jNjU)}jHj,Ysb#c.usb_core.usb_hcd_check_unlink_urbesbuh1hhjBYubjC)}(h h]h }(hjYhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjBYubjs)}(hjvh]h*}(hjYhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjBYubj)}(hhcdh]hhcd}(hjYhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjBYubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj>Yubj)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjYhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjYubjC)}(h h]h }(hjYhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjYubh)}(hhh]j)}(hurbh]hurb}(hjYhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjYmodnameN classnameNjLjO)}jR](jNjY#c.usb_core.usb_hcd_check_unlink_urbesbuh1hhjYubjC)}(h h]h }(hjYhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjYubjs)}(hjvh]h*}(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjYubj)}(hurbh]hurb}(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjYubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj>Yubj)}(h int statush](jT)}(hinth]hint}(hj*ZhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj&ZubjC)}(h h]h }(hj8ZhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj&Zubj)}(hstatush]hstatus}(hjFZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&Zubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj>Yubeh}(h]h ]h"]h$]h&]jjuh1jhjYhhhjYhMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjYhhhjYhMubah}(h]jXah ](jjeh"]h$]h&]jj)jhuh1j$hjYhMhjXhhubj)}(hhh]h)}(h$check whether an URB may be unlinkedh]h$check whether an URB may be unlinked}(hjpZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjmZhhubah}(h]h ]h"]h$]h&]uh1jhjXhhhjYhMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjZjjZj j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct usb_hcd *hcd`` host controller to which **urb** was submitted ``struct urb *urb`` URB being checked for unlinkability ``int status`` error code to store in **urb** if the unlink succeeds **Description** Host controller drivers should call this routine in their dequeue() method. The HCD's private spinlock must be held and interrupts must be disabled. The actions carried out here are required for making sure than an unlink is valid. -EIDRM: **urb** was not submitted or has already completed. The completion function may not have been called yet. -EBUSY: **urb** has already been unlinked. **Return** 0 for no error, otherwise a negative error code (in which case the dequeue() method must fail). The possible error codes are:h](h)}(h**Parameters**h]j.)}(hjZh]h Parameters}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjZubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjZubjD)}(hhh](jI)}(hG``struct usb_hcd *hcd`` host controller to which **urb** was submitted h](jO)}(h``struct usb_hcd *hcd``h]j)}(hjZh]hstruct usb_hcd *hcd}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjZubji)}(hhh]h)}(h.host controller to which **urb** was submittedh](hhost controller to which }(hjZhhhNhNubj.)}(h**urb**h]hurb}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjZubh was submitted}(hjZhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjZhMhjZubah}(h]h ]h"]h$]h&]uh1jhhjZubeh}(h]h ]h"]h$]h&]uh1jHhjZhMhjZubjI)}(h8``struct urb *urb`` URB being checked for unlinkability h](jO)}(h``struct urb *urb``h]j)}(hjZh]hstruct urb *urb}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjZubji)}(hhh]h)}(h#URB being checked for unlinkabilityh]h#URB being checked for unlinkability}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[hMhj[ubah}(h]h ]h"]h$]h&]uh1jhhjZubeh}(h]h ]h"]h$]h&]uh1jHhj[hMhjZubjI)}(hE``int status`` error code to store in **urb** if the unlink succeeds h](jO)}(h``int status``h]j)}(hj5[h]h int status}(hj7[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3[ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj/[ubji)}(hhh]h)}(h5error code to store in **urb** if the unlink succeedsh](herror code to store in }(hjN[hhhNhNubj.)}(h**urb**h]hurb}(hjV[hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjN[ubh if the unlink succeeds}(hjN[hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjJ[hMhjK[ubah}(h]h ]h"]h$]h&]uh1jhhj/[ubeh}(h]h ]h"]h$]h&]uh1jHhjJ[hMhjZubeh}(h]h ]h"]h$]h&]uh1jChjZubh)}(h**Description**h]j.)}(hj[h]h Description}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj[ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjZubh)}(hHost controller drivers should call this routine in their dequeue() method. The HCD's private spinlock must be held and interrupts must be disabled. The actions carried out here are required for making sure than an unlink is valid.h]hHost controller drivers should call this routine in their dequeue() method. The HCD’s private spinlock must be held and interrupts must be disabled. The actions carried out here are required for making sure than an unlink is valid.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjZubj7)}(h-EIDRM: **urb** was not submitted or has already completed. The completion function may not have been called yet. -EBUSY: **urb** has already been unlinked. h](jD)}(hhh]jI)}(hr-EIDRM: **urb** was not submitted or has already completed. The completion function may not have been called yet. h](jO)}(h;-EIDRM: **urb** was not submitted or has already completed.h](h-EIDRM: }(hj[hhhNhNubj.)}(h**urb**h]hurb}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj[ubh, was not submitted or has already completed.}(hj[hhhNhNubeh}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj[ubji)}(hhh]h)}(h5The completion function may not have been called yet.h]h5The completion function may not have been called yet.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[hMhj[ubah}(h]h ]h"]h$]h&]uh1jhhj[ubeh}(h]h ]h"]h$]h&]uh1jHhj[hMhj[ubah}(h]h ]h"]h$]h&]uh1jChj[ubh)}(h*-EBUSY: **urb** has already been unlinked.h](h-EBUSY: }(hj[hhhNhNubj.)}(h**urb**h]hurb}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj[ubh has already been unlinked.}(hj[hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj[ubeh}(h]h ]h"]h$]h&]uh1j7hZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjZubh)}(h **Return**h]j.)}(hj \h]hReturn}(hj"\hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj\ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjZubh)}(h~0 for no error, otherwise a negative error code (in which case the dequeue() method must fail). The possible error codes are:h]h~0 for no error, otherwise a negative error code (in which case the dequeue() method must fail). The possible error codes are:}(hj6\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjZubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j0usb_core.usb_hcd_unlink_urb_from_ep (C function)%c.usb_core.usb_hcd_unlink_urb_from_ephNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hFvoid usb_hcd_unlink_urb_from_ep (struct usb_hcd *hcd, struct urb *urb)h]j+)}(hEvoid usb_hcd_unlink_urb_from_ep(struct usb_hcd *hcd, struct urb *urb)h](jT)}(hvoidh]hvoid}(hje\hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShja\hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMubjC)}(h h]h }(hjt\hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhja\hhhjs\hMubj)}(husb_hcd_unlink_urb_from_eph]j)}(husb_hcd_unlink_urb_from_eph]husb_hcd_unlink_urb_from_ep}(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\ubah}(h]h ](jjeh"]h$]h&]jjuh1jhja\hhhjs\hMubj)}(h&(struct usb_hcd *hcd, struct urb *urb)h](j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hj\hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj\ubjC)}(h h]h }(hj\hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj\ubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj\modnameN classnameNjLjO)}jR](jNjU)}jHj\sb%c.usb_core.usb_hcd_unlink_urb_from_epesbuh1hhj\ubjC)}(h h]h }(hj\hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj\ubjs)}(hjvh]h*}(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj\ubj)}(hhcdh]hhcd}(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj\ubj)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hj]hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj]ubjC)}(h h]h }(hj"]hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj]ubh)}(hhh]j)}(hurbh]hurb}(hj3]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0]ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj5]modnameN classnameNjLjO)}jR](jNj\%c.usb_core.usb_hcd_unlink_urb_from_epesbuh1hhj]ubjC)}(h h]h }(hjR]hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj]ubjs)}(hjvh]h*}(hj`]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj]ubj)}(hurbh]hurb}(hjm]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj\ubeh}(h]h ]h"]h$]h&]jjuh1jhja\hhhjs\hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj]\hhhjs\hMubah}(h]jX\ah ](jjeh"]h$]h&]jj)jhuh1j$hjs\hMhjZ\hhubj)}(hhh]h)}(h%remove an URB from its endpoint queueh]h%remove an URB from its endpoint queue}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj]hhubah}(h]h ]h"]h$]h&]uh1jhjZ\hhhjs\hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj]jj]j j!j"uh1jhhhjQShNhNubj$)}(hXu**Parameters** ``struct usb_hcd *hcd`` host controller to which **urb** was submitted ``struct urb *urb`` URB being unlinked **Description** Host controller drivers should call this routine before calling usb_hcd_giveback_urb(). The HCD's private spinlock must be held and interrupts must be disabled. The actions carried out here are required for URB completion.h](h)}(h**Parameters**h]j.)}(hj]h]h Parameters}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj]ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj]ubjD)}(hhh](jI)}(hG``struct usb_hcd *hcd`` host controller to which **urb** was submitted h](jO)}(h``struct usb_hcd *hcd``h]j)}(hj]h]hstruct usb_hcd *hcd}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj]ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj]ubji)}(hhh]h)}(h.host controller to which **urb** was submittedh](hhost controller to which }(hj]hhhNhNubj.)}(h**urb**h]hurb}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj]ubh was submitted}(hj]hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj]hMhj]ubah}(h]h ]h"]h$]h&]uh1jhhj]ubeh}(h]h ]h"]h$]h&]uh1jHhj]hMhj]ubjI)}(h'``struct urb *urb`` URB being unlinked h](jO)}(h``struct urb *urb``h]j)}(hj#^h]hstruct urb *urb}(hj%^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!^ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj^ubji)}(hhh]h)}(hURB being unlinkedh]hURB being unlinked}(hj<^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8^hMhj9^ubah}(h]h ]h"]h$]h&]uh1jhhj^ubeh}(h]h ]h"]h$]h&]uh1jHhj8^hMhj]ubeh}(h]h ]h"]h$]h&]uh1jChj]ubh)}(h**Description**h]j.)}(hj^^h]h Description}(hj`^hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj\^ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj]ubh)}(hHost controller drivers should call this routine before calling usb_hcd_giveback_urb(). The HCD's private spinlock must be held and interrupts must be disabled. The actions carried out here are required for URB completion.h]hHost controller drivers should call this routine before calling usb_hcd_giveback_urb(). The HCD’s private spinlock must be held and interrupts must be disabled. The actions carried out here are required for URB completion.}(hjt^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj]ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j*usb_core.usb_hcd_giveback_urb (C function)c.usb_core.usb_hcd_giveback_urbhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hLvoid usb_hcd_giveback_urb (struct usb_hcd *hcd, struct urb *urb, int status)h]j+)}(hKvoid usb_hcd_giveback_urb(struct usb_hcd *hcd, struct urb *urb, int status)h](jT)}(hvoidh]hvoid}(hj^hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj^hhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMubjC)}(h h]h }(hj^hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj^hhhj^hMubj)}(husb_hcd_giveback_urbh]j)}(husb_hcd_giveback_urbh]husb_hcd_giveback_urb}(hj^hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj^hhhj^hMubj)}(h2(struct usb_hcd *hcd, struct urb *urb, int status)h](j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hj^hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj^ubjC)}(h h]h }(hj^hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj^ubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hj^hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj_modnameN classnameNjLjO)}jR](jNjU)}jHj^sbc.usb_core.usb_hcd_giveback_urbesbuh1hhj^ubjC)}(h h]h }(hj_hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj^ubjs)}(hjvh]h*}(hj-_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj^ubj)}(hhcdh]hhcd}(hj:_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj^ubj)}(hstruct urb *urbh](j1)}(hjh]hstruct}(hjS_hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjO_ubjC)}(h h]h }(hj`_hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjO_ubh)}(hhh]j)}(hurbh]hurb}(hjq_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjn_ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjs_modnameN classnameNjLjO)}jR](jNj_c.usb_core.usb_hcd_giveback_urbesbuh1hhjO_ubjC)}(h h]h }(hj_hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjO_ubjs)}(hjvh]h*}(hj_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjO_ubj)}(hurbh]hurb}(hj_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjO_ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj^ubj)}(h int statush](jT)}(hinth]hint}(hj_hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj_ubjC)}(h h]h }(hj_hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj_ubj)}(hstatush]hstatus}(hj_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj^ubeh}(h]h ]h"]h$]h&]jjuh1jhj^hhhj^hMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj^hhhj^hMubah}(h]j^ah ](jjeh"]h$]h&]jj)jhuh1j$hj^hMhj^hhubj)}(hhh]h)}(h$return URB from HCD to device driverh]h$return URB from HCD to device driver}(hj `hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj`hhubah}(h]h ]h"]h$]h&]uh1jhj^hhhj^hMubeh}(h]h ](jfunctioneh"]h$]h&]jjjj"`jj"`j j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct usb_hcd *hcd`` host controller returning the URB ``struct urb *urb`` urb being returned to the USB device driver. ``int status`` completion status code for the URB. **Context** atomic. The completion callback is invoked either in a work queue (BH) context or in the caller's context, depending on whether the HCD_BH flag is set in the **hcd** structure, except that URBs submitted to the root hub always complete in BH context. **Description** This hands the URB from HCD to its USB device driver, using its completion function. The HCD has freed all per-urb resources (and is done using urb->hcpriv). It also released all HCD locks; the device driver won't cause problems if it frees, modifies, or resubmits this URB. If **urb** was unlinked, the value of **status** will be overridden by **urb->unlinked**. Erroneous short transfers are detected in case the HCD hasn't checked for them.h](h)}(h**Parameters**h]j.)}(hj,`h]h Parameters}(hj.`hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj*`ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj&`ubjD)}(hhh](jI)}(h:``struct usb_hcd *hcd`` host controller returning the URB h](jO)}(h``struct usb_hcd *hcd``h]j)}(hjK`h]hstruct usb_hcd *hcd}(hjM`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjI`ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjE`ubji)}(hhh]h)}(h!host controller returning the URBh]h!host controller returning the URB}(hjd`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj``hMhja`ubah}(h]h ]h"]h$]h&]uh1jhhjE`ubeh}(h]h ]h"]h$]h&]uh1jHhj``hMhjB`ubjI)}(hA``struct urb *urb`` urb being returned to the USB device driver. h](jO)}(h``struct urb *urb``h]j)}(hj`h]hstruct urb *urb}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj~`ubji)}(hhh]h)}(h,urb being returned to the USB device driver.h]h,urb being returned to the USB device driver.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hMhj`ubah}(h]h ]h"]h$]h&]uh1jhhj~`ubeh}(h]h ]h"]h$]h&]uh1jHhj`hMhjB`ubjI)}(h3``int status`` completion status code for the URB. h](jO)}(h``int status``h]j)}(hj`h]h int status}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj`ubji)}(hhh]h)}(h#completion status code for the URB.h]h#completion status code for the URB.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hMhj`ubah}(h]h ]h"]h$]h&]uh1jhhj`ubeh}(h]h ]h"]h$]h&]uh1jHhj`hMhjB`ubeh}(h]h ]h"]h$]h&]uh1jChj&`ubh)}(h **Context**h]j.)}(hj`h]hContext}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj`ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj&`ubh)}(hatomic. The completion callback is invoked either in a work queue (BH) context or in the caller's context, depending on whether the HCD_BH flag is set in the **hcd** structure, except that URBs submitted to the root hub always complete in BH context.h](hatomic. The completion callback is invoked either in a work queue (BH) context or in the caller’s context, depending on whether the HCD_BH flag is set in the }(hjahhhNhNubj.)}(h**hcd**h]hhcd}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjaubhU structure, except that URBs submitted to the root hub always complete in BH context.}(hjahhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj&`ubh)}(h**Description**h]j.)}(hj1ah]h Description}(hj3ahhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj/aubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj&`ubh)}(hXThis hands the URB from HCD to its USB device driver, using its completion function. The HCD has freed all per-urb resources (and is done using urb->hcpriv). It also released all HCD locks; the device driver won't cause problems if it frees, modifies, or resubmits this URB.h]hXThis hands the URB from HCD to its USB device driver, using its completion function. The HCD has freed all per-urb resources (and is done using urb->hcpriv). It also released all HCD locks; the device driver won’t cause problems if it frees, modifies, or resubmits this URB.}(hjGahhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj&`ubh)}(hIf **urb** was unlinked, the value of **status** will be overridden by **urb->unlinked**. Erroneous short transfers are detected in case the HCD hasn't checked for them.h](hIf }(hjVahhhNhNubj.)}(h**urb**h]hurb}(hj^ahhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjVaubh was unlinked, the value of }(hjVahhhNhNubj.)}(h **status**h]hstatus}(hjpahhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjVaubh will be overridden by }(hjVahhhNhNubj.)}(h**urb->unlinked**h]h urb->unlinked}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjVaubhT. Erroneous short transfers are detected in case the HCD hasn’t checked for them.}(hjVahhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj&`ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_core.usb_alloc_streams (C function)c.usb_core.usb_alloc_streamshNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hint usb_alloc_streams (struct usb_interface *interface, struct usb_host_endpoint **eps, unsigned int num_eps, unsigned int num_streams, gfp_t mem_flags)h]j+)}(hint usb_alloc_streams(struct usb_interface *interface, struct usb_host_endpoint **eps, unsigned int num_eps, unsigned int num_streams, gfp_t mem_flags)h](jT)}(hinth]hint}(hjahhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjahhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMubjC)}(h h]h }(hjahhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjahhhjahMubj)}(husb_alloc_streamsh]j)}(husb_alloc_streamsh]husb_alloc_streams}(hjahhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjaubah}(h]h ](jjeh"]h$]h&]jjuh1jhjahhhjahMubj)}(h(struct usb_interface *interface, struct usb_host_endpoint **eps, unsigned int num_eps, unsigned int num_streams, gfp_t mem_flags)h](j)}(hstruct usb_interface *interfaceh](j1)}(hjh]hstruct}(hjahhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjaubjC)}(h h]h }(hjbhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjaubh)}(hhh]j)}(h usb_interfaceh]h usb_interface}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjbmodnameN classnameNjLjO)}jR](jNjU)}jHjasbc.usb_core.usb_alloc_streamsesbuh1hhjaubjC)}(h h]h }(hj7bhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjaubjs)}(hjvh]h*}(hjEbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjaubj)}(h interfaceh]h interface}(hjRbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjaubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjaubj)}(hstruct usb_host_endpoint **epsh](j1)}(hjh]hstruct}(hjkbhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjgbubjC)}(h h]h }(hjxbhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjgbubh)}(hhh]j)}(husb_host_endpointh]husb_host_endpoint}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjbmodnameN classnameNjLjO)}jR](jNj3bc.usb_core.usb_alloc_streamsesbuh1hhjgbubjC)}(h h]h }(hjbhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjgbubjs)}(hjvh]h*}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjgbubjs)}(hjvh]h*}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjgbubj)}(hepsh]heps}(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjgbubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjaubj)}(hunsigned int num_epsh](jT)}(hunsignedh]hunsigned}(hjbhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjbubjC)}(h h]h }(hjbhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjbubjT)}(hinth]hint}(hjchhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjbubjC)}(h h]h }(hjchhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjbubj)}(hnum_epsh]hnum_eps}(hj!chhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjaubj)}(hunsigned int num_streamsh](jT)}(hunsignedh]hunsigned}(hj:chhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj6cubjC)}(h h]h }(hjHchhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj6cubjT)}(hinth]hint}(hjVchhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj6cubjC)}(h h]h }(hjdchhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj6cubj)}(h num_streamsh]h num_streams}(hjrchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6cubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjaubj)}(hgfp_t mem_flagsh](h)}(hhh]j)}(hgfp_th]hgfp_t}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjcubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjcmodnameN classnameNjLjO)}jR](jNj3bc.usb_core.usb_alloc_streamsesbuh1hhjcubjC)}(h h]h }(hjchhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjcubj)}(h mem_flagsh]h mem_flags}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjcubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjaubeh}(h]h ]h"]h$]h&]jjuh1jhjahhhjahMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjahhhjahMubah}(h]jaah ](jjeh"]h$]h&]jj)jhuh1j$hjahMhjahhubj)}(hhh]h)}(h"allocate bulk endpoint stream IDs.h]h"allocate bulk endpoint stream IDs.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjchhubah}(h]h ]h"]h$]h&]uh1jhjahhhjahMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjcjjcj j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct usb_interface *interface`` alternate setting that includes all endpoints. ``struct usb_host_endpoint **eps`` array of endpoints that need streams. ``unsigned int num_eps`` number of endpoints in the array. ``unsigned int num_streams`` number of streams to allocate. ``gfp_t mem_flags`` flags hcd should use to allocate memory. **Description** Sets up a group of bulk endpoints to have **num_streams** stream IDs available. Drivers may queue multiple transfers to different stream IDs, which may complete in a different order than they were queued. **Return** On success, the number of allocated streams. On failure, a negative error code.h](h)}(h**Parameters**h]j.)}(hjdh]h Parameters}(hj dhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjdubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjdubjD)}(hhh](jI)}(hS``struct usb_interface *interface`` alternate setting that includes all endpoints. h](jO)}(h#``struct usb_interface *interface``h]j)}(hj&dh]hstruct usb_interface *interface}(hj(dhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$dubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhj dubji)}(hhh]h)}(h.alternate setting that includes all endpoints.h]h.alternate setting that includes all endpoints.}(hj?dhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;dhMhjgubjC)}(h h]h }(hjdghhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj>gubj)}(h mem_flagsh]h mem_flags}(hjrghhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>gubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjeubeh}(h]h ]h"]h$]h&]jjuh1jhjehhhjehMubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjehhhjehMubah}(h]jeah ](jjeh"]h$]h&]jj)jhuh1j$hjehMhjehhubj)}(hhh]h)}(hfree bulk endpoint stream IDs.h]hfree bulk endpoint stream IDs.}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjghhubah}(h]h ]h"]h$]h&]uh1jhjehhhjehMubeh}(h]h ](jfunctioneh"]h$]h&]jjjjgjjgj j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct usb_interface *interface`` alternate setting that includes all endpoints. ``struct usb_host_endpoint **eps`` array of endpoints to remove streams from. ``unsigned int num_eps`` number of endpoints in the array. ``gfp_t mem_flags`` flags hcd should use to allocate memory. **Description** Reverts a group of bulk endpoints back to not using stream IDs. Can fail if we are given bad arguments, or HCD is broken. **Return** 0 on success. On failure, a negative error code.h](h)}(h**Parameters**h]j.)}(hjgh]h Parameters}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjgubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjgubjD)}(hhh](jI)}(hS``struct usb_interface *interface`` alternate setting that includes all endpoints. h](jO)}(h#``struct usb_interface *interface``h]j)}(hjgh]hstruct usb_interface *interface}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjgubji)}(hhh]h)}(h.alternate setting that includes all endpoints.h]h.alternate setting that includes all endpoints.}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhjghMhjgubah}(h]h ]h"]h$]h&]uh1jhhjgubeh}(h]h ]h"]h$]h&]uh1jHhjghMhjgubjI)}(hN``struct usb_host_endpoint **eps`` array of endpoints to remove streams from. h](jO)}(h"``struct usb_host_endpoint **eps``h]j)}(hjhh]hstruct usb_host_endpoint **eps}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjhubji)}(hhh]h)}(h*array of endpoints to remove streams from.h]h*array of endpoints to remove streams from.}(hj/hhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hhMhj,hubah}(h]h ]h"]h$]h&]uh1jhhjhubeh}(h]h ]h"]h$]h&]uh1jHhj+hhMhjgubjI)}(h;``unsigned int num_eps`` number of endpoints in the array. h](jO)}(h``unsigned int num_eps``h]j)}(hjOhh]hunsigned int num_eps}(hjQhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMhubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjIhubji)}(hhh]h)}(h!number of endpoints in the array.h]h!number of endpoints in the array.}(hjhhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjdhhMhjehubah}(h]h ]h"]h$]h&]uh1jhhjIhubeh}(h]h ]h"]h$]h&]uh1jHhjdhhMhjgubjI)}(h=``gfp_t mem_flags`` flags hcd should use to allocate memory. h](jO)}(h``gfp_t mem_flags``h]j)}(hjhh]hgfp_t mem_flags}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjhubji)}(hhh]h)}(h(flags hcd should use to allocate memory.h]h(flags hcd should use to allocate memory.}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhMhjhubah}(h]h ]h"]h$]h&]uh1jhhjhubeh}(h]h ]h"]h$]h&]uh1jHhjhhMhjgubeh}(h]h ]h"]h$]h&]uh1jChjgubh)}(h**Description**h]j.)}(hjhh]h Description}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjhubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjgubh)}(hyReverts a group of bulk endpoints back to not using stream IDs. Can fail if we are given bad arguments, or HCD is broken.h]hyReverts a group of bulk endpoints back to not using stream IDs. Can fail if we are given bad arguments, or HCD is broken.}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjgubh)}(h **Return**h]j.)}(hjhh]hReturn}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjhubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjgubh)}(h00 on success. On failure, a negative error code.h]h00 on success. On failure, a negative error code.}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMhjgubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j-usb_core.usb_hcd_resume_root_hub (C function)"c.usb_core.usb_hcd_resume_root_hubhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h2void usb_hcd_resume_root_hub (struct usb_hcd *hcd)h]j+)}(h1void usb_hcd_resume_root_hub(struct usb_hcd *hcd)h](jT)}(hvoidh]hvoid}(hj/ihhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj+ihhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMV ubjC)}(h h]h }(hj>ihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj+ihhhj=ihMV ubj)}(husb_hcd_resume_root_hubh]j)}(husb_hcd_resume_root_hubh]husb_hcd_resume_root_hub}(hjPihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjLiubah}(h]h ](jjeh"]h$]h&]jjuh1jhj+ihhhj=ihMV ubj)}(h(struct usb_hcd *hcd)h]j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hjlihhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjhiubjC)}(h h]h }(hjyihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhiubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjimodnameN classnameNjLjO)}jR](jNjU)}jHjRisb"c.usb_core.usb_hcd_resume_root_hubesbuh1hhjhiubjC)}(h h]h }(hjihhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhiubjs)}(hjvh]h*}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjhiubj)}(hhcdh]hhcd}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhiubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjdiubah}(h]h ]h"]h$]h&]jjuh1jhj+ihhhj=ihMV ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj'ihhhj=ihMV ubah}(h]j"iah ](jjeh"]h$]h&]jj)jhuh1j$hj=ihMV hj$ihhubj)}(hhh]h)}(h$called by HCD to resume its root hubh]h$called by HCD to resume its root hub}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMV hjihhubah}(h]h ]h"]h$]h&]uh1jhj$ihhhj=ihMV ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjjjj j!j"uh1jhhhjQShNhNubj$)}(hXh**Parameters** ``struct usb_hcd *hcd`` host controller for this root hub **Description** The USB host controller calls this function when its root hub is suspended (with the remote wakeup feature enabled) and a remote wakeup request is received. The routine submits a workqueue request to resume the root hub (that is, manage its downstream ports again).h](h)}(h**Parameters**h]j.)}(hjjh]h Parameters}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMZ hj jubjD)}(hhh]jI)}(h:``struct usb_hcd *hcd`` host controller for this root hub h](jO)}(h``struct usb_hcd *hcd``h]j)}(hj1jh]hstruct usb_hcd *hcd}(hj3jhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/jubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMW hj+jubji)}(hhh]h)}(h!host controller for this root hubh]h!host controller for this root hub}(hjJjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFjhMW hjGjubah}(h]h ]h"]h$]h&]uh1jhhj+jubeh}(h]h ]h"]h$]h&]uh1jHhjFjhMW hj(jubah}(h]h ]h"]h$]h&]uh1jChj jubh)}(h**Description**h]j.)}(hjljh]h Description}(hjnjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjjjubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMY hj jubh)}(hX The USB host controller calls this function when its root hub is suspended (with the remote wakeup feature enabled) and a remote wakeup request is received. The routine submits a workqueue request to resume the root hub (that is, manage its downstream ports again).h]hX The USB host controller calls this function when its root hub is suspended (with the remote wakeup feature enabled) and a remote wakeup request is received. The routine submits a workqueue request to resume the root hub (that is, manage its downstream ports again).}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMX hj jubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.usb_bus_start_enum (C function)c.usb_core.usb_bus_start_enumhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h?int usb_bus_start_enum (struct usb_bus *bus, unsigned port_num)h]j+)}(h>int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num)h](jT)}(hinth]hint}(hjjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjjhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMs ubjC)}(h h]h }(hjjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjjhhhjjhMs ubj)}(husb_bus_start_enumh]j)}(husb_bus_start_enumh]husb_bus_start_enum}(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjjhhhjjhMs ubj)}(h((struct usb_bus *bus, unsigned port_num)h](j)}(hstruct usb_bus *bush](j1)}(hjh]hstruct}(hjjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjjubjC)}(h h]h }(hjjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjjubh)}(hhh]j)}(husb_bush]husb_bus}(hj khhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj kubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjkmodnameN classnameNjLjO)}jR](jNjU)}jHjjsbc.usb_core.usb_bus_start_enumesbuh1hhjjubjC)}(h h]h }(hj-khhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjjubjs)}(hjvh]h*}(hj;khhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjjubj)}(hbush]hbus}(hjHkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjjubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjjubj)}(hunsigned port_numh](jT)}(hunsignedh]hunsigned}(hjakhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj]kubjC)}(h h]h }(hjokhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj]kubj)}(hport_numh]hport_num}(hj}khhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]kubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjjubeh}(h]h ]h"]h$]h&]jjuh1jhjjhhhjjhMs ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjjhhhjjhMs ubah}(h]jjah ](jjeh"]h$]h&]jj)jhuh1j$hjjhMs hjjhhubj)}(hhh]h)}(h%start immediate enumeration (for OTG)h]h%start immediate enumeration (for OTG)}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMs hjkhhubah}(h]h ]h"]h$]h&]uh1jhjjhhhjjhMs ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjkjjkj j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct usb_bus *bus`` the bus (must use hcd framework) ``unsigned port_num`` 1-based number of port; usually bus->otg_port **Context** atomic **Description** Starts enumeration, with an immediate reset followed later by hub_wq identifying and possibly configuring the device. This is needed by OTG controller drivers, where it helps meet HNP protocol timing requirements for starting a port reset. **Return** 0 if successful.h](h)}(h**Parameters**h]j.)}(hjkh]h Parameters}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjkubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMw hjkubjD)}(hhh](jI)}(h9``struct usb_bus *bus`` the bus (must use hcd framework) h](jO)}(h``struct usb_bus *bus``h]j)}(hjkh]hstruct usb_bus *bus}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMt hjkubji)}(hhh]h)}(h the bus (must use hcd framework)h]h the bus (must use hcd framework)}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkhMt hjkubah}(h]h ]h"]h$]h&]uh1jhhjkubeh}(h]h ]h"]h$]h&]uh1jHhjkhMt hjkubjI)}(hD``unsigned port_num`` 1-based number of port; usually bus->otg_port h](jO)}(h``unsigned port_num``h]j)}(hj!lh]hunsigned port_num}(hj#lhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjlubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMu hjlubji)}(hhh]h)}(h-1-based number of port; usually bus->otg_porth]h-1-based number of port; usually bus->otg_port}(hj:lhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6lhMu hj7lubah}(h]h ]h"]h$]h&]uh1jhhjlubeh}(h]h ]h"]h$]h&]uh1jHhj6lhMu hjkubeh}(h]h ]h"]h$]h&]uh1jChjkubh)}(h **Context**h]j.)}(hj\lh]hContext}(hj^lhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjZlubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMw hjkubh)}(hatomich]hatomic}(hjrlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMv hjkubh)}(h**Description**h]j.)}(hjlh]h Description}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjlubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMx hjkubh)}(hStarts enumeration, with an immediate reset followed later by hub_wq identifying and possibly configuring the device. This is needed by OTG controller drivers, where it helps meet HNP protocol timing requirements for starting a port reset.h]hStarts enumeration, with an immediate reset followed later by hub_wq identifying and possibly configuring the device. This is needed by OTG controller drivers, where it helps meet HNP protocol timing requirements for starting a port reset.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMw hjkubh)}(h **Return**h]j.)}(hjlh]hReturn}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjlubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM| hjkubh)}(h0 if successful.h]h0 if successful.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM} hjkubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!usb_core.usb_hcd_irq (C function)c.usb_core.usb_hcd_irqhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h.irqreturn_t usb_hcd_irq (int irq, void *__hcd)h]j+)}(h-irqreturn_t usb_hcd_irq(int irq, void *__hcd)h](h)}(hhh]j)}(h irqreturn_th]h irqreturn_t}(hjlhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjlubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjlmodnameN classnameNjLjO)}jR](jNjU)}jH usb_hcd_irqsbc.usb_core.usb_hcd_irqesbuh1hhjlhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM ubjC)}(h h]h }(hjmhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjlhhhjmhM ubj)}(h usb_hcd_irqh]j)}(hjmh]h usb_hcd_irq}(hj'mhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#mubah}(h]h ](jjeh"]h$]h&]jjuh1jhjlhhhjmhM ubj)}(h(int irq, void *__hcd)h](j)}(hint irqh](jT)}(hinth]hint}(hjBmhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj>mubjC)}(h h]h }(hjPmhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj>mubj)}(hirqh]hirq}(hj^mhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>mubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:mubj)}(h void *__hcdh](jT)}(hvoidh]hvoid}(hjwmhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjsmubjC)}(h h]h }(hjmhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjsmubjs)}(hjvh]h*}(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjsmubj)}(h__hcdh]h__hcd}(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjsmubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj:mubeh}(h]h ]h"]h$]h&]jjuh1jhjlhhhjmhM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjlhhhjmhM ubah}(h]jlah ](jjeh"]h$]h&]jj)jhuh1j$hjmhM hjlhhubj)}(hhh]h)}(h%hook IRQs to HCD framework (bus glue)h]h%hook IRQs to HCD framework (bus glue)}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjmhhubah}(h]h ]h"]h$]h&]uh1jhjlhhhjmhM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjmjjmj j!j"uh1jhhhjQShNhNubj$)}(hX>**Parameters** ``int irq`` the IRQ being raised ``void *__hcd`` pointer to the HCD whose IRQ is being signaled **Description** If the controller isn't HALTed, calls the driver's irq handler. Checks whether the controller is now dead. **Return** ``IRQ_HANDLED`` if the IRQ was handled. ``IRQ_NONE`` otherwise.h](h)}(h**Parameters**h]j.)}(hjmh]h Parameters}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjmubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjmubjD)}(hhh](jI)}(h!``int irq`` the IRQ being raised h](jO)}(h ``int irq``h]j)}(hj nh]hint irq}(hj nhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj nubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjnubji)}(hhh]h)}(hthe IRQ being raisedh]hthe IRQ being raised}(hj$nhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj nhM hj!nubah}(h]h ]h"]h$]h&]uh1jhhjnubeh}(h]h ]h"]h$]h&]uh1jHhj nhM hjnubjI)}(h?``void *__hcd`` pointer to the HCD whose IRQ is being signaled h](jO)}(h``void *__hcd``h]j)}(hjDnh]h void *__hcd}(hjFnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBnubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hj>nubji)}(hhh]h)}(h.pointer to the HCD whose IRQ is being signaledh]h.pointer to the HCD whose IRQ is being signaled}(hj]nhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYnhM hjZnubah}(h]h ]h"]h$]h&]uh1jhhj>nubeh}(h]h ]h"]h$]h&]uh1jHhjYnhM hjnubeh}(h]h ]h"]h$]h&]uh1jChjmubh)}(h**Description**h]j.)}(hjnh]h Description}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj}nubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjmubh)}(hjIf the controller isn't HALTed, calls the driver's irq handler. Checks whether the controller is now dead.h]hnIf the controller isn’t HALTed, calls the driver’s irq handler. Checks whether the controller is now dead.}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjmubh)}(h **Return**h]j.)}(hjnh]hReturn}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjnubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjmubh)}(h?``IRQ_HANDLED`` if the IRQ was handled. ``IRQ_NONE`` otherwise.h](j)}(h``IRQ_HANDLED``h]h IRQ_HANDLED}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnubh if the IRQ was handled. }(hjnhhhNhNubj)}(h ``IRQ_NONE``h]hIRQ_NONE}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjnubh otherwise.}(hjnhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjmubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!usb_core.usb_hc_died (C function)c.usb_core.usb_hc_diedhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h&void usb_hc_died (struct usb_hcd *hcd)h]j+)}(h%void usb_hc_died(struct usb_hcd *hcd)h](jT)}(hvoidh]hvoid}(hj ohhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjohhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM ubjC)}(h h]h }(hjohhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjohhhjohM ubj)}(h usb_hc_diedh]j)}(h usb_hc_diedh]h usb_hc_died}(hj,ohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(oubah}(h]h ](jjeh"]h$]h&]jjuh1jhjohhhjohM ubj)}(h(struct usb_hcd *hcd)h]j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hjHohhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjDoubjC)}(h h]h }(hjUohhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjDoubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjfohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjcoubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjhomodnameN classnameNjLjO)}jR](jNjU)}jHj.osbc.usb_core.usb_hc_diedesbuh1hhjDoubjC)}(h h]h }(hjohhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjDoubjs)}(hjvh]h*}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjDoubj)}(hhcdh]hhcd}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjDoubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj@oubah}(h]h ]h"]h$]h&]jjuh1jhjohhhjohM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjohhhjohM ubah}(h]jnah ](jjeh"]h$]h&]jj)jhuh1j$hjohM hjohhubj)}(hhh]h)}(h8report abnormal shutdown of a host controller (bus glue)h]h8report abnormal shutdown of a host controller (bus glue)}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjohhubah}(h]h ]h"]h$]h&]uh1jhjohhhjohM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjojjoj j!j"uh1jhhhjQShNhNubj$)}(hXp**Parameters** ``struct usb_hcd *hcd`` pointer to the HCD representing the controller **Description** This is called by bus glue to report a USB host controller that died while operations may still have been pending. It's called automatically by the PCI glue, so only glue for non-PCI busses should need to call it. Only call this function with the primary HCD.h](h)}(h**Parameters**h]j.)}(hjoh]h Parameters}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjoubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjoubjD)}(hhh]jI)}(hG``struct usb_hcd *hcd`` pointer to the HCD representing the controller h](jO)}(h``struct usb_hcd *hcd``h]j)}(hj ph]hstruct usb_hcd *hcd}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jhj pubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjpubji)}(hhh]h)}(h.pointer to the HCD representing the controllerh]h.pointer to the HCD representing the controller}(hj&phhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"phM hj#pubah}(h]h ]h"]h$]h&]uh1jhhjpubeh}(h]h ]h"]h$]h&]uh1jHhj"phM hjpubah}(h]h ]h"]h$]h&]uh1jChjoubh)}(h**Description**h]j.)}(hjHph]h Description}(hjJphhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjFpubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjoubh)}(hThis is called by bus glue to report a USB host controller that died while operations may still have been pending. It's called automatically by the PCI glue, so only glue for non-PCI busses should need to call it.h]hThis is called by bus glue to report a USB host controller that died while operations may still have been pending. It’s called automatically by the PCI glue, so only glue for non-PCI busses should need to call it.}(hj^phhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjoubh)}(h-Only call this function with the primary HCD.h]h-Only call this function with the primary HCD.}(hjmphhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjoubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j+usb_core.usb_create_shared_hcd (C function) c.usb_core.usb_create_shared_hcdhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hstruct usb_hcd * usb_create_shared_hcd (const struct hc_driver *driver, struct device *dev, const char *bus_name, struct usb_hcd *primary_hcd)h]j+)}(hstruct usb_hcd *usb_create_shared_hcd(const struct hc_driver *driver, struct device *dev, const char *bus_name, struct usb_hcd *primary_hcd)h](j1)}(hjh]hstruct}(hjphhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjphhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM< ubjC)}(h h]h }(hjphhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjphhhjphM< ubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjpmodnameN classnameNjLjO)}jR](jNjU)}jHusb_create_shared_hcdsb c.usb_core.usb_create_shared_hcdesbuh1hhjphhhjphM< ubjC)}(h h]h }(hjphhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjphhhjphM< ubjs)}(hjvh]h*}(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjphhhjphM< ubj)}(husb_create_shared_hcdh]j)}(hjph]husb_create_shared_hcd}(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjpubah}(h]h ](jjeh"]h$]h&]jjuh1jhjphhhjphM< ubj)}(hg(const struct hc_driver *driver, struct device *dev, const char *bus_name, struct usb_hcd *primary_hcd)h](j)}(hconst struct hc_driver *driverh](j1)}(hj4h]hconst}(hjqhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjqubjC)}(h h]h }(hj$qhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjqubj1)}(hjh]hstruct}(hj2qhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjqubjC)}(h h]h }(hj?qhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjqubh)}(hhh]j)}(h hc_driverh]h hc_driver}(hjPqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjMqubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjRqmodnameN classnameNjLjO)}jR](jNjp c.usb_core.usb_create_shared_hcdesbuh1hhjqubjC)}(h h]h }(hjoqhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjqubjs)}(hjvh]h*}(hj}qhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjqubj)}(hdriverh]hdriver}(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjqubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjqubj)}(hstruct device *devh](j1)}(hjh]hstruct}(hjqhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjqubjC)}(h h]h }(hjqhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjqubh)}(hhh]j)}(hdeviceh]hdevice}(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjqmodnameN classnameNjLjO)}jR](jNjp c.usb_core.usb_create_shared_hcdesbuh1hhjqubjC)}(h h]h }(hjqhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjqubjs)}(hjvh]h*}(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjqubj)}(hdevh]hdev}(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjqubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjqubj)}(hconst char *bus_nameh](j1)}(hj4h]hconst}(hjrhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjrubjC)}(h h]h }(hj!rhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjrubjT)}(hcharh]hchar}(hj/rhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjrubjC)}(h h]h }(hj=rhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjrubjs)}(hjvh]h*}(hjKrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjrubj)}(hbus_nameh]hbus_name}(hjXrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjqubj)}(hstruct usb_hcd *primary_hcdh](j1)}(hjh]hstruct}(hjqrhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjmrubjC)}(h h]h }(hj~rhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjmrubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjrmodnameN classnameNjLjO)}jR](jNjp c.usb_core.usb_create_shared_hcdesbuh1hhjmrubjC)}(h h]h }(hjrhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjmrubjs)}(hjvh]h*}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjmrubj)}(h primary_hcdh]h primary_hcd}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjmrubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjqubeh}(h]h ]h"]h$]h&]jjuh1jhjphhhjphM< ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjphhhjphM< ubah}(h]jpah ](jjeh"]h$]h&]jj)jhuh1j$hjphM< hjphhubj)}(hhh]h)}(h&create and initialize an HCD structureh]h&create and initialize an HCD structure}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM< hjrhhubah}(h]h ]h"]h$]h&]uh1jhjphhhjphM< ubeh}(h]h ](jfunctioneh"]h$]h&]jjjj sjj sj j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``const struct hc_driver *driver`` HC driver that will use this hcd ``struct device *dev`` device for this HC, stored in hcd->self.controller ``const char *bus_name`` value to store in hcd->self.bus_name ``struct usb_hcd *primary_hcd`` a pointer to the usb_hcd structure that is sharing the PCI device. Only allocate certain resources for the primary HCD **Context** task context, might sleep. **Description** Allocate a struct usb_hcd, with extra space at the end for the HC driver's private data. Initialize the generic members of the hcd structure. **Return** On success, a pointer to the created and initialized HCD structure. On failure (e.g. if memory is unavailable), ``NULL``.h](h)}(h**Parameters**h]j.)}(hjsh]h Parameters}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjsubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM@ hjsubjD)}(hhh](jI)}(hD``const struct hc_driver *driver`` HC driver that will use this hcd h](jO)}(h"``const struct hc_driver *driver``h]j)}(hj4sh]hconst struct hc_driver *driver}(hj6shhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2subah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM= hj.subji)}(hhh]h)}(h HC driver that will use this hcdh]h HC driver that will use this hcd}(hjMshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjIshM= hjJsubah}(h]h ]h"]h$]h&]uh1jhhj.subeh}(h]h ]h"]h$]h&]uh1jHhjIshM= hj+subjI)}(hJ``struct device *dev`` device for this HC, stored in hcd->self.controller h](jO)}(h``struct device *dev``h]j)}(hjmsh]hstruct device *dev}(hjoshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjksubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM> hjgsubji)}(hhh]h)}(h2device for this HC, stored in hcd->self.controllerh]h2device for this HC, stored in hcd->self.controller}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshM> hjsubah}(h]h ]h"]h$]h&]uh1jhhjgsubeh}(h]h ]h"]h$]h&]uh1jHhjshM> hj+subjI)}(h>``const char *bus_name`` value to store in hcd->self.bus_name h](jO)}(h``const char *bus_name``h]j)}(hjsh]hconst char *bus_name}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM? hjsubji)}(hhh]h)}(h$value to store in hcd->self.bus_nameh]h$value to store in hcd->self.bus_name}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjshM? hjsubah}(h]h ]h"]h$]h&]uh1jhhjsubeh}(h]h ]h"]h$]h&]uh1jHhjshM? hj+subjI)}(h``struct usb_hcd *primary_hcd`` a pointer to the usb_hcd structure that is sharing the PCI device. Only allocate certain resources for the primary HCD h](jO)}(h``struct usb_hcd *primary_hcd``h]j)}(hjsh]hstruct usb_hcd *primary_hcd}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMA hjsubji)}(hhh]h)}(hwa pointer to the usb_hcd structure that is sharing the PCI device. Only allocate certain resources for the primary HCDh]hwa pointer to the usb_hcd structure that is sharing the PCI device. Only allocate certain resources for the primary HCD}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM@ hjsubah}(h]h ]h"]h$]h&]uh1jhhjsubeh}(h]h ]h"]h$]h&]uh1jHhjshMA hj+subeh}(h]h ]h"]h$]h&]uh1jChjsubh)}(h **Context**h]j.)}(hjth]hContext}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjtubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMC hjsubh)}(htask context, might sleep.h]htask context, might sleep.}(hj1thhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMC hjsubh)}(h**Description**h]j.)}(hjBth]h Description}(hjDthhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj@tubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chME hjsubh)}(hAllocate a struct usb_hcd, with extra space at the end for the HC driver's private data. Initialize the generic members of the hcd structure.h]hAllocate a struct usb_hcd, with extra space at the end for the HC driver’s private data. Initialize the generic members of the hcd structure.}(hjXthhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMD hjsubh)}(h **Return**h]j.)}(hjith]hReturn}(hjkthhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjgtubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMH hjsubh)}(hyOn success, a pointer to the created and initialized HCD structure. On failure (e.g. if memory is unavailable), ``NULL``.h](hpOn success, a pointer to the created and initialized HCD structure. On failure (e.g. if memory is unavailable), }(hjthhhNhNubj)}(h``NULL``h]hNULL}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubh.}(hjthhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMI hjsubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$usb_core.usb_create_hcd (C function)c.usb_core.usb_create_hcdhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hjstruct usb_hcd * usb_create_hcd (const struct hc_driver *driver, struct device *dev, const char *bus_name)h]j+)}(hhstruct usb_hcd *usb_create_hcd(const struct hc_driver *driver, struct device *dev, const char *bus_name)h](j1)}(hjh]hstruct}(hjthhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjthhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMU ubjC)}(h h]h }(hjthhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjthhhjthMU ubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjthhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjtmodnameN classnameNjLjO)}jR](jNjU)}jHusb_create_hcdsbc.usb_core.usb_create_hcdesbuh1hhjthhhjthMU ubjC)}(h h]h }(hjuhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjthhhjthMU ubjs)}(hjvh]h*}(hjuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjthhhjthMU ubj)}(husb_create_hcdh]j)}(hjth]husb_create_hcd}(hj uhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjuubah}(h]h ](jjeh"]h$]h&]jjuh1jhjthhhjthMU ubj)}(hJ(const struct hc_driver *driver, struct device *dev, const char *bus_name)h](j)}(hconst struct hc_driver *driverh](j1)}(hj4h]hconst}(hj;uhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj7uubjC)}(h h]h }(hjHuhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj7uubj1)}(hjh]hstruct}(hjVuhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj7uubjC)}(h h]h }(hjcuhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj7uubh)}(hhh]j)}(h hc_driverh]h hc_driver}(hjtuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjquubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjvumodnameN classnameNjLjO)}jR](jNjtc.usb_core.usb_create_hcdesbuh1hhj7uubjC)}(h h]h }(hjuhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj7uubjs)}(hjvh]h*}(hjuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj7uubj)}(hdriverh]hdriver}(hjuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj7uubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj3uubj)}(hstruct device *devh](j1)}(hjh]hstruct}(hjuhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjuubjC)}(h h]h }(hjuhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjuubh)}(hhh]j)}(hdeviceh]hdevice}(hjuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjumodnameN classnameNjLjO)}jR](jNjtc.usb_core.usb_create_hcdesbuh1hhjuubjC)}(h h]h }(hjvhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjuubjs)}(hjvh]h*}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjuubj)}(hdevh]hdev}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjuubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj3uubj)}(hconst char *bus_nameh](j1)}(hj4h]hconst}(hj8vhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj4vubjC)}(h h]h }(hjEvhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj4vubjT)}(hcharh]hchar}(hjSvhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj4vubjC)}(h h]h }(hjavhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj4vubjs)}(hjvh]h*}(hjovhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj4vubj)}(hbus_nameh]hbus_name}(hj|vhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4vubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj3uubeh}(h]h ]h"]h$]h&]jjuh1jhjthhhjthMU ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjthhhjthMU ubah}(h]jtah ](jjeh"]h$]h&]jj)jhuh1j$hjthMU hjthhubj)}(hhh]h)}(h&create and initialize an HCD structureh]h&create and initialize an HCD structure}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMU hjvhhubah}(h]h ]h"]h$]h&]uh1jhjthhhjthMU ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjvjjvj j!j"uh1jhhhjQShNhNubj$)}(hX4**Parameters** ``const struct hc_driver *driver`` HC driver that will use this hcd ``struct device *dev`` device for this HC, stored in hcd->self.controller ``const char *bus_name`` value to store in hcd->self.bus_name **Context** task context, might sleep. **Description** Allocate a struct usb_hcd, with extra space at the end for the HC driver's private data. Initialize the generic members of the hcd structure. **Return** On success, a pointer to the created and initialized HCD structure. On failure (e.g. if memory is unavailable), ``NULL``.h](h)}(h**Parameters**h]j.)}(hjvh]h Parameters}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjvubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMY hjvubjD)}(hhh](jI)}(hD``const struct hc_driver *driver`` HC driver that will use this hcd h](jO)}(h"``const struct hc_driver *driver``h]j)}(hjvh]hconst struct hc_driver *driver}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjvubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMV hjvubji)}(hhh]h)}(h HC driver that will use this hcdh]h HC driver that will use this hcd}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjvhMV hjvubah}(h]h ]h"]h$]h&]uh1jhhjvubeh}(h]h ]h"]h$]h&]uh1jHhjvhMV hjvubjI)}(hJ``struct device *dev`` device for this HC, stored in hcd->self.controller h](jO)}(h``struct device *dev``h]j)}(hj wh]hstruct device *dev}(hj"whhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMW hjwubji)}(hhh]h)}(h2device for this HC, stored in hcd->self.controllerh]h2device for this HC, stored in hcd->self.controller}(hj9whhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5whMW hj6wubah}(h]h ]h"]h$]h&]uh1jhhjwubeh}(h]h ]h"]h$]h&]uh1jHhj5whMW hjvubjI)}(h>``const char *bus_name`` value to store in hcd->self.bus_name h](jO)}(h``const char *bus_name``h]j)}(hjYwh]hconst char *bus_name}(hj[whhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWwubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMX hjSwubji)}(hhh]h)}(h$value to store in hcd->self.bus_nameh]h$value to store in hcd->self.bus_name}(hjrwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjnwhMX hjowubah}(h]h ]h"]h$]h&]uh1jhhjSwubeh}(h]h ]h"]h$]h&]uh1jHhjnwhMX hjvubeh}(h]h ]h"]h$]h&]uh1jChjvubh)}(h **Context**h]j.)}(hjwh]hContext}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjwubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMZ hjvubh)}(htask context, might sleep.h]htask context, might sleep.}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chMZ hjvubh)}(h**Description**h]j.)}(hjwh]h Description}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjwubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM\ hjvubh)}(hAllocate a struct usb_hcd, with extra space at the end for the HC driver's private data. Initialize the generic members of the hcd structure.h]hAllocate a struct usb_hcd, with extra space at the end for the HC driver’s private data. Initialize the generic members of the hcd structure.}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM[ hjvubh)}(h **Return**h]j.)}(hjwh]hReturn}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjwubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM_ hjvubh)}(hyOn success, a pointer to the created and initialized HCD structure. On failure (e.g. if memory is unavailable), ``NULL``.h](hpOn success, a pointer to the created and initialized HCD structure. On failure (e.g. if memory is unavailable), }(hjwhhhNhNubj)}(h``NULL``h]hNULL}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjwubh.}(hjwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM` hjvubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!usb_core.usb_add_hcd (C function)c.usb_core.usb_add_hcdhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hRint usb_add_hcd (struct usb_hcd *hcd, unsigned int irqnum, unsigned long irqflags)h]j+)}(hQint usb_add_hcd(struct usb_hcd *hcd, unsigned int irqnum, unsigned long irqflags)h](jT)}(hinth]hint}(hj9xhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj5xhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM ubjC)}(h h]h }(hjHxhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj5xhhhjGxhM ubj)}(h usb_add_hcdh]j)}(h usb_add_hcdh]h usb_add_hcd}(hjZxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjVxubah}(h]h ](jjeh"]h$]h&]jjuh1jhj5xhhhjGxhM ubj)}(hB(struct usb_hcd *hcd, unsigned int irqnum, unsigned long irqflags)h](j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hjvxhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjrxubjC)}(h h]h }(hjxhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjrxubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjxmodnameN classnameNjLjO)}jR](jNjU)}jHj\xsbc.usb_core.usb_add_hcdesbuh1hhjrxubjC)}(h h]h }(hjxhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjrxubjs)}(hjvh]h*}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjrxubj)}(hhcdh]hhcd}(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrxubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjnxubj)}(hunsigned int irqnumh](jT)}(hunsignedh]hunsigned}(hjxhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjxubjC)}(h h]h }(hjxhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjxubjT)}(hinth]hint}(hjyhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjxubjC)}(h h]h }(hjyhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjxubj)}(hirqnumh]hirqnum}(hj!yhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjnxubj)}(hunsigned long irqflagsh](jT)}(hunsignedh]hunsigned}(hj:yhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj6yubjC)}(h h]h }(hjHyhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj6yubjT)}(hlongh]hlong}(hjVyhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj6yubjC)}(h h]h }(hjdyhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj6yubj)}(hirqflagsh]hirqflags}(hjryhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6yubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjnxubeh}(h]h ]h"]h$]h&]jjuh1jhj5xhhhjGxhM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj1xhhhjGxhM ubah}(h]j,xah ](jjeh"]h$]h&]jj)jhuh1j$hjGxhM hj.xhhubj)}(hhh]h)}(h8finish generic HCD structure initialization and registerh]h8finish generic HCD structure initialization and register}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjyhhubah}(h]h ]h"]h$]h&]uh1jhj.xhhhjGxhM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjyjjyj j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct usb_hcd *hcd`` the usb_hcd structure to initialize ``unsigned int irqnum`` Interrupt line to allocate ``unsigned long irqflags`` Interrupt type flags **Description** Finish the remaining parts of generic HCD initialization: allocate the buffers of consistent memory, register the bus, request the IRQ line, and call the driver's reset() and start() routines.h](h)}(h**Parameters**h]j.)}(hjyh]h Parameters}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjyubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjyubjD)}(hhh](jI)}(h<``struct usb_hcd *hcd`` the usb_hcd structure to initialize h](jO)}(h``struct usb_hcd *hcd``h]j)}(hjyh]hstruct usb_hcd *hcd}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjyubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjyubji)}(hhh]h)}(h#the usb_hcd structure to initializeh]h#the usb_hcd structure to initialize}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhM hjyubah}(h]h ]h"]h$]h&]uh1jhhjyubeh}(h]h ]h"]h$]h&]uh1jHhjyhM hjyubjI)}(h3``unsigned int irqnum`` Interrupt line to allocate h](jO)}(h``unsigned int irqnum``h]j)}(hjzh]hunsigned int irqnum}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjzubji)}(hhh]h)}(hInterrupt line to allocateh]hInterrupt line to allocate}(hj/zhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+zhM hj,zubah}(h]h ]h"]h$]h&]uh1jhhjzubeh}(h]h ]h"]h$]h&]uh1jHhj+zhM hjyubjI)}(h0``unsigned long irqflags`` Interrupt type flags h](jO)}(h``unsigned long irqflags``h]j)}(hjOzh]hunsigned long irqflags}(hjQzhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMzubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjIzubji)}(hhh]h)}(hInterrupt type flagsh]hInterrupt type flags}(hjhzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjdzhM hjezubah}(h]h ]h"]h$]h&]uh1jhhjIzubeh}(h]h ]h"]h$]h&]uh1jHhjdzhM hjyubeh}(h]h ]h"]h$]h&]uh1jChjyubh)}(h**Description**h]j.)}(hjzh]h Description}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjzubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjyubh)}(hFinish the remaining parts of generic HCD initialization: allocate the buffers of consistent memory, register the bus, request the IRQ line, and call the driver's reset() and start() routines.h]hFinish the remaining parts of generic HCD initialization: allocate the buffers of consistent memory, register the bus, request the IRQ line, and call the driver’s reset() and start() routines.}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hjyubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$usb_core.usb_remove_hcd (C function)c.usb_core.usb_remove_hcdhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h)void usb_remove_hcd (struct usb_hcd *hcd)h]j+)}(h(void usb_remove_hcd(struct usb_hcd *hcd)h](jT)}(hvoidh]hvoid}(hjzhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjzhhhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM ubjC)}(h h]h }(hjzhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjzhhhjzhM ubj)}(husb_remove_hcdh]j)}(husb_remove_hcdh]husb_remove_hcd}(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzubah}(h]h ](jjeh"]h$]h&]jjuh1jhjzhhhjzhM ubj)}(h(struct usb_hcd *hcd)h]j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hj {hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj{ubjC)}(h h]h }(hj{hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj{ubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hj*{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'{ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj,{modnameN classnameNjLjO)}jR](jNjU)}jHjzsbc.usb_core.usb_remove_hcdesbuh1hhj{ubjC)}(h h]h }(hjK{hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj{ubjs)}(hjvh]h*}(hjY{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj{ubj)}(hhcdh]hhcd}(hjf{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj{ubah}(h]h ]h"]h$]h&]jjuh1jhjzhhhjzhM ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjzhhhjzhM ubah}(h]jzah ](jjeh"]h$]h&]jj)jhuh1j$hjzhM hjzhhubj)}(hhh]h)}(h$shutdown processing for generic HCDsh]h$shutdown processing for generic HCDs}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hj{hhubah}(h]h ]h"]h$]h&]uh1jhjzhhhjzhM ubeh}(h]h ](jfunctioneh"]h$]h&]jjjj{jj{j j!j"uh1jhhhjQShNhNubj$)}(h**Parameters** ``struct usb_hcd *hcd`` the usb_hcd structure to remove **Context** task context, might sleep. **Description** Disconnects the root hub, then reverses the effects of usb_add_hcd(), invoking the HCD's stop() method.h](h)}(h**Parameters**h]j.)}(hj{h]h Parameters}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj{ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hj{ubjD)}(hhh]jI)}(h8``struct usb_hcd *hcd`` the usb_hcd structure to remove h](jO)}(h``struct usb_hcd *hcd``h]j)}(hj{h]hstruct usb_hcd *hcd}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]uh1jNhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hj{ubji)}(hhh]h)}(hthe usb_hcd structure to removeh]hthe usb_hcd structure to remove}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{hM hj{ubah}(h]h ]h"]h$]h&]uh1jhhj{ubeh}(h]h ]h"]h$]h&]uh1jHhj{hM hj{ubah}(h]h ]h"]h$]h&]uh1jChj{ubh)}(h **Context**h]j.)}(hj |h]hContext}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj |ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hj{ubh)}(htask context, might sleep.h]htask context, might sleep.}(hj"|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hj{ubh)}(h**Description**h]j.)}(hj3|h]h Description}(hj5|hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj1|ubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hj{ubh)}(hgDisconnects the root hub, then reverses the effects of usb_add_hcd(), invoking the HCD's stop() method.h]hiDisconnects the root hub, then reverses the effects of usb_add_hcd(), invoking the HCD’s stop() method.}(hjI|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhZ/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:206: ./drivers/usb/core/hcd.chM hj{ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_core.usb_hcd_pci_probe (C function)c.usb_core.usb_hcd_pci_probehNtauh1jhjQShhhNhNubj )}(hhh](j%)}(hKint usb_hcd_pci_probe (struct pci_dev *dev, const struct hc_driver *driver)h]j+)}(hJint usb_hcd_pci_probe(struct pci_dev *dev, const struct hc_driver *driver)h](jT)}(hinth]hint}(hjx|hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjt|hhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKubjC)}(h h]h }(hj|hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjt|hhhj|hKubj)}(husb_hcd_pci_probeh]j)}(husb_hcd_pci_probeh]husb_hcd_pci_probe}(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjt|hhhj|hKubj)}(h5(struct pci_dev *dev, const struct hc_driver *driver)h](j)}(hstruct pci_dev *devh](j1)}(hjh]hstruct}(hj|hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj|ubjC)}(h h]h }(hj|hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj|ubh)}(hhh]j)}(hpci_devh]hpci_dev}(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj|modnameN classnameNjLjO)}jR](jNjU)}jHj|sbc.usb_core.usb_hcd_pci_probeesbuh1hhj|ubjC)}(h h]h }(hj|hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj|ubjs)}(hjvh]h*}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj|ubj)}(hdevh]hdev}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|ubj)}(hconst struct hc_driver *driverh](j1)}(hj4h]hconst}(hj(}hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj$}ubjC)}(h h]h }(hj5}hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj$}ubj1)}(hjh]hstruct}(hjC}hhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj$}ubjC)}(h h]h }(hjP}hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj$}ubh)}(hhh]j)}(h hc_driverh]h hc_driver}(hja}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^}ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjc}modnameN classnameNjLjO)}jR](jNj|c.usb_core.usb_hcd_pci_probeesbuh1hhj$}ubjC)}(h h]h }(hj}hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj$}ubjs)}(hjvh]h*}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj$}ubj)}(hdriverh]hdriver}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj$}ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj|ubeh}(h]h ]h"]h$]h&]jjuh1jhjt|hhhj|hKubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjp|hhhj|hKubah}(h]jk|ah ](jjeh"]h$]h&]jj)jhuh1j$hj|hKhjm|hhubj)}(hhh]h)}(hinitialize PCI-based HCDsh]hinitialize PCI-based HCDs}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}hhubah}(h]h ]h"]h$]h&]uh1jhjm|hhhj|hKubeh}(h]h ](jfunctioneh"]h$]h&]jjjj}jj}j j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct pci_dev *dev`` USB Host Controller being probed ``const struct hc_driver *driver`` USB HC driver handle **Context** task context, might sleep **Description** Allocates basic PCI resources for this USB host controller, and then invokes the start() method for the HCD associated with it through the hotplug entry's driver_data. Store this function in the HCD's struct pci_driver as probe(). **Return** 0 if successful.h](h)}(h**Parameters**h]j.)}(hj}h]h Parameters}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj}ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}ubjD)}(hhh](jI)}(h9``struct pci_dev *dev`` USB Host Controller being probed h](jO)}(h``struct pci_dev *dev``h]j)}(hj~h]hstruct pci_dev *dev}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj~ubji)}(hhh]h)}(h USB Host Controller being probedh]h USB Host Controller being probed}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~hKhj~ubah}(h]h ]h"]h$]h&]uh1jhhj~ubeh}(h]h ]h"]h$]h&]uh1jHhj~hKhj}ubjI)}(h8``const struct hc_driver *driver`` USB HC driver handle h](jO)}(h"``const struct hc_driver *driver``h]j)}(hj?~h]hconst struct hc_driver *driver}(hjA~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=~ubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj9~ubji)}(hhh]h)}(hUSB HC driver handleh]hUSB HC driver handle}(hjX~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjT~hKhjU~ubah}(h]h ]h"]h$]h&]uh1jhhj9~ubeh}(h]h ]h"]h$]h&]uh1jHhjT~hKhj}ubeh}(h]h ]h"]h$]h&]uh1jChj}ubh)}(h **Context**h]j.)}(hjz~h]hContext}(hj|~hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjx~ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}ubh)}(htask context, might sleeph]htask context, might sleep}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}ubh)}(h**Description**h]j.)}(hj~h]h Description}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj~ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}ubh)}(hAllocates basic PCI resources for this USB host controller, and then invokes the start() method for the HCD associated with it through the hotplug entry's driver_data.h]hAllocates basic PCI resources for this USB host controller, and then invokes the start() method for the HCD associated with it through the hotplug entry’s driver_data.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}ubh)}(h>Store this function in the HCD's struct pci_driver as probe().h]h@Store this function in the HCD’s struct pci_driver as probe().}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}ubh)}(h **Return**h]j.)}(hj~h]hReturn}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj~ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}ubh)}(h0 if successful.h]h0 if successful.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chKhj}ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.usb_hcd_pci_remove (C function)c.usb_core.usb_hcd_pci_removehNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h-void usb_hcd_pci_remove (struct pci_dev *dev)h]j+)}(h,void usb_hcd_pci_remove(struct pci_dev *dev)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM,ubjC)}(h h]h }(hj+hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjhhhj*hM,ubj)}(husb_hcd_pci_removeh]j)}(husb_hcd_pci_removeh]husb_hcd_pci_remove}(hj=hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj9ubah}(h]h ](jjeh"]h$]h&]jjuh1jhjhhhj*hM,ubj)}(h(struct pci_dev *dev)h]j)}(hstruct pci_dev *devh](j1)}(hjh]hstruct}(hjYhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjUubjC)}(h h]h }(hjfhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjUubh)}(hhh]j)}(hpci_devh]hpci_dev}(hjwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjymodnameN classnameNjLjO)}jR](jNjU)}jHj?sbc.usb_core.usb_hcd_pci_removeesbuh1hhjUubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjUubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjUubj)}(hdevh]hdev}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjUubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjQubah}(h]h ]h"]h$]h&]jjuh1jhjhhhj*hM,ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhj*hM,ubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hj*hM,hjhhubj)}(hhh]h)}(h&shutdown processing for PCI-based HCDsh]h&shutdown processing for PCI-based HCDs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM,hjhhubah}(h]h ]h"]h$]h&]uh1jhjhhhj*hM,ubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjQShNhNubj$)}(hXv**Parameters** ``struct pci_dev *dev`` USB Host Controller being removed **Context** task context, might sleep **Description** Reverses the effect of usb_hcd_pci_probe(), first invoking the HCD's stop() method. It is always called from a thread context, normally "rmmod", "apmd", or something similar. Store this function in the HCD's struct pci_driver as remove().h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM0hjubjD)}(hhh]jI)}(h:``struct pci_dev *dev`` USB Host Controller being removed h](jO)}(h``struct pci_dev *dev``h]j)}(hjh]hstruct pci_dev *dev}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM-hjubji)}(hhh]h)}(h!USB Host Controller being removedh]h!USB Host Controller being removed}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3hM-hj4ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhj3hM-hjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hjYh]hContext}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjWubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM/hjubh)}(htask context, might sleeph]htask context, might sleep}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM/hjubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hj~ubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM1hjubh)}(hReverses the effect of usb_hcd_pci_probe(), first invoking the HCD's stop() method. It is always called from a thread context, normally "rmmod", "apmd", or something similar.h]hReverses the effect of usb_hcd_pci_probe(), first invoking the HCD’s stop() method. It is always called from a thread context, normally “rmmod”, “apmd”, or something similar.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM0hjubh)}(h?Store this function in the HCD's struct pci_driver as remove().h]hAStore this function in the HCD’s struct pci_driver as remove().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chM4hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j*usb_core.usb_hcd_pci_shutdown (C function)c.usb_core.usb_hcd_pci_shutdownhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h/void usb_hcd_pci_shutdown (struct pci_dev *dev)h]j+)}(h.void usb_hcd_pci_shutdown(struct pci_dev *dev)h](jT)}(hvoidh]hvoid}(hjԀhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShjЀhhh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chMdubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjЀhhhjhMdubj)}(husb_hcd_pci_shutdownh]j)}(husb_hcd_pci_shutdownh]husb_hcd_pci_shutdown}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](jjeh"]h$]h&]jjuh1jhjЀhhhjhMdubj)}(h(struct pci_dev *dev)h]j)}(hstruct pci_dev *devh](j1)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hj ubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubh)}(hhh]j)}(hpci_devh]hpci_dev}(hj/hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetj1modnameN classnameNjLjO)}jR](jNjU)}jHjsbc.usb_core.usb_hcd_pci_shutdownesbuh1hhj ubjC)}(h h]h }(hjPhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj ubjs)}(hjvh]h*}(hj^hhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhj ubj)}(hdevh]hdev}(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphjjuh1jhj ubah}(h]h ]h"]h$]h&]jjuh1jhjЀhhhjhMdubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj̀hhhjhMdubah}(h]jǀah ](jjeh"]h$]h&]jj)jhuh1j$hjhMdhjɀhhubj)}(hhh]h)}(hshutdown host controllerh]hshutdown host controller}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chMdhjhhubah}(h]h ]h"]h$]h&]uh1jhjɀhhhjhMdubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjQShNhNubj$)}(hL**Parameters** ``struct pci_dev *dev`` USB Host Controller being shutdownh](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chMhhjubjD)}(hhh]jI)}(h:``struct pci_dev *dev`` USB Host Controller being shutdownh](jO)}(h``struct pci_dev *dev``h]j)}(hjցh]hstruct pci_dev *dev}(hj؁hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjԁubah}(h]h ]h"]h$]h&]uh1jNh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chMjhjЁubji)}(hhh]h)}(h"USB Host Controller being shutdownh]h"USB Host Controller being shutdown}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh^/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:209: ./drivers/usb/core/hcd-pci.chMehjubah}(h]h ]h"]h$]h&]uh1jhhjЁubeh}(h]h ]h"]h$]h&]uh1jHhjhMjhj́ubah}(h]h ]h"]h$]h&]uh1jChjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j'usb_core.hcd_buffer_create (C function)c.usb_core.hcd_buffer_createhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h+int hcd_buffer_create (struct usb_hcd *hcd)h]j+)}(h*int hcd_buffer_create(struct usb_hcd *hcd)h](jT)}(hinth]hint}(hj0hhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj,hhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK4ubjC)}(h h]h }(hj?hhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj,hhhj>hK4ubj)}(hhcd_buffer_createh]j)}(hhcd_buffer_createh]hhcd_buffer_create}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjMubah}(h]h ](jjeh"]h$]h&]jjuh1jhj,hhhj>hK4ubj)}(h(struct usb_hcd *hcd)h]j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hjmhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjiubjC)}(h h]h }(hjzhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjiubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjmodnameN classnameNjLjO)}jR](jNjU)}jHjSsbc.usb_core.hcd_buffer_createesbuh1hhjiubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjiubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjiubj)}(hhcdh]hhcd}(hjǂhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjeubah}(h]h ]h"]h$]h&]jjuh1jhj,hhhj>hK4ubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhj(hhhj>hK4ubah}(h]j#ah ](jjeh"]h$]h&]jj)jhuh1j$hj>hK4hj%hhubj)}(hhh]h)}(hinitialize buffer poolsh]hinitialize buffer pools}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK4hjhhubah}(h]h ]h"]h$]h&]uh1jhj%hhhj>hK4ubeh}(h]h ](jfunctioneh"]h$]h&]jjjj jj j j!j"uh1jhhhjQShNhNubj$)}(hX**Parameters** ``struct usb_hcd *hcd`` the bus whose buffer pools are to be initialized **Context** task context, might sleep **Description** Call this as part of initializing a host controller that uses the dma memory allocators. It initializes some pools of dma-coherent memory that will be shared by all drivers using that controller. Call hcd_buffer_destroy() to clean up after using those pools. **Return** 0 if successful. A negative errno value otherwise.h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK8hj ubjD)}(hhh]jI)}(hI``struct usb_hcd *hcd`` the bus whose buffer pools are to be initialized h](jO)}(h``struct usb_hcd *hcd``h]j)}(hj2h]hstruct usb_hcd *hcd}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj0ubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK5hj,ubji)}(hhh]h)}(h0the bus whose buffer pools are to be initializedh]h0the bus whose buffer pools are to be initialized}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjGhK5hjHubah}(h]h ]h"]h$]h&]uh1jhhj,ubeh}(h]h ]h"]h$]h&]uh1jHhjGhK5hj)ubah}(h]h ]h"]h$]h&]uh1jChj ubh)}(h **Context**h]j.)}(hjmh]hContext}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjkubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK7hj ubh)}(htask context, might sleeph]htask context, might sleep}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK7hj ubh)}(h**Description**h]j.)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK9hj ubh)}(hCall this as part of initializing a host controller that uses the dma memory allocators. It initializes some pools of dma-coherent memory that will be shared by all drivers using that controller.h]hCall this as part of initializing a host controller that uses the dma memory allocators. It initializes some pools of dma-coherent memory that will be shared by all drivers using that controller.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK8hj ubh)}(h>Call hcd_buffer_destroy() to clean up after using those pools.h]h>Call hcd_buffer_destroy() to clean up after using those pools.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chKhj ubh)}(h20 if successful. A negative errno value otherwise.h]h20 if successful. A negative errno value otherwise.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK?hj ubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(usb_core.hcd_buffer_destroy (C function)c.usb_core.hcd_buffer_destroyhNtauh1jhjQShhhNhNubj )}(hhh](j%)}(h-void hcd_buffer_destroy (struct usb_hcd *hcd)h]j+)}(h,void hcd_buffer_destroy(struct usb_hcd *hcd)h](jT)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j`ah"]h$]h&]uh1jShj hhh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chKZubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhj hhhjhKZubj)}(hhcd_buffer_destroyh]j)}(hhcd_buffer_destroyh]hhcd_buffer_destroy}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj,ubah}(h]h ](jjeh"]h$]h&]jjuh1jhj hhhjhKZubj)}(h(struct usb_hcd *hcd)h]j)}(hstruct usb_hcd *hcdh](j1)}(hjh]hstruct}(hjLhhhNhNubah}(h]h ]j=ah"]h$]h&]uh1j0hjHubjC)}(h h]h }(hjYhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjHubh)}(hhh]j)}(husb_hcdh]husb_hcd}(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjgubah}(h]h ]h"]h$]h&] refdomainjreftypejH reftargetjlmodnameN classnameNjLjO)}jR](jNjU)}jHj2sbc.usb_core.hcd_buffer_destroyesbuh1hhjHubjC)}(h h]h }(hjhhhNhNubah}(h]h ]jOah"]h$]h&]uh1jBhjHubjs)}(hjvh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jrhjHubj)}(hhcdh]hhcd}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjHubeh}(h]h ]h"]h$]h&]noemphjjuh1jhjDubah}(h]h ]h"]h$]h&]jjuh1jhj hhhjhKZubeh}(h]h ]h"]h$]h&]jjjuh1j*jjhjhhhjhKZubah}(h]jah ](jjeh"]h$]h&]jj)jhuh1j$hjhKZhjhhubj)}(hhh]h)}(hdeallocate buffer poolsh]hdeallocate buffer pools}(hjЄhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chKZhj̈́hhubah}(h]h ]h"]h$]h&]uh1jhjhhhjhKZubeh}(h]h ](jfunctioneh"]h$]h&]jjjjjjj j!j"uh1jhhhjQShNhNubj$)}(h**Parameters** ``struct usb_hcd *hcd`` the bus whose buffer pools are to be destroyed **Context** task context, might sleep **Description** This frees the buffer pools created by hcd_buffer_create().h](h)}(h**Parameters**h]j.)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK^hjubjD)}(hhh]jI)}(hG``struct usb_hcd *hcd`` the bus whose buffer pools are to be destroyed h](jO)}(h``struct usb_hcd *hcd``h]j)}(hjh]hstruct usb_hcd *hcd}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jNh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK[hj ubji)}(hhh]h)}(h.the bus whose buffer pools are to be destroyedh]h.the bus whose buffer pools are to be destroyed}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&hK[hj'ubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhj&hK[hjubah}(h]h ]h"]h$]h&]uh1jChjubh)}(h **Context**h]j.)}(hjLh]hContext}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjJubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK]hjubh)}(htask context, might sleeph]htask context, might sleep}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK]hjubh)}(h**Description**h]j.)}(hjsh]h Description}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1j-hjqubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK_hjubh)}(h;This frees the buffer pools created by hcd_buffer_create().h]h;This frees the buffer pools created by hcd_buffer_create().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hh]/var/lib/git/docbuild/linux/Documentation/driver-api/usb/usb:212: ./drivers/usb/core/buffer.chK^hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j#hjQShhhNhNubeh}(h]host-controller-apisah ]h"]host controller apisah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hThe USB character device nodesh]hThe USB character device nodes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hX.This chapter presents the Linux character device nodes. You may prefer to avoid writing new kernel code for your USB driver. User mode device drivers are usually packaged as applications or libraries, and may use character devices through some programming library that wraps it. Such libraries include:h]hX.This chapter presents the Linux character device nodes. You may prefer to avoid writing new kernel code for your USB driver. User mode device drivers are usually packaged as applications or libraries, and may use character devices through some programming library that wraps it. Such libraries include:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj7)}(ho- `libusb `__ for C/C++, and - `jUSB `__ for Java. h]j)}(hhh](j)}(h9`libusb `__ for C/C++, andh]h)}(hjυh](h reference)}(h*`libusb `__h]hlibusb}(hjօhhhNhNubah}(h]h ]h"]h$]h&]namelibusbrefurihttp://libusb.sourceforge.netuh1jԅhjхubh for C/C++, and}(hjхhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjͅubah}(h]h ]h"]h$]h&]uh1jhjʅubj)}(h1`jUSB `__ for Java. h]h)}(h0`jUSB `__ for Java.h](jՅ)}(h&`jUSB `__h]hjUSB}(hjhhhNhNubah}(h]h ]h"]h$]h&]namejUSBjhttp://jUSB.sourceforge.netuh1jԅhjubh for Java.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjʅubeh}(h]h ]h"]h$]h&]jjuh1jhhhKhjƅubah}(h]h ]h"]h$]h&]uh1j7hhhKhjhhubh)}(hSome old information about it can be seen at the "USB Device Filesystem" section of the USB Guide. The latest copy of the USB Guide can be found at http://www.linux-usb.org/h](hSome old information about it can be seen at the “USB Device Filesystem” section of the USB Guide. The latest copy of the USB Guide can be found at }(hj-hhhNhNubjՅ)}(hhttp://www.linux-usb.org/h]hhttp://www.linux-usb.org/}(hj5hhhNhNubah}(h]h ]h"]h$]h&]refurij7uh1jԅhj-ubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubhnote)}(hX"- They were used to be implemented via *usbfs*, but this is not part of the sysfs debug interface. - This particular documentation is incomplete, especially with respect to the asynchronous mode. As of kernel 2.5.66 the code and this (new) documentation need to be cross-reviewed.h](j)}(hhh]j)}(haThey were used to be implemented via *usbfs*, but this is not part of the sysfs debug interface. h]h)}(h`They were used to be implemented via *usbfs*, but this is not part of the sysfs debug interface.h](h%They were used to be implemented via }(hjWhhhNhNubj)}(h*usbfs*h]husbfs}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubh4, but this is not part of the sysfs debug interface.}(hjWhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjSubah}(h]h ]h"]h$]h&]uh1jhjPubah}(h]h ]h"]h$]h&]jjuh1jhhhKhjLubj7)}(h- This particular documentation is incomplete, especially with respect to the asynchronous mode. As of kernel 2.5.66 the code and this (new) documentation need to be cross-reviewed.h]j)}(hhh]j)}(hThis particular documentation is incomplete, especially with respect to the asynchronous mode. As of kernel 2.5.66 the code and this (new) documentation need to be cross-reviewed.h]h)}(hThis particular documentation is incomplete, especially with respect to the asynchronous mode. As of kernel 2.5.66 the code and this (new) documentation need to be cross-reviewed.h]hThis particular documentation is incomplete, especially with respect to the asynchronous mode. As of kernel 2.5.66 the code and this (new) documentation need to be cross-reviewed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhhhKhjubah}(h]h ]h"]h$]h&]uh1j7hhhKhjLubeh}(h]h ]h"]h$]h&]uh1jJhjhhhhhNubh)}(hhh](h)}(hWhat files are in "devtmpfs"?h]h!What files are in “devtmpfs”?}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hDConventionally mounted at ``/dev/bus/usb/``, usbfs features include:h](hConventionally mounted at }(hjņhhhNhNubj)}(h``/dev/bus/usb/``h]h /dev/bus/usb/}(hj͆hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjņubh, usbfs features include:}(hjņhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hhh]j)}(h``/dev/bus/usb/BBB/DDD`` ... magic files exposing the each device's configuration descriptors, and supporting a series of ioctls for making device requests, including I/O to devices. (Purely for access by programs.) h]h)}(h``/dev/bus/usb/BBB/DDD`` ... magic files exposing the each device's configuration descriptors, and supporting a series of ioctls for making device requests, including I/O to devices. (Purely for access by programs.)h](j)}(h``/dev/bus/usb/BBB/DDD``h]h/dev/bus/usb/BBB/DDD}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh ... magic files exposing the each device’s configuration descriptors, and supporting a series of ioctls for making device requests, including I/O to devices. (Purely for access by programs.)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubah}(h]h ]h"]h$]h&]jjuh1jhhhKhjhhubh)}(hX}Each bus is given a number (``BBB``) based on when it was enumerated; within each bus, each device is given a similar number (``DDD``). Those ``BBB/DDD`` paths are not "stable" identifiers; expect them to change even if you always leave the devices plugged in to the same hub port. *Don't even think of saving these in application configuration files.* Stable identifiers are available, for user mode applications that want to use them. HID and networking devices expose these stable IDs, so that for example you can be sure that you told the right UPS to power down its second server. Pleast note that it doesn't (yet) expose those IDs.h](hEach bus is given a number (}(hjhhhNhNubj)}(h``BBB``h]hBBB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh[) based on when it was enumerated; within each bus, each device is given a similar number (}(hjhhhNhNubj)}(h``DDD``h]hDDD}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh ). Those }(hjhhhNhNubj)}(h ``BBB/DDD``h]hBBB/DDD}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh paths are not “stable” identifiers; expect them to change even if you always leave the devices plugged in to the same hub port. }(hjhhhNhNubj)}(hF*Don't even think of saving these in application configuration files.*h]hFDon’t even think of saving these in application configuration files.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX Stable identifiers are available, for user mode applications that want to use them. HID and networking devices expose these stable IDs, so that for example you can be sure that you told the right UPS to power down its second server. Pleast note that it doesn’t (yet) expose those IDs.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]what-files-are-in-devtmpfsah ]h"]what files are in "devtmpfs"?ah$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(h/dev/bus/usb/BBB/DDDh]h/dev/bus/usb/BBB/DDD}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjrhhhhhMubh)}(h+Use these files in one of these basic ways:h]h+Use these files in one of these basic ways:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjrhhubj)}(hhh](j)}(hXB*They can be read,* producing first the device descriptor (18 bytes) and then the descriptors for the current configuration. See the USB 2.0 spec for details about those binary data formats. You'll need to convert most multibyte values from little endian format to your native host byte order, although a few of the fields in the device descriptor (both of the BCD-encoded fields, and the vendor and product IDs) will be byteswapped for you. Note that configuration descriptors include descriptors for interfaces, altsettings, endpoints, and maybe additional class descriptors. h]h)}(hXA*They can be read,* producing first the device descriptor (18 bytes) and then the descriptors for the current configuration. See the USB 2.0 spec for details about those binary data formats. You'll need to convert most multibyte values from little endian format to your native host byte order, although a few of the fields in the device descriptor (both of the BCD-encoded fields, and the vendor and product IDs) will be byteswapped for you. Note that configuration descriptors include descriptors for interfaces, altsettings, endpoints, and maybe additional class descriptors.h](j)}(h*They can be read,*h]hThey can be read,}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX0 producing first the device descriptor (18 bytes) and then the descriptors for the current configuration. See the USB 2.0 spec for details about those binary data formats. You’ll need to convert most multibyte values from little endian format to your native host byte order, although a few of the fields in the device descriptor (both of the BCD-encoded fields, and the vendor and product IDs) will be byteswapped for you. Note that configuration descriptors include descriptors for interfaces, altsettings, endpoints, and maybe additional class descriptors.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubj)}(hX=*Perform USB operations* using *ioctl()* requests to make endpoint I/O requests (synchronously or asynchronously) or manage the device. These requests need the ``CAP_SYS_RAWIO`` capability, as well as filesystem access permissions. Only one ioctl request can be made on one of these device files at a time. This means that if you are synchronously reading an endpoint from one thread, you won't be able to write to a different endpoint from another thread until the read completes. This works for *half duplex* protocols, but otherwise you'd use asynchronous i/o requests. h]h)}(hX<*Perform USB operations* using *ioctl()* requests to make endpoint I/O requests (synchronously or asynchronously) or manage the device. These requests need the ``CAP_SYS_RAWIO`` capability, as well as filesystem access permissions. Only one ioctl request can be made on one of these device files at a time. This means that if you are synchronously reading an endpoint from one thread, you won't be able to write to a different endpoint from another thread until the read completes. This works for *half duplex* protocols, but otherwise you'd use asynchronous i/o requests.h](j)}(h*Perform USB operations*h]hPerform USB operations}(hj‡hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh using }(hjhhhNhNubj)}(h *ioctl()*h]hioctl()}(hjԇhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhx requests to make endpoint I/O requests (synchronously or asynchronously) or manage the device. These requests need the }(hjhhhNhNubj)}(h``CAP_SYS_RAWIO``h]h CAP_SYS_RAWIO}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhXB capability, as well as filesystem access permissions. Only one ioctl request can be made on one of these device files at a time. This means that if you are synchronously reading an endpoint from one thread, you won’t be able to write to a different endpoint from another thread until the read completes. This works for }(hjhhhNhNubj)}(h *half duplex*h]h half duplex}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh@ protocols, but otherwise you’d use asynchronous i/o requests.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubeh}(h]h ]h"]h$]h&]jjuh1jhhhM hjrhhubh)}(hXEach connected USB device has one file. The ``BBB`` indicates the bus number. The ``DDD`` indicates the device address on that bus. Both of these numbers are assigned sequentially, and can be reused, so you can't rely on them for stable access to devices. For example, it's relatively common for devices to re-enumerate while they are still connected (perhaps someone jostled their power supply, hub, or USB cable), so a device might be ``002/027`` when you first connect it and ``002/048`` sometime later.h](h-Each connected USB device has one file. The }(hjhhhNhNubj)}(h``BBB``h]hBBB}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh indicates the bus number. The }(hjhhhNhNubj)}(h``DDD``h]hDDD}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhXb indicates the device address on that bus. Both of these numbers are assigned sequentially, and can be reused, so you can’t rely on them for stable access to devices. For example, it’s relatively common for devices to re-enumerate while they are still connected (perhaps someone jostled their power supply, hub, or USB cable), so a device might be }(hjhhhNhNubj)}(h ``002/027``h]h002/027}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh when you first connect it and }(hjhhhNhNubj)}(h ``002/048``h]h002/048}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh sometime later.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjrhhubh)}(hXgThese files can be read as binary data. The binary data consists of first the device descriptor, then the descriptors for each configuration of the device. Multi-byte fields in the device descriptor are converted to host endianness by the kernel. The configuration descriptors are in bus endian format! The configuration descriptor are wTotalLength bytes apart. If a device returns less configuration descriptor data than indicated by wTotalLength there will be a hole in the file for the missing bytes. This information is also shown in text form by the ``/sys/kernel/debug/usb/devices`` file, described later.h](hX/These files can be read as binary data. The binary data consists of first the device descriptor, then the descriptors for each configuration of the device. Multi-byte fields in the device descriptor are converted to host endianness by the kernel. The configuration descriptors are in bus endian format! The configuration descriptor are wTotalLength bytes apart. If a device returns less configuration descriptor data than indicated by wTotalLength there will be a hole in the file for the missing bytes. This information is also shown in text form by the }(hjrhhhNhNubj)}(h!``/sys/kernel/debug/usb/devices``h]h/sys/kernel/debug/usb/devices}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrubh file, described later.}(hjrhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM&hjrhhubh)}(hXWThese files may also be used to write user-level drivers for the USB devices. You would open the ``/dev/bus/usb/BBB/DDD`` file read/write, read its descriptors to make sure it's the device you expect, and then bind to an interface (or perhaps several) using an ioctl call. You would issue more ioctls to the device to communicate to it using control, bulk, or other kinds of USB transfers. The IOCTLs are listed in the ```` file, and at this writing the source code (``linux/drivers/usb/core/devio.c``) is the primary reference for how to access devices through those files.h](hbThese files may also be used to write user-level drivers for the USB devices. You would open the }(hjhhhNhNubj)}(h``/dev/bus/usb/BBB/DDD``h]h/dev/bus/usb/BBB/DDD}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX. file read/write, read its descriptors to make sure it’s the device you expect, and then bind to an interface (or perhaps several) using an ioctl call. You would issue more ioctls to the device to communicate to it using control, bulk, or other kinds of USB transfers. The IOCTLs are listed in the }(hjhhhNhNubj)}(h````h]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, file, and at this writing the source code (}(hjhhhNhNubj)}(h"``linux/drivers/usb/core/devio.c``h]hlinux/drivers/usb/core/devio.c}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhI) is the primary reference for how to access devices through those files.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM0hjrhhubh)}(hXNote that since by default these ``BBB/DDD`` files are writable only by root, only root can write such user mode drivers. You can selectively grant read/write permissions to other users by using ``chmod``. Also, usbfs mount options such as ``devmode=0666`` may be helpful.h](h!Note that since by default these }(hjֈhhhNhNubj)}(h ``BBB/DDD``h]hBBB/DDD}(hjވhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjֈubh files are writable only by root, only root can write such user mode drivers. You can selectively grant read/write permissions to other users by using }(hjֈhhhNhNubj)}(h ``chmod``h]hchmod}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjֈubh%. Also, usbfs mount options such as }(hjֈhhhNhNubj)}(h``devmode=0666``h]h devmode=0666}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjֈubh may be helpful.}(hjֈhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM:hjrhhubeh}(h]dev-bus-usb-bbb-dddah ]h"]/dev/bus/usb/bbb/dddah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hLife Cycle of User Mode Driversh]hLife Cycle of User Mode Drivers}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hhhhhMAubh)}(hX(Such a driver first needs to find a device file for a device it knows how to handle. Maybe it was told about it because a ``/sbin/hotplug`` event handling agent chose that driver to handle the new device. Or maybe it's an application that scans all the ``/dev/bus/usb`` device files, and ignores most devices. In either case, it should :c:func:`read()` all the descriptors from the device file, and check them against what it knows how to handle. It might just reject everything except a particular vendor and product ID, or need a more complex policy.h](hzSuch a driver first needs to find a device file for a device it knows how to handle. Maybe it was told about it because a }(hj3hhhNhNubj)}(h``/sbin/hotplug``h]h /sbin/hotplug}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubht event handling agent chose that driver to handle the new device. Or maybe it’s an application that scans all the }(hj3hhhNhNubj)}(h``/dev/bus/usb``h]h /dev/bus/usb}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubhC device files, and ignores most devices. In either case, it should }(hj3hhhNhNubh)}(h:c:func:`read()`h]j)}(hjah]hread()}(hjchhhNhNubah}(h]h ](jdjc-funceh"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]refdocjd refdomainjreftypefunc refexplicitrefwarnjLjSjdreaduh1hhhhMChj3ubh all the descriptors from the device file, and check them against what it knows how to handle. It might just reject everything except a particular vendor and product ID, or need a more complex policy.}(hj3hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMChj"hhubh)}(hNever assume there will only be one such device on the system at a time! If your code can't handle more than one device at a time, at least detect when there's more than one, and have your users choose which device to use.h]hNever assume there will only be one such device on the system at a time! If your code can’t handle more than one device at a time, at least detect when there’s more than one, and have your users choose which device to use.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMLhj"hhubh)}(hXlOnce your user mode driver knows what device to use, it interacts with it in either of two styles. The simple style is to make only control requests; some devices don't need more complex interactions than those. (An example might be software using vendor-specific control requests for some initialization or configuration tasks, with a kernel driver for the rest.)h]hXnOnce your user mode driver knows what device to use, it interacts with it in either of two styles. The simple style is to make only control requests; some devices don’t need more complex interactions than those. (An example might be software using vendor-specific control requests for some initialization or configuration tasks, with a kernel driver for the rest.)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMQhj"hhubh)}(hX(More likely, you need a more complex style driver: one using non-control endpoints, reading or writing data and claiming exclusive use of an interface. *Bulk* transfers are easiest to use, but only their sibling *interrupt* transfers work with low speed devices. Both interrupt and *isochronous* transfers offer service guarantees because their bandwidth is reserved. Such "periodic" transfers are awkward to use through usbfs, unless you're using the asynchronous calls. However, interrupt transfers can also be used in a synchronous "one shot" style.h](hMore likely, you need a more complex style driver: one using non-control endpoints, reading or writing data and claiming exclusive use of an interface. }(hjhhhNhNubj)}(h*Bulk*h]hBulk}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh6 transfers are easiest to use, but only their sibling }(hjhhhNhNubj)}(h *interrupt*h]h interrupt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh; transfers work with low speed devices. Both interrupt and }(hjhhhNhNubj)}(h *isochronous*h]h isochronous}(hjЉhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX  transfers offer service guarantees because their bandwidth is reserved. Such “periodic” transfers are awkward to use through usbfs, unless you’re using the asynchronous calls. However, interrupt transfers can also be used in a synchronous “one shot” style.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMXhj"hhubh)}(hYour user-mode driver should never need to worry about cleaning up request state when the device is disconnected, although it should close its open file descriptors as soon as it starts seeing the ENODEV errors.h]hYour user-mode driver should never need to worry about cleaning up request state when the device is disconnected, although it should close its open file descriptors as soon as it starts seeing the ENODEV errors.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMahj"hhubeh}(h]life-cycle-of-user-mode-driversah ]h"]life cycle of user mode driversah$]h&]uh1hhjhhhhhMAubh)}(hhh](h)}(hThe ioctl() Requestsh]hThe ioctl() Requests}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMfubh)}(hZTo use these ioctls, you need to include the following headers in your userspace program::h]hYTo use these ioctls, you need to include the following headers in your userspace program:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhhjhhubj )}(hQ#include #include #include h]hQ#include #include #include }hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMkhjhhubh)}(hThe standard USB device model requests, from "Chapter 9" of the USB 2.0 specification, are automatically included from the ```` header.h](hThe standard USB device model requests, from “Chapter 9” of the USB 2.0 specification, are automatically included from the }(hj+hhhNhNubj)}(h````h]h}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubh header.}(hj+hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMohjhhubh)}(hX"Unless noted otherwise, the ioctl requests described here will update the modification time on the usbfs file to which they are applied (unless they fail). A return of zero indicates success; otherwise, a standard USB error code is returned (These are documented in :ref:`usb-error-codes`).h](hX Unless noted otherwise, the ioctl requests described here will update the modification time on the usbfs file to which they are applied (unless they fail). A return of zero indicates success; otherwise, a standard USB error code is returned (These are documented in }(hjKhhhNhNubh)}(h:ref:`usb-error-codes`h]hinline)}(hjUh]husb-error-codes}(hjYhhhNhNubah}(h]h ](jdstdstd-refeh"]h$]h&]uh1jWhjSubah}(h]h ]h"]h$]h&]refdocjd refdomainjcreftyperef refexplicitrefwarnjdusb-error-codesuh1hhhhMshjKubh).}(hjKhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMshjhhubh)}(hXJEach of these files multiplexes access to several I/O streams, one per endpoint. Each device has one control endpoint (endpoint zero) which supports a limited RPC style RPC access. Devices are configured by hub_wq (in the kernel) setting a device-wide *configuration* that affects things like power consumption and basic functionality. The endpoints are part of USB *interfaces*, which may have *altsettings* affecting things like which endpoints are available. Many devices only have a single configuration and interface, so drivers for them will ignore configurations and altsettings.h](hEach of these files multiplexes access to several I/O streams, one per endpoint. Each device has one control endpoint (endpoint zero) which supports a limited RPC style RPC access. Devices are configured by hub_wq (in the kernel) setting a device-wide }(hjhhhNhNubj)}(h*configuration*h]h configuration}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhc that affects things like power consumption and basic functionality. The endpoints are part of USB }(hjhhhNhNubj)}(h *interfaces*h]h interfaces}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, which may have }(hjhhhNhNubj)}(h *altsettings*h]h altsettings}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh affecting things like which endpoints are available. Many devices only have a single configuration and interface, so drivers for them will ignore configurations and altsettings.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMyhjhhubh)}(hhh](h)}(hManagement/Status Requestsh]hManagement/Status Requests}(hjƊhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjÊhhhhhMubh)}(hA number of usbfs requests don't deal very directly with device I/O. They mostly relate to device management and status. These are all synchronous requests.h]hA number of usbfs requests don’t deal very directly with device I/O. They mostly relate to device management and status. These are all synchronous requests.}(hjԊhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjÊhhubjD)}(hhh](jI)}(hXWUSBDEVFS_CLAIMINTERFACE This is used to force usbfs to claim a specific interface, which has not previously been claimed by usbfs or any other kernel driver. The ioctl parameter is an integer holding the number of the interface (bInterfaceNumber from descriptor). Note that if your driver doesn't claim an interface before trying to use one of its endpoints, and no other driver has bound to it, then the interface is automatically claimed by usbfs. This claim will be released by a RELEASEINTERFACE ioctl, or by closing the file descriptor. File modification time is not updated by this request. h](jO)}(hUSBDEVFS_CLAIMINTERFACEh]hUSBDEVFS_CLAIMINTERFACE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjubji)}(hhh](h)}(hThis is used to force usbfs to claim a specific interface, which has not previously been claimed by usbfs or any other kernel driver. The ioctl parameter is an integer holding the number of the interface (bInterfaceNumber from descriptor).h]hThis is used to force usbfs to claim a specific interface, which has not previously been claimed by usbfs or any other kernel driver. The ioctl parameter is an integer holding the number of the interface (bInterfaceNumber from descriptor).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hNote that if your driver doesn't claim an interface before trying to use one of its endpoints, and no other driver has bound to it, then the interface is automatically claimed by usbfs.h]hNote that if your driver doesn’t claim an interface before trying to use one of its endpoints, and no other driver has bound to it, then the interface is automatically claimed by usbfs.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hThis claim will be released by a RELEASEINTERFACE ioctl, or by closing the file descriptor. File modification time is not updated by this request.h]hThis claim will be released by a RELEASEINTERFACE ioctl, or by closing the file descriptor. File modification time is not updated by this request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjubjI)}(hXUSBDEVFS_CONNECTINFO Says whether the device is lowspeed. The ioctl parameter points to a structure like this:: struct usbdevfs_connectinfo { unsigned int devnum; unsigned char slow; }; File modification time is not updated by this request. *You can't tell whether a "not slow" device is connected at high speed (480 MBit/sec) or just full speed (12 MBit/sec).* You should know the devnum value already, it's the DDD value of the device file name. h](jO)}(hUSBDEVFS_CONNECTINFOh]hUSBDEVFS_CONNECTINFO}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhj0ubji)}(hhh](h)}(hZSays whether the device is lowspeed. The ioctl parameter points to a structure like this::h]hYSays whether the device is lowspeed. The ioctl parameter points to a structure like this:}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjBubj )}(h\struct usbdevfs_connectinfo { unsigned int devnum; unsigned char slow; };h]h\struct usbdevfs_connectinfo { unsigned int devnum; unsigned char slow; };}hjSsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjBubh)}(h6File modification time is not updated by this request.h]h6File modification time is not updated by this request.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjBubh)}(h*You can't tell whether a "not slow" device is connected at high speed (480 MBit/sec) or just full speed (12 MBit/sec).* You should know the devnum value already, it's the DDD value of the device file name.h](j)}(hx*You can't tell whether a "not slow" device is connected at high speed (480 MBit/sec) or just full speed (12 MBit/sec).*h]h|You can’t tell whether a “not slow” device is connected at high speed (480 MBit/sec) or just full speed (12 MBit/sec).}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjoubhX You should know the devnum value already, it’s the DDD value of the device file name.}(hjohhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjBubeh}(h]h ]h"]h$]h&]uh1jhhj0ubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjhhubjI)}(hUSBDEVFS_GET_SPEED Returns the speed of the device. The speed is returned as a numerical value in accordance with enum usb_device_speed File modification time is not updated by this request. h](jO)}(hUSBDEVFS_GET_SPEEDh]hUSBDEVFS_GET_SPEED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjubji)}(hhh](h)}(htReturns the speed of the device. The speed is returned as a numerical value in accordance with enum usb_device_speedh]htReturns the speed of the device. The speed is returned as a numerical value in accordance with enum usb_device_speed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(h6File modification time is not updated by this request.h]h6File modification time is not updated by this request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjhhubjI)}(hXaUSBDEVFS_GETDRIVER Returns the name of the kernel driver bound to a given interface (a string). Parameter is a pointer to this structure, which is modified:: struct usbdevfs_getdriver { unsigned int interface; char driver[USBDEVFS_MAXDRIVERNAME + 1]; }; File modification time is not updated by this request. h](jO)}(hUSBDEVFS_GETDRIVERh]hUSBDEVFS_GETDRIVER}(hj؋hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjԋubji)}(hhh](h)}(hReturns the name of the kernel driver bound to a given interface (a string). Parameter is a pointer to this structure, which is modified::h]hReturns the name of the kernel driver bound to a given interface (a string). Parameter is a pointer to this structure, which is modified:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj )}(hystruct usbdevfs_getdriver { unsigned int interface; char driver[USBDEVFS_MAXDRIVERNAME + 1]; };h]hystruct usbdevfs_getdriver { unsigned int interface; char driver[USBDEVFS_MAXDRIVERNAME + 1]; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjubh)}(h6File modification time is not updated by this request.h]h6File modification time is not updated by this request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhjԋubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjhhubjI)}(hXUSBDEVFS_IOCTL Passes a request from userspace through to a kernel driver that has an ioctl entry in the *struct usb_driver* it registered:: struct usbdevfs_ioctl { int ifno; int ioctl_code; void *data; }; /* user mode call looks like this. * 'request' becomes the driver->ioctl() 'code' parameter. * the size of 'param' is encoded in 'request', and that data * is copied to or from the driver->ioctl() 'buf' parameter. */ static int usbdev_ioctl (int fd, int ifno, unsigned request, void *param) { struct usbdevfs_ioctl wrapper; wrapper.ifno = ifno; wrapper.ioctl_code = request; wrapper.data = param; return ioctl (fd, USBDEVFS_IOCTL, &wrapper); } File modification time is not updated by this request. This request lets kernel drivers talk to user mode code through filesystem operations even when they don't create a character or block special device. It's also been used to do things like ask devices what device special file should be used. Two pre-defined ioctls are used to disconnect and reconnect kernel drivers, so that user mode code can completely manage binding and configuration of devices. h](jO)}(hUSBDEVFS_IOCTLh]hUSBDEVFS_IOCTL}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjubji)}(hhh](h)}(h}Passes a request from userspace through to a kernel driver that has an ioctl entry in the *struct usb_driver* it registered::h](hZPasses a request from userspace through to a kernel driver that has an ioctl entry in the }(hj4hhhNhNubj)}(h*struct usb_driver*h]hstruct usb_driver}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubh it registered:}(hj4hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj1ubj )}(hXPstruct usbdevfs_ioctl { int ifno; int ioctl_code; void *data; }; /* user mode call looks like this. * 'request' becomes the driver->ioctl() 'code' parameter. * the size of 'param' is encoded in 'request', and that data * is copied to or from the driver->ioctl() 'buf' parameter. */ static int usbdev_ioctl (int fd, int ifno, unsigned request, void *param) { struct usbdevfs_ioctl wrapper; wrapper.ifno = ifno; wrapper.ioctl_code = request; wrapper.data = param; return ioctl (fd, USBDEVFS_IOCTL, &wrapper); }h]hXPstruct usbdevfs_ioctl { int ifno; int ioctl_code; void *data; }; /* user mode call looks like this. * 'request' becomes the driver->ioctl() 'code' parameter. * the size of 'param' is encoded in 'request', and that data * is copied to or from the driver->ioctl() 'buf' parameter. */ static int usbdev_ioctl (int fd, int ifno, unsigned request, void *param) { struct usbdevfs_ioctl wrapper; wrapper.ifno = ifno; wrapper.ioctl_code = request; wrapper.data = param; return ioctl (fd, USBDEVFS_IOCTL, &wrapper); }}hjTsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhj1ubh)}(h6File modification time is not updated by this request.Dh]h6File modification time is not updated by this request.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj1ubh)}(hXThis request lets kernel drivers talk to user mode code through filesystem operations even when they don't create a character or block special device. It's also been used to do things like ask devices what device special file should be used. Two pre-defined ioctls are used to disconnect and reconnect kernel drivers, so that user mode code can completely manage binding and configuration of devices.h]hXThis request lets kernel drivers talk to user mode code through filesystem operations even when they don’t create a character or block special device. It’s also been used to do things like ask devices what device special file should be used. Two pre-defined ioctls are used to disconnect and reconnect kernel drivers, so that user mode code can completely manage binding and configuration of devices.}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj1ubeh}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjhhubjI)}(hXUSBDEVFS_RELEASEINTERFACE This is used to release the claim usbfs made on interface, either implicitly or because of a USBDEVFS_CLAIMINTERFACE call, before the file descriptor is closed. The ioctl parameter is an integer holding the number of the interface (bInterfaceNumber from descriptor); File modification time is not updated by this request. .. warning:: *No security check is made to ensure that the task which made the claim is the one which is releasing it. This means that user mode driver may interfere other ones.* h](jO)}(hUSBDEVFS_RELEASEINTERFACEh]hUSBDEVFS_RELEASEINTERFACE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjubji)}(hhh](h)}(hXAThis is used to release the claim usbfs made on interface, either implicitly or because of a USBDEVFS_CLAIMINTERFACE call, before the file descriptor is closed. The ioctl parameter is an integer holding the number of the interface (bInterfaceNumber from descriptor); File modification time is not updated by this request.h]hXAThis is used to release the claim usbfs made on interface, either implicitly or because of a USBDEVFS_CLAIMINTERFACE call, before the file descriptor is closed. The ioctl parameter is an integer holding the number of the interface (bInterfaceNumber from descriptor); File modification time is not updated by this request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubhwarning)}(h*No security check is made to ensure that the task which made the claim is the one which is releasing it. This means that user mode driver may interfere other ones.*h]h)}(h*No security check is made to ensure that the task which made the claim is the one which is releasing it. This means that user mode driver may interfere other ones.*h]j)}(hjh]hNo security check is made to ensure that the task which made the claim is the one which is releasing it. This means that user mode driver may interfere other ones.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjhhubjI)}(hXHUSBDEVFS_RESETEP Resets the data toggle value for an endpoint (bulk or interrupt) to DATA0. The ioctl parameter is an integer endpoint number (1 to 15, as identified in the endpoint descriptor), with USB_DIR_IN added if the device's endpoint sends data to the host. .. Warning:: *Avoid using this request. It should probably be removed.* Using it typically means the device and driver will lose toggle synchronization. If you really lost synchronization, you likely need to completely handshake with the device, using a request like CLEAR_HALT or SET_INTERFACE. h](jO)}(hUSBDEVFS_RESETEPh]hUSBDEVFS_RESETEP}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhj܌ubji)}(hhh](h)}(hResets the data toggle value for an endpoint (bulk or interrupt) to DATA0. The ioctl parameter is an integer endpoint number (1 to 15, as identified in the endpoint descriptor), with USB_DIR_IN added if the device's endpoint sends data to the host.h]hResets the data toggle value for an endpoint (bulk or interrupt) to DATA0. The ioctl parameter is an integer endpoint number (1 to 15, as identified in the endpoint descriptor), with USB_DIR_IN added if the device’s endpoint sends data to the host.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(hX*Avoid using this request. It should probably be removed.* Using it typically means the device and driver will lose toggle synchronization. If you really lost synchronization, you likely need to completely handshake with the device, using a request like CLEAR_HALT or SET_INTERFACE.h]h)}(hX*Avoid using this request. It should probably be removed.* Using it typically means the device and driver will lose toggle synchronization. If you really lost synchronization, you likely need to completely handshake with the device, using a request like CLEAR_HALT or SET_INTERFACE.h](j)}(h:*Avoid using this request. It should probably be removed.*h]h8Avoid using this request. It should probably be removed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh Using it typically means the device and driver will lose toggle synchronization. If you really lost synchronization, you likely need to completely handshake with the device, using a request like CLEAR_HALT or SET_INTERFACE.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhj܌ubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjhhubjI)}(hXUSBDEVFS_DROP_PRIVILEGES This is used to relinquish the ability to do certain operations which are considered to be privileged on a usbfs file descriptor. This includes claiming arbitrary interfaces, resetting a device on which there are currently claimed interfaces from other users, and issuing USBDEVFS_IOCTL calls. The ioctl parameter is a 32 bit mask of interfaces the user is allowed to claim on this file descriptor. You may issue this ioctl more than one time to narrow said mask. h](jO)}(hUSBDEVFS_DROP_PRIVILEGESh]hUSBDEVFS_DROP_PRIVILEGES}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhj1ubji)}(hhh]h)}(hXThis is used to relinquish the ability to do certain operations which are considered to be privileged on a usbfs file descriptor. This includes claiming arbitrary interfaces, resetting a device on which there are currently claimed interfaces from other users, and issuing USBDEVFS_IOCTL calls. The ioctl parameter is a 32 bit mask of interfaces the user is allowed to claim on this file descriptor. You may issue this ioctl more than one time to narrow said mask.h]hXThis is used to relinquish the ability to do certain operations which are considered to be privileged on a usbfs file descriptor. This includes claiming arbitrary interfaces, resetting a device on which there are currently claimed interfaces from other users, and issuing USBDEVFS_IOCTL calls. The ioctl parameter is a 32 bit mask of interfaces the user is allowed to claim on this file descriptor. You may issue this ioctl more than one time to narrow said mask.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjCubah}(h]h ]h"]h$]h&]uh1jhhj1ubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjhhubeh}(h]h ]h"]h$]h&]uh1jChjÊhhhhhNubeh}(h]management-status-requestsah ]h"]management/status requestsah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hSynchronous I/O Supporth]hSynchronous I/O Support}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjnhhhhhMubh)}(hX#Synchronous requests involve the kernel blocking until the user mode request completes, either by finishing successfully or by reporting an error. In most cases this is the simplest way to use usbfs, although as noted above it does prevent performing I/O to more than one endpoint at a time.h]hX#Synchronous requests involve the kernel blocking until the user mode request completes, either by finishing successfully or by reporting an error. In most cases this is the simplest way to use usbfs, although as noted above it does prevent performing I/O to more than one endpoint at a time.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjnhhubjD)}(hhh](jI)}(hXUSBDEVFS_BULK Issues a bulk read or write request to the device. The ioctl parameter is a pointer to this structure:: struct usbdevfs_bulktransfer { unsigned int ep; unsigned int len; unsigned int timeout; /* in milliseconds */ void *data; }; The ``ep`` value identifies a bulk endpoint number (1 to 15, as identified in an endpoint descriptor), masked with USB_DIR_IN when referring to an endpoint which sends data to the host from the device. The length of the data buffer is identified by ``len``; Recent kernels support requests up to about 128KBytes. *FIXME say how read length is returned, and how short reads are handled.*. h](jO)}(h USBDEVFS_BULKh]h USBDEVFS_BULK}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjubji)}(hhh](h)}(hgIssues a bulk read or write request to the device. The ioctl parameter is a pointer to this structure::h]hfIssues a bulk read or write request to the device. The ioctl parameter is a pointer to this structure:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubj )}(hstruct usbdevfs_bulktransfer { unsigned int ep; unsigned int len; unsigned int timeout; /* in milliseconds */ void *data; };h]hstruct usbdevfs_bulktransfer { unsigned int ep; unsigned int len; unsigned int timeout; /* in milliseconds */ void *data; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjubh)}(hXThe ``ep`` value identifies a bulk endpoint number (1 to 15, as identified in an endpoint descriptor), masked with USB_DIR_IN when referring to an endpoint which sends data to the host from the device. The length of the data buffer is identified by ``len``; Recent kernels support requests up to about 128KBytes. *FIXME say how read length is returned, and how short reads are handled.*.h](hThe }(hjhhhNhNubj)}(h``ep``h]hep}(hjɍhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh value identifies a bulk endpoint number (1 to 15, as identified in an endpoint descriptor), masked with USB_DIR_IN when referring to an endpoint which sends data to the host from the device. The length of the data buffer is identified by }(hjhhhNhNubj)}(h``len``h]hlen}(hjۍhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh9; Recent kernels support requests up to about 128KBytes. }(hjhhhNhNubj)}(hI*FIXME say how read length is returned, and how short reads are handled.*h]hGFIXME say how read length is returned, and how short reads are handled.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjubjI)}(hX5USBDEVFS_CLEAR_HALT Clears endpoint halt (stall) and resets the endpoint toggle. This is only meaningful for bulk or interrupt endpoints. The ioctl parameter is an integer endpoint number (1 to 15, as identified in an endpoint descriptor), masked with USB_DIR_IN when referring to an endpoint which sends data to the host from the device. Use this on bulk or interrupt endpoints which have stalled, returning ``-EPIPE`` status to a data transfer request. Do not issue the control request directly, since that could invalidate the host's record of the data toggle. h](jO)}(hUSBDEVFS_CLEAR_HALTh]hUSBDEVFS_CLEAR_HALT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhM(hjubji)}(hhh](h)}(hX>Clears endpoint halt (stall) and resets the endpoint toggle. This is only meaningful for bulk or interrupt endpoints. The ioctl parameter is an integer endpoint number (1 to 15, as identified in an endpoint descriptor), masked with USB_DIR_IN when referring to an endpoint which sends data to the host from the device.h]hX>Clears endpoint halt (stall) and resets the endpoint toggle. This is only meaningful for bulk or interrupt endpoints. The ioctl parameter is an integer endpoint number (1 to 15, as identified in an endpoint descriptor), masked with USB_DIR_IN when referring to an endpoint which sends data to the host from the device.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj#ubh)}(hUse this on bulk or interrupt endpoints which have stalled, returning ``-EPIPE`` status to a data transfer request. Do not issue the control request directly, since that could invalidate the host's record of the data toggle.h](hFUse this on bulk or interrupt endpoints which have stalled, returning }(hj4hhhNhNubj)}(h ``-EPIPE``h]h-EPIPE}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4ubh status to a data transfer request. Do not issue the control request directly, since that could invalidate the host’s record of the data toggle.}(hj4hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM%hj#ubeh}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhM(hjhhubjI)}(hXDUSBDEVFS_CONTROL Issues a control request to the device. The ioctl parameter points to a structure like this:: struct usbdevfs_ctrltransfer { __u8 bRequestType; __u8 bRequest; __u16 wValue; __u16 wIndex; __u16 wLength; __u32 timeout; /* in milliseconds */ void *data; }; The first eight bytes of this structure are the contents of the SETUP packet to be sent to the device; see the USB 2.0 specification for details. The bRequestType value is composed by combining a ``USB_TYPE_*`` value, a ``USB_DIR_*`` value, and a ``USB_RECIP_*`` value (from ``linux/usb.h``). If wLength is nonzero, it describes the length of the data buffer, which is either written to the device (USB_DIR_OUT) or read from the device (USB_DIR_IN). At this writing, you can't transfer more than 4 KBytes of data to or from a device; usbfs has a limit, and some host controller drivers have a limit. (That's not usually a problem.) *Also* there's no way to say it's not OK to get a short read back from the device. h](jO)}(hUSBDEVFS_CONTROLh]hUSBDEVFS_CONTROL}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMChj`ubji)}(hhh](h)}(h]Issues a control request to the device. The ioctl parameter points to a structure like this::h]h\Issues a control request to the device. The ioctl parameter points to a structure like this:}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM+hjrubj )}(hstruct usbdevfs_ctrltransfer { __u8 bRequestType; __u8 bRequest; __u16 wValue; __u16 wIndex; __u16 wLength; __u32 timeout; /* in milliseconds */ void *data; };h]hstruct usbdevfs_ctrltransfer { __u8 bRequestType; __u8 bRequest; __u16 wValue; __u16 wIndex; __u16 wLength; __u32 timeout; /* in milliseconds */ void *data; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhM.hjrubh)}(hXThe first eight bytes of this structure are the contents of the SETUP packet to be sent to the device; see the USB 2.0 specification for details. The bRequestType value is composed by combining a ``USB_TYPE_*`` value, a ``USB_DIR_*`` value, and a ``USB_RECIP_*`` value (from ``linux/usb.h``). If wLength is nonzero, it describes the length of the data buffer, which is either written to the device (USB_DIR_OUT) or read from the device (USB_DIR_IN).h](hThe first eight bytes of this structure are the contents of the SETUP packet to be sent to the device; see the USB 2.0 specification for details. The bRequestType value is composed by combining a }(hjhhhNhNubj)}(h``USB_TYPE_*``h]h USB_TYPE_*}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh value, a }(hjhhhNhNubj)}(h ``USB_DIR_*``h]h USB_DIR_*}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh value, and a }(hjhhhNhNubj)}(h``USB_RECIP_*``h]h USB_RECIP_*}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh value (from }(hjhhhNhNubj)}(h``linux/usb.h``h]h linux/usb.h}(hjώhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh). If wLength is nonzero, it describes the length of the data buffer, which is either written to the device (USB_DIR_OUT) or read from the device (USB_DIR_IN).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM8hjrubh)}(hXAt this writing, you can't transfer more than 4 KBytes of data to or from a device; usbfs has a limit, and some host controller drivers have a limit. (That's not usually a problem.) *Also* there's no way to say it's not OK to get a short read back from the device.h](hAt this writing, you can’t transfer more than 4 KBytes of data to or from a device; usbfs has a limit, and some host controller drivers have a limit. (That’s not usually a problem.) }(hjhhhNhNubj)}(h*Also*h]hAlso}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhP there’s no way to say it’s not OK to get a short read back from the device.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM@hjrubeh}(h]h ]h"]h$]h&]uh1jhhj`ubeh}(h]h ]h"]h$]h&]uh1jHhhhMChjhhubjI)}(hUSBDEVFS_RESET Does a USB level device reset. The ioctl parameter is ignored. After the reset, this rebinds all device interfaces. File modification time is not updated by this request. h](jO)}(hUSBDEVFS_RESETh]hUSBDEVFS_RESET}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMHhjubji)}(hhh]h)}(hDoes a USB level device reset. The ioctl parameter is ignored. After the reset, this rebinds all device interfaces. File modification time is not updated by this request.h]hDoes a USB level device reset. The ioctl parameter is ignored. After the reset, this rebinds all device interfaces. File modification time is not updated by this request.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMFhj%ubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMHhjhhubeh}(h]h ]h"]h$]h&]uh1jChjnhhhhhNubj)}(h*Avoid using this call* until some usbcore bugs get fixed, since it does not fully synchronize device, interface, and driver (not just usbfs) state.h]h)}(h*Avoid using this call* until some usbcore bugs get fixed, since it does not fully synchronize device, interface, and driver (not just usbfs) state.h](j)}(h*Avoid using this call*h]hAvoid using this call}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjLubh} until some usbcore bugs get fixed, since it does not fully synchronize device, interface, and driver (not just usbfs) state.}(hjLhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMLhjHubah}(h]h ]h"]h$]h&]uh1jhjnhhhhhNubjD)}(hhh](jI)}(hX)USBDEVFS_SETINTERFACE Sets the alternate setting for an interface. The ioctl parameter is a pointer to a structure like this:: struct usbdevfs_setinterface { unsigned int interface; unsigned int altsetting; }; File modification time is not updated by this request. Those struct members are from some interface descriptor applying to the current configuration. The interface number is the bInterfaceNumber value, and the altsetting number is the bAlternateSetting value. (This resets each endpoint in the interface.) h](jO)}(hUSBDEVFS_SETINTERFACEh]hUSBDEVFS_SETINTERFACE}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhM_hjqubji)}(hhh](h)}(hhSets the alternate setting for an interface. The ioctl parameter is a pointer to a structure like this::h]hgSets the alternate setting for an interface. The ioctl parameter is a pointer to a structure like this:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMQhjubj )}(hdstruct usbdevfs_setinterface { unsigned int interface; unsigned int altsetting; };h]hdstruct usbdevfs_setinterface { unsigned int interface; unsigned int altsetting; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMThjubh)}(h6File modification time is not updated by this request.h]h6File modification time is not updated by this request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMYhjubh)}(hThose struct members are from some interface descriptor applying to the current configuration. The interface number is the bInterfaceNumber value, and the altsetting number is the bAlternateSetting value. (This resets each endpoint in the interface.)h]hThose struct members are from some interface descriptor applying to the current configuration. The interface number is the bInterfaceNumber value, and the altsetting number is the bAlternateSetting value. (This resets each endpoint in the interface.)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM[hjubeh}(h]h ]h"]h$]h&]uh1jhhjqubeh}(h]h ]h"]h$]h&]uh1jHhhhM_hjnubjI)}(hUSBDEVFS_SETCONFIGURATION Issues the :c:func:`usb_set_configuration()` call for the device. The parameter is an integer holding the number of a configuration (bConfigurationValue from descriptor). File modification time is not updated by this request. h](jO)}(hUSBDEVFS_SETCONFIGURATIONh]hUSBDEVFS_SETCONFIGURATION}(hjΏhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMehjʏubji)}(hhh]h)}(hIssues the :c:func:`usb_set_configuration()` call for the device. The parameter is an integer holding the number of a configuration (bConfigurationValue from descriptor). File modification time is not updated by this request.h](h Issues the }(hjߏhhhNhNubh)}(h!:c:func:`usb_set_configuration()`h]j)}(hjh]husb_set_configuration()}(hjhhhNhNubah}(h]h ](jdjc-funceh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocjd refdomainjreftypefunc refexplicitrefwarnjLjSjdusb_set_configurationuh1hhhhMbhjߏubh call for the device. The parameter is an integer holding the number of a configuration (bConfigurationValue from descriptor). File modification time is not updated by this request.}(hjߏhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMbhj܏ubah}(h]h ]h"]h$]h&]uh1jhhjʏubeh}(h]h ]h"]h$]h&]uh1jHhhhMehjnhhubeh}(h]h ]h"]h$]h&]uh1jChjnhhhhhNubj)}(h*Avoid using this call* until some usbcore bugs get fixed, since it does not fully synchronize device, interface, and driver (not just usbfs) state.h]h)}(h*Avoid using this call* until some usbcore bugs get fixed, since it does not fully synchronize device, interface, and driver (not just usbfs) state.h](j)}(h*Avoid using this call*h]hAvoid using this call}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj&ubh} until some usbcore bugs get fixed, since it does not fully synchronize device, interface, and driver (not just usbfs) state.}(hj&hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMihj"ubah}(h]h ]h"]h$]h&]uh1jhjnhhhhhNubeh}(h]synchronous-i-o-supportah ]h"]synchronous i/o supportah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hAsynchronous I/O Supporth]hAsynchronous I/O Support}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjPhhhhhMnubh)}(hXAs mentioned above, there are situations where it may be important to initiate concurrent operations from user mode code. This is particularly important for periodic transfers (interrupt and isochronous), but it can be used for other kinds of USB requests too. In such cases, the asynchronous requests described here are essential. Rather than submitting one request and having the kernel block until it completes, the blocking is separate.h]hXAs mentioned above, there are situations where it may be important to initiate concurrent operations from user mode code. This is particularly important for periodic transfers (interrupt and isochronous), but it can be used for other kinds of USB requests too. In such cases, the asynchronous requests described here are essential. Rather than submitting one request and having the kernel block until it completes, the blocking is separate.}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMphjPhhubh)}(hXThese requests are packaged into a structure that resembles the URB used by kernel device drivers. (No POSIX Async I/O support here, sorry.) It identifies the endpoint type (``USBDEVFS_URB_TYPE_*``), endpoint (number, masked with USB_DIR_IN as appropriate), buffer and length, and a user "context" value serving to uniquely identify each request. (It's usually a pointer to per-request data.) Flags can modify requests (not as many as supported for kernel drivers).h](hThese requests are packaged into a structure that resembles the URB used by kernel device drivers. (No POSIX Async I/O support here, sorry.) It identifies the endpoint type (}(hjohhhNhNubj)}(h``USBDEVFS_URB_TYPE_*``h]hUSBDEVFS_URB_TYPE_*}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjoubhX), endpoint (number, masked with USB_DIR_IN as appropriate), buffer and length, and a user “context” value serving to uniquely identify each request. (It’s usually a pointer to per-request data.) Flags can modify requests (not as many as supported for kernel drivers).}(hjohhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMxhjPhhubh)}(hEach request can specify a realtime signal number (between SIGRTMIN and SIGRTMAX, inclusive) to request a signal be sent when the request completes.h]hEach request can specify a realtime signal number (between SIGRTMIN and SIGRTMAX, inclusive) to request a signal be sent when the request completes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjPhhubh)}(hX_When usbfs returns these urbs, the status value is updated, and the buffer may have been modified. Except for isochronous transfers, the actual_length is updated to say how many bytes were transferred; if the USBDEVFS_URB_DISABLE_SPD flag is set ("short packets are not OK"), if fewer bytes were read than were requested then you get an error report::h]hXbWhen usbfs returns these urbs, the status value is updated, and the buffer may have been modified. Except for isochronous transfers, the actual_length is updated to say how many bytes were transferred; if the USBDEVFS_URB_DISABLE_SPD flag is set (“short packets are not OK”), if fewer bytes were read than were requested then you get an error report:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjPhhubj )}(hXstruct usbdevfs_iso_packet_desc { unsigned int length; unsigned int actual_length; unsigned int status; }; struct usbdevfs_urb { unsigned char type; unsigned char endpoint; int status; unsigned int flags; void *buffer; int buffer_length; int actual_length; int start_frame; int number_of_packets; int error_count; unsigned int signr; void *usercontext; struct usbdevfs_iso_packet_desc iso_frame_desc[]; };h]hXstruct usbdevfs_iso_packet_desc { unsigned int length; unsigned int actual_length; unsigned int status; }; struct usbdevfs_urb { unsigned char type; unsigned char endpoint; int status; unsigned int flags; void *buffer; int buffer_length; int actual_length; int start_frame; int number_of_packets; int error_count; unsigned int signr; void *usercontext; struct usbdevfs_iso_packet_desc iso_frame_desc[]; };}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjPhhubh)}(hFor these asynchronous requests, the file modification time reflects when the request was initiated. This contrasts with their use with the synchronous requests, where it reflects when requests complete.h]hFor these asynchronous requests, the file modification time reflects when the request was initiated. This contrasts with their use with the synchronous requests, where it reflects when requests complete.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjPhhubjD)}(hhh](jI)}(hQUSBDEVFS_DISCARDURB *TBS* File modification time is not updated by this request. h](jO)}(hUSBDEVFS_DISCARDURBh]hUSBDEVFS_DISCARDURB}(hjΐhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjʐubji)}(hhh]h)}(h<*TBS* File modification time is not updated by this request.h](j)}(h*TBS*h]hTBS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjߐubh7 File modification time is not updated by this request.}(hjߐhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjܐubah}(h]h ]h"]h$]h&]uh1jhhjʐubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjǐubjI)}(hQUSBDEVFS_DISCSIGNAL *TBS* File modification time is not updated by this request. h](jO)}(hUSBDEVFS_DISCSIGNALh]hUSBDEVFS_DISCSIGNAL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjubji)}(hhh]h)}(h<*TBS* File modification time is not updated by this request.h](j)}(h*TBS*h]hTBS}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh7 File modification time is not updated by this request.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjǐhhubjI)}(hNUSBDEVFS_REAPURB *TBS* File modification time is not updated by this request. h](jO)}(hUSBDEVFS_REAPURBh]hUSBDEVFS_REAPURB}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjDubji)}(hhh]h)}(h<*TBS* File modification time is not updated by this request.h](j)}(h*TBS*h]hTBS}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubh7 File modification time is not updated by this request.}(hjYhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjVubah}(h]h ]h"]h$]h&]uh1jhhjDubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjǐhhubjI)}(hTUSBDEVFS_REAPURBNDELAY *TBS* File modification time is not updated by this request. h](jO)}(hUSBDEVFS_REAPURBNDELAYh]hUSBDEVFS_REAPURBNDELAY}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjubji)}(hhh]h)}(h<*TBS* File modification time is not updated by this request.h](j)}(h*TBS*h]hTBS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh7 File modification time is not updated by this request.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjǐhhubjI)}(hUSBDEVFS_SUBMITURB *TBS* h](jO)}(hUSBDEVFS_SUBMITURBh]hUSBDEVFS_SUBMITURB}(hj‘hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhjubji)}(hhh]h)}(h*TBS*h]j)}(hjՑh]hTBS}(hjבhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjӑubah}(h]h ]h"]h$]h&]uh1hhhhMhjБubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjǐhhubeh}(h]h ]h"]h$]h&]uh1jChjPhhhhhNubeh}(h]asynchronous-i-o-supportah ]h"]asynchronous i/o supportah$]h&]uh1hhjhhhhhMnubeh}(h]the-ioctl-requestsah ]h"]the ioctl() requestsah$]h&]uh1hhjhhhhhMfubeh}(h]the-usb-character-device-nodesah ]h"]the usb character device nodesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hThe USB devicesh]hThe USB devices}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(h-The USB devices are now exported via debugfs:h]h-The USB devices are now exported via debugfs:}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hhh]j)}(h``/sys/kernel/debug/usb/devices`` ... a text file showing each of the USB devices on known to the kernel, and their configuration descriptors. You can also poll() this to learn about new devices. h]h)}(h``/sys/kernel/debug/usb/devices`` ... a text file showing each of the USB devices on known to the kernel, and their configuration descriptors. You can also poll() this to learn about new devices.h](j)}(h!``/sys/kernel/debug/usb/devices``h]h/sys/kernel/debug/usb/devices}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj:ubh ... a text file showing each of the USB devices on known to the kernel, and their configuration descriptors. You can also poll() this to learn about new devices.}(hj:hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj6ubah}(h]h ]h"]h$]h&]uh1jhj3hhhhhNubah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(hhh](h)}(h/sys/kernel/debug/usb/devicesh]h/sys/kernel/debug/usb/devices}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhjbhhhhhMubh)}(hXThis file is handy for status viewing tools in user mode, which can scan the text format and ignore most of it. More detailed device status (including class and vendor status) is available from device-specific files. For information about the current format of this file, see below.h]hXThis file is handy for status viewing tools in user mode, which can scan the text format and ignore most of it. More detailed device status (including class and vendor status) is available from device-specific files. For information about the current format of this file, see below.}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjbhhubh)}(huThis file, in combination with the poll() system call, can also be used to detect when devices are added or removed::h]htThis file, in combination with the poll() system call, can also be used to detect when devices are added or removed:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjbhhubj )}(hXbint fd; struct pollfd pfd; fd = open("/sys/kernel/debug/usb/devices", O_RDONLY); pfd = { fd, POLLIN, 0 }; for (;;) { /* The first time through, this call will return immediately. */ poll(&pfd, 1, -1); /* To see what's changed, compare the file's previous and current contents or scan the filesystem. (Scanning is more precise.) */ }h]hXbint fd; struct pollfd pfd; fd = open("/sys/kernel/debug/usb/devices", O_RDONLY); pfd = { fd, POLLIN, 0 }; for (;;) { /* The first time through, this call will return immediately. */ poll(&pfd, 1, -1); /* To see what's changed, compare the file's previous and current contents or scan the filesystem. (Scanning is more precise.) */ }}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjbhhubh)}(hNote that this behavior is intended to be used for informational and debug purposes. It would be more appropriate to use programs such as udev or HAL to initialize a device or start a user-mode helper program, for instance.h]hNote that this behavior is intended to be used for informational and debug purposes. It would be more appropriate to use programs such as udev or HAL to initialize a device or start a user-mode helper program, for instance.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjbhhubh)}(hFIn this file, each device's output has multiple lines of ASCII output.h]hHIn this file, each device’s output has multiple lines of ASCII output.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjbhhubh)}(hX9I made it ASCII instead of binary on purpose, so that someone can obtain some useful data from it without the use of an auxiliary program. However, with an auxiliary program, the numbers in the first 4 columns of each ``T:`` line (topology info: Lev, Prnt, Port, Cnt) can be used to build a USB topology diagram.h](hI made it ASCII instead of binary on purpose, so that someone can obtain some useful data from it without the use of an auxiliary program. However, with an auxiliary program, the numbers in the first 4 columns of each }(hjhhhNhNubj)}(h``T:``h]hT:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX line (topology info: Lev, Prnt, Port, Cnt) can be used to build a USB topology diagram.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjbhhubh)}(h;Each line is tagged with a one-character ID for that line::h]h:Each line is tagged with a one-character ID for that line:}(hjْhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjbhhubj )}(hXrT = Topology (etc.) B = Bandwidth (applies only to USB host controllers, which are virtualized as root hubs) D = Device descriptor info. P = Product ID info. (from Device descriptor, but they won't fit together on one line) S = String descriptors. C = Configuration descriptor info. (* = active configuration) I = Interface descriptor info. E = Endpoint descriptor info.h]hXrT = Topology (etc.) B = Bandwidth (applies only to USB host controllers, which are virtualized as root hubs) D = Device descriptor info. P = Product ID info. (from Device descriptor, but they won't fit together on one line) S = String descriptors. C = Configuration descriptor info. (* = active configuration) I = Interface descriptor info. E = Endpoint descriptor info.}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjbhhubh)}(hhh](h)}(h+/sys/kernel/debug/usb/devices output formath]h+/sys/kernel/debug/usb/devices output format}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubjD)}(hhh]jI)}(hLegend:: d = decimal number (may have leading spaces or 0's) x = hexadecimal number (may have leading spaces or 0's) s = string h](jO)}(hLegend::h]hLegend::}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jNhhhMhj ubji)}(hhh]h)}(hvd = decimal number (may have leading spaces or 0's) x = hexadecimal number (may have leading spaces or 0's) s = stringh]hzd = decimal number (may have leading spaces or 0’s) x = hexadecimal number (may have leading spaces or 0’s) s = string}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhj ubeh}(h]h ]h"]h$]h&]uh1jHhhhMhjubah}(h]h ]h"]h$]h&]uh1jChjhhhhhNubh)}(hhh](h)}(h Topology infoh]h Topology info}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hhhhhMubj )}(hXT: Bus=dd Lev=dd Prnt=dd Port=dd Cnt=dd Dev#=ddd Spd=dddd MxCh=dd | | | | | | | | |__MaxChildren | | | | | | | |__Device Speed in Mbps | | | | | | |__DeviceNumber | | | | | |__Count of devices at this level | | | | |__Connector/Port on Parent for this device | | | |__Parent DeviceNumber | | |__Level in topology for this bus | |__Bus number |__Topology info tagh]hXT: Bus=dd Lev=dd Prnt=dd Port=dd Cnt=dd Dev#=ddd Spd=dddd MxCh=dd | | | | | | | | |__MaxChildren | | | | | | | |__Device Speed in Mbps | | | | | | |__DeviceNumber | | | | | |__Count of devices at this level | | | | |__Connector/Port on Parent for this device | | | |__Parent DeviceNumber | | |__Level in topology for this bus | |__Bus number |__Topology info tag}hjOsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhj>hhubh)}(h Speed may be:h]h Speed may be:}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj>hhubj7)}(hX-======= ====================================================== 1.5 Mbit/s for low speed USB 12 Mbit/s for full speed USB 480 Mbit/s for high speed USB (added for USB 2.0) 5000 Mbit/s for SuperSpeed USB (added for USB 3.0) ======= ====================================================== h]htable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jyhjvubjz)}(hhh]h}(h]h ]h"]h$]h&]colwidthK6uh1jyhjvubhtbody)}(hhh](hrow)}(hhh](hentry)}(hhh]h)}(h1.5h]h1.5}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hMbit/s for low speed USBh]hMbit/s for low speed USB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h12h]h12}(hjՓhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjғubah}(h]h ]h"]h$]h&]uh1jhjϓubj)}(hhh]h)}(hMbit/s for full speed USBh]hMbit/s for full speed USB}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1jhjϓubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h480h]h480}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h-Mbit/s for high speed USB (added for USB 2.0)h]h-Mbit/s for high speed USB (added for USB 2.0)}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](j)}(hhh]h)}(h5000h]h5000}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj@ubah}(h]h ]h"]h$]h&]uh1jhj=ubj)}(hhh]h)}(h-Mbit/s for SuperSpeed USB (added for USB 3.0)h]h-Mbit/s for SuperSpeed USB (added for USB 3.0)}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjWubah}(h]h ]h"]h$]h&]uh1jhj=ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjvubeh}(h]h ]h"]h$]h&]colsKuh1jthjqubah}(h]h ]h"]h$]h&]uh1johjkubah}(h]h ]h"]h$]h&]uh1j7hhhM hj>hhubh)}(hFor reasons lost in the mists of time, the Port number is always too low by 1. For example, a device plugged into port 4 will show up with ``Port=03``.h](hFor reasons lost in the mists of time, the Port number is always too low by 1. For example, a device plugged into port 4 will show up with }(hjhhhNhNubj)}(h ``Port=03``h]hPort=03}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj>hhubeh}(h] topology-infoah ]h"] topology infoah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hBandwidth infoh]hBandwidth info}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj )}(hB: Alloc=ddd/ddd us (xx%), #Int=ddd, #Iso=ddd | | | |__Number of isochronous requests | | |__Number of interrupt requests | |__Total Bandwidth allocated to this bus |__Bandwidth info tagh]hB: Alloc=ddd/ddd us (xx%), #Int=ddd, #Iso=ddd | | | |__Number of isochronous requests | | |__Number of interrupt requests | |__Total Bandwidth allocated to this bus |__Bandwidth info tag}hjƔsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(hXCBandwidth allocation is an approximation of how much of one frame (millisecond) is in use. It reflects only periodic transfers, which are the only transfers that reserve bandwidth. Control and bulk transfers use all other bandwidth, including reserved bandwidth that is not used for transfers (such as for short packets).h]hXCBandwidth allocation is an approximation of how much of one frame (millisecond) is in use. It reflects only periodic transfers, which are the only transfers that reserve bandwidth. Control and bulk transfers use all other bandwidth, including reserved bandwidth that is not used for transfers (such as for short packets).}(hjԔhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjhhubh)}(hThe percentage is how much of the "reserved" bandwidth is scheduled by those transfers. For a low or full speed bus (loosely, "USB 1.1"), 90% of the bus bandwidth is reserved. For a high speed bus (loosely, "USB 2.0") 80% is reserved.h]hThe percentage is how much of the “reserved” bandwidth is scheduled by those transfers. For a low or full speed bus (loosely, “USB 1.1”), 90% of the bus bandwidth is reserved. For a high speed bus (loosely, “USB 2.0”) 80% is reserved.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM&hjhhubeh}(h]bandwidth-infoah ]h"]bandwidth infoah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(h(Device descriptor info & Product ID infoh]h(Device descriptor info & Product ID info}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM-ubj )}(h\D: Ver=x.xx Cls=xx(s) Sub=xx Prot=xx MxPS=dd #Cfgs=dd P: Vendor=xxxx ProdID=xxxx Rev=xx.xxh]h\D: Ver=x.xx Cls=xx(s) Sub=xx Prot=xx MxPS=dd #Cfgs=dd P: Vendor=xxxx ProdID=xxxx Rev=xx.xx}hj sbah}(h]h ]h"]h$]h&]jjuh1jhhhM1hjhhubh)}(hwhere::h]hwhere:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM4hjhhubj )}(hXD: Ver=x.xx Cls=xx(sssss) Sub=xx Prot=xx MxPS=dd #Cfgs=dd | | | | | | |__NumberConfigurations | | | | | |__MaxPacketSize of Default Endpoint | | | | |__DeviceProtocol | | | |__DeviceSubClass | | |__DeviceClass | |__Device USB version |__Device info tag #1h]hXD: Ver=x.xx Cls=xx(sssss) Sub=xx Prot=xx MxPS=dd #Cfgs=dd | | | | | | |__NumberConfigurations | | | | | |__MaxPacketSize of Default Endpoint | | | | |__DeviceProtocol | | | |__DeviceSubClass | | |__DeviceClass | |__Device USB version |__Device info tag #1}hj%sbah}(h]h ]h"]h$]h&]jjuh1jhhhM6hjhhubh)}(hwhere::h]hwhere:}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM?hjhhubj )}(hP: Vendor=xxxx ProdID=xxxx Rev=xx.xx | | | |__Product revision number | | |__Product ID code | |__Vendor ID code |__Device info tag #2h]hP: Vendor=xxxx ProdID=xxxx Rev=xx.xx | | | |__Product revision number | | |__Product ID code | |__Vendor ID code |__Device info tag #2}hjAsbah}(h]h ]h"]h$]h&]jjuh1jhhhMAhjhhubeh}(h]&device-descriptor-info-product-id-infoah ]h"](device descriptor info & product id infoah$]h&]uh1hhjhhhhhM-ubh)}(hhh](h)}(hString descriptor infoh]hString descriptor info}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjWhhhhhMIubj )}(hXS: Manufacturer=ssss | |__Manufacturer of this device as read from the device. | For USB host controller drivers (virtual root hubs) this may | be omitted, or (for newer drivers) will identify the kernel | version and the driver which provides this hub emulation. |__String info tag S: Product=ssss | |__Product description of this device as read from the device. | For older USB host controller drivers (virtual root hubs) this | indicates the driver; for newer ones, it's a product (and vendor) | description that often comes from the kernel's PCI ID database. |__String info tag S: SerialNumber=ssss | |__Serial Number of this device as read from the device. | For USB host controller drivers (virtual root hubs) this is | some unique ID, normally a bus ID (address or slot name) that | can't be shared with any other device. |__String info tagh]hXS: Manufacturer=ssss | |__Manufacturer of this device as read from the device. | For USB host controller drivers (virtual root hubs) this may | be omitted, or (for newer drivers) will identify the kernel | version and the driver which provides this hub emulation. |__String info tag S: Product=ssss | |__Product description of this device as read from the device. | For older USB host controller drivers (virtual root hubs) this | indicates the driver; for newer ones, it's a product (and vendor) | description that often comes from the kernel's PCI ID database. |__String info tag S: SerialNumber=ssss | |__Serial Number of this device as read from the device. | For USB host controller drivers (virtual root hubs) this is | some unique ID, normally a bus ID (address or slot name) that | can't be shared with any other device. |__String info tag}hjhsbah}(h]h ]h"]h$]h&]jjuh1jhhhMLhjWhhubeh}(h]string-descriptor-infoah ]h"]string descriptor infoah$]h&]uh1hhjhhhhhMIubh)}(hhh](h)}(hConfiguration descriptor infoh]hConfiguration descriptor info}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj~hhhhhMdubj )}(hXC:* #Ifs=dd Cfg#=dd Atr=xx MPwr=dddmA | | | | | |__MaxPower in mA | | | | |__Attributes | | | |__ConfiguratioNumber | | |__NumberOfInterfaces | |__ "*" indicates the active configuration (others are " ") |__Config info tagh]hXC:* #Ifs=dd Cfg#=dd Atr=xx MPwr=dddmA | | | | | |__MaxPower in mA | | | | |__Attributes | | | |__ConfiguratioNumber | | |__NumberOfInterfaces | |__ "*" indicates the active configuration (others are " ") |__Config info tag}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMghj~hhubh)}(hXUSB devices may have multiple configurations, each of which act rather differently. For example, a bus-powered configuration might be much less capable than one that is self-powered. Only one device configuration can be active at a time; most devices have only one configuration.h]hXUSB devices may have multiple configurations, each of which act rather differently. For example, a bus-powered configuration might be much less capable than one that is self-powered. Only one device configuration can be active at a time; most devices have only one configuration.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMohj~hhubh)}(hX$Each configuration consists of one or more interfaces. Each interface serves a distinct "function", which is typically bound to a different USB device driver. One common example is a USB speaker with an audio interface for playback, and a HID interface for use with software volume control.h]hX(Each configuration consists of one or more interfaces. Each interface serves a distinct “function”, which is typically bound to a different USB device driver. One common example is a USB speaker with an audio interface for playback, and a HID interface for use with software volume control.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMuhj~hhubeh}(h]configuration-descriptor-infoah ]h"]configuration descriptor infoah$]h&]uh1hhjhhhhhMdubh)}(hhh](h)}(h6Interface descriptor info (can be multiple per Config)h]h6Interface descriptor info (can be multiple per Config)}(hjĕhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM|ubj )}(hX/I:* If#=dd Alt=dd #EPs=dd Cls=xx(sssss) Sub=xx Prot=xx Driver=ssss | | | | | | | | |__Driver name | | | | | | | | or "(none)" | | | | | | | |__InterfaceProtocol | | | | | | |__InterfaceSubClass | | | | | |__InterfaceClass | | | | |__NumberOfEndpoints | | | |__AlternateSettingNumber | | |__InterfaceNumber | |__ "*" indicates the active altsetting (others are " ") |__Interface info tagh]hX/I:* If#=dd Alt=dd #EPs=dd Cls=xx(sssss) Sub=xx Prot=xx Driver=ssss | | | | | | | | |__Driver name | | | | | | | | or "(none)" | | | | | | | |__InterfaceProtocol | | | | | | |__InterfaceSubClass | | | | | |__InterfaceClass | | | | |__NumberOfEndpoints | | | |__AlternateSettingNumber | | |__InterfaceNumber | |__ "*" indicates the active altsetting (others are " ") |__Interface info tag}hjҕsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(hA given interface may have one or more "alternate" settings. For example, default settings may not use more than a small amount of periodic bandwidth. To use significant fractions of bus bandwidth, drivers must select a non-default altsetting.h]hA given interface may have one or more “alternate” settings. For example, default settings may not use more than a small amount of periodic bandwidth. To use significant fractions of bus bandwidth, drivers must select a non-default altsetting.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hOnly one setting for an interface may be active at a time, and only one driver may bind to an interface at a time. Most devices have only one alternate setting per interface.h]hOnly one setting for an interface may be active at a time, and only one driver may bind to an interface at a time. Most devices have only one alternate setting per interface.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]4interface-descriptor-info-can-be-multiple-per-configah ]h"]6interface descriptor info (can be multiple per config)ah$]h&]uh1hhjhhhhhM|ubh)}(hhh](h)}(h8Endpoint descriptor info (can be multiple per Interface)h]h8Endpoint descriptor info (can be multiple per Interface)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj )}(hX E: Ad=xx(s) Atr=xx(ssss) MxPS=dddd Ivl=dddss | | | | |__Interval (max) between transfers | | | |__EndpointMaxPacketSize | | |__Attributes(EndpointType) | |__EndpointAddress(I=In,O=Out) |__Endpoint info tagh]hX E: Ad=xx(s) Atr=xx(ssss) MxPS=dddd Ivl=dddss | | | | |__Interval (max) between transfers | | | |__EndpointMaxPacketSize | | |__Attributes(EndpointType) | |__EndpointAddress(I=In,O=Out) |__Endpoint info tag}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjhhubh)}(hThe interval is nonzero for all periodic (interrupt or isochronous) endpoints. For high speed endpoints the transfer interval may be measured in microseconds rather than milliseconds.h]hThe interval is nonzero for all periodic (interrupt or isochronous) endpoints. For high speed endpoints the transfer interval may be measured in microseconds rather than milliseconds.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hFor high speed periodic endpoints, the ``EndpointMaxPacketSize`` reflects the per-microframe data transfer size. For "high bandwidth" endpoints, that can reflect two or three packets (for up to 3KBytes every 125 usec) per endpoint.h](h'For high speed periodic endpoints, the }(hj1hhhNhNubj)}(h``EndpointMaxPacketSize``h]hEndpointMaxPacketSize}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubh reflects the per-microframe data transfer size. For “high bandwidth” endpoints, that can reflect two or three packets (for up to 3KBytes every 125 usec) per endpoint.}(hj1hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hWith the Linux-USB stack, periodic bandwidth reservations use the transfer intervals and sizes provided by URBs, which can be less than those found in endpoint descriptor.h]hWith the Linux-USB stack, periodic bandwidth reservations use the transfer intervals and sizes provided by URBs, which can be less than those found in endpoint descriptor.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]6endpoint-descriptor-info-can-be-multiple-per-interfaceah ]h"]8endpoint descriptor info (can be multiple per interface)ah$]h&]uh1hhjhhhhhMubeh}(h]*sys-kernel-debug-usb-devices-output-formatah ]h"]+/sys/kernel/debug/usb/devices output formatah$]h&]uh1hhjbhhhhhMubh)}(hhh](h)}(hUsage examplesh]hUsage examples}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjohhhhhMubh)}(hXIf a user or script is interested only in Topology info, for example, use something like ``grep ^T: /sys/kernel/debug/usb/devices`` for only the Topology lines. A command like ``grep -i ^[tdp]: /sys/kernel/debug/usb/devices`` can be used to list only the lines that begin with the characters in square brackets, where the valid characters are TDPCIE. With a slightly more able script, it can display any selected lines (for example, only T, D, and P lines) and change their output format. (The ``procusb`` Perl script is the beginning of this idea. It will list only selected lines [selected from TBDPSCIE] or "All" lines from ``/sys/kernel/debug/usb/devices``.)h](hYIf a user or script is interested only in Topology info, for example, use something like }(hjhhhNhNubj)}(h*``grep ^T: /sys/kernel/debug/usb/devices``h]h&grep ^T: /sys/kernel/debug/usb/devices}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. for only the Topology lines. A command like }(hjhhhNhNubj)}(h1``grep -i ^[tdp]: /sys/kernel/debug/usb/devices``h]h-grep -i ^[tdp]: /sys/kernel/debug/usb/devices}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX can be used to list only the lines that begin with the characters in square brackets, where the valid characters are TDPCIE. With a slightly more able script, it can display any selected lines (for example, only T, D, and P lines) and change their output format. (The }(hjhhhNhNubj)}(h ``procusb``h]hprocusb}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh Perl script is the beginning of this idea. It will list only selected lines [selected from TBDPSCIE] or “All” lines from }(hjhhhNhNubj)}(h!``/sys/kernel/debug/usb/devices``h]h/sys/kernel/debug/usb/devices}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjohhubh)}(hThe Topology lines can be used to generate a graphic/pictorial of the USB devices on a system's root hub. (See more below on how to do this.)h]hThe Topology lines can be used to generate a graphic/pictorial of the USB devices on a system’s root hub. (See more below on how to do this.)}(hj֖hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjohhubh)}(hzThe Interface lines can be used to determine what driver is being used for each device, and which altsetting it activated.h]hzThe Interface lines can be used to determine what driver is being used for each device, and which altsetting it activated.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjohhubh)}(hThe Configuration lines could be used to list maximum power (in milliamps) that a system's USB devices are using. For example, ``grep ^C: /sys/kernel/debug/usb/devices``.h](hThe Configuration lines could be used to list maximum power (in milliamps) that a system’s USB devices are using. For example, }(hjhhhNhNubj)}(h*``grep ^C: /sys/kernel/debug/usb/devices``h]h&grep ^C: /sys/kernel/debug/usb/devices}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjohhubh)}(hHere's an example, from a system which has a UHCI root hub, an external hub connected to the root hub, and a mouse and a serial converter connected to the external hub.h]hHere’s an example, from a system which has a UHCI root hub, an external hub connected to the root hub, and a mouse and a serial converter connected to the external hub.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjohhubj )}(hXT: Bus=00 Lev=00 Prnt=00 Port=00 Cnt=00 Dev#= 1 Spd=12 MxCh= 2 B: Alloc= 28/900 us ( 3%), #Int= 2, #Iso= 0 D: Ver= 1.00 Cls=09(hub ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=0000 ProdID=0000 Rev= 0.00 S: Product=USB UHCI Root Hub S: SerialNumber=dce0 C:* #Ifs= 1 Cfg#= 1 Atr=40 MxPwr= 0mA I: If#= 0 Alt= 0 #EPs= 1 Cls=09(hub ) Sub=00 Prot=00 Driver=hub E: Ad=81(I) Atr=03(Int.) MxPS= 8 Ivl=255ms T: Bus=00 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#= 2 Spd=12 MxCh= 4 D: Ver= 1.00 Cls=09(hub ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=0451 ProdID=1446 Rev= 1.00 C:* #Ifs= 1 Cfg#= 1 Atr=e0 MxPwr=100mA I: If#= 0 Alt= 0 #EPs= 1 Cls=09(hub ) Sub=00 Prot=00 Driver=hub E: Ad=81(I) Atr=03(Int.) MxPS= 1 Ivl=255ms T: Bus=00 Lev=02 Prnt=02 Port=00 Cnt=01 Dev#= 3 Spd=1.5 MxCh= 0 D: Ver= 1.00 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=04b4 ProdID=0001 Rev= 0.00 C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA I: If#= 0 Alt= 0 #EPs= 1 Cls=03(HID ) Sub=01 Prot=02 Driver=mouse E: Ad=81(I) Atr=03(Int.) MxPS= 3 Ivl= 10ms T: Bus=00 Lev=02 Prnt=02 Port=02 Cnt=02 Dev#= 4 Spd=12 MxCh= 0 D: Ver= 1.00 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=0565 ProdID=0001 Rev= 1.08 S: Manufacturer=Peracom Networks, Inc. S: Product=Peracom USB to Serial Converter C:* #Ifs= 1 Cfg#= 1 Atr=a0 MxPwr=100mA I: If#= 0 Alt= 0 #EPs= 3 Cls=00(>ifc ) Sub=00 Prot=00 Driver=serial E: Ad=81(I) Atr=02(Bulk) MxPS= 64 Ivl= 16ms E: Ad=01(O) Atr=02(Bulk) MxPS= 16 Ivl= 16ms E: Ad=82(I) Atr=03(Int.) MxPS= 8 Ivl= 8mss.h]hXT: Bus=00 Lev=00 Prnt=00 Port=00 Cnt=00 Dev#= 1 Spd=12 MxCh= 2 B: Alloc= 28/900 us ( 3%), #Int= 2, #Iso= 0 D: Ver= 1.00 Cls=09(hub ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=0000 ProdID=0000 Rev= 0.00 S: Product=USB UHCI Root Hub S: SerialNumber=dce0 C:* #Ifs= 1 Cfg#= 1 Atr=40 MxPwr= 0mA I: If#= 0 Alt= 0 #EPs= 1 Cls=09(hub ) Sub=00 Prot=00 Driver=hub E: Ad=81(I) Atr=03(Int.) MxPS= 8 Ivl=255ms T: Bus=00 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#= 2 Spd=12 MxCh= 4 D: Ver= 1.00 Cls=09(hub ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=0451 ProdID=1446 Rev= 1.00 C:* #Ifs= 1 Cfg#= 1 Atr=e0 MxPwr=100mA I: If#= 0 Alt= 0 #EPs= 1 Cls=09(hub ) Sub=00 Prot=00 Driver=hub E: Ad=81(I) Atr=03(Int.) MxPS= 1 Ivl=255ms T: Bus=00 Lev=02 Prnt=02 Port=00 Cnt=01 Dev#= 3 Spd=1.5 MxCh= 0 D: Ver= 1.00 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=04b4 ProdID=0001 Rev= 0.00 C:* #Ifs= 1 Cfg#= 1 Atr=80 MxPwr=100mA I: If#= 0 Alt= 0 #EPs= 1 Cls=03(HID ) Sub=01 Prot=02 Driver=mouse E: Ad=81(I) Atr=03(Int.) MxPS= 3 Ivl= 10ms T: Bus=00 Lev=02 Prnt=02 Port=02 Cnt=02 Dev#= 4 Spd=12 MxCh= 0 D: Ver= 1.00 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=0565 ProdID=0001 Rev= 1.08 S: Manufacturer=Peracom Networks, Inc. S: Product=Peracom USB to Serial Converter C:* #Ifs= 1 Cfg#= 1 Atr=a0 MxPwr=100mA I: If#= 0 Alt= 0 #EPs= 3 Cls=00(>ifc ) Sub=00 Prot=00 Driver=serial E: Ad=81(I) Atr=02(Bulk) MxPS= 64 Ivl= 16ms E: Ad=01(O) Atr=02(Bulk) MxPS= 16 Ivl= 16ms E: Ad=82(I) Atr=03(Int.) MxPS= 8 Ivl= 8ms}hj sbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjohhubh)}(hdSelecting only the ``T:`` and ``I:`` lines from this (for example, by using ``procusb ti``), we haveh](hSelecting only the }(hj.hhhNhNubj)}(h``T:``h]hT:}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubh and }(hj.hhhNhNubj)}(h``I:``h]hI:}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubh( lines from this (for example, by using }(hj.hhhNhNubj)}(h``procusb ti``h]h procusb ti}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubh ), we have}(hj.hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjohhubj )}(hXT: Bus=00 Lev=00 Prnt=00 Port=00 Cnt=00 Dev#= 1 Spd=12 MxCh= 2 T: Bus=00 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#= 2 Spd=12 MxCh= 4 I: If#= 0 Alt= 0 #EPs= 1 Cls=09(hub ) Sub=00 Prot=00 Driver=hub T: Bus=00 Lev=02 Prnt=02 Port=00 Cnt=01 Dev#= 3 Spd=1.5 MxCh= 0 I: If#= 0 Alt= 0 #EPs= 1 Cls=03(HID ) Sub=01 Prot=02 Driver=mouse T: Bus=00 Lev=02 Prnt=02 Port=02 Cnt=02 Dev#= 4 Spd=12 MxCh= 0 I: If#= 0 Alt= 0 #EPs= 3 Cls=00(>ifc ) Sub=00 Prot=00 Driver=serialh]hXT: Bus=00 Lev=00 Prnt=00 Port=00 Cnt=00 Dev#= 1 Spd=12 MxCh= 2 T: Bus=00 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#= 2 Spd=12 MxCh= 4 I: If#= 0 Alt= 0 #EPs= 1 Cls=09(hub ) Sub=00 Prot=00 Driver=hub T: Bus=00 Lev=02 Prnt=02 Port=00 Cnt=01 Dev#= 3 Spd=1.5 MxCh= 0 I: If#= 0 Alt= 0 #EPs= 1 Cls=03(HID ) Sub=01 Prot=02 Driver=mouse T: Bus=00 Lev=02 Prnt=02 Port=02 Cnt=02 Dev#= 4 Spd=12 MxCh= 0 I: If#= 0 Alt= 0 #EPs= 3 Cls=00(>ifc ) Sub=00 Prot=00 Driver=serial}hjrsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjohhubh)}(h7Physically this looks like (or could be converted to)::h]h6Physically this looks like (or could be converted to):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjohhubj )}(hX; +------------------+ | PC/root_hub (12)| Dev# = 1 +------------------+ (nn) is Mbps. Level 0 | CN.0 | CN.1 | [CN = connector/port #] +------------------+ / / +-----------------------+ Level 1 | Dev#2: 4-port hub (12)| +-----------------------+ |CN.0 |CN.1 |CN.2 |CN.3 | +-----------------------+ \ \____________________ \_____ \ \ \ +--------------------+ +--------------------+ Level 2 | Dev# 3: mouse (1.5)| | Dev# 4: serial (12)| +--------------------+ +--------------------+h]hX; +------------------+ | PC/root_hub (12)| Dev# = 1 +------------------+ (nn) is Mbps. Level 0 | CN.0 | CN.1 | [CN = connector/port #] +------------------+ / / +-----------------------+ Level 1 | Dev#2: 4-port hub (12)| +-----------------------+ |CN.0 |CN.1 |CN.2 |CN.3 | +-----------------------+ \ \____________________ \_____ \ \ \ +--------------------+ +--------------------+ Level 2 | Dev# 3: mouse (1.5)| | Dev# 4: serial (12)| +--------------------+ +--------------------+}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjohhubh)}(h]Or, in a more tree-like structure (ports [Connectors] without connections could be omitted)::h]h\Or, in a more tree-like structure (ports [Connectors] without connections could be omitted):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjohhubj )}(hPC: Dev# 1, root hub, 2 ports, 12 Mbps |_ CN.0: Dev# 2, hub, 4 ports, 12 Mbps |_ CN.0: Dev #3, mouse, 1.5 Mbps |_ CN.1: |_ CN.2: Dev #4, serial, 12 Mbps |_ CN.3: |_ CN.1:h]hPC: Dev# 1, root hub, 2 ports, 12 Mbps |_ CN.0: Dev# 2, hub, 4 ports, 12 Mbps |_ CN.0: Dev #3, mouse, 1.5 Mbps |_ CN.1: |_ CN.2: Dev #4, serial, 12 Mbps |_ CN.3: |_ CN.1:}hjsbah}(h]h ]h"]h$]h&]jjuh1jhhhMhjohhubeh}(h]usage-examplesah ]h"]usage examplesah$]h&]uh1hhjbhhhhhMubeh}(h]sys-kernel-debug-usb-devicesah ]h"]/sys/kernel/debug/usb/devicesah$]h&]uh1hhjhhhhhMubeh}(h]the-usb-devicesah ]h"]the usb devicesah$]h&]uh1hhhhhhhhMubeh}(h](the-linux-usb-host-side-apiheh ]h"](the linux-usb host side apiusb-hostside-apieh$]h&]uh1hhhhhhhhKjc}j֗hsje}hhsubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksjfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehÌ _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}(h]haj]jajY]jOaunameids}(j֗hj՗jҗj=j:jjj`jj_j\jrjYjrjrjNSjKSjjjjjojljjjjj jjkjhjMjJjjj͗jʗjŗj—jljijjjjjTjQj{jxjjjjjdjajju nametypes}(j֗j՗j=jj`j_jrjrjNSjjjojjj jkjMjj͗jŗjljjjTj{jjjdjuh}(hhjҗhj:hjj@jjj\jjj&jjj j%jjjF jK j j jk jp jjjnjsjjj jj7j<jYjgjrjgjjjjjj!jo!ju#jz#j%j%j'j'j27j77j8j8jR:jW:j=j =jH>jM>j?j@jyAj~AjBjBjqDjvDjEjEjiGjnGjfIjkIj*Kj/KjNPjSPj TjTjUjUjVjVj^j^j:dj?djhjhj njnjojoj0qj5qjKSjrjrjrjtjtjvjvjxjxjszjxzj|j|j~j#~j)j.jŁjʁjNjSjjjrjwj0j5jjōjPjUjjjajfjӓjؓjEjJjwj|jjjjjjjqjvjjjejjjjjjjPjUjjjjjjjrjwjjjjjxj}jjjjjjjjjjj2j7jjjjj=jBjj jVj[jjjjjjjjjjjTjYj jjjjjj4j9j?jDj jjjjR jW jjjjjjjj$jjjjj!j!j#j#j&j'j(j(jt*jy*jh,jm,j-j-j/j/jL2jQ2j3j3jM7jR7jN:jS:j>j>jBjBj-Ej2EjGjGj=IjBIjzKjKjMjMjNjNjPjPjjQSjSjSjVjVjXjYjX\j]\j^j^jajajejej"ij'ijjjjjljljnjojpjpjtjtj,xj1xjzjzjk|jp|jjjǀj̀j#j(jjjjjljjjrjj"jjjhjÊjJjnjjPjʗjj—jbjijjj>jjjQjjxjWjj~jjjajjjou footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]hsystem_message)}(hhh]h)}(h`Blank line missing before literal block (after the "::")? Interpreted as a definition list item.h]hdBlank line missing before literal block (after the “::”)? Interpreted as a definition list item.}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhjdubah}(h]h ]h"]h$]h&]levelKtypeINFOlineMsourcehuh1jbhjubatransform_messages](jc)}(hhh]h)}(hhh]h6Hyperlink target "usb-hostside-api" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypej}sourcehÌlineKuh1jbubjc)}(hhh]h)}(hhh]h2Hyperlink target "usb-chapter9" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypej}sourcehÌlineKkuh1jbubjc)}(hhh]h)}(hhh]h0Hyperlink target "usb-header" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypej}sourcehÌlineK~uh1jbube transformerN include_log] decorationNhhub.