public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Jiaxin Wu <Jiaxin.wu@intel.com>
To: edk2-devel@lists.01.org
Cc: Leif Lindholm <leif.lindholm@linaro.org>,
	Rothman Michael A <michael.a.rothman@intel.com>,
	Kinney Michael D <michael.d.kinney@intel.com>,
	Li Ruth <ruth.li@intel.com>, Ye Ting <ting.ye@intel.com>,
	Fu Siyuan <siyuan.fu@intel.com>, Wang Fan <fan.wang@intel.com>,
	Wu Jiaxin <jiaxin.wu@intel.com>
Subject: [staging/UEFI_Redfish][PATCH v2] Announce to create "UEFI_Redfish" branch in edk2-staging.
Date: Mon, 21 Jan 2019 02:19:23 +0800	[thread overview]
Message-ID: <20190120181923.336-1-Jiaxin.wu@intel.com> (raw)

v2: Resend the patch as diff adding instead of modifying.

UEFI_Redfish branch is to develop the UEFI Redfish feature. The code base
of development is based on the release of edk2-stable201811 tag. Please
refer to the patch of Readme.md to get the detailed feature introduction.

Note: The branch will be created by the end of Jan 28th if no objection.

Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Rothman Michael A <michael.a.rothman@intel.com>
Cc: Kinney Michael D <michael.d.kinney@intel.com>
Cc: Li Ruth <ruth.li@intel.com>
Cc: Ye Ting <ting.ye@intel.com>
Cc: Fu Siyuan <siyuan.fu@intel.com>
Cc: Wang Fan <fan.wang@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
---
 Readme.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000000..b9b5ab38e2
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,85 @@
+This branch is used to develop the **UEFI Redfish Feature**. The code base of development is based on the release of **edk2-stable201811** tag.
+
+The branch owner:
+Fu Siyuan <siyuan.fu@intel.com>, Ye Ting <ting.ye@intel.com>, Wang Fan <fan.wang@intel.com>, Wu Jiaxin <jiaxin.wu@intel.com>
+
+## Introduction
+UEFI Redfish is an efficient and secure solution for end users to remote control and configure UEFI pre-OS environment by leveraging the RESTful API.  It's simple for end users to access the data from UEFI firmware defined in JSON format.
+
+One of the design goals for UEFI Redfish solution is to provide a scalable implementation which allow users to easily add/remove/modify each independent Redfish configure features (RedfishBiosDxe & RedfishBootInfoDxe). This is done by extracting the generic logic to a single UEFI driver model driver (RedfishConfigDxe), and several library instances (DxeRedfishLib & BaseJsonLib).
+
+#### Supported Features
+  * Protocols
+    * EFI RestEx Service Binding Protocol
+    * EFI RestEx Protocol
+    * Redfish ConfigHandler Protocol
+    * Redfish Credential Protocol
+
+  * Configuration Items via UEFI Redfish
+    * [ISCSI Boot Keywords](http://www.uefi.org/confignamespace).
+    * HII Opcodes/Questions marked with REST_SYTLE flag or in REST_SYTLE formset.
+    * BootOrder/BootNext variables.
+
+  * Redfish Schemas
+    * [AttributeRegistry](https://redfish.dmtf.org/schemas/v1/AttributeRegistry.v1_1_0.json)
+    * [ComputerSystemCollection](https://redfish.dmtf.org/schemas/ComputerSystemCollection.json)
+    * [ComputerSystem](https://redfish.dmtf.org/schemas/v1/ComputerSystem.v1_5_0.json)
+    * [Bios](https://redfish.dmtf.org/schemas/v1/Bios.v1_0_2.json)
+    * [BootOptionCollection](https://redfish.dmtf.org/schemas/BootOptionCollection.json)
+    * [BootOption](https://redfish.dmtf.org/schemas/BootOption.v1_0_0.json)
+
+    If any additional Redfish Schema or a new version of above Schemas are required to be supported, please send the email to edk2-devel mailing list by following [edk2-satging process](https://github.com/tianocore/edk2-staging).
+
+#### Related Modules
+  The following modules are related to UEFI Redfish solution, **RedfishPkg** is the new package to support UEFI Redfish solution:
+  * **RedfishPkg\RestExDxe\RestExDxe.inf** - UEFI driver to enable standardized RESTful access to resources from UEFI environment.
+
+  * **RedfishPkg\Library\DxeRedfishLib** - Library to Create/Read/Update/Delete (CRUD) resources and provide basic query abilities by using [URI/RedPath](https://github.com/DMTF/libredfish).
+
+  * **RedfishPkg\Library\BaseJsonLib** - Library to encode/decode JSON data.
+
+  * **RedfishPkg\RedfishConfigDxe\RedfishConfigDxe.inf** - UEFI driver to execute registered Redfish Configuration Handlers:
+
+    * **RedfishPkg\Features\RedfishBiosDxe\RedfishBiosDxe.inf** - DXE driver to register Redfish configuration handler to process "Bios" schema and "AttributeRegistry" schema.
+
+    * **RedfishPkg\Features\Features\RedfishBootInfoDxe\RedfishBootInfoDxe.inf** - DXE driver to register Redfish configuration handler to process Boot property defined in "ComputerSystem" schema.
+
+  * Platform Components for NT32:
+    * **Nt32Pkg\RedfishPlatformDxe\RedfishPlatformDxe.inf** - UEFI sample platform driver for NT32 to fill the SMBIOS table 42 and publish Redfish Credential info.
+
+    * **Nt32Pkg\Application\RedfishPlatformConfig\RedfishPlatformConfig.inf** - UEFI application for NT32 to publish Redfish Host Interface Record.
+
+  * Misc
+   * BaseTools - VfrCompile changes to support Rest Style Formset/Flag.
+
+   * MdePkg - Headers related to Rest Style Formset/Flag.
+
+   * MdeModulePkg - Extract more general APIs in UefiHiiLib & DxeHttpLib & DxeNetLib.
+
+   * NetworkPkg -  1) UefiPxeBcDxe & HttpBootDxe: Consume new APIs defined in DxeHttpLib & DxeNetLib. 2) HttpDxe: Cross-Subnet support. 3) IScsiDxe: REST Style FORMSET support.
+
+   * Nt32Pkg - 1) Enable UEFI Redfish feature in NT32 platform. 2) Fix TLS build error with CryptoPkg from edk2-stable201811 tag.
+
+
+## Promote to edk2 Trunk
+If a subset feature or a bug fix in this staging branch could meet below requirement, it could be promoted to edk2 trunk and removed from this staging branch:
+* Meet all edk2 required quality criteria.
+* Support both IA32 and X64 Platform.
+* Ready for product integration.
+
+## Timeline
+| Time | Event | Related Modules |
+|:----:|:-----:|:--------------:|
+| 2019.01 | Initial open source release of UEFI Redfish feature. | Refer to "Related Modules" |
+|...|...|...|
+
+## Related Materials
+1. DSP0270 - Redfish Host Interface Specification, 1.0.1
+
+2. DSP0266 - Redfish Scalable Platforms Management API Specification, 1.5.0
+
+3. UEFI Configuration Namespace Registry - http://www.uefi.org/confignamespace
+
+4. Redfish Schemas - https://redfish.dmtf.org/schemas/v1/
+
+5. UEFI Specification - http://uefi.org/specifications
-- 
2.17.1.windows.2



             reply	other threads:[~2019-01-20 18:19 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-01-20 18:19 Jiaxin Wu [this message]
2019-04-10  1:09 ` FW: [staging/UEFI_Redfish][PATCH v2] Announce to create "UEFI_Redfish" branch in edk2-staging Wu, Jiaxin

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-list 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=20190120181923.336-1-Jiaxin.wu@intel.com \
    --to=devel@edk2.groups.io \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox