err.no Git - linux-2.6/blob - drivers/media/dvb/siano/smscoreapi.c

   1 /*
   2  *  Siano core API module
   3  *
   4  *  This file contains implementation for the interface to sms core component
   5  *
   6  *  author: Anatoly Greenblat
   7  *
   8  *  Copyright (c), 2005-2008 Siano Mobile Silicon, Inc.
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License version 3 as
  12  *  published by the Free Software Foundation;
  13  *
  14  *  Software distributed under the License is distributed on an "AS IS"
  15  *  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
  16  *
  17  *  See the GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  */
  23
  24 #include <linux/kernel.h>
  25 #include <linux/init.h>
  26 #include <linux/module.h>
  27 #include <linux/moduleparam.h>
  28 #include <linux/dma-mapping.h>
  29 #include <linux/delay.h>
  30 #include <asm/io.h>
  31
  32 #include <linux/firmware.h>
  33
  34 #include "smscoreapi.h"
  35
  36 #define PERROR(fmt, args...)\
  37         printk(KERN_ERR "smscore error: line %d- %s(): " fmt, \
  38                 __LINE__,  __func__, ## args)
  39
  40 #ifdef SMSCORE_DEBUG
  41 #undef PWARNING
  42 #  define PWARNING(fmt, args...) printk(KERN_INFO "smscore warning: " \
  43                                         "line %d- %s(): " fmt, \
  44                                         __LINE__, __func__, ## args)
  45 #undef PDEBUG                                   /* undef it, just in case */
  46 #  define PDEBUG(fmt, args...)   printk(KERN_INFO "smscore - %s(): " fmt, \
  47                                         __func__, ## args)
  48 #else /*SMSCORE_DEBUG*/
  49 #define PDEBUG(fmt, args...)
  50 #define PWARNING(fmt, args...)
  51 #endif
  52
  53 struct smscore_device_notifyee_t {
  54         struct list_head entry;
  55         hotplug_t hotplug;
  56 };
  57
  58 struct smscore_idlist_t {
  59         struct list_head entry;
  60         int             id;
  61         int             data_type;
  62 };
  63
  64 struct smscore_client_t {
  65         struct list_head entry;
  66         struct smscore_device_t *coredev;
  67         void                    *context;
  68         struct list_head        idlist;
  69         onresponse_t    onresponse_handler;
  70         onremove_t              onremove_handler;
  71 };
  72
  73 struct smscore_device_t {
  74         struct list_head entry;
  75
  76         struct list_head clients;
  77         struct list_head subclients;
  78         spinlock_t              clientslock;
  79
  80         struct list_head buffers;
  81         spinlock_t              bufferslock;
  82         int                             num_buffers;
  83
  84         void                    *common_buffer;
  85         int                             common_buffer_size;
  86         dma_addr_t              common_buffer_phys;
  87
  88         void                    *context;
  89         struct device   *device;
  90
  91         char                    devpath[32];
  92         unsigned long   device_flags;
  93
  94         setmode_t               setmode_handler;
  95         detectmode_t    detectmode_handler;
  96         sendrequest_t   sendrequest_handler;
  97         preload_t               preload_handler;
  98         postload_t              postload_handler;
  99
 100         int                             mode, modes_supported;
 101
 102         struct completion version_ex_done, data_download_done, trigger_done;
 103         struct completion init_device_done, reload_start_done, resume_done;
 104 };
 105
 106 struct smscore_registry_entry_t {
 107         struct list_head entry;
 108         char                    devpath[32];
 109         int                             mode;
 110         enum sms_device_type_st type;
 111 };
 112
 113 struct list_head g_smscore_notifyees;
 114 struct list_head g_smscore_devices;
 115 kmutex_t g_smscore_deviceslock;
 116
 117 struct list_head g_smscore_registry;
 118 kmutex_t g_smscore_registrylock;
 119
 120 static int default_mode = 4;
 121
 122 module_param(default_mode, int, 0644);
 123 MODULE_PARM_DESC(default_mode, "default firmware id (device mode)");
 124
 125 static struct smscore_registry_entry_t *smscore_find_registry(char *devpath)
 126 {
 127         struct smscore_registry_entry_t *entry;
 128         struct list_head *next;
 129
 130         kmutex_lock(&g_smscore_registrylock);
 131         for (next = g_smscore_registry.next;
 132              next != &g_smscore_registry;
 133              next = next->next) {
 134                 entry = (struct smscore_registry_entry_t *) next;
 135                 if (!strcmp(entry->devpath, devpath)) {
 136                         kmutex_unlock(&g_smscore_registrylock);
 137                         return entry;
 138                 }
 139         }
 140         entry = (struct smscore_registry_entry_t *)
 141                         kmalloc(sizeof(struct smscore_registry_entry_t),
 142                                 GFP_KERNEL);
 143         if (entry) {
 144                 entry->mode = default_mode;
 145                 strcpy(entry->devpath, devpath);
 146                 list_add(&entry->entry, &g_smscore_registry);
 147         } else
 148                 printk(KERN_ERR "%s failed to create smscore_registry.\n",
 149                        __func__);
 150         kmutex_unlock(&g_smscore_registrylock);
 151         return entry;
 152 }
 153
 154 int smscore_registry_getmode(char *devpath)
 155 {
 156         struct smscore_registry_entry_t *entry;
 157
 158         entry = smscore_find_registry(devpath);
 159         if (entry)
 160                 return entry->mode;
 161         else
 162                 printk(KERN_ERR "%s No registry found.\n", __func__);
 163
 164         return default_mode;
 165 }
 166
 167 enum sms_device_type_st smscore_registry_gettype(char *devpath)
 168 {
 169         struct smscore_registry_entry_t *entry;
 170
 171         entry = smscore_find_registry(devpath);
 172         if (entry)
 173                 return entry->type;
 174         else
 175                 printk(KERN_ERR "%s No registry found.\n", __func__);
 176
 177         return -1;
 178 }
 179
 180 void smscore_registry_setmode(char *devpath, int mode)
 181 {
 182         struct smscore_registry_entry_t *entry;
 183
 184         entry = smscore_find_registry(devpath);
 185         if (entry)
 186                 entry->mode = mode;
 187         else
 188                 printk(KERN_ERR "%s No registry found.\n", __func__);
 189 }
 190
 191 void smscore_registry_settype(char *devpath, enum sms_device_type_st type)
 192 {
 193         struct smscore_registry_entry_t *entry;
 194
 195         entry = smscore_find_registry(devpath);
 196         if (entry)
 197                 entry->type = type;
 198         else
 199                 printk(KERN_ERR "%s No registry found.\n", __func__);
 200 }
 201
 202
 203 void list_add_locked(struct list_head *new, struct list_head *head,
 204                      spinlock_t *lock)
 205 {
 206         unsigned long flags;
 207
 208         spin_lock_irqsave(lock, flags);
 209
 210         list_add(new, head);
 211
 212         spin_unlock_irqrestore(lock, flags);
 213 }
 214
 215 /**
 216  * register a client callback that called when device plugged in/unplugged
 217  * NOTE: if devices exist callback is called immediately for each device
 218  *
 219  * @param hotplug callback
 220  *
 221  * @return 0 on success, <0 on error.
 222  */
 223 int smscore_register_hotplug(hotplug_t hotplug)
 224 {
 225         struct smscore_device_notifyee_t *notifyee;
 226         struct list_head *next, *first;
 227         int rc = 0;
 228
 229         kmutex_lock(&g_smscore_deviceslock);
 230
 231         notifyee = kmalloc(sizeof(struct smscore_device_notifyee_t),
 232                            GFP_KERNEL);
 233         if (notifyee) {
 234                 /* now notify callback about existing devices */
 235                 first = &g_smscore_devices;
 236                 for (next = first->next;
 237                      next != first && !rc;
 238                      next = next->next) {
 239                         struct smscore_device_t *coredev =
 240                                 (struct smscore_device_t *) next;
 241                         rc = hotplug(coredev, coredev->device, 1);
 242                 }
 243
 244                 if (rc >= 0) {
 245                         notifyee->hotplug = hotplug;
 246                         list_add(&notifyee->entry, &g_smscore_notifyees);
 247                 } else
 248                         kfree(notifyee);
 249         } else
 250                 rc = -ENOMEM;
 251
 252         kmutex_unlock(&g_smscore_deviceslock);
 253
 254         return rc;
 255 }
 256
 257 /**
 258  * unregister a client callback that called when device plugged in/unplugged
 259  *
 260  * @param hotplug callback
 261  *
 262  */
 263 void smscore_unregister_hotplug(hotplug_t hotplug)
 264 {
 265         struct list_head *next, *first;
 266
 267         kmutex_lock(&g_smscore_deviceslock);
 268
 269         first = &g_smscore_notifyees;
 270
 271         for (next = first->next; next != first;) {
 272                 struct smscore_device_notifyee_t *notifyee =
 273                         (struct smscore_device_notifyee_t *) next;
 274                 next = next->next;
 275
 276                 if (notifyee->hotplug == hotplug) {
 277                         list_del(&notifyee->entry);
 278                         kfree(notifyee);
 279                 }
 280         }
 281
 282         kmutex_unlock(&g_smscore_deviceslock);
 283 }
 284
 285 void smscore_notify_clients(struct smscore_device_t *coredev)
 286 {
 287         struct smscore_client_t *client;
 288
 289         /* the client must call smscore_unregister_client from remove handler */
 290         while (!list_empty(&coredev->clients)) {
 291                 client = (struct smscore_client_t *) coredev->clients.next;
 292                 client->onremove_handler(client->context);
 293         }
 294 }
 295
 296 int smscore_notify_callbacks(struct smscore_device_t *coredev,
 297                              struct device *device, int arrival)
 298 {
 299         struct list_head *next, *first;
 300         int rc = 0;
 301
 302         /* note: must be called under g_deviceslock */
 303
 304         first = &g_smscore_notifyees;
 305
 306         for (next = first->next; next != first; next = next->next) {
 307                 rc = ((struct smscore_device_notifyee_t *) next)->
 308                                 hotplug(coredev, device, arrival);
 309                 if (rc < 0)
 310                         break;
 311         }
 312
 313         return rc;
 314 }
 315
 316 struct smscore_buffer_t *smscore_createbuffer(u8 *buffer, void *common_buffer,
 317                                        dma_addr_t common_buffer_phys)
 318 {
 319         struct smscore_buffer_t *cb =
 320                 kmalloc(sizeof(struct smscore_buffer_t), GFP_KERNEL);
 321         if (!cb) {
 322                 printk(KERN_INFO "%s kmalloc(...) failed\n", __func__);
 323                 return NULL;
 324         }
 325
 326         cb->p = buffer;
 327         cb->offset_in_common = buffer - (u8 *) common_buffer;
 328         cb->phys = common_buffer_phys + cb->offset_in_common;
 329
 330         return cb;
 331 }
 332
 333 /**
 334  * creates coredev object for a device, prepares buffers,
 335  * creates buffer mappings, notifies registered hotplugs about new device.
 336  *
 337  * @param params device pointer to struct with device specific parameters
 338  *               and handlers
 339  * @param coredev pointer to a value that receives created coredev object
 340  *
 341  * @return 0 on success, <0 on error.
 342  */
 343 int smscore_register_device(struct smsdevice_params_t *params,
 344                             struct smscore_device_t **coredev)
 345 {
 346         struct smscore_device_t *dev;
 347         u8 *buffer;
 348
 349         dev = kzalloc(sizeof(struct smscore_device_t), GFP_KERNEL);
 350         if (!dev) {
 351                 printk(KERN_INFO "%s kzalloc(...) failed\n", __func__);
 352                 return -ENOMEM;
 353         }
 354
 355         /* init list entry so it could be safe in smscore_unregister_device */
 356         INIT_LIST_HEAD(&dev->entry);
 357
 358         /* init queues */
 359         INIT_LIST_HEAD(&dev->clients);
 360         INIT_LIST_HEAD(&dev->buffers);
 361
 362         /* init locks */
 363         spin_lock_init(&dev->clientslock);
 364         spin_lock_init(&dev->bufferslock);
 365
 366         /* init completion events */
 367         init_completion(&dev->version_ex_done);
 368         init_completion(&dev->data_download_done);
 369         init_completion(&dev->trigger_done);
 370         init_completion(&dev->init_device_done);
 371         init_completion(&dev->reload_start_done);
 372         init_completion(&dev->resume_done);
 373
 374         /* alloc common buffer */
 375         dev->common_buffer_size = params->buffer_size * params->num_buffers;
 376         dev->common_buffer = dma_alloc_coherent(NULL, dev->common_buffer_size,
 377                                                 &dev->common_buffer_phys,
 378                                                 GFP_KERNEL | GFP_DMA);
 379         if (!dev->common_buffer) {
 380                 smscore_unregister_device(dev);
 381                 return -ENOMEM;
 382         }
 383
 384         /* prepare dma buffers */
 385         for (buffer = dev->common_buffer;
 386              dev->num_buffers < params->num_buffers;
 387              dev->num_buffers++, buffer += params->buffer_size) {
 388                 struct smscore_buffer_t *cb =
 389                         smscore_createbuffer(buffer, dev->common_buffer,
 390                                              dev->common_buffer_phys);
 391                 if (!cb) {
 392                         smscore_unregister_device(dev);
 393                         return -ENOMEM;
 394                 }
 395
 396                 smscore_putbuffer(dev, cb);
 397         }
 398
 399         printk(KERN_INFO "%s allocated %d buffers\n",
 400                __func__, dev->num_buffers);
 401
 402         dev->mode = DEVICE_MODE_NONE;
 403         dev->context = params->context;
 404         dev->device = params->device;
 405         dev->setmode_handler = params->setmode_handler;
 406         dev->detectmode_handler = params->detectmode_handler;
 407         dev->sendrequest_handler = params->sendrequest_handler;
 408         dev->preload_handler = params->preload_handler;
 409         dev->postload_handler = params->postload_handler;
 410
 411         dev->device_flags = params->flags;
 412         strcpy(dev->devpath, params->devpath);
 413
 414         smscore_registry_settype(dev->devpath, params->device_type);
 415
 416         /* add device to devices list */
 417         kmutex_lock(&g_smscore_deviceslock);
 418         list_add(&dev->entry, &g_smscore_devices);
 419         kmutex_unlock(&g_smscore_deviceslock);
 420
 421         *coredev = dev;
 422
 423         printk(KERN_INFO "%s device %p created\n", __func__, dev);
 424
 425         return 0;
 426 }
 427
 428 /**
 429  * sets initial device mode and notifies client hotplugs that device is ready
 430  *
 431  * @param coredev pointer to a coredev object returned by
 432  *                smscore_register_device
 433  *
 434  * @return 0 on success, <0 on error.
 435  */
 436 int smscore_start_device(struct smscore_device_t *coredev)
 437 {
 438         int rc = smscore_set_device_mode(
 439                         coredev, smscore_registry_getmode(coredev->devpath));
 440         if (rc < 0) {
 441                 printk(KERN_INFO "%s set device mode faile , rc %d\n",
 442                        __func__, rc);
 443                 return rc;
 444         }
 445
 446         kmutex_lock(&g_smscore_deviceslock);
 447
 448         rc = smscore_notify_callbacks(coredev, coredev->device, 1);
 449
 450         printk(KERN_INFO "%s device %p started, rc %d\n",
 451                __func__, coredev, rc);
 452
 453         kmutex_unlock(&g_smscore_deviceslock);
 454
 455         return rc;
 456 }
 457
 458 int smscore_sendrequest_and_wait(struct smscore_device_t *coredev, void *buffer,
 459                                  size_t size, struct completion *completion)
 460 {
 461         int rc = coredev->sendrequest_handler(coredev->context, buffer, size);
 462         if (rc < 0) {
 463                 printk(KERN_INFO "%s sendrequest returned error %d\n",
 464                        __func__, rc);
 465                 return rc;
 466         }
 467
 468         return wait_for_completion_timeout(completion,
 469                                            msecs_to_jiffies(10000)) ?
 470                                                 0 : -ETIME;
 471 }
 472
 473 int smscore_load_firmware_family2(struct smscore_device_t *coredev,
 474                                   void *buffer, size_t size)
 475 {
 476         struct SmsFirmware_ST *firmware = (struct SmsFirmware_ST *) buffer;
 477         struct SmsMsgHdr_ST *msg;
 478         u32 mem_address = firmware->StartAddress;
 479         u8 *payload = firmware->Payload;
 480         int rc = 0;
 481
 482         printk(KERN_INFO "%s loading FW to addr 0x%x size %d\n",
 483                __func__, mem_address, firmware->Length);
 484         if (coredev->preload_handler) {
 485                 rc = coredev->preload_handler(coredev->context);
 486                 if (rc < 0)
 487                         return rc;
 488         }
 489
 490         /* PAGE_SIZE buffer shall be enough and dma aligned */
 491         msg = kmalloc(PAGE_SIZE, GFP_KERNEL | GFP_DMA);
 492         if (!msg)
 493                 return -ENOMEM;
 494
 495         if (coredev->mode != DEVICE_MODE_NONE) {
 496                 PDEBUG("Sending reload command\n");
 497                 SMS_INIT_MSG(msg, MSG_SW_RELOAD_START_REQ,
 498                              sizeof(struct SmsMsgHdr_ST));
 499                 rc = smscore_sendrequest_and_wait(coredev, msg,
 500                                                   msg->msgLength,
 501                                                   &coredev->reload_start_done);
 502                 mem_address = *(u32 *) &payload[20];
 503         }
 504
 505         while (size && rc >= 0) {
 506                 struct SmsDataDownload_ST *DataMsg =
 507                         (struct SmsDataDownload_ST *) msg;
 508                 int payload_size = min((int) size, SMS_MAX_PAYLOAD_SIZE);
 509
 510                 SMS_INIT_MSG(msg, MSG_SMS_DATA_DOWNLOAD_REQ,
 511                              (u16)(sizeof(struct SmsMsgHdr_ST) +
 512                                       sizeof(u32) + payload_size));
 513
 514                 DataMsg->MemAddr = mem_address;
 515                 memcpy(DataMsg->Payload, payload, payload_size);
 516
 517                 if ((coredev->device_flags & SMS_ROM_NO_RESPONSE) &&
 518                     (coredev->mode == DEVICE_MODE_NONE))
 519                         rc = coredev->sendrequest_handler(
 520                                 coredev->context, DataMsg,
 521                                 DataMsg->xMsgHeader.msgLength);
 522                 else
 523                         rc = smscore_sendrequest_and_wait(
 524                                 coredev, DataMsg,
 525                                 DataMsg->xMsgHeader.msgLength,
 526                                 &coredev->data_download_done);
 527
 528                 payload += payload_size;
 529                 size -= payload_size;
 530                 mem_address += payload_size;
 531         }
 532
 533         if (rc >= 0) {
 534                 if (coredev->mode == DEVICE_MODE_NONE) {
 535                         struct SmsMsgData_ST *TriggerMsg =
 536                                 (struct SmsMsgData_ST *) msg;
 537
 538                         SMS_INIT_MSG(msg, MSG_SMS_SWDOWNLOAD_TRIGGER_REQ,
 539                                      sizeof(struct SmsMsgHdr_ST) +
 540                                      sizeof(u32) * 5);
 541
 542                         TriggerMsg->msgData[0] = firmware->StartAddress;
 543                                                 /* Entry point */
 544                         TriggerMsg->msgData[1] = 5; /* Priority */
 545                         TriggerMsg->msgData[2] = 0x200; /* Stack size */
 546                         TriggerMsg->msgData[3] = 0; /* Parameter */
 547                         TriggerMsg->msgData[4] = 4; /* Task ID */
 548
 549                         if (coredev->device_flags & SMS_ROM_NO_RESPONSE) {
 550                                 rc = coredev->sendrequest_handler(
 551                                         coredev->context, TriggerMsg,
 552                                         TriggerMsg->xMsgHeader.msgLength);
 553                                 msleep(100);
 554                         } else
 555                                 rc = smscore_sendrequest_and_wait(
 556                                         coredev, TriggerMsg,
 557                                         TriggerMsg->xMsgHeader.msgLength,
 558                                         &coredev->trigger_done);
 559                 } else {
 560                         SMS_INIT_MSG(msg, MSG_SW_RELOAD_EXEC_REQ,
 561                                      sizeof(struct SmsMsgHdr_ST));
 562
 563                         rc = coredev->sendrequest_handler(coredev->context,
 564                                                           msg, msg->msgLength);
 565                 }
 566                 msleep(500);
 567         }
 568
 569         printk(KERN_DEBUG "%s rc=%d, postload=%p \n", __func__, rc,
 570                coredev->postload_handler);
 571
 572         kfree(msg);
 573
 574         return ((rc >= 0) && coredev->postload_handler) ?
 575                 coredev->postload_handler(coredev->context) :
 576                 rc;
 577 }
 578
 579 /**
 580  * loads specified firmware into a buffer and calls device loadfirmware_handler
 581  *
 582  * @param coredev pointer to a coredev object returned by
 583  *                smscore_register_device
 584  * @param filename null-terminated string specifies firmware file name
 585  * @param loadfirmware_handler device handler that loads firmware
 586  *
 587  * @return 0 on success, <0 on error.
 588  */
 589 int smscore_load_firmware_from_file(struct smscore_device_t *coredev,
 590                                     char *filename,
 591                                     loadfirmware_t loadfirmware_handler)
 592 {
 593         int rc = -ENOENT;
 594         const struct firmware *fw;
 595         u8 *fw_buffer;
 596
 597         if (loadfirmware_handler == NULL && !(coredev->device_flags &
 598                                               SMS_DEVICE_FAMILY2))
 599                 return -EINVAL;
 600
 601         rc = request_firmware(&fw, filename, coredev->device);
 602         if (rc < 0) {
 603                 printk(KERN_INFO "%s failed to open \"%s\"\n",
 604                        __func__, filename);
 605                 return rc;
 606         }
 607         printk(KERN_INFO "%s read FW %s, size=%d\"\n", __func__,
 608                filename, fw->size);
 609         fw_buffer = kmalloc(ALIGN(fw->size, SMS_ALLOC_ALIGNMENT),
 610                             GFP_KERNEL | GFP_DMA);
 611         if (fw_buffer) {
 612                 memcpy(fw_buffer, fw->data, fw->size);
 613
 614                 rc = (coredev->device_flags & SMS_DEVICE_FAMILY2) ?
 615                       smscore_load_firmware_family2(coredev,
 616                                                     fw_buffer,
 617                                                     fw->size) :
 618                       loadfirmware_handler(coredev->context,
 619                                            fw_buffer, fw->size);
 620
 621                 kfree(fw_buffer);
 622         } else {
 623                 printk(KERN_INFO "%s failed to allocate firmware buffer\n",
 624                        __func__);
 625                 rc = -ENOMEM;
 626         }
 627
 628         release_firmware(fw);
 629
 630         return rc;
 631 }
 632
 633 int smscore_load_firmware_from_buffer(struct smscore_device_t *coredev,
 634                                       u8 *buffer, int size, int new_mode)
 635 {
 636         PERROR("Feature not implemented yet\n");
 637         return -EFAULT;
 638 }
 639
 640 /**
 641  * notifies all clients registered with the device, notifies hotplugs,
 642  * frees all buffers and coredev object
 643  *
 644  * @param coredev pointer to a coredev object returned by
 645  *                smscore_register_device
 646  *
 647  * @return 0 on success, <0 on error.
 648  */
 649 void smscore_unregister_device(struct smscore_device_t *coredev)
 650 {
 651         struct smscore_buffer_t *cb;
 652         int num_buffers = 0;
 653         int retry = 0;
 654
 655         kmutex_lock(&g_smscore_deviceslock);
 656
 657         smscore_notify_clients(coredev);
 658         smscore_notify_callbacks(coredev, NULL, 0);
 659
 660         /* at this point all buffers should be back
 661          * onresponse must no longer be called */
 662
 663         while (1) {
 664                 while ((cb = smscore_getbuffer(coredev))) {
 665                         kfree(cb);
 666                         num_buffers++;
 667                 }
 668                 if (num_buffers == coredev->num_buffers)
 669                         break;
 670                 if (++retry > 10) {
 671                         printk(KERN_INFO "%s exiting although "
 672                                "not all buffers released.\n", __func__);
 673                         break;
 674                 }
 675
 676                 printk(KERN_INFO "%s waiting for %d buffer(s)\n", __func__,
 677                        coredev->num_buffers - num_buffers);
 678                 msleep(100);
 679         }
 680
 681         printk(KERN_INFO "%s freed %d buffers\n", __func__, num_buffers);
 682
 683         if (coredev->common_buffer)
 684                 dma_free_coherent(NULL, coredev->common_buffer_size,
 685                                   coredev->common_buffer,
 686                                   coredev->common_buffer_phys);
 687
 688         list_del(&coredev->entry);
 689         kfree(coredev);
 690
 691         kmutex_unlock(&g_smscore_deviceslock);
 692
 693         printk(KERN_INFO "%s device %p destroyed\n", __func__, coredev);
 694 }
 695
 696 int smscore_detect_mode(struct smscore_device_t *coredev)
 697 {
 698         void *buffer = kmalloc(sizeof(struct SmsMsgHdr_ST) + SMS_DMA_ALIGNMENT,
 699                                GFP_KERNEL | GFP_DMA);
 700         struct SmsMsgHdr_ST *msg =
 701                 (struct SmsMsgHdr_ST *) SMS_ALIGN_ADDRESS(buffer);
 702         int rc;
 703
 704         if (!buffer)
 705                 return -ENOMEM;
 706
 707         SMS_INIT_MSG(msg, MSG_SMS_GET_VERSION_EX_REQ,
 708                      sizeof(struct SmsMsgHdr_ST));
 709
 710         rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength,
 711                                           &coredev->version_ex_done);
 712         if (rc == -ETIME) {
 713                 printk(KERN_ERR "%s: MSG_SMS_GET_VERSION_EX_REQ "
 714                        "failed first try\n", __func__);
 715
 716                 if (wait_for_completion_timeout(&coredev->resume_done,
 717                                                 msecs_to_jiffies(5000))) {
 718                         rc = smscore_sendrequest_and_wait(
 719                                 coredev, msg, msg->msgLength,
 720                                 &coredev->version_ex_done);
 721                         if (rc < 0)
 722                                 printk(KERN_ERR "%s: "
 723                                        "MSG_SMS_GET_VERSION_EX_REQ failed "
 724                                        "second try, rc %d\n", __func__, rc);
 725                 } else
 726                         rc = -ETIME;
 727         }
 728
 729         kfree(buffer);
 730
 731         return rc;
 732 }
 733
 734 char *smscore_fw_lkup[][SMS_NUM_OF_DEVICE_TYPES] = {
 735         /*Stellar               NOVA A0         Nova B0         VEGA*/
 736         /*DVBT*/
 737         {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
 738         /*DVBH*/
 739         {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
 740         /*TDMB*/
 741         {"none", "tdmb_nova_12mhz.inp", "none", "none"},
 742         /*DABIP*/
 743         {"none", "none", "none", "none"},
 744         /*BDA*/
 745         {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
 746         /*ISDBT*/
 747         {"none", "isdbt_nova_12mhz.inp", "dvb_nova_12mhz.inp", "none"},
 748         /*ISDBTBDA*/
 749         {"none", "isdbt_nova_12mhz.inp", "isdbt_nova_12mhz_b0.inp", "none"},
 750         /*CMMB*/
 751         {"none", "none", "none", "cmmb_vega_12mhz.inp"}
 752 };
 753
 754
 755 /**
 756  * calls device handler to change mode of operation
 757  * NOTE: stellar/usb may disconnect when changing mode
 758  *
 759  * @param coredev pointer to a coredev object returned by
 760  *                smscore_register_device
 761  * @param mode requested mode of operation
 762  *
 763  * @return 0 on success, <0 on error.
 764  */
 765 int smscore_set_device_mode(struct smscore_device_t *coredev, int mode)
 766 {
 767         void *buffer;
 768         int rc = 0;
 769         enum sms_device_type_st type;
 770
 771         PDEBUG("set device mode to %d\n", mode);
 772         if (coredev->device_flags & SMS_DEVICE_FAMILY2) {
 773                 if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_RAW_TUNER) {
 774                         printk(KERN_INFO "%s invalid mode specified %d\n",
 775                                __func__, mode);
 776                         return -EINVAL;
 777                 }
 778
 779                 smscore_registry_setmode(coredev->devpath, mode);
 780
 781                 if (!(coredev->device_flags & SMS_DEVICE_NOT_READY)) {
 782                         rc = smscore_detect_mode(coredev);
 783                         if (rc < 0) {
 784                                 printk(KERN_INFO "%s mode detect failed %d\n",
 785                                        __func__, rc);
 786                                 return rc;
 787                         }
 788                 }
 789
 790                 if (coredev->mode == mode) {
 791                         printk(KERN_INFO "%s device mode %d already set\n",
 792                                __func__, mode);
 793                         return 0;
 794                 }
 795
 796                 if (!(coredev->modes_supported & (1 << mode))) {
 797                         type = smscore_registry_gettype(coredev->devpath);
 798                         rc = smscore_load_firmware_from_file(
 799                                 coredev, smscore_fw_lkup[mode][type], NULL);
 800                         if (rc < 0) {
 801                                 printk(KERN_INFO "%s load firmware "
 802                                        "failed %d\n", __func__, rc);
 803                                 return rc;
 804                         }
 805                 } else
 806                         printk(KERN_INFO "%s mode %d supported by running "
 807                                "firmware\n", __func__, mode);
 808
 809                 buffer = kmalloc(sizeof(struct SmsMsgData_ST) +
 810                                  SMS_DMA_ALIGNMENT, GFP_KERNEL | GFP_DMA);
 811                 if (buffer) {
 812                         struct SmsMsgData_ST *msg =
 813                                 (struct SmsMsgData_ST *)
 814                                         SMS_ALIGN_ADDRESS(buffer);
 815
 816                         SMS_INIT_MSG(&msg->xMsgHeader, MSG_SMS_INIT_DEVICE_REQ,
 817                                      sizeof(struct SmsMsgData_ST));
 818                         msg->msgData[0] = mode;
 819
 820                         rc = smscore_sendrequest_and_wait(
 821                                 coredev, msg, msg->xMsgHeader.msgLength,
 822                                 &coredev->init_device_done);
 823
 824                         kfree(buffer);
 825                 } else {
 826                         printk(KERN_INFO "%s Could not allocate buffer for "
 827                                "init device message.\n", __func__);
 828                         rc = -ENOMEM;
 829                 }
 830         } else {
 831                 if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_DVBT_BDA) {
 832                         printk(KERN_INFO "%s invalid mode specified %d\n",
 833                                __func__, mode);
 834                         return -EINVAL;
 835                 }
 836
 837                 smscore_registry_setmode(coredev->devpath, mode);
 838
 839                 if (coredev->detectmode_handler)
 840                         coredev->detectmode_handler(coredev->context,
 841                                                     &coredev->mode);
 842
 843                 if (coredev->mode != mode && coredev->setmode_handler)
 844                         rc = coredev->setmode_handler(coredev->context, mode);
 845         }
 846
 847         if (rc >= 0) {
 848                 coredev->mode = mode;
 849                 coredev->device_flags &= ~SMS_DEVICE_NOT_READY;
 850         }
 851
 852         if (rc != 0)
 853                 printk(KERN_INFO "%s return error code %d.\n", __func__, rc);
 854         return rc;
 855 }
 856
 857 /**
 858  * calls device handler to get current mode of operation
 859  *
 860  * @param coredev pointer to a coredev object returned by
 861  *                smscore_register_device
 862  *
 863  * @return current mode
 864  */
 865 int smscore_get_device_mode(struct smscore_device_t *coredev)
 866 {
 867         return coredev->mode;
 868 }
 869
 870 /**
 871  * find client by response id & type within the clients list.
 872  * return client handle or NULL.
 873  *
 874  * @param coredev pointer to a coredev object returned by
 875  *                smscore_register_device
 876  * @param data_type client data type (SMS_DONT_CARE for all types)
 877  * @param id client id (SMS_DONT_CARE for all id)
 878  *
 879  */
 880 struct smscore_client_t *smscore_find_client(struct smscore_device_t *coredev,
 881                                       int data_type, int id)
 882 {
 883         struct smscore_client_t *client = NULL;
 884         struct list_head *next, *first;
 885         unsigned long flags;
 886         struct list_head *firstid, *nextid;
 887
 888
 889         spin_lock_irqsave(&coredev->clientslock, flags);
 890         first = &coredev->clients;
 891         for (next = first->next;
 892              (next != first) && !client;
 893              next = next->next) {
 894                 firstid = &((struct smscore_client_t *)next)->idlist;
 895                 for (nextid = firstid->next;
 896                      nextid != firstid;
 897                      nextid = nextid->next) {
 898                         if ((((struct smscore_idlist_t *)nextid)->id == id) &&
 899                             (((struct smscore_idlist_t *)nextid)->data_type == data_type ||
 900                             (((struct smscore_idlist_t *)nextid)->data_type == 0))) {
 901                                 client = (struct smscore_client_t *) next;
 902                                 break;
 903                         }
 904                 }
 905         }
 906         spin_unlock_irqrestore(&coredev->clientslock, flags);
 907         return client;
 908 }
 909
 910 /**
 911  * find client by response id/type, call clients onresponse handler
 912  * return buffer to pool on error
 913  *
 914  * @param coredev pointer to a coredev object returned by
 915  *                smscore_register_device
 916  * @param cb pointer to response buffer descriptor
 917  *
 918  */
 919 void smscore_onresponse(struct smscore_device_t *coredev,
 920                         struct smscore_buffer_t *cb)
 921 {
 922         struct SmsMsgHdr_ST *phdr =
 923                 (struct SmsMsgHdr_ST *)((u8 *) cb->p + cb->offset);
 924         struct smscore_client_t *client =
 925                 smscore_find_client(coredev, phdr->msgType, phdr->msgDstId);
 926         int rc = -EBUSY;
 927
 928         static unsigned long last_sample_time; /* = 0; */
 929         static int data_total; /* = 0; */
 930         unsigned long time_now = jiffies_to_msecs(jiffies);
 931
 932         if (!last_sample_time)
 933                 last_sample_time = time_now;
 934
 935         if (time_now - last_sample_time > 10000) {
 936                 printk(KERN_DEBUG "\n%s data rate %d bytes/secs\n", __func__,
 937                        (int)((data_total * 1000) /
 938                              (time_now - last_sample_time)));
 939
 940                 last_sample_time = time_now;
 941                 data_total = 0;
 942         }
 943
 944         data_total += cb->size;
 945         /* If no client registered for type & id,
 946          * check for control client where type is not registered */
 947         if (client)
 948                 rc = client->onresponse_handler(client->context, cb);
 949
 950         if (rc < 0) {
 951                 switch (phdr->msgType) {
 952                 case MSG_SMS_GET_VERSION_EX_RES:
 953                 {
 954                         struct SmsVersionRes_ST *ver =
 955                                 (struct SmsVersionRes_ST *) phdr;
 956                         printk(KERN_DEBUG "%s: MSG_SMS_GET_VERSION_EX_RES "
 957                                "id %d prots 0x%x ver %d.%d\n", __func__,
 958                                ver->FirmwareId, ver->SupportedProtocols,
 959                                ver->RomVersionMajor, ver->RomVersionMinor);
 960
 961                         coredev->mode = ver->FirmwareId == 255 ?
 962                                 DEVICE_MODE_NONE : ver->FirmwareId;
 963                         coredev->modes_supported = ver->SupportedProtocols;
 964
 965                         complete(&coredev->version_ex_done);
 966                         break;
 967                 }
 968                 case MSG_SMS_INIT_DEVICE_RES:
 969                         printk(KERN_DEBUG "%s: MSG_SMS_INIT_DEVICE_RES\n",
 970                                __func__);
 971                         complete(&coredev->init_device_done);
 972                         break;
 973                 case MSG_SW_RELOAD_START_RES:
 974                         printk(KERN_DEBUG "%s: MSG_SW_RELOAD_START_RES\n",
 975                                __func__);
 976                         complete(&coredev->reload_start_done);
 977                         break;
 978                 case MSG_SMS_DATA_DOWNLOAD_RES:
 979                         complete(&coredev->data_download_done);
 980                         break;
 981                 case MSG_SW_RELOAD_EXEC_RES:
 982                         printk(KERN_DEBUG "%s: MSG_SW_RELOAD_EXEC_RES\n",
 983                                __func__);
 984                         break;
 985                 case MSG_SMS_SWDOWNLOAD_TRIGGER_RES:
 986                         printk(KERN_DEBUG
 987                                "%s: MSG_SMS_SWDOWNLOAD_TRIGGER_RES\n",
 988                                __func__);
 989                         complete(&coredev->trigger_done);
 990                         break;
 991                 case MSG_SMS_SLEEP_RESUME_COMP_IND:
 992                         complete(&coredev->resume_done);
 993                         break;
 994                 default:
 995                         break;
 996                 }
 997                 smscore_putbuffer(coredev, cb);
 998         }
 999 }
1000
1001 /**
1002  * return pointer to next free buffer descriptor from core pool
1003  *
1004  * @param coredev pointer to a coredev object returned by
1005  *                smscore_register_device
1006  *
1007  * @return pointer to descriptor on success, NULL on error.
1008  */
1009 struct smscore_buffer_t *smscore_getbuffer(struct smscore_device_t *coredev)
1010 {
1011         struct smscore_buffer_t *cb = NULL;
1012         unsigned long flags;
1013
1014         spin_lock_irqsave(&coredev->bufferslock, flags);
1015
1016         if (!list_empty(&coredev->buffers)) {
1017                 cb = (struct smscore_buffer_t *) coredev->buffers.next;
1018                 list_del(&cb->entry);
1019         }
1020
1021         spin_unlock_irqrestore(&coredev->bufferslock, flags);
1022
1023         return cb;
1024 }
1025
1026 /**
1027  * return buffer descriptor to a pool
1028  *
1029  * @param coredev pointer to a coredev object returned by
1030  *                smscore_register_device
1031  * @param cb pointer buffer descriptor
1032  *
1033  */
1034 void smscore_putbuffer(struct smscore_device_t *coredev,
1035                        struct smscore_buffer_t *cb)
1036 {
1037         list_add_locked(&cb->entry, &coredev->buffers, &coredev->bufferslock);
1038 }
1039
1040 int smscore_validate_client(struct smscore_device_t *coredev,
1041                             struct smscore_client_t *client,
1042                             int data_type, int id)
1043 {
1044         struct smscore_idlist_t *listentry;
1045         struct smscore_client_t *registered_client;
1046
1047         if (!client) {
1048                 PERROR("bad parameter.\n");
1049                 return -EFAULT;
1050         }
1051         registered_client = smscore_find_client(coredev, data_type, id);
1052         if (registered_client == client)
1053                 return 0;
1054
1055         if (registered_client) {
1056                 PERROR("The msg ID already registered to another client.\n");
1057                 return -EEXIST;
1058         }
1059         listentry = kzalloc(sizeof(struct smscore_idlist_t), GFP_KERNEL);
1060         if (!listentry) {
1061                 PERROR("Can't allocate memory for client id.\n");
1062                 return -ENOMEM;
1063         }
1064         listentry->id = id;
1065         listentry->data_type = data_type;
1066         list_add_locked(&listentry->entry, &client->idlist,
1067                         &coredev->clientslock);
1068         return 0;
1069 }
1070
1071 /**
1072  * creates smsclient object, check that id is taken by another client
1073  *
1074  * @param coredev pointer to a coredev object from clients hotplug
1075  * @param initial_id all messages with this id would be sent to this client
1076  * @param data_type all messages of this type would be sent to this client
1077  * @param onresponse_handler client handler that is called to
1078  *                           process incoming messages
1079  * @param onremove_handler client handler that is called when device is removed
1080  * @param context client-specific context
1081  * @param client pointer to a value that receives created smsclient object
1082  *
1083  * @return 0 on success, <0 on error.
1084  */
1085 int smscore_register_client(struct smscore_device_t *coredev,
1086                             struct smsclient_params_t *params,
1087                             struct smscore_client_t **client)
1088 {
1089         struct smscore_client_t *newclient;
1090         /* check that no other channel with same parameters exists */
1091         if (smscore_find_client(coredev, params->data_type,
1092                                 params->initial_id)) {
1093                 PERROR("Client already exist.\n");
1094                 return -EEXIST;
1095         }
1096
1097         newclient = kzalloc(sizeof(struct smscore_client_t), GFP_KERNEL);
1098         if (!newclient) {
1099                 PERROR("Failed to allocate memory for client.\n");
1100                 return -ENOMEM;
1101         }
1102
1103         INIT_LIST_HEAD(&newclient->idlist);
1104         newclient->coredev = coredev;
1105         newclient->onresponse_handler = params->onresponse_handler;
1106         newclient->onremove_handler = params->onremove_handler;
1107         newclient->context = params->context;
1108         list_add_locked(&newclient->entry, &coredev->clients,
1109                         &coredev->clientslock);
1110         smscore_validate_client(coredev, newclient, params->data_type,
1111                                 params->initial_id);
1112         *client = newclient;
1113         PDEBUG("%p %d %d\n", params->context, params->data_type,
1114                params->initial_id);
1115
1116         return 0;
1117 }
1118
1119 /**
1120  * frees smsclient object and all subclients associated with it
1121  *
1122  * @param client pointer to smsclient object returned by
1123  *               smscore_register_client
1124  *
1125  */
1126 void smscore_unregister_client(struct smscore_client_t *client)
1127 {
1128         struct smscore_device_t *coredev = client->coredev;
1129         unsigned long flags;
1130
1131         spin_lock_irqsave(&coredev->clientslock, flags);
1132
1133
1134         while (!list_empty(&client->idlist)) {
1135                 struct smscore_idlist_t *identry =
1136                         (struct smscore_idlist_t *) client->idlist.next;
1137                 list_del(&identry->entry);
1138                 kfree(identry);
1139         }
1140
1141         printk(KERN_INFO "%s %p\n", __func__, client->context);
1142
1143         list_del(&client->entry);
1144         kfree(client);
1145
1146         spin_unlock_irqrestore(&coredev->clientslock, flags);
1147 }
1148
1149 /**
1150  * verifies that source id is not taken by another client,
1151  * calls device handler to send requests to the device
1152  *
1153  * @param client pointer to smsclient object returned by
1154  *               smscore_register_client
1155  * @param buffer pointer to a request buffer
1156  * @param size size (in bytes) of request buffer
1157  *
1158  * @return 0 on success, <0 on error.
1159  */
1160 int smsclient_sendrequest(struct smscore_client_t *client,
1161                           void *buffer, size_t size)
1162 {
1163         struct smscore_device_t *coredev;
1164         struct SmsMsgHdr_ST *phdr = (struct SmsMsgHdr_ST *) buffer;
1165         int rc;
1166
1167         if (client == NULL) {
1168                 printk(KERN_ERR "%s Got NULL client\n", __func__);
1169                 return -EINVAL;
1170         }
1171
1172         coredev = client->coredev;
1173
1174         /* check that no other channel with same id exists */
1175         if (coredev == NULL) {
1176                 printk(KERN_ERR "%s Got NULL coredev\n", __func__);
1177                 return -EINVAL;
1178         }
1179
1180         rc = smscore_validate_client(client->coredev, client, 0,
1181                                      phdr->msgSrcId);
1182         if (rc < 0)
1183                 return rc;
1184
1185         return coredev->sendrequest_handler(coredev->context, buffer, size);
1186 }
1187
1188 /**
1189  * return the size of large (common) buffer
1190  *
1191  * @param coredev pointer to a coredev object from clients hotplug
1192  *
1193  * @return size (in bytes) of the buffer
1194  */
1195 int smscore_get_common_buffer_size(struct smscore_device_t *coredev)
1196 {
1197         return coredev->common_buffer_size;
1198 }
1199
1200 /**
1201  * maps common buffer (if supported by platform)
1202  *
1203  * @param coredev pointer to a coredev object from clients hotplug
1204  * @param vma pointer to vma struct from mmap handler
1205  *
1206  * @return 0 on success, <0 on error.
1207  */
1208 int smscore_map_common_buffer(struct smscore_device_t *coredev,
1209                                struct vm_area_struct *vma)
1210 {
1211         unsigned long end = vma->vm_end,
1212                       start = vma->vm_start,
1213                       size = PAGE_ALIGN(coredev->common_buffer_size);
1214
1215         if (!(vma->vm_flags & (VM_READ | VM_SHARED)) ||
1216              (vma->vm_flags & VM_WRITE)) {
1217                 printk(KERN_INFO "%s invalid vm flags\n", __func__);
1218                 return -EINVAL;
1219         }
1220
1221         if ((end - start) != size) {
1222                 printk(KERN_INFO "%s invalid size %d expected %d\n",
1223                        __func__, (int)(end - start), (int) size);
1224                 return -EINVAL;
1225         }
1226
1227         if (remap_pfn_range(vma, start,
1228                             coredev->common_buffer_phys >> PAGE_SHIFT,
1229                             size, pgprot_noncached(vma->vm_page_prot))) {
1230                 printk(KERN_INFO "%s remap_page_range failed\n", __func__);
1231                 return -EAGAIN;
1232         }
1233
1234         return 0;
1235 }
1236
1237 int smscore_module_init(void)
1238 {
1239         int rc = 0;
1240
1241         INIT_LIST_HEAD(&g_smscore_notifyees);
1242         INIT_LIST_HEAD(&g_smscore_devices);
1243         kmutex_init(&g_smscore_deviceslock);
1244
1245         INIT_LIST_HEAD(&g_smscore_registry);
1246         kmutex_init(&g_smscore_registrylock);
1247
1248         /* USB Register */
1249         rc = smsusb_register();
1250
1251         /* DVB Register */
1252         rc = smsdvb_register();
1253
1254         printk(KERN_INFO "%s, rc %d\n", __func__, rc);
1255
1256         return rc;
1257 }
1258
1259 void smscore_module_exit(void)
1260 {
1261
1262         kmutex_lock(&g_smscore_deviceslock);
1263         while (!list_empty(&g_smscore_notifyees)) {
1264                 struct smscore_device_notifyee_t *notifyee =
1265                         (struct smscore_device_notifyee_t *)
1266                                 g_smscore_notifyees.next;
1267
1268                 list_del(&notifyee->entry);
1269                 kfree(notifyee);
1270         }
1271         kmutex_unlock(&g_smscore_deviceslock);
1272
1273         kmutex_lock(&g_smscore_registrylock);
1274         while (!list_empty(&g_smscore_registry)) {
1275                 struct smscore_registry_entry_t *entry =
1276                         (struct smscore_registry_entry_t *)
1277                                 g_smscore_registry.next;
1278
1279                 list_del(&entry->entry);
1280                 kfree(entry);
1281         }
1282         kmutex_unlock(&g_smscore_registrylock);
1283
1284         /* DVB UnRegister */
1285         smsdvb_unregister();
1286
1287         /* Unregister USB */
1288         smsusb_unregister();
1289
1290         printk(KERN_INFO "%s\n", __func__);
1291 }
1292
1293 module_init(smscore_module_init);
1294 module_exit(smscore_module_exit);
1295
1296 MODULE_DESCRIPTION("smscore");
1297 MODULE_AUTHOR("Siano Mobile Silicon,,, (doronc@siano-ms.com)");
1298 MODULE_LICENSE("GPL");