blob: a974241f98d8628fbd40f9017edc23e6450e969e [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass18530302013-03-19 04:58:56 +00002/*
3 * Copyright (c) 2011 The Chromium OS Authors.
4 *
Simon Glass18530302013-03-19 04:58:56 +00005 * This file is derived from the flashrom project.
6 */
7
Bin Meng9eb43392016-02-01 01:40:36 -08008#ifndef _ICH_H_
9#define _ICH_H_
10
Simon Glass18530302013-03-19 04:58:56 +000011struct ich7_spi_regs {
12 uint16_t spis;
13 uint16_t spic;
14 uint32_t spia;
15 uint64_t spid[8];
16 uint64_t _pad;
17 uint32_t bbar;
18 uint16_t preop;
19 uint16_t optype;
20 uint8_t opmenu[8];
21} __packed;
22
23struct ich9_spi_regs {
Bin Meng9eb43392016-02-01 01:40:36 -080024 uint32_t bfpr; /* 0x00 */
Simon Glass18530302013-03-19 04:58:56 +000025 uint16_t hsfs;
26 uint16_t hsfc;
27 uint32_t faddr;
28 uint32_t _reserved0;
Bin Meng9eb43392016-02-01 01:40:36 -080029 uint32_t fdata[16]; /* 0x10 */
30 uint32_t frap; /* 0x50 */
Simon Glass18530302013-03-19 04:58:56 +000031 uint32_t freg[5];
32 uint32_t _reserved1[3];
Bin Meng9eb43392016-02-01 01:40:36 -080033 uint32_t pr[5]; /* 0x74 */
Simon Glass18530302013-03-19 04:58:56 +000034 uint32_t _reserved2[2];
Bin Meng9eb43392016-02-01 01:40:36 -080035 uint8_t ssfs; /* 0x90 */
Simon Glass18530302013-03-19 04:58:56 +000036 uint8_t ssfc[3];
Bin Meng9eb43392016-02-01 01:40:36 -080037 uint16_t preop; /* 0x94 */
Simon Glass18530302013-03-19 04:58:56 +000038 uint16_t optype;
Bin Meng9eb43392016-02-01 01:40:36 -080039 uint8_t opmenu[8]; /* 0x98 */
Simon Glass18530302013-03-19 04:58:56 +000040 uint32_t bbar;
41 uint8_t _reserved3[12];
Bin Meng9eb43392016-02-01 01:40:36 -080042 uint32_t fdoc; /* 0xb0 */
Simon Glass18530302013-03-19 04:58:56 +000043 uint32_t fdod;
44 uint8_t _reserved4[8];
Bin Meng9eb43392016-02-01 01:40:36 -080045 uint32_t afc; /* 0xc0 */
Simon Glass18530302013-03-19 04:58:56 +000046 uint32_t lvscc;
47 uint32_t uvscc;
48 uint8_t _reserved5[4];
Bin Meng9eb43392016-02-01 01:40:36 -080049 uint32_t fpb; /* 0xd0 */
Simon Glass18530302013-03-19 04:58:56 +000050 uint8_t _reserved6[28];
Bin Meng9eb43392016-02-01 01:40:36 -080051 uint32_t srdl; /* 0xf0 */
Simon Glass18530302013-03-19 04:58:56 +000052 uint32_t srdc;
Simon Glass5093bad2015-01-27 22:13:43 -070053 uint32_t scs;
54 uint32_t bcr;
Simon Glass18530302013-03-19 04:58:56 +000055} __packed;
56
57enum {
58 SPIS_SCIP = 0x0001,
59 SPIS_GRANT = 0x0002,
60 SPIS_CDS = 0x0004,
61 SPIS_FCERR = 0x0008,
62 SSFS_AEL = 0x0010,
63 SPIS_LOCK = 0x8000,
64 SPIS_RESERVED_MASK = 0x7ff0,
65 SSFS_RESERVED_MASK = 0x7fe2
66};
67
68enum {
69 SPIC_SCGO = 0x000002,
70 SPIC_ACS = 0x000004,
71 SPIC_SPOP = 0x000008,
72 SPIC_DBC = 0x003f00,
73 SPIC_DS = 0x004000,
74 SPIC_SME = 0x008000,
75 SSFC_SCF_MASK = 0x070000,
76 SSFC_RESERVED = 0xf80000,
77
78 /* Mask for speed byte, biuts 23:16 of SSFC */
79 SSFC_SCF_33MHZ = 0x01,
80};
81
82enum {
83 HSFS_FDONE = 0x0001,
84 HSFS_FCERR = 0x0002,
85 HSFS_AEL = 0x0004,
86 HSFS_BERASE_MASK = 0x0018,
87 HSFS_BERASE_SHIFT = 3,
88 HSFS_SCIP = 0x0020,
89 HSFS_FDOPSS = 0x2000,
90 HSFS_FDV = 0x4000,
91 HSFS_FLOCKDN = 0x8000
92};
93
94enum {
95 HSFC_FGO = 0x0001,
96 HSFC_FCYCLE_MASK = 0x0006,
97 HSFC_FCYCLE_SHIFT = 1,
98 HSFC_FDBC_MASK = 0x3f00,
99 HSFC_FDBC_SHIFT = 8,
100 HSFC_FSMIE = 0x8000
101};
102
103enum {
Simon Glass18530302013-03-19 04:58:56 +0000104 ICH_MAX_CMD_LEN = 5,
105};
106
107struct spi_trans {
108 uint8_t cmd[ICH_MAX_CMD_LEN];
109 int cmd_len;
110 const uint8_t *out;
111 uint32_t bytesout;
112 uint8_t *in;
113 uint32_t bytesin;
114 uint8_t type;
115 uint8_t opcode;
116 uint32_t offset;
117};
118
Stefan Roese4759dff2017-04-24 09:48:04 +0200119#define SPI_OPCODE_WRSR 0x01
120#define SPI_OPCODE_PAGE_PROGRAM 0x02
121#define SPI_OPCODE_READ 0x03
122#define SPI_OPCODE_WRDIS 0x04
123#define SPI_OPCODE_RDSR 0x05
Bin Meng9eb43392016-02-01 01:40:36 -0800124#define SPI_OPCODE_WREN 0x06
125#define SPI_OPCODE_FAST_READ 0x0b
Stefan Roese4759dff2017-04-24 09:48:04 +0200126#define SPI_OPCODE_ERASE_SECT 0x20
127#define SPI_OPCODE_READ_ID 0x9f
128#define SPI_OPCODE_ERASE_BLOCK 0xd8
129
130#define SPI_OPCODE_TYPE_READ_NO_ADDRESS 0
131#define SPI_OPCODE_TYPE_WRITE_NO_ADDRESS 1
132#define SPI_OPCODE_TYPE_READ_WITH_ADDRESS 2
133#define SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS 3
134
135#define SPI_OPMENU_0 SPI_OPCODE_WRSR
136#define SPI_OPTYPE_0 SPI_OPCODE_TYPE_WRITE_NO_ADDRESS
137
138#define SPI_OPMENU_1 SPI_OPCODE_PAGE_PROGRAM
139#define SPI_OPTYPE_1 SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS
140
141#define SPI_OPMENU_2 SPI_OPCODE_READ
142#define SPI_OPTYPE_2 SPI_OPCODE_TYPE_READ_WITH_ADDRESS
143
144#define SPI_OPMENU_3 SPI_OPCODE_RDSR
145#define SPI_OPTYPE_3 SPI_OPCODE_TYPE_READ_NO_ADDRESS
146
147#define SPI_OPMENU_4 SPI_OPCODE_ERASE_SECT
148#define SPI_OPTYPE_4 SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS
149
150#define SPI_OPMENU_5 SPI_OPCODE_READ_ID
151#define SPI_OPTYPE_5 SPI_OPCODE_TYPE_READ_NO_ADDRESS
152
153#define SPI_OPMENU_6 SPI_OPCODE_ERASE_BLOCK
154#define SPI_OPTYPE_6 SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS
155
156#define SPI_OPMENU_7 SPI_OPCODE_FAST_READ
157#define SPI_OPTYPE_7 SPI_OPCODE_TYPE_READ_WITH_ADDRESS
158
159#define SPI_OPPREFIX ((SPI_OPCODE_WREN << 8) | SPI_OPCODE_WREN)
160#define SPI_OPTYPE ((SPI_OPTYPE_7 << 14) | (SPI_OPTYPE_6 << 12) | \
161 (SPI_OPTYPE_5 << 10) | (SPI_OPTYPE_4 << 8) | \
162 (SPI_OPTYPE_3 << 6) | (SPI_OPTYPE_2 << 4) | \
163 (SPI_OPTYPE_1 << 2) | (SPI_OPTYPE_0 << 0))
164#define SPI_OPMENU_UPPER ((SPI_OPMENU_7 << 24) | (SPI_OPMENU_6 << 16) | \
165 (SPI_OPMENU_5 << 8) | (SPI_OPMENU_4 << 0))
166#define SPI_OPMENU_LOWER ((SPI_OPMENU_3 << 24) | (SPI_OPMENU_2 << 16) | \
167 (SPI_OPMENU_1 << 8) | (SPI_OPMENU_0 << 0))
Bin Meng9eb43392016-02-01 01:40:36 -0800168
Bin Meng6e670b52016-02-01 01:40:38 -0800169enum ich_version {
170 ICHV_7,
171 ICHV_9,
172};
173
Bin Meng9eb43392016-02-01 01:40:36 -0800174struct ich_spi_platdata {
Bin Meng6e670b52016-02-01 01:40:38 -0800175 enum ich_version ich_version; /* Controller version, 7 or 9 */
Bin Mengab201072017-10-18 18:20:57 -0700176 bool lockdown; /* lock down controller settings? */
Simon Glass18530302013-03-19 04:58:56 +0000177};
Bin Meng9eb43392016-02-01 01:40:36 -0800178
179struct ich_spi_priv {
Bin Meng9eb43392016-02-01 01:40:36 -0800180 int opmenu;
181 int menubytes;
182 void *base; /* Base of register set */
183 int preop;
184 int optype;
185 int addr;
186 int data;
187 unsigned databytes;
188 int status;
189 int control;
190 int bbar;
191 int bcr;
192 uint32_t *pr; /* only for ich9 */
193 int speed; /* pointer to speed control */
194 ulong max_speed; /* Maximum bus speed in MHz */
195 ulong cur_speed; /* Current bus speed */
196 struct spi_trans trans; /* current transaction in progress */
197};
198
199#endif /* _ICH_H_ */