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

usb: xhci-mtk: correct most kernel-doc problems in xhci-mtk.h

Correct the kernel-doc notation in xhck-mtk.h to avoid most kernel-doc
warnings. Summary of changes:

- don't use /** to begin comments that are not in kernel-doc format
- add missing "struct mu3h_sch_tt" kernel-doc line
- convert several "struct mu3h_...:" to using " - " to separate the
struct name from its short description
- add a missing @speed: struct member description

Warning messages that are fixed:

xhci-mtk.h:25: warning: This comment starts with '/**', but isn't a
kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* To simplify scheduler algorithm, set a upper limit for ESIT,
xhci-mtk.h:25: warning: missing initial short description on line:
* To simplify scheduler algorithm, set a upper limit for ESIT,

Warning: drivers/usb/host/xhci-mtk.h:36 Cannot find identifier on line:
* @fs_bus_bw_out: save bandwidth used by FS/LS OUT eps in each uframes
Warning: drivers/usb/host/xhci-mtk.h:37 Cannot find identifier on line:
* @fs_bus_bw_in: save bandwidth used by FS/LS IN eps in each uframes
Warning: drivers/usb/host/xhci-mtk.h:38 Cannot find identifier on line:
* @ls_bus_bw: save bandwidth used by LS eps in each uframes
Warning: drivers/usb/host/xhci-mtk.h:39 Cannot find identifier on line:
* @fs_frame_bw: save bandwidth used by FS/LS eps in each FS frames
Warning: drivers/usb/host/xhci-mtk.h:40 Cannot find identifier on line:
* @in_ss_cnt: the count of Start-Split for IN eps
Warning: drivers/usb/host/xhci-mtk.h:41 Cannot find identifier on line:
* @ep_list: Endpoints using this TT
Warning: drivers/usb/host/xhci-mtk.h:42 Cannot find identifier on line:
*/
Warning: drivers/usb/host/xhci-mtk.h:43 Cannot find identifier on line:
struct mu3h_sch_tt {
Warning: drivers/usb/host/xhci-mtk.h:44 Cannot find identifier on line:
u16 fs_bus_bw_out[XHCI_MTK_MAX_ESIT];
Warning: drivers/usb/host/xhci-mtk.h:45 Cannot find identifier on line:
u16 fs_bus_bw_in[XHCI_MTK_MAX_ESIT];
Warning: drivers/usb/host/xhci-mtk.h:46 Cannot find identifier on line:
u8 ls_bus_bw[XHCI_MTK_MAX_ESIT];
Warning: drivers/usb/host/xhci-mtk.h:47 Cannot find identifier on line:
u16 fs_frame_bw[XHCI_MTK_FRAMES_CNT];
Warning: drivers/usb/host/xhci-mtk.h:48 Cannot find identifier on line:
u8 in_ss_cnt[XHCI_MTK_MAX_ESIT];
Warning: drivers/usb/host/xhci-mtk.h:49 Cannot find identifier on line:
struct list_head ep_list;
Warning: drivers/usb/host/xhci-mtk.h:50 Cannot find identifier on line:
};
Warning: drivers/usb/host/xhci-mtk.h:51 Cannot find identifier on line:

Warning: drivers/usb/host/xhci-mtk.h:52 Cannot find identifier on line:
/**
Warning: drivers/usb/host/xhci-mtk.h:121 struct member 'speed' not
described in 'mu3h_sch_ep_info'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20251104070216.907540-1-rdunlap@infradead.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Randy Dunlap and committed by
Greg Kroah-Hartman
e7ab90c8 2a06ffc3

+6 -4
+6 -4
drivers/usb/host/xhci-mtk.h
··· 21 21 /* support at most 64 ep, use 32 size hash table */ 22 22 #define SCH_EP_HASH_BITS 5 23 23 24 - /** 24 + /* 25 25 * To simplify scheduler algorithm, set a upper limit for ESIT, 26 26 * if a synchromous ep's ESIT is larger than @XHCI_MTK_MAX_ESIT, 27 27 * round down to the limit value, that means allocating more ··· 34 34 #define XHCI_MTK_FRAMES_CNT (XHCI_MTK_MAX_ESIT / UFRAMES_PER_FRAME) 35 35 36 36 /** 37 + * struct mu3h_sch_tt - TT scheduling data 37 38 * @fs_bus_bw_out: save bandwidth used by FS/LS OUT eps in each uframes 38 39 * @fs_bus_bw_in: save bandwidth used by FS/LS IN eps in each uframes 39 40 * @ls_bus_bw: save bandwidth used by LS eps in each uframes ··· 52 51 }; 53 52 54 53 /** 55 - * struct mu3h_sch_bw_info: schedule information for bandwidth domain 54 + * struct mu3h_sch_bw_info - schedule information for bandwidth domain 56 55 * 57 56 * @bus_bw: array to keep track of bandwidth already used at each uframes 58 57 * ··· 64 63 }; 65 64 66 65 /** 67 - * struct mu3h_sch_ep_info: schedule information for endpoint 66 + * struct mu3h_sch_ep_info - schedule information for endpoint 68 67 * 69 68 * @esit: unit is 125us, equal to 2 << Interval field in ep-context 70 69 * @num_esit: number of @esit in a period ··· 78 77 * @ep_type: endpoint type 79 78 * @maxpkt: max packet size of endpoint 80 79 * @ep: address of usb_host_endpoint struct 80 + * @speed: usb device speed 81 81 * @allocated: the bandwidth is aready allocated from bus_bw 82 82 * @offset: which uframe of the interval that transfer should be 83 83 * scheduled first time within the interval ··· 127 125 #define MU3C_U2_PORT_MAX 5 128 126 129 127 /** 130 - * struct mu3c_ippc_regs: MTK ssusb ip port control registers 128 + * struct mu3c_ippc_regs - MTK ssusb ip port control registers 131 129 * @ip_pw_ctr0~3: ip power and clock control registers 132 130 * @ip_pw_sts1~2: ip power and clock status registers 133 131 * @ip_xhci_cap: ip xHCI capability register