projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 63b9a685 JY |
1 | /** @file\r |
| 2 | SPI flash device header file.\r | |
| 3 | \r | |
| 4 | Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r | |
| 0eb3de2e | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 63b9a685 JY |
6 | \r |
| 7 | **/\r | |
| 8 | \r | |
| 9 | #ifndef _SPI_FLASH_DEVICE_H_\r | |
| 10 | #define _SPI_FLASH_DEVICE_H_\r | |
| 11 | \r | |
| 12 | #include <PiDxe.h>\r | |
| 13 | #include <Protocol/Spi.h>\r | |
| 14 | #include <Protocol/FirmwareVolumeBlock.h>\r | |
| 15 | \r | |
| 16 | //\r | |
| 17 | // Supported SPI Flash Devices\r | |
| 18 | //\r | |
| 19 | typedef enum {\r | |
| 20 | EnumSpiFlash25L3205D, // Macronix 32Mbit part\r | |
| 21 | EnumSpiFlashW25Q32, // Winbond 32Mbit part\r | |
| 22 | EnumSpiFlashW25X32, // Winbond 32Mbit part\r | |
| 23 | EnumSpiFlashAT25DF321, // Atmel 32Mbit part\r | |
| 24 | EnumSpiFlashQH25F320, // Intel 32Mbit part\r | |
| 25 | EnumSpiFlash25VF064C, // SST 64Mbit part\r | |
| 26 | EnumSpiFlashM25PX64, // NUMONYX 64Mbit part\r | |
| 27 | EnumSpiFlashAT25DF641, // Atmel 64Mbit part\r | |
| 28 | EnumSpiFlashS25FL064K, // Spansion 64Mbit part\r | |
| 29 | EnumSpiFlash25L6405D, // Macronix 64Mbit part\r | |
| 30 | EnumSpiFlashW25Q64, // Winbond 64Mbit part\r | |
| 31 | EnumSpiFlashW25X64, // Winbond 64Mbit part\r | |
| 32 | EnumSpiFlashQH25F640, // Intel 64Mbit part\r | |
| 33 | EnumSpiFlashMax\r | |
| 34 | } SPI_FLASH_TYPES_SUPPORTED;\r | |
| 35 | \r | |
| 36 | //\r | |
| 37 | // Flash Device commands\r | |
| 38 | //\r | |
| 39 | // If a supported device uses a command different from the list below, a device specific command\r | |
| 40 | // will be defined just below it's JEDEC id section.\r | |
| 41 | //\r | |
| 42 | #define SPI_COMMAND_WRITE 0x02\r | |
| 43 | #define SPI_COMMAND_WRITE_AAI 0xAD\r | |
| 44 | #define SPI_COMMAND_READ 0x03\r | |
| 45 | #define SPI_COMMAND_ERASE 0x20\r | |
| 46 | #define SPI_COMMAND_WRITE_DISABLE 0x04\r | |
| 47 | #define SPI_COMMAND_READ_S 0x05\r | |
| 48 | #define SPI_COMMAND_WRITE_ENABLE 0x06\r | |
| 49 | #define SPI_COMMAND_READ_ID 0xAB\r | |
| 50 | #define SPI_COMMAND_JEDEC_ID 0x9F\r | |
| 51 | #define SPI_COMMAND_WRITE_S_EN 0x50\r | |
| 52 | #define SPI_COMMAND_WRITE_S 0x01\r | |
| 53 | #define SPI_COMMAND_CHIP_ERASE 0xC7\r | |
| 54 | #define SPI_COMMAND_BLOCK_ERASE 0xD8\r | |
| 55 | \r | |
| 56 | //\r | |
| 57 | // Flash JEDEC device ids\r | |
| 58 | //\r | |
| 59 | // SST 8Mbit part\r | |
| 60 | //\r | |
| 61 | #define SPI_SST25VF080B_ID1 0xBF\r | |
| 62 | #define SPI_SST25VF080B_ID2 0x25\r | |
| 63 | #define SPI_SST25VF080B_ID3 0x8E\r | |
| 64 | //\r | |
| 65 | // SST 16Mbit part\r | |
| 66 | //\r | |
| 67 | #define SPI_SST25VF016B_ID1 0xBF\r | |
| 68 | #define SPI_SST25VF016B_ID2 0x25\r | |
| 69 | #define SPI_SST25V016BF_ID3 0x41\r | |
| 70 | //\r | |
| 71 | // Macronix 32Mbit part\r | |
| 72 | //\r | |
| 73 | // MX25 part does not support WRITE_AAI comand (0xAD)\r | |
| 74 | //\r | |
| 75 | #define SPI_MX25L3205_ID1 0xC2\r | |
| 76 | #define SPI_MX25L3205_ID2 0x20\r | |
| 77 | #define SPI_MX25L3205_ID3 0x16\r | |
| 78 | //\r | |
| 79 | // Intel 32Mbit part bottom boot\r | |
| 80 | //\r | |
| 81 | #define SPI_QH25F320_ID1 0x89\r | |
| 82 | #define SPI_QH25F320_ID2 0x89\r | |
| 83 | #define SPI_QH25F320_ID3 0x12 // 32Mbit bottom boot\r | |
| 84 | //\r | |
| 85 | // Intel 64Mbit part bottom boot\r | |
| 86 | //\r | |
| 87 | #define SPI_QH25F640_ID1 0x89\r | |
| 88 | #define SPI_QH25F640_ID2 0x89\r | |
| 89 | #define SPI_QH25F640_ID3 0x13 // 64Mbit bottom boot\r | |
| 90 | //\r | |
| 91 | // QH part does not support command 0x20 for erase; only 0xD8 (sector erase)\r | |
| 92 | // QH part has 0x40 command for erase of parameter block (8 x 8K blocks at bottom of part)\r | |
| 93 | // 0x40 command ignored if address outside of parameter block range\r | |
| 94 | //\r | |
| 95 | #define SPI_QH25F320_COMMAND_PBLOCK_ERASE 0x40\r | |
| 96 | //\r | |
| 97 | // Winbond 32Mbit part\r | |
| 98 | //\r | |
| 99 | #define SPI_W25X32_ID1 0xEF\r | |
| 100 | #define SPI_W25X32_ID2 0x30 // Memory Type\r | |
| 101 | #define SPI_W25X32_ID3 0x16 // Capacity\r | |
| 102 | #define SF_DEVICE_ID1_W25Q32 0x16\r | |
| 103 | \r | |
| 104 | //\r | |
| 105 | // Winbond 64Mbit part\r | |
| 106 | //\r | |
| 107 | #define SPI_W25X64_ID1 0xEF\r | |
| 108 | #define SPI_W25X64_ID2 0x30 // Memory Type\r | |
| 109 | #define SPI_W25X64_ID3 0x17 // Capacity\r | |
| 110 | #define SF_DEVICE_ID0_W25QXX 0x40\r | |
| 111 | #define SF_DEVICE_ID1_W25Q64 0x17\r | |
| 112 | //\r | |
| 113 | // Winbond 128Mbit part\r | |
| 114 | //\r | |
| 115 | #define SF_DEVICE_ID0_W25Q128 0x40\r | |
| 116 | #define SF_DEVICE_ID1_W25Q128 0x18\r | |
| 117 | \r | |
| 118 | //\r | |
| 119 | // Atmel 32Mbit part\r | |
| 120 | //\r | |
| 121 | #define SPI_AT26DF321_ID1 0x1F\r | |
| 122 | #define SPI_AT26DF321_ID2 0x47 // [7:5]=Family, [4:0]=Density\r | |
| 123 | #define SPI_AT26DF321_ID3 0x00\r | |
| 124 | \r | |
| 125 | #define SF_VENDOR_ID_ATMEL 0x1F\r | |
| 126 | #define SF_DEVICE_ID0_AT25DF641 0x48\r | |
| 127 | #define SF_DEVICE_ID1_AT25DF641 0x00\r | |
| 128 | \r | |
| 129 | //\r | |
| 130 | // SST 8Mbit part\r | |
| 131 | //\r | |
| 132 | #define SPI_SST25VF080B_ID1 0xBF\r | |
| 133 | #define SPI_SST25VF080B_ID2 0x25\r | |
| 134 | #define SPI_SST25VF080B_ID3 0x8E\r | |
| 135 | #define SF_DEVICE_ID0_25VF064C 0x25\r | |
| 136 | #define SF_DEVICE_ID1_25VF064C 0x4B\r | |
| 137 | \r | |
| 138 | //\r | |
| 139 | // SST 16Mbit part\r | |
| 140 | //\r | |
| 141 | #define SPI_SST25VF016B_ID1 0xBF\r | |
| 142 | #define SPI_SST25VF016B_ID2 0x25\r | |
| 143 | #define SPI_SST25V016BF_ID3 0x41\r | |
| 144 | \r | |
| 145 | //\r | |
| 146 | // Winbond 32Mbit part\r | |
| 147 | //\r | |
| 148 | #define SPI_W25X32_ID1 0xEF\r | |
| 149 | #define SPI_W25X32_ID2 0x30 // Memory Type\r | |
| 150 | #define SPI_W25X32_ID3 0x16 // Capacity\r | |
| 151 | \r | |
| 152 | #define SF_VENDOR_ID_MX 0xC2\r | |
| 153 | #define SF_DEVICE_ID0_25L6405D 0x20\r | |
| 154 | #define SF_DEVICE_ID1_25L6405D 0x17\r | |
| 155 | \r | |
| 156 | #define SF_VENDOR_ID_NUMONYX 0x20\r | |
| 157 | #define SF_DEVICE_ID0_M25PX64 0x71\r | |
| 158 | #define SF_DEVICE_ID1_M25PX64 0x17\r | |
| 159 | \r | |
| 160 | //\r | |
| 161 | // Spansion 64Mbit part\r | |
| 162 | //\r | |
| 163 | #define SF_VENDOR_ID_SPANSION 0xEF\r | |
| 164 | #define SF_DEVICE_ID0_S25FL064K 0x40\r | |
| 165 | #define SF_DEVICE_ID1_S25FL064K 0x00\r | |
| 166 | \r | |
| 167 | //\r | |
| 168 | // index for prefix opcodes\r | |
| 169 | //\r | |
| 170 | #define SPI_WREN_INDEX 0 // Prefix Opcode 0: SPI_COMMAND_WRITE_ENABLE\r | |
| 171 | #define SPI_EWSR_INDEX 1 // Prefix Opcode 1: SPI_COMMAND_WRITE_S_EN\r | |
| 172 | #define BIOS_CTRL 0xDC\r | |
| 173 | \r | |
| 174 | #define PFAB_CARD_DEVICE_ID 0x5150\r | |
| 175 | #define PFAB_CARD_VENDOR_ID 0x8086\r | |
| 176 | #define PFAB_CARD_SETUP_REGISTER 0x40\r | |
| 177 | #define PFAB_CARD_SETUP_BYTE 0x0d\r | |
| 178 | \r | |
| 179 | \r | |
| 180 | #endif\r |