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/interrupt.h>
21 #include <linux/err.h>
22 #include <sysdev/fsl_soc.h>
24 #include "spi-fsl-lib.h"
26 /* eSPI Controller registers */
28 __be32 mode; /* 0x000 - eSPI mode register */
29 __be32 event; /* 0x004 - eSPI event register */
30 __be32 mask; /* 0x008 - eSPI mask register */
31 __be32 command; /* 0x00c - eSPI command register */
32 __be32 transmit; /* 0x010 - eSPI transmit FIFO access register*/
33 __be32 receive; /* 0x014 - eSPI receive FIFO access register*/
34 u8 res[8]; /* 0x018 - 0x01c reserved */
35 __be32 csmode[4]; /* 0x020 - 0x02c eSPI cs mode register */
38 struct fsl_espi_transfer {
44 unsigned actual_length;
48 /* eSPI Controller mode register definitions */
49 #define SPMODE_ENABLE (1 << 31)
50 #define SPMODE_LOOP (1 << 30)
51 #define SPMODE_TXTHR(x) ((x) << 8)
52 #define SPMODE_RXTHR(x) ((x) << 0)
54 /* eSPI Controller CS mode register definitions */
55 #define CSMODE_CI_INACTIVEHIGH (1 << 31)
56 #define CSMODE_CP_BEGIN_EDGECLK (1 << 30)
57 #define CSMODE_REV (1 << 29)
58 #define CSMODE_DIV16 (1 << 28)
59 #define CSMODE_PM(x) ((x) << 24)
60 #define CSMODE_POL_1 (1 << 20)
61 #define CSMODE_LEN(x) ((x) << 16)
62 #define CSMODE_BEF(x) ((x) << 12)
63 #define CSMODE_AFT(x) ((x) << 8)
64 #define CSMODE_CG(x) ((x) << 3)
66 /* Default mode/csmode for eSPI controller */
67 #define SPMODE_INIT_VAL (SPMODE_TXTHR(4) | SPMODE_RXTHR(3))
68 #define CSMODE_INIT_VAL (CSMODE_POL_1 | CSMODE_BEF(0) \
69 | CSMODE_AFT(0) | CSMODE_CG(1))
71 /* SPIE register values */
72 #define SPIE_NE 0x00000200 /* Not empty */
73 #define SPIE_NF 0x00000100 /* Not full */
75 /* SPIM register values */
76 #define SPIM_NE 0x00000200 /* Not empty */
77 #define SPIM_NF 0x00000100 /* Not full */
78 #define SPIE_RXCNT(reg) ((reg >> 24) & 0x3F)
79 #define SPIE_TXCNT(reg) ((reg >> 16) & 0x3F)
81 /* SPCOM register values */
82 #define SPCOM_CS(x) ((x) << 30)
83 #define SPCOM_TRANLEN(x) ((x) << 0)
84 #define SPCOM_TRANLEN_MAX 0xFFFF /* Max transaction length */
86 static void fsl_espi_change_mode(struct spi_device *spi)
88 struct mpc8xxx_spi *mspi = spi_master_get_devdata(spi->master);
89 struct spi_mpc8xxx_cs *cs = spi->controller_state;
90 struct fsl_espi_reg *reg_base = mspi->reg_base;
91 __be32 __iomem *mode = ®_base->csmode[spi->chip_select];
92 __be32 __iomem *espi_mode = ®_base->mode;
96 /* Turn off IRQs locally to minimize time that SPI is disabled. */
97 local_irq_save(flags);
99 /* Turn off SPI unit prior changing mode */
100 tmp = mpc8xxx_spi_read_reg(espi_mode);
101 mpc8xxx_spi_write_reg(espi_mode, tmp & ~SPMODE_ENABLE);
102 mpc8xxx_spi_write_reg(mode, cs->hw_mode);
103 mpc8xxx_spi_write_reg(espi_mode, tmp);
105 local_irq_restore(flags);
108 static u32 fsl_espi_tx_buf_lsb(struct mpc8xxx_spi *mpc8xxx_spi)
113 const u32 *tx = mpc8xxx_spi->tx;
118 data = *tx++ << mpc8xxx_spi->tx_shift;
119 data_l = data & 0xffff;
120 data_h = (data >> 16) & 0xffff;
123 data = data_h | data_l;
125 mpc8xxx_spi->tx = tx;
129 static int fsl_espi_setup_transfer(struct spi_device *spi,
130 struct spi_transfer *t)
132 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
133 int bits_per_word = 0;
136 struct spi_mpc8xxx_cs *cs = spi->controller_state;
139 bits_per_word = t->bits_per_word;
143 /* spi_transfer level calls that work per-word */
145 bits_per_word = spi->bits_per_word;
147 /* Make sure its a bit width we support [4..16] */
148 if ((bits_per_word < 4) || (bits_per_word > 16))
152 hz = spi->max_speed_hz;
156 cs->get_rx = mpc8xxx_spi_rx_buf_u32;
157 cs->get_tx = mpc8xxx_spi_tx_buf_u32;
158 if (bits_per_word <= 8) {
159 cs->rx_shift = 8 - bits_per_word;
160 } else if (bits_per_word <= 16) {
161 cs->rx_shift = 16 - bits_per_word;
162 if (spi->mode & SPI_LSB_FIRST)
163 cs->get_tx = fsl_espi_tx_buf_lsb;
168 mpc8xxx_spi->rx_shift = cs->rx_shift;
169 mpc8xxx_spi->tx_shift = cs->tx_shift;
170 mpc8xxx_spi->get_rx = cs->get_rx;
171 mpc8xxx_spi->get_tx = cs->get_tx;
173 bits_per_word = bits_per_word - 1;
175 /* mask out bits we are going to set */
176 cs->hw_mode &= ~(CSMODE_LEN(0xF) | CSMODE_DIV16 | CSMODE_PM(0xF));
178 cs->hw_mode |= CSMODE_LEN(bits_per_word);
180 if ((mpc8xxx_spi->spibrg / hz) > 64) {
181 cs->hw_mode |= CSMODE_DIV16;
182 pm = DIV_ROUND_UP(mpc8xxx_spi->spibrg, hz * 16 * 4);
184 WARN_ONCE(pm > 33, "%s: Requested speed is too low: %d Hz. "
185 "Will use %d Hz instead.\n", dev_name(&spi->dev),
186 hz, mpc8xxx_spi->spibrg / (4 * 16 * (32 + 1)));
190 pm = DIV_ROUND_UP(mpc8xxx_spi->spibrg, hz * 4);
197 cs->hw_mode |= CSMODE_PM(pm);
199 fsl_espi_change_mode(spi);
203 static int fsl_espi_cpu_bufs(struct mpc8xxx_spi *mspi, struct spi_transfer *t,
207 struct fsl_espi_reg *reg_base = mspi->reg_base;
212 mpc8xxx_spi_write_reg(®_base->mask, SPIM_NE);
215 word = mspi->get_tx(mspi);
216 mpc8xxx_spi_write_reg(®_base->transmit, word);
221 static int fsl_espi_bufs(struct spi_device *spi, struct spi_transfer *t)
223 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
224 struct fsl_espi_reg *reg_base = mpc8xxx_spi->reg_base;
225 unsigned int len = t->len;
229 bits_per_word = spi->bits_per_word;
230 if (t->bits_per_word)
231 bits_per_word = t->bits_per_word;
233 mpc8xxx_spi->len = t->len;
234 len = roundup(len, 4) / 4;
236 mpc8xxx_spi->tx = t->tx_buf;
237 mpc8xxx_spi->rx = t->rx_buf;
239 INIT_COMPLETION(mpc8xxx_spi->done);
241 /* Set SPCOM[CS] and SPCOM[TRANLEN] field */
242 if ((t->len - 1) > SPCOM_TRANLEN_MAX) {
243 dev_err(mpc8xxx_spi->dev, "Transaction length (%d)"
244 " beyond the SPCOM[TRANLEN] field\n", t->len);
247 mpc8xxx_spi_write_reg(®_base->command,
248 (SPCOM_CS(spi->chip_select) | SPCOM_TRANLEN(t->len - 1)));
250 ret = fsl_espi_cpu_bufs(mpc8xxx_spi, t, len);
254 wait_for_completion(&mpc8xxx_spi->done);
256 /* disable rx ints */
257 mpc8xxx_spi_write_reg(®_base->mask, 0);
259 return mpc8xxx_spi->count;
262 static inline void fsl_espi_addr2cmd(unsigned int addr, u8 *cmd)
265 cmd[1] = (u8)(addr >> 16);
266 cmd[2] = (u8)(addr >> 8);
267 cmd[3] = (u8)(addr >> 0);
271 static inline unsigned int fsl_espi_cmd2addr(u8 *cmd)
274 return cmd[1] << 16 | cmd[2] << 8 | cmd[3] << 0;
279 static void fsl_espi_do_trans(struct spi_message *m,
280 struct fsl_espi_transfer *tr)
282 struct spi_device *spi = m->spi;
283 struct mpc8xxx_spi *mspi = spi_master_get_devdata(spi->master);
284 struct fsl_espi_transfer *espi_trans = tr;
285 struct spi_message message;
286 struct spi_transfer *t, *first, trans;
289 spi_message_init(&message);
290 memset(&trans, 0, sizeof(trans));
292 first = list_first_entry(&m->transfers, struct spi_transfer,
294 list_for_each_entry(t, &m->transfers, transfer_list) {
295 if ((first->bits_per_word != t->bits_per_word) ||
296 (first->speed_hz != t->speed_hz)) {
297 espi_trans->status = -EINVAL;
298 dev_err(mspi->dev, "bits_per_word/speed_hz should be"
299 " same for the same SPI transfer\n");
303 trans.speed_hz = t->speed_hz;
304 trans.bits_per_word = t->bits_per_word;
305 trans.delay_usecs = max(first->delay_usecs, t->delay_usecs);
308 trans.len = espi_trans->len;
309 trans.tx_buf = espi_trans->tx_buf;
310 trans.rx_buf = espi_trans->rx_buf;
311 spi_message_add_tail(&trans, &message);
313 list_for_each_entry(t, &message.transfers, transfer_list) {
314 if (t->bits_per_word || t->speed_hz) {
317 status = fsl_espi_setup_transfer(spi, t);
323 status = fsl_espi_bufs(spi, t);
331 udelay(t->delay_usecs);
334 espi_trans->status = status;
335 fsl_espi_setup_transfer(spi, NULL);
338 static void fsl_espi_cmd_trans(struct spi_message *m,
339 struct fsl_espi_transfer *trans, u8 *rx_buff)
341 struct spi_transfer *t;
344 struct fsl_espi_transfer *espi_trans = trans;
346 local_buf = kzalloc(SPCOM_TRANLEN_MAX, GFP_KERNEL);
348 espi_trans->status = -ENOMEM;
352 list_for_each_entry(t, &m->transfers, transfer_list) {
354 memcpy(local_buf + i, t->tx_buf, t->len);
359 espi_trans->tx_buf = local_buf;
360 espi_trans->rx_buf = local_buf + espi_trans->n_tx;
361 fsl_espi_do_trans(m, espi_trans);
363 espi_trans->actual_length = espi_trans->len;
367 static void fsl_espi_rw_trans(struct spi_message *m,
368 struct fsl_espi_transfer *trans, u8 *rx_buff)
370 struct fsl_espi_transfer *espi_trans = trans;
371 unsigned int n_tx = espi_trans->n_tx;
372 unsigned int n_rx = espi_trans->n_rx;
373 struct spi_transfer *t;
375 u8 *rx_buf = rx_buff;
376 unsigned int trans_len;
380 local_buf = kzalloc(SPCOM_TRANLEN_MAX, GFP_KERNEL);
382 espi_trans->status = -ENOMEM;
386 for (pos = 0, loop = 0; pos < n_rx; pos += trans_len, loop++) {
387 trans_len = n_rx - pos;
388 if (trans_len > SPCOM_TRANLEN_MAX - n_tx)
389 trans_len = SPCOM_TRANLEN_MAX - n_tx;
392 list_for_each_entry(t, &m->transfers, transfer_list) {
394 memcpy(local_buf + i, t->tx_buf, t->len);
400 addr = fsl_espi_cmd2addr(local_buf);
402 fsl_espi_addr2cmd(addr, local_buf);
405 espi_trans->n_tx = n_tx;
406 espi_trans->n_rx = trans_len;
407 espi_trans->len = trans_len + n_tx;
408 espi_trans->tx_buf = local_buf;
409 espi_trans->rx_buf = local_buf + n_tx;
410 fsl_espi_do_trans(m, espi_trans);
412 memcpy(rx_buf + pos, espi_trans->rx_buf + n_tx, trans_len);
415 espi_trans->actual_length += espi_trans->len - n_tx;
417 espi_trans->actual_length += espi_trans->len;
423 static void fsl_espi_do_one_msg(struct spi_message *m)
425 struct spi_transfer *t;
427 unsigned int n_tx = 0;
428 unsigned int n_rx = 0;
429 struct fsl_espi_transfer espi_trans;
431 list_for_each_entry(t, &m->transfers, transfer_list) {
440 espi_trans.n_tx = n_tx;
441 espi_trans.n_rx = n_rx;
442 espi_trans.len = n_tx + n_rx;
443 espi_trans.actual_length = 0;
444 espi_trans.status = 0;
447 fsl_espi_cmd_trans(m, &espi_trans, NULL);
449 fsl_espi_rw_trans(m, &espi_trans, rx_buf);
451 m->actual_length = espi_trans.actual_length;
452 m->status = espi_trans.status;
453 m->complete(m->context);
456 static int fsl_espi_setup(struct spi_device *spi)
458 struct mpc8xxx_spi *mpc8xxx_spi;
459 struct fsl_espi_reg *reg_base;
463 struct spi_mpc8xxx_cs *cs = spi->controller_state;
465 if (!spi->max_speed_hz)
469 cs = kzalloc(sizeof *cs, GFP_KERNEL);
472 spi->controller_state = cs;
475 mpc8xxx_spi = spi_master_get_devdata(spi->master);
476 reg_base = mpc8xxx_spi->reg_base;
478 hw_mode = cs->hw_mode; /* Save original settings */
479 cs->hw_mode = mpc8xxx_spi_read_reg(
480 ®_base->csmode[spi->chip_select]);
481 /* mask out bits we are going to set */
482 cs->hw_mode &= ~(CSMODE_CP_BEGIN_EDGECLK | CSMODE_CI_INACTIVEHIGH
485 if (spi->mode & SPI_CPHA)
486 cs->hw_mode |= CSMODE_CP_BEGIN_EDGECLK;
487 if (spi->mode & SPI_CPOL)
488 cs->hw_mode |= CSMODE_CI_INACTIVEHIGH;
489 if (!(spi->mode & SPI_LSB_FIRST))
490 cs->hw_mode |= CSMODE_REV;
492 /* Handle the loop mode */
493 loop_mode = mpc8xxx_spi_read_reg(®_base->mode);
494 loop_mode &= ~SPMODE_LOOP;
495 if (spi->mode & SPI_LOOP)
496 loop_mode |= SPMODE_LOOP;
497 mpc8xxx_spi_write_reg(®_base->mode, loop_mode);
499 retval = fsl_espi_setup_transfer(spi, NULL);
501 cs->hw_mode = hw_mode; /* Restore settings */
507 void fsl_espi_cpu_irq(struct mpc8xxx_spi *mspi, u32 events)
509 struct fsl_espi_reg *reg_base = mspi->reg_base;
511 /* We need handle RX first */
512 if (events & SPIE_NE) {
516 /* Spin until RX is done */
517 while (SPIE_RXCNT(events) < min(4, mspi->len)) {
519 events = mpc8xxx_spi_read_reg(®_base->event);
522 if (mspi->len >= 4) {
523 rx_data = mpc8xxx_spi_read_reg(®_base->receive);
528 rx_data_8 = in_8((u8 *)®_base->receive);
529 rx_data |= (rx_data_8 << (tmp * 8));
532 rx_data <<= (4 - mspi->len) * 8;
538 mspi->get_rx(rx_data, mspi);
541 if (!(events & SPIE_NF)) {
544 /* spin until TX is done */
545 ret = spin_event_timeout(((events = mpc8xxx_spi_read_reg(
546 ®_base->event)) & SPIE_NF) == 0, 1000, 0);
548 dev_err(mspi->dev, "tired waiting for SPIE_NF\n");
553 /* Clear the events */
554 mpc8xxx_spi_write_reg(®_base->event, events);
558 u32 word = mspi->get_tx(mspi);
560 mpc8xxx_spi_write_reg(®_base->transmit, word);
562 complete(&mspi->done);
566 static irqreturn_t fsl_espi_irq(s32 irq, void *context_data)
568 struct mpc8xxx_spi *mspi = context_data;
569 struct fsl_espi_reg *reg_base = mspi->reg_base;
570 irqreturn_t ret = IRQ_NONE;
573 /* Get interrupt events(tx/rx) */
574 events = mpc8xxx_spi_read_reg(®_base->event);
578 dev_vdbg(mspi->dev, "%s: events %x\n", __func__, events);
580 fsl_espi_cpu_irq(mspi, events);
585 static void fsl_espi_remove(struct mpc8xxx_spi *mspi)
587 iounmap(mspi->reg_base);
590 static struct spi_master * fsl_espi_probe(struct device *dev,
591 struct resource *mem, unsigned int irq)
593 struct fsl_spi_platform_data *pdata = dev->platform_data;
594 struct spi_master *master;
595 struct mpc8xxx_spi *mpc8xxx_spi;
596 struct fsl_espi_reg *reg_base;
600 master = spi_alloc_master(dev, sizeof(struct mpc8xxx_spi));
606 dev_set_drvdata(dev, master);
608 ret = mpc8xxx_spi_probe(dev, mem, irq);
612 master->setup = fsl_espi_setup;
614 mpc8xxx_spi = spi_master_get_devdata(master);
615 mpc8xxx_spi->spi_do_one_msg = fsl_espi_do_one_msg;
616 mpc8xxx_spi->spi_remove = fsl_espi_remove;
618 mpc8xxx_spi->reg_base = ioremap(mem->start, resource_size(mem));
619 if (!mpc8xxx_spi->reg_base) {
624 reg_base = mpc8xxx_spi->reg_base;
626 /* Register for SPI Interrupt */
627 ret = request_irq(mpc8xxx_spi->irq, fsl_espi_irq,
628 0, "fsl_espi", mpc8xxx_spi);
632 if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE) {
633 mpc8xxx_spi->rx_shift = 16;
634 mpc8xxx_spi->tx_shift = 24;
637 /* SPI controller initializations */
638 mpc8xxx_spi_write_reg(®_base->mode, 0);
639 mpc8xxx_spi_write_reg(®_base->mask, 0);
640 mpc8xxx_spi_write_reg(®_base->command, 0);
641 mpc8xxx_spi_write_reg(®_base->event, 0xffffffff);
643 /* Init eSPI CS mode register */
644 for (i = 0; i < pdata->max_chipselect; i++)
645 mpc8xxx_spi_write_reg(®_base->csmode[i], CSMODE_INIT_VAL);
647 /* Enable SPI interface */
648 regval = pdata->initial_spmode | SPMODE_INIT_VAL | SPMODE_ENABLE;
650 mpc8xxx_spi_write_reg(®_base->mode, regval);
652 ret = spi_register_master(master);
656 dev_info(dev, "at 0x%p (irq = %d)\n", reg_base, mpc8xxx_spi->irq);
661 free_irq(mpc8xxx_spi->irq, mpc8xxx_spi);
663 iounmap(mpc8xxx_spi->reg_base);
665 spi_master_put(master);
670 static int of_fsl_espi_get_chipselects(struct device *dev)
672 struct device_node *np = dev->of_node;
673 struct fsl_spi_platform_data *pdata = dev->platform_data;
677 prop = of_get_property(np, "fsl,espi-num-chipselects", &len);
678 if (!prop || len < sizeof(*prop)) {
679 dev_err(dev, "No 'fsl,espi-num-chipselects' property\n");
683 pdata->max_chipselect = *prop;
684 pdata->cs_control = NULL;
689 static int of_fsl_espi_probe(struct platform_device *ofdev)
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);
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 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 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 = of_fsl_espi_remove,
748 module_platform_driver(fsl_espi_driver);
750 MODULE_AUTHOR("Mingkai Hu");
751 MODULE_DESCRIPTION("Enhanced Freescale SPI Driver");
752 MODULE_LICENSE("GPL");