Skip to content

Commit

Permalink
platform/mellanox: tmfifo: fix kernel-doc warnings
Browse files Browse the repository at this point in the history
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: 1357dfd ("platform/mellanox: Add TmFifo driver for Mellanox BlueField Soc")
Fixes: bc05ea6 ("platform/mellanox: Add BlueField-3 support in the tmfifo driver")
Signed-off-by: Randy Dunlap <[email protected]>
Reported-by: kernel test robot <[email protected]>
Closes: lore.kernel.org/r/[email protected]
Cc: Liming Sun <[email protected]>
Cc: Hans de Goede <[email protected]>
Cc: Ilpo Järvinen <[email protected]>
Cc: Mark Gross <[email protected]>
Cc: Vadim Pasternak <[email protected]>
Cc: [email protected]
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Hans de Goede <[email protected]>
  • Loading branch information
rddunlap authored and jwrdegoede committed Oct 4, 2023
1 parent 2545deb commit cbf9256
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions drivers/platform/mellanox/mlxbf-tmfifo.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 -
Expand All @@ -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
Expand All @@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -208,6 +209,7 @@ struct mlxbf_tmfifo {
struct mlxbf_tmfifo_msg_hdr {
u8 type;
__be16 len;
/* private: */
u8 unused[5];
} __packed __aligned(sizeof(u64));

Expand Down

0 comments on commit cbf9256

Please sign in to comment.