Marvell/Drivers: MvSpiFlash: Enable dynamic SPI Flash detection

Hitherto mechanism of fixing SPI flash model in the PCDs,
occured to be very inefficient and problematic. Enable
dynamic detection by reworking MvSpiFlashReadId() command,
which now uses newly added NorFlashInfoLib, that helps to
obtain description of the JEDEC compliant devices.

This patch updates the MvSpiFlashProtocol ReadId() protocol
callback on both producer's (MvFlashDxe) and consumers' sides
(FirmwareUpdate and SpiTool applications). Because all
information about detected SPI NOR flash is now stored in
the obtained NorFlashInfo structure fields, use them instead
of the PCDs.

Enable compilation of the NorFlashInfoLib and update
PortingGuide documentation accordingly.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Marcin Wojtas <mw@semihalf.com>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

13 files changed, 48 insertions, 98 deletions

diff --git a/Platform/Marvell/Applications/FirmwareUpdate/FUpdate.c b/Platform/Marvell/Applications/FirmwareUpdate/FUpdate.c
index 8a2ad3fb54..750e52a0ae 100644
--- a/Platform/Marvell/Applications/FirmwareUpdate/FUpdate.c
+++ b/Platform/Marvell/Applications/FirmwareUpdate/FUpdate.c
@@ -94,14 +94,9 @@ SpiFlashProbe (
   )

 {

   EFI_STATUS       Status;

-  UINT32           FlashIdLen;

-  UINT8           *FlashId;

-

-  FlashId = (UINT8 *)PcdGetPtr (PcdSpiFlashId);

-  FlashIdLen = PcdGetSize (PcdSpiFlashId);

 

   // Read SPI flash ID

-  Status = SpiFlashProtocol->ReadId (Slave, FlashIdLen, FlashId);

+  Status = SpiFlashProtocol->ReadId (Slave, FALSE);

   if (EFI_ERROR (Status)) {

     return SHELL_ABORTED;

   }

diff --git a/Platform/Marvell/Applications/FirmwareUpdate/FUpdate.inf b/Platform/Marvell/Applications/FirmwareUpdate/FUpdate.inf
index 92c3333137..53ea4916d6 100644
--- a/Platform/Marvell/Applications/FirmwareUpdate/FUpdate.inf
+++ b/Platform/Marvell/Applications/FirmwareUpdate/FUpdate.inf
@@ -44,6 +44,7 @@
   FUpdate.uni

 

 [Packages]

+  EmbeddedPkg/EmbeddedPkg.dec

   MdeModulePkg/MdeModulePkg.dec

   MdePkg/MdePkg.dec

   Platform/Marvell/Marvell.dec

@@ -64,9 +65,6 @@
   UefiLib

   UefiRuntimeServicesTableLib

 

-[Pcd]

- gMarvellTokenSpaceGuid.PcdSpiFlashId

-

 [Protocols]

  gMarvellSpiFlashProtocolGuid

  gMarvellSpiMasterProtocolGuid

diff --git a/Platform/Marvell/Applications/SpiTool/SpiFlashCmd.c b/Platform/Marvell/Applications/SpiTool/SpiFlashCmd.c
index 7c81bfc0d0..68a6cf756b 100644
--- a/Platform/Marvell/Applications/SpiTool/SpiFlashCmd.c
+++ b/Platform/Marvell/Applications/SpiTool/SpiFlashCmd.c
@@ -166,13 +166,8 @@ FlashProbe (
   )

 {

   EFI_STATUS Status;

-  UINT32     FlashIdLen;

-  UINT8      *FlashId;

 

-  FlashId = (UINT8 *)PcdGetPtr (PcdSpiFlashId);

-  FlashIdLen = PcdGetSize (PcdSpiFlashId);

-

-  Status = SpiFlashProtocol->ReadId (Slave, FlashIdLen, FlashId);

+  Status = SpiFlashProtocol->ReadId (Slave, FALSE);

   if (EFI_ERROR (Status)) {

     return SHELL_ABORTED;

   }

diff --git a/Platform/Marvell/Applications/SpiTool/SpiFlashCmd.inf b/Platform/Marvell/Applications/SpiTool/SpiFlashCmd.inf
index 887b9a5514..a52906bd23 100644
--- a/Platform/Marvell/Applications/SpiTool/SpiFlashCmd.inf
+++ b/Platform/Marvell/Applications/SpiTool/SpiFlashCmd.inf
@@ -44,6 +44,7 @@
  SpiFlashCmd.uni

 

 [Packages]

+ EmbeddedPkg/EmbeddedPkg.dec

  MdePkg/MdePkg.dec

  ShellPkg/ShellPkg.dec

  MdeModulePkg/MdeModulePkg.dec

@@ -66,7 +67,6 @@
 

 [Pcd]

  gMarvellTokenSpaceGuid.PcdSpiFlashCs

- gMarvellTokenSpaceGuid.PcdSpiFlashId

  gMarvellTokenSpaceGuid.PcdSpiFlashMode

 

 [Protocols]

diff --git a/Platform/Marvell/Armada/Armada.dsc.inc b/Platform/Marvell/Armada/Armada.dsc.inc
index b9fc384adb..2cd96e60a8 100644
--- a/Platform/Marvell/Armada/Armada.dsc.inc
+++ b/Platform/Marvell/Armada/Armada.dsc.inc
@@ -33,6 +33,7 @@
   ArmPlatformLib|Platform/Marvell/Armada/Library/Armada70x0Lib/Armada70x0Lib.inf

   ComPhyLib|Platform/Marvell/Library/ComPhyLib/ComPhyLib.inf

   MppLib|Platform/Marvell/Library/MppLib/MppLib.inf

+  NorFlashInfoLib|EmbeddedPkg/Library/NorFlashInfoLib/NorFlashInfoLib.inf

   UtmiPhyLib|Platform/Marvell/Library/UtmiPhyLib/UtmiPhyLib.inf

 

   DebugLib|MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf

diff --git a/Platform/Marvell/Armada/Armada70x0.dsc b/Platform/Marvell/Armada/Armada70x0.dsc
index 4d5f55f076..8e4cdb2763 100644
--- a/Platform/Marvell/Armada/Armada70x0.dsc
+++ b/Platform/Marvell/Armada/Armada70x0.dsc
@@ -90,11 +90,6 @@
   gMarvellTokenSpaceGuid.PcdSpiMaxFrequency|10000000

   gMarvellTokenSpaceGuid.PcdSpiClockFrequency|200000000

 

-  gMarvellTokenSpaceGuid.PcdSpiFlashPollCmd|0x70

-  gMarvellTokenSpaceGuid.PcdSpiFlashAddressCycles|3

-  gMarvellTokenSpaceGuid.PcdSpiFlashEraseSize|65536

-  gMarvellTokenSpaceGuid.PcdSpiFlashPageSize|256

-  gMarvellTokenSpaceGuid.PcdSpiFlashId|{ 0x20, 0xBA, 0x18 }

   gMarvellTokenSpaceGuid.PcdSpiFlashMode|3

   gMarvellTokenSpaceGuid.PcdSpiFlashCs|0

 

diff --git a/Platform/Marvell/Drivers/Spi/Devices/MvSpiFlash.c b/Platform/Marvell/Drivers/Spi/Devices/MvSpiFlash.c
index ab3ed6a55a..4a97ba9283 100755
--- a/Platform/Marvell/Drivers/Spi/Devices/MvSpiFlash.c
+++ b/Platform/Marvell/Drivers/Spi/Devices/MvSpiFlash.c
@@ -107,10 +107,10 @@ MvSpiFlashWriteCommon (
   UINT8 PollBit = STATUS_REG_POLL_WIP;

   UINT8 CheckStatus = 0x0;

 

-  CmdStatus = (UINT8)PcdGet32 (PcdSpiFlashPollCmd);

-  if (CmdStatus == CMD_FLAG_STATUS) {

+  if (Slave->Info->Flags & NOR_FLASH_WRITE_FSR) {

+    CmdStatus = CMD_FLAG_STATUS;

     PollBit = STATUS_REG_POLL_PEC;

-    CheckStatus = PollBit;

+    CheckStatus = STATUS_REG_POLL_PEC;

   }

 

   // Send command

@@ -177,12 +177,20 @@ MvSpiFlashErase (
   )

 {

   EFI_STATUS Status;

-  UINT32 AddrSize, EraseAddr;

+  UINT32 EraseAddr;

   UINTN EraseSize;

   UINT8 Cmd[5];

 

-  AddrSize  = PcdGet32 (PcdSpiFlashAddressCycles);

-  EraseSize = PcdGet64 (PcdSpiFlashEraseSize);

+  if (Slave->Info->Flags & NOR_FLASH_ERASE_4K) {

+    Cmd[0] = CMD_ERASE_4K;

+    EraseSize = SIZE_4KB;

+  } else if (Slave->Info->Flags & NOR_FLASH_ERASE_32K) {

+    Cmd[0] = CMD_ERASE_32K;

+    EraseSize = SIZE_32KB;

+  } else {

+    Cmd[0] = CMD_ERASE_64K;

+    EraseSize = Slave->Info->SectorSize;

+  }

 

   // Check input parameters

   if (Offset % EraseSize || Length % EraseSize) {

@@ -191,30 +199,15 @@ MvSpiFlashErase (
     return EFI_DEVICE_ERROR;

   }

 

-  switch (EraseSize) {

-  case SIZE_4KB:

-    Cmd[0] = CMD_ERASE_4K;

-    break;

-  case SIZE_32KB:

-    Cmd[0] = CMD_ERASE_32K;

-    break;

-  case SIZE_64KB:

-    Cmd[0] = CMD_ERASE_64K;

-    break;

-  default:

-    DEBUG ((DEBUG_ERROR, "MvSpiFlash: Invalid EraseSize parameter\n"));

-    return EFI_INVALID_PARAMETER;

-  }

-

   while (Length) {

     EraseAddr = Offset;

 

     SpiFlashBank (Slave, EraseAddr);

 

-    SpiFlashFormatAddress (EraseAddr, AddrSize, Cmd);

+    SpiFlashFormatAddress (EraseAddr, Slave->AddrSize, Cmd);

 

     // Programm proper erase address

-    Status = MvSpiFlashWriteCommon (Slave, Cmd, AddrSize + 1, NULL, 0);

+    Status = MvSpiFlashWriteCommon (Slave, Cmd, Slave->AddrSize + 1, NULL, 0);

       if (EFI_ERROR (Status)) {

         DEBUG((DEBUG_ERROR, "SpiFlash: Error while programming target address\n"));

         return Status;

@@ -236,11 +229,9 @@ MvSpiFlashRead (
 {

   EFI_STATUS Status = EFI_SUCCESS;

   UINT8 Cmd[6];

-  UINT32 AddrSize, ReadAddr, ReadLength, RemainLength;

+  UINT32 ReadAddr, ReadLength, RemainLength;

   UINTN BankSel = 0;

 

-  AddrSize = PcdGet32 (PcdSpiFlashAddressCycles);

-

   Cmd[0] = CMD_READ_ARRAY_FAST;

 

   // Sign end of address with 0 byte

@@ -257,9 +248,9 @@ MvSpiFlashRead (
     } else {

       ReadLength = RemainLength;

     }

-    SpiFlashFormatAddress (ReadAddr, AddrSize, Cmd);

+    SpiFlashFormatAddress (ReadAddr, Slave->AddrSize, Cmd);

     // Program proper read address and read data

-    Status = MvSpiFlashReadCmd (Slave, Cmd, AddrSize + 2, Buf, Length);

+    Status = MvSpiFlashReadCmd (Slave, Cmd, Slave->AddrSize + 2, Buf, Length);

 

     Offset += ReadLength;

     Length -= ReadLength;

@@ -280,10 +271,9 @@ MvSpiFlashWrite (
   EFI_STATUS Status;

   UINTN ByteAddr, ChunkLength, ActualIndex, PageSize;

   UINT32 WriteAddr;

-  UINT8 Cmd[5], AddrSize;

+  UINT8 Cmd[5];

 

-  AddrSize = PcdGet32 (PcdSpiFlashAddressCycles);

-  PageSize = PcdGet32 (PcdSpiFlashPageSize);

+  PageSize = Slave->Info->PageSize;

 

   Cmd[0] = CMD_PAGE_PROGRAM;

 

@@ -296,10 +286,10 @@ MvSpiFlashWrite (
 

     ChunkLength = MIN(Length - ActualIndex, (UINT64) (PageSize - ByteAddr));

 

-    SpiFlashFormatAddress (WriteAddr, AddrSize, Cmd);

+    SpiFlashFormatAddress (WriteAddr, Slave->AddrSize, Cmd);

 

     // Program proper write address and write data

-    Status = MvSpiFlashWriteCommon (Slave, Cmd, AddrSize + 1, Buf + ActualIndex,

+    Status = MvSpiFlashWriteCommon (Slave, Cmd, Slave->AddrSize + 1, Buf + ActualIndex,

       ChunkLength);

     if (EFI_ERROR (Status)) {

       DEBUG((DEBUG_ERROR, "SpiFlash: Error while programming write address\n"));

@@ -370,7 +360,7 @@ MvSpiFlashUpdate (
   UINT64 SectorSize, ToUpdate, Scale = 1;

   UINT8 *TmpBuf, *End;

 

-  SectorSize = PcdGet64 (PcdSpiFlashSectorSize);

+  SectorSize = Slave->Info->SectorSize;

 

   End = Buf + ByteCount;

 

@@ -404,8 +394,7 @@ EFI_STATUS
 EFIAPI

 MvSpiFlashReadId (

   IN     SPI_DEVICE *SpiDev,

-  IN     UINT32     DataByteCount,

-  IN OUT UINT8      *Buffer

+  IN     BOOLEAN     UseInRuntime

   )

 {

   EFI_STATUS Status;

@@ -425,9 +414,7 @@ MvSpiFlashReadId (
     return Status;

   }

 

-  if (CompareMem (Id, Buffer, DataByteCount) != 0) {

-    Status = EFI_NOT_FOUND;

-  }

+  Status = NorFlashGetInfo (Id, &SpiDev->Info, UseInRuntime);

   if (EFI_ERROR (Status)) {

     DEBUG ((DEBUG_ERROR,

       "%a: Unrecognized JEDEC Id bytes: 0x%02x%02x%02x\n",

@@ -438,6 +425,8 @@ MvSpiFlashReadId (
     return Status;

   }

 

+  NorFlashPrintInfo (SpiDev->Info);

+

   return EFI_SUCCESS;

 }

 

@@ -450,11 +439,14 @@ MvSpiFlashInit (
 {

   EFI_STATUS Status;

   UINT8 Cmd, StatusRegister;

-  UINT32 AddrSize;

 

-  AddrSize = PcdGet32 (PcdSpiFlashAddressCycles);

+  if (Slave->Info->Flags & NOR_FLASH_4B_ADDR) {

+    Slave->AddrSize = 4;

+  } else {

+    Slave->AddrSize = 3;

+  }

 

-  if (AddrSize == 4) {

+  if (Slave->AddrSize == 4) {

     // Set 4 byte address mode

     Status = MvSpiFlashWriteEnableCmd (Slave);

     if (EFI_ERROR (Status)) {

diff --git a/Platform/Marvell/Drivers/Spi/Devices/MvSpiFlash.inf b/Platform/Marvell/Drivers/Spi/Devices/MvSpiFlash.inf
index 4519b02ea5..6587f69915 100644
--- a/Platform/Marvell/Drivers/Spi/Devices/MvSpiFlash.inf
+++ b/Platform/Marvell/Drivers/Spi/Devices/MvSpiFlash.inf
@@ -42,10 +42,12 @@
   MvSpiFlash.h

 

 [Packages]

+  EmbeddedPkg/EmbeddedPkg.dec

   MdePkg/MdePkg.dec

   Platform/Marvell/Marvell.dec

 

 [LibraryClasses]

+  NorFlashInfoLib

   UefiBootServicesTableLib

   UefiDriverEntryPoint

   TimerLib

@@ -53,13 +55,6 @@
   DebugLib

   MemoryAllocationLib

 

-[FixedPcd]

-  gMarvellTokenSpaceGuid.PcdSpiFlashAddressCycles

-  gMarvellTokenSpaceGuid.PcdSpiFlashEraseSize

-  gMarvellTokenSpaceGuid.PcdSpiFlashPageSize

-  gMarvellTokenSpaceGuid.PcdSpiFlashPollCmd

-  gMarvellTokenSpaceGuid.PcdSpiFlashSectorSize

-

 [Protocols]

   gMarvellSpiMasterProtocolGuid

   gMarvellSpiFlashProtocolGuid

diff --git a/Platform/Marvell/Drivers/Spi/MvSpiDxe.inf b/Platform/Marvell/Drivers/Spi/MvSpiDxe.inf
index d38d331f7c..08c6c04159 100644
--- a/Platform/Marvell/Drivers/Spi/MvSpiDxe.inf
+++ b/Platform/Marvell/Drivers/Spi/MvSpiDxe.inf
@@ -42,10 +42,12 @@
   MvSpiDxe.h

 

 [Packages]

+  EmbeddedPkg/EmbeddedPkg.dec

   MdePkg/MdePkg.dec

   Platform/Marvell/Marvell.dec

 

 [LibraryClasses]

+  NorFlashInfoLib

   UefiBootServicesTableLib

   UefiDriverEntryPoint

   TimerLib

diff --git a/Platform/Marvell/Include/Protocol/Spi.h b/Platform/Marvell/Include/Protocol/Spi.h
index ae78a31ca0..6f26a36b5a 100644
--- a/Platform/Marvell/Include/Protocol/Spi.h
+++ b/Platform/Marvell/Include/Protocol/Spi.h
@@ -34,6 +34,8 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #ifndef __MARVELL_SPI_MASTER_PROTOCOL_H__

 #define __MARVELL_SPI_MASTER_PROTOCOL_H__

 

+#include <Library/NorFlashInfoLib.h>

+

 extern EFI_GUID gMarvellSpiMasterProtocolGuid;

 

 typedef struct _MARVELL_SPI_MASTER_PROTOCOL MARVELL_SPI_MASTER_PROTOCOL;

@@ -49,6 +51,8 @@ typedef struct {
   INTN Cs;

   INTN MaxFreq;

   SPI_MODE Mode;

+  UINT32 AddrSize;

+  NOR_FLASH_INFO *Info;

 } SPI_DEVICE;

 

 typedef

diff --git a/Platform/Marvell/Include/Protocol/SpiFlash.h b/Platform/Marvell/Include/Protocol/SpiFlash.h
index f65a12d188..4a3053ec7e 100644
--- a/Platform/Marvell/Include/Protocol/SpiFlash.h
+++ b/Platform/Marvell/Include/Protocol/SpiFlash.h
@@ -47,8 +47,6 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #define CMD_ERASE_64K                   0xd8

 #define CMD_4B_ADDR_ENABLE              0xb7

 

-#define NOR_FLASH_MAX_ID_LEN            6

-

 extern EFI_GUID gMarvellSpiFlashProtocolGuid;

 

 typedef struct _MARVELL_SPI_FLASH_PROTOCOL MARVELL_SPI_FLASH_PROTOCOL;

@@ -64,8 +62,7 @@ typedef
 EFI_STATUS

 (EFIAPI *MV_SPI_FLASH_READ_ID) (

   IN     SPI_DEVICE *SpiDev,

-  IN     UINT32     DataByteCount,

-  IN OUT UINT8      *Buffer

+  IN     BOOLEAN     UseInRuntime

   );

 

 typedef

diff --git a/Platform/Marvell/Marvell.dec b/Platform/Marvell/Marvell.dec
index 679a9d0c80..825589536b 100644
--- a/Platform/Marvell/Marvell.dec
+++ b/Platform/Marvell/Marvell.dec
@@ -128,12 +128,6 @@
   gMarvellTokenSpaceGuid.PcdSpiMaxFrequency|0|UINT32|0x30000052

   gMarvellTokenSpaceGuid.PcdSpiClockFrequency|0|UINT32|0x30000053

 

-  gMarvellTokenSpaceGuid.PcdSpiFlashPollCmd|0|UINT32|0x3000052

-  gMarvellTokenSpaceGuid.PcdSpiFlashAddressCycles|0|UINT32|0x3000053

-  gMarvellTokenSpaceGuid.PcdSpiFlashEraseSize|0|UINT64|0x3000054

-  gMarvellTokenSpaceGuid.PcdSpiFlashPageSize|0|UINT32|0x3000055

-  gMarvellTokenSpaceGuid.PcdSpiFlashSectorSize|65536|UINT64|0x3000059

-  gMarvellTokenSpaceGuid.PcdSpiFlashId|{ 0x0 }|VOID*|0x3000056

   gMarvellTokenSpaceGuid.PcdSpiFlashCs|0|UINT32|0x3000057

   gMarvellTokenSpaceGuid.PcdSpiFlashMode|0|UINT32|0x3000058

 

diff --git a/Silicon/Marvell/Documentation/PortingGuide.txt b/Silicon/Marvell/Documentation/PortingGuide.txt
index cbe3bed59c..d5deed5171 100644
--- a/Silicon/Marvell/Documentation/PortingGuide.txt
+++ b/Silicon/Marvell/Documentation/PortingGuide.txt
@@ -312,24 +312,6 @@ SpiFlash configuration
 ======================

 Folowing PCDs for spi flash driver configuration must be set properly:

 

-  - gMarvellTokenSpaceGuid.PcdSpiFlashAddressCycles

-        (Size of SPI flash address in bytes (3 or 4) )

-

-  - gMarvellTokenSpaceGuid.PcdSpiFlashEraseSize

-        (Size of minimal erase block in bytes)

-

-  - gMarvellTokenSpaceGuid.PcdSpiFlashPageSize

-        (Size of SPI flash page)

-

-  - gMarvellTokenSpaceGuid.PcdSpiFlashSectorSize

-        (Size of SPI flash sector, 65536 bytes by default)

-

-  - gMarvellTokenSpaceGuid.PcdSpiFlashId

-        (Id of SPI flash)

-

-  - gMarvellTokenSpaceGuid.PcdSpiFlashPollCmd

-        (Spi flash polling flag)

-

   - gMarvellTokenSpaceGuid.PcdSpiFlashMode

         (Default SCLK mode (see SPI_MODE enum in file

          edk2-platforms/Platform/Marvell/Drivers/Spi/MvSpi.h))