@@ -218,111 +218,121 @@ struct octep_ctrl_net_wait_data {
218
218
} data ;
219
219
};
220
220
221
- /** Initialize data for ctrl net.
221
+ /**
222
+ * octep_ctrl_net_init() - Initialize data for ctrl net.
222
223
*
223
- * @param oct: non-null pointer to struct octep_device.
224
+ * @oct: non-null pointer to struct octep_device.
224
225
*
225
226
* return value: 0 on success, -errno on error.
226
227
*/
227
228
int octep_ctrl_net_init (struct octep_device * oct );
228
229
229
- /** Get link status from firmware.
230
+ /**
231
+ * octep_ctrl_net_get_link_status() - Get link status from firmware.
230
232
*
231
- * @param oct: non-null pointer to struct octep_device.
232
- * @param vfid: Index of virtual function.
233
+ * @oct: non-null pointer to struct octep_device.
234
+ * @vfid: Index of virtual function.
233
235
*
234
236
* return value: link status 0=down, 1=up.
235
237
*/
236
238
int octep_ctrl_net_get_link_status (struct octep_device * oct , int vfid );
237
239
238
- /** Set link status in firmware.
240
+ /**
241
+ * octep_ctrl_net_set_link_status() - Set link status in firmware.
239
242
*
240
- * @param oct: non-null pointer to struct octep_device.
241
- * @param vfid: Index of virtual function.
242
- * @param up: boolean status.
243
- * @param wait_for_response: poll for response.
243
+ * @oct: non-null pointer to struct octep_device.
244
+ * @vfid: Index of virtual function.
245
+ * @up: boolean status.
246
+ * @wait_for_response: poll for response.
244
247
*
245
248
* return value: 0 on success, -errno on failure
246
249
*/
247
250
int octep_ctrl_net_set_link_status (struct octep_device * oct , int vfid , bool up ,
248
251
bool wait_for_response );
249
252
250
- /** Set rx state in firmware.
253
+ /**
254
+ * octep_ctrl_net_set_rx_state() - Set rx state in firmware.
251
255
*
252
- * @param oct: non-null pointer to struct octep_device.
253
- * @param vfid: Index of virtual function.
254
- * @param up: boolean status.
255
- * @param wait_for_response: poll for response.
256
+ * @oct: non-null pointer to struct octep_device.
257
+ * @vfid: Index of virtual function.
258
+ * @up: boolean status.
259
+ * @wait_for_response: poll for response.
256
260
*
257
261
* return value: 0 on success, -errno on failure.
258
262
*/
259
263
int octep_ctrl_net_set_rx_state (struct octep_device * oct , int vfid , bool up ,
260
264
bool wait_for_response );
261
265
262
- /** Get mac address from firmware.
266
+ /**
267
+ * octep_ctrl_net_get_mac_addr() - Get mac address from firmware.
263
268
*
264
- * @param oct: non-null pointer to struct octep_device.
265
- * @param vfid: Index of virtual function.
266
- * @param addr: non-null pointer to mac address.
269
+ * @oct: non-null pointer to struct octep_device.
270
+ * @vfid: Index of virtual function.
271
+ * @addr: non-null pointer to mac address.
267
272
*
268
273
* return value: 0 on success, -errno on failure.
269
274
*/
270
275
int octep_ctrl_net_get_mac_addr (struct octep_device * oct , int vfid , u8 * addr );
271
276
272
- /** Set mac address in firmware.
277
+ /**
278
+ * octep_ctrl_net_set_mac_addr() - Set mac address in firmware.
273
279
*
274
- * @param oct: non-null pointer to struct octep_device.
275
- * @param vfid: Index of virtual function.
276
- * @param addr: non-null pointer to mac address.
277
- * @param wait_for_response: poll for response.
280
+ * @oct: non-null pointer to struct octep_device.
281
+ * @vfid: Index of virtual function.
282
+ * @addr: non-null pointer to mac address.
283
+ * @wait_for_response: poll for response.
278
284
*
279
285
* return value: 0 on success, -errno on failure.
280
286
*/
281
287
int octep_ctrl_net_set_mac_addr (struct octep_device * oct , int vfid , u8 * addr ,
282
288
bool wait_for_response );
283
289
284
- /** Set mtu in firmware.
290
+ /**
291
+ * octep_ctrl_net_set_mtu() - Set mtu in firmware.
285
292
*
286
- * @param oct: non-null pointer to struct octep_device.
287
- * @param vfid: Index of virtual function.
288
- * @param mtu: mtu.
289
- * @param wait_for_response: poll for response.
293
+ * @oct: non-null pointer to struct octep_device.
294
+ * @vfid: Index of virtual function.
295
+ * @mtu: mtu.
296
+ * @wait_for_response: poll for response.
290
297
*
291
298
* return value: 0 on success, -errno on failure.
292
299
*/
293
300
int octep_ctrl_net_set_mtu (struct octep_device * oct , int vfid , int mtu ,
294
301
bool wait_for_response );
295
302
296
- /** Get interface statistics from firmware.
303
+ /**
304
+ * octep_ctrl_net_get_if_stats() - Get interface statistics from firmware.
297
305
*
298
- * @param oct: non-null pointer to struct octep_device.
299
- * @param vfid: Index of virtual function.
300
- * @param rx_stats: non-null pointer struct octep_iface_rx_stats.
301
- * @param tx_stats: non-null pointer struct octep_iface_tx_stats.
306
+ * @oct: non-null pointer to struct octep_device.
307
+ * @vfid: Index of virtual function.
308
+ * @rx_stats: non-null pointer struct octep_iface_rx_stats.
309
+ * @tx_stats: non-null pointer struct octep_iface_tx_stats.
302
310
*
303
311
* return value: 0 on success, -errno on failure.
304
312
*/
305
313
int octep_ctrl_net_get_if_stats (struct octep_device * oct , int vfid ,
306
314
struct octep_iface_rx_stats * rx_stats ,
307
315
struct octep_iface_tx_stats * tx_stats );
308
316
309
- /** Get link info from firmware.
317
+ /**
318
+ * octep_ctrl_net_get_link_info() - Get link info from firmware.
310
319
*
311
- * @param oct: non-null pointer to struct octep_device.
312
- * @param vfid: Index of virtual function.
313
- * @param link_info: non-null pointer to struct octep_iface_link_info.
320
+ * @oct: non-null pointer to struct octep_device.
321
+ * @vfid: Index of virtual function.
322
+ * @link_info: non-null pointer to struct octep_iface_link_info.
314
323
*
315
324
* return value: 0 on success, -errno on failure.
316
325
*/
317
326
int octep_ctrl_net_get_link_info (struct octep_device * oct , int vfid ,
318
327
struct octep_iface_link_info * link_info );
319
328
320
- /** Set link info in firmware.
329
+ /**
330
+ * octep_ctrl_net_set_link_info() - Set link info in firmware.
321
331
*
322
- * @param oct: non-null pointer to struct octep_device.
323
- * @param vfid: Index of virtual function.
324
- * @param link_info: non-null pointer to struct octep_iface_link_info.
325
- * @param wait_for_response: poll for response.
332
+ * @oct: non-null pointer to struct octep_device.
333
+ * @vfid: Index of virtual function.
334
+ * @link_info: non-null pointer to struct octep_iface_link_info.
335
+ * @wait_for_response: poll for response.
326
336
*
327
337
* return value: 0 on success, -errno on failure.
328
338
*/
@@ -331,26 +341,29 @@ int octep_ctrl_net_set_link_info(struct octep_device *oct,
331
341
struct octep_iface_link_info * link_info ,
332
342
bool wait_for_response );
333
343
334
- /** Poll for firmware messages and process them.
344
+ /**
345
+ * octep_ctrl_net_recv_fw_messages() - Poll for firmware messages and process them.
335
346
*
336
- * @param oct: non-null pointer to struct octep_device.
347
+ * @oct: non-null pointer to struct octep_device.
337
348
*/
338
349
void octep_ctrl_net_recv_fw_messages (struct octep_device * oct );
339
350
340
- /** Get info from firmware.
351
+ /**
352
+ * octep_ctrl_net_get_info() - Get info from firmware.
341
353
*
342
- * @param oct: non-null pointer to struct octep_device.
343
- * @param vfid: Index of virtual function.
344
- * @param info: non-null pointer to struct octep_fw_info.
354
+ * @oct: non-null pointer to struct octep_device.
355
+ * @vfid: Index of virtual function.
356
+ * @info: non-null pointer to struct octep_fw_info.
345
357
*
346
358
* return value: 0 on success, -errno on failure.
347
359
*/
348
360
int octep_ctrl_net_get_info (struct octep_device * oct , int vfid ,
349
361
struct octep_fw_info * info );
350
362
351
- /** Uninitialize data for ctrl net.
363
+ /**
364
+ * octep_ctrl_net_uninit() - Uninitialize data for ctrl net.
352
365
*
353
- * @param oct: non-null pointer to struct octep_device.
366
+ * @oct: non-null pointer to struct octep_device.
354
367
*
355
368
* return value: 0 on success, -errno on error.
356
369
*/
0 commit comments