coreboot
coreboot is an Open Source project aimed at replacing the proprietary BIOS found in most computers.
fast_spi_def.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 
3 #ifndef SOC_INTEL_COMMON_BLOCK_FAST_SPI_DEF_H
4 #define SOC_INTEL_COMMON_BLOCK_FAST_SPI_DEF_H
5 
6 /* PCI configuration registers */
7 
8 #define SPI_BIOS_CONTROL 0xdc
9 
10 /* Extended Bios Support Registers */
11 #define SPI_CFG_BAR1 0xe0 /* SPI BAR1 MMIO */
12 
13 /* Bit definitions for BIOS_CONTROL */
14 #define SPI_BIOS_CONTROL_WPD (1 << 0)
15 #define SPI_BIOS_CONTROL_LOCK_ENABLE (1 << 1)
16 #define SPI_BIOS_CONTROL_CACHE_DISABLE (1 << 2)
17 #define SPI_BIOS_CONTROL_PREFETCH_ENABLE (1 << 3)
18 #define SPI_BIOS_CONTROL_EISS (1 << 5)
19 #define SPI_BIOS_CONTROL_BILD (1 << 7)
20 #define SPI_BIOS_CONTROL_SYNC_SS (1 << 8)
21 #define SPI_BIOS_CONTROL_EXT_BIOS_ENABLE (1 << 27)
22 #define SPI_BIOS_CONTROL_EXT_BIOS_LOCK_ENABLE (1 << 28)
23 #define SPI_BIOS_CONTROL_EXT_BIOS_LIMIT(x) ((x) & ~(0xfff))
24 
25 /* Register offsets from the MMIO region base (PCI_BASE_ADDRESS_0) */
26 
27 #define SPIBAR_BFPREG 0x00
28 #define SPIBAR_HSFSTS_CTL 0x04
29 #define SPIBAR_FADDR 0x08
30 #define SPIBAR_DLOCK 0x0c
31 #define SPIBAR_FDATA(n) (0x10 + ((n) & 0xf) * 4)
32 #define SPIBAR_FPR_BASE 0x84
33 #define SPIBAR_FPR(n) (0x84 + (4 * (n)))
34 #define SPIBAR_PREOP 0xa4
35 #define SPIBAR_OPTYPE 0xa6
36 #define SPIBAR_OPMENU_LOWER 0xa8
37 #define SPIBAR_OPMENU_UPPER 0xac
38 #define SPIBAR_FDOC 0xb4
39 #define SPIBAR_FDOD 0xb8
40 #define SPIBAR_PTINX 0xcc
41 #define SPIBAR_PTDATA 0xd0
42 
43 /* Bit definitions for BFPREG (0x00) register */
44 #define SPIBAR_BFPREG_PRB_MASK 0x7fff
45 #define SPIBAR_BFPREG_PRL_SHIFT 16
46 #define SPIBAR_BFPREG_PRL_MASK (0x7fff << SPIBAR_BFPREG_PRL_SHIFT)
47 #define SPIBAR_BFPREG_SBRS (1 << 31)
48 
49 /* Bit definitions for HSFSTS_CTL (0x04) register */
50 #define SPIBAR_HSFSTS_FDBC_MASK (0x3f << 24)
51 #define SPIBAR_HSFSTS_FDBC(n) (((n) << 24) & SPIBAR_HSFSTS_FDBC_MASK)
52 #define SPIBAR_HSFSTS_WET (1 << 21)
53 #define SPIBAR_HSFSTS_FCYCLE_MASK (0xf << 17)
54 #define SPIBAR_HSFSTS_FCYCLE(cyc) (((cyc) << 17) & SPIBAR_HSFSTS_FCYCLE_MASK)
55 
56 /* Supported flash cycle types */
57 #define SPIBAR_HSFSTS_CYCLE_READ SPIBAR_HSFSTS_FCYCLE(0)
58 #define SPIBAR_HSFSTS_CYCLE_WRITE SPIBAR_HSFSTS_FCYCLE(2)
59 #define SPIBAR_HSFSTS_CYCLE_4K_ERASE SPIBAR_HSFSTS_FCYCLE(3)
60 #define SPIBAR_HSFSTS_CYCLE_64K_ERASE SPIBAR_HSFSTS_FCYCLE(4)
61 #define SPIBAR_HSFSTS_CYCLE_RD_STATUS SPIBAR_HSFSTS_FCYCLE(8)
62 
63 #define SPIBAR_HSFSTS_FGO (1 << 16)
64 #define SPIBAR_HSFSTS_FLOCKDN (1 << 15)
65 #define SPIBAR_HSFSTS_FDV (1 << 14)
66 #define SPIBAR_HSFSTS_FDOPSS (1 << 13)
67 #define SPIBAR_HSFSTS_PRR34_LOCKDN (1 << 12)
68 #define SPIBAR_HSFSTS_WRSDIS (1 << 11)
69 #define SPIBAR_HSFSTS_SAF_CE (1 << 8)
70 #define SPIBAR_HSFSTS_SAF_ACTIVE (1 << 7)
71 #define SPIBAR_HSFSTS_SAF_LE (1 << 6)
72 #define SPIBAR_HSFSTS_SCIP (1 << 5)
73 #define SPIBAR_HSFSTS_SAF_DLE (1 << 4)
74 #define SPIBAR_HSFSTS_SAF_ERROR (1 << 3)
75 #define SPIBAR_HSFSTS_AEL (1 << 2)
76 #define SPIBAR_HSFSTS_FCERR (1 << 1)
77 #define SPIBAR_HSFSTS_FDONE (1 << 0)
78 #define SPIBAR_HSFSTS_W1C_BITS 0x1ff
79 
80 /* Bit definitions for FADDR (0x08) register */
81 #define SPIBAR_FADDR_MASK 0x7ffffff
82 
83 /* Bit definitions for DLOCK (0x0c) register */
84 #define SPIBAR_DLOCK_PR0LOCKDN (1 << 8)
85 #define SPIBAR_DLOCK_PR1LOCKDN (1 << 9)
86 #define SPIBAR_DLOCK_PR2LOCKDN (1 << 10)
87 #define SPIBAR_DLOCK_PR3LOCKDN (1 << 11)
88 #define SPIBAR_DLOCK_PR4LOCKDN (1 << 12)
89 
90 /* Maximum bytes of data that can fit in FDATAn (0x10) registers */
91 #define SPIBAR_FDATA_FIFO_SIZE 0x40
92 
93 /* Bit definitions for FDOC (0xb4) register */
94 #define SPIBAR_FDOC_COMPONENT (1 << 12)
95 #define SPIBAR_FDOC_FDSI_1 (1 << 2)
96 
97 /* Flash Descriptor Component Section - Component 0 Density Bit Settings */
98 #define FLCOMP_C0DEN_MASK 0xf
99 #define FLCOMP_C0DEN_8MB 4
100 #define FLCOMP_C0DEN_16MB 5
101 #define FLCOMP_C0DEN_32MB 6
102 
103 /* Bit definitions for FPRn (0x84 + (4 * n)) registers */
104 #define SPIBAR_FPR_WPE (1 << 31) /* Flash Write protected */
105 #define SPIBAR_FPR_MAX 5
106 
107 /* Programmable values for OPMENU_LOWER(0xa8) & OPMENU_UPPER(0xac) register */
108 #define SPI_OPMENU_0 0x01 /* WRSR: Write Status Register */
109 #define SPI_OPTYPE_0 0x01 /* Write, no address */
110 #define SPI_OPMENU_1 0x02 /* BYPR: Byte Program */
111 #define SPI_OPTYPE_1 0x03 /* Write, address required */
112 #define SPI_OPMENU_2 0x03 /* READ: Read Data */
113 #define SPI_OPTYPE_2 0x02 /* Read, address required */
114 #define SPI_OPMENU_3 0x05 /* RDSR: Read Status Register */
115 #define SPI_OPTYPE_3 0x00 /* Read, no address */
116 #define SPI_OPMENU_4 0x20 /* SE20: Sector Erase 0x20 */
117 #define SPI_OPTYPE_4 0x03 /* Write, address required */
118 #define SPI_OPMENU_5 0x9f /* RDID: Read ID */
119 #define SPI_OPTYPE_5 0x00 /* Read, no address */
120 #define SPI_OPMENU_6 0xd8 /* BED8: Block Erase 0xd8 */
121 #define SPI_OPTYPE_6 0x03 /* Write, address required */
122 #define SPI_OPMENU_7 0x0b /* FAST: Fast Read */
123 #define SPI_OPTYPE_7 0x02 /* Read, address required */
124 #define SPI_OPMENU_UPPER ((SPI_OPMENU_7 << 24) | (SPI_OPMENU_6 << 16) | \
125  (SPI_OPMENU_5 << 8) | SPI_OPMENU_4)
126 #define SPI_OPMENU_LOWER ((SPI_OPMENU_3 << 24) | (SPI_OPMENU_2 << 16) | \
127  (SPI_OPMENU_1 << 8) | SPI_OPMENU_0)
128 #define SPI_OPTYPE ((SPI_OPTYPE_7 << 14) | (SPI_OPTYPE_6 << 12) | \
129  (SPI_OPTYPE_5 << 10) | (SPI_OPTYPE_4 << 8) | \
130  (SPI_OPTYPE_3 << 6) | (SPI_OPTYPE_2 << 4) | \
131  (SPI_OPTYPE_1 << 2) | (SPI_OPTYPE_0))
132 #define SPI_OPPREFIX ((0x50 << 8) | 0x06) /* EWSR and WREN */
133 
134 /*
135  * Register Offset of BIOS Vendor Specific Component Capabilities (VSCC)
136  * for Component 0 Register
137  */
138 #define SPIBAR_SFDP0_VSCC0 0xc4
139 #define SPIBAR_VSCC0_VCL (1 << 30)
140 
141 /* Bit definitions for PTINX (0xcc) register */
142 #define SPIBAR_PTINX_COMP_0 (0 << 14)
143 #define SPIBAR_PTINX_COMP_1 (1 << 14)
144 #define SPIBAR_PTINX_HORD_SFDP (0 << 12)
145 #define SPIBAR_PTINX_HORD_PARAM (1 << 12)
146 #define SPIBAR_PTINX_HORD_JEDEC (2 << 12)
147 #define SPIBAR_PTINX_IDX_MASK 0xffc
148 
149 /* Register Offsets of BIOS Flash Program Registers */
150 #define SPIBAR_RESET_LOCK 0xf0
151 #define SPIBAR_RESET_CTRL 0xf4
152 #define SPIBAR_RESET_DATA 0xf8
153 
154 /* Programmable values of Bit0 (SSL) of Set STRAP MSG LOCK (0xF0) Register */
155 #define SPIBAR_RESET_LOCK_DISABLE 0 /* Set_Strap Lock(SSL) Bit 0 = 0 */
156 #define SPIBAR_RESET_LOCK_ENABLE 1 /* Set_Strap Lock(SSL) Bit 0 = 1 */
157 
158 /* Programmable values of Bit0(SSMS) of Set STRAP MSG Control (0xF4) Register*/
159 #define SPIBAR_RESET_CTRL_SSMC 1 /* Set_Strap Mux Select(SSMS) Bit=1*/
160 
161 #define SPIBAR_HWSEQ_XFER_TIMEOUT_MS 5000
162 
163 void *fast_spi_get_bar(void);
164 
165 #endif /* SOC_INTEL_COMMON_BLOCK_FAST_SPI_DEF_H */
void * fast_spi_get_bar(void)
Definition: fast_spi.c:24