2 * Siano core API module
4 * This file contains implementation for the interface to sms core component
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 2 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>
33 #include <linux/wait.h>
34 #include <asm/byteorder.h>
36 #include "smscoreapi.h"
37 #include "sms-cards.h"
39 #include "smsendian.h"
42 module_param_named(debug, sms_dbg, int, 0644);
43 MODULE_PARM_DESC(debug, "set debug level (info=1, adv=2 (or-able))");
45 struct smscore_device_notifyee_t {
46 struct list_head entry;
50 struct smscore_idlist_t {
51 struct list_head entry;
56 struct smscore_client_t {
57 struct list_head entry;
58 struct smscore_device_t *coredev;
60 struct list_head idlist;
61 onresponse_t onresponse_handler;
62 onremove_t onremove_handler;
65 void smscore_set_board_id(struct smscore_device_t *core, int id)
70 int smscore_led_state(struct smscore_device_t *core, int led)
73 core->led_state = led;
74 return core->led_state;
76 EXPORT_SYMBOL_GPL(smscore_set_board_id);
78 int smscore_get_board_id(struct smscore_device_t *core)
80 return core->board_id;
82 EXPORT_SYMBOL_GPL(smscore_get_board_id);
84 struct smscore_registry_entry_t {
85 struct list_head entry;
88 enum sms_device_type_st type;
91 static struct list_head g_smscore_notifyees;
92 static struct list_head g_smscore_devices;
93 static struct mutex g_smscore_deviceslock;
95 static struct list_head g_smscore_registry;
96 static struct mutex g_smscore_registrylock;
98 static int default_mode = 4;
100 module_param(default_mode, int, 0644);
101 MODULE_PARM_DESC(default_mode, "default firmware id (device mode)");
103 static struct smscore_registry_entry_t *smscore_find_registry(char *devpath)
105 struct smscore_registry_entry_t *entry;
106 struct list_head *next;
108 kmutex_lock(&g_smscore_registrylock);
109 for (next = g_smscore_registry.next;
110 next != &g_smscore_registry;
112 entry = (struct smscore_registry_entry_t *) next;
113 if (!strcmp(entry->devpath, devpath)) {
114 kmutex_unlock(&g_smscore_registrylock);
118 entry = (struct smscore_registry_entry_t *)
119 kmalloc(sizeof(struct smscore_registry_entry_t),
122 entry->mode = default_mode;
123 strcpy(entry->devpath, devpath);
124 list_add(&entry->entry, &g_smscore_registry);
126 sms_err("failed to create smscore_registry.");
127 kmutex_unlock(&g_smscore_registrylock);
131 int smscore_registry_getmode(char *devpath)
133 struct smscore_registry_entry_t *entry;
135 entry = smscore_find_registry(devpath);
139 sms_err("No registry found.");
143 EXPORT_SYMBOL_GPL(smscore_registry_getmode);
145 static enum sms_device_type_st smscore_registry_gettype(char *devpath)
147 struct smscore_registry_entry_t *entry;
149 entry = smscore_find_registry(devpath);
153 sms_err("No registry found.");
158 void smscore_registry_setmode(char *devpath, int mode)
160 struct smscore_registry_entry_t *entry;
162 entry = smscore_find_registry(devpath);
166 sms_err("No registry found.");
169 static void smscore_registry_settype(char *devpath,
170 enum sms_device_type_st type)
172 struct smscore_registry_entry_t *entry;
174 entry = smscore_find_registry(devpath);
178 sms_err("No registry found.");
182 static void list_add_locked(struct list_head *new, struct list_head *head,
187 spin_lock_irqsave(lock, flags);
191 spin_unlock_irqrestore(lock, flags);
195 * register a client callback that called when device plugged in/unplugged
196 * NOTE: if devices exist callback is called immediately for each device
198 * @param hotplug callback
200 * @return 0 on success, <0 on error.
202 int smscore_register_hotplug(hotplug_t hotplug)
204 struct smscore_device_notifyee_t *notifyee;
205 struct list_head *next, *first;
208 kmutex_lock(&g_smscore_deviceslock);
210 notifyee = kmalloc(sizeof(struct smscore_device_notifyee_t),
213 /* now notify callback about existing devices */
214 first = &g_smscore_devices;
215 for (next = first->next;
216 next != first && !rc;
218 struct smscore_device_t *coredev =
219 (struct smscore_device_t *) next;
220 rc = hotplug(coredev, coredev->device, 1);
224 notifyee->hotplug = hotplug;
225 list_add(¬ifyee->entry, &g_smscore_notifyees);
231 kmutex_unlock(&g_smscore_deviceslock);
235 EXPORT_SYMBOL_GPL(smscore_register_hotplug);
238 * unregister a client callback that called when device plugged in/unplugged
240 * @param hotplug callback
243 void smscore_unregister_hotplug(hotplug_t hotplug)
245 struct list_head *next, *first;
247 kmutex_lock(&g_smscore_deviceslock);
249 first = &g_smscore_notifyees;
251 for (next = first->next; next != first;) {
252 struct smscore_device_notifyee_t *notifyee =
253 (struct smscore_device_notifyee_t *) next;
256 if (notifyee->hotplug == hotplug) {
257 list_del(¬ifyee->entry);
262 kmutex_unlock(&g_smscore_deviceslock);
264 EXPORT_SYMBOL_GPL(smscore_unregister_hotplug);
266 static void smscore_notify_clients(struct smscore_device_t *coredev)
268 struct smscore_client_t *client;
270 /* the client must call smscore_unregister_client from remove handler */
271 while (!list_empty(&coredev->clients)) {
272 client = (struct smscore_client_t *) coredev->clients.next;
273 client->onremove_handler(client->context);
277 static int smscore_notify_callbacks(struct smscore_device_t *coredev,
278 struct device *device, int arrival)
280 struct list_head *next, *first;
283 /* note: must be called under g_deviceslock */
285 first = &g_smscore_notifyees;
287 for (next = first->next; next != first; next = next->next) {
288 rc = ((struct smscore_device_notifyee_t *) next)->
289 hotplug(coredev, device, arrival);
298 smscore_buffer_t *smscore_createbuffer(u8 *buffer, void *common_buffer,
299 dma_addr_t common_buffer_phys)
301 struct smscore_buffer_t *cb =
302 kmalloc(sizeof(struct smscore_buffer_t), GFP_KERNEL);
304 sms_info("kmalloc(...) failed");
309 cb->offset_in_common = buffer - (u8 *) common_buffer;
310 cb->phys = common_buffer_phys + cb->offset_in_common;
316 * creates coredev object for a device, prepares buffers,
317 * creates buffer mappings, notifies registered hotplugs about new device.
319 * @param params device pointer to struct with device specific parameters
321 * @param coredev pointer to a value that receives created coredev object
323 * @return 0 on success, <0 on error.
325 int smscore_register_device(struct smsdevice_params_t *params,
326 struct smscore_device_t **coredev)
328 struct smscore_device_t *dev;
331 dev = kzalloc(sizeof(struct smscore_device_t), GFP_KERNEL);
333 sms_info("kzalloc(...) failed");
337 /* init list entry so it could be safe in smscore_unregister_device */
338 INIT_LIST_HEAD(&dev->entry);
341 INIT_LIST_HEAD(&dev->clients);
342 INIT_LIST_HEAD(&dev->buffers);
345 spin_lock_init(&dev->clientslock);
346 spin_lock_init(&dev->bufferslock);
348 /* init completion events */
349 init_completion(&dev->version_ex_done);
350 init_completion(&dev->data_download_done);
351 init_completion(&dev->trigger_done);
352 init_completion(&dev->init_device_done);
353 init_completion(&dev->reload_start_done);
354 init_completion(&dev->resume_done);
355 init_completion(&dev->ir_init_done);
357 /* Buffer management */
358 init_waitqueue_head(&dev->buffer_mng_waitq);
360 /* alloc common buffer */
361 dev->common_buffer_size = params->buffer_size * params->num_buffers;
362 dev->common_buffer = dma_alloc_coherent(NULL, dev->common_buffer_size,
363 &dev->common_buffer_phys,
364 GFP_KERNEL | GFP_DMA);
365 if (!dev->common_buffer) {
366 smscore_unregister_device(dev);
370 /* prepare dma buffers */
371 for (buffer = dev->common_buffer;
372 dev->num_buffers < params->num_buffers;
373 dev->num_buffers++, buffer += params->buffer_size) {
374 struct smscore_buffer_t *cb =
375 smscore_createbuffer(buffer, dev->common_buffer,
376 dev->common_buffer_phys);
378 smscore_unregister_device(dev);
382 smscore_putbuffer(dev, cb);
385 sms_info("allocated %d buffers", dev->num_buffers);
387 dev->mode = DEVICE_MODE_NONE;
388 dev->context = params->context;
389 dev->device = params->device;
390 dev->setmode_handler = params->setmode_handler;
391 dev->detectmode_handler = params->detectmode_handler;
392 dev->sendrequest_handler = params->sendrequest_handler;
393 dev->preload_handler = params->preload_handler;
394 dev->postload_handler = params->postload_handler;
396 dev->device_flags = params->flags;
397 strcpy(dev->devpath, params->devpath);
399 smscore_registry_settype(dev->devpath, params->device_type);
401 /* add device to devices list */
402 kmutex_lock(&g_smscore_deviceslock);
403 list_add(&dev->entry, &g_smscore_devices);
404 kmutex_unlock(&g_smscore_deviceslock);
408 sms_info("device %p created", dev);
412 EXPORT_SYMBOL_GPL(smscore_register_device);
415 static int smscore_sendrequest_and_wait(struct smscore_device_t *coredev,
416 void *buffer, size_t size, struct completion *completion) {
417 int rc = coredev->sendrequest_handler(coredev->context, buffer, size);
419 sms_info("sendrequest returned error %d", rc);
423 return wait_for_completion_timeout(completion,
424 msecs_to_jiffies(SMS_PROTOCOL_MAX_RAOUNDTRIP_MS)) ?
429 * Starts & enables IR operations
431 * @return 0 on success, < 0 on error.
433 static int smscore_init_ir(struct smscore_device_t *coredev)
439 coredev->ir.input_dev = NULL;
440 ir_io = sms_get_board(smscore_get_board_id(coredev))->board_cfg.ir;
441 if (ir_io) {/* only if IR port exist we use IR sub-module */
442 sms_info("IR loading");
443 rc = sms_ir_init(coredev);
446 sms_err("Error initialization DTV IR sub-module");
448 buffer = kmalloc(sizeof(struct SmsMsgData_ST2) +
450 GFP_KERNEL | GFP_DMA);
452 struct SmsMsgData_ST2 *msg =
453 (struct SmsMsgData_ST2 *)
454 SMS_ALIGN_ADDRESS(buffer);
456 SMS_INIT_MSG(&msg->xMsgHeader,
457 MSG_SMS_START_IR_REQ,
458 sizeof(struct SmsMsgData_ST2));
459 msg->msgData[0] = coredev->ir.controller;
460 msg->msgData[1] = coredev->ir.timeout;
462 smsendian_handle_tx_message(
463 (struct SmsMsgHdr_ST2 *)msg);
464 rc = smscore_sendrequest_and_wait(coredev, msg,
465 msg->xMsgHeader. msgLength,
466 &coredev->ir_init_done);
471 ("Sending IR initialization message failed");
474 sms_info("IR port has not been detected");
480 * sets initial device mode and notifies client hotplugs that device is ready
482 * @param coredev pointer to a coredev object returned by
483 * smscore_register_device
485 * @return 0 on success, <0 on error.
487 int smscore_start_device(struct smscore_device_t *coredev)
489 int rc = smscore_set_device_mode(
490 coredev, smscore_registry_getmode(coredev->devpath));
492 sms_info("set device mode faile , rc %d", rc);
496 kmutex_lock(&g_smscore_deviceslock);
498 rc = smscore_notify_callbacks(coredev, coredev->device, 1);
499 smscore_init_ir(coredev);
501 sms_info("device %p started, rc %d", coredev, rc);
503 kmutex_unlock(&g_smscore_deviceslock);
507 EXPORT_SYMBOL_GPL(smscore_start_device);
510 static int smscore_load_firmware_family2(struct smscore_device_t *coredev,
511 void *buffer, size_t size)
513 struct SmsFirmware_ST *firmware = (struct SmsFirmware_ST *) buffer;
514 struct SmsMsgHdr_ST *msg;
516 u8 *payload = firmware->Payload;
518 firmware->StartAddress = le32_to_cpu(firmware->StartAddress);
519 firmware->Length = le32_to_cpu(firmware->Length);
521 mem_address = firmware->StartAddress;
523 sms_info("loading FW to addr 0x%x size %d",
524 mem_address, firmware->Length);
525 if (coredev->preload_handler) {
526 rc = coredev->preload_handler(coredev->context);
531 /* PAGE_SIZE buffer shall be enough and dma aligned */
532 msg = kmalloc(PAGE_SIZE, GFP_KERNEL | GFP_DMA);
536 if (coredev->mode != DEVICE_MODE_NONE) {
537 sms_debug("sending reload command.");
538 SMS_INIT_MSG(msg, MSG_SW_RELOAD_START_REQ,
539 sizeof(struct SmsMsgHdr_ST));
540 rc = smscore_sendrequest_and_wait(coredev, msg,
542 &coredev->reload_start_done);
543 mem_address = *(u32 *) &payload[20];
546 while (size && rc >= 0) {
547 struct SmsDataDownload_ST *DataMsg =
548 (struct SmsDataDownload_ST *) msg;
549 int payload_size = min((int) size, SMS_MAX_PAYLOAD_SIZE);
551 SMS_INIT_MSG(msg, MSG_SMS_DATA_DOWNLOAD_REQ,
552 (u16)(sizeof(struct SmsMsgHdr_ST) +
553 sizeof(u32) + payload_size));
555 DataMsg->MemAddr = mem_address;
556 memcpy(DataMsg->Payload, payload, payload_size);
558 if ((coredev->device_flags & SMS_ROM_NO_RESPONSE) &&
559 (coredev->mode == DEVICE_MODE_NONE))
560 rc = coredev->sendrequest_handler(
561 coredev->context, DataMsg,
562 DataMsg->xMsgHeader.msgLength);
564 rc = smscore_sendrequest_and_wait(
566 DataMsg->xMsgHeader.msgLength,
567 &coredev->data_download_done);
569 payload += payload_size;
570 size -= payload_size;
571 mem_address += payload_size;
575 if (coredev->mode == DEVICE_MODE_NONE) {
576 struct SmsMsgData_ST *TriggerMsg =
577 (struct SmsMsgData_ST *) msg;
579 SMS_INIT_MSG(msg, MSG_SMS_SWDOWNLOAD_TRIGGER_REQ,
580 sizeof(struct SmsMsgHdr_ST) +
583 TriggerMsg->msgData[0] = firmware->StartAddress;
585 TriggerMsg->msgData[1] = 5; /* Priority */
586 TriggerMsg->msgData[2] = 0x200; /* Stack size */
587 TriggerMsg->msgData[3] = 0; /* Parameter */
588 TriggerMsg->msgData[4] = 4; /* Task ID */
590 if (coredev->device_flags & SMS_ROM_NO_RESPONSE) {
591 rc = coredev->sendrequest_handler(
592 coredev->context, TriggerMsg,
593 TriggerMsg->xMsgHeader.msgLength);
596 rc = smscore_sendrequest_and_wait(
598 TriggerMsg->xMsgHeader.msgLength,
599 &coredev->trigger_done);
601 SMS_INIT_MSG(msg, MSG_SW_RELOAD_EXEC_REQ,
602 sizeof(struct SmsMsgHdr_ST));
604 rc = coredev->sendrequest_handler(coredev->context,
605 msg, msg->msgLength);
610 sms_debug("rc=%d, postload=%p ", rc,
611 coredev->postload_handler);
615 return ((rc >= 0) && coredev->postload_handler) ?
616 coredev->postload_handler(coredev->context) :
621 * loads specified firmware into a buffer and calls device loadfirmware_handler
623 * @param coredev pointer to a coredev object returned by
624 * smscore_register_device
625 * @param filename null-terminated string specifies firmware file name
626 * @param loadfirmware_handler device handler that loads firmware
628 * @return 0 on success, <0 on error.
630 static int smscore_load_firmware_from_file(struct smscore_device_t *coredev,
632 loadfirmware_t loadfirmware_handler)
635 const struct firmware *fw;
638 if (loadfirmware_handler == NULL && !(coredev->device_flags &
642 rc = request_firmware(&fw, filename, coredev->device);
644 sms_info("failed to open \"%s\"", filename);
647 sms_info("read FW %s, size=%zd", filename, fw->size);
648 fw_buffer = kmalloc(ALIGN(fw->size, SMS_ALLOC_ALIGNMENT),
649 GFP_KERNEL | GFP_DMA);
651 memcpy(fw_buffer, fw->data, fw->size);
653 rc = (coredev->device_flags & SMS_DEVICE_FAMILY2) ?
654 smscore_load_firmware_family2(coredev,
657 loadfirmware_handler(coredev->context,
658 fw_buffer, fw->size);
662 sms_info("failed to allocate firmware buffer");
666 release_firmware(fw);
672 * notifies all clients registered with the device, notifies hotplugs,
673 * frees all buffers and coredev object
675 * @param coredev pointer to a coredev object returned by
676 * smscore_register_device
678 * @return 0 on success, <0 on error.
680 void smscore_unregister_device(struct smscore_device_t *coredev)
682 struct smscore_buffer_t *cb;
686 kmutex_lock(&g_smscore_deviceslock);
688 /* Release input device (IR) resources */
689 sms_ir_exit(coredev);
691 smscore_notify_clients(coredev);
692 smscore_notify_callbacks(coredev, NULL, 0);
694 /* at this point all buffers should be back
695 * onresponse must no longer be called */
698 while (!list_empty(&coredev->buffers)) {
699 cb = (struct smscore_buffer_t *) coredev->buffers.next;
700 list_del(&cb->entry);
704 if (num_buffers == coredev->num_buffers)
707 sms_info("exiting although "
708 "not all buffers released.");
712 sms_info("waiting for %d buffer(s)",
713 coredev->num_buffers - num_buffers);
717 sms_info("freed %d buffers", num_buffers);
719 if (coredev->common_buffer)
720 dma_free_coherent(NULL, coredev->common_buffer_size,
721 coredev->common_buffer, coredev->common_buffer_phys);
723 if (coredev->fw_buf != NULL)
724 kfree(coredev->fw_buf);
726 list_del(&coredev->entry);
729 kmutex_unlock(&g_smscore_deviceslock);
731 sms_info("device %p destroyed", coredev);
733 EXPORT_SYMBOL_GPL(smscore_unregister_device);
735 static int smscore_detect_mode(struct smscore_device_t *coredev)
737 void *buffer = kmalloc(sizeof(struct SmsMsgHdr_ST) + SMS_DMA_ALIGNMENT,
738 GFP_KERNEL | GFP_DMA);
739 struct SmsMsgHdr_ST *msg =
740 (struct SmsMsgHdr_ST *) SMS_ALIGN_ADDRESS(buffer);
746 SMS_INIT_MSG(msg, MSG_SMS_GET_VERSION_EX_REQ,
747 sizeof(struct SmsMsgHdr_ST));
749 rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength,
750 &coredev->version_ex_done);
752 sms_err("MSG_SMS_GET_VERSION_EX_REQ failed first try");
754 if (wait_for_completion_timeout(&coredev->resume_done,
755 msecs_to_jiffies(5000))) {
756 rc = smscore_sendrequest_and_wait(
757 coredev, msg, msg->msgLength,
758 &coredev->version_ex_done);
760 sms_err("MSG_SMS_GET_VERSION_EX_REQ failed "
761 "second try, rc %d", rc);
771 static char *smscore_fw_lkup[][SMS_NUM_OF_DEVICE_TYPES] = {
772 /*Stellar NOVA A0 Nova B0 VEGA*/
774 {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
776 {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
778 {"none", "tdmb_nova_12mhz.inp", "tdmb_nova_12mhz_b0.inp", "none"},
780 {"none", "none", "none", "none"},
782 {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
784 {"none", "isdbt_nova_12mhz.inp", "isdbt_nova_12mhz_b0.inp", "none"},
786 {"none", "isdbt_nova_12mhz.inp", "isdbt_nova_12mhz_b0.inp", "none"},
788 {"none", "none", "none", "cmmb_vega_12mhz.inp"}
791 static inline char *sms_get_fw_name(struct smscore_device_t *coredev,
792 int mode, enum sms_device_type_st type)
794 char **fw = sms_get_board(smscore_get_board_id(coredev))->fw;
795 return (fw && fw[mode]) ? fw[mode] : smscore_fw_lkup[mode][type];
799 * calls device handler to change mode of operation
800 * NOTE: stellar/usb may disconnect when changing mode
802 * @param coredev pointer to a coredev object returned by
803 * smscore_register_device
804 * @param mode requested mode of operation
806 * @return 0 on success, <0 on error.
808 int smscore_set_device_mode(struct smscore_device_t *coredev, int mode)
812 enum sms_device_type_st type;
814 sms_debug("set device mode to %d", mode);
815 if (coredev->device_flags & SMS_DEVICE_FAMILY2) {
816 if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_RAW_TUNER) {
817 sms_err("invalid mode specified %d", mode);
821 smscore_registry_setmode(coredev->devpath, mode);
823 if (!(coredev->device_flags & SMS_DEVICE_NOT_READY)) {
824 rc = smscore_detect_mode(coredev);
826 sms_err("mode detect failed %d", rc);
831 if (coredev->mode == mode) {
832 sms_info("device mode %d already set", mode);
836 if (!(coredev->modes_supported & (1 << mode))) {
839 type = smscore_registry_gettype(coredev->devpath);
840 fw_filename = sms_get_fw_name(coredev, mode, type);
842 rc = smscore_load_firmware_from_file(coredev,
845 sms_warn("error %d loading firmware: %s, "
846 "trying again with default firmware",
849 /* try again with the default firmware */
850 fw_filename = smscore_fw_lkup[mode][type];
851 rc = smscore_load_firmware_from_file(coredev,
855 sms_warn("error %d loading "
861 sms_log("firmware download success: %s", fw_filename);
863 sms_info("mode %d supported by running "
866 buffer = kmalloc(sizeof(struct SmsMsgData_ST) +
867 SMS_DMA_ALIGNMENT, GFP_KERNEL | GFP_DMA);
869 struct SmsMsgData_ST *msg =
870 (struct SmsMsgData_ST *)
871 SMS_ALIGN_ADDRESS(buffer);
873 SMS_INIT_MSG(&msg->xMsgHeader, MSG_SMS_INIT_DEVICE_REQ,
874 sizeof(struct SmsMsgData_ST));
875 msg->msgData[0] = mode;
877 rc = smscore_sendrequest_and_wait(
878 coredev, msg, msg->xMsgHeader.msgLength,
879 &coredev->init_device_done);
883 sms_err("Could not allocate buffer for "
884 "init device message.");
888 if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_DVBT_BDA) {
889 sms_err("invalid mode specified %d", mode);
893 smscore_registry_setmode(coredev->devpath, mode);
895 if (coredev->detectmode_handler)
896 coredev->detectmode_handler(coredev->context,
899 if (coredev->mode != mode && coredev->setmode_handler)
900 rc = coredev->setmode_handler(coredev->context, mode);
904 coredev->mode = mode;
905 coredev->device_flags &= ~SMS_DEVICE_NOT_READY;
909 sms_err("return error code %d.", rc);
914 * calls device handler to get current mode of operation
916 * @param coredev pointer to a coredev object returned by
917 * smscore_register_device
919 * @return current mode
921 int smscore_get_device_mode(struct smscore_device_t *coredev)
923 return coredev->mode;
925 EXPORT_SYMBOL_GPL(smscore_get_device_mode);
928 * find client by response id & type within the clients list.
929 * return client handle or NULL.
931 * @param coredev pointer to a coredev object returned by
932 * smscore_register_device
933 * @param data_type client data type (SMS_DONT_CARE for all types)
934 * @param id client id (SMS_DONT_CARE for all id)
938 smscore_client_t *smscore_find_client(struct smscore_device_t *coredev,
939 int data_type, int id)
941 struct smscore_client_t *client = NULL;
942 struct list_head *next, *first;
944 struct list_head *firstid, *nextid;
947 spin_lock_irqsave(&coredev->clientslock, flags);
948 first = &coredev->clients;
949 for (next = first->next;
950 (next != first) && !client;
952 firstid = &((struct smscore_client_t *)next)->idlist;
953 for (nextid = firstid->next;
955 nextid = nextid->next) {
956 if ((((struct smscore_idlist_t *)nextid)->id == id) &&
957 (((struct smscore_idlist_t *)nextid)->data_type == data_type ||
958 (((struct smscore_idlist_t *)nextid)->data_type == 0))) {
959 client = (struct smscore_client_t *) next;
964 spin_unlock_irqrestore(&coredev->clientslock, flags);
969 * find client by response id/type, call clients onresponse handler
970 * return buffer to pool on error
972 * @param coredev pointer to a coredev object returned by
973 * smscore_register_device
974 * @param cb pointer to response buffer descriptor
977 void smscore_onresponse(struct smscore_device_t *coredev,
978 struct smscore_buffer_t *cb) {
979 struct SmsMsgHdr_ST *phdr = (struct SmsMsgHdr_ST *) ((u8 *) cb->p
981 struct smscore_client_t *client;
983 static unsigned long last_sample_time; /* = 0; */
984 static int data_total; /* = 0; */
985 unsigned long time_now = jiffies_to_msecs(jiffies);
987 if (!last_sample_time)
988 last_sample_time = time_now;
990 if (time_now - last_sample_time > 10000) {
991 sms_debug("\ndata rate %d bytes/secs",
992 (int)((data_total * 1000) /
993 (time_now - last_sample_time)));
995 last_sample_time = time_now;
999 data_total += cb->size;
1000 /* Do we need to re-route? */
1001 if ((phdr->msgType == MSG_SMS_HO_PER_SLICES_IND) ||
1002 (phdr->msgType == MSG_SMS_TRANSMISSION_IND)) {
1003 if (coredev->mode == DEVICE_MODE_DVBT_BDA)
1004 phdr->msgDstId = DVBT_BDA_CONTROL_MSG_ID;
1008 client = smscore_find_client(coredev, phdr->msgType, phdr->msgDstId);
1010 /* If no client registered for type & id,
1011 * check for control client where type is not registered */
1013 rc = client->onresponse_handler(client->context, cb);
1016 switch (phdr->msgType) {
1017 case MSG_SMS_GET_VERSION_EX_RES:
1019 struct SmsVersionRes_ST *ver =
1020 (struct SmsVersionRes_ST *) phdr;
1021 sms_debug("MSG_SMS_GET_VERSION_EX_RES "
1022 "id %d prots 0x%x ver %d.%d",
1023 ver->FirmwareId, ver->SupportedProtocols,
1024 ver->RomVersionMajor, ver->RomVersionMinor);
1026 coredev->mode = ver->FirmwareId == 255 ?
1027 DEVICE_MODE_NONE : ver->FirmwareId;
1028 coredev->modes_supported = ver->SupportedProtocols;
1030 complete(&coredev->version_ex_done);
1033 case MSG_SMS_INIT_DEVICE_RES:
1034 sms_debug("MSG_SMS_INIT_DEVICE_RES");
1035 complete(&coredev->init_device_done);
1037 case MSG_SW_RELOAD_START_RES:
1038 sms_debug("MSG_SW_RELOAD_START_RES");
1039 complete(&coredev->reload_start_done);
1041 case MSG_SMS_DATA_DOWNLOAD_RES:
1042 complete(&coredev->data_download_done);
1044 case MSG_SW_RELOAD_EXEC_RES:
1045 sms_debug("MSG_SW_RELOAD_EXEC_RES");
1047 case MSG_SMS_SWDOWNLOAD_TRIGGER_RES:
1048 sms_debug("MSG_SMS_SWDOWNLOAD_TRIGGER_RES");
1049 complete(&coredev->trigger_done);
1051 case MSG_SMS_SLEEP_RESUME_COMP_IND:
1052 complete(&coredev->resume_done);
1054 case MSG_SMS_START_IR_RES:
1055 complete(&coredev->ir_init_done);
1057 case MSG_SMS_IR_SAMPLES_IND:
1058 sms_ir_event(coredev,
1061 + sizeof(struct SmsMsgHdr_ST)),
1062 (int)phdr->msgLength
1063 - sizeof(struct SmsMsgHdr_ST));
1069 smscore_putbuffer(coredev, cb);
1072 EXPORT_SYMBOL_GPL(smscore_onresponse);
1075 * return pointer to next free buffer descriptor from core pool
1077 * @param coredev pointer to a coredev object returned by
1078 * smscore_register_device
1080 * @return pointer to descriptor on success, NULL on error.
1082 struct smscore_buffer_t *smscore_getbuffer(struct smscore_device_t *coredev)
1084 struct smscore_buffer_t *cb = NULL;
1085 unsigned long flags;
1089 spin_lock_irqsave(&coredev->bufferslock, flags);
1091 /* This function must return a valid buffer, since the buffer list is
1092 * finite, we check that there is an available buffer, if not, we wait
1093 * until such buffer become available.
1096 prepare_to_wait(&coredev->buffer_mng_waitq, &wait, TASK_INTERRUPTIBLE);
1098 if (list_empty(&coredev->buffers))
1101 finish_wait(&coredev->buffer_mng_waitq, &wait);
1103 cb = (struct smscore_buffer_t *) coredev->buffers.next;
1104 list_del(&cb->entry);
1106 spin_unlock_irqrestore(&coredev->bufferslock, flags);
1110 EXPORT_SYMBOL_GPL(smscore_getbuffer);
1113 * return buffer descriptor to a pool
1115 * @param coredev pointer to a coredev object returned by
1116 * smscore_register_device
1117 * @param cb pointer buffer descriptor
1120 void smscore_putbuffer(struct smscore_device_t *coredev,
1121 struct smscore_buffer_t *cb) {
1122 wake_up_interruptible(&coredev->buffer_mng_waitq);
1123 list_add_locked(&cb->entry, &coredev->buffers, &coredev->bufferslock);
1125 EXPORT_SYMBOL_GPL(smscore_putbuffer);
1127 static int smscore_validate_client(struct smscore_device_t *coredev,
1128 struct smscore_client_t *client,
1129 int data_type, int id)
1131 struct smscore_idlist_t *listentry;
1132 struct smscore_client_t *registered_client;
1135 sms_err("bad parameter.");
1138 registered_client = smscore_find_client(coredev, data_type, id);
1139 if (registered_client == client)
1142 if (registered_client) {
1143 sms_err("The msg ID already registered to another client.");
1146 listentry = kzalloc(sizeof(struct smscore_idlist_t), GFP_KERNEL);
1148 sms_err("Can't allocate memory for client id.");
1152 listentry->data_type = data_type;
1153 list_add_locked(&listentry->entry, &client->idlist,
1154 &coredev->clientslock);
1159 * creates smsclient object, check that id is taken by another client
1161 * @param coredev pointer to a coredev object from clients hotplug
1162 * @param initial_id all messages with this id would be sent to this client
1163 * @param data_type all messages of this type would be sent to this client
1164 * @param onresponse_handler client handler that is called to
1165 * process incoming messages
1166 * @param onremove_handler client handler that is called when device is removed
1167 * @param context client-specific context
1168 * @param client pointer to a value that receives created smsclient object
1170 * @return 0 on success, <0 on error.
1172 int smscore_register_client(struct smscore_device_t *coredev,
1173 struct smsclient_params_t *params,
1174 struct smscore_client_t **client)
1176 struct smscore_client_t *newclient;
1177 /* check that no other channel with same parameters exists */
1178 if (smscore_find_client(coredev, params->data_type,
1179 params->initial_id)) {
1180 sms_err("Client already exist.");
1184 newclient = kzalloc(sizeof(struct smscore_client_t), GFP_KERNEL);
1186 sms_err("Failed to allocate memory for client.");
1190 INIT_LIST_HEAD(&newclient->idlist);
1191 newclient->coredev = coredev;
1192 newclient->onresponse_handler = params->onresponse_handler;
1193 newclient->onremove_handler = params->onremove_handler;
1194 newclient->context = params->context;
1195 list_add_locked(&newclient->entry, &coredev->clients,
1196 &coredev->clientslock);
1197 smscore_validate_client(coredev, newclient, params->data_type,
1198 params->initial_id);
1199 *client = newclient;
1200 sms_debug("%p %d %d", params->context, params->data_type,
1201 params->initial_id);
1205 EXPORT_SYMBOL_GPL(smscore_register_client);
1208 * frees smsclient object and all subclients associated with it
1210 * @param client pointer to smsclient object returned by
1211 * smscore_register_client
1214 void smscore_unregister_client(struct smscore_client_t *client)
1216 struct smscore_device_t *coredev = client->coredev;
1217 unsigned long flags;
1219 spin_lock_irqsave(&coredev->clientslock, flags);
1222 while (!list_empty(&client->idlist)) {
1223 struct smscore_idlist_t *identry =
1224 (struct smscore_idlist_t *) client->idlist.next;
1225 list_del(&identry->entry);
1229 sms_info("%p", client->context);
1231 list_del(&client->entry);
1234 spin_unlock_irqrestore(&coredev->clientslock, flags);
1236 EXPORT_SYMBOL_GPL(smscore_unregister_client);
1239 * verifies that source id is not taken by another client,
1240 * calls device handler to send requests to the device
1242 * @param client pointer to smsclient object returned by
1243 * smscore_register_client
1244 * @param buffer pointer to a request buffer
1245 * @param size size (in bytes) of request buffer
1247 * @return 0 on success, <0 on error.
1249 int smsclient_sendrequest(struct smscore_client_t *client,
1250 void *buffer, size_t size)
1252 struct smscore_device_t *coredev;
1253 struct SmsMsgHdr_ST *phdr = (struct SmsMsgHdr_ST *) buffer;
1256 if (client == NULL) {
1257 sms_err("Got NULL client");
1261 coredev = client->coredev;
1263 /* check that no other channel with same id exists */
1264 if (coredev == NULL) {
1265 sms_err("Got NULL coredev");
1269 rc = smscore_validate_client(client->coredev, client, 0,
1274 return coredev->sendrequest_handler(coredev->context, buffer, size);
1276 EXPORT_SYMBOL_GPL(smsclient_sendrequest);
1279 /* old GPIO managments implementation */
1280 int smscore_configure_gpio(struct smscore_device_t *coredev, u32 pin,
1281 struct smscore_config_gpio *pinconfig)
1284 struct SmsMsgHdr_ST hdr;
1288 if (coredev->device_flags & SMS_DEVICE_FAMILY2) {
1289 msg.hdr.msgSrcId = DVBT_BDA_CONTROL_MSG_ID;
1290 msg.hdr.msgDstId = HIF_TASK;
1291 msg.hdr.msgFlags = 0;
1292 msg.hdr.msgType = MSG_SMS_GPIO_CONFIG_EX_REQ;
1293 msg.hdr.msgLength = sizeof(msg);
1296 msg.data[1] = pinconfig->pullupdown;
1298 /* Convert slew rate for Nova: Fast(0) = 3 / Slow(1) = 0; */
1299 msg.data[2] = pinconfig->outputslewrate == 0 ? 3 : 0;
1301 switch (pinconfig->outputdriving) {
1302 case SMS_GPIO_OUTPUTDRIVING_16mA:
1303 msg.data[3] = 7; /* Nova - 16mA */
1305 case SMS_GPIO_OUTPUTDRIVING_12mA:
1306 msg.data[3] = 5; /* Nova - 11mA */
1308 case SMS_GPIO_OUTPUTDRIVING_8mA:
1309 msg.data[3] = 3; /* Nova - 7mA */
1311 case SMS_GPIO_OUTPUTDRIVING_4mA:
1313 msg.data[3] = 2; /* Nova - 4mA */
1317 msg.data[4] = pinconfig->direction;
1319 } else /* TODO: SMS_DEVICE_FAMILY1 */
1322 return coredev->sendrequest_handler(coredev->context,
1326 int smscore_set_gpio(struct smscore_device_t *coredev, u32 pin, int level)
1329 struct SmsMsgHdr_ST hdr;
1333 if (pin > MAX_GPIO_PIN_NUMBER)
1336 msg.hdr.msgSrcId = DVBT_BDA_CONTROL_MSG_ID;
1337 msg.hdr.msgDstId = HIF_TASK;
1338 msg.hdr.msgFlags = 0;
1339 msg.hdr.msgType = MSG_SMS_GPIO_SET_LEVEL_REQ;
1340 msg.hdr.msgLength = sizeof(msg);
1343 msg.data[1] = level ? 1 : 0;
1346 return coredev->sendrequest_handler(coredev->context,
1350 /* new GPIO managment implementation */
1351 static int GetGpioPinParams(u32 PinNum, u32 *pTranslatedPinNum,
1352 u32 *pGroupNum, u32 *pGroupCfg) {
1356 if (PinNum >= 0 && PinNum <= 1) {
1357 *pTranslatedPinNum = 0;
1360 } else if (PinNum >= 2 && PinNum <= 6) {
1361 *pTranslatedPinNum = 2;
1364 } else if (PinNum >= 7 && PinNum <= 11) {
1365 *pTranslatedPinNum = 7;
1367 } else if (PinNum >= 12 && PinNum <= 15) {
1368 *pTranslatedPinNum = 12;
1371 } else if (PinNum == 16) {
1372 *pTranslatedPinNum = 16;
1374 } else if (PinNum >= 17 && PinNum <= 24) {
1375 *pTranslatedPinNum = 17;
1377 } else if (PinNum == 25) {
1378 *pTranslatedPinNum = 25;
1380 } else if (PinNum >= 26 && PinNum <= 28) {
1381 *pTranslatedPinNum = 26;
1383 } else if (PinNum == 29) {
1384 *pTranslatedPinNum = 29;
1387 } else if (PinNum == 30) {
1388 *pTranslatedPinNum = 30;
1390 } else if (PinNum == 31) {
1391 *pTranslatedPinNum = 31;
1401 int smscore_gpio_configure(struct smscore_device_t *coredev, u8 PinNum,
1402 struct smscore_gpio_config *pGpioConfig) {
1405 u32 TranslatedPinNum;
1413 struct SmsMsgHdr_ST xMsgHeader;
1418 if (PinNum > MAX_GPIO_PIN_NUMBER)
1421 if (pGpioConfig == NULL)
1424 totalLen = sizeof(struct SmsMsgHdr_ST) + (sizeof(u32) * 6);
1426 buffer = kmalloc(totalLen + SMS_DMA_ALIGNMENT,
1427 GFP_KERNEL | GFP_DMA);
1431 pMsg = (struct SetGpioMsg *) SMS_ALIGN_ADDRESS(buffer);
1433 pMsg->xMsgHeader.msgSrcId = DVBT_BDA_CONTROL_MSG_ID;
1434 pMsg->xMsgHeader.msgDstId = HIF_TASK;
1435 pMsg->xMsgHeader.msgFlags = 0;
1436 pMsg->xMsgHeader.msgLength = (u16) totalLen;
1437 pMsg->msgData[0] = PinNum;
1439 if (!(coredev->device_flags & SMS_DEVICE_FAMILY2)) {
1440 pMsg->xMsgHeader.msgType = MSG_SMS_GPIO_CONFIG_REQ;
1441 if (GetGpioPinParams(PinNum, &TranslatedPinNum, &GroupNum,
1445 pMsg->msgData[1] = TranslatedPinNum;
1446 pMsg->msgData[2] = GroupNum;
1447 ElectricChar = (pGpioConfig->PullUpDown)
1448 | (pGpioConfig->InputCharacteristics << 2)
1449 | (pGpioConfig->OutputSlewRate << 3)
1450 | (pGpioConfig->OutputDriving << 4);
1451 pMsg->msgData[3] = ElectricChar;
1452 pMsg->msgData[4] = pGpioConfig->Direction;
1453 pMsg->msgData[5] = groupCfg;
1455 pMsg->xMsgHeader.msgType = MSG_SMS_GPIO_CONFIG_EX_REQ;
1456 pMsg->msgData[1] = pGpioConfig->PullUpDown;
1457 pMsg->msgData[2] = pGpioConfig->OutputSlewRate;
1458 pMsg->msgData[3] = pGpioConfig->OutputDriving;
1459 pMsg->msgData[4] = pGpioConfig->Direction;
1460 pMsg->msgData[5] = 0;
1463 smsendian_handle_tx_message((struct SmsMsgHdr_ST *)pMsg);
1464 rc = smscore_sendrequest_and_wait(coredev, pMsg, totalLen,
1465 &coredev->gpio_configuration_done);
1469 sms_err("smscore_gpio_configure timeout");
1471 sms_err("smscore_gpio_configure error");
1478 int smscore_gpio_set_level(struct smscore_device_t *coredev, u8 PinNum,
1486 struct SmsMsgHdr_ST xMsgHeader;
1487 u32 msgData[3]; /* keep it 3 ! */
1490 if ((NewLevel > 1) || (PinNum > MAX_GPIO_PIN_NUMBER) ||
1491 (PinNum > MAX_GPIO_PIN_NUMBER))
1494 totalLen = sizeof(struct SmsMsgHdr_ST) +
1495 (3 * sizeof(u32)); /* keep it 3 ! */
1497 buffer = kmalloc(totalLen + SMS_DMA_ALIGNMENT,
1498 GFP_KERNEL | GFP_DMA);
1502 pMsg = (struct SetGpioMsg *) SMS_ALIGN_ADDRESS(buffer);
1504 pMsg->xMsgHeader.msgSrcId = DVBT_BDA_CONTROL_MSG_ID;
1505 pMsg->xMsgHeader.msgDstId = HIF_TASK;
1506 pMsg->xMsgHeader.msgFlags = 0;
1507 pMsg->xMsgHeader.msgType = MSG_SMS_GPIO_SET_LEVEL_REQ;
1508 pMsg->xMsgHeader.msgLength = (u16) totalLen;
1509 pMsg->msgData[0] = PinNum;
1510 pMsg->msgData[1] = NewLevel;
1512 /* Send message to SMS */
1513 smsendian_handle_tx_message((struct SmsMsgHdr_ST *)pMsg);
1514 rc = smscore_sendrequest_and_wait(coredev, pMsg, totalLen,
1515 &coredev->gpio_set_level_done);
1519 sms_err("smscore_gpio_set_level timeout");
1521 sms_err("smscore_gpio_set_level error");
1528 int smscore_gpio_get_level(struct smscore_device_t *coredev, u8 PinNum,
1536 struct SmsMsgHdr_ST xMsgHeader;
1541 if (PinNum > MAX_GPIO_PIN_NUMBER)
1544 totalLen = sizeof(struct SmsMsgHdr_ST) + (2 * sizeof(u32));
1546 buffer = kmalloc(totalLen + SMS_DMA_ALIGNMENT,
1547 GFP_KERNEL | GFP_DMA);
1551 pMsg = (struct SetGpioMsg *) SMS_ALIGN_ADDRESS(buffer);
1553 pMsg->xMsgHeader.msgSrcId = DVBT_BDA_CONTROL_MSG_ID;
1554 pMsg->xMsgHeader.msgDstId = HIF_TASK;
1555 pMsg->xMsgHeader.msgFlags = 0;
1556 pMsg->xMsgHeader.msgType = MSG_SMS_GPIO_GET_LEVEL_REQ;
1557 pMsg->xMsgHeader.msgLength = (u16) totalLen;
1558 pMsg->msgData[0] = PinNum;
1559 pMsg->msgData[1] = 0;
1561 /* Send message to SMS */
1562 smsendian_handle_tx_message((struct SmsMsgHdr_ST *)pMsg);
1563 rc = smscore_sendrequest_and_wait(coredev, pMsg, totalLen,
1564 &coredev->gpio_get_level_done);
1568 sms_err("smscore_gpio_get_level timeout");
1570 sms_err("smscore_gpio_get_level error");
1574 /* Its a race between other gpio_get_level() and the copy of the single
1575 * global 'coredev->gpio_get_res' to the function's variable 'level'
1577 *level = coredev->gpio_get_res;
1582 static int __init smscore_module_init(void)
1586 INIT_LIST_HEAD(&g_smscore_notifyees);
1587 INIT_LIST_HEAD(&g_smscore_devices);
1588 kmutex_init(&g_smscore_deviceslock);
1590 INIT_LIST_HEAD(&g_smscore_registry);
1591 kmutex_init(&g_smscore_registrylock);
1599 sms_debug("rc %d", rc);
1604 static void __exit smscore_module_exit(void)
1611 kmutex_lock(&g_smscore_deviceslock);
1612 while (!list_empty(&g_smscore_notifyees)) {
1613 struct smscore_device_notifyee_t *notifyee =
1614 (struct smscore_device_notifyee_t *)
1615 g_smscore_notifyees.next;
1617 list_del(¬ifyee->entry);
1620 kmutex_unlock(&g_smscore_deviceslock);
1622 kmutex_lock(&g_smscore_registrylock);
1623 while (!list_empty(&g_smscore_registry)) {
1624 struct smscore_registry_entry_t *entry =
1625 (struct smscore_registry_entry_t *)
1626 g_smscore_registry.next;
1628 list_del(&entry->entry);
1631 kmutex_unlock(&g_smscore_registrylock);
1636 module_init(smscore_module_init);
1637 module_exit(smscore_module_exit);
1639 MODULE_DESCRIPTION("Siano MDTV Core module");
1640 MODULE_AUTHOR("Siano Mobile Silicon, Inc. (uris@siano-ms.com)");
1641 MODULE_LICENSE("GPL");