Document ifdi_tx_queues_alloc and ifdi_rx_queues_alloc.
Prior to this change the manual page documented ifdi_queues_alloc which has been replaced by separate methods for tx and rx queues. Reviewed by: kmacy, shurd Sponsored by: iXsystems, Inc. Differential Revision: https://reviews.freebsd.org/D15218
This commit is contained in:
parent
aa8a24d37f
commit
42536618be
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=333219
@ -1,5 +1,5 @@
|
|||||||
.\" $FreeBSD$
|
.\" $FreeBSD$
|
||||||
.Dd March 23, 2017
|
.Dd May 3, 2018
|
||||||
.Dt IFLIBDD 9
|
.Dt IFLIBDD 9
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
@ -10,11 +10,20 @@
|
|||||||
.Ss "Soft Queue Setup and Teardown Functions"
|
.Ss "Soft Queue Setup and Teardown Functions"
|
||||||
.Ss "Mandatory Functions"
|
.Ss "Mandatory Functions"
|
||||||
.Ft int
|
.Ft int
|
||||||
.Fo ifdi_queues_alloc
|
.Fo ifdi_tx_queues_alloc
|
||||||
.Fa "if_ctx_t ctx"
|
.Fa "if_ctx_t ctx"
|
||||||
.Fa "caddr_t *vaddrs"
|
.Fa "caddr_t *vaddrs"
|
||||||
.Fa "uint64_t *paddrs"
|
.Fa "uint64_t *paddrs"
|
||||||
.Fa "int nqs"
|
.Fa "int ntxqs"
|
||||||
|
.Fa "int ntxqsets"
|
||||||
|
.Fc
|
||||||
|
.Ft int
|
||||||
|
.Fo ifdi_rx_queues_alloc
|
||||||
|
.Fa "if_ctx_t ctx"
|
||||||
|
.Fa "caddr_t *vaddrs"
|
||||||
|
.Fa "uint64_t *paddrs"
|
||||||
|
.Fa "int nrxqs"
|
||||||
|
.Fa "int nrxqsets"
|
||||||
.Fc
|
.Fc
|
||||||
.Ft int
|
.Ft int
|
||||||
.Fo ifdi_queues_free
|
.Fo ifdi_queues_free
|
||||||
@ -185,14 +194,20 @@ registers.
|
|||||||
.Ss Device Dependent Functions
|
.Ss Device Dependent Functions
|
||||||
.Ss Soft Queue Setup and Teardown
|
.Ss Soft Queue Setup and Teardown
|
||||||
.Bl -ohang -offset indent
|
.Bl -ohang -offset indent
|
||||||
.It Fn ifdi_queues_alloc
|
.It Fn ifdi_tx_queues_alloc
|
||||||
Mandatory queues allocation function that is called during iflib_attach.
|
Mandatory function that is called during iflib_attach to allocate transmit
|
||||||
|
queues.
|
||||||
vaddrs and paddrs are arrays of virtual and physical addresses respectively of
|
vaddrs and paddrs are arrays of virtual and physical addresses respectively of
|
||||||
the hardware transmit and receive queues, and if relevany, any command
|
the hardware transmit queues.
|
||||||
completion queues.
|
ntxqs is the number of queues per qset.
|
||||||
nqs is the number of queues per qset.
|
ntxqsets is the number of qsets.
|
||||||
For example, a driver with a single receive and transmit queue would have a nqs
|
.It Fn ifdi_rx_queues_alloc
|
||||||
equal to 2.
|
Mandatory function that is called during iflib_attach to allocate receive
|
||||||
|
queues.
|
||||||
|
vaddrs and paddrs are arrays of virtual and physical addresses respectively of
|
||||||
|
the hardware receive queues.
|
||||||
|
nrxqs is the number of queues per qset.
|
||||||
|
nrxqsets is the number of qsets.
|
||||||
.It Fn ifdi_queues_free
|
.It Fn ifdi_queues_free
|
||||||
Mandatory function that frees the allocated queues and associated transmit
|
Mandatory function that frees the allocated queues and associated transmit
|
||||||
buffers.
|
buffers.
|
||||||
|
Loading…
Reference in New Issue
Block a user