4 * Copyright (C) 2011 Renesas Solutions Corp.
6 * Based on pxa2xx_spi.c:
7 * Copyright (C) 2005 Stephen Street / StreetFire Sound Labs
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; version 2 of the License.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/sched.h>
27 #include <linux/errno.h>
28 #include <linux/timer.h>
29 #include <linux/delay.h>
30 #include <linux/list.h>
31 #include <linux/workqueue.h>
32 #include <linux/interrupt.h>
33 #include <linux/platform_device.h>
35 #include <linux/spi/spi.h>
37 #define SPI_SH_TBR 0x00
38 #define SPI_SH_RBR 0x00
39 #define SPI_SH_CR1 0x08
40 #define SPI_SH_CR2 0x10
41 #define SPI_SH_CR3 0x18
42 #define SPI_SH_CR4 0x20
43 #define SPI_SH_CR5 0x28
46 #define SPI_SH_TBE 0x80
47 #define SPI_SH_TBF 0x40
48 #define SPI_SH_RBE 0x20
49 #define SPI_SH_RBF 0x10
50 #define SPI_SH_PFONRD 0x08
51 #define SPI_SH_SSDB 0x04
52 #define SPI_SH_SSD 0x02
53 #define SPI_SH_SSA 0x01
56 #define SPI_SH_RSTF 0x80
57 #define SPI_SH_LOOPBK 0x40
58 #define SPI_SH_CPOL 0x20
59 #define SPI_SH_CPHA 0x10
60 #define SPI_SH_L1M0 0x08
63 #define SPI_SH_MAX_BYTE 0xFF
66 #define SPI_SH_TBEI 0x80
67 #define SPI_SH_TBFI 0x40
68 #define SPI_SH_RBEI 0x20
69 #define SPI_SH_RBFI 0x10
70 #define SPI_SH_WPABRT 0x04
71 #define SPI_SH_SSS 0x01
74 #define SPI_SH_P1L0 0x80
75 #define SPI_SH_PP1L0 0x40
76 #define SPI_SH_MUXI 0x20
77 #define SPI_SH_MUXIRQ 0x10
79 #define SPI_SH_FIFO_SIZE 32
80 #define SPI_SH_SEND_TIMEOUT (3 * HZ)
81 #define SPI_SH_RECEIVE_TIMEOUT (HZ >> 3)
88 struct spi_master
*master
;
89 struct list_head queue
;
90 struct workqueue_struct
*workqueue
;
91 struct work_struct ws
;
93 wait_queue_head_t wait
;
98 static void spi_sh_write(struct spi_sh_data
*ss
, unsigned long data
,
102 iowrite8(data
, ss
->addr
+ (offset
>> 2));
103 else if (ss
->width
== 32)
104 iowrite32(data
, ss
->addr
+ offset
);
107 static unsigned long spi_sh_read(struct spi_sh_data
*ss
, unsigned long offset
)
110 return ioread8(ss
->addr
+ (offset
>> 2));
111 else if (ss
->width
== 32)
112 return ioread32(ss
->addr
+ offset
);
117 static void spi_sh_set_bit(struct spi_sh_data
*ss
, unsigned long val
,
118 unsigned long offset
)
122 tmp
= spi_sh_read(ss
, offset
);
124 spi_sh_write(ss
, tmp
, offset
);
127 static void spi_sh_clear_bit(struct spi_sh_data
*ss
, unsigned long val
,
128 unsigned long offset
)
132 tmp
= spi_sh_read(ss
, offset
);
134 spi_sh_write(ss
, tmp
, offset
);
137 static void clear_fifo(struct spi_sh_data
*ss
)
139 spi_sh_set_bit(ss
, SPI_SH_RSTF
, SPI_SH_CR2
);
140 spi_sh_clear_bit(ss
, SPI_SH_RSTF
, SPI_SH_CR2
);
143 static int spi_sh_wait_receive_buffer(struct spi_sh_data
*ss
)
145 int timeout
= 100000;
147 while (spi_sh_read(ss
, SPI_SH_CR1
) & SPI_SH_RBE
) {
155 static int spi_sh_wait_write_buffer_empty(struct spi_sh_data
*ss
)
157 int timeout
= 100000;
159 while (!(spi_sh_read(ss
, SPI_SH_CR1
) & SPI_SH_TBE
)) {
167 static int spi_sh_send(struct spi_sh_data
*ss
, struct spi_message
*mesg
,
168 struct spi_transfer
*t
)
177 spi_sh_set_bit(ss
, SPI_SH_SSA
, SPI_SH_CR1
);
179 data
= (unsigned char *)t
->tx_buf
;
181 cur_len
= min(SPI_SH_FIFO_SIZE
, remain
);
182 for (i
= 0; i
< cur_len
&&
183 !(spi_sh_read(ss
, SPI_SH_CR4
) &
185 !(spi_sh_read(ss
, SPI_SH_CR1
) & SPI_SH_TBF
);
187 spi_sh_write(ss
, (unsigned long)data
[i
], SPI_SH_TBR
);
189 if (spi_sh_read(ss
, SPI_SH_CR4
) & SPI_SH_WPABRT
) {
190 /* Abort SPI operation */
191 spi_sh_set_bit(ss
, SPI_SH_WPABRT
, SPI_SH_CR4
);
202 ss
->cr1
&= ~SPI_SH_TBE
;
203 spi_sh_set_bit(ss
, SPI_SH_TBE
, SPI_SH_CR4
);
204 ret
= wait_event_interruptible_timeout(ss
->wait
,
205 ss
->cr1
& SPI_SH_TBE
,
206 SPI_SH_SEND_TIMEOUT
);
207 if (ret
== 0 && !(ss
->cr1
& SPI_SH_TBE
)) {
208 printk(KERN_ERR
"%s: timeout\n", __func__
);
214 if (list_is_last(&t
->transfer_list
, &mesg
->transfers
)) {
215 spi_sh_clear_bit(ss
, SPI_SH_SSD
| SPI_SH_SSDB
, SPI_SH_CR1
);
216 spi_sh_set_bit(ss
, SPI_SH_SSA
, SPI_SH_CR1
);
218 ss
->cr1
&= ~SPI_SH_TBE
;
219 spi_sh_set_bit(ss
, SPI_SH_TBE
, SPI_SH_CR4
);
220 ret
= wait_event_interruptible_timeout(ss
->wait
,
221 ss
->cr1
& SPI_SH_TBE
,
222 SPI_SH_SEND_TIMEOUT
);
223 if (ret
== 0 && (ss
->cr1
& SPI_SH_TBE
)) {
224 printk(KERN_ERR
"%s: timeout\n", __func__
);
232 static int spi_sh_receive(struct spi_sh_data
*ss
, struct spi_message
*mesg
,
233 struct spi_transfer
*t
)
241 if (t
->len
> SPI_SH_MAX_BYTE
)
242 spi_sh_write(ss
, SPI_SH_MAX_BYTE
, SPI_SH_CR3
);
244 spi_sh_write(ss
, t
->len
, SPI_SH_CR3
);
246 spi_sh_clear_bit(ss
, SPI_SH_SSD
| SPI_SH_SSDB
, SPI_SH_CR1
);
247 spi_sh_set_bit(ss
, SPI_SH_SSA
, SPI_SH_CR1
);
249 spi_sh_wait_write_buffer_empty(ss
);
251 data
= (unsigned char *)t
->rx_buf
;
253 if (remain
>= SPI_SH_FIFO_SIZE
) {
254 ss
->cr1
&= ~SPI_SH_RBF
;
255 spi_sh_set_bit(ss
, SPI_SH_RBF
, SPI_SH_CR4
);
256 ret
= wait_event_interruptible_timeout(ss
->wait
,
257 ss
->cr1
& SPI_SH_RBF
,
258 SPI_SH_RECEIVE_TIMEOUT
);
260 spi_sh_read(ss
, SPI_SH_CR1
) & SPI_SH_RBE
) {
261 printk(KERN_ERR
"%s: timeout\n", __func__
);
266 cur_len
= min(SPI_SH_FIFO_SIZE
, remain
);
267 for (i
= 0; i
< cur_len
; i
++) {
268 if (spi_sh_wait_receive_buffer(ss
))
270 data
[i
] = (unsigned char)spi_sh_read(ss
, SPI_SH_RBR
);
277 /* deassert CS when SPI is receiving. */
278 if (t
->len
> SPI_SH_MAX_BYTE
) {
280 spi_sh_write(ss
, 1, SPI_SH_CR3
);
282 spi_sh_write(ss
, 0, SPI_SH_CR3
);
288 static void spi_sh_work(struct work_struct
*work
)
290 struct spi_sh_data
*ss
= container_of(work
, struct spi_sh_data
, ws
);
291 struct spi_message
*mesg
;
292 struct spi_transfer
*t
;
296 pr_debug("%s: enter\n", __func__
);
298 spin_lock_irqsave(&ss
->lock
, flags
);
299 while (!list_empty(&ss
->queue
)) {
300 mesg
= list_entry(ss
->queue
.next
, struct spi_message
, queue
);
301 list_del_init(&mesg
->queue
);
303 spin_unlock_irqrestore(&ss
->lock
, flags
);
304 list_for_each_entry(t
, &mesg
->transfers
, transfer_list
) {
305 pr_debug("tx_buf = %p, rx_buf = %p\n",
306 t
->tx_buf
, t
->rx_buf
);
307 pr_debug("len = %d, delay_usecs = %d\n",
308 t
->len
, t
->delay_usecs
);
311 ret
= spi_sh_send(ss
, mesg
, t
);
316 ret
= spi_sh_receive(ss
, mesg
, t
);
320 mesg
->actual_length
+= t
->len
;
322 spin_lock_irqsave(&ss
->lock
, flags
);
326 mesg
->complete(mesg
->context
);
330 spi_sh_set_bit(ss
, SPI_SH_SSD
, SPI_SH_CR1
);
333 spi_sh_clear_bit(ss
, SPI_SH_SSA
| SPI_SH_SSDB
| SPI_SH_SSD
,
338 spin_unlock_irqrestore(&ss
->lock
, flags
);
345 mesg
->complete(mesg
->context
);
347 spi_sh_clear_bit(ss
, SPI_SH_SSA
| SPI_SH_SSDB
| SPI_SH_SSD
,
353 static int spi_sh_setup(struct spi_device
*spi
)
355 struct spi_sh_data
*ss
= spi_master_get_devdata(spi
->master
);
357 pr_debug("%s: enter\n", __func__
);
359 spi_sh_write(ss
, 0xfe, SPI_SH_CR1
); /* SPI sycle stop */
360 spi_sh_write(ss
, 0x00, SPI_SH_CR1
); /* CR1 init */
361 spi_sh_write(ss
, 0x00, SPI_SH_CR3
); /* CR3 init */
366 spi_sh_write(ss
, spi_sh_read(ss
, SPI_SH_CR2
) | 0x07, SPI_SH_CR2
);
372 static int spi_sh_transfer(struct spi_device
*spi
, struct spi_message
*mesg
)
374 struct spi_sh_data
*ss
= spi_master_get_devdata(spi
->master
);
377 pr_debug("%s: enter\n", __func__
);
378 pr_debug("\tmode = %02x\n", spi
->mode
);
380 spin_lock_irqsave(&ss
->lock
, flags
);
382 mesg
->actual_length
= 0;
383 mesg
->status
= -EINPROGRESS
;
385 spi_sh_clear_bit(ss
, SPI_SH_SSA
, SPI_SH_CR1
);
387 list_add_tail(&mesg
->queue
, &ss
->queue
);
388 queue_work(ss
->workqueue
, &ss
->ws
);
390 spin_unlock_irqrestore(&ss
->lock
, flags
);
395 static void spi_sh_cleanup(struct spi_device
*spi
)
397 struct spi_sh_data
*ss
= spi_master_get_devdata(spi
->master
);
399 pr_debug("%s: enter\n", __func__
);
401 spi_sh_clear_bit(ss
, SPI_SH_SSA
| SPI_SH_SSDB
| SPI_SH_SSD
,
405 static irqreturn_t
spi_sh_irq(int irq
, void *_ss
)
407 struct spi_sh_data
*ss
= (struct spi_sh_data
*)_ss
;
410 cr1
= spi_sh_read(ss
, SPI_SH_CR1
);
411 if (cr1
& SPI_SH_TBE
)
412 ss
->cr1
|= SPI_SH_TBE
;
413 if (cr1
& SPI_SH_TBF
)
414 ss
->cr1
|= SPI_SH_TBF
;
415 if (cr1
& SPI_SH_RBE
)
416 ss
->cr1
|= SPI_SH_RBE
;
417 if (cr1
& SPI_SH_RBF
)
418 ss
->cr1
|= SPI_SH_RBF
;
421 spi_sh_clear_bit(ss
, ss
->cr1
, SPI_SH_CR4
);
428 static int spi_sh_remove(struct platform_device
*pdev
)
430 struct spi_sh_data
*ss
= platform_get_drvdata(pdev
);
432 spi_unregister_master(ss
->master
);
433 destroy_workqueue(ss
->workqueue
);
434 free_irq(ss
->irq
, ss
);
440 static int spi_sh_probe(struct platform_device
*pdev
)
442 struct resource
*res
;
443 struct spi_master
*master
;
444 struct spi_sh_data
*ss
;
448 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
449 if (unlikely(res
== NULL
)) {
450 dev_err(&pdev
->dev
, "invalid resource\n");
454 irq
= platform_get_irq(pdev
, 0);
456 dev_err(&pdev
->dev
, "platform_get_irq error\n");
460 master
= spi_alloc_master(&pdev
->dev
, sizeof(struct spi_sh_data
));
461 if (master
== NULL
) {
462 dev_err(&pdev
->dev
, "spi_alloc_master error.\n");
466 ss
= spi_master_get_devdata(master
);
467 platform_set_drvdata(pdev
, ss
);
469 switch (res
->flags
& IORESOURCE_MEM_TYPE_MASK
) {
470 case IORESOURCE_MEM_8BIT
:
473 case IORESOURCE_MEM_32BIT
:
477 dev_err(&pdev
->dev
, "No support width\n");
483 ss
->addr
= ioremap(res
->start
, resource_size(res
));
484 if (ss
->addr
== NULL
) {
485 dev_err(&pdev
->dev
, "ioremap error.\n");
489 INIT_LIST_HEAD(&ss
->queue
);
490 spin_lock_init(&ss
->lock
);
491 INIT_WORK(&ss
->ws
, spi_sh_work
);
492 init_waitqueue_head(&ss
->wait
);
493 ss
->workqueue
= create_singlethread_workqueue(
494 dev_name(master
->dev
.parent
));
495 if (ss
->workqueue
== NULL
) {
496 dev_err(&pdev
->dev
, "create workqueue error\n");
501 ret
= request_irq(irq
, spi_sh_irq
, 0, "spi_sh", ss
);
503 dev_err(&pdev
->dev
, "request_irq error\n");
507 master
->num_chipselect
= 2;
508 master
->bus_num
= pdev
->id
;
509 master
->setup
= spi_sh_setup
;
510 master
->transfer
= spi_sh_transfer
;
511 master
->cleanup
= spi_sh_cleanup
;
513 ret
= spi_register_master(master
);
515 printk(KERN_ERR
"spi_register_master error.\n");
524 destroy_workqueue(ss
->workqueue
);
528 spi_master_put(master
);
533 static struct platform_driver spi_sh_driver
= {
534 .probe
= spi_sh_probe
,
535 .remove
= spi_sh_remove
,
538 .owner
= THIS_MODULE
,
541 module_platform_driver(spi_sh_driver
);
543 MODULE_DESCRIPTION("SH SPI bus driver");
544 MODULE_LICENSE("GPL");
545 MODULE_AUTHOR("Yoshihiro Shimoda");
546 MODULE_ALIAS("platform:sh_spi");