From patchwork Mon Jul 11 13:45:18 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Xiao Guangrong X-Patchwork-Id: 9223681 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 474E560572 for ; Mon, 11 Jul 2016 14:08:07 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 3815327CF9 for ; Mon, 11 Jul 2016 14:08:07 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2C34527D76; Mon, 11 Jul 2016 14:08:07 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id A5ADA27CF9 for ; Mon, 11 Jul 2016 14:08:06 +0000 (UTC) Received: from localhost ([::1]:33891 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bMbsT-0000gf-QK for patchwork-qemu-devel@patchwork.kernel.org; Mon, 11 Jul 2016 10:08:05 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:50943) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bMbhz-0005U7-Dz for qemu-devel@nongnu.org; Mon, 11 Jul 2016 09:57:16 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bMbhv-0006Z4-Bn for qemu-devel@nongnu.org; Mon, 11 Jul 2016 09:57:14 -0400 Received: from mga02.intel.com ([134.134.136.20]:30874) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bMbhv-0006US-52 for qemu-devel@nongnu.org; Mon, 11 Jul 2016 09:57:11 -0400 Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga101.jf.intel.com with ESMTP; 11 Jul 2016 06:57:10 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos; i="5.28,346,1464678000"; d="scan'208"; a="1014572185" Received: from xiaoreal1.sh.intel.com (HELO xiaoreal1.sh.intel.com.sh.intel.com) ([10.239.48.133]) by orsmga002.jf.intel.com with ESMTP; 11 Jul 2016 06:57:10 -0700 From: Xiao Guangrong To: pbonzini@redhat.com, imammedo@redhat.com Date: Mon, 11 Jul 2016 21:45:18 +0800 Message-Id: <1468244718-3731-9-git-send-email-guangrong.xiao@linux.intel.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1468244718-3731-1-git-send-email-guangrong.xiao@linux.intel.com> References: <1468244718-3731-1-git-send-email-guangrong.xiao@linux.intel.com> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 134.134.136.20 Subject: [Qemu-devel] [PATCH 8/8] nvdimm docs: add nvdimm Read FIT function X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Xiao Guangrong , ehabkost@redhat.com, kvm@vger.kernel.org, mst@redhat.com, gleb@kernel.org, mtosatti@redhat.com, qemu-devel@nongnu.org, stefanha@redhat.com, dan.j.williams@intel.com, rth@twiddle.net Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP Add the specification of Read FIT function Signed-off-by: Xiao Guangrong --- docs/specs/acpi_nvdimm.txt | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/docs/specs/acpi_nvdimm.txt b/docs/specs/acpi_nvdimm.txt index 0fdd251..1a31b19 100644 --- a/docs/specs/acpi_nvdimm.txt +++ b/docs/specs/acpi_nvdimm.txt @@ -127,6 +127,38 @@ _DSM process diagram: | result from the page | | | +--------------------------+ +--------------+ - _FIT implementation - ------------------- - TODO (will fill it when nvdimm hotplug is introduced) + QEMU internal use only _DSM function + ------------------------------------ + There is the function introduced by QEMU and only used by QEMU internal. + + 1) Read FIT + As we only reserved one page for NVDIMM ACPI it is impossible to map the + whole FIT data to guest's address space. This function is for NVDIMM root + device and is used by _FIT method to read a piece of FIT data from QEMU. + + Input parameters: + Arg0 – UUID {set to 2f10e7a4-9e91-11e4-89d3-123b93f75cba} + Arg1 – Revision ID (set to 1) + Arg2 - 0xFFFFFFFF + Arg3 - A package containing a buffer whose layout is as follows: + + +----------+-------------+-------------+-----------------------------------+ + | Filed | Byte Length | Byte Offset | Description | + +----------+-------------+-------------+-----------------------------------+ + | offset | 4 | 0 | the offset of FIT buffer | + +----------+-------------+-------------+-----------------------------------+ + + Output: + +----------+-------------+-------------+-----------------------------------+ + | Filed | Byte Length | Byte Offset | Description | + +----------+-------------+-------------+-----------------------------------+ + | status | 4 | 0 | return status codes following | + | | | | Chapter 3 in DSM Spec Rev1 | + +----------+-------------+-------------+-----------------------------------+ + | fit data | Varies | 8 | FIT data | + | | | | | + +----------+-------------+-------------+-----------------------------------+ + + The FIT offset is maintained by the caller itself, current offset plugs + the length returned by the function is the next offset we should read. + When all the FIT data has been read out, zero length is returned.