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 The FFS function provides just one attribute in its function directory:
213 The attribute is read-only and signals if the function is ready (1) to be
217 Testing the FFS function
220 On the device: start the function's userspace daemon, enable the gadget
222 On the host: use the USB function provided by the device
224 6. HID function
227 The function is provided by usb_f_hid.ko module.
229 Function-specific configfs interface
232 The function name to use when creating the function directory is "hid".
233 The HID function provides these attributes in its function directory:
257 Testing the HID function
274 7. LOOPBACK function
277 The function is provided by usb_f_ss_lb.ko module.
279 Function-specific configfs interface
282 The function name to use when creating the function directory is "Loopback".
283 The LOOPBACK function provides these attributes in its function directory:
290 Testing the LOOPBACK function
297 8. MASS STORAGE function
300 The function is provided by usb_f_mass_storage.ko module.
302 Function-specific configfs interface
305 The function name to use when creating the function directory is "mass_storage".
306 The MASS STORAGE function provides these attributes in its directory:
310 	stall		Set to permit function to halt bulk endpoints.
346 			the function is active. It causes the backing
353 Testing the MASS STORAGE function
360 9. MIDI function
363 The function is provided by usb_f_midi.ko module.
365 Function-specific configfs interface
368 The function name to use when creating the function directory is "midi".
369 The MIDI function provides these attributes in its function directory:
381 Testing the MIDI function
449 10. NCM function
452 The function is provided by usb_f_ncm.ko module.
454 Function-specific configfs interface
457 The function name to use when creating the function directory is "ncm".
458 The NCM function provides these attributes in its function directory:
462 				function instance
474 The ifname can be written to if the function is not bound. A write must be an
478 Testing the NCM function
491 11. OBEX function
494 The function is provided by usb_f_obex.ko module.
496 Function-specific configfs interface
499 The function name to use when creating the function directory is "obex".
500 The OBEX function provides just one attribute in its function directory:
508 Testing the OBEX function
524 12. PHONET function
527 The function is provided by usb_f_phonet.ko module.
529 Function-specific configfs interface
532 The function name to use when creating the function directory is "phonet".
533 The PHONET function provides just one attribute in its function directory:
537 			function instance
540 Testing the PHONET function
589 13. RNDIS function
592 The function is provided by usb_f_rndis.ko module.
594 Function-specific configfs interface
597 The function name to use when creating the function directory is "rndis".
598 The RNDIS function provides these attributes in its function directory:
602 			function instance
612 The ifname can be written to if the function is not bound. A write must be an
616 Testing the RNDIS function
629 14. SERIAL function
632 The function is provided by usb_f_gser.ko module.
634 Function-specific configfs interface
637 The function name to use when creating the function directory is "gser".
638 The SERIAL function provides just one attribute in its function directory:
646 Testing the SERIAL function
672 15. SOURCESINK function
675 The function is provided by usb_f_ss_lb.ko module.
677 Function-specific configfs interface
680 The function name to use when creating the function directory is "SourceSink".
681 The SOURCESINK function provides these attributes in its function directory:
695 Testing the SOURCESINK function
703 16. UAC1 function (legacy implementation)
706 The function is provided by usb_f_uac1_legacy.ko module.
708 Function-specific configfs interface
711 The function name to use when creating the function directory
713 The uac1 function provides these attributes in its function directory:
726 Testing the UAC1 function
735 17. UAC2 function
738 The function is provided by usb_f_uac2.ko module.
740 Function-specific configfs interface
743 The function name to use when creating the function directory is "uac2".
744 The uac2 function provides these attributes in its function directory:
776 	p_fu_vol_name    playback function unit name
787 Testing the UAC2 function
793 This function does not require real hardware support, it just
805 18. UVC function
808 The function is provided by usb_f_uvc.ko module.
810 Function-specific configfs interface
813 The function name to use when creating the function directory is "uvc".
814 The uvc function provides these attributes in its function directory:
867 Testing the UVC function
885 19. PRINTER function
888 The function is provided by usb_f_printer.ko module.
890 Function-specific configfs interface
893 The function name to use when creating the function directory is "printer".
894 The printer function provides these attributes in its function directory:
901 Testing the PRINTER function
940 20. UAC1 function (virtual ALSA card, using u_audio API)
943 The function is provided by usb_f_uac1.ko module.
947 Function-specific configfs interface
950 The function name to use when creating the function directory is "uac1".
951 The uac1 function provides these attributes in its function directory:
985 Testing the UAC1 function
991 This function does not require real hardware support, it just
1004 21. MIDI2 function
1007 The function is provided by usb_f_midi2.ko module.
1013 Function-specific configfs interface
1016 The function name to use when creating the function directory is "midi2".
1017 The midi2 function provides these attributes in its function directory
1042 represents the Function Block for Block 0 information.
1046 	name			Function Block name string
1064 If multiple Function Blocks are required, you can add more Function
1066 Function Block number (1, 2, ....). The FB subdirectories can be
1067 dynamically removed, too. Note that the Function Block numbers must be
1077 Testing the MIDI2 function
1143 Function Block 0.