Loading...
1/*
2 * MPC512x PSC in SPI mode driver.
3 *
4 * Copyright (C) 2007,2008 Freescale Semiconductor Inc.
5 * Original port from 52xx driver:
6 * Hongjun Chen <hong-jun.chen@freescale.com>
7 *
8 * Fork of mpc52xx_psc_spi.c:
9 * Copyright (C) 2006 TOPTICA Photonics AG., Dragos Carp
10 *
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
15 */
16
17#include <linux/module.h>
18#include <linux/kernel.h>
19#include <linux/init.h>
20#include <linux/errno.h>
21#include <linux/interrupt.h>
22#include <linux/of_address.h>
23#include <linux/of_platform.h>
24#include <linux/workqueue.h>
25#include <linux/completion.h>
26#include <linux/io.h>
27#include <linux/delay.h>
28#include <linux/clk.h>
29#include <linux/spi/spi.h>
30#include <linux/fsl_devices.h>
31#include <asm/mpc52xx_psc.h>
32
33struct mpc512x_psc_spi {
34 void (*cs_control)(struct spi_device *spi, bool on);
35 u32 sysclk;
36
37 /* driver internal data */
38 struct mpc52xx_psc __iomem *psc;
39 struct mpc512x_psc_fifo __iomem *fifo;
40 unsigned int irq;
41 u8 bits_per_word;
42 u8 busy;
43 u32 mclk;
44 u8 eofbyte;
45
46 struct workqueue_struct *workqueue;
47 struct work_struct work;
48
49 struct list_head queue;
50 spinlock_t lock; /* Message queue lock */
51
52 struct completion done;
53};
54
55/* controller state */
56struct mpc512x_psc_spi_cs {
57 int bits_per_word;
58 int speed_hz;
59};
60
61/* set clock freq, clock ramp, bits per work
62 * if t is NULL then reset the values to the default values
63 */
64static int mpc512x_psc_spi_transfer_setup(struct spi_device *spi,
65 struct spi_transfer *t)
66{
67 struct mpc512x_psc_spi_cs *cs = spi->controller_state;
68
69 cs->speed_hz = (t && t->speed_hz)
70 ? t->speed_hz : spi->max_speed_hz;
71 cs->bits_per_word = (t && t->bits_per_word)
72 ? t->bits_per_word : spi->bits_per_word;
73 cs->bits_per_word = ((cs->bits_per_word + 7) / 8) * 8;
74 return 0;
75}
76
77static void mpc512x_psc_spi_activate_cs(struct spi_device *spi)
78{
79 struct mpc512x_psc_spi_cs *cs = spi->controller_state;
80 struct mpc512x_psc_spi *mps = spi_master_get_devdata(spi->master);
81 struct mpc52xx_psc __iomem *psc = mps->psc;
82 u32 sicr;
83 u32 ccr;
84 u16 bclkdiv;
85
86 sicr = in_be32(&psc->sicr);
87
88 /* Set clock phase and polarity */
89 if (spi->mode & SPI_CPHA)
90 sicr |= 0x00001000;
91 else
92 sicr &= ~0x00001000;
93
94 if (spi->mode & SPI_CPOL)
95 sicr |= 0x00002000;
96 else
97 sicr &= ~0x00002000;
98
99 if (spi->mode & SPI_LSB_FIRST)
100 sicr |= 0x10000000;
101 else
102 sicr &= ~0x10000000;
103 out_be32(&psc->sicr, sicr);
104
105 ccr = in_be32(&psc->ccr);
106 ccr &= 0xFF000000;
107 if (cs->speed_hz)
108 bclkdiv = (mps->mclk / cs->speed_hz) - 1;
109 else
110 bclkdiv = (mps->mclk / 1000000) - 1; /* default 1MHz */
111
112 ccr |= (((bclkdiv & 0xff) << 16) | (((bclkdiv >> 8) & 0xff) << 8));
113 out_be32(&psc->ccr, ccr);
114 mps->bits_per_word = cs->bits_per_word;
115
116 if (mps->cs_control)
117 mps->cs_control(spi, (spi->mode & SPI_CS_HIGH) ? 1 : 0);
118}
119
120static void mpc512x_psc_spi_deactivate_cs(struct spi_device *spi)
121{
122 struct mpc512x_psc_spi *mps = spi_master_get_devdata(spi->master);
123
124 if (mps->cs_control)
125 mps->cs_control(spi, (spi->mode & SPI_CS_HIGH) ? 0 : 1);
126
127}
128
129/* extract and scale size field in txsz or rxsz */
130#define MPC512x_PSC_FIFO_SZ(sz) ((sz & 0x7ff) << 2);
131
132#define EOFBYTE 1
133
134static int mpc512x_psc_spi_transfer_rxtx(struct spi_device *spi,
135 struct spi_transfer *t)
136{
137 struct mpc512x_psc_spi *mps = spi_master_get_devdata(spi->master);
138 struct mpc52xx_psc __iomem *psc = mps->psc;
139 struct mpc512x_psc_fifo __iomem *fifo = mps->fifo;
140 size_t len = t->len;
141 u8 *tx_buf = (u8 *)t->tx_buf;
142 u8 *rx_buf = (u8 *)t->rx_buf;
143
144 if (!tx_buf && !rx_buf && t->len)
145 return -EINVAL;
146
147 /* Zero MR2 */
148 in_8(&psc->mode);
149 out_8(&psc->mode, 0x0);
150
151 while (len) {
152 int count;
153 int i;
154 u8 data;
155 size_t fifosz;
156 int rxcount;
157
158 /*
159 * The number of bytes that can be sent at a time
160 * depends on the fifo size.
161 */
162 fifosz = MPC512x_PSC_FIFO_SZ(in_be32(&fifo->txsz));
163 count = min(fifosz, len);
164
165 for (i = count; i > 0; i--) {
166 data = tx_buf ? *tx_buf++ : 0;
167 if (len == EOFBYTE)
168 setbits32(&fifo->txcmd, MPC512x_PSC_FIFO_EOF);
169 out_8(&fifo->txdata_8, data);
170 len--;
171 }
172
173 INIT_COMPLETION(mps->done);
174
175 /* interrupt on tx fifo empty */
176 out_be32(&fifo->txisr, MPC512x_PSC_FIFO_EMPTY);
177 out_be32(&fifo->tximr, MPC512x_PSC_FIFO_EMPTY);
178
179 /* enable transmiter/receiver */
180 out_8(&psc->command,
181 MPC52xx_PSC_TX_ENABLE | MPC52xx_PSC_RX_ENABLE);
182
183 wait_for_completion(&mps->done);
184
185 mdelay(1);
186
187 /* rx fifo should have count bytes in it */
188 rxcount = in_be32(&fifo->rxcnt);
189 if (rxcount != count)
190 mdelay(1);
191
192 rxcount = in_be32(&fifo->rxcnt);
193 if (rxcount != count) {
194 dev_warn(&spi->dev, "expected %d bytes in rx fifo "
195 "but got %d\n", count, rxcount);
196 }
197
198 rxcount = min(rxcount, count);
199 for (i = rxcount; i > 0; i--) {
200 data = in_8(&fifo->rxdata_8);
201 if (rx_buf)
202 *rx_buf++ = data;
203 }
204 while (in_be32(&fifo->rxcnt)) {
205 in_8(&fifo->rxdata_8);
206 }
207
208 out_8(&psc->command,
209 MPC52xx_PSC_TX_DISABLE | MPC52xx_PSC_RX_DISABLE);
210 }
211 /* disable transmiter/receiver and fifo interrupt */
212 out_8(&psc->command, MPC52xx_PSC_TX_DISABLE | MPC52xx_PSC_RX_DISABLE);
213 out_be32(&fifo->tximr, 0);
214 return 0;
215}
216
217static void mpc512x_psc_spi_work(struct work_struct *work)
218{
219 struct mpc512x_psc_spi *mps = container_of(work,
220 struct mpc512x_psc_spi,
221 work);
222
223 spin_lock_irq(&mps->lock);
224 mps->busy = 1;
225 while (!list_empty(&mps->queue)) {
226 struct spi_message *m;
227 struct spi_device *spi;
228 struct spi_transfer *t = NULL;
229 unsigned cs_change;
230 int status;
231
232 m = container_of(mps->queue.next, struct spi_message, queue);
233 list_del_init(&m->queue);
234 spin_unlock_irq(&mps->lock);
235
236 spi = m->spi;
237 cs_change = 1;
238 status = 0;
239 list_for_each_entry(t, &m->transfers, transfer_list) {
240 if (t->bits_per_word || t->speed_hz) {
241 status = mpc512x_psc_spi_transfer_setup(spi, t);
242 if (status < 0)
243 break;
244 }
245
246 if (cs_change)
247 mpc512x_psc_spi_activate_cs(spi);
248 cs_change = t->cs_change;
249
250 status = mpc512x_psc_spi_transfer_rxtx(spi, t);
251 if (status)
252 break;
253 m->actual_length += t->len;
254
255 if (t->delay_usecs)
256 udelay(t->delay_usecs);
257
258 if (cs_change)
259 mpc512x_psc_spi_deactivate_cs(spi);
260 }
261
262 m->status = status;
263 m->complete(m->context);
264
265 if (status || !cs_change)
266 mpc512x_psc_spi_deactivate_cs(spi);
267
268 mpc512x_psc_spi_transfer_setup(spi, NULL);
269
270 spin_lock_irq(&mps->lock);
271 }
272 mps->busy = 0;
273 spin_unlock_irq(&mps->lock);
274}
275
276static int mpc512x_psc_spi_setup(struct spi_device *spi)
277{
278 struct mpc512x_psc_spi *mps = spi_master_get_devdata(spi->master);
279 struct mpc512x_psc_spi_cs *cs = spi->controller_state;
280 unsigned long flags;
281
282 if (spi->bits_per_word % 8)
283 return -EINVAL;
284
285 if (!cs) {
286 cs = kzalloc(sizeof *cs, GFP_KERNEL);
287 if (!cs)
288 return -ENOMEM;
289 spi->controller_state = cs;
290 }
291
292 cs->bits_per_word = spi->bits_per_word;
293 cs->speed_hz = spi->max_speed_hz;
294
295 spin_lock_irqsave(&mps->lock, flags);
296 if (!mps->busy)
297 mpc512x_psc_spi_deactivate_cs(spi);
298 spin_unlock_irqrestore(&mps->lock, flags);
299
300 return 0;
301}
302
303static int mpc512x_psc_spi_transfer(struct spi_device *spi,
304 struct spi_message *m)
305{
306 struct mpc512x_psc_spi *mps = spi_master_get_devdata(spi->master);
307 unsigned long flags;
308
309 m->actual_length = 0;
310 m->status = -EINPROGRESS;
311
312 spin_lock_irqsave(&mps->lock, flags);
313 list_add_tail(&m->queue, &mps->queue);
314 queue_work(mps->workqueue, &mps->work);
315 spin_unlock_irqrestore(&mps->lock, flags);
316
317 return 0;
318}
319
320static void mpc512x_psc_spi_cleanup(struct spi_device *spi)
321{
322 kfree(spi->controller_state);
323}
324
325static int mpc512x_psc_spi_port_config(struct spi_master *master,
326 struct mpc512x_psc_spi *mps)
327{
328 struct mpc52xx_psc __iomem *psc = mps->psc;
329 struct mpc512x_psc_fifo __iomem *fifo = mps->fifo;
330 struct clk *spiclk;
331 int ret = 0;
332 char name[32];
333 u32 sicr;
334 u32 ccr;
335 u16 bclkdiv;
336
337 sprintf(name, "psc%d_mclk", master->bus_num);
338 spiclk = clk_get(&master->dev, name);
339 clk_enable(spiclk);
340 mps->mclk = clk_get_rate(spiclk);
341 clk_put(spiclk);
342
343 /* Reset the PSC into a known state */
344 out_8(&psc->command, MPC52xx_PSC_RST_RX);
345 out_8(&psc->command, MPC52xx_PSC_RST_TX);
346 out_8(&psc->command, MPC52xx_PSC_TX_DISABLE | MPC52xx_PSC_RX_DISABLE);
347
348 /* Disable psc interrupts all useful interrupts are in fifo */
349 out_be16(&psc->isr_imr.imr, 0);
350
351 /* Disable fifo interrupts, will be enabled later */
352 out_be32(&fifo->tximr, 0);
353 out_be32(&fifo->rximr, 0);
354
355 /* Setup fifo slice address and size */
356 /*out_be32(&fifo->txsz, 0x0fe00004);*/
357 /*out_be32(&fifo->rxsz, 0x0ff00004);*/
358
359 sicr = 0x01000000 | /* SIM = 0001 -- 8 bit */
360 0x00800000 | /* GenClk = 1 -- internal clk */
361 0x00008000 | /* SPI = 1 */
362 0x00004000 | /* MSTR = 1 -- SPI master */
363 0x00000800; /* UseEOF = 1 -- SS low until EOF */
364
365 out_be32(&psc->sicr, sicr);
366
367 ccr = in_be32(&psc->ccr);
368 ccr &= 0xFF000000;
369 bclkdiv = (mps->mclk / 1000000) - 1; /* default 1MHz */
370 ccr |= (((bclkdiv & 0xff) << 16) | (((bclkdiv >> 8) & 0xff) << 8));
371 out_be32(&psc->ccr, ccr);
372
373 /* Set 2ms DTL delay */
374 out_8(&psc->ctur, 0x00);
375 out_8(&psc->ctlr, 0x82);
376
377 /* we don't use the alarms */
378 out_be32(&fifo->rxalarm, 0xfff);
379 out_be32(&fifo->txalarm, 0);
380
381 /* Enable FIFO slices for Rx/Tx */
382 out_be32(&fifo->rxcmd,
383 MPC512x_PSC_FIFO_ENABLE_SLICE | MPC512x_PSC_FIFO_ENABLE_DMA);
384 out_be32(&fifo->txcmd,
385 MPC512x_PSC_FIFO_ENABLE_SLICE | MPC512x_PSC_FIFO_ENABLE_DMA);
386
387 mps->bits_per_word = 8;
388
389 return ret;
390}
391
392static irqreturn_t mpc512x_psc_spi_isr(int irq, void *dev_id)
393{
394 struct mpc512x_psc_spi *mps = (struct mpc512x_psc_spi *)dev_id;
395 struct mpc512x_psc_fifo __iomem *fifo = mps->fifo;
396
397 /* clear interrupt and wake up the work queue */
398 if (in_be32(&fifo->txisr) &
399 in_be32(&fifo->tximr) & MPC512x_PSC_FIFO_EMPTY) {
400 out_be32(&fifo->txisr, MPC512x_PSC_FIFO_EMPTY);
401 out_be32(&fifo->tximr, 0);
402 complete(&mps->done);
403 return IRQ_HANDLED;
404 }
405 return IRQ_NONE;
406}
407
408/* bus_num is used only for the case dev->platform_data == NULL */
409static int __devinit mpc512x_psc_spi_do_probe(struct device *dev, u32 regaddr,
410 u32 size, unsigned int irq,
411 s16 bus_num)
412{
413 struct fsl_spi_platform_data *pdata = dev->platform_data;
414 struct mpc512x_psc_spi *mps;
415 struct spi_master *master;
416 int ret;
417 void *tempp;
418
419 master = spi_alloc_master(dev, sizeof *mps);
420 if (master == NULL)
421 return -ENOMEM;
422
423 dev_set_drvdata(dev, master);
424 mps = spi_master_get_devdata(master);
425 mps->irq = irq;
426
427 if (pdata == NULL) {
428 dev_err(dev, "probe called without platform data, no "
429 "cs_control function will be called\n");
430 mps->cs_control = NULL;
431 mps->sysclk = 0;
432 master->bus_num = bus_num;
433 master->num_chipselect = 255;
434 } else {
435 mps->cs_control = pdata->cs_control;
436 mps->sysclk = pdata->sysclk;
437 master->bus_num = pdata->bus_num;
438 master->num_chipselect = pdata->max_chipselect;
439 }
440
441 master->setup = mpc512x_psc_spi_setup;
442 master->transfer = mpc512x_psc_spi_transfer;
443 master->cleanup = mpc512x_psc_spi_cleanup;
444 master->dev.of_node = dev->of_node;
445
446 tempp = ioremap(regaddr, size);
447 if (!tempp) {
448 dev_err(dev, "could not ioremap I/O port range\n");
449 ret = -EFAULT;
450 goto free_master;
451 }
452 mps->psc = tempp;
453 mps->fifo =
454 (struct mpc512x_psc_fifo *)(tempp + sizeof(struct mpc52xx_psc));
455
456 ret = request_irq(mps->irq, mpc512x_psc_spi_isr, IRQF_SHARED,
457 "mpc512x-psc-spi", mps);
458 if (ret)
459 goto free_master;
460
461 ret = mpc512x_psc_spi_port_config(master, mps);
462 if (ret < 0)
463 goto free_irq;
464
465 spin_lock_init(&mps->lock);
466 init_completion(&mps->done);
467 INIT_WORK(&mps->work, mpc512x_psc_spi_work);
468 INIT_LIST_HEAD(&mps->queue);
469
470 mps->workqueue =
471 create_singlethread_workqueue(dev_name(master->dev.parent));
472 if (mps->workqueue == NULL) {
473 ret = -EBUSY;
474 goto free_irq;
475 }
476
477 ret = spi_register_master(master);
478 if (ret < 0)
479 goto unreg_master;
480
481 return ret;
482
483unreg_master:
484 destroy_workqueue(mps->workqueue);
485free_irq:
486 free_irq(mps->irq, mps);
487free_master:
488 if (mps->psc)
489 iounmap(mps->psc);
490 spi_master_put(master);
491
492 return ret;
493}
494
495static int __devexit mpc512x_psc_spi_do_remove(struct device *dev)
496{
497 struct spi_master *master = dev_get_drvdata(dev);
498 struct mpc512x_psc_spi *mps = spi_master_get_devdata(master);
499
500 flush_workqueue(mps->workqueue);
501 destroy_workqueue(mps->workqueue);
502 spi_unregister_master(master);
503 free_irq(mps->irq, mps);
504 if (mps->psc)
505 iounmap(mps->psc);
506
507 return 0;
508}
509
510static int __devinit mpc512x_psc_spi_of_probe(struct platform_device *op)
511{
512 const u32 *regaddr_p;
513 u64 regaddr64, size64;
514 s16 id = -1;
515
516 regaddr_p = of_get_address(op->dev.of_node, 0, &size64, NULL);
517 if (!regaddr_p) {
518 dev_err(&op->dev, "Invalid PSC address\n");
519 return -EINVAL;
520 }
521 regaddr64 = of_translate_address(op->dev.of_node, regaddr_p);
522
523 /* get PSC id (0..11, used by port_config) */
524 if (op->dev.platform_data == NULL) {
525 const u32 *psc_nump;
526
527 psc_nump = of_get_property(op->dev.of_node, "cell-index", NULL);
528 if (!psc_nump || *psc_nump > 11) {
529 dev_err(&op->dev, "mpc512x_psc_spi: Device node %s "
530 "has invalid cell-index property\n",
531 op->dev.of_node->full_name);
532 return -EINVAL;
533 }
534 id = *psc_nump;
535 }
536
537 return mpc512x_psc_spi_do_probe(&op->dev, (u32) regaddr64, (u32) size64,
538 irq_of_parse_and_map(op->dev.of_node, 0), id);
539}
540
541static int __devexit mpc512x_psc_spi_of_remove(struct platform_device *op)
542{
543 return mpc512x_psc_spi_do_remove(&op->dev);
544}
545
546static struct of_device_id mpc512x_psc_spi_of_match[] = {
547 { .compatible = "fsl,mpc5121-psc-spi", },
548 {},
549};
550
551MODULE_DEVICE_TABLE(of, mpc512x_psc_spi_of_match);
552
553static struct platform_driver mpc512x_psc_spi_of_driver = {
554 .probe = mpc512x_psc_spi_of_probe,
555 .remove = __devexit_p(mpc512x_psc_spi_of_remove),
556 .driver = {
557 .name = "mpc512x-psc-spi",
558 .owner = THIS_MODULE,
559 .of_match_table = mpc512x_psc_spi_of_match,
560 },
561};
562
563static int __init mpc512x_psc_spi_init(void)
564{
565 return platform_driver_register(&mpc512x_psc_spi_of_driver);
566}
567module_init(mpc512x_psc_spi_init);
568
569static void __exit mpc512x_psc_spi_exit(void)
570{
571 platform_driver_unregister(&mpc512x_psc_spi_of_driver);
572}
573module_exit(mpc512x_psc_spi_exit);
574
575MODULE_AUTHOR("John Rigby");
576MODULE_DESCRIPTION("MPC512x PSC SPI Driver");
577MODULE_LICENSE("GPL");
1/*
2 * MPC512x PSC in SPI mode driver.
3 *
4 * Copyright (C) 2007,2008 Freescale Semiconductor Inc.
5 * Original port from 52xx driver:
6 * Hongjun Chen <hong-jun.chen@freescale.com>
7 *
8 * Fork of mpc52xx_psc_spi.c:
9 * Copyright (C) 2006 TOPTICA Photonics AG., Dragos Carp
10 *
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
15 */
16
17#include <linux/module.h>
18#include <linux/kernel.h>
19#include <linux/errno.h>
20#include <linux/interrupt.h>
21#include <linux/of_address.h>
22#include <linux/of_irq.h>
23#include <linux/of_platform.h>
24#include <linux/completion.h>
25#include <linux/io.h>
26#include <linux/delay.h>
27#include <linux/clk.h>
28#include <linux/spi/spi.h>
29#include <linux/fsl_devices.h>
30#include <linux/gpio.h>
31#include <asm/mpc52xx_psc.h>
32
33enum {
34 TYPE_MPC5121,
35 TYPE_MPC5125,
36};
37
38/*
39 * This macro abstracts the differences in the PSC register layout between
40 * MPC5121 (which uses a struct mpc52xx_psc) and MPC5125 (using mpc5125_psc).
41 */
42#define psc_addr(mps, regname) ({ \
43 void *__ret = NULL; \
44 switch (mps->type) { \
45 case TYPE_MPC5121: { \
46 struct mpc52xx_psc __iomem *psc = mps->psc; \
47 __ret = &psc->regname; \
48 }; \
49 break; \
50 case TYPE_MPC5125: { \
51 struct mpc5125_psc __iomem *psc = mps->psc; \
52 __ret = &psc->regname; \
53 }; \
54 break; \
55 } \
56 __ret; })
57
58struct mpc512x_psc_spi {
59 void (*cs_control)(struct spi_device *spi, bool on);
60
61 /* driver internal data */
62 int type;
63 void __iomem *psc;
64 struct mpc512x_psc_fifo __iomem *fifo;
65 unsigned int irq;
66 u8 bits_per_word;
67 struct clk *clk_mclk;
68 struct clk *clk_ipg;
69 u32 mclk_rate;
70
71 struct completion txisrdone;
72};
73
74/* controller state */
75struct mpc512x_psc_spi_cs {
76 int bits_per_word;
77 int speed_hz;
78};
79
80/* set clock freq, clock ramp, bits per work
81 * if t is NULL then reset the values to the default values
82 */
83static int mpc512x_psc_spi_transfer_setup(struct spi_device *spi,
84 struct spi_transfer *t)
85{
86 struct mpc512x_psc_spi_cs *cs = spi->controller_state;
87
88 cs->speed_hz = (t && t->speed_hz)
89 ? t->speed_hz : spi->max_speed_hz;
90 cs->bits_per_word = (t && t->bits_per_word)
91 ? t->bits_per_word : spi->bits_per_word;
92 cs->bits_per_word = ((cs->bits_per_word + 7) / 8) * 8;
93 return 0;
94}
95
96static void mpc512x_psc_spi_activate_cs(struct spi_device *spi)
97{
98 struct mpc512x_psc_spi_cs *cs = spi->controller_state;
99 struct mpc512x_psc_spi *mps = spi_master_get_devdata(spi->master);
100 u32 sicr;
101 u32 ccr;
102 int speed;
103 u16 bclkdiv;
104
105 sicr = in_be32(psc_addr(mps, sicr));
106
107 /* Set clock phase and polarity */
108 if (spi->mode & SPI_CPHA)
109 sicr |= 0x00001000;
110 else
111 sicr &= ~0x00001000;
112
113 if (spi->mode & SPI_CPOL)
114 sicr |= 0x00002000;
115 else
116 sicr &= ~0x00002000;
117
118 if (spi->mode & SPI_LSB_FIRST)
119 sicr |= 0x10000000;
120 else
121 sicr &= ~0x10000000;
122 out_be32(psc_addr(mps, sicr), sicr);
123
124 ccr = in_be32(psc_addr(mps, ccr));
125 ccr &= 0xFF000000;
126 speed = cs->speed_hz;
127 if (!speed)
128 speed = 1000000; /* default 1MHz */
129 bclkdiv = (mps->mclk_rate / speed) - 1;
130
131 ccr |= (((bclkdiv & 0xff) << 16) | (((bclkdiv >> 8) & 0xff) << 8));
132 out_be32(psc_addr(mps, ccr), ccr);
133 mps->bits_per_word = cs->bits_per_word;
134
135 if (mps->cs_control && gpio_is_valid(spi->cs_gpio))
136 mps->cs_control(spi, (spi->mode & SPI_CS_HIGH) ? 1 : 0);
137}
138
139static void mpc512x_psc_spi_deactivate_cs(struct spi_device *spi)
140{
141 struct mpc512x_psc_spi *mps = spi_master_get_devdata(spi->master);
142
143 if (mps->cs_control && gpio_is_valid(spi->cs_gpio))
144 mps->cs_control(spi, (spi->mode & SPI_CS_HIGH) ? 0 : 1);
145
146}
147
148/* extract and scale size field in txsz or rxsz */
149#define MPC512x_PSC_FIFO_SZ(sz) ((sz & 0x7ff) << 2);
150
151#define EOFBYTE 1
152
153static int mpc512x_psc_spi_transfer_rxtx(struct spi_device *spi,
154 struct spi_transfer *t)
155{
156 struct mpc512x_psc_spi *mps = spi_master_get_devdata(spi->master);
157 struct mpc512x_psc_fifo __iomem *fifo = mps->fifo;
158 size_t tx_len = t->len;
159 size_t rx_len = t->len;
160 u8 *tx_buf = (u8 *)t->tx_buf;
161 u8 *rx_buf = (u8 *)t->rx_buf;
162
163 if (!tx_buf && !rx_buf && t->len)
164 return -EINVAL;
165
166 while (rx_len || tx_len) {
167 size_t txcount;
168 u8 data;
169 size_t fifosz;
170 size_t rxcount;
171 int rxtries;
172
173 /*
174 * send the TX bytes in as large a chunk as possible
175 * but neither exceed the TX nor the RX FIFOs
176 */
177 fifosz = MPC512x_PSC_FIFO_SZ(in_be32(&fifo->txsz));
178 txcount = min(fifosz, tx_len);
179 fifosz = MPC512x_PSC_FIFO_SZ(in_be32(&fifo->rxsz));
180 fifosz -= in_be32(&fifo->rxcnt) + 1;
181 txcount = min(fifosz, txcount);
182 if (txcount) {
183
184 /* fill the TX FIFO */
185 while (txcount-- > 0) {
186 data = tx_buf ? *tx_buf++ : 0;
187 if (tx_len == EOFBYTE && t->cs_change)
188 setbits32(&fifo->txcmd,
189 MPC512x_PSC_FIFO_EOF);
190 out_8(&fifo->txdata_8, data);
191 tx_len--;
192 }
193
194 /* have the ISR trigger when the TX FIFO is empty */
195 reinit_completion(&mps->txisrdone);
196 out_be32(&fifo->txisr, MPC512x_PSC_FIFO_EMPTY);
197 out_be32(&fifo->tximr, MPC512x_PSC_FIFO_EMPTY);
198 wait_for_completion(&mps->txisrdone);
199 }
200
201 /*
202 * consume as much RX data as the FIFO holds, while we
203 * iterate over the transfer's TX data length
204 *
205 * only insist in draining all the remaining RX bytes
206 * when the TX bytes were exhausted (that's at the very
207 * end of this transfer, not when still iterating over
208 * the transfer's chunks)
209 */
210 rxtries = 50;
211 do {
212
213 /*
214 * grab whatever was in the FIFO when we started
215 * looking, don't bother fetching what was added to
216 * the FIFO while we read from it -- we'll return
217 * here eventually and prefer sending out remaining
218 * TX data
219 */
220 fifosz = in_be32(&fifo->rxcnt);
221 rxcount = min(fifosz, rx_len);
222 while (rxcount-- > 0) {
223 data = in_8(&fifo->rxdata_8);
224 if (rx_buf)
225 *rx_buf++ = data;
226 rx_len--;
227 }
228
229 /*
230 * come back later if there still is TX data to send,
231 * bail out of the RX drain loop if all of the TX data
232 * was sent and all of the RX data was received (i.e.
233 * when the transmission has completed)
234 */
235 if (tx_len)
236 break;
237 if (!rx_len)
238 break;
239
240 /*
241 * TX data transmission has completed while RX data
242 * is still pending -- that's a transient situation
243 * which depends on wire speed and specific
244 * hardware implementation details (buffering) yet
245 * should resolve very quickly
246 *
247 * just yield for a moment to not hog the CPU for
248 * too long when running SPI at low speed
249 *
250 * the timeout range is rather arbitrary and tries
251 * to balance throughput against system load; the
252 * chosen values result in a minimal timeout of 50
253 * times 10us and thus work at speeds as low as
254 * some 20kbps, while the maximum timeout at the
255 * transfer's end could be 5ms _if_ nothing else
256 * ticks in the system _and_ RX data still wasn't
257 * received, which only occurs in situations that
258 * are exceptional; removing the unpredictability
259 * of the timeout either decreases throughput
260 * (longer timeouts), or puts more load on the
261 * system (fixed short timeouts) or requires the
262 * use of a timeout API instead of a counter and an
263 * unknown inner delay
264 */
265 usleep_range(10, 100);
266
267 } while (--rxtries > 0);
268 if (!tx_len && rx_len && !rxtries) {
269 /*
270 * not enough RX bytes even after several retries
271 * and the resulting rather long timeout?
272 */
273 rxcount = in_be32(&fifo->rxcnt);
274 dev_warn(&spi->dev,
275 "short xfer, missing %zd RX bytes, FIFO level %zd\n",
276 rx_len, rxcount);
277 }
278
279 /*
280 * drain and drop RX data which "should not be there" in
281 * the first place, for undisturbed transmission this turns
282 * into a NOP (except for the FIFO level fetch)
283 */
284 if (!tx_len && !rx_len) {
285 while (in_be32(&fifo->rxcnt))
286 in_8(&fifo->rxdata_8);
287 }
288
289 }
290 return 0;
291}
292
293static int mpc512x_psc_spi_msg_xfer(struct spi_master *master,
294 struct spi_message *m)
295{
296 struct spi_device *spi;
297 unsigned cs_change;
298 int status;
299 struct spi_transfer *t;
300
301 spi = m->spi;
302 cs_change = 1;
303 status = 0;
304 list_for_each_entry(t, &m->transfers, transfer_list) {
305 status = mpc512x_psc_spi_transfer_setup(spi, t);
306 if (status < 0)
307 break;
308
309 if (cs_change)
310 mpc512x_psc_spi_activate_cs(spi);
311 cs_change = t->cs_change;
312
313 status = mpc512x_psc_spi_transfer_rxtx(spi, t);
314 if (status)
315 break;
316 m->actual_length += t->len;
317
318 if (t->delay_usecs)
319 udelay(t->delay_usecs);
320
321 if (cs_change)
322 mpc512x_psc_spi_deactivate_cs(spi);
323 }
324
325 m->status = status;
326 if (m->complete)
327 m->complete(m->context);
328
329 if (status || !cs_change)
330 mpc512x_psc_spi_deactivate_cs(spi);
331
332 mpc512x_psc_spi_transfer_setup(spi, NULL);
333
334 spi_finalize_current_message(master);
335 return status;
336}
337
338static int mpc512x_psc_spi_prep_xfer_hw(struct spi_master *master)
339{
340 struct mpc512x_psc_spi *mps = spi_master_get_devdata(master);
341
342 dev_dbg(&master->dev, "%s()\n", __func__);
343
344 /* Zero MR2 */
345 in_8(psc_addr(mps, mr2));
346 out_8(psc_addr(mps, mr2), 0x0);
347
348 /* enable transmitter/receiver */
349 out_8(psc_addr(mps, command), MPC52xx_PSC_TX_ENABLE | MPC52xx_PSC_RX_ENABLE);
350
351 return 0;
352}
353
354static int mpc512x_psc_spi_unprep_xfer_hw(struct spi_master *master)
355{
356 struct mpc512x_psc_spi *mps = spi_master_get_devdata(master);
357 struct mpc512x_psc_fifo __iomem *fifo = mps->fifo;
358
359 dev_dbg(&master->dev, "%s()\n", __func__);
360
361 /* disable transmitter/receiver and fifo interrupt */
362 out_8(psc_addr(mps, command), MPC52xx_PSC_TX_DISABLE | MPC52xx_PSC_RX_DISABLE);
363 out_be32(&fifo->tximr, 0);
364
365 return 0;
366}
367
368static int mpc512x_psc_spi_setup(struct spi_device *spi)
369{
370 struct mpc512x_psc_spi_cs *cs = spi->controller_state;
371 int ret;
372
373 if (spi->bits_per_word % 8)
374 return -EINVAL;
375
376 if (!cs) {
377 cs = kzalloc(sizeof *cs, GFP_KERNEL);
378 if (!cs)
379 return -ENOMEM;
380
381 if (gpio_is_valid(spi->cs_gpio)) {
382 ret = gpio_request(spi->cs_gpio, dev_name(&spi->dev));
383 if (ret) {
384 dev_err(&spi->dev, "can't get CS gpio: %d\n",
385 ret);
386 kfree(cs);
387 return ret;
388 }
389 gpio_direction_output(spi->cs_gpio,
390 spi->mode & SPI_CS_HIGH ? 0 : 1);
391 }
392
393 spi->controller_state = cs;
394 }
395
396 cs->bits_per_word = spi->bits_per_word;
397 cs->speed_hz = spi->max_speed_hz;
398
399 return 0;
400}
401
402static void mpc512x_psc_spi_cleanup(struct spi_device *spi)
403{
404 if (gpio_is_valid(spi->cs_gpio))
405 gpio_free(spi->cs_gpio);
406 kfree(spi->controller_state);
407}
408
409static int mpc512x_psc_spi_port_config(struct spi_master *master,
410 struct mpc512x_psc_spi *mps)
411{
412 struct mpc512x_psc_fifo __iomem *fifo = mps->fifo;
413 u32 sicr;
414 u32 ccr;
415 int speed;
416 u16 bclkdiv;
417
418 /* Reset the PSC into a known state */
419 out_8(psc_addr(mps, command), MPC52xx_PSC_RST_RX);
420 out_8(psc_addr(mps, command), MPC52xx_PSC_RST_TX);
421 out_8(psc_addr(mps, command), MPC52xx_PSC_TX_DISABLE | MPC52xx_PSC_RX_DISABLE);
422
423 /* Disable psc interrupts all useful interrupts are in fifo */
424 out_be16(psc_addr(mps, isr_imr.imr), 0);
425
426 /* Disable fifo interrupts, will be enabled later */
427 out_be32(&fifo->tximr, 0);
428 out_be32(&fifo->rximr, 0);
429
430 /* Setup fifo slice address and size */
431 /*out_be32(&fifo->txsz, 0x0fe00004);*/
432 /*out_be32(&fifo->rxsz, 0x0ff00004);*/
433
434 sicr = 0x01000000 | /* SIM = 0001 -- 8 bit */
435 0x00800000 | /* GenClk = 1 -- internal clk */
436 0x00008000 | /* SPI = 1 */
437 0x00004000 | /* MSTR = 1 -- SPI master */
438 0x00000800; /* UseEOF = 1 -- SS low until EOF */
439
440 out_be32(psc_addr(mps, sicr), sicr);
441
442 ccr = in_be32(psc_addr(mps, ccr));
443 ccr &= 0xFF000000;
444 speed = 1000000; /* default 1MHz */
445 bclkdiv = (mps->mclk_rate / speed) - 1;
446 ccr |= (((bclkdiv & 0xff) << 16) | (((bclkdiv >> 8) & 0xff) << 8));
447 out_be32(psc_addr(mps, ccr), ccr);
448
449 /* Set 2ms DTL delay */
450 out_8(psc_addr(mps, ctur), 0x00);
451 out_8(psc_addr(mps, ctlr), 0x82);
452
453 /* we don't use the alarms */
454 out_be32(&fifo->rxalarm, 0xfff);
455 out_be32(&fifo->txalarm, 0);
456
457 /* Enable FIFO slices for Rx/Tx */
458 out_be32(&fifo->rxcmd,
459 MPC512x_PSC_FIFO_ENABLE_SLICE | MPC512x_PSC_FIFO_ENABLE_DMA);
460 out_be32(&fifo->txcmd,
461 MPC512x_PSC_FIFO_ENABLE_SLICE | MPC512x_PSC_FIFO_ENABLE_DMA);
462
463 mps->bits_per_word = 8;
464
465 return 0;
466}
467
468static irqreturn_t mpc512x_psc_spi_isr(int irq, void *dev_id)
469{
470 struct mpc512x_psc_spi *mps = (struct mpc512x_psc_spi *)dev_id;
471 struct mpc512x_psc_fifo __iomem *fifo = mps->fifo;
472
473 /* clear interrupt and wake up the rx/tx routine */
474 if (in_be32(&fifo->txisr) &
475 in_be32(&fifo->tximr) & MPC512x_PSC_FIFO_EMPTY) {
476 out_be32(&fifo->txisr, MPC512x_PSC_FIFO_EMPTY);
477 out_be32(&fifo->tximr, 0);
478 complete(&mps->txisrdone);
479 return IRQ_HANDLED;
480 }
481 return IRQ_NONE;
482}
483
484static void mpc512x_spi_cs_control(struct spi_device *spi, bool onoff)
485{
486 gpio_set_value(spi->cs_gpio, onoff);
487}
488
489static int mpc512x_psc_spi_do_probe(struct device *dev, u32 regaddr,
490 u32 size, unsigned int irq)
491{
492 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
493 struct mpc512x_psc_spi *mps;
494 struct spi_master *master;
495 int ret;
496 void *tempp;
497 struct clk *clk;
498
499 master = spi_alloc_master(dev, sizeof *mps);
500 if (master == NULL)
501 return -ENOMEM;
502
503 dev_set_drvdata(dev, master);
504 mps = spi_master_get_devdata(master);
505 mps->type = (int)of_device_get_match_data(dev);
506 mps->irq = irq;
507
508 if (pdata == NULL) {
509 mps->cs_control = mpc512x_spi_cs_control;
510 } else {
511 mps->cs_control = pdata->cs_control;
512 master->bus_num = pdata->bus_num;
513 master->num_chipselect = pdata->max_chipselect;
514 }
515
516 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LSB_FIRST;
517 master->setup = mpc512x_psc_spi_setup;
518 master->prepare_transfer_hardware = mpc512x_psc_spi_prep_xfer_hw;
519 master->transfer_one_message = mpc512x_psc_spi_msg_xfer;
520 master->unprepare_transfer_hardware = mpc512x_psc_spi_unprep_xfer_hw;
521 master->cleanup = mpc512x_psc_spi_cleanup;
522 master->dev.of_node = dev->of_node;
523
524 tempp = devm_ioremap(dev, regaddr, size);
525 if (!tempp) {
526 dev_err(dev, "could not ioremap I/O port range\n");
527 ret = -EFAULT;
528 goto free_master;
529 }
530 mps->psc = tempp;
531 mps->fifo =
532 (struct mpc512x_psc_fifo *)(tempp + sizeof(struct mpc52xx_psc));
533 ret = devm_request_irq(dev, mps->irq, mpc512x_psc_spi_isr, IRQF_SHARED,
534 "mpc512x-psc-spi", mps);
535 if (ret)
536 goto free_master;
537 init_completion(&mps->txisrdone);
538
539 clk = devm_clk_get(dev, "mclk");
540 if (IS_ERR(clk)) {
541 ret = PTR_ERR(clk);
542 goto free_master;
543 }
544 ret = clk_prepare_enable(clk);
545 if (ret)
546 goto free_master;
547 mps->clk_mclk = clk;
548 mps->mclk_rate = clk_get_rate(clk);
549
550 clk = devm_clk_get(dev, "ipg");
551 if (IS_ERR(clk)) {
552 ret = PTR_ERR(clk);
553 goto free_mclk_clock;
554 }
555 ret = clk_prepare_enable(clk);
556 if (ret)
557 goto free_mclk_clock;
558 mps->clk_ipg = clk;
559
560 ret = mpc512x_psc_spi_port_config(master, mps);
561 if (ret < 0)
562 goto free_ipg_clock;
563
564 ret = devm_spi_register_master(dev, master);
565 if (ret < 0)
566 goto free_ipg_clock;
567
568 return ret;
569
570free_ipg_clock:
571 clk_disable_unprepare(mps->clk_ipg);
572free_mclk_clock:
573 clk_disable_unprepare(mps->clk_mclk);
574free_master:
575 spi_master_put(master);
576
577 return ret;
578}
579
580static int mpc512x_psc_spi_do_remove(struct device *dev)
581{
582 struct spi_master *master = dev_get_drvdata(dev);
583 struct mpc512x_psc_spi *mps = spi_master_get_devdata(master);
584
585 clk_disable_unprepare(mps->clk_mclk);
586 clk_disable_unprepare(mps->clk_ipg);
587
588 return 0;
589}
590
591static int mpc512x_psc_spi_of_probe(struct platform_device *op)
592{
593 const u32 *regaddr_p;
594 u64 regaddr64, size64;
595
596 regaddr_p = of_get_address(op->dev.of_node, 0, &size64, NULL);
597 if (!regaddr_p) {
598 dev_err(&op->dev, "Invalid PSC address\n");
599 return -EINVAL;
600 }
601 regaddr64 = of_translate_address(op->dev.of_node, regaddr_p);
602
603 return mpc512x_psc_spi_do_probe(&op->dev, (u32) regaddr64, (u32) size64,
604 irq_of_parse_and_map(op->dev.of_node, 0));
605}
606
607static int mpc512x_psc_spi_of_remove(struct platform_device *op)
608{
609 return mpc512x_psc_spi_do_remove(&op->dev);
610}
611
612static const struct of_device_id mpc512x_psc_spi_of_match[] = {
613 { .compatible = "fsl,mpc5121-psc-spi", .data = (void *)TYPE_MPC5121 },
614 { .compatible = "fsl,mpc5125-psc-spi", .data = (void *)TYPE_MPC5125 },
615 {},
616};
617
618MODULE_DEVICE_TABLE(of, mpc512x_psc_spi_of_match);
619
620static struct platform_driver mpc512x_psc_spi_of_driver = {
621 .probe = mpc512x_psc_spi_of_probe,
622 .remove = mpc512x_psc_spi_of_remove,
623 .driver = {
624 .name = "mpc512x-psc-spi",
625 .of_match_table = mpc512x_psc_spi_of_match,
626 },
627};
628module_platform_driver(mpc512x_psc_spi_of_driver);
629
630MODULE_AUTHOR("John Rigby");
631MODULE_DESCRIPTION("MPC512x PSC SPI Driver");
632MODULE_LICENSE("GPL");