Loading...
1/*
2 * Freescale SPI controller driver.
3 *
4 * Maintainer: Kumar Gala
5 *
6 * Copyright (C) 2006 Polycom, Inc.
7 * Copyright 2010 Freescale Semiconductor, Inc.
8 *
9 * CPM SPI and QE buffer descriptors mode support:
10 * Copyright (c) 2009 MontaVista Software, Inc.
11 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
12 *
13 * GRLIB support:
14 * Copyright (c) 2012 Aeroflex Gaisler AB.
15 * Author: Andreas Larsson <andreas@gaisler.com>
16 *
17 * This program is free software; you can redistribute it and/or modify it
18 * under the terms of the GNU General Public License as published by the
19 * Free Software Foundation; either version 2 of the License, or (at your
20 * option) any later version.
21 */
22#include <linux/delay.h>
23#include <linux/dma-mapping.h>
24#include <linux/fsl_devices.h>
25#include <linux/gpio.h>
26#include <linux/interrupt.h>
27#include <linux/irq.h>
28#include <linux/kernel.h>
29#include <linux/mm.h>
30#include <linux/module.h>
31#include <linux/mutex.h>
32#include <linux/of.h>
33#include <linux/of_address.h>
34#include <linux/of_irq.h>
35#include <linux/of_gpio.h>
36#include <linux/of_platform.h>
37#include <linux/platform_device.h>
38#include <linux/spi/spi.h>
39#include <linux/spi/spi_bitbang.h>
40#include <linux/types.h>
41
42#include "spi-fsl-lib.h"
43#include "spi-fsl-cpm.h"
44#include "spi-fsl-spi.h"
45
46#define TYPE_FSL 0
47#define TYPE_GRLIB 1
48
49struct fsl_spi_match_data {
50 int type;
51};
52
53static struct fsl_spi_match_data of_fsl_spi_fsl_config = {
54 .type = TYPE_FSL,
55};
56
57static struct fsl_spi_match_data of_fsl_spi_grlib_config = {
58 .type = TYPE_GRLIB,
59};
60
61static const struct of_device_id of_fsl_spi_match[] = {
62 {
63 .compatible = "fsl,spi",
64 .data = &of_fsl_spi_fsl_config,
65 },
66 {
67 .compatible = "aeroflexgaisler,spictrl",
68 .data = &of_fsl_spi_grlib_config,
69 },
70 {}
71};
72MODULE_DEVICE_TABLE(of, of_fsl_spi_match);
73
74static int fsl_spi_get_type(struct device *dev)
75{
76 const struct of_device_id *match;
77
78 if (dev->of_node) {
79 match = of_match_node(of_fsl_spi_match, dev->of_node);
80 if (match && match->data)
81 return ((struct fsl_spi_match_data *)match->data)->type;
82 }
83 return TYPE_FSL;
84}
85
86static void fsl_spi_change_mode(struct spi_device *spi)
87{
88 struct mpc8xxx_spi *mspi = spi_master_get_devdata(spi->master);
89 struct spi_mpc8xxx_cs *cs = spi->controller_state;
90 struct fsl_spi_reg *reg_base = mspi->reg_base;
91 __be32 __iomem *mode = ®_base->mode;
92 unsigned long flags;
93
94 if (cs->hw_mode == mpc8xxx_spi_read_reg(mode))
95 return;
96
97 /* Turn off IRQs locally to minimize time that SPI is disabled. */
98 local_irq_save(flags);
99
100 /* Turn off SPI unit prior changing mode */
101 mpc8xxx_spi_write_reg(mode, cs->hw_mode & ~SPMODE_ENABLE);
102
103 /* When in CPM mode, we need to reinit tx and rx. */
104 if (mspi->flags & SPI_CPM_MODE) {
105 fsl_spi_cpm_reinit_txrx(mspi);
106 }
107 mpc8xxx_spi_write_reg(mode, cs->hw_mode);
108 local_irq_restore(flags);
109}
110
111static void fsl_spi_chipselect(struct spi_device *spi, int value)
112{
113 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
114 struct fsl_spi_platform_data *pdata;
115 bool pol = spi->mode & SPI_CS_HIGH;
116 struct spi_mpc8xxx_cs *cs = spi->controller_state;
117
118 pdata = spi->dev.parent->parent->platform_data;
119
120 if (value == BITBANG_CS_INACTIVE) {
121 if (pdata->cs_control)
122 pdata->cs_control(spi, !pol);
123 }
124
125 if (value == BITBANG_CS_ACTIVE) {
126 mpc8xxx_spi->rx_shift = cs->rx_shift;
127 mpc8xxx_spi->tx_shift = cs->tx_shift;
128 mpc8xxx_spi->get_rx = cs->get_rx;
129 mpc8xxx_spi->get_tx = cs->get_tx;
130
131 fsl_spi_change_mode(spi);
132
133 if (pdata->cs_control)
134 pdata->cs_control(spi, pol);
135 }
136}
137
138static void fsl_spi_qe_cpu_set_shifts(u32 *rx_shift, u32 *tx_shift,
139 int bits_per_word, int msb_first)
140{
141 *rx_shift = 0;
142 *tx_shift = 0;
143 if (msb_first) {
144 if (bits_per_word <= 8) {
145 *rx_shift = 16;
146 *tx_shift = 24;
147 } else if (bits_per_word <= 16) {
148 *rx_shift = 16;
149 *tx_shift = 16;
150 }
151 } else {
152 if (bits_per_word <= 8)
153 *rx_shift = 8;
154 }
155}
156
157static void fsl_spi_grlib_set_shifts(u32 *rx_shift, u32 *tx_shift,
158 int bits_per_word, int msb_first)
159{
160 *rx_shift = 0;
161 *tx_shift = 0;
162 if (bits_per_word <= 16) {
163 if (msb_first) {
164 *rx_shift = 16; /* LSB in bit 16 */
165 *tx_shift = 32 - bits_per_word; /* MSB in bit 31 */
166 } else {
167 *rx_shift = 16 - bits_per_word; /* MSB in bit 15 */
168 }
169 }
170}
171
172static int mspi_apply_cpu_mode_quirks(struct spi_mpc8xxx_cs *cs,
173 struct spi_device *spi,
174 struct mpc8xxx_spi *mpc8xxx_spi,
175 int bits_per_word)
176{
177 cs->rx_shift = 0;
178 cs->tx_shift = 0;
179 if (bits_per_word <= 8) {
180 cs->get_rx = mpc8xxx_spi_rx_buf_u8;
181 cs->get_tx = mpc8xxx_spi_tx_buf_u8;
182 } else if (bits_per_word <= 16) {
183 cs->get_rx = mpc8xxx_spi_rx_buf_u16;
184 cs->get_tx = mpc8xxx_spi_tx_buf_u16;
185 } else if (bits_per_word <= 32) {
186 cs->get_rx = mpc8xxx_spi_rx_buf_u32;
187 cs->get_tx = mpc8xxx_spi_tx_buf_u32;
188 } else
189 return -EINVAL;
190
191 if (mpc8xxx_spi->set_shifts)
192 mpc8xxx_spi->set_shifts(&cs->rx_shift, &cs->tx_shift,
193 bits_per_word,
194 !(spi->mode & SPI_LSB_FIRST));
195
196 mpc8xxx_spi->rx_shift = cs->rx_shift;
197 mpc8xxx_spi->tx_shift = cs->tx_shift;
198 mpc8xxx_spi->get_rx = cs->get_rx;
199 mpc8xxx_spi->get_tx = cs->get_tx;
200
201 return bits_per_word;
202}
203
204static int mspi_apply_qe_mode_quirks(struct spi_mpc8xxx_cs *cs,
205 struct spi_device *spi,
206 int bits_per_word)
207{
208 /* QE uses Little Endian for words > 8
209 * so transform all words > 8 into 8 bits
210 * Unfortnatly that doesn't work for LSB so
211 * reject these for now */
212 /* Note: 32 bits word, LSB works iff
213 * tfcr/rfcr is set to CPMFCR_GBL */
214 if (spi->mode & SPI_LSB_FIRST &&
215 bits_per_word > 8)
216 return -EINVAL;
217 if (bits_per_word > 8)
218 return 8; /* pretend its 8 bits */
219 return bits_per_word;
220}
221
222static int fsl_spi_setup_transfer(struct spi_device *spi,
223 struct spi_transfer *t)
224{
225 struct mpc8xxx_spi *mpc8xxx_spi;
226 int bits_per_word = 0;
227 u8 pm;
228 u32 hz = 0;
229 struct spi_mpc8xxx_cs *cs = spi->controller_state;
230
231 mpc8xxx_spi = spi_master_get_devdata(spi->master);
232
233 if (t) {
234 bits_per_word = t->bits_per_word;
235 hz = t->speed_hz;
236 }
237
238 /* spi_transfer level calls that work per-word */
239 if (!bits_per_word)
240 bits_per_word = spi->bits_per_word;
241
242 if (!hz)
243 hz = spi->max_speed_hz;
244
245 if (!(mpc8xxx_spi->flags & SPI_CPM_MODE))
246 bits_per_word = mspi_apply_cpu_mode_quirks(cs, spi,
247 mpc8xxx_spi,
248 bits_per_word);
249 else if (mpc8xxx_spi->flags & SPI_QE)
250 bits_per_word = mspi_apply_qe_mode_quirks(cs, spi,
251 bits_per_word);
252
253 if (bits_per_word < 0)
254 return bits_per_word;
255
256 if (bits_per_word == 32)
257 bits_per_word = 0;
258 else
259 bits_per_word = bits_per_word - 1;
260
261 /* mask out bits we are going to set */
262 cs->hw_mode &= ~(SPMODE_LEN(0xF) | SPMODE_DIV16
263 | SPMODE_PM(0xF));
264
265 cs->hw_mode |= SPMODE_LEN(bits_per_word);
266
267 if ((mpc8xxx_spi->spibrg / hz) > 64) {
268 cs->hw_mode |= SPMODE_DIV16;
269 pm = (mpc8xxx_spi->spibrg - 1) / (hz * 64) + 1;
270
271 WARN_ONCE(pm > 16, "%s: Requested speed is too low: %d Hz. "
272 "Will use %d Hz instead.\n", dev_name(&spi->dev),
273 hz, mpc8xxx_spi->spibrg / 1024);
274 if (pm > 16)
275 pm = 16;
276 } else {
277 pm = (mpc8xxx_spi->spibrg - 1) / (hz * 4) + 1;
278 }
279 if (pm)
280 pm--;
281
282 cs->hw_mode |= SPMODE_PM(pm);
283
284 fsl_spi_change_mode(spi);
285 return 0;
286}
287
288static int fsl_spi_cpu_bufs(struct mpc8xxx_spi *mspi,
289 struct spi_transfer *t, unsigned int len)
290{
291 u32 word;
292 struct fsl_spi_reg *reg_base = mspi->reg_base;
293
294 mspi->count = len;
295
296 /* enable rx ints */
297 mpc8xxx_spi_write_reg(®_base->mask, SPIM_NE);
298
299 /* transmit word */
300 word = mspi->get_tx(mspi);
301 mpc8xxx_spi_write_reg(®_base->transmit, word);
302
303 return 0;
304}
305
306static int fsl_spi_bufs(struct spi_device *spi, struct spi_transfer *t,
307 bool is_dma_mapped)
308{
309 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
310 struct fsl_spi_reg *reg_base;
311 unsigned int len = t->len;
312 u8 bits_per_word;
313 int ret;
314
315 reg_base = mpc8xxx_spi->reg_base;
316 bits_per_word = spi->bits_per_word;
317 if (t->bits_per_word)
318 bits_per_word = t->bits_per_word;
319
320 if (bits_per_word > 8) {
321 /* invalid length? */
322 if (len & 1)
323 return -EINVAL;
324 len /= 2;
325 }
326 if (bits_per_word > 16) {
327 /* invalid length? */
328 if (len & 1)
329 return -EINVAL;
330 len /= 2;
331 }
332
333 mpc8xxx_spi->tx = t->tx_buf;
334 mpc8xxx_spi->rx = t->rx_buf;
335
336 reinit_completion(&mpc8xxx_spi->done);
337
338 if (mpc8xxx_spi->flags & SPI_CPM_MODE)
339 ret = fsl_spi_cpm_bufs(mpc8xxx_spi, t, is_dma_mapped);
340 else
341 ret = fsl_spi_cpu_bufs(mpc8xxx_spi, t, len);
342 if (ret)
343 return ret;
344
345 wait_for_completion(&mpc8xxx_spi->done);
346
347 /* disable rx ints */
348 mpc8xxx_spi_write_reg(®_base->mask, 0);
349
350 if (mpc8xxx_spi->flags & SPI_CPM_MODE)
351 fsl_spi_cpm_bufs_complete(mpc8xxx_spi);
352
353 return mpc8xxx_spi->count;
354}
355
356static int fsl_spi_do_one_msg(struct spi_master *master,
357 struct spi_message *m)
358{
359 struct spi_device *spi = m->spi;
360 struct spi_transfer *t, *first;
361 unsigned int cs_change;
362 const int nsecs = 50;
363 int status;
364
365 /* Don't allow changes if CS is active */
366 first = list_first_entry(&m->transfers, struct spi_transfer,
367 transfer_list);
368 list_for_each_entry(t, &m->transfers, transfer_list) {
369 if ((first->bits_per_word != t->bits_per_word) ||
370 (first->speed_hz != t->speed_hz)) {
371 dev_err(&spi->dev,
372 "bits_per_word/speed_hz should be same for the same SPI transfer\n");
373 return -EINVAL;
374 }
375 }
376
377 cs_change = 1;
378 status = -EINVAL;
379 list_for_each_entry(t, &m->transfers, transfer_list) {
380 if (t->bits_per_word || t->speed_hz) {
381 if (cs_change)
382 status = fsl_spi_setup_transfer(spi, t);
383 if (status < 0)
384 break;
385 }
386
387 if (cs_change) {
388 fsl_spi_chipselect(spi, BITBANG_CS_ACTIVE);
389 ndelay(nsecs);
390 }
391 cs_change = t->cs_change;
392 if (t->len)
393 status = fsl_spi_bufs(spi, t, m->is_dma_mapped);
394 if (status) {
395 status = -EMSGSIZE;
396 break;
397 }
398 m->actual_length += t->len;
399
400 if (t->delay_usecs)
401 udelay(t->delay_usecs);
402
403 if (cs_change) {
404 ndelay(nsecs);
405 fsl_spi_chipselect(spi, BITBANG_CS_INACTIVE);
406 ndelay(nsecs);
407 }
408 }
409
410 m->status = status;
411 spi_finalize_current_message(master);
412
413 if (status || !cs_change) {
414 ndelay(nsecs);
415 fsl_spi_chipselect(spi, BITBANG_CS_INACTIVE);
416 }
417
418 fsl_spi_setup_transfer(spi, NULL);
419 return 0;
420}
421
422static int fsl_spi_setup(struct spi_device *spi)
423{
424 struct mpc8xxx_spi *mpc8xxx_spi;
425 struct fsl_spi_reg *reg_base;
426 int retval;
427 u32 hw_mode;
428 struct spi_mpc8xxx_cs *cs = spi_get_ctldata(spi);
429
430 if (!spi->max_speed_hz)
431 return -EINVAL;
432
433 if (!cs) {
434 cs = kzalloc(sizeof(*cs), GFP_KERNEL);
435 if (!cs)
436 return -ENOMEM;
437 spi_set_ctldata(spi, cs);
438 }
439 mpc8xxx_spi = spi_master_get_devdata(spi->master);
440
441 reg_base = mpc8xxx_spi->reg_base;
442
443 hw_mode = cs->hw_mode; /* Save original settings */
444 cs->hw_mode = mpc8xxx_spi_read_reg(®_base->mode);
445 /* mask out bits we are going to set */
446 cs->hw_mode &= ~(SPMODE_CP_BEGIN_EDGECLK | SPMODE_CI_INACTIVEHIGH
447 | SPMODE_REV | SPMODE_LOOP);
448
449 if (spi->mode & SPI_CPHA)
450 cs->hw_mode |= SPMODE_CP_BEGIN_EDGECLK;
451 if (spi->mode & SPI_CPOL)
452 cs->hw_mode |= SPMODE_CI_INACTIVEHIGH;
453 if (!(spi->mode & SPI_LSB_FIRST))
454 cs->hw_mode |= SPMODE_REV;
455 if (spi->mode & SPI_LOOP)
456 cs->hw_mode |= SPMODE_LOOP;
457
458 retval = fsl_spi_setup_transfer(spi, NULL);
459 if (retval < 0) {
460 cs->hw_mode = hw_mode; /* Restore settings */
461 return retval;
462 }
463
464 if (mpc8xxx_spi->type == TYPE_GRLIB) {
465 if (gpio_is_valid(spi->cs_gpio)) {
466 int desel;
467
468 retval = gpio_request(spi->cs_gpio,
469 dev_name(&spi->dev));
470 if (retval)
471 return retval;
472
473 desel = !(spi->mode & SPI_CS_HIGH);
474 retval = gpio_direction_output(spi->cs_gpio, desel);
475 if (retval) {
476 gpio_free(spi->cs_gpio);
477 return retval;
478 }
479 } else if (spi->cs_gpio != -ENOENT) {
480 if (spi->cs_gpio < 0)
481 return spi->cs_gpio;
482 return -EINVAL;
483 }
484 /* When spi->cs_gpio == -ENOENT, a hole in the phandle list
485 * indicates to use native chipselect if present, or allow for
486 * an always selected chip
487 */
488 }
489
490 /* Initialize chipselect - might be active for SPI_CS_HIGH mode */
491 fsl_spi_chipselect(spi, BITBANG_CS_INACTIVE);
492
493 return 0;
494}
495
496static void fsl_spi_cleanup(struct spi_device *spi)
497{
498 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
499 struct spi_mpc8xxx_cs *cs = spi_get_ctldata(spi);
500
501 if (mpc8xxx_spi->type == TYPE_GRLIB && gpio_is_valid(spi->cs_gpio))
502 gpio_free(spi->cs_gpio);
503
504 kfree(cs);
505 spi_set_ctldata(spi, NULL);
506}
507
508static void fsl_spi_cpu_irq(struct mpc8xxx_spi *mspi, u32 events)
509{
510 struct fsl_spi_reg *reg_base = mspi->reg_base;
511
512 /* We need handle RX first */
513 if (events & SPIE_NE) {
514 u32 rx_data = mpc8xxx_spi_read_reg(®_base->receive);
515
516 if (mspi->rx)
517 mspi->get_rx(rx_data, mspi);
518 }
519
520 if ((events & SPIE_NF) == 0)
521 /* spin until TX is done */
522 while (((events =
523 mpc8xxx_spi_read_reg(®_base->event)) &
524 SPIE_NF) == 0)
525 cpu_relax();
526
527 /* Clear the events */
528 mpc8xxx_spi_write_reg(®_base->event, events);
529
530 mspi->count -= 1;
531 if (mspi->count) {
532 u32 word = mspi->get_tx(mspi);
533
534 mpc8xxx_spi_write_reg(®_base->transmit, word);
535 } else {
536 complete(&mspi->done);
537 }
538}
539
540static irqreturn_t fsl_spi_irq(s32 irq, void *context_data)
541{
542 struct mpc8xxx_spi *mspi = context_data;
543 irqreturn_t ret = IRQ_NONE;
544 u32 events;
545 struct fsl_spi_reg *reg_base = mspi->reg_base;
546
547 /* Get interrupt events(tx/rx) */
548 events = mpc8xxx_spi_read_reg(®_base->event);
549 if (events)
550 ret = IRQ_HANDLED;
551
552 dev_dbg(mspi->dev, "%s: events %x\n", __func__, events);
553
554 if (mspi->flags & SPI_CPM_MODE)
555 fsl_spi_cpm_irq(mspi, events);
556 else
557 fsl_spi_cpu_irq(mspi, events);
558
559 return ret;
560}
561
562static void fsl_spi_grlib_cs_control(struct spi_device *spi, bool on)
563{
564 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
565 struct fsl_spi_reg *reg_base = mpc8xxx_spi->reg_base;
566 u32 slvsel;
567 u16 cs = spi->chip_select;
568
569 if (gpio_is_valid(spi->cs_gpio)) {
570 gpio_set_value(spi->cs_gpio, on);
571 } else if (cs < mpc8xxx_spi->native_chipselects) {
572 slvsel = mpc8xxx_spi_read_reg(®_base->slvsel);
573 slvsel = on ? (slvsel | (1 << cs)) : (slvsel & ~(1 << cs));
574 mpc8xxx_spi_write_reg(®_base->slvsel, slvsel);
575 }
576}
577
578static void fsl_spi_grlib_probe(struct device *dev)
579{
580 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
581 struct spi_master *master = dev_get_drvdata(dev);
582 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
583 struct fsl_spi_reg *reg_base = mpc8xxx_spi->reg_base;
584 int mbits;
585 u32 capabilities;
586
587 capabilities = mpc8xxx_spi_read_reg(®_base->cap);
588
589 mpc8xxx_spi->set_shifts = fsl_spi_grlib_set_shifts;
590 mbits = SPCAP_MAXWLEN(capabilities);
591 if (mbits)
592 mpc8xxx_spi->max_bits_per_word = mbits + 1;
593
594 mpc8xxx_spi->native_chipselects = 0;
595 if (SPCAP_SSEN(capabilities)) {
596 mpc8xxx_spi->native_chipselects = SPCAP_SSSZ(capabilities);
597 mpc8xxx_spi_write_reg(®_base->slvsel, 0xffffffff);
598 }
599 master->num_chipselect = mpc8xxx_spi->native_chipselects;
600 pdata->cs_control = fsl_spi_grlib_cs_control;
601}
602
603static struct spi_master * fsl_spi_probe(struct device *dev,
604 struct resource *mem, unsigned int irq)
605{
606 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
607 struct spi_master *master;
608 struct mpc8xxx_spi *mpc8xxx_spi;
609 struct fsl_spi_reg *reg_base;
610 u32 regval;
611 int ret = 0;
612
613 master = spi_alloc_master(dev, sizeof(struct mpc8xxx_spi));
614 if (master == NULL) {
615 ret = -ENOMEM;
616 goto err;
617 }
618
619 dev_set_drvdata(dev, master);
620
621 mpc8xxx_spi_probe(dev, mem, irq);
622
623 master->setup = fsl_spi_setup;
624 master->cleanup = fsl_spi_cleanup;
625 master->transfer_one_message = fsl_spi_do_one_msg;
626
627 mpc8xxx_spi = spi_master_get_devdata(master);
628 mpc8xxx_spi->max_bits_per_word = 32;
629 mpc8xxx_spi->type = fsl_spi_get_type(dev);
630
631 ret = fsl_spi_cpm_init(mpc8xxx_spi);
632 if (ret)
633 goto err_cpm_init;
634
635 mpc8xxx_spi->reg_base = devm_ioremap_resource(dev, mem);
636 if (IS_ERR(mpc8xxx_spi->reg_base)) {
637 ret = PTR_ERR(mpc8xxx_spi->reg_base);
638 goto err_probe;
639 }
640
641 if (mpc8xxx_spi->type == TYPE_GRLIB)
642 fsl_spi_grlib_probe(dev);
643
644 master->bits_per_word_mask =
645 (SPI_BPW_RANGE_MASK(4, 16) | SPI_BPW_MASK(32)) &
646 SPI_BPW_RANGE_MASK(1, mpc8xxx_spi->max_bits_per_word);
647
648 if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE)
649 mpc8xxx_spi->set_shifts = fsl_spi_qe_cpu_set_shifts;
650
651 if (mpc8xxx_spi->set_shifts)
652 /* 8 bits per word and MSB first */
653 mpc8xxx_spi->set_shifts(&mpc8xxx_spi->rx_shift,
654 &mpc8xxx_spi->tx_shift, 8, 1);
655
656 /* Register for SPI Interrupt */
657 ret = devm_request_irq(dev, mpc8xxx_spi->irq, fsl_spi_irq,
658 0, "fsl_spi", mpc8xxx_spi);
659
660 if (ret != 0)
661 goto err_probe;
662
663 reg_base = mpc8xxx_spi->reg_base;
664
665 /* SPI controller initializations */
666 mpc8xxx_spi_write_reg(®_base->mode, 0);
667 mpc8xxx_spi_write_reg(®_base->mask, 0);
668 mpc8xxx_spi_write_reg(®_base->command, 0);
669 mpc8xxx_spi_write_reg(®_base->event, 0xffffffff);
670
671 /* Enable SPI interface */
672 regval = pdata->initial_spmode | SPMODE_INIT_VAL | SPMODE_ENABLE;
673 if (mpc8xxx_spi->max_bits_per_word < 8) {
674 regval &= ~SPMODE_LEN(0xF);
675 regval |= SPMODE_LEN(mpc8xxx_spi->max_bits_per_word - 1);
676 }
677 if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE)
678 regval |= SPMODE_OP;
679
680 mpc8xxx_spi_write_reg(®_base->mode, regval);
681
682 ret = devm_spi_register_master(dev, master);
683 if (ret < 0)
684 goto err_probe;
685
686 dev_info(dev, "at 0x%p (irq = %d), %s mode\n", reg_base,
687 mpc8xxx_spi->irq, mpc8xxx_spi_strmode(mpc8xxx_spi->flags));
688
689 return master;
690
691err_probe:
692 fsl_spi_cpm_free(mpc8xxx_spi);
693err_cpm_init:
694 spi_master_put(master);
695err:
696 return ERR_PTR(ret);
697}
698
699static void fsl_spi_cs_control(struct spi_device *spi, bool on)
700{
701 struct device *dev = spi->dev.parent->parent;
702 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
703 struct mpc8xxx_spi_probe_info *pinfo = to_of_pinfo(pdata);
704 u16 cs = spi->chip_select;
705 int gpio = pinfo->gpios[cs];
706 bool alow = pinfo->alow_flags[cs];
707
708 gpio_set_value(gpio, on ^ alow);
709}
710
711static int of_fsl_spi_get_chipselects(struct device *dev)
712{
713 struct device_node *np = dev->of_node;
714 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
715 struct mpc8xxx_spi_probe_info *pinfo = to_of_pinfo(pdata);
716 int ngpios;
717 int i = 0;
718 int ret;
719
720 ngpios = of_gpio_count(np);
721 if (ngpios <= 0) {
722 /*
723 * SPI w/o chip-select line. One SPI device is still permitted
724 * though.
725 */
726 pdata->max_chipselect = 1;
727 return 0;
728 }
729
730 pinfo->gpios = kmalloc(ngpios * sizeof(*pinfo->gpios), GFP_KERNEL);
731 if (!pinfo->gpios)
732 return -ENOMEM;
733 memset(pinfo->gpios, -1, ngpios * sizeof(*pinfo->gpios));
734
735 pinfo->alow_flags = kzalloc(ngpios * sizeof(*pinfo->alow_flags),
736 GFP_KERNEL);
737 if (!pinfo->alow_flags) {
738 ret = -ENOMEM;
739 goto err_alloc_flags;
740 }
741
742 for (; i < ngpios; i++) {
743 int gpio;
744 enum of_gpio_flags flags;
745
746 gpio = of_get_gpio_flags(np, i, &flags);
747 if (!gpio_is_valid(gpio)) {
748 dev_err(dev, "invalid gpio #%d: %d\n", i, gpio);
749 ret = gpio;
750 goto err_loop;
751 }
752
753 ret = gpio_request(gpio, dev_name(dev));
754 if (ret) {
755 dev_err(dev, "can't request gpio #%d: %d\n", i, ret);
756 goto err_loop;
757 }
758
759 pinfo->gpios[i] = gpio;
760 pinfo->alow_flags[i] = flags & OF_GPIO_ACTIVE_LOW;
761
762 ret = gpio_direction_output(pinfo->gpios[i],
763 pinfo->alow_flags[i]);
764 if (ret) {
765 dev_err(dev, "can't set output direction for gpio "
766 "#%d: %d\n", i, ret);
767 goto err_loop;
768 }
769 }
770
771 pdata->max_chipselect = ngpios;
772 pdata->cs_control = fsl_spi_cs_control;
773
774 return 0;
775
776err_loop:
777 while (i >= 0) {
778 if (gpio_is_valid(pinfo->gpios[i]))
779 gpio_free(pinfo->gpios[i]);
780 i--;
781 }
782
783 kfree(pinfo->alow_flags);
784 pinfo->alow_flags = NULL;
785err_alloc_flags:
786 kfree(pinfo->gpios);
787 pinfo->gpios = NULL;
788 return ret;
789}
790
791static int of_fsl_spi_free_chipselects(struct device *dev)
792{
793 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
794 struct mpc8xxx_spi_probe_info *pinfo = to_of_pinfo(pdata);
795 int i;
796
797 if (!pinfo->gpios)
798 return 0;
799
800 for (i = 0; i < pdata->max_chipselect; i++) {
801 if (gpio_is_valid(pinfo->gpios[i]))
802 gpio_free(pinfo->gpios[i]);
803 }
804
805 kfree(pinfo->gpios);
806 kfree(pinfo->alow_flags);
807 return 0;
808}
809
810static int of_fsl_spi_probe(struct platform_device *ofdev)
811{
812 struct device *dev = &ofdev->dev;
813 struct device_node *np = ofdev->dev.of_node;
814 struct spi_master *master;
815 struct resource mem;
816 int irq, type;
817 int ret = -ENOMEM;
818
819 ret = of_mpc8xxx_spi_probe(ofdev);
820 if (ret)
821 return ret;
822
823 type = fsl_spi_get_type(&ofdev->dev);
824 if (type == TYPE_FSL) {
825 ret = of_fsl_spi_get_chipselects(dev);
826 if (ret)
827 goto err;
828 }
829
830 ret = of_address_to_resource(np, 0, &mem);
831 if (ret)
832 goto err;
833
834 irq = irq_of_parse_and_map(np, 0);
835 if (!irq) {
836 ret = -EINVAL;
837 goto err;
838 }
839
840 master = fsl_spi_probe(dev, &mem, irq);
841 if (IS_ERR(master)) {
842 ret = PTR_ERR(master);
843 goto err;
844 }
845
846 return 0;
847
848err:
849 if (type == TYPE_FSL)
850 of_fsl_spi_free_chipselects(dev);
851 return ret;
852}
853
854static int of_fsl_spi_remove(struct platform_device *ofdev)
855{
856 struct spi_master *master = platform_get_drvdata(ofdev);
857 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
858
859 fsl_spi_cpm_free(mpc8xxx_spi);
860 if (mpc8xxx_spi->type == TYPE_FSL)
861 of_fsl_spi_free_chipselects(&ofdev->dev);
862 return 0;
863}
864
865static struct platform_driver of_fsl_spi_driver = {
866 .driver = {
867 .name = "fsl_spi",
868 .of_match_table = of_fsl_spi_match,
869 },
870 .probe = of_fsl_spi_probe,
871 .remove = of_fsl_spi_remove,
872};
873
874#ifdef CONFIG_MPC832x_RDB
875/*
876 * XXX XXX XXX
877 * This is "legacy" platform driver, was used by the MPC8323E-RDB boards
878 * only. The driver should go away soon, since newer MPC8323E-RDB's device
879 * tree can work with OpenFirmware driver. But for now we support old trees
880 * as well.
881 */
882static int plat_mpc8xxx_spi_probe(struct platform_device *pdev)
883{
884 struct resource *mem;
885 int irq;
886 struct spi_master *master;
887
888 if (!dev_get_platdata(&pdev->dev))
889 return -EINVAL;
890
891 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
892 if (!mem)
893 return -EINVAL;
894
895 irq = platform_get_irq(pdev, 0);
896 if (irq <= 0)
897 return -EINVAL;
898
899 master = fsl_spi_probe(&pdev->dev, mem, irq);
900 return PTR_ERR_OR_ZERO(master);
901}
902
903static int plat_mpc8xxx_spi_remove(struct platform_device *pdev)
904{
905 struct spi_master *master = platform_get_drvdata(pdev);
906 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
907
908 fsl_spi_cpm_free(mpc8xxx_spi);
909
910 return 0;
911}
912
913MODULE_ALIAS("platform:mpc8xxx_spi");
914static struct platform_driver mpc8xxx_spi_driver = {
915 .probe = plat_mpc8xxx_spi_probe,
916 .remove = plat_mpc8xxx_spi_remove,
917 .driver = {
918 .name = "mpc8xxx_spi",
919 },
920};
921
922static bool legacy_driver_failed;
923
924static void __init legacy_driver_register(void)
925{
926 legacy_driver_failed = platform_driver_register(&mpc8xxx_spi_driver);
927}
928
929static void __exit legacy_driver_unregister(void)
930{
931 if (legacy_driver_failed)
932 return;
933 platform_driver_unregister(&mpc8xxx_spi_driver);
934}
935#else
936static void __init legacy_driver_register(void) {}
937static void __exit legacy_driver_unregister(void) {}
938#endif /* CONFIG_MPC832x_RDB */
939
940static int __init fsl_spi_init(void)
941{
942 legacy_driver_register();
943 return platform_driver_register(&of_fsl_spi_driver);
944}
945module_init(fsl_spi_init);
946
947static void __exit fsl_spi_exit(void)
948{
949 platform_driver_unregister(&of_fsl_spi_driver);
950 legacy_driver_unregister();
951}
952module_exit(fsl_spi_exit);
953
954MODULE_AUTHOR("Kumar Gala");
955MODULE_DESCRIPTION("Simple Freescale SPI Driver");
956MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Freescale SPI controller driver.
4 *
5 * Maintainer: Kumar Gala
6 *
7 * Copyright (C) 2006 Polycom, Inc.
8 * Copyright 2010 Freescale Semiconductor, Inc.
9 *
10 * CPM SPI and QE buffer descriptors mode support:
11 * Copyright (c) 2009 MontaVista Software, Inc.
12 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
13 *
14 * GRLIB support:
15 * Copyright (c) 2012 Aeroflex Gaisler AB.
16 * Author: Andreas Larsson <andreas@gaisler.com>
17 */
18#include <linux/delay.h>
19#include <linux/dma-mapping.h>
20#include <linux/fsl_devices.h>
21#include <linux/gpio/consumer.h>
22#include <linux/interrupt.h>
23#include <linux/irq.h>
24#include <linux/kernel.h>
25#include <linux/mm.h>
26#include <linux/module.h>
27#include <linux/mutex.h>
28#include <linux/of.h>
29#include <linux/of_address.h>
30#include <linux/of_irq.h>
31#include <linux/of_platform.h>
32#include <linux/platform_device.h>
33#include <linux/spi/spi.h>
34#include <linux/spi/spi_bitbang.h>
35#include <linux/types.h>
36
37#ifdef CONFIG_FSL_SOC
38#include <sysdev/fsl_soc.h>
39#endif
40
41/* Specific to the MPC8306/MPC8309 */
42#define IMMR_SPI_CS_OFFSET 0x14c
43#define SPI_BOOT_SEL_BIT 0x80000000
44
45#include "spi-fsl-lib.h"
46#include "spi-fsl-cpm.h"
47#include "spi-fsl-spi.h"
48
49#define TYPE_FSL 0
50#define TYPE_GRLIB 1
51
52struct fsl_spi_match_data {
53 int type;
54};
55
56static struct fsl_spi_match_data of_fsl_spi_fsl_config = {
57 .type = TYPE_FSL,
58};
59
60static struct fsl_spi_match_data of_fsl_spi_grlib_config = {
61 .type = TYPE_GRLIB,
62};
63
64static const struct of_device_id of_fsl_spi_match[] = {
65 {
66 .compatible = "fsl,spi",
67 .data = &of_fsl_spi_fsl_config,
68 },
69 {
70 .compatible = "aeroflexgaisler,spictrl",
71 .data = &of_fsl_spi_grlib_config,
72 },
73 {}
74};
75MODULE_DEVICE_TABLE(of, of_fsl_spi_match);
76
77static int fsl_spi_get_type(struct device *dev)
78{
79 const struct of_device_id *match;
80
81 if (dev->of_node) {
82 match = of_match_node(of_fsl_spi_match, dev->of_node);
83 if (match && match->data)
84 return ((struct fsl_spi_match_data *)match->data)->type;
85 }
86 return TYPE_FSL;
87}
88
89static void fsl_spi_change_mode(struct spi_device *spi)
90{
91 struct mpc8xxx_spi *mspi = spi_master_get_devdata(spi->master);
92 struct spi_mpc8xxx_cs *cs = spi->controller_state;
93 struct fsl_spi_reg __iomem *reg_base = mspi->reg_base;
94 __be32 __iomem *mode = ®_base->mode;
95 unsigned long flags;
96
97 if (cs->hw_mode == mpc8xxx_spi_read_reg(mode))
98 return;
99
100 /* Turn off IRQs locally to minimize time that SPI is disabled. */
101 local_irq_save(flags);
102
103 /* Turn off SPI unit prior changing mode */
104 mpc8xxx_spi_write_reg(mode, cs->hw_mode & ~SPMODE_ENABLE);
105
106 /* When in CPM mode, we need to reinit tx and rx. */
107 if (mspi->flags & SPI_CPM_MODE) {
108 fsl_spi_cpm_reinit_txrx(mspi);
109 }
110 mpc8xxx_spi_write_reg(mode, cs->hw_mode);
111 local_irq_restore(flags);
112}
113
114static void fsl_spi_qe_cpu_set_shifts(u32 *rx_shift, u32 *tx_shift,
115 int bits_per_word, int msb_first)
116{
117 *rx_shift = 0;
118 *tx_shift = 0;
119 if (msb_first) {
120 if (bits_per_word <= 8) {
121 *rx_shift = 16;
122 *tx_shift = 24;
123 } else if (bits_per_word <= 16) {
124 *rx_shift = 16;
125 *tx_shift = 16;
126 }
127 } else {
128 if (bits_per_word <= 8)
129 *rx_shift = 8;
130 }
131}
132
133static void fsl_spi_grlib_set_shifts(u32 *rx_shift, u32 *tx_shift,
134 int bits_per_word, int msb_first)
135{
136 *rx_shift = 0;
137 *tx_shift = 0;
138 if (bits_per_word <= 16) {
139 if (msb_first) {
140 *rx_shift = 16; /* LSB in bit 16 */
141 *tx_shift = 32 - bits_per_word; /* MSB in bit 31 */
142 } else {
143 *rx_shift = 16 - bits_per_word; /* MSB in bit 15 */
144 }
145 }
146}
147
148static int mspi_apply_cpu_mode_quirks(struct spi_mpc8xxx_cs *cs,
149 struct spi_device *spi,
150 struct mpc8xxx_spi *mpc8xxx_spi,
151 int bits_per_word)
152{
153 cs->rx_shift = 0;
154 cs->tx_shift = 0;
155 if (bits_per_word <= 8) {
156 cs->get_rx = mpc8xxx_spi_rx_buf_u8;
157 cs->get_tx = mpc8xxx_spi_tx_buf_u8;
158 } else if (bits_per_word <= 16) {
159 cs->get_rx = mpc8xxx_spi_rx_buf_u16;
160 cs->get_tx = mpc8xxx_spi_tx_buf_u16;
161 } else if (bits_per_word <= 32) {
162 cs->get_rx = mpc8xxx_spi_rx_buf_u32;
163 cs->get_tx = mpc8xxx_spi_tx_buf_u32;
164 } else
165 return -EINVAL;
166
167 if (mpc8xxx_spi->set_shifts)
168 mpc8xxx_spi->set_shifts(&cs->rx_shift, &cs->tx_shift,
169 bits_per_word,
170 !(spi->mode & SPI_LSB_FIRST));
171
172 mpc8xxx_spi->rx_shift = cs->rx_shift;
173 mpc8xxx_spi->tx_shift = cs->tx_shift;
174 mpc8xxx_spi->get_rx = cs->get_rx;
175 mpc8xxx_spi->get_tx = cs->get_tx;
176
177 return bits_per_word;
178}
179
180static int mspi_apply_qe_mode_quirks(struct spi_mpc8xxx_cs *cs,
181 struct spi_device *spi,
182 int bits_per_word)
183{
184 /* QE uses Little Endian for words > 8
185 * so transform all words > 8 into 8 bits
186 * Unfortnatly that doesn't work for LSB so
187 * reject these for now */
188 /* Note: 32 bits word, LSB works iff
189 * tfcr/rfcr is set to CPMFCR_GBL */
190 if (spi->mode & SPI_LSB_FIRST &&
191 bits_per_word > 8)
192 return -EINVAL;
193 if (bits_per_word > 8)
194 return 8; /* pretend its 8 bits */
195 return bits_per_word;
196}
197
198static int fsl_spi_setup_transfer(struct spi_device *spi,
199 struct spi_transfer *t)
200{
201 struct mpc8xxx_spi *mpc8xxx_spi;
202 int bits_per_word = 0;
203 u8 pm;
204 u32 hz = 0;
205 struct spi_mpc8xxx_cs *cs = spi->controller_state;
206
207 mpc8xxx_spi = spi_master_get_devdata(spi->master);
208
209 if (t) {
210 bits_per_word = t->bits_per_word;
211 hz = t->speed_hz;
212 }
213
214 /* spi_transfer level calls that work per-word */
215 if (!bits_per_word)
216 bits_per_word = spi->bits_per_word;
217
218 if (!hz)
219 hz = spi->max_speed_hz;
220
221 if (!(mpc8xxx_spi->flags & SPI_CPM_MODE))
222 bits_per_word = mspi_apply_cpu_mode_quirks(cs, spi,
223 mpc8xxx_spi,
224 bits_per_word);
225 else if (mpc8xxx_spi->flags & SPI_QE)
226 bits_per_word = mspi_apply_qe_mode_quirks(cs, spi,
227 bits_per_word);
228
229 if (bits_per_word < 0)
230 return bits_per_word;
231
232 if (bits_per_word == 32)
233 bits_per_word = 0;
234 else
235 bits_per_word = bits_per_word - 1;
236
237 /* mask out bits we are going to set */
238 cs->hw_mode &= ~(SPMODE_LEN(0xF) | SPMODE_DIV16
239 | SPMODE_PM(0xF));
240
241 cs->hw_mode |= SPMODE_LEN(bits_per_word);
242
243 if ((mpc8xxx_spi->spibrg / hz) > 64) {
244 cs->hw_mode |= SPMODE_DIV16;
245 pm = (mpc8xxx_spi->spibrg - 1) / (hz * 64) + 1;
246 WARN_ONCE(pm > 16,
247 "%s: Requested speed is too low: %d Hz. Will use %d Hz instead.\n",
248 dev_name(&spi->dev), hz, mpc8xxx_spi->spibrg / 1024);
249 if (pm > 16)
250 pm = 16;
251 } else {
252 pm = (mpc8xxx_spi->spibrg - 1) / (hz * 4) + 1;
253 }
254 if (pm)
255 pm--;
256
257 cs->hw_mode |= SPMODE_PM(pm);
258
259 fsl_spi_change_mode(spi);
260 return 0;
261}
262
263static int fsl_spi_cpu_bufs(struct mpc8xxx_spi *mspi,
264 struct spi_transfer *t, unsigned int len)
265{
266 u32 word;
267 struct fsl_spi_reg __iomem *reg_base = mspi->reg_base;
268
269 mspi->count = len;
270
271 /* enable rx ints */
272 mpc8xxx_spi_write_reg(®_base->mask, SPIM_NE);
273
274 /* transmit word */
275 word = mspi->get_tx(mspi);
276 mpc8xxx_spi_write_reg(®_base->transmit, word);
277
278 return 0;
279}
280
281static int fsl_spi_bufs(struct spi_device *spi, struct spi_transfer *t,
282 bool is_dma_mapped)
283{
284 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
285 struct fsl_spi_reg __iomem *reg_base;
286 unsigned int len = t->len;
287 u8 bits_per_word;
288 int ret;
289
290 reg_base = mpc8xxx_spi->reg_base;
291 bits_per_word = spi->bits_per_word;
292 if (t->bits_per_word)
293 bits_per_word = t->bits_per_word;
294
295 if (bits_per_word > 8) {
296 /* invalid length? */
297 if (len & 1)
298 return -EINVAL;
299 len /= 2;
300 }
301 if (bits_per_word > 16) {
302 /* invalid length? */
303 if (len & 1)
304 return -EINVAL;
305 len /= 2;
306 }
307
308 mpc8xxx_spi->tx = t->tx_buf;
309 mpc8xxx_spi->rx = t->rx_buf;
310
311 reinit_completion(&mpc8xxx_spi->done);
312
313 if (mpc8xxx_spi->flags & SPI_CPM_MODE)
314 ret = fsl_spi_cpm_bufs(mpc8xxx_spi, t, is_dma_mapped);
315 else
316 ret = fsl_spi_cpu_bufs(mpc8xxx_spi, t, len);
317 if (ret)
318 return ret;
319
320 wait_for_completion(&mpc8xxx_spi->done);
321
322 /* disable rx ints */
323 mpc8xxx_spi_write_reg(®_base->mask, 0);
324
325 if (mpc8xxx_spi->flags & SPI_CPM_MODE)
326 fsl_spi_cpm_bufs_complete(mpc8xxx_spi);
327
328 return mpc8xxx_spi->count;
329}
330
331static int fsl_spi_prepare_message(struct spi_controller *ctlr,
332 struct spi_message *m)
333{
334 struct mpc8xxx_spi *mpc8xxx_spi = spi_controller_get_devdata(ctlr);
335 struct spi_transfer *t;
336 struct spi_transfer *first;
337
338 first = list_first_entry(&m->transfers, struct spi_transfer,
339 transfer_list);
340
341 /*
342 * In CPU mode, optimize large byte transfers to use larger
343 * bits_per_word values to reduce number of interrupts taken.
344 *
345 * Some glitches can appear on the SPI clock when the mode changes.
346 * Check that there is no speed change during the transfer and set it up
347 * now to change the mode without having a chip-select asserted.
348 */
349 list_for_each_entry(t, &m->transfers, transfer_list) {
350 if (t->speed_hz != first->speed_hz) {
351 dev_err(&m->spi->dev,
352 "speed_hz cannot change during message.\n");
353 return -EINVAL;
354 }
355 if (!(mpc8xxx_spi->flags & SPI_CPM_MODE)) {
356 if (t->len < 256 || t->bits_per_word != 8)
357 continue;
358 if ((t->len & 3) == 0)
359 t->bits_per_word = 32;
360 else if ((t->len & 1) == 0)
361 t->bits_per_word = 16;
362 }
363 }
364 return fsl_spi_setup_transfer(m->spi, first);
365}
366
367static int fsl_spi_transfer_one(struct spi_controller *controller,
368 struct spi_device *spi,
369 struct spi_transfer *t)
370{
371 int status;
372
373 status = fsl_spi_setup_transfer(spi, t);
374 if (status < 0)
375 return status;
376 if (t->len)
377 status = fsl_spi_bufs(spi, t, !!t->tx_dma || !!t->rx_dma);
378 if (status > 0)
379 return -EMSGSIZE;
380
381 return status;
382}
383
384static int fsl_spi_unprepare_message(struct spi_controller *controller,
385 struct spi_message *msg)
386{
387 return fsl_spi_setup_transfer(msg->spi, NULL);
388}
389
390static int fsl_spi_setup(struct spi_device *spi)
391{
392 struct mpc8xxx_spi *mpc8xxx_spi;
393 struct fsl_spi_reg __iomem *reg_base;
394 bool initial_setup = false;
395 int retval;
396 u32 hw_mode;
397 struct spi_mpc8xxx_cs *cs = spi_get_ctldata(spi);
398
399 if (!spi->max_speed_hz)
400 return -EINVAL;
401
402 if (!cs) {
403 cs = kzalloc(sizeof(*cs), GFP_KERNEL);
404 if (!cs)
405 return -ENOMEM;
406 spi_set_ctldata(spi, cs);
407 initial_setup = true;
408 }
409 mpc8xxx_spi = spi_master_get_devdata(spi->master);
410
411 reg_base = mpc8xxx_spi->reg_base;
412
413 hw_mode = cs->hw_mode; /* Save original settings */
414 cs->hw_mode = mpc8xxx_spi_read_reg(®_base->mode);
415 /* mask out bits we are going to set */
416 cs->hw_mode &= ~(SPMODE_CP_BEGIN_EDGECLK | SPMODE_CI_INACTIVEHIGH
417 | SPMODE_REV | SPMODE_LOOP);
418
419 if (spi->mode & SPI_CPHA)
420 cs->hw_mode |= SPMODE_CP_BEGIN_EDGECLK;
421 if (spi->mode & SPI_CPOL)
422 cs->hw_mode |= SPMODE_CI_INACTIVEHIGH;
423 if (!(spi->mode & SPI_LSB_FIRST))
424 cs->hw_mode |= SPMODE_REV;
425 if (spi->mode & SPI_LOOP)
426 cs->hw_mode |= SPMODE_LOOP;
427
428 retval = fsl_spi_setup_transfer(spi, NULL);
429 if (retval < 0) {
430 cs->hw_mode = hw_mode; /* Restore settings */
431 if (initial_setup)
432 kfree(cs);
433 return retval;
434 }
435
436 return 0;
437}
438
439static void fsl_spi_cleanup(struct spi_device *spi)
440{
441 struct spi_mpc8xxx_cs *cs = spi_get_ctldata(spi);
442
443 kfree(cs);
444 spi_set_ctldata(spi, NULL);
445}
446
447static void fsl_spi_cpu_irq(struct mpc8xxx_spi *mspi, u32 events)
448{
449 struct fsl_spi_reg __iomem *reg_base = mspi->reg_base;
450
451 /* We need handle RX first */
452 if (events & SPIE_NE) {
453 u32 rx_data = mpc8xxx_spi_read_reg(®_base->receive);
454
455 if (mspi->rx)
456 mspi->get_rx(rx_data, mspi);
457 }
458
459 if ((events & SPIE_NF) == 0)
460 /* spin until TX is done */
461 while (((events =
462 mpc8xxx_spi_read_reg(®_base->event)) &
463 SPIE_NF) == 0)
464 cpu_relax();
465
466 /* Clear the events */
467 mpc8xxx_spi_write_reg(®_base->event, events);
468
469 mspi->count -= 1;
470 if (mspi->count) {
471 u32 word = mspi->get_tx(mspi);
472
473 mpc8xxx_spi_write_reg(®_base->transmit, word);
474 } else {
475 complete(&mspi->done);
476 }
477}
478
479static irqreturn_t fsl_spi_irq(s32 irq, void *context_data)
480{
481 struct mpc8xxx_spi *mspi = context_data;
482 irqreturn_t ret = IRQ_NONE;
483 u32 events;
484 struct fsl_spi_reg __iomem *reg_base = mspi->reg_base;
485
486 /* Get interrupt events(tx/rx) */
487 events = mpc8xxx_spi_read_reg(®_base->event);
488 if (events)
489 ret = IRQ_HANDLED;
490
491 dev_dbg(mspi->dev, "%s: events %x\n", __func__, events);
492
493 if (mspi->flags & SPI_CPM_MODE)
494 fsl_spi_cpm_irq(mspi, events);
495 else
496 fsl_spi_cpu_irq(mspi, events);
497
498 return ret;
499}
500
501static void fsl_spi_grlib_cs_control(struct spi_device *spi, bool on)
502{
503 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
504 struct fsl_spi_reg __iomem *reg_base = mpc8xxx_spi->reg_base;
505 u32 slvsel;
506 u16 cs = spi->chip_select;
507
508 if (cs < mpc8xxx_spi->native_chipselects) {
509 slvsel = mpc8xxx_spi_read_reg(®_base->slvsel);
510 slvsel = on ? (slvsel | (1 << cs)) : (slvsel & ~(1 << cs));
511 mpc8xxx_spi_write_reg(®_base->slvsel, slvsel);
512 }
513}
514
515static void fsl_spi_grlib_probe(struct device *dev)
516{
517 struct spi_master *master = dev_get_drvdata(dev);
518 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
519 struct fsl_spi_reg __iomem *reg_base = mpc8xxx_spi->reg_base;
520 int mbits;
521 u32 capabilities;
522
523 capabilities = mpc8xxx_spi_read_reg(®_base->cap);
524
525 mpc8xxx_spi->set_shifts = fsl_spi_grlib_set_shifts;
526 mbits = SPCAP_MAXWLEN(capabilities);
527 if (mbits)
528 mpc8xxx_spi->max_bits_per_word = mbits + 1;
529
530 mpc8xxx_spi->native_chipselects = 0;
531 if (SPCAP_SSEN(capabilities)) {
532 mpc8xxx_spi->native_chipselects = SPCAP_SSSZ(capabilities);
533 mpc8xxx_spi_write_reg(®_base->slvsel, 0xffffffff);
534 }
535 master->num_chipselect = mpc8xxx_spi->native_chipselects;
536 master->set_cs = fsl_spi_grlib_cs_control;
537}
538
539static void fsl_spi_cs_control(struct spi_device *spi, bool on)
540{
541 struct device *dev = spi->dev.parent->parent;
542 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
543 struct mpc8xxx_spi_probe_info *pinfo = to_of_pinfo(pdata);
544
545 if (WARN_ON_ONCE(!pinfo->immr_spi_cs))
546 return;
547 iowrite32be(on ? 0 : SPI_BOOT_SEL_BIT, pinfo->immr_spi_cs);
548}
549
550static struct spi_master *fsl_spi_probe(struct device *dev,
551 struct resource *mem, unsigned int irq)
552{
553 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
554 struct spi_master *master;
555 struct mpc8xxx_spi *mpc8xxx_spi;
556 struct fsl_spi_reg __iomem *reg_base;
557 u32 regval;
558 int ret = 0;
559
560 master = spi_alloc_master(dev, sizeof(struct mpc8xxx_spi));
561 if (master == NULL) {
562 ret = -ENOMEM;
563 goto err;
564 }
565
566 dev_set_drvdata(dev, master);
567
568 mpc8xxx_spi_probe(dev, mem, irq);
569
570 master->setup = fsl_spi_setup;
571 master->cleanup = fsl_spi_cleanup;
572 master->prepare_message = fsl_spi_prepare_message;
573 master->transfer_one = fsl_spi_transfer_one;
574 master->unprepare_message = fsl_spi_unprepare_message;
575 master->use_gpio_descriptors = true;
576 master->set_cs = fsl_spi_cs_control;
577
578 mpc8xxx_spi = spi_master_get_devdata(master);
579 mpc8xxx_spi->max_bits_per_word = 32;
580 mpc8xxx_spi->type = fsl_spi_get_type(dev);
581
582 ret = fsl_spi_cpm_init(mpc8xxx_spi);
583 if (ret)
584 goto err_cpm_init;
585
586 mpc8xxx_spi->reg_base = devm_ioremap_resource(dev, mem);
587 if (IS_ERR(mpc8xxx_spi->reg_base)) {
588 ret = PTR_ERR(mpc8xxx_spi->reg_base);
589 goto err_probe;
590 }
591
592 if (mpc8xxx_spi->type == TYPE_GRLIB)
593 fsl_spi_grlib_probe(dev);
594
595 master->bits_per_word_mask =
596 (SPI_BPW_RANGE_MASK(4, 16) | SPI_BPW_MASK(32)) &
597 SPI_BPW_RANGE_MASK(1, mpc8xxx_spi->max_bits_per_word);
598
599 if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE)
600 mpc8xxx_spi->set_shifts = fsl_spi_qe_cpu_set_shifts;
601
602 if (mpc8xxx_spi->set_shifts)
603 /* 8 bits per word and MSB first */
604 mpc8xxx_spi->set_shifts(&mpc8xxx_spi->rx_shift,
605 &mpc8xxx_spi->tx_shift, 8, 1);
606
607 /* Register for SPI Interrupt */
608 ret = devm_request_irq(dev, mpc8xxx_spi->irq, fsl_spi_irq,
609 0, "fsl_spi", mpc8xxx_spi);
610
611 if (ret != 0)
612 goto err_probe;
613
614 reg_base = mpc8xxx_spi->reg_base;
615
616 /* SPI controller initializations */
617 mpc8xxx_spi_write_reg(®_base->mode, 0);
618 mpc8xxx_spi_write_reg(®_base->mask, 0);
619 mpc8xxx_spi_write_reg(®_base->command, 0);
620 mpc8xxx_spi_write_reg(®_base->event, 0xffffffff);
621
622 /* Enable SPI interface */
623 regval = pdata->initial_spmode | SPMODE_INIT_VAL | SPMODE_ENABLE;
624 if (mpc8xxx_spi->max_bits_per_word < 8) {
625 regval &= ~SPMODE_LEN(0xF);
626 regval |= SPMODE_LEN(mpc8xxx_spi->max_bits_per_word - 1);
627 }
628 if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE)
629 regval |= SPMODE_OP;
630
631 mpc8xxx_spi_write_reg(®_base->mode, regval);
632
633 ret = devm_spi_register_master(dev, master);
634 if (ret < 0)
635 goto err_probe;
636
637 dev_info(dev, "at 0x%p (irq = %d), %s mode\n", reg_base,
638 mpc8xxx_spi->irq, mpc8xxx_spi_strmode(mpc8xxx_spi->flags));
639
640 return master;
641
642err_probe:
643 fsl_spi_cpm_free(mpc8xxx_spi);
644err_cpm_init:
645 spi_master_put(master);
646err:
647 return ERR_PTR(ret);
648}
649
650static int of_fsl_spi_probe(struct platform_device *ofdev)
651{
652 struct device *dev = &ofdev->dev;
653 struct device_node *np = ofdev->dev.of_node;
654 struct spi_master *master;
655 struct resource mem;
656 int irq, type;
657 int ret;
658 bool spisel_boot = false;
659#if IS_ENABLED(CONFIG_FSL_SOC)
660 struct mpc8xxx_spi_probe_info *pinfo = NULL;
661#endif
662
663
664 ret = of_mpc8xxx_spi_probe(ofdev);
665 if (ret)
666 return ret;
667
668 type = fsl_spi_get_type(&ofdev->dev);
669 if (type == TYPE_FSL) {
670 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
671#if IS_ENABLED(CONFIG_FSL_SOC)
672 pinfo = to_of_pinfo(pdata);
673
674 spisel_boot = of_property_read_bool(np, "fsl,spisel_boot");
675 if (spisel_boot) {
676 pinfo->immr_spi_cs = ioremap(get_immrbase() + IMMR_SPI_CS_OFFSET, 4);
677 if (!pinfo->immr_spi_cs)
678 return -ENOMEM;
679 }
680#endif
681 /*
682 * Handle the case where we have one hardwired (always selected)
683 * device on the first "chipselect". Else we let the core code
684 * handle any GPIOs or native chip selects and assign the
685 * appropriate callback for dealing with the CS lines. This isn't
686 * supported on the GRLIB variant.
687 */
688 ret = gpiod_count(dev, "cs");
689 if (ret < 0)
690 ret = 0;
691 if (ret == 0 && !spisel_boot)
692 pdata->max_chipselect = 1;
693 else
694 pdata->max_chipselect = ret + spisel_boot;
695 }
696
697 ret = of_address_to_resource(np, 0, &mem);
698 if (ret)
699 goto unmap_out;
700
701 irq = platform_get_irq(ofdev, 0);
702 if (irq < 0) {
703 ret = irq;
704 goto unmap_out;
705 }
706
707 master = fsl_spi_probe(dev, &mem, irq);
708
709 return PTR_ERR_OR_ZERO(master);
710
711unmap_out:
712#if IS_ENABLED(CONFIG_FSL_SOC)
713 if (spisel_boot)
714 iounmap(pinfo->immr_spi_cs);
715#endif
716 return ret;
717}
718
719static int of_fsl_spi_remove(struct platform_device *ofdev)
720{
721 struct spi_master *master = platform_get_drvdata(ofdev);
722 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
723
724 fsl_spi_cpm_free(mpc8xxx_spi);
725 return 0;
726}
727
728static struct platform_driver of_fsl_spi_driver = {
729 .driver = {
730 .name = "fsl_spi",
731 .of_match_table = of_fsl_spi_match,
732 },
733 .probe = of_fsl_spi_probe,
734 .remove = of_fsl_spi_remove,
735};
736
737#ifdef CONFIG_MPC832x_RDB
738/*
739 * XXX XXX XXX
740 * This is "legacy" platform driver, was used by the MPC8323E-RDB boards
741 * only. The driver should go away soon, since newer MPC8323E-RDB's device
742 * tree can work with OpenFirmware driver. But for now we support old trees
743 * as well.
744 */
745static int plat_mpc8xxx_spi_probe(struct platform_device *pdev)
746{
747 struct resource *mem;
748 int irq;
749 struct spi_master *master;
750
751 if (!dev_get_platdata(&pdev->dev))
752 return -EINVAL;
753
754 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
755 if (!mem)
756 return -EINVAL;
757
758 irq = platform_get_irq(pdev, 0);
759 if (irq <= 0)
760 return -EINVAL;
761
762 master = fsl_spi_probe(&pdev->dev, mem, irq);
763 return PTR_ERR_OR_ZERO(master);
764}
765
766static int plat_mpc8xxx_spi_remove(struct platform_device *pdev)
767{
768 struct spi_master *master = platform_get_drvdata(pdev);
769 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
770
771 fsl_spi_cpm_free(mpc8xxx_spi);
772
773 return 0;
774}
775
776MODULE_ALIAS("platform:mpc8xxx_spi");
777static struct platform_driver mpc8xxx_spi_driver = {
778 .probe = plat_mpc8xxx_spi_probe,
779 .remove = plat_mpc8xxx_spi_remove,
780 .driver = {
781 .name = "mpc8xxx_spi",
782 },
783};
784
785static bool legacy_driver_failed;
786
787static void __init legacy_driver_register(void)
788{
789 legacy_driver_failed = platform_driver_register(&mpc8xxx_spi_driver);
790}
791
792static void __exit legacy_driver_unregister(void)
793{
794 if (legacy_driver_failed)
795 return;
796 platform_driver_unregister(&mpc8xxx_spi_driver);
797}
798#else
799static void __init legacy_driver_register(void) {}
800static void __exit legacy_driver_unregister(void) {}
801#endif /* CONFIG_MPC832x_RDB */
802
803static int __init fsl_spi_init(void)
804{
805 legacy_driver_register();
806 return platform_driver_register(&of_fsl_spi_driver);
807}
808module_init(fsl_spi_init);
809
810static void __exit fsl_spi_exit(void)
811{
812 platform_driver_unregister(&of_fsl_spi_driver);
813 legacy_driver_unregister();
814}
815module_exit(fsl_spi_exit);
816
817MODULE_AUTHOR("Kumar Gala");
818MODULE_DESCRIPTION("Simple Freescale SPI Driver");
819MODULE_LICENSE("GPL");