From mboxrd@z Thu Jan 1 00:00:00 1970 From: Xiao Guangrong Subject: [PATCH v2 8/8] nvdimm docs: add nvdimm Read FIT function Date: Fri, 12 Aug 2016 14:54:10 +0800 Message-ID: <1470984850-66891-9-git-send-email-guangrong.xiao@linux.intel.com> References: <1470984850-66891-1-git-send-email-guangrong.xiao@linux.intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cc: gleb@kernel.org, mtosatti@redhat.com, stefanha@redhat.com, mst@redhat.com, rth@twiddle.net, ehabkost@redhat.com, dan.j.williams@intel.com, kvm@vger.kernel.org, qemu-devel@nongnu.org, Xiao Guangrong To: pbonzini@redhat.com, imammedo@redhat.com Return-path: Received: from mga09.intel.com ([134.134.136.24]:52642 "EHLO mga09.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751561AbcHLHIu (ORCPT ); Fri, 12 Aug 2016 03:08:50 -0400 In-Reply-To: <1470984850-66891-1-git-send-email-guangrong.xiao@linux.intel.com> Sender: kvm-owner@vger.kernel.org List-ID: 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. -- 1.8.3.1 From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33213) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bYDKh-0004cT-IG for qemu-devel@nongnu.org; Fri, 12 Aug 2016 10:21:22 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bYDKS-0001jl-5f for qemu-devel@nongnu.org; Fri, 12 Aug 2016 10:21:10 -0400 Received: from mga04.intel.com ([192.55.52.120]:2220) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bYDKR-0001jM-Ub for qemu-devel@nongnu.org; Fri, 12 Aug 2016 10:20:56 -0400 From: Xiao Guangrong Date: Fri, 12 Aug 2016 14:54:10 +0800 Message-Id: <1470984850-66891-9-git-send-email-guangrong.xiao@linux.intel.com> In-Reply-To: <1470984850-66891-1-git-send-email-guangrong.xiao@linux.intel.com> References: <1470984850-66891-1-git-send-email-guangrong.xiao@linux.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [Qemu-devel] [PATCH v2 8/8] nvdimm docs: add nvdimm Read FIT function List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: pbonzini@redhat.com, imammedo@redhat.com Cc: gleb@kernel.org, mtosatti@redhat.com, stefanha@redhat.com, mst@redhat.com, rth@twiddle.net, ehabkost@redhat.com, dan.j.williams@intel.com, kvm@vger.kernel.org, qemu-devel@nongnu.org, Xiao Guangrong 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. -- 1.8.3.1