SpiNorFlashJedecSfdpInternal.h

Go to the documentation of this file.

 
#ifndef SPI_NOR_FLASH_INSTANCE_H_
#define SPI_NOR_FLASH_INSTANCE_H_
 
#include <PiDxe.h>
#include <Protocol/SpiNorFlash.h>
#include <Protocol/SpiIo.h>
#include <IndustryStandard/SpiNorFlashJedecSfdp.h>
 
#define SPI_NOR_FLASH_SIGNATURE  SIGNATURE_32 ('s', 'n', 'f', 'm')
 
#define SPI_NOR_FLASH_FROM_THIS(a)  CR (a, SPI_NOR_FLASH_INSTANCE, Protocol, SPI_NOR_FLASH_SIGNATURE)
 
typedef struct {
  LIST_ENTRY    NextFastReadCap;     
  UINT8         FastReadInstruction; 
  UINT8         ModeClocks;          
  UINT8         WaitStates;          
} SFPD_FAST_READ_CAPBILITY_RECORD;
 
typedef struct {
  LIST_ENTRY    NextEraseType;      
  UINT16        EraseType;          
  UINT8         EraseInstruction;   
  UINT32        EraseSizeInByte;    
  UINT32        EraseTypicalTime;   
  UINT64        EraseTimeout;       
} SFDP_SUPPORTED_ERASE_TYPE_RECORD;
 
typedef enum {
  SearchEraseTypeByType = 1,
  SearchEraseTypeByCommand,
  SearchEraseTypeBySize,
  SearchEraseTypeBySmallestSize,
  SearchEraseTypeByBiggestSize
} SFDP_SEARCH_ERASE_TYPE;
 
typedef struct {
  LIST_ENTRY                                NextCommand;          
  UINT32                                    CommandAddress;       
  UINT8                                     CommandInstruction;   
  UINT8                                     LatencyInClock;       
  SPDF_CONFIGURATION_COMMAND_ADDR_LENGTH    CommandAddressLength; 
  UINT8                                     ConfigurationBitMask; 
} SFDP_SECTOR_MAP_DETECTION_RECORD;
 
typedef struct {
  LIST_ENTRY    NextRegion;                                      
  UINT32        RegionAddress;                                   
  UINT32        RegionTotalSize;                                 
  UINT32        RegionSectors;                                   
  UINT32        SectorSize;                                      
  UINT8         SupportedEraseTypeNum;                           
  UINT8         SupportedEraseType[SFDP_ERASE_TYPES_NUMBER];     
  UINT32        EraseTypeBySizeBitmap;                           
} SFDP_SECTOR_REGION_RECORD;
 
typedef struct {
  LIST_ENTRY    NextDescriptor;                                  
  UINT8         ConfigurationId;                                 
  UINT8         RegionCount;                                     
  LIST_ENTRY    RegionList;                                      
} SFDP_SECTOR_MAP_RECORD;
 
typedef struct {
  UINTN                         Signature;
  EFI_HANDLE                    Handle;
  EFI_SPI_NOR_FLASH_PROTOCOL    Protocol;
  EFI_SPI_IO_PROTOCOL           *SpiIo;
  UINT32                        SfdpBasicFlashByteCount;
  UINT32                        SfdpSectorMapByteCount;
  SFDP_BASIC_FLASH_PARAMETER    *SfdpBasicFlash;
  SFDP_SECTOR_MAP_TABLE         *SfdpFlashSectorMap;
  UINT8                         *SpiTransactionWriteBuffer;
  UINT32                        SpiTransactionWriteBufferIndex;
  //
  // SFDP information.
  //
  SFDP_HEADER                   SfdpHeader;              
  UINT32                        FlashDeviceSize;         
  UINT8                         CurrentAddressBytes;     
 
  //
  // This is a linked list in which the Fast Read capability tables
  // are linked from the low performance transfer to higher performance
  // transfer. The SPI read would use the first Fast Read entry for
  // SPI read operation.
  //
  LIST_ENTRY                    FastReadTableList;
 
  LIST_ENTRY                    SupportedEraseTypes;      
  BOOLEAN                       Uniform4KEraseSupported;  
  BOOLEAN                       WriteEnableLatchRequired; 
  UINT8                         WriteEnableLatchCommand;  
  //
  // Below is the linked list of flash device sector
  // map configuration detection command and map descriptors.
  //
  BOOLEAN                       ConfigurationCommandsNeeded; 
  LIST_ENTRY                    ConfigurationCommandList;    
  LIST_ENTRY                    ConfigurationMapList;        
  SFDP_SECTOR_MAP_RECORD        *CurrentSectorMap;           
} SPI_NOR_FLASH_INSTANCE;
 
EFI_STATUS
GetFastReadParameter (
  IN     SPI_NOR_FLASH_INSTANCE  *Instance,
  IN OUT UINT8                   *FastReadInstruction,
  IN OUT UINT8                   *FastReadOperationClock,
  IN OUT UINT8                   *FastReadDummyClocks
  );
 
EFI_STATUS
ReadSfdpBasicParameterTable (
  IN  SPI_NOR_FLASH_INSTANCE  *Instance
  );
 
EFI_STATUS
ReadSfdpSectorMapParameterTable (
  IN  SPI_NOR_FLASH_INSTANCE  *Instance
  );
 
UINT32
SfdpGetFlashSize (
  IN  SPI_NOR_FLASH_INSTANCE  *Instance
  );
 
EFI_STATUS
ReadSfdp (
  IN  SPI_NOR_FLASH_INSTANCE  *Instance
  );
 
EFI_STATUS
SetSectorEraseBlockSize (
  IN  SPI_NOR_FLASH_INSTANCE  *Instance
  );
 
EFI_STATUS
GetEraseBlockAttribute (
  IN     SPI_NOR_FLASH_INSTANCE     *Instance,
  IN     SFDP_SECTOR_REGION_RECORD  *FlashRegion,
  IN     UINT32                     FlashAddress,
  IN     UINT32                     RemainingSize,
  IN OUT UINT32                     *BlockSizeToErase,
  IN OUT UINT32                     *BlockCountToErase,
  OUT    UINT8                      *BlockEraseCommand,
  OUT    UINT32                     *TypicalTime,
  OUT    UINT64                     *MaximumTimeout
  );
 
EFI_STATUS
GetRegionByFlashAddress (
  IN  SPI_NOR_FLASH_INSTANCE     *Instance,
  IN  UINT32                     FlashAddress,
  OUT SFDP_SECTOR_REGION_RECORD  **FlashRegion
  );
 
EFI_STATUS
InitialSpiNorFlashSfdpInstance (
  IN SPI_NOR_FLASH_INSTANCE  *Instance
  );
 
#endif // SPI_NOR_FLASH_INSTANCE_H_