V4L/DVB (8258): add support for SMS1010 and SMS1150 based digital television devices

initial driver drop, provided by Siano Mobile Silicon, Inc.

Signed-off-by: Michael Krufky <mkrufky@linuxtv.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab@infradead.org>

1 files changed, 1170 insertions, 0 deletions

diff --git a/drivers/media/mdtv/smscoreapi.c b/drivers/media/mdtv/smscoreapi.c
new file mode 100644
index 00000000000..a354912391a
--- /dev/null
+++ b/drivers/media/mdtv/smscoreapi.c
@@ -0,0 +1,1170 @@
+/*!
+
+	\file		smscoreapi.c
+
+	\brief		Siano core API module
+				This file contains implementation for the interface to sms core component
+
+    \par 		Copyright (c), 2005-2008 Siano Mobile Silicon, Inc.
+
+    \par 		This program is free software; you can redistribute it and/or modify
+			it under the terms of the GNU General Public License version 3 as
+			published by the Free Software Foundation;
+
+			Software distributed under the License is distributed on an "AS
+			IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+			implied.
+
+	\author		Anatoly Greenblat
+
+*/
+
+#include <linux/kernel.h>
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/moduleparam.h>
+#include <linux/dma-mapping.h>
+#include <linux/delay.h>
+#include <asm/io.h>
+
+#include "smskdefs.h" // device, page, scatterlist, kmutex
+
+#include <linux/firmware.h>
+
+#include "smscoreapi.h"
+#include "smstypes.h"
+
+#include "smschar.h"
+
+typedef struct _smscore_device_notifyee
+{
+	struct list_head entry;
+	hotplug_t hotplug;
+} smscore_device_notifyee_t;
+
+typedef struct _smscore_client
+{
+	struct list_head entry;
+	smscore_device_t *coredev;
+
+	void			*context;
+
+	int				data_type;
+
+	onresponse_t	onresponse_handler;
+	onremove_t		onremove_handler;
+} *psmscore_client_t;
+
+typedef struct _smscore_subclient
+{
+	struct list_head entry;
+	smscore_client_t *client;
+
+	int				id;
+} smscore_subclient_t;
+
+typedef struct _smscore_device
+{
+	struct list_head entry;
+
+	struct list_head clients;
+	struct list_head subclients;
+	spinlock_t		clientslock;
+
+	struct list_head buffers;
+	spinlock_t		bufferslock;
+	int				num_buffers;
+
+	void			*common_buffer;
+	int				common_buffer_size;
+	dma_addr_t		common_buffer_phys;
+
+	void			*context;
+	struct device	*device;
+
+	char			devpath[32];
+	unsigned long	device_flags;
+
+	setmode_t		setmode_handler;
+	detectmode_t	detectmode_handler;
+	sendrequest_t	sendrequest_handler;
+	preload_t		preload_handler;
+	postload_t		postload_handler;
+
+	int				mode, modes_supported;
+
+	struct completion version_ex_done, data_download_done, trigger_done;
+	struct completion init_device_done, reload_start_done, resume_done;
+} *psmscore_device_t;
+
+typedef struct _smscore_registry_entry
+{
+	struct list_head entry;
+	char			devpath[32];
+	int				mode;
+} smscore_registry_entry_t;
+
+struct list_head g_smscore_notifyees;
+struct list_head g_smscore_devices;
+kmutex_t g_smscore_deviceslock;
+
+struct list_head g_smscore_registry;
+kmutex_t g_smscore_registrylock;
+
+static int default_mode = 1;
+module_param(default_mode, int, 0644);
+MODULE_PARM_DESC(default_mode, "default firmware id (device mode)");
+
+int smscore_registry_getmode(char* devpath)
+{
+	smscore_registry_entry_t *entry;
+	struct list_head *next;
+
+	kmutex_lock(&g_smscore_registrylock);
+
+	for (next = g_smscore_registry.next; next != &g_smscore_registry; next = next->next)
+	{
+		entry = (smscore_registry_entry_t *) next;
+
+		if (!strcmp(entry->devpath, devpath))
+		{
+			kmutex_unlock(&g_smscore_registrylock);
+			return entry->mode;
+		}
+	}
+
+	entry = (smscore_registry_entry_t *) kmalloc(sizeof(smscore_registry_entry_t), GFP_KERNEL);
+	if (entry)
+	{
+		entry->mode = default_mode;
+		strcpy(entry->devpath, devpath);
+
+		list_add(&entry->entry, &g_smscore_registry);
+	}
+
+	kmutex_unlock(&g_smscore_registrylock);
+
+	return default_mode;
+}
+
+void smscore_registry_setmode(char* devpath, int mode)
+{
+	smscore_registry_entry_t *entry;
+	struct list_head *next;
+
+	kmutex_lock(&g_smscore_registrylock);
+
+	for (next = g_smscore_registry.next; next != &g_smscore_registry; next = next->next)
+	{
+		entry = (smscore_registry_entry_t *) next;
+
+		if (!strcmp(entry->devpath, devpath))
+		{
+			entry->mode = mode;
+			break;
+		}
+	}
+
+	kmutex_unlock(&g_smscore_registrylock);
+}
+
+
+void list_add_locked(struct list_head *new, struct list_head *head, spinlock_t* lock)
+{
+	unsigned long flags;
+
+	spin_lock_irqsave(lock, flags);
+
+	list_add(new, head);
+
+	spin_unlock_irqrestore(lock, flags);
+}
+
+/**
+ * register a client callback that called when device plugged in/unplugged
+ * NOTE: if devices exist callback is called immediately for each device
+ *
+ * @param hotplug callback
+ *
+ * @return 0 on success, <0 on error.
+ */
+int smscore_register_hotplug(hotplug_t hotplug)
+{
+	smscore_device_notifyee_t *notifyee;
+	struct list_head *next, *first;
+	int rc = 0;
+
+	kmutex_lock(&g_smscore_deviceslock);
+
+	notifyee = kmalloc(sizeof(smscore_device_notifyee_t), GFP_KERNEL);
+	if (notifyee)
+	{
+		// now notify callback about existing devices
+		first = &g_smscore_devices;
+		for (next = first->next; next != first && !rc; next = next->next)
+		{
+			smscore_device_t *coredev = (smscore_device_t *) next;
+			rc = hotplug(coredev, coredev->device, 1);
+		}
+
+		if (rc >= 0)
+		{
+			notifyee->hotplug = hotplug;
+			list_add(&notifyee->entry, &g_smscore_notifyees);
+		}
+		else
+			kfree(notifyee);
+	}
+	else
+		rc = -ENOMEM;
+
+	kmutex_unlock(&g_smscore_deviceslock);
+
+	return rc;
+}
+
+/**
+ * unregister a client callback that called when device plugged in/unplugged
+ *
+ * @param hotplug callback
+ *
+ */
+void smscore_unregister_hotplug(hotplug_t hotplug)
+{
+	struct list_head *next, *first;
+
+	kmutex_lock(&g_smscore_deviceslock);
+
+	first = &g_smscore_notifyees;
+
+	for (next = first->next; next != first;)
+	{
+		smscore_device_notifyee_t *notifyee = (smscore_device_notifyee_t *) next;
+		next = next->next;
+
+		if (notifyee->hotplug == hotplug)
+		{
+			list_del(&notifyee->entry);
+			kfree(notifyee);
+		}
+	}
+
+	kmutex_unlock(&g_smscore_deviceslock);
+}
+
+void smscore_notify_clients(smscore_device_t *coredev)
+{
+	smscore_client_t* client;
+
+	// the client must call smscore_unregister_client from remove handler
+	while (!list_empty(&coredev->clients))
+	{
+		client = (smscore_client_t *) coredev->clients.next;
+		client->onremove_handler(client->context);
+	}
+}
+
+int smscore_notify_callbacks(smscore_device_t *coredev, struct device *device, int arrival)
+{
+	struct list_head *next, *first;
+	int rc = 0;
+
+	// note: must be called under g_deviceslock
+
+	first = &g_smscore_notifyees;
+
+	for (next = first->next; next != first; next = next->next)
+	{
+		rc = ((smscore_device_notifyee_t *) next)->hotplug(coredev, device, arrival);
+		if (rc < 0)
+			break;
+	}
+
+	return rc;
+}
+
+smscore_buffer_t *smscore_createbuffer(u8* buffer, void* common_buffer, dma_addr_t common_buffer_phys)
+{
+	smscore_buffer_t *cb = kmalloc(sizeof(smscore_buffer_t), GFP_KERNEL);
+	if (!cb)
+	{
+		printk(KERN_INFO "%s kmalloc(...) failed\n", __FUNCTION__);
+		return NULL;
+	}
+
+	cb->p = buffer;
+	cb->offset_in_common = buffer - (u8*) common_buffer;
+	cb->phys = common_buffer_phys + cb->offset_in_common;
+
+	return cb;
+}
+
+/**
+ * creates coredev object for a device, prepares buffers, creates buffer mappings, notifies
+ * registered hotplugs about new device.
+ *
+ * @param params device pointer to struct with device specific parameters and handlers
+ * @param coredev pointer to a value that receives created coredev object
+ *
+ * @return 0 on success, <0 on error.
+ */
+int smscore_register_device(smsdevice_params_t *params, smscore_device_t **coredev)
+{
+	smscore_device_t* dev;
+	u8 *buffer;
+
+	dev = kzalloc(sizeof(smscore_device_t), GFP_KERNEL);
+	if (!dev)
+	{
+		printk(KERN_INFO "%s kzalloc(...) failed\n", __FUNCTION__);
+		return -ENOMEM;
+	}
+
+	// init list entry so it could be safe in smscore_unregister_device
+	INIT_LIST_HEAD(&dev->entry);
+
+	// init queues
+	INIT_LIST_HEAD(&dev->clients);
+	INIT_LIST_HEAD(&dev->subclients);
+	INIT_LIST_HEAD(&dev->buffers);
+
+	// init locks
+	spin_lock_init(&dev->clientslock);
+	spin_lock_init(&dev->bufferslock);
+
+	// init completion events
+	init_completion(&dev->version_ex_done);
+	init_completion(&dev->data_download_done);
+	init_completion(&dev->trigger_done);
+	init_completion(&dev->init_device_done);
+	init_completion(&dev->reload_start_done);
+	init_completion(&dev->resume_done);
+
+	// alloc common buffer
+	dev->common_buffer_size = params->buffer_size * params->num_buffers;
+	dev->common_buffer = dma_alloc_coherent(NULL, dev->common_buffer_size, &dev->common_buffer_phys, GFP_KERNEL | GFP_DMA);
+	if (!dev->common_buffer)
+	{
+		smscore_unregister_device(dev);
+		return -ENOMEM;
+	}
+
+	// prepare dma buffers
+	for (buffer = dev->common_buffer; dev->num_buffers < params->num_buffers; dev->num_buffers ++, buffer += params->buffer_size)
+	{
+		smscore_buffer_t *cb = smscore_createbuffer(buffer, dev->common_buffer, dev->common_buffer_phys);
+		if (!cb)
+		{
+			smscore_unregister_device(dev);
+			return -ENOMEM;
+		}
+
+		smscore_putbuffer(dev, cb);
+	}
+
+	printk(KERN_INFO "%s allocated %d buffers\n", __FUNCTION__, dev->num_buffers);
+
+	dev->mode = DEVICE_MODE_NONE;
+	dev->context = params->context;
+	dev->device = params->device;
+	dev->setmode_handler = params->setmode_handler;
+	dev->detectmode_handler = params->detectmode_handler;
+	dev->sendrequest_handler = params->sendrequest_handler;
+	dev->preload_handler = params->preload_handler;
+	dev->postload_handler = params->postload_handler;
+
+	dev->device_flags = params->flags;
+	strcpy(dev->devpath, params->devpath);
+
+	// add device to devices list
+	kmutex_lock(&g_smscore_deviceslock);
+	list_add(&dev->entry, &g_smscore_devices);
+	kmutex_unlock(&g_smscore_deviceslock);
+
+	*coredev = dev;
+
+	printk(KERN_INFO "%s device %p created\n", __FUNCTION__, dev);
+
+	return 0;
+}
+
+/**
+ * sets initial device mode and notifies client hotplugs that device is ready
+ *
+ * @param coredev pointer to a coredev object returned by smscore_register_device
+ *
+ * @return 0 on success, <0 on error.
+ */
+int smscore_start_device(smscore_device_t *coredev)
+{
+	int rc = smscore_set_device_mode(coredev, smscore_registry_getmode(coredev->devpath));
+	if (rc < 0)
+		return rc;
+
+	kmutex_lock(&g_smscore_deviceslock);
+
+	rc = smscore_notify_callbacks(coredev, coredev->device, 1);
+
+	printk(KERN_INFO "%s device %p started, rc %d\n", __FUNCTION__, coredev, rc);
+
+	kmutex_unlock(&g_smscore_deviceslock);
+
+	return rc;
+}
+
+int smscore_sendrequest_and_wait(smscore_device_t *coredev, void* buffer, size_t size, struct completion *completion)
+{
+	int rc = coredev->sendrequest_handler(coredev->context, buffer, size);
+	if (rc < 0)
+		return rc;
+
+	return wait_for_completion_timeout(completion, msecs_to_jiffies(1000)) ? 0 : -ETIME;
+}
+
+int smscore_load_firmware_family2(smscore_device_t *coredev, void *buffer, size_t size)
+{
+	SmsFirmware_ST* firmware = (SmsFirmware_ST*) buffer;
+	SmsMsgHdr_ST *msg;
+	UINT32 mem_address = firmware->StartAddress;
+	u8* payload = firmware->Payload;
+	int rc = 0;
+
+	if (coredev->preload_handler)
+	{
+		rc = coredev->preload_handler(coredev->context);
+		if (rc < 0)
+			return rc;
+	}
+
+	// PAGE_SIZE buffer shall be enough and dma aligned
+	msg = (SmsMsgHdr_ST *) kmalloc(PAGE_SIZE, GFP_KERNEL | GFP_DMA);
+	if (!msg)
+		return -ENOMEM;
+
+	if (coredev->mode != DEVICE_MODE_NONE)
+	{
+		SMS_INIT_MSG(msg, MSG_SW_RELOAD_START_REQ, sizeof(SmsMsgHdr_ST));
+		rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength, &coredev->reload_start_done);
+		mem_address = *(UINT32*) &payload[20];
+	}
+
+	while (size && rc >= 0)
+	{
+		SmsDataDownload_ST *DataMsg = (SmsDataDownload_ST *) msg;
+		int payload_size = min((int) size, SMS_MAX_PAYLOAD_SIZE);
+
+		SMS_INIT_MSG(msg, MSG_SMS_DATA_DOWNLOAD_REQ, (UINT16)(sizeof(SmsMsgHdr_ST) + sizeof(UINT32) + payload_size));
+
+		DataMsg->MemAddr = mem_address;
+		memcpy(DataMsg->Payload, payload, payload_size);
+
+		if (coredev->device_flags & SMS_ROM_NO_RESPONSE && coredev->mode == DEVICE_MODE_NONE)
+			rc = coredev->sendrequest_handler(coredev->context, DataMsg, DataMsg->xMsgHeader.msgLength);
+		else
+			rc = smscore_sendrequest_and_wait(coredev, DataMsg, DataMsg->xMsgHeader.msgLength, &coredev->data_download_done);
+
+		payload += payload_size;
+		size -= payload_size;
+		mem_address += payload_size;
+	}
+
+	if (rc >= 0)
+	{
+		if (coredev->mode == DEVICE_MODE_NONE)
+		{
+			SmsMsgData_ST* TriggerMsg = (SmsMsgData_ST*) msg;
+
+			SMS_INIT_MSG(msg, MSG_SMS_SWDOWNLOAD_TRIGGER_REQ, sizeof(SmsMsgHdr_ST) + sizeof(UINT32) * 5);
+
+			TriggerMsg->msgData[0] = firmware->StartAddress;	// Entry point
+			TriggerMsg->msgData[1] = 5;							// Priority
+			TriggerMsg->msgData[2] = 0x200;						// Stack size
+			TriggerMsg->msgData[3] = 0;							// Parameter
+			TriggerMsg->msgData[4] = 4;							// Task ID
+
+			if (coredev->device_flags & SMS_ROM_NO_RESPONSE)
+			{
+				rc = coredev->sendrequest_handler(coredev->context, TriggerMsg, TriggerMsg->xMsgHeader.msgLength);
+				msleep(100);
+			}
+			else
+				rc = smscore_sendrequest_and_wait(coredev, TriggerMsg, TriggerMsg->xMsgHeader.msgLength, &coredev->trigger_done);
+		}
+		else
+		{
+			SMS_INIT_MSG(msg, MSG_SW_RELOAD_EXEC_REQ, sizeof(SmsMsgHdr_ST));
+
+			rc = coredev->sendrequest_handler(coredev->context, msg, msg->msgLength);
+		}
+	}
+
+	printk("%s %d \n", __func__, rc);
+
+	kfree(msg);
+
+	return (rc >= 0 && coredev->postload_handler) ?
+		coredev->postload_handler(coredev->context) :
+		rc;
+}
+
+/**
+ * loads specified firmware into a buffer and calls device loadfirmware_handler
+ *
+ * @param coredev pointer to a coredev object returned by smscore_register_device
+ * @param filename null-terminated string specifies firmware file name
+ * @param loadfirmware_handler device handler that loads firmware
+ *
+ * @return 0 on success, <0 on error.
+ */
+int smscore_load_firmware(smscore_device_t *coredev, char* filename, loadfirmware_t loadfirmware_handler)
+{
+	int rc = -ENOENT;
+
+	const struct firmware *fw;
+	u8* fw_buffer;
+
+	if (loadfirmware_handler == NULL && !(coredev->device_flags & SMS_DEVICE_FAMILY2))
+		return -EINVAL;
+
+	rc = request_firmware(&fw, filename, coredev->device);
+	if (rc < 0)
+	{
+		printk(KERN_INFO "%s failed to open \"%s\"\n", __FUNCTION__, filename);
+		return rc;
+	}
+
+	fw_buffer = kmalloc(ALIGN(fw->size, SMS_ALLOC_ALIGNMENT), GFP_KERNEL | GFP_DMA);
+	if (fw_buffer)
+	{
+		memcpy(fw_buffer, fw->data, fw->size);
+
+		rc = (coredev->device_flags & SMS_DEVICE_FAMILY2) ?
+			smscore_load_firmware_family2(coredev, fw_buffer, fw->size) :
+			loadfirmware_handler(coredev->context, fw_buffer, fw->size);
+
+		kfree(fw_buffer);
+	}
+	else
+	{
+		printk(KERN_INFO "%s failed to allocate firmware buffer\n", __FUNCTION__);
+		rc = -ENOMEM;
+	}
+
+	release_firmware(fw);
+
+	return rc;
+}
+
+/**
+ * notifies all clients registered with the device, notifies hotplugs, frees all buffers and coredev object
+ *
+ * @param coredev pointer to a coredev object returned by smscore_register_device
+ *
+ * @return 0 on success, <0 on error.
+ */
+void smscore_unregister_device(smscore_device_t *coredev)
+{
+	smscore_buffer_t *cb;
+	int num_buffers = 0;
+
+	kmutex_lock(&g_smscore_deviceslock);
+
+	smscore_notify_clients(coredev);
+	smscore_notify_callbacks(coredev, NULL, 0);
+
+	// at this point all buffers should be back
+	// onresponse must no longer be called
+
+	while (1)
+	{
+		while ((cb = smscore_getbuffer(coredev)))
+		{
+			kfree(cb);
+			num_buffers ++;
+		}
+
+		if (num_buffers == coredev->num_buffers)
+			break;
+
+		printk(KERN_INFO "%s waiting for %d buffer(s)\n", __FUNCTION__, coredev->num_buffers - num_buffers);
+		msleep(100);
+	}
+
+	printk(KERN_INFO "%s freed %d buffers\n", __FUNCTION__, num_buffers);
+
+	if (coredev->common_buffer)
+		dma_free_coherent(NULL, coredev->common_buffer_size, coredev->common_buffer, coredev->common_buffer_phys);
+
+	list_del(&coredev->entry);
+	kfree(coredev);
+
+	kmutex_unlock(&g_smscore_deviceslock);
+
+	printk(KERN_INFO "%s device %p destroyed\n", __FUNCTION__, coredev);
+}
+
+int smscore_detect_mode(smscore_device_t *coredev)
+{
+	void *buffer = kmalloc(sizeof(SmsMsgHdr_ST) + SMS_DMA_ALIGNMENT, GFP_KERNEL | GFP_DMA);
+	SmsMsgHdr_ST *msg = (SmsMsgHdr_ST *) SMS_ALIGN_ADDRESS(buffer);
+	int rc;
+
+	if (!buffer)
+		return -ENOMEM;
+
+	SMS_INIT_MSG(msg, MSG_SMS_GET_VERSION_EX_REQ, sizeof(SmsMsgHdr_ST));
+
+	rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength, &coredev->version_ex_done);
+	if (rc == -ETIME)
+	{
+		printk("%s: MSG_SMS_GET_VERSION_EX_REQ failed first try\n", __FUNCTION__);
+
+		if (wait_for_completion_timeout(&coredev->resume_done, msecs_to_jiffies(5000)))
+		{
+			rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength, &coredev->version_ex_done);
+			if (rc < 0)
+			{
+				printk("%s: MSG_SMS_GET_VERSION_EX_REQ failed second try, rc %d\n", __FUNCTION__, rc);
+			}
+		}
+		else
+			rc = -ETIME;
+	}
+
+	kfree(buffer);
+
+	return rc;
+}
+
+char *smscore_fw_lkup[] =
+{
+	"dvb_nova_12mhz.inp",
+	"dvb_nova_12mhz.inp",
+	"tdmb_nova.inp",
+	"none",
+	"dvb_nova_12mhz.inp",
+	"isdbt_nova_12mhz.inp",
+	"isdbt_nova_12mhz.inp",
+	"cmmb_nova_12mhz.inp",
+	"none",
+};
+
+/**
+ * calls device handler to change mode of operation
+ * NOTE: stellar/usb may disconnect when changing mode
+ *
+ * @param coredev pointer to a coredev object returned by smscore_register_device
+ * @param mode requested mode of operation
+ *
+ * @return 0 on success, <0 on error.
+ */
+int smscore_set_device_mode(smscore_device_t *coredev, int mode)
+{
+	void *buffer;
+	int rc = 0;
+
+	if (coredev->device_flags & SMS_DEVICE_FAMILY2)
+	{
+		if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_RAW_TUNER)
+		{
+			printk(KERN_INFO "%s invalid mode specified %d\n", __FUNCTION__, mode);
+			return -EINVAL;
+		}
+
+		if (!(coredev->device_flags & SMS_DEVICE_NOT_READY))
+		{
+			rc = smscore_detect_mode(coredev);
+			if (rc < 0)
+				return rc;
+		}
+
+		if (coredev->mode == mode)
+		{
+			printk(KERN_INFO "%s device mode %d already set\n", __FUNCTION__, mode);
+			return 0;
+		}
+
+		if (!(coredev->modes_supported & (1 << mode)))
+		{
+			rc = smscore_load_firmware(coredev, smscore_fw_lkup[mode], NULL);
+			if (rc < 0)
+				return rc;
+		}
+		else
+		{
+			printk(KERN_INFO "%s mode %d supported by running firmware\n", __FUNCTION__, mode);
+		}
+
+		buffer = kmalloc(sizeof(SmsMsgData_ST) + SMS_DMA_ALIGNMENT, GFP_KERNEL | GFP_DMA);
+		if (buffer)
+		{
+			SmsMsgData_ST *msg = (SmsMsgData_ST *) SMS_ALIGN_ADDRESS(buffer);
+
+			SMS_INIT_MSG(&msg->xMsgHeader, MSG_SMS_INIT_DEVICE_REQ, sizeof(SmsMsgData_ST));
+			msg->msgData[0] = mode;
+
+			rc = smscore_sendrequest_and_wait(coredev, msg, msg->xMsgHeader.msgLength, &coredev->init_device_done);
+
+			kfree(buffer);
+		}
+		else
+			rc = -ENOMEM;
+	}
+	else
+	{
+		if (coredev->detectmode_handler)
+			coredev->detectmode_handler(coredev->context, &coredev->mode);
+
+		if (coredev->mode != mode && coredev->setmode_handler)
+			rc = coredev->setmode_handler(coredev->context, mode);
+	}
+
+	smscore_registry_setmode(coredev->devpath, mode);
+
+	if (rc >= 0)
+	{
+		coredev->mode = mode;
+		coredev->device_flags &= ~SMS_DEVICE_NOT_READY;
+	}
+
+	return rc;
+}
+
+/**
+ * calls device handler to get current mode of operation
+ *
+ * @param coredev pointer to a coredev object returned by smscore_register_device
+ *
+ * @return current mode
+ */
+int smscore_get_device_mode(smscore_device_t *coredev)
+{
+	return coredev->mode;
+}
+
+smscore_client_t* smscore_getclient_by_type(smscore_device_t *coredev, int data_type)
+{
+	smscore_client_t *client = NULL;
+	struct list_head *next, *first;
+	unsigned long flags;
+
+	if (!data_type)
+		return NULL;
+
+	spin_lock_irqsave(&coredev->clientslock, flags);
+
+	first = &coredev->clients;
+
+	for (next = first->next; next != first; next = next->next)
+	{
+		if (((smscore_client_t*) next)->data_type == data_type)
+		{
+			client = (smscore_client_t*) next;
+			break;
+		}
+	}
+
+	spin_unlock_irqrestore(&coredev->clientslock, flags);
+
+	return client;
+}
+
+smscore_client_t* smscore_getclient_by_id(smscore_device_t *coredev, int id)
+{
+	smscore_client_t *client = NULL;
+	struct list_head *next, *first;
+	unsigned long flags;
+
+	spin_lock_irqsave(&coredev->clientslock, flags);
+
+	first = &coredev->subclients;
+
+	for (next = first->next; next != first; next = next->next)
+	{
+		if (((smscore_subclient_t*) next)->id == id)
+		{
+			client = ((smscore_subclient_t*) next)->client;
+			break;
+		}
+	}
+
+	spin_unlock_irqrestore(&coredev->clientslock, flags);
+
+	return client;
+}
+
+/**
+ * find client by response id/type, call clients onresponse handler
+ * return buffer to pool on error
+ *
+ * @param coredev pointer to a coredev object returned by smscore_register_device
+ * @param cb pointer to response buffer descriptor
+ *
+ */
+void smscore_onresponse(smscore_device_t *coredev, smscore_buffer_t *cb)
+{
+	SmsMsgHdr_ST *phdr = (SmsMsgHdr_ST *)((u8*) cb->p + cb->offset);
+	smscore_client_t * client = smscore_getclient_by_type(coredev, phdr->msgType);
+	int rc = -EBUSY;
+
+	static unsigned long last_sample_time = 0;
+	static int data_total = 0;
+	unsigned long time_now = jiffies_to_msecs(jiffies);
+
+	if (!last_sample_time)
+		last_sample_time = time_now;
+
+	if (time_now - last_sample_time > 10000)
+	{
+		printk("\n%s data rate %d bytes/secs\n", __func__, (int)((data_total * 1000) / (time_now - last_sample_time)));
+
+		last_sample_time = time_now;
+		data_total = 0;
+	}
+
+	data_total += cb->size;
+
+	if (!client)
+		client = smscore_getclient_by_id(coredev, phdr->msgDstId);
+
+	if (client)
+		rc = client->onresponse_handler(client->context, cb);
+
+	if (rc < 0)
+	{
+		switch (phdr->msgType)
+		{
+			case MSG_SMS_GET_VERSION_EX_RES:
+			{
+				SmsVersionRes_ST *ver = (SmsVersionRes_ST*) phdr;
+				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);
+
+				coredev->mode = ver->FirmwareId == 255 ? DEVICE_MODE_NONE : ver->FirmwareId;
+				coredev->modes_supported = ver->SupportedProtocols;
+
+				complete(&coredev->version_ex_done);
+				break;
+			}
+
+			case MSG_SMS_INIT_DEVICE_RES:
+				printk("%s: MSG_SMS_INIT_DEVICE_RES\n", __FUNCTION__);
+				complete(&coredev->init_device_done);
+				break;
+
+			case MSG_SW_RELOAD_START_RES:
+				printk("%s: MSG_SW_RELOAD_START_RES\n", __FUNCTION__);
+				complete(&coredev->reload_start_done);
+				break;
+
+			case MSG_SMS_DATA_DOWNLOAD_RES:
+				complete(&coredev->data_download_done);
+				break;
+
+			case MSG_SW_RELOAD_EXEC_RES:
+				printk("%s: MSG_SW_RELOAD_EXEC_RES\n", __FUNCTION__);
+				break;
+
+			case MSG_SMS_SWDOWNLOAD_TRIGGER_RES:
+				printk("%s: MSG_SMS_SWDOWNLOAD_TRIGGER_RES\n", __FUNCTION__);
+				complete(&coredev->trigger_done);
+				break;
+
+			case MSG_SMS_SLEEP_RESUME_COMP_IND:
+				complete(&coredev->resume_done);
+				break;
+
+			default:
+				printk(KERN_INFO "%s no client (%p) or error (%d), type:%d dstid:%d\n", __FUNCTION__, client, rc, phdr->msgType, phdr->msgDstId);
+		}
+
+		smscore_putbuffer(coredev, cb);
+	}
+}
+
+/**
+ * return pointer to next free buffer descriptor from core pool
+ *
+ * @param coredev pointer to a coredev object returned by smscore_register_device
+ *
+ * @return pointer to descriptor on success, NULL on error.
+ */
+smscore_buffer_t *smscore_getbuffer(smscore_device_t *coredev)
+{
+	smscore_buffer_t *cb = NULL;
+	unsigned long flags;
+
+	spin_lock_irqsave(&coredev->bufferslock, flags);
+
+	if (!list_empty(&coredev->buffers))
+	{
+		cb = (smscore_buffer_t *) coredev->buffers.next;
+		list_del(&cb->entry);
+	}
+
+	spin_unlock_irqrestore(&coredev->bufferslock, flags);
+
+	return cb;
+}
+
+/**
+ * return buffer descriptor to a pool
+ *
+ * @param coredev pointer to a coredev object returned by smscore_register_device
+ * @param cb pointer buffer descriptor
+ *
+ */
+void smscore_putbuffer(smscore_device_t *coredev, smscore_buffer_t *cb)
+{
+	list_add_locked(&cb->entry, &coredev->buffers, &coredev->bufferslock);
+}
+
+int smscore_validate_client(smscore_device_t *coredev, smscore_client_t *client, int id)
+{
+	smscore_client_t *existing_client;
+	smscore_subclient_t *subclient;
+
+	if (!id)
+		return 0;
+
+	existing_client = smscore_getclient_by_id(coredev, id);
+	if (existing_client == client)
+		return 0;
+
+	if (existing_client)
+		return -EBUSY;
+
+	subclient = kzalloc(sizeof(smscore_subclient_t), GFP_KERNEL);
+	if (!subclient)
+		return -ENOMEM;
+
+	subclient->client = client;
+	subclient->id = id;
+
+	list_add_locked(&subclient->entry, &coredev->subclients, &coredev->clientslock);
+
+	return 0;
+}
+
+/**
+ * creates smsclient object, check that id is taken by another client
+ *
+ * @param coredev pointer to a coredev object from clients hotplug
+ * @param initial_id all messages with this id would be sent to this client
+ * @param data_type all messages of this type would be sent to this client
+ * @param onresponse_handler client handler that is called to process incoming messages
+ * @param onremove_handler client handler that is called when device is removed
+ * @param context client-specific context
+ * @param client pointer to a value that receives created smsclient object
+ *
+ * @return 0 on success, <0 on error.
+ */
+int smscore_register_client(smscore_device_t *coredev, smsclient_params_t *params, smscore_client_t **client)
+{
+	smscore_client_t* newclient;
+	int rc;
+
+	// check that no other channel with same data type exists
+	if (params->data_type && smscore_getclient_by_type(coredev, params->data_type))
+		return -EEXIST;
+
+	newclient = kzalloc(sizeof(smscore_client_t), GFP_KERNEL);
+	if (!newclient)
+		return -ENOMEM;
+
+	// check that no other channel with same id exists
+	rc = smscore_validate_client(coredev, newclient, params->initial_id);
+	if (rc < 0)
+	{
+		kfree(newclient);
+		return rc;
+	}
+
+	newclient->coredev = coredev;
+	newclient->data_type = params->data_type;
+	newclient->onresponse_handler = params->onresponse_handler;
+	newclient->onremove_handler = params->onremove_handler;
+	newclient->context = params->context;
+
+	list_add_locked(&newclient->entry, &coredev->clients, &coredev->clientslock);
+
+	*client = newclient;
+
+	printk(KERN_INFO "%s %p %d %d\n", __FUNCTION__, params->context, params->data_type, params->initial_id);
+
+	return 0;
+}
+
+/**
+ * frees smsclient object and all subclients associated with it
+ *
+ * @param client pointer to smsclient object returned by smscore_register_client
+ *
+ */
+void smscore_unregister_client(smscore_client_t *client)
+{
+	smscore_device_t *coredev = client->coredev;
+	struct list_head *next, *first;
+	unsigned long flags;
+
+	spin_lock_irqsave(&coredev->clientslock, flags);
+
+	first = &coredev->subclients;
+
+	for (next = first->next; next != first;)
+	{
+		smscore_subclient_t *subclient = (smscore_subclient_t *) next;
+		next = next->next;
+
+		if (subclient->client == client)
+		{
+			list_del(&subclient->entry);
+			kfree(subclient);
+		}
+	}
+
+	printk(KERN_INFO "%s %p %d\n", __FUNCTION__, client->context, client->data_type);
+
+	list_del(&client->entry);
+	kfree(client);
+
+	spin_unlock_irqrestore(&coredev->clientslock, flags);
+}
+
+/**
+ * verifies that source id is not taken by another client,
+ * calls device handler to send requests to the device
+ *
+ * @param client pointer to smsclient object returned by smscore_register_client
+ * @param buffer pointer to a request buffer
+ * @param size size (in bytes) of request buffer
+ *
+ * @return 0 on success, <0 on error.
+ */
+int smsclient_sendrequest(smscore_client_t *client, void *buffer, size_t size)
+{
+	smscore_device_t* coredev = client->coredev;
+	SmsMsgHdr_ST* phdr = (SmsMsgHdr_ST*) buffer;
+
+	// check that no other channel with same id exists
+	int rc = smscore_validate_client(client->coredev, client, phdr->msgSrcId);
+	if (rc < 0)
+		return rc;
+
+	return coredev->sendrequest_handler(coredev->context, buffer, size);
+}
+
+/**
+ * return the size of large (common) buffer
+ *
+ * @param coredev pointer to a coredev object from clients hotplug
+ *
+ * @return size (in bytes) of the buffer
+ */
+int smscore_get_common_buffer_size(smscore_device_t *coredev)
+{
+	return coredev->common_buffer_size;
+}
+
+/**
+ * maps common buffer (if supported by platform)
+ *
+ * @param coredev pointer to a coredev object from clients hotplug
+ * @param vma pointer to vma struct from mmap handler
+ *
+ * @return 0 on success, <0 on error.
+ */
+int smscore_map_common_buffer(smscore_device_t *coredev, struct vm_area_struct * vma)
+{
+	unsigned long end = vma->vm_end, start = vma->vm_start, size = PAGE_ALIGN(coredev->common_buffer_size);
+
+	if (!(vma->vm_flags & (VM_READ | VM_SHARED)) || (vma->vm_flags & VM_WRITE))
+	{
+		printk(KERN_INFO "%s invalid vm flags\n", __FUNCTION__);
+		return -EINVAL;
+	}
+
+	if ((end - start) != size)
+	{
+		printk(KERN_INFO "%s invalid size %d expected %d\n", __FUNCTION__, (int)(end - start), (int) size);
+		return -EINVAL;
+	}
+
+	if (remap_pfn_range(vma, start, coredev->common_buffer_phys >> PAGE_SHIFT, size, pgprot_noncached(vma->vm_page_prot)))
+	{
+		printk(KERN_INFO "%s remap_page_range failed\n", __FUNCTION__);
+		return -EAGAIN;
+	}
+
+	return 0;
+}
+
+int smscore_module_init(void)
+{
+	int rc;
+
+	INIT_LIST_HEAD(&g_smscore_notifyees);
+	INIT_LIST_HEAD(&g_smscore_devices);
+	kmutex_init(&g_smscore_deviceslock);
+
+	INIT_LIST_HEAD(&g_smscore_registry);
+	kmutex_init(&g_smscore_registrylock);
+
+	rc = smschar_initialize();
+
+	printk(KERN_INFO "%s, rc %d\n", __FUNCTION__, rc);
+
+	return rc;
+}
+
+void smscore_module_exit(void)
+{
+	smschar_terminate();
+
+	kmutex_lock(&g_smscore_deviceslock);
+	while (!list_empty(&g_smscore_notifyees))
+	{
+		smscore_device_notifyee_t *notifyee = (smscore_device_notifyee_t *) g_smscore_notifyees.next;
+
+		list_del(&notifyee->entry);
+		kfree(notifyee);
+	}
+	kmutex_unlock(&g_smscore_deviceslock);
+
+	kmutex_lock(&g_smscore_registrylock);
+	while (!list_empty(&g_smscore_registry))
+	{
+		smscore_registry_entry_t *entry = (smscore_registry_entry_t *) g_smscore_registry.next;
+
+		list_del(&entry->entry);
+		kfree(entry);
+	}
+	kmutex_unlock(&g_smscore_registrylock);
+
+	printk(KERN_INFO "%s\n", __FUNCTION__);
+}
+
+module_init(smscore_module_init);
+module_exit(smscore_module_exit);
+
+MODULE_DESCRIPTION("smscore");
+MODULE_AUTHOR("Anatoly Greenblatt,,, (anatolyg@siano-ms.com)");
+MODULE_LICENSE("GPL");
+
+EXPORT_SYMBOL(smscore_registry_setmode);
+EXPORT_SYMBOL(smscore_registry_getmode);
+EXPORT_SYMBOL(smscore_register_hotplug);
+EXPORT_SYMBOL(smscore_unregister_hotplug);
+EXPORT_SYMBOL(smscore_register_device);
+EXPORT_SYMBOL(smscore_unregister_device);
+EXPORT_SYMBOL(smscore_start_device);
+EXPORT_SYMBOL(smscore_load_firmware);
+EXPORT_SYMBOL(smscore_set_device_mode);
+EXPORT_SYMBOL(smscore_get_device_mode);
+EXPORT_SYMBOL(smscore_register_client);
+EXPORT_SYMBOL(smscore_unregister_client);
+EXPORT_SYMBOL(smsclient_sendrequest);
+EXPORT_SYMBOL(smscore_onresponse);
+EXPORT_SYMBOL(smscore_get_common_buffer_size);
+EXPORT_SYMBOL(smscore_map_common_buffer);
+EXPORT_SYMBOL(smscore_getbuffer);
+EXPORT_SYMBOL(smscore_putbuffer);