Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
usb: gadget: u_ncm: Add kernel-doc comments for struct f_ncm_opts
Provide kernel-doc descriptions for the fields in struct f_ncm_opts to
improve code readability and maintainability.
Signed-off-by: Kuen-Han Tsai <khtsai@google.com>
Link: https://patch.msgid.link/20260320-usb-net-lifecycle-v1-3-4886b578161b@google.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
authored by
Kuen-Han Tsai
and committed by
Greg Kroah-Hartman
57f531df
8d8c68b1
+15
-6
+15
-6
drivers/usb/gadget/function/u_ncm.h
+15
-6
drivers/usb/gadget/function/u_ncm.h
···
15
15
16
16
#include <linux/usb/composite.h>
17
17
18
+
/**
19
+
* struct f_ncm_opts - NCM function options
20
+
* @func_inst: USB function instance.
21
+
* @net: The net_device associated with the NCM function.
22
+
* @bind_count: Tracks the number of configurations the NCM function is
23
+
* bound to, preventing double-registration of the @net device.
24
+
* @ncm_interf_group: ConfigFS group for NCM interface.
25
+
* @ncm_os_desc: USB OS descriptor for NCM.
26
+
* @ncm_ext_compat_id: Extended compatibility ID.
27
+
* @lock: Protects the data from concurrent access by configfs read/write
28
+
* and create symlink/remove symlink operations.
29
+
* @refcnt: Reference counter for the function instance.
30
+
* @max_segment_size: Maximum segment size.
31
+
*/
18
32
struct f_ncm_opts {
19
33
struct usb_function_instance func_inst;
20
34
struct net_device *net;
···
37
23
struct config_group *ncm_interf_group;
38
24
struct usb_os_desc ncm_os_desc;
39
25
char ncm_ext_compat_id[16];
40
-
/*
41
-
* Read/write access to configfs attributes is handled by configfs.
42
-
*
43
-
* This is to protect the data from concurrent access by read/write
44
-
* and create symlink/remove symlink.
45
-
*/
26
+
46
27
struct mutex lock;
47
28
int refcnt;
48
29