Skip to content

Commit 81929a4

Browse files
jbrandebdavem330
authored andcommitted
drivers/net/ethernet: remove incorrectly formatted doc
As part of the W=1 series for ethernet, these drivers were discovered to be using kdoc style comments but were not actually doing kdoc. The kernel uses kdoc style when documenting code, not doxygen or other styles. Fixed Warnings: drivers/net/ethernet/amazon/ena/ena_com.c:613: warning: Function parameter or member 'ena_dev' not described in 'ena_com_set_llq' drivers/net/ethernet/aquantia/atlantic/hw_atl/hw_atl_b0.c:1540: warning: Cannot understand * @brief Set VLAN filter table drivers/net/ethernet/xilinx/ll_temac_main.c:114: warning: Function parameter or member 'lp' not described in 'temac_indirect_busywait' drivers/net/ethernet/xilinx/ll_temac_main.c:129: warning: Function parameter or member 'lp' not described in 'temac_indirect_in32' drivers/net/ethernet/xilinx/ll_temac_main.c:129: warning: Function parameter or member 'reg' not described in 'temac_indirect_in32' drivers/net/ethernet/xilinx/ll_temac_main.c:147: warning: Function parameter or member 'lp' not described in 'temac_indirect_in32_locked' drivers/net/ethernet/xilinx/ll_temac_main.c:147: warning: Function parameter or member 'reg' not described in 'temac_indirect_in32_locked' drivers/net/ethernet/xilinx/ll_temac_main.c:172: warning: Function parameter or member 'lp' not described in 'temac_indirect_out32' drivers/net/ethernet/xilinx/ll_temac_main.c:172: warning: Function parameter or member 'reg' not described in 'temac_indirect_out32' drivers/net/ethernet/xilinx/ll_temac_main.c:172: warning: Function parameter or member 'value' not described in 'temac_indirect_out32' drivers/net/ethernet/xilinx/ll_temac_main.c:188: warning: Function parameter or member 'lp' not described in 'temac_indirect_out32_locked' drivers/net/ethernet/xilinx/ll_temac_main.c:188: warning: Function parameter or member 'reg' not described in 'temac_indirect_out32_locked' drivers/net/ethernet/xilinx/ll_temac_main.c:188: warning: Function parameter or member 'value' not described in 'temac_indirect_out32_locked' drivers/net/ethernet/xilinx/ll_temac_main.c:212: warning: Function parameter or member 'lp' not described in 'temac_dma_in32_be' drivers/net/ethernet/xilinx/ll_temac_main.c:212: warning: Function parameter or member 'reg' not described in 'temac_dma_in32_be' drivers/net/ethernet/xilinx/ll_temac_main.c:228: warning: Function parameter or member 'lp' not described in 'temac_dma_out32_be' drivers/net/ethernet/xilinx/ll_temac_main.c:228: warning: Function parameter or member 'reg' not described in 'temac_dma_out32_be' drivers/net/ethernet/xilinx/ll_temac_main.c:228: warning: Function parameter or member 'value' not described in 'temac_dma_out32_be' drivers/net/ethernet/xilinx/ll_temac_main.c:247: warning: Function parameter or member 'lp' not described in 'temac_dma_dcr_in' drivers/net/ethernet/xilinx/ll_temac_main.c:247: warning: Function parameter or member 'reg' not described in 'temac_dma_dcr_in' drivers/net/ethernet/xilinx/ll_temac_main.c:255: warning: Function parameter or member 'lp' not described in 'temac_dma_dcr_out' drivers/net/ethernet/xilinx/ll_temac_main.c:255: warning: Function parameter or member 'reg' not described in 'temac_dma_dcr_out' drivers/net/ethernet/xilinx/ll_temac_main.c:255: warning: Function parameter or member 'value' not described in 'temac_dma_dcr_out' drivers/net/ethernet/xilinx/ll_temac_main.c:265: warning: Function parameter or member 'lp' not described in 'temac_dcr_setup' drivers/net/ethernet/xilinx/ll_temac_main.c:265: warning: Function parameter or member 'op' not described in 'temac_dcr_setup' drivers/net/ethernet/xilinx/ll_temac_main.c:265: warning: Function parameter or member 'np' not described in 'temac_dcr_setup' drivers/net/ethernet/xilinx/ll_temac_main.c:300: warning: Function parameter or member 'ndev' not described in 'temac_dma_bd_release' drivers/net/ethernet/xilinx/ll_temac_main.c:330: warning: Function parameter or member 'ndev' not described in 'temac_dma_bd_init' drivers/net/ethernet/xilinx/ll_temac_main.c:600: warning: Function parameter or member 'ndev' not described in 'temac_setoptions' drivers/net/ethernet/xilinx/ll_temac_main.c:600: warning: Function parameter or member 'options' not described in 'temac_setoptions' Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com> Signed-off-by: David S. Miller <davem@davemloft.net>
1 parent f410f15 commit 81929a4

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

drivers/net/ethernet/amazon/ena/ena_com.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ static int ena_com_wait_and_process_admin_cq_polling(struct ena_comp_ctx *comp_c
579579
return ret;
580580
}
581581

582-
/**
582+
/*
583583
* Set the LLQ configurations of the firmware
584584
*
585585
* The driver provides only the enabled feature values to the device,

drivers/net/ethernet/aquantia/atlantic/hw_atl/hw_atl_b0.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1536,7 +1536,7 @@ static int hw_atl_b0_hw_fl2_clear(struct aq_hw_s *self,
15361536
return aq_hw_err_from_flags(self);
15371537
}
15381538

1539-
/**
1539+
/*
15401540
* @brief Set VLAN filter table
15411541
* @details Configure VLAN filter table to accept (and assign the queue) traffic
15421542
* for the particular vlan ids.

drivers/net/ethernet/xilinx/ll_temac_main.c

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ static bool hard_acs_rdy_or_timeout(struct temac_local *lp, ktime_t timeout)
106106
*/
107107
#define HARD_ACS_RDY_POLL_NS (20 * NSEC_PER_MSEC)
108108

109-
/**
109+
/*
110110
* temac_indirect_busywait - Wait for current indirect register access
111111
* to complete.
112112
*/
@@ -121,7 +121,7 @@ int temac_indirect_busywait(struct temac_local *lp)
121121
return 0;
122122
}
123123

124-
/**
124+
/*
125125
* temac_indirect_in32 - Indirect register read access. This function
126126
* must be called without lp->indirect_lock being held.
127127
*/
@@ -136,7 +136,7 @@ u32 temac_indirect_in32(struct temac_local *lp, int reg)
136136
return val;
137137
}
138138

139-
/**
139+
/*
140140
* temac_indirect_in32_locked - Indirect register read access. This
141141
* function must be called with lp->indirect_lock being held. Use
142142
* this together with spin_lock_irqsave/spin_lock_irqrestore to avoid
@@ -164,7 +164,7 @@ u32 temac_indirect_in32_locked(struct temac_local *lp, int reg)
164164
return temac_ior(lp, XTE_LSW0_OFFSET);
165165
}
166166

167-
/**
167+
/*
168168
* temac_indirect_out32 - Indirect register write access. This function
169169
* must be called without lp->indirect_lock being held.
170170
*/
@@ -177,7 +177,7 @@ void temac_indirect_out32(struct temac_local *lp, int reg, u32 value)
177177
spin_unlock_irqrestore(lp->indirect_lock, flags);
178178
}
179179

180-
/**
180+
/*
181181
* temac_indirect_out32_locked - Indirect register write access. This
182182
* function must be called with lp->indirect_lock being held. Use
183183
* this together with spin_lock_irqsave/spin_lock_irqrestore to avoid
@@ -202,7 +202,7 @@ void temac_indirect_out32_locked(struct temac_local *lp, int reg, u32 value)
202202
WARN_ON(temac_indirect_busywait(lp));
203203
}
204204

205-
/**
205+
/*
206206
* temac_dma_in32_* - Memory mapped DMA read, these function expects a
207207
* register input that is based on DCR word addresses which are then
208208
* converted to memory mapped byte addresses. To be assigned to
@@ -218,7 +218,7 @@ static u32 temac_dma_in32_le(struct temac_local *lp, int reg)
218218
return ioread32(lp->sdma_regs + (reg << 2));
219219
}
220220

221-
/**
221+
/*
222222
* temac_dma_out32_* - Memory mapped DMA read, these function expects
223223
* a register input that is based on DCR word addresses which are then
224224
* converted to memory mapped byte addresses. To be assigned to
@@ -240,23 +240,23 @@ static void temac_dma_out32_le(struct temac_local *lp, int reg, u32 value)
240240
*/
241241
#ifdef CONFIG_PPC_DCR
242242

243-
/**
243+
/*
244244
* temac_dma_dcr_in32 - DCR based DMA read
245245
*/
246246
static u32 temac_dma_dcr_in(struct temac_local *lp, int reg)
247247
{
248248
return dcr_read(lp->sdma_dcrs, reg);
249249
}
250250

251-
/**
251+
/*
252252
* temac_dma_dcr_out32 - DCR based DMA write
253253
*/
254254
static void temac_dma_dcr_out(struct temac_local *lp, int reg, u32 value)
255255
{
256256
dcr_write(lp->sdma_dcrs, reg, value);
257257
}
258258

259-
/**
259+
/*
260260
* temac_dcr_setup - If the DMA is DCR based, then setup the address and
261261
* I/O functions
262262
*/
@@ -293,7 +293,7 @@ static int temac_dcr_setup(struct temac_local *lp, struct platform_device *op,
293293

294294
#endif
295295

296-
/**
296+
/*
297297
* temac_dma_bd_release - Release buffer descriptor rings
298298
*/
299299
static void temac_dma_bd_release(struct net_device *ndev)
@@ -323,7 +323,7 @@ static void temac_dma_bd_release(struct net_device *ndev)
323323
lp->tx_bd_v, lp->tx_bd_p);
324324
}
325325

326-
/**
326+
/*
327327
* temac_dma_bd_init - Setup buffer descriptor rings
328328
*/
329329
static int temac_dma_bd_init(struct net_device *ndev)
@@ -593,7 +593,7 @@ static struct temac_option {
593593
{}
594594
};
595595

596-
/**
596+
/*
597597
* temac_setoptions
598598
*/
599599
static u32 temac_setoptions(struct net_device *ndev, u32 options)

0 commit comments

Comments
 (0)