Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 529eb362 authored by Jan Sokolowski's avatar Jan Sokolowski Committed by Jeff Kirsher
Browse files

i40e: fix kerneldoc for xsk methods 



One method, xsk_umem_setup, had an incorrect kernel doc
description, which has been corrected.

Also fixes small typos found in the comments.

Signed-off-by: default avatarJan Sokolowski <jan.sokolowski@intel.com>
Tested-by: default avatarAndrew Bowers <andrewx.bowers@intel.com>
Signed-off-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
parent a8bf879a

drivers/net/ethernet/intel/i40e/i40e_xsk.c

+7 −7
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ static int i40e_alloc_xsk_umems(struct i40e_vsi *vsi) 
}



/**

 * i40e_add_xsk_umem - Store an UMEM for a certain ring/qid

 * i40e_add_xsk_umem - Store a UMEM for a certain ring/qid

 * @vsi: Current VSI

 * @umem: UMEM to store

 * @qid: Ring/qid to associate with the UMEM
@@ -56,7 +56,7 @@ static int i40e_add_xsk_umem(struct i40e_vsi *vsi, struct xdp_umem *umem, 
}



/**

 * i40e_remove_xsk_umem - Remove an UMEM for a certain ring/qid

 * i40e_remove_xsk_umem - Remove a UMEM for a certain ring/qid

 * @vsi: Current VSI

 * @qid: Ring/qid associated with the UMEM

 **/
@@ -130,7 +130,7 @@ static void i40e_xsk_umem_dma_unmap(struct i40e_vsi *vsi, struct xdp_umem *umem) 
}



/**

 * i40e_xsk_umem_enable - Enable/associate an UMEM to a certain ring/qid

 * i40e_xsk_umem_enable - Enable/associate a UMEM to a certain ring/qid

 * @vsi: Current VSI

 * @umem: UMEM

 * @qid: Rx ring to associate UMEM to
@@ -189,7 +189,7 @@ static int i40e_xsk_umem_enable(struct i40e_vsi *vsi, struct xdp_umem *umem, 
}



/**

 * i40e_xsk_umem_disable - Diassociate an UMEM from a certain ring/qid

 * i40e_xsk_umem_disable - Disassociate a UMEM from a certain ring/qid

 * @vsi: Current VSI

 * @qid: Rx ring to associate UMEM to

 *
@@ -255,12 +255,12 @@ int i40e_xsk_umem_query(struct i40e_vsi *vsi, struct xdp_umem **umem, 
}



/**

 * i40e_xsk_umem_query - Queries a certain ring/qid for its UMEM

 * i40e_xsk_umem_setup - Enable/disassociate a UMEM to/from a ring/qid

 * @vsi: Current VSI

 * @umem: UMEM to enable/associate to a ring, or NULL to disable

 * @qid: Rx ring to (dis)associate UMEM (from)to

 *

 * This function enables or disables an UMEM to a certain ring.

 * This function enables or disables a UMEM to a certain ring.

 *

 * Returns 0 on success, <0 on failure

 **/
@@ -276,7 +276,7 @@ int i40e_xsk_umem_setup(struct i40e_vsi *vsi, struct xdp_umem *umem, 
 * @rx_ring: Rx ring

 * @xdp: xdp_buff used as input to the XDP program

 *

 * This function enables or disables an UMEM to a certain ring.

 * This function enables or disables a UMEM to a certain ring.

 *

 * Returns any of I40E_XDP_{PASS, CONSUMED, TX, REDIR}

 **/