Differential D15218 Diff 42097 head/share/man/man9/iflibdd.9

Changeset View

Standalone View

head/share/man/man9/iflibdd.9

	.\" $FreeBSD$			.\" $FreeBSD$
	.Dd March 23, 2017			.Dd May 3, 2018
	.Dt IFLIBDD 9			.Dt IFLIBDD 9
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm iflibdd			.Nm iflibdd
	.Nd Device Dependent Configuration Functions			.Nd Device Dependent Configuration Functions
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.In "ifdi_if.h"			.In "ifdi_if.h"
	.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			.Fc
	.Ft int			.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
				.Ft int
	.Fo ifdi_queues_free			.Fo ifdi_queues_free
	.Fa "if_ctx_t ctx"			.Fa "if_ctx_t ctx"
	.Fc			.Fc
	.Ss "Optional Functions"			.Ss "Optional Functions"
	.Ft int			.Ft int
	.Fo ifdi_txq_setup			.Fo ifdi_txq_setup
	.Fa "if_ctx_t ctx"			.Fa "if_ctx_t ctx"
	.Fa "uint16_t qid"			.Fa "uint16_t qid"
	▲ Show 20 Lines • Show All 152 Lines • ▼ Show 20 Lines
	.Sh FUNCTIONS			.Sh FUNCTIONS
	The above named functions are device dependent configuration functions.			The above named functions are device dependent configuration functions.
	These routines are registered with iflib by the driver and are called from the			These routines are registered with iflib by the driver and are called from the
	corresponding iflib function to configure device specific functions and			corresponding iflib function to configure device specific functions and
	registers.			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.
	.It Fn ifdi_txq_setup			.It Fn ifdi_txq_setup
	Optional function for each transmit queue that handles device specific			Optional function for each transmit queue that handles device specific
	initialization.			initialization.
	.It Fn ifdi_rxq_setup			.It Fn ifdi_rxq_setup
	Optional function for each receive queue that handles device specific			Optional function for each receive queue that handles device specific
	▲ Show 20 Lines • Show All 101 Lines • Show Last 20 Lines