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

thunderbolt: Update clx.c function documentation

Make clx.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
66cf14cc c0a078d7

+7 -5
+7 -5
drivers/thunderbolt/clx.c
··· 167 167 * @port: USB4 port to check 168 168 * @clx: Mask of CL states to check 169 169 * 170 - * Returns true if any of the given CL states is enabled for @port. 170 + * Return: %true if any of the given CL states is enabled for @port, 171 + * %false otherwise. 171 172 */ 172 173 bool tb_port_clx_is_enabled(struct tb_port *port, unsigned int clx) 173 174 { ··· 178 177 /** 179 178 * tb_switch_clx_is_supported() - Is CLx supported on this type of router 180 179 * @sw: The router to check CLx support for 180 + * 181 + * Return: %true if CLx is supported, %false otherwise. 181 182 */ 182 183 static bool tb_switch_clx_is_supported(const struct tb_switch *sw) 183 184 { ··· 206 203 * Can be called for any router. Initializes the current CL state by 207 204 * reading it from the hardware. 208 205 * 209 - * Returns %0 in case of success and negative errno in case of failure. 206 + * Return: %0 on success, negative errno otherwise. 210 207 */ 211 208 int tb_switch_clx_init(struct tb_switch *sw) 212 209 { ··· 316 313 * is not inter-domain link. The complete set of conditions is described in CM 317 314 * Guide 1.0 section 8.1. 318 315 * 319 - * Returns %0 on success or an error code on failure. 316 + * Return: %0 on success, negative errno otherwise. 320 317 */ 321 318 int tb_switch_clx_enable(struct tb_switch *sw, unsigned int clx) 322 319 { ··· 393 390 * Disables all CL states of the given router. Can be called on any 394 391 * router and if the states were not enabled already does nothing. 395 392 * 396 - * Returns the CL states that were disabled or negative errno in case of 397 - * failure. 393 + * Return: CL states that were disabled or negative errno otherwise. 398 394 */ 399 395 int tb_switch_clx_disable(struct tb_switch *sw) 400 396 {