On Thu, Feb 09, 2017 at 10:11:43PM +0800, Haojian Zhuang wrote:

Add more register definitions in Hi6220 SoC.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

Reviewed-by: Leif Lindholm leif.lindholm@linaro.org

---

Chips/Hisilicon/Hi6220/Include/Hi6220.h | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+)

diff --git a/Chips/Hisilicon/Hi6220/Include/Hi6220.h b/Chips/Hisilicon/Hi6220/Include/Hi6220.h index 203424a..6b87524 100644 --- a/Chips/Hisilicon/Hi6220/Include/Hi6220.h +++ b/Chips/Hisilicon/Hi6220/Include/Hi6220.h @@ -48,15 +48,41 @@ #define SC_PERIPH_CLKDIS0 0x204 #define SC_PERIPH_CLKSTAT0 0x208 +#define SC_PERIPH_CLKEN3 0x230 #define SC_PERIPH_RSTEN0 0x300 #define SC_PERIPH_RSTDIS0 0x304 #define SC_PERIPH_RSTSTAT0 0x308 +#define SC_PERIPH_RSTEN3 0x330 +#define SC_PERIPH_RSTDIS3 0x334 +#define SC_PERIPH_RSTSTAT3 0x338 #define RST0_USBOTG_BUS BIT4 #define RST0_POR_PICOPHY BIT5 #define RST0_USBOTG BIT6 #define RST0_USBOTG_32K BIT7 +/* SC_PERIPH_RSTEN0/RSTDIS0/RSTSTAT0 */ +#define PERIPH_RST0_MMC2 (1 << 2)

+/* SC_PERIPH_RSTEN3/RSTDIS3/RSTSTAT3 */ +#define PERIPH_RST3_CSSYS (1 << 0) +#define PERIPH_RST3_I2C0 (1 << 1) +#define PERIPH_RST3_I2C1 (1 << 2) +#define PERIPH_RST3_I2C2 (1 << 3) +#define PERIPH_RST3_I2C3 (1 << 4) +#define PERIPH_RST3_UART1 (1 << 5) +#define PERIPH_RST3_UART2 (1 << 6) +#define PERIPH_RST3_UART3 (1 << 7) +#define PERIPH_RST3_UART4 (1 << 8) +#define PERIPH_RST3_SSP (1 << 9) +#define PERIPH_RST3_PWM (1 << 10) +#define PERIPH_RST3_BLPWM (1 << 11) +#define PERIPH_RST3_TSENSOR (1 << 12) +#define PERIPH_RST3_DAPB (1 << 18) +#define PERIPH_RST3_HKADC (1 << 19) +#define PERIPH_RST3_CODEC_SSI (1 << 20) +#define PERIPH_RST3_PMUSSI1 (1 << 22)

#define EYE_PATTERN_PARA 0x7053348c #define MDDRC_AXI_BASE 0xF7120000 @@ -74,4 +100,7 @@ #define PMUSSI_BASE 0xF8000000 +#define PMUSSI_REG(x) (PMUSSI_BASE + ((x) << 2))

#endif /* __HI6220_H__ */

2.7.4

On Thu, Feb 09, 2017 at 10:11:46PM +0800, Haojian Zhuang wrote:

These GUIDs are used in HiKeyUsb and HiKeyGpio driver.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

This can be squashed with 2/9, and I believe both of these could really be squashed into 7/9?

/ Leif

---

Platforms/Hisilicon/HiKey/HiKey.dec | 1 + 1 file changed, 1 insertion(+)

diff --git a/Platforms/Hisilicon/HiKey/HiKey.dec b/Platforms/Hisilicon/HiKey/HiKey.dec index 537138e..17c6484 100644 --- a/Platforms/Hisilicon/HiKey/HiKey.dec +++ b/Platforms/Hisilicon/HiKey/HiKey.dec @@ -30,6 +30,7 @@ [Guids.common] gHiKeyTokenSpaceGuid = { 0x91148425, 0xcdd2, 0x4830, { 0x8b, 0xd0, 0xc6, 0x1c, 0x6d, 0xea, 0x36, 0x21 } }

• gHiKeyVariableGuid = { 0x66b8d063, 0x1daa, 0x4c60, { 0xb9, 0xf2, 0x55, 0x0d, 0x7e, 0xe1, 0x2f, 0x38 } }

[PcdsFixedAtBuild.common] gHiKeyTokenSpaceGuid.PcdAndroidFastbootNvmDevicePath|L""|VOID*|0x00000001 -- 2.7.4

On Thu, Feb 09, 2017 at 10:11:47PM +0800, Haojian Zhuang wrote:

Support PL061 GPIO controller on HiKey platform.

I don't feel this accurately describes what this patch does.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

.../Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.c | 68 ++++++++++++++++++++++ .../Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf | 37 ++++++++++++ 2 files changed, 105 insertions(+) create mode 100644 Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.c create mode 100644 Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf

diff --git a/Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.c b/Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.c new file mode 100644 index 0000000..9e7a895 --- /dev/null +++ b/Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.c @@ -0,0 +1,68 @@ +/** @file +* +* Copyright (c) 2015-2017, Linaro. All rights reserved. +* +* This program and the accompanying materials +* are licensed and made available under the terms and conditions of the BSD License +* which accompanies this distribution. The full text of the license may be found at +* http://opensource.org/licenses/bsd-license.php +* +* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +* +**/

+#include <Library/UefiBootServicesTableLib.h>

+#include <Protocol/EmbeddedGpio.h>

+GPIO_CONTROLLER gGpioDevice[]= {

• { 0xf8011000, 0, 8 }, // GPIO0
• { 0xf8012000, 8, 8 }, // GPIO1
• { 0xf8013000, 16, 8 }, // GPIO2
• { 0xf8014000, 24, 8 }, // GPIO3
• { 0xf7020000, 32, 8 }, // GPIO4
• { 0xf7021000, 40, 8 }, // GPIO5
• { 0xf7022000, 48, 8 }, // GPIO6
• { 0xf7023000, 56, 8 }, // GPIO7
• { 0xf7024000, 64, 8 }, // GPIO8
• { 0xf7025000, 72, 8 }, // GPIO9
• { 0xf7026000, 80, 8 }, // GPIO10
• { 0xf7027000, 88, 8 }, // GPIO11
• { 0xf7028000, 96, 8 }, // GPIO12
• { 0xf7029000, 104, 8 }, // GPIO13
• { 0xf702a000, 112, 8 }, // GPIO14
• { 0xf702b000, 120, 8 }, // GPIO15
• { 0xf702c000, 128, 8 }, // GPIO16
• { 0xf702d000, 136, 8 }, // GPIO17
• { 0xf702e000, 144, 8 }, // GPIO18
• { 0xf702f000, 152, 8 } // GPIO19

No magic values please, add as #defines.

+};

+PLATFORM_GPIO_CONTROLLER gPlatformGpioDevice = {

• 160, 20, gGpioDevice

No magic values please. Add as #defines.

+};

+EFI_STATUS +EFIAPI +HiKeyGpioEntryPoint (

• IN EFI_HANDLE ImageHandle,
• IN EFI_SYSTEM_TABLE *SystemTable
• )

+{

• EFI_STATUS Status;
• EFI_HANDLE Handle;
• // Install the Embedded Platform GPIO Protocol onto a new handle
• Handle = NULL;
• Status = gBS->InstallMultipleProtocolInterfaces(

Status = gBS->InstallMultipleProtocolInterfaces (

•              &Handle,
  

•              &gPlatformGpioProtocolGuid, &gPlatformGpioDevice,
  

•              NULL
  

•             );
  

• if (EFI_ERROR(Status)) {

if (EFI_ERROR (Status)) {

• Status = EFI_OUT_OF_RESOURCES;
• }
• return Status;

+} diff --git a/Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf b/Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf new file mode 100644 index 0000000..65aa5da --- /dev/null +++ b/Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf @@ -0,0 +1,37 @@ +# +# Copyright (c) 2015-2017, Linaro. All rights reserved. +# +# This program and the accompanying materials +# are licensed and made available under the terms and conditions of the BSD License +# which accompanies this distribution. The full text of the license may be found at +# http://opensource.org/licenses/bsd-license.php +# +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +#

+[Defines]

• INF_VERSION = 0x00010019
• BASE_NAME = HiKeyGpio
• FILE_GUID = b51a851c-7bf7-463f-b261-cfb158b7f699
• MODULE_TYPE = DXE_DRIVER
• VERSION_STRING = 1.0
• ENTRY_POINT = HiKeyGpioEntryPoint

+[Sources.common]

• HiKeyGpioDxe.c

+[Packages]

• EmbeddedPkg/EmbeddedPkg.dec
• MdePkg/MdePkg.dec
• OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKey.dec

+[LibraryClasses]

• DebugLib
• UefiDriverEntryPoint

+[Protocols]

• gPlatformGpioProtocolGuid

+[Depex]

• TRUE

-- 2.7.4

On Thu, Feb 09, 2017 at 10:11:48PM +0800, Haojian Zhuang wrote:

Support Designware USB device controller on HiKey platform.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

.../Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c | 266 +++++++++++++++++++++ .../Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf | 46 ++++ 2 files changed, 312 insertions(+) create mode 100644 Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c create mode 100644 Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf

diff --git a/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c b/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c new file mode 100644 index 0000000..60ad4d6 --- /dev/null +++ b/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c @@ -0,0 +1,266 @@ +/** @file +* +* Copyright (c) 2015-2017, Linaro. All rights reserved. +* +* This program and the accompanying materials +* are licensed and made available under the terms and conditions of the BSD License +* which accompanies this distribution. The full text of the license may be found at +* http://opensource.org/licenses/bsd-license.php +* +* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +* +**/

+#include <Library/BaseMemoryLib.h> +#include <Library/DebugLib.h> +#include <Library/IoLib.h> +#include <Library/TimerLib.h> +#include <Library/UefiBootServicesTableLib.h> +#include <Library/UefiLib.h> +#include <Library/UefiRuntimeServicesTableLib.h>

+#include <Protocol/EmbeddedGpio.h> +#include <Protocol/DwUsb.h>

+#include <Hi6220.h>

+#define USB_SEL_GPIO0_3 3 // GPIO 0_3 +#define USB_5V_HUB_EN 7 // GPIO 0_7 +#define USB_ID_DET_GPIO2_5 21 // GPIO 2_5 +#define USB_VBUS_DET_GPIO2_6 22 // GPIO 2_6

+// Jumper on pin5-6 of J15 determines whether boot to fastboot +#define DETECT_J15_FASTBOOT 24 // GPIO 3_0

+STATIC EMBEDDED_GPIO *mGpio;

+STATIC +VOID +HiKeyDetectUsbModeInit (

• IN VOID
• )

+{

• EFI_STATUS Status;
• /* set pullup on both GPIO2_5 & GPIO2_6. It's required for inupt. */
• MmioWrite32 (0xf8001864, 1);
• MmioWrite32 (0xf8001868, 1);

No magic values please, add #defines.

• Status = gBS->LocateProtocol (&gEmbeddedGpioProtocolGuid, NULL, (VOID **)&mGpio);
• ASSERT_EFI_ERROR (Status);

This should unconditionally print an error and return if failed. Also, it should probably return error and be handled at the call site, instead of continuing as if nothing had happened.

• Status = mGpio->Set (mGpio, USB_SEL_GPIO0_3, GPIO_MODE_OUTPUT_0);
• ASSERT_EFI_ERROR (Status);
• Status = mGpio->Set (mGpio, USB_5V_HUB_EN, GPIO_MODE_OUTPUT_0);
• ASSERT_EFI_ERROR (Status);
• MicroSecondDelay (1000);

Why this delay? Is a barrier needed? Why was 1ms chosen as the delay?

• Status = mGpio->Set (mGpio, USB_ID_DET_GPIO2_5, GPIO_MODE_INPUT);
• ASSERT_EFI_ERROR (Status);
• Status = mGpio->Set (mGpio, USB_VBUS_DET_GPIO2_6, GPIO_MODE_INPUT);
• ASSERT_EFI_ERROR (Status);

+}

+UINTN +HiKeyGetUsbMode (

• IN VOID
• )

+{ +#if 0

Please don't include commented-out code blocks.

• EFI_STATUS Status;
• UINTN GpioId, GpioVbus;
• UINTN Value;
• Status = mGpio->Get (mGpio, USB_ID_DET_GPIO2_5, &Value);
• ASSERT_EFI_ERROR (Status);
• GpioId = Value;
• Status = mGpio->Get (mGpio, USB_VBUS_DET_GPIO2_6, &Value);
• ASSERT_EFI_ERROR (Status);
• GpioVbus = Value;

+DEBUG ((DEBUG_ERROR, "#%a, %d, GpioId:%d, GpioVbus:%d\n", __func__, __LINE__, GpioId, GpioVbus));

• if ((GpioId == 1) && (GpioVbus == 0)) {
• return USB_DEVICE_MODE;
• } else if ((GpioId == 0) && (GpioVbus == 1)) {
• return USB_CABLE_NOT_ATTACHED;
• }
• return USB_HOST_MODE;

+#else

• return USB_DEVICE_MODE;

+#endif +}

+EFI_STATUS +HiKeyUsbPhyInit (

• IN UINT8 Mode
• )

+{

• UINTN Value;
• UINT32 Data;
• HiKeyDetectUsbModeInit ();
• //setup clock
• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_CLKEN0, BIT4);

What does BIT4 mean in this context? Can a #define with a more descriptive name be created?

• do {

•   Value = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_CLKSTAT0);
  

• } while ((Value & BIT4) == 0);
• //setup phy
• Data = RST0_USBOTG_BUS | RST0_POR_PICOPHY |

•       RST0_USBOTG | RST0_USBOTG_32K;
  

• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_RSTDIS0, Data);
• do {
• Value = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_RSTSTAT0);
• Value &= Data;
• } while (Value);
• Value = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_CTRL4);
• Value &= ~(CTRL4_PICO_SIDDQ | CTRL4_FPGA_EXT_PHY_SEL |

•         CTRL4_OTG_PHY_SEL);
  

• Value |= CTRL4_PICO_VBUSVLDEXT | CTRL4_PICO_VBUSVLDEXTSEL;
• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_CTRL4, Value);
• MicroSecondDelay (1000);

Why this delay? Is a barrier needed? Why was 1ms chosen as the delay?

• //If Mode = 1, USB in Device Mode
• //If Mode = 0, USB in Host Mode

You have introduced #defines for these, so don't need to list. Could just say: // Verify that controller is in expected mode

• if (Mode == USB_DEVICE_MODE) {
• if (HiKeyGetUsbMode () == USB_DEVICE_MODE) {

•  DEBUG ((DEBUG_ERROR, "usb work as device mode.\n"));
  

• } else {

•  return EFI_INVALID_PARAMETER;
  

• }

May be cleaner written as:

if (HiKeyGetUsbMode () != USB_DEVICE_MODE) { return EFI_INVALID_PARAMETER; }

DEBUG ((DEBUG_ERROR, "usb work as device mode.\n"));

But also, please don't use DEBUG_ERROR for non-error conditions.

• Value = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_CTRL5);
  

• Value &= ~CTRL5_PICOPHY_BC_MODE;
  

• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_CTRL5, Value);
  

• MicroSecondDelay (20000);
  

Why this delay? Is a barrier needed? Why was 20ms chosen as the delay?

• } else {
• if (HiKeyGetUsbMode () == USB_HOST_MODE) {

•  DEBUG ((DEBUG_ERROR, "usb work as host mode.\n"));
  

Please don't use DEBUG_ERROR for non-error conditions.

• } else {

•  return EFI_INVALID_PARAMETER;
  

• }

Ah, but here the pattern repeats again. So actually, you could do:

if (HiKeyGetUsbMode () != Mode) { return EFI_INVALID_PARAMETER; }

once

and then if (Mode == USB_DEVICE_MODE) { ... } else { ... }

• /*CTRL5*/
• Data = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_CTRL5);
• Data &= ~CTRL5_PICOPHY_BC_MODE;
• Data |= CTRL5_USBOTG_RES_SEL | CTRL5_PICOPHY_ACAENB |

•        CTRL5_PICOPHY_VDATDETENB | CTRL5_PICOPHY_DCDENB;
  

• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_CTRL5, Data);
• MicroSecondDelay (20000);

Why this delay? Is a barrier needed? Why was 20ms chosen as the delay?

• MmioWrite32 (PERI_CTRL_BASE + 0x018, 0x70533483); //EYE_PATTERN

No magic values, please. (What's an eye pattern?)

• MicroSecondDelay (5000);

Why this delay? Is a barrier needed? Why was 5ms chosen as the delay?

• }
• return EFI_SUCCESS;

+}

+EFI_STATUS +EFIAPI +HiKeyUsbGetLang (

• OUT CHAR16 *Lang,
• OUT UINT8 *Length
• )

+{

• if ((Lang == NULL) || (Length == NULL)) {
• return EFI_INVALID_PARAMETER;
• }
• Lang[0] = 0x409;

No magic values, please.

• *Length = sizeof (CHAR16);
• return EFI_SUCCESS;

+}

+EFI_STATUS +EFIAPI +HiKeyUsbGetManuFacturer (

Manufacturer is a single word, so the 'f' should not be capitalised and the #define should be "MANUFACTURER_". (To be corrected also in 3/9, where I missed it on the first pass.)

• OUT CHAR16 *ManuFacturer,
• OUT UINT8 *Length
• )

+{

• UINTN VariableSize;
• CHAR16 DataUnicode[MANU_FACTURER_STRING_LENGTH];
• if ((ManuFacturer == NULL) || (Length == NULL)) {
• return EFI_INVALID_PARAMETER;
• }
• VariableSize = MANU_FACTURER_STRING_LENGTH * sizeof (CHAR16);
• ZeroMem (DataUnicode, MANU_FACTURER_STRING_LENGTH * sizeof(CHAR16));
• StrCpy (DataUnicode, L"96Boards");
• CopyMem (ManuFacturer, DataUnicode, VariableSize);
• *Length = VariableSize;
• return EFI_SUCCESS;

+}

OK, the mechanism used here to set manufacturer, product and serial strings is hideously over-complicated.

In fact, ignore my comment that the string lenghts should be corrected also in 3/9 - they should never exist as defines in the first place.

This file holds all of the information about which strings are going into the data structure, and that should not be exported anywhere.

These functions should return a pointer to a string allocated dynamically in this file (or NULL if allocation fails). Since these functions create '0'-terminated strings. the length can then be determined using StrLen.

+EFI_STATUS +EFIAPI +HiKeyUsbGetProduct (

• OUT CHAR16 *Product,
• OUT UINT8 *Length
• )

+{

• UINTN VariableSize;
• CHAR16 DataUnicode[PRODUCT_STRING_LENGTH];
• if ((Product == NULL) || (Length == NULL)) {
• return EFI_INVALID_PARAMETER;
• }
• VariableSize = PRODUCT_STRING_LENGTH * sizeof (CHAR16);
• ZeroMem (DataUnicode, PRODUCT_STRING_LENGTH * sizeof(CHAR16));
• StrCpy (DataUnicode, L"HiKey");
• CopyMem (Product, DataUnicode, VariableSize);
• *Length = VariableSize;
• return EFI_SUCCESS;

+}

+EFI_STATUS +EFIAPI +HiKeyUsbGetSerialNo (

• OUT CHAR16 *SerialNo,
• OUT UINT8 *Length
• )

+{

• UINTN VariableSize;
• CHAR16 DataUnicode[SERIAL_STRING_LENGTH];
• if ((SerialNo == NULL) || (Length == NULL)) {
• return EFI_INVALID_PARAMETER;
• }
• VariableSize = SERIAL_STRING_LENGTH * sizeof (CHAR16);
• ZeroMem (DataUnicode, SERIAL_STRING_LENGTH * sizeof(CHAR16));
• StrCpy (DataUnicode, L"0123456789abcdef");

A hardcoded serial number will make you no friends in validation labs. I would suggest that as a start, this fake serial number is broken out to be retreived from a helper function (which for now can return only a made up one). Then at a later date, you can figure out how to provide it with some data that lets you actually tell different devices apart.

• CopyMem (SerialNo, DataUnicode, VariableSize);
• *Length = VariableSize;
• return EFI_SUCCESS;

+}

+DW_USB_PROTOCOL mDwUsbDevice = {

• HiKeyUsbGetLang,
• HiKeyUsbGetManuFacturer,
• HiKeyUsbGetProduct,
• HiKeyUsbGetSerialNo,
• HiKeyUsbPhyInit

+};

+EFI_STATUS +EFIAPI +HiKeyUsbEntryPoint (

• IN EFI_HANDLE ImageHandle,
• IN EFI_SYSTEM_TABLE *SystemTable
• )

+{

• EFI_STATUS Status;
• Status = gBS->InstallProtocolInterface (

•              &ImageHandle,
  

•              &gDwUsbProtocolGuid,
  

•              EFI_NATIVE_INTERFACE,
  

•              &mDwUsbDevice
  

•              );
  

• if (EFI_ERROR (Status)) {
• return Status;
• }

The code returns status anyway, so this EFI_ERROR test has no purpose.

• return Status;

+} diff --git a/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf b/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf new file mode 100644 index 0000000..1cb70c9 --- /dev/null +++ b/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf @@ -0,0 +1,46 @@ +#/** @file +# +# Copyright (c) 2015-2017, Linaro. All rights reserved. +# +# This program and the accompanying materials +# are licensed and made available under the terms and conditions of the BSD License +# which accompanies this distribution. The full text of the license may be found at +# http://opensource.org/licenses/bsd-license.php +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +# +# +#**/

+[Defines]

• INF_VERSION = 0x00010019
• BASE_NAME = HiKeyUsbDxe
• FILE_GUID = c5c7089e-9b00-448c-8b23-a552688e2833
• MODULE_TYPE = UEFI_DRIVER
• VERSION_STRING = 1.0
• ENTRY_POINT = HiKeyUsbEntryPoint

+[Sources.common]

• HiKeyUsbDxe.c

+[LibraryClasses]

• DebugLib
• IoLib
• TimerLib
• UefiBootServicesTableLib
• UefiDriverEntryPoint

+[Protocols]

• gDwUsbProtocolGuid
• gEfiDriverBindingProtocolGuid
• gEmbeddedGpioProtocolGuid

+[Packages]

• MdePkg/MdePkg.dec
• MdeModulePkg/MdeModulePkg.dec
• EmbeddedPkg/EmbeddedPkg.dec
• OpenPlatformPkg/Drivers/Usb/DwUsbDxe/DwUsbDxe.dec
• OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKey.dec

Please sort packages alphabetically.

+[Depex]

• TRUE

-- 2.7.4

On Fri, Feb 10, 2017 at 11:45:20AM +0000, Ard Biesheuvel wrote:

...

On 10 Feb 2017, at 11:37, Leif Lindholm leif.lindholm@linaro.org wrote:

...

On Thu, Feb 09, 2017 at 10:11:48PM +0800, Haojian Zhuang wrote: Support Designware USB device controller on HiKey platform.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

.../Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c | 266 +++++++++++++++++++++ .../Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf | 46 ++++ 2 files changed, 312 insertions(+) create mode 100644 Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c create mode 100644 Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf

diff --git a/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c b/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c new file mode 100644 index 0000000..60ad4d6 --- /dev/null +++ b/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.c @@ -0,0 +1,266 @@ +/** @file +* +* Copyright (c) 2015-2017, Linaro. All rights reserved. +* +* This program and the accompanying materials +* are licensed and made available under the terms and conditions of the BSD License +* which accompanies this distribution. The full text of the license may be found at +* http://opensource.org/licenses/bsd-license.php +* +* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +* +**/

+#include <Library/BaseMemoryLib.h> +#include <Library/DebugLib.h> +#include <Library/IoLib.h> +#include <Library/TimerLib.h> +#include <Library/UefiBootServicesTableLib.h> +#include <Library/UefiLib.h> +#include <Library/UefiRuntimeServicesTableLib.h>

+#include <Protocol/EmbeddedGpio.h> +#include <Protocol/DwUsb.h>

+#include <Hi6220.h>

+#define USB_SEL_GPIO0_3 3 // GPIO 0_3 +#define USB_5V_HUB_EN 7 // GPIO 0_7 +#define USB_ID_DET_GPIO2_5 21 // GPIO 2_5 +#define USB_VBUS_DET_GPIO2_6 22 // GPIO 2_6

+// Jumper on pin5-6 of J15 determines whether boot to fastboot +#define DETECT_J15_FASTBOOT 24 // GPIO 3_0

+STATIC EMBEDDED_GPIO *mGpio;

+STATIC +VOID +HiKeyDetectUsbModeInit (

• IN VOID
• )

+{

• EFI_STATUS Status;
• /* set pullup on both GPIO2_5 & GPIO2_6. It's required for inupt. */
• MmioWrite32 (0xf8001864, 1);
• MmioWrite32 (0xf8001868, 1);

No magic values please, add #defines.

...

• Status = gBS->LocateProtocol (&gEmbeddedGpioProtocolGuid, NULL, (VOID **)&mGpio);
• ASSERT_EFI_ERROR (Status);

This should unconditionally print an error and return if failed. Also, it should probably return error and be handled at the call site, instead of continuing as if nothing had happened.

If this driver has a depex on this protocol, it is reasonable (and idiomatic in edk2) to use this pattern imo

Right, I didn't notice that aspect. On the basis that this is an "impossible" error?

I still don't feel great about _not_ returning before dereferencing a NULL pointer, and I see both ways of dealing with this in edk2.

But I think if the code stays as it is, there should at least be a comment added - I shouldn't need to refer to other files in order to determine whether a condition is impossible or not.

/ Leif

...

...

• Status = mGpio->Set (mGpio, USB_SEL_GPIO0_3, GPIO_MODE_OUTPUT_0);
• ASSERT_EFI_ERROR (Status);
• Status = mGpio->Set (mGpio, USB_5V_HUB_EN, GPIO_MODE_OUTPUT_0);
• ASSERT_EFI_ERROR (Status);
• MicroSecondDelay (1000);

Why this delay? Is a barrier needed? Why was 1ms chosen as the delay?

...

• Status = mGpio->Set (mGpio, USB_ID_DET_GPIO2_5, GPIO_MODE_INPUT);
• ASSERT_EFI_ERROR (Status);
• Status = mGpio->Set (mGpio, USB_VBUS_DET_GPIO2_6, GPIO_MODE_INPUT);
• ASSERT_EFI_ERROR (Status);

+}

+UINTN +HiKeyGetUsbMode (

• IN VOID
• )

+{ +#if 0

Please don't include commented-out code blocks.

...

• EFI_STATUS Status;
• UINTN GpioId, GpioVbus;
• UINTN Value;
• Status = mGpio->Get (mGpio, USB_ID_DET_GPIO2_5, &Value);
• ASSERT_EFI_ERROR (Status);
• GpioId = Value;
• Status = mGpio->Get (mGpio, USB_VBUS_DET_GPIO2_6, &Value);
• ASSERT_EFI_ERROR (Status);
• GpioVbus = Value;

+DEBUG ((DEBUG_ERROR, "#%a, %d, GpioId:%d, GpioVbus:%d\n", __func__, __LINE__, GpioId, GpioVbus));

• if ((GpioId == 1) && (GpioVbus == 0)) {
• return USB_DEVICE_MODE;
• } else if ((GpioId == 0) && (GpioVbus == 1)) {
• return USB_CABLE_NOT_ATTACHED;
• }
• return USB_HOST_MODE;

+#else

• return USB_DEVICE_MODE;

+#endif +}

+EFI_STATUS +HiKeyUsbPhyInit (

• IN UINT8 Mode
• )

+{

• UINTN Value;
• UINT32 Data;
• HiKeyDetectUsbModeInit ();
• //setup clock
• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_CLKEN0, BIT4);

What does BIT4 mean in this context? Can a #define with a more descriptive name be created?

...

• do {

•   Value = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_CLKSTAT0);
  

• } while ((Value & BIT4) == 0);
• //setup phy
• Data = RST0_USBOTG_BUS | RST0_POR_PICOPHY |

•       RST0_USBOTG | RST0_USBOTG_32K;
  

• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_RSTDIS0, Data);
• do {
• Value = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_RSTSTAT0);
• Value &= Data;
• } while (Value);
• Value = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_CTRL4);
• Value &= ~(CTRL4_PICO_SIDDQ | CTRL4_FPGA_EXT_PHY_SEL |

•         CTRL4_OTG_PHY_SEL);
  

• Value |= CTRL4_PICO_VBUSVLDEXT | CTRL4_PICO_VBUSVLDEXTSEL;
• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_CTRL4, Value);
• MicroSecondDelay (1000);

Why this delay? Is a barrier needed? Why was 1ms chosen as the delay?

...

• //If Mode = 1, USB in Device Mode
• //If Mode = 0, USB in Host Mode

You have introduced #defines for these, so don't need to list. Could just say: // Verify that controller is in expected mode

...

• if (Mode == USB_DEVICE_MODE) {
• if (HiKeyGetUsbMode () == USB_DEVICE_MODE) {

•  DEBUG ((DEBUG_ERROR, "usb work as device mode.\n"));
  

• } else {

•  return EFI_INVALID_PARAMETER;
  

• }

May be cleaner written as:

if (HiKeyGetUsbMode () != USB_DEVICE_MODE) { return EFI_INVALID_PARAMETER; }

DEBUG ((DEBUG_ERROR, "usb work as device mode.\n"));

But also, please don't use DEBUG_ERROR for non-error conditions.

...

• Value = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_CTRL5);
  

• Value &= ~CTRL5_PICOPHY_BC_MODE;
  

• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_CTRL5, Value);
  

• MicroSecondDelay (20000);
  

Why this delay? Is a barrier needed? Why was 20ms chosen as the delay?

...

• } else {
• if (HiKeyGetUsbMode () == USB_HOST_MODE) {

•  DEBUG ((DEBUG_ERROR, "usb work as host mode.\n"));
  

Please don't use DEBUG_ERROR for non-error conditions.

...

• } else {

•  return EFI_INVALID_PARAMETER;
  

• }

Ah, but here the pattern repeats again. So actually, you could do:

if (HiKeyGetUsbMode () != Mode) { return EFI_INVALID_PARAMETER; }

once

and then if (Mode == USB_DEVICE_MODE) { ... } else { ... }

...

• /*CTRL5*/
• Data = MmioRead32 (PERI_CTRL_BASE + SC_PERIPH_CTRL5);
• Data &= ~CTRL5_PICOPHY_BC_MODE;
• Data |= CTRL5_USBOTG_RES_SEL | CTRL5_PICOPHY_ACAENB |

•        CTRL5_PICOPHY_VDATDETENB | CTRL5_PICOPHY_DCDENB;
  

• MmioWrite32 (PERI_CTRL_BASE + SC_PERIPH_CTRL5, Data);
• MicroSecondDelay (20000);

Why this delay? Is a barrier needed? Why was 20ms chosen as the delay?

...

• MmioWrite32 (PERI_CTRL_BASE + 0x018, 0x70533483); //EYE_PATTERN

No magic values, please. (What's an eye pattern?)

...

• MicroSecondDelay (5000);

Why this delay? Is a barrier needed? Why was 5ms chosen as the delay?

...

• }
• return EFI_SUCCESS;

+}

+EFI_STATUS +EFIAPI +HiKeyUsbGetLang (

• OUT CHAR16 *Lang,
• OUT UINT8 *Length
• )

+{

• if ((Lang == NULL) || (Length == NULL)) {
• return EFI_INVALID_PARAMETER;
• }
• Lang[0] = 0x409;

No magic values, please.

...

• *Length = sizeof (CHAR16);
• return EFI_SUCCESS;

+}

+EFI_STATUS +EFIAPI +HiKeyUsbGetManuFacturer (

Manufacturer is a single word, so the 'f' should not be capitalised and the #define should be "MANUFACTURER_". (To be corrected also in 3/9, where I missed it on the first pass.)

...

• OUT CHAR16 *ManuFacturer,
• OUT UINT8 *Length
• )

+{

• UINTN VariableSize;
• CHAR16 DataUnicode[MANU_FACTURER_STRING_LENGTH];
• if ((ManuFacturer == NULL) || (Length == NULL)) {
• return EFI_INVALID_PARAMETER;
• }
• VariableSize = MANU_FACTURER_STRING_LENGTH * sizeof (CHAR16);
• ZeroMem (DataUnicode, MANU_FACTURER_STRING_LENGTH * sizeof(CHAR16));
• StrCpy (DataUnicode, L"96Boards");
• CopyMem (ManuFacturer, DataUnicode, VariableSize);
• *Length = VariableSize;
• return EFI_SUCCESS;

+}

OK, the mechanism used here to set manufacturer, product and serial strings is hideously over-complicated.

In fact, ignore my comment that the string lenghts should be corrected also in 3/9 - they should never exist as defines in the first place.

This file holds all of the information about which strings are going into the data structure, and that should not be exported anywhere.

These functions should return a pointer to a string allocated dynamically in this file (or NULL if allocation fails). Since these functions create '0'-terminated strings. the length can then be determined using StrLen.

...

+EFI_STATUS +EFIAPI +HiKeyUsbGetProduct (

• OUT CHAR16 *Product,
• OUT UINT8 *Length
• )

+{

• UINTN VariableSize;
• CHAR16 DataUnicode[PRODUCT_STRING_LENGTH];
• if ((Product == NULL) || (Length == NULL)) {
• return EFI_INVALID_PARAMETER;
• }
• VariableSize = PRODUCT_STRING_LENGTH * sizeof (CHAR16);
• ZeroMem (DataUnicode, PRODUCT_STRING_LENGTH * sizeof(CHAR16));
• StrCpy (DataUnicode, L"HiKey");
• CopyMem (Product, DataUnicode, VariableSize);
• *Length = VariableSize;
• return EFI_SUCCESS;

+}

+EFI_STATUS +EFIAPI +HiKeyUsbGetSerialNo (

• OUT CHAR16 *SerialNo,
• OUT UINT8 *Length
• )

+{

• UINTN VariableSize;
• CHAR16 DataUnicode[SERIAL_STRING_LENGTH];
• if ((SerialNo == NULL) || (Length == NULL)) {
• return EFI_INVALID_PARAMETER;
• }
• VariableSize = SERIAL_STRING_LENGTH * sizeof (CHAR16);
• ZeroMem (DataUnicode, SERIAL_STRING_LENGTH * sizeof(CHAR16));
• StrCpy (DataUnicode, L"0123456789abcdef");

A hardcoded serial number will make you no friends in validation labs. I would suggest that as a start, this fake serial number is broken out to be retreived from a helper function (which for now can return only a made up one). Then at a later date, you can figure out how to provide it with some data that lets you actually tell different devices apart.

...

• CopyMem (SerialNo, DataUnicode, VariableSize);
• *Length = VariableSize;
• return EFI_SUCCESS;

+}

+DW_USB_PROTOCOL mDwUsbDevice = {

• HiKeyUsbGetLang,
• HiKeyUsbGetManuFacturer,
• HiKeyUsbGetProduct,
• HiKeyUsbGetSerialNo,
• HiKeyUsbPhyInit

+};

+EFI_STATUS +EFIAPI +HiKeyUsbEntryPoint (

• IN EFI_HANDLE ImageHandle,
• IN EFI_SYSTEM_TABLE *SystemTable
• )

+{

• EFI_STATUS Status;
• Status = gBS->InstallProtocolInterface (

•              &ImageHandle,
  

•              &gDwUsbProtocolGuid,
  

•              EFI_NATIVE_INTERFACE,
  

•              &mDwUsbDevice
  

•              );
  

• if (EFI_ERROR (Status)) {
• return Status;
• }

The code returns status anyway, so this EFI_ERROR test has no purpose.

...

• return Status;

+} diff --git a/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf b/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf new file mode 100644 index 0000000..1cb70c9 --- /dev/null +++ b/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf @@ -0,0 +1,46 @@ +#/** @file +# +# Copyright (c) 2015-2017, Linaro. All rights reserved. +# +# This program and the accompanying materials +# are licensed and made available under the terms and conditions of the BSD License +# which accompanies this distribution. The full text of the license may be found at +# http://opensource.org/licenses/bsd-license.php +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +# +# +#**/

+[Defines]

• INF_VERSION = 0x00010019
• BASE_NAME = HiKeyUsbDxe
• FILE_GUID = c5c7089e-9b00-448c-8b23-a552688e2833
• MODULE_TYPE = UEFI_DRIVER
• VERSION_STRING = 1.0
• ENTRY_POINT = HiKeyUsbEntryPoint

+[Sources.common]

• HiKeyUsbDxe.c

+[LibraryClasses]

• DebugLib
• IoLib
• TimerLib
• UefiBootServicesTableLib
• UefiDriverEntryPoint

+[Protocols]

• gDwUsbProtocolGuid
• gEfiDriverBindingProtocolGuid
• gEmbeddedGpioProtocolGuid

+[Packages]

• MdePkg/MdePkg.dec
• MdeModulePkg/MdeModulePkg.dec
• EmbeddedPkg/EmbeddedPkg.dec
• OpenPlatformPkg/Drivers/Usb/DwUsbDxe/DwUsbDxe.dec
• OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKey.dec

Please sort packages alphabetically.

...

+[Depex]

• TRUE

-- 2.7.4

On Thu, Feb 09, 2017 at 10:11:49PM +0800, Haojian Zhuang wrote:

Support HiKey Fastboot driver for Fastboot App.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

.../HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.c | 705 +++++++++++++++++++++ .../HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.inf | 61 ++ 2 files changed, 766 insertions(+) create mode 100644 Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.c create mode 100644 Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.inf

diff --git a/Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.c b/Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.c new file mode 100644 index 0000000..78e1d0d --- /dev/null +++ b/Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.c @@ -0,0 +1,705 @@ +/** @file

Based on ArmVExpressFastBoot.c.

It may not need to happen for this version, but certainly if we are adding more platforms in the future, we should look into creating a generic implementation with platform-specific hooks. There is way too much code duplication for my liking here.

(And, yes, I see you have fixed some issues with the original here :)

• Copyright (c) 2014, ARM Ltd. All rights reserved.<BR>
• Copyright (c) 2015-2017, Linaro. All rights reserved.
• This program and the accompanying materials
• are licensed and made available under the terms and conditions of the BSD License
• which accompanies this distribution. The full text of the license may be found at
• http://opensource.org/licenses/bsd-license.php
• THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
• WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+**/

+/*

• Implementation of the Android Fastboot Platform protocol, to be used by the
• Fastboot UEFI application, for Hisilicon HiKey platform.

+*/

+#include <Protocol/AndroidFastbootPlatform.h> +#include <Protocol/BlockIo.h> +#include <Protocol/DiskIo.h> +#include <Protocol/EraseBlock.h> +#include <Protocol/SimpleTextOut.h>

+#include <Library/BaseLib.h> +#include <Library/BaseMemoryLib.h> +#include <Library/DebugLib.h> +#include <Library/DevicePathLib.h> +#include <Library/MemoryAllocationLib.h> +#include <Library/UefiBootServicesTableLib.h> +#include <Library/UefiRuntimeServicesTableLib.h> +#include <Library/PrintLib.h> +#include <Library/TimerLib.h>

+#include <Guid/HiKeyVariable.h>

+#define FLASH_DEVICE_PATH_SIZE(DevPath) ( GetDevicePathSize (DevPath) - \

•                                        sizeof (EFI_DEVICE_PATH_PROTOCOL))
  

+#define PARTITION_NAME_MAX_LENGTH 72/2

+#define IS_ALPHA(Char) (((Char) <= L'z' && (Char) >= L'a') || \

•                    ((Char) <= L'Z' && (Char) >= L'Z'))
  

+#define IS_HEXCHAR(Char) (((Char) <= L'9' && (Char) >= L'0') || \

•                      IS_ALPHA(Char))
  

+#define SERIAL_NUMBER_LENGTH 16 +#define BOOT_DEVICE_LENGTH 16

+#define HIKEY_ERASE_SIZE (16 * 1024 * 1024) +#define HIKEY_ERASE_BLOCKS (HIKEY_ERASE_SIZE / EFI_PAGE_SIZE)

+typedef struct _FASTBOOT_PARTITION_LIST {

• LIST_ENTRY Link;
• CHAR16 PartitionName[PARTITION_NAME_MAX_LENGTH];
• EFI_HANDLE PartitionHandle;
• EFI_LBA Lba;

+} FASTBOOT_PARTITION_LIST;

+STATIC LIST_ENTRY mPartitionListHead;

+STATIC EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *mTextOut;

+/*

• Helper to free the partition list

+*/ +STATIC +VOID +FreePartitionList (

• VOID
• )

+{

• FASTBOOT_PARTITION_LIST *Entry;
• FASTBOOT_PARTITION_LIST *NextEntry;
• Entry = (FASTBOOT_PARTITION_LIST *) GetFirstNode (&mPartitionListHead);
• while (!IsNull (&mPartitionListHead, &Entry->Link)) {
• NextEntry = (FASTBOOT_PARTITION_LIST *) GetNextNode (&mPartitionListHead, &Entry->Link);
• RemoveEntryList (&Entry->Link);
• FreePool (Entry);
• Entry = NextEntry;
• }

+} +/*

• Read the PartitionName fields from the GPT partition entries, putting them
• into an allocated array that should later be freed.

+*/ +STATIC +EFI_STATUS +ReadPartitionEntries (

• IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
• OUT EFI_PARTITION_ENTRY **PartitionEntries
• )

+{

• UINTN EntrySize;
• UINTN NumEntries;
• UINTN BufferSize;
• UINT32 MediaId;
• EFI_PARTITION_TABLE_HEADER *GptHeader;
• EFI_STATUS Status;
• MediaId = BlockIo->Media->MediaId;
• //
• // Read size of Partition entry and number of entries from GPT header
• //
• GptHeader = AllocatePool (BlockIo->Media->BlockSize);
• if (GptHeader == NULL) {
• return EFI_OUT_OF_RESOURCES;
• }
• Status = BlockIo->ReadBlocks (BlockIo, MediaId, 1, BlockIo->Media->BlockSize, (VOID *) GptHeader);

The last parameter to ReadBlocks is a (VOID *) - is the explicit cast really needed?

• if (EFI_ERROR (Status)) {
• return Status;
• }
• // Check there is a GPT on the media
• if (GptHeader->Header.Signature != EFI_PTAB_HEADER_ID ||

•  GptHeader->MyLBA != 1) {
  

• DEBUG ((DEBUG_ERROR,

•  "Fastboot platform: No GPT on flash. "
  

•  "Fastboot on Versatile Express does not support MBR.\n"
  

This is not Versatile Express.

•  ));
  

• return EFI_DEVICE_ERROR;
• }
• EntrySize = GptHeader->SizeOfPartitionEntry;
• NumEntries = GptHeader->NumberOfPartitionEntries;
• FreePool (GptHeader);
• ASSERT (EntrySize != 0);
• ASSERT (NumEntries != 0);
• BufferSize = ALIGN_VALUE (EntrySize * NumEntries, BlockIo->Media->BlockSize);
• *PartitionEntries = AllocatePool (BufferSize);
• if (PartitionEntries == NULL) {
• return EFI_OUT_OF_RESOURCES;
• }
• Status = BlockIo->ReadBlocks (BlockIo, MediaId, 2, BufferSize, (VOID *) *PartitionEntries);
• if (EFI_ERROR (Status)) {
• FreePool (PartitionEntries);
• return Status;
• }
• return Status;

+}

+/*

• Initialise: Open the Android NVM device and find the partitions on it. Save them in
• a list along with the "PartitionName" fields for their GPT entries.
• We will use these partition names as the key in
• HiKeyFastbootPlatformFlashPartition.

+*/

STATIC?

+EFI_STATUS +HiKeyFastbootPlatformInit (

• VOID
• )

+{

• EFI_STATUS Status;
• EFI_DEVICE_PATH_PROTOCOL *FlashDevicePath;
• EFI_DEVICE_PATH_PROTOCOL *FlashDevicePathDup;
• EFI_DEVICE_PATH_PROTOCOL *DevicePath;
• EFI_DEVICE_PATH_PROTOCOL *NextNode;
• HARDDRIVE_DEVICE_PATH *PartitionNode;
• UINTN NumHandles;
• EFI_HANDLE *AllHandles;
• UINTN LoopIndex;
• EFI_HANDLE FlashHandle;
• EFI_BLOCK_IO_PROTOCOL *FlashBlockIo;
• EFI_PARTITION_ENTRY *PartitionEntries;
• FASTBOOT_PARTITION_LIST *Entry;
• InitializeListHead (&mPartitionListHead);
• Status = gBS->LocateProtocol (&gEfiSimpleTextOutProtocolGuid, NULL, (VOID **) &mTextOut);

Why is this implementation explicitly accessing EfiSimpleTextOutProtocol instead of printing to console?

• if (EFI_ERROR (Status)) {
• DEBUG ((DEBUG_ERROR,

•  "Fastboot platform: Couldn't open Text Output Protocol: %r\n", Status
  

•  ));
  

• return Status;
• }
• //
• // Get EFI_HANDLES for all the partitions on the block devices pointed to by
• // PcdFastbootFlashDevicePath, also saving their GPT partition labels.
• // There's no way to find all of a device's children, so we get every handle
• // in the system supporting EFI_BLOCK_IO_PROTOCOL and then filter out ones
• // that don't represent partitions on the flash device.
• //
• FlashDevicePath = ConvertTextToDevicePath ((CHAR16*)FixedPcdGetPtr (PcdAndroidFastbootNvmDevicePath));
• //
• // Open the Disk IO protocol on the flash device - this will be used to read
• // partition names out of the GPT entries
• //
• // Create another device path pointer because LocateDevicePath will modify it.
• FlashDevicePathDup = FlashDevicePath;
• Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &FlashDevicePathDup, &FlashHandle);
• if (EFI_ERROR (Status)) {
• DEBUG ((DEBUG_ERROR, "Warning: Couldn't locate Android NVM device (status: %r)\n", Status));
• // Failing to locate partitions should not prevent to do other Android FastBoot actions
• return EFI_SUCCESS;
• }
• Status = gBS->OpenProtocol (

•              FlashHandle,
  

•              &gEfiBlockIoProtocolGuid,
  

•              (VOID **) &FlashBlockIo,
  

•              gImageHandle,
  

•              NULL,
  

•              EFI_OPEN_PROTOCOL_GET_PROTOCOL
  

•              );
  

• if (EFI_ERROR (Status)) {
• DEBUG ((DEBUG_ERROR, "Fastboot platform: Couldn't open Android NVM device (status: %r)\n", Status));
• return EFI_DEVICE_ERROR;
• }
• // Read the GPT partition entry array into memory so we can get the partition names
• Status = ReadPartitionEntries (FlashBlockIo, &PartitionEntries);
• if (EFI_ERROR (Status)) {
• DEBUG ((DEBUG_ERROR, "Warning: Failed to read partitions from Android NVM device (status: %r)\n", Status));
• // Failing to locate partitions should not prevent to do other Android FastBoot actions
• return EFI_SUCCESS;
• }
• // Get every Block IO protocol instance installed in the system
• Status = gBS->LocateHandleBuffer (

•              ByProtocol,
  

•              &gEfiBlockIoProtocolGuid,
  

•              NULL,
  

•              &NumHandles,
  

•              &AllHandles
  

•              );
  

• ASSERT_EFI_ERROR (Status);
• // Filter out handles that aren't children of the flash device
• for (LoopIndex = 0; LoopIndex < NumHandles; LoopIndex++) {
• // Get the device path for the handle
• Status = gBS->OpenProtocol (

•                AllHandles[LoopIndex],
  

•                &gEfiDevicePathProtocolGuid,
  

•                (VOID **) &DevicePath,
  

•                gImageHandle,
  

•                NULL,
  

•                EFI_OPEN_PROTOCOL_GET_PROTOCOL
  

•                );
  

• ASSERT_EFI_ERROR (Status);

Could the bit from here

• // Check if it is a sub-device of the flash device
• if (!CompareMem (DevicePath, FlashDevicePath, FLASH_DEVICE_PATH_SIZE (FlashDevicePath))) {

•  // Device path starts with path of flash device. Check it isn't the flash
  

•  // device itself.
  

•  NextNode = NextDevicePathNode (DevicePath);
  

•  if (IsDevicePathEndType (NextNode)) {
  

•    // Create entry
  

•    Entry = AllocatePool (sizeof (FASTBOOT_PARTITION_LIST));
  

•    if (Entry == NULL) {
  

•      Status = EFI_OUT_OF_RESOURCES;
  

•      FreePartitionList ();
  

•      goto Exit;
  

•    }
  

•    // Copy handle and partition name
  

•    Entry->PartitionHandle = AllHandles[LoopIndex];
  

•    StrCpy (Entry->PartitionName, L"ptable");
  

•    InsertTailList (&mPartitionListHead, &Entry->Link);
  

•    continue;
  

•  }
  

•  // Assert that this device path node represents a partition.
  

•  ASSERT (NextNode->Type == MEDIA_DEVICE_PATH &&
  

•          NextNode->SubType == MEDIA_HARDDRIVE_DP);
  

•  PartitionNode = (HARDDRIVE_DEVICE_PATH *) NextNode;
  

•  // Assert that the partition type is GPT. ReadPartitionEntries checks for
  

•  // presence of a GPT, so we should never find MBR partitions.
  

•  // ("MBRType" is a misnomer - this field is actually called "Partition
  

•  //  Format")
  

•  ASSERT (PartitionNode->MBRType == MBR_TYPE_EFI_PARTITION_TABLE_HEADER);
  

•  // The firmware may install a handle for "partition 0", representing the
  

•  // whole device. Ignore it.
  

•  if (PartitionNode->PartitionNumber == 0) {
  

•    continue;
  

•  }
  

To here, roughly, be turned into a helper function.

And the bit from here

•  //
  

•  // Add the partition handle to the list
  

•  //
  

•  // Create entry
  

•  Entry = AllocatePool (sizeof (FASTBOOT_PARTITION_LIST));
  

•  if (Entry == NULL) {
  

•    Status = EFI_OUT_OF_RESOURCES;
  

•    FreePartitionList ();
  

•    goto Exit;
  

•  }
  

•  // Copy handle and partition name
  

•  Entry->PartitionHandle = AllHandles[LoopIndex];
  

•  StrnCpy (
  

•    Entry->PartitionName,
  

•    PartitionEntries[PartitionNode->PartitionNumber - 1].PartitionName, // Partition numbers start from 1.
  

•    PARTITION_NAME_MAX_LENGTH
  

•    );
  

•  Entry->Lba = PartitionEntries[PartitionNode->PartitionNumber - 1].StartingLBA;
  

•  InsertTailList (&mPartitionListHead, &Entry->Link);
  

•  // Print a debug message if the partition label is empty or looks like
  

•  // garbage.
  

•  if (!IS_ALPHA (Entry->PartitionName[0])) {
  

•    DEBUG ((DEBUG_ERROR,
  

•      "Warning: Partition %d doesn't seem to have a GPT partition label. "
  

•      "You won't be able to flash it with Fastboot.\n",
  

•      PartitionNode->PartitionNumber
  

•      ));
  

•  }
  

• }
• }

to here, be turned into another helper function please?

+Exit:

• FreePool (PartitionEntries);
• FreePool (FlashDevicePath);
• FreePool (AllHandles);
• return Status;

+}

STATIC?

+VOID +HiKeyFastbootPlatformUnInit (

• VOID
• )

+{

• FreePartitionList ();

+}

STATIC?

+EFI_STATUS +HiKeyFastbootPlatformFlashPartition (

• IN CHAR8 *PartitionName,
• IN UINTN Size,
• IN VOID *Image
• )

+{

• EFI_STATUS Status;
• EFI_BLOCK_IO_PROTOCOL *BlockIo;
• EFI_DISK_IO_PROTOCOL *DiskIo;
• UINT32 MediaId;
• UINTN PartitionSize;
• FASTBOOT_PARTITION_LIST *Entry;
• CHAR16 PartitionNameUnicode[60];
• BOOLEAN PartitionFound;

+#ifdef SPARSE_HEADER

• SPARSE_HEADER *SparseHeader;
• CHUNK_HEADER *ChunkHeader;
• UINTN Offset = 0;
• UINT32 Chunk, EntrySize, EntryOffset;
• UINT32 *FillVal, TmpCount, FillBuf[1024];

+#else

• UINT32 EntrySize, EntryOffset;

+#endif

• VOID *Buffer;
• AsciiStrToUnicodeStr (PartitionName, PartitionNameUnicode);
• PartitionFound = FALSE;
• Entry = (FASTBOOT_PARTITION_LIST *) GetFirstNode (&(mPartitionListHead));
• while (!IsNull (&mPartitionListHead, &Entry->Link)) {
• // Search the partition list for the partition named by PartitionName
• if (StrCmp (Entry->PartitionName, PartitionNameUnicode) == 0) {

•  PartitionFound = TRUE;
  

•  break;
  

• }
• Entry = (FASTBOOT_PARTITION_LIST *) GetNextNode (&mPartitionListHead, &(Entry)->Link);
• }
• if (!PartitionFound) {
• return EFI_NOT_FOUND;
• }
• Status = gBS->OpenProtocol (

•              Entry->PartitionHandle,
  

•              &gEfiBlockIoProtocolGuid,
  

•              (VOID **) &BlockIo,
  

•              gImageHandle,
  

•              NULL,
  

•              EFI_OPEN_PROTOCOL_GET_PROTOCOL
  

•              );
  

• if (EFI_ERROR (Status)) {
• DEBUG ((DEBUG_ERROR, "Fastboot platform: couldn't open Block IO for flash: %r\n", Status));
• return EFI_NOT_FOUND;
• }

+#ifdef SPARSE_HEADER

• SparseHeader=(SPARSE_HEADER *)Image;

Spaces around '='.

• if (SparseHeader->Magic == SPARSE_HEADER_MAGIC) {
• DEBUG ((DEBUG_INFO, "Sparse Magic: 0x%x Major: %d Minor: %d fhs: %d chs: %d bs: %d tbs: %d tcs: %d checksum: %d \n",

•            SparseHeader->Magic, SparseHeader->MajorVersion, SparseHeader->MinorVersion,  SparseHeader->FileHeaderSize,
  

•            SparseHeader->ChunkHeaderSize, SparseHeader->BlockSize, SparseHeader->TotalBlocks,
  

•            SparseHeader->TotalChunks, SparseHeader->ImageChecksum));
  

• if (SparseHeader->MajorVersion != 1) {

•    DEBUG ((DEBUG_ERROR, "Sparse image version %d.%d not supported.\n",
  

•                SparseHeader->MajorVersion, SparseHeader->MinorVersion));
  

•    return EFI_INVALID_PARAMETER;
  

• }
• Size = SparseHeader->BlockSize * SparseHeader->TotalBlocks;
• }

+#endif

• // Check image will fit on device
• PartitionSize = (BlockIo->Media->LastBlock + 1) * BlockIo->Media->BlockSize;
• if (PartitionSize < Size) {
• DEBUG ((DEBUG_ERROR, "Partition not big enough.\n"));
• DEBUG ((DEBUG_ERROR, "Partition Size:\t%ld\nImage Size:\t%ld\n", PartitionSize, Size));
• return EFI_VOLUME_FULL;
• }
• MediaId = BlockIo->Media->MediaId;
• Status = gBS->OpenProtocol (

•              Entry->PartitionHandle,
  

•              &gEfiDiskIoProtocolGuid,
  

•              (VOID **) &DiskIo,
  

•              gImageHandle,
  

•              NULL,
  

•              EFI_OPEN_PROTOCOL_GET_PROTOCOL
  

•              );
  

• ASSERT_EFI_ERROR (Status);

+#ifdef SPARSE_HEADER

• if (SparseHeader->Magic == SPARSE_HEADER_MAGIC) {
• CHAR16 OutputString[64];

Why 64?

• UINTN ChunkPrintDensity =

•    SparseHeader->TotalChunks > 1600 ? SparseHeader->TotalChunks / 200 : 32;
  

What is 200? What is 32?

• Image += SparseHeader->FileHeaderSize;
• for (Chunk = 0; Chunk < SparseHeader->TotalChunks; Chunk++) {

•  UINTN WriteSize;
  

•  ChunkHeader = (CHUNK_HEADER *)Image;
  

•  // Show progress. Don't do it for every packet as outputting text
  

•  // might be time consuming. ChunkPrintDensity is calculated to
  

•  // provide an update every half percent change for large
  

•  // downloads.
  

•  if (Chunk % ChunkPrintDensity == 0) {
  

•    UnicodeSPrint(OutputString, sizeof(OutputString),
  

•                  L"\r%5d / %5d chunks written (%d%%)", Chunk,
  

•                  SparseHeader->TotalChunks,
  

•                 (Chunk * 100) / SparseHeader->TotalChunks);
  

What is 100?

•    mTextOut->OutputString(mTextOut, OutputString);
  

•  }
  

•  DEBUG ((DEBUG_INFO, "Chunk #%d - Type: 0x%x Size: %d TotalSize: %d Offset %d\n",
  

•              (Chunk+1), ChunkHeader->ChunkType, ChunkHeader->ChunkSize,
  

(Chunk + 1) Alsthough, that said - Printing "Chunk #%d", and substituting %d with (Chunk + 1), is quite counterintuitive. Why is this done?

•              ChunkHeader->TotalSize, Offset));
  

•  Image += sizeof(CHUNK_HEADER);
  

•  WriteSize=(SparseHeader->BlockSize) * ChunkHeader->ChunkSize;
  

•  switch (ChunkHeader->ChunkType) {
  

•    case CHUNK_TYPE_RAW:
  

•      DEBUG ((DEBUG_INFO, "Writing %d at Offset %d\n", WriteSize, Offset));
  

•      Status = DiskIo->WriteDisk (DiskIo, MediaId, Offset, WriteSize, Image);
  

•      if (EFI_ERROR (Status)) {
  

•        return Status;
  

•      }
  

•      Image+=WriteSize;
  

•      break;
  

•    case CHUNK_TYPE_FILL:
  

•      //Assume fillVal is 0, and we can skip here
  

•      FillVal = (UINT32 *)Image;
  

•      Image += sizeof(UINT32);
  

•      if (*FillVal != 0){
  

•        mTextOut->OutputString(mTextOut, OutputString);
  

•        for(TmpCount = 0; TmpCount < 1024; TmpCount++){
  

•            FillBuf[TmpCount] = *FillVal;
  

•        }
  

•        for (TmpCount= 0; TmpCount < WriteSize; TmpCount += sizeof(FillBuf)) {
  

•            if ((WriteSize - TmpCount) < sizeof(FillBuf)) {
  

•              Status = DiskIo->WriteDisk (DiskIo, MediaId, Offset + TmpCount, WriteSize - TmpCount, FillBuf);
  

•            } else {
  

•              Status = DiskIo->WriteDisk (DiskIo, MediaId, Offset + TmpCount, sizeof(FillBuf), FillBuf);
  

•            }
  

•            if (EFI_ERROR (Status)) {
  

•                return Status;
  

•            }
  

•        }
  

•      }
  

•      break;
  

•    case CHUNK_TYPE_DONT_CARE:
  

•      break;
  

•    case CHUNK_TYPE_CRC32:
  

•      break;
  

•    default:
  

•      DEBUG ((DEBUG_ERROR, "Unknown Chunk Type: 0x%x", ChunkHeader->ChunkType));
  

•      return EFI_PROTOCOL_ERROR;
  

•  }
  

•  Offset += WriteSize;
  

• }
• UnicodeSPrint(OutputString, sizeof(OutputString),

Space before (.

•              L"\r%5d / %5d chunks written (100%%)\r\n",
  

•              SparseHeader->TotalChunks, SparseHeader->TotalChunks);
  

• mTextOut->OutputString(mTextOut, OutputString);
• } else {

+#endif

• if (AsciiStrCmp (PartitionName, "ptable") == 0) {

•  Buffer = Image;
  

•  if (AsciiStrnCmp (Buffer, "ENTRYHDR", 8) != 0) {
  

Don't calculate the string length. You are bounding it _anyway_ on the length of the static string - it would only have a benefit if you were bounding it on the length of Buffer. So in these instances, simply use AsciiStrCmp().

•    DEBUG ((DEBUG_ERROR, "unknown ptable image\n"));
  

•    return EFI_UNSUPPORTED;
  

•  }
  

•  Buffer += 8;
  

Add a #define.

•  if (AsciiStrnCmp (Buffer, "primary", 7) != 0) {
  

•    DEBUG ((DEBUG_ERROR, "unknown ptable image\n"));
  

•    return EFI_UNSUPPORTED;
  

•  }
  

•  Buffer += 8;
  

Add a #define.

•  EntryOffset = *(UINT32 *)Buffer * BlockIo->Media->BlockSize;
  

•  Buffer += 4;
  

Use sizeof (UINT32) instead?

•  EntrySize = *(UINT32 *)Buffer * BlockIo->Media->BlockSize;
  

•  if ((EntrySize + 512) > Size) {
  

A #define for that 512, please.

•    DEBUG ((DEBUG_ERROR, "Entry size doesn't match\n"));
  

•    return EFI_UNSUPPORTED;
  

•  }
  

•  Buffer = Image + 512;
  

Same #define.

•  Status = DiskIo->WriteDisk (DiskIo, MediaId, EntryOffset, EntrySize, Buffer);
  

•  if (EFI_ERROR (Status)) {
  

•    return Status;
  

•  }
  

•  Buffer = Image + 16 + 12;
  

What are these 16 and 12?

•  if (AsciiStrnCmp (Buffer, "ENTRYHDR", 8) != 0)
  

AsciiStrCmp()

•    return Status;
  

•  Buffer += 8;
  

#define

•  if (AsciiStrnCmp (Buffer, "second", 6) != 0)
  

AsciiStrCmp()

•    return Status;
  

•  Buffer += 8;
  

#define

•  EntryOffset = *(UINT32 *)Buffer * BlockIo->Media->BlockSize;
  

•  Buffer += 4;
  

sizeof (UINT32)

•  EntrySize = *(UINT32 *)Buffer * BlockIo->Media->BlockSize;
  

•  if ((EntrySize + 512) > Size) {
  

#define

•    DEBUG ((DEBUG_ERROR, "Entry size doesn't match\n"));
  

•    return EFI_UNSUPPORTED;
  

•  }
  

•  Buffer = Image + 512;
  

#define

•  Status = DiskIo->WriteDisk (DiskIo, MediaId, EntryOffset, EntrySize, Buffer);
  

• } else {

This bit deserves a short comment.

•  Status = DiskIo->WriteDisk (DiskIo, MediaId, 0, Size, Image);
  

• }
• if (EFI_ERROR (Status)) {

•  return Status;
  

• }

+#ifdef SPARSE_HEADER

• }

+#endif

• BlockIo->FlushBlocks(BlockIo);
• MicroSecondDelay (50000);

Why this delay? Do we need a barrier? Why is 50ms a suitable time to delay?

• return Status;

+}

STATIC?

+EFI_STATUS +HiKeyFastbootPlatformErasePartition (

• IN CHAR8 *PartitionName
• )

+{

• return EFI_SUCCESS;

+}

STATIC?

+EFI_STATUS +HiKeyFastbootPlatformGetVar (

• IN CHAR8 *Name,
• OUT CHAR8 *Value
• )

+{

• EFI_STATUS Status;
• EFI_BLOCK_IO_PROTOCOL *BlockIo;
• UINT64 PartitionSize;
• FASTBOOT_PARTITION_LIST *Entry;
• CHAR16 PartitionNameUnicode[60];

Why 60?

• BOOLEAN PartitionFound;
• CHAR16 DataUnicode[17];

Why 17?

• UINTN VariableSize;
• if (!AsciiStrCmp (Name, "max-download-size")) {
• AsciiStrCpy (Value, FixedPcdGetPtr (PcdArmFastbootFlashLimit));
• } else if (!AsciiStrCmp (Name, "product")) {
• AsciiStrCpy (Value, FixedPcdGetPtr (PcdFirmwareVendor));
• } else if (!AsciiStrCmp (Name, "serialno")) {
• VariableSize = 17 * sizeof (CHAR16);

No magic numbers.

• Status = gRT->GetVariable (

•                (CHAR16 *)L"SerialNo",
  

•                &gHiKeyVariableGuid,
  

•                NULL,
  

•                &VariableSize,
  

•                &DataUnicode
  

•                );
  

• if (EFI_ERROR (Status)) {

•  *Value = '\0';
  

•  return EFI_NOT_FOUND;
  

• }
• DataUnicode[(VariableSize / sizeof(CHAR16)) - 1] = '\0';
• UnicodeStrToAsciiStr (DataUnicode, Value);
• } else if ( !AsciiStrnCmp (Name, "partition-size", 14)) {

No magic values. (Just use AsciiStrCmp().)

• AsciiStrToUnicodeStr ((Name + 15), PartitionNameUnicode);

No magic values.

• PartitionFound = FALSE;
• Entry = (FASTBOOT_PARTITION_LIST *) GetFirstNode (&(mPartitionListHead));
• while (!IsNull (&mPartitionListHead, &Entry->Link)) {

•  // Search the partition list for the partition named by PartitionName
  

•  if (StrCmp (Entry->PartitionName, PartitionNameUnicode) == 0) {
  

•    PartitionFound = TRUE;
  

•    break;
  

•  }
  

• Entry = (FASTBOOT_PARTITION_LIST *) GetNextNode (&mPartitionListHead, &(Entry)->Link);
  

• }
• if (!PartitionFound) {

•  *Value = '\0';
  

•  return EFI_NOT_FOUND;
  

• }
• Status = gBS->OpenProtocol (

•                Entry->PartitionHandle,
  

•                &gEfiBlockIoProtocolGuid,
  

•                (VOID **) &BlockIo,
  

•                gImageHandle,
  

•                NULL,
  

•                EFI_OPEN_PROTOCOL_GET_PROTOCOL
  

•                );
  

• if (EFI_ERROR (Status)) {

•  DEBUG ((DEBUG_ERROR, "Fastboot platform: couldn't open Block IO for flash: %r\n", Status));
  

•  *Value = '\0';
  

•  return EFI_NOT_FOUND;
  

• }
• PartitionSize = (BlockIo->Media->LastBlock + 1) * BlockIo->Media->BlockSize;
• DEBUG ((DEBUG_ERROR, "Fastboot platform: check for partition-size:%a 0X%llx\n", Name, PartitionSize ));
• AsciiSPrint (Value, 12, "0x%llx", PartitionSize);

No magic values.

• } else if ( !AsciiStrnCmp (Name, "partition-type", 14)) {

No magic values. (Just use AsciiStrCmp().)

•  DEBUG ((DEBUG_ERROR, "Fastboot platform: check for partition-type:%a\n", (Name + 15) ));
  

No magic values.

• if ( !AsciiStrnCmp ( (Name + 15) , "system", 6) || !AsciiStrnCmp ( (Name + 15) , "userdata", 8)

•        || !AsciiStrnCmp  ( (Name + 15) , "cache", 5)) {
  

No magic values.

•  AsciiStrCpy (Value, "ext4");
  

• } else {

•  AsciiStrCpy (Value, "raw");
  

• }
• } else {
• *Value = '\0';
• }
• return EFI_SUCCESS;

+}

STATIC?

+EFI_STATUS +HiKeyFastbootPlatformOemCommand (

• IN CHAR8 *Command
• )

+{

• if (AsciiStrCmp (Command, "Demonstrate") == 0) {
• DEBUG ((DEBUG_ERROR, "ARM OEM Fastboot command 'Demonstrate' received.\n"));
• return EFI_SUCCESS;
• } else {
• DEBUG ((DEBUG_ERROR,

•  "HiKey: Unrecognised Fastboot OEM command: %s\n",
  

•  Command
  

•  ));
  

• return EFI_NOT_FOUND;
• }

+}

+FASTBOOT_PLATFORM_PROTOCOL mPlatformProtocol = {

STATIC?

• HiKeyFastbootPlatformInit,
• HiKeyFastbootPlatformUnInit,
• HiKeyFastbootPlatformFlashPartition,
• HiKeyFastbootPlatformErasePartition,
• HiKeyFastbootPlatformGetVar,
• HiKeyFastbootPlatformOemCommand

+};

+EFI_STATUS +EFIAPI +HiKeyFastbootPlatformEntryPoint (

• IN EFI_HANDLE ImageHandle,
• IN EFI_SYSTEM_TABLE *SystemTable
• )

+{

• return gBS->InstallProtocolInterface (

•            &ImageHandle,
  

•            &gAndroidFastbootPlatformProtocolGuid,
  

•            EFI_NATIVE_INTERFACE,
  

•            &mPlatformProtocol
  

•            );
  

+} diff --git a/Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.inf b/Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.inf new file mode 100644 index 0000000..8afd096 --- /dev/null +++ b/Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.inf @@ -0,0 +1,61 @@ +#/** @file +# +# Copyright (c) 2014, ARM Ltd. All rights reserved.<BR> +# Copyright (c) 2015-2017, Linaro. All rights reserved. +# +# This program and the accompanying materials +# are licensed and made available under the terms and conditions of the BSD License +# which accompanies this distribution. The full text of the license may be found at +# http://opensource.org/licenses/bsd-license.php +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +# +# +#**/

+[Defines]

• INF_VERSION = 0x00010019
• BASE_NAME = HiKeyFastbootDxe
• FILE_GUID = 8e335c38-c4e1-494e-8011-37a858d9763d
• MODULE_TYPE = UEFI_DRIVER
• VERSION_STRING = 1.0
• ENTRY_POINT = HiKeyFastbootPlatformEntryPoint

+[Sources.common]

• HiKeyFastbootDxe.c

+[LibraryClasses]

• BaseLib
• BaseMemoryLib
• DebugLib
• DevicePathLib
• MemoryAllocationLib
• PcdLib
• UefiBootServicesTableLib
• UefiRuntimeServicesTableLib
• UefiDriverEntryPoint
• TimerLib

Please sort LibraryClasses alphabetically (only TimerLib is out of order).

+[Protocols]

• gAndroidFastbootPlatformProtocolGuid
• gEfiBlockIoProtocolGuid
• gEfiDiskIoProtocolGuid
• gEfiSimpleTextOutProtocolGuid
• gEfiEraseBlockProtocolGuid

Plese sort Protocols alphabetically.

+[Packages]

• EmbeddedPkg/EmbeddedPkg.dec
• MdePkg/MdePkg.dec
• MdeModulePkg/MdeModulePkg.dec
• ArmPlatformPkg/ArmPlatformPkg.dec
• ArmPlatformPkg/ArmVExpressPkg/ArmVExpressPkg.dec
• ArmPkg/ArmPkg.dec
• OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKey.dec

Please sort Packages alphabetically.

+[Guids]

• gHiKeyVariableGuid

+[Pcd]

• gArmPlatformTokenSpaceGuid.PcdFirmwareVendor
• gHiKeyTokenSpaceGuid.PcdAndroidFastbootNvmDevicePath
• gHiKeyTokenSpaceGuid.PcdArmFastbootFlashLimit

-- 2.7.4

On Thu, Feb 09, 2017 at 10:11:50PM +0800, Haojian Zhuang wrote:

Add the platform boot manager to boot Android Fastboot.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

OpenPlatformPkg.dec | 1 + .../Library/PlatformBootManagerLib/PlatformBm.c | 485 +++++++++++++++ .../Library/PlatformBootManagerLib/PlatformBm.h | 59 ++ .../PlatformBootManagerLib.inf | 88 +++ .../Library/PlatformBootManagerLib/QuietBoot.c | 680 +++++++++++++++++++++ 5 files changed, 1313 insertions(+) create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.h create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/QuietBoot.c

diff --git a/OpenPlatformPkg.dec b/OpenPlatformPkg.dec index 2db143d..e82b4d4 100644 --- a/OpenPlatformPkg.dec +++ b/OpenPlatformPkg.dec @@ -39,5 +39,6 @@ [PcdsFixedAtBuild] ## Indicates the size in MB for RAM disk. gOpenPlatformTokenSpaceGuid.PcdRamDiskMaxSize|0|UINT32|0x00000001

• gOpenPlatformTokenSpaceGuid.PcdAndroidFastbootFile|{ 0x2a, 0x50, 0x88, 0x95, 0x70, 0x53, 0xe3, 0x11, 0x86, 0x31, 0xd7, 0xc5, 0x95, 0x13, 0x64, 0xc8 }|VOID*|0x00000002

[PcdsFeatureFlag] diff --git a/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c new file mode 100644 index 0000000..03b764d --- /dev/null +++ b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c @@ -0,0 +1,485 @@ +/** @file

• Implementation for PlatformBootManagerLib library class interfaces.

From ArmPkg/Library/PlatformBootManagerLib/PlatformBm.c

Like the fastboot duplication, this also looks like a lot of opportunity for unifying into a common version.

It looks to me like the only differences from the original are: - Deleting code specific to PCI systems. - Deleting the Connect() function (unused with PCI bits gone). - Updating EFI_D_ to DEBUG_ in order to keep PatchCheck.py happy. - A call to PlatformRegisterFvBootOption().

Ard: would you be happy for us to start introducing a few compile-time settings that would let this platform just reuse the ArmPkg Platform boot manager?

I.e., CONFIG_PCI and CONFIG_ANDROID_FASTBOOT.

That would also be an excellent starting point for commonalizing config fragments.

/ Leif

• Copyright (C) 2015-2016, Red Hat, Inc.
• Copyright (c) 2014, ARM Ltd. All rights reserved.<BR>
• Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
• Copyright (c) 2016-2017, Linaro Ltd. All rights reserved.<BR>
• This program and the accompanying materials are licensed and made available
• under the terms and conditions of the BSD License which accompanies this
• distribution. The full text of the license may be found at
• http://opensource.org/licenses/bsd-license.php
• THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
• WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+**/

+#include <Library/DevicePathLib.h> +#include <Library/PcdLib.h> +#include <Library/UefiBootManagerLib.h> +#include <Library/UefiLib.h> +#include <Protocol/DevicePath.h> +#include <Protocol/GraphicsOutput.h> +#include <Protocol/LoadedImage.h> +#include <Guid/EventGroup.h> +#include <Guid/TtyTerm.h>

+#include "PlatformBm.h"

+#define DP_NODE_LEN(Type) { (UINT8)sizeof (Type), (UINT8)(sizeof (Type) >> 8) }

+#pragma pack (1) +typedef struct {

• VENDOR_DEVICE_PATH SerialDxe;
• UART_DEVICE_PATH Uart;
• VENDOR_DEFINED_DEVICE_PATH TermType;
• EFI_DEVICE_PATH_PROTOCOL End;

+} PLATFORM_SERIAL_CONSOLE; +#pragma pack ()

+#define SERIAL_DXE_FILE_GUID { \

•      0xD3987D4B, 0x971A, 0x435F, \
  

•      { 0x8C, 0xAF, 0x49, 0x67, 0xEB, 0x62, 0x72, 0x41 } \
  

•      }
  

+STATIC PLATFORM_SERIAL_CONSOLE mSerialConsole = {

• //
• // VENDOR_DEVICE_PATH SerialDxe
• //
• {
• { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, DP_NODE_LEN (VENDOR_DEVICE_PATH) },
• SERIAL_DXE_FILE_GUID
• },
• //
• // UART_DEVICE_PATH Uart
• //
• {
• { MESSAGING_DEVICE_PATH, MSG_UART_DP, DP_NODE_LEN (UART_DEVICE_PATH) },
• 0, // Reserved
• FixedPcdGet64 (PcdUartDefaultBaudRate), // BaudRate
• FixedPcdGet8 (PcdUartDefaultDataBits), // DataBits
• FixedPcdGet8 (PcdUartDefaultParity), // Parity
• FixedPcdGet8 (PcdUartDefaultStopBits) // StopBits
• },
• //
• // VENDOR_DEFINED_DEVICE_PATH TermType
• //
• {
• {

•  MESSAGING_DEVICE_PATH, MSG_VENDOR_DP,
  

•  DP_NODE_LEN (VENDOR_DEFINED_DEVICE_PATH)
  

• }
• //
• // Guid to be filled in dynamically
• //
• },
• //
• // EFI_DEVICE_PATH_PROTOCOL End
• //
• {
• END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE,
• DP_NODE_LEN (EFI_DEVICE_PATH_PROTOCOL)
• }

+};

+#pragma pack (1) +typedef struct {

• USB_CLASS_DEVICE_PATH Keyboard;
• EFI_DEVICE_PATH_PROTOCOL End;

+} PLATFORM_USB_KEYBOARD; +#pragma pack ()

+STATIC PLATFORM_USB_KEYBOARD mUsbKeyboard = {

• //
• // USB_CLASS_DEVICE_PATH Keyboard
• //
• {
• {

•  MESSAGING_DEVICE_PATH, MSG_USB_CLASS_DP,
  

•  DP_NODE_LEN (USB_CLASS_DEVICE_PATH)
  

• },
• 0xFFFF, // VendorId: any
• 0xFFFF, // ProductId: any
• 3, // DeviceClass: HID
• 1, // DeviceSubClass: boot
• 1 // DeviceProtocol: keyboard
• },
• //
• // EFI_DEVICE_PATH_PROTOCOL End
• //
• {
• END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE,
• DP_NODE_LEN (EFI_DEVICE_PATH_PROTOCOL)
• }

+};

+/**

• Check if the handle satisfies a particular condition.
• @param[in] Handle The handle to check.
• @param[in] ReportText A caller-allocated string passed in for reporting

•                     purposes. It must never be NULL.
  

• @retval TRUE The condition is satisfied.
• @retval FALSE Otherwise. This includes the case when the condition could not

•             be fully evaluated due to an error.
  

+**/ +typedef +BOOLEAN +(EFIAPI *FILTER_FUNCTION) (

• IN EFI_HANDLE Handle,
• IN CONST CHAR16 *ReportText
• );

+/**

• Process a handle.
• @param[in] Handle The handle to process.
• @param[in] ReportText A caller-allocated string passed in for reporting

•                     purposes. It must never be NULL.
  

+**/ +typedef +VOID +(EFIAPI *CALLBACK_FUNCTION) (

• IN EFI_HANDLE Handle,
• IN CONST CHAR16 *ReportText
• );

+/**

• Locate all handles that carry the specified protocol, filter them with a
• callback function, and pass each handle that passes the filter to another
• callback.
• @param[in] ProtocolGuid The protocol to look for.
• @param[in] Filter The filter function to pass each handle to. If this

•                       parameter is NULL, then all handles are processed.
  

• @param[in] Process The callback function to pass each handle to that

•                       clears the filter.
  

+**/ +STATIC +VOID +FilterAndProcess (

• IN EFI_GUID *ProtocolGuid,
• IN FILTER_FUNCTION Filter OPTIONAL,
• IN CALLBACK_FUNCTION Process
• )

+{

• EFI_STATUS Status;
• EFI_HANDLE *Handles;
• UINTN NoHandles;
• UINTN Idx;
• Status = gBS->LocateHandleBuffer (ByProtocol, ProtocolGuid,

•              NULL /* SearchKey */, &NoHandles, &Handles);
  

• if (EFI_ERROR (Status)) {
• //
• // This is not an error, just an informative condition.
• //
• DEBUG ((DEBUG_VERBOSE, "%a: %g: %r\n", __FUNCTION__, ProtocolGuid,

•  Status));
  

• return;
• }
• ASSERT (NoHandles > 0);
• for (Idx = 0; Idx < NoHandles; ++Idx) {
• CHAR16 *DevicePathText;
• STATIC CHAR16 Fallback[] = L"<device path unavailable>";
• //
• // The ConvertDevicePathToText() function handles NULL input transparently.
• //
• DevicePathText = ConvertDevicePathToText (

•                   DevicePathFromHandle (Handles[Idx]),
  

•                   FALSE, // DisplayOnly
  

•                   FALSE  // AllowShortcuts
  

•                   );
  

• if (DevicePathText == NULL) {

•  DevicePathText = Fallback;
  

• }
• if (Filter == NULL || Filter (Handles[Idx], DevicePathText)) {

•  Process (Handles[Idx], DevicePathText);
  

• }
• if (DevicePathText != Fallback) {

•  FreePool (DevicePathText);
  

• }
• }
• gBS->FreePool (Handles);

+}

+/**

• This CALLBACK_FUNCTION retrieves the EFI_DEVICE_PATH_PROTOCOL from the
• handle, and adds it to ConOut and ErrOut.

+**/ +STATIC +VOID +EFIAPI +AddOutput (

• IN EFI_HANDLE Handle,
• IN CONST CHAR16 *ReportText
• )

+{

• EFI_STATUS Status;
• EFI_DEVICE_PATH_PROTOCOL *DevicePath;
• DevicePath = DevicePathFromHandle (Handle);
• if (DevicePath == NULL) {
• DEBUG ((DEBUG_ERROR, "%a: %s: handle %p: device path not found\n",

•  __FUNCTION__, ReportText, Handle));
  

• return;
• }
• Status = EfiBootManagerUpdateConsoleVariable (ConOut, DevicePath, NULL);
• if (EFI_ERROR (Status)) {
• DEBUG ((DEBUG_ERROR, "%a: %s: adding to ConOut: %r\n", __FUNCTION__,

•  ReportText, Status));
  

• return;
• }
• Status = EfiBootManagerUpdateConsoleVariable (ErrOut, DevicePath, NULL);
• if (EFI_ERROR (Status)) {
• DEBUG ((DEBUG_ERROR, "%a: %s: adding to ErrOut: %r\n", __FUNCTION__,

•  ReportText, Status));
  

• return;
• }
• DEBUG ((DEBUG_VERBOSE, "%a: %s: added to ConOut and ErrOut\n", __FUNCTION__,
• ReportText));

+}

+STATIC +VOID +PlatformRegisterFvBootOption (

• EFI_GUID *FileGuid,
• CHAR16 *Description,
• UINT32 Attributes
• )

+{

• EFI_STATUS Status;
• INTN OptionIndex;
• EFI_BOOT_MANAGER_LOAD_OPTION NewOption;
• EFI_BOOT_MANAGER_LOAD_OPTION *BootOptions;
• UINTN BootOptionCount;
• MEDIA_FW_VOL_FILEPATH_DEVICE_PATH FileNode;
• EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
• EFI_DEVICE_PATH_PROTOCOL *DevicePath;
• Status = gBS->HandleProtocol (

•              gImageHandle,
  

•              &gEfiLoadedImageProtocolGuid,
  

•              (VOID **) &LoadedImage
  

•              );
  

• ASSERT_EFI_ERROR (Status);
• EfiInitializeFwVolDevicepathNode (&FileNode, FileGuid);
• DevicePath = DevicePathFromHandle (LoadedImage->DeviceHandle);
• ASSERT (DevicePath != NULL);
• DevicePath = AppendDevicePathNode (

•             DevicePath,
  

•             (EFI_DEVICE_PATH_PROTOCOL *) &FileNode
  

•             );
  

• ASSERT (DevicePath != NULL);
• Status = EfiBootManagerInitializeLoadOption (

•         &NewOption,
  

•         LoadOptionNumberUnassigned,
  

•         LoadOptionTypeBoot,
  

•         Attributes,
  

•         Description,
  

•         DevicePath,
  

•         NULL,
  

•         0
  

•         );
  

• ASSERT_EFI_ERROR (Status);
• FreePool (DevicePath);
• BootOptions = EfiBootManagerGetLoadOptions (

•              &BootOptionCount, LoadOptionTypeBoot
  

•              );
  

• OptionIndex = EfiBootManagerFindLoadOption (

•              &NewOption, BootOptions, BootOptionCount
  

•              );
  

• if (OptionIndex == -1) {
• Status = EfiBootManagerAddLoadOptionVariable (&NewOption, MAX_UINTN);
• ASSERT_EFI_ERROR (Status);
• }
• EfiBootManagerFreeLoadOption (&NewOption);
• EfiBootManagerFreeLoadOptions (BootOptions, BootOptionCount);

+}

+STATIC +VOID +PlatformRegisterOptionsAndKeys (

• VOID
• )

+{

• EFI_STATUS Status;
• EFI_INPUT_KEY Enter;
• EFI_INPUT_KEY F2;
• EFI_INPUT_KEY Esc;
• EFI_BOOT_MANAGER_LOAD_OPTION BootOption;
• //
• // Register ENTER as CONTINUE key
• //
• Enter.ScanCode = SCAN_NULL;
• Enter.UnicodeChar = CHAR_CARRIAGE_RETURN;
• Status = EfiBootManagerRegisterContinueKeyOption (0, &Enter, NULL);
• ASSERT_EFI_ERROR (Status);
• //
• // Map F2 and ESC to Boot Manager Menu
• //
• F2.ScanCode = SCAN_F2;
• F2.UnicodeChar = CHAR_NULL;
• Esc.ScanCode = SCAN_ESC;
• Esc.UnicodeChar = CHAR_NULL;
• Status = EfiBootManagerGetBootManagerMenu (&BootOption);
• ASSERT_EFI_ERROR (Status);
• Status = EfiBootManagerAddKeyOptionVariable (

•         NULL, (UINT16) BootOption.OptionNumber, 0, &F2, NULL
  

•         );
  

• ASSERT (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED);
• Status = EfiBootManagerAddKeyOptionVariable (

•         NULL, (UINT16) BootOption.OptionNumber, 0, &Esc, NULL
  

•         );
  

• ASSERT (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED);

+}

+// +// BDS Platform Functions +// +/**

• Do the platform init, can be customized by OEM/IBV
• Possible things that can be done in PlatformBootManagerBeforeConsole:
• ...

  Update console variable: 1. include hot-plug devices;

• ...

                       2. Clear ConIn and add SOL for AMT
  

• ...

  Register new Driver#### or Boot####

• ...

  Register new Key####: e.g.: F12

• ...

  Signal ReadyToLock event

• ...

  Authentication action: 1. connect Auth devices;

• ...

                     2. Identify auto logon user.
  

+**/ +VOID +EFIAPI +PlatformBootManagerBeforeConsole (

• VOID
• )

+{

• //
• // Signal EndOfDxe PI Event
• //
• EfiEventGroupSignal (&gEfiEndOfDxeEventGroupGuid);
• //
• // Now add the device path of all handles with GOP on them to ConOut and
• // ErrOut.
• //
• FilterAndProcess (&gEfiGraphicsOutputProtocolGuid, NULL, AddOutput);
• //
• // Add the hardcoded short-form USB keyboard device path to ConIn.
• //
• EfiBootManagerUpdateConsoleVariable (ConIn,
• (EFI_DEVICE_PATH_PROTOCOL *)&mUsbKeyboard, NULL);
• //
• // Add the hardcoded serial console device path to ConIn, ConOut, ErrOut.
• //
• ASSERT (FixedPcdGet8 (PcdDefaultTerminalType) == 4);
• CopyGuid (&mSerialConsole.TermType.Guid, &gEfiTtyTermGuid);
• EfiBootManagerUpdateConsoleVariable (ConIn,
• (EFI_DEVICE_PATH_PROTOCOL *)&mSerialConsole, NULL);
• EfiBootManagerUpdateConsoleVariable (ConOut,
• (EFI_DEVICE_PATH_PROTOCOL *)&mSerialConsole, NULL);
• EfiBootManagerUpdateConsoleVariable (ErrOut,
• (EFI_DEVICE_PATH_PROTOCOL *)&mSerialConsole, NULL);
• //
• // Register platform-specific boot options and keyboard shortcuts.
• //
• PlatformRegisterOptionsAndKeys ();

+}

+/**

• Do the platform specific action after the console is ready
• Possible things that can be done in PlatformBootManagerAfterConsole:
• ...

  Console post action:

• ...

  Dynamically switch output mode from 100x31 to 80x25 for certain senarino

• ...

  Signal console ready platform customized event

• ...

  Run diagnostics like memory testing

• ...

  Connect certain devices

• ...

  Dispatch aditional option roms

• ...

  Special boot: e.g.: USB boot, enter UI

+**/ +VOID +EFIAPI +PlatformBootManagerAfterConsole (

• VOID
• )

+{

• Print (L"Press ESCAPE for boot options ");
• //
• // Show the splash screen.
• //
• EnableQuietBoot (PcdGetPtr (PcdLogoFile));
• //
• // Connect the rest of the devices.
• //
• EfiBootManagerConnectAll ();
• //
• // Enumerate all possible boot options.
• //
• EfiBootManagerRefreshAllBootOption ();
• //
• // Register UEFI Shell
• //
• PlatformRegisterFvBootOption (
• PcdGetPtr (PcdShellFile), L"UEFI Shell", LOAD_OPTION_ACTIVE
• );
• //
• // Register Android Fastboot
• //
• PlatformRegisterFvBootOption (
• PcdGetPtr (PcdAndroidFastbootFile), L"Android Fastboot", LOAD_OPTION_ACTIVE
• );

+}

+/**

• This function is called each second during the boot manager waits the
• timeout.
• @param TimeoutRemain The remaining timeout.

+**/ +VOID +EFIAPI +PlatformBootManagerWaitCallback (

• UINT16 TimeoutRemain
• )

+{

• Print (L".");

+} diff --git a/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.h b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.h new file mode 100644 index 0000000..0a3c626 --- /dev/null +++ b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.h @@ -0,0 +1,59 @@ +/** @file

• Head file for BDS Platform specific code
• Copyright (C) 2015-2016, Red Hat, Inc.
• Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>
• Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>
• This program and the accompanying materials are licensed and made available
• under the terms and conditions of the BSD License which accompanies this
• distribution. The full text of the license may be found at
• http://opensource.org/licenses/bsd-license.php
• THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
• WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+**/

+#ifndef _PLATFORM_BM_H_ +#define _PLATFORM_BM_H_

+#include <Library/BaseLib.h> +#include <Library/BaseMemoryLib.h> +#include <Library/DebugLib.h> +#include <Library/DevicePathLib.h> +#include <Library/MemoryAllocationLib.h> +#include <Library/UefiBootServicesTableLib.h> +#include <Library/UefiLib.h> +#include <Library/UefiRuntimeServicesTableLib.h>

+/**

• Use SystemTable Conout to stop video based Simple Text Out consoles from
• going to the video device. Put up LogoFile on every video device that is a
• console.
• @param[in] LogoFile File name of logo to display on the center of the

•                     screen.
  

• @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo

•                      displayed.
  

• @retval EFI_UNSUPPORTED Logo not found

+**/ +EFI_STATUS +EnableQuietBoot (

• IN EFI_GUID *LogoFile
• );

+/**

• Use SystemTable Conout to turn on video based Simple Text Out consoles. The
• Simple Text Out screens will now be synced up with all non video output
• devices
• @retval EFI_SUCCESS UGA devices are back in text mode and synced up.

+**/ +EFI_STATUS +DisableQuietBoot (

• VOID
• );

+#endif // _PLATFORM_BM_H_ diff --git a/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf new file mode 100644 index 0000000..3256758 --- /dev/null +++ b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf @@ -0,0 +1,88 @@ +## @file +# Implementation for PlatformBootManagerLib library class interfaces. +# +# Copyright (C) 2015-2016, Red Hat, Inc. +# Copyright (c) 2014, ARM Ltd. All rights reserved.<BR> +# Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR> +# Copyright (c) 2016-2017, Linaro Ltd. All rights reserved.<BR> +# +# This program and the accompanying materials are licensed and made available +# under the terms and conditions of the BSD License which accompanies this +# distribution. The full text of the license may be found at +# http://opensource.org/licenses/bsd-license.php +# +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR +# IMPLIED. +# +##

+[Defines]

• INF_VERSION = 0x00010005
• BASE_NAME = PlatformBootManagerLib
• FILE_GUID = a5a1ecfc-7c11-427a-8803-012869067095
• MODULE_TYPE = DXE_DRIVER
• VERSION_STRING = 1.0
• LIBRARY_CLASS = PlatformBootManagerLib|DXE_DRIVER

+# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = ARM AARCH64 +#

+[Sources]

• PlatformBm.c
• QuietBoot.c

+[Packages]

• IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
• MdeModulePkg/MdeModulePkg.dec
• MdePkg/MdePkg.dec
• OpenPlatformPkg/OpenPlatformPkg.dec

+[LibraryClasses]

• BaseLib
• BaseMemoryLib
• DebugLib
• DevicePathLib
• DxeServicesLib
• MemoryAllocationLib
• PcdLib
• PrintLib
• UefiBootManagerLib
• UefiBootServicesTableLib
• UefiLib

+[FeaturePcd]

• gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdBootlogoOnlyEnable
• gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport

+[FixedPcd]

• gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdLogoFile
• gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile
• gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate
• gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits
• gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity
• gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits
• gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType

+[Pcd]

• gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut
• gOpenPlatformTokenSpaceGuid.PcdAndroidFastbootFile

+[Guids]

• gEfiFileInfoGuid
• gEfiFileSystemInfoGuid
• gEfiFileSystemVolumeLabelInfoIdGuid
• gEfiEndOfDxeEventGroupGuid
• gEfiTtyTermGuid

+[Protocols]

• gEfiDevicePathProtocolGuid
• gEfiGraphicsOutputProtocolGuid
• gEfiLoadedImageProtocolGuid
• gEfiOEMBadgingProtocolGuid
• gEfiPciRootBridgeIoProtocolGuid
• gEfiSimpleFileSystemProtocolGuid
• gEfiDevicePathToTextProtocolGuid

diff --git a/Platforms/Hisilicon/Library/PlatformBootManagerLib/QuietBoot.c b/Platforms/Hisilicon/Library/PlatformBootManagerLib/QuietBoot.c new file mode 100644 index 0000000..687bda0 --- /dev/null +++ b/Platforms/Hisilicon/Library/PlatformBootManagerLib/QuietBoot.c @@ -0,0 +1,680 @@ +/** @file

• Platform BDS function for quiet boot support.

+Copyright (C) 2016, Red Hat, Inc. +Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR> +This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+**/

+#include <IndustryStandard/Bmp.h> +#include <Library/DxeServicesLib.h> +#include <Protocol/BootLogo.h> +#include <Protocol/OEMBadging.h> +#include <Protocol/UgaDraw.h>

+#include "PlatformBm.h"

+/**

• Convert a *.BMP graphics image to a GOP blt buffer. If a NULL Blt buffer
• is passed in a GopBlt buffer will be allocated by this routine. If a GopBlt
• buffer is passed in it will be used if it is big enough.
• @param BmpImage Pointer to BMP file
• @param BmpImageSize Number of bytes in BmpImage
• @param GopBlt Buffer containing GOP version of BmpImage.
• @param GopBltSize Size of GopBlt in bytes.
• @param PixelHeight Height of GopBlt/BmpImage in pixels
• @param PixelWidth Width of GopBlt/BmpImage in pixels
• @retval EFI_SUCCESS GopBlt and GopBltSize are returned.
• @retval EFI_UNSUPPORTED BmpImage is not a valid *.BMP image
• @retval EFI_BUFFER_TOO_SMALL The passed in GopBlt buffer is not big enough.

•                            GopBltSize will contain the required size.
  

• @retval EFI_OUT_OF_RESOURCES No enough buffer to allocate.

+**/ +STATIC +EFI_STATUS +ConvertBmpToGopBlt (

• IN VOID *BmpImage,
• IN UINTN BmpImageSize,
• IN OUT VOID **GopBlt,
• IN OUT UINTN *GopBltSize,

• OUT UINTN     *PixelHeight,
  

• OUT UINTN     *PixelWidth
  

• )

+{

• UINT8 *Image;
• UINT8 *ImageHeader;
• BMP_IMAGE_HEADER *BmpHeader;
• BMP_COLOR_MAP *BmpColorMap;
• EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer;
• EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt;
• UINT64 BltBufferSize;
• UINTN Index;
• UINTN Height;
• UINTN Width;
• UINTN ImageIndex;
• UINT32 DataSizePerLine;
• BOOLEAN IsAllocated;
• UINT32 ColorMapNum;
• if (sizeof (BMP_IMAGE_HEADER) > BmpImageSize) {
• return EFI_INVALID_PARAMETER;
• }
• BmpHeader = (BMP_IMAGE_HEADER *) BmpImage;
• if (BmpHeader->CharB != 'B' || BmpHeader->CharM != 'M') {
• return EFI_UNSUPPORTED;
• }
• //
• // Doesn't support compress.
• //
• if (BmpHeader->CompressionType != 0) {
• return EFI_UNSUPPORTED;
• }
• //
• // Only support BITMAPINFOHEADER format.
• // BITMAPFILEHEADER + BITMAPINFOHEADER = BMP_IMAGE_HEADER
• //
• if (BmpHeader->HeaderSize != sizeof (BMP_IMAGE_HEADER) - OFFSET_OF(BMP_IMAGE_HEADER, HeaderSize)) {
• return EFI_UNSUPPORTED;
• }
• //
• // The data size in each line must be 4 byte alignment.
• //
• DataSizePerLine = ((BmpHeader->PixelWidth * BmpHeader->BitPerPixel + 31) >> 3) & (~0x3);
• BltBufferSize = MultU64x32 (DataSizePerLine, BmpHeader->PixelHeight);
• if (BltBufferSize > (UINT32) ~0) {
• return EFI_INVALID_PARAMETER;
• }
• if ((BmpHeader->Size != BmpImageSize) ||

•  (BmpHeader->Size < BmpHeader->ImageOffset) ||
  

•  (BmpHeader->Size - BmpHeader->ImageOffset !=  BmpHeader->PixelHeight * DataSizePerLine)) {
  

• return EFI_INVALID_PARAMETER;
• }
• //
• // Calculate Color Map offset in the image.
• //
• Image = BmpImage;
• BmpColorMap = (BMP_COLOR_MAP *) (Image + sizeof (BMP_IMAGE_HEADER));
• if (BmpHeader->ImageOffset < sizeof (BMP_IMAGE_HEADER)) {
• return EFI_INVALID_PARAMETER;
• }
• if (BmpHeader->ImageOffset > sizeof (BMP_IMAGE_HEADER)) {
• switch (BmpHeader->BitPerPixel) {

•  case 1:
  

•    ColorMapNum = 2;
  

•    break;
  

•  case 4:
  

•    ColorMapNum = 16;
  

•    break;
  

•  case 8:
  

•    ColorMapNum = 256;
  

•    break;
  

•  default:
  

•    ColorMapNum = 0;
  

•    break;
  

•  }
  

• //
• // BMP file may has padding data between the bmp header section and the bmp data section.
• //
• if (BmpHeader->ImageOffset - sizeof (BMP_IMAGE_HEADER) < sizeof (BMP_COLOR_MAP) * ColorMapNum) {

•  return EFI_INVALID_PARAMETER;
  

• }
• }
• //
• // Calculate graphics image data address in the image
• //
• Image = ((UINT8 *) BmpImage) + BmpHeader->ImageOffset;
• ImageHeader = Image;
• //
• // Calculate the BltBuffer needed size.
• //
• BltBufferSize = MultU64x32 ((UINT64) BmpHeader->PixelWidth, BmpHeader->PixelHeight);
• //
• // Ensure the BltBufferSize * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) doesn't overflow
• //
• if (BltBufferSize > DivU64x32 ((UINTN) ~0, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL))) {
• return EFI_UNSUPPORTED;
• }
• BltBufferSize = MultU64x32 (BltBufferSize, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
• IsAllocated = FALSE;
• if (*GopBlt == NULL) {
• //
• // GopBlt is not allocated by caller.
• //
• *GopBltSize = (UINTN) BltBufferSize;
• *GopBlt = AllocatePool (*GopBltSize);
• IsAllocated = TRUE;
• if (*GopBlt == NULL) {

•  return EFI_OUT_OF_RESOURCES;
  

• }
• } else {
• //
• // GopBlt has been allocated by caller.
• //
• if (*GopBltSize < (UINTN) BltBufferSize) {

•  *GopBltSize = (UINTN) BltBufferSize;
  

•  return EFI_BUFFER_TOO_SMALL;
  

• }
• }
• *PixelWidth = BmpHeader->PixelWidth;
• *PixelHeight = BmpHeader->PixelHeight;
• //
• // Convert image from BMP to Blt buffer format
• //
• BltBuffer = *GopBlt;
• for (Height = 0; Height < BmpHeader->PixelHeight; Height++) {
• Blt = &BltBuffer[(BmpHeader->PixelHeight - Height - 1) * BmpHeader->PixelWidth];
• for (Width = 0; Width < BmpHeader->PixelWidth; Width++, Image++, Blt++) {

•  switch (BmpHeader->BitPerPixel) {
  

•  case 1:
  

•    //
  

•    // Convert 1-bit (2 colors) BMP to 24-bit color
  

•    //
  

•    for (Index = 0; Index < 8 && Width < BmpHeader->PixelWidth; Index++) {
  

•      Blt->Red    = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Red;
  

•      Blt->Green  = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Green;
  

•      Blt->Blue   = BmpColorMap[((*Image) >> (7 - Index)) & 0x1].Blue;
  

•      Blt++;
  

•      Width++;
  

•    }
  

•    Blt--;
  

•    Width--;
  

•    break;
  

•  case 4:
  

•    //
  

•    // Convert 4-bit (16 colors) BMP Palette to 24-bit color
  

•    //
  

•    Index       = (*Image) >> 4;
  

•    Blt->Red    = BmpColorMap[Index].Red;
  

•    Blt->Green  = BmpColorMap[Index].Green;
  

•    Blt->Blue   = BmpColorMap[Index].Blue;
  

•    if (Width < (BmpHeader->PixelWidth - 1)) {
  

•      Blt++;
  

•      Width++;
  

•      Index       = (*Image) & 0x0f;
  

•      Blt->Red    = BmpColorMap[Index].Red;
  

•      Blt->Green  = BmpColorMap[Index].Green;
  

•      Blt->Blue   = BmpColorMap[Index].Blue;
  

•    }
  

•    break;
  

•  case 8:
  

•    //
  

•    // Convert 8-bit (256 colors) BMP Palette to 24-bit color
  

•    //
  

•    Blt->Red    = BmpColorMap[*Image].Red;
  

•    Blt->Green  = BmpColorMap[*Image].Green;
  

•    Blt->Blue   = BmpColorMap[*Image].Blue;
  

•    break;
  

•  case 24:
  

•    //
  

•    // It is 24-bit BMP.
  

•    //
  

•    Blt->Blue   = *Image++;
  

•    Blt->Green  = *Image++;
  

•    Blt->Red    = *Image;
  

•    break;
  

•  default:
  

•    //
  

•    // Other bit format BMP is not supported.
  

•    //
  

•    if (IsAllocated) {
  

•      FreePool (*GopBlt);
  

•      *GopBlt = NULL;
  

•    }
  

•    return EFI_UNSUPPORTED;
  

•  };
  

• }
• ImageIndex = (UINTN) (Image - ImageHeader);
• if ((ImageIndex % 4) != 0) {

•  //
  

•  // Bmp Image starts each row on a 32-bit boundary!
  

•  //
  

•  Image = Image + (4 - (ImageIndex % 4));
  

• }
• }
• return EFI_SUCCESS;

+}

+/**

• Use SystemTable Conout to stop video based Simple Text Out consoles from going
• to the video device. Put up LogoFile on every video device that is a console.
• @param[in] LogoFile File name of logo to display on the center of the screen.
• @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
• @retval EFI_UNSUPPORTED Logo not found

+**/ +EFI_STATUS +EnableQuietBoot (

• IN EFI_GUID *LogoFile
• )

+{

• EFI_STATUS Status;
• EFI_OEM_BADGING_PROTOCOL *Badging;
• UINT32 SizeOfX;
• UINT32 SizeOfY;
• INTN DestX;
• INTN DestY;
• UINT8 *ImageData;
• UINTN ImageSize;
• UINTN BltSize;
• UINT32 Instance;
• EFI_BADGING_FORMAT Format;
• EFI_BADGING_DISPLAY_ATTRIBUTE Attribute;
• UINTN CoordinateX;
• UINTN CoordinateY;
• UINTN Height;
• UINTN Width;
• EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Blt;
• EFI_UGA_DRAW_PROTOCOL *UgaDraw;
• UINT32 ColorDepth;
• UINT32 RefreshRate;
• EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
• EFI_BOOT_LOGO_PROTOCOL *BootLogo;
• UINTN NumberOfLogos;
• EFI_GRAPHICS_OUTPUT_BLT_PIXEL *LogoBlt;
• UINTN LogoDestX;
• UINTN LogoDestY;
• UINTN LogoHeight;
• UINTN LogoWidth;
• UINTN NewDestX;
• UINTN NewDestY;
• UINTN NewHeight;
• UINTN NewWidth;
• UINT64 BufferSize;
• UgaDraw = NULL;
• //
• // Try to open GOP first
• //
• Status = gBS->HandleProtocol (gST->ConsoleOutHandle, &gEfiGraphicsOutputProtocolGuid, (VOID **) &GraphicsOutput);
• if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {
• GraphicsOutput = NULL;
• //
• // Open GOP failed, try to open UGA
• //
• Status = gBS->HandleProtocol (gST->ConsoleOutHandle, &gEfiUgaDrawProtocolGuid, (VOID **) &UgaDraw);
• }
• if (EFI_ERROR (Status)) {
• return EFI_UNSUPPORTED;
• }
• //
• // Try to open Boot Logo Protocol.
• //
• BootLogo = NULL;
• gBS->LocateProtocol (&gEfiBootLogoProtocolGuid, NULL, (VOID **) &BootLogo);
• //
• // Erase Cursor from screen
• //
• gST->ConOut->EnableCursor (gST->ConOut, FALSE);
• Badging = NULL;
• Status = gBS->LocateProtocol (&gEfiOEMBadgingProtocolGuid, NULL, (VOID **) &Badging);
• if (GraphicsOutput != NULL) {
• SizeOfX = GraphicsOutput->Mode->Info->HorizontalResolution;
• SizeOfY = GraphicsOutput->Mode->Info->VerticalResolution;
• } else if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {
• Status = UgaDraw->GetMode (UgaDraw, &SizeOfX, &SizeOfY, &ColorDepth, &RefreshRate);
• if (EFI_ERROR (Status)) {

•  return EFI_UNSUPPORTED;
  

• }
• } else {
• return EFI_UNSUPPORTED;
• }
• Blt = NULL;
• NumberOfLogos = 0;
• LogoDestX = 0;
• LogoDestY = 0;
• LogoHeight = 0;
• LogoWidth = 0;
• NewDestX = 0;
• NewDestY = 0;
• NewHeight = 0;
• NewWidth = 0;
• Instance = 0;
• Height = 0;
• Width = 0;
• while (1) {
• ImageData = NULL;
• ImageSize = 0;
• if (Badging != NULL) {

•  //
  

•  // Get image from OEMBadging protocol.
  

•  //
  

•  Status = Badging->GetImage (
  

•                      Badging,
  

•                      &Instance,
  

•                      &Format,
  

•                      &ImageData,
  

•                      &ImageSize,
  

•                      &Attribute,
  

•                      &CoordinateX,
  

•                      &CoordinateY
  

•                      );
  

•  if (EFI_ERROR (Status)) {
  

•    goto Done;
  

•  }
  

•  //
  

•  // Currently only support BMP format.
  

•  //
  

•  if (Format != EfiBadgingFormatBMP) {
  

•    if (ImageData != NULL) {
  

•      FreePool (ImageData);
  

•    }
  

•    continue;
  

•  }
  

• } else {

•  //
  

•  // Get the specified image from FV.
  

•  //
  

•  Status = GetSectionFromAnyFv (LogoFile, EFI_SECTION_RAW, 0, (VOID **) &ImageData, &ImageSize);
  

•  if (EFI_ERROR (Status)) {
  

•    return EFI_UNSUPPORTED;
  

•  }
  

•  CoordinateX = 0;
  

•  CoordinateY = 0;
  

•  if (!FeaturePcdGet(PcdBootlogoOnlyEnable)) {
  

•    Attribute   = EfiBadgingDisplayAttributeCenter;
  

•  } else {
  

•    Attribute   = EfiBadgingDisplayAttributeCustomized;
  

•  }
  

• }
• if (Blt != NULL) {

•  FreePool (Blt);
  

• }
• Blt = NULL;
• Status = ConvertBmpToGopBlt (

•          ImageData,
  

•          ImageSize,
  

•          (VOID **) &Blt,
  

•          &BltSize,
  

•          &Height,
  

•          &Width
  

•          );
  

• if (EFI_ERROR (Status)) {

•  FreePool (ImageData);
  

•  if (Badging == NULL) {
  

•    return Status;
  

•  } else {
  

•    continue;
  

•  }
  

• }
• //
• // Calculate the display position according to Attribute.
• //
• switch (Attribute) {
• case EfiBadgingDisplayAttributeLeftTop:

•  DestX = CoordinateX;
  

•  DestY = CoordinateY;
  

•  break;
  

• case EfiBadgingDisplayAttributeCenterTop:

•  DestX = (SizeOfX - Width) / 2;
  

•  DestY = CoordinateY;
  

•  break;
  

• case EfiBadgingDisplayAttributeRightTop:

•  DestX = (SizeOfX - Width - CoordinateX);
  

•  DestY = CoordinateY;;
  

•  break;
  

• case EfiBadgingDisplayAttributeCenterRight:

•  DestX = (SizeOfX - Width - CoordinateX);
  

•  DestY = (SizeOfY - Height) / 2;
  

•  break;
  

• case EfiBadgingDisplayAttributeRightBottom:

•  DestX = (SizeOfX - Width - CoordinateX);
  

•  DestY = (SizeOfY - Height - CoordinateY);
  

•  break;
  

• case EfiBadgingDisplayAttributeCenterBottom:

•  DestX = (SizeOfX - Width) / 2;
  

•  DestY = (SizeOfY - Height - CoordinateY);
  

•  break;
  

• case EfiBadgingDisplayAttributeLeftBottom:

•  DestX = CoordinateX;
  

•  DestY = (SizeOfY - Height - CoordinateY);
  

•  break;
  

• case EfiBadgingDisplayAttributeCenterLeft:

•  DestX = CoordinateX;
  

•  DestY = (SizeOfY - Height) / 2;
  

•  break;
  

• case EfiBadgingDisplayAttributeCenter:

•  DestX = (SizeOfX - Width) / 2;
  

•  DestY = (SizeOfY - Height) / 2;
  

•  break;
  

• case EfiBadgingDisplayAttributeCustomized:

•  DestX = (SizeOfX - Width) / 2;
  

•  DestY = ((SizeOfY * 382) / 1000) - Height / 2;
  

•  break;
  

• default:

•  DestX = CoordinateX;
  

•  DestY = CoordinateY;
  

•  break;
  

• }
• if ((DestX >= 0) && (DestY >= 0)) {

•  if (GraphicsOutput != NULL) {
  

•    Status = GraphicsOutput->Blt (
  

•                        GraphicsOutput,
  

•                        Blt,
  

•                        EfiBltBufferToVideo,
  

•                        0,
  

•                        0,
  

•                        (UINTN) DestX,
  

•                        (UINTN) DestY,
  

•                        Width,
  

•                        Height,
  

•                        Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
  

•                        );
  

•  } else if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {
  

•    Status = UgaDraw->Blt (
  

•                        UgaDraw,
  

•                        (EFI_UGA_PIXEL *) Blt,
  

•                        EfiUgaBltBufferToVideo,
  

•                        0,
  

•                        0,
  

•                        (UINTN) DestX,
  

•                        (UINTN) DestY,
  

•                        Width,
  

•                        Height,
  

•                        Width * sizeof (EFI_UGA_PIXEL)
  

•                        );
  

•  } else {
  

•    Status = EFI_UNSUPPORTED;
  

•  }
  

•  //
  

•  // Report displayed Logo information.
  

•  //
  

•  if (!EFI_ERROR (Status)) {
  

•    NumberOfLogos++;
  

•    if (LogoWidth == 0) {
  

•      //
  

•      // The first Logo.
  

•      //
  

•      LogoDestX = (UINTN) DestX;
  

•      LogoDestY = (UINTN) DestY;
  

•      LogoWidth = Width;
  

•      LogoHeight = Height;
  

•    } else {
  

•      //
  

•      // Merge new logo with old one.
  

•      //
  

•      NewDestX = MIN ((UINTN) DestX, LogoDestX);
  

•      NewDestY = MIN ((UINTN) DestY, LogoDestY);
  

•      NewWidth = MAX ((UINTN) DestX + Width, LogoDestX + LogoWidth) - NewDestX;
  

•      NewHeight = MAX ((UINTN) DestY + Height, LogoDestY + LogoHeight) - NewDestY;
  

•      LogoDestX = NewDestX;
  

•      LogoDestY = NewDestY;
  

•      LogoWidth = NewWidth;
  

•      LogoHeight = NewHeight;
  

•    }
  

•  }
  

• }
• FreePool (ImageData);
• if (Badging == NULL) {

•  break;
  

• }
• }

+Done:

• if (BootLogo == NULL || NumberOfLogos == 0) {
• //
• // No logo displayed.
• //
• if (Blt != NULL) {

•  FreePool (Blt);
  

• }
• return Status;
• }
• //
• // Advertise displayed Logo information.
• //
• if (NumberOfLogos == 1) {
• //
• // Only one logo displayed, use its Blt buffer directly for BootLogo protocol.
• //
• LogoBlt = Blt;
• Status = EFI_SUCCESS;
• } else {
• //
• // More than one Logo displayed, get merged BltBuffer using VideoToBuffer operation.
• //
• if (Blt != NULL) {

•  FreePool (Blt);
  

• }
• //
• // Ensure the LogoHeight * LogoWidth doesn't overflow
• //
• if (LogoHeight > DivU64x64Remainder ((UINTN) ~0, LogoWidth, NULL)) {

•  return EFI_UNSUPPORTED;
  

• }
• BufferSize = MultU64x64 (LogoWidth, LogoHeight);
• //
• // Ensure the BufferSize * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) doesn't overflow
• //
• if (BufferSize > DivU64x32 ((UINTN) ~0, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL))) {

•  return EFI_UNSUPPORTED;
  

• }
• LogoBlt = AllocateZeroPool ((UINTN)BufferSize * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
• if (LogoBlt == NULL) {

•  return EFI_OUT_OF_RESOURCES;
  

• }
• if (GraphicsOutput != NULL) {

•  Status = GraphicsOutput->Blt (
  

•                      GraphicsOutput,
  

•                      LogoBlt,
  

•                      EfiBltVideoToBltBuffer,
  

•                      LogoDestX,
  

•                      LogoDestY,
  

•                      0,
  

•                      0,
  

•                      LogoWidth,
  

•                      LogoHeight,
  

•                      LogoWidth * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
  

•                      );
  

• } else if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {

•  Status = UgaDraw->Blt (
  

•                      UgaDraw,
  

•                      (EFI_UGA_PIXEL *) LogoBlt,
  

•                      EfiUgaVideoToBltBuffer,
  

•                      LogoDestX,
  

•                      LogoDestY,
  

•                      0,
  

•                      0,
  

•                      LogoWidth,
  

•                      LogoHeight,
  

•                      LogoWidth * sizeof (EFI_UGA_PIXEL)
  

•                      );
  

• } else {

•  Status = EFI_UNSUPPORTED;
  

• }
• }
• if (!EFI_ERROR (Status)) {
• BootLogo->SetBootLogo (BootLogo, LogoBlt, LogoDestX, LogoDestY, LogoWidth, LogoHeight);
• }
• FreePool (LogoBlt);
• return Status;

+}

+/**

• Use SystemTable Conout to turn on video based Simple Text Out consoles. The
• Simple Text Out screens will now be synced up with all non video output devices
• @retval EFI_SUCCESS UGA devices are back in text mode and synced up.

+**/ +EFI_STATUS +DisableQuietBoot (

• VOID
• )

+{

• //
• // Enable Cursor on Screen
• //
• gST->ConOut->EnableCursor (gST->ConOut, TRUE);
• return EFI_SUCCESS;

+}

-- 2.7.4

On Fri, Feb 10, 2017 at 03:59:05PM +0000, Ard Biesheuvel wrote:

On 10 February 2017 at 15:57, Leif Lindholm leif.lindholm@linaro.org wrote:

...

On Thu, Feb 09, 2017 at 10:11:50PM +0800, Haojian Zhuang wrote:

...

Add the platform boot manager to boot Android Fastboot.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

OpenPlatformPkg.dec | 1 + .../Library/PlatformBootManagerLib/PlatformBm.c | 485 +++++++++++++++ .../Library/PlatformBootManagerLib/PlatformBm.h | 59 ++ .../PlatformBootManagerLib.inf | 88 +++ .../Library/PlatformBootManagerLib/QuietBoot.c | 680 +++++++++++++++++++++ 5 files changed, 1313 insertions(+) create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.h create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/QuietBoot.c

diff --git a/OpenPlatformPkg.dec b/OpenPlatformPkg.dec index 2db143d..e82b4d4 100644 --- a/OpenPlatformPkg.dec +++ b/OpenPlatformPkg.dec @@ -39,5 +39,6 @@ [PcdsFixedAtBuild] ## Indicates the size in MB for RAM disk. gOpenPlatformTokenSpaceGuid.PcdRamDiskMaxSize|0|UINT32|0x00000001

• gOpenPlatformTokenSpaceGuid.PcdAndroidFastbootFile|{ 0x2a, 0x50, 0x88, 0x95, 0x70, 0x53, 0xe3, 0x11, 0x86, 0x31, 0xd7, 0xc5, 0x95, 0x13, 0x64, 0xc8 }|VOID*|0x00000002

[PcdsFeatureFlag] diff --git a/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c new file mode 100644 index 0000000..03b764d --- /dev/null +++ b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c @@ -0,0 +1,485 @@ +/** @file

• Implementation for PlatformBootManagerLib library class interfaces.

From ArmPkg/Library/PlatformBootManagerLib/PlatformBm.c

Like the fastboot duplication, this also looks like a lot of opportunity for unifying into a common version.

It looks to me like the only differences from the original are:

• Deleting code specific to PCI systems.
• Deleting the Connect() function (unused with PCI bits gone).
• Updating EFI_D_ to DEBUG_ in order to keep PatchCheck.py happy.
• A call to PlatformRegisterFvBootOption().

Ard: would you be happy for us to start introducing a few compile-time settings that would let this platform just reuse the ArmPkg Platform boot manager?

I.e., CONFIG_PCI and CONFIG_ANDROID_FASTBOOT.

That would also be an excellent starting point for commonalizing config fragments.

Do you mean #ifdefs in the code? Shouldn't we use PCDs instead?

Can we use PCDs to comment out unused functions?

/ Leif

On 10 February 2017 at 23:57, Leif Lindholm leif.lindholm@linaro.org wrote:

On Thu, Feb 09, 2017 at 10:11:50PM +0800, Haojian Zhuang wrote:

...

Add the platform boot manager to boot Android Fastboot.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

OpenPlatformPkg.dec | 1 + .../Library/PlatformBootManagerLib/PlatformBm.c | 485 +++++++++++++++ .../Library/PlatformBootManagerLib/PlatformBm.h | 59 ++ .../PlatformBootManagerLib.inf | 88 +++ .../Library/PlatformBootManagerLib/QuietBoot.c | 680 +++++++++++++++++++++ 5 files changed, 1313 insertions(+) create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.h create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/QuietBoot.c

diff --git a/OpenPlatformPkg.dec b/OpenPlatformPkg.dec index 2db143d..e82b4d4 100644 --- a/OpenPlatformPkg.dec +++ b/OpenPlatformPkg.dec @@ -39,5 +39,6 @@ [PcdsFixedAtBuild] ## Indicates the size in MB for RAM disk. gOpenPlatformTokenSpaceGuid.PcdRamDiskMaxSize|0|UINT32|0x00000001

• gOpenPlatformTokenSpaceGuid.PcdAndroidFastbootFile|{ 0x2a, 0x50, 0x88, 0x95, 0x70, 0x53, 0xe3, 0x11, 0x86, 0x31, 0xd7, 0xc5, 0x95, 0x13, 0x64, 0xc8 }|VOID*|0x00000002

[PcdsFeatureFlag] diff --git a/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c new file mode 100644 index 0000000..03b764d --- /dev/null +++ b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c @@ -0,0 +1,485 @@ +/** @file

• Implementation for PlatformBootManagerLib library class interfaces.

From ArmPkg/Library/PlatformBootManagerLib/PlatformBm.c

Like the fastboot duplication, this also looks like a lot of opportunity for unifying into a common version.

It looks to me like the only differences from the original are:

• Deleting code specific to PCI systems.
• Deleting the Connect() function (unused with PCI bits gone).
• Updating EFI_D_ to DEBUG_ in order to keep PatchCheck.py happy.
• A call to PlatformRegisterFvBootOption().

Ard: would you be happy for us to start introducing a few compile-time settings that would let this platform just reuse the ArmPkg Platform boot manager?

I have one question on BootNext. Does it mean that I have to update BootNext variable in platform boot manager? Could I update BootNext variable out of platform boot manager?

In HiKey, we detect GPIO pins to determine boot to either android fastboot app or grub.

Regards Haojian

On Tue, Feb 14, 2017 at 03:51:03PM +0800, Haojian Zhuang wrote:

On 10 February 2017 at 23:57, Leif Lindholm leif.lindholm@linaro.org wrote:

...

On Thu, Feb 09, 2017 at 10:11:50PM +0800, Haojian Zhuang wrote:

...

Add the platform boot manager to boot Android Fastboot.

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

OpenPlatformPkg.dec | 1 + .../Library/PlatformBootManagerLib/PlatformBm.c | 485 +++++++++++++++ .../Library/PlatformBootManagerLib/PlatformBm.h | 59 ++ .../PlatformBootManagerLib.inf | 88 +++ .../Library/PlatformBootManagerLib/QuietBoot.c | 680 +++++++++++++++++++++ 5 files changed, 1313 insertions(+) create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.h create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf create mode 100644 Platforms/Hisilicon/Library/PlatformBootManagerLib/QuietBoot.c

diff --git a/OpenPlatformPkg.dec b/OpenPlatformPkg.dec index 2db143d..e82b4d4 100644 --- a/OpenPlatformPkg.dec +++ b/OpenPlatformPkg.dec @@ -39,5 +39,6 @@ [PcdsFixedAtBuild] ## Indicates the size in MB for RAM disk. gOpenPlatformTokenSpaceGuid.PcdRamDiskMaxSize|0|UINT32|0x00000001

• gOpenPlatformTokenSpaceGuid.PcdAndroidFastbootFile|{ 0x2a, 0x50, 0x88, 0x95, 0x70, 0x53, 0xe3, 0x11, 0x86, 0x31, 0xd7, 0xc5, 0x95, 0x13, 0x64, 0xc8 }|VOID*|0x00000002

[PcdsFeatureFlag] diff --git a/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c new file mode 100644 index 0000000..03b764d --- /dev/null +++ b/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBm.c @@ -0,0 +1,485 @@ +/** @file

• Implementation for PlatformBootManagerLib library class interfaces.

From ArmPkg/Library/PlatformBootManagerLib/PlatformBm.c

Like the fastboot duplication, this also looks like a lot of opportunity for unifying into a common version.

It looks to me like the only differences from the original are:

• Deleting code specific to PCI systems.
• Deleting the Connect() function (unused with PCI bits gone).
• Updating EFI_D_ to DEBUG_ in order to keep PatchCheck.py happy.
• A call to PlatformRegisterFvBootOption().

Ard: would you be happy for us to start introducing a few compile-time settings that would let this platform just reuse the ArmPkg Platform boot manager?

I have one question on BootNext. Does it mean that I have to update BootNext variable in platform boot manager? Could I update BootNext variable out of platform boot manager?

Yes, that could make sense. If there is not an easier way of doing it.

In HiKey, we detect GPIO pins to determine boot to either android fastboot app or grub.

Yes, that sounds like an excellent input for a boot policy. I'd be happy to put some hooks into the common on to support boot mode detection.

/ Leif

On Thu, Feb 09, 2017 at 10:11:51PM +0800, Haojian Zhuang wrote:

Enable HiKeyGpio, HiKeyUsb and Platform Boot Manager to launch Android Fastboot App on HiKey platform.

I have no objections to this file, but I think it will change some based on fooedback on other patches.

Regards,

Leif

Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Haojian Zhuang haojian.zhuang@linaro.org

---

Platforms/Hisilicon/HiKey/HiKey.dsc | 17 +++++++++++++++-- Platforms/Hisilicon/HiKey/HiKey.fdf | 6 +++++- 2 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/Platforms/Hisilicon/HiKey/HiKey.dsc b/Platforms/Hisilicon/HiKey/HiKey.dsc index 492faaa..6fe1bd5 100644 --- a/Platforms/Hisilicon/HiKey/HiKey.dsc +++ b/Platforms/Hisilicon/HiKey/HiKey.dsc @@ -62,7 +62,7 @@ FdtLib|EmbeddedPkg/Library/FdtLib/FdtLib.inf UefiBootManagerLib|MdeModulePkg/Library/UefiBootManagerLib/UefiBootManagerLib.inf

• PlatformBootManagerLib|ArmPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf

• PlatformBootManagerLib|OpenPlatformPkg/Platforms/Hisilicon/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf CustomizedDisplayLib|MdeModulePkg/Library/CustomizedDisplayLib/CustomizedDisplayLib.inf

ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf @@ -162,7 +162,7 @@ ReportStatusCodeLib|IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf [BuildOptions]

• GCC:*_*_*_PLATFORM_FLAGS = -I$(WORKSPACE)/OpenPlatformPkg/Chips/Hisilicon/Hi6220/Include -I$(WORKSPACE)/OpenPlatformPkg/Platforms/Hisilicon/HiKey/Include

• GCC:*_*_*_PLATFORM_FLAGS = -I$(WORKSPACE)/OpenPlatformPkg/Chips/Hisilicon/Hi6220/Include -I$(WORKSPACE)/OpenPlatformPkg/Platforms/Hisilicon/HiKey/Include -I$(WORKSPACE)/OpenPlatformPkg/Include

[BuildOptions.common.EDKII.DXE_RUNTIME_DRIVER] GCC:*_*_AARCH64_DLINK_FLAGS = -z common-page-size=0x10000 @@ -339,11 +339,19 @@ gDwEmmcDxeTokenSpaceGuid.PcdDwEmmcDxeClockFrequencyInHz|100000000 #

• # DW USB controller
• #
• gDwUsbDxeTokenSpaceGuid.PcdDwUsbDxeBaseAddress|0xF72C0000
• # # # Fastboot # gEmbeddedTokenSpaceGuid.PcdAndroidFastbootUsbVendorId|0x18d1 gEmbeddedTokenSpaceGuid.PcdAndroidFastbootUsbProductId|0xd00d
• gHiKeyTokenSpaceGuid.PcdAndroidFastbootNvmDevicePath|L"VenHw(b549f005-4bd4-4020-a0cb-06f42bda68c3)"
• # Flash limit 128M/time, for memory concern
• gHiKeyTokenSpaceGuid.PcdArmFastbootFlashLimit|"134217728"

################################################################################ # @@ -395,6 +403,7 @@ # # GPIO #

• OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf ArmPlatformPkg/Drivers/PL061GpioDxe/PL061GpioDxe.inf

# @@ -416,6 +425,9 @@ # # USB Peripheral Support #

• OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf
• OpenPlatformPkg/Drivers/Usb/DwUsbDxe/DwUsbDxe.inf
• OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.inf EmbeddedPkg/Drivers/AndroidFastbootTransportUsbDxe/FastbootTransportUsbDxe.inf

# @@ -451,6 +463,7 @@ MdeModulePkg/Universal/Disk/DiskIoDxe/DiskIoDxe.inf MdeModulePkg/Universal/Disk/PartitionDxe/PartitionDxe.inf MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/EnglishDxe.inf

• FatPkg/EnhancedFatDxe/Fat.inf

# # Bds diff --git a/Platforms/Hisilicon/HiKey/HiKey.fdf b/Platforms/Hisilicon/HiKey/HiKey.fdf index 9c8c54a..693206f 100644 --- a/Platforms/Hisilicon/HiKey/HiKey.fdf +++ b/Platforms/Hisilicon/HiKey/HiKey.fdf @@ -117,6 +117,7 @@ READ_LOCK_STATUS = TRUE # # GPIO #

• INF OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKeyGpioDxe/HiKeyGpioDxe.inf INF ArmPlatformPkg/Drivers/PL061GpioDxe/PL061GpioDxe.inf

# @@ -138,6 +139,9 @@ READ_LOCK_STATUS = TRUE # # USB Peripheral Support #

• INF OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKeyUsbDxe/HiKeyUsbDxe.inf
• INF OpenPlatformPkg/Drivers/Usb/DwUsbDxe/DwUsbDxe.inf
• INF OpenPlatformPkg/Platforms/Hisilicon/HiKey/HiKeyFastbootDxe/HiKeyFastbootDxe.inf INF EmbeddedPkg/Drivers/AndroidFastbootTransportUsbDxe/FastbootTransportUsbDxe.inf

# @@ -168,7 +172,7 @@ READ_LOCK_STATUS = TRUE # INF MdeModulePkg/Universal/Disk/DiskIoDxe/DiskIoDxe.inf INF MdeModulePkg/Universal/Disk/PartitionDxe/PartitionDxe.inf

• INF FatBinPkg/EnhancedFatDxe/Fat.inf

• INF FatPkg/EnhancedFatDxe/Fat.inf INF MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/EnglishDxe.inf

INF MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf -- 2.7.4