tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: usb: gadget: Reindent numbered list

Paragraphs that are part of a numbered list must be indented to render
correctly in html. Do that right here. There are only whitespace changes
in this patch.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@baylibre.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20250607224747.3653041-2-u.kleine-koenig@baylibre.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Uwe Kleine-König and committed by
Greg Kroah-Hartman 41edd08b 783e15dd

+17 -18
+17 -18
Documentation/usb/gadget_configfs.rst
··· 369 369 The concepts described above translate to USB gadgets like this: 370 370 371 371 1. A gadget has its config group, which has some attributes (idVendor, 372 - idProduct etc) and default sub-groups (configs, functions, strings). 373 - Writing to the attributes causes the information to be stored in 374 - appropriate locations. In the configs, functions and strings sub-groups 375 - a user can create their sub-groups to represent configurations, functions, 376 - and groups of strings in a given language. 372 + idProduct etc) and default sub-groups (configs, functions, strings). 373 + Writing to the attributes causes the information to be stored in appropriate 374 + locations. In the configs, functions and strings sub-groups a user can 375 + create their sub-groups to represent configurations, functions, and groups 376 + of strings in a given language. 377 377 378 378 2. The user creates configurations and functions, in the configurations 379 - creates symbolic links to functions. This information is used when the 380 - gadget's UDC attribute is written to, which means binding the gadget 381 - to the UDC. The code in drivers/usb/gadget/configfs.c iterates over 382 - all configurations, and in each configuration it iterates over all 383 - functions and binds them. This way the whole gadget is bound. 379 + creates symbolic links to functions. This information is used when the 380 + gadget's UDC attribute is written to, which means binding the gadget to the 381 + UDC. The code in drivers/usb/gadget/configfs.c iterates over all 382 + configurations, and in each configuration it iterates over all functions and 383 + binds them. This way the whole gadget is bound. 384 384 385 385 3. The file drivers/usb/gadget/configfs.c contains code for 386 386 ··· 388 388 - gadget's default groups (configs, functions, strings) 389 389 - associating functions with configurations (symlinks) 390 390 391 - 4. Each USB function naturally has its own view of what it wants 392 - configured, so config_groups for particular functions are defined 393 - in the functions implementation files drivers/usb/gadget/f_*.c. 391 + 4. Each USB function naturally has its own view of what it wants configured, so 392 + config_groups for particular functions are defined in the functions 393 + implementation files drivers/usb/gadget/f_*.c. 394 394 395 395 5. Function's code is written in such a way that it uses 396 - 397 - usb_get_function_instance(), which, in turn, calls request_module. 398 - So, provided that modprobe works, modules for particular functions 399 - are loaded automatically. Please note that the converse is not true: 400 - after a gadget is disabled and torn down, the modules remain loaded. 396 + usb_get_function_instance(), which, in turn, calls request_module. So, 397 + provided that modprobe works, modules for particular functions are loaded 398 + automatically. Please note that the converse is not true: after a gadget is 399 + disabled and torn down, the modules remain loaded.