2 * spi_txx9.c - TXx9 SPI controller driver.
4 * Based on linux/arch/mips/tx4938/toshiba_rbtx4938/spi_txx9.c
5 * Copyright (C) 2000-2001 Toshiba Corporation
7 * 2003-2005 (c) MontaVista Software, Inc. This file is licensed under the
8 * terms of the GNU General Public License version 2. This program is
9 * licensed "as is" without any warranty of any kind, whether express
12 * Support for TX4938 in 2.6 - Manish Lachwani (mlachwani@mvista.com)
14 * Convert to generic SPI framework - Atsushi Nemoto (anemo@mba.ocn.ne.jp)
16 #include <linux/init.h>
17 #include <linux/delay.h>
18 #include <linux/errno.h>
19 #include <linux/interrupt.h>
20 #include <linux/platform_device.h>
21 #include <linux/sched.h>
22 #include <linux/spinlock.h>
23 #include <linux/workqueue.h>
24 #include <linux/spi/spi.h>
25 #include <linux/err.h>
26 #include <linux/clk.h>
31 #define SPI_FIFO_SIZE 4
33 #define TXx9_SPMCR 0x00
34 #define TXx9_SPCR0 0x04
35 #define TXx9_SPCR1 0x08
36 #define TXx9_SPFS 0x0c
37 #define TXx9_SPSR 0x14
38 #define TXx9_SPDR 0x18
40 /* SPMCR : SPI Master Control */
41 #define TXx9_SPMCR_OPMODE 0xc0
42 #define TXx9_SPMCR_CONFIG 0x40
43 #define TXx9_SPMCR_ACTIVE 0x80
44 #define TXx9_SPMCR_SPSTP 0x02
45 #define TXx9_SPMCR_BCLR 0x01
47 /* SPCR0 : SPI Control 0 */
48 #define TXx9_SPCR0_TXIFL_MASK 0xc000
49 #define TXx9_SPCR0_RXIFL_MASK 0x3000
50 #define TXx9_SPCR0_SIDIE 0x0800
51 #define TXx9_SPCR0_SOEIE 0x0400
52 #define TXx9_SPCR0_RBSIE 0x0200
53 #define TXx9_SPCR0_TBSIE 0x0100
54 #define TXx9_SPCR0_IFSPSE 0x0010
55 #define TXx9_SPCR0_SBOS 0x0004
56 #define TXx9_SPCR0_SPHA 0x0002
57 #define TXx9_SPCR0_SPOL 0x0001
59 /* SPSR : SPI Status */
60 #define TXx9_SPSR_TBSI 0x8000
61 #define TXx9_SPSR_RBSI 0x4000
62 #define TXx9_SPSR_TBS_MASK 0x3800
63 #define TXx9_SPSR_RBS_MASK 0x0700
64 #define TXx9_SPSR_SPOE 0x0080
65 #define TXx9_SPSR_IFSD 0x0008
66 #define TXx9_SPSR_SIDLE 0x0004
67 #define TXx9_SPSR_STRDY 0x0002
68 #define TXx9_SPSR_SRRDY 0x0001
72 struct workqueue_struct
*workqueue
;
73 struct work_struct work
;
74 spinlock_t lock
; /* protect 'queue' */
75 struct list_head queue
;
76 wait_queue_head_t waitq
;
77 void __iomem
*membase
;
80 u32 max_speed_hz
, min_speed_hz
;
82 int last_chipselect_val
;
85 static u32
txx9spi_rd(struct txx9spi
*c
, int reg
)
87 return __raw_readl(c
->membase
+ reg
);
89 static void txx9spi_wr(struct txx9spi
*c
, u32 val
, int reg
)
91 __raw_writel(val
, c
->membase
+ reg
);
94 static void txx9spi_cs_func(struct spi_device
*spi
, struct txx9spi
*c
,
95 int on
, unsigned int cs_delay
)
97 int val
= (spi
->mode
& SPI_CS_HIGH
) ? on
: !on
;
99 /* deselect the chip with cs_change hint in last transfer */
100 if (c
->last_chipselect
>= 0)
101 gpio_set_value(c
->last_chipselect
,
102 !c
->last_chipselect_val
);
103 c
->last_chipselect
= spi
->chip_select
;
104 c
->last_chipselect_val
= val
;
106 c
->last_chipselect
= -1;
107 ndelay(cs_delay
); /* CS Hold Time */
109 gpio_set_value(spi
->chip_select
, val
);
110 ndelay(cs_delay
); /* CS Setup Time / CS Recovery Time */
113 /* the spi->mode bits understood by this driver: */
114 #define MODEBITS (SPI_CS_HIGH|SPI_CPOL|SPI_CPHA)
116 static int txx9spi_setup(struct spi_device
*spi
)
118 struct txx9spi
*c
= spi_master_get_devdata(spi
->master
);
121 if (spi
->mode
& ~MODEBITS
)
124 if (!spi
->max_speed_hz
125 || spi
->max_speed_hz
> c
->max_speed_hz
126 || spi
->max_speed_hz
< c
->min_speed_hz
)
129 bits_per_word
= spi
->bits_per_word
? : 8;
130 if (bits_per_word
!= 8 && bits_per_word
!= 16)
133 if (gpio_direction_output(spi
->chip_select
,
134 !(spi
->mode
& SPI_CS_HIGH
))) {
135 dev_err(&spi
->dev
, "Cannot setup GPIO for chipselect.\n");
141 txx9spi_cs_func(spi
, c
, 0, (NSEC_PER_SEC
/ 2) / spi
->max_speed_hz
);
142 spin_unlock(&c
->lock
);
147 static irqreturn_t
txx9spi_interrupt(int irq
, void *dev_id
)
149 struct txx9spi
*c
= dev_id
;
151 /* disable rx intr */
152 txx9spi_wr(c
, txx9spi_rd(c
, TXx9_SPCR0
) & ~TXx9_SPCR0_RBSIE
,
158 static void txx9spi_work_one(struct txx9spi
*c
, struct spi_message
*m
)
160 struct spi_device
*spi
= m
->spi
;
161 struct spi_transfer
*t
;
162 unsigned int cs_delay
;
163 unsigned int cs_change
= 1;
166 u32 prev_speed_hz
= 0;
167 u8 prev_bits_per_word
= 0;
169 /* CS setup/hold/recovery time in nsec */
170 cs_delay
= 100 + (NSEC_PER_SEC
/ 2) / spi
->max_speed_hz
;
172 mcr
= txx9spi_rd(c
, TXx9_SPMCR
);
173 if (unlikely((mcr
& TXx9_SPMCR_OPMODE
) == TXx9_SPMCR_ACTIVE
)) {
174 dev_err(&spi
->dev
, "Bad mode.\n");
178 mcr
&= ~(TXx9_SPMCR_OPMODE
| TXx9_SPMCR_SPSTP
| TXx9_SPMCR_BCLR
);
180 /* enter config mode */
181 txx9spi_wr(c
, mcr
| TXx9_SPMCR_CONFIG
| TXx9_SPMCR_BCLR
, TXx9_SPMCR
);
182 txx9spi_wr(c
, TXx9_SPCR0_SBOS
183 | ((spi
->mode
& SPI_CPOL
) ? TXx9_SPCR0_SPOL
: 0)
184 | ((spi
->mode
& SPI_CPHA
) ? TXx9_SPCR0_SPHA
: 0)
188 list_for_each_entry (t
, &m
->transfers
, transfer_list
) {
189 const void *txbuf
= t
->tx_buf
;
190 void *rxbuf
= t
->rx_buf
;
192 unsigned int len
= t
->len
;
194 u32 speed_hz
= t
->speed_hz
? : spi
->max_speed_hz
;
195 u8 bits_per_word
= t
->bits_per_word
? : spi
->bits_per_word
;
197 bits_per_word
= bits_per_word
? : 8;
198 wsize
= bits_per_word
>> 3; /* in bytes */
200 if (prev_speed_hz
!= speed_hz
201 || prev_bits_per_word
!= bits_per_word
) {
202 u32 n
= (c
->baseclk
+ speed_hz
- 1) / speed_hz
;
207 /* enter config mode */
208 txx9spi_wr(c
, mcr
| TXx9_SPMCR_CONFIG
| TXx9_SPMCR_BCLR
,
210 txx9spi_wr(c
, (n
<< 8) | bits_per_word
, TXx9_SPCR1
);
211 /* enter active mode */
212 txx9spi_wr(c
, mcr
| TXx9_SPMCR_ACTIVE
, TXx9_SPMCR
);
214 prev_speed_hz
= speed_hz
;
215 prev_bits_per_word
= bits_per_word
;
219 txx9spi_cs_func(spi
, c
, 1, cs_delay
);
220 cs_change
= t
->cs_change
;
222 unsigned int count
= SPI_FIFO_SIZE
;
226 if (len
< count
* wsize
)
228 /* now tx must be idle... */
229 while (!(txx9spi_rd(c
, TXx9_SPSR
) & TXx9_SPSR_SIDLE
))
231 cr0
= txx9spi_rd(c
, TXx9_SPCR0
);
232 cr0
&= ~TXx9_SPCR0_RXIFL_MASK
;
233 cr0
|= (count
- 1) << 12;
235 cr0
|= TXx9_SPCR0_RBSIE
;
236 txx9spi_wr(c
, cr0
, TXx9_SPCR0
);
238 for (i
= 0; i
< count
; i
++) {
242 : *(const u16
*)txbuf
;
243 txx9spi_wr(c
, data
, TXx9_SPDR
);
246 txx9spi_wr(c
, 0, TXx9_SPDR
);
248 /* wait all rx data */
250 txx9spi_rd(c
, TXx9_SPSR
) & TXx9_SPSR_RBSI
);
252 for (i
= 0; i
< count
; i
++) {
253 data
= txx9spi_rd(c
, TXx9_SPDR
);
258 *(u16
*)rxbuf
= data
;
262 len
-= count
* wsize
;
264 m
->actual_length
+= t
->len
;
266 udelay(t
->delay_usecs
);
270 if (t
->transfer_list
.next
== &m
->transfers
)
272 /* sometimes a short mid-message deselect of the chip
273 * may be needed to terminate a mode or command
275 txx9spi_cs_func(spi
, c
, 0, cs_delay
);
280 m
->complete(m
->context
);
282 /* normally deactivate chipselect ... unless no error and
283 * cs_change has hinted that the next message will probably
284 * be for this chip too.
286 if (!(status
== 0 && cs_change
))
287 txx9spi_cs_func(spi
, c
, 0, cs_delay
);
289 /* enter config mode */
290 txx9spi_wr(c
, mcr
| TXx9_SPMCR_CONFIG
| TXx9_SPMCR_BCLR
, TXx9_SPMCR
);
293 static void txx9spi_work(struct work_struct
*work
)
295 struct txx9spi
*c
= container_of(work
, struct txx9spi
, work
);
298 spin_lock_irqsave(&c
->lock
, flags
);
299 while (!list_empty(&c
->queue
)) {
300 struct spi_message
*m
;
302 m
= container_of(c
->queue
.next
, struct spi_message
, queue
);
303 list_del_init(&m
->queue
);
304 spin_unlock_irqrestore(&c
->lock
, flags
);
306 txx9spi_work_one(c
, m
);
308 spin_lock_irqsave(&c
->lock
, flags
);
310 spin_unlock_irqrestore(&c
->lock
, flags
);
313 static int txx9spi_transfer(struct spi_device
*spi
, struct spi_message
*m
)
315 struct spi_master
*master
= spi
->master
;
316 struct txx9spi
*c
= spi_master_get_devdata(master
);
317 struct spi_transfer
*t
;
320 m
->actual_length
= 0;
322 /* check each transfer's parameters */
323 list_for_each_entry (t
, &m
->transfers
, transfer_list
) {
324 u32 speed_hz
= t
->speed_hz
? : spi
->max_speed_hz
;
325 u8 bits_per_word
= t
->bits_per_word
? : spi
->bits_per_word
;
327 bits_per_word
= bits_per_word
? : 8;
328 if (!t
->tx_buf
&& !t
->rx_buf
&& t
->len
)
330 if (bits_per_word
!= 8 && bits_per_word
!= 16)
332 if (t
->len
& ((bits_per_word
>> 3) - 1))
334 if (speed_hz
< c
->min_speed_hz
|| speed_hz
> c
->max_speed_hz
)
338 spin_lock_irqsave(&c
->lock
, flags
);
339 list_add_tail(&m
->queue
, &c
->queue
);
340 queue_work(c
->workqueue
, &c
->work
);
341 spin_unlock_irqrestore(&c
->lock
, flags
);
346 static int __init
txx9spi_probe(struct platform_device
*dev
)
348 struct spi_master
*master
;
350 struct resource
*res
;
355 master
= spi_alloc_master(&dev
->dev
, sizeof(*c
));
358 c
= spi_master_get_devdata(master
);
359 platform_set_drvdata(dev
, master
);
361 INIT_WORK(&c
->work
, txx9spi_work
);
362 spin_lock_init(&c
->lock
);
363 INIT_LIST_HEAD(&c
->queue
);
364 init_waitqueue_head(&c
->waitq
);
366 c
->clk
= clk_get(&dev
->dev
, "spi-baseclk");
367 if (IS_ERR(c
->clk
)) {
368 ret
= PTR_ERR(c
->clk
);
372 ret
= clk_enable(c
->clk
);
378 c
->baseclk
= clk_get_rate(c
->clk
);
379 c
->min_speed_hz
= (c
->baseclk
+ 0xff - 1) / 0xff;
380 c
->max_speed_hz
= c
->baseclk
;
382 res
= platform_get_resource(dev
, IORESOURCE_MEM
, 0);
385 if (!devm_request_mem_region(&dev
->dev
,
386 res
->start
, res
->end
- res
->start
+ 1,
389 c
->membase
= devm_ioremap(&dev
->dev
,
390 res
->start
, res
->end
- res
->start
+ 1);
394 /* enter config mode */
395 mcr
= txx9spi_rd(c
, TXx9_SPMCR
);
396 mcr
&= ~(TXx9_SPMCR_OPMODE
| TXx9_SPMCR_SPSTP
| TXx9_SPMCR_BCLR
);
397 txx9spi_wr(c
, mcr
| TXx9_SPMCR_CONFIG
| TXx9_SPMCR_BCLR
, TXx9_SPMCR
);
399 irq
= platform_get_irq(dev
, 0);
402 ret
= devm_request_irq(&dev
->dev
, irq
, txx9spi_interrupt
, 0,
407 c
->workqueue
= create_singlethread_workqueue(
408 dev_name(master
->dev
.parent
));
411 c
->last_chipselect
= -1;
413 dev_info(&dev
->dev
, "at %#llx, irq %d, %dMHz\n",
414 (unsigned long long)res
->start
, irq
,
415 (c
->baseclk
+ 500000) / 1000000);
417 master
->bus_num
= dev
->id
;
418 master
->setup
= txx9spi_setup
;
419 master
->transfer
= txx9spi_transfer
;
420 master
->num_chipselect
= (u16
)UINT_MAX
; /* any GPIO numbers */
422 ret
= spi_register_master(master
);
430 destroy_workqueue(c
->workqueue
);
435 platform_set_drvdata(dev
, NULL
);
436 spi_master_put(master
);
440 static int __exit
txx9spi_remove(struct platform_device
*dev
)
442 struct spi_master
*master
= spi_master_get(platform_get_drvdata(dev
));
443 struct txx9spi
*c
= spi_master_get_devdata(master
);
445 spi_unregister_master(master
);
446 platform_set_drvdata(dev
, NULL
);
447 destroy_workqueue(c
->workqueue
);
450 spi_master_put(master
);
454 /* work with hotplug and coldplug */
455 MODULE_ALIAS("platform:spi_txx9");
457 static struct platform_driver txx9spi_driver
= {
458 .remove
= __exit_p(txx9spi_remove
),
461 .owner
= THIS_MODULE
,
465 static int __init
txx9spi_init(void)
467 return platform_driver_probe(&txx9spi_driver
, txx9spi_probe
);
469 subsys_initcall(txx9spi_init
);
471 static void __exit
txx9spi_exit(void)
473 platform_driver_unregister(&txx9spi_driver
);
475 module_exit(txx9spi_exit
);
477 MODULE_DESCRIPTION("TXx9 SPI Driver");
478 MODULE_LICENSE("GPL");