blob: 887510bf1002c8c0bebf250627a4f368cdf301dd [file] [log] [blame]
Simon Glass18530302013-03-19 04:58:56 +00001/*
2 * Copyright (c) 2011-12 The Chromium OS Authors.
3 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02004 * SPDX-License-Identifier: GPL-2.0+
Simon Glass18530302013-03-19 04:58:56 +00005 *
6 * This file is derived from the flashrom project.
7 */
8
9#include <common.h>
Simon Glassba457562015-03-26 09:29:26 -060010#include <dm.h>
Simon Glass5093bad2015-01-27 22:13:43 -070011#include <errno.h>
Simon Glass18530302013-03-19 04:58:56 +000012#include <malloc.h>
13#include <spi.h>
14#include <pci.h>
15#include <pci_ids.h>
16#include <asm/io.h>
17
18#include "ich.h"
19
20#define SPI_OPCODE_WREN 0x06
21#define SPI_OPCODE_FAST_READ 0x0b
22
Simon Glassfffe25d2016-01-18 20:19:20 -070023#ifdef DEBUG_TRACE
24#define debug_trace(fmt, args...) debug(fmt, ##args)
25#else
26#define debug_trace(x, args...)
27#endif
28
Simon Glassba457562015-03-26 09:29:26 -060029struct ich_spi_platdata {
Simon Glass18530302013-03-19 04:58:56 +000030 pci_dev_t dev; /* PCI device number */
31 int ich_version; /* Controller version, 7 or 9 */
Simon Glass5093bad2015-01-27 22:13:43 -070032 bool use_sbase; /* Use SBASE instead of RCB */
Simon Glass18530302013-03-19 04:58:56 +000033};
34
Simon Glassba457562015-03-26 09:29:26 -060035struct ich_spi_priv {
36 int ichspi_lock;
37 int locked;
38 int opmenu;
39 int menubytes;
40 void *base; /* Base of register set */
41 int preop;
42 int optype;
43 int addr;
44 int data;
45 unsigned databytes;
46 int status;
47 int control;
48 int bbar;
Simon Glass50787922015-07-03 18:28:22 -060049 int bcr;
Simon Glassba457562015-03-26 09:29:26 -060050 uint32_t *pr; /* only for ich9 */
51 int speed; /* pointer to speed control */
52 ulong max_speed; /* Maximum bus speed in MHz */
53 ulong cur_speed; /* Current bus speed */
54 struct spi_trans trans; /* current transaction in progress */
55};
Simon Glass18530302013-03-19 04:58:56 +000056
Simon Glassba457562015-03-26 09:29:26 -060057static u8 ich_readb(struct ich_spi_priv *priv, int reg)
Simon Glass18530302013-03-19 04:58:56 +000058{
Simon Glassba457562015-03-26 09:29:26 -060059 u8 value = readb(priv->base + reg);
Simon Glass18530302013-03-19 04:58:56 +000060
Simon Glassfffe25d2016-01-18 20:19:20 -070061 debug_trace("read %2.2x from %4.4x\n", value, reg);
Simon Glass18530302013-03-19 04:58:56 +000062
63 return value;
64}
65
Simon Glassba457562015-03-26 09:29:26 -060066static u16 ich_readw(struct ich_spi_priv *priv, int reg)
Simon Glass18530302013-03-19 04:58:56 +000067{
Simon Glassba457562015-03-26 09:29:26 -060068 u16 value = readw(priv->base + reg);
Simon Glass18530302013-03-19 04:58:56 +000069
Simon Glassfffe25d2016-01-18 20:19:20 -070070 debug_trace("read %4.4x from %4.4x\n", value, reg);
Simon Glass18530302013-03-19 04:58:56 +000071
72 return value;
73}
74
Simon Glassba457562015-03-26 09:29:26 -060075static u32 ich_readl(struct ich_spi_priv *priv, int reg)
Simon Glass18530302013-03-19 04:58:56 +000076{
Simon Glassba457562015-03-26 09:29:26 -060077 u32 value = readl(priv->base + reg);
Simon Glass18530302013-03-19 04:58:56 +000078
Simon Glassfffe25d2016-01-18 20:19:20 -070079 debug_trace("read %8.8x from %4.4x\n", value, reg);
Simon Glass18530302013-03-19 04:58:56 +000080
81 return value;
82}
83
Simon Glassba457562015-03-26 09:29:26 -060084static void ich_writeb(struct ich_spi_priv *priv, u8 value, int reg)
Simon Glass18530302013-03-19 04:58:56 +000085{
Simon Glassba457562015-03-26 09:29:26 -060086 writeb(value, priv->base + reg);
Simon Glassfffe25d2016-01-18 20:19:20 -070087 debug_trace("wrote %2.2x to %4.4x\n", value, reg);
Simon Glass18530302013-03-19 04:58:56 +000088}
89
Simon Glassba457562015-03-26 09:29:26 -060090static void ich_writew(struct ich_spi_priv *priv, u16 value, int reg)
Simon Glass18530302013-03-19 04:58:56 +000091{
Simon Glassba457562015-03-26 09:29:26 -060092 writew(value, priv->base + reg);
Simon Glassfffe25d2016-01-18 20:19:20 -070093 debug_trace("wrote %4.4x to %4.4x\n", value, reg);
Simon Glass18530302013-03-19 04:58:56 +000094}
95
Simon Glassba457562015-03-26 09:29:26 -060096static void ich_writel(struct ich_spi_priv *priv, u32 value, int reg)
Simon Glass18530302013-03-19 04:58:56 +000097{
Simon Glassba457562015-03-26 09:29:26 -060098 writel(value, priv->base + reg);
Simon Glassfffe25d2016-01-18 20:19:20 -070099 debug_trace("wrote %8.8x to %4.4x\n", value, reg);
Simon Glass18530302013-03-19 04:58:56 +0000100}
101
Simon Glassba457562015-03-26 09:29:26 -0600102static void write_reg(struct ich_spi_priv *priv, const void *value,
103 int dest_reg, uint32_t size)
Simon Glass18530302013-03-19 04:58:56 +0000104{
Simon Glassba457562015-03-26 09:29:26 -0600105 memcpy_toio(priv->base + dest_reg, value, size);
Simon Glass18530302013-03-19 04:58:56 +0000106}
107
Simon Glassba457562015-03-26 09:29:26 -0600108static void read_reg(struct ich_spi_priv *priv, int src_reg, void *value,
109 uint32_t size)
Simon Glass18530302013-03-19 04:58:56 +0000110{
Simon Glassba457562015-03-26 09:29:26 -0600111 memcpy_fromio(value, priv->base + src_reg, size);
Simon Glass18530302013-03-19 04:58:56 +0000112}
113
Simon Glassba457562015-03-26 09:29:26 -0600114static void ich_set_bbar(struct ich_spi_priv *ctlr, uint32_t minaddr)
Simon Glass18530302013-03-19 04:58:56 +0000115{
116 const uint32_t bbar_mask = 0x00ffff00;
117 uint32_t ichspi_bbar;
118
119 minaddr &= bbar_mask;
Simon Glassba457562015-03-26 09:29:26 -0600120 ichspi_bbar = ich_readl(ctlr, ctlr->bbar) & ~bbar_mask;
Simon Glass18530302013-03-19 04:58:56 +0000121 ichspi_bbar |= minaddr;
Simon Glassba457562015-03-26 09:29:26 -0600122 ich_writel(ctlr, ichspi_bbar, ctlr->bbar);
Simon Glass18530302013-03-19 04:58:56 +0000123}
124
125/*
126 * Check if this device ID matches one of supported Intel PCH devices.
127 *
128 * Return the ICH version if there is a match, or zero otherwise.
129 */
130static int get_ich_version(uint16_t device_id)
131{
Bin Meng7e774032014-12-12 21:05:27 +0800132 if (device_id == PCI_DEVICE_ID_INTEL_TGP_LPC ||
Bin Meng728b3932015-02-04 16:26:12 +0800133 device_id == PCI_DEVICE_ID_INTEL_ITC_LPC ||
134 device_id == PCI_DEVICE_ID_INTEL_QRK_ILB)
Simon Glass18530302013-03-19 04:58:56 +0000135 return 7;
136
137 if ((device_id >= PCI_DEVICE_ID_INTEL_COUGARPOINT_LPC_MIN &&
138 device_id <= PCI_DEVICE_ID_INTEL_COUGARPOINT_LPC_MAX) ||
139 (device_id >= PCI_DEVICE_ID_INTEL_PANTHERPOINT_LPC_MIN &&
Simon Glass5093bad2015-01-27 22:13:43 -0700140 device_id <= PCI_DEVICE_ID_INTEL_PANTHERPOINT_LPC_MAX) ||
Simon Glass87108cf2015-03-02 12:40:52 -0700141 device_id == PCI_DEVICE_ID_INTEL_VALLEYVIEW_LPC ||
George McCollister5ac98cb2015-10-12 16:18:41 -0500142 device_id == PCI_DEVICE_ID_INTEL_LYNXPOINT_LPC ||
143 device_id == PCI_DEVICE_ID_INTEL_WILDCATPOINT_LPC)
Simon Glass18530302013-03-19 04:58:56 +0000144 return 9;
145
146 return 0;
147}
148
149/* @return 1 if the SPI flash supports the 33MHz speed */
150static int ich9_can_do_33mhz(pci_dev_t dev)
151{
152 u32 fdod, speed;
153
154 /* Observe SPI Descriptor Component Section 0 */
155 pci_write_config_dword(dev, 0xb0, 0x1000);
156
157 /* Extract the Write/Erase SPI Frequency from descriptor */
158 pci_read_config_dword(dev, 0xb4, &fdod);
159
160 /* Bits 23:21 have the fast read clock frequency, 0=20MHz, 1=33MHz */
161 speed = (fdod >> 21) & 7;
162
163 return speed == 1;
164}
165
Simon Glassba457562015-03-26 09:29:26 -0600166static int ich_find_spi_controller(struct ich_spi_platdata *ich)
Simon Glass18530302013-03-19 04:58:56 +0000167{
168 int last_bus = pci_last_busno();
169 int bus;
170
171 if (last_bus == -1) {
172 debug("No PCI busses?\n");
Simon Glass5093bad2015-01-27 22:13:43 -0700173 return -ENODEV;
Simon Glass18530302013-03-19 04:58:56 +0000174 }
175
176 for (bus = 0; bus <= last_bus; bus++) {
177 uint16_t vendor_id, device_id;
178 uint32_t ids;
179 pci_dev_t dev;
180
181 dev = PCI_BDF(bus, 31, 0);
182 pci_read_config_dword(dev, 0, &ids);
183 vendor_id = ids;
184 device_id = ids >> 16;
185
186 if (vendor_id == PCI_VENDOR_ID_INTEL) {
Simon Glass5093bad2015-01-27 22:13:43 -0700187 ich->dev = dev;
188 ich->ich_version = get_ich_version(device_id);
189 if (device_id == PCI_DEVICE_ID_INTEL_VALLEYVIEW_LPC)
190 ich->use_sbase = true;
191 return ich->ich_version == 0 ? -ENODEV : 0;
Simon Glass18530302013-03-19 04:58:56 +0000192 }
193 }
194
195 debug("ICH SPI: No ICH found.\n");
Simon Glass5093bad2015-01-27 22:13:43 -0700196 return -ENODEV;
Simon Glass18530302013-03-19 04:58:56 +0000197}
198
Simon Glassba457562015-03-26 09:29:26 -0600199static int ich_init_controller(struct ich_spi_platdata *plat,
200 struct ich_spi_priv *ctlr)
Simon Glass18530302013-03-19 04:58:56 +0000201{
202 uint8_t *rcrb; /* Root Complex Register Block */
203 uint32_t rcba; /* Root Complex Base Address */
Simon Glass5093bad2015-01-27 22:13:43 -0700204 uint32_t sbase_addr;
205 uint8_t *sbase;
Simon Glass18530302013-03-19 04:58:56 +0000206
Simon Glassba457562015-03-26 09:29:26 -0600207 pci_read_config_dword(plat->dev, 0xf0, &rcba);
Simon Glass18530302013-03-19 04:58:56 +0000208 /* Bits 31-14 are the base address, 13-1 are reserved, 0 is enable. */
209 rcrb = (uint8_t *)(rcba & 0xffffc000);
Simon Glass5093bad2015-01-27 22:13:43 -0700210
211 /* SBASE is similar */
Simon Glassba457562015-03-26 09:29:26 -0600212 pci_read_config_dword(plat->dev, 0x54, &sbase_addr);
Simon Glass5093bad2015-01-27 22:13:43 -0700213 sbase = (uint8_t *)(sbase_addr & 0xfffffe00);
214
Simon Glassba457562015-03-26 09:29:26 -0600215 if (plat->ich_version == 7) {
Simon Glass18530302013-03-19 04:58:56 +0000216 struct ich7_spi_regs *ich7_spi;
217
218 ich7_spi = (struct ich7_spi_regs *)(rcrb + 0x3020);
Simon Glassba457562015-03-26 09:29:26 -0600219 ctlr->ichspi_lock = readw(&ich7_spi->spis) & SPIS_LOCK;
220 ctlr->opmenu = offsetof(struct ich7_spi_regs, opmenu);
Simon Glass18530302013-03-19 04:58:56 +0000221 ctlr->menubytes = sizeof(ich7_spi->opmenu);
Simon Glassba457562015-03-26 09:29:26 -0600222 ctlr->optype = offsetof(struct ich7_spi_regs, optype);
223 ctlr->addr = offsetof(struct ich7_spi_regs, spia);
224 ctlr->data = offsetof(struct ich7_spi_regs, spid);
Simon Glass18530302013-03-19 04:58:56 +0000225 ctlr->databytes = sizeof(ich7_spi->spid);
Simon Glassba457562015-03-26 09:29:26 -0600226 ctlr->status = offsetof(struct ich7_spi_regs, spis);
227 ctlr->control = offsetof(struct ich7_spi_regs, spic);
228 ctlr->bbar = offsetof(struct ich7_spi_regs, bbar);
229 ctlr->preop = offsetof(struct ich7_spi_regs, preop);
Simon Glass18530302013-03-19 04:58:56 +0000230 ctlr->base = ich7_spi;
Simon Glassba457562015-03-26 09:29:26 -0600231 } else if (plat->ich_version == 9) {
Simon Glass18530302013-03-19 04:58:56 +0000232 struct ich9_spi_regs *ich9_spi;
233
Simon Glassba457562015-03-26 09:29:26 -0600234 if (plat->use_sbase)
Simon Glass5093bad2015-01-27 22:13:43 -0700235 ich9_spi = (struct ich9_spi_regs *)sbase;
236 else
237 ich9_spi = (struct ich9_spi_regs *)(rcrb + 0x3800);
Simon Glassba457562015-03-26 09:29:26 -0600238 ctlr->ichspi_lock = readw(&ich9_spi->hsfs) & HSFS_FLOCKDN;
239 ctlr->opmenu = offsetof(struct ich9_spi_regs, opmenu);
Simon Glass18530302013-03-19 04:58:56 +0000240 ctlr->menubytes = sizeof(ich9_spi->opmenu);
Simon Glassba457562015-03-26 09:29:26 -0600241 ctlr->optype = offsetof(struct ich9_spi_regs, optype);
242 ctlr->addr = offsetof(struct ich9_spi_regs, faddr);
243 ctlr->data = offsetof(struct ich9_spi_regs, fdata);
Simon Glass18530302013-03-19 04:58:56 +0000244 ctlr->databytes = sizeof(ich9_spi->fdata);
Simon Glassba457562015-03-26 09:29:26 -0600245 ctlr->status = offsetof(struct ich9_spi_regs, ssfs);
246 ctlr->control = offsetof(struct ich9_spi_regs, ssfc);
247 ctlr->speed = ctlr->control + 2;
248 ctlr->bbar = offsetof(struct ich9_spi_regs, bbar);
249 ctlr->preop = offsetof(struct ich9_spi_regs, preop);
Simon Glass50787922015-07-03 18:28:22 -0600250 ctlr->bcr = offsetof(struct ich9_spi_regs, bcr);
Simon Glass18530302013-03-19 04:58:56 +0000251 ctlr->pr = &ich9_spi->pr[0];
252 ctlr->base = ich9_spi;
253 } else {
Simon Glassba457562015-03-26 09:29:26 -0600254 debug("ICH SPI: Unrecognised ICH version %d\n",
255 plat->ich_version);
256 return -EINVAL;
Simon Glass18530302013-03-19 04:58:56 +0000257 }
Simon Glass18530302013-03-19 04:58:56 +0000258
259 /* Work out the maximum speed we can support */
260 ctlr->max_speed = 20000000;
Simon Glassba457562015-03-26 09:29:26 -0600261 if (plat->ich_version == 9 && ich9_can_do_33mhz(plat->dev))
Simon Glass18530302013-03-19 04:58:56 +0000262 ctlr->max_speed = 33000000;
Simon Glass5093bad2015-01-27 22:13:43 -0700263 debug("ICH SPI: Version %d detected at %p, speed %ld\n",
Simon Glassba457562015-03-26 09:29:26 -0600264 plat->ich_version, ctlr->base, ctlr->max_speed);
Simon Glass18530302013-03-19 04:58:56 +0000265
266 ich_set_bbar(ctlr, 0);
267
268 return 0;
269}
270
Simon Glass18530302013-03-19 04:58:56 +0000271static inline void spi_use_out(struct spi_trans *trans, unsigned bytes)
272{
273 trans->out += bytes;
274 trans->bytesout -= bytes;
275}
276
277static inline void spi_use_in(struct spi_trans *trans, unsigned bytes)
278{
279 trans->in += bytes;
280 trans->bytesin -= bytes;
281}
282
283static void spi_setup_type(struct spi_trans *trans, int data_bytes)
284{
285 trans->type = 0xFF;
286
287 /* Try to guess spi type from read/write sizes. */
288 if (trans->bytesin == 0) {
289 if (trans->bytesout + data_bytes > 4)
290 /*
291 * If bytesin = 0 and bytesout > 4, we presume this is
292 * a write data operation, which is accompanied by an
293 * address.
294 */
295 trans->type = SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS;
296 else
297 trans->type = SPI_OPCODE_TYPE_WRITE_NO_ADDRESS;
298 return;
299 }
300
301 if (trans->bytesout == 1) { /* and bytesin is > 0 */
302 trans->type = SPI_OPCODE_TYPE_READ_NO_ADDRESS;
303 return;
304 }
305
306 if (trans->bytesout == 4) /* and bytesin is > 0 */
307 trans->type = SPI_OPCODE_TYPE_READ_WITH_ADDRESS;
308
309 /* Fast read command is called with 5 bytes instead of 4 */
310 if (trans->out[0] == SPI_OPCODE_FAST_READ && trans->bytesout == 5) {
311 trans->type = SPI_OPCODE_TYPE_READ_WITH_ADDRESS;
312 --trans->bytesout;
313 }
314}
315
Simon Glassba457562015-03-26 09:29:26 -0600316static int spi_setup_opcode(struct ich_spi_priv *ctlr, struct spi_trans *trans)
Simon Glass18530302013-03-19 04:58:56 +0000317{
318 uint16_t optypes;
Simon Glassba457562015-03-26 09:29:26 -0600319 uint8_t opmenu[ctlr->menubytes];
Simon Glass18530302013-03-19 04:58:56 +0000320
321 trans->opcode = trans->out[0];
322 spi_use_out(trans, 1);
Simon Glassba457562015-03-26 09:29:26 -0600323 if (!ctlr->ichspi_lock) {
Simon Glass18530302013-03-19 04:58:56 +0000324 /* The lock is off, so just use index 0. */
Simon Glassba457562015-03-26 09:29:26 -0600325 ich_writeb(ctlr, trans->opcode, ctlr->opmenu);
326 optypes = ich_readw(ctlr, ctlr->optype);
Simon Glass18530302013-03-19 04:58:56 +0000327 optypes = (optypes & 0xfffc) | (trans->type & 0x3);
Simon Glassba457562015-03-26 09:29:26 -0600328 ich_writew(ctlr, optypes, ctlr->optype);
Simon Glass18530302013-03-19 04:58:56 +0000329 return 0;
330 } else {
331 /* The lock is on. See if what we need is on the menu. */
332 uint8_t optype;
333 uint16_t opcode_index;
334
335 /* Write Enable is handled as atomic prefix */
336 if (trans->opcode == SPI_OPCODE_WREN)
337 return 0;
338
Simon Glassba457562015-03-26 09:29:26 -0600339 read_reg(ctlr, ctlr->opmenu, opmenu, sizeof(opmenu));
340 for (opcode_index = 0; opcode_index < ctlr->menubytes;
Simon Glass18530302013-03-19 04:58:56 +0000341 opcode_index++) {
342 if (opmenu[opcode_index] == trans->opcode)
343 break;
344 }
345
Simon Glassba457562015-03-26 09:29:26 -0600346 if (opcode_index == ctlr->menubytes) {
Simon Glass18530302013-03-19 04:58:56 +0000347 printf("ICH SPI: Opcode %x not found\n",
348 trans->opcode);
Simon Glassba457562015-03-26 09:29:26 -0600349 return -EINVAL;
Simon Glass18530302013-03-19 04:58:56 +0000350 }
351
Simon Glassba457562015-03-26 09:29:26 -0600352 optypes = ich_readw(ctlr, ctlr->optype);
Simon Glass18530302013-03-19 04:58:56 +0000353 optype = (optypes >> (opcode_index * 2)) & 0x3;
354 if (trans->type == SPI_OPCODE_TYPE_WRITE_NO_ADDRESS &&
355 optype == SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS &&
356 trans->bytesout >= 3) {
357 /* We guessed wrong earlier. Fix it up. */
358 trans->type = optype;
359 }
360 if (optype != trans->type) {
361 printf("ICH SPI: Transaction doesn't fit type %d\n",
362 optype);
Simon Glassba457562015-03-26 09:29:26 -0600363 return -ENOSPC;
Simon Glass18530302013-03-19 04:58:56 +0000364 }
365 return opcode_index;
366 }
367}
368
369static int spi_setup_offset(struct spi_trans *trans)
370{
371 /* Separate the SPI address and data. */
372 switch (trans->type) {
373 case SPI_OPCODE_TYPE_READ_NO_ADDRESS:
374 case SPI_OPCODE_TYPE_WRITE_NO_ADDRESS:
375 return 0;
376 case SPI_OPCODE_TYPE_READ_WITH_ADDRESS:
377 case SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS:
378 trans->offset = ((uint32_t)trans->out[0] << 16) |
379 ((uint32_t)trans->out[1] << 8) |
380 ((uint32_t)trans->out[2] << 0);
381 spi_use_out(trans, 3);
382 return 1;
383 default:
384 printf("Unrecognized SPI transaction type %#x\n", trans->type);
Simon Glassba457562015-03-26 09:29:26 -0600385 return -EPROTO;
Simon Glass18530302013-03-19 04:58:56 +0000386 }
387}
388
389/*
390 * Wait for up to 6s til status register bit(s) turn 1 (in case wait_til_set
York Sun472d5462013-04-01 11:29:11 -0700391 * below is true) or 0. In case the wait was for the bit(s) to set - write
Simon Glass18530302013-03-19 04:58:56 +0000392 * those bits back, which would cause resetting them.
393 *
394 * Return the last read status value on success or -1 on failure.
395 */
Simon Glassba457562015-03-26 09:29:26 -0600396static int ich_status_poll(struct ich_spi_priv *ctlr, u16 bitmask,
397 int wait_til_set)
Simon Glass18530302013-03-19 04:58:56 +0000398{
399 int timeout = 600000; /* This will result in 6s */
400 u16 status = 0;
401
402 while (timeout--) {
Simon Glassba457562015-03-26 09:29:26 -0600403 status = ich_readw(ctlr, ctlr->status);
Simon Glass18530302013-03-19 04:58:56 +0000404 if (wait_til_set ^ ((status & bitmask) == 0)) {
Simon Glassba457562015-03-26 09:29:26 -0600405 if (wait_til_set) {
406 ich_writew(ctlr, status & bitmask,
407 ctlr->status);
408 }
Simon Glass18530302013-03-19 04:58:56 +0000409 return status;
410 }
411 udelay(10);
412 }
413
414 printf("ICH SPI: SCIP timeout, read %x, expected %x\n",
415 status, bitmask);
Simon Glassba457562015-03-26 09:29:26 -0600416 return -ETIMEDOUT;
Simon Glass18530302013-03-19 04:58:56 +0000417}
418
Simon Glassba457562015-03-26 09:29:26 -0600419static int ich_spi_xfer(struct udevice *dev, unsigned int bitlen,
420 const void *dout, void *din, unsigned long flags)
Simon Glass18530302013-03-19 04:58:56 +0000421{
Simon Glassba457562015-03-26 09:29:26 -0600422 struct udevice *bus = dev_get_parent(dev);
Simon Glasse1e332c2015-07-03 18:28:21 -0600423 struct ich_spi_platdata *plat = dev_get_platdata(bus);
Simon Glassba457562015-03-26 09:29:26 -0600424 struct ich_spi_priv *ctlr = dev_get_priv(bus);
Simon Glass18530302013-03-19 04:58:56 +0000425 uint16_t control;
426 int16_t opcode_index;
427 int with_address;
428 int status;
429 int bytes = bitlen / 8;
Simon Glassba457562015-03-26 09:29:26 -0600430 struct spi_trans *trans = &ctlr->trans;
Simon Glass18530302013-03-19 04:58:56 +0000431 unsigned type = flags & (SPI_XFER_BEGIN | SPI_XFER_END);
432 int using_cmd = 0;
Simon Glassba457562015-03-26 09:29:26 -0600433 int ret;
Simon Glass18530302013-03-19 04:58:56 +0000434
Simon Glass5d4a7572015-06-07 08:50:33 -0600435 /* We don't support writing partial bytes */
Simon Glass18530302013-03-19 04:58:56 +0000436 if (bitlen % 8) {
437 debug("ICH SPI: Accessing partial bytes not supported\n");
Simon Glassba457562015-03-26 09:29:26 -0600438 return -EPROTONOSUPPORT;
Simon Glass18530302013-03-19 04:58:56 +0000439 }
440
441 /* An empty end transaction can be ignored */
442 if (type == SPI_XFER_END && !dout && !din)
443 return 0;
444
445 if (type & SPI_XFER_BEGIN)
446 memset(trans, '\0', sizeof(*trans));
447
448 /* Dp we need to come back later to finish it? */
449 if (dout && type == SPI_XFER_BEGIN) {
450 if (bytes > ICH_MAX_CMD_LEN) {
451 debug("ICH SPI: Command length limit exceeded\n");
Simon Glassba457562015-03-26 09:29:26 -0600452 return -ENOSPC;
Simon Glass18530302013-03-19 04:58:56 +0000453 }
454 memcpy(trans->cmd, dout, bytes);
455 trans->cmd_len = bytes;
Simon Glassfffe25d2016-01-18 20:19:20 -0700456 debug_trace("ICH SPI: Saved %d bytes\n", bytes);
Simon Glass18530302013-03-19 04:58:56 +0000457 return 0;
458 }
459
460 /*
461 * We process a 'middle' spi_xfer() call, which has no
462 * SPI_XFER_BEGIN/END, as an independent transaction as if it had
463 * an end. We therefore repeat the command. This is because ICH
464 * seems to have no support for this, or because interest (in digging
465 * out the details and creating a special case in the code) is low.
466 */
467 if (trans->cmd_len) {
468 trans->out = trans->cmd;
469 trans->bytesout = trans->cmd_len;
470 using_cmd = 1;
Simon Glassfffe25d2016-01-18 20:19:20 -0700471 debug_trace("ICH SPI: Using %d bytes\n", trans->cmd_len);
Simon Glass18530302013-03-19 04:58:56 +0000472 } else {
473 trans->out = dout;
474 trans->bytesout = dout ? bytes : 0;
475 }
476
477 trans->in = din;
478 trans->bytesin = din ? bytes : 0;
479
480 /* There has to always at least be an opcode. */
481 if (!trans->bytesout) {
482 debug("ICH SPI: No opcode for transfer\n");
Simon Glassba457562015-03-26 09:29:26 -0600483 return -EPROTO;
Simon Glass18530302013-03-19 04:58:56 +0000484 }
485
Simon Glassba457562015-03-26 09:29:26 -0600486 ret = ich_status_poll(ctlr, SPIS_SCIP, 0);
487 if (ret < 0)
488 return ret;
Simon Glass18530302013-03-19 04:58:56 +0000489
Simon Glasse1e332c2015-07-03 18:28:21 -0600490 if (plat->ich_version == 7)
491 ich_writew(ctlr, SPIS_CDS | SPIS_FCERR, ctlr->status);
492 else
493 ich_writeb(ctlr, SPIS_CDS | SPIS_FCERR, ctlr->status);
Simon Glass18530302013-03-19 04:58:56 +0000494
495 spi_setup_type(trans, using_cmd ? bytes : 0);
Simon Glassba457562015-03-26 09:29:26 -0600496 opcode_index = spi_setup_opcode(ctlr, trans);
Simon Glass18530302013-03-19 04:58:56 +0000497 if (opcode_index < 0)
Simon Glassba457562015-03-26 09:29:26 -0600498 return -EINVAL;
Simon Glass18530302013-03-19 04:58:56 +0000499 with_address = spi_setup_offset(trans);
500 if (with_address < 0)
Simon Glassba457562015-03-26 09:29:26 -0600501 return -EINVAL;
Simon Glass18530302013-03-19 04:58:56 +0000502
503 if (trans->opcode == SPI_OPCODE_WREN) {
504 /*
505 * Treat Write Enable as Atomic Pre-Op if possible
506 * in order to prevent the Management Engine from
507 * issuing a transaction between WREN and DATA.
508 */
Simon Glassba457562015-03-26 09:29:26 -0600509 if (!ctlr->ichspi_lock)
510 ich_writew(ctlr, trans->opcode, ctlr->preop);
Simon Glass18530302013-03-19 04:58:56 +0000511 return 0;
512 }
513
Simon Glassba457562015-03-26 09:29:26 -0600514 if (ctlr->speed && ctlr->max_speed >= 33000000) {
Simon Glass18530302013-03-19 04:58:56 +0000515 int byte;
516
Simon Glassba457562015-03-26 09:29:26 -0600517 byte = ich_readb(ctlr, ctlr->speed);
518 if (ctlr->cur_speed >= 33000000)
Simon Glass18530302013-03-19 04:58:56 +0000519 byte |= SSFC_SCF_33MHZ;
520 else
521 byte &= ~SSFC_SCF_33MHZ;
Simon Glassba457562015-03-26 09:29:26 -0600522 ich_writeb(ctlr, byte, ctlr->speed);
Simon Glass18530302013-03-19 04:58:56 +0000523 }
524
525 /* See if we have used up the command data */
526 if (using_cmd && dout && bytes) {
527 trans->out = dout;
528 trans->bytesout = bytes;
Simon Glassfffe25d2016-01-18 20:19:20 -0700529 debug_trace("ICH SPI: Moving to data, %d bytes\n", bytes);
Simon Glass18530302013-03-19 04:58:56 +0000530 }
531
532 /* Preset control fields */
Simon Glassba457562015-03-26 09:29:26 -0600533 control = ich_readw(ctlr, ctlr->control);
Simon Glass18530302013-03-19 04:58:56 +0000534 control &= ~SSFC_RESERVED;
535 control = SPIC_SCGO | ((opcode_index & 0x07) << 4);
536
537 /* Issue atomic preop cycle if needed */
Simon Glassba457562015-03-26 09:29:26 -0600538 if (ich_readw(ctlr, ctlr->preop))
Simon Glass18530302013-03-19 04:58:56 +0000539 control |= SPIC_ACS;
540
541 if (!trans->bytesout && !trans->bytesin) {
542 /* SPI addresses are 24 bit only */
Simon Glassba457562015-03-26 09:29:26 -0600543 if (with_address) {
544 ich_writel(ctlr, trans->offset & 0x00FFFFFF,
545 ctlr->addr);
546 }
Simon Glass18530302013-03-19 04:58:56 +0000547 /*
548 * This is a 'no data' command (like Write Enable), its
549 * bitesout size was 1, decremented to zero while executing
550 * spi_setup_opcode() above. Tell the chip to send the
551 * command.
552 */
Simon Glassba457562015-03-26 09:29:26 -0600553 ich_writew(ctlr, control, ctlr->control);
Simon Glass18530302013-03-19 04:58:56 +0000554
555 /* wait for the result */
Simon Glassba457562015-03-26 09:29:26 -0600556 status = ich_status_poll(ctlr, SPIS_CDS | SPIS_FCERR, 1);
557 if (status < 0)
558 return status;
Simon Glass18530302013-03-19 04:58:56 +0000559
560 if (status & SPIS_FCERR) {
561 debug("ICH SPI: Command transaction error\n");
Simon Glassba457562015-03-26 09:29:26 -0600562 return -EIO;
Simon Glass18530302013-03-19 04:58:56 +0000563 }
564
565 return 0;
566 }
567
568 /*
569 * Check if this is a write command atempting to transfer more bytes
570 * than the controller can handle. Iterations for writes are not
571 * supported here because each SPI write command needs to be preceded
572 * and followed by other SPI commands, and this sequence is controlled
573 * by the SPI chip driver.
574 */
Simon Glassba457562015-03-26 09:29:26 -0600575 if (trans->bytesout > ctlr->databytes) {
Simon Glass18530302013-03-19 04:58:56 +0000576 debug("ICH SPI: Too much to write. This should be prevented by the driver's max_write_size?\n");
Simon Glassba457562015-03-26 09:29:26 -0600577 return -EPROTO;
Simon Glass18530302013-03-19 04:58:56 +0000578 }
579
580 /*
581 * Read or write up to databytes bytes at a time until everything has
582 * been sent.
583 */
584 while (trans->bytesout || trans->bytesin) {
585 uint32_t data_length;
Simon Glass18530302013-03-19 04:58:56 +0000586
587 /* SPI addresses are 24 bit only */
Simon Glassba457562015-03-26 09:29:26 -0600588 ich_writel(ctlr, trans->offset & 0x00FFFFFF, ctlr->addr);
Simon Glass18530302013-03-19 04:58:56 +0000589
590 if (trans->bytesout)
Simon Glassba457562015-03-26 09:29:26 -0600591 data_length = min(trans->bytesout, ctlr->databytes);
Simon Glass18530302013-03-19 04:58:56 +0000592 else
Simon Glassba457562015-03-26 09:29:26 -0600593 data_length = min(trans->bytesin, ctlr->databytes);
Simon Glass18530302013-03-19 04:58:56 +0000594
595 /* Program data into FDATA0 to N */
596 if (trans->bytesout) {
Simon Glassba457562015-03-26 09:29:26 -0600597 write_reg(ctlr, trans->out, ctlr->data, data_length);
Simon Glass18530302013-03-19 04:58:56 +0000598 spi_use_out(trans, data_length);
599 if (with_address)
600 trans->offset += data_length;
601 }
602
603 /* Add proper control fields' values */
Simon Glassba457562015-03-26 09:29:26 -0600604 control &= ~((ctlr->databytes - 1) << 8);
Simon Glass18530302013-03-19 04:58:56 +0000605 control |= SPIC_DS;
606 control |= (data_length - 1) << 8;
607
608 /* write it */
Simon Glassba457562015-03-26 09:29:26 -0600609 ich_writew(ctlr, control, ctlr->control);
Simon Glass18530302013-03-19 04:58:56 +0000610
611 /* Wait for Cycle Done Status or Flash Cycle Error. */
Simon Glassba457562015-03-26 09:29:26 -0600612 status = ich_status_poll(ctlr, SPIS_CDS | SPIS_FCERR, 1);
613 if (status < 0)
614 return status;
Simon Glass18530302013-03-19 04:58:56 +0000615
616 if (status & SPIS_FCERR) {
Simon Glass5d4a7572015-06-07 08:50:33 -0600617 debug("ICH SPI: Data transaction error %x\n", status);
Simon Glassba457562015-03-26 09:29:26 -0600618 return -EIO;
Simon Glass18530302013-03-19 04:58:56 +0000619 }
620
621 if (trans->bytesin) {
Simon Glassba457562015-03-26 09:29:26 -0600622 read_reg(ctlr, ctlr->data, trans->in, data_length);
Simon Glass18530302013-03-19 04:58:56 +0000623 spi_use_in(trans, data_length);
624 if (with_address)
625 trans->offset += data_length;
626 }
627 }
628
629 /* Clear atomic preop now that xfer is done */
Simon Glassba457562015-03-26 09:29:26 -0600630 ich_writew(ctlr, 0, ctlr->preop);
Simon Glass18530302013-03-19 04:58:56 +0000631
632 return 0;
633}
634
Simon Glass18530302013-03-19 04:58:56 +0000635/*
636 * This uses the SPI controller from the Intel Cougar Point and Panther Point
637 * PCH to write-protect portions of the SPI flash until reboot. The changes
638 * don't actually take effect until the HSFS[FLOCKDN] bit is set, but that's
639 * done elsewhere.
640 */
Simon Glassba457562015-03-26 09:29:26 -0600641int spi_write_protect_region(struct udevice *dev, uint32_t lower_limit,
642 uint32_t length, int hint)
Simon Glass18530302013-03-19 04:58:56 +0000643{
Simon Glassba457562015-03-26 09:29:26 -0600644 struct udevice *bus = dev->parent;
645 struct ich_spi_priv *ctlr = dev_get_priv(bus);
Simon Glass18530302013-03-19 04:58:56 +0000646 uint32_t tmplong;
647 uint32_t upper_limit;
648
Simon Glassba457562015-03-26 09:29:26 -0600649 if (!ctlr->pr) {
Simon Glass18530302013-03-19 04:58:56 +0000650 printf("%s: operation not supported on this chipset\n",
651 __func__);
Simon Glassba457562015-03-26 09:29:26 -0600652 return -ENOSYS;
Simon Glass18530302013-03-19 04:58:56 +0000653 }
654
655 if (length == 0 ||
656 lower_limit > (0xFFFFFFFFUL - length) + 1 ||
657 hint < 0 || hint > 4) {
658 printf("%s(0x%x, 0x%x, %d): invalid args\n", __func__,
659 lower_limit, length, hint);
Simon Glassba457562015-03-26 09:29:26 -0600660 return -EPERM;
Simon Glass18530302013-03-19 04:58:56 +0000661 }
662
663 upper_limit = lower_limit + length - 1;
664
665 /*
666 * Determine bits to write, as follows:
667 * 31 Write-protection enable (includes erase operation)
668 * 30:29 reserved
669 * 28:16 Upper Limit (FLA address bits 24:12, with 11:0 == 0xfff)
670 * 15 Read-protection enable
671 * 14:13 reserved
672 * 12:0 Lower Limit (FLA address bits 24:12, with 11:0 == 0x000)
673 */
674 tmplong = 0x80000000 |
675 ((upper_limit & 0x01fff000) << 4) |
676 ((lower_limit & 0x01fff000) >> 12);
677
678 printf("%s: writing 0x%08x to %p\n", __func__, tmplong,
Simon Glassba457562015-03-26 09:29:26 -0600679 &ctlr->pr[hint]);
680 ctlr->pr[hint] = tmplong;
Simon Glass18530302013-03-19 04:58:56 +0000681
682 return 0;
683}
Simon Glassba457562015-03-26 09:29:26 -0600684
685static int ich_spi_probe(struct udevice *bus)
686{
687 struct ich_spi_platdata *plat = dev_get_platdata(bus);
688 struct ich_spi_priv *priv = dev_get_priv(bus);
689 uint8_t bios_cntl;
690 int ret;
691
692 ret = ich_init_controller(plat, priv);
693 if (ret)
694 return ret;
695 /*
696 * Disable the BIOS write protect so write commands are allowed. On
697 * v9, deassert SMM BIOS Write Protect Disable.
698 */
699 if (plat->use_sbase) {
Simon Glass50787922015-07-03 18:28:22 -0600700 bios_cntl = ich_readb(priv, priv->bcr);
Jagan Teki69fd4c32015-10-23 01:37:56 +0530701 bios_cntl &= ~BIT(5); /* clear Enable InSMM_STS (EISS) */
Simon Glassba457562015-03-26 09:29:26 -0600702 bios_cntl |= 1; /* Write Protect Disable (WPD) */
Simon Glass50787922015-07-03 18:28:22 -0600703 ich_writeb(priv, bios_cntl, priv->bcr);
Simon Glassba457562015-03-26 09:29:26 -0600704 } else {
705 pci_read_config_byte(plat->dev, 0xdc, &bios_cntl);
706 if (plat->ich_version == 9)
Jagan Teki69fd4c32015-10-23 01:37:56 +0530707 bios_cntl &= ~BIT(5);
Simon Glassba457562015-03-26 09:29:26 -0600708 pci_write_config_byte(plat->dev, 0xdc, bios_cntl | 0x1);
709 }
710
711 priv->cur_speed = priv->max_speed;
712
713 return 0;
714}
715
716static int ich_spi_ofdata_to_platdata(struct udevice *bus)
717{
718 struct ich_spi_platdata *plat = dev_get_platdata(bus);
719 int ret;
720
721 ret = ich_find_spi_controller(plat);
722 if (ret)
723 return ret;
724
725 return 0;
726}
727
728static int ich_spi_set_speed(struct udevice *bus, uint speed)
729{
730 struct ich_spi_priv *priv = dev_get_priv(bus);
731
732 priv->cur_speed = speed;
733
734 return 0;
735}
736
737static int ich_spi_set_mode(struct udevice *bus, uint mode)
738{
739 debug("%s: mode=%d\n", __func__, mode);
740
741 return 0;
742}
743
744static int ich_spi_child_pre_probe(struct udevice *dev)
745{
746 struct udevice *bus = dev_get_parent(dev);
747 struct ich_spi_platdata *plat = dev_get_platdata(bus);
748 struct ich_spi_priv *priv = dev_get_priv(bus);
Simon Glassbcbe3d12015-09-28 23:32:01 -0600749 struct spi_slave *slave = dev_get_parent_priv(dev);
Simon Glassba457562015-03-26 09:29:26 -0600750
751 /*
752 * Yes this controller can only write a small number of bytes at
753 * once! The limit is typically 64 bytes.
754 */
755 slave->max_write_size = priv->databytes;
756 /*
757 * ICH 7 SPI controller only supports array read command
758 * and byte program command for SST flash
759 */
760 if (plat->ich_version == 7) {
Jagan Teki91292e02015-12-16 15:24:24 +0530761 slave->mode_rx = SPI_RX_SLOW;
Jagan Tekicdf33932015-12-13 20:12:45 +0530762 slave->mode = SPI_TX_BYTE;
Simon Glassba457562015-03-26 09:29:26 -0600763 }
764
765 return 0;
766}
767
768static const struct dm_spi_ops ich_spi_ops = {
769 .xfer = ich_spi_xfer,
770 .set_speed = ich_spi_set_speed,
771 .set_mode = ich_spi_set_mode,
772 /*
773 * cs_info is not needed, since we require all chip selects to be
774 * in the device tree explicitly
775 */
776};
777
778static const struct udevice_id ich_spi_ids[] = {
779 { .compatible = "intel,ich-spi" },
780 { }
781};
782
783U_BOOT_DRIVER(ich_spi) = {
784 .name = "ich_spi",
785 .id = UCLASS_SPI,
786 .of_match = ich_spi_ids,
787 .ops = &ich_spi_ops,
788 .ofdata_to_platdata = ich_spi_ofdata_to_platdata,
789 .platdata_auto_alloc_size = sizeof(struct ich_spi_platdata),
790 .priv_auto_alloc_size = sizeof(struct ich_spi_priv),
791 .child_pre_probe = ich_spi_child_pre_probe,
792 .probe = ich_spi_probe,
793};