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>
This commit is contained in:
Kuen-Han Tsai
2026-03-20 16:54:46 +08:00
committed by Greg Kroah-Hartman
parent 8d8c68b1fc
commit 57f531df36

View File

@@ -15,6 +15,20 @@
#include <linux/usb/composite.h>
/**
* struct f_ncm_opts - NCM function options
* @func_inst: USB function instance.
* @net: The net_device associated with the NCM function.
* @bind_count: Tracks the number of configurations the NCM function is
* bound to, preventing double-registration of the @net device.
* @ncm_interf_group: ConfigFS group for NCM interface.
* @ncm_os_desc: USB OS descriptor for NCM.
* @ncm_ext_compat_id: Extended compatibility ID.
* @lock: Protects the data from concurrent access by configfs read/write
* and create symlink/remove symlink operations.
* @refcnt: Reference counter for the function instance.
* @max_segment_size: Maximum segment size.
*/
struct f_ncm_opts {
struct usb_function_instance func_inst;
struct net_device *net;
@@ -23,12 +37,7 @@ struct f_ncm_opts {
struct config_group *ncm_interf_group;
struct usb_os_desc ncm_os_desc;
char ncm_ext_compat_id[16];
/*
* Read/write access to configfs attributes is handled by configfs.
*
* This is to protect the data from concurrent access by read/write
* and create symlink/remove symlink.
*/
struct mutex lock;
int refcnt;