spi: move common spi_setup() functionality into core
[linux-2.6.git] / drivers / spi / xilinx_spi.c
1 /*
2  * xilinx_spi.c
3  *
4  * Xilinx SPI controller driver (master mode only)
5  *
6  * Author: MontaVista Software, Inc.
7  *      source@mvista.com
8  *
9  * 2002-2007 (c) MontaVista Software, Inc.  This file is licensed under the
10  * terms of the GNU General Public License version 2.  This program is licensed
11  * "as is" without any warranty of any kind, whether express or implied.
12  */
13
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/interrupt.h>
17 #include <linux/platform_device.h>
18
19 #include <linux/of_platform.h>
20 #include <linux/of_device.h>
21 #include <linux/of_spi.h>
22
23 #include <linux/spi/spi.h>
24 #include <linux/spi/spi_bitbang.h>
25 #include <linux/io.h>
26
27 #define XILINX_SPI_NAME "xilinx_spi"
28
29 /* Register definitions as per "OPB Serial Peripheral Interface (SPI) (v1.00e)
30  * Product Specification", DS464
31  */
32 #define XSPI_CR_OFFSET          0x62    /* 16-bit Control Register */
33
34 #define XSPI_CR_ENABLE          0x02
35 #define XSPI_CR_MASTER_MODE     0x04
36 #define XSPI_CR_CPOL            0x08
37 #define XSPI_CR_CPHA            0x10
38 #define XSPI_CR_MODE_MASK       (XSPI_CR_CPHA | XSPI_CR_CPOL)
39 #define XSPI_CR_TXFIFO_RESET    0x20
40 #define XSPI_CR_RXFIFO_RESET    0x40
41 #define XSPI_CR_MANUAL_SSELECT  0x80
42 #define XSPI_CR_TRANS_INHIBIT   0x100
43
44 #define XSPI_SR_OFFSET          0x67    /* 8-bit Status Register */
45
46 #define XSPI_SR_RX_EMPTY_MASK   0x01    /* Receive FIFO is empty */
47 #define XSPI_SR_RX_FULL_MASK    0x02    /* Receive FIFO is full */
48 #define XSPI_SR_TX_EMPTY_MASK   0x04    /* Transmit FIFO is empty */
49 #define XSPI_SR_TX_FULL_MASK    0x08    /* Transmit FIFO is full */
50 #define XSPI_SR_MODE_FAULT_MASK 0x10    /* Mode fault error */
51
52 #define XSPI_TXD_OFFSET         0x6b    /* 8-bit Data Transmit Register */
53 #define XSPI_RXD_OFFSET         0x6f    /* 8-bit Data Receive Register */
54
55 #define XSPI_SSR_OFFSET         0x70    /* 32-bit Slave Select Register */
56
57 /* Register definitions as per "OPB IPIF (v3.01c) Product Specification", DS414
58  * IPIF registers are 32 bit
59  */
60 #define XIPIF_V123B_DGIER_OFFSET        0x1c    /* IPIF global int enable reg */
61 #define XIPIF_V123B_GINTR_ENABLE        0x80000000
62
63 #define XIPIF_V123B_IISR_OFFSET         0x20    /* IPIF interrupt status reg */
64 #define XIPIF_V123B_IIER_OFFSET         0x28    /* IPIF interrupt enable reg */
65
66 #define XSPI_INTR_MODE_FAULT            0x01    /* Mode fault error */
67 #define XSPI_INTR_SLAVE_MODE_FAULT      0x02    /* Selected as slave while
68                                                  * disabled */
69 #define XSPI_INTR_TX_EMPTY              0x04    /* TxFIFO is empty */
70 #define XSPI_INTR_TX_UNDERRUN           0x08    /* TxFIFO was underrun */
71 #define XSPI_INTR_RX_FULL               0x10    /* RxFIFO is full */
72 #define XSPI_INTR_RX_OVERRUN            0x20    /* RxFIFO was overrun */
73
74 #define XIPIF_V123B_RESETR_OFFSET       0x40    /* IPIF reset register */
75 #define XIPIF_V123B_RESET_MASK          0x0a    /* the value to write */
76
77 struct xilinx_spi {
78         /* bitbang has to be first */
79         struct spi_bitbang bitbang;
80         struct completion done;
81
82         void __iomem    *regs;  /* virt. address of the control registers */
83
84         u32             irq;
85
86         u32             speed_hz; /* SCK has a fixed frequency of speed_hz Hz */
87
88         u8 *rx_ptr;             /* pointer in the Tx buffer */
89         const u8 *tx_ptr;       /* pointer in the Rx buffer */
90         int remaining_bytes;    /* the number of bytes left to transfer */
91 };
92
93 static void xspi_init_hw(void __iomem *regs_base)
94 {
95         /* Reset the SPI device */
96         out_be32(regs_base + XIPIF_V123B_RESETR_OFFSET,
97                  XIPIF_V123B_RESET_MASK);
98         /* Disable all the interrupts just in case */
99         out_be32(regs_base + XIPIF_V123B_IIER_OFFSET, 0);
100         /* Enable the global IPIF interrupt */
101         out_be32(regs_base + XIPIF_V123B_DGIER_OFFSET,
102                  XIPIF_V123B_GINTR_ENABLE);
103         /* Deselect the slave on the SPI bus */
104         out_be32(regs_base + XSPI_SSR_OFFSET, 0xffff);
105         /* Disable the transmitter, enable Manual Slave Select Assertion,
106          * put SPI controller into master mode, and enable it */
107         out_be16(regs_base + XSPI_CR_OFFSET,
108                  XSPI_CR_TRANS_INHIBIT | XSPI_CR_MANUAL_SSELECT
109                  | XSPI_CR_MASTER_MODE | XSPI_CR_ENABLE);
110 }
111
112 static void xilinx_spi_chipselect(struct spi_device *spi, int is_on)
113 {
114         struct xilinx_spi *xspi = spi_master_get_devdata(spi->master);
115
116         if (is_on == BITBANG_CS_INACTIVE) {
117                 /* Deselect the slave on the SPI bus */
118                 out_be32(xspi->regs + XSPI_SSR_OFFSET, 0xffff);
119         } else if (is_on == BITBANG_CS_ACTIVE) {
120                 /* Set the SPI clock phase and polarity */
121                 u16 cr = in_be16(xspi->regs + XSPI_CR_OFFSET)
122                          & ~XSPI_CR_MODE_MASK;
123                 if (spi->mode & SPI_CPHA)
124                         cr |= XSPI_CR_CPHA;
125                 if (spi->mode & SPI_CPOL)
126                         cr |= XSPI_CR_CPOL;
127                 out_be16(xspi->regs + XSPI_CR_OFFSET, cr);
128
129                 /* We do not check spi->max_speed_hz here as the SPI clock
130                  * frequency is not software programmable (the IP block design
131                  * parameter)
132                  */
133
134                 /* Activate the chip select */
135                 out_be32(xspi->regs + XSPI_SSR_OFFSET,
136                          ~(0x0001 << spi->chip_select));
137         }
138 }
139
140 /* spi_bitbang requires custom setup_transfer() to be defined if there is a
141  * custom txrx_bufs(). We have nothing to setup here as the SPI IP block
142  * supports just 8 bits per word, and SPI clock can't be changed in software.
143  * Check for 8 bits per word. Chip select delay calculations could be
144  * added here as soon as bitbang_work() can be made aware of the delay value.
145  */
146 static int xilinx_spi_setup_transfer(struct spi_device *spi,
147                 struct spi_transfer *t)
148 {
149         u8 bits_per_word;
150
151         bits_per_word = (t) ? t->bits_per_word : spi->bits_per_word;
152         if (bits_per_word != 8) {
153                 dev_err(&spi->dev, "%s, unsupported bits_per_word=%d\n",
154                         __func__, bits_per_word);
155                 return -EINVAL;
156         }
157
158         return 0;
159 }
160
161 /* the spi->mode bits understood by this driver: */
162 #define MODEBITS (SPI_CPOL | SPI_CPHA)
163
164 static int xilinx_spi_setup(struct spi_device *spi)
165 {
166         struct spi_bitbang *bitbang;
167         struct xilinx_spi *xspi;
168         int retval;
169
170         xspi = spi_master_get_devdata(spi->master);
171         bitbang = &xspi->bitbang;
172
173         if (spi->mode & ~MODEBITS) {
174                 dev_err(&spi->dev, "%s, unsupported mode bits %x\n",
175                         __func__, spi->mode & ~MODEBITS);
176                 return -EINVAL;
177         }
178
179         retval = xilinx_spi_setup_transfer(spi, NULL);
180         if (retval < 0)
181                 return retval;
182
183         return 0;
184 }
185
186 static void xilinx_spi_fill_tx_fifo(struct xilinx_spi *xspi)
187 {
188         u8 sr;
189
190         /* Fill the Tx FIFO with as many bytes as possible */
191         sr = in_8(xspi->regs + XSPI_SR_OFFSET);
192         while ((sr & XSPI_SR_TX_FULL_MASK) == 0 && xspi->remaining_bytes > 0) {
193                 if (xspi->tx_ptr) {
194                         out_8(xspi->regs + XSPI_TXD_OFFSET, *xspi->tx_ptr++);
195                 } else {
196                         out_8(xspi->regs + XSPI_TXD_OFFSET, 0);
197                 }
198                 xspi->remaining_bytes--;
199                 sr = in_8(xspi->regs + XSPI_SR_OFFSET);
200         }
201 }
202
203 static int xilinx_spi_txrx_bufs(struct spi_device *spi, struct spi_transfer *t)
204 {
205         struct xilinx_spi *xspi = spi_master_get_devdata(spi->master);
206         u32 ipif_ier;
207         u16 cr;
208
209         /* We get here with transmitter inhibited */
210
211         xspi->tx_ptr = t->tx_buf;
212         xspi->rx_ptr = t->rx_buf;
213         xspi->remaining_bytes = t->len;
214         INIT_COMPLETION(xspi->done);
215
216         xilinx_spi_fill_tx_fifo(xspi);
217
218         /* Enable the transmit empty interrupt, which we use to determine
219          * progress on the transmission.
220          */
221         ipif_ier = in_be32(xspi->regs + XIPIF_V123B_IIER_OFFSET);
222         out_be32(xspi->regs + XIPIF_V123B_IIER_OFFSET,
223                  ipif_ier | XSPI_INTR_TX_EMPTY);
224
225         /* Start the transfer by not inhibiting the transmitter any longer */
226         cr = in_be16(xspi->regs + XSPI_CR_OFFSET) & ~XSPI_CR_TRANS_INHIBIT;
227         out_be16(xspi->regs + XSPI_CR_OFFSET, cr);
228
229         wait_for_completion(&xspi->done);
230
231         /* Disable the transmit empty interrupt */
232         out_be32(xspi->regs + XIPIF_V123B_IIER_OFFSET, ipif_ier);
233
234         return t->len - xspi->remaining_bytes;
235 }
236
237
238 /* This driver supports single master mode only. Hence Tx FIFO Empty
239  * is the only interrupt we care about.
240  * Receive FIFO Overrun, Transmit FIFO Underrun, Mode Fault, and Slave Mode
241  * Fault are not to happen.
242  */
243 static irqreturn_t xilinx_spi_irq(int irq, void *dev_id)
244 {
245         struct xilinx_spi *xspi = dev_id;
246         u32 ipif_isr;
247
248         /* Get the IPIF interrupts, and clear them immediately */
249         ipif_isr = in_be32(xspi->regs + XIPIF_V123B_IISR_OFFSET);
250         out_be32(xspi->regs + XIPIF_V123B_IISR_OFFSET, ipif_isr);
251
252         if (ipif_isr & XSPI_INTR_TX_EMPTY) {    /* Transmission completed */
253                 u16 cr;
254                 u8 sr;
255
256                 /* A transmit has just completed. Process received data and
257                  * check for more data to transmit. Always inhibit the
258                  * transmitter while the Isr refills the transmit register/FIFO,
259                  * or make sure it is stopped if we're done.
260                  */
261                 cr = in_be16(xspi->regs + XSPI_CR_OFFSET);
262                 out_be16(xspi->regs + XSPI_CR_OFFSET,
263                          cr | XSPI_CR_TRANS_INHIBIT);
264
265                 /* Read out all the data from the Rx FIFO */
266                 sr = in_8(xspi->regs + XSPI_SR_OFFSET);
267                 while ((sr & XSPI_SR_RX_EMPTY_MASK) == 0) {
268                         u8 data;
269
270                         data = in_8(xspi->regs + XSPI_RXD_OFFSET);
271                         if (xspi->rx_ptr) {
272                                 *xspi->rx_ptr++ = data;
273                         }
274                         sr = in_8(xspi->regs + XSPI_SR_OFFSET);
275                 }
276
277                 /* See if there is more data to send */
278                 if (xspi->remaining_bytes > 0) {
279                         xilinx_spi_fill_tx_fifo(xspi);
280                         /* Start the transfer by not inhibiting the
281                          * transmitter any longer
282                          */
283                         out_be16(xspi->regs + XSPI_CR_OFFSET, cr);
284                 } else {
285                         /* No more data to send.
286                          * Indicate the transfer is completed.
287                          */
288                         complete(&xspi->done);
289                 }
290         }
291
292         return IRQ_HANDLED;
293 }
294
295 static int __init xilinx_spi_of_probe(struct of_device *ofdev,
296                                         const struct of_device_id *match)
297 {
298         struct spi_master *master;
299         struct xilinx_spi *xspi;
300         struct resource r_irq_struct;
301         struct resource r_mem_struct;
302
303         struct resource *r_irq = &r_irq_struct;
304         struct resource *r_mem = &r_mem_struct;
305         int rc = 0;
306         const u32 *prop;
307         int len;
308
309         /* Get resources(memory, IRQ) associated with the device */
310         master = spi_alloc_master(&ofdev->dev, sizeof(struct xilinx_spi));
311
312         if (master == NULL) {
313                 return -ENOMEM;
314         }
315
316         dev_set_drvdata(&ofdev->dev, master);
317
318         rc = of_address_to_resource(ofdev->node, 0, r_mem);
319         if (rc) {
320                 dev_warn(&ofdev->dev, "invalid address\n");
321                 goto put_master;
322         }
323
324         rc = of_irq_to_resource(ofdev->node, 0, r_irq);
325         if (rc == NO_IRQ) {
326                 dev_warn(&ofdev->dev, "no IRQ found\n");
327                 goto put_master;
328         }
329
330         xspi = spi_master_get_devdata(master);
331         xspi->bitbang.master = spi_master_get(master);
332         xspi->bitbang.chipselect = xilinx_spi_chipselect;
333         xspi->bitbang.setup_transfer = xilinx_spi_setup_transfer;
334         xspi->bitbang.txrx_bufs = xilinx_spi_txrx_bufs;
335         xspi->bitbang.master->setup = xilinx_spi_setup;
336         init_completion(&xspi->done);
337
338         xspi->irq = r_irq->start;
339
340         if (!request_mem_region(r_mem->start,
341                         r_mem->end - r_mem->start + 1, XILINX_SPI_NAME)) {
342                 rc = -ENXIO;
343                 dev_warn(&ofdev->dev, "memory request failure\n");
344                 goto put_master;
345         }
346
347         xspi->regs = ioremap(r_mem->start, r_mem->end - r_mem->start + 1);
348         if (xspi->regs == NULL) {
349                 rc = -ENOMEM;
350                 dev_warn(&ofdev->dev, "ioremap failure\n");
351                 goto release_mem;
352         }
353         xspi->irq = r_irq->start;
354
355         /* dynamic bus assignment */
356         master->bus_num = -1;
357
358         /* number of slave select bits is required */
359         prop = of_get_property(ofdev->node, "xlnx,num-ss-bits", &len);
360         if (!prop || len < sizeof(*prop)) {
361                 dev_warn(&ofdev->dev, "no 'xlnx,num-ss-bits' property\n");
362                 goto unmap_io;
363         }
364         master->num_chipselect = *prop;
365
366         /* SPI controller initializations */
367         xspi_init_hw(xspi->regs);
368
369         /* Register for SPI Interrupt */
370         rc = request_irq(xspi->irq, xilinx_spi_irq, 0, XILINX_SPI_NAME, xspi);
371         if (rc != 0) {
372                 dev_warn(&ofdev->dev, "irq request failure: %d\n", xspi->irq);
373                 goto unmap_io;
374         }
375
376         rc = spi_bitbang_start(&xspi->bitbang);
377         if (rc != 0) {
378                 dev_err(&ofdev->dev, "spi_bitbang_start FAILED\n");
379                 goto free_irq;
380         }
381
382         dev_info(&ofdev->dev, "at 0x%08X mapped to 0x%08X, irq=%d\n",
383                         (unsigned int)r_mem->start, (u32)xspi->regs, xspi->irq);
384
385         /* Add any subnodes on the SPI bus */
386         of_register_spi_devices(master, ofdev->node);
387
388         return rc;
389
390 free_irq:
391         free_irq(xspi->irq, xspi);
392 unmap_io:
393         iounmap(xspi->regs);
394 release_mem:
395         release_mem_region(r_mem->start, resource_size(r_mem));
396 put_master:
397         spi_master_put(master);
398         return rc;
399 }
400
401 static int __devexit xilinx_spi_remove(struct of_device *ofdev)
402 {
403         struct xilinx_spi *xspi;
404         struct spi_master *master;
405         struct resource r_mem;
406
407         master = platform_get_drvdata(ofdev);
408         xspi = spi_master_get_devdata(master);
409
410         spi_bitbang_stop(&xspi->bitbang);
411         free_irq(xspi->irq, xspi);
412         iounmap(xspi->regs);
413         if (!of_address_to_resource(ofdev->node, 0, &r_mem))
414                 release_mem_region(r_mem.start, resource_size(&r_mem));
415         dev_set_drvdata(&ofdev->dev, 0);
416         spi_master_put(xspi->bitbang.master);
417
418         return 0;
419 }
420
421 /* work with hotplug and coldplug */
422 MODULE_ALIAS("platform:" XILINX_SPI_NAME);
423
424 static int __exit xilinx_spi_of_remove(struct of_device *op)
425 {
426         return xilinx_spi_remove(op);
427 }
428
429 static struct of_device_id xilinx_spi_of_match[] = {
430         { .compatible = "xlnx,xps-spi-2.00.a", },
431         { .compatible = "xlnx,xps-spi-2.00.b", },
432         {}
433 };
434
435 MODULE_DEVICE_TABLE(of, xilinx_spi_of_match);
436
437 static struct of_platform_driver xilinx_spi_of_driver = {
438         .owner = THIS_MODULE,
439         .name = "xilinx-xps-spi",
440         .match_table = xilinx_spi_of_match,
441         .probe = xilinx_spi_of_probe,
442         .remove = __exit_p(xilinx_spi_of_remove),
443         .driver = {
444                 .name = "xilinx-xps-spi",
445                 .owner = THIS_MODULE,
446         },
447 };
448
449 static int __init xilinx_spi_init(void)
450 {
451         return of_register_platform_driver(&xilinx_spi_of_driver);
452 }
453 module_init(xilinx_spi_init);
454
455 static void __exit xilinx_spi_exit(void)
456 {
457         of_unregister_platform_driver(&xilinx_spi_of_driver);
458 }
459 module_exit(xilinx_spi_exit);
460 MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
461 MODULE_DESCRIPTION("Xilinx SPI driver");
462 MODULE_LICENSE("GPL");