Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * SuperH HSPI bus driver
4 *
5 * Copyright (C) 2011 Kuninori Morimoto
6 *
7 * Based on spi-sh.c:
8 * Based on pxa2xx_spi.c:
9 * Copyright (C) 2011 Renesas Solutions Corp.
10 * Copyright (C) 2005 Stephen Street / StreetFire Sound Labs
11 */
12
13#include <linux/clk.h>
14#include <linux/module.h>
15#include <linux/kernel.h>
16#include <linux/timer.h>
17#include <linux/delay.h>
18#include <linux/list.h>
19#include <linux/interrupt.h>
20#include <linux/platform_device.h>
21#include <linux/pm_runtime.h>
22#include <linux/io.h>
23#include <linux/spi/spi.h>
24#include <linux/spi/sh_hspi.h>
25
26#define SPCR 0x00
27#define SPSR 0x04
28#define SPSCR 0x08
29#define SPTBR 0x0C
30#define SPRBR 0x10
31#define SPCR2 0x14
32
33/* SPSR */
34#define RXFL (1 << 2)
35
36struct hspi_priv {
37 void __iomem *addr;
38 struct spi_controller *ctlr;
39 struct device *dev;
40 struct clk *clk;
41};
42
43/*
44 * basic function
45 */
46static void hspi_write(struct hspi_priv *hspi, int reg, u32 val)
47{
48 iowrite32(val, hspi->addr + reg);
49}
50
51static u32 hspi_read(struct hspi_priv *hspi, int reg)
52{
53 return ioread32(hspi->addr + reg);
54}
55
56static void hspi_bit_set(struct hspi_priv *hspi, int reg, u32 mask, u32 set)
57{
58 u32 val = hspi_read(hspi, reg);
59
60 val &= ~mask;
61 val |= set & mask;
62
63 hspi_write(hspi, reg, val);
64}
65
66/*
67 * transfer function
68 */
69static int hspi_status_check_timeout(struct hspi_priv *hspi, u32 mask, u32 val)
70{
71 int t = 256;
72
73 while (t--) {
74 if ((mask & hspi_read(hspi, SPSR)) == val)
75 return 0;
76
77 udelay(10);
78 }
79
80 dev_err(hspi->dev, "timeout\n");
81 return -ETIMEDOUT;
82}
83
84/*
85 * spi master function
86 */
87
88#define hspi_hw_cs_enable(hspi) hspi_hw_cs_ctrl(hspi, 0)
89#define hspi_hw_cs_disable(hspi) hspi_hw_cs_ctrl(hspi, 1)
90static void hspi_hw_cs_ctrl(struct hspi_priv *hspi, int hi)
91{
92 hspi_bit_set(hspi, SPSCR, (1 << 6), (hi) << 6);
93}
94
95static void hspi_hw_setup(struct hspi_priv *hspi,
96 struct spi_message *msg,
97 struct spi_transfer *t)
98{
99 struct spi_device *spi = msg->spi;
100 struct device *dev = hspi->dev;
101 u32 spcr, idiv_clk;
102 u32 rate, best_rate, min, tmp;
103
104 /*
105 * find best IDIV/CLKCx settings
106 */
107 min = ~0;
108 best_rate = 0;
109 spcr = 0;
110 for (idiv_clk = 0x00; idiv_clk <= 0x3F; idiv_clk++) {
111 rate = clk_get_rate(hspi->clk);
112
113 /* IDIV calculation */
114 if (idiv_clk & (1 << 5))
115 rate /= 128;
116 else
117 rate /= 16;
118
119 /* CLKCx calculation */
120 rate /= (((idiv_clk & 0x1F) + 1) * 2);
121
122 /* save best settings */
123 tmp = abs(t->speed_hz - rate);
124 if (tmp < min) {
125 min = tmp;
126 spcr = idiv_clk;
127 best_rate = rate;
128 }
129 }
130
131 if (spi->mode & SPI_CPHA)
132 spcr |= 1 << 7;
133 if (spi->mode & SPI_CPOL)
134 spcr |= 1 << 6;
135
136 dev_dbg(dev, "speed %d/%d\n", t->speed_hz, best_rate);
137
138 hspi_write(hspi, SPCR, spcr);
139 hspi_write(hspi, SPSR, 0x0);
140 hspi_write(hspi, SPSCR, 0x21); /* master mode / CS control */
141}
142
143static int hspi_transfer_one_message(struct spi_controller *ctlr,
144 struct spi_message *msg)
145{
146 struct hspi_priv *hspi = spi_controller_get_devdata(ctlr);
147 struct spi_transfer *t;
148 u32 tx;
149 u32 rx;
150 int ret, i;
151 unsigned int cs_change;
152 const int nsecs = 50;
153
154 dev_dbg(hspi->dev, "%s\n", __func__);
155
156 cs_change = 1;
157 ret = 0;
158 list_for_each_entry(t, &msg->transfers, transfer_list) {
159
160 if (cs_change) {
161 hspi_hw_setup(hspi, msg, t);
162 hspi_hw_cs_enable(hspi);
163 ndelay(nsecs);
164 }
165 cs_change = t->cs_change;
166
167 for (i = 0; i < t->len; i++) {
168
169 /* wait remains */
170 ret = hspi_status_check_timeout(hspi, 0x1, 0);
171 if (ret < 0)
172 break;
173
174 tx = 0;
175 if (t->tx_buf)
176 tx = (u32)((u8 *)t->tx_buf)[i];
177
178 hspi_write(hspi, SPTBR, tx);
179
180 /* wait receive */
181 ret = hspi_status_check_timeout(hspi, 0x4, 0x4);
182 if (ret < 0)
183 break;
184
185 rx = hspi_read(hspi, SPRBR);
186 if (t->rx_buf)
187 ((u8 *)t->rx_buf)[i] = (u8)rx;
188
189 }
190
191 msg->actual_length += t->len;
192
193 spi_transfer_delay_exec(t);
194
195 if (cs_change) {
196 ndelay(nsecs);
197 hspi_hw_cs_disable(hspi);
198 ndelay(nsecs);
199 }
200 }
201
202 msg->status = ret;
203 if (!cs_change) {
204 ndelay(nsecs);
205 hspi_hw_cs_disable(hspi);
206 }
207 spi_finalize_current_message(ctlr);
208
209 return ret;
210}
211
212static int hspi_probe(struct platform_device *pdev)
213{
214 struct resource *res;
215 struct spi_controller *ctlr;
216 struct hspi_priv *hspi;
217 struct clk *clk;
218 int ret;
219
220 /* get base addr */
221 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
222 if (!res) {
223 dev_err(&pdev->dev, "invalid resource\n");
224 return -EINVAL;
225 }
226
227 ctlr = spi_alloc_master(&pdev->dev, sizeof(*hspi));
228 if (!ctlr)
229 return -ENOMEM;
230
231 clk = clk_get(&pdev->dev, NULL);
232 if (IS_ERR(clk)) {
233 dev_err(&pdev->dev, "couldn't get clock\n");
234 ret = -EINVAL;
235 goto error0;
236 }
237
238 hspi = spi_controller_get_devdata(ctlr);
239 platform_set_drvdata(pdev, hspi);
240
241 /* init hspi */
242 hspi->ctlr = ctlr;
243 hspi->dev = &pdev->dev;
244 hspi->clk = clk;
245 hspi->addr = devm_ioremap(hspi->dev,
246 res->start, resource_size(res));
247 if (!hspi->addr) {
248 ret = -ENOMEM;
249 goto error1;
250 }
251
252 pm_runtime_enable(&pdev->dev);
253
254 ctlr->bus_num = pdev->id;
255 ctlr->mode_bits = SPI_CPOL | SPI_CPHA;
256 ctlr->dev.of_node = pdev->dev.of_node;
257 ctlr->auto_runtime_pm = true;
258 ctlr->transfer_one_message = hspi_transfer_one_message;
259 ctlr->bits_per_word_mask = SPI_BPW_MASK(8);
260
261 ret = devm_spi_register_controller(&pdev->dev, ctlr);
262 if (ret < 0) {
263 dev_err(&pdev->dev, "devm_spi_register_controller error.\n");
264 goto error2;
265 }
266
267 return 0;
268
269 error2:
270 pm_runtime_disable(&pdev->dev);
271 error1:
272 clk_put(clk);
273 error0:
274 spi_controller_put(ctlr);
275
276 return ret;
277}
278
279static int hspi_remove(struct platform_device *pdev)
280{
281 struct hspi_priv *hspi = platform_get_drvdata(pdev);
282
283 pm_runtime_disable(&pdev->dev);
284
285 clk_put(hspi->clk);
286
287 return 0;
288}
289
290static const struct of_device_id hspi_of_match[] = {
291 { .compatible = "renesas,hspi", },
292 { /* sentinel */ }
293};
294MODULE_DEVICE_TABLE(of, hspi_of_match);
295
296static struct platform_driver hspi_driver = {
297 .probe = hspi_probe,
298 .remove = hspi_remove,
299 .driver = {
300 .name = "sh-hspi",
301 .of_match_table = hspi_of_match,
302 },
303};
304module_platform_driver(hspi_driver);
305
306MODULE_DESCRIPTION("SuperH HSPI bus driver");
307MODULE_LICENSE("GPL v2");
308MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
309MODULE_ALIAS("platform:sh-hspi");
1/*
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 */
25
26#include <linux/clk.h>
27#include <linux/module.h>
28#include <linux/kernel.h>
29#include <linux/timer.h>
30#include <linux/delay.h>
31#include <linux/list.h>
32#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
49struct hspi_priv {
50 void __iomem *addr;
51 struct spi_master *master;
52 struct device *dev;
53 struct clk *clk;
54};
55
56/*
57 * basic function
58 */
59static void hspi_write(struct hspi_priv *hspi, int reg, u32 val)
60{
61 iowrite32(val, hspi->addr + reg);
62}
63
64static u32 hspi_read(struct hspi_priv *hspi, int reg)
65{
66 return ioread32(hspi->addr + reg);
67}
68
69static void hspi_bit_set(struct hspi_priv *hspi, int reg, u32 mask, u32 set)
70{
71 u32 val = hspi_read(hspi, reg);
72
73 val &= ~mask;
74 val |= set & mask;
75
76 hspi_write(hspi, reg, val);
77}
78
79/*
80 * transfer function
81 */
82static int hspi_status_check_timeout(struct hspi_priv *hspi, u32 mask, u32 val)
83{
84 int t = 256;
85
86 while (t--) {
87 if ((mask & hspi_read(hspi, SPSR)) == val)
88 return 0;
89
90 udelay(10);
91 }
92
93 dev_err(hspi->dev, "timeout\n");
94 return -ETIMEDOUT;
95}
96
97/*
98 * spi master function
99 */
100
101#define hspi_hw_cs_enable(hspi) hspi_hw_cs_ctrl(hspi, 0)
102#define hspi_hw_cs_disable(hspi) hspi_hw_cs_ctrl(hspi, 1)
103static void hspi_hw_cs_ctrl(struct hspi_priv *hspi, int hi)
104{
105 hspi_bit_set(hspi, SPSCR, (1 << 6), (hi) << 6);
106}
107
108static void hspi_hw_setup(struct hspi_priv *hspi,
109 struct spi_message *msg,
110 struct spi_transfer *t)
111{
112 struct spi_device *spi = msg->spi;
113 struct device *dev = hspi->dev;
114 u32 spcr, idiv_clk;
115 u32 rate, best_rate, min, tmp;
116
117 /*
118 * find best IDIV/CLKCx settings
119 */
120 min = ~0;
121 best_rate = 0;
122 spcr = 0;
123 for (idiv_clk = 0x00; idiv_clk <= 0x3F; idiv_clk++) {
124 rate = clk_get_rate(hspi->clk);
125
126 /* IDIV calculation */
127 if (idiv_clk & (1 << 5))
128 rate /= 128;
129 else
130 rate /= 16;
131
132 /* CLKCx calculation */
133 rate /= (((idiv_clk & 0x1F) + 1) * 2);
134
135 /* save best settings */
136 tmp = abs(t->speed_hz - rate);
137 if (tmp < min) {
138 min = tmp;
139 spcr = idiv_clk;
140 best_rate = rate;
141 }
142 }
143
144 if (spi->mode & SPI_CPHA)
145 spcr |= 1 << 7;
146 if (spi->mode & SPI_CPOL)
147 spcr |= 1 << 6;
148
149 dev_dbg(dev, "speed %d/%d\n", t->speed_hz, best_rate);
150
151 hspi_write(hspi, SPCR, spcr);
152 hspi_write(hspi, SPSR, 0x0);
153 hspi_write(hspi, SPSCR, 0x21); /* master mode / CS control */
154}
155
156static int hspi_transfer_one_message(struct spi_master *master,
157 struct spi_message *msg)
158{
159 struct hspi_priv *hspi = spi_master_get_devdata(master);
160 struct spi_transfer *t;
161 u32 tx;
162 u32 rx;
163 int ret, i;
164 unsigned int cs_change;
165 const int nsecs = 50;
166
167 dev_dbg(hspi->dev, "%s\n", __func__);
168
169 cs_change = 1;
170 ret = 0;
171 list_for_each_entry(t, &msg->transfers, transfer_list) {
172
173 if (cs_change) {
174 hspi_hw_setup(hspi, msg, t);
175 hspi_hw_cs_enable(hspi);
176 ndelay(nsecs);
177 }
178 cs_change = t->cs_change;
179
180 for (i = 0; i < t->len; i++) {
181
182 /* wait remains */
183 ret = hspi_status_check_timeout(hspi, 0x1, 0);
184 if (ret < 0)
185 break;
186
187 tx = 0;
188 if (t->tx_buf)
189 tx = (u32)((u8 *)t->tx_buf)[i];
190
191 hspi_write(hspi, SPTBR, tx);
192
193 /* wait receive */
194 ret = hspi_status_check_timeout(hspi, 0x4, 0x4);
195 if (ret < 0)
196 break;
197
198 rx = hspi_read(hspi, SPRBR);
199 if (t->rx_buf)
200 ((u8 *)t->rx_buf)[i] = (u8)rx;
201
202 }
203
204 msg->actual_length += t->len;
205
206 if (t->delay_usecs)
207 udelay(t->delay_usecs);
208
209 if (cs_change) {
210 ndelay(nsecs);
211 hspi_hw_cs_disable(hspi);
212 ndelay(nsecs);
213 }
214 }
215
216 msg->status = ret;
217 if (!cs_change) {
218 ndelay(nsecs);
219 hspi_hw_cs_disable(hspi);
220 }
221 spi_finalize_current_message(master);
222
223 return ret;
224}
225
226static int hspi_probe(struct platform_device *pdev)
227{
228 struct resource *res;
229 struct spi_master *master;
230 struct hspi_priv *hspi;
231 struct clk *clk;
232 int ret;
233
234 /* get base addr */
235 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
236 if (!res) {
237 dev_err(&pdev->dev, "invalid resource\n");
238 return -EINVAL;
239 }
240
241 master = spi_alloc_master(&pdev->dev, sizeof(*hspi));
242 if (!master) {
243 dev_err(&pdev->dev, "spi_alloc_master error.\n");
244 return -ENOMEM;
245 }
246
247 clk = clk_get(&pdev->dev, NULL);
248 if (IS_ERR(clk)) {
249 dev_err(&pdev->dev, "couldn't get clock\n");
250 ret = -EINVAL;
251 goto error0;
252 }
253
254 hspi = spi_master_get_devdata(master);
255 platform_set_drvdata(pdev, hspi);
256
257 /* init hspi */
258 hspi->master = master;
259 hspi->dev = &pdev->dev;
260 hspi->clk = clk;
261 hspi->addr = devm_ioremap(hspi->dev,
262 res->start, resource_size(res));
263 if (!hspi->addr) {
264 dev_err(&pdev->dev, "ioremap error.\n");
265 ret = -ENOMEM;
266 goto error1;
267 }
268
269 pm_runtime_enable(&pdev->dev);
270
271 master->bus_num = pdev->id;
272 master->mode_bits = SPI_CPOL | SPI_CPHA;
273 master->dev.of_node = pdev->dev.of_node;
274 master->auto_runtime_pm = true;
275 master->transfer_one_message = hspi_transfer_one_message;
276 master->bits_per_word_mask = SPI_BPW_MASK(8);
277
278 ret = devm_spi_register_master(&pdev->dev, master);
279 if (ret < 0) {
280 dev_err(&pdev->dev, "spi_register_master error.\n");
281 goto error2;
282 }
283
284 return 0;
285
286 error2:
287 pm_runtime_disable(&pdev->dev);
288 error1:
289 clk_put(clk);
290 error0:
291 spi_master_put(master);
292
293 return ret;
294}
295
296static int hspi_remove(struct platform_device *pdev)
297{
298 struct hspi_priv *hspi = platform_get_drvdata(pdev);
299
300 pm_runtime_disable(&pdev->dev);
301
302 clk_put(hspi->clk);
303
304 return 0;
305}
306
307static struct of_device_id hspi_of_match[] = {
308 { .compatible = "renesas,hspi", },
309 { /* sentinel */ }
310};
311MODULE_DEVICE_TABLE(of, hspi_of_match);
312
313static struct platform_driver hspi_driver = {
314 .probe = hspi_probe,
315 .remove = hspi_remove,
316 .driver = {
317 .name = "sh-hspi",
318 .owner = THIS_MODULE,
319 .of_match_table = hspi_of_match,
320 },
321};
322module_platform_driver(hspi_driver);
323
324MODULE_DESCRIPTION("SuperH HSPI bus driver");
325MODULE_LICENSE("GPL");
326MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
327MODULE_ALIAS("platform:sh-hspi");