GNU Linux-libre 4.14.290-gnu1
[releases.git] / arch / arm / plat-pxa / ssp.c
1 /*
2  *  linux/arch/arm/mach-pxa/ssp.c
3  *
4  *  based on linux/arch/arm/mach-sa1100/ssp.c by Russell King
5  *
6  *  Copyright (C) 2003 Russell King.
7  *  Copyright (C) 2003 Wolfson Microelectronics PLC
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  *
13  *  PXA2xx SSP driver.  This provides the generic core for simple
14  *  IO-based SSP applications and allows easy port setup for DMA access.
15  *
16  *  Author: Liam Girdwood <liam.girdwood@wolfsonmicro.com>
17  */
18
19 #include <linux/module.h>
20 #include <linux/kernel.h>
21 #include <linux/sched.h>
22 #include <linux/slab.h>
23 #include <linux/errno.h>
24 #include <linux/interrupt.h>
25 #include <linux/ioport.h>
26 #include <linux/init.h>
27 #include <linux/mutex.h>
28 #include <linux/clk.h>
29 #include <linux/err.h>
30 #include <linux/platform_device.h>
31 #include <linux/spi/pxa2xx_spi.h>
32 #include <linux/io.h>
33 #include <linux/of.h>
34 #include <linux/of_device.h>
35
36 #include <asm/irq.h>
37
38 static DEFINE_MUTEX(ssp_lock);
39 static LIST_HEAD(ssp_list);
40
41 struct ssp_device *pxa_ssp_request(int port, const char *label)
42 {
43         struct ssp_device *ssp = NULL;
44
45         mutex_lock(&ssp_lock);
46
47         list_for_each_entry(ssp, &ssp_list, node) {
48                 if (ssp->port_id == port && ssp->use_count == 0) {
49                         ssp->use_count++;
50                         ssp->label = label;
51                         break;
52                 }
53         }
54
55         mutex_unlock(&ssp_lock);
56
57         if (&ssp->node == &ssp_list)
58                 return NULL;
59
60         return ssp;
61 }
62 EXPORT_SYMBOL(pxa_ssp_request);
63
64 struct ssp_device *pxa_ssp_request_of(const struct device_node *of_node,
65                                       const char *label)
66 {
67         struct ssp_device *ssp = NULL;
68
69         mutex_lock(&ssp_lock);
70
71         list_for_each_entry(ssp, &ssp_list, node) {
72                 if (ssp->of_node == of_node && ssp->use_count == 0) {
73                         ssp->use_count++;
74                         ssp->label = label;
75                         break;
76                 }
77         }
78
79         mutex_unlock(&ssp_lock);
80
81         if (&ssp->node == &ssp_list)
82                 return NULL;
83
84         return ssp;
85 }
86 EXPORT_SYMBOL(pxa_ssp_request_of);
87
88 void pxa_ssp_free(struct ssp_device *ssp)
89 {
90         mutex_lock(&ssp_lock);
91         if (ssp->use_count) {
92                 ssp->use_count--;
93                 ssp->label = NULL;
94         } else
95                 dev_err(&ssp->pdev->dev, "device already free\n");
96         mutex_unlock(&ssp_lock);
97 }
98 EXPORT_SYMBOL(pxa_ssp_free);
99
100 #ifdef CONFIG_OF
101 static const struct of_device_id pxa_ssp_of_ids[] = {
102         { .compatible = "mrvl,pxa25x-ssp",      .data = (void *) PXA25x_SSP },
103         { .compatible = "mvrl,pxa25x-nssp",     .data = (void *) PXA25x_NSSP },
104         { .compatible = "mrvl,pxa27x-ssp",      .data = (void *) PXA27x_SSP },
105         { .compatible = "mrvl,pxa3xx-ssp",      .data = (void *) PXA3xx_SSP },
106         { .compatible = "mvrl,pxa168-ssp",      .data = (void *) PXA168_SSP },
107         { .compatible = "mrvl,pxa910-ssp",      .data = (void *) PXA910_SSP },
108         { .compatible = "mrvl,ce4100-ssp",      .data = (void *) CE4100_SSP },
109         { },
110 };
111 MODULE_DEVICE_TABLE(of, pxa_ssp_of_ids);
112 #endif
113
114 static int pxa_ssp_probe(struct platform_device *pdev)
115 {
116         struct resource *res;
117         struct ssp_device *ssp;
118         struct device *dev = &pdev->dev;
119
120         ssp = devm_kzalloc(dev, sizeof(struct ssp_device), GFP_KERNEL);
121         if (ssp == NULL)
122                 return -ENOMEM;
123
124         ssp->pdev = pdev;
125
126         ssp->clk = devm_clk_get(dev, NULL);
127         if (IS_ERR(ssp->clk))
128                 return PTR_ERR(ssp->clk);
129
130         if (dev->of_node) {
131                 struct of_phandle_args dma_spec;
132                 struct device_node *np = dev->of_node;
133                 int ret;
134
135                 /*
136                  * FIXME: we should allocate the DMA channel from this
137                  * context and pass the channel down to the ssp users.
138                  * For now, we lookup the rx and tx indices manually
139                  */
140
141                 /* rx */
142                 ret = of_parse_phandle_with_args(np, "dmas", "#dma-cells",
143                                                  0, &dma_spec);
144
145                 if (ret) {
146                         dev_err(dev, "Can't parse dmas property\n");
147                         return -ENODEV;
148                 }
149                 ssp->drcmr_rx = dma_spec.args[0];
150                 of_node_put(dma_spec.np);
151
152                 /* tx */
153                 ret = of_parse_phandle_with_args(np, "dmas", "#dma-cells",
154                                                  1, &dma_spec);
155                 if (ret) {
156                         dev_err(dev, "Can't parse dmas property\n");
157                         return -ENODEV;
158                 }
159                 ssp->drcmr_tx = dma_spec.args[0];
160                 of_node_put(dma_spec.np);
161         } else {
162                 res = platform_get_resource(pdev, IORESOURCE_DMA, 0);
163                 if (res == NULL) {
164                         dev_err(dev, "no SSP RX DRCMR defined\n");
165                         return -ENODEV;
166                 }
167                 ssp->drcmr_rx = res->start;
168
169                 res = platform_get_resource(pdev, IORESOURCE_DMA, 1);
170                 if (res == NULL) {
171                         dev_err(dev, "no SSP TX DRCMR defined\n");
172                         return -ENODEV;
173                 }
174                 ssp->drcmr_tx = res->start;
175         }
176
177         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
178         if (res == NULL) {
179                 dev_err(dev, "no memory resource defined\n");
180                 return -ENODEV;
181         }
182
183         res = devm_request_mem_region(dev, res->start, resource_size(res),
184                                       pdev->name);
185         if (res == NULL) {
186                 dev_err(dev, "failed to request memory resource\n");
187                 return -EBUSY;
188         }
189
190         ssp->phys_base = res->start;
191
192         ssp->mmio_base = devm_ioremap(dev, res->start, resource_size(res));
193         if (ssp->mmio_base == NULL) {
194                 dev_err(dev, "failed to ioremap() registers\n");
195                 return -ENODEV;
196         }
197
198         ssp->irq = platform_get_irq(pdev, 0);
199         if (ssp->irq < 0) {
200                 dev_err(dev, "no IRQ resource defined\n");
201                 return -ENODEV;
202         }
203
204         if (dev->of_node) {
205                 const struct of_device_id *id =
206                         of_match_device(of_match_ptr(pxa_ssp_of_ids), dev);
207                 ssp->type = (int) id->data;
208         } else {
209                 const struct platform_device_id *id =
210                         platform_get_device_id(pdev);
211                 ssp->type = (int) id->driver_data;
212
213                 /* PXA2xx/3xx SSP ports starts from 1 and the internal pdev->id
214                  * starts from 0, do a translation here
215                  */
216                 ssp->port_id = pdev->id + 1;
217         }
218
219         ssp->use_count = 0;
220         ssp->of_node = dev->of_node;
221
222         mutex_lock(&ssp_lock);
223         list_add(&ssp->node, &ssp_list);
224         mutex_unlock(&ssp_lock);
225
226         platform_set_drvdata(pdev, ssp);
227
228         return 0;
229 }
230
231 static int pxa_ssp_remove(struct platform_device *pdev)
232 {
233         struct ssp_device *ssp;
234
235         ssp = platform_get_drvdata(pdev);
236         if (ssp == NULL)
237                 return -ENODEV;
238
239         mutex_lock(&ssp_lock);
240         list_del(&ssp->node);
241         mutex_unlock(&ssp_lock);
242
243         return 0;
244 }
245
246 static const struct platform_device_id ssp_id_table[] = {
247         { "pxa25x-ssp",         PXA25x_SSP },
248         { "pxa25x-nssp",        PXA25x_NSSP },
249         { "pxa27x-ssp",         PXA27x_SSP },
250         { "pxa3xx-ssp",         PXA3xx_SSP },
251         { "pxa168-ssp",         PXA168_SSP },
252         { "pxa910-ssp",         PXA910_SSP },
253         { },
254 };
255
256 static struct platform_driver pxa_ssp_driver = {
257         .probe          = pxa_ssp_probe,
258         .remove         = pxa_ssp_remove,
259         .driver         = {
260                 .name           = "pxa2xx-ssp",
261                 .of_match_table = of_match_ptr(pxa_ssp_of_ids),
262         },
263         .id_table       = ssp_id_table,
264 };
265
266 static int __init pxa_ssp_init(void)
267 {
268         return platform_driver_register(&pxa_ssp_driver);
269 }
270
271 static void __exit pxa_ssp_exit(void)
272 {
273         platform_driver_unregister(&pxa_ssp_driver);
274 }
275
276 arch_initcall(pxa_ssp_init);
277 module_exit(pxa_ssp_exit);
278
279 MODULE_DESCRIPTION("PXA SSP driver");
280 MODULE_AUTHOR("Liam Girdwood");
281 MODULE_LICENSE("GPL");