2 * SPI driver for Nvidia's Tegra20 Serial Flash Controller.
4 * Copyright (c) 2012, NVIDIA CORPORATION. All rights reserved.
6 * Author: Laxman Dewangan <ldewangan@nvidia.com>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms and conditions of the GNU General Public License,
10 * version 2, as published by the Free Software Foundation.
12 * This program is distributed in the hope it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include <linux/clk.h>
22 #include <linux/completion.h>
23 #include <linux/delay.h>
24 #include <linux/err.h>
25 #include <linux/interrupt.h>
27 #include <linux/kernel.h>
28 #include <linux/kthread.h>
29 #include <linux/module.h>
30 #include <linux/platform_device.h>
31 #include <linux/pm_runtime.h>
33 #include <linux/of_device.h>
34 #include <linux/reset.h>
35 #include <linux/spi/spi.h>
37 #define SPI_COMMAND 0x000
38 #define SPI_GO BIT(30)
39 #define SPI_M_S BIT(28)
40 #define SPI_ACTIVE_SCLK_MASK (0x3 << 26)
41 #define SPI_ACTIVE_SCLK_DRIVE_LOW (0 << 26)
42 #define SPI_ACTIVE_SCLK_DRIVE_HIGH (1 << 26)
43 #define SPI_ACTIVE_SCLK_PULL_LOW (2 << 26)
44 #define SPI_ACTIVE_SCLK_PULL_HIGH (3 << 26)
46 #define SPI_CK_SDA_FALLING (1 << 21)
47 #define SPI_CK_SDA_RISING (0 << 21)
48 #define SPI_CK_SDA_MASK (1 << 21)
49 #define SPI_ACTIVE_SDA (0x3 << 18)
50 #define SPI_ACTIVE_SDA_DRIVE_LOW (0 << 18)
51 #define SPI_ACTIVE_SDA_DRIVE_HIGH (1 << 18)
52 #define SPI_ACTIVE_SDA_PULL_LOW (2 << 18)
53 #define SPI_ACTIVE_SDA_PULL_HIGH (3 << 18)
55 #define SPI_CS_POL_INVERT BIT(16)
56 #define SPI_TX_EN BIT(15)
57 #define SPI_RX_EN BIT(14)
58 #define SPI_CS_VAL_HIGH BIT(13)
59 #define SPI_CS_VAL_LOW 0x0
60 #define SPI_CS_SW BIT(12)
62 #define SPI_CS_DELAY_MASK (7 << 9)
63 #define SPI_CS3_EN BIT(8)
64 #define SPI_CS2_EN BIT(7)
65 #define SPI_CS1_EN BIT(6)
66 #define SPI_CS0_EN BIT(5)
68 #define SPI_CS_MASK (SPI_CS3_EN | SPI_CS2_EN | \
69 SPI_CS1_EN | SPI_CS0_EN)
70 #define SPI_BIT_LENGTH(x) (((x) & 0x1f) << 0)
72 #define SPI_MODES (SPI_ACTIVE_SCLK_MASK | SPI_CK_SDA_MASK)
74 #define SPI_STATUS 0x004
75 #define SPI_BSY BIT(31)
76 #define SPI_RDY BIT(30)
77 #define SPI_TXF_FLUSH BIT(29)
78 #define SPI_RXF_FLUSH BIT(28)
79 #define SPI_RX_UNF BIT(27)
80 #define SPI_TX_OVF BIT(26)
81 #define SPI_RXF_EMPTY BIT(25)
82 #define SPI_RXF_FULL BIT(24)
83 #define SPI_TXF_EMPTY BIT(23)
84 #define SPI_TXF_FULL BIT(22)
85 #define SPI_BLK_CNT(count) (((count) & 0xffff) + 1)
87 #define SPI_FIFO_ERROR (SPI_RX_UNF | SPI_TX_OVF)
88 #define SPI_FIFO_EMPTY (SPI_TX_EMPTY | SPI_RX_EMPTY)
90 #define SPI_RX_CMP 0x8
91 #define SPI_DMA_CTL 0x0C
92 #define SPI_DMA_EN BIT(31)
93 #define SPI_IE_RXC BIT(27)
94 #define SPI_IE_TXC BIT(26)
95 #define SPI_PACKED BIT(20)
96 #define SPI_RX_TRIG_MASK (0x3 << 18)
97 #define SPI_RX_TRIG_1W (0x0 << 18)
98 #define SPI_RX_TRIG_4W (0x1 << 18)
99 #define SPI_TX_TRIG_MASK (0x3 << 16)
100 #define SPI_TX_TRIG_1W (0x0 << 16)
101 #define SPI_TX_TRIG_4W (0x1 << 16)
102 #define SPI_DMA_BLK_COUNT(count) (((count) - 1) & 0xFFFF)
104 #define SPI_TX_FIFO 0x10
105 #define SPI_RX_FIFO 0x20
107 #define DATA_DIR_TX (1 << 0)
108 #define DATA_DIR_RX (1 << 1)
110 #define MAX_CHIP_SELECT 4
111 #define SPI_FIFO_DEPTH 4
112 #define SPI_DMA_TIMEOUT (msecs_to_jiffies(1000))
114 struct tegra_sflash_data {
116 struct spi_master *master;
120 struct reset_control *rst;
125 struct spi_device *cur_spi;
128 unsigned bytes_per_word;
129 unsigned cur_direction;
130 unsigned curr_xfer_words;
143 struct completion xfer_completion;
144 struct spi_transfer *curr_xfer;
147 static int tegra_sflash_runtime_suspend(struct device *dev);
148 static int tegra_sflash_runtime_resume(struct device *dev);
150 static inline u32 tegra_sflash_readl(struct tegra_sflash_data *tsd,
153 return readl(tsd->base + reg);
156 static inline void tegra_sflash_writel(struct tegra_sflash_data *tsd,
157 u32 val, unsigned long reg)
159 writel(val, tsd->base + reg);
162 static void tegra_sflash_clear_status(struct tegra_sflash_data *tsd)
164 /* Write 1 to clear status register */
165 tegra_sflash_writel(tsd, SPI_RDY | SPI_FIFO_ERROR, SPI_STATUS);
168 static unsigned tegra_sflash_calculate_curr_xfer_param(
169 struct spi_device *spi, struct tegra_sflash_data *tsd,
170 struct spi_transfer *t)
172 unsigned remain_len = t->len - tsd->cur_pos;
175 tsd->bytes_per_word = DIV_ROUND_UP(t->bits_per_word, 8);
176 max_word = remain_len / tsd->bytes_per_word;
177 if (max_word > SPI_FIFO_DEPTH)
178 max_word = SPI_FIFO_DEPTH;
179 tsd->curr_xfer_words = max_word;
183 static unsigned tegra_sflash_fill_tx_fifo_from_client_txbuf(
184 struct tegra_sflash_data *tsd, struct spi_transfer *t)
188 unsigned max_n_32bit = tsd->curr_xfer_words;
189 u8 *tx_buf = (u8 *)t->tx_buf + tsd->cur_tx_pos;
191 if (max_n_32bit > SPI_FIFO_DEPTH)
192 max_n_32bit = SPI_FIFO_DEPTH;
193 nbytes = max_n_32bit * tsd->bytes_per_word;
195 status = tegra_sflash_readl(tsd, SPI_STATUS);
196 while (!(status & SPI_TXF_FULL)) {
200 for (i = 0; nbytes && (i < tsd->bytes_per_word);
202 x |= (u32)(*tx_buf++) << (i * 8);
203 tegra_sflash_writel(tsd, x, SPI_TX_FIFO);
207 status = tegra_sflash_readl(tsd, SPI_STATUS);
209 tsd->cur_tx_pos += max_n_32bit * tsd->bytes_per_word;
213 static int tegra_sflash_read_rx_fifo_to_client_rxbuf(
214 struct tegra_sflash_data *tsd, struct spi_transfer *t)
217 unsigned int read_words = 0;
218 u8 *rx_buf = (u8 *)t->rx_buf + tsd->cur_rx_pos;
220 status = tegra_sflash_readl(tsd, SPI_STATUS);
221 while (!(status & SPI_RXF_EMPTY)) {
223 u32 x = tegra_sflash_readl(tsd, SPI_RX_FIFO);
225 for (i = 0; (i < tsd->bytes_per_word); i++)
226 *rx_buf++ = (x >> (i*8)) & 0xFF;
228 status = tegra_sflash_readl(tsd, SPI_STATUS);
230 tsd->cur_rx_pos += read_words * tsd->bytes_per_word;
234 static int tegra_sflash_start_cpu_based_transfer(
235 struct tegra_sflash_data *tsd, struct spi_transfer *t)
240 if (tsd->cur_direction & DATA_DIR_TX)
243 if (tsd->cur_direction & DATA_DIR_RX)
246 tegra_sflash_writel(tsd, val, SPI_DMA_CTL);
247 tsd->dma_control_reg = val;
249 if (tsd->cur_direction & DATA_DIR_TX)
250 cur_words = tegra_sflash_fill_tx_fifo_from_client_txbuf(tsd, t);
252 cur_words = tsd->curr_xfer_words;
253 val |= SPI_DMA_BLK_COUNT(cur_words);
254 tegra_sflash_writel(tsd, val, SPI_DMA_CTL);
255 tsd->dma_control_reg = val;
257 tegra_sflash_writel(tsd, val, SPI_DMA_CTL);
261 static int tegra_sflash_start_transfer_one(struct spi_device *spi,
262 struct spi_transfer *t, bool is_first_of_msg,
265 struct tegra_sflash_data *tsd = spi_master_get_devdata(spi->master);
270 if (speed != tsd->cur_speed) {
271 clk_set_rate(tsd->clk, speed);
272 tsd->cur_speed = speed;
280 tegra_sflash_calculate_curr_xfer_param(spi, tsd, t);
281 if (is_first_of_msg) {
282 command = tsd->def_command_reg;
283 command |= SPI_BIT_LENGTH(t->bits_per_word - 1);
284 command |= SPI_CS_VAL_HIGH;
286 command &= ~SPI_MODES;
287 if (spi->mode & SPI_CPHA)
288 command |= SPI_CK_SDA_FALLING;
290 if (spi->mode & SPI_CPOL)
291 command |= SPI_ACTIVE_SCLK_DRIVE_HIGH;
293 command |= SPI_ACTIVE_SCLK_DRIVE_LOW;
294 command |= SPI_CS0_EN << spi->chip_select;
296 command = tsd->command_reg;
297 command &= ~SPI_BIT_LENGTH(~0);
298 command |= SPI_BIT_LENGTH(t->bits_per_word - 1);
299 command &= ~(SPI_RX_EN | SPI_TX_EN);
302 tsd->cur_direction = 0;
304 command |= SPI_RX_EN;
305 tsd->cur_direction |= DATA_DIR_RX;
308 command |= SPI_TX_EN;
309 tsd->cur_direction |= DATA_DIR_TX;
311 tegra_sflash_writel(tsd, command, SPI_COMMAND);
312 tsd->command_reg = command;
314 return tegra_sflash_start_cpu_based_transfer(tsd, t);
317 static int tegra_sflash_transfer_one_message(struct spi_master *master,
318 struct spi_message *msg)
320 bool is_first_msg = true;
322 struct tegra_sflash_data *tsd = spi_master_get_devdata(master);
323 struct spi_transfer *xfer;
324 struct spi_device *spi = msg->spi;
328 msg->actual_length = 0;
329 single_xfer = list_is_singular(&msg->transfers);
330 list_for_each_entry(xfer, &msg->transfers, transfer_list) {
331 reinit_completion(&tsd->xfer_completion);
332 ret = tegra_sflash_start_transfer_one(spi, xfer,
333 is_first_msg, single_xfer);
336 "spi can not start transfer, err %d\n", ret);
339 is_first_msg = false;
340 ret = wait_for_completion_timeout(&tsd->xfer_completion,
342 if (WARN_ON(ret == 0)) {
344 "spi transfer timeout, err %d\n", ret);
349 if (tsd->tx_status || tsd->rx_status) {
350 dev_err(tsd->dev, "Error in Transfer\n");
354 msg->actual_length += xfer->len;
355 if (xfer->cs_change && xfer->delay_usecs) {
356 tegra_sflash_writel(tsd, tsd->def_command_reg,
358 udelay(xfer->delay_usecs);
363 tegra_sflash_writel(tsd, tsd->def_command_reg, SPI_COMMAND);
365 spi_finalize_current_message(master);
369 static irqreturn_t handle_cpu_based_xfer(struct tegra_sflash_data *tsd)
371 struct spi_transfer *t = tsd->curr_xfer;
374 spin_lock_irqsave(&tsd->lock, flags);
375 if (tsd->tx_status || tsd->rx_status || (tsd->status_reg & SPI_BSY)) {
377 "CpuXfer ERROR bit set 0x%x\n", tsd->status_reg);
379 "CpuXfer 0x%08x:0x%08x\n", tsd->command_reg,
380 tsd->dma_control_reg);
381 reset_control_assert(tsd->rst);
383 reset_control_deassert(tsd->rst);
384 complete(&tsd->xfer_completion);
388 if (tsd->cur_direction & DATA_DIR_RX)
389 tegra_sflash_read_rx_fifo_to_client_rxbuf(tsd, t);
391 if (tsd->cur_direction & DATA_DIR_TX)
392 tsd->cur_pos = tsd->cur_tx_pos;
394 tsd->cur_pos = tsd->cur_rx_pos;
396 if (tsd->cur_pos == t->len) {
397 complete(&tsd->xfer_completion);
401 tegra_sflash_calculate_curr_xfer_param(tsd->cur_spi, tsd, t);
402 tegra_sflash_start_cpu_based_transfer(tsd, t);
404 spin_unlock_irqrestore(&tsd->lock, flags);
408 static irqreturn_t tegra_sflash_isr(int irq, void *context_data)
410 struct tegra_sflash_data *tsd = context_data;
412 tsd->status_reg = tegra_sflash_readl(tsd, SPI_STATUS);
413 if (tsd->cur_direction & DATA_DIR_TX)
414 tsd->tx_status = tsd->status_reg & SPI_TX_OVF;
416 if (tsd->cur_direction & DATA_DIR_RX)
417 tsd->rx_status = tsd->status_reg & SPI_RX_UNF;
418 tegra_sflash_clear_status(tsd);
420 return handle_cpu_based_xfer(tsd);
423 static const struct of_device_id tegra_sflash_of_match[] = {
424 { .compatible = "nvidia,tegra20-sflash", },
427 MODULE_DEVICE_TABLE(of, tegra_sflash_of_match);
429 static int tegra_sflash_probe(struct platform_device *pdev)
431 struct spi_master *master;
432 struct tegra_sflash_data *tsd;
435 const struct of_device_id *match;
437 match = of_match_device(tegra_sflash_of_match, &pdev->dev);
439 dev_err(&pdev->dev, "Error: No device match found\n");
443 master = spi_alloc_master(&pdev->dev, sizeof(*tsd));
445 dev_err(&pdev->dev, "master allocation failed\n");
449 /* the spi->mode bits understood by this driver: */
450 master->mode_bits = SPI_CPOL | SPI_CPHA;
451 master->transfer_one_message = tegra_sflash_transfer_one_message;
452 master->auto_runtime_pm = true;
453 master->num_chipselect = MAX_CHIP_SELECT;
455 platform_set_drvdata(pdev, master);
456 tsd = spi_master_get_devdata(master);
457 tsd->master = master;
458 tsd->dev = &pdev->dev;
459 spin_lock_init(&tsd->lock);
461 if (of_property_read_u32(tsd->dev->of_node, "spi-max-frequency",
462 &master->max_speed_hz))
463 master->max_speed_hz = 25000000; /* 25MHz */
465 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
466 tsd->base = devm_ioremap_resource(&pdev->dev, r);
467 if (IS_ERR(tsd->base)) {
468 ret = PTR_ERR(tsd->base);
469 goto exit_free_master;
472 tsd->irq = platform_get_irq(pdev, 0);
473 ret = request_irq(tsd->irq, tegra_sflash_isr, 0,
474 dev_name(&pdev->dev), tsd);
476 dev_err(&pdev->dev, "Failed to register ISR for IRQ %d\n",
478 goto exit_free_master;
481 tsd->clk = devm_clk_get(&pdev->dev, NULL);
482 if (IS_ERR(tsd->clk)) {
483 dev_err(&pdev->dev, "can not get clock\n");
484 ret = PTR_ERR(tsd->clk);
488 tsd->rst = devm_reset_control_get_exclusive(&pdev->dev, "spi");
489 if (IS_ERR(tsd->rst)) {
490 dev_err(&pdev->dev, "can not get reset\n");
491 ret = PTR_ERR(tsd->rst);
495 init_completion(&tsd->xfer_completion);
496 pm_runtime_enable(&pdev->dev);
497 if (!pm_runtime_enabled(&pdev->dev)) {
498 ret = tegra_sflash_runtime_resume(&pdev->dev);
500 goto exit_pm_disable;
503 ret = pm_runtime_get_sync(&pdev->dev);
505 dev_err(&pdev->dev, "pm runtime get failed, e = %d\n", ret);
506 goto exit_pm_disable;
509 /* Reset controller */
510 reset_control_assert(tsd->rst);
512 reset_control_deassert(tsd->rst);
514 tsd->def_command_reg = SPI_M_S | SPI_CS_SW;
515 tegra_sflash_writel(tsd, tsd->def_command_reg, SPI_COMMAND);
516 pm_runtime_put(&pdev->dev);
518 master->dev.of_node = pdev->dev.of_node;
519 ret = devm_spi_register_master(&pdev->dev, master);
521 dev_err(&pdev->dev, "can not register to master err %d\n", ret);
522 goto exit_pm_disable;
527 pm_runtime_disable(&pdev->dev);
528 if (!pm_runtime_status_suspended(&pdev->dev))
529 tegra_sflash_runtime_suspend(&pdev->dev);
531 free_irq(tsd->irq, tsd);
533 spi_master_put(master);
537 static int tegra_sflash_remove(struct platform_device *pdev)
539 struct spi_master *master = platform_get_drvdata(pdev);
540 struct tegra_sflash_data *tsd = spi_master_get_devdata(master);
542 free_irq(tsd->irq, tsd);
544 pm_runtime_disable(&pdev->dev);
545 if (!pm_runtime_status_suspended(&pdev->dev))
546 tegra_sflash_runtime_suspend(&pdev->dev);
551 #ifdef CONFIG_PM_SLEEP
552 static int tegra_sflash_suspend(struct device *dev)
554 struct spi_master *master = dev_get_drvdata(dev);
556 return spi_master_suspend(master);
559 static int tegra_sflash_resume(struct device *dev)
561 struct spi_master *master = dev_get_drvdata(dev);
562 struct tegra_sflash_data *tsd = spi_master_get_devdata(master);
565 ret = pm_runtime_get_sync(dev);
567 dev_err(dev, "pm runtime failed, e = %d\n", ret);
570 tegra_sflash_writel(tsd, tsd->command_reg, SPI_COMMAND);
573 return spi_master_resume(master);
577 static int tegra_sflash_runtime_suspend(struct device *dev)
579 struct spi_master *master = dev_get_drvdata(dev);
580 struct tegra_sflash_data *tsd = spi_master_get_devdata(master);
582 /* Flush all write which are in PPSB queue by reading back */
583 tegra_sflash_readl(tsd, SPI_COMMAND);
585 clk_disable_unprepare(tsd->clk);
589 static int tegra_sflash_runtime_resume(struct device *dev)
591 struct spi_master *master = dev_get_drvdata(dev);
592 struct tegra_sflash_data *tsd = spi_master_get_devdata(master);
595 ret = clk_prepare_enable(tsd->clk);
597 dev_err(tsd->dev, "clk_prepare failed: %d\n", ret);
603 static const struct dev_pm_ops slink_pm_ops = {
604 SET_RUNTIME_PM_OPS(tegra_sflash_runtime_suspend,
605 tegra_sflash_runtime_resume, NULL)
606 SET_SYSTEM_SLEEP_PM_OPS(tegra_sflash_suspend, tegra_sflash_resume)
608 static struct platform_driver tegra_sflash_driver = {
610 .name = "spi-tegra-sflash",
612 .of_match_table = tegra_sflash_of_match,
614 .probe = tegra_sflash_probe,
615 .remove = tegra_sflash_remove,
617 module_platform_driver(tegra_sflash_driver);
619 MODULE_ALIAS("platform:spi-tegra-sflash");
620 MODULE_DESCRIPTION("NVIDIA Tegra20 Serial Flash Controller Driver");
621 MODULE_AUTHOR("Laxman Dewangan <ldewangan@nvidia.com>");
622 MODULE_LICENSE("GPL v2");