ArmPlatformPkg: Apply uncrustify changes

[mirror_edk2.git] / ArmPlatformPkg / Drivers / NorFlashDxe / NorFlash.h

/** @file  NorFlash.h\r
\r
  Copyright (c) 2011 - 2014, ARM Ltd. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __NOR_FLASH_H__\r
#define __NOR_FLASH_H__\r
\r
#include <Base.h>\r
#include <PiDxe.h>\r
\r
#include <Guid/EventGroup.h>\r
\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/DiskIo.h>\r
#include <Protocol/FirmwareVolumeBlock.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/NorFlashPlatformLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
\r
#define NOR_FLASH_ERASE_RETRY  10\r
\r
// Device access macros\r
// These are necessary because we use 2 x 16bit parts to make up 32bit data\r
\r
#define HIGH_16_BITS  0xFFFF0000\r
#define LOW_16_BITS   0x0000FFFF\r
#define LOW_8_BITS    0x000000FF\r
\r
#define FOLD_32BIT_INTO_16BIT(value)  ( ( value >> 16 ) | ( value & LOW_16_BITS ) )\r
\r
#define GET_LOW_BYTE(value)   ( value & LOW_8_BITS )\r
#define GET_HIGH_BYTE(value)  ( GET_LOW_BYTE( value >> 16 ) )\r
\r
// Each command must be sent simultaneously to both chips,\r
// i.e. at the lower 16 bits AND at the higher 16 bits\r
#define CREATE_NOR_ADDRESS(BaseAddr, OffsetAddr)       ((BaseAddr) + ((OffsetAddr) << 2))\r
#define CREATE_DUAL_CMD(Cmd)                           ( ( Cmd << 16) | ( Cmd & LOW_16_BITS) )\r
#define SEND_NOR_COMMAND(BaseAddr, Offset, Cmd)        MmioWrite32 (CREATE_NOR_ADDRESS(BaseAddr,Offset), CREATE_DUAL_CMD(Cmd))\r
#define GET_NOR_BLOCK_ADDRESS(BaseAddr, Lba, LbaSize)  ( BaseAddr + (UINTN)((Lba) * LbaSize) )\r
\r
// Status Register Bits\r
#define P30_SR_BIT_WRITE            (BIT7 << 16 | BIT7)\r
#define P30_SR_BIT_ERASE_SUSPEND    (BIT6 << 16 | BIT6)\r
#define P30_SR_BIT_ERASE            (BIT5 << 16 | BIT5)\r
#define P30_SR_BIT_PROGRAM          (BIT4 << 16 | BIT4)\r
#define P30_SR_BIT_VPP              (BIT3 << 16 | BIT3)\r
#define P30_SR_BIT_PROGRAM_SUSPEND  (BIT2 << 16 | BIT2)\r
#define P30_SR_BIT_BLOCK_LOCKED     (BIT1 << 16 | BIT1)\r
#define P30_SR_BIT_BEFP             (BIT0 << 16 | BIT0)\r
\r
// Device Commands for Intel StrataFlash(R) Embedded Memory (P30) Family\r
\r
// On chip buffer size for buffered programming operations\r
// There are 2 chips, each chip can buffer up to 32 (16-bit)words, and each word is 2 bytes.\r
// Therefore the total size of the buffer is 2 x 32 x 2 = 128 bytes\r
#define P30_MAX_BUFFER_SIZE_IN_BYTES  ((UINTN)128)\r
#define P30_MAX_BUFFER_SIZE_IN_WORDS  (P30_MAX_BUFFER_SIZE_IN_BYTES/((UINTN)4))\r
#define MAX_BUFFERED_PROG_ITERATIONS  10000000\r
#define BOUNDARY_OF_32_WORDS          0x7F\r
\r
// CFI Addresses\r
#define P30_CFI_ADDR_QUERY_UNIQUE_QRY  0x10\r
#define P30_CFI_ADDR_VENDOR_ID         0x13\r
\r
// CFI Data\r
#define CFI_QRY  0x00595251\r
\r
// READ Commands\r
#define P30_CMD_READ_DEVICE_ID         0x0090\r
#define P30_CMD_READ_STATUS_REGISTER   0x0070\r
#define P30_CMD_CLEAR_STATUS_REGISTER  0x0050\r
#define P30_CMD_READ_ARRAY             0x00FF\r
#define P30_CMD_READ_CFI_QUERY         0x0098\r
\r
// WRITE Commands\r
#define P30_CMD_WORD_PROGRAM_SETUP            0x0040\r
#define P30_CMD_ALTERNATE_WORD_PROGRAM_SETUP  0x0010\r
#define P30_CMD_BUFFERED_PROGRAM_SETUP        0x00E8\r
#define P30_CMD_BUFFERED_PROGRAM_CONFIRM      0x00D0\r
#define P30_CMD_BEFP_SETUP                    0x0080\r
#define P30_CMD_BEFP_CONFIRM                  0x00D0\r
\r
// ERASE Commands\r
#define P30_CMD_BLOCK_ERASE_SETUP    0x0020\r
#define P30_CMD_BLOCK_ERASE_CONFIRM  0x00D0\r
\r
// SUSPEND Commands\r
#define P30_CMD_PROGRAM_OR_ERASE_SUSPEND  0x00B0\r
#define P30_CMD_SUSPEND_RESUME            0x00D0\r
\r
// BLOCK LOCKING / UNLOCKING Commands\r
#define P30_CMD_LOCK_BLOCK_SETUP  0x0060\r
#define P30_CMD_LOCK_BLOCK        0x0001\r
#define P30_CMD_UNLOCK_BLOCK      0x00D0\r
#define P30_CMD_LOCK_DOWN_BLOCK   0x002F\r
\r
// PROTECTION Commands\r
#define P30_CMD_PROGRAM_PROTECTION_REGISTER_SETUP  0x00C0\r
\r
// CONFIGURATION Commands\r
#define P30_CMD_READ_CONFIGURATION_REGISTER_SETUP  0x0060\r
#define P30_CMD_READ_CONFIGURATION_REGISTER        0x0003\r
\r
#define NOR_FLASH_SIGNATURE  SIGNATURE_32('n', 'o', 'r', '0')\r
#define INSTANCE_FROM_FVB_THIS(a)     CR(a, NOR_FLASH_INSTANCE, FvbProtocol, NOR_FLASH_SIGNATURE)\r
#define INSTANCE_FROM_BLKIO_THIS(a)   CR(a, NOR_FLASH_INSTANCE, BlockIoProtocol, NOR_FLASH_SIGNATURE)\r
#define INSTANCE_FROM_DISKIO_THIS(a)  CR(a, NOR_FLASH_INSTANCE, DiskIoProtocol, NOR_FLASH_SIGNATURE)\r
\r
typedef struct _NOR_FLASH_INSTANCE NOR_FLASH_INSTANCE;\r
\r
#pragma pack (1)\r
typedef struct {\r
  VENDOR_DEVICE_PATH          Vendor;\r
  UINT8                       Index;\r
  EFI_DEVICE_PATH_PROTOCOL    End;\r
} NOR_FLASH_DEVICE_PATH;\r
#pragma pack ()\r
\r
struct _NOR_FLASH_INSTANCE {\r
  UINT32                                 Signature;\r
  EFI_HANDLE                             Handle;\r
\r
  UINTN                                  DeviceBaseAddress;\r
  UINTN                                  RegionBaseAddress;\r
  UINTN                                  Size;\r
  EFI_LBA                                StartLba;\r
\r
  EFI_BLOCK_IO_PROTOCOL                  BlockIoProtocol;\r
  EFI_BLOCK_IO_MEDIA                     Media;\r
  EFI_DISK_IO_PROTOCOL                   DiskIoProtocol;\r
\r
  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL    FvbProtocol;\r
  VOID                                   *ShadowBuffer;\r
\r
  NOR_FLASH_DEVICE_PATH                  DevicePath;\r
};\r
\r
EFI_STATUS\r
NorFlashReadCfiData (\r
  IN  UINTN   DeviceBaseAddress,\r
  IN  UINTN   CFI_Offset,\r
  IN  UINT32  NumberOfBytes,\r
  OUT UINT32  *Data\r
  );\r
\r
EFI_STATUS\r
NorFlashWriteBuffer (\r
  IN NOR_FLASH_INSTANCE  *Instance,\r
  IN UINTN               TargetAddress,\r
  IN UINTN               BufferSizeInBytes,\r
  IN UINT32              *Buffer\r
  );\r
\r
//\r
// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.Reset\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashBlockIoReset (\r
  IN EFI_BLOCK_IO_PROTOCOL  *This,\r
  IN BOOLEAN                ExtendedVerification\r
  );\r
\r
//\r
// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.ReadBlocks\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashBlockIoReadBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL  *This,\r
  IN  UINT32                 MediaId,\r
  IN  EFI_LBA                Lba,\r
  IN  UINTN                  BufferSizeInBytes,\r
  OUT VOID                   *Buffer\r
  );\r
\r
//\r
// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.WriteBlocks\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashBlockIoWriteBlocks (\r
  IN  EFI_BLOCK_IO_PROTOCOL  *This,\r
  IN  UINT32                 MediaId,\r
  IN  EFI_LBA                Lba,\r
  IN  UINTN                  BufferSizeInBytes,\r
  IN  VOID                   *Buffer\r
  );\r
\r
//\r
// BlockIO Protocol function EFI_BLOCK_IO_PROTOCOL.FlushBlocks\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashBlockIoFlushBlocks (\r
  IN EFI_BLOCK_IO_PROTOCOL  *This\r
  );\r
\r
//\r
// DiskIO Protocol function EFI_DISK_IO_PROTOCOL.ReadDisk\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashDiskIoReadDisk (\r
  IN EFI_DISK_IO_PROTOCOL  *This,\r
  IN UINT32                MediaId,\r
  IN UINT64                Offset,\r
  IN UINTN                 BufferSize,\r
  OUT VOID                 *Buffer\r
  );\r
\r
//\r
// DiskIO Protocol function EFI_DISK_IO_PROTOCOL.WriteDisk\r
//\r
EFI_STATUS\r
EFIAPI\r
NorFlashDiskIoWriteDisk (\r
  IN EFI_DISK_IO_PROTOCOL  *This,\r
  IN UINT32                MediaId,\r
  IN UINT64                Offset,\r
  IN UINTN                 BufferSize,\r
  IN VOID                  *Buffer\r
  );\r
\r
//\r
// NorFlashFvbDxe.c\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
FvbGetAttributes (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL  *This,\r
  OUT       EFI_FVB_ATTRIBUTES_2                 *Attributes\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbSetAttributes (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL  *This,\r
  IN OUT    EFI_FVB_ATTRIBUTES_2                 *Attributes\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbGetPhysicalAddress (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL  *This,\r
  OUT       EFI_PHYSICAL_ADDRESS                 *Address\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbGetBlockSize (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL  *This,\r
  IN        EFI_LBA                              Lba,\r
  OUT       UINTN                                *BlockSize,\r
  OUT       UINTN                                *NumberOfBlocks\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbRead (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL  *This,\r
  IN        EFI_LBA                              Lba,\r
  IN        UINTN                                Offset,\r
  IN OUT    UINTN                                *NumBytes,\r
  IN OUT    UINT8                                *Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbWrite (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL  *This,\r
  IN        EFI_LBA                              Lba,\r
  IN        UINTN                                Offset,\r
  IN OUT    UINTN                                *NumBytes,\r
  IN        UINT8                                *Buffer\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
FvbEraseBlocks (\r
  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL  *This,\r
  ...\r
  );\r
\r
EFI_STATUS\r
ValidateFvHeader (\r
  IN  NOR_FLASH_INSTANCE  *Instance\r
  );\r
\r
EFI_STATUS\r
InitializeFvAndVariableStoreHeaders (\r
  IN NOR_FLASH_INSTANCE  *Instance\r
  );\r
\r
VOID\r
EFIAPI\r
FvbVirtualNotifyEvent (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
//\r
// NorFlashDxe.c\r
//\r
\r
EFI_STATUS\r
NorFlashWriteFullBlock (\r
  IN NOR_FLASH_INSTANCE  *Instance,\r
  IN EFI_LBA             Lba,\r
  IN UINT32              *DataBuffer,\r
  IN UINT32              BlockSizeInWords\r
  );\r
\r
EFI_STATUS\r
NorFlashUnlockAndEraseSingleBlock (\r
  IN NOR_FLASH_INSTANCE  *Instance,\r
  IN UINTN               BlockAddress\r
  );\r
\r
EFI_STATUS\r
NorFlashCreateInstance (\r
  IN UINTN                NorFlashDeviceBase,\r
  IN UINTN                NorFlashRegionBase,\r
  IN UINTN                NorFlashSize,\r
  IN UINT32               Index,\r
  IN UINT32               BlockSize,\r
  IN BOOLEAN              SupportFvb,\r
  OUT NOR_FLASH_INSTANCE  **NorFlashInstance\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
NorFlashFvbInitialize (\r
  IN NOR_FLASH_INSTANCE  *Instance\r
  );\r
\r
//\r
// NorFlash.c\r
//\r
EFI_STATUS\r
NorFlashWriteSingleBlock (\r
  IN        NOR_FLASH_INSTANCE  *Instance,\r
  IN        EFI_LBA             Lba,\r
  IN        UINTN               Offset,\r
  IN OUT    UINTN               *NumBytes,\r
  IN        UINT8               *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashWriteBlocks (\r
  IN  NOR_FLASH_INSTANCE  *Instance,\r
  IN  EFI_LBA             Lba,\r
  IN  UINTN               BufferSizeInBytes,\r
  IN  VOID                *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashReadBlocks (\r
  IN NOR_FLASH_INSTANCE  *Instance,\r
  IN EFI_LBA             Lba,\r
  IN UINTN               BufferSizeInBytes,\r
  OUT VOID               *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashRead (\r
  IN NOR_FLASH_INSTANCE  *Instance,\r
  IN EFI_LBA             Lba,\r
  IN UINTN               Offset,\r
  IN UINTN               BufferSizeInBytes,\r
  OUT VOID               *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashWrite (\r
  IN        NOR_FLASH_INSTANCE  *Instance,\r
  IN        EFI_LBA             Lba,\r
  IN        UINTN               Offset,\r
  IN OUT    UINTN               *NumBytes,\r
  IN        UINT8               *Buffer\r
  );\r
\r
EFI_STATUS\r
NorFlashReset (\r
  IN  NOR_FLASH_INSTANCE  *Instance\r
  );\r
\r
EFI_STATUS\r
NorFlashEraseSingleBlock (\r
  IN NOR_FLASH_INSTANCE  *Instance,\r
  IN UINTN               BlockAddress\r
  );\r
\r
EFI_STATUS\r
NorFlashUnlockSingleBlockIfNecessary (\r
  IN NOR_FLASH_INSTANCE  *Instance,\r
  IN UINTN               BlockAddress\r
  );\r
\r
EFI_STATUS\r
NorFlashWriteSingleWord (\r
  IN NOR_FLASH_INSTANCE  *Instance,\r
  IN UINTN               WordAddress,\r
  IN UINT32              WriteData\r
  );\r
\r
VOID\r
EFIAPI\r
NorFlashVirtualNotifyEvent (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
#endif /* __NOR_FLASH_H__ */\r