From patchwork Thu Mar 25 16:47:13 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Rob Herring \(Arm\)" X-Patchwork-Id: 408844 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp700178jai; Thu, 25 Mar 2021 09:48:30 -0700 (PDT) X-Google-Smtp-Source: ABdhPJycwB3pYgBhEtO+4+FrVomO2ZclQdimStPqQWkrpY48INYZkg5Mmcp3izjt8nfVz085gR8A X-Received: by 2002:aa7:c857:: with SMTP id g23mr10203172edt.86.1616690910603; Thu, 25 Mar 2021 09:48:30 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1616690910; cv=none; d=google.com; s=arc-20160816; b=elGMC7huMhqTHTWX/vEaAel38CTVL9eSp0G5gouo8MvZDuWjYsEjC1a6ahSwQJiT14 1CocOYt2WGEDZ9U51oFMlJM8xkLULslX8ZTrUYYuVYq5wd+nhZtEsKVXe2wQvHKNbhCW /498SXBzgJfDs5304riLi50BNJx0ys8wjt2go5Fna7AQchqElyL6N/1DAbmwBbpoZ+yn 5ebzzgZIuAWqIsdt7WYHxM50ai7OEVY3j9Xk99kQiIeDHp7S08gqM0TxTyQEAgvyytNB d8GIG2qxf8iRPaxNQk7RyuM84PDH1BuSmG+ibdC4ym6zdY3l4pkzDvFmmsYt61y7mJGW MqNw== 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 :references:in-reply-to:message-id:date:subject:cc:to:from; bh=1O1E/xRwZme5NOHcXojTDxawVUZizZj5kgRyChIK9Ao=; b=0up0QuR1FpmzariQuq2IWDLDal6iYmGKExe5VRs7Z0G6J71+1aKr2E9KK6z2yd3fg+ BV8hnS01tGj7O0x5Gmx+5ddYqmaPA+MPlgvpErJjxeDXIAnwPqVnw5pxCAMu711EeF8G xnILm2Q/1s7j3FsO629wWhT37HIql3nJxVnbCwW56/gGTE6vMU7tnlEky3DMqdS03kmy zO2QXIxCXRRxULkKjTV4aHPTIGBrI3shaRFh5bCkxWzYHSOj5SFRRmltZHuRtE+5xVjt vGP+PMsuLUqJ+l4Q9pzSRhEFHH5bPkCRJ7xLkefz7zVSEhU5W2v4pH3K3tjii4YP0eqx w6oA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of devicetree-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=devicetree-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id f7si4498477edu.503.2021.03.25.09.48.30; Thu, 25 Mar 2021 09:48:30 -0700 (PDT) Received-SPF: pass (google.com: domain of devicetree-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; spf=pass (google.com: domain of devicetree-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=devicetree-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229993AbhCYQr4 (ORCPT + 6 others); Thu, 25 Mar 2021 12:47:56 -0400 Received: from mail-il1-f180.google.com ([209.85.166.180]:34773 "EHLO mail-il1-f180.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229676AbhCYQrt (ORCPT ); Thu, 25 Mar 2021 12:47:49 -0400 Received: by mail-il1-f180.google.com with SMTP id u2so2693350ilk.1; Thu, 25 Mar 2021 09:47:49 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=1O1E/xRwZme5NOHcXojTDxawVUZizZj5kgRyChIK9Ao=; b=sfi7ror6M6j9nyTvcoRvlWfNcETGxKZaeUeJtcOY1SOnTUmKBhzakvuSGzT0IfPxxl beEfrwA+u2bm+8jQE/+yDv6jWvXs1049j0lv7fQ7tsAELZ7qn1XJvC+BrpPn8l6IMh9G nwYDhFEz4MP/6gJSO28dpkGSoWUfLfM3KliIjCXarWhClpVAK1lEIattqqlOhi+mk8yN /Wunr4bdbGXJU1XknqA+zCOxhiLzqXMeWDRVklOtBXw+fWYVTb77RiA6LAUEH9/gIZ7z OSqhWIW48NxO+vIna50tiFAHd7cLOw4uWrM1X01uSSWNE2yiwOXN7WlzNaghFYlhM8x3 uVPw== X-Gm-Message-State: AOAM5326XItPh+mNexOp7fxztIrmwm4alh3nCyIYoPeycmMAd3ZYtQfC 7Q4jaYmBBraPFHIsv9OnaBqxeVB5rg== X-Received: by 2002:a05:6e02:1d9b:: with SMTP id h27mr7501787ila.279.1616690868432; Thu, 25 Mar 2021 09:47:48 -0700 (PDT) Received: from xps15.herring.priv ([64.188.179.253]) by smtp.googlemail.com with ESMTPSA id h13sm2868615ila.82.2021.03.25.09.47.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Mar 2021 09:47:47 -0700 (PDT) From: Rob Herring To: devicetree@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Frank Rowand , Lee Jones , Mauro Carvalho Chehab , Jonathan Corbet , linux-doc@vger.kernel.org Subject: [PATCH 8/8] docs: dt: Add DT API documentation Date: Thu, 25 Mar 2021 10:47:13 -0600 Message-Id: <20210325164713.1296407-9-robh@kernel.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210325164713.1296407-1-robh@kernel.org> References: <20210325164713.1296407-1-robh@kernel.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org The kernel-doc for the DT APIs are not included in the documentation build. Add them. Cc: Frank Rowand Cc: Mauro Carvalho Chehab Signed-off-by: Rob Herring --- Documentation/devicetree/index.rst | 1 + Documentation/devicetree/kernel-api.rst | 57 +++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 Documentation/devicetree/kernel-api.rst -- 2.27.0 Reviewed-by: Mauro Carvalho Chehab diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst index 70b5dcdbcf07..1a2fc8014996 100644 --- a/Documentation/devicetree/index.rst +++ b/Documentation/devicetree/index.rst @@ -11,6 +11,7 @@ Kernel Devicetree Usage usage-model of_unittest + kernel-api Devicetree Overlays =================== diff --git a/Documentation/devicetree/kernel-api.rst b/Documentation/devicetree/kernel-api.rst new file mode 100644 index 000000000000..b7429e6ed6d5 --- /dev/null +++ b/Documentation/devicetree/kernel-api.rst @@ -0,0 +1,57 @@ +.. SPDX-License-Identifier: GPL-2.0 +.. _devicetree: + +====================================== +DeviceTree Kernel API +====================================== + +Core functions +-------------- + +.. kernel-doc:: drivers/of/base.c + :export: + +.. kernel-doc:: include/linux/of.h + :internal: + +.. kernel-doc:: drivers/of/property.c + :export: + +.. kernel-doc:: include/linux/of_graph.h + :internal: + +.. kernel-doc:: drivers/of/address.c + :export: + +.. kernel-doc:: drivers/of/irq.c + :export: + +.. kernel-doc:: drivers/of/fdt.c + :export: + +Driver model functions +---------------------- + +.. kernel-doc:: include/linux/of_device.h + :internal: + +.. kernel-doc:: drivers/of/device.c + :export: + +.. kernel-doc:: include/linux/of_platform.h + :internal: + +.. kernel-doc:: drivers/of/platform.c + :export: + +Overlay and Dynamic DT functions +-------------------------------- + +.. kernel-doc:: drivers/of/resolver.c + :export: + +.. kernel-doc:: drivers/of/dynamic.c + :export: + +.. kernel-doc:: drivers/of/overlay.c + :export: