All of lore.kernel.org
 help / color / mirror / Atom feed
From: richard.gong@linux.intel.com
To: gregkh@linuxfoundation.org, catalin.marinas@arm.com,
	will.deacon@arm.com, dinguyen@kernel.org, robh+dt@kernel.org,
	mark.rutland@arm.com, atull@kernel.org, mdf@kernel.org,
	arnd@arndb.de, corbet@lwn.net
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
	linux-fpga@vger.kernel.org, linux-doc@vger.kernel.org,
	todd.riffel@intel.com, richard.gong@linux.intel.com,
	richard.gong@intel.com
Subject: [PATCHv11 7/8] Documentation: driver-api: add stratix10 service layer
Date: Tue, 13 Nov 2018 12:14:05 -0600	[thread overview]
Message-ID: <1542132846-24168-8-git-send-email-richard.gong@linux.intel.com> (raw)
In-Reply-To: <1542132846-24168-1-git-send-email-richard.gong@linux.intel.com>

From: Richard Gong <richard.gong@intel.com>

Add Intel Stratix10 service layer driver document

Signed-off-by: Richard Gong <richard.gong@intel.com>
Signed-off-by: Alan Tull <atull@kernel.org>
---
v5: this patch is added in patch set version 5,
    add new file stratix10-svc.rst
    add stratix10-svc.rst to driver-api/index.rst
v6: no change
v7: no change
v8: no change
v9: no change
v10: add stratix10 service layer document to other firmware
     interface, and then remove stratix10-svc.rst file
v11: no change
---
 .../driver-api/firmware/other_interfaces.rst       | 30 ++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/Documentation/driver-api/firmware/other_interfaces.rst b/Documentation/driver-api/firmware/other_interfaces.rst
index 36c47b1..a4ac54b 100644
--- a/Documentation/driver-api/firmware/other_interfaces.rst
+++ b/Documentation/driver-api/firmware/other_interfaces.rst
@@ -13,3 +13,33 @@ EDD Interfaces
 .. kernel-doc:: drivers/firmware/edd.c
    :internal:
 
+Intel Stratix10 SoC Service Layer
+---------------------------------
+Some features of the Intel Stratix10 SoC require a level of privilege
+higher than the kernel is granted. Such secure features include
+FPGA programming. In terms of the ARMv8 architecture, the kernel runs
+at Exception Level 1 (EL1), access to the features requires
+Exception Level 3 (EL3).
+
+The Intel Stratix10 SoC service layer provides an in kernel API for
+drivers to request access to the secure features. The requests are queued
+and processed one by one. ARM’s SMCCC is used to pass the execution
+of the requests on to a secure monitor (EL3).
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_command_code
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_client_msg
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_command_reconfig_payload
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_cb_data
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_client
+
+.. kernel-doc:: drivers/firmware/stratix10-svc.c
+   :export:
-- 
2.7.4


WARNING: multiple messages have this Message-ID (diff)
From: richard.gong@linux.intel.com (richard.gong at linux.intel.com)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCHv11 7/8] Documentation: driver-api: add stratix10 service layer
Date: Tue, 13 Nov 2018 12:14:05 -0600	[thread overview]
Message-ID: <1542132846-24168-8-git-send-email-richard.gong@linux.intel.com> (raw)
In-Reply-To: <1542132846-24168-1-git-send-email-richard.gong@linux.intel.com>

From: Richard Gong <richard.gong@intel.com>

Add Intel Stratix10 service layer driver document

Signed-off-by: Richard Gong <richard.gong@intel.com>
Signed-off-by: Alan Tull <atull@kernel.org>
---
v5: this patch is added in patch set version 5,
    add new file stratix10-svc.rst
    add stratix10-svc.rst to driver-api/index.rst
v6: no change
v7: no change
v8: no change
v9: no change
v10: add stratix10 service layer document to other firmware
     interface, and then remove stratix10-svc.rst file
v11: no change
---
 .../driver-api/firmware/other_interfaces.rst       | 30 ++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/Documentation/driver-api/firmware/other_interfaces.rst b/Documentation/driver-api/firmware/other_interfaces.rst
index 36c47b1..a4ac54b 100644
--- a/Documentation/driver-api/firmware/other_interfaces.rst
+++ b/Documentation/driver-api/firmware/other_interfaces.rst
@@ -13,3 +13,33 @@ EDD Interfaces
 .. kernel-doc:: drivers/firmware/edd.c
    :internal:
 
+Intel Stratix10 SoC Service Layer
+---------------------------------
+Some features of the Intel Stratix10 SoC require a level of privilege
+higher than the kernel is granted. Such secure features include
+FPGA programming. In terms of the ARMv8 architecture, the kernel runs
+at Exception Level 1 (EL1), access to the features requires
+Exception Level 3 (EL3).
+
+The Intel Stratix10 SoC service layer provides an in kernel API for
+drivers to request access to the secure features. The requests are queued
+and processed one by one. ARM?s SMCCC is used to pass the execution
+of the requests on to a secure monitor (EL3).
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_command_code
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_client_msg
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_command_reconfig_payload
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_cb_data
+
+.. kernel-doc:: include/linux/firmware/intel/stratix10-svc-client.h
+   :functions: stratix10_svc_client
+
+.. kernel-doc:: drivers/firmware/stratix10-svc.c
+   :export:
-- 
2.7.4

  parent reply	other threads:[~2018-11-13 18:08 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-13 18:13 [PATCHv11 0/8] Add Intel Stratix10 FPGA manager and service layer richard.gong
2018-11-13 18:13 ` richard.gong at linux.intel.com
2018-11-13 18:13 ` [PATCHv11 1/8] dt-bindings, firmware: add Intel Stratix10 service layer binding richard.gong
2018-11-13 18:13   ` richard.gong at linux.intel.com
2018-11-13 18:14 ` [PATCHv11 2/8] arm64: dts: stratix10: add stratix10 service driver binding to base dtsi richard.gong
2018-11-13 18:14   ` richard.gong at linux.intel.com
2018-11-13 18:14 ` [PATCHv11 3/8] firmware: add Intel Stratix10 service layer driver richard.gong
2018-11-13 18:14   ` richard.gong at linux.intel.com
2018-11-13 18:14 ` [PATCHv11 4/8] dt-bindings: fpga: add Stratix10 SoC FPGA manager binding richard.gong
2018-11-13 18:14   ` richard.gong at linux.intel.com
2018-11-13 18:14 ` [PATCHv11 5/8] arm64: dts: stratix10: add fpga manager and region richard.gong
2018-11-13 18:14   ` richard.gong at linux.intel.com
2018-11-13 18:14 ` [PATCHv11 6/8] fpga: add intel stratix10 soc fpga manager driver richard.gong
2018-11-13 18:14   ` richard.gong at linux.intel.com
2018-11-13 18:14 ` richard.gong [this message]
2018-11-13 18:14   ` [PATCHv11 7/8] Documentation: driver-api: add stratix10 service layer richard.gong at linux.intel.com
2018-11-13 18:14 ` [PATCHv11 8/8] firmware: add remote status update client support richard.gong
2018-11-13 18:14   ` richard.gong at linux.intel.com

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1542132846-24168-8-git-send-email-richard.gong@linux.intel.com \
    --to=richard.gong@linux.intel.com \
    --cc=arnd@arndb.de \
    --cc=atull@kernel.org \
    --cc=catalin.marinas@arm.com \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=dinguyen@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-fpga@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=mdf@kernel.org \
    --cc=richard.gong@intel.com \
    --cc=robh+dt@kernel.org \
    --cc=todd.riffel@intel.com \
    --cc=will.deacon@arm.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.