From nobody Thu Jan 16 15:52:00 2025 X-Original-To: dev-commits-src-main@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 4YYnRh44w2z5kbHd; Thu, 16 Jan 2025 15:52:00 +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 4YYnRh3Q1Rz4QGv; Thu, 16 Jan 2025 15:52:00 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1737042720; 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=8HCyyYqeHCOlYxrAldXttT9UzyQFzTiSF72OD7O2pwI=; b=q/Nbe9hlpUK+WfEKIRslXZ4UrlAyGaeABzdJOoY75pkRTrZBiRvFbfZky5nN7KYULpUwnW mcDOLWynquXsEwq7xSxjkQWhSU7nipnwtdbqHpCYpB+kj6osC40/iH+QnmeCJrt5Z7Ri5W Vcqm/tbCzExUDsLtcR9lG1LFDU7d6iQbv7BYDQ1K9kP1M5C4YB3H8X4W0MO3YfWjib6Bo9 cIL57uavN3th/tj7jp00PUAZZTvbKN8OBl5NaVB+0jw2wx5HXu63DZ3ySGXbFUUjteHTBf Gxty+pzhorMu16kJr+Dpxg0CiqUsTjeN/6VtKlW05yB1IHdKL0vPZsX5DOnTLg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1737042720; 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=8HCyyYqeHCOlYxrAldXttT9UzyQFzTiSF72OD7O2pwI=; b=NuJUOFlsYBPApfXOi9TU4JTcopNiuTZrmOUl2T/OLu/1fHHWjfNSAMFdRgCtcPYiFwakz7 lwEhq4Uo3ZY4+O01hYnWyFOnxr8DhiL9/5WENpHeK2qhl+3V5JI35fXRfpJID7G6b+40qd TqhjJBO0o4En1x1a5l8A/R0ICEx87KrWpkuWuKrbsksRBdvWDFHCc+yOVdyOulOVzi/DO3 ZE/+fP1+q3cVq1GKYLAxwLCMOXQLgHTU1+It4jshZ9RYo+N+TXVpFoy8s9djhWayzGMems J2sRV0qQfivlcQapjJh0098tKq+6UkQ2ntoWzbzhwYcvbad9I8v7uoMekSg+rw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1737042720; a=rsa-sha256; cv=none; b=kdEfUPquzVr5zhaF65g7uYSkIMAHQ7ihAdJbLeOn8nTkt5Xg17boeyHyvgx5cKnuZ4MgIj C++zSfEPJPFSzqJvjjEPIv/B6QmY+x3RRbPhH5Jzx8Rc78VHs75GpTPnh9sC31ftMijrbg idlAUtFwCHq3IMT66NuF5DOg3tH+ozTFfEu01kD/povNWchvUBpR67BuY+Yqp8h2n9YYcv qQkVQjdijnGpjbXNccz6kRzqxYFyn5MyOmtlrkzh5aJ2rXsHP253VckmIQksoBdOD0VRur B8xBS+h7I7fbwVNHKAdE7z7dMdjCNhzn0UKXr1YAzoTKKoD3biPh+Ghj7xgMiw== 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 4YYnRh2zjGzg29; Thu, 16 Jan 2025 15:52:00 +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 50GFq0wM040548; Thu, 16 Jan 2025 15:52:00 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 50GFq0Bp040545; Thu, 16 Jan 2025 15:52:00 GMT (envelope-from git) Date: Thu, 16 Jan 2025 15:52:00 GMT Message-Id: <202501161552.50GFq0Bp040545@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: 4276dfa8c4b9 - main - BUS_HINTED_CHILD.9: New manpage to document this bus method List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@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: 4276dfa8c4b9e75ab29f2c53a7af36c2f77ab563 Auto-Submitted: auto-generated The branch main has been updated by jhb: URL: https://cgit.FreeBSD.org/src/commit/?id=4276dfa8c4b9e75ab29f2c53a7af36c2f77ab563 commit 4276dfa8c4b9e75ab29f2c53a7af36c2f77ab563 Author: John Baldwin AuthorDate: 2025-01-16 15:51:44 +0000 Commit: John Baldwin CommitDate: 2025-01-16 15:51:44 +0000 BUS_HINTED_CHILD.9: New manpage to document this bus method Reviewed by: ziaee, imp Differential Revision: https://reviews.freebsd.org/D48366 --- share/man/man9/BUS_HINTED_CHILD.9 | 36 ++++++++++++++++++++++++++++++++++++ share/man/man9/Makefile | 1 + 2 files changed, 37 insertions(+) diff --git a/share/man/man9/BUS_HINTED_CHILD.9 b/share/man/man9/BUS_HINTED_CHILD.9 new file mode 100644 index 000000000000..699bb06e8dd8 --- /dev/null +++ b/share/man/man9/BUS_HINTED_CHILD.9 @@ -0,0 +1,36 @@ +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright (c) 2025 John Baldwin +.Dd January 6, 2025 +.Dt BUS_HINTED_CHILD 9 +.Os +.Sh NAME +.Nm BUS_HINTED_CHILD +.Nd notify a bus device about a potential child device identified by hints +.Sh SYNOPSIS +.In sys/param.h +.In sys/bus.h +.Ft void +.Fn BUS_HINTED_CHILD "device_t dev" "const char *dname" "int dunit" +.Sh DESCRIPTION +The +.Fn BUS_HINTED_CHILD +method is invoked by the +.Xr bus_enumerate_hinted_children 9 +function for each set of named hints whose +.Dq at +hint matches the bus device +.Fa dev . +Typically, this method should determine if the set of hints for the given +device name and unit sufficiently describe a new device. +If so, a new device should be added via +.Xr BUS_ADD_CHILD 9 . +.Sh SEE ALSO +.Xr BUS_ADD_CHILD 9 , +.Xr device 9 +.Sh HISTORY +The +.Fn BUS_HINTED_CHILD +method first appeared in +.Fx 6.2 . diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index c09d3aa554a1..6e8edc3f698d 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -47,6 +47,7 @@ MAN= accept_filter.9 \ BUS_GET_CPUS.9 \ BUS_GET_PROPERTY.9 \ bus_get_resource.9 \ + BUS_HINTED_CHILD.9 \ bus_map_resource.9 \ BUS_NEW_PASS.9 \ BUS_PRINT_CHILD.9 \