2 * This file is part of OMAP DSP driver (DSP Gateway version 3.3.1)
4 * Copyright (C) 2002-2006 Nokia Corporation. All rights reserved.
6 * Contact: Toshihiro Kobayashi <toshihiro.kobayashi@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
24 #include <linux/init.h>
25 #include <linux/module.h>
26 #include <linux/platform_device.h>
27 #include <linux/sched.h>
28 #include <linux/mutex.h>
29 #include <linux/err.h>
30 #include <linux/clk.h>
31 #include <asm/delay.h>
32 #include <asm/arch/mailbox.h>
33 #include <asm/arch/dsp_common.h>
34 #include "dsp_mbcmd.h"
37 #include "dsp_common.h"
39 MODULE_AUTHOR("Toshihiro Kobayashi <toshihiro.kobayashi@nokia.com>");
40 MODULE_DESCRIPTION("OMAP DSP driver module");
41 MODULE_LICENSE("GPL");
43 static struct sync_seq *mbseq;
44 static u16 mbseq_expect_tmp;
45 static u16 *mbseq_expect = &mbseq_expect_tmp;
47 extern void dsp_mem_late_init(void);
52 extern void mbox_wdsnd(struct mbcmd *mb);
53 extern void mbox_wdreq(struct mbcmd *mb);
54 extern void mbox_bksnd(struct mbcmd *mb);
55 extern void mbox_bkreq(struct mbcmd *mb);
56 extern void mbox_bkyld(struct mbcmd *mb);
57 extern void mbox_bksndp(struct mbcmd *mb);
58 extern void mbox_bkreqp(struct mbcmd *mb);
59 extern void mbox_tctl(struct mbcmd *mb);
60 extern void mbox_poll(struct mbcmd *mb);
61 #ifdef OLD_BINARY_SUPPORT
63 extern void mbox_wdt(struct mbcmd *mb);
65 extern void mbox_suspend(struct mbcmd *mb);
66 static void mbox_kfunc(struct mbcmd *mb);
67 extern void mbox_tcfg(struct mbcmd *mb);
68 extern void mbox_tadd(struct mbcmd *mb);
69 extern void mbox_tdel(struct mbcmd *mb);
70 extern void mbox_dspcfg(struct mbcmd *mb);
71 extern void mbox_regrw(struct mbcmd *mb);
72 extern void mbox_getvar(struct mbcmd *mb);
73 extern void mbox_err(struct mbcmd *mb);
74 extern void mbox_dbg(struct mbcmd *mb);
76 static const struct cmdinfo
77 cif_wdsnd = { "WDSND", CMD_L_TYPE_TID, mbox_wdsnd },
78 cif_wdreq = { "WDREQ", CMD_L_TYPE_TID, mbox_wdreq },
79 cif_bksnd = { "BKSND", CMD_L_TYPE_TID, mbox_bksnd },
80 cif_bkreq = { "BKREQ", CMD_L_TYPE_TID, mbox_bkreq },
81 cif_bkyld = { "BKYLD", CMD_L_TYPE_NULL, mbox_bkyld },
82 cif_bksndp = { "BKSNDP", CMD_L_TYPE_TID, mbox_bksndp },
83 cif_bkreqp = { "BKREQP", CMD_L_TYPE_TID, mbox_bkreqp },
84 cif_tctl = { "TCTL", CMD_L_TYPE_TID, mbox_tctl },
85 cif_poll = { "POLL", CMD_L_TYPE_NULL, mbox_poll },
86 #ifdef OLD_BINARY_SUPPORT
88 cif_wdt = { "WDT", CMD_L_TYPE_NULL, mbox_wdt },
90 cif_runlevel = { "RUNLEVEL", CMD_L_TYPE_SUBCMD, NULL },
91 cif_pm = { "PM", CMD_L_TYPE_SUBCMD, NULL },
92 cif_suspend = { "SUSPEND", CMD_L_TYPE_NULL, mbox_suspend },
93 cif_kfunc = { "KFUNC", CMD_L_TYPE_SUBCMD, mbox_kfunc },
94 cif_tcfg = { "TCFG", CMD_L_TYPE_TID, mbox_tcfg },
95 cif_tadd = { "TADD", CMD_L_TYPE_TID, mbox_tadd },
96 cif_tdel = { "TDEL", CMD_L_TYPE_TID, mbox_tdel },
97 cif_tstop = { "TSTOP", CMD_L_TYPE_TID, NULL },
98 cif_dspcfg = { "DSPCFG", CMD_L_TYPE_SUBCMD, mbox_dspcfg },
99 cif_regrw = { "REGRW", CMD_L_TYPE_SUBCMD, mbox_regrw },
100 cif_getvar = { "GETVAR", CMD_L_TYPE_SUBCMD, mbox_getvar },
101 cif_setvar = { "SETVAR", CMD_L_TYPE_SUBCMD, NULL },
102 cif_err = { "ERR", CMD_L_TYPE_SUBCMD, mbox_err },
103 cif_dbg = { "DBG", CMD_L_TYPE_NULL, mbox_dbg };
105 #define MBOX_CMD_MAX 0x80
106 const struct cmdinfo *cmdinfo[MBOX_CMD_MAX] = {
107 [MBOX_CMD_DSP_WDSND] = &cif_wdsnd,
108 [MBOX_CMD_DSP_WDREQ] = &cif_wdreq,
109 [MBOX_CMD_DSP_BKSND] = &cif_bksnd,
110 [MBOX_CMD_DSP_BKREQ] = &cif_bkreq,
111 [MBOX_CMD_DSP_BKYLD] = &cif_bkyld,
112 [MBOX_CMD_DSP_BKSNDP] = &cif_bksndp,
113 [MBOX_CMD_DSP_BKREQP] = &cif_bkreqp,
114 [MBOX_CMD_DSP_TCTL] = &cif_tctl,
115 [MBOX_CMD_DSP_POLL] = &cif_poll,
116 #ifdef OLD_BINARY_SUPPORT
117 [MBOX_CMD_DSP_WDT] = &cif_wdt, /* v3.3 obsolete */
119 [MBOX_CMD_DSP_RUNLEVEL] = &cif_runlevel,
120 [MBOX_CMD_DSP_PM] = &cif_pm,
121 [MBOX_CMD_DSP_SUSPEND] = &cif_suspend,
122 [MBOX_CMD_DSP_KFUNC] = &cif_kfunc,
123 [MBOX_CMD_DSP_TCFG] = &cif_tcfg,
124 [MBOX_CMD_DSP_TADD] = &cif_tadd,
125 [MBOX_CMD_DSP_TDEL] = &cif_tdel,
126 [MBOX_CMD_DSP_TSTOP] = &cif_tstop,
127 [MBOX_CMD_DSP_DSPCFG] = &cif_dspcfg,
128 [MBOX_CMD_DSP_REGRW] = &cif_regrw,
129 [MBOX_CMD_DSP_GETVAR] = &cif_getvar,
130 [MBOX_CMD_DSP_SETVAR] = &cif_setvar,
131 [MBOX_CMD_DSP_ERR] = &cif_err,
132 [MBOX_CMD_DSP_DBG] = &cif_dbg,
135 static int dsp_kfunc_probe_devices(struct omap_dsp *dsp)
137 struct dsp_kfunc_device *p;
140 mutex_lock(&dsp->lock);
141 list_for_each_entry(p, dsp->kdev_list, entry) {
142 if (p->probe == NULL)
147 "probing %s failed\n", p->name);
151 mutex_unlock(&dsp->lock);
153 pr_debug("%s() fail:%d\n", __FUNCTION__, fail);
158 static int dsp_kfunc_remove_devices(struct omap_dsp *dsp)
160 struct dsp_kfunc_device *p;
163 mutex_lock(&dsp->lock);
164 list_for_each_entry_reverse(p, dsp->kdev_list, entry) {
165 if (p->remove == NULL)
170 "removing %s failed\n", p->name);
174 mutex_unlock(&dsp->lock);
176 pr_debug("%s() fail:%d\n", __FUNCTION__, fail);
181 static int dsp_kfunc_enable_devices(struct omap_dsp *dsp, int type, int stage)
183 struct dsp_kfunc_device *p;
186 mutex_lock(&dsp->lock);
187 list_for_each_entry(p, dsp->kdev_list, entry) {
188 if ((p->type != type) || (p->enable == NULL))
190 ret = p->enable(p, stage);
193 "enabling %s failed\n", p->name);
197 mutex_unlock(&dsp->lock);
199 pr_debug("%s(%d) fail:%d\n", __FUNCTION__, type, fail);
204 static int dsp_kfunc_disable_devices(struct omap_dsp *dsp, int type, int stage)
206 struct dsp_kfunc_device *p;
209 mutex_lock(&dsp->lock);
210 list_for_each_entry_reverse(p, omap_dsp->kdev_list, entry) {
211 if ((p->type != type) || (p->disable == NULL))
213 ret = p->disable(p, stage);
216 "disabling %s failed\n", p->name);
220 mutex_unlock(&dsp->lock);
222 pr_debug("%s(%d) fail:%d\n", __FUNCTION__, type, fail);
227 int sync_with_dsp(u16 *adr, u16 val, int try_cnt)
231 if (*(volatile u16 *)adr == val)
234 for (try = 0; try < try_cnt; try++) {
236 if (*(volatile u16 *)adr == val) {
238 pr_info("omapdsp: sync_with_dsp(): try = %d\n", try);
247 static int mbcmd_sender_prepare(void *data)
249 struct mb_exarg *arg = data;
252 * even if ipbuf_sys_ad is in DSP internal memory,
253 * dsp_mem_enable() never cause to call PM mailbox command
254 * because in that case DSP memory should be always enabled.
255 * (see ipbuf_sys_hold_mem_active in ipbuf.c)
257 * Therefore, we can call this function here safely.
259 if (sync_with_dsp(&ipbuf_sys_ad->s, TID_FREE, 10) < 0) {
260 printk(KERN_ERR "omapdsp: ipbuf_sys_ad is busy.\n");
265 for (i = 0; i < arg->argc; i++) {
266 ipbuf_sys_ad->d[i] = arg->argv[i];
268 ipbuf_sys_ad->s = arg->tid;
274 * __dsp_mbcmd_send_exarg(): mailbox dispatcher
276 int __dsp_mbcmd_send_exarg(struct mbcmd *mb, struct mb_exarg *arg,
281 if (unlikely(omap_dsp->enabled == 0)) {
282 ret = dsp_kfunc_enable_devices(omap_dsp,
283 DSP_KFUNC_DEV_TYPE_COMMON, 0);
285 omap_dsp->enabled = 1;
289 * while MMU fault is set,
290 * only recovery command can be executed
292 if (dsp_err_isset(ERRCODE_MMU) && !recovery_flag) {
294 "mbox: mmu interrupt is set. %s is aborting.\n",
300 dsp_mem_enable(ipbuf_sys_ad);
302 ret = omap_mbox_msg_send(omap_dsp->mbox,
303 *(mbox_msg_t *)mb, (void*)arg);
310 mblog_add(mb, DIR_A2D);
313 dsp_mem_disable(ipbuf_sys_ad);
318 int dsp_mbcmd_send_and_wait_exarg(struct mbcmd *mb, struct mb_exarg *arg,
319 wait_queue_head_t *q)
322 DECLARE_WAITQUEUE(wait, current);
324 add_wait_queue(q, &wait);
325 current_state = current->state;
326 set_current_state(TASK_INTERRUPTIBLE);
327 if (dsp_mbcmd_send_exarg(mb, arg) < 0) {
328 set_current_state(current_state);
329 remove_wait_queue(q, &wait);
332 schedule_timeout(DSP_TIMEOUT);
333 set_current_state(current_state);
334 remove_wait_queue(q, &wait);
342 static void mbcmd_receiver(mbox_msg_t msg)
344 struct mbcmd *mb = (struct mbcmd *)&msg;
346 if (cmdinfo[mb->cmd_h] == NULL) {
348 "invalid message (%08x) for mbcmd_receiver().\n", msg);
354 mblog_add(mb, DIR_D2A);
356 /* call handler for the command */
357 if (cmdinfo[mb->cmd_h]->handler)
358 cmdinfo[mb->cmd_h]->handler(mb);
360 printk(KERN_ERR "mbox: %s is not allowed from DSP.\n",
364 static int mbsync_hold_mem_active;
366 void dsp_mbox_start(void)
368 omap_mbox_init_seq(omap_dsp->mbox);
369 mbseq_expect_tmp = 0;
372 void dsp_mbox_stop(void)
375 mbseq_expect = &mbseq_expect_tmp;
378 int dsp_mbox_config(void *p)
382 if (dsp_address_validate(p, sizeof(struct sync_seq), "mbseq") < 0)
384 if (dsp_mem_type(p, sizeof(struct sync_seq)) != MEM_TYPE_EXTERN) {
386 "omapdsp: mbseq is placed in DSP internal memory.\n"
387 " It will prevent DSP from idling.\n");
388 mbsync_hold_mem_active = 1;
390 * dsp_mem_enable() never fails because
391 * it has been already enabled in dspcfg process and
392 * this will just increment the usecount.
394 dsp_mem_enable((void *)daram_base);
397 local_irq_save(flags);
399 mbseq->da_arm = mbseq_expect_tmp;
400 mbseq_expect = &mbseq->da_arm;
401 local_irq_restore(flags);
406 static int __init dsp_mbox_init(void)
408 omap_dsp->mbox = omap_mbox_get("dsp");
409 if (omap_dsp->mbox == NULL) {
410 printk(KERN_ERR "failed to get mailbox handler for DSP.\n");
414 omap_dsp->mbox->msg_receive_cb = mbcmd_receiver;
415 omap_dsp->mbox->msg_sender_cb = mbcmd_sender_prepare;
420 static void dsp_mbox_exit(void)
422 omap_dsp->mbox->msg_sender_cb = NULL;
423 omap_dsp->mbox->msg_receive_cb = NULL;
425 if (mbsync_hold_mem_active) {
426 dsp_mem_disable((void *)daram_base);
427 mbsync_hold_mem_active = 0;
432 * kernel function dispatcher
434 extern void mbox_fbctl_upd(void);
435 extern void mbox_fbctl_disable(struct mbcmd *mb);
437 static void mbox_kfunc_fbctl(struct mbcmd *mb)
444 mbox_fbctl_disable(mb);
448 "mbox: Unknown FBCTL from DSP: 0x%04x\n", mb->data);
453 * dspgw: KFUNC message handler
455 static void mbox_kfunc_power(unsigned short data)
460 case DVFS_START: /* ACK from DSP */
464 ret = dsp_kfunc_enable_devices(omap_dsp,
465 DSP_KFUNC_DEV_TYPE_AUDIO, 0);
469 case AUDIO_PWR_DOWN: /* == AUDIO_PWR_DOWN1 */
470 ret = dsp_kfunc_disable_devices(omap_dsp,
471 DSP_KFUNC_DEV_TYPE_AUDIO, 1);
473 case AUDIO_PWR_DOWN2:
474 ret = dsp_kfunc_disable_devices(omap_dsp,
475 DSP_KFUNC_DEV_TYPE_AUDIO, 2);
478 ret = dsp_kfunc_disable_devices(omap_dsp,
479 DSP_KFUNC_DEV_TYPE_COMMON, 0);
481 omap_dsp->enabled = 0;
485 "mailbox: Unknown PWR from DSP: 0x%04x\n", data);
489 if (unlikely(ret < 0)) {
490 printk(KERN_ERR "mailbox: PWR(0x%04x) failed\n", data);
494 if (likely(ret == 0))
497 mbcompose_send(KFUNC, KFUNC_POWER, data);
500 static void mbox_kfunc(struct mbcmd *mb)
504 mbox_kfunc_fbctl(mb);
507 mbox_kfunc_power(mb->data);
511 "mbox: Unknown KFUNC from DSP: 0x%02x\n", mb->cmd_l);
515 int dsp_late_init(void)
521 #ifdef CONFIG_ARCH_OMAP2
522 clk_enable(dsp_fck_handle);
523 clk_enable(dsp_ick_handle);
528 #ifdef CONFIG_ARCH_OMAP1
529 dsp_set_idle_boot_base(IDLEPG_BASE, IDLEPG_SIZE);
531 ret = dsp_kfunc_enable_devices(omap_dsp,
532 DSP_KFUNC_DEV_TYPE_COMMON, 0);
534 omap_dsp->enabled = 0;
539 extern int dsp_ctl_core_init(void);
540 extern void dsp_ctl_core_exit(void);
541 extern void dsp_ctl_init(void);
542 extern void dsp_ctl_exit(void);
543 extern int dsp_mem_init(void);
544 extern void dsp_mem_exit(void);
545 extern void mblog_init(void);
546 extern void mblog_exit(void);
547 extern int dsp_taskmod_init(void);
548 extern void dsp_taskmod_exit(void);
553 static int __init dsp_drv_probe(struct platform_device *pdev)
556 struct omap_dsp *info;
557 struct dsp_platform_data *pdata = pdev->dev.platform_data;
559 dev_info(&pdev->dev, "OMAP DSP driver initialization\n");
561 info = kzalloc(sizeof(struct omap_dsp), GFP_KERNEL);
562 if (unlikely(info == NULL)) {
563 dev_dbg(&pdev->dev, "no memory for info\n");
566 platform_set_drvdata(pdev, info);
569 mutex_init(&info->lock);
570 info->dev = &pdev->dev;
571 info->kdev_list = &pdata->kdev_list;
573 ret = dsp_kfunc_probe_devices(info);
579 info->mmu_irq = platform_get_irq_byname(pdev, "dsp_mmu");
580 if (unlikely(info->mmu_irq) < 0) {
585 if ((ret = dsp_ctl_core_init()) < 0)
587 if ((ret = dsp_mem_init()) < 0)
591 if ((ret = dsp_taskmod_init()) < 0)
593 if ((ret = dsp_mbox_init()) < 0)
608 dsp_kfunc_remove_devices(info);
615 static int dsp_drv_remove(struct platform_device *pdev)
617 struct omap_dsp *info = platform_get_drvdata(pdev);
619 dsp_cpustat_request(CPUSTAT_RESET);
621 dsp_cfgstat_request(CFGSTAT_CLEAN);
630 #ifdef CONFIG_ARCH_OMAP2
632 clk_disable(dsp_ick_handle);
633 clk_disable(dsp_fck_handle);
635 dsp_kfunc_remove_devices(info);
642 static int dsp_drv_suspend(struct platform_device *pdev, pm_message_t state)
644 dsp_cfgstat_request(CFGSTAT_SUSPEND);
649 static int dsp_drv_resume(struct platform_device *pdev)
651 dsp_cfgstat_request(CFGSTAT_RESUME);
656 #define dsp_drv_suspend NULL
657 #define dsp_drv_resume NULL
658 #endif /* CONFIG_PM */
660 static struct platform_driver dsp_driver = {
661 .probe = dsp_drv_probe,
662 .remove = dsp_drv_remove,
663 .suspend = dsp_drv_suspend,
664 .resume = dsp_drv_resume,
670 static int __init omap_dsp_mod_init(void)
672 return platform_driver_register(&dsp_driver);
675 static void __exit omap_dsp_mod_exit(void)
677 platform_driver_unregister(&dsp_driver);
680 /* module dependency: need mailbox module that have mbox_dsp_info */
681 extern struct omap_mbox mbox_dsp_info;
682 struct omap_mbox *mbox_dep = &mbox_dsp_info;
684 module_init(omap_dsp_mod_init);
685 module_exit(omap_dsp_mod_exit);