From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.9 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id E9ABAC43218 for ; Thu, 25 Apr 2019 15:32:01 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 1D7FF20891 for ; Thu, 25 Apr 2019 15:32:02 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="R295VI7Q" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2387425AbfDYPcA (ORCPT ); Thu, 25 Apr 2019 11:32:00 -0400 Received: from mail-pl1-f194.google.com ([209.85.214.194]:34656 "EHLO mail-pl1-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729450AbfDYPb6 (ORCPT ); Thu, 25 Apr 2019 11:31:58 -0400 Received: by mail-pl1-f194.google.com with SMTP id y6so11298721plt.1; Thu, 25 Apr 2019 08:31:58 -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=DKtDv1X/aYP4TvJqarXB9+14q+P9ROu4ceFb9isBfF8=; b=R295VI7QFzX47fOQliJT6SAB8a4Lo15a8oqc1uIuMm5o6eMQC71L5udxtmk9/ez9ox 0vWb/JikCzyXtGGZJ/P2dArZRjXMniipAU1IUAiENYMsuGvsBHtn6n0hMiC1+72OxuKq KJGZzI4XUNhRNJuWinqG1bj2KdzTL5ojoE1I3rcVGDQwzIlf5s5c/Qd0sQxiJ5bcJr9X MeO8WZEf5tZlxg1Gfzul6U0jVsfq/n+RxJrmkUJh2B1YLpw7PjToMljCWr4oLrziUDqV C6sMPzX8CqOd71wcnccdojH48oj2bsVyZZZoglzFh3bZeu+km4+u2sNVYCGT02ajwxyV 53ag== 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=DKtDv1X/aYP4TvJqarXB9+14q+P9ROu4ceFb9isBfF8=; b=AF0NnnVp3tm/R31p6ymRc1z5HZB5rm+2l8kOQoyIPtWoGZ7qw7iPO/l1NAb6v/Stpb EKTEY7YXtlbx7gpgoSTBfZAtCJUUdekuzCftfxCRcw9fBmADc+5+1azdclFqS3wbXRPV 1IW85Fa/wLX/TkmDvKrXfL5Zha8E+R0sBIkYAkoKDSiXW0QYcQuSM/vXWKx3JlIyqCZ3 qD567+wiJnONkUwuMIO0PHHpyOd+FyFv852umTcQo+YxALxUabb+ef7OshXLW73hIeee EDt7yaCCDrX2LO8giCMfME2N4k76uSF1nJ7rJSmMOVuVpkn3fLXEpIMIianwnwdouxor G9aw== X-Gm-Message-State: APjAAAUWyqnyC8eXLmuE+b3Uhpm4irQux8NcgpkmRwFRuNpvbPYSu850 g1lWt7RYGSKs90JvtebyZvc= X-Google-Smtp-Source: APXvYqxJKD93yI70xJjG8VmbHvuBA/uvF1Cv7d9MawmQ55dp/SRwX4ZAs/UZLWeCGgmvDN5p25We7Q== X-Received: by 2002:a17:902:1003:: with SMTP id b3mr40279344pla.306.1556206318027; Thu, 25 Apr 2019 08:31:58 -0700 (PDT) Received: from localhost.localdomain ([104.238.181.70]) by smtp.gmail.com with ESMTPSA id c14sm2643363pgj.94.2019.04.25.08.31.52 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 25 Apr 2019 08:31:57 -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 v6 04/24] Documentation: ACPI: move osi.txt to firmware-guide/acpi and convert to reST Date: Thu, 25 Apr 2019 23:30:57 +0800 Message-Id: <20190425153117.16057-5-changbin.du@gmail.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190425153117.16057-1-changbin.du@gmail.com> References: <20190425153117.16057-1-changbin.du@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@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 --- Documentation/firmware-guide/acpi/index.rst | 1 + .../{acpi/osi.txt => firmware-guide/acpi/osi.rst} | 15 +++++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) rename Documentation/{acpi/osi.txt => firmware-guide/acpi/osi.rst} (97%) diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst index 99677c73f1fb..868bd25a3398 100644 --- a/Documentation/firmware-guide/acpi/index.rst +++ b/Documentation/firmware-guide/acpi/index.rst @@ -9,3 +9,4 @@ ACPI Support namespace enumeration + osi diff --git a/Documentation/acpi/osi.txt b/Documentation/firmware-guide/acpi/osi.rst similarity index 97% rename from Documentation/acpi/osi.txt rename to Documentation/firmware-guide/acpi/osi.rst index 50cde0ceb9b0..29e9ef79ebc0 100644 --- a/Documentation/acpi/osi.txt +++ b/Documentation/firmware-guide/acpi/osi.rst @@ -1,5 +1,8 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========================== ACPI _OSI and _REV methods --------------------------- +========================== An ACPI BIOS can use the "Operating System Interfaces" method (_OSI) to find out what the operating system supports. Eg. If BIOS @@ -14,7 +17,7 @@ This document explains how and why the BIOS and Linux should use these methods. It also explains how and why they are widely misused. How to use _OSI ---------------- +=============== Linux runs on two groups of machines -- those that are tested by the OEM to be compatible with Linux, and those that were never tested with Linux, @@ -62,7 +65,7 @@ the string when that support is added to the kernel. That was easy. Read on, to find out how to do it wrong. Before _OSI, there was _OS --------------------------- +========================== ACPI 1.0 specified "_OS" as an "object that evaluates to a string that identifies the operating system." @@ -96,7 +99,7 @@ That is the *only* viable strategy, as that is what modern Windows does, and so doing otherwise could steer the BIOS down an untested path. _OSI is born, and immediately misused --------------------------------------- +===================================== With _OSI, the *BIOS* provides the string describing an interface, and asks the OS: "YES/NO, are you compatible with this interface?" @@ -144,7 +147,7 @@ catastrophic failure resulting from the BIOS taking paths that were never validated under *any* OS. Do not use _REV ---------------- +=============== Since _OSI("Linux") went away, some BIOS writers used _REV to support Linux and Windows differences in the same BIOS. @@ -164,7 +167,7 @@ from mid-2015 onward. The ACPI specification will also be updated to reflect that _REV is deprecated, and always returns 2. Apple Mac and _OSI("Darwin") ----------------------------- +============================ On Apple's Mac platforms, the ACPI BIOS invokes _OSI("Darwin") to determine if the machine is running Apple OSX. -- 2.20.1