3 * Copyright (C) 2010 Nokia Corporation. All rights reserved.
4 * Copyright (C) 2014 Sebastian Reichel <sre@kernel.org>
6 * Contact: Carlos Chinea <carlos.chinea@nokia.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
23 #include <linux/compiler.h>
24 #include <linux/err.h>
25 #include <linux/ioport.h>
27 #include <linux/clk.h>
28 #include <linux/device.h>
29 #include <linux/platform_device.h>
30 #include <linux/dma-mapping.h>
31 #include <linux/dmaengine.h>
32 #include <linux/delay.h>
33 #include <linux/seq_file.h>
34 #include <linux/scatterlist.h>
35 #include <linux/interrupt.h>
36 #include <linux/spinlock.h>
37 #include <linux/debugfs.h>
38 #include <linux/pinctrl/consumer.h>
39 #include <linux/pm_runtime.h>
40 #include <linux/of_platform.h>
41 #include <linux/hsi/hsi.h>
42 #include <linux/idr.h>
44 #include "omap_ssi_regs.h"
47 /* For automatically allocated device IDs */
48 static DEFINE_IDA(platform_omap_ssi_ida
);
50 #ifdef CONFIG_DEBUG_FS
51 static int ssi_regs_show(struct seq_file
*m
, void *p __maybe_unused
)
53 struct hsi_controller
*ssi
= m
->private;
54 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
55 void __iomem
*sys
= omap_ssi
->sys
;
57 pm_runtime_get_sync(ssi
->device
.parent
);
58 seq_printf(m
, "REVISION\t: 0x%08x\n", readl(sys
+ SSI_REVISION_REG
));
59 seq_printf(m
, "SYSCONFIG\t: 0x%08x\n", readl(sys
+ SSI_SYSCONFIG_REG
));
60 seq_printf(m
, "SYSSTATUS\t: 0x%08x\n", readl(sys
+ SSI_SYSSTATUS_REG
));
61 pm_runtime_put(ssi
->device
.parent
);
66 static int ssi_gdd_regs_show(struct seq_file
*m
, void *p __maybe_unused
)
68 struct hsi_controller
*ssi
= m
->private;
69 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
70 void __iomem
*gdd
= omap_ssi
->gdd
;
71 void __iomem
*sys
= omap_ssi
->sys
;
74 pm_runtime_get_sync(ssi
->device
.parent
);
76 seq_printf(m
, "GDD_MPU_STATUS\t: 0x%08x\n",
77 readl(sys
+ SSI_GDD_MPU_IRQ_STATUS_REG
));
78 seq_printf(m
, "GDD_MPU_ENABLE\t: 0x%08x\n\n",
79 readl(sys
+ SSI_GDD_MPU_IRQ_ENABLE_REG
));
80 seq_printf(m
, "HW_ID\t\t: 0x%08x\n",
81 readl(gdd
+ SSI_GDD_HW_ID_REG
));
82 seq_printf(m
, "PPORT_ID\t: 0x%08x\n",
83 readl(gdd
+ SSI_GDD_PPORT_ID_REG
));
84 seq_printf(m
, "MPORT_ID\t: 0x%08x\n",
85 readl(gdd
+ SSI_GDD_MPORT_ID_REG
));
86 seq_printf(m
, "TEST\t\t: 0x%08x\n",
87 readl(gdd
+ SSI_GDD_TEST_REG
));
88 seq_printf(m
, "GCR\t\t: 0x%08x\n",
89 readl(gdd
+ SSI_GDD_GCR_REG
));
91 for (lch
= 0; lch
< SSI_MAX_GDD_LCH
; lch
++) {
92 seq_printf(m
, "\nGDD LCH %d\n=========\n", lch
);
93 seq_printf(m
, "CSDP\t\t: 0x%04x\n",
94 readw(gdd
+ SSI_GDD_CSDP_REG(lch
)));
95 seq_printf(m
, "CCR\t\t: 0x%04x\n",
96 readw(gdd
+ SSI_GDD_CCR_REG(lch
)));
97 seq_printf(m
, "CICR\t\t: 0x%04x\n",
98 readw(gdd
+ SSI_GDD_CICR_REG(lch
)));
99 seq_printf(m
, "CSR\t\t: 0x%04x\n",
100 readw(gdd
+ SSI_GDD_CSR_REG(lch
)));
101 seq_printf(m
, "CSSA\t\t: 0x%08x\n",
102 readl(gdd
+ SSI_GDD_CSSA_REG(lch
)));
103 seq_printf(m
, "CDSA\t\t: 0x%08x\n",
104 readl(gdd
+ SSI_GDD_CDSA_REG(lch
)));
105 seq_printf(m
, "CEN\t\t: 0x%04x\n",
106 readw(gdd
+ SSI_GDD_CEN_REG(lch
)));
107 seq_printf(m
, "CSAC\t\t: 0x%04x\n",
108 readw(gdd
+ SSI_GDD_CSAC_REG(lch
)));
109 seq_printf(m
, "CDAC\t\t: 0x%04x\n",
110 readw(gdd
+ SSI_GDD_CDAC_REG(lch
)));
111 seq_printf(m
, "CLNK_CTRL\t: 0x%04x\n",
112 readw(gdd
+ SSI_GDD_CLNK_CTRL_REG(lch
)));
115 pm_runtime_put(ssi
->device
.parent
);
120 DEFINE_SHOW_ATTRIBUTE(ssi_regs
);
121 DEFINE_SHOW_ATTRIBUTE(ssi_gdd_regs
);
123 static int ssi_debug_add_ctrl(struct hsi_controller
*ssi
)
125 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
129 omap_ssi
->dir
= debugfs_create_dir(dev_name(&ssi
->device
), NULL
);
133 debugfs_create_file("regs", S_IRUGO
, omap_ssi
->dir
, ssi
,
136 dir
= debugfs_create_dir("gdd", omap_ssi
->dir
);
139 debugfs_create_file("regs", S_IRUGO
, dir
, ssi
, &ssi_gdd_regs_fops
);
143 debugfs_remove_recursive(omap_ssi
->dir
);
148 static void ssi_debug_remove_ctrl(struct hsi_controller
*ssi
)
150 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
152 debugfs_remove_recursive(omap_ssi
->dir
);
154 #endif /* CONFIG_DEBUG_FS */
157 * FIXME: Horrible HACK needed until we remove the useless wakeline test
158 * in the CMT. To be removed !!!!
160 void ssi_waketest(struct hsi_client
*cl
, unsigned int enable
)
162 struct hsi_port
*port
= hsi_get_port(cl
);
163 struct omap_ssi_port
*omap_port
= hsi_port_drvdata(port
);
164 struct hsi_controller
*ssi
= to_hsi_controller(port
->device
.parent
);
165 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
167 omap_port
->wktest
= !!enable
;
168 if (omap_port
->wktest
) {
169 pm_runtime_get_sync(ssi
->device
.parent
);
170 writel_relaxed(SSI_WAKE(0),
171 omap_ssi
->sys
+ SSI_SET_WAKE_REG(port
->num
));
173 writel_relaxed(SSI_WAKE(0),
174 omap_ssi
->sys
+ SSI_CLEAR_WAKE_REG(port
->num
));
175 pm_runtime_put(ssi
->device
.parent
);
178 EXPORT_SYMBOL_GPL(ssi_waketest
);
180 static void ssi_gdd_complete(struct hsi_controller
*ssi
, unsigned int lch
)
182 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
183 struct hsi_msg
*msg
= omap_ssi
->gdd_trn
[lch
].msg
;
184 struct hsi_port
*port
= to_hsi_port(msg
->cl
->device
.parent
);
185 struct omap_ssi_port
*omap_port
= hsi_port_drvdata(port
);
190 spin_lock(&omap_ssi
->lock
);
192 val
= readl(omap_ssi
->sys
+ SSI_GDD_MPU_IRQ_ENABLE_REG
);
193 val
&= ~SSI_GDD_LCH(lch
);
194 writel_relaxed(val
, omap_ssi
->sys
+ SSI_GDD_MPU_IRQ_ENABLE_REG
);
196 if (msg
->ttype
== HSI_MSG_READ
) {
197 dir
= DMA_FROM_DEVICE
;
198 val
= SSI_DATAAVAILABLE(msg
->channel
);
199 pm_runtime_put(omap_port
->pdev
);
202 val
= SSI_DATAACCEPT(msg
->channel
);
203 /* Keep clocks reference for write pio event */
205 dma_unmap_sg(&ssi
->device
, msg
->sgt
.sgl
, msg
->sgt
.nents
, dir
);
206 csr
= readw(omap_ssi
->gdd
+ SSI_GDD_CSR_REG(lch
));
207 omap_ssi
->gdd_trn
[lch
].msg
= NULL
; /* release GDD lch */
208 dev_dbg(&port
->device
, "DMA completed ch %d ttype %d\n",
209 msg
->channel
, msg
->ttype
);
210 spin_unlock(&omap_ssi
->lock
);
211 if (csr
& SSI_CSR_TOUR
) { /* Timeout error */
212 msg
->status
= HSI_STATUS_ERROR
;
214 spin_lock(&omap_port
->lock
);
215 list_del(&msg
->link
); /* Dequeue msg */
216 spin_unlock(&omap_port
->lock
);
218 list_add_tail(&msg
->link
, &omap_port
->errqueue
);
219 schedule_delayed_work(&omap_port
->errqueue_work
, 0);
222 spin_lock(&omap_port
->lock
);
223 val
|= readl(omap_ssi
->sys
+ SSI_MPU_ENABLE_REG(port
->num
, 0));
224 writel_relaxed(val
, omap_ssi
->sys
+ SSI_MPU_ENABLE_REG(port
->num
, 0));
225 spin_unlock(&omap_port
->lock
);
227 msg
->status
= HSI_STATUS_COMPLETED
;
228 msg
->actual_len
= sg_dma_len(msg
->sgt
.sgl
);
231 static void ssi_gdd_tasklet(unsigned long dev
)
233 struct hsi_controller
*ssi
= (struct hsi_controller
*)dev
;
234 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
235 void __iomem
*sys
= omap_ssi
->sys
;
239 pm_runtime_get(ssi
->device
.parent
);
241 if (!pm_runtime_active(ssi
->device
.parent
)) {
242 dev_warn(ssi
->device
.parent
, "ssi_gdd_tasklet called without runtime PM!\n");
243 pm_runtime_put(ssi
->device
.parent
);
247 status_reg
= readl(sys
+ SSI_GDD_MPU_IRQ_STATUS_REG
);
248 for (lch
= 0; lch
< SSI_MAX_GDD_LCH
; lch
++) {
249 if (status_reg
& SSI_GDD_LCH(lch
))
250 ssi_gdd_complete(ssi
, lch
);
252 writel_relaxed(status_reg
, sys
+ SSI_GDD_MPU_IRQ_STATUS_REG
);
253 status_reg
= readl(sys
+ SSI_GDD_MPU_IRQ_STATUS_REG
);
255 pm_runtime_put(ssi
->device
.parent
);
258 tasklet_hi_schedule(&omap_ssi
->gdd_tasklet
);
260 enable_irq(omap_ssi
->gdd_irq
);
264 static irqreturn_t
ssi_gdd_isr(int irq
, void *ssi
)
266 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
268 tasklet_hi_schedule(&omap_ssi
->gdd_tasklet
);
269 disable_irq_nosync(irq
);
274 static unsigned long ssi_get_clk_rate(struct hsi_controller
*ssi
)
276 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
277 unsigned long rate
= clk_get_rate(omap_ssi
->fck
);
281 static int ssi_clk_event(struct notifier_block
*nb
, unsigned long event
,
284 struct omap_ssi_controller
*omap_ssi
= container_of(nb
,
285 struct omap_ssi_controller
, fck_nb
);
286 struct hsi_controller
*ssi
= to_hsi_controller(omap_ssi
->dev
);
287 struct clk_notifier_data
*clk_data
= data
;
288 struct omap_ssi_port
*omap_port
;
292 case PRE_RATE_CHANGE
:
293 dev_dbg(&ssi
->device
, "pre rate change\n");
295 for (i
= 0; i
< ssi
->num_ports
; i
++) {
296 omap_port
= omap_ssi
->port
[i
];
301 /* Workaround for SWBREAK + CAwake down race in CMT */
302 disable_irq(omap_port
->wake_irq
);
304 /* stop all ssi communication */
305 pinctrl_pm_select_idle_state(omap_port
->pdev
);
306 udelay(1); /* wait for racing frames */
310 case ABORT_RATE_CHANGE
:
311 dev_dbg(&ssi
->device
, "abort rate change\n");
313 case POST_RATE_CHANGE
:
314 dev_dbg(&ssi
->device
, "post rate change (%lu -> %lu)\n",
315 clk_data
->old_rate
, clk_data
->new_rate
);
316 omap_ssi
->fck_rate
= DIV_ROUND_CLOSEST(clk_data
->new_rate
, 1000); /* kHz */
318 for (i
= 0; i
< ssi
->num_ports
; i
++) {
319 omap_port
= omap_ssi
->port
[i
];
324 omap_ssi_port_update_fclk(ssi
, omap_port
);
326 /* resume ssi communication */
327 pinctrl_pm_select_default_state(omap_port
->pdev
);
328 enable_irq(omap_port
->wake_irq
);
339 static int ssi_get_iomem(struct platform_device
*pd
,
340 const char *name
, void __iomem
**pbase
, dma_addr_t
*phy
)
342 struct resource
*mem
;
344 struct hsi_controller
*ssi
= platform_get_drvdata(pd
);
346 mem
= platform_get_resource_byname(pd
, IORESOURCE_MEM
, name
);
347 base
= devm_ioremap_resource(&ssi
->device
, mem
);
349 return PTR_ERR(base
);
359 static int ssi_add_controller(struct hsi_controller
*ssi
,
360 struct platform_device
*pd
)
362 struct omap_ssi_controller
*omap_ssi
;
365 omap_ssi
= devm_kzalloc(&ssi
->device
, sizeof(*omap_ssi
), GFP_KERNEL
);
369 err
= ida_simple_get(&platform_omap_ssi_ida
, 0, 0, GFP_KERNEL
);
374 ssi
->owner
= THIS_MODULE
;
375 ssi
->device
.parent
= &pd
->dev
;
376 dev_set_name(&ssi
->device
, "ssi%d", ssi
->id
);
377 hsi_controller_set_drvdata(ssi
, omap_ssi
);
378 omap_ssi
->dev
= &ssi
->device
;
379 err
= ssi_get_iomem(pd
, "sys", &omap_ssi
->sys
, NULL
);
382 err
= ssi_get_iomem(pd
, "gdd", &omap_ssi
->gdd
, NULL
);
385 err
= platform_get_irq_byname(pd
, "gdd_mpu");
387 dev_err(&pd
->dev
, "GDD IRQ resource missing\n");
390 omap_ssi
->gdd_irq
= err
;
391 tasklet_init(&omap_ssi
->gdd_tasklet
, ssi_gdd_tasklet
,
393 err
= devm_request_irq(&ssi
->device
, omap_ssi
->gdd_irq
, ssi_gdd_isr
,
396 dev_err(&ssi
->device
, "Request GDD IRQ %d failed (%d)",
397 omap_ssi
->gdd_irq
, err
);
401 omap_ssi
->port
= devm_kcalloc(&ssi
->device
, ssi
->num_ports
,
402 sizeof(*omap_ssi
->port
), GFP_KERNEL
);
403 if (!omap_ssi
->port
) {
408 omap_ssi
->fck
= devm_clk_get(&ssi
->device
, "ssi_ssr_fck");
409 if (IS_ERR(omap_ssi
->fck
)) {
410 dev_err(&pd
->dev
, "Could not acquire clock \"ssi_ssr_fck\": %li\n",
411 PTR_ERR(omap_ssi
->fck
));
416 omap_ssi
->fck_nb
.notifier_call
= ssi_clk_event
;
417 omap_ssi
->fck_nb
.priority
= INT_MAX
;
418 clk_notifier_register(omap_ssi
->fck
, &omap_ssi
->fck_nb
);
420 /* TODO: find register, which can be used to detect context loss */
421 omap_ssi
->get_loss
= NULL
;
423 omap_ssi
->max_speed
= UINT_MAX
;
424 spin_lock_init(&omap_ssi
->lock
);
425 err
= hsi_register_controller(ssi
);
433 ida_simple_remove(&platform_omap_ssi_ida
, ssi
->id
);
437 static int ssi_hw_init(struct hsi_controller
*ssi
)
439 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
442 err
= pm_runtime_get_sync(ssi
->device
.parent
);
444 dev_err(&ssi
->device
, "runtime PM failed %d\n", err
);
448 writel_relaxed(SSI_SWRESET
, omap_ssi
->gdd
+ SSI_GDD_GRST_REG
);
449 /* Get FCK rate in kHz */
450 omap_ssi
->fck_rate
= DIV_ROUND_CLOSEST(ssi_get_clk_rate(ssi
), 1000);
451 dev_dbg(&ssi
->device
, "SSI fck rate %lu kHz\n", omap_ssi
->fck_rate
);
453 writel_relaxed(SSI_CLK_AUTOGATING_ON
, omap_ssi
->sys
+ SSI_GDD_GCR_REG
);
454 omap_ssi
->gdd_gcr
= SSI_CLK_AUTOGATING_ON
;
455 pm_runtime_put_sync(ssi
->device
.parent
);
460 static void ssi_remove_controller(struct hsi_controller
*ssi
)
462 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
464 tasklet_kill(&omap_ssi
->gdd_tasklet
);
465 hsi_unregister_controller(ssi
);
466 clk_notifier_unregister(omap_ssi
->fck
, &omap_ssi
->fck_nb
);
467 ida_simple_remove(&platform_omap_ssi_ida
, id
);
470 static inline int ssi_of_get_available_ports_count(const struct device_node
*np
)
472 struct device_node
*child
;
475 for_each_available_child_of_node(np
, child
)
476 if (of_device_is_compatible(child
, "ti,omap3-ssi-port"))
482 static int ssi_remove_ports(struct device
*dev
, void *c
)
484 struct platform_device
*pdev
= to_platform_device(dev
);
489 of_node_clear_flag(dev
->of_node
, OF_POPULATED
);
490 of_device_unregister(pdev
);
495 static int ssi_probe(struct platform_device
*pd
)
497 struct platform_device
*childpdev
;
498 struct device_node
*np
= pd
->dev
.of_node
;
499 struct device_node
*child
;
500 struct hsi_controller
*ssi
;
505 dev_err(&pd
->dev
, "missing device tree data\n");
509 num_ports
= ssi_of_get_available_ports_count(np
);
511 ssi
= hsi_alloc_controller(num_ports
, GFP_KERNEL
);
513 dev_err(&pd
->dev
, "No memory for controller\n");
517 platform_set_drvdata(pd
, ssi
);
519 err
= ssi_add_controller(ssi
, pd
);
523 pm_runtime_enable(&pd
->dev
);
525 err
= ssi_hw_init(ssi
);
528 #ifdef CONFIG_DEBUG_FS
529 err
= ssi_debug_add_ctrl(ssi
);
534 for_each_available_child_of_node(np
, child
) {
535 if (!of_device_is_compatible(child
, "ti,omap3-ssi-port"))
538 childpdev
= of_platform_device_create(child
, NULL
, &pd
->dev
);
541 dev_err(&pd
->dev
, "failed to create ssi controller port\n");
546 dev_info(&pd
->dev
, "ssi controller %d initialized (%d ports)!\n",
550 device_for_each_child(&pd
->dev
, NULL
, ssi_remove_ports
);
552 ssi_remove_controller(ssi
);
554 platform_set_drvdata(pd
, NULL
);
555 pm_runtime_disable(&pd
->dev
);
560 static int ssi_remove(struct platform_device
*pd
)
562 struct hsi_controller
*ssi
= platform_get_drvdata(pd
);
564 /* cleanup of of_platform_populate() call */
565 device_for_each_child(&pd
->dev
, NULL
, ssi_remove_ports
);
567 #ifdef CONFIG_DEBUG_FS
568 ssi_debug_remove_ctrl(ssi
);
570 ssi_remove_controller(ssi
);
571 platform_set_drvdata(pd
, NULL
);
573 pm_runtime_disable(&pd
->dev
);
579 static int omap_ssi_runtime_suspend(struct device
*dev
)
581 struct hsi_controller
*ssi
= dev_get_drvdata(dev
);
582 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
584 dev_dbg(dev
, "runtime suspend!\n");
586 if (omap_ssi
->get_loss
)
587 omap_ssi
->loss_count
=
588 omap_ssi
->get_loss(ssi
->device
.parent
);
593 static int omap_ssi_runtime_resume(struct device
*dev
)
595 struct hsi_controller
*ssi
= dev_get_drvdata(dev
);
596 struct omap_ssi_controller
*omap_ssi
= hsi_controller_drvdata(ssi
);
598 dev_dbg(dev
, "runtime resume!\n");
600 if ((omap_ssi
->get_loss
) && (omap_ssi
->loss_count
==
601 omap_ssi
->get_loss(ssi
->device
.parent
)))
604 writel_relaxed(omap_ssi
->gdd_gcr
, omap_ssi
->gdd
+ SSI_GDD_GCR_REG
);
609 static const struct dev_pm_ops omap_ssi_pm_ops
= {
610 SET_RUNTIME_PM_OPS(omap_ssi_runtime_suspend
, omap_ssi_runtime_resume
,
614 #define DEV_PM_OPS (&omap_ssi_pm_ops)
616 #define DEV_PM_OPS NULL
620 static const struct of_device_id omap_ssi_of_match
[] = {
621 { .compatible
= "ti,omap3-ssi", },
624 MODULE_DEVICE_TABLE(of
, omap_ssi_of_match
);
626 #define omap_ssi_of_match NULL
629 static struct platform_driver ssi_pdriver
= {
631 .remove
= ssi_remove
,
635 .of_match_table
= omap_ssi_of_match
,
639 static int __init
ssi_init(void) {
642 ret
= platform_driver_register(&ssi_pdriver
);
646 return platform_driver_register(&ssi_port_pdriver
);
648 module_init(ssi_init
);
650 static void __exit
ssi_exit(void) {
651 platform_driver_unregister(&ssi_port_pdriver
);
652 platform_driver_unregister(&ssi_pdriver
);
654 module_exit(ssi_exit
);
656 MODULE_ALIAS("platform:omap_ssi");
657 MODULE_AUTHOR("Carlos Chinea <carlos.chinea@nokia.com>");
658 MODULE_AUTHOR("Sebastian Reichel <sre@kernel.org>");
659 MODULE_DESCRIPTION("Synchronous Serial Interface Driver");
660 MODULE_LICENSE("GPL v2");