4 * DSP-BIOS Bridge driver support functions for TI OMAP processors.
6 * DSP/BIOS Bridge driver interface.
8 * Copyright (C) 2005-2006 Texas Instruments, Inc.
10 * This package is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
16 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
19 /* ----------------------------------- Host OS */
21 #include <dspbridge/host_os.h>
22 #include <linux/types.h>
23 #include <linux/platform_device.h>
27 #include <linux/module.h>
30 #include <linux/device.h>
31 #include <linux/init.h>
32 #include <linux/moduleparam.h>
33 #include <linux/cdev.h>
35 /* ----------------------------------- DSP/BIOS Bridge */
36 #include <dspbridge/dbdefs.h>
38 /* ----------------------------------- Trace & Debug */
39 #include <dspbridge/dbc.h>
41 /* ----------------------------------- OS Adaptation Layer */
42 #include <dspbridge/services.h>
43 #include <dspbridge/clk.h>
44 #include <dspbridge/sync.h>
46 /* ----------------------------------- Platform Manager */
47 #include <dspbridge/dspapi-ioctl.h>
48 #include <dspbridge/dspapi.h>
49 #include <dspbridge/dspdrv.h>
51 /* ----------------------------------- Resource Manager */
52 #include <dspbridge/pwr.h>
54 /* ----------------------------------- This */
55 #include <drv_interface.h>
57 #include <dspbridge/cfg.h>
58 #include <dspbridge/resourcecleanup.h>
59 #include <dspbridge/chnl.h>
60 #include <dspbridge/proc.h>
61 #include <dspbridge/dev.h>
62 #include <dspbridge/drvdefs.h>
63 #include <dspbridge/drv.h>
65 #ifdef CONFIG_TIDSPBRIDGE_DVFS
66 #include <mach-omap2/omap3-opp.h>
69 #define BRIDGE_NAME "C6410"
70 /* ----------------------------------- Globals */
71 #define DRIVER_NAME "DspBridge"
72 #define DSPBRIDGE_VERSION "0.3"
75 struct platform_device *omap_dspbridge_dev;
76 struct device *bridge;
78 /* This is a test variable used by Bridge to test different sleep states */
79 s32 dsp_test_sleepstate;
81 static struct cdev bridge_cdev;
83 static struct class *bridge_class;
85 static u32 driver_context;
86 static s32 driver_major;
87 static char *base_img;
89 static s32 shm_size = 0x500000; /* 5 MB */
90 static int tc_wordswapon; /* Default value is always false */
91 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
92 #define REC_TIMEOUT 5000 /*recovery timeout in msecs */
93 static atomic_t bridge_cref; /* number of bridge open handles */
94 static struct workqueue_struct *bridge_rec_queue;
95 static struct work_struct bridge_recovery_work;
96 static DECLARE_COMPLETION(bridge_comp);
97 static DECLARE_COMPLETION(bridge_open_comp);
102 struct omap34_xx_bridge_suspend_data {
104 wait_queue_head_t suspend_wq;
107 static struct omap34_xx_bridge_suspend_data bridge_suspend_data;
109 static int omap34_xxbridge_suspend_lockout(struct omap34_xx_bridge_suspend_data
112 if ((s)->suspended) {
113 if ((f)->f_flags & O_NONBLOCK)
115 wait_event_interruptible((s)->suspend_wq, (s)->suspended == 0);
121 module_param(dsp_debug, int, 0);
122 MODULE_PARM_DESC(dsp_debug, "Wait after loading DSP image. default = false");
124 module_param(dsp_test_sleepstate, int, 0);
125 MODULE_PARM_DESC(dsp_test_sleepstate, "DSP Sleep state = 0");
127 module_param(base_img, charp, 0);
128 MODULE_PARM_DESC(base_img, "DSP base image, default = NULL");
130 module_param(shm_size, int, 0);
131 MODULE_PARM_DESC(shm_size, "shm size, default = 4 MB, minimum = 64 KB");
133 module_param(tc_wordswapon, int, 0);
134 MODULE_PARM_DESC(tc_wordswapon, "TC Word Swap Option. default = 0");
136 MODULE_AUTHOR("Texas Instruments");
137 MODULE_LICENSE("GPL");
138 MODULE_VERSION(DSPBRIDGE_VERSION);
140 static char *driver_name = DRIVER_NAME;
142 static const struct file_operations bridge_fops = {
144 .release = bridge_release,
145 .unlocked_ioctl = bridge_ioctl,
150 static u32 time_out = 1000;
151 #ifdef CONFIG_TIDSPBRIDGE_DVFS
152 s32 dsp_max_opps = VDD1_OPP5;
155 /* Maximum Opps that can be requested by IVA */
157 #ifdef CONFIG_TIDSPBRIDGE_DVFS
158 const struct omap_opp vdd1_rate_table_bridge[] = {
161 {S125M, VDD1_OPP1, 0},
163 {S250M, VDD1_OPP2, 0},
165 {S500M, VDD1_OPP3, 0},
167 {S550M, VDD1_OPP4, 0},
169 {S600M, VDD1_OPP5, 0},
174 struct dspbridge_platform_data *omap_dspbridge_pdata;
176 u32 vdd1_dsp_freq[6][4] = {
179 {0, 90000, 0, 86000},
181 {0, 180000, 80000, 170000},
183 {0, 360000, 160000, 340000},
185 {0, 396000, 325000, 376000},
187 {0, 430000, 355000, 430000},
190 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
191 static void bridge_recover(struct work_struct *work)
193 struct dev_object *dev;
194 struct cfg_devnode *dev_node;
195 if (atomic_read(&bridge_cref)) {
196 INIT_COMPLETION(bridge_comp);
197 while (!wait_for_completion_timeout(&bridge_comp,
198 msecs_to_jiffies(REC_TIMEOUT)))
199 pr_info("%s:%d handle(s) still opened\n",
200 __func__, atomic_read(&bridge_cref));
202 dev = dev_get_first();
203 dev_get_dev_node(dev, &dev_node);
204 if (!dev_node || proc_auto_start(dev_node, dev))
205 pr_err("DSP could not be restarted\n");
207 complete_all(&bridge_open_comp);
210 void bridge_recover_schedule(void)
212 INIT_COMPLETION(bridge_open_comp);
214 queue_work(bridge_rec_queue, &bridge_recovery_work);
217 #ifdef CONFIG_TIDSPBRIDGE_DVFS
218 static int dspbridge_scale_notification(struct notifier_block *op,
219 unsigned long val, void *ptr)
221 struct dspbridge_platform_data *pdata =
222 omap_dspbridge_dev->dev.platform_data;
224 if (CPUFREQ_POSTCHANGE == val && pdata->dsp_get_opp)
225 pwr_pm_post_scale(PRCM_VDD1, pdata->dsp_get_opp());
230 static struct notifier_block iva_clk_notifier = {
231 .notifier_call = dspbridge_scale_notification,
237 * omap3_bridge_startup() - perform low lever initializations
238 * @pdev: pointer to platform device
240 * Initializes recovery, PM and DVFS required data, before calling
241 * clk and memory init routines.
243 static int omap3_bridge_startup(struct platform_device *pdev)
245 struct dspbridge_platform_data *pdata = pdev->dev.platform_data;
246 struct drv_data *drv_datap = NULL;
247 u32 phys_membase, phys_memsize;
250 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
251 bridge_rec_queue = create_workqueue("bridge_rec_queue");
252 INIT_WORK(&bridge_recovery_work, bridge_recover);
253 INIT_COMPLETION(bridge_comp);
257 /* Initialize the wait queue */
258 bridge_suspend_data.suspended = 0;
259 init_waitqueue_head(&bridge_suspend_data.suspend_wq);
261 #ifdef CONFIG_TIDSPBRIDGE_DVFS
262 for (i = 0; i < 6; i++)
263 pdata->mpu_speed[i] = vdd1_rate_table_bridge[i].rate;
265 err = cpufreq_register_notifier(&iva_clk_notifier,
266 CPUFREQ_TRANSITION_NOTIFIER);
268 pr_err("%s: clk_notifier_register failed for iva2_ck\n",
276 drv_datap = kzalloc(sizeof(struct drv_data), GFP_KERNEL);
282 drv_datap->shm_size = shm_size;
283 drv_datap->tc_wordswapon = tc_wordswapon;
286 drv_datap->base_img = kmalloc(strlen(base_img) + 1, GFP_KERNEL);
287 if (!drv_datap->base_img) {
291 strncpy(drv_datap->base_img, base_img, strlen(base_img) + 1);
294 dev_set_drvdata(bridge, drv_datap);
296 if (shm_size < 0x10000) { /* 64 KB */
298 pr_err("%s: shm size must be at least 64 KB\n", __func__);
301 dev_dbg(bridge, "%s: requested shm_size = 0x%x\n", __func__, shm_size);
303 phys_membase = pdata->phys_mempool_base;
304 phys_memsize = pdata->phys_mempool_size;
305 if (phys_membase > 0 && phys_memsize > 0)
306 mem_ext_phys_pool_init(phys_membase, phys_memsize);
309 dev_dbg(bridge, "%s: TC Word Swap is enabled\n", __func__);
311 driver_context = dsp_init(&err);
313 pr_err("DSP Bridge driver initialization failed\n");
320 mem_ext_phys_pool_release();
322 kfree(drv_datap->base_img);
326 #ifdef CONFIG_TIDSPBRIDGE_DVFS
327 cpufreq_unregister_notifier(&iva_clk_notifier,
328 CPUFREQ_TRANSITION_NOTIFIER);
336 static int __devinit omap34_xx_bridge_probe(struct platform_device *pdev)
340 #ifdef CONFIG_TIDSPBRIDGE_DVFS
344 omap_dspbridge_dev = pdev;
346 /* Global bridge device */
347 bridge = &omap_dspbridge_dev->dev;
349 /* Bridge low level initializations */
350 err = omap3_bridge_startup(pdev);
354 /* use 2.6 device model */
355 err = alloc_chrdev_region(&dev, 0, 1, driver_name);
357 pr_err("%s: Can't get major %d\n", __func__, driver_major);
361 cdev_init(&bridge_cdev, &bridge_fops);
362 bridge_cdev.owner = THIS_MODULE;
364 err = cdev_add(&bridge_cdev, dev, 1);
366 pr_err("%s: Failed to add bridge device\n", __func__);
371 bridge_class = class_create(THIS_MODULE, "ti_bridge");
372 if (IS_ERR(bridge_class)) {
373 pr_err("%s: Error creating bridge class\n", __func__);
377 driver_major = MAJOR(dev);
378 device_create(bridge_class, NULL, MKDEV(driver_major, 0),
380 pr_info("DSP Bridge driver loaded\n");
385 cdev_del(&bridge_cdev);
387 unregister_chrdev_region(dev, 1);
392 static int __devexit omap34_xx_bridge_remove(struct platform_device *pdev)
397 void *hdrv_obj = NULL;
399 status = cfg_get_object((u32 *) &hdrv_obj, REG_DRV_OBJECT);
403 #ifdef CONFIG_TIDSPBRIDGE_DVFS
404 if (cpufreq_unregister_notifier(&iva_clk_notifier,
405 CPUFREQ_TRANSITION_NOTIFIER))
406 pr_err("%s: cpufreq_unregister_notifier failed for iva2_ck\n",
408 #endif /* #ifdef CONFIG_TIDSPBRIDGE_DVFS */
410 if (driver_context) {
411 /* Put the DSP in reset state */
412 ret = dsp_deinit(driver_context);
414 DBC_ASSERT(ret == true);
418 mem_ext_phys_pool_release();
423 devno = MKDEV(driver_major, 0);
424 cdev_del(&bridge_cdev);
425 unregister_chrdev_region(devno, 1);
427 /* remove the device from sysfs */
428 device_destroy(bridge_class, MKDEV(driver_major, 0));
429 class_destroy(bridge_class);
436 static int BRIDGE_SUSPEND(struct platform_device *pdev, pm_message_t state)
439 u32 command = PWR_EMERGENCYDEEPSLEEP;
441 status = pwr_sleep_dsp(command, time_out);
445 bridge_suspend_data.suspended = 1;
449 static int BRIDGE_RESUME(struct platform_device *pdev)
453 status = pwr_wake_dsp(time_out);
457 bridge_suspend_data.suspended = 0;
458 wake_up(&bridge_suspend_data.suspend_wq);
462 #define BRIDGE_SUSPEND NULL
463 #define BRIDGE_RESUME NULL
466 static struct platform_driver bridge_driver = {
470 .probe = omap34_xx_bridge_probe,
471 .remove = __devexit_p(omap34_xx_bridge_remove),
472 .suspend = BRIDGE_SUSPEND,
473 .resume = BRIDGE_RESUME,
476 static int __init bridge_init(void)
478 return platform_driver_register(&bridge_driver);
481 static void __exit bridge_exit(void)
483 platform_driver_unregister(&bridge_driver);
487 * This function is called when an application opens handle to the
490 static int bridge_open(struct inode *ip, struct file *filp)
493 struct process_context *pr_ctxt = NULL;
496 * Allocate a new process context and insert it into global
497 * process context list.
500 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
502 if (filp->f_flags & O_NONBLOCK ||
503 wait_for_completion_interruptible(&bridge_open_comp))
507 pr_ctxt = kzalloc(sizeof(struct process_context), GFP_KERNEL);
509 pr_ctxt->res_state = PROC_RES_ALLOCATED;
510 spin_lock_init(&pr_ctxt->dmm_map_lock);
511 INIT_LIST_HEAD(&pr_ctxt->dmm_map_list);
512 spin_lock_init(&pr_ctxt->dmm_rsv_lock);
513 INIT_LIST_HEAD(&pr_ctxt->dmm_rsv_list);
515 pr_ctxt->node_id = kzalloc(sizeof(struct idr), GFP_KERNEL);
516 if (pr_ctxt->node_id) {
517 idr_init(pr_ctxt->node_id);
523 pr_ctxt->stream_id = kzalloc(sizeof(struct idr), GFP_KERNEL);
524 if (pr_ctxt->stream_id)
525 idr_init(pr_ctxt->stream_id);
532 filp->private_data = pr_ctxt;
533 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
535 atomic_inc(&bridge_cref);
541 * This function is called when an application closes handle to the bridge
544 static int bridge_release(struct inode *ip, struct file *filp)
547 struct process_context *pr_ctxt;
549 if (!filp->private_data) {
554 pr_ctxt = filp->private_data;
555 flush_signals(current);
556 drv_remove_all_resources(pr_ctxt);
557 proc_detach(pr_ctxt);
560 filp->private_data = NULL;
563 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
564 if (!atomic_dec_return(&bridge_cref))
565 complete(&bridge_comp);
570 /* This function provides IO interface to the bridge driver. */
571 static long bridge_ioctl(struct file *filp, unsigned int code,
576 union trapped_args buf_in;
578 DBC_REQUIRE(filp != NULL);
579 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
586 status = omap34_xxbridge_suspend_lockout(&bridge_suspend_data, filp);
591 if (!filp->private_data) {
596 status = copy_from_user(&buf_in, (union trapped_args *)args,
597 sizeof(union trapped_args));
600 status = api_call_dev_ioctl(code, &buf_in, &retval,
606 dev_dbg(bridge, "%s: IOCTL Failed, code: 0x%x "
607 "status 0x%x\n", __func__, code, status);
617 /* This function maps kernel space memory to user space memory. */
618 static int bridge_mmap(struct file *filp, struct vm_area_struct *vma)
620 u32 offset = vma->vm_pgoff << PAGE_SHIFT;
623 DBC_ASSERT(vma->vm_start < vma->vm_end);
625 vma->vm_flags |= VM_RESERVED | VM_IO;
626 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
628 dev_dbg(bridge, "%s: vm filp %p offset %x start %lx end %lx page_prot "
629 "%lx flags %lx\n", __func__, filp, offset,
630 vma->vm_start, vma->vm_end, vma->vm_page_prot, vma->vm_flags);
632 status = remap_pfn_range(vma, vma->vm_start, vma->vm_pgoff,
633 vma->vm_end - vma->vm_start,
641 /* To remove all process resources before removing the process from the
642 * process context list */
643 int drv_remove_all_resources(void *process_ctxt)
646 struct process_context *ctxt = (struct process_context *)process_ctxt;
647 drv_remove_all_strm_res_elements(ctxt);
648 drv_remove_all_node_res_elements(ctxt);
649 drv_remove_all_dmm_res_elements(ctxt);
650 ctxt->res_state = PROC_RES_FREED;
654 /* Bridge driver initialization and de-initialization functions */
655 module_init(bridge_init);
656 module_exit(bridge_exit);