All of lore.kernel.org
 help / color / mirror / Atom feed
From: richard.gong@linux.intel.com
To: 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,
	gregkh@linuxfoundation.org, 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,
	yves.vandervennet@linux.intel.com, richard.gong@linux.intel.com,
	richard.gong@intel.com
Subject: [PATCHv5 8/8] Documentation: driver-api: add stratix10 service layer
Date: Thu, 24 May 2018 11:33:20 -0500	[thread overview]
Message-ID: <1527179600-26441-9-git-send-email-richard.gong@linux.intel.com> (raw)
In-Reply-To: <1527179600-26441-1-git-send-email-richard.gong@linux.intel.com>

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

Add new file stratix10-svc.rst
Add stratix10-svc.rst to driver-api/index.rst

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
---
 Documentation/driver-api/index.rst         |  1 +
 Documentation/driver-api/stratix10-svc.rst | 32 ++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 Documentation/driver-api/stratix10-svc.rst

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 6d8352c..4b31109 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -49,6 +49,7 @@ available subsections can be seen below.
    dmaengine/index
    slimbus
    soundwire/index
+   stratix10-svc
 
 .. only::  subproject and html
 
diff --git a/Documentation/driver-api/stratix10-svc.rst b/Documentation/driver-api/stratix10-svc.rst
new file mode 100644
index 0000000..ed361d8
--- /dev/null
+++ b/Documentation/driver-api/stratix10-svc.rst
@@ -0,0 +1,32 @@
+
+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/stratix10-svc-client.h
+   :functions: stratix10_svc_command_code
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_client_msg
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_command_reconfig_payload
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_cb_data
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_client
+
+.. kernel-doc:: drivers/misc/stratix10-svc.c
+   :export:
-- 
2.7.4

WARNING: multiple messages have this Message-ID (diff)
From: richard.gong@linux.intel.com
To: 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,
	gregkh@linuxfoundation.org, 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,
	yves.vandervennet@linux.intel.com, richard.gong@linux.intel.com,
	richard.gong@intel.com
Subject: [PATCHv5 8/8] Documentation: driver-api: add stratix10 service layer
Date: Thu, 24 May 2018 11:33:20 -0500	[thread overview]
Message-ID: <1527179600-26441-9-git-send-email-richard.gong@linux.intel.com> (raw)
In-Reply-To: <1527179600-26441-1-git-send-email-richard.gong@linux.intel.com>

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

Add new file stratix10-svc.rst
Add stratix10-svc.rst to driver-api/index.rst

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
---
 Documentation/driver-api/index.rst         |  1 +
 Documentation/driver-api/stratix10-svc.rst | 32 ++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 Documentation/driver-api/stratix10-svc.rst

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 6d8352c..4b31109 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -49,6 +49,7 @@ available subsections can be seen below.
    dmaengine/index
    slimbus
    soundwire/index
+   stratix10-svc
 
 .. only::  subproject and html
 
diff --git a/Documentation/driver-api/stratix10-svc.rst b/Documentation/driver-api/stratix10-svc.rst
new file mode 100644
index 0000000..ed361d8
--- /dev/null
+++ b/Documentation/driver-api/stratix10-svc.rst
@@ -0,0 +1,32 @@
+
+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/stratix10-svc-client.h
+   :functions: stratix10_svc_command_code
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_client_msg
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_command_reconfig_payload
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_cb_data
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_client
+
+.. kernel-doc:: drivers/misc/stratix10-svc.c
+   :export:
-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

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: [PATCHv5 8/8] Documentation: driver-api: add stratix10 service layer
Date: Thu, 24 May 2018 11:33:20 -0500	[thread overview]
Message-ID: <1527179600-26441-9-git-send-email-richard.gong@linux.intel.com> (raw)
In-Reply-To: <1527179600-26441-1-git-send-email-richard.gong@linux.intel.com>

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

Add new file stratix10-svc.rst
Add stratix10-svc.rst to driver-api/index.rst

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
---
 Documentation/driver-api/index.rst         |  1 +
 Documentation/driver-api/stratix10-svc.rst | 32 ++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 Documentation/driver-api/stratix10-svc.rst

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 6d8352c..4b31109 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -49,6 +49,7 @@ available subsections can be seen below.
    dmaengine/index
    slimbus
    soundwire/index
+   stratix10-svc
 
 .. only::  subproject and html
 
diff --git a/Documentation/driver-api/stratix10-svc.rst b/Documentation/driver-api/stratix10-svc.rst
new file mode 100644
index 0000000..ed361d8
--- /dev/null
+++ b/Documentation/driver-api/stratix10-svc.rst
@@ -0,0 +1,32 @@
+
+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/stratix10-svc-client.h
+   :functions: stratix10_svc_command_code
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_client_msg
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_command_reconfig_payload
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_cb_data
+
+.. kernel-doc:: include/linux/stratix10-svc-client.h
+   :functions: stratix10_svc_client
+
+.. kernel-doc:: drivers/misc/stratix10-svc.c
+   :export:
-- 
2.7.4

  parent reply	other threads:[~2018-05-24 16:30 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-24 16:33 [PATCHv5 0/8] Add Intel Stratix10 FPGA manager and service layer richard.gong
2018-05-24 16:33 ` richard.gong at linux.intel.com
2018-05-24 16:33 ` richard.gong
2018-05-24 16:33 ` [PATCHv5 1/8] dt-bindings, firmware: add Intel Stratix10 service layer binding richard.gong
2018-05-24 16:33   ` richard.gong at linux.intel.com
2018-05-24 16:33   ` richard.gong
2018-05-24 17:04   ` Moritz Fischer
2018-05-24 17:04     ` Moritz Fischer
2018-05-24 17:04     ` Moritz Fischer
2018-05-24 16:33 ` [PATCHv5 2/8] arm64: dts: stratix10: add stratix10 service driver binding to base dtsi richard.gong
2018-05-24 16:33   ` richard.gong at linux.intel.com
2018-05-24 16:33   ` richard.gong
2018-05-24 16:33   ` richard.gong
2018-05-24 17:04   ` Moritz Fischer
2018-05-24 17:04     ` Moritz Fischer
2018-05-24 17:04     ` Moritz Fischer
2018-05-24 16:33 ` [PATCHv5 3/8] driver, misc: add Intel Stratix10 service layer driver richard.gong
2018-05-24 16:33   ` richard.gong at linux.intel.com
2018-05-24 16:33   ` richard.gong
2018-05-24 16:33 ` [PATCHv5 4/8] dt-bindings: fpga: add Stratix10 SoC FPGA manager binding richard.gong
2018-05-24 16:33   ` richard.gong at linux.intel.com
2018-05-24 16:33   ` richard.gong
2018-05-24 16:33 ` [PATCHv5 5/8] arm64: dts: stratix10: add fpga manager and region richard.gong
2018-05-24 16:33   ` richard.gong at linux.intel.com
2018-05-24 16:33   ` richard.gong
2018-05-24 16:33 ` [PATCHv5 6/8] fpga: add intel stratix10 soc fpga manager driver richard.gong
2018-05-24 16:33   ` richard.gong at linux.intel.com
2018-05-24 16:33   ` richard.gong
2018-05-24 16:33 ` [PATCHv5 7/8] defconfig: enable fpga and service layer richard.gong
2018-05-24 16:33   ` richard.gong at linux.intel.com
2018-05-24 16:33   ` richard.gong
2018-05-24 16:33 ` richard.gong [this message]
2018-05-24 16:33   ` [PATCHv5 8/8] Documentation: driver-api: add stratix10 " richard.gong at linux.intel.com
2018-05-24 16:33   ` richard.gong

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=1527179600-26441-9-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=will.deacon@arm.com \
    --cc=yves.vandervennet@linux.intel.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.