Received: by 2002:a05:6358:3188:b0:123:57c1:9b43 with SMTP id q8csp17264220rwd; Tue, 27 Jun 2023 00:03:12 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ71jla+MtsgUiFdvPCHldAHFXZxcRI1q2/o9LMz35jSHgK19Gwv/rnJnLc6iBuAOOjdxQJN X-Received: by 2002:a17:907:803:b0:982:cfe2:32fe with SMTP id wv3-20020a170907080300b00982cfe232femr26780498ejb.63.1687849392599; Tue, 27 Jun 2023 00:03:12 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1687849392; cv=none; d=google.com; s=arc-20160816; b=yHwCMJqKAlEQyONo+MRNzYrzFS0Uu5bq+CwDRd52RF4seJBsAACYcN7bAgrrhH5Vgi yzmOA6tufqstfoXJHrlGLWtsy/TGDBikA4OnGMfOfnNO6Hs9iQcsGmZgeTcbJIDNlRaI KVAW5e9adnHbqOm2U8/5D9ynGsCGHCFRZUYaljd/KFB+8S/we6iUZZimUohthqal+/01 e3uATB90asHlW0siFfzidpa07NKKokb/NeeGi4GF96VT1lb5bA6sChf3yUUOODr5ky7U tIwTlmhzW7iviFw/mpKiXB7yibhK+Shh8XjF8+3rjB11hI4fu8i/+yMtu2+N9ZIbbLJz Edkw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=7zoVn6pt8mC/XFCWob4MAbf9NS9Enf9msdxXChlUhcs=; fh=Evm9Vg2eZ9rM042sLrI0zBjwxfvgr6MPjbSTqlNbLgI=; b=VYxIZoRl8qeMjY3uvrBDQTXBSpZNOZ0pYJGG6F1zkxz+aoLcPw7+mzMadaPhcAYxx8 5vg/n88yMRxAtfdcCOjkfPgIpZYw8/+/usKEWs+x3PcIfIU0emedrjuu7b4diulTU7xS 3g1u/gCu1GvT/P5AmOkobat/Vv6c6FUkgk46V6+c+w30pD4rW/qWlfBrq70HupdVB7lk NIWNqRGiDbhGUueP7X+T7ZH8Iu/Bme/Zt+gO2gVCDOTpSY3MSLWCosbUjJXTOVxv4moG h3gmaVqIsWI9gggXZAV/0gqr2sTivfdvXwcBpuc2BuDwSHSOXmzI0EOqe+ZeXM+A9Km8 5Iug== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b="C/TUoCi3"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id k25-20020a1709061c1900b0098c9432ad22si3765159ejg.45.2023.06.27.00.02.47; Tue, 27 Jun 2023 00:03:12 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b="C/TUoCi3"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230086AbjF0Grx (ORCPT + 99 others); Tue, 27 Jun 2023 02:47:53 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44696 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230350AbjF0GrF (ORCPT ); Tue, 27 Jun 2023 02:47:05 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D0E492944; Mon, 26 Jun 2023 23:45:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=7zoVn6pt8mC/XFCWob4MAbf9NS9Enf9msdxXChlUhcs=; b=C/TUoCi3PofYR8dOAZKRmNZcOM ub+da7rv73DezRSsq2wYZAlFl8pkKtqzHvlhBrY6sGWCT5C3TIB+bsgAquiuaSSo3cswWgcwQ+k4W LuyfWiohu2PQ747t630wX/FM8CWqGz0yRDwlEov8EymQVb+wBZDLO4PhEzvXmMA89MxjvBeZBj/RQ qxmWDUZf00+uoUALelorMAcEKdQc+meM3mrSrYbwxy22oKJv+zGb+wnQuTvhKcpO/V5DLBKhZjWlu uhYqRJuGsZvvTj1BYf9qdy/RQjjdfvGL9pLz7/xO7kquI8lDEQ8oPDENIZVLmOub1YBobUiKO/kMv xei42+JQ==; Received: from [2601:1c2:980:9ec0::2764] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qE2S4-00CD8x-2h; Tue, 27 Jun 2023 06:45:24 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Jonathan Corbet , linux-doc@vger.kernel.org, Greg Kroah-Hartman , "Rafael J. Wysocki" Subject: [PATCH] docs: add more driver-model infrastructure interfaces Date: Mon, 26 Jun 2023 23:45:23 -0700 Message-ID: <20230627064523.16618-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add bus, class, and device data structures and enum constants to the Driver-Model Structures section and add function interfaces to the Device Drivers Base section of the Device drivers infrastructure chapter. Signed-off-by: Randy Dunlap Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Cc: Greg Kroah-Hartman Cc: "Rafael J. Wysocki" --- Documentation/driver-api/infrastructure.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff -- a/Documentation/driver-api/infrastructure.rst b/Documentation/driver-api/infrastructure.rst --- a/Documentation/driver-api/infrastructure.rst +++ b/Documentation/driver-api/infrastructure.rst @@ -8,12 +8,24 @@ The Basic Device Driver-Model Structures :internal: :no-identifiers: device_link_state +.. kernel-doc:: include/linux/device/bus.h + :identifiers: bus_type bus_notifier_event + +.. kernel-doc:: include/linux/device/class.h + :identifiers: class + +.. kernel-doc:: include/linux/device/driver.h + :identifiers: probe_type device_driver + Device Drivers Base ------------------- .. kernel-doc:: drivers/base/init.c :internal: +.. kernel-doc:: include/linux/device/driver.h + :no-identifiers: probe_type device_driver + .. kernel-doc:: drivers/base/driver.c :export: @@ -23,6 +35,9 @@ Device Drivers Base .. kernel-doc:: drivers/base/syscore.c :export: +.. kernel-doc:: include/linux/device/class.h + :no-identifiers: class + .. kernel-doc:: drivers/base/class.c :export: @@ -41,6 +56,9 @@ Device Drivers Base .. kernel-doc:: drivers/base/platform.c :export: +.. kernel-doc:: include/linux/device/bus.h + :no-identifiers: bus_type bus_notifier_event + .. kernel-doc:: drivers/base/bus.c :export: