Documentation/usb/gadget-testing.rst

10    1. ACM function
11    2. ECM function
12    3. ECM subset function
13    4. EEM function
14    5. FFS function
15    6. HID function
16    7. LOOPBACK function
17    8. MASS STORAGE function
18    9. MIDI function
19    10. NCM function
20    11. OBEX function
21    12. PHONET function
22    13. RNDIS function
23    14. SERIAL function
24    15. SOURCESINK function
25    16. UAC1 function (legacy implementation)
26    17. UAC2 function
27    18. UVC function
28    19. PRINTER function
29    20. UAC1 function (new API)
32 1. ACM function
35 The function is provided by usb_f_acm.ko module.
37 Function-specific configfs interface
40 The function name to use when creating the function directory is "acm".
41 The ACM function provides just one attribute in its function directory:
50 Testing the ACM function
71 2. ECM function
74 The function is provided by usb_f_ecm.ko module.
76 Function-specific configfs interface
79 The function name to use when creating the function directory is "ecm".
80 The ECM function provides these attributes in its function directory:
84 			function instance
94 Except for ifname they can be written to until the function is linked to a
98 Testing the ECM function
111 3. ECM subset function
114 The function is provided by usb_f_ecm_subset.ko module.
116 Function-specific configfs interface
119 The function name to use when creating the function directory is "geth".
120 The ECM subset function provides these attributes in its function directory:
124 			function instance
134 Except for ifname they can be written to until the function is linked to a
138 Testing the ECM subset function
151 4. EEM function
154 The function is provided by usb_f_eem.ko module.
156 Function-specific configfs interface
159 The function name to use when creating the function directory is "eem".
160 The EEM function provides these attributes in its function directory:
164 			function instance
174 Except for ifname they can be written to until the function is linked to a
178 Testing the EEM function
191 5. FFS function
194 The function is provided by usb_f_fs.ko module.
196 Function-specific configfs interface
199 The function name to use when creating the function directory is "ffs".
200 The function directory is intentionally empty and not modifiable.
205 process which implements the function proper). The gadget should be enabled
208 Testing the FFS function
211 On the device: start the function's userspace daemon, enable the gadget
213 On the host: use the USB function provided by the device
215 6. HID function
218 The function is provided by usb_f_hid.ko module.
220 Function-specific configfs interface
223 The function name to use when creating the function directory is "hid".
224 The HID function provides these attributes in its function directory:
248 Testing the HID function
265 7. LOOPBACK function
268 The function is provided by usb_f_ss_lb.ko module.
270 Function-specific configfs interface
273 The function name to use when creating the function directory is "Loopback".
274 The LOOPBACK function provides these attributes in its function directory:
281 Testing the LOOPBACK function
288 8. MASS STORAGE function
291 The function is provided by usb_f_mass_storage.ko module.
293 Function-specific configfs interface
296 The function name to use when creating the function directory is "mass_storage".
297 The MASS STORAGE function provides these attributes in its directory:
301 	stall		Set to permit function to halt bulk endpoints.
338 Testing the MASS STORAGE function
345 9. MIDI function
348 The function is provided by usb_f_midi.ko module.
350 Function-specific configfs interface
353 The function name to use when creating the function directory is "midi".
354 The MIDI function provides these attributes in its function directory:
365 Testing the MIDI function
433 10. NCM function
436 The function is provided by usb_f_ncm.ko module.
438 Function-specific configfs interface
441 The function name to use when creating the function directory is "ncm".
442 The NCM function provides these attributes in its function directory:
446 			function instance
456 Except for ifname they can be written to until the function is linked to a
460 Testing the NCM function
473 11. OBEX function
476 The function is provided by usb_f_obex.ko module.
478 Function-specific configfs interface
481 The function name to use when creating the function directory is "obex".
482 The OBEX function provides just one attribute in its function directory:
490 Testing the OBEX function
506 12. PHONET function
509 The function is provided by usb_f_phonet.ko module.
511 Function-specific configfs interface
514 The function name to use when creating the function directory is "phonet".
515 The PHONET function provides just one attribute in its function directory:
519 			function instance
522 Testing the PHONET function
571 13. RNDIS function
574 The function is provided by usb_f_rndis.ko module.
576 Function-specific configfs interface
579 The function name to use when creating the function directory is "rndis".
580 The RNDIS function provides these attributes in its function directory:
584 			function instance
594 Except for ifname they can be written to until the function is linked to a
598 Testing the RNDIS function
611 14. SERIAL function
614 The function is provided by usb_f_gser.ko module.
616 Function-specific configfs interface
619 The function name to use when creating the function directory is "gser".
620 The SERIAL function provides just one attribute in its function directory:
628 Testing the SERIAL function
654 15. SOURCESINK function
657 The function is provided by usb_f_ss_lb.ko module.
659 Function-specific configfs interface
662 The function name to use when creating the function directory is "SourceSink".
663 The SOURCESINK function provides these attributes in its function directory:
676 Testing the SOURCESINK function
684 16. UAC1 function (legacy implementation)
687 The function is provided by usb_f_uac1_legacy.ko module.
689 Function-specific configfs interface
692 The function name to use when creating the function directory
694 The uac1 function provides these attributes in its function directory:
707 Testing the UAC1 function
716 17. UAC2 function
719 The function is provided by usb_f_uac2.ko module.
721 Function-specific configfs interface
724 The function name to use when creating the function directory is "uac2".
725 The uac2 function provides these attributes in its function directory:
740 Testing the UAC2 function
746 This function does not require real hardware support, it just
758 18. UVC function
761 The function is provided by usb_f_uvc.ko module.
763 Function-specific configfs interface
766 The function name to use when creating the function directory is "uvc".
767 The uvc function provides these attributes in its function directory:
819 Testing the UVC function
837 19. PRINTER function
840 The function is provided by usb_f_printer.ko module.
842 Function-specific configfs interface
845 The function name to use when creating the function directory is "printer".
846 The printer function provides these attributes in its function directory:
853 Testing the PRINTER function
892 20. UAC1 function (virtual ALSA card, using u_audio API)
895 The function is provided by usb_f_uac1.ko module.
899 Function-specific configfs interface
902 The function name to use when creating the function directory is "uac1".
903 The uac1 function provides these attributes in its function directory:
918 Testing the UAC1 function
924 This function does not require real hardware support, it just