Linux Audio

Check our new training course

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