2 * Freescale eSPI controller driver.
4 * Copyright 2010 Freescale Semiconductor, Inc.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
11 #include <linux/module.h>
12 #include <linux/delay.h>
13 #include <linux/irq.h>
14 #include <linux/spi/spi.h>
15 #include <linux/platform_device.h>
16 #include <linux/fsl_devices.h>
19 #include <linux/of_platform.h>
20 #include <linux/of_spi.h>
21 #include <linux/interrupt.h>
22 #include <linux/err.h>
23 #include <sysdev/fsl_soc.h>
25 #include "spi_fsl_lib.h"
27 /* eSPI Controller registers */
29 __be32 mode; /* 0x000 - eSPI mode register */
30 __be32 event; /* 0x004 - eSPI event register */
31 __be32 mask; /* 0x008 - eSPI mask register */
32 __be32 command; /* 0x00c - eSPI command register */
33 __be32 transmit; /* 0x010 - eSPI transmit FIFO access register*/
34 __be32 receive; /* 0x014 - eSPI receive FIFO access register*/
35 u8 res[8]; /* 0x018 - 0x01c reserved */
36 __be32 csmode[4]; /* 0x020 - 0x02c eSPI cs mode register */
39 struct fsl_espi_transfer {
45 unsigned actual_length;
49 /* eSPI Controller mode register definitions */
50 #define SPMODE_ENABLE (1 << 31)
51 #define SPMODE_LOOP (1 << 30)
52 #define SPMODE_TXTHR(x) ((x) << 8)
53 #define SPMODE_RXTHR(x) ((x) << 0)
55 /* eSPI Controller CS mode register definitions */
56 #define CSMODE_CI_INACTIVEHIGH (1 << 31)
57 #define CSMODE_CP_BEGIN_EDGECLK (1 << 30)
58 #define CSMODE_REV (1 << 29)
59 #define CSMODE_DIV16 (1 << 28)
60 #define CSMODE_PM(x) ((x) << 24)
61 #define CSMODE_POL_1 (1 << 20)
62 #define CSMODE_LEN(x) ((x) << 16)
63 #define CSMODE_BEF(x) ((x) << 12)
64 #define CSMODE_AFT(x) ((x) << 8)
65 #define CSMODE_CG(x) ((x) << 3)
67 /* Default mode/csmode for eSPI controller */
68 #define SPMODE_INIT_VAL (SPMODE_TXTHR(4) | SPMODE_RXTHR(3))
69 #define CSMODE_INIT_VAL (CSMODE_POL_1 | CSMODE_BEF(0) \
70 | CSMODE_AFT(0) | CSMODE_CG(1))
72 /* SPIE register values */
73 #define SPIE_NE 0x00000200 /* Not empty */
74 #define SPIE_NF 0x00000100 /* Not full */
76 /* SPIM register values */
77 #define SPIM_NE 0x00000200 /* Not empty */
78 #define SPIM_NF 0x00000100 /* Not full */
79 #define SPIE_RXCNT(reg) ((reg >> 24) & 0x3F)
80 #define SPIE_TXCNT(reg) ((reg >> 16) & 0x3F)
82 /* SPCOM register values */
83 #define SPCOM_CS(x) ((x) << 30)
84 #define SPCOM_TRANLEN(x) ((x) << 0)
85 #define SPCOM_TRANLEN_MAX 0xFFFF /* Max transaction length */
87 static void fsl_espi_change_mode(struct spi_device *spi)
89 struct mpc8xxx_spi *mspi = spi_master_get_devdata(spi->master);
90 struct spi_mpc8xxx_cs *cs = spi->controller_state;
91 struct fsl_espi_reg *reg_base = mspi->reg_base;
92 __be32 __iomem *mode = ®_base->csmode[spi->chip_select];
93 __be32 __iomem *espi_mode = ®_base->mode;
97 /* Turn off IRQs locally to minimize time that SPI is disabled. */
98 local_irq_save(flags);
100 /* Turn off SPI unit prior changing mode */
101 tmp = mpc8xxx_spi_read_reg(espi_mode);
102 mpc8xxx_spi_write_reg(espi_mode, tmp & ~SPMODE_ENABLE);
103 mpc8xxx_spi_write_reg(mode, cs->hw_mode);
104 mpc8xxx_spi_write_reg(espi_mode, tmp);
106 local_irq_restore(flags);
109 static u32 fsl_espi_tx_buf_lsb(struct mpc8xxx_spi *mpc8xxx_spi)
114 const u32 *tx = mpc8xxx_spi->tx;
119 data = *tx++ << mpc8xxx_spi->tx_shift;
120 data_l = data & 0xffff;
121 data_h = (data >> 16) & 0xffff;
124 data = data_h | data_l;
126 mpc8xxx_spi->tx = tx;
130 static int fsl_espi_setup_transfer(struct spi_device *spi,
131 struct spi_transfer *t)
133 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
134 int bits_per_word = 0;
137 struct spi_mpc8xxx_cs *cs = spi->controller_state;
140 bits_per_word = t->bits_per_word;
144 /* spi_transfer level calls that work per-word */
146 bits_per_word = spi->bits_per_word;
148 /* Make sure its a bit width we support [4..16] */
149 if ((bits_per_word < 4) || (bits_per_word > 16))
153 hz = spi->max_speed_hz;
157 cs->get_rx = mpc8xxx_spi_rx_buf_u32;
158 cs->get_tx = mpc8xxx_spi_tx_buf_u32;
159 if (bits_per_word <= 8) {
160 cs->rx_shift = 8 - bits_per_word;
161 } else if (bits_per_word <= 16) {
162 cs->rx_shift = 16 - bits_per_word;
163 if (spi->mode & SPI_LSB_FIRST)
164 cs->get_tx = fsl_espi_tx_buf_lsb;
169 mpc8xxx_spi->rx_shift = cs->rx_shift;
170 mpc8xxx_spi->tx_shift = cs->tx_shift;
171 mpc8xxx_spi->get_rx = cs->get_rx;
172 mpc8xxx_spi->get_tx = cs->get_tx;
174 bits_per_word = bits_per_word - 1;
176 /* mask out bits we are going to set */
177 cs->hw_mode &= ~(CSMODE_LEN(0xF) | CSMODE_DIV16 | CSMODE_PM(0xF));
179 cs->hw_mode |= CSMODE_LEN(bits_per_word);
181 if ((mpc8xxx_spi->spibrg / hz) > 64) {
182 cs->hw_mode |= CSMODE_DIV16;
183 pm = (mpc8xxx_spi->spibrg - 1) / (hz * 64) + 1;
185 WARN_ONCE(pm > 16, "%s: Requested speed is too low: %d Hz. "
186 "Will use %d Hz instead.\n", dev_name(&spi->dev),
187 hz, mpc8xxx_spi->spibrg / 1024);
191 pm = (mpc8xxx_spi->spibrg - 1) / (hz * 4) + 1;
196 cs->hw_mode |= CSMODE_PM(pm);
198 fsl_espi_change_mode(spi);
202 static int fsl_espi_cpu_bufs(struct mpc8xxx_spi *mspi, struct spi_transfer *t,
206 struct fsl_espi_reg *reg_base = mspi->reg_base;
211 mpc8xxx_spi_write_reg(®_base->mask, SPIM_NE);
214 word = mspi->get_tx(mspi);
215 mpc8xxx_spi_write_reg(®_base->transmit, word);
220 static int fsl_espi_bufs(struct spi_device *spi, struct spi_transfer *t)
222 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
223 struct fsl_espi_reg *reg_base = mpc8xxx_spi->reg_base;
224 unsigned int len = t->len;
228 bits_per_word = spi->bits_per_word;
229 if (t->bits_per_word)
230 bits_per_word = t->bits_per_word;
232 mpc8xxx_spi->len = t->len;
233 len = roundup(len, 4) / 4;
235 mpc8xxx_spi->tx = t->tx_buf;
236 mpc8xxx_spi->rx = t->rx_buf;
238 INIT_COMPLETION(mpc8xxx_spi->done);
240 /* Set SPCOM[CS] and SPCOM[TRANLEN] field */
241 if ((t->len - 1) > SPCOM_TRANLEN_MAX) {
242 dev_err(mpc8xxx_spi->dev, "Transaction length (%d)"
243 " beyond the SPCOM[TRANLEN] field\n", t->len);
246 mpc8xxx_spi_write_reg(®_base->command,
247 (SPCOM_CS(spi->chip_select) | SPCOM_TRANLEN(t->len - 1)));
249 ret = fsl_espi_cpu_bufs(mpc8xxx_spi, t, len);
253 wait_for_completion(&mpc8xxx_spi->done);
255 /* disable rx ints */
256 mpc8xxx_spi_write_reg(®_base->mask, 0);
258 return mpc8xxx_spi->count;
261 static inline void fsl_espi_addr2cmd(unsigned int addr, u8 *cmd)
264 cmd[1] = (u8)(addr >> 16);
265 cmd[2] = (u8)(addr >> 8);
266 cmd[3] = (u8)(addr >> 0);
270 static inline unsigned int fsl_espi_cmd2addr(u8 *cmd)
273 return cmd[1] << 16 | cmd[2] << 8 | cmd[3] << 0;
278 static void fsl_espi_do_trans(struct spi_message *m,
279 struct fsl_espi_transfer *tr)
281 struct spi_device *spi = m->spi;
282 struct mpc8xxx_spi *mspi = spi_master_get_devdata(spi->master);
283 struct fsl_espi_transfer *espi_trans = tr;
284 struct spi_message message;
285 struct spi_transfer *t, *first, trans;
288 spi_message_init(&message);
289 memset(&trans, 0, sizeof(trans));
291 first = list_first_entry(&m->transfers, struct spi_transfer,
293 list_for_each_entry(t, &m->transfers, transfer_list) {
294 if ((first->bits_per_word != t->bits_per_word) ||
295 (first->speed_hz != t->speed_hz)) {
296 espi_trans->status = -EINVAL;
297 dev_err(mspi->dev, "bits_per_word/speed_hz should be"
298 " same for the same SPI transfer\n");
302 trans.speed_hz = t->speed_hz;
303 trans.bits_per_word = t->bits_per_word;
304 trans.delay_usecs = max(first->delay_usecs, t->delay_usecs);
307 trans.len = espi_trans->len;
308 trans.tx_buf = espi_trans->tx_buf;
309 trans.rx_buf = espi_trans->rx_buf;
310 spi_message_add_tail(&trans, &message);
312 list_for_each_entry(t, &message.transfers, transfer_list) {
313 if (t->bits_per_word || t->speed_hz) {
316 status = fsl_espi_setup_transfer(spi, t);
322 status = fsl_espi_bufs(spi, t);
330 udelay(t->delay_usecs);
333 espi_trans->status = status;
334 fsl_espi_setup_transfer(spi, NULL);
337 static void fsl_espi_cmd_trans(struct spi_message *m,
338 struct fsl_espi_transfer *trans, u8 *rx_buff)
340 struct spi_transfer *t;
343 struct fsl_espi_transfer *espi_trans = trans;
345 local_buf = kzalloc(SPCOM_TRANLEN_MAX, GFP_KERNEL);
347 espi_trans->status = -ENOMEM;
351 list_for_each_entry(t, &m->transfers, transfer_list) {
353 memcpy(local_buf + i, t->tx_buf, t->len);
358 espi_trans->tx_buf = local_buf;
359 espi_trans->rx_buf = local_buf + espi_trans->n_tx;
360 fsl_espi_do_trans(m, espi_trans);
362 espi_trans->actual_length = espi_trans->len;
366 static void fsl_espi_rw_trans(struct spi_message *m,
367 struct fsl_espi_transfer *trans, u8 *rx_buff)
369 struct fsl_espi_transfer *espi_trans = trans;
370 unsigned int n_tx = espi_trans->n_tx;
371 unsigned int n_rx = espi_trans->n_rx;
372 struct spi_transfer *t;
374 u8 *rx_buf = rx_buff;
375 unsigned int trans_len;
379 local_buf = kzalloc(SPCOM_TRANLEN_MAX, GFP_KERNEL);
381 espi_trans->status = -ENOMEM;
385 for (pos = 0, loop = 0; pos < n_rx; pos += trans_len, loop++) {
386 trans_len = n_rx - pos;
387 if (trans_len > SPCOM_TRANLEN_MAX - n_tx)
388 trans_len = SPCOM_TRANLEN_MAX - n_tx;
391 list_for_each_entry(t, &m->transfers, transfer_list) {
393 memcpy(local_buf + i, t->tx_buf, t->len);
399 addr = fsl_espi_cmd2addr(local_buf);
401 fsl_espi_addr2cmd(addr, local_buf);
404 espi_trans->n_tx = n_tx;
405 espi_trans->n_rx = trans_len;
406 espi_trans->len = trans_len + n_tx;
407 espi_trans->tx_buf = local_buf;
408 espi_trans->rx_buf = local_buf + n_tx;
409 fsl_espi_do_trans(m, espi_trans);
411 memcpy(rx_buf + pos, espi_trans->rx_buf + n_tx, trans_len);
414 espi_trans->actual_length += espi_trans->len - n_tx;
416 espi_trans->actual_length += espi_trans->len;
422 static void fsl_espi_do_one_msg(struct spi_message *m)
424 struct spi_transfer *t;
426 unsigned int n_tx = 0;
427 unsigned int n_rx = 0;
428 struct fsl_espi_transfer espi_trans;
430 list_for_each_entry(t, &m->transfers, transfer_list) {
439 espi_trans.n_tx = n_tx;
440 espi_trans.n_rx = n_rx;
441 espi_trans.len = n_tx + n_rx;
442 espi_trans.actual_length = 0;
443 espi_trans.status = 0;
446 fsl_espi_cmd_trans(m, &espi_trans, NULL);
448 fsl_espi_rw_trans(m, &espi_trans, rx_buf);
450 m->actual_length = espi_trans.actual_length;
451 m->status = espi_trans.status;
452 m->complete(m->context);
455 static int fsl_espi_setup(struct spi_device *spi)
457 struct mpc8xxx_spi *mpc8xxx_spi;
458 struct fsl_espi_reg *reg_base;
462 struct spi_mpc8xxx_cs *cs = spi->controller_state;
464 if (!spi->max_speed_hz)
468 cs = kzalloc(sizeof *cs, GFP_KERNEL);
471 spi->controller_state = cs;
474 mpc8xxx_spi = spi_master_get_devdata(spi->master);
475 reg_base = mpc8xxx_spi->reg_base;
477 hw_mode = cs->hw_mode; /* Save orginal settings */
478 cs->hw_mode = mpc8xxx_spi_read_reg(
479 ®_base->csmode[spi->chip_select]);
480 /* mask out bits we are going to set */
481 cs->hw_mode &= ~(CSMODE_CP_BEGIN_EDGECLK | CSMODE_CI_INACTIVEHIGH
484 if (spi->mode & SPI_CPHA)
485 cs->hw_mode |= CSMODE_CP_BEGIN_EDGECLK;
486 if (spi->mode & SPI_CPOL)
487 cs->hw_mode |= CSMODE_CI_INACTIVEHIGH;
488 if (!(spi->mode & SPI_LSB_FIRST))
489 cs->hw_mode |= CSMODE_REV;
491 /* Handle the loop mode */
492 loop_mode = mpc8xxx_spi_read_reg(®_base->mode);
493 loop_mode &= ~SPMODE_LOOP;
494 if (spi->mode & SPI_LOOP)
495 loop_mode |= SPMODE_LOOP;
496 mpc8xxx_spi_write_reg(®_base->mode, loop_mode);
498 retval = fsl_espi_setup_transfer(spi, NULL);
500 cs->hw_mode = hw_mode; /* Restore settings */
506 void fsl_espi_cpu_irq(struct mpc8xxx_spi *mspi, u32 events)
508 struct fsl_espi_reg *reg_base = mspi->reg_base;
510 /* We need handle RX first */
511 if (events & SPIE_NE) {
515 /* Spin until RX is done */
516 while (SPIE_RXCNT(events) < min(4, mspi->len)) {
518 events = mpc8xxx_spi_read_reg(®_base->event);
521 if (mspi->len >= 4) {
522 rx_data = mpc8xxx_spi_read_reg(®_base->receive);
527 rx_data_8 = in_8((u8 *)®_base->receive);
528 rx_data |= (rx_data_8 << (tmp * 8));
531 rx_data <<= (4 - mspi->len) * 8;
537 mspi->get_rx(rx_data, mspi);
540 if (!(events & SPIE_NF)) {
543 /* spin until TX is done */
544 ret = spin_event_timeout(((events = mpc8xxx_spi_read_reg(
545 ®_base->event)) & SPIE_NF) == 0, 1000, 0);
547 dev_err(mspi->dev, "tired waiting for SPIE_NF\n");
552 /* Clear the events */
553 mpc8xxx_spi_write_reg(®_base->event, events);
557 u32 word = mspi->get_tx(mspi);
559 mpc8xxx_spi_write_reg(®_base->transmit, word);
561 complete(&mspi->done);
565 static irqreturn_t fsl_espi_irq(s32 irq, void *context_data)
567 struct mpc8xxx_spi *mspi = context_data;
568 struct fsl_espi_reg *reg_base = mspi->reg_base;
569 irqreturn_t ret = IRQ_NONE;
572 /* Get interrupt events(tx/rx) */
573 events = mpc8xxx_spi_read_reg(®_base->event);
577 dev_vdbg(mspi->dev, "%s: events %x\n", __func__, events);
579 fsl_espi_cpu_irq(mspi, events);
584 static void fsl_espi_remove(struct mpc8xxx_spi *mspi)
586 iounmap(mspi->reg_base);
589 static struct spi_master * __devinit fsl_espi_probe(struct device *dev,
590 struct resource *mem, unsigned int irq)
592 struct fsl_spi_platform_data *pdata = dev->platform_data;
593 struct spi_master *master;
594 struct mpc8xxx_spi *mpc8xxx_spi;
595 struct fsl_espi_reg *reg_base;
599 master = spi_alloc_master(dev, sizeof(struct mpc8xxx_spi));
605 dev_set_drvdata(dev, master);
607 ret = mpc8xxx_spi_probe(dev, mem, irq);
611 master->setup = fsl_espi_setup;
613 mpc8xxx_spi = spi_master_get_devdata(master);
614 mpc8xxx_spi->spi_do_one_msg = fsl_espi_do_one_msg;
615 mpc8xxx_spi->spi_remove = fsl_espi_remove;
617 mpc8xxx_spi->reg_base = ioremap(mem->start, resource_size(mem));
618 if (!mpc8xxx_spi->reg_base) {
623 reg_base = mpc8xxx_spi->reg_base;
625 /* Register for SPI Interrupt */
626 ret = request_irq(mpc8xxx_spi->irq, fsl_espi_irq,
627 0, "fsl_espi", mpc8xxx_spi);
631 if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE) {
632 mpc8xxx_spi->rx_shift = 16;
633 mpc8xxx_spi->tx_shift = 24;
636 /* SPI controller initializations */
637 mpc8xxx_spi_write_reg(®_base->mode, 0);
638 mpc8xxx_spi_write_reg(®_base->mask, 0);
639 mpc8xxx_spi_write_reg(®_base->command, 0);
640 mpc8xxx_spi_write_reg(®_base->event, 0xffffffff);
642 /* Init eSPI CS mode register */
643 for (i = 0; i < pdata->max_chipselect; i++)
644 mpc8xxx_spi_write_reg(®_base->csmode[i], CSMODE_INIT_VAL);
646 /* Enable SPI interface */
647 regval = pdata->initial_spmode | SPMODE_INIT_VAL | SPMODE_ENABLE;
649 mpc8xxx_spi_write_reg(®_base->mode, regval);
651 ret = spi_register_master(master);
655 dev_info(dev, "at 0x%p (irq = %d)\n", reg_base, mpc8xxx_spi->irq);
660 free_irq(mpc8xxx_spi->irq, mpc8xxx_spi);
662 iounmap(mpc8xxx_spi->reg_base);
664 spi_master_put(master);
669 static int of_fsl_espi_get_chipselects(struct device *dev)
671 struct device_node *np = dev->of_node;
672 struct fsl_spi_platform_data *pdata = dev->platform_data;
676 prop = of_get_property(np, "fsl,espi-num-chipselects", &len);
677 if (!prop || len < sizeof(*prop)) {
678 dev_err(dev, "No 'fsl,espi-num-chipselects' property\n");
682 pdata->max_chipselect = *prop;
683 pdata->cs_control = NULL;
688 static int __devinit of_fsl_espi_probe(struct platform_device *ofdev,
689 const struct of_device_id *ofid)
691 struct device *dev = &ofdev->dev;
692 struct device_node *np = ofdev->dev.of_node;
693 struct spi_master *master;
698 ret = of_mpc8xxx_spi_probe(ofdev, ofid);
702 ret = of_fsl_espi_get_chipselects(dev);
706 ret = of_address_to_resource(np, 0, &mem);
710 ret = of_irq_to_resource(np, 0, &irq);
716 master = fsl_espi_probe(dev, &mem, irq.start);
717 if (IS_ERR(master)) {
718 ret = PTR_ERR(master);
728 static int __devexit of_fsl_espi_remove(struct platform_device *dev)
730 return mpc8xxx_spi_remove(&dev->dev);
733 static const struct of_device_id of_fsl_espi_match[] = {
734 { .compatible = "fsl,mpc8536-espi" },
737 MODULE_DEVICE_TABLE(of, of_fsl_espi_match);
739 static struct of_platform_driver fsl_espi_driver = {
742 .owner = THIS_MODULE,
743 .of_match_table = of_fsl_espi_match,
745 .probe = of_fsl_espi_probe,
746 .remove = __devexit_p(of_fsl_espi_remove),
749 static int __init fsl_espi_init(void)
751 return of_register_platform_driver(&fsl_espi_driver);
753 module_init(fsl_espi_init);
755 static void __exit fsl_espi_exit(void)
757 of_unregister_platform_driver(&fsl_espi_driver);
759 module_exit(fsl_espi_exit);
761 MODULE_AUTHOR("Mingkai Hu");
762 MODULE_DESCRIPTION("Enhanced Freescale SPI Driver");
763 MODULE_LICENSE("GPL");