1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2011-12 The Chromium OS Authors.
5 * This file is derived from the flashrom project.
22 DECLARE_GLOBAL_DATA_PTR;
25 #define debug_trace(fmt, args...) debug(fmt, ##args)
27 #define debug_trace(x, args...)
30 static u8 ich_readb(struct ich_spi_priv *priv, int reg)
32 u8 value = readb(priv->base + reg);
34 debug_trace("read %2.2x from %4.4x\n", value, reg);
39 static u16 ich_readw(struct ich_spi_priv *priv, int reg)
41 u16 value = readw(priv->base + reg);
43 debug_trace("read %4.4x from %4.4x\n", value, reg);
48 static u32 ich_readl(struct ich_spi_priv *priv, int reg)
50 u32 value = readl(priv->base + reg);
52 debug_trace("read %8.8x from %4.4x\n", value, reg);
57 static void ich_writeb(struct ich_spi_priv *priv, u8 value, int reg)
59 writeb(value, priv->base + reg);
60 debug_trace("wrote %2.2x to %4.4x\n", value, reg);
63 static void ich_writew(struct ich_spi_priv *priv, u16 value, int reg)
65 writew(value, priv->base + reg);
66 debug_trace("wrote %4.4x to %4.4x\n", value, reg);
69 static void ich_writel(struct ich_spi_priv *priv, u32 value, int reg)
71 writel(value, priv->base + reg);
72 debug_trace("wrote %8.8x to %4.4x\n", value, reg);
75 static void write_reg(struct ich_spi_priv *priv, const void *value,
76 int dest_reg, uint32_t size)
78 memcpy_toio(priv->base + dest_reg, value, size);
81 static void read_reg(struct ich_spi_priv *priv, int src_reg, void *value,
84 memcpy_fromio(value, priv->base + src_reg, size);
87 static void ich_set_bbar(struct ich_spi_priv *ctlr, uint32_t minaddr)
89 const uint32_t bbar_mask = 0x00ffff00;
93 ichspi_bbar = ich_readl(ctlr, ctlr->bbar) & ~bbar_mask;
94 ichspi_bbar |= minaddr;
95 ich_writel(ctlr, ichspi_bbar, ctlr->bbar);
98 /* @return 1 if the SPI flash supports the 33MHz speed */
99 static int ich9_can_do_33mhz(struct udevice *dev)
103 /* Observe SPI Descriptor Component Section 0 */
104 dm_pci_write_config32(dev->parent, 0xb0, 0x1000);
106 /* Extract the Write/Erase SPI Frequency from descriptor */
107 dm_pci_read_config32(dev->parent, 0xb4, &fdod);
109 /* Bits 23:21 have the fast read clock frequency, 0=20MHz, 1=33MHz */
110 speed = (fdod >> 21) & 7;
115 static int ich_init_controller(struct udevice *dev,
116 struct ich_spi_platdata *plat,
117 struct ich_spi_priv *ctlr)
122 /* SBASE is similar */
123 pch_get_spi_base(dev->parent, &sbase_addr);
124 sbase = (void *)sbase_addr;
125 debug("%s: sbase=%p\n", __func__, sbase);
127 if (plat->ich_version == ICHV_7) {
128 struct ich7_spi_regs *ich7_spi = sbase;
130 ctlr->opmenu = offsetof(struct ich7_spi_regs, opmenu);
131 ctlr->menubytes = sizeof(ich7_spi->opmenu);
132 ctlr->optype = offsetof(struct ich7_spi_regs, optype);
133 ctlr->addr = offsetof(struct ich7_spi_regs, spia);
134 ctlr->data = offsetof(struct ich7_spi_regs, spid);
135 ctlr->databytes = sizeof(ich7_spi->spid);
136 ctlr->status = offsetof(struct ich7_spi_regs, spis);
137 ctlr->control = offsetof(struct ich7_spi_regs, spic);
138 ctlr->bbar = offsetof(struct ich7_spi_regs, bbar);
139 ctlr->preop = offsetof(struct ich7_spi_regs, preop);
140 ctlr->base = ich7_spi;
141 } else if (plat->ich_version == ICHV_9) {
142 struct ich9_spi_regs *ich9_spi = sbase;
144 ctlr->opmenu = offsetof(struct ich9_spi_regs, opmenu);
145 ctlr->menubytes = sizeof(ich9_spi->opmenu);
146 ctlr->optype = offsetof(struct ich9_spi_regs, optype);
147 ctlr->addr = offsetof(struct ich9_spi_regs, faddr);
148 ctlr->data = offsetof(struct ich9_spi_regs, fdata);
149 ctlr->databytes = sizeof(ich9_spi->fdata);
150 ctlr->status = offsetof(struct ich9_spi_regs, ssfs);
151 ctlr->control = offsetof(struct ich9_spi_regs, ssfc);
152 ctlr->speed = ctlr->control + 2;
153 ctlr->bbar = offsetof(struct ich9_spi_regs, bbar);
154 ctlr->preop = offsetof(struct ich9_spi_regs, preop);
155 ctlr->bcr = offsetof(struct ich9_spi_regs, bcr);
156 ctlr->pr = &ich9_spi->pr[0];
157 ctlr->base = ich9_spi;
159 debug("ICH SPI: Unrecognised ICH version %d\n",
164 /* Work out the maximum speed we can support */
165 ctlr->max_speed = 20000000;
166 if (plat->ich_version == ICHV_9 && ich9_can_do_33mhz(dev))
167 ctlr->max_speed = 33000000;
168 debug("ICH SPI: Version ID %d detected at %p, speed %ld\n",
169 plat->ich_version, ctlr->base, ctlr->max_speed);
171 ich_set_bbar(ctlr, 0);
176 static void spi_lock_down(struct ich_spi_platdata *plat, void *sbase)
178 if (plat->ich_version == ICHV_7) {
179 struct ich7_spi_regs *ich7_spi = sbase;
181 setbits_le16(&ich7_spi->spis, SPIS_LOCK);
182 } else if (plat->ich_version == ICHV_9) {
183 struct ich9_spi_regs *ich9_spi = sbase;
185 setbits_le16(&ich9_spi->hsfs, HSFS_FLOCKDN);
189 static bool spi_lock_status(struct ich_spi_platdata *plat, void *sbase)
193 if (plat->ich_version == ICHV_7) {
194 struct ich7_spi_regs *ich7_spi = sbase;
196 lock = readw(&ich7_spi->spis) & SPIS_LOCK;
197 } else if (plat->ich_version == ICHV_9) {
198 struct ich9_spi_regs *ich9_spi = sbase;
200 lock = readw(&ich9_spi->hsfs) & HSFS_FLOCKDN;
206 static int spi_setup_opcode(struct ich_spi_priv *ctlr, struct spi_trans *trans,
210 uint8_t opmenu[ctlr->menubytes];
213 /* The lock is off, so just use index 0. */
214 ich_writeb(ctlr, trans->opcode, ctlr->opmenu);
215 optypes = ich_readw(ctlr, ctlr->optype);
216 optypes = (optypes & 0xfffc) | (trans->type & 0x3);
217 ich_writew(ctlr, optypes, ctlr->optype);
220 /* The lock is on. See if what we need is on the menu. */
222 uint16_t opcode_index;
224 /* Write Enable is handled as atomic prefix */
225 if (trans->opcode == SPI_OPCODE_WREN)
228 read_reg(ctlr, ctlr->opmenu, opmenu, sizeof(opmenu));
229 for (opcode_index = 0; opcode_index < ctlr->menubytes;
231 if (opmenu[opcode_index] == trans->opcode)
235 if (opcode_index == ctlr->menubytes) {
236 printf("ICH SPI: Opcode %x not found\n",
241 optypes = ich_readw(ctlr, ctlr->optype);
242 optype = (optypes >> (opcode_index * 2)) & 0x3;
244 if (optype != trans->type) {
245 printf("ICH SPI: Transaction doesn't fit type %d\n",
254 * Wait for up to 6s til status register bit(s) turn 1 (in case wait_til_set
255 * below is true) or 0. In case the wait was for the bit(s) to set - write
256 * those bits back, which would cause resetting them.
258 * Return the last read status value on success or -1 on failure.
260 static int ich_status_poll(struct ich_spi_priv *ctlr, u16 bitmask,
263 int timeout = 600000; /* This will result in 6s */
267 status = ich_readw(ctlr, ctlr->status);
268 if (wait_til_set ^ ((status & bitmask) == 0)) {
270 ich_writew(ctlr, status & bitmask,
278 printf("ICH SPI: SCIP timeout, read %x, expected %x\n",
283 static void ich_spi_config_opcode(struct udevice *dev)
285 struct ich_spi_priv *ctlr = dev_get_priv(dev);
288 * PREOP, OPTYPE, OPMENU1/OPMENU2 registers can be locked down
289 * to prevent accidental or intentional writes. Before they get
290 * locked down, these registers should be initialized properly.
292 ich_writew(ctlr, SPI_OPPREFIX, ctlr->preop);
293 ich_writew(ctlr, SPI_OPTYPE, ctlr->optype);
294 ich_writel(ctlr, SPI_OPMENU_LOWER, ctlr->opmenu);
295 ich_writel(ctlr, SPI_OPMENU_UPPER, ctlr->opmenu + sizeof(u32));
298 static int ich_spi_exec_op(struct spi_slave *slave, const struct spi_mem_op *op)
300 struct udevice *bus = dev_get_parent(slave->dev);
301 struct ich_spi_platdata *plat = dev_get_platdata(bus);
302 struct ich_spi_priv *ctlr = dev_get_priv(bus);
304 int16_t opcode_index;
307 struct spi_trans *trans = &ctlr->trans;
308 bool lock = spi_lock_status(plat, ctlr->base);
315 if (op->data.nbytes) {
316 if (op->data.dir == SPI_MEM_DATA_IN) {
317 trans->in = op->data.buf.in;
318 trans->bytesin = op->data.nbytes;
320 trans->out = op->data.buf.out;
321 trans->bytesout = op->data.nbytes;
325 if (trans->opcode != op->cmd.opcode)
326 trans->opcode = op->cmd.opcode;
328 if (lock && trans->opcode == SPI_OPCODE_WRDIS)
331 if (trans->opcode == SPI_OPCODE_WREN) {
333 * Treat Write Enable as Atomic Pre-Op if possible
334 * in order to prevent the Management Engine from
335 * issuing a transaction between WREN and DATA.
338 ich_writew(ctlr, trans->opcode, ctlr->preop);
342 ret = ich_status_poll(ctlr, SPIS_SCIP, 0);
346 if (plat->ich_version == ICHV_7)
347 ich_writew(ctlr, SPIS_CDS | SPIS_FCERR, ctlr->status);
349 ich_writeb(ctlr, SPIS_CDS | SPIS_FCERR, ctlr->status);
351 /* Try to guess spi transaction type */
352 if (op->data.dir == SPI_MEM_DATA_OUT) {
354 trans->type = SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS;
356 trans->type = SPI_OPCODE_TYPE_WRITE_NO_ADDRESS;
359 trans->type = SPI_OPCODE_TYPE_READ_WITH_ADDRESS;
361 trans->type = SPI_OPCODE_TYPE_READ_NO_ADDRESS;
363 /* Special erase case handling */
364 if (op->addr.nbytes && !op->data.buswidth)
365 trans->type = SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS;
367 opcode_index = spi_setup_opcode(ctlr, trans, lock);
368 if (opcode_index < 0)
371 if (op->addr.nbytes) {
372 trans->offset = op->addr.val;
376 if (ctlr->speed && ctlr->max_speed >= 33000000) {
379 byte = ich_readb(ctlr, ctlr->speed);
380 if (ctlr->cur_speed >= 33000000)
381 byte |= SSFC_SCF_33MHZ;
383 byte &= ~SSFC_SCF_33MHZ;
384 ich_writeb(ctlr, byte, ctlr->speed);
387 /* Preset control fields */
388 control = SPIC_SCGO | ((opcode_index & 0x07) << 4);
390 /* Issue atomic preop cycle if needed */
391 if (ich_readw(ctlr, ctlr->preop))
394 if (!trans->bytesout && !trans->bytesin) {
395 /* SPI addresses are 24 bit only */
397 ich_writel(ctlr, trans->offset & 0x00FFFFFF,
401 * This is a 'no data' command (like Write Enable), its
402 * bitesout size was 1, decremented to zero while executing
403 * spi_setup_opcode() above. Tell the chip to send the
406 ich_writew(ctlr, control, ctlr->control);
408 /* wait for the result */
409 status = ich_status_poll(ctlr, SPIS_CDS | SPIS_FCERR, 1);
413 if (status & SPIS_FCERR) {
414 debug("ICH SPI: Command transaction error\n");
421 while (trans->bytesout || trans->bytesin) {
422 uint32_t data_length;
424 /* SPI addresses are 24 bit only */
425 ich_writel(ctlr, trans->offset & 0x00FFFFFF, ctlr->addr);
428 data_length = min(trans->bytesout, ctlr->databytes);
430 data_length = min(trans->bytesin, ctlr->databytes);
432 /* Program data into FDATA0 to N */
433 if (trans->bytesout) {
434 write_reg(ctlr, trans->out, ctlr->data, data_length);
435 trans->bytesout -= data_length;
438 /* Add proper control fields' values */
439 control &= ~((ctlr->databytes - 1) << 8);
441 control |= (data_length - 1) << 8;
444 ich_writew(ctlr, control, ctlr->control);
446 /* Wait for Cycle Done Status or Flash Cycle Error */
447 status = ich_status_poll(ctlr, SPIS_CDS | SPIS_FCERR, 1);
451 if (status & SPIS_FCERR) {
452 debug("ICH SPI: Data transaction error %x\n", status);
456 if (trans->bytesin) {
457 read_reg(ctlr, ctlr->data, trans->in, data_length);
458 trans->bytesin -= data_length;
462 /* Clear atomic preop now that xfer is done */
464 ich_writew(ctlr, 0, ctlr->preop);
469 static int ich_spi_adjust_size(struct spi_slave *slave, struct spi_mem_op *op)
471 unsigned int page_offset;
472 int addr = op->addr.val;
473 unsigned int byte_count = op->data.nbytes;
475 if (hweight32(ICH_BOUNDARY) == 1) {
476 page_offset = addr & (ICH_BOUNDARY - 1);
480 page_offset = do_div(aux, ICH_BOUNDARY);
483 if (op->data.dir == SPI_MEM_DATA_IN && slave->max_read_size) {
484 op->data.nbytes = min(ICH_BOUNDARY - page_offset,
485 slave->max_read_size);
486 } else if (slave->max_write_size) {
487 op->data.nbytes = min(ICH_BOUNDARY - page_offset,
488 slave->max_write_size);
491 op->data.nbytes = min(op->data.nbytes, byte_count);
496 static int ich_spi_probe(struct udevice *dev)
498 struct ich_spi_platdata *plat = dev_get_platdata(dev);
499 struct ich_spi_priv *priv = dev_get_priv(dev);
503 ret = ich_init_controller(dev, plat, priv);
506 /* Disable the BIOS write protect so write commands are allowed */
507 ret = pch_set_spi_protect(dev->parent, false);
508 if (ret == -ENOSYS) {
509 bios_cntl = ich_readb(priv, priv->bcr);
510 bios_cntl &= ~BIT(5); /* clear Enable InSMM_STS (EISS) */
511 bios_cntl |= 1; /* Write Protect Disable (WPD) */
512 ich_writeb(priv, bios_cntl, priv->bcr);
514 debug("%s: Failed to disable write-protect: err=%d\n",
519 /* Lock down SPI controller settings if required */
520 if (plat->lockdown) {
521 ich_spi_config_opcode(dev);
522 spi_lock_down(plat, priv->base);
525 priv->cur_speed = priv->max_speed;
530 static int ich_spi_remove(struct udevice *bus)
533 * Configure SPI controller so that the Linux MTD driver can fully
534 * access the SPI NOR chip
536 ich_spi_config_opcode(bus);
541 static int ich_spi_set_speed(struct udevice *bus, uint speed)
543 struct ich_spi_priv *priv = dev_get_priv(bus);
545 priv->cur_speed = speed;
550 static int ich_spi_set_mode(struct udevice *bus, uint mode)
552 debug("%s: mode=%d\n", __func__, mode);
557 static int ich_spi_child_pre_probe(struct udevice *dev)
559 struct udevice *bus = dev_get_parent(dev);
560 struct ich_spi_platdata *plat = dev_get_platdata(bus);
561 struct ich_spi_priv *priv = dev_get_priv(bus);
562 struct spi_slave *slave = dev_get_parent_priv(dev);
565 * Yes this controller can only write a small number of bytes at
566 * once! The limit is typically 64 bytes.
568 slave->max_write_size = priv->databytes;
570 * ICH 7 SPI controller only supports array read command
571 * and byte program command for SST flash
573 if (plat->ich_version == ICHV_7)
574 slave->mode = SPI_RX_SLOW | SPI_TX_BYTE;
579 static int ich_spi_ofdata_to_platdata(struct udevice *dev)
581 struct ich_spi_platdata *plat = dev_get_platdata(dev);
582 int node = dev_of_offset(dev);
585 ret = fdt_node_check_compatible(gd->fdt_blob, node, "intel,ich7-spi");
587 plat->ich_version = ICHV_7;
589 ret = fdt_node_check_compatible(gd->fdt_blob, node,
592 plat->ich_version = ICHV_9;
595 plat->lockdown = fdtdec_get_bool(gd->fdt_blob, node,
596 "intel,spi-lock-down");
601 static const struct spi_controller_mem_ops ich_controller_mem_ops = {
602 .adjust_op_size = ich_spi_adjust_size,
604 .exec_op = ich_spi_exec_op,
607 static const struct dm_spi_ops ich_spi_ops = {
608 /* xfer is not supported */
609 .set_speed = ich_spi_set_speed,
610 .set_mode = ich_spi_set_mode,
611 .mem_ops = &ich_controller_mem_ops,
613 * cs_info is not needed, since we require all chip selects to be
614 * in the device tree explicitly
618 static const struct udevice_id ich_spi_ids[] = {
619 { .compatible = "intel,ich7-spi" },
620 { .compatible = "intel,ich9-spi" },
624 U_BOOT_DRIVER(ich_spi) = {
627 .of_match = ich_spi_ids,
629 .ofdata_to_platdata = ich_spi_ofdata_to_platdata,
630 .platdata_auto_alloc_size = sizeof(struct ich_spi_platdata),
631 .priv_auto_alloc_size = sizeof(struct ich_spi_priv),
632 .child_pre_probe = ich_spi_child_pre_probe,
633 .probe = ich_spi_probe,
634 .remove = ich_spi_remove,
635 .flags = DM_FLAG_OS_PREPARE,