1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * MPC512x PSC in SPI mode driver.
5 * Copyright (C) 2007,2008 Freescale Semiconductor Inc.
6 * Original port from 52xx driver:
7 * Hongjun Chen <hong-jun.chen@freescale.com>
9 * Fork of mpc52xx_psc_spi.c:
10 * Copyright (C) 2006 TOPTICA Photonics AG., Dragos Carp
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/interrupt.h>
17 #include <linux/of_address.h>
18 #include <linux/of_irq.h>
19 #include <linux/of_platform.h>
20 #include <linux/completion.h>
22 #include <linux/delay.h>
23 #include <linux/clk.h>
24 #include <linux/spi/spi.h>
25 #include <linux/fsl_devices.h>
26 #include <linux/gpio.h>
27 #include <asm/mpc52xx_psc.h>
35 * This macro abstracts the differences in the PSC register layout between
36 * MPC5121 (which uses a struct mpc52xx_psc) and MPC5125 (using mpc5125_psc).
38 #define psc_addr(mps, regname) ({ \
40 switch (mps->type) { \
41 case TYPE_MPC5121: { \
42 struct mpc52xx_psc __iomem *psc = mps->psc; \
43 __ret = &psc->regname; \
46 case TYPE_MPC5125: { \
47 struct mpc5125_psc __iomem *psc = mps->psc; \
48 __ret = &psc->regname; \
54 struct mpc512x_psc_spi
{
55 void (*cs_control
)(struct spi_device
*spi
, bool on
);
57 /* driver internal data */
60 struct mpc512x_psc_fifo __iomem
*fifo
;
67 struct completion txisrdone
;
70 /* controller state */
71 struct mpc512x_psc_spi_cs
{
76 /* set clock freq, clock ramp, bits per work
77 * if t is NULL then reset the values to the default values
79 static int mpc512x_psc_spi_transfer_setup(struct spi_device
*spi
,
80 struct spi_transfer
*t
)
82 struct mpc512x_psc_spi_cs
*cs
= spi
->controller_state
;
84 cs
->speed_hz
= (t
&& t
->speed_hz
)
85 ? t
->speed_hz
: spi
->max_speed_hz
;
86 cs
->bits_per_word
= (t
&& t
->bits_per_word
)
87 ? t
->bits_per_word
: spi
->bits_per_word
;
88 cs
->bits_per_word
= ((cs
->bits_per_word
+ 7) / 8) * 8;
92 static void mpc512x_psc_spi_activate_cs(struct spi_device
*spi
)
94 struct mpc512x_psc_spi_cs
*cs
= spi
->controller_state
;
95 struct mpc512x_psc_spi
*mps
= spi_master_get_devdata(spi
->master
);
101 sicr
= in_be32(psc_addr(mps
, sicr
));
103 /* Set clock phase and polarity */
104 if (spi
->mode
& SPI_CPHA
)
109 if (spi
->mode
& SPI_CPOL
)
114 if (spi
->mode
& SPI_LSB_FIRST
)
118 out_be32(psc_addr(mps
, sicr
), sicr
);
120 ccr
= in_be32(psc_addr(mps
, ccr
));
122 speed
= cs
->speed_hz
;
124 speed
= 1000000; /* default 1MHz */
125 bclkdiv
= (mps
->mclk_rate
/ speed
) - 1;
127 ccr
|= (((bclkdiv
& 0xff) << 16) | (((bclkdiv
>> 8) & 0xff) << 8));
128 out_be32(psc_addr(mps
, ccr
), ccr
);
129 mps
->bits_per_word
= cs
->bits_per_word
;
131 if (mps
->cs_control
&& gpio_is_valid(spi
->cs_gpio
))
132 mps
->cs_control(spi
, (spi
->mode
& SPI_CS_HIGH
) ? 1 : 0);
135 static void mpc512x_psc_spi_deactivate_cs(struct spi_device
*spi
)
137 struct mpc512x_psc_spi
*mps
= spi_master_get_devdata(spi
->master
);
139 if (mps
->cs_control
&& gpio_is_valid(spi
->cs_gpio
))
140 mps
->cs_control(spi
, (spi
->mode
& SPI_CS_HIGH
) ? 0 : 1);
144 /* extract and scale size field in txsz or rxsz */
145 #define MPC512x_PSC_FIFO_SZ(sz) ((sz & 0x7ff) << 2);
149 static int mpc512x_psc_spi_transfer_rxtx(struct spi_device
*spi
,
150 struct spi_transfer
*t
)
152 struct mpc512x_psc_spi
*mps
= spi_master_get_devdata(spi
->master
);
153 struct mpc512x_psc_fifo __iomem
*fifo
= mps
->fifo
;
154 size_t tx_len
= t
->len
;
155 size_t rx_len
= t
->len
;
156 u8
*tx_buf
= (u8
*)t
->tx_buf
;
157 u8
*rx_buf
= (u8
*)t
->rx_buf
;
159 if (!tx_buf
&& !rx_buf
&& t
->len
)
162 while (rx_len
|| tx_len
) {
170 * send the TX bytes in as large a chunk as possible
171 * but neither exceed the TX nor the RX FIFOs
173 fifosz
= MPC512x_PSC_FIFO_SZ(in_be32(&fifo
->txsz
));
174 txcount
= min(fifosz
, tx_len
);
175 fifosz
= MPC512x_PSC_FIFO_SZ(in_be32(&fifo
->rxsz
));
176 fifosz
-= in_be32(&fifo
->rxcnt
) + 1;
177 txcount
= min(fifosz
, txcount
);
180 /* fill the TX FIFO */
181 while (txcount
-- > 0) {
182 data
= tx_buf
? *tx_buf
++ : 0;
183 if (tx_len
== EOFBYTE
&& t
->cs_change
)
184 setbits32(&fifo
->txcmd
,
185 MPC512x_PSC_FIFO_EOF
);
186 out_8(&fifo
->txdata_8
, data
);
190 /* have the ISR trigger when the TX FIFO is empty */
191 reinit_completion(&mps
->txisrdone
);
192 out_be32(&fifo
->txisr
, MPC512x_PSC_FIFO_EMPTY
);
193 out_be32(&fifo
->tximr
, MPC512x_PSC_FIFO_EMPTY
);
194 wait_for_completion(&mps
->txisrdone
);
198 * consume as much RX data as the FIFO holds, while we
199 * iterate over the transfer's TX data length
201 * only insist in draining all the remaining RX bytes
202 * when the TX bytes were exhausted (that's at the very
203 * end of this transfer, not when still iterating over
204 * the transfer's chunks)
210 * grab whatever was in the FIFO when we started
211 * looking, don't bother fetching what was added to
212 * the FIFO while we read from it -- we'll return
213 * here eventually and prefer sending out remaining
216 fifosz
= in_be32(&fifo
->rxcnt
);
217 rxcount
= min(fifosz
, rx_len
);
218 while (rxcount
-- > 0) {
219 data
= in_8(&fifo
->rxdata_8
);
226 * come back later if there still is TX data to send,
227 * bail out of the RX drain loop if all of the TX data
228 * was sent and all of the RX data was received (i.e.
229 * when the transmission has completed)
237 * TX data transmission has completed while RX data
238 * is still pending -- that's a transient situation
239 * which depends on wire speed and specific
240 * hardware implementation details (buffering) yet
241 * should resolve very quickly
243 * just yield for a moment to not hog the CPU for
244 * too long when running SPI at low speed
246 * the timeout range is rather arbitrary and tries
247 * to balance throughput against system load; the
248 * chosen values result in a minimal timeout of 50
249 * times 10us and thus work at speeds as low as
250 * some 20kbps, while the maximum timeout at the
251 * transfer's end could be 5ms _if_ nothing else
252 * ticks in the system _and_ RX data still wasn't
253 * received, which only occurs in situations that
254 * are exceptional; removing the unpredictability
255 * of the timeout either decreases throughput
256 * (longer timeouts), or puts more load on the
257 * system (fixed short timeouts) or requires the
258 * use of a timeout API instead of a counter and an
259 * unknown inner delay
261 usleep_range(10, 100);
263 } while (--rxtries
> 0);
264 if (!tx_len
&& rx_len
&& !rxtries
) {
266 * not enough RX bytes even after several retries
267 * and the resulting rather long timeout?
269 rxcount
= in_be32(&fifo
->rxcnt
);
271 "short xfer, missing %zd RX bytes, FIFO level %zd\n",
276 * drain and drop RX data which "should not be there" in
277 * the first place, for undisturbed transmission this turns
278 * into a NOP (except for the FIFO level fetch)
280 if (!tx_len
&& !rx_len
) {
281 while (in_be32(&fifo
->rxcnt
))
282 in_8(&fifo
->rxdata_8
);
289 static int mpc512x_psc_spi_msg_xfer(struct spi_master
*master
,
290 struct spi_message
*m
)
292 struct spi_device
*spi
;
295 struct spi_transfer
*t
;
300 list_for_each_entry(t
, &m
->transfers
, transfer_list
) {
301 status
= mpc512x_psc_spi_transfer_setup(spi
, t
);
306 mpc512x_psc_spi_activate_cs(spi
);
307 cs_change
= t
->cs_change
;
309 status
= mpc512x_psc_spi_transfer_rxtx(spi
, t
);
312 m
->actual_length
+= t
->len
;
315 udelay(t
->delay_usecs
);
318 mpc512x_psc_spi_deactivate_cs(spi
);
323 m
->complete(m
->context
);
325 if (status
|| !cs_change
)
326 mpc512x_psc_spi_deactivate_cs(spi
);
328 mpc512x_psc_spi_transfer_setup(spi
, NULL
);
330 spi_finalize_current_message(master
);
334 static int mpc512x_psc_spi_prep_xfer_hw(struct spi_master
*master
)
336 struct mpc512x_psc_spi
*mps
= spi_master_get_devdata(master
);
338 dev_dbg(&master
->dev
, "%s()\n", __func__
);
341 in_8(psc_addr(mps
, mr2
));
342 out_8(psc_addr(mps
, mr2
), 0x0);
344 /* enable transmitter/receiver */
345 out_8(psc_addr(mps
, command
), MPC52xx_PSC_TX_ENABLE
| MPC52xx_PSC_RX_ENABLE
);
350 static int mpc512x_psc_spi_unprep_xfer_hw(struct spi_master
*master
)
352 struct mpc512x_psc_spi
*mps
= spi_master_get_devdata(master
);
353 struct mpc512x_psc_fifo __iomem
*fifo
= mps
->fifo
;
355 dev_dbg(&master
->dev
, "%s()\n", __func__
);
357 /* disable transmitter/receiver and fifo interrupt */
358 out_8(psc_addr(mps
, command
), MPC52xx_PSC_TX_DISABLE
| MPC52xx_PSC_RX_DISABLE
);
359 out_be32(&fifo
->tximr
, 0);
364 static int mpc512x_psc_spi_setup(struct spi_device
*spi
)
366 struct mpc512x_psc_spi_cs
*cs
= spi
->controller_state
;
369 if (spi
->bits_per_word
% 8)
373 cs
= kzalloc(sizeof *cs
, GFP_KERNEL
);
377 if (gpio_is_valid(spi
->cs_gpio
)) {
378 ret
= gpio_request(spi
->cs_gpio
, dev_name(&spi
->dev
));
380 dev_err(&spi
->dev
, "can't get CS gpio: %d\n",
385 gpio_direction_output(spi
->cs_gpio
,
386 spi
->mode
& SPI_CS_HIGH
? 0 : 1);
389 spi
->controller_state
= cs
;
392 cs
->bits_per_word
= spi
->bits_per_word
;
393 cs
->speed_hz
= spi
->max_speed_hz
;
398 static void mpc512x_psc_spi_cleanup(struct spi_device
*spi
)
400 if (gpio_is_valid(spi
->cs_gpio
))
401 gpio_free(spi
->cs_gpio
);
402 kfree(spi
->controller_state
);
405 static int mpc512x_psc_spi_port_config(struct spi_master
*master
,
406 struct mpc512x_psc_spi
*mps
)
408 struct mpc512x_psc_fifo __iomem
*fifo
= mps
->fifo
;
414 /* Reset the PSC into a known state */
415 out_8(psc_addr(mps
, command
), MPC52xx_PSC_RST_RX
);
416 out_8(psc_addr(mps
, command
), MPC52xx_PSC_RST_TX
);
417 out_8(psc_addr(mps
, command
), MPC52xx_PSC_TX_DISABLE
| MPC52xx_PSC_RX_DISABLE
);
419 /* Disable psc interrupts all useful interrupts are in fifo */
420 out_be16(psc_addr(mps
, isr_imr
.imr
), 0);
422 /* Disable fifo interrupts, will be enabled later */
423 out_be32(&fifo
->tximr
, 0);
424 out_be32(&fifo
->rximr
, 0);
426 /* Setup fifo slice address and size */
427 /*out_be32(&fifo->txsz, 0x0fe00004);*/
428 /*out_be32(&fifo->rxsz, 0x0ff00004);*/
430 sicr
= 0x01000000 | /* SIM = 0001 -- 8 bit */
431 0x00800000 | /* GenClk = 1 -- internal clk */
432 0x00008000 | /* SPI = 1 */
433 0x00004000 | /* MSTR = 1 -- SPI master */
434 0x00000800; /* UseEOF = 1 -- SS low until EOF */
436 out_be32(psc_addr(mps
, sicr
), sicr
);
438 ccr
= in_be32(psc_addr(mps
, ccr
));
440 speed
= 1000000; /* default 1MHz */
441 bclkdiv
= (mps
->mclk_rate
/ speed
) - 1;
442 ccr
|= (((bclkdiv
& 0xff) << 16) | (((bclkdiv
>> 8) & 0xff) << 8));
443 out_be32(psc_addr(mps
, ccr
), ccr
);
445 /* Set 2ms DTL delay */
446 out_8(psc_addr(mps
, ctur
), 0x00);
447 out_8(psc_addr(mps
, ctlr
), 0x82);
449 /* we don't use the alarms */
450 out_be32(&fifo
->rxalarm
, 0xfff);
451 out_be32(&fifo
->txalarm
, 0);
453 /* Enable FIFO slices for Rx/Tx */
454 out_be32(&fifo
->rxcmd
,
455 MPC512x_PSC_FIFO_ENABLE_SLICE
| MPC512x_PSC_FIFO_ENABLE_DMA
);
456 out_be32(&fifo
->txcmd
,
457 MPC512x_PSC_FIFO_ENABLE_SLICE
| MPC512x_PSC_FIFO_ENABLE_DMA
);
459 mps
->bits_per_word
= 8;
464 static irqreturn_t
mpc512x_psc_spi_isr(int irq
, void *dev_id
)
466 struct mpc512x_psc_spi
*mps
= (struct mpc512x_psc_spi
*)dev_id
;
467 struct mpc512x_psc_fifo __iomem
*fifo
= mps
->fifo
;
469 /* clear interrupt and wake up the rx/tx routine */
470 if (in_be32(&fifo
->txisr
) &
471 in_be32(&fifo
->tximr
) & MPC512x_PSC_FIFO_EMPTY
) {
472 out_be32(&fifo
->txisr
, MPC512x_PSC_FIFO_EMPTY
);
473 out_be32(&fifo
->tximr
, 0);
474 complete(&mps
->txisrdone
);
480 static void mpc512x_spi_cs_control(struct spi_device
*spi
, bool onoff
)
482 gpio_set_value(spi
->cs_gpio
, onoff
);
485 static int mpc512x_psc_spi_do_probe(struct device
*dev
, u32 regaddr
,
486 u32 size
, unsigned int irq
)
488 struct fsl_spi_platform_data
*pdata
= dev_get_platdata(dev
);
489 struct mpc512x_psc_spi
*mps
;
490 struct spi_master
*master
;
495 master
= spi_alloc_master(dev
, sizeof *mps
);
499 dev_set_drvdata(dev
, master
);
500 mps
= spi_master_get_devdata(master
);
501 mps
->type
= (int)of_device_get_match_data(dev
);
505 mps
->cs_control
= mpc512x_spi_cs_control
;
507 mps
->cs_control
= pdata
->cs_control
;
508 master
->bus_num
= pdata
->bus_num
;
509 master
->num_chipselect
= pdata
->max_chipselect
;
512 master
->mode_bits
= SPI_CPOL
| SPI_CPHA
| SPI_CS_HIGH
| SPI_LSB_FIRST
;
513 master
->setup
= mpc512x_psc_spi_setup
;
514 master
->prepare_transfer_hardware
= mpc512x_psc_spi_prep_xfer_hw
;
515 master
->transfer_one_message
= mpc512x_psc_spi_msg_xfer
;
516 master
->unprepare_transfer_hardware
= mpc512x_psc_spi_unprep_xfer_hw
;
517 master
->cleanup
= mpc512x_psc_spi_cleanup
;
518 master
->dev
.of_node
= dev
->of_node
;
520 tempp
= devm_ioremap(dev
, regaddr
, size
);
522 dev_err(dev
, "could not ioremap I/O port range\n");
528 (struct mpc512x_psc_fifo
*)(tempp
+ sizeof(struct mpc52xx_psc
));
529 ret
= devm_request_irq(dev
, mps
->irq
, mpc512x_psc_spi_isr
, IRQF_SHARED
,
530 "mpc512x-psc-spi", mps
);
533 init_completion(&mps
->txisrdone
);
535 clk
= devm_clk_get(dev
, "mclk");
540 ret
= clk_prepare_enable(clk
);
544 mps
->mclk_rate
= clk_get_rate(clk
);
546 clk
= devm_clk_get(dev
, "ipg");
549 goto free_mclk_clock
;
551 ret
= clk_prepare_enable(clk
);
553 goto free_mclk_clock
;
556 ret
= mpc512x_psc_spi_port_config(master
, mps
);
560 ret
= devm_spi_register_master(dev
, master
);
567 clk_disable_unprepare(mps
->clk_ipg
);
569 clk_disable_unprepare(mps
->clk_mclk
);
571 spi_master_put(master
);
576 static int mpc512x_psc_spi_do_remove(struct device
*dev
)
578 struct spi_master
*master
= dev_get_drvdata(dev
);
579 struct mpc512x_psc_spi
*mps
= spi_master_get_devdata(master
);
581 clk_disable_unprepare(mps
->clk_mclk
);
582 clk_disable_unprepare(mps
->clk_ipg
);
587 static int mpc512x_psc_spi_of_probe(struct platform_device
*op
)
589 const u32
*regaddr_p
;
590 u64 regaddr64
, size64
;
592 regaddr_p
= of_get_address(op
->dev
.of_node
, 0, &size64
, NULL
);
594 dev_err(&op
->dev
, "Invalid PSC address\n");
597 regaddr64
= of_translate_address(op
->dev
.of_node
, regaddr_p
);
599 return mpc512x_psc_spi_do_probe(&op
->dev
, (u32
) regaddr64
, (u32
) size64
,
600 irq_of_parse_and_map(op
->dev
.of_node
, 0));
603 static int mpc512x_psc_spi_of_remove(struct platform_device
*op
)
605 return mpc512x_psc_spi_do_remove(&op
->dev
);
608 static const struct of_device_id mpc512x_psc_spi_of_match
[] = {
609 { .compatible
= "fsl,mpc5121-psc-spi", .data
= (void *)TYPE_MPC5121
},
610 { .compatible
= "fsl,mpc5125-psc-spi", .data
= (void *)TYPE_MPC5125
},
614 MODULE_DEVICE_TABLE(of
, mpc512x_psc_spi_of_match
);
616 static struct platform_driver mpc512x_psc_spi_of_driver
= {
617 .probe
= mpc512x_psc_spi_of_probe
,
618 .remove
= mpc512x_psc_spi_of_remove
,
620 .name
= "mpc512x-psc-spi",
621 .of_match_table
= mpc512x_psc_spi_of_match
,
624 module_platform_driver(mpc512x_psc_spi_of_driver
);
626 MODULE_AUTHOR("John Rigby");
627 MODULE_DESCRIPTION("MPC512x PSC SPI Driver");
628 MODULE_LICENSE("GPL");