mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-12-27 10:01:39 -05:00
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>
This commit is contained in:
committed by
Mika Westerberg
parent
c0a078d7bc
commit
66cf14cc9f
@@ -167,7 +167,8 @@ static int tb_port_clx(struct tb_port *port)
|
||||
* @port: USB4 port to check
|
||||
* @clx: Mask of CL states to check
|
||||
*
|
||||
* Returns true if any of the given CL states is enabled for @port.
|
||||
* Return: %true if any of the given CL states is enabled for @port,
|
||||
* %false otherwise.
|
||||
*/
|
||||
bool tb_port_clx_is_enabled(struct tb_port *port, unsigned int clx)
|
||||
{
|
||||
@@ -177,6 +178,8 @@ bool tb_port_clx_is_enabled(struct tb_port *port, unsigned int clx)
|
||||
/**
|
||||
* tb_switch_clx_is_supported() - Is CLx supported on this type of router
|
||||
* @sw: The router to check CLx support for
|
||||
*
|
||||
* Return: %true if CLx is supported, %false otherwise.
|
||||
*/
|
||||
static bool tb_switch_clx_is_supported(const struct tb_switch *sw)
|
||||
{
|
||||
@@ -203,7 +206,7 @@ static bool tb_switch_clx_is_supported(const struct tb_switch *sw)
|
||||
* Can be called for any router. Initializes the current CL state by
|
||||
* reading it from the hardware.
|
||||
*
|
||||
* Returns %0 in case of success and negative errno in case of failure.
|
||||
* Return: %0 on success, negative errno otherwise.
|
||||
*/
|
||||
int tb_switch_clx_init(struct tb_switch *sw)
|
||||
{
|
||||
@@ -313,7 +316,7 @@ static bool validate_mask(unsigned int clx)
|
||||
* is not inter-domain link. The complete set of conditions is described in CM
|
||||
* Guide 1.0 section 8.1.
|
||||
*
|
||||
* Returns %0 on success or an error code on failure.
|
||||
* Return: %0 on success, negative errno otherwise.
|
||||
*/
|
||||
int tb_switch_clx_enable(struct tb_switch *sw, unsigned int clx)
|
||||
{
|
||||
@@ -390,8 +393,7 @@ int tb_switch_clx_enable(struct tb_switch *sw, unsigned int clx)
|
||||
* Disables all CL states of the given router. Can be called on any
|
||||
* router and if the states were not enabled already does nothing.
|
||||
*
|
||||
* Returns the CL states that were disabled or negative errno in case of
|
||||
* failure.
|
||||
* Return: CL states that were disabled or negative errno otherwise.
|
||||
*/
|
||||
int tb_switch_clx_disable(struct tb_switch *sw)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user