staging: ti-st: move TI_ST from staging to misc/

move the 3 source files st_core.c, st_kim.c and st_ll.c
from staging to drivers/misc/.

Texas Instrument's WiLink 7 chipset packs wireless technologies like
Bluetooth, FM, GPS and WLAN into a single die.
Among these the Bluetooth, FM Rx/Tx and GPS are interfaced to a apps processor
over a single UART.

This line discipline driver allows various protocol drivers such as Bluetooth
BlueZ driver, FM V4L2 driver and GPS simple character device driver
to communicate with its relevant core in the chip.

Each protocol or technologies use a logical channel to communicate with chip.
Bluetooth uses the HCI-H4 [channels 1-4], FM uses a CH-8 and
GPS a CH-9 protocol. The driver also constitutes the TI HCI-LL Power
Management protocol which use channels 30-33.

Signed-off-by: Pavan Savoy <pavan_savoy@ti.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

1 files changed, 798 insertions, 0 deletions

diff --git a/drivers/misc/ti-st/st_kim.c b/drivers/misc/ti-st/st_kim.c
new file mode 100644
index 000000000000..6d23a7222627
--- /dev/null
+++ b/drivers/misc/ti-st/st_kim.c
@@ -0,0 +1,798 @@
+/*
+ *  Shared Transport Line discipline driver Core
+ *      Init Manager module responsible for GPIO control
+ *      and firmware download
+ *  Copyright (C) 2009-2010 Texas Instruments
+ *  Author: Pavan Savoy <pavan_savoy@ti.com>
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License version 2 as
+ *  published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ */
+
+#define pr_fmt(fmt) "(stk) :" fmt
+#include <linux/platform_device.h>
+#include <linux/jiffies.h>
+#include <linux/firmware.h>
+#include <linux/delay.h>
+#include <linux/wait.h>
+#include <linux/gpio.h>
+#include <linux/debugfs.h>
+#include <linux/seq_file.h>
+#include <linux/sched.h>
+#include <linux/rfkill.h>
+
+/* understand BT events for fw response */
+#include <net/bluetooth/bluetooth.h>
+#include <net/bluetooth/hci_core.h>
+#include <net/bluetooth/hci.h>
+
+#include <linux/ti_wilink_st.h>
+
+
+static int kim_probe(struct platform_device *pdev);
+static int kim_remove(struct platform_device *pdev);
+
+/* KIM platform device driver structure */
+static struct platform_driver kim_platform_driver = {
+        .probe = kim_probe,
+        .remove = kim_remove,
+        /* TODO: ST driver power management during suspend/resume ?
+         */
+#if 0
+        .suspend = kim_suspend,
+        .resume = kim_resume,
+#endif
+        .driver = {
+                   .name = "kim",
+                   .owner = THIS_MODULE,
+                   },
+};
+
+static int kim_toggle_radio(void*, bool);
+static const struct rfkill_ops kim_rfkill_ops = {
+        .set_block = kim_toggle_radio,
+};
+
+/* strings to be used for rfkill entries and by
+ * ST Core to be used for sysfs debug entry
+ */
+#define PROTO_ENTRY(type, name) name
+const unsigned char *protocol_names[] = {
+        PROTO_ENTRY(ST_BT, "Bluetooth"),
+        PROTO_ENTRY(ST_FM, "FM"),
+        PROTO_ENTRY(ST_GPS, "GPS"),
+};
+
+#define MAX_ST_DEVICES  3       /* Imagine 1 on each UART for now */
+struct platform_device *st_kim_devices[MAX_ST_DEVICES];
+
+/**********************************************************************/
+/* internal functions */
+
+/**
+ * st_get_plat_device -
+ *      function which returns the reference to the platform device
+ *      requested by id. As of now only 1 such device exists (id=0)
+ *      the context requesting for reference can get the id to be
+ *      requested by a. The protocol driver which is registering or
+ *      b. the tty device which is opened.
+ */
+static struct platform_device *st_get_plat_device(int id)
+{
+        return st_kim_devices[id];
+}
+
+/**
+ * validate_firmware_response -
+ *      function to return whether the firmware response was proper
+ *      in case of error don't complete so that waiting for proper
+ *      response times out
+ */
+void validate_firmware_response(struct kim_data_s *kim_gdata)
+{
+        struct sk_buff *skb = kim_gdata->rx_skb;
+        if (unlikely(skb->data[5] != 0)) {
+                pr_err("no proper response during fw download");
+                pr_err("data6 %x", skb->data[5]);
+                return;         /* keep waiting for the proper response */
+        }
+        /* becos of all the script being downloaded */
+        complete_all(&kim_gdata->kim_rcvd);
+        kfree_skb(skb);
+}
+
+/* check for data len received inside kim_int_recv
+ * most often hit the last case to update state to waiting for data
+ */
+static inline int kim_check_data_len(struct kim_data_s *kim_gdata, int len)
+{
+        register int room = skb_tailroom(kim_gdata->rx_skb);
+
+        pr_debug("len %d room %d", len, room);
+
+        if (!len) {
+                validate_firmware_response(kim_gdata);
+        } else if (len > room) {
+                /* Received packet's payload length is larger.
+                 * We can't accommodate it in created skb.
+                 */
+                pr_err("Data length is too large len %d room %d", len,
+                           room);
+                kfree_skb(kim_gdata->rx_skb);
+        } else {
+                /* Packet header has non-zero payload length and
+                 * we have enough space in created skb. Lets read
+                 * payload data */
+                kim_gdata->rx_state = ST_BT_W4_DATA;
+                kim_gdata->rx_count = len;
+                return len;
+        }
+
+        /* Change ST LL state to continue to process next
+         * packet */
+        kim_gdata->rx_state = ST_W4_PACKET_TYPE;
+        kim_gdata->rx_skb = NULL;
+        kim_gdata->rx_count = 0;
+
+        return 0;
+}
+
+/**
+ * kim_int_recv - receive function called during firmware download
+ *      firmware download responses on different UART drivers
+ *      have been observed to come in bursts of different
+ *      tty_receive and hence the logic
+ */
+void kim_int_recv(struct kim_data_s *kim_gdata,
+        const unsigned char *data, long count)
+{
+        register char *ptr;
+        struct hci_event_hdr *eh;
+        register int len = 0, type = 0;
+
+        pr_debug("%s", __func__);
+        /* Decode received bytes here */
+        ptr = (char *)data;
+        if (unlikely(ptr == NULL)) {
+                pr_err(" received null from TTY ");
+                return;
+        }
+        while (count) {
+                if (kim_gdata->rx_count) {
+                        len = min_t(unsigned int, kim_gdata->rx_count, count);
+                        memcpy(skb_put(kim_gdata->rx_skb, len), ptr, len);
+                        kim_gdata->rx_count -= len;
+                        count -= len;
+                        ptr += len;
+
+                        if (kim_gdata->rx_count)
+                                continue;
+
+                        /* Check ST RX state machine , where are we? */
+                        switch (kim_gdata->rx_state) {
+                                /* Waiting for complete packet ? */
+                        case ST_BT_W4_DATA:
+                                pr_debug("Complete pkt received");
+                                validate_firmware_response(kim_gdata);
+                                kim_gdata->rx_state = ST_W4_PACKET_TYPE;
+                                kim_gdata->rx_skb = NULL;
+                                continue;
+                                /* Waiting for Bluetooth event header ? */
+                        case ST_BT_W4_EVENT_HDR:
+                                eh = (struct hci_event_hdr *)kim_gdata->
+                                    rx_skb->data;
+                                pr_debug("Event header: evt 0x%2.2x"
+                                           "plen %d", eh->evt, eh->plen);
+                                kim_check_data_len(kim_gdata, eh->plen);
+                                continue;
+                        }       /* end of switch */
+                }               /* end of if rx_state */
+                switch (*ptr) {
+                        /* Bluetooth event packet? */
+                case HCI_EVENT_PKT:
+                        pr_info("Event packet");
+                        kim_gdata->rx_state = ST_BT_W4_EVENT_HDR;
+                        kim_gdata->rx_count = HCI_EVENT_HDR_SIZE;
+                        type = HCI_EVENT_PKT;
+                        break;
+                default:
+                        pr_info("unknown packet");
+                        ptr++;
+                        count--;
+                        continue;
+                }
+                ptr++;
+                count--;
+                kim_gdata->rx_skb =
+                    bt_skb_alloc(HCI_MAX_FRAME_SIZE, GFP_ATOMIC);
+                if (!kim_gdata->rx_skb) {
+                        pr_err("can't allocate mem for new packet");
+                        kim_gdata->rx_state = ST_W4_PACKET_TYPE;
+                        kim_gdata->rx_count = 0;
+                        return;
+                }
+                bt_cb(kim_gdata->rx_skb)->pkt_type = type;
+        }
+        pr_info("done %s", __func__);
+        return;
+}
+
+static long read_local_version(struct kim_data_s *kim_gdata, char *bts_scr_name)
+{
+        unsigned short version = 0, chip = 0, min_ver = 0, maj_ver = 0;
+        char read_ver_cmd[] = { 0x01, 0x01, 0x10, 0x00 };
+
+        pr_debug("%s", __func__);
+
+        INIT_COMPLETION(kim_gdata->kim_rcvd);
+        if (4 != st_int_write(kim_gdata->core_data, read_ver_cmd, 4)) {
+                pr_err("kim: couldn't write 4 bytes");
+                return -1;
+        }
+
+        if (!wait_for_completion_timeout
+            (&kim_gdata->kim_rcvd, msecs_to_jiffies(CMD_RESP_TIME))) {
+                pr_err(" waiting for ver info- timed out ");
+                return -1;
+        }
+
+        version =
+                MAKEWORD(kim_gdata->resp_buffer[13],
+                                kim_gdata->resp_buffer[14]);
+        chip = (version & 0x7C00) >> 10;
+        min_ver = (version & 0x007F);
+        maj_ver = (version & 0x0380) >> 7;
+
+        if (version & 0x8000)
+                maj_ver |= 0x0008;
+
+        sprintf(bts_scr_name, "TIInit_%d.%d.%d.bts", chip, maj_ver, min_ver);
+
+        /* to be accessed later via sysfs entry */
+        kim_gdata->version.full = version;
+        kim_gdata->version.chip = chip;
+        kim_gdata->version.maj_ver = maj_ver;
+        kim_gdata->version.min_ver = min_ver;
+
+        pr_info("%s", bts_scr_name);
+        return 0;
+}
+
+/**
+ * download_firmware -
+ *      internal function which parses through the .bts firmware
+ *      script file intreprets SEND, DELAY actions only as of now
+ */
+static long download_firmware(struct kim_data_s *kim_gdata)
+{
+        long err = 0;
+        long len = 0;
+        register unsigned char *ptr = NULL;
+        register unsigned char *action_ptr = NULL;
+        unsigned char bts_scr_name[30] = { 0 }; /* 30 char long bts scr name? */
+
+        err = read_local_version(kim_gdata, bts_scr_name);
+        if (err != 0) {
+                pr_err("kim: failed to read local ver");
+                return err;
+        }
+        err =
+            request_firmware(&kim_gdata->fw_entry, bts_scr_name,
+                             &kim_gdata->kim_pdev->dev);
+        if (unlikely((err != 0) || (kim_gdata->fw_entry->data == NULL) ||
+                     (kim_gdata->fw_entry->size == 0))) {
+                pr_err(" request_firmware failed(errno %ld) for %s", err,
+                           bts_scr_name);
+                return -1;
+        }
+        ptr = (void *)kim_gdata->fw_entry->data;
+        len = kim_gdata->fw_entry->size;
+        /* bts_header to remove out magic number and
+         * version
+         */
+        ptr += sizeof(struct bts_header);
+        len -= sizeof(struct bts_header);
+
+        while (len > 0 && ptr) {
+                pr_debug(" action size %d, type %d ",
+                           ((struct bts_action *)ptr)->size,
+                           ((struct bts_action *)ptr)->type);
+
+                switch (((struct bts_action *)ptr)->type) {
+                case ACTION_SEND_COMMAND:       /* action send */
+                        action_ptr = &(((struct bts_action *)ptr)->data[0]);
+                        if (unlikely
+                            (((struct hci_command *)action_ptr)->opcode ==
+                             0xFF36)) {
+                                /* ignore remote change
+                                 * baud rate HCI VS command */
+                                pr_err
+                                    (" change remote baud"
+                                    " rate command in firmware");
+                                break;
+                        }
+
+                        INIT_COMPLETION(kim_gdata->kim_rcvd);
+                        err = st_int_write(kim_gdata->core_data,
+                        ((struct bts_action_send *)action_ptr)->data,
+                                           ((struct bts_action *)ptr)->size);
+                        if (unlikely(err < 0)) {
+                                release_firmware(kim_gdata->fw_entry);
+                                return -1;
+                        }
+                        if (!wait_for_completion_timeout
+                            (&kim_gdata->kim_rcvd,
+                             msecs_to_jiffies(CMD_RESP_TIME))) {
+                                pr_err
+                                    (" response timeout during fw download ");
+                                /* timed out */
+                                release_firmware(kim_gdata->fw_entry);
+                                return -1;
+                        }
+                        break;
+                case ACTION_DELAY:      /* sleep */
+                        pr_info("sleep command in scr");
+                        action_ptr = &(((struct bts_action *)ptr)->data[0]);
+                        mdelay(((struct bts_action_delay *)action_ptr)->msec);
+                        break;
+                }
+                len =
+                    len - (sizeof(struct bts_action) +
+                           ((struct bts_action *)ptr)->size);
+                ptr =
+                    ptr + sizeof(struct bts_action) +
+                    ((struct bts_action *)ptr)->size;
+        }
+        /* fw download complete */
+        release_firmware(kim_gdata->fw_entry);
+        return 0;
+}
+
+/**********************************************************************/
+/* functions called from ST core */
+/* function to toggle the GPIO
+ * needs to know whether the GPIO is active high or active low
+ */
+void st_kim_chip_toggle(enum proto_type type, enum kim_gpio_state state)
+{
+        struct platform_device  *kim_pdev;
+        struct kim_data_s       *kim_gdata;
+        pr_info(" %s ", __func__);
+
+        kim_pdev = st_get_plat_device(0);
+        kim_gdata = dev_get_drvdata(&kim_pdev->dev);
+
+        if (kim_gdata->gpios[type] == -1) {
+                pr_info(" gpio not requested for protocol %s",
+                           protocol_names[type]);
+                return;
+        }
+        switch (type) {
+        case ST_BT:
+                /*Do Nothing */
+                break;
+
+        case ST_FM:
+                if (state == KIM_GPIO_ACTIVE)
+                        gpio_set_value(kim_gdata->gpios[ST_FM], GPIO_LOW);
+                else
+                        gpio_set_value(kim_gdata->gpios[ST_FM], GPIO_HIGH);
+                break;
+
+        case ST_GPS:
+                if (state == KIM_GPIO_ACTIVE)
+                        gpio_set_value(kim_gdata->gpios[ST_GPS], GPIO_HIGH);
+                else
+                        gpio_set_value(kim_gdata->gpios[ST_GPS], GPIO_LOW);
+                break;
+
+        case ST_MAX:
+        default:
+                break;
+        }
+
+        return;
+}
+
+/* called from ST Core, when REG_IN_PROGRESS (registration in progress)
+ * can be because of
+ * 1. response to read local version
+ * 2. during send/recv's of firmware download
+ */
+void st_kim_recv(void *disc_data, const unsigned char *data, long count)
+{
+        struct st_data_s        *st_gdata = (struct st_data_s *)disc_data;
+        struct kim_data_s       *kim_gdata = st_gdata->kim_data;
+
+        pr_info(" %s ", __func__);
+        /* copy to local buffer */
+        if (unlikely(data[4] == 0x01 && data[5] == 0x10 && data[0] == 0x04)) {
+                /* must be the read_ver_cmd */
+                memcpy(kim_gdata->resp_buffer, data, count);
+                complete_all(&kim_gdata->kim_rcvd);
+                return;
+        } else {
+                kim_int_recv(kim_gdata, data, count);
+                /* either completes or times out */
+        }
+        return;
+}
+
+/* to signal completion of line discipline installation
+ * called from ST Core, upon tty_open
+ */
+void st_kim_complete(void *kim_data)
+{
+        struct kim_data_s       *kim_gdata = (struct kim_data_s *)kim_data;
+        complete(&kim_gdata->ldisc_installed);
+}
+
+/**
+ * st_kim_start - called from ST Core upon 1st registration
+ *      This involves toggling the chip enable gpio, reading
+ *      the firmware version from chip, forming the fw file name
+ *      based on the chip version, requesting the fw, parsing it
+ *      and perform download(send/recv).
+ */
+long st_kim_start(void *kim_data)
+{
+        long err = 0;
+        long retry = POR_RETRY_COUNT;
+        struct kim_data_s       *kim_gdata = (struct kim_data_s *)kim_data;
+
+        pr_info(" %s", __func__);
+
+        do {
+                /* TODO: this is only because rfkill sub-system
+                 * doesn't send events to user-space if the state
+                 * isn't changed
+                 */
+                rfkill_set_hw_state(kim_gdata->rfkill[ST_BT], 1);
+                /* Configure BT nShutdown to HIGH state */
+                gpio_set_value(kim_gdata->gpios[ST_BT], GPIO_LOW);
+                mdelay(5);      /* FIXME: a proper toggle */
+                gpio_set_value(kim_gdata->gpios[ST_BT], GPIO_HIGH);
+                mdelay(100);
+                /* re-initialize the completion */
+                INIT_COMPLETION(kim_gdata->ldisc_installed);
+#if 0 /* older way of signalling user-space UIM */
+                /* send signal to UIM */
+                err = kill_pid(find_get_pid(kim_gdata->uim_pid), SIGUSR2, 0);
+                if (err != 0) {
+                        pr_info(" sending SIGUSR2 to uim failed %ld", err);
+                        err = -1;
+                        continue;
+                }
+#endif
+                /* unblock and send event to UIM via /dev/rfkill */
+                rfkill_set_hw_state(kim_gdata->rfkill[ST_BT], 0);
+                /* wait for ldisc to be installed */
+                err = wait_for_completion_timeout(&kim_gdata->ldisc_installed,
+                                msecs_to_jiffies(LDISC_TIME));
+                if (!err) {     /* timeout */
+                        pr_err("line disc installation timed out ");
+                        err = -1;
+                        continue;
+                } else {
+                        /* ldisc installed now */
+                        pr_info(" line discipline installed ");
+                        err = download_firmware(kim_gdata);
+                        if (err != 0) {
+                                pr_err("download firmware failed");
+                                continue;
+                        } else {        /* on success don't retry */
+                                break;
+                        }
+                }
+        } while (retry--);
+        return err;
+}
+
+/**
+ * st_kim_stop - called from ST Core, on the last un-registration
+ *      toggle low the chip enable gpio
+ */
+long st_kim_stop(void *kim_data)
+{
+        long err = 0;
+        struct kim_data_s       *kim_gdata = (struct kim_data_s *)kim_data;
+
+        INIT_COMPLETION(kim_gdata->ldisc_installed);
+#if 0 /* older way of signalling user-space UIM */
+        /* send signal to UIM */
+        err = kill_pid(find_get_pid(kim_gdata->uim_pid), SIGUSR2, 1);
+        if (err != 0) {
+                pr_err("sending SIGUSR2 to uim failed %ld", err);
+                return -1;
+        }
+#endif
+        /* set BT rfkill to be blocked */
+        err = rfkill_set_hw_state(kim_gdata->rfkill[ST_BT], 1);
+
+        /* wait for ldisc to be un-installed */
+        err = wait_for_completion_timeout(&kim_gdata->ldisc_installed,
+                        msecs_to_jiffies(LDISC_TIME));
+        if (!err) {             /* timeout */
+                pr_err(" timed out waiting for ldisc to be un-installed");
+                return -1;
+        }
+
+        /* By default configure BT nShutdown to LOW state */
+        gpio_set_value(kim_gdata->gpios[ST_BT], GPIO_LOW);
+        mdelay(1);
+        gpio_set_value(kim_gdata->gpios[ST_BT], GPIO_HIGH);
+        mdelay(1);
+        gpio_set_value(kim_gdata->gpios[ST_BT], GPIO_LOW);
+        return err;
+}
+
+/**********************************************************************/
+/* functions called from subsystems */
+/* called when debugfs entry is read from */
+
+static int show_version(struct seq_file *s, void *unused)
+{
+        struct kim_data_s *kim_gdata = (struct kim_data_s *)s->private;
+        seq_printf(s, "%04X %d.%d.%d\n", kim_gdata->version.full,
+                        kim_gdata->version.chip, kim_gdata->version.maj_ver,
+                        kim_gdata->version.min_ver);
+        return 0;
+}
+
+static int show_list(struct seq_file *s, void *unused)
+{
+        struct kim_data_s *kim_gdata = (struct kim_data_s *)s->private;
+        kim_st_list_protocols(kim_gdata->core_data, s);
+        return 0;
+}
+
+/* function called from rfkill subsystem, when someone from
+ * user space would write 0/1 on the sysfs entry
+ * /sys/class/rfkill/rfkill0,1,3/state
+ */
+static int kim_toggle_radio(void *data, bool blocked)
+{
+        enum proto_type type = *((enum proto_type *)data);
+        pr_debug(" %s: %d ", __func__, type);
+
+        switch (type) {
+        case ST_BT:
+                /* do nothing */
+        break;
+        case ST_FM:
+        case ST_GPS:
+                if (blocked)
+                        st_kim_chip_toggle(type, KIM_GPIO_INACTIVE);
+                else
+                        st_kim_chip_toggle(type, KIM_GPIO_ACTIVE);
+        break;
+        case ST_MAX:
+                pr_err(" wrong proto type ");
+        break;
+        }
+        return 0;
+}
+
+/**
+ * st_kim_ref - reference the core's data
+ *      This references the per-ST platform device in the arch/xx/
+ *      board-xx.c file.
+ *      This would enable multiple such platform devices to exist
+ *      on a given platform
+ */
+void st_kim_ref(struct st_data_s **core_data, int id)
+{
+        struct platform_device  *pdev;
+        struct kim_data_s       *kim_gdata;
+        /* get kim_gdata reference from platform device */
+        pdev = st_get_plat_device(id);
+        kim_gdata = dev_get_drvdata(&pdev->dev);
+        *core_data = kim_gdata->core_data;
+}
+
+static int kim_version_open(struct inode *i, struct file *f)
+{
+        return single_open(f, show_version, i->i_private);
+}
+
+static int kim_list_open(struct inode *i, struct file *f)
+{
+        return single_open(f, show_list, i->i_private);
+}
+
+static const struct file_operations version_debugfs_fops = {
+        /* version info */
+        .open = kim_version_open,
+        .read = seq_read,
+        .llseek = seq_lseek,
+        .release = single_release,
+};
+static const struct file_operations list_debugfs_fops = {
+        /* protocols info */
+        .open = kim_list_open,
+        .read = seq_read,
+        .llseek = seq_lseek,
+        .release = single_release,
+};
+
+/**********************************************************************/
+/* functions called from platform device driver subsystem
+ * need to have a relevant platform device entry in the platform's
+ * board-*.c file
+ */
+
+struct dentry *kim_debugfs_dir;
+static int kim_probe(struct platform_device *pdev)
+{
+        long status;
+        long proto;
+        long *gpios = pdev->dev.platform_data;
+        struct kim_data_s       *kim_gdata;
+
+        if ((pdev->id != -1) && (pdev->id < MAX_ST_DEVICES)) {
+                /* multiple devices could exist */
+                st_kim_devices[pdev->id] = pdev;
+        } else {
+                /* platform's sure about existance of 1 device */
+                st_kim_devices[0] = pdev;
+        }
+
+        kim_gdata = kzalloc(sizeof(struct kim_data_s), GFP_ATOMIC);
+        if (!kim_gdata) {
+                pr_err("no mem to allocate");
+                return -ENOMEM;
+        }
+        dev_set_drvdata(&pdev->dev, kim_gdata);
+
+        status = st_core_init(&kim_gdata->core_data);
+        if (status != 0) {
+                pr_err(" ST core init failed");
+                return -1;
+        }
+        /* refer to itself */
+        kim_gdata->core_data->kim_data = kim_gdata;
+
+        for (proto = 0; proto < ST_MAX; proto++) {
+                kim_gdata->gpios[proto] = gpios[proto];
+                pr_info(" %ld gpio to be requested", gpios[proto]);
+        }
+
+        for (proto = 0; (proto < ST_MAX) && (gpios[proto] != -1); proto++) {
+                /* Claim the Bluetooth/FM/GPIO
+                 * nShutdown gpio from the system
+                 */
+                status = gpio_request(gpios[proto], "kim");
+                if (unlikely(status)) {
+                        pr_err(" gpio %ld request failed ", gpios[proto]);
+                        proto -= 1;
+                        while (proto >= 0) {
+                                if (gpios[proto] != -1)
+                                        gpio_free(gpios[proto]);
+                        }
+                        return status;
+                }
+
+                /* Configure nShutdown GPIO as output=0 */
+                status =
+                    gpio_direction_output(gpios[proto], 0);
+                if (unlikely(status)) {
+                        pr_err(" unable to configure gpio %ld",
+                                   gpios[proto]);
+                        proto -= 1;
+                        while (proto >= 0) {
+                                if (gpios[proto] != -1)
+                                        gpio_free(gpios[proto]);
+                        }
+                        return status;
+                }
+        }
+        /* get reference of pdev for request_firmware
+         */
+        kim_gdata->kim_pdev = pdev;
+        init_completion(&kim_gdata->kim_rcvd);
+        init_completion(&kim_gdata->ldisc_installed);
+
+        for (proto = 0; (proto < ST_MAX) && (gpios[proto] != -1); proto++) {
+                /* TODO: should all types be rfkill_type_bt ? */
+                kim_gdata->rf_protos[proto] = proto;
+                kim_gdata->rfkill[proto] = rfkill_alloc(protocol_names[proto],
+                        &pdev->dev, RFKILL_TYPE_BLUETOOTH,
+                        &kim_rfkill_ops, &kim_gdata->rf_protos[proto]);
+                if (kim_gdata->rfkill[proto] == NULL) {
+                        pr_err("cannot create rfkill entry for gpio %ld",
+                                   gpios[proto]);
+                        continue;
+                }
+                /* block upon creation */
+                rfkill_init_sw_state(kim_gdata->rfkill[proto], 1);
+                status = rfkill_register(kim_gdata->rfkill[proto]);
+                if (unlikely(status)) {
+                        pr_err("rfkill registration failed for gpio %ld",
+                                   gpios[proto]);
+                        rfkill_unregister(kim_gdata->rfkill[proto]);
+                        continue;
+                }
+                pr_info("rfkill entry created for %ld", gpios[proto]);
+        }
+
+        kim_debugfs_dir = debugfs_create_dir("ti-st", NULL);
+        if (IS_ERR(kim_debugfs_dir)) {
+                pr_err(" debugfs entries creation failed ");
+                kim_debugfs_dir = NULL;
+                return -1;
+        }
+
+        debugfs_create_file("version", S_IRUGO, kim_debugfs_dir,
+                                kim_gdata, &version_debugfs_fops);
+        debugfs_create_file("protocols", S_IRUGO, kim_debugfs_dir,
+                                kim_gdata, &list_debugfs_fops);
+        pr_info(" debugfs entries created ");
+        return 0;
+}
+
+static int kim_remove(struct platform_device *pdev)
+{
+        /* free the GPIOs requested
+         */
+        long *gpios = pdev->dev.platform_data;
+        long proto;
+        struct kim_data_s       *kim_gdata;
+
+        kim_gdata = dev_get_drvdata(&pdev->dev);
+
+        for (proto = 0; (proto < ST_MAX) && (gpios[proto] != -1); proto++) {
+                /* Claim the Bluetooth/FM/GPIO
+                 * nShutdown gpio from the system
+                 */
+                gpio_free(gpios[proto]);
+                rfkill_unregister(kim_gdata->rfkill[proto]);
+                rfkill_destroy(kim_gdata->rfkill[proto]);
+                kim_gdata->rfkill[proto] = NULL;
+        }
+        pr_info("kim: GPIO Freed");
+        debugfs_remove_recursive(kim_debugfs_dir);
+        kim_gdata->kim_pdev = NULL;
+        st_core_exit(kim_gdata->core_data);
+
+        kfree(kim_gdata);
+        kim_gdata = NULL;
+        return 0;
+}
+
+/**********************************************************************/
+/* entry point for ST KIM module, called in from ST Core */
+
+static int __init st_kim_init(void)
+{
+        long ret = 0;
+        ret = platform_driver_register(&kim_platform_driver);
+        if (ret != 0) {
+                pr_err("platform drv registration failed");
+                return -1;
+        }
+        return 0;
+}
+
+static void __exit st_kim_deinit(void)
+{
+        /* the following returns void */
+        platform_driver_unregister(&kim_platform_driver);
+}
+
+
+module_init(st_kim_init);
+module_exit(st_kim_deinit);
+MODULE_AUTHOR("Pavan Savoy <pavan_savoy@ti.com>");
+MODULE_DESCRIPTION("Shared Transport Driver for TI BT/FM/GPS combo chips ");
+MODULE_LICENSE("GPL");