blob: 82d2f922ffa0a830883fee3aafff2be4b86c1d50 [file] [log] [blame]
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -08001/*
2 * SuperH HSPI bus driver
3 *
4 * Copyright (C) 2011 Kuninori Morimoto
5 *
6 * Based on spi-sh.c:
7 * Based on pxa2xx_spi.c:
8 * Copyright (C) 2011 Renesas Solutions Corp.
9 * Copyright (C) 2005 Stephen Street / StreetFire Sound Labs
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; version 2 of the License.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 *
24 */
Kuninori Morimoto49e599b82012-03-14 02:48:05 -070025
26#include <linux/clk.h>
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -080027#include <linux/module.h>
28#include <linux/kernel.h>
29#include <linux/timer.h>
30#include <linux/delay.h>
31#include <linux/list.h>
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -080032#include <linux/interrupt.h>
33#include <linux/platform_device.h>
34#include <linux/pm_runtime.h>
35#include <linux/io.h>
36#include <linux/spi/spi.h>
37#include <linux/spi/sh_hspi.h>
38
39#define SPCR 0x00
40#define SPSR 0x04
41#define SPSCR 0x08
42#define SPTBR 0x0C
43#define SPRBR 0x10
44#define SPCR2 0x14
45
46/* SPSR */
47#define RXFL (1 << 2)
48
49#define hspi2info(h) (h->dev->platform_data)
50
51struct hspi_priv {
52 void __iomem *addr;
53 struct spi_master *master;
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -080054 struct device *dev;
Kuninori Morimoto49e599b82012-03-14 02:48:05 -070055 struct clk *clk;
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -080056};
57
58/*
59 * basic function
60 */
61static void hspi_write(struct hspi_priv *hspi, int reg, u32 val)
62{
63 iowrite32(val, hspi->addr + reg);
64}
65
66static u32 hspi_read(struct hspi_priv *hspi, int reg)
67{
68 return ioread32(hspi->addr + reg);
69}
70
Phil Edworthyce329302012-11-22 14:37:27 +000071static void hspi_bit_set(struct hspi_priv *hspi, int reg, u32 mask, u32 set)
72{
73 u32 val = hspi_read(hspi, reg);
74
75 val &= ~mask;
76 val |= set & mask;
77
78 hspi_write(hspi, reg, val);
79}
80
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -080081/*
82 * transfer function
83 */
84static int hspi_status_check_timeout(struct hspi_priv *hspi, u32 mask, u32 val)
85{
86 int t = 256;
87
88 while (t--) {
89 if ((mask & hspi_read(hspi, SPSR)) == val)
90 return 0;
91
Kuninori Morimotobc2bfff2013-05-26 17:59:20 -070092 udelay(10);
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -080093 }
94
95 dev_err(hspi->dev, "timeout\n");
96 return -ETIMEDOUT;
97}
98
Kuninori Morimotoec139b62012-03-14 02:47:40 -070099/*
100 * spi master function
101 */
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700102
Phil Edworthyce329302012-11-22 14:37:27 +0000103#define hspi_hw_cs_enable(hspi) hspi_hw_cs_ctrl(hspi, 0)
104#define hspi_hw_cs_disable(hspi) hspi_hw_cs_ctrl(hspi, 1)
105static void hspi_hw_cs_ctrl(struct hspi_priv *hspi, int hi)
106{
107 hspi_bit_set(hspi, SPSCR, (1 << 6), (hi) << 6);
108}
109
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700110static void hspi_hw_setup(struct hspi_priv *hspi,
111 struct spi_message *msg,
112 struct spi_transfer *t)
113{
114 struct spi_device *spi = msg->spi;
115 struct device *dev = hspi->dev;
116 u32 target_rate;
117 u32 spcr, idiv_clk;
118 u32 rate, best_rate, min, tmp;
119
120 target_rate = t ? t->speed_hz : 0;
121 if (!target_rate)
122 target_rate = spi->max_speed_hz;
123
124 /*
125 * find best IDIV/CLKCx settings
126 */
127 min = ~0;
128 best_rate = 0;
129 spcr = 0;
130 for (idiv_clk = 0x00; idiv_clk <= 0x3F; idiv_clk++) {
131 rate = clk_get_rate(hspi->clk);
132
133 /* IDIV calculation */
134 if (idiv_clk & (1 << 5))
135 rate /= 128;
136 else
137 rate /= 16;
138
139 /* CLKCx calculation */
Jingoo Hana29c8ae2013-10-14 10:35:42 +0900140 rate /= (((idiv_clk & 0x1F) + 1) * 2);
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700141
142 /* save best settings */
143 tmp = abs(target_rate - rate);
144 if (tmp < min) {
145 min = tmp;
146 spcr = idiv_clk;
147 best_rate = rate;
148 }
149 }
150
151 if (spi->mode & SPI_CPHA)
152 spcr |= 1 << 7;
153 if (spi->mode & SPI_CPOL)
154 spcr |= 1 << 6;
155
156 dev_dbg(dev, "speed %d/%d\n", target_rate, best_rate);
157
158 hspi_write(hspi, SPCR, spcr);
159 hspi_write(hspi, SPSR, 0x0);
Phil Edworthyce329302012-11-22 14:37:27 +0000160 hspi_write(hspi, SPSCR, 0x21); /* master mode / CS control */
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700161}
162
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700163static int hspi_transfer_one_message(struct spi_master *master,
164 struct spi_message *msg)
165{
166 struct hspi_priv *hspi = spi_master_get_devdata(master);
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800167 struct spi_transfer *t;
Kuninori Morimotobb9c5682012-03-14 02:48:25 -0700168 u32 tx;
169 u32 rx;
170 int ret, i;
Phil Edworthyce329302012-11-22 14:37:27 +0000171 unsigned int cs_change;
172 const int nsecs = 50;
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800173
174 dev_dbg(hspi->dev, "%s\n", __func__);
175
Phil Edworthyce329302012-11-22 14:37:27 +0000176 cs_change = 1;
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700177 ret = 0;
178 list_for_each_entry(t, &msg->transfers, transfer_list) {
Phil Edworthyce329302012-11-22 14:37:27 +0000179
180 if (cs_change) {
181 hspi_hw_setup(hspi, msg, t);
182 hspi_hw_cs_enable(hspi);
183 ndelay(nsecs);
184 }
185 cs_change = t->cs_change;
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700186
Kuninori Morimotobb9c5682012-03-14 02:48:25 -0700187 for (i = 0; i < t->len; i++) {
188
189 /* wait remains */
190 ret = hspi_status_check_timeout(hspi, 0x1, 0);
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700191 if (ret < 0)
Kuninori Morimotobb9c5682012-03-14 02:48:25 -0700192 break;
193
194 tx = 0;
195 if (t->tx_buf)
196 tx = (u32)((u8 *)t->tx_buf)[i];
197
198 hspi_write(hspi, SPTBR, tx);
199
Geert Uytterhoevenc6c07b42014-01-12 14:03:38 +0100200 /* wait receive */
Kuninori Morimotobb9c5682012-03-14 02:48:25 -0700201 ret = hspi_status_check_timeout(hspi, 0x4, 0x4);
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700202 if (ret < 0)
Kuninori Morimotobb9c5682012-03-14 02:48:25 -0700203 break;
204
205 rx = hspi_read(hspi, SPRBR);
206 if (t->rx_buf)
207 ((u8 *)t->rx_buf)[i] = (u8)rx;
208
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700209 }
Kuninori Morimotobb9c5682012-03-14 02:48:25 -0700210
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700211 msg->actual_length += t->len;
Phil Edworthyce329302012-11-22 14:37:27 +0000212
213 if (t->delay_usecs)
214 udelay(t->delay_usecs);
215
216 if (cs_change) {
217 ndelay(nsecs);
218 hspi_hw_cs_disable(hspi);
219 ndelay(nsecs);
220 }
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700221 }
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700222
223 msg->status = ret;
Phil Edworthyce329302012-11-22 14:37:27 +0000224 if (!cs_change) {
225 ndelay(nsecs);
226 hspi_hw_cs_disable(hspi);
227 }
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700228 spi_finalize_current_message(master);
229
230 return ret;
231}
232
233static int hspi_setup(struct spi_device *spi)
234{
235 struct hspi_priv *hspi = spi_master_get_devdata(spi->master);
236 struct device *dev = hspi->dev;
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700237
238 if (8 != spi->bits_per_word) {
239 dev_err(dev, "bits_per_word should be 8\n");
240 return -EIO;
241 }
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800242
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800243 dev_dbg(dev, "%s setup\n", spi->modalias);
244
245 return 0;
246}
247
248static void hspi_cleanup(struct spi_device *spi)
249{
250 struct hspi_priv *hspi = spi_master_get_devdata(spi->master);
251 struct device *dev = hspi->dev;
252
253 dev_dbg(dev, "%s cleanup\n", spi->modalias);
254}
255
Grant Likelyfd4a3192012-12-07 16:57:14 +0000256static int hspi_probe(struct platform_device *pdev)
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800257{
258 struct resource *res;
259 struct spi_master *master;
260 struct hspi_priv *hspi;
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700261 struct clk *clk;
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800262 int ret;
263
264 /* get base addr */
265 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
266 if (!res) {
267 dev_err(&pdev->dev, "invalid resource\n");
268 return -EINVAL;
269 }
270
271 master = spi_alloc_master(&pdev->dev, sizeof(*hspi));
272 if (!master) {
273 dev_err(&pdev->dev, "spi_alloc_master error.\n");
274 return -ENOMEM;
275 }
276
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700277 clk = clk_get(NULL, "shyway_clk");
Cyril Roelandtd3601e52012-12-12 01:24:54 +0100278 if (IS_ERR(clk)) {
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700279 dev_err(&pdev->dev, "shyway_clk is required\n");
280 ret = -EINVAL;
281 goto error0;
282 }
283
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800284 hspi = spi_master_get_devdata(master);
Jingoo Han24b5a822013-05-23 19:20:40 +0900285 platform_set_drvdata(pdev, hspi);
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800286
287 /* init hspi */
288 hspi->master = master;
289 hspi->dev = &pdev->dev;
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700290 hspi->clk = clk;
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800291 hspi->addr = devm_ioremap(hspi->dev,
292 res->start, resource_size(res));
293 if (!hspi->addr) {
294 dev_err(&pdev->dev, "ioremap error.\n");
295 ret = -ENOMEM;
296 goto error1;
297 }
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800298
Kuninori Morimoto268d7642013-10-03 02:15:50 -0700299 pm_runtime_enable(&pdev->dev);
300
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800301 master->num_chipselect = 1;
302 master->bus_num = pdev->id;
303 master->setup = hspi_setup;
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800304 master->cleanup = hspi_cleanup;
305 master->mode_bits = SPI_CPOL | SPI_CPHA;
Kuninori Morimotoe5f78252013-10-24 21:53:29 -0700306 master->dev.of_node = pdev->dev.of_node;
Mark Brown3e00a092013-07-28 15:35:36 +0100307 master->auto_runtime_pm = true;
Kuninori Morimotoec139b62012-03-14 02:47:40 -0700308 master->transfer_one_message = hspi_transfer_one_message;
Jingoo Han1c43f2a2013-09-24 13:47:59 +0900309 ret = devm_spi_register_master(&pdev->dev, master);
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800310 if (ret < 0) {
311 dev_err(&pdev->dev, "spi_register_master error.\n");
Julia Lawall78bfee02012-09-01 18:33:08 +0200312 goto error1;
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800313 }
314
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800315 return 0;
316
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800317 error1:
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700318 clk_put(clk);
319 error0:
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800320 spi_master_put(master);
321
322 return ret;
323}
324
Grant Likelyfd4a3192012-12-07 16:57:14 +0000325static int hspi_remove(struct platform_device *pdev)
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800326{
Jingoo Han24b5a822013-05-23 19:20:40 +0900327 struct hspi_priv *hspi = platform_get_drvdata(pdev);
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800328
329 pm_runtime_disable(&pdev->dev);
330
Kuninori Morimoto49e599b82012-03-14 02:48:05 -0700331 clk_put(hspi->clk);
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800332
333 return 0;
334}
335
Kuninori Morimotoe5f78252013-10-24 21:53:29 -0700336static struct of_device_id hspi_of_match[] = {
337 { .compatible = "renesas,hspi", },
338 { /* sentinel */ }
339};
340MODULE_DEVICE_TABLE(of, hspi_of_match);
341
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800342static struct platform_driver hspi_driver = {
343 .probe = hspi_probe,
Grant Likelyfd4a3192012-12-07 16:57:14 +0000344 .remove = hspi_remove,
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800345 .driver = {
346 .name = "sh-hspi",
347 .owner = THIS_MODULE,
Kuninori Morimotoe5f78252013-10-24 21:53:29 -0700348 .of_match_table = hspi_of_match,
Kuninori Morimotod1c8bbd2012-03-01 17:10:17 -0800349 },
350};
351module_platform_driver(hspi_driver);
352
353MODULE_DESCRIPTION("SuperH HSPI bus driver");
354MODULE_LICENSE("GPL");
355MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
Axel Lincaedb992014-01-08 18:52:40 +0800356MODULE_ALIAS("platform:sh-hspi");