xref: /openbmc/linux/drivers/spi/spi-fsl-lib.c (revision fd4a319b) 
1ca632f55SGrant Likely /*
2ca632f55SGrant Likely  * Freescale SPI/eSPI controller driver library.
3ca632f55SGrant Likely  *
4ca632f55SGrant Likely  * Maintainer: Kumar Gala
5ca632f55SGrant Likely  *
6ca632f55SGrant Likely  * Copyright (C) 2006 Polycom, Inc.
7ca632f55SGrant Likely  *
8ca632f55SGrant Likely  * CPM SPI and QE buffer descriptors mode support:
9ca632f55SGrant Likely  * Copyright (c) 2009  MontaVista Software, Inc.
10ca632f55SGrant Likely  * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
11ca632f55SGrant Likely  *
12ca632f55SGrant Likely  * Copyright 2010 Freescale Semiconductor, Inc.
13ca632f55SGrant Likely  *
14ca632f55SGrant Likely  * This program is free software; you can redistribute  it and/or modify it
15ca632f55SGrant Likely  * under  the terms of  the GNU General  Public License as published by the
16ca632f55SGrant Likely  * Free Software Foundation;  either version 2 of the  License, or (at your
17ca632f55SGrant Likely  * option) any later version.
18ca632f55SGrant Likely  */
19ca632f55SGrant Likely #include <linux/kernel.h>
20ca632f55SGrant Likely #include <linux/interrupt.h>
21ca632f55SGrant Likely #include <linux/fsl_devices.h>
22ca632f55SGrant Likely #include <linux/dma-mapping.h>
23ca632f55SGrant Likely #include <linux/mm.h>
24ca632f55SGrant Likely #include <linux/of_platform.h>
25d57a4282SGrant Likely #include <linux/spi/spi.h>
26ca632f55SGrant Likely #include <sysdev/fsl_soc.h>
27ca632f55SGrant Likely 
28ca632f55SGrant Likely #include "spi-fsl-lib.h"
29ca632f55SGrant Likely 
30ca632f55SGrant Likely #define MPC8XXX_SPI_RX_BUF(type) 					  \
31ca632f55SGrant Likely void mpc8xxx_spi_rx_buf_##type(u32 data, struct mpc8xxx_spi *mpc8xxx_spi) \
32ca632f55SGrant Likely {									  \
33ca632f55SGrant Likely 	type *rx = mpc8xxx_spi->rx;					  \
34ca632f55SGrant Likely 	*rx++ = (type)(data >> mpc8xxx_spi->rx_shift);			  \
35ca632f55SGrant Likely 	mpc8xxx_spi->rx = rx;						  \
36ca632f55SGrant Likely }
37ca632f55SGrant Likely 
38ca632f55SGrant Likely #define MPC8XXX_SPI_TX_BUF(type)				\
39ca632f55SGrant Likely u32 mpc8xxx_spi_tx_buf_##type(struct mpc8xxx_spi *mpc8xxx_spi)	\
40ca632f55SGrant Likely {								\
41ca632f55SGrant Likely 	u32 data;						\
42ca632f55SGrant Likely 	const type *tx = mpc8xxx_spi->tx;			\
43ca632f55SGrant Likely 	if (!tx)						\
44ca632f55SGrant Likely 		return 0;					\
45ca632f55SGrant Likely 	data = *tx++ << mpc8xxx_spi->tx_shift;			\
46ca632f55SGrant Likely 	mpc8xxx_spi->tx = tx;					\
47ca632f55SGrant Likely 	return data;						\
48ca632f55SGrant Likely }
49ca632f55SGrant Likely 
50ca632f55SGrant Likely MPC8XXX_SPI_RX_BUF(u8)
51ca632f55SGrant Likely MPC8XXX_SPI_RX_BUF(u16)
52ca632f55SGrant Likely MPC8XXX_SPI_RX_BUF(u32)
53ca632f55SGrant Likely MPC8XXX_SPI_TX_BUF(u8)
54ca632f55SGrant Likely MPC8XXX_SPI_TX_BUF(u16)
55ca632f55SGrant Likely MPC8XXX_SPI_TX_BUF(u32)
56ca632f55SGrant Likely 
57ca632f55SGrant Likely struct mpc8xxx_spi_probe_info *to_of_pinfo(struct fsl_spi_platform_data *pdata)
58ca632f55SGrant Likely {
59ca632f55SGrant Likely 	return container_of(pdata, struct mpc8xxx_spi_probe_info, pdata);
60ca632f55SGrant Likely }
61ca632f55SGrant Likely 
62ca632f55SGrant Likely void mpc8xxx_spi_work(struct work_struct *work)
63ca632f55SGrant Likely {
64ca632f55SGrant Likely 	struct mpc8xxx_spi *mpc8xxx_spi = container_of(work, struct mpc8xxx_spi,
65ca632f55SGrant Likely 						       work);
66ca632f55SGrant Likely 
67ca632f55SGrant Likely 	spin_lock_irq(&mpc8xxx_spi->lock);
68ca632f55SGrant Likely 	while (!list_empty(&mpc8xxx_spi->queue)) {
69ca632f55SGrant Likely 		struct spi_message *m = container_of(mpc8xxx_spi->queue.next,
70ca632f55SGrant Likely 						   struct spi_message, queue);
71ca632f55SGrant Likely 
72ca632f55SGrant Likely 		list_del_init(&m->queue);
73ca632f55SGrant Likely 		spin_unlock_irq(&mpc8xxx_spi->lock);
74ca632f55SGrant Likely 
75ca632f55SGrant Likely 		if (mpc8xxx_spi->spi_do_one_msg)
76ca632f55SGrant Likely 			mpc8xxx_spi->spi_do_one_msg(m);
77ca632f55SGrant Likely 
78ca632f55SGrant Likely 		spin_lock_irq(&mpc8xxx_spi->lock);
79ca632f55SGrant Likely 	}
80ca632f55SGrant Likely 	spin_unlock_irq(&mpc8xxx_spi->lock);
81ca632f55SGrant Likely }
82ca632f55SGrant Likely 
83ca632f55SGrant Likely int mpc8xxx_spi_transfer(struct spi_device *spi,
84ca632f55SGrant Likely 				struct spi_message *m)
85ca632f55SGrant Likely {
86ca632f55SGrant Likely 	struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
87ca632f55SGrant Likely 	unsigned long flags;
88ca632f55SGrant Likely 
89ca632f55SGrant Likely 	m->actual_length = 0;
90ca632f55SGrant Likely 	m->status = -EINPROGRESS;
91ca632f55SGrant Likely 
92ca632f55SGrant Likely 	spin_lock_irqsave(&mpc8xxx_spi->lock, flags);
93ca632f55SGrant Likely 	list_add_tail(&m->queue, &mpc8xxx_spi->queue);
94ca632f55SGrant Likely 	queue_work(mpc8xxx_spi->workqueue, &mpc8xxx_spi->work);
95ca632f55SGrant Likely 	spin_unlock_irqrestore(&mpc8xxx_spi->lock, flags);
96ca632f55SGrant Likely 
97ca632f55SGrant Likely 	return 0;
98ca632f55SGrant Likely }
99ca632f55SGrant Likely 
100ca632f55SGrant Likely void mpc8xxx_spi_cleanup(struct spi_device *spi)
101ca632f55SGrant Likely {
102ca632f55SGrant Likely 	kfree(spi->controller_state);
103ca632f55SGrant Likely }
104ca632f55SGrant Likely 
105ca632f55SGrant Likely const char *mpc8xxx_spi_strmode(unsigned int flags)
106ca632f55SGrant Likely {
107ca632f55SGrant Likely 	if (flags & SPI_QE_CPU_MODE) {
108ca632f55SGrant Likely 		return "QE CPU";
109ca632f55SGrant Likely 	} else if (flags & SPI_CPM_MODE) {
110ca632f55SGrant Likely 		if (flags & SPI_QE)
111ca632f55SGrant Likely 			return "QE";
112ca632f55SGrant Likely 		else if (flags & SPI_CPM2)
113ca632f55SGrant Likely 			return "CPM2";
114ca632f55SGrant Likely 		else
115ca632f55SGrant Likely 			return "CPM1";
116ca632f55SGrant Likely 	}
117ca632f55SGrant Likely 	return "CPU";
118ca632f55SGrant Likely }
119ca632f55SGrant Likely 
120ca632f55SGrant Likely int mpc8xxx_spi_probe(struct device *dev, struct resource *mem,
121ca632f55SGrant Likely 			unsigned int irq)
122ca632f55SGrant Likely {
123ca632f55SGrant Likely 	struct fsl_spi_platform_data *pdata = dev->platform_data;
124ca632f55SGrant Likely 	struct spi_master *master;
125ca632f55SGrant Likely 	struct mpc8xxx_spi *mpc8xxx_spi;
126ca632f55SGrant Likely 	int ret = 0;
127ca632f55SGrant Likely 
128ca632f55SGrant Likely 	master = dev_get_drvdata(dev);
129ca632f55SGrant Likely 
130ca632f55SGrant Likely 	/* the spi->mode bits understood by this driver: */
131ca632f55SGrant Likely 	master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH
132ca632f55SGrant Likely 			| SPI_LSB_FIRST | SPI_LOOP;
133ca632f55SGrant Likely 
134ca632f55SGrant Likely 	master->transfer = mpc8xxx_spi_transfer;
135ca632f55SGrant Likely 	master->cleanup = mpc8xxx_spi_cleanup;
136ca632f55SGrant Likely 	master->dev.of_node = dev->of_node;
137ca632f55SGrant Likely 
138ca632f55SGrant Likely 	mpc8xxx_spi = spi_master_get_devdata(master);
139ca632f55SGrant Likely 	mpc8xxx_spi->dev = dev;
140ca632f55SGrant Likely 	mpc8xxx_spi->get_rx = mpc8xxx_spi_rx_buf_u8;
141ca632f55SGrant Likely 	mpc8xxx_spi->get_tx = mpc8xxx_spi_tx_buf_u8;
142ca632f55SGrant Likely 	mpc8xxx_spi->flags = pdata->flags;
143ca632f55SGrant Likely 	mpc8xxx_spi->spibrg = pdata->sysclk;
144ca632f55SGrant Likely 	mpc8xxx_spi->irq = irq;
145ca632f55SGrant Likely 
146ca632f55SGrant Likely 	mpc8xxx_spi->rx_shift = 0;
147ca632f55SGrant Likely 	mpc8xxx_spi->tx_shift = 0;
148ca632f55SGrant Likely 
149ca632f55SGrant Likely 	init_completion(&mpc8xxx_spi->done);
150ca632f55SGrant Likely 
151ca632f55SGrant Likely 	master->bus_num = pdata->bus_num;
152ca632f55SGrant Likely 	master->num_chipselect = pdata->max_chipselect;
153ca632f55SGrant Likely 
154ca632f55SGrant Likely 	spin_lock_init(&mpc8xxx_spi->lock);
155ca632f55SGrant Likely 	init_completion(&mpc8xxx_spi->done);
156ca632f55SGrant Likely 	INIT_WORK(&mpc8xxx_spi->work, mpc8xxx_spi_work);
157ca632f55SGrant Likely 	INIT_LIST_HEAD(&mpc8xxx_spi->queue);
158ca632f55SGrant Likely 
159ca632f55SGrant Likely 	mpc8xxx_spi->workqueue = create_singlethread_workqueue(
160ca632f55SGrant Likely 		dev_name(master->dev.parent));
161ca632f55SGrant Likely 	if (mpc8xxx_spi->workqueue == NULL) {
162ca632f55SGrant Likely 		ret = -EBUSY;
163ca632f55SGrant Likely 		goto err;
164ca632f55SGrant Likely 	}
165ca632f55SGrant Likely 
166ca632f55SGrant Likely 	return 0;
167ca632f55SGrant Likely 
168ca632f55SGrant Likely err:
169ca632f55SGrant Likely 	return ret;
170ca632f55SGrant Likely }
171ca632f55SGrant Likely 
172fd4a319bSGrant Likely int mpc8xxx_spi_remove(struct device *dev)
173ca632f55SGrant Likely {
174ca632f55SGrant Likely 	struct mpc8xxx_spi *mpc8xxx_spi;
175ca632f55SGrant Likely 	struct spi_master *master;
176ca632f55SGrant Likely 
177ca632f55SGrant Likely 	master = dev_get_drvdata(dev);
178ca632f55SGrant Likely 	mpc8xxx_spi = spi_master_get_devdata(master);
179ca632f55SGrant Likely 
180ca632f55SGrant Likely 	flush_workqueue(mpc8xxx_spi->workqueue);
181ca632f55SGrant Likely 	destroy_workqueue(mpc8xxx_spi->workqueue);
182ca632f55SGrant Likely 	spi_unregister_master(master);
183ca632f55SGrant Likely 
184ca632f55SGrant Likely 	free_irq(mpc8xxx_spi->irq, mpc8xxx_spi);
185ca632f55SGrant Likely 
186ca632f55SGrant Likely 	if (mpc8xxx_spi->spi_remove)
187ca632f55SGrant Likely 		mpc8xxx_spi->spi_remove(mpc8xxx_spi);
188ca632f55SGrant Likely 
189ca632f55SGrant Likely 	return 0;
190ca632f55SGrant Likely }
191ca632f55SGrant Likely 
192fd4a319bSGrant Likely int of_mpc8xxx_spi_probe(struct platform_device *ofdev)
193ca632f55SGrant Likely {
194ca632f55SGrant Likely 	struct device *dev = &ofdev->dev;
195ca632f55SGrant Likely 	struct device_node *np = ofdev->dev.of_node;
196ca632f55SGrant Likely 	struct mpc8xxx_spi_probe_info *pinfo;
197ca632f55SGrant Likely 	struct fsl_spi_platform_data *pdata;
198ca632f55SGrant Likely 	const void *prop;
199ca632f55SGrant Likely 	int ret = -ENOMEM;
200ca632f55SGrant Likely 
201ca632f55SGrant Likely 	pinfo = kzalloc(sizeof(*pinfo), GFP_KERNEL);
202ca632f55SGrant Likely 	if (!pinfo)
203ca632f55SGrant Likely 		return -ENOMEM;
204ca632f55SGrant Likely 
205ca632f55SGrant Likely 	pdata = &pinfo->pdata;
206ca632f55SGrant Likely 	dev->platform_data = pdata;
207ca632f55SGrant Likely 
208ca632f55SGrant Likely 	/* Allocate bus num dynamically. */
209ca632f55SGrant Likely 	pdata->bus_num = -1;
210ca632f55SGrant Likely 
211ca632f55SGrant Likely 	/* SPI controller is either clocked from QE or SoC clock. */
212ca632f55SGrant Likely 	pdata->sysclk = get_brgfreq();
213ca632f55SGrant Likely 	if (pdata->sysclk == -1) {
214ca632f55SGrant Likely 		pdata->sysclk = fsl_get_sys_freq();
215ca632f55SGrant Likely 		if (pdata->sysclk == -1) {
216ca632f55SGrant Likely 			ret = -ENODEV;
217ca632f55SGrant Likely 			goto err;
218ca632f55SGrant Likely 		}
219ca632f55SGrant Likely 	}
220ca632f55SGrant Likely 
221ca632f55SGrant Likely 	prop = of_get_property(np, "mode", NULL);
222ca632f55SGrant Likely 	if (prop && !strcmp(prop, "cpu-qe"))
223ca632f55SGrant Likely 		pdata->flags = SPI_QE_CPU_MODE;
224ca632f55SGrant Likely 	else if (prop && !strcmp(prop, "qe"))
225ca632f55SGrant Likely 		pdata->flags = SPI_CPM_MODE | SPI_QE;
226ca632f55SGrant Likely 	else if (of_device_is_compatible(np, "fsl,cpm2-spi"))
227ca632f55SGrant Likely 		pdata->flags = SPI_CPM_MODE | SPI_CPM2;
228ca632f55SGrant Likely 	else if (of_device_is_compatible(np, "fsl,cpm1-spi"))
229ca632f55SGrant Likely 		pdata->flags = SPI_CPM_MODE | SPI_CPM1;
230ca632f55SGrant Likely 
231ca632f55SGrant Likely 	return 0;
232ca632f55SGrant Likely 
233ca632f55SGrant Likely err:
234ca632f55SGrant Likely 	kfree(pinfo);
235ca632f55SGrant Likely 	return ret;
236ca632f55SGrant Likely }
237