From nobody Wed Feb 5 19:49:53 2025 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Yp9mx5lh8z5mHkj; Wed, 05 Feb 2025 19:49:53 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Yp9mx3KcSz3v4f; Wed, 05 Feb 2025 19:49:53 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1738784993; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=PlSL7UsvSJyr+gtXPcAc7egPt9vu1pzh47mkWOLRKeE=; b=QvANKxpUcenbv4kkONniXmvgaNide7UmcSssLwtvMyJ9ZoDKFxYk4HZyIAQ6X85p4mymzV T8/KQL8+KnLMx6/f3TOpGZWmyI6dkDABl64s7h+h87wJwaGWeKUwI0qogclc/qRDuQ5B59 4T0j1qPGbn0P/m6ExANzCkjX6rKlBfd3xzN/Xa5dWNJCrfqd0NYoEBehYbFB76dN6tpSAx gHkXmrE6VYPbARqdoWZsBmUl03tBL6dFsXEp4xfj4h5CHt674mW0R4yisz1vCUsXGZklJO ZOmBk9i64LS9CViDuftZcdg165+/VLkBk0/6uUN2kt98ySfTl2trYI9e0PZpMQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1738784993; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=PlSL7UsvSJyr+gtXPcAc7egPt9vu1pzh47mkWOLRKeE=; b=JhHe2lZpf0Xq9b6uRN1pRicEkJyvUlY9XVkLqOBZ6ClyFR3+yuxthAfQNb/05fOkYCkK/s oZCpunCGCtFiSkV7Uxi2suQIyFQHR5NrnpwyONaDFtNf9SBotAa/hOJcUQav5tjSFz8ntP EqQzJanj8zVyiruCxHPMzjzTDuVx8H89qVmmDyCC5x/Y/amCk4uvw/5tSt4Yp5TRoJd+iz AGQyixBzjkLI5AUGNzCa3T+KuyzzF921EKpja0NRMs5ZaVj7hb8xhgr59GOnX9zcl687NA RGELK+9HeZ+g9PAZC8HUghYArBd9/ItMkoG2JjXo0jgv71owCOUZOp8WVbUBXg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1738784993; a=rsa-sha256; cv=none; b=tZ9Kkc6/IssEd/JlB6uj56s14T2brrbyRJpE4AupeHbGZ8LfU2q7RCOlFJet5BUMJ3g51e yWyi62YoiCkUJYPAA0WgfKDOm2H0TK1/70p4NcAgq5UuX/b0ztTXVMPAdHLICK0vOAbwj9 YH7kKx9+oddwBuPjPRvtxnBG7ieiMmr2Nb4jHos6m6KcAXeQIL+NLj7NFGGPYqKWB6/YKL fsdFs/c6KXVZ4GiJT4uLYsRPeZ9EuxnMra12ePAsTtU4lhNzia2AREQMIkYi93qxLPM05q 42pzWI0LhMdbOK6QWzouJyCalX5xXLZUmBDjNCpKkIsBDvD0OMbz0Pac1QKq5Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Yp9mx2vlHz14wJ; Wed, 05 Feb 2025 19:49:53 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 515JnrSG070427; Wed, 5 Feb 2025 19:49:53 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 515JnrUK070424; Wed, 5 Feb 2025 19:49:53 GMT (envelope-from git) Date: Wed, 5 Feb 2025 19:49:53 GMT Message-Id: <202502051949.515JnrUK070424@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: John Baldwin Subject: git: 36ecb25e6158 - main - bus_generic_print_child.9: Document bus_print_domain List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: jhb X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 36ecb25e6158f16356938432defd9f9df67a1366 Auto-Submitted: auto-generated The branch main has been updated by jhb: URL: https://cgit.FreeBSD.org/src/commit/?id=36ecb25e6158f16356938432defd9f9df67a1366 commit 36ecb25e6158f16356938432defd9f9df67a1366 Author: John Baldwin AuthorDate: 2025-02-05 19:49:01 +0000 Commit: John Baldwin CommitDate: 2025-02-05 19:49:29 +0000 bus_generic_print_child.9: Document bus_print_domain While here, cross-reference BUS_PRINT_CHILD (and fix a stale reference to DEVICE_PRINT_CHILD which doesn't exist) and expand the text describing the role of the helper functions. Differential Revision: https://reviews.freebsd.org/D48373 --- share/man/man9/Makefile | 3 +- share/man/man9/bus_generic_print_child.9 | 69 ++++++++++++++++++++++++++------ 2 files changed, 59 insertions(+), 13 deletions(-) diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 7992a8da4508..05c5de574ef5 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -697,7 +697,8 @@ MLINKS+=bus_dma.9 busdma.9 \ bus_dma.9 bus_dmamem_free.9 \ bus_dma.9 bus_dma_tag_create.9 \ bus_dma.9 bus_dma_tag_destroy.9 -MLINKS+=bus_generic_print_child.9 bus_print_child_footer.9 \ +MLINKS+=bus_generic_print_child.9 bus_print_child_domain.9 \ + bus_generic_print_child.9 bus_print_child_footer.9 \ bus_generic_print_child.9 bus_print_child_header.9 MLINKS+=bus_generic_read_ivar.9 bus_generic_write_ivar.9 MLINKS+=BUS_GET_CPUS.9 bus_get_cpus.9 diff --git a/share/man/man9/bus_generic_print_child.9 b/share/man/man9/bus_generic_print_child.9 index 1adca331b016..8a72c8e743ec 100644 --- a/share/man/man9/bus_generic_print_child.9 +++ b/share/man/man9/bus_generic_print_child.9 @@ -26,43 +26,88 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd January 16, 2025 +.Dd February 5, 2025 .Dt BUS_GENERIC_PRINT_CHILD 9 .Os .Sh NAME .Nm bus_generic_print_child , +.Nm bus_print_child_domain , .Nm bus_print_child_footer , .Nm bus_print_child_header .Nd generic implementation of -.Dv DEVICE_PRINT_CHILD -for buses +.Xr BUS_PRINT_CHILD 9 .Sh SYNOPSIS .In sys/param.h .In sys/bus.h .Ft int .Fn bus_generic_print_child "device_t dev" "device_t child" .Ft int +.Fn bus_print_child_domain "device_t dev" "device_t child" +.Ft int .Fn bus_print_child_footer "device_t dev" "device_t child" .Ft int .Fn bus_print_child_header "device_t dev" "device_t child" .Sh DESCRIPTION -This implementation prints out the default device announcement message. -Given device 'foo0' on bus 'bar0' where foo0 has the name "FooCard 1234" the +.Fn bus_generic_print_child +prints out the default device announcement message. +Given device +.Sq foo0 +on bus +.Sq bar0 +where foo0 has the description +.Dq FooCard 1234 +and is associated with the NUMA domain 1, +the following would be printed: +.Bd -literal -offset indent +foo0: numa-domain 1 on bar0 +.Ed .Pp -foo0: on bar0 -.Pp -bus_generic_print_child itself calls two functions -.Fn bus_print_child_header +.Fn bus_generic_print_child +calls the three helper functions +.Fn bus_print_child_header , +.Fn bus_print_child_domain , and .Fn bus_print_child_footer . -The former prints "foo0: " and the latter "on bar0". -These routines should be used if possible in your own code if +.Pp +.Fn bus_print_child_header +outputs the device name and unit followed by the device description +in angle brackets +.Po +.Dq foo0: +.Pc . +.Pp +.Fn bus_print_child_domain +outputs +.Dq \& numa-domain +followed by the domain number if +.Fn bus_get_domain +returns a valid domain for the device +.Po +.Dq numa-domain 1 +.Pc . +If +.Fa dev +is not associated witha valid domain, +nothing is output. +.Pp +.Fn bus_print_child_footer +outputs the string +.Dq \& on +followed by the parent device's name and unit +.Po +.Dq \& on bar0 +.Pc . +.Pp +These functions can be used to implement +.Xr BUS_PRINT_CHILD 9 +in a bus driver if .Fn bus_generic_print_child -does not completely suit your needs. +is not sufficient. .Sh RETURN VALUES The number of characters output. .Sh SEE ALSO +.Xr BUS_PRINT_CHILD 9 , .Xr device 9 .Sh AUTHORS This manual page was written by