Commit cbf92564 authored by Randy Dunlap's avatar Randy Dunlap Committed by Hans de Goede
Browse files

platform/mellanox: tmfifo: fix kernel-doc warnings 



Fix kernel-doc notation for structs and struct members to prevent
these warnings:

mlxbf-tmfifo.c:73: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_vring '
mlxbf-tmfifo.c:128: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_vdev '
mlxbf-tmfifo.c:146: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_irq_info '
mlxbf-tmfifo.c:158: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_io '
mlxbf-tmfifo.c:182: warning: cannot understand function prototype: 'struct mlxbf_tmfifo '
mlxbf-tmfifo.c:208: warning: cannot understand function prototype: 'struct mlxbf_tmfifo_msg_hdr '
mlxbf-tmfifo.c:138: warning: Function parameter or member 'config' not described in 'mlxbf_tmfifo_vdev'
mlxbf-tmfifo.c:212: warning: Function parameter or member 'unused' not described in 'mlxbf_tmfifo_msg_hdr'

Fixes: 1357dfd7 ("platform/mellanox: Add TmFifo driver for Mellanox BlueField Soc")
Fixes: bc05ea63 ("platform/mellanox: Add BlueField-3 support in the tmfifo driver")
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Closes: lore.kernel.org/r/202309252330.saRU491h-lkp@intel.com
Cc: Liming Sun <lsun@mellanox.com>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Cc: Mark Gross <markgross@kernel.org>
Cc: Vadim Pasternak <vadimp@nvidia.com>
Cc: platform-driver-x86@vger.kernel.org
Link: https://lore.kernel.org/r/20230926054013.11450-1-rdunlap@infradead.org


Signed-off-by: default avatarHans de Goede <hdegoede@redhat.com>
parent 2545deba

drivers/platform/mellanox/mlxbf-tmfifo.c

+8 −6
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ 
struct mlxbf_tmfifo;



/**

 * mlxbf_tmfifo_vring - Structure of the TmFifo virtual ring

 * struct mlxbf_tmfifo_vring - Structure of the TmFifo virtual ring

 * @va: virtual address of the ring

 * @dma: dma address of the ring

 * @vq: pointer to the virtio virtqueue
@@ -113,12 +113,13 @@ enum { 
};



/**

 * mlxbf_tmfifo_vdev - Structure of the TmFifo virtual device

 * struct mlxbf_tmfifo_vdev - Structure of the TmFifo virtual device

 * @vdev: virtio device, in which the vdev.id.device field has the

 *        VIRTIO_ID_xxx id to distinguish the virtual device.

 * @status: status of the device

 * @features: supported features of the device

 * @vrings: array of tmfifo vrings of this device

 * @config: non-anonymous union for cons and net

 * @config.cons: virtual console config -

 *               select if vdev.id.device is VIRTIO_ID_CONSOLE

 * @config.net: virtual network config -
@@ -138,7 +139,7 @@ struct mlxbf_tmfifo_vdev { 
};



/**

 * mlxbf_tmfifo_irq_info - Structure of the interrupt information

 * struct mlxbf_tmfifo_irq_info - Structure of the interrupt information

 * @fifo: pointer to the tmfifo structure

 * @irq: interrupt number

 * @index: index into the interrupt array
@@ -150,7 +151,7 @@ struct mlxbf_tmfifo_irq_info { 
};



/**

 * mlxbf_tmfifo_io - Structure of the TmFifo IO resource (for both rx & tx)

 * struct mlxbf_tmfifo_io - Structure of the TmFifo IO resource (for both rx & tx)

 * @ctl: control register offset (TMFIFO_RX_CTL / TMFIFO_TX_CTL)

 * @sts: status register offset (TMFIFO_RX_STS / TMFIFO_TX_STS)

 * @data: data register offset (TMFIFO_RX_DATA / TMFIFO_TX_DATA)
@@ -162,7 +163,7 @@ struct mlxbf_tmfifo_io { 
};



/**

 * mlxbf_tmfifo - Structure of the TmFifo

 * struct mlxbf_tmfifo - Structure of the TmFifo

 * @vdev: array of the virtual devices running over the TmFifo

 * @lock: lock to protect the TmFifo access

 * @res0: mapped resource block 0
@@ -198,7 +199,7 @@ struct mlxbf_tmfifo { 
};



/**

 * mlxbf_tmfifo_msg_hdr - Structure of the TmFifo message header

 * struct mlxbf_tmfifo_msg_hdr - Structure of the TmFifo message header

 * @type: message type

 * @len: payload length in network byte order. Messages sent into the FIFO

 *       will be read by the other side as data stream in the same byte order.
@@ -208,6 +209,7 @@ struct mlxbf_tmfifo { 
struct mlxbf_tmfifo_msg_hdr {

	u8 type;

	__be16 len;

	/* private: */

	u8 unused[5];

} __packed __aligned(sizeof(u64));