From owner-svn-src-head@freebsd.org Thu May 3 17:49:27 2018 Return-Path: Delivered-To: svn-src-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 78EDCFB3929; Thu, 3 May 2018 17:49:27 +0000 (UTC) (envelope-from benno@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 2A6687CCAA; Thu, 3 May 2018 17:49:27 +0000 (UTC) (envelope-from benno@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 1EA8B23116; Thu, 3 May 2018 17:49:27 +0000 (UTC) (envelope-from benno@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w43HnQRd011613; Thu, 3 May 2018 17:49:26 GMT (envelope-from benno@FreeBSD.org) Received: (from benno@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w43HnQo5011612; Thu, 3 May 2018 17:49:26 GMT (envelope-from benno@FreeBSD.org) Message-Id: <201805031749.w43HnQo5011612@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: benno set sender to benno@FreeBSD.org using -f From: Benno Rice Date: Thu, 3 May 2018 17:49:26 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r333219 - head/share/man/man9 X-SVN-Group: head X-SVN-Commit-Author: benno X-SVN-Commit-Paths: head/share/man/man9 X-SVN-Commit-Revision: 333219 X-SVN-Commit-Repository: base MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-head@freebsd.org X-Mailman-Version: 2.1.25 Precedence: list List-Id: SVN commit messages for the src tree for head/-current List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 03 May 2018 17:49:27 -0000 Author: benno Date: Thu May 3 17:49:26 2018 New Revision: 333219 URL: https://svnweb.freebsd.org/changeset/base/333219 Log: 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 Modified: head/share/man/man9/iflibdd.9 Modified: head/share/man/man9/iflibdd.9 ============================================================================== --- head/share/man/man9/iflibdd.9 Thu May 3 17:02:31 2018 (r333218) +++ head/share/man/man9/iflibdd.9 Thu May 3 17:49:26 2018 (r333219) @@ -1,5 +1,5 @@ .\" $FreeBSD$ -.Dd March 23, 2017 +.Dd May 3, 2018 .Dt IFLIBDD 9 .Os .Sh NAME @@ -10,13 +10,22 @@ .Ss "Soft Queue Setup and Teardown Functions" .Ss "Mandatory Functions" .Ft int -.Fo ifdi_queues_alloc +.Fo ifdi_tx_queues_alloc .Fa "if_ctx_t ctx" .Fa "caddr_t *vaddrs" .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 +.Ft int .Fo ifdi_queues_free .Fa "if_ctx_t ctx" .Fc @@ -185,14 +194,20 @@ registers. .Ss Device Dependent Functions .Ss Soft Queue Setup and Teardown .Bl -ohang -offset indent -.It Fn ifdi_queues_alloc -Mandatory queues allocation function that is called during iflib_attach. +.It Fn ifdi_tx_queues_alloc +Mandatory function that is called during iflib_attach to allocate transmit +queues. vaddrs and paddrs are arrays of virtual and physical addresses respectively of -the hardware transmit and receive queues, and if relevany, any command -completion queues. -nqs is the number of queues per qset. -For example, a driver with a single receive and transmit queue would have a nqs -equal to 2. +the hardware transmit queues. +ntxqs is the number of queues per qset. +ntxqsets is the number of qsets. +.It Fn ifdi_rx_queues_alloc +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 Mandatory function that frees the allocated queues and associated transmit buffers.