drivers/staging/tidspbridge/rmgr/drv_interface.c

   1 /*
   2  * drv_interface.c
   3  *
   4  * DSP-BIOS Bridge driver support functions for TI OMAP processors.
   5  *
   6  * DSP/BIOS Bridge driver interface.
   7  *
   8  * Copyright (C) 2005-2006 Texas Instruments, Inc.
   9  *
  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.
  13  *
  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.
  17  */
  18
  19 /*  ----------------------------------- Host OS */
  20
  21 #include <dspbridge/host_os.h>
  22 #include <linux/types.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/pm.h>
  25
  26 #ifdef MODULE
  27 #include <linux/module.h>
  28 #endif
  29
  30 #include <linux/device.h>
  31 #include <linux/init.h>
  32 #include <linux/moduleparam.h>
  33 #include <linux/cdev.h>
  34
  35 /*  ----------------------------------- DSP/BIOS Bridge */
  36 #include <dspbridge/dbdefs.h>
  37
  38 /*  ----------------------------------- Trace & Debug */
  39 #include <dspbridge/dbc.h>
  40
  41 /*  ----------------------------------- OS Adaptation Layer */
  42 #include <dspbridge/clk.h>
  43 #include <dspbridge/sync.h>
  44
  45 /*  ----------------------------------- Platform Manager */
  46 #include <dspbridge/dspapi-ioctl.h>
  47 #include <dspbridge/dspapi.h>
  48 #include <dspbridge/dspdrv.h>
  49
  50 /*  ----------------------------------- Resource Manager */
  51 #include <dspbridge/pwr.h>
  52
  53 /*  ----------------------------------- This */
  54 #include <drv_interface.h>
  55
  56 #include <dspbridge/resourcecleanup.h>
  57 #include <dspbridge/chnl.h>
  58 #include <dspbridge/proc.h>
  59 #include <dspbridge/dev.h>
  60 #include <dspbridge/drvdefs.h>
  61 #include <dspbridge/drv.h>
  62
  63 #ifdef CONFIG_TIDSPBRIDGE_DVFS
  64 #include <mach-omap2/omap3-opp.h>
  65 #endif
  66
  67 #define BRIDGE_NAME "C6410"
  68 /*  ----------------------------------- Globals */
  69 #define DRIVER_NAME  "DspBridge"
  70 #define DSPBRIDGE_VERSION       "0.3"
  71 s32 dsp_debug;
  72
  73 struct platform_device *omap_dspbridge_dev;
  74 struct device *bridge;
  75
  76 /* This is a test variable used by Bridge to test different sleep states */
  77 s32 dsp_test_sleepstate;
  78
  79 static struct cdev bridge_cdev;
  80
  81 static struct class *bridge_class;
  82
  83 static u32 driver_context;
  84 static s32 driver_major;
  85 static char *base_img;
  86 char *iva_img;
  87 static s32 shm_size = 0x500000; /* 5 MB */
  88 static int tc_wordswapon;       /* Default value is always false */
  89 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
  90 #define REC_TIMEOUT 5000        /*recovery timeout in msecs */
  91 static atomic_t bridge_cref;    /* number of bridge open handles */
  92 static struct workqueue_struct *bridge_rec_queue;
  93 static struct work_struct bridge_recovery_work;
  94 static DECLARE_COMPLETION(bridge_comp);
  95 static DECLARE_COMPLETION(bridge_open_comp);
  96 static bool recover;
  97 #endif
  98
  99 #ifdef CONFIG_PM
 100 struct omap34_xx_bridge_suspend_data {
 101         int suspended;
 102         wait_queue_head_t suspend_wq;
 103 };
 104
 105 static struct omap34_xx_bridge_suspend_data bridge_suspend_data;
 106
 107 static int omap34_xxbridge_suspend_lockout(struct omap34_xx_bridge_suspend_data
 108                                            *s, struct file *f)
 109 {
 110         if ((s)->suspended) {
 111                 if ((f)->f_flags & O_NONBLOCK)
 112                         return -EPERM;
 113                 wait_event_interruptible((s)->suspend_wq, (s)->suspended == 0);
 114         }
 115         return 0;
 116 }
 117 #endif
 118
 119 module_param(dsp_debug, int, 0);
 120 MODULE_PARM_DESC(dsp_debug, "Wait after loading DSP image. default = false");
 121
 122 module_param(dsp_test_sleepstate, int, 0);
 123 MODULE_PARM_DESC(dsp_test_sleepstate, "DSP Sleep state = 0");
 124
 125 module_param(base_img, charp, 0);
 126 MODULE_PARM_DESC(base_img, "DSP base image, default = NULL");
 127
 128 module_param(shm_size, int, 0);
 129 MODULE_PARM_DESC(shm_size, "shm size, default = 4 MB, minimum = 64 KB");
 130
 131 module_param(tc_wordswapon, int, 0);
 132 MODULE_PARM_DESC(tc_wordswapon, "TC Word Swap Option. default = 0");
 133
 134 MODULE_AUTHOR("Texas Instruments");
 135 MODULE_LICENSE("GPL");
 136 MODULE_VERSION(DSPBRIDGE_VERSION);
 137
 138 static char *driver_name = DRIVER_NAME;
 139
 140 static const struct file_operations bridge_fops = {
 141         .open = bridge_open,
 142         .release = bridge_release,
 143         .unlocked_ioctl = bridge_ioctl,
 144         .mmap = bridge_mmap,
 145 };
 146
 147 #ifdef CONFIG_PM
 148 static u32 time_out = 1000;
 149 #ifdef CONFIG_TIDSPBRIDGE_DVFS
 150 s32 dsp_max_opps = VDD1_OPP5;
 151 #endif
 152
 153 /* Maximum Opps that can be requested by IVA */
 154 /*vdd1 rate table */
 155 #ifdef CONFIG_TIDSPBRIDGE_DVFS
 156 const struct omap_opp vdd1_rate_table_bridge[] = {
 157         {0, 0, 0},
 158         /*OPP1 */
 159         {S125M, VDD1_OPP1, 0},
 160         /*OPP2 */
 161         {S250M, VDD1_OPP2, 0},
 162         /*OPP3 */
 163         {S500M, VDD1_OPP3, 0},
 164         /*OPP4 */
 165         {S550M, VDD1_OPP4, 0},
 166         /*OPP5 */
 167         {S600M, VDD1_OPP5, 0},
 168 };
 169 #endif
 170 #endif
 171
 172 struct dspbridge_platform_data *omap_dspbridge_pdata;
 173
 174 u32 vdd1_dsp_freq[6][4] = {
 175         {0, 0, 0, 0},
 176         /*OPP1 */
 177         {0, 90000, 0, 86000},
 178         /*OPP2 */
 179         {0, 180000, 80000, 170000},
 180         /*OPP3 */
 181         {0, 360000, 160000, 340000},
 182         /*OPP4 */
 183         {0, 396000, 325000, 376000},
 184         /*OPP5 */
 185         {0, 430000, 355000, 430000},
 186 };
 187
 188 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
 189 static void bridge_recover(struct work_struct *work)
 190 {
 191         struct dev_object *dev;
 192         struct cfg_devnode *dev_node;
 193         if (atomic_read(&bridge_cref)) {
 194                 INIT_COMPLETION(bridge_comp);
 195                 while (!wait_for_completion_timeout(&bridge_comp,
 196                                                 msecs_to_jiffies(REC_TIMEOUT)))
 197                         pr_info("%s:%d handle(s) still opened\n",
 198                                         __func__, atomic_read(&bridge_cref));
 199         }
 200         dev = dev_get_first();
 201         dev_get_dev_node(dev, &dev_node);
 202         if (!dev_node || proc_auto_start(dev_node, dev))
 203                 pr_err("DSP could not be restarted\n");
 204         recover = false;
 205         complete_all(&bridge_open_comp);
 206 }
 207
 208 void bridge_recover_schedule(void)
 209 {
 210         INIT_COMPLETION(bridge_open_comp);
 211         recover = true;
 212         queue_work(bridge_rec_queue, &bridge_recovery_work);
 213 }
 214 #endif
 215 #ifdef CONFIG_TIDSPBRIDGE_DVFS
 216 static int dspbridge_scale_notification(struct notifier_block *op,
 217                 unsigned long val, void *ptr)
 218 {
 219         struct dspbridge_platform_data *pdata =
 220                                         omap_dspbridge_dev->dev.platform_data;
 221
 222         if (CPUFREQ_POSTCHANGE == val && pdata->dsp_get_opp)
 223                 pwr_pm_post_scale(PRCM_VDD1, pdata->dsp_get_opp());
 224
 225         return 0;
 226 }
 227
 228 static struct notifier_block iva_clk_notifier = {
 229         .notifier_call = dspbridge_scale_notification,
 230         NULL,
 231 };
 232 #endif
 233
 234 /**
 235  * omap3_bridge_startup() - perform low lever initializations
 236  * @pdev:      pointer to platform device
 237  *
 238  * Initializes recovery, PM and DVFS required data, before calling
 239  * clk and memory init routines.
 240  */
 241 static int omap3_bridge_startup(struct platform_device *pdev)
 242 {
 243         struct dspbridge_platform_data *pdata = pdev->dev.platform_data;
 244         struct drv_data *drv_datap = NULL;
 245         u32 phys_membase, phys_memsize;
 246         int err;
 247
 248 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
 249         bridge_rec_queue = create_workqueue("bridge_rec_queue");
 250         INIT_WORK(&bridge_recovery_work, bridge_recover);
 251         INIT_COMPLETION(bridge_comp);
 252 #endif
 253
 254 #ifdef CONFIG_PM
 255         /* Initialize the wait queue */
 256         bridge_suspend_data.suspended = 0;
 257         init_waitqueue_head(&bridge_suspend_data.suspend_wq);
 258
 259 #ifdef CONFIG_TIDSPBRIDGE_DVFS
 260         for (i = 0; i < 6; i++)
 261                 pdata->mpu_speed[i] = vdd1_rate_table_bridge[i].rate;
 262
 263         err = cpufreq_register_notifier(&iva_clk_notifier,
 264                                         CPUFREQ_TRANSITION_NOTIFIER);
 265         if (err)
 266                 pr_err("%s: clk_notifier_register failed for iva2_ck\n",
 267                                                                 __func__);
 268 #endif
 269 #endif
 270
 271         dsp_clk_init();
 272
 273         drv_datap = kzalloc(sizeof(struct drv_data), GFP_KERNEL);
 274         if (!drv_datap) {
 275                 err = -ENOMEM;
 276                 goto err1;
 277         }
 278
 279         drv_datap->shm_size = shm_size;
 280         drv_datap->tc_wordswapon = tc_wordswapon;
 281
 282         if (base_img) {
 283                 drv_datap->base_img = kmalloc(strlen(base_img) + 1, GFP_KERNEL);
 284                 if (!drv_datap->base_img) {
 285                         err = -ENOMEM;
 286                         goto err2;
 287                 }
 288                 strncpy(drv_datap->base_img, base_img, strlen(base_img) + 1);
 289         }
 290
 291         dev_set_drvdata(bridge, drv_datap);
 292
 293         if (shm_size < 0x10000) {       /* 64 KB */
 294                 err = -EINVAL;
 295                 pr_err("%s: shm size must be at least 64 KB\n", __func__);
 296                 goto err3;
 297         }
 298         dev_dbg(bridge, "%s: requested shm_size = 0x%x\n", __func__, shm_size);
 299
 300         phys_membase = pdata->phys_mempool_base;
 301         phys_memsize = pdata->phys_mempool_size;
 302         if (phys_membase > 0 && phys_memsize > 0)
 303                 mem_ext_phys_pool_init(phys_membase, phys_memsize);
 304
 305         if (tc_wordswapon)
 306                 dev_dbg(bridge, "%s: TC Word Swap is enabled\n", __func__);
 307
 308         driver_context = dsp_init(&err);
 309         if (err) {
 310                 pr_err("DSP Bridge driver initialization failed\n");
 311                 goto err4;
 312         }
 313
 314         return 0;
 315
 316 err4:
 317         mem_ext_phys_pool_release();
 318 err3:
 319         kfree(drv_datap->base_img);
 320 err2:
 321         kfree(drv_datap);
 322 err1:
 323 #ifdef CONFIG_TIDSPBRIDGE_DVFS
 324         cpufreq_unregister_notifier(&iva_clk_notifier,
 325                                         CPUFREQ_TRANSITION_NOTIFIER);
 326 #endif
 327         dsp_clk_exit();
 328
 329         return err;
 330 }
 331
 332 static int __devinit omap34_xx_bridge_probe(struct platform_device *pdev)
 333 {
 334         int err;
 335         dev_t dev = 0;
 336 #ifdef CONFIG_TIDSPBRIDGE_DVFS
 337         int i = 0;
 338 #endif
 339
 340         omap_dspbridge_dev = pdev;
 341
 342         /* Global bridge device */
 343         bridge = &omap_dspbridge_dev->dev;
 344
 345         /* Bridge low level initializations */
 346         err = omap3_bridge_startup(pdev);
 347         if (err)
 348                 goto err1;
 349
 350         /* use 2.6 device model */
 351         err = alloc_chrdev_region(&dev, 0, 1, driver_name);
 352         if (err) {
 353                 pr_err("%s: Can't get major %d\n", __func__, driver_major);
 354                 goto err1;
 355         }
 356
 357         cdev_init(&bridge_cdev, &bridge_fops);
 358         bridge_cdev.owner = THIS_MODULE;
 359
 360         err = cdev_add(&bridge_cdev, dev, 1);
 361         if (err) {
 362                 pr_err("%s: Failed to add bridge device\n", __func__);
 363                 goto err2;
 364         }
 365
 366         /* udev support */
 367         bridge_class = class_create(THIS_MODULE, "ti_bridge");
 368         if (IS_ERR(bridge_class)) {
 369                 pr_err("%s: Error creating bridge class\n", __func__);
 370                 goto err3;
 371         }
 372
 373         driver_major = MAJOR(dev);
 374         device_create(bridge_class, NULL, MKDEV(driver_major, 0),
 375                       NULL, "DspBridge");
 376         pr_info("DSP Bridge driver loaded\n");
 377
 378         return 0;
 379
 380 err3:
 381         cdev_del(&bridge_cdev);
 382 err2:
 383         unregister_chrdev_region(dev, 1);
 384 err1:
 385         return err;
 386 }
 387
 388 static int __devexit omap34_xx_bridge_remove(struct platform_device *pdev)
 389 {
 390         dev_t devno;
 391         bool ret;
 392         int status = 0;
 393         struct drv_data *drv_datap = dev_get_drvdata(bridge);
 394
 395         /* Retrieve the Object handle from the driver data */
 396         if (!drv_datap || !drv_datap->drv_object) {
 397                 status = -ENODATA;
 398                 pr_err("%s: Failed to retrieve the object handle\n", __func__);
 399                 goto func_cont;
 400         }
 401
 402 #ifdef CONFIG_TIDSPBRIDGE_DVFS
 403         if (cpufreq_unregister_notifier(&iva_clk_notifier,
 404                                                 CPUFREQ_TRANSITION_NOTIFIER))
 405                 pr_err("%s: cpufreq_unregister_notifier failed for iva2_ck\n",
 406                        __func__);
 407 #endif /* #ifdef CONFIG_TIDSPBRIDGE_DVFS */
 408
 409         if (driver_context) {
 410                 /* Put the DSP in reset state */
 411                 ret = dsp_deinit(driver_context);
 412                 driver_context = 0;
 413                 DBC_ASSERT(ret == true);
 414         }
 415
 416 func_cont:
 417         mem_ext_phys_pool_release();
 418
 419         dsp_clk_exit();
 420
 421         devno = MKDEV(driver_major, 0);
 422         cdev_del(&bridge_cdev);
 423         unregister_chrdev_region(devno, 1);
 424         if (bridge_class) {
 425                 /* remove the device from sysfs */
 426                 device_destroy(bridge_class, MKDEV(driver_major, 0));
 427                 class_destroy(bridge_class);
 428
 429         }
 430         return 0;
 431 }
 432
 433 #ifdef CONFIG_PM
 434 static int BRIDGE_SUSPEND(struct platform_device *pdev, pm_message_t state)
 435 {
 436         u32 status;
 437         u32 command = PWR_EMERGENCYDEEPSLEEP;
 438
 439         status = pwr_sleep_dsp(command, time_out);
 440         if (status)
 441                 return -1;
 442
 443         bridge_suspend_data.suspended = 1;
 444         return 0;
 445 }
 446
 447 static int BRIDGE_RESUME(struct platform_device *pdev)
 448 {
 449         u32 status;
 450
 451         status = pwr_wake_dsp(time_out);
 452         if (status)
 453                 return -1;
 454
 455         bridge_suspend_data.suspended = 0;
 456         wake_up(&bridge_suspend_data.suspend_wq);
 457         return 0;
 458 }
 459 #else
 460 #define BRIDGE_SUSPEND NULL
 461 #define BRIDGE_RESUME NULL
 462 #endif
 463
 464 static struct platform_driver bridge_driver = {
 465         .driver = {
 466                    .name = BRIDGE_NAME,
 467                    },
 468         .probe = omap34_xx_bridge_probe,
 469         .remove = __devexit_p(omap34_xx_bridge_remove),
 470         .suspend = BRIDGE_SUSPEND,
 471         .resume = BRIDGE_RESUME,
 472 };
 473
 474 static int __init bridge_init(void)
 475 {
 476         return platform_driver_register(&bridge_driver);
 477 }
 478
 479 static void __exit bridge_exit(void)
 480 {
 481         platform_driver_unregister(&bridge_driver);
 482 }
 483
 484 /*
 485  * This function is called when an application opens handle to the
 486  * bridge driver.
 487  */
 488 static int bridge_open(struct inode *ip, struct file *filp)
 489 {
 490         int status = 0;
 491         struct process_context *pr_ctxt = NULL;
 492
 493         /*
 494          * Allocate a new process context and insert it into global
 495          * process context list.
 496          */
 497
 498 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
 499         if (recover) {
 500                 if (filp->f_flags & O_NONBLOCK ||
 501                         wait_for_completion_interruptible(&bridge_open_comp))
 502                         return -EBUSY;
 503         }
 504 #endif
 505         pr_ctxt = kzalloc(sizeof(struct process_context), GFP_KERNEL);
 506         if (pr_ctxt) {
 507                 pr_ctxt->res_state = PROC_RES_ALLOCATED;
 508                 spin_lock_init(&pr_ctxt->dmm_map_lock);
 509                 INIT_LIST_HEAD(&pr_ctxt->dmm_map_list);
 510                 spin_lock_init(&pr_ctxt->dmm_rsv_lock);
 511                 INIT_LIST_HEAD(&pr_ctxt->dmm_rsv_list);
 512
 513                 pr_ctxt->node_id = kzalloc(sizeof(struct idr), GFP_KERNEL);
 514                 if (pr_ctxt->node_id) {
 515                         idr_init(pr_ctxt->node_id);
 516                 } else {
 517                         status = -ENOMEM;
 518                         goto err;
 519                 }
 520
 521                 pr_ctxt->stream_id = kzalloc(sizeof(struct idr), GFP_KERNEL);
 522                 if (pr_ctxt->stream_id)
 523                         idr_init(pr_ctxt->stream_id);
 524                 else
 525                         status = -ENOMEM;
 526         } else {
 527                 status = -ENOMEM;
 528         }
 529 err:
 530         filp->private_data = pr_ctxt;
 531 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
 532         if (!status)
 533                 atomic_inc(&bridge_cref);
 534 #endif
 535         return status;
 536 }
 537
 538 /*
 539  * This function is called when an application closes handle to the bridge
 540  * driver.
 541  */
 542 static int bridge_release(struct inode *ip, struct file *filp)
 543 {
 544         int status = 0;
 545         struct process_context *pr_ctxt;
 546
 547         if (!filp->private_data) {
 548                 status = -EIO;
 549                 goto err;
 550         }
 551
 552         pr_ctxt = filp->private_data;
 553         flush_signals(current);
 554         drv_remove_all_resources(pr_ctxt);
 555         proc_detach(pr_ctxt);
 556         kfree(pr_ctxt);
 557
 558         filp->private_data = NULL;
 559
 560 err:
 561 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
 562         if (!atomic_dec_return(&bridge_cref))
 563                 complete(&bridge_comp);
 564 #endif
 565         return status;
 566 }
 567
 568 /* This function provides IO interface to the bridge driver. */
 569 static long bridge_ioctl(struct file *filp, unsigned int code,
 570                          unsigned long args)
 571 {
 572         int status;
 573         u32 retval = 0;
 574         union trapped_args buf_in;
 575
 576         DBC_REQUIRE(filp != NULL);
 577 #ifdef CONFIG_TIDSPBRIDGE_RECOVERY
 578         if (recover) {
 579                 status = -EIO;
 580                 goto err;
 581         }
 582 #endif
 583 #ifdef CONFIG_PM
 584         status = omap34_xxbridge_suspend_lockout(&bridge_suspend_data, filp);
 585         if (status != 0)
 586                 return status;
 587 #endif
 588
 589         if (!filp->private_data) {
 590                 status = -EIO;
 591                 goto err;
 592         }
 593
 594         status = copy_from_user(&buf_in, (union trapped_args *)args,
 595                                 sizeof(union trapped_args));
 596
 597         if (!status) {
 598                 status = api_call_dev_ioctl(code, &buf_in, &retval,
 599                                              filp->private_data);
 600
 601                 if (!status) {
 602                         status = retval;
 603                 } else {
 604                         dev_dbg(bridge, "%s: IOCTL Failed, code: 0x%x "
 605                                 "status 0x%x\n", __func__, code, status);
 606                         status = -1;
 607                 }
 608
 609         }
 610
 611 err:
 612         return status;
 613 }
 614
 615 /* This function maps kernel space memory to user space memory. */
 616 static int bridge_mmap(struct file *filp, struct vm_area_struct *vma)
 617 {
 618         u32 offset = vma->vm_pgoff << PAGE_SHIFT;
 619         u32 status;
 620
 621         DBC_ASSERT(vma->vm_start < vma->vm_end);
 622
 623         vma->vm_flags |= VM_RESERVED | VM_IO;
 624         vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
 625
 626         dev_dbg(bridge, "%s: vm filp %p offset %x start %lx end %lx page_prot "
 627                 "%lx flags %lx\n", __func__, filp, offset,
 628                 vma->vm_start, vma->vm_end, vma->vm_page_prot, vma->vm_flags);
 629
 630         status = remap_pfn_range(vma, vma->vm_start, vma->vm_pgoff,
 631                                  vma->vm_end - vma->vm_start,
 632                                  vma->vm_page_prot);
 633         if (status != 0)
 634                 status = -EAGAIN;
 635
 636         return status;
 637 }
 638
 639 /* To remove all process resources before removing the process from the
 640  * process context list */
 641 int drv_remove_all_resources(void *process_ctxt)
 642 {
 643         int status = 0;
 644         struct process_context *ctxt = (struct process_context *)process_ctxt;
 645         drv_remove_all_strm_res_elements(ctxt);
 646         drv_remove_all_node_res_elements(ctxt);
 647         drv_remove_all_dmm_res_elements(ctxt);
 648         ctxt->res_state = PROC_RES_FREED;
 649         return status;
 650 }
 651
 652 /* Bridge driver initialization and de-initialization functions */
 653 module_init(bridge_init);
 654 module_exit(bridge_exit);