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

thunderbolt: Update nhi.c function documentation

Make nhi.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
a3852380 4815b754

+13 -4
+13 -4
drivers/thunderbolt/nhi.c
··· 344 344 * 345 345 * This function can be called when @start_poll callback of the @ring 346 346 * has been called. It will read one completed frame from the ring and 347 - * return it to the caller. Returns %NULL if there is no more completed 348 - * frames. 347 + * return it to the caller. 348 + * 349 + * Return: Pointer to &struct ring_frame, %NULL if there is no more 350 + * completed frames. 349 351 */ 350 352 struct ring_frame *tb_ring_poll(struct tb_ring *ring) 351 353 { ··· 642 640 * @hop: HopID (ring) to allocate 643 641 * @size: Number of entries in the ring 644 642 * @flags: Flags for the ring 643 + * 644 + * Return: Pointer to &struct tb_ring, %NULL otherwise. 645 645 */ 646 646 struct tb_ring *tb_ring_alloc_tx(struct tb_nhi *nhi, int hop, int size, 647 647 unsigned int flags) ··· 665 661 * interrupt is triggered and masked, instead of callback 666 662 * in each Rx frame. 667 663 * @poll_data: Optional data passed to @start_poll 664 + * 665 + * Return: Pointer to &struct tb_ring, %NULL otherwise. 668 666 */ 669 667 struct tb_ring *tb_ring_alloc_rx(struct tb_nhi *nhi, int hop, int size, 670 668 unsigned int flags, int e2e_tx_hop, ··· 860 854 * @cmd: Command to send 861 855 * @data: Data to be send with the command 862 856 * 863 - * Sends mailbox command to the firmware running on NHI. Returns %0 in 864 - * case of success and negative errno in case of failure. 857 + * Sends mailbox command to the firmware running on NHI. 858 + * 859 + * Return: %0 on success, negative errno otherwise. 865 860 */ 866 861 int nhi_mailbox_cmd(struct tb_nhi *nhi, enum nhi_mailbox_cmd cmd, u32 data) 867 862 { ··· 898 891 * 899 892 * The function reads current firmware operation mode using NHI mailbox 900 893 * registers and returns it to the caller. 894 + * 895 + * Return: &enum nhi_fw_mode. 901 896 */ 902 897 enum nhi_fw_mode nhi_mailbox_mode(struct tb_nhi *nhi) 903 898 {