Commit da0940e5 authored by Lee Jones's avatar Lee Jones Committed by Jason Gunthorpe

RDMA/hw/hfi1/chip: Fix a bunch of kernel-doc formatting and spelling issues

Fixes the following W=1 kernel build warning(s):

 drivers/infiniband/hw/hfi1/chip.c:1335: warning: Function parameter or member 'dd' not described in 'hfi1_addr_from_offset'
 drivers/infiniband/hw/hfi1/chip.c:1335: warning: Function parameter or member 'offset' not described in 'hfi1_addr_from_offset'
 drivers/infiniband/hw/hfi1/chip.c:1350: warning: Function parameter or member 'dd' not described in 'read_csr'
 drivers/infiniband/hw/hfi1/chip.c:1350: warning: Function parameter or member 'offset' not described in 'read_csr'
 drivers/infiniband/hw/hfi1/chip.c:1363: warning: Function parameter or member 'dd' not described in 'write_csr'
 drivers/infiniband/hw/hfi1/chip.c:1363: warning: Function parameter or member 'offset' not described in 'write_csr'
 drivers/infiniband/hw/hfi1/chip.c:1363: warning: Function parameter or member 'value' not described in 'write_csr'
 drivers/infiniband/hw/hfi1/chip.c:1385: warning: Function parameter or member 'dd' not described in 'get_csr_addr'
 drivers/infiniband/hw/hfi1/chip.c:1385: warning: Function parameter or member 'offset' not described in 'get_csr_addr'
 drivers/infiniband/hw/hfi1/chip.c:8442: warning: Function parameter or member 'rcd' not described in 'receive_interrupt_common'
 drivers/infiniband/hw/hfi1/chip.c:8491: warning: Function parameter or member 'napi' not described in 'hfi1_netdev_rx_napi'
 drivers/infiniband/hw/hfi1/chip.c:8491: warning: Function parameter or member 'budget' not described in 'hfi1_netdev_rx_napi'
 drivers/infiniband/hw/hfi1/chip.c:14221: warning: Function parameter or member 'dd' not described in 'init_qpmap_table'
 drivers/infiniband/hw/hfi1/chip.c:14221: warning: Function parameter or member 'first_ctxt' not described in 'init_qpmap_table'
 drivers/infiniband/hw/hfi1/chip.c:14221: warning: Function parameter or member 'last_ctxt' not described in 'init_qpmap_table'
 drivers/infiniband/hw/hfi1/chip.c:14399: warning: Function parameter or member 'dd' not described in 'init_qos'
 drivers/infiniband/hw/hfi1/chip.c:14399: warning: Function parameter or member 'rmt' not described in 'init_qos'
 drivers/infiniband/hw/hfi1/chip.c:15032: warning: Function parameter or member 'dd' not described in 'hfi1_init_dd'
 drivers/infiniband/hw/hfi1/chip.c:15032: warning: Excess function parameter 'dev' description in 'hfi1_init_dd'
 drivers/infiniband/hw/hfi1/chip.c:15032: warning: Excess function parameter 'ent' description in 'hfi1_init_dd'
 drivers/infiniband/hw/hfi1/chip.c:15395: warning: Function parameter or member 'ppd' not described in 'create_pbc'
 drivers/infiniband/hw/hfi1/chip.c:15395: warning: Function parameter or member 'srate_mbs' not described in 'create_pbc'
 drivers/infiniband/hw/hfi1/chip.c:15395: warning: Function parameter or member 'dw_len' not described in 'create_pbc'
 drivers/infiniband/hw/hfi1/chip.c:15395: warning: Excess function parameter 'srate' description in 'create_pbc'
 drivers/infiniband/hw/hfi1/chip.c:15395: warning: Excess function parameter 'dwlen' description in 'create_pbc'

Link: https://lore.kernel.org/r/20210121094519.2044049-16-lee.jones@linaro.org
Cc: Mike Marciniszyn <mike.marciniszyn@cornelisnetworks.com>
Cc: Dennis Dalessandro <dennis.dalessandro@cornelisnetworks.com>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@ziepe.ca>
Cc: linux-rdma@vger.kernel.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarJason Gunthorpe <jgg@nvidia.com>
parent 24d02e04
...@@ -1323,8 +1323,8 @@ CNTR_ELEM(#name, \ ...@@ -1323,8 +1323,8 @@ CNTR_ELEM(#name, \
/** /**
* hfi_addr_from_offset - return addr for readq/writeq * hfi_addr_from_offset - return addr for readq/writeq
* @dd - the dd device * @dd: the dd device
* @offset - the offset of the CSR within bar0 * @offset: the offset of the CSR within bar0
* *
* This routine selects the appropriate base address * This routine selects the appropriate base address
* based on the indicated offset. * based on the indicated offset.
...@@ -1340,8 +1340,8 @@ static inline void __iomem *hfi1_addr_from_offset( ...@@ -1340,8 +1340,8 @@ static inline void __iomem *hfi1_addr_from_offset(
/** /**
* read_csr - read CSR at the indicated offset * read_csr - read CSR at the indicated offset
* @dd - the dd device * @dd: the dd device
* @offset - the offset of the CSR within bar0 * @offset: the offset of the CSR within bar0
* *
* Return: the value read or all FF's if there * Return: the value read or all FF's if there
* is no mapping * is no mapping
...@@ -1355,9 +1355,9 @@ u64 read_csr(const struct hfi1_devdata *dd, u32 offset) ...@@ -1355,9 +1355,9 @@ u64 read_csr(const struct hfi1_devdata *dd, u32 offset)
/** /**
* write_csr - write CSR at the indicated offset * write_csr - write CSR at the indicated offset
* @dd - the dd device * @dd: the dd device
* @offset - the offset of the CSR within bar0 * @offset: the offset of the CSR within bar0
* @value - value to write * @value: value to write
*/ */
void write_csr(const struct hfi1_devdata *dd, u32 offset, u64 value) void write_csr(const struct hfi1_devdata *dd, u32 offset, u64 value)
{ {
...@@ -1373,8 +1373,8 @@ void write_csr(const struct hfi1_devdata *dd, u32 offset, u64 value) ...@@ -1373,8 +1373,8 @@ void write_csr(const struct hfi1_devdata *dd, u32 offset, u64 value)
/** /**
* get_csr_addr - return te iomem address for offset * get_csr_addr - return te iomem address for offset
* @dd - the dd device * @dd: the dd device
* @offset - the offset of the CSR within bar0 * @offset: the offset of the CSR within bar0
* *
* Return: The iomem address to use in subsequent * Return: The iomem address to use in subsequent
* writeq/readq operations. * writeq/readq operations.
...@@ -8433,7 +8433,7 @@ static inline int check_packet_present(struct hfi1_ctxtdata *rcd) ...@@ -8433,7 +8433,7 @@ static inline int check_packet_present(struct hfi1_ctxtdata *rcd)
return hfi1_rcd_head(rcd) != tail; return hfi1_rcd_head(rcd) != tail;
} }
/** /*
* Common code for receive contexts interrupt handlers. * Common code for receive contexts interrupt handlers.
* Update traces, increment kernel IRQ counter and * Update traces, increment kernel IRQ counter and
* setup ASPM when needed. * setup ASPM when needed.
...@@ -8447,7 +8447,7 @@ static void receive_interrupt_common(struct hfi1_ctxtdata *rcd) ...@@ -8447,7 +8447,7 @@ static void receive_interrupt_common(struct hfi1_ctxtdata *rcd)
aspm_ctx_disable(rcd); aspm_ctx_disable(rcd);
} }
/** /*
* __hfi1_rcd_eoi_intr() - Make HW issue receive interrupt * __hfi1_rcd_eoi_intr() - Make HW issue receive interrupt
* when there are packets present in the queue. When calling * when there are packets present in the queue. When calling
* with interrupts enabled please use hfi1_rcd_eoi_intr. * with interrupts enabled please use hfi1_rcd_eoi_intr.
...@@ -8484,8 +8484,8 @@ static void hfi1_rcd_eoi_intr(struct hfi1_ctxtdata *rcd) ...@@ -8484,8 +8484,8 @@ static void hfi1_rcd_eoi_intr(struct hfi1_ctxtdata *rcd)
/** /**
* hfi1_netdev_rx_napi - napi poll function to move eoi inline * hfi1_netdev_rx_napi - napi poll function to move eoi inline
* @napi - pointer to napi object * @napi: pointer to napi object
* @budget - netdev budget * @budget: netdev budget
*/ */
int hfi1_netdev_rx_napi(struct napi_struct *napi, int budget) int hfi1_netdev_rx_napi(struct napi_struct *napi, int budget)
{ {
...@@ -10142,7 +10142,7 @@ u32 lrh_max_header_bytes(struct hfi1_devdata *dd) ...@@ -10142,7 +10142,7 @@ u32 lrh_max_header_bytes(struct hfi1_devdata *dd)
/* /*
* Set Send Length * Set Send Length
* @ppd - per port data * @ppd: per port data
* *
* Set the MTU by limiting how many DWs may be sent. The SendLenCheck* * Set the MTU by limiting how many DWs may be sent. The SendLenCheck*
* registers compare against LRH.PktLen, so use the max bytes included * registers compare against LRH.PktLen, so use the max bytes included
...@@ -14200,9 +14200,9 @@ u8 hfi1_get_qp_map(struct hfi1_devdata *dd, u8 idx) ...@@ -14200,9 +14200,9 @@ u8 hfi1_get_qp_map(struct hfi1_devdata *dd, u8 idx)
/** /**
* init_qpmap_table * init_qpmap_table
* @dd - device data * @dd: device data
* @first_ctxt - first context * @first_ctxt: first context
* @last_ctxt - first context * @last_ctxt: first context
* *
* This return sets the qpn mapping table that * This return sets the qpn mapping table that
* is indexed by qpn[8:1]. * is indexed by qpn[8:1].
...@@ -14383,8 +14383,8 @@ static int qos_rmt_entries(struct hfi1_devdata *dd, unsigned int *mp, ...@@ -14383,8 +14383,8 @@ static int qos_rmt_entries(struct hfi1_devdata *dd, unsigned int *mp,
/** /**
* init_qos - init RX qos * init_qos - init RX qos
* @dd - device data * @dd: device data
* @rmt - RSM map table * @rmt: RSM map table
* *
* This routine initializes Rule 0 and the RSM map table to implement * This routine initializes Rule 0 and the RSM map table to implement
* quality of service (qos). * quality of service (qos).
...@@ -15022,8 +15022,7 @@ static int check_int_registers(struct hfi1_devdata *dd) ...@@ -15022,8 +15022,7 @@ static int check_int_registers(struct hfi1_devdata *dd)
/** /**
* hfi1_init_dd() - Initialize most of the dd structure. * hfi1_init_dd() - Initialize most of the dd structure.
* @dev: the pci_dev for hfi1_ib device * @dd: the dd device
* @ent: pci_device_id struct for this dev
* *
* This is global, and is called directly at init to set up the * This is global, and is called directly at init to set up the
* chip-specific function pointers for later use. * chip-specific function pointers for later use.
...@@ -15378,10 +15377,11 @@ static u16 delay_cycles(struct hfi1_pportdata *ppd, u32 desired_egress_rate, ...@@ -15378,10 +15377,11 @@ static u16 delay_cycles(struct hfi1_pportdata *ppd, u32 desired_egress_rate,
/** /**
* create_pbc - build a pbc for transmission * create_pbc - build a pbc for transmission
* @ppd: info of physical Hfi port
* @flags: special case flags or-ed in built pbc * @flags: special case flags or-ed in built pbc
* @srate: static rate * @srate_mbs: static rate
* @vl: vl * @vl: vl
* @dwlen: dword length (header words + data words + pbc words) * @dw_len: dword length (header words + data words + pbc words)
* *
* Create a PBC with the given flags, rate, VL, and length. * Create a PBC with the given flags, rate, VL, and length.
* *
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment