Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
thunderbolt: Update cap.c function documentation
Make cap.c function documentation compliant with current kernel-doc
standards. No functional changes.
Signed-off-by: Alan Borzeszkowski <alan.borzeszkowski@linux.intel.com>
Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
authored by
Alan Borzeszkowski
and committed by
Mika Westerberg
c0a078d7
1fac4d00
+31
-18
+31
-18
drivers/thunderbolt/cap.c
+31
-18
drivers/thunderbolt/cap.c
···
64
64
* @port: Port to find the capability for
65
65
* @offset: Previous capability offset (%0 for start)
66
66
*
67
-
* Returns dword offset of the next capability in port config space
68
-
* capability list and returns it. Passing %0 returns the first entry in
69
-
* the capability list. If no next capability is found returns %0. In case
70
-
* of failure returns negative errno.
67
+
* Finds dword offset of the next capability in port config space
68
+
* capability list. When passed %0 in @offset parameter, first entry
69
+
* will be returned, if it exists.
70
+
*
71
+
* Return:
72
+
* * Double word offset of the first or next capability - On success.
73
+
* * %0 - If no next capability is found.
74
+
* * Negative errno - Another error occurred.
71
75
*/
72
76
int tb_port_next_cap(struct tb_port *port, unsigned int offset)
73
77
{
···
116
112
* @port: Port to find the capability for
117
113
* @cap: Capability to look
118
114
*
119
-
* Returns offset to start of capability or %-ENOENT if no such
120
-
* capability was found. Negative errno is returned if there was an
121
-
* error.
115
+
* Return:
116
+
* * Offset to the start of capability - On success.
117
+
* * %-ENOENT - If no such capability was found.
118
+
* * Negative errno - Another error occurred.
122
119
*/
123
120
int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap)
124
121
{
···
142
137
* @sw: Switch to find the capability for
143
138
* @offset: Previous capability offset (%0 for start)
144
139
*
145
-
* Finds dword offset of the next capability in router config space
146
-
* capability list and returns it. Passing %0 returns the first entry in
147
-
* the capability list. If no next capability is found returns %0. In case
148
-
* of failure returns negative errno.
140
+
* Finds dword offset of the next capability in port config space
141
+
* capability list. When passed %0 in @offset parameter, first entry
142
+
* will be returned, if it exists.
143
+
*
144
+
* Return:
145
+
* * Double word offset of the first or next capability - On success.
146
+
* * %0 - If no next capability is found.
147
+
* * Negative errno - Another error occurred.
149
148
*/
150
149
int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset)
151
150
{
···
190
181
* @sw: Switch to find the capability for
191
182
* @cap: Capability to look
192
183
*
193
-
* Returns offset to start of capability or %-ENOENT if no such
194
-
* capability was found. Negative errno is returned if there was an
195
-
* error.
184
+
* Return:
185
+
* * Offset to the start of capability - On success.
186
+
* * %-ENOENT - If no such capability was found.
187
+
* * Negative errno - Another error occurred.
196
188
*/
197
189
int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap)
198
190
{
···
223
213
* @sw: Switch to find the capability for
224
214
* @vsec: Vendor specific capability to look
225
215
*
226
-
* Functions enumerates vendor specific capabilities (VSEC) of a switch
227
-
* and returns offset when capability matching @vsec is found. If no
228
-
* such capability is found returns %-ENOENT. In case of error returns
229
-
* negative errno.
216
+
* This function enumerates vendor specific capabilities (VSEC) of a
217
+
* switch and returns offset when capability matching @vsec is found.
218
+
*
219
+
* Return:
220
+
* * Offset of capability - On success.
221
+
* * %-ENOENT - If capability was not found.
222
+
* * Negative errno - Another error occurred.
230
223
*/
231
224
int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec)
232
225
{