2 * Siano core API module
4 * This file contains implementation for the interface to sms core component
6 * author: Anatoly Greenblat
8 * Copyright (c), 2005-2008 Siano Mobile Silicon, Inc.
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;
14 * Software distributed under the License is distributed on an "AS IS"
15 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
17 * See the GNU General Public License for more details.
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.
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>
32 #include <linux/firmware.h>
34 #include "smscoreapi.h"
36 typedef struct _smscore_device_notifyee
38 struct list_head entry;
40 } smscore_device_notifyee_t;
42 typedef struct _smscore_client
44 struct list_head entry;
45 smscore_device_t *coredev;
51 onresponse_t onresponse_handler;
52 onremove_t onremove_handler;
55 typedef struct _smscore_subclient
57 struct list_head entry;
58 smscore_client_t *client;
61 } smscore_subclient_t;
63 typedef struct _smscore_device
65 struct list_head entry;
67 struct list_head clients;
68 struct list_head subclients;
69 spinlock_t clientslock;
71 struct list_head buffers;
72 spinlock_t bufferslock;
76 int common_buffer_size;
77 dma_addr_t common_buffer_phys;
80 struct device *device;
83 unsigned long device_flags;
85 setmode_t setmode_handler;
86 detectmode_t detectmode_handler;
87 sendrequest_t sendrequest_handler;
88 preload_t preload_handler;
89 postload_t postload_handler;
91 int mode, modes_supported;
93 struct completion version_ex_done, data_download_done, trigger_done;
94 struct completion init_device_done, reload_start_done, resume_done;
97 typedef struct _smscore_registry_entry
99 struct list_head entry;
102 } smscore_registry_entry_t;
104 struct list_head g_smscore_notifyees;
105 struct list_head g_smscore_devices;
106 kmutex_t g_smscore_deviceslock;
108 struct list_head g_smscore_registry;
109 kmutex_t g_smscore_registrylock;
111 static int default_mode = 1;
112 module_param(default_mode, int, 0644);
113 MODULE_PARM_DESC(default_mode, "default firmware id (device mode)");
115 int smscore_registry_getmode(char* devpath)
117 smscore_registry_entry_t *entry;
118 struct list_head *next;
120 kmutex_lock(&g_smscore_registrylock);
122 for (next = g_smscore_registry.next; next != &g_smscore_registry; next = next->next)
124 entry = (smscore_registry_entry_t *) next;
126 if (!strcmp(entry->devpath, devpath))
128 kmutex_unlock(&g_smscore_registrylock);
133 entry = (smscore_registry_entry_t *) kmalloc(sizeof(smscore_registry_entry_t), GFP_KERNEL);
136 entry->mode = default_mode;
137 strcpy(entry->devpath, devpath);
139 list_add(&entry->entry, &g_smscore_registry);
142 kmutex_unlock(&g_smscore_registrylock);
147 void smscore_registry_setmode(char* devpath, int mode)
149 smscore_registry_entry_t *entry;
150 struct list_head *next;
152 kmutex_lock(&g_smscore_registrylock);
154 for (next = g_smscore_registry.next; next != &g_smscore_registry; next = next->next)
156 entry = (smscore_registry_entry_t *) next;
158 if (!strcmp(entry->devpath, devpath))
165 kmutex_unlock(&g_smscore_registrylock);
169 void list_add_locked(struct list_head *new, struct list_head *head, spinlock_t* lock)
173 spin_lock_irqsave(lock, flags);
177 spin_unlock_irqrestore(lock, flags);
181 * register a client callback that called when device plugged in/unplugged
182 * NOTE: if devices exist callback is called immediately for each device
184 * @param hotplug callback
186 * @return 0 on success, <0 on error.
188 int smscore_register_hotplug(hotplug_t hotplug)
190 smscore_device_notifyee_t *notifyee;
191 struct list_head *next, *first;
194 kmutex_lock(&g_smscore_deviceslock);
196 notifyee = kmalloc(sizeof(smscore_device_notifyee_t), GFP_KERNEL);
199 // now notify callback about existing devices
200 first = &g_smscore_devices;
201 for (next = first->next; next != first && !rc; next = next->next)
203 smscore_device_t *coredev = (smscore_device_t *) next;
204 rc = hotplug(coredev, coredev->device, 1);
209 notifyee->hotplug = hotplug;
210 list_add(¬ifyee->entry, &g_smscore_notifyees);
218 kmutex_unlock(&g_smscore_deviceslock);
224 * unregister a client callback that called when device plugged in/unplugged
226 * @param hotplug callback
229 void smscore_unregister_hotplug(hotplug_t hotplug)
231 struct list_head *next, *first;
233 kmutex_lock(&g_smscore_deviceslock);
235 first = &g_smscore_notifyees;
237 for (next = first->next; next != first;)
239 smscore_device_notifyee_t *notifyee = (smscore_device_notifyee_t *) next;
242 if (notifyee->hotplug == hotplug)
244 list_del(¬ifyee->entry);
249 kmutex_unlock(&g_smscore_deviceslock);
252 void smscore_notify_clients(smscore_device_t *coredev)
254 smscore_client_t* client;
256 // the client must call smscore_unregister_client from remove handler
257 while (!list_empty(&coredev->clients))
259 client = (smscore_client_t *) coredev->clients.next;
260 client->onremove_handler(client->context);
264 int smscore_notify_callbacks(smscore_device_t *coredev, struct device *device, int arrival)
266 struct list_head *next, *first;
269 // note: must be called under g_deviceslock
271 first = &g_smscore_notifyees;
273 for (next = first->next; next != first; next = next->next)
275 rc = ((smscore_device_notifyee_t *) next)->hotplug(coredev, device, arrival);
283 smscore_buffer_t *smscore_createbuffer(u8* buffer, void* common_buffer, dma_addr_t common_buffer_phys)
285 smscore_buffer_t *cb = kmalloc(sizeof(smscore_buffer_t), GFP_KERNEL);
288 printk(KERN_INFO "%s kmalloc(...) failed\n", __FUNCTION__);
293 cb->offset_in_common = buffer - (u8*) common_buffer;
294 cb->phys = common_buffer_phys + cb->offset_in_common;
300 * creates coredev object for a device, prepares buffers, creates buffer mappings, notifies
301 * registered hotplugs about new device.
303 * @param params device pointer to struct with device specific parameters and handlers
304 * @param coredev pointer to a value that receives created coredev object
306 * @return 0 on success, <0 on error.
308 int smscore_register_device(smsdevice_params_t *params, smscore_device_t **coredev)
310 smscore_device_t* dev;
313 dev = kzalloc(sizeof(smscore_device_t), GFP_KERNEL);
316 printk(KERN_INFO "%s kzalloc(...) failed\n", __FUNCTION__);
320 // init list entry so it could be safe in smscore_unregister_device
321 INIT_LIST_HEAD(&dev->entry);
324 INIT_LIST_HEAD(&dev->clients);
325 INIT_LIST_HEAD(&dev->subclients);
326 INIT_LIST_HEAD(&dev->buffers);
329 spin_lock_init(&dev->clientslock);
330 spin_lock_init(&dev->bufferslock);
332 // init completion events
333 init_completion(&dev->version_ex_done);
334 init_completion(&dev->data_download_done);
335 init_completion(&dev->trigger_done);
336 init_completion(&dev->init_device_done);
337 init_completion(&dev->reload_start_done);
338 init_completion(&dev->resume_done);
340 // alloc common buffer
341 dev->common_buffer_size = params->buffer_size * params->num_buffers;
342 dev->common_buffer = dma_alloc_coherent(NULL, dev->common_buffer_size, &dev->common_buffer_phys, GFP_KERNEL | GFP_DMA);
343 if (!dev->common_buffer)
345 smscore_unregister_device(dev);
349 // prepare dma buffers
350 for (buffer = dev->common_buffer; dev->num_buffers < params->num_buffers; dev->num_buffers ++, buffer += params->buffer_size)
352 smscore_buffer_t *cb = smscore_createbuffer(buffer, dev->common_buffer, dev->common_buffer_phys);
355 smscore_unregister_device(dev);
359 smscore_putbuffer(dev, cb);
362 printk(KERN_INFO "%s allocated %d buffers\n", __FUNCTION__, dev->num_buffers);
364 dev->mode = DEVICE_MODE_NONE;
365 dev->context = params->context;
366 dev->device = params->device;
367 dev->setmode_handler = params->setmode_handler;
368 dev->detectmode_handler = params->detectmode_handler;
369 dev->sendrequest_handler = params->sendrequest_handler;
370 dev->preload_handler = params->preload_handler;
371 dev->postload_handler = params->postload_handler;
373 dev->device_flags = params->flags;
374 strcpy(dev->devpath, params->devpath);
376 // add device to devices list
377 kmutex_lock(&g_smscore_deviceslock);
378 list_add(&dev->entry, &g_smscore_devices);
379 kmutex_unlock(&g_smscore_deviceslock);
383 printk(KERN_INFO "%s device %p created\n", __FUNCTION__, dev);
389 * sets initial device mode and notifies client hotplugs that device is ready
391 * @param coredev pointer to a coredev object returned by smscore_register_device
393 * @return 0 on success, <0 on error.
395 int smscore_start_device(smscore_device_t *coredev)
397 int rc = smscore_set_device_mode(coredev, smscore_registry_getmode(coredev->devpath));
401 kmutex_lock(&g_smscore_deviceslock);
403 rc = smscore_notify_callbacks(coredev, coredev->device, 1);
405 printk(KERN_INFO "%s device %p started, rc %d\n", __FUNCTION__, coredev, rc);
407 kmutex_unlock(&g_smscore_deviceslock);
412 int smscore_sendrequest_and_wait(smscore_device_t *coredev, void* buffer, size_t size, struct completion *completion)
414 int rc = coredev->sendrequest_handler(coredev->context, buffer, size);
418 return wait_for_completion_timeout(completion, msecs_to_jiffies(1000)) ? 0 : -ETIME;
421 int smscore_load_firmware_family2(smscore_device_t *coredev, void *buffer, size_t size)
423 SmsFirmware_ST* firmware = (SmsFirmware_ST*) buffer;
425 UINT32 mem_address = firmware->StartAddress;
426 u8* payload = firmware->Payload;
429 if (coredev->preload_handler)
431 rc = coredev->preload_handler(coredev->context);
436 // PAGE_SIZE buffer shall be enough and dma aligned
437 msg = (SmsMsgHdr_ST *) kmalloc(PAGE_SIZE, GFP_KERNEL | GFP_DMA);
441 if (coredev->mode != DEVICE_MODE_NONE)
443 SMS_INIT_MSG(msg, MSG_SW_RELOAD_START_REQ, sizeof(SmsMsgHdr_ST));
444 rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength, &coredev->reload_start_done);
445 mem_address = *(UINT32*) &payload[20];
448 while (size && rc >= 0)
450 SmsDataDownload_ST *DataMsg = (SmsDataDownload_ST *) msg;
451 int payload_size = min((int) size, SMS_MAX_PAYLOAD_SIZE);
453 SMS_INIT_MSG(msg, MSG_SMS_DATA_DOWNLOAD_REQ, (UINT16)(sizeof(SmsMsgHdr_ST) + sizeof(UINT32) + payload_size));
455 DataMsg->MemAddr = mem_address;
456 memcpy(DataMsg->Payload, payload, payload_size);
458 if (coredev->device_flags & SMS_ROM_NO_RESPONSE && coredev->mode == DEVICE_MODE_NONE)
459 rc = coredev->sendrequest_handler(coredev->context, DataMsg, DataMsg->xMsgHeader.msgLength);
461 rc = smscore_sendrequest_and_wait(coredev, DataMsg, DataMsg->xMsgHeader.msgLength, &coredev->data_download_done);
463 payload += payload_size;
464 size -= payload_size;
465 mem_address += payload_size;
470 if (coredev->mode == DEVICE_MODE_NONE)
472 SmsMsgData_ST* TriggerMsg = (SmsMsgData_ST*) msg;
474 SMS_INIT_MSG(msg, MSG_SMS_SWDOWNLOAD_TRIGGER_REQ, sizeof(SmsMsgHdr_ST) + sizeof(UINT32) * 5);
476 TriggerMsg->msgData[0] = firmware->StartAddress; // Entry point
477 TriggerMsg->msgData[1] = 5; // Priority
478 TriggerMsg->msgData[2] = 0x200; // Stack size
479 TriggerMsg->msgData[3] = 0; // Parameter
480 TriggerMsg->msgData[4] = 4; // Task ID
482 if (coredev->device_flags & SMS_ROM_NO_RESPONSE)
484 rc = coredev->sendrequest_handler(coredev->context, TriggerMsg, TriggerMsg->xMsgHeader.msgLength);
488 rc = smscore_sendrequest_and_wait(coredev, TriggerMsg, TriggerMsg->xMsgHeader.msgLength, &coredev->trigger_done);
492 SMS_INIT_MSG(msg, MSG_SW_RELOAD_EXEC_REQ, sizeof(SmsMsgHdr_ST));
494 rc = coredev->sendrequest_handler(coredev->context, msg, msg->msgLength);
498 printk("%s %d \n", __func__, rc);
502 return (rc >= 0 && coredev->postload_handler) ?
503 coredev->postload_handler(coredev->context) :
508 * loads specified firmware into a buffer and calls device loadfirmware_handler
510 * @param coredev pointer to a coredev object returned by smscore_register_device
511 * @param filename null-terminated string specifies firmware file name
512 * @param loadfirmware_handler device handler that loads firmware
514 * @return 0 on success, <0 on error.
516 int smscore_load_firmware(smscore_device_t *coredev, char* filename, loadfirmware_t loadfirmware_handler)
520 const struct firmware *fw;
523 if (loadfirmware_handler == NULL && !(coredev->device_flags & SMS_DEVICE_FAMILY2))
526 rc = request_firmware(&fw, filename, coredev->device);
529 printk(KERN_INFO "%s failed to open \"%s\"\n", __FUNCTION__, filename);
533 fw_buffer = kmalloc(ALIGN(fw->size, SMS_ALLOC_ALIGNMENT), GFP_KERNEL | GFP_DMA);
536 memcpy(fw_buffer, fw->data, fw->size);
538 rc = (coredev->device_flags & SMS_DEVICE_FAMILY2) ?
539 smscore_load_firmware_family2(coredev, fw_buffer, fw->size) :
540 loadfirmware_handler(coredev->context, fw_buffer, fw->size);
546 printk(KERN_INFO "%s failed to allocate firmware buffer\n", __FUNCTION__);
550 release_firmware(fw);
556 * notifies all clients registered with the device, notifies hotplugs, frees all buffers and coredev object
558 * @param coredev pointer to a coredev object returned by smscore_register_device
560 * @return 0 on success, <0 on error.
562 void smscore_unregister_device(smscore_device_t *coredev)
564 smscore_buffer_t *cb;
567 kmutex_lock(&g_smscore_deviceslock);
569 smscore_notify_clients(coredev);
570 smscore_notify_callbacks(coredev, NULL, 0);
572 // at this point all buffers should be back
573 // onresponse must no longer be called
577 while ((cb = smscore_getbuffer(coredev)))
583 if (num_buffers == coredev->num_buffers)
586 printk(KERN_INFO "%s waiting for %d buffer(s)\n", __FUNCTION__, coredev->num_buffers - num_buffers);
590 printk(KERN_INFO "%s freed %d buffers\n", __FUNCTION__, num_buffers);
592 if (coredev->common_buffer)
593 dma_free_coherent(NULL, coredev->common_buffer_size, coredev->common_buffer, coredev->common_buffer_phys);
595 list_del(&coredev->entry);
598 kmutex_unlock(&g_smscore_deviceslock);
600 printk(KERN_INFO "%s device %p destroyed\n", __FUNCTION__, coredev);
603 int smscore_detect_mode(smscore_device_t *coredev)
605 void *buffer = kmalloc(sizeof(SmsMsgHdr_ST) + SMS_DMA_ALIGNMENT, GFP_KERNEL | GFP_DMA);
606 SmsMsgHdr_ST *msg = (SmsMsgHdr_ST *) SMS_ALIGN_ADDRESS(buffer);
612 SMS_INIT_MSG(msg, MSG_SMS_GET_VERSION_EX_REQ, sizeof(SmsMsgHdr_ST));
614 rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength, &coredev->version_ex_done);
617 printk("%s: MSG_SMS_GET_VERSION_EX_REQ failed first try\n", __FUNCTION__);
619 if (wait_for_completion_timeout(&coredev->resume_done, msecs_to_jiffies(5000)))
621 rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength, &coredev->version_ex_done);
624 printk("%s: MSG_SMS_GET_VERSION_EX_REQ failed second try, rc %d\n", __FUNCTION__, rc);
636 char *smscore_fw_lkup[] =
638 "dvb_nova_12mhz.inp",
639 "dvb_nova_12mhz.inp",
642 "dvb_nova_12mhz.inp",
643 "isdbt_nova_12mhz.inp",
644 "isdbt_nova_12mhz.inp",
645 "cmmb_nova_12mhz.inp",
650 * calls device handler to change mode of operation
651 * NOTE: stellar/usb may disconnect when changing mode
653 * @param coredev pointer to a coredev object returned by smscore_register_device
654 * @param mode requested mode of operation
656 * @return 0 on success, <0 on error.
658 int smscore_set_device_mode(smscore_device_t *coredev, int mode)
663 if (coredev->device_flags & SMS_DEVICE_FAMILY2)
665 if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_RAW_TUNER)
667 printk(KERN_INFO "%s invalid mode specified %d\n", __FUNCTION__, mode);
671 if (!(coredev->device_flags & SMS_DEVICE_NOT_READY))
673 rc = smscore_detect_mode(coredev);
678 if (coredev->mode == mode)
680 printk(KERN_INFO "%s device mode %d already set\n", __FUNCTION__, mode);
684 if (!(coredev->modes_supported & (1 << mode)))
686 rc = smscore_load_firmware(coredev, smscore_fw_lkup[mode], NULL);
692 printk(KERN_INFO "%s mode %d supported by running firmware\n", __FUNCTION__, mode);
695 buffer = kmalloc(sizeof(SmsMsgData_ST) + SMS_DMA_ALIGNMENT, GFP_KERNEL | GFP_DMA);
698 SmsMsgData_ST *msg = (SmsMsgData_ST *) SMS_ALIGN_ADDRESS(buffer);
700 SMS_INIT_MSG(&msg->xMsgHeader, MSG_SMS_INIT_DEVICE_REQ, sizeof(SmsMsgData_ST));
701 msg->msgData[0] = mode;
703 rc = smscore_sendrequest_and_wait(coredev, msg, msg->xMsgHeader.msgLength, &coredev->init_device_done);
712 if (coredev->detectmode_handler)
713 coredev->detectmode_handler(coredev->context, &coredev->mode);
715 if (coredev->mode != mode && coredev->setmode_handler)
716 rc = coredev->setmode_handler(coredev->context, mode);
719 smscore_registry_setmode(coredev->devpath, mode);
723 coredev->mode = mode;
724 coredev->device_flags &= ~SMS_DEVICE_NOT_READY;
731 * calls device handler to get current mode of operation
733 * @param coredev pointer to a coredev object returned by smscore_register_device
735 * @return current mode
737 int smscore_get_device_mode(smscore_device_t *coredev)
739 return coredev->mode;
742 smscore_client_t* smscore_getclient_by_type(smscore_device_t *coredev, int data_type)
744 smscore_client_t *client = NULL;
745 struct list_head *next, *first;
751 spin_lock_irqsave(&coredev->clientslock, flags);
753 first = &coredev->clients;
755 for (next = first->next; next != first; next = next->next)
757 if (((smscore_client_t*) next)->data_type == data_type)
759 client = (smscore_client_t*) next;
764 spin_unlock_irqrestore(&coredev->clientslock, flags);
769 smscore_client_t* smscore_getclient_by_id(smscore_device_t *coredev, int id)
771 smscore_client_t *client = NULL;
772 struct list_head *next, *first;
775 spin_lock_irqsave(&coredev->clientslock, flags);
777 first = &coredev->subclients;
779 for (next = first->next; next != first; next = next->next)
781 if (((smscore_subclient_t*) next)->id == id)
783 client = ((smscore_subclient_t*) next)->client;
788 spin_unlock_irqrestore(&coredev->clientslock, flags);
794 * find client by response id/type, call clients onresponse handler
795 * return buffer to pool on error
797 * @param coredev pointer to a coredev object returned by smscore_register_device
798 * @param cb pointer to response buffer descriptor
801 void smscore_onresponse(smscore_device_t *coredev, smscore_buffer_t *cb)
803 SmsMsgHdr_ST *phdr = (SmsMsgHdr_ST *)((u8*) cb->p + cb->offset);
804 smscore_client_t * client = smscore_getclient_by_type(coredev, phdr->msgType);
807 static unsigned long last_sample_time = 0;
808 static int data_total = 0;
809 unsigned long time_now = jiffies_to_msecs(jiffies);
811 if (!last_sample_time)
812 last_sample_time = time_now;
814 if (time_now - last_sample_time > 10000)
816 printk("\n%s data rate %d bytes/secs\n", __func__, (int)((data_total * 1000) / (time_now - last_sample_time)));
818 last_sample_time = time_now;
822 data_total += cb->size;
825 client = smscore_getclient_by_id(coredev, phdr->msgDstId);
828 rc = client->onresponse_handler(client->context, cb);
832 switch (phdr->msgType)
834 case MSG_SMS_GET_VERSION_EX_RES:
836 SmsVersionRes_ST *ver = (SmsVersionRes_ST*) phdr;
837 printk("%s: MSG_SMS_GET_VERSION_EX_RES id %d prots 0x%x ver %d.%d\n", __FUNCTION__, ver->FirmwareId, ver->SupportedProtocols, ver->RomVersionMajor, ver->RomVersionMinor);
839 coredev->mode = ver->FirmwareId == 255 ? DEVICE_MODE_NONE : ver->FirmwareId;
840 coredev->modes_supported = ver->SupportedProtocols;
842 complete(&coredev->version_ex_done);
846 case MSG_SMS_INIT_DEVICE_RES:
847 printk("%s: MSG_SMS_INIT_DEVICE_RES\n", __FUNCTION__);
848 complete(&coredev->init_device_done);
851 case MSG_SW_RELOAD_START_RES:
852 printk("%s: MSG_SW_RELOAD_START_RES\n", __FUNCTION__);
853 complete(&coredev->reload_start_done);
856 case MSG_SMS_DATA_DOWNLOAD_RES:
857 complete(&coredev->data_download_done);
860 case MSG_SW_RELOAD_EXEC_RES:
861 printk("%s: MSG_SW_RELOAD_EXEC_RES\n", __FUNCTION__);
864 case MSG_SMS_SWDOWNLOAD_TRIGGER_RES:
865 printk("%s: MSG_SMS_SWDOWNLOAD_TRIGGER_RES\n", __FUNCTION__);
866 complete(&coredev->trigger_done);
869 case MSG_SMS_SLEEP_RESUME_COMP_IND:
870 complete(&coredev->resume_done);
874 printk(KERN_INFO "%s no client (%p) or error (%d), type:%d dstid:%d\n", __FUNCTION__, client, rc, phdr->msgType, phdr->msgDstId);
877 smscore_putbuffer(coredev, cb);
882 * return pointer to next free buffer descriptor from core pool
884 * @param coredev pointer to a coredev object returned by smscore_register_device
886 * @return pointer to descriptor on success, NULL on error.
888 smscore_buffer_t *smscore_getbuffer(smscore_device_t *coredev)
890 smscore_buffer_t *cb = NULL;
893 spin_lock_irqsave(&coredev->bufferslock, flags);
895 if (!list_empty(&coredev->buffers))
897 cb = (smscore_buffer_t *) coredev->buffers.next;
898 list_del(&cb->entry);
901 spin_unlock_irqrestore(&coredev->bufferslock, flags);
907 * return buffer descriptor to a pool
909 * @param coredev pointer to a coredev object returned by smscore_register_device
910 * @param cb pointer buffer descriptor
913 void smscore_putbuffer(smscore_device_t *coredev, smscore_buffer_t *cb)
915 list_add_locked(&cb->entry, &coredev->buffers, &coredev->bufferslock);
918 int smscore_validate_client(smscore_device_t *coredev, smscore_client_t *client, int id)
920 smscore_client_t *existing_client;
921 smscore_subclient_t *subclient;
926 existing_client = smscore_getclient_by_id(coredev, id);
927 if (existing_client == client)
933 subclient = kzalloc(sizeof(smscore_subclient_t), GFP_KERNEL);
937 subclient->client = client;
940 list_add_locked(&subclient->entry, &coredev->subclients, &coredev->clientslock);
946 * creates smsclient object, check that id is taken by another client
948 * @param coredev pointer to a coredev object from clients hotplug
949 * @param initial_id all messages with this id would be sent to this client
950 * @param data_type all messages of this type would be sent to this client
951 * @param onresponse_handler client handler that is called to process incoming messages
952 * @param onremove_handler client handler that is called when device is removed
953 * @param context client-specific context
954 * @param client pointer to a value that receives created smsclient object
956 * @return 0 on success, <0 on error.
958 int smscore_register_client(smscore_device_t *coredev, smsclient_params_t *params, smscore_client_t **client)
960 smscore_client_t* newclient;
963 // check that no other channel with same data type exists
964 if (params->data_type && smscore_getclient_by_type(coredev, params->data_type))
967 newclient = kzalloc(sizeof(smscore_client_t), GFP_KERNEL);
971 // check that no other channel with same id exists
972 rc = smscore_validate_client(coredev, newclient, params->initial_id);
979 newclient->coredev = coredev;
980 newclient->data_type = params->data_type;
981 newclient->onresponse_handler = params->onresponse_handler;
982 newclient->onremove_handler = params->onremove_handler;
983 newclient->context = params->context;
985 list_add_locked(&newclient->entry, &coredev->clients, &coredev->clientslock);
989 printk(KERN_INFO "%s %p %d %d\n", __FUNCTION__, params->context, params->data_type, params->initial_id);
995 * frees smsclient object and all subclients associated with it
997 * @param client pointer to smsclient object returned by smscore_register_client
1000 void smscore_unregister_client(smscore_client_t *client)
1002 smscore_device_t *coredev = client->coredev;
1003 struct list_head *next, *first;
1004 unsigned long flags;
1006 spin_lock_irqsave(&coredev->clientslock, flags);
1008 first = &coredev->subclients;
1010 for (next = first->next; next != first;)
1012 smscore_subclient_t *subclient = (smscore_subclient_t *) next;
1015 if (subclient->client == client)
1017 list_del(&subclient->entry);
1022 printk(KERN_INFO "%s %p %d\n", __FUNCTION__, client->context, client->data_type);
1024 list_del(&client->entry);
1027 spin_unlock_irqrestore(&coredev->clientslock, flags);
1031 * verifies that source id is not taken by another client,
1032 * calls device handler to send requests to the device
1034 * @param client pointer to smsclient object returned by smscore_register_client
1035 * @param buffer pointer to a request buffer
1036 * @param size size (in bytes) of request buffer
1038 * @return 0 on success, <0 on error.
1040 int smsclient_sendrequest(smscore_client_t *client, void *buffer, size_t size)
1042 smscore_device_t* coredev = client->coredev;
1043 SmsMsgHdr_ST* phdr = (SmsMsgHdr_ST*) buffer;
1045 // check that no other channel with same id exists
1046 int rc = smscore_validate_client(client->coredev, client, phdr->msgSrcId);
1050 return coredev->sendrequest_handler(coredev->context, buffer, size);
1054 * return the size of large (common) buffer
1056 * @param coredev pointer to a coredev object from clients hotplug
1058 * @return size (in bytes) of the buffer
1060 int smscore_get_common_buffer_size(smscore_device_t *coredev)
1062 return coredev->common_buffer_size;
1066 * maps common buffer (if supported by platform)
1068 * @param coredev pointer to a coredev object from clients hotplug
1069 * @param vma pointer to vma struct from mmap handler
1071 * @return 0 on success, <0 on error.
1073 int smscore_map_common_buffer(smscore_device_t *coredev, struct vm_area_struct * vma)
1075 unsigned long end = vma->vm_end, start = vma->vm_start, size = PAGE_ALIGN(coredev->common_buffer_size);
1077 if (!(vma->vm_flags & (VM_READ | VM_SHARED)) || (vma->vm_flags & VM_WRITE))
1079 printk(KERN_INFO "%s invalid vm flags\n", __FUNCTION__);
1083 if ((end - start) != size)
1085 printk(KERN_INFO "%s invalid size %d expected %d\n", __FUNCTION__, (int)(end - start), (int) size);
1089 if (remap_pfn_range(vma, start, coredev->common_buffer_phys >> PAGE_SHIFT, size, pgprot_noncached(vma->vm_page_prot)))
1091 printk(KERN_INFO "%s remap_page_range failed\n", __FUNCTION__);
1098 int smscore_module_init(void)
1102 INIT_LIST_HEAD(&g_smscore_notifyees);
1103 INIT_LIST_HEAD(&g_smscore_devices);
1104 kmutex_init(&g_smscore_deviceslock);
1106 INIT_LIST_HEAD(&g_smscore_registry);
1107 kmutex_init(&g_smscore_registrylock);
1110 rc = smsusb_register();
1113 rc = smsdvb_register();
1115 printk(KERN_INFO "%s, rc %d\n", __FUNCTION__, rc);
1120 void smscore_module_exit(void)
1123 kmutex_lock(&g_smscore_deviceslock);
1124 while (!list_empty(&g_smscore_notifyees))
1126 smscore_device_notifyee_t *notifyee = (smscore_device_notifyee_t *) g_smscore_notifyees.next;
1128 list_del(¬ifyee->entry);
1131 kmutex_unlock(&g_smscore_deviceslock);
1133 kmutex_lock(&g_smscore_registrylock);
1134 while (!list_empty(&g_smscore_registry))
1136 smscore_registry_entry_t *entry = (smscore_registry_entry_t *) g_smscore_registry.next;
1138 list_del(&entry->entry);
1141 kmutex_unlock(&g_smscore_registrylock);
1143 /* DVB UnRegister */
1144 smsdvb_unregister();
1146 /* Unregister USB */
1147 smsusb_unregister();
1149 printk(KERN_INFO "%s\n", __FUNCTION__);
1152 module_init(smscore_module_init);
1153 module_exit(smscore_module_exit);
1155 MODULE_DESCRIPTION("smscore");
1156 MODULE_AUTHOR("Anatoly Greenblatt,,, (anatolyg@siano-ms.com)");
1157 MODULE_LICENSE("GPL");