From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-5.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=unavailable autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 62DD47D922 for ; Wed, 24 Apr 2019 17:55:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2391005AbfDXRyy (ORCPT ); Wed, 24 Apr 2019 13:54:54 -0400 Received: from mail-pl1-f194.google.com ([209.85.214.194]:43984 "EHLO mail-pl1-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2390255AbfDXRyx (ORCPT ); Wed, 24 Apr 2019 13:54:53 -0400 Received: by mail-pl1-f194.google.com with SMTP id n8so9641357plp.10; Wed, 24 Apr 2019 10:54:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=TaCx91wAcR4ikyNBIoUaFJho1ovTMWA1CQykmERd8P8=; b=FEYnTqwAc2fxNRPXY2L0oyc1FvLU0ghDznFRVvTI7RCd68UScVHnw/DkdKxWH5htDb 5gkBcFZaWMvLkkjzhGKSfMTJ1Y0wRG2+5sHzRCdbnV6M+71QykRvgc+Zk+ZX6aQL6GgI tp/8yoQtEMwYzoJZyRvH8eDn64CyP48URkA03RSwvlF7xAMyit+C+PVMc2aa14RKGAmE bz6T1CYb1eH9LjtKSibaSdS9LGIpfsnJkM+F9bre/6LQplD7J356sH2+71hy2Ddrin4s xowpyUMOTkvcxb6gWqAO5YjEAUR/Qoy6nV2xXEwNRtkEcY27fR9OXT0zgQL6rmbn4ZU6 vdJw== 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=TaCx91wAcR4ikyNBIoUaFJho1ovTMWA1CQykmERd8P8=; b=gHSXk18RIk0s6qENYSQMIcgZ2jjz1/ZffjV0bygLwZvR5wuVn3TqHGt5Bc+q7sLQ4l +GvztYpltu2x3OKUGvrLe1IihXYlQfb/z50hxAqtB0GuIPCLaeDoIQtE59DOl7GC/hFO 8pkuYnP+C3vhhRJTWMoc0q48YPPBU3V9ssyvHFyaMY2XZw4r+3jPaRC1HnCZH/dCk1Uc XvmDChU4MdPS1DeED2re6rOMSrWSjQLDHrDcRVb76uLZKwF42/WjF8NXSs0bORH0NOIK YQAiaG26W6bhs66OZNAjAO+f/r7wyHLzoT4QW8fS4Vu2aWFQGRhiFAL5sLkNcqJbtYIq edyg== X-Gm-Message-State: APjAAAXxHy5J3tvASc3RGfGn3u5pGH1mMLkUQIXj8zuBkb4cPak5MZRy Kt5Id2Vfz9gRXNJZPdpu7lQ= X-Google-Smtp-Source: APXvYqw94LJSG6bq/oxV3g25pebeMLlLlm7qpwZ5Gc6UHmRBGwyg81szL5vyrIWlHh2ubVqXtedWIQ== X-Received: by 2002:a17:902:362:: with SMTP id 89mr32591775pld.172.1556128491862; Wed, 24 Apr 2019 10:54:51 -0700 (PDT) Received: from localhost.localdomain ([104.238.181.70]) by smtp.gmail.com with ESMTPSA id 6sm29275630pfp.143.2019.04.24.10.54.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 24 Apr 2019 10:54:50 -0700 (PDT) From: Changbin Du To: rjw@rjwysocki.net, Jonathan Corbet Cc: Bjorn Helgaas , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, fenghua.yu@intel.com, linuxppc-dev@lists.ozlabs.org, linux-acpi@vger.kernel.org, linux-gpio@vger.kernel.org, mchehab+samsung@kernel.org, Changbin Du Subject: [PATCH v5 06/23] Documentation: ACPI: move DSD-properties-rules.txt to firmware-guide/acpi and covert to reST Date: Thu, 25 Apr 2019 01:52:49 +0800 Message-Id: <20190424175306.25880-7-changbin.du@gmail.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190424175306.25880-1-changbin.du@gmail.com> References: <20190424175306.25880-1-changbin.du@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org This converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Changbin Du Reviewed-by: Mauro Carvalho Chehab --- .../acpi/DSD-properties-rules.rst} | 21 +++++++++++-------- Documentation/firmware-guide/acpi/index.rst | 1 + 2 files changed, 13 insertions(+), 9 deletions(-) rename Documentation/{acpi/DSD-properties-rules.txt => firmware-guide/acpi/DSD-properties-rules.rst} (88%) diff --git a/Documentation/acpi/DSD-properties-rules.txt b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst similarity index 88% rename from Documentation/acpi/DSD-properties-rules.txt rename to Documentation/firmware-guide/acpi/DSD-properties-rules.rst index 3e4862bdad98..4306f29b6103 100644 --- a/Documentation/acpi/DSD-properties-rules.txt +++ b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst @@ -1,8 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================================== _DSD Device Properties Usage Rules ----------------------------------- +================================== Properties, Property Sets and Property Subsets ----------------------------------------------- +============================================== The _DSD (Device Specific Data) configuration object, introduced in ACPI 5.1, allows any type of device configuration data to be provided via the ACPI @@ -18,7 +21,7 @@ specific type) associated with it. In the ACPI _DSD context it is an element of the sub-package following the generic Device Properties UUID in the _DSD return package as specified in the -Device Properties UUID definition document [1]. +Device Properties UUID definition document [1]_. It also may be regarded as the definition of a key and the associated data type that can be returned by _DSD in the Device Properties UUID sub-package for a @@ -33,14 +36,14 @@ Property subsets are nested collections of properties. Each of them is associated with an additional key (name) allowing the subset to be referred to as a whole (and to be treated as a separate entity). The canonical representation of property subsets is via the mechanism specified in the -Hierarchical Properties Extension UUID definition document [2]. +Hierarchical Properties Extension UUID definition document [2]_. Property sets may be hierarchical. That is, a property set may contain multiple property subsets that each may contain property subsets of its own and so on. General Validity Rule for Property Sets ---------------------------------------- +======================================= Valid property sets must follow the guidance given by the Device Properties UUID definition document [1]. @@ -73,7 +76,7 @@ suitable for the ACPI environment and consequently they cannot belong to a valid property set. Property Sets and Device Tree Bindings --------------------------------------- +====================================== It often is useful to make _DSD return property sets that follow Device Tree bindings. @@ -91,7 +94,7 @@ expected to automatically work in the ACPI environment regardless of their contents. References ----------- +========== -[1] http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf -[2] http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf +.. [1] http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf +.. [2] http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst index 868bd25a3398..0e05b843521c 100644 --- a/Documentation/firmware-guide/acpi/index.rst +++ b/Documentation/firmware-guide/acpi/index.rst @@ -10,3 +10,4 @@ ACPI Support namespace enumeration osi + DSD-properties-rules -- 2.20.1