drivers:misc: ti-st: wait for completion at fail
[linux-2.6.git] / drivers / misc / ti-st / st_kim.c
1 /*
2  *  Shared Transport Line discipline driver Core
3  *      Init Manager module responsible for GPIO control
4  *      and firmware download
5  *  Copyright (C) 2009-2010 Texas Instruments
6  *  Author: Pavan Savoy <pavan_savoy@ti.com>
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License version 2 as
10  *  published by the Free Software Foundation.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  */
22
23 #define pr_fmt(fmt) "(stk) :" fmt
24 #include <linux/platform_device.h>
25 #include <linux/jiffies.h>
26 #include <linux/firmware.h>
27 #include <linux/delay.h>
28 #include <linux/wait.h>
29 #include <linux/gpio.h>
30 #include <linux/debugfs.h>
31 #include <linux/seq_file.h>
32 #include <linux/sched.h>
33 #include <linux/sysfs.h>
34 #include <linux/tty.h>
35
36 #include <linux/skbuff.h>
37 #include <linux/ti_wilink_st.h>
38
39
40 #define MAX_ST_DEVICES  3       /* Imagine 1 on each UART for now */
41 static struct platform_device *st_kim_devices[MAX_ST_DEVICES];
42
43 /**********************************************************************/
44 /* internal functions */
45
46 /**
47  * st_get_plat_device -
48  *      function which returns the reference to the platform device
49  *      requested by id. As of now only 1 such device exists (id=0)
50  *      the context requesting for reference can get the id to be
51  *      requested by a. The protocol driver which is registering or
52  *      b. the tty device which is opened.
53  */
54 static struct platform_device *st_get_plat_device(int id)
55 {
56         return st_kim_devices[id];
57 }
58
59 /**
60  * validate_firmware_response -
61  *      function to return whether the firmware response was proper
62  *      in case of error don't complete so that waiting for proper
63  *      response times out
64  */
65 void validate_firmware_response(struct kim_data_s *kim_gdata)
66 {
67         struct sk_buff *skb = kim_gdata->rx_skb;
68         if (unlikely(skb->data[5] != 0)) {
69                 pr_err("no proper response during fw download");
70                 pr_err("data6 %x", skb->data[5]);
71                 return;         /* keep waiting for the proper response */
72         }
73         /* becos of all the script being downloaded */
74         complete_all(&kim_gdata->kim_rcvd);
75         kfree_skb(skb);
76 }
77
78 /* check for data len received inside kim_int_recv
79  * most often hit the last case to update state to waiting for data
80  */
81 static inline int kim_check_data_len(struct kim_data_s *kim_gdata, int len)
82 {
83         register int room = skb_tailroom(kim_gdata->rx_skb);
84
85         pr_debug("len %d room %d", len, room);
86
87         if (!len) {
88                 validate_firmware_response(kim_gdata);
89         } else if (len > room) {
90                 /* Received packet's payload length is larger.
91                  * We can't accommodate it in created skb.
92                  */
93                 pr_err("Data length is too large len %d room %d", len,
94                            room);
95                 kfree_skb(kim_gdata->rx_skb);
96         } else {
97                 /* Packet header has non-zero payload length and
98                  * we have enough space in created skb. Lets read
99                  * payload data */
100                 kim_gdata->rx_state = ST_W4_DATA;
101                 kim_gdata->rx_count = len;
102                 return len;
103         }
104
105         /* Change ST LL state to continue to process next
106          * packet */
107         kim_gdata->rx_state = ST_W4_PACKET_TYPE;
108         kim_gdata->rx_skb = NULL;
109         kim_gdata->rx_count = 0;
110
111         return 0;
112 }
113
114 /**
115  * kim_int_recv - receive function called during firmware download
116  *      firmware download responses on different UART drivers
117  *      have been observed to come in bursts of different
118  *      tty_receive and hence the logic
119  */
120 void kim_int_recv(struct kim_data_s *kim_gdata,
121         const unsigned char *data, long count)
122 {
123         const unsigned char *ptr;
124         int len = 0, type = 0;
125         unsigned char *plen;
126
127         pr_debug("%s", __func__);
128         /* Decode received bytes here */
129         ptr = data;
130         if (unlikely(ptr == NULL)) {
131                 pr_err(" received null from TTY ");
132                 return;
133         }
134
135         while (count) {
136                 if (kim_gdata->rx_count) {
137                         len = min_t(unsigned int, kim_gdata->rx_count, count);
138                         memcpy(skb_put(kim_gdata->rx_skb, len), ptr, len);
139                         kim_gdata->rx_count -= len;
140                         count -= len;
141                         ptr += len;
142
143                         if (kim_gdata->rx_count)
144                                 continue;
145
146                         /* Check ST RX state machine , where are we? */
147                         switch (kim_gdata->rx_state) {
148                                 /* Waiting for complete packet ? */
149                         case ST_W4_DATA:
150                                 pr_debug("Complete pkt received");
151                                 validate_firmware_response(kim_gdata);
152                                 kim_gdata->rx_state = ST_W4_PACKET_TYPE;
153                                 kim_gdata->rx_skb = NULL;
154                                 continue;
155                                 /* Waiting for Bluetooth event header ? */
156                         case ST_W4_HEADER:
157                                 plen =
158                                 (unsigned char *)&kim_gdata->rx_skb->data[1];
159                                 pr_debug("event hdr: plen 0x%02x\n", *plen);
160                                 kim_check_data_len(kim_gdata, *plen);
161                                 continue;
162                         }       /* end of switch */
163                 }               /* end of if rx_state */
164                 switch (*ptr) {
165                         /* Bluetooth event packet? */
166                 case 0x04:
167                         kim_gdata->rx_state = ST_W4_HEADER;
168                         kim_gdata->rx_count = 2;
169                         type = *ptr;
170                         break;
171                 default:
172                         pr_info("unknown packet");
173                         ptr++;
174                         count--;
175                         continue;
176                 }
177                 ptr++;
178                 count--;
179                 kim_gdata->rx_skb =
180                         alloc_skb(1024+8, GFP_ATOMIC);
181                 if (!kim_gdata->rx_skb) {
182                         pr_err("can't allocate mem for new packet");
183                         kim_gdata->rx_state = ST_W4_PACKET_TYPE;
184                         kim_gdata->rx_count = 0;
185                         return;
186                 }
187                 skb_reserve(kim_gdata->rx_skb, 8);
188                 kim_gdata->rx_skb->cb[0] = 4;
189                 kim_gdata->rx_skb->cb[1] = 0;
190
191         }
192         return;
193 }
194
195 static long read_local_version(struct kim_data_s *kim_gdata, char *bts_scr_name)
196 {
197         unsigned short version = 0, chip = 0, min_ver = 0, maj_ver = 0;
198         const char read_ver_cmd[] = { 0x01, 0x01, 0x10, 0x00 };
199
200         pr_debug("%s", __func__);
201
202         INIT_COMPLETION(kim_gdata->kim_rcvd);
203         if (4 != st_int_write(kim_gdata->core_data, read_ver_cmd, 4)) {
204                 pr_err("kim: couldn't write 4 bytes");
205                 return -EIO;
206         }
207
208         if (!wait_for_completion_timeout
209             (&kim_gdata->kim_rcvd, msecs_to_jiffies(CMD_RESP_TIME))) {
210                 pr_err(" waiting for ver info- timed out ");
211                 return -ETIMEDOUT;
212         }
213         INIT_COMPLETION(kim_gdata->kim_rcvd);
214
215         version =
216                 MAKEWORD(kim_gdata->resp_buffer[13],
217                                 kim_gdata->resp_buffer[14]);
218         chip = (version & 0x7C00) >> 10;
219         min_ver = (version & 0x007F);
220         maj_ver = (version & 0x0380) >> 7;
221
222         if (version & 0x8000)
223                 maj_ver |= 0x0008;
224
225         sprintf(bts_scr_name, "TIInit_%d.%d.%d.bts", chip, maj_ver, min_ver);
226
227         /* to be accessed later via sysfs entry */
228         kim_gdata->version.full = version;
229         kim_gdata->version.chip = chip;
230         kim_gdata->version.maj_ver = maj_ver;
231         kim_gdata->version.min_ver = min_ver;
232
233         pr_info("%s", bts_scr_name);
234         return 0;
235 }
236
237 void skip_change_remote_baud(unsigned char **ptr, long *len)
238 {
239         unsigned char *nxt_action, *cur_action;
240         cur_action = *ptr;
241
242         nxt_action = cur_action + sizeof(struct bts_action) +
243                 ((struct bts_action *) cur_action)->size;
244
245         if (((struct bts_action *) nxt_action)->type != ACTION_WAIT_EVENT) {
246                 pr_err("invalid action after change remote baud command");
247         } else {
248                 *ptr = *ptr + sizeof(struct bts_action) +
249                         ((struct bts_action *)cur_action)->size;
250                 *len = *len - (sizeof(struct bts_action) +
251                                 ((struct bts_action *)cur_action)->size);
252                 /* warn user on not commenting these in firmware */
253                 pr_warn("skipping the wait event of change remote baud");
254         }
255 }
256
257 /**
258  * download_firmware -
259  *      internal function which parses through the .bts firmware
260  *      script file intreprets SEND, DELAY actions only as of now
261  */
262 static long download_firmware(struct kim_data_s *kim_gdata)
263 {
264         long err = 0;
265         long len = 0;
266         unsigned char *ptr = NULL;
267         unsigned char *action_ptr = NULL;
268         unsigned char bts_scr_name[30] = { 0 }; /* 30 char long bts scr name? */
269         int wr_room_space;
270         int cmd_size;
271         unsigned long timeout;
272
273         err = read_local_version(kim_gdata, bts_scr_name);
274         if (err != 0) {
275                 pr_err("kim: failed to read local ver");
276                 return err;
277         }
278         err =
279             request_firmware(&kim_gdata->fw_entry, bts_scr_name,
280                              &kim_gdata->kim_pdev->dev);
281         if (unlikely((err != 0) || (kim_gdata->fw_entry->data == NULL) ||
282                      (kim_gdata->fw_entry->size == 0))) {
283                 pr_err(" request_firmware failed(errno %ld) for %s", err,
284                            bts_scr_name);
285                 return -EINVAL;
286         }
287         ptr = (void *)kim_gdata->fw_entry->data;
288         len = kim_gdata->fw_entry->size;
289         /* bts_header to remove out magic number and
290          * version
291          */
292         ptr += sizeof(struct bts_header);
293         len -= sizeof(struct bts_header);
294
295         while (len > 0 && ptr) {
296                 pr_debug(" action size %d, type %d ",
297                            ((struct bts_action *)ptr)->size,
298                            ((struct bts_action *)ptr)->type);
299
300                 switch (((struct bts_action *)ptr)->type) {
301                 case ACTION_SEND_COMMAND:       /* action send */
302                         pr_debug("S");
303                         action_ptr = &(((struct bts_action *)ptr)->data[0]);
304                         if (unlikely
305                             (((struct hci_command *)action_ptr)->opcode ==
306                              0xFF36)) {
307                                 /* ignore remote change
308                                  * baud rate HCI VS command */
309                                 pr_warn("change remote baud"
310                                     " rate command in firmware");
311                                 skip_change_remote_baud(&ptr, &len);
312                                 break;
313                         }
314                         /*
315                          * Make sure we have enough free space in uart
316                          * tx buffer to write current firmware command
317                          */
318                         cmd_size = ((struct bts_action *)ptr)->size;
319                         timeout = jiffies + msecs_to_jiffies(CMD_WR_TIME);
320                         do {
321                                 wr_room_space =
322                                         st_get_uart_wr_room(kim_gdata->core_data);
323                                 if (wr_room_space < 0) {
324                                         pr_err("Unable to get free "
325                                                         "space info from uart tx buffer");
326                                         release_firmware(kim_gdata->fw_entry);
327                                         return wr_room_space;
328                                 }
329                                 mdelay(1); /* wait 1ms before checking room */
330                         } while ((wr_room_space < cmd_size) &&
331                                         time_before(jiffies, timeout));
332
333                         /* Timeout happened ? */
334                         if (time_after_eq(jiffies, timeout)) {
335                                 pr_err("Timeout while waiting for free "
336                                                 "free space in uart tx buffer");
337                                 release_firmware(kim_gdata->fw_entry);
338                                 return -ETIMEDOUT;
339                         }
340                         /* reinit completion before sending for the
341                          * relevant wait
342                          */
343                         INIT_COMPLETION(kim_gdata->kim_rcvd);
344
345                         /*
346                          * Free space found in uart buffer, call st_int_write
347                          * to send current firmware command to the uart tx
348                          * buffer.
349                          */
350                         err = st_int_write(kim_gdata->core_data,
351                         ((struct bts_action_send *)action_ptr)->data,
352                                            ((struct bts_action *)ptr)->size);
353                         if (unlikely(err < 0)) {
354                                 release_firmware(kim_gdata->fw_entry);
355                                 return err;
356                         }
357                         /*
358                          * Check number of bytes written to the uart tx buffer
359                          * and requested command write size
360                          */
361                         if (err != cmd_size) {
362                                 pr_err("Number of bytes written to uart "
363                                                 "tx buffer are not matching with "
364                                                 "requested cmd write size");
365                                 release_firmware(kim_gdata->fw_entry);
366                                 return -EIO;
367                         }
368                         break;
369                 case ACTION_WAIT_EVENT:  /* wait */
370                         pr_debug("W");
371                         if (!wait_for_completion_timeout
372                                         (&kim_gdata->kim_rcvd,
373                                          msecs_to_jiffies(CMD_RESP_TIME))) {
374                                 pr_err("response timeout during fw download ");
375                                 /* timed out */
376                                 release_firmware(kim_gdata->fw_entry);
377                                 return -ETIMEDOUT;
378                         }
379                         INIT_COMPLETION(kim_gdata->kim_rcvd);
380                         break;
381                 case ACTION_DELAY:      /* sleep */
382                         pr_info("sleep command in scr");
383                         action_ptr = &(((struct bts_action *)ptr)->data[0]);
384                         mdelay(((struct bts_action_delay *)action_ptr)->msec);
385                         break;
386                 }
387                 len =
388                     len - (sizeof(struct bts_action) +
389                            ((struct bts_action *)ptr)->size);
390                 ptr =
391                     ptr + sizeof(struct bts_action) +
392                     ((struct bts_action *)ptr)->size;
393         }
394         /* fw download complete */
395         release_firmware(kim_gdata->fw_entry);
396         return 0;
397 }
398
399 /**********************************************************************/
400 /* functions called from ST core */
401 /* called from ST Core, when REG_IN_PROGRESS (registration in progress)
402  * can be because of
403  * 1. response to read local version
404  * 2. during send/recv's of firmware download
405  */
406 void st_kim_recv(void *disc_data, const unsigned char *data, long count)
407 {
408         struct st_data_s        *st_gdata = (struct st_data_s *)disc_data;
409         struct kim_data_s       *kim_gdata = st_gdata->kim_data;
410
411         /* copy to local buffer */
412         if (unlikely(data[4] == 0x01 && data[5] == 0x10 && data[0] == 0x04)) {
413                 /* must be the read_ver_cmd */
414                 memcpy(kim_gdata->resp_buffer, data, count);
415                 complete_all(&kim_gdata->kim_rcvd);
416                 return;
417         } else {
418                 kim_int_recv(kim_gdata, data, count);
419                 /* either completes or times out */
420         }
421         return;
422 }
423
424 /* to signal completion of line discipline installation
425  * called from ST Core, upon tty_open
426  */
427 void st_kim_complete(void *kim_data)
428 {
429         struct kim_data_s       *kim_gdata = (struct kim_data_s *)kim_data;
430         complete(&kim_gdata->ldisc_installed);
431 }
432
433 /**
434  * st_kim_start - called from ST Core upon 1st registration
435  *      This involves toggling the chip enable gpio, reading
436  *      the firmware version from chip, forming the fw file name
437  *      based on the chip version, requesting the fw, parsing it
438  *      and perform download(send/recv).
439  */
440 long st_kim_start(void *kim_data)
441 {
442         long err = 0;
443         long retry = POR_RETRY_COUNT;
444         struct ti_st_plat_data  *pdata;
445         struct kim_data_s       *kim_gdata = (struct kim_data_s *)kim_data;
446
447         pr_info(" %s", __func__);
448         pdata = kim_gdata->kim_pdev->dev.platform_data;
449
450         do {
451                 /* platform specific enabling code here */
452                 if (pdata->chip_enable)
453                         pdata->chip_enable(kim_gdata);
454
455                 /* Configure BT nShutdown to HIGH state */
456                 gpio_set_value(kim_gdata->nshutdown, GPIO_LOW);
457                 mdelay(5);      /* FIXME: a proper toggle */
458                 gpio_set_value(kim_gdata->nshutdown, GPIO_HIGH);
459                 mdelay(100);
460                 /* re-initialize the completion */
461                 INIT_COMPLETION(kim_gdata->ldisc_installed);
462                 /* send notification to UIM */
463                 kim_gdata->ldisc_install = 1;
464                 pr_info("ldisc_install = 1");
465                 sysfs_notify(&kim_gdata->kim_pdev->dev.kobj,
466                                 NULL, "install");
467                 /* wait for ldisc to be installed */
468                 err = wait_for_completion_timeout(&kim_gdata->ldisc_installed,
469                                 msecs_to_jiffies(LDISC_TIME));
470                 if (!err) {     /* timeout */
471                         pr_err("line disc installation timed out ");
472                         kim_gdata->ldisc_install = 0;
473                         pr_info("ldisc_install = 0");
474                         sysfs_notify(&kim_gdata->kim_pdev->dev.kobj,
475                                         NULL, "install");
476                         /* the following wait is never going to be completed,
477                          * since the ldisc was never installed, hence serving
478                          * as a mdelay of LDISC_TIME msecs */
479                         err = wait_for_completion_timeout
480                                 (&kim_gdata->ldisc_installed,
481                                  msecs_to_jiffies(LDISC_TIME));
482                         err = -ETIMEDOUT;
483                         continue;
484                 } else {
485                         /* ldisc installed now */
486                         pr_info(" line discipline installed ");
487                         err = download_firmware(kim_gdata);
488                         if (err != 0) {
489                                 pr_err("download firmware failed");
490                                 kim_gdata->ldisc_install = 0;
491                                 pr_info("ldisc_install = 0");
492                                 sysfs_notify(&kim_gdata->kim_pdev->dev.kobj,
493                                                 NULL, "install");
494                                 /* this wait might be completed, though in the
495                                  * tty_close() since the ldisc is already
496                                  * installed */
497                                 err = wait_for_completion_timeout
498                                         (&kim_gdata->ldisc_installed,
499                                          msecs_to_jiffies(LDISC_TIME));
500                                 err = -EINVAL;
501                                 continue;
502                         } else {        /* on success don't retry */
503                                 break;
504                         }
505                 }
506         } while (retry--);
507         return err;
508 }
509
510 /**
511  * st_kim_stop - called from ST Core, on the last un-registration
512  *      toggle low the chip enable gpio
513  */
514 long st_kim_stop(void *kim_data)
515 {
516         long err = 0;
517         struct kim_data_s       *kim_gdata = (struct kim_data_s *)kim_data;
518         struct ti_st_plat_data  *pdata =
519                 kim_gdata->kim_pdev->dev.platform_data;
520
521         INIT_COMPLETION(kim_gdata->ldisc_installed);
522
523         /* Flush any pending characters in the driver and discipline. */
524         tty_ldisc_flush(kim_gdata->core_data->tty);
525         tty_driver_flush_buffer(kim_gdata->core_data->tty);
526
527         /* send uninstall notification to UIM */
528         pr_info("ldisc_install = 0");
529         kim_gdata->ldisc_install = 0;
530         sysfs_notify(&kim_gdata->kim_pdev->dev.kobj, NULL, "install");
531
532         /* wait for ldisc to be un-installed */
533         err = wait_for_completion_timeout(&kim_gdata->ldisc_installed,
534                         msecs_to_jiffies(LDISC_TIME));
535         if (!err) {             /* timeout */
536                 pr_err(" timed out waiting for ldisc to be un-installed");
537                 return -ETIMEDOUT;
538         }
539
540         /* By default configure BT nShutdown to LOW state */
541         gpio_set_value(kim_gdata->nshutdown, GPIO_LOW);
542         mdelay(1);
543         gpio_set_value(kim_gdata->nshutdown, GPIO_HIGH);
544         mdelay(1);
545         gpio_set_value(kim_gdata->nshutdown, GPIO_LOW);
546
547         /* platform specific disable */
548         if (pdata->chip_disable)
549                 pdata->chip_disable(kim_gdata);
550         return err;
551 }
552
553 /**********************************************************************/
554 /* functions called from subsystems */
555 /* called when debugfs entry is read from */
556
557 static int show_version(struct seq_file *s, void *unused)
558 {
559         struct kim_data_s *kim_gdata = (struct kim_data_s *)s->private;
560         seq_printf(s, "%04X %d.%d.%d\n", kim_gdata->version.full,
561                         kim_gdata->version.chip, kim_gdata->version.maj_ver,
562                         kim_gdata->version.min_ver);
563         return 0;
564 }
565
566 static int show_list(struct seq_file *s, void *unused)
567 {
568         struct kim_data_s *kim_gdata = (struct kim_data_s *)s->private;
569         kim_st_list_protocols(kim_gdata->core_data, s);
570         return 0;
571 }
572
573 static ssize_t show_install(struct device *dev,
574                 struct device_attribute *attr, char *buf)
575 {
576         struct kim_data_s *kim_data = dev_get_drvdata(dev);
577         return sprintf(buf, "%d\n", kim_data->ldisc_install);
578 }
579
580 static ssize_t show_dev_name(struct device *dev,
581                 struct device_attribute *attr, char *buf)
582 {
583         struct kim_data_s *kim_data = dev_get_drvdata(dev);
584         return sprintf(buf, "%s\n", kim_data->dev_name);
585 }
586
587 static ssize_t show_baud_rate(struct device *dev,
588                 struct device_attribute *attr, char *buf)
589 {
590         struct kim_data_s *kim_data = dev_get_drvdata(dev);
591         return sprintf(buf, "%ld\n", kim_data->baud_rate);
592 }
593
594 static ssize_t show_flow_cntrl(struct device *dev,
595                 struct device_attribute *attr, char *buf)
596 {
597         struct kim_data_s *kim_data = dev_get_drvdata(dev);
598         return sprintf(buf, "%d\n", kim_data->flow_cntrl);
599 }
600
601 /* structures specific for sysfs entries */
602 static struct kobj_attribute ldisc_install =
603 __ATTR(install, 0444, (void *)show_install, NULL);
604
605 static struct kobj_attribute uart_dev_name =
606 __ATTR(dev_name, 0444, (void *)show_dev_name, NULL);
607
608 static struct kobj_attribute uart_baud_rate =
609 __ATTR(baud_rate, 0444, (void *)show_baud_rate, NULL);
610
611 static struct kobj_attribute uart_flow_cntrl =
612 __ATTR(flow_cntrl, 0444, (void *)show_flow_cntrl, NULL);
613
614 static struct attribute *uim_attrs[] = {
615         &ldisc_install.attr,
616         &uart_dev_name.attr,
617         &uart_baud_rate.attr,
618         &uart_flow_cntrl.attr,
619         NULL,
620 };
621
622 static struct attribute_group uim_attr_grp = {
623         .attrs = uim_attrs,
624 };
625
626 /**
627  * st_kim_ref - reference the core's data
628  *      This references the per-ST platform device in the arch/xx/
629  *      board-xx.c file.
630  *      This would enable multiple such platform devices to exist
631  *      on a given platform
632  */
633 void st_kim_ref(struct st_data_s **core_data, int id)
634 {
635         struct platform_device  *pdev;
636         struct kim_data_s       *kim_gdata;
637         /* get kim_gdata reference from platform device */
638         pdev = st_get_plat_device(id);
639         if (!pdev) {
640                 *core_data = NULL;
641                 return;
642         }
643         kim_gdata = dev_get_drvdata(&pdev->dev);
644         *core_data = kim_gdata->core_data;
645 }
646
647 static int kim_version_open(struct inode *i, struct file *f)
648 {
649         return single_open(f, show_version, i->i_private);
650 }
651
652 static int kim_list_open(struct inode *i, struct file *f)
653 {
654         return single_open(f, show_list, i->i_private);
655 }
656
657 static const struct file_operations version_debugfs_fops = {
658         /* version info */
659         .open = kim_version_open,
660         .read = seq_read,
661         .llseek = seq_lseek,
662         .release = single_release,
663 };
664 static const struct file_operations list_debugfs_fops = {
665         /* protocols info */
666         .open = kim_list_open,
667         .read = seq_read,
668         .llseek = seq_lseek,
669         .release = single_release,
670 };
671
672 /**********************************************************************/
673 /* functions called from platform device driver subsystem
674  * need to have a relevant platform device entry in the platform's
675  * board-*.c file
676  */
677
678 struct dentry *kim_debugfs_dir;
679 static int kim_probe(struct platform_device *pdev)
680 {
681         long status;
682         struct kim_data_s       *kim_gdata;
683         struct ti_st_plat_data  *pdata = pdev->dev.platform_data;
684
685         if ((pdev->id != -1) && (pdev->id < MAX_ST_DEVICES)) {
686                 /* multiple devices could exist */
687                 st_kim_devices[pdev->id] = pdev;
688         } else {
689                 /* platform's sure about existence of 1 device */
690                 st_kim_devices[0] = pdev;
691         }
692
693         kim_gdata = kzalloc(sizeof(struct kim_data_s), GFP_ATOMIC);
694         if (!kim_gdata) {
695                 pr_err("no mem to allocate");
696                 return -ENOMEM;
697         }
698         dev_set_drvdata(&pdev->dev, kim_gdata);
699
700         status = st_core_init(&kim_gdata->core_data);
701         if (status != 0) {
702                 pr_err(" ST core init failed");
703                 return -EIO;
704         }
705         /* refer to itself */
706         kim_gdata->core_data->kim_data = kim_gdata;
707
708         /* Claim the chip enable nShutdown gpio from the system */
709         kim_gdata->nshutdown = pdata->nshutdown_gpio;
710         status = gpio_request(kim_gdata->nshutdown, "kim");
711         if (unlikely(status)) {
712                 pr_err(" gpio %ld request failed ", kim_gdata->nshutdown);
713                 return status;
714         }
715
716         /* Configure nShutdown GPIO as output=0 */
717         status = gpio_direction_output(kim_gdata->nshutdown, 0);
718         if (unlikely(status)) {
719                 pr_err(" unable to configure gpio %ld", kim_gdata->nshutdown);
720                 return status;
721         }
722         /* get reference of pdev for request_firmware
723          */
724         kim_gdata->kim_pdev = pdev;
725         init_completion(&kim_gdata->kim_rcvd);
726         init_completion(&kim_gdata->ldisc_installed);
727
728         status = sysfs_create_group(&pdev->dev.kobj, &uim_attr_grp);
729         if (status) {
730                 pr_err("failed to create sysfs entries");
731                 return status;
732         }
733
734         /* copying platform data */
735         strncpy(kim_gdata->dev_name, pdata->dev_name, UART_DEV_NAME_LEN);
736         kim_gdata->flow_cntrl = pdata->flow_cntrl;
737         kim_gdata->baud_rate = pdata->baud_rate;
738         pr_info("sysfs entries created\n");
739
740         kim_debugfs_dir = debugfs_create_dir("ti-st", NULL);
741         if (IS_ERR(kim_debugfs_dir)) {
742                 pr_err(" debugfs entries creation failed ");
743                 kim_debugfs_dir = NULL;
744                 return -EIO;
745         }
746
747         debugfs_create_file("version", S_IRUGO, kim_debugfs_dir,
748                                 kim_gdata, &version_debugfs_fops);
749         debugfs_create_file("protocols", S_IRUGO, kim_debugfs_dir,
750                                 kim_gdata, &list_debugfs_fops);
751         pr_info(" debugfs entries created ");
752         return 0;
753 }
754
755 static int kim_remove(struct platform_device *pdev)
756 {
757         /* free the GPIOs requested */
758         struct ti_st_plat_data  *pdata = pdev->dev.platform_data;
759         struct kim_data_s       *kim_gdata;
760
761         kim_gdata = dev_get_drvdata(&pdev->dev);
762
763         /* Free the Bluetooth/FM/GPIO
764          * nShutdown gpio from the system
765          */
766         gpio_free(pdata->nshutdown_gpio);
767         pr_info("nshutdown GPIO Freed");
768
769         debugfs_remove_recursive(kim_debugfs_dir);
770         sysfs_remove_group(&pdev->dev.kobj, &uim_attr_grp);
771         pr_info("sysfs entries removed");
772
773         kim_gdata->kim_pdev = NULL;
774         st_core_exit(kim_gdata->core_data);
775
776         kfree(kim_gdata);
777         kim_gdata = NULL;
778         return 0;
779 }
780
781 int kim_suspend(struct platform_device *pdev, pm_message_t state)
782 {
783         struct ti_st_plat_data  *pdata = pdev->dev.platform_data;
784
785         if (pdata->suspend)
786                 return pdata->suspend(pdev, state);
787
788         return -EOPNOTSUPP;
789 }
790
791 int kim_resume(struct platform_device *pdev)
792 {
793         struct ti_st_plat_data  *pdata = pdev->dev.platform_data;
794
795         if (pdata->resume)
796                 return pdata->resume(pdev);
797
798         return -EOPNOTSUPP;
799 }
800
801 /**********************************************************************/
802 /* entry point for ST KIM module, called in from ST Core */
803 static struct platform_driver kim_platform_driver = {
804         .probe = kim_probe,
805         .remove = kim_remove,
806         .suspend = kim_suspend,
807         .resume = kim_resume,
808         .driver = {
809                 .name = "kim",
810                 .owner = THIS_MODULE,
811         },
812 };
813
814 static int __init st_kim_init(void)
815 {
816         return platform_driver_register(&kim_platform_driver);
817 }
818
819 static void __exit st_kim_deinit(void)
820 {
821         platform_driver_unregister(&kim_platform_driver);
822 }
823
824
825 module_init(st_kim_init);
826 module_exit(st_kim_deinit);
827 MODULE_AUTHOR("Pavan Savoy <pavan_savoy@ti.com>");
828 MODULE_DESCRIPTION("Shared Transport Driver for TI BT/FM/GPS combo chips ");
829 MODULE_LICENSE("GPL");