Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
thunderbolt: Update domain.c function documentation
Make domain.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
250afc7f
a84be45d
+19
-9
+19
-9
drivers/thunderbolt/domain.c
+19
-9
drivers/thunderbolt/domain.c
···
369
369
* Call tb_domain_put() to release the domain before it has been added
370
370
* to the system.
371
371
*
372
-
* Return: allocated domain structure on %NULL in case of error
372
+
* Return: Pointer to &struct tb or %NULL in case of error.
373
373
*/
374
374
struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize)
375
375
{
···
431
431
* and release the domain after this function has been called, call
432
432
* tb_domain_remove().
433
433
*
434
-
* Return: %0 in case of success and negative errno in case of error
434
+
* Return: %0 on success, negative errno otherwise.
435
435
*/
436
436
int tb_domain_add(struct tb *tb, bool reset)
437
437
{
···
519
519
* @tb: Domain to suspend
520
520
*
521
521
* Suspends all devices in the domain and stops the control channel.
522
+
*
523
+
* Return: %0 on success, negative errno otherwise.
522
524
*/
523
525
int tb_domain_suspend_noirq(struct tb *tb)
524
526
{
···
547
545
*
548
546
* Re-starts the control channel, and resumes all devices connected to
549
547
* the domain.
548
+
*
549
+
* Return: %0 on success, negative errno otherwise.
550
550
*/
551
551
int tb_domain_resume_noirq(struct tb *tb)
552
552
{
···
648
644
* This will approve switch by connection manager specific means. In
649
645
* case of success the connection manager will create PCIe tunnel from
650
646
* parent to @sw.
647
+
*
648
+
* Return: %0 on success, negative errno otherwise.
651
649
*/
652
650
int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw)
653
651
{
···
748
742
* This needs to be called in preparation for NVM upgrade of the host
749
743
* controller. Makes sure all PCIe paths are disconnected.
750
744
*
751
-
* Return %0 on success and negative errno in case of error.
745
+
* Return: %0 on success and negative errno in case of error.
752
746
*/
753
747
int tb_domain_disconnect_pcie_paths(struct tb *tb)
754
748
{
···
770
764
* Calls connection manager specific method to enable DMA paths to the
771
765
* XDomain in question.
772
766
*
773
-
* Return: 0% in case of success and negative errno otherwise. In
774
-
* particular returns %-ENOTSUPP if the connection manager
775
-
* implementation does not support XDomains.
767
+
* Return:
768
+
* * %0 - On success.
769
+
* * %-ENOTSUPP - If the connection manager implementation does not support
770
+
* XDomains.
771
+
* * Negative errno - An error occurred.
776
772
*/
777
773
int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
778
774
int transmit_path, int transmit_ring,
···
799
791
* Calls connection manager specific method to disconnect DMA paths to
800
792
* the XDomain in question.
801
793
*
802
-
* Return: 0% in case of success and negative errno otherwise. In
803
-
* particular returns %-ENOTSUPP if the connection manager
804
-
* implementation does not support XDomains.
794
+
* Return:
795
+
* * %0 - On success.
796
+
* * %-ENOTSUPP - If the connection manager implementation does not support
797
+
* XDomains.
798
+
* * Negative errno - An error occurred.
805
799
*/
806
800
int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
807
801
int transmit_path, int transmit_ring,