Linux Audio

Check our new training course

Loading...
v3.15
 
  1/*
  2 * TI QSPI driver
  3 *
  4 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
  5 * Author: Sourav Poddar <sourav.poddar@ti.com>
  6 *
  7 * This program is free software; you can redistribute it and/or
  8 * modify it under the terms of the GPLv2.
  9 *
 10 * This program is distributed in the hope that it will be useful,
 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR /PURPOSE.  See the
 13 * GNU General Public License for more details.
 14 */
 15
 16#include <linux/kernel.h>
 17#include <linux/init.h>
 18#include <linux/interrupt.h>
 19#include <linux/module.h>
 20#include <linux/device.h>
 21#include <linux/delay.h>
 22#include <linux/dma-mapping.h>
 23#include <linux/dmaengine.h>
 24#include <linux/omap-dma.h>
 25#include <linux/platform_device.h>
 26#include <linux/err.h>
 27#include <linux/clk.h>
 28#include <linux/io.h>
 29#include <linux/slab.h>
 30#include <linux/pm_runtime.h>
 31#include <linux/of.h>
 32#include <linux/of_device.h>
 33#include <linux/pinctrl/consumer.h>
 
 
 
 34
 35#include <linux/spi/spi.h>
 
 36
 37struct ti_qspi_regs {
 38	u32 clkctrl;
 39};
 40
 41struct ti_qspi {
 42	struct completion       transfer_complete;
 43
 44	/* list synchronization */
 45	struct mutex            list_lock;
 46
 47	struct spi_master	*master;
 48	void __iomem            *base;
 49	void __iomem            *ctrl_base;
 50	void __iomem            *mmap_base;
 
 
 
 51	struct clk		*fclk;
 52	struct device           *dev;
 53
 54	struct ti_qspi_regs     ctx_reg;
 55
 
 
 
 
 
 56	u32 spi_max_frequency;
 57	u32 cmd;
 58	u32 dc;
 59
 60	bool ctrl_mod;
 
 61};
 62
 63#define QSPI_PID			(0x0)
 64#define QSPI_SYSCONFIG			(0x10)
 65#define QSPI_INTR_STATUS_RAW_SET	(0x20)
 66#define QSPI_INTR_STATUS_ENABLED_CLEAR	(0x24)
 67#define QSPI_INTR_ENABLE_SET_REG	(0x28)
 68#define QSPI_INTR_ENABLE_CLEAR_REG	(0x2c)
 69#define QSPI_SPI_CLOCK_CNTRL_REG	(0x40)
 70#define QSPI_SPI_DC_REG			(0x44)
 71#define QSPI_SPI_CMD_REG		(0x48)
 72#define QSPI_SPI_STATUS_REG		(0x4c)
 73#define QSPI_SPI_DATA_REG		(0x50)
 74#define QSPI_SPI_SETUP0_REG		(0x54)
 75#define QSPI_SPI_SWITCH_REG		(0x64)
 76#define QSPI_SPI_SETUP1_REG		(0x58)
 77#define QSPI_SPI_SETUP2_REG		(0x5c)
 78#define QSPI_SPI_SETUP3_REG		(0x60)
 79#define QSPI_SPI_DATA_REG_1		(0x68)
 80#define QSPI_SPI_DATA_REG_2		(0x6c)
 81#define QSPI_SPI_DATA_REG_3		(0x70)
 82
 83#define QSPI_COMPLETION_TIMEOUT		msecs_to_jiffies(2000)
 84
 85#define QSPI_FCLK			192000000
 86
 87/* Clock Control */
 88#define QSPI_CLK_EN			(1 << 31)
 89#define QSPI_CLK_DIV_MAX		0xffff
 90
 91/* Command */
 92#define QSPI_EN_CS(n)			(n << 28)
 93#define QSPI_WLEN(n)			((n - 1) << 19)
 94#define QSPI_3_PIN			(1 << 18)
 95#define QSPI_RD_SNGL			(1 << 16)
 96#define QSPI_WR_SNGL			(2 << 16)
 97#define QSPI_RD_DUAL			(3 << 16)
 98#define QSPI_RD_QUAD			(7 << 16)
 99#define QSPI_INVAL			(4 << 16)
100#define QSPI_WC_CMD_INT_EN			(1 << 14)
101#define QSPI_FLEN(n)			((n - 1) << 0)
 
 
 
102
103/* STATUS REGISTER */
 
104#define WC				0x02
105
106/* INTERRUPT REGISTER */
107#define QSPI_WC_INT_EN				(1 << 1)
108#define QSPI_WC_INT_DISABLE			(1 << 1)
109
110/* Device Control */
111#define QSPI_DD(m, n)			(m << (3 + n * 8))
112#define QSPI_CKPHA(n)			(1 << (2 + n * 8))
113#define QSPI_CSPOL(n)			(1 << (1 + n * 8))
114#define QSPI_CKPOL(n)			(1 << (n * 8))
115
116#define	QSPI_FRAME			4096
117
118#define QSPI_AUTOSUSPEND_TIMEOUT         2000
119
 
 
 
 
 
 
 
 
 
 
 
 
 
120static inline unsigned long ti_qspi_read(struct ti_qspi *qspi,
121		unsigned long reg)
122{
123	return readl(qspi->base + reg);
124}
125
126static inline void ti_qspi_write(struct ti_qspi *qspi,
127		unsigned long val, unsigned long reg)
128{
129	writel(val, qspi->base + reg);
130}
131
132static int ti_qspi_setup(struct spi_device *spi)
133{
134	struct ti_qspi	*qspi = spi_master_get_devdata(spi->master);
135	struct ti_qspi_regs *ctx_reg = &qspi->ctx_reg;
136	int clk_div = 0, ret;
137	u32 clk_ctrl_reg, clk_rate, clk_mask;
138
139	if (spi->master->busy) {
140		dev_dbg(qspi->dev, "master busy doing other trasnfers\n");
141		return -EBUSY;
142	}
143
144	if (!qspi->spi_max_frequency) {
145		dev_err(qspi->dev, "spi max frequency not defined\n");
146		return -EINVAL;
147	}
148
149	clk_rate = clk_get_rate(qspi->fclk);
150
151	clk_div = DIV_ROUND_UP(clk_rate, qspi->spi_max_frequency) - 1;
152
153	if (clk_div < 0) {
154		dev_dbg(qspi->dev, "clock divider < 0, using /1 divider\n");
155		return -EINVAL;
156	}
157
158	if (clk_div > QSPI_CLK_DIV_MAX) {
159		dev_dbg(qspi->dev, "clock divider >%d , using /%d divider\n",
160				QSPI_CLK_DIV_MAX, QSPI_CLK_DIV_MAX + 1);
161		return -EINVAL;
162	}
163
164	dev_dbg(qspi->dev, "hz: %d, clock divider %d\n",
165			qspi->spi_max_frequency, clk_div);
166
167	ret = pm_runtime_get_sync(qspi->dev);
168	if (ret < 0) {
 
169		dev_err(qspi->dev, "pm_runtime_get_sync() failed\n");
170		return ret;
171	}
172
173	clk_ctrl_reg = ti_qspi_read(qspi, QSPI_SPI_CLOCK_CNTRL_REG);
174
175	clk_ctrl_reg &= ~QSPI_CLK_EN;
176
177	/* disable SCLK */
178	ti_qspi_write(qspi, clk_ctrl_reg, QSPI_SPI_CLOCK_CNTRL_REG);
179
180	/* enable SCLK */
181	clk_mask = QSPI_CLK_EN | clk_div;
182	ti_qspi_write(qspi, clk_mask, QSPI_SPI_CLOCK_CNTRL_REG);
183	ctx_reg->clkctrl = clk_mask;
184
185	pm_runtime_mark_last_busy(qspi->dev);
186	ret = pm_runtime_put_autosuspend(qspi->dev);
187	if (ret < 0) {
188		dev_err(qspi->dev, "pm_runtime_put_autosuspend() failed\n");
189		return ret;
190	}
191
192	return 0;
193}
194
195static void ti_qspi_restore_ctx(struct ti_qspi *qspi)
196{
197	struct ti_qspi_regs *ctx_reg = &qspi->ctx_reg;
198
199	ti_qspi_write(qspi, ctx_reg->clkctrl, QSPI_SPI_CLOCK_CNTRL_REG);
200}
201
202static int qspi_write_msg(struct ti_qspi *qspi, struct spi_transfer *t)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
203{
204	int wlen, count, ret;
205	unsigned int cmd;
206	const u8 *txbuf;
 
207
208	txbuf = t->tx_buf;
209	cmd = qspi->cmd | QSPI_WR_SNGL;
210	count = t->len;
211	wlen = t->bits_per_word >> 3;	/* in bytes */
 
212
213	while (count) {
 
 
 
214		switch (wlen) {
215		case 1:
216			dev_dbg(qspi->dev, "tx cmd %08x dc %08x data %02x\n",
217					cmd, qspi->dc, *txbuf);
218			writeb(*txbuf, qspi->base + QSPI_SPI_DATA_REG);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
219			break;
220		case 2:
221			dev_dbg(qspi->dev, "tx cmd %08x dc %08x data %04x\n",
222					cmd, qspi->dc, *txbuf);
223			writew(*((u16 *)txbuf), qspi->base + QSPI_SPI_DATA_REG);
224			break;
225		case 4:
226			dev_dbg(qspi->dev, "tx cmd %08x dc %08x data %08x\n",
227					cmd, qspi->dc, *txbuf);
228			writel(*((u32 *)txbuf), qspi->base + QSPI_SPI_DATA_REG);
229			break;
230		}
231
232		ti_qspi_write(qspi, cmd, QSPI_SPI_CMD_REG);
233		ret = wait_for_completion_timeout(&qspi->transfer_complete,
234						  QSPI_COMPLETION_TIMEOUT);
235		if (ret == 0) {
236			dev_err(qspi->dev, "write timed out\n");
237			return -ETIMEDOUT;
238		}
239		txbuf += wlen;
240		count -= wlen;
241	}
242
243	return 0;
244}
245
246static int qspi_read_msg(struct ti_qspi *qspi, struct spi_transfer *t)
 
247{
248	int wlen, count, ret;
249	unsigned int cmd;
 
 
250	u8 *rxbuf;
251
252	rxbuf = t->rx_buf;
253	cmd = qspi->cmd;
254	switch (t->rx_nbits) {
255	case SPI_NBITS_DUAL:
256		cmd |= QSPI_RD_DUAL;
257		break;
258	case SPI_NBITS_QUAD:
259		cmd |= QSPI_RD_QUAD;
260		break;
261	default:
262		cmd |= QSPI_RD_SNGL;
263		break;
264	}
265	count = t->len;
266	wlen = t->bits_per_word >> 3;	/* in bytes */
 
267
268	while (count) {
269		dev_dbg(qspi->dev, "rx cmd %08x dc %08x\n", cmd, qspi->dc);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
270		ti_qspi_write(qspi, cmd, QSPI_SPI_CMD_REG);
271		ret = wait_for_completion_timeout(&qspi->transfer_complete,
272				QSPI_COMPLETION_TIMEOUT);
273		if (ret == 0) {
274			dev_err(qspi->dev, "read timed out\n");
275			return -ETIMEDOUT;
276		}
 
277		switch (wlen) {
278		case 1:
279			*rxbuf = readb(qspi->base + QSPI_SPI_DATA_REG);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
280			break;
281		case 2:
282			*((u16 *)rxbuf) = readw(qspi->base + QSPI_SPI_DATA_REG);
283			break;
284		case 4:
285			*((u32 *)rxbuf) = readl(qspi->base + QSPI_SPI_DATA_REG);
286			break;
287		}
288		rxbuf += wlen;
289		count -= wlen;
290	}
291
292	return 0;
293}
294
295static int qspi_transfer_msg(struct ti_qspi *qspi, struct spi_transfer *t)
 
296{
297	int ret;
298
299	if (t->tx_buf) {
300		ret = qspi_write_msg(qspi, t);
301		if (ret) {
302			dev_dbg(qspi->dev, "Error while writing\n");
303			return ret;
304		}
305	}
306
307	if (t->rx_buf) {
308		ret = qspi_read_msg(qspi, t);
309		if (ret) {
310			dev_dbg(qspi->dev, "Error while reading\n");
311			return ret;
312		}
313	}
314
315	return 0;
316}
317
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
318static int ti_qspi_start_transfer_one(struct spi_master *master,
319		struct spi_message *m)
320{
321	struct ti_qspi *qspi = spi_master_get_devdata(master);
322	struct spi_device *spi = m->spi;
323	struct spi_transfer *t;
324	int status = 0, ret;
325	int frame_length;
 
326
327	/* setup device control reg */
328	qspi->dc = 0;
329
330	if (spi->mode & SPI_CPHA)
331		qspi->dc |= QSPI_CKPHA(spi->chip_select);
332	if (spi->mode & SPI_CPOL)
333		qspi->dc |= QSPI_CKPOL(spi->chip_select);
334	if (spi->mode & SPI_CS_HIGH)
335		qspi->dc |= QSPI_CSPOL(spi->chip_select);
336
337	frame_length = (m->frame_length << 3) / spi->bits_per_word;
338
339	frame_length = clamp(frame_length, 0, QSPI_FRAME);
 
340
341	/* setup command reg */
342	qspi->cmd = 0;
343	qspi->cmd |= QSPI_EN_CS(spi->chip_select);
344	qspi->cmd |= QSPI_FLEN(frame_length);
345	qspi->cmd |= QSPI_WC_CMD_INT_EN;
346
347	ti_qspi_write(qspi, QSPI_WC_INT_EN, QSPI_INTR_ENABLE_SET_REG);
348	ti_qspi_write(qspi, qspi->dc, QSPI_SPI_DC_REG);
349
350	mutex_lock(&qspi->list_lock);
351
 
 
 
352	list_for_each_entry(t, &m->transfers, transfer_list) {
353		qspi->cmd |= QSPI_WLEN(t->bits_per_word);
 
 
 
 
354
355		ret = qspi_transfer_msg(qspi, t);
356		if (ret) {
357			dev_dbg(qspi->dev, "transfer message failed\n");
358			mutex_unlock(&qspi->list_lock);
359			return -EINVAL;
360		}
361
362		m->actual_length += t->len;
 
 
 
363	}
364
365	mutex_unlock(&qspi->list_lock);
366
 
367	m->status = status;
368	spi_finalize_current_message(master);
369
370	ti_qspi_write(qspi, qspi->cmd | QSPI_INVAL, QSPI_SPI_CMD_REG);
371
372	return status;
373}
374
375static irqreturn_t ti_qspi_isr(int irq, void *dev_id)
376{
377	struct ti_qspi *qspi = dev_id;
378	u16 int_stat;
379	u32 stat;
380
381	irqreturn_t ret = IRQ_HANDLED;
382
383	int_stat = ti_qspi_read(qspi, QSPI_INTR_STATUS_ENABLED_CLEAR);
384	stat = ti_qspi_read(qspi, QSPI_SPI_STATUS_REG);
385
386	if (!int_stat) {
387		dev_dbg(qspi->dev, "No IRQ triggered\n");
388		ret = IRQ_NONE;
389		goto out;
390	}
391
392	ti_qspi_write(qspi, QSPI_WC_INT_DISABLE,
393				QSPI_INTR_STATUS_ENABLED_CLEAR);
394	if (stat & WC)
395		complete(&qspi->transfer_complete);
396out:
397	return ret;
398}
399
400static int ti_qspi_runtime_resume(struct device *dev)
401{
402	struct ti_qspi      *qspi;
403
404	qspi = dev_get_drvdata(dev);
405	ti_qspi_restore_ctx(qspi);
406
407	return 0;
408}
409
 
 
 
 
 
 
 
 
 
 
 
410static const struct of_device_id ti_qspi_match[] = {
411	{.compatible = "ti,dra7xxx-qspi" },
412	{.compatible = "ti,am4372-qspi" },
413	{},
414};
415MODULE_DEVICE_TABLE(of, ti_qspi_match);
416
417static int ti_qspi_probe(struct platform_device *pdev)
418{
419	struct  ti_qspi *qspi;
420	struct spi_master *master;
421	struct resource         *r, *res_ctrl, *res_mmap;
422	struct device_node *np = pdev->dev.of_node;
423	u32 max_freq;
424	int ret = 0, num_cs, irq;
 
425
426	master = spi_alloc_master(&pdev->dev, sizeof(*qspi));
427	if (!master)
428		return -ENOMEM;
429
430	master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_RX_DUAL | SPI_RX_QUAD;
431
432	master->flags = SPI_MASTER_HALF_DUPLEX;
433	master->setup = ti_qspi_setup;
434	master->auto_runtime_pm = true;
435	master->transfer_one_message = ti_qspi_start_transfer_one;
436	master->dev.of_node = pdev->dev.of_node;
437	master->bits_per_word_mask = SPI_BPW_MASK(32) | SPI_BPW_MASK(16) |
438				     SPI_BPW_MASK(8);
 
439
440	if (!of_property_read_u32(np, "num-cs", &num_cs))
441		master->num_chipselect = num_cs;
442
443	qspi = spi_master_get_devdata(master);
444	qspi->master = master;
445	qspi->dev = &pdev->dev;
446	platform_set_drvdata(pdev, qspi);
447
448	r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qspi_base");
449	if (r == NULL) {
450		r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
451		if (r == NULL) {
452			dev_err(&pdev->dev, "missing platform data\n");
453			return -ENODEV;
 
454		}
455	}
456
457	res_mmap = platform_get_resource_byname(pdev,
458			IORESOURCE_MEM, "qspi_mmap");
459	if (res_mmap == NULL) {
460		res_mmap = platform_get_resource(pdev, IORESOURCE_MEM, 1);
461		if (res_mmap == NULL) {
462			dev_err(&pdev->dev,
463				"memory mapped resource not required\n");
464		}
465	}
466
467	res_ctrl = platform_get_resource_byname(pdev,
468			IORESOURCE_MEM, "qspi_ctrlmod");
469	if (res_ctrl == NULL) {
470		res_ctrl = platform_get_resource(pdev, IORESOURCE_MEM, 2);
471		if (res_ctrl == NULL) {
472			dev_dbg(&pdev->dev,
473				"control module resources not required\n");
474		}
475	}
476
477	irq = platform_get_irq(pdev, 0);
478	if (irq < 0) {
479		dev_err(&pdev->dev, "no irq resource?\n");
480		return irq;
481	}
482
483	mutex_init(&qspi->list_lock);
484
485	qspi->base = devm_ioremap_resource(&pdev->dev, r);
486	if (IS_ERR(qspi->base)) {
487		ret = PTR_ERR(qspi->base);
488		goto free_master;
489	}
490
491	if (res_ctrl) {
492		qspi->ctrl_mod = true;
493		qspi->ctrl_base = devm_ioremap_resource(&pdev->dev, res_ctrl);
 
 
494		if (IS_ERR(qspi->ctrl_base)) {
495			ret = PTR_ERR(qspi->ctrl_base);
496			goto free_master;
497		}
498	}
499
500	if (res_mmap) {
501		qspi->mmap_base = devm_ioremap_resource(&pdev->dev, res_mmap);
502		if (IS_ERR(qspi->mmap_base)) {
503			ret = PTR_ERR(qspi->mmap_base);
504			goto free_master;
505		}
506	}
507
508	ret = devm_request_irq(&pdev->dev, irq, ti_qspi_isr, 0,
509			dev_name(&pdev->dev), qspi);
510	if (ret < 0) {
511		dev_err(&pdev->dev, "Failed to register ISR for IRQ %d\n",
512				irq);
513		goto free_master;
514	}
515
516	qspi->fclk = devm_clk_get(&pdev->dev, "fck");
517	if (IS_ERR(qspi->fclk)) {
518		ret = PTR_ERR(qspi->fclk);
519		dev_err(&pdev->dev, "could not get clk: %d\n", ret);
520	}
521
522	init_completion(&qspi->transfer_complete);
523
524	pm_runtime_use_autosuspend(&pdev->dev);
525	pm_runtime_set_autosuspend_delay(&pdev->dev, QSPI_AUTOSUSPEND_TIMEOUT);
526	pm_runtime_enable(&pdev->dev);
527
528	if (!of_property_read_u32(np, "spi-max-frequency", &max_freq))
529		qspi->spi_max_frequency = max_freq;
530
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
531	ret = devm_spi_register_master(&pdev->dev, master);
532	if (ret)
533		goto free_master;
534
535	return 0;
536
 
537free_master:
538	spi_master_put(master);
539	return ret;
540}
541
542static int ti_qspi_remove(struct platform_device *pdev)
543{
544	struct ti_qspi *qspi = platform_get_drvdata(pdev);
545	int ret;
546
547	ret = pm_runtime_get_sync(qspi->dev);
548	if (ret < 0) {
549		dev_err(qspi->dev, "pm_runtime_get_sync() failed\n");
550		return ret;
551	}
552
553	ti_qspi_write(qspi, QSPI_WC_INT_DISABLE, QSPI_INTR_ENABLE_CLEAR_REG);
554
555	pm_runtime_put(qspi->dev);
556	pm_runtime_disable(&pdev->dev);
557
 
 
558	return 0;
559}
560
561static const struct dev_pm_ops ti_qspi_pm_ops = {
562	.runtime_resume = ti_qspi_runtime_resume,
563};
564
565static struct platform_driver ti_qspi_driver = {
566	.probe	= ti_qspi_probe,
567	.remove = ti_qspi_remove,
568	.driver = {
569		.name	= "ti-qspi",
570		.owner	= THIS_MODULE,
571		.pm =   &ti_qspi_pm_ops,
572		.of_match_table = ti_qspi_match,
573	}
574};
575
576module_platform_driver(ti_qspi_driver);
577
578MODULE_AUTHOR("Sourav Poddar <sourav.poddar@ti.com>");
579MODULE_LICENSE("GPL v2");
580MODULE_DESCRIPTION("TI QSPI controller driver");
581MODULE_ALIAS("platform:ti-qspi");
v5.14.15
  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * TI QSPI driver
  4 *
  5 * Copyright (C) 2013 Texas Instruments Incorporated - https://www.ti.com
  6 * Author: Sourav Poddar <sourav.poddar@ti.com>
 
 
 
 
 
 
 
 
  7 */
  8
  9#include <linux/kernel.h>
 10#include <linux/init.h>
 11#include <linux/interrupt.h>
 12#include <linux/module.h>
 13#include <linux/device.h>
 14#include <linux/delay.h>
 15#include <linux/dma-mapping.h>
 16#include <linux/dmaengine.h>
 17#include <linux/omap-dma.h>
 18#include <linux/platform_device.h>
 19#include <linux/err.h>
 20#include <linux/clk.h>
 21#include <linux/io.h>
 22#include <linux/slab.h>
 23#include <linux/pm_runtime.h>
 24#include <linux/of.h>
 25#include <linux/of_device.h>
 26#include <linux/pinctrl/consumer.h>
 27#include <linux/mfd/syscon.h>
 28#include <linux/regmap.h>
 29#include <linux/sizes.h>
 30
 31#include <linux/spi/spi.h>
 32#include <linux/spi/spi-mem.h>
 33
 34struct ti_qspi_regs {
 35	u32 clkctrl;
 36};
 37
 38struct ti_qspi {
 39	struct completion	transfer_complete;
 40
 41	/* list synchronization */
 42	struct mutex            list_lock;
 43
 44	struct spi_master	*master;
 45	void __iomem            *base;
 
 46	void __iomem            *mmap_base;
 47	size_t			mmap_size;
 48	struct regmap		*ctrl_base;
 49	unsigned int		ctrl_reg;
 50	struct clk		*fclk;
 51	struct device           *dev;
 52
 53	struct ti_qspi_regs     ctx_reg;
 54
 55	dma_addr_t		mmap_phys_base;
 56	dma_addr_t		rx_bb_dma_addr;
 57	void			*rx_bb_addr;
 58	struct dma_chan		*rx_chan;
 59
 60	u32 spi_max_frequency;
 61	u32 cmd;
 62	u32 dc;
 63
 64	bool mmap_enabled;
 65	int current_cs;
 66};
 67
 68#define QSPI_PID			(0x0)
 69#define QSPI_SYSCONFIG			(0x10)
 
 
 
 
 70#define QSPI_SPI_CLOCK_CNTRL_REG	(0x40)
 71#define QSPI_SPI_DC_REG			(0x44)
 72#define QSPI_SPI_CMD_REG		(0x48)
 73#define QSPI_SPI_STATUS_REG		(0x4c)
 74#define QSPI_SPI_DATA_REG		(0x50)
 75#define QSPI_SPI_SETUP_REG(n)		((0x54 + 4 * n))
 76#define QSPI_SPI_SWITCH_REG		(0x64)
 
 
 
 77#define QSPI_SPI_DATA_REG_1		(0x68)
 78#define QSPI_SPI_DATA_REG_2		(0x6c)
 79#define QSPI_SPI_DATA_REG_3		(0x70)
 80
 81#define QSPI_COMPLETION_TIMEOUT		msecs_to_jiffies(2000)
 82
 
 
 83/* Clock Control */
 84#define QSPI_CLK_EN			(1 << 31)
 85#define QSPI_CLK_DIV_MAX		0xffff
 86
 87/* Command */
 88#define QSPI_EN_CS(n)			(n << 28)
 89#define QSPI_WLEN(n)			((n - 1) << 19)
 90#define QSPI_3_PIN			(1 << 18)
 91#define QSPI_RD_SNGL			(1 << 16)
 92#define QSPI_WR_SNGL			(2 << 16)
 93#define QSPI_RD_DUAL			(3 << 16)
 94#define QSPI_RD_QUAD			(7 << 16)
 95#define QSPI_INVAL			(4 << 16)
 
 96#define QSPI_FLEN(n)			((n - 1) << 0)
 97#define QSPI_WLEN_MAX_BITS		128
 98#define QSPI_WLEN_MAX_BYTES		16
 99#define QSPI_WLEN_MASK			QSPI_WLEN(QSPI_WLEN_MAX_BITS)
100
101/* STATUS REGISTER */
102#define BUSY				0x01
103#define WC				0x02
104
 
 
 
 
105/* Device Control */
106#define QSPI_DD(m, n)			(m << (3 + n * 8))
107#define QSPI_CKPHA(n)			(1 << (2 + n * 8))
108#define QSPI_CSPOL(n)			(1 << (1 + n * 8))
109#define QSPI_CKPOL(n)			(1 << (n * 8))
110
111#define	QSPI_FRAME			4096
112
113#define QSPI_AUTOSUSPEND_TIMEOUT         2000
114
115#define MEM_CS_EN(n)			((n + 1) << 8)
116#define MEM_CS_MASK			(7 << 8)
117
118#define MM_SWITCH			0x1
119
120#define QSPI_SETUP_RD_NORMAL		(0x0 << 12)
121#define QSPI_SETUP_RD_DUAL		(0x1 << 12)
122#define QSPI_SETUP_RD_QUAD		(0x3 << 12)
123#define QSPI_SETUP_ADDR_SHIFT		8
124#define QSPI_SETUP_DUMMY_SHIFT		10
125
126#define QSPI_DMA_BUFFER_SIZE            SZ_64K
127
128static inline unsigned long ti_qspi_read(struct ti_qspi *qspi,
129		unsigned long reg)
130{
131	return readl(qspi->base + reg);
132}
133
134static inline void ti_qspi_write(struct ti_qspi *qspi,
135		unsigned long val, unsigned long reg)
136{
137	writel(val, qspi->base + reg);
138}
139
140static int ti_qspi_setup(struct spi_device *spi)
141{
142	struct ti_qspi	*qspi = spi_master_get_devdata(spi->master);
143	struct ti_qspi_regs *ctx_reg = &qspi->ctx_reg;
144	int clk_div = 0, ret;
145	u32 clk_ctrl_reg, clk_rate, clk_mask;
146
147	if (spi->master->busy) {
148		dev_dbg(qspi->dev, "master busy doing other transfers\n");
149		return -EBUSY;
150	}
151
152	if (!qspi->spi_max_frequency) {
153		dev_err(qspi->dev, "spi max frequency not defined\n");
154		return -EINVAL;
155	}
156
157	clk_rate = clk_get_rate(qspi->fclk);
158
159	clk_div = DIV_ROUND_UP(clk_rate, qspi->spi_max_frequency) - 1;
160
161	if (clk_div < 0) {
162		dev_dbg(qspi->dev, "clock divider < 0, using /1 divider\n");
163		return -EINVAL;
164	}
165
166	if (clk_div > QSPI_CLK_DIV_MAX) {
167		dev_dbg(qspi->dev, "clock divider >%d , using /%d divider\n",
168				QSPI_CLK_DIV_MAX, QSPI_CLK_DIV_MAX + 1);
169		return -EINVAL;
170	}
171
172	dev_dbg(qspi->dev, "hz: %d, clock divider %d\n",
173			qspi->spi_max_frequency, clk_div);
174
175	ret = pm_runtime_get_sync(qspi->dev);
176	if (ret < 0) {
177		pm_runtime_put_noidle(qspi->dev);
178		dev_err(qspi->dev, "pm_runtime_get_sync() failed\n");
179		return ret;
180	}
181
182	clk_ctrl_reg = ti_qspi_read(qspi, QSPI_SPI_CLOCK_CNTRL_REG);
183
184	clk_ctrl_reg &= ~QSPI_CLK_EN;
185
186	/* disable SCLK */
187	ti_qspi_write(qspi, clk_ctrl_reg, QSPI_SPI_CLOCK_CNTRL_REG);
188
189	/* enable SCLK */
190	clk_mask = QSPI_CLK_EN | clk_div;
191	ti_qspi_write(qspi, clk_mask, QSPI_SPI_CLOCK_CNTRL_REG);
192	ctx_reg->clkctrl = clk_mask;
193
194	pm_runtime_mark_last_busy(qspi->dev);
195	ret = pm_runtime_put_autosuspend(qspi->dev);
196	if (ret < 0) {
197		dev_err(qspi->dev, "pm_runtime_put_autosuspend() failed\n");
198		return ret;
199	}
200
201	return 0;
202}
203
204static void ti_qspi_restore_ctx(struct ti_qspi *qspi)
205{
206	struct ti_qspi_regs *ctx_reg = &qspi->ctx_reg;
207
208	ti_qspi_write(qspi, ctx_reg->clkctrl, QSPI_SPI_CLOCK_CNTRL_REG);
209}
210
211static inline u32 qspi_is_busy(struct ti_qspi *qspi)
212{
213	u32 stat;
214	unsigned long timeout = jiffies + QSPI_COMPLETION_TIMEOUT;
215
216	stat = ti_qspi_read(qspi, QSPI_SPI_STATUS_REG);
217	while ((stat & BUSY) && time_after(timeout, jiffies)) {
218		cpu_relax();
219		stat = ti_qspi_read(qspi, QSPI_SPI_STATUS_REG);
220	}
221
222	WARN(stat & BUSY, "qspi busy\n");
223	return stat & BUSY;
224}
225
226static inline int ti_qspi_poll_wc(struct ti_qspi *qspi)
227{
228	u32 stat;
229	unsigned long timeout = jiffies + QSPI_COMPLETION_TIMEOUT;
230
231	do {
232		stat = ti_qspi_read(qspi, QSPI_SPI_STATUS_REG);
233		if (stat & WC)
234			return 0;
235		cpu_relax();
236	} while (time_after(timeout, jiffies));
237
238	stat = ti_qspi_read(qspi, QSPI_SPI_STATUS_REG);
239	if (stat & WC)
240		return 0;
241	return  -ETIMEDOUT;
242}
243
244static int qspi_write_msg(struct ti_qspi *qspi, struct spi_transfer *t,
245			  int count)
246{
247	int wlen, xfer_len;
248	unsigned int cmd;
249	const u8 *txbuf;
250	u32 data;
251
252	txbuf = t->tx_buf;
253	cmd = qspi->cmd | QSPI_WR_SNGL;
 
254	wlen = t->bits_per_word >> 3;	/* in bytes */
255	xfer_len = wlen;
256
257	while (count) {
258		if (qspi_is_busy(qspi))
259			return -EBUSY;
260
261		switch (wlen) {
262		case 1:
263			dev_dbg(qspi->dev, "tx cmd %08x dc %08x data %02x\n",
264					cmd, qspi->dc, *txbuf);
265			if (count >= QSPI_WLEN_MAX_BYTES) {
266				u32 *txp = (u32 *)txbuf;
267
268				data = cpu_to_be32(*txp++);
269				writel(data, qspi->base +
270				       QSPI_SPI_DATA_REG_3);
271				data = cpu_to_be32(*txp++);
272				writel(data, qspi->base +
273				       QSPI_SPI_DATA_REG_2);
274				data = cpu_to_be32(*txp++);
275				writel(data, qspi->base +
276				       QSPI_SPI_DATA_REG_1);
277				data = cpu_to_be32(*txp++);
278				writel(data, qspi->base +
279				       QSPI_SPI_DATA_REG);
280				xfer_len = QSPI_WLEN_MAX_BYTES;
281				cmd |= QSPI_WLEN(QSPI_WLEN_MAX_BITS);
282			} else {
283				writeb(*txbuf, qspi->base + QSPI_SPI_DATA_REG);
284				cmd = qspi->cmd | QSPI_WR_SNGL;
285				xfer_len = wlen;
286				cmd |= QSPI_WLEN(wlen);
287			}
288			break;
289		case 2:
290			dev_dbg(qspi->dev, "tx cmd %08x dc %08x data %04x\n",
291					cmd, qspi->dc, *txbuf);
292			writew(*((u16 *)txbuf), qspi->base + QSPI_SPI_DATA_REG);
293			break;
294		case 4:
295			dev_dbg(qspi->dev, "tx cmd %08x dc %08x data %08x\n",
296					cmd, qspi->dc, *txbuf);
297			writel(*((u32 *)txbuf), qspi->base + QSPI_SPI_DATA_REG);
298			break;
299		}
300
301		ti_qspi_write(qspi, cmd, QSPI_SPI_CMD_REG);
302		if (ti_qspi_poll_wc(qspi)) {
 
 
303			dev_err(qspi->dev, "write timed out\n");
304			return -ETIMEDOUT;
305		}
306		txbuf += xfer_len;
307		count -= xfer_len;
308	}
309
310	return 0;
311}
312
313static int qspi_read_msg(struct ti_qspi *qspi, struct spi_transfer *t,
314			 int count)
315{
316	int wlen;
317	unsigned int cmd;
318	u32 rx;
319	u8 rxlen, rx_wlen;
320	u8 *rxbuf;
321
322	rxbuf = t->rx_buf;
323	cmd = qspi->cmd;
324	switch (t->rx_nbits) {
325	case SPI_NBITS_DUAL:
326		cmd |= QSPI_RD_DUAL;
327		break;
328	case SPI_NBITS_QUAD:
329		cmd |= QSPI_RD_QUAD;
330		break;
331	default:
332		cmd |= QSPI_RD_SNGL;
333		break;
334	}
 
335	wlen = t->bits_per_word >> 3;	/* in bytes */
336	rx_wlen = wlen;
337
338	while (count) {
339		dev_dbg(qspi->dev, "rx cmd %08x dc %08x\n", cmd, qspi->dc);
340		if (qspi_is_busy(qspi))
341			return -EBUSY;
342
343		switch (wlen) {
344		case 1:
345			/*
346			 * Optimize the 8-bit words transfers, as used by
347			 * the SPI flash devices.
348			 */
349			if (count >= QSPI_WLEN_MAX_BYTES) {
350				rxlen = QSPI_WLEN_MAX_BYTES;
351			} else {
352				rxlen = min(count, 4);
353			}
354			rx_wlen = rxlen << 3;
355			cmd &= ~QSPI_WLEN_MASK;
356			cmd |= QSPI_WLEN(rx_wlen);
357			break;
358		default:
359			rxlen = wlen;
360			break;
361		}
362
363		ti_qspi_write(qspi, cmd, QSPI_SPI_CMD_REG);
364		if (ti_qspi_poll_wc(qspi)) {
 
 
365			dev_err(qspi->dev, "read timed out\n");
366			return -ETIMEDOUT;
367		}
368
369		switch (wlen) {
370		case 1:
371			/*
372			 * Optimize the 8-bit words transfers, as used by
373			 * the SPI flash devices.
374			 */
375			if (count >= QSPI_WLEN_MAX_BYTES) {
376				u32 *rxp = (u32 *) rxbuf;
377				rx = readl(qspi->base + QSPI_SPI_DATA_REG_3);
378				*rxp++ = be32_to_cpu(rx);
379				rx = readl(qspi->base + QSPI_SPI_DATA_REG_2);
380				*rxp++ = be32_to_cpu(rx);
381				rx = readl(qspi->base + QSPI_SPI_DATA_REG_1);
382				*rxp++ = be32_to_cpu(rx);
383				rx = readl(qspi->base + QSPI_SPI_DATA_REG);
384				*rxp++ = be32_to_cpu(rx);
385			} else {
386				u8 *rxp = rxbuf;
387				rx = readl(qspi->base + QSPI_SPI_DATA_REG);
388				if (rx_wlen >= 8)
389					*rxp++ = rx >> (rx_wlen - 8);
390				if (rx_wlen >= 16)
391					*rxp++ = rx >> (rx_wlen - 16);
392				if (rx_wlen >= 24)
393					*rxp++ = rx >> (rx_wlen - 24);
394				if (rx_wlen >= 32)
395					*rxp++ = rx;
396			}
397			break;
398		case 2:
399			*((u16 *)rxbuf) = readw(qspi->base + QSPI_SPI_DATA_REG);
400			break;
401		case 4:
402			*((u32 *)rxbuf) = readl(qspi->base + QSPI_SPI_DATA_REG);
403			break;
404		}
405		rxbuf += rxlen;
406		count -= rxlen;
407	}
408
409	return 0;
410}
411
412static int qspi_transfer_msg(struct ti_qspi *qspi, struct spi_transfer *t,
413			     int count)
414{
415	int ret;
416
417	if (t->tx_buf) {
418		ret = qspi_write_msg(qspi, t, count);
419		if (ret) {
420			dev_dbg(qspi->dev, "Error while writing\n");
421			return ret;
422		}
423	}
424
425	if (t->rx_buf) {
426		ret = qspi_read_msg(qspi, t, count);
427		if (ret) {
428			dev_dbg(qspi->dev, "Error while reading\n");
429			return ret;
430		}
431	}
432
433	return 0;
434}
435
436static void ti_qspi_dma_callback(void *param)
437{
438	struct ti_qspi *qspi = param;
439
440	complete(&qspi->transfer_complete);
441}
442
443static int ti_qspi_dma_xfer(struct ti_qspi *qspi, dma_addr_t dma_dst,
444			    dma_addr_t dma_src, size_t len)
445{
446	struct dma_chan *chan = qspi->rx_chan;
447	dma_cookie_t cookie;
448	enum dma_ctrl_flags flags = DMA_CTRL_ACK | DMA_PREP_INTERRUPT;
449	struct dma_async_tx_descriptor *tx;
450	int ret;
451
452	tx = dmaengine_prep_dma_memcpy(chan, dma_dst, dma_src, len, flags);
453	if (!tx) {
454		dev_err(qspi->dev, "device_prep_dma_memcpy error\n");
455		return -EIO;
456	}
457
458	tx->callback = ti_qspi_dma_callback;
459	tx->callback_param = qspi;
460	cookie = tx->tx_submit(tx);
461	reinit_completion(&qspi->transfer_complete);
462
463	ret = dma_submit_error(cookie);
464	if (ret) {
465		dev_err(qspi->dev, "dma_submit_error %d\n", cookie);
466		return -EIO;
467	}
468
469	dma_async_issue_pending(chan);
470	ret = wait_for_completion_timeout(&qspi->transfer_complete,
471					  msecs_to_jiffies(len));
472	if (ret <= 0) {
473		dmaengine_terminate_sync(chan);
474		dev_err(qspi->dev, "DMA wait_for_completion_timeout\n");
475		return -ETIMEDOUT;
476	}
477
478	return 0;
479}
480
481static int ti_qspi_dma_bounce_buffer(struct ti_qspi *qspi, loff_t offs,
482				     void *to, size_t readsize)
483{
484	dma_addr_t dma_src = qspi->mmap_phys_base + offs;
485	int ret = 0;
486
487	/*
488	 * Use bounce buffer as FS like jffs2, ubifs may pass
489	 * buffers that does not belong to kernel lowmem region.
490	 */
491	while (readsize != 0) {
492		size_t xfer_len = min_t(size_t, QSPI_DMA_BUFFER_SIZE,
493					readsize);
494
495		ret = ti_qspi_dma_xfer(qspi, qspi->rx_bb_dma_addr,
496				       dma_src, xfer_len);
497		if (ret != 0)
498			return ret;
499		memcpy(to, qspi->rx_bb_addr, xfer_len);
500		readsize -= xfer_len;
501		dma_src += xfer_len;
502		to += xfer_len;
503	}
504
505	return ret;
506}
507
508static int ti_qspi_dma_xfer_sg(struct ti_qspi *qspi, struct sg_table rx_sg,
509			       loff_t from)
510{
511	struct scatterlist *sg;
512	dma_addr_t dma_src = qspi->mmap_phys_base + from;
513	dma_addr_t dma_dst;
514	int i, len, ret;
515
516	for_each_sg(rx_sg.sgl, sg, rx_sg.nents, i) {
517		dma_dst = sg_dma_address(sg);
518		len = sg_dma_len(sg);
519		ret = ti_qspi_dma_xfer(qspi, dma_dst, dma_src, len);
520		if (ret)
521			return ret;
522		dma_src += len;
523	}
524
525	return 0;
526}
527
528static void ti_qspi_enable_memory_map(struct spi_device *spi)
529{
530	struct ti_qspi  *qspi = spi_master_get_devdata(spi->master);
531
532	ti_qspi_write(qspi, MM_SWITCH, QSPI_SPI_SWITCH_REG);
533	if (qspi->ctrl_base) {
534		regmap_update_bits(qspi->ctrl_base, qspi->ctrl_reg,
535				   MEM_CS_MASK,
536				   MEM_CS_EN(spi->chip_select));
537	}
538	qspi->mmap_enabled = true;
539	qspi->current_cs = spi->chip_select;
540}
541
542static void ti_qspi_disable_memory_map(struct spi_device *spi)
543{
544	struct ti_qspi  *qspi = spi_master_get_devdata(spi->master);
545
546	ti_qspi_write(qspi, 0, QSPI_SPI_SWITCH_REG);
547	if (qspi->ctrl_base)
548		regmap_update_bits(qspi->ctrl_base, qspi->ctrl_reg,
549				   MEM_CS_MASK, 0);
550	qspi->mmap_enabled = false;
551	qspi->current_cs = -1;
552}
553
554static void ti_qspi_setup_mmap_read(struct spi_device *spi, u8 opcode,
555				    u8 data_nbits, u8 addr_width,
556				    u8 dummy_bytes)
557{
558	struct ti_qspi  *qspi = spi_master_get_devdata(spi->master);
559	u32 memval = opcode;
560
561	switch (data_nbits) {
562	case SPI_NBITS_QUAD:
563		memval |= QSPI_SETUP_RD_QUAD;
564		break;
565	case SPI_NBITS_DUAL:
566		memval |= QSPI_SETUP_RD_DUAL;
567		break;
568	default:
569		memval |= QSPI_SETUP_RD_NORMAL;
570		break;
571	}
572	memval |= ((addr_width - 1) << QSPI_SETUP_ADDR_SHIFT |
573		   dummy_bytes << QSPI_SETUP_DUMMY_SHIFT);
574	ti_qspi_write(qspi, memval,
575		      QSPI_SPI_SETUP_REG(spi->chip_select));
576}
577
578static int ti_qspi_adjust_op_size(struct spi_mem *mem, struct spi_mem_op *op)
579{
580	struct ti_qspi *qspi = spi_controller_get_devdata(mem->spi->master);
581	size_t max_len;
582
583	if (op->data.dir == SPI_MEM_DATA_IN) {
584		if (op->addr.val < qspi->mmap_size) {
585			/* Limit MMIO to the mmaped region */
586			if (op->addr.val + op->data.nbytes > qspi->mmap_size) {
587				max_len = qspi->mmap_size - op->addr.val;
588				op->data.nbytes = min((size_t) op->data.nbytes,
589						      max_len);
590			}
591		} else {
592			/*
593			 * Use fallback mode (SW generated transfers) above the
594			 * mmaped region.
595			 * Adjust size to comply with the QSPI max frame length.
596			 */
597			max_len = QSPI_FRAME;
598			max_len -= 1 + op->addr.nbytes + op->dummy.nbytes;
599			op->data.nbytes = min((size_t) op->data.nbytes,
600					      max_len);
601		}
602	}
603
604	return 0;
605}
606
607static int ti_qspi_exec_mem_op(struct spi_mem *mem,
608			       const struct spi_mem_op *op)
609{
610	struct ti_qspi *qspi = spi_master_get_devdata(mem->spi->master);
611	u32 from = 0;
612	int ret = 0;
613
614	/* Only optimize read path. */
615	if (!op->data.nbytes || op->data.dir != SPI_MEM_DATA_IN ||
616	    !op->addr.nbytes || op->addr.nbytes > 4)
617		return -ENOTSUPP;
618
619	/* Address exceeds MMIO window size, fall back to regular mode. */
620	from = op->addr.val;
621	if (from + op->data.nbytes > qspi->mmap_size)
622		return -ENOTSUPP;
623
624	mutex_lock(&qspi->list_lock);
625
626	if (!qspi->mmap_enabled || qspi->current_cs != mem->spi->chip_select)
627		ti_qspi_enable_memory_map(mem->spi);
628	ti_qspi_setup_mmap_read(mem->spi, op->cmd.opcode, op->data.buswidth,
629				op->addr.nbytes, op->dummy.nbytes);
630
631	if (qspi->rx_chan) {
632		struct sg_table sgt;
633
634		if (virt_addr_valid(op->data.buf.in) &&
635		    !spi_controller_dma_map_mem_op_data(mem->spi->master, op,
636							&sgt)) {
637			ret = ti_qspi_dma_xfer_sg(qspi, sgt, from);
638			spi_controller_dma_unmap_mem_op_data(mem->spi->master,
639							     op, &sgt);
640		} else {
641			ret = ti_qspi_dma_bounce_buffer(qspi, from,
642							op->data.buf.in,
643							op->data.nbytes);
644		}
645	} else {
646		memcpy_fromio(op->data.buf.in, qspi->mmap_base + from,
647			      op->data.nbytes);
648	}
649
650	mutex_unlock(&qspi->list_lock);
651
652	return ret;
653}
654
655static const struct spi_controller_mem_ops ti_qspi_mem_ops = {
656	.exec_op = ti_qspi_exec_mem_op,
657	.adjust_op_size = ti_qspi_adjust_op_size,
658};
659
660static int ti_qspi_start_transfer_one(struct spi_master *master,
661		struct spi_message *m)
662{
663	struct ti_qspi *qspi = spi_master_get_devdata(master);
664	struct spi_device *spi = m->spi;
665	struct spi_transfer *t;
666	int status = 0, ret;
667	unsigned int frame_len_words, transfer_len_words;
668	int wlen;
669
670	/* setup device control reg */
671	qspi->dc = 0;
672
673	if (spi->mode & SPI_CPHA)
674		qspi->dc |= QSPI_CKPHA(spi->chip_select);
675	if (spi->mode & SPI_CPOL)
676		qspi->dc |= QSPI_CKPOL(spi->chip_select);
677	if (spi->mode & SPI_CS_HIGH)
678		qspi->dc |= QSPI_CSPOL(spi->chip_select);
679
680	frame_len_words = 0;
681	list_for_each_entry(t, &m->transfers, transfer_list)
682		frame_len_words += t->len / (t->bits_per_word >> 3);
683	frame_len_words = min_t(unsigned int, frame_len_words, QSPI_FRAME);
684
685	/* setup command reg */
686	qspi->cmd = 0;
687	qspi->cmd |= QSPI_EN_CS(spi->chip_select);
688	qspi->cmd |= QSPI_FLEN(frame_len_words);
 
689
 
690	ti_qspi_write(qspi, qspi->dc, QSPI_SPI_DC_REG);
691
692	mutex_lock(&qspi->list_lock);
693
694	if (qspi->mmap_enabled)
695		ti_qspi_disable_memory_map(spi);
696
697	list_for_each_entry(t, &m->transfers, transfer_list) {
698		qspi->cmd = ((qspi->cmd & ~QSPI_WLEN_MASK) |
699			     QSPI_WLEN(t->bits_per_word));
700
701		wlen = t->bits_per_word >> 3;
702		transfer_len_words = min(t->len / wlen, frame_len_words);
703
704		ret = qspi_transfer_msg(qspi, t, transfer_len_words * wlen);
705		if (ret) {
706			dev_dbg(qspi->dev, "transfer message failed\n");
707			mutex_unlock(&qspi->list_lock);
708			return -EINVAL;
709		}
710
711		m->actual_length += transfer_len_words * wlen;
712		frame_len_words -= transfer_len_words;
713		if (frame_len_words == 0)
714			break;
715	}
716
717	mutex_unlock(&qspi->list_lock);
718
719	ti_qspi_write(qspi, qspi->cmd | QSPI_INVAL, QSPI_SPI_CMD_REG);
720	m->status = status;
721	spi_finalize_current_message(master);
722
 
 
723	return status;
724}
725
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
726static int ti_qspi_runtime_resume(struct device *dev)
727{
728	struct ti_qspi      *qspi;
729
730	qspi = dev_get_drvdata(dev);
731	ti_qspi_restore_ctx(qspi);
732
733	return 0;
734}
735
736static void ti_qspi_dma_cleanup(struct ti_qspi *qspi)
737{
738	if (qspi->rx_bb_addr)
739		dma_free_coherent(qspi->dev, QSPI_DMA_BUFFER_SIZE,
740				  qspi->rx_bb_addr,
741				  qspi->rx_bb_dma_addr);
742
743	if (qspi->rx_chan)
744		dma_release_channel(qspi->rx_chan);
745}
746
747static const struct of_device_id ti_qspi_match[] = {
748	{.compatible = "ti,dra7xxx-qspi" },
749	{.compatible = "ti,am4372-qspi" },
750	{},
751};
752MODULE_DEVICE_TABLE(of, ti_qspi_match);
753
754static int ti_qspi_probe(struct platform_device *pdev)
755{
756	struct  ti_qspi *qspi;
757	struct spi_master *master;
758	struct resource         *r, *res_mmap;
759	struct device_node *np = pdev->dev.of_node;
760	u32 max_freq;
761	int ret = 0, num_cs, irq;
762	dma_cap_mask_t mask;
763
764	master = spi_alloc_master(&pdev->dev, sizeof(*qspi));
765	if (!master)
766		return -ENOMEM;
767
768	master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_RX_DUAL | SPI_RX_QUAD;
769
770	master->flags = SPI_MASTER_HALF_DUPLEX;
771	master->setup = ti_qspi_setup;
772	master->auto_runtime_pm = true;
773	master->transfer_one_message = ti_qspi_start_transfer_one;
774	master->dev.of_node = pdev->dev.of_node;
775	master->bits_per_word_mask = SPI_BPW_MASK(32) | SPI_BPW_MASK(16) |
776				     SPI_BPW_MASK(8);
777	master->mem_ops = &ti_qspi_mem_ops;
778
779	if (!of_property_read_u32(np, "num-cs", &num_cs))
780		master->num_chipselect = num_cs;
781
782	qspi = spi_master_get_devdata(master);
783	qspi->master = master;
784	qspi->dev = &pdev->dev;
785	platform_set_drvdata(pdev, qspi);
786
787	r = platform_get_resource_byname(pdev, IORESOURCE_MEM, "qspi_base");
788	if (r == NULL) {
789		r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
790		if (r == NULL) {
791			dev_err(&pdev->dev, "missing platform data\n");
792			ret = -ENODEV;
793			goto free_master;
794		}
795	}
796
797	res_mmap = platform_get_resource_byname(pdev,
798			IORESOURCE_MEM, "qspi_mmap");
799	if (res_mmap == NULL) {
800		res_mmap = platform_get_resource(pdev, IORESOURCE_MEM, 1);
801		if (res_mmap == NULL) {
802			dev_err(&pdev->dev,
803				"memory mapped resource not required\n");
804		}
805	}
806
807	if (res_mmap)
808		qspi->mmap_size = resource_size(res_mmap);
 
 
 
 
 
 
 
809
810	irq = platform_get_irq(pdev, 0);
811	if (irq < 0) {
812		ret = irq;
813		goto free_master;
814	}
815
816	mutex_init(&qspi->list_lock);
817
818	qspi->base = devm_ioremap_resource(&pdev->dev, r);
819	if (IS_ERR(qspi->base)) {
820		ret = PTR_ERR(qspi->base);
821		goto free_master;
822	}
823
824
825	if (of_property_read_bool(np, "syscon-chipselects")) {
826		qspi->ctrl_base =
827		syscon_regmap_lookup_by_phandle(np,
828						"syscon-chipselects");
829		if (IS_ERR(qspi->ctrl_base)) {
830			ret = PTR_ERR(qspi->ctrl_base);
831			goto free_master;
832		}
833		ret = of_property_read_u32_index(np,
834						 "syscon-chipselects",
835						 1, &qspi->ctrl_reg);
836		if (ret) {
837			dev_err(&pdev->dev,
838				"couldn't get ctrl_mod reg index\n");
839			goto free_master;
840		}
841	}
842
 
 
 
 
 
 
 
 
843	qspi->fclk = devm_clk_get(&pdev->dev, "fck");
844	if (IS_ERR(qspi->fclk)) {
845		ret = PTR_ERR(qspi->fclk);
846		dev_err(&pdev->dev, "could not get clk: %d\n", ret);
847	}
848
 
 
849	pm_runtime_use_autosuspend(&pdev->dev);
850	pm_runtime_set_autosuspend_delay(&pdev->dev, QSPI_AUTOSUSPEND_TIMEOUT);
851	pm_runtime_enable(&pdev->dev);
852
853	if (!of_property_read_u32(np, "spi-max-frequency", &max_freq))
854		qspi->spi_max_frequency = max_freq;
855
856	dma_cap_zero(mask);
857	dma_cap_set(DMA_MEMCPY, mask);
858
859	qspi->rx_chan = dma_request_chan_by_mask(&mask);
860	if (IS_ERR(qspi->rx_chan)) {
861		dev_err(qspi->dev,
862			"No Rx DMA available, trying mmap mode\n");
863		qspi->rx_chan = NULL;
864		ret = 0;
865		goto no_dma;
866	}
867	qspi->rx_bb_addr = dma_alloc_coherent(qspi->dev,
868					      QSPI_DMA_BUFFER_SIZE,
869					      &qspi->rx_bb_dma_addr,
870					      GFP_KERNEL | GFP_DMA);
871	if (!qspi->rx_bb_addr) {
872		dev_err(qspi->dev,
873			"dma_alloc_coherent failed, using PIO mode\n");
874		dma_release_channel(qspi->rx_chan);
875		goto no_dma;
876	}
877	master->dma_rx = qspi->rx_chan;
878	init_completion(&qspi->transfer_complete);
879	if (res_mmap)
880		qspi->mmap_phys_base = (dma_addr_t)res_mmap->start;
881
882no_dma:
883	if (!qspi->rx_chan && res_mmap) {
884		qspi->mmap_base = devm_ioremap_resource(&pdev->dev, res_mmap);
885		if (IS_ERR(qspi->mmap_base)) {
886			dev_info(&pdev->dev,
887				 "mmap failed with error %ld using PIO mode\n",
888				 PTR_ERR(qspi->mmap_base));
889			qspi->mmap_base = NULL;
890			master->mem_ops = NULL;
891		}
892	}
893	qspi->mmap_enabled = false;
894	qspi->current_cs = -1;
895
896	ret = devm_spi_register_master(&pdev->dev, master);
897	if (!ret)
898		return 0;
899
900	ti_qspi_dma_cleanup(qspi);
901
902	pm_runtime_disable(&pdev->dev);
903free_master:
904	spi_master_put(master);
905	return ret;
906}
907
908static int ti_qspi_remove(struct platform_device *pdev)
909{
910	struct ti_qspi *qspi = platform_get_drvdata(pdev);
911	int rc;
912
913	rc = spi_master_suspend(qspi->master);
914	if (rc)
915		return rc;
 
 
916
917	pm_runtime_put_sync(&pdev->dev);
 
 
918	pm_runtime_disable(&pdev->dev);
919
920	ti_qspi_dma_cleanup(qspi);
921
922	return 0;
923}
924
925static const struct dev_pm_ops ti_qspi_pm_ops = {
926	.runtime_resume = ti_qspi_runtime_resume,
927};
928
929static struct platform_driver ti_qspi_driver = {
930	.probe	= ti_qspi_probe,
931	.remove = ti_qspi_remove,
932	.driver = {
933		.name	= "ti-qspi",
 
934		.pm =   &ti_qspi_pm_ops,
935		.of_match_table = ti_qspi_match,
936	}
937};
938
939module_platform_driver(ti_qspi_driver);
940
941MODULE_AUTHOR("Sourav Poddar <sourav.poddar@ti.com>");
942MODULE_LICENSE("GPL v2");
943MODULE_DESCRIPTION("TI QSPI controller driver");
944MODULE_ALIAS("platform:ti-qspi");