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

thunderbolt: Update acpi.c function documentation

Make acpi.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
1fac4d00 00f2bf97

+15 -13
+15 -13
drivers/thunderbolt/acpi.c
··· 86 86 * @nhi ACPI node. For each reference a device link is added. The link 87 87 * is automatically removed by the driver core. 88 88 * 89 - * Returns %true if at least one link was created. 89 + * Returns %true if at least one link was created, %false otherwise. 90 90 */ 91 91 bool tb_acpi_add_links(struct tb_nhi *nhi) 92 92 { ··· 113 113 /** 114 114 * tb_acpi_is_native() - Did the platform grant native TBT/USB4 control 115 115 * 116 - * Returns %true if the platform granted OS native control over 117 - * TBT/USB4. In this case software based connection manager can be used, 116 + * Return: %true if the platform granted OS native control over 117 + * TBT/USB4, %false otherwise. 118 + * 119 + * When returned %true, software based connection manager can be used, 118 120 * otherwise there is firmware based connection manager running. 119 121 */ 120 122 bool tb_acpi_is_native(void) ··· 128 126 /** 129 127 * tb_acpi_may_tunnel_usb3() - Is USB3 tunneling allowed by the platform 130 128 * 131 - * When software based connection manager is used, this function 132 - * returns %true if platform allows native USB3 tunneling. 129 + * Return: %true if software based connection manager is used and 130 + * platform allows native USB 3.x tunneling, %false otherwise. 133 131 */ 134 132 bool tb_acpi_may_tunnel_usb3(void) 135 133 { ··· 141 139 /** 142 140 * tb_acpi_may_tunnel_dp() - Is DisplayPort tunneling allowed by the platform 143 141 * 144 - * When software based connection manager is used, this function 145 - * returns %true if platform allows native DP tunneling. 142 + * Return: %true if software based connection manager is used and 143 + * platform allows native DP tunneling, %false otherwise. 146 144 */ 147 145 bool tb_acpi_may_tunnel_dp(void) 148 146 { ··· 154 152 /** 155 153 * tb_acpi_may_tunnel_pcie() - Is PCIe tunneling allowed by the platform 156 154 * 157 - * When software based connection manager is used, this function 158 - * returns %true if platform allows native PCIe tunneling. 155 + * Return: %true if software based connection manager is used and 156 + * platform allows native PCIe tunneling, %false otherwise. 159 157 */ 160 158 bool tb_acpi_may_tunnel_pcie(void) 161 159 { ··· 167 165 /** 168 166 * tb_acpi_is_xdomain_allowed() - Are XDomain connections allowed 169 167 * 170 - * When software based connection manager is used, this function 171 - * returns %true if platform allows XDomain connections. 168 + * Return: %true if software based connection manager is used and 169 + * platform allows XDomain tunneling, %false otherwise. 172 170 */ 173 171 bool tb_acpi_is_xdomain_allowed(void) 174 172 { ··· 258 256 * 259 257 * This should only be called if the USB4/TBT link is not up. 260 258 * 261 - * Returns %0 on success. 259 + * Return: %0 on success, negative errno otherwise. 262 260 */ 263 261 int tb_acpi_power_on_retimers(struct tb_port *port) 264 262 { ··· 272 270 * This is the opposite of tb_acpi_power_on_retimers(). After returning 273 271 * successfully the normal operations with the @port can continue. 274 272 * 275 - * Returns %0 on success. 273 + * Return: %0 on success, negative errno otherwise. 276 274 */ 277 275 int tb_acpi_power_off_retimers(struct tb_port *port) 278 276 {