From patchwork Tue Jun 27 06:45:23 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 113260 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp7995426vqr; Mon, 26 Jun 2023 23:54:42 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ5+cpwDj3pRMwIpq4Re/46De+kFWifOv74GZFFbweR9ootDLH7Z7TqWWydM854V3bdyl8XD X-Received: by 2002:a05:6a00:1951:b0:66a:2ff1:dedb with SMTP id s17-20020a056a00195100b0066a2ff1dedbmr16321825pfk.16.1687848882624; Mon, 26 Jun 2023 23:54:42 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1687848882; cv=none; d=google.com; s=arc-20160816; b=peD23ClO6m2M25WuehUYxNE4Nqb3Agn7UUw+iDX170fbP+WIpog03/gy5/tXARYTgL fT3KVHKBvBoVdoNmZiFKsql/lCMFKA8R/nMTTdXCidTCmMjZu/lO3MMnaepyMjRhYH1u HvabCAHjZGqnjXG6E9PDxJW7wHM27ptoOjX8KCiRgu4nsKGBUcviiOBsOWyOWq7YUvMr V91Tq/ze7RtNsT1x2r6oTeuPIDypzBoaATC5QJwIcg7G99lz7TB5XLBbn/pTR+JfHA18 kH8FH8nWDnUCyATDrV3DWv6Ec7k4CUWG42zVF9aMd277mU7juLZkX++EG+HmLql7+57R TNWg== 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 Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id u14-20020aa7848e000000b0066e96a581c8si5222296pfn.261.2023.06.26.23.54.27; Mon, 26 Jun 2023 23:54:42 -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 S230136AbjF0Gry (ORCPT + 99 others); Tue, 27 Jun 2023 02:47:54 -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 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 X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1769837829506026334?= X-GMAIL-MSGID: =?utf-8?q?1769837829506026334?= 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: