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)
30    21. MIDI2 function
33 1. ACM function
36 The function is provided by usb_f_acm.ko module.
38 Function-specific configfs interface
41 The function name to use when creating the function directory is "acm".
42 The ACM function provides just one attribute in its function directory:
51 Testing the ACM function
72 2. ECM function
75 The function is provided by usb_f_ecm.ko module.
77 Function-specific configfs interface
80 The function name to use when creating the function directory is "ecm".
81 The ECM function provides these attributes in its function directory:
85 			function instance
95 The ifname can be written to if the function is not bound. A write must be an
99 Testing the ECM function
112 3. ECM subset function
115 The function is provided by usb_f_ecm_subset.ko module.
117 Function-specific configfs interface
120 The function name to use when creating the function directory is "geth".
121 The ECM subset function provides these attributes in its function directory:
125 			function instance
135 The ifname can be written to if the function is not bound. A write must be an
139 Testing the ECM subset function
152 4. EEM function
155 The function is provided by usb_f_eem.ko module.
157 Function-specific configfs interface
160 The function name to use when creating the function directory is "eem".
161 The EEM function provides these attributes in its function directory:
165 			function instance
175 The ifname can be written to if the function is not bound. A write must be an
179 Testing the EEM function
192 5. FFS function
195 The function is provided by usb_f_fs.ko module.
197 Function-specific configfs interface
200 The function name to use when creating the function directory is "ffs".
201 The function directory is intentionally empty and not modifiable.
206 process which implements the function proper). The gadget should be enabled
209 Testing the FFS function
212 On the device: start the function's userspace daemon, enable the gadget
214 On the host: use the USB function provided by the device
216 6. HID function
219 The function is provided by usb_f_hid.ko module.
221 Function-specific configfs interface
224 The function name to use when creating the function directory is "hid".
225 The HID function provides these attributes in its function directory:
249 Testing the HID function
266 7. LOOPBACK function
269 The function is provided by usb_f_ss_lb.ko module.
271 Function-specific configfs interface
274 The function name to use when creating the function directory is "Loopback".
275 The LOOPBACK function provides these attributes in its function directory:
282 Testing the LOOPBACK function
289 8. MASS STORAGE function
292 The function is provided by usb_f_mass_storage.ko module.
294 Function-specific configfs interface
297 The function name to use when creating the function directory is "mass_storage".
298 The MASS STORAGE function provides these attributes in its directory:
302 	stall		Set to permit function to halt bulk endpoints.
338 			the function is active. It causes the backing
345 Testing the MASS STORAGE function
352 9. MIDI function
355 The function is provided by usb_f_midi.ko module.
357 Function-specific configfs interface
360 The function name to use when creating the function directory is "midi".
361 The MIDI function provides these attributes in its function directory:
372 Testing the MIDI function
440 10. NCM function
443 The function is provided by usb_f_ncm.ko module.
445 Function-specific configfs interface
448 The function name to use when creating the function directory is "ncm".
449 The NCM function provides these attributes in its function directory:
453 			function instance
463 The ifname can be written to if the function is not bound. A write must be an
467 Testing the NCM function
480 11. OBEX function
483 The function is provided by usb_f_obex.ko module.
485 Function-specific configfs interface
488 The function name to use when creating the function directory is "obex".
489 The OBEX function provides just one attribute in its function directory:
497 Testing the OBEX function
513 12. PHONET function
516 The function is provided by usb_f_phonet.ko module.
518 Function-specific configfs interface
521 The function name to use when creating the function directory is "phonet".
522 The PHONET function provides just one attribute in its function directory:
526 			function instance
529 Testing the PHONET function
578 13. RNDIS function
581 The function is provided by usb_f_rndis.ko module.
583 Function-specific configfs interface
586 The function name to use when creating the function directory is "rndis".
587 The RNDIS function provides these attributes in its function directory:
591 			function instance
601 The ifname can be written to if the function is not bound. A write must be an
605 Testing the RNDIS function
618 14. SERIAL function
621 The function is provided by usb_f_gser.ko module.
623 Function-specific configfs interface
626 The function name to use when creating the function directory is "gser".
627 The SERIAL function provides just one attribute in its function directory:
635 Testing the SERIAL function
661 15. SOURCESINK function
664 The function is provided by usb_f_ss_lb.ko module.
666 Function-specific configfs interface
669 The function name to use when creating the function directory is "SourceSink".
670 The SOURCESINK function provides these attributes in its function directory:
683 Testing the SOURCESINK function
691 16. UAC1 function (legacy implementation)
694 The function is provided by usb_f_uac1_legacy.ko module.
696 Function-specific configfs interface
699 The function name to use when creating the function directory
701 The uac1 function provides these attributes in its function directory:
714 Testing the UAC1 function
723 17. UAC2 function
726 The function is provided by usb_f_uac2.ko module.
728 Function-specific configfs interface
731 The function name to use when creating the function directory is "uac2".
732 The uac2 function provides these attributes in its function directory:
762 Testing the UAC2 function
768 This function does not require real hardware support, it just
780 18. UVC function
783 The function is provided by usb_f_uvc.ko module.
785 Function-specific configfs interface
788 The function name to use when creating the function directory is "uvc".
789 The uvc function provides these attributes in its function directory:
842 Testing the UVC function
860 19. PRINTER function
863 The function is provided by usb_f_printer.ko module.
865 Function-specific configfs interface
868 The function name to use when creating the function directory is "printer".
869 The printer function provides these attributes in its function directory:
876 Testing the PRINTER function
915 20. UAC1 function (virtual ALSA card, using u_audio API)
918 The function is provided by usb_f_uac1.ko module.
922 Function-specific configfs interface
925 The function name to use when creating the function directory is "uac1".
926 The uac1 function provides these attributes in its function directory:
952 Testing the UAC1 function
958 This function does not require real hardware support, it just
971 21. MIDI2 function
974 The function is provided by usb_f_midi2.ko module.
980 Function-specific configfs interface
983 The function name to use when creating the function directory is "midi2".
984 The midi2 function provides these attributes in its function directory
1009 represents the Function Block for Block 0 information.
1013 	name			Function Block name string
1031 If multiple Function Blocks are required, you can add more Function
1033 Function Block number (1, 2, ....). The FB subdirectories can be
1034 dynamically removed, too. Note that the Function Block numbers must be
1044 Testing the MIDI2 function
1110 Function Block 0.