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>
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.
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.
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
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>
36 #include <linux/skbuff.h>
37 #include <linux/ti_wilink_st.h>
38 #include <linux/module.h>
41 #define MAX_ST_DEVICES 3 /* Imagine 1 on each UART for now */
42 static struct platform_device *st_kim_devices[MAX_ST_DEVICES];
44 /**********************************************************************/
45 /* internal functions */
48 * st_get_plat_device -
49 * function which returns the reference to the platform device
50 * requested by id. As of now only 1 such device exists (id=0)
51 * the context requesting for reference can get the id to be
52 * requested by a. The protocol driver which is registering or
53 * b. the tty device which is opened.
55 static struct platform_device *st_get_plat_device(int id)
57 return st_kim_devices[id];
61 * validate_firmware_response -
62 * function to return whether the firmware response was proper
63 * in case of error don't complete so that waiting for proper
66 static void validate_firmware_response(struct kim_data_s *kim_gdata)
68 struct sk_buff *skb = kim_gdata->rx_skb;
69 if (unlikely(skb->data[5] != 0)) {
70 pr_err("no proper response during fw download");
71 pr_err("data6 %x", skb->data[5]);
73 return; /* keep waiting for the proper response */
75 /* becos of all the script being downloaded */
76 complete_all(&kim_gdata->kim_rcvd);
80 /* check for data len received inside kim_int_recv
81 * most often hit the last case to update state to waiting for data
83 static inline int kim_check_data_len(struct kim_data_s *kim_gdata, int len)
85 register int room = skb_tailroom(kim_gdata->rx_skb);
87 pr_debug("len %d room %d", len, room);
90 validate_firmware_response(kim_gdata);
91 } else if (len > room) {
92 /* Received packet's payload length is larger.
93 * We can't accommodate it in created skb.
95 pr_err("Data length is too large len %d room %d", len,
97 kfree_skb(kim_gdata->rx_skb);
99 /* Packet header has non-zero payload length and
100 * we have enough space in created skb. Lets read
102 kim_gdata->rx_state = ST_W4_DATA;
103 kim_gdata->rx_count = len;
107 /* Change ST LL state to continue to process next
109 kim_gdata->rx_state = ST_W4_PACKET_TYPE;
110 kim_gdata->rx_skb = NULL;
111 kim_gdata->rx_count = 0;
117 * kim_int_recv - receive function called during firmware download
118 * firmware download responses on different UART drivers
119 * have been observed to come in bursts of different
120 * tty_receive and hence the logic
122 static void kim_int_recv(struct kim_data_s *kim_gdata,
123 const unsigned char *data, long count)
125 const unsigned char *ptr;
126 int len = 0, type = 0;
129 pr_debug("%s", __func__);
130 /* Decode received bytes here */
132 if (unlikely(ptr == NULL)) {
133 pr_err(" received null from TTY ");
138 if (kim_gdata->rx_count) {
139 len = min_t(unsigned int, kim_gdata->rx_count, count);
140 memcpy(skb_put(kim_gdata->rx_skb, len), ptr, len);
141 kim_gdata->rx_count -= len;
145 if (kim_gdata->rx_count)
148 /* Check ST RX state machine , where are we? */
149 switch (kim_gdata->rx_state) {
150 /* Waiting for complete packet ? */
152 pr_debug("Complete pkt received");
153 validate_firmware_response(kim_gdata);
154 kim_gdata->rx_state = ST_W4_PACKET_TYPE;
155 kim_gdata->rx_skb = NULL;
157 /* Waiting for Bluetooth event header ? */
160 (unsigned char *)&kim_gdata->rx_skb->data[1];
161 pr_debug("event hdr: plen 0x%02x\n", *plen);
162 kim_check_data_len(kim_gdata, *plen);
164 } /* end of switch */
165 } /* end of if rx_state */
167 /* Bluetooth event packet? */
169 kim_gdata->rx_state = ST_W4_HEADER;
170 kim_gdata->rx_count = 2;
174 pr_info("unknown packet");
182 alloc_skb(1024+8, GFP_ATOMIC);
183 if (!kim_gdata->rx_skb) {
184 pr_err("can't allocate mem for new packet");
185 kim_gdata->rx_state = ST_W4_PACKET_TYPE;
186 kim_gdata->rx_count = 0;
189 skb_reserve(kim_gdata->rx_skb, 8);
190 kim_gdata->rx_skb->cb[0] = 4;
191 kim_gdata->rx_skb->cb[1] = 0;
197 static long read_local_version(struct kim_data_s *kim_gdata, char *bts_scr_name)
199 unsigned short version = 0, chip = 0, min_ver = 0, maj_ver = 0;
200 const char read_ver_cmd[] = { 0x01, 0x01, 0x10, 0x00 };
202 pr_debug("%s", __func__);
204 INIT_COMPLETION(kim_gdata->kim_rcvd);
205 if (4 != st_int_write(kim_gdata->core_data, read_ver_cmd, 4)) {
206 pr_err("kim: couldn't write 4 bytes");
210 if (!wait_for_completion_timeout
211 (&kim_gdata->kim_rcvd, msecs_to_jiffies(CMD_RESP_TIME))) {
212 pr_err(" waiting for ver info- timed out ");
215 INIT_COMPLETION(kim_gdata->kim_rcvd);
218 MAKEWORD(kim_gdata->resp_buffer[13],
219 kim_gdata->resp_buffer[14]);
220 chip = (version & 0x7C00) >> 10;
221 min_ver = (version & 0x007F);
222 maj_ver = (version & 0x0380) >> 7;
224 if (version & 0x8000)
227 sprintf(bts_scr_name, "TIInit_%d.%d.%d.bts", chip, maj_ver, min_ver);
229 /* to be accessed later via sysfs entry */
230 kim_gdata->version.full = version;
231 kim_gdata->version.chip = chip;
232 kim_gdata->version.maj_ver = maj_ver;
233 kim_gdata->version.min_ver = min_ver;
235 pr_info("%s", bts_scr_name);
239 static void skip_change_remote_baud(unsigned char **ptr, long *len)
241 unsigned char *nxt_action, *cur_action;
244 nxt_action = cur_action + sizeof(struct bts_action) +
245 ((struct bts_action *) cur_action)->size;
247 if (((struct bts_action *) nxt_action)->type != ACTION_WAIT_EVENT) {
248 pr_err("invalid action after change remote baud command");
250 *ptr = *ptr + sizeof(struct bts_action) +
251 ((struct bts_action *)cur_action)->size;
252 *len = *len - (sizeof(struct bts_action) +
253 ((struct bts_action *)cur_action)->size);
254 /* warn user on not commenting these in firmware */
255 pr_warn("skipping the wait event of change remote baud");
260 * download_firmware -
261 * internal function which parses through the .bts firmware
262 * script file intreprets SEND, DELAY actions only as of now
264 static long download_firmware(struct kim_data_s *kim_gdata)
268 unsigned char *ptr = NULL;
269 unsigned char *action_ptr = NULL;
270 unsigned char bts_scr_name[30] = { 0 }; /* 30 char long bts scr name? */
273 unsigned long timeout;
275 err = read_local_version(kim_gdata, bts_scr_name);
277 pr_err("kim: failed to read local ver");
281 request_firmware(&kim_gdata->fw_entry, bts_scr_name,
282 &kim_gdata->kim_pdev->dev);
283 if (unlikely((err != 0) || (kim_gdata->fw_entry->data == NULL) ||
284 (kim_gdata->fw_entry->size == 0))) {
285 pr_err(" request_firmware failed(errno %ld) for %s", err,
289 ptr = (void *)kim_gdata->fw_entry->data;
290 len = kim_gdata->fw_entry->size;
291 /* bts_header to remove out magic number and
294 ptr += sizeof(struct bts_header);
295 len -= sizeof(struct bts_header);
297 while (len > 0 && ptr) {
298 pr_debug(" action size %d, type %d ",
299 ((struct bts_action *)ptr)->size,
300 ((struct bts_action *)ptr)->type);
302 switch (((struct bts_action *)ptr)->type) {
303 case ACTION_SEND_COMMAND: /* action send */
305 action_ptr = &(((struct bts_action *)ptr)->data[0]);
307 (((struct hci_command *)action_ptr)->opcode ==
309 /* ignore remote change
310 * baud rate HCI VS command */
311 pr_warn("change remote baud"
312 " rate command in firmware");
313 skip_change_remote_baud(&ptr, &len);
317 * Make sure we have enough free space in uart
318 * tx buffer to write current firmware command
320 cmd_size = ((struct bts_action *)ptr)->size;
321 timeout = jiffies + msecs_to_jiffies(CMD_WR_TIME);
324 st_get_uart_wr_room(kim_gdata->core_data);
325 if (wr_room_space < 0) {
326 pr_err("Unable to get free "
327 "space info from uart tx buffer");
328 release_firmware(kim_gdata->fw_entry);
329 return wr_room_space;
331 mdelay(1); /* wait 1ms before checking room */
332 } while ((wr_room_space < cmd_size) &&
333 time_before(jiffies, timeout));
335 /* Timeout happened ? */
336 if (time_after_eq(jiffies, timeout)) {
337 pr_err("Timeout while waiting for free "
338 "free space in uart tx buffer");
339 release_firmware(kim_gdata->fw_entry);
342 /* reinit completion before sending for the
345 INIT_COMPLETION(kim_gdata->kim_rcvd);
348 * Free space found in uart buffer, call st_int_write
349 * to send current firmware command to the uart tx
352 err = st_int_write(kim_gdata->core_data,
353 ((struct bts_action_send *)action_ptr)->data,
354 ((struct bts_action *)ptr)->size);
355 if (unlikely(err < 0)) {
356 release_firmware(kim_gdata->fw_entry);
360 * Check number of bytes written to the uart tx buffer
361 * and requested command write size
363 if (err != cmd_size) {
364 pr_err("Number of bytes written to uart "
365 "tx buffer are not matching with "
366 "requested cmd write size");
367 release_firmware(kim_gdata->fw_entry);
371 case ACTION_WAIT_EVENT: /* wait */
373 if (!wait_for_completion_timeout
374 (&kim_gdata->kim_rcvd,
375 msecs_to_jiffies(CMD_RESP_TIME))) {
376 pr_err("response timeout during fw download ");
378 release_firmware(kim_gdata->fw_entry);
381 INIT_COMPLETION(kim_gdata->kim_rcvd);
383 case ACTION_DELAY: /* sleep */
384 pr_info("sleep command in scr");
385 action_ptr = &(((struct bts_action *)ptr)->data[0]);
386 mdelay(((struct bts_action_delay *)action_ptr)->msec);
390 len - (sizeof(struct bts_action) +
391 ((struct bts_action *)ptr)->size);
393 ptr + sizeof(struct bts_action) +
394 ((struct bts_action *)ptr)->size;
396 /* fw download complete */
397 release_firmware(kim_gdata->fw_entry);
401 /**********************************************************************/
402 /* functions called from ST core */
403 /* called from ST Core, when REG_IN_PROGRESS (registration in progress)
405 * 1. response to read local version
406 * 2. during send/recv's of firmware download
408 void st_kim_recv(void *disc_data, const unsigned char *data, long count)
410 struct st_data_s *st_gdata = (struct st_data_s *)disc_data;
411 struct kim_data_s *kim_gdata = st_gdata->kim_data;
413 /* copy to local buffer */
414 if (unlikely(data[4] == 0x01 && data[5] == 0x10 && data[0] == 0x04)) {
415 /* must be the read_ver_cmd */
416 memcpy(kim_gdata->resp_buffer, data, count);
417 complete_all(&kim_gdata->kim_rcvd);
420 kim_int_recv(kim_gdata, data, count);
421 /* either completes or times out */
426 /* to signal completion of line discipline installation
427 * called from ST Core, upon tty_open
429 void st_kim_complete(void *kim_data)
431 struct kim_data_s *kim_gdata = (struct kim_data_s *)kim_data;
432 complete(&kim_gdata->ldisc_installed);
436 * st_kim_start - called from ST Core upon 1st registration
437 * This involves toggling the chip enable gpio, reading
438 * the firmware version from chip, forming the fw file name
439 * based on the chip version, requesting the fw, parsing it
440 * and perform download(send/recv).
442 long st_kim_start(void *kim_data)
445 long retry = POR_RETRY_COUNT;
446 struct ti_st_plat_data *pdata;
447 struct kim_data_s *kim_gdata = (struct kim_data_s *)kim_data;
449 pr_info(" %s", __func__);
450 pdata = kim_gdata->kim_pdev->dev.platform_data;
453 /* platform specific enabling code here */
454 if (pdata->chip_enable)
455 pdata->chip_enable(kim_gdata);
457 /* re-initialize the completion */
458 INIT_COMPLETION(kim_gdata->ldisc_installed);
459 /* send notification to UIM */
460 kim_gdata->ldisc_install = 1;
461 pr_info("ldisc_install = 1");
462 sysfs_notify(&kim_gdata->kim_pdev->dev.kobj,
464 /* wait for ldisc to be installed */
465 err = wait_for_completion_timeout(&kim_gdata->ldisc_installed,
466 msecs_to_jiffies(LDISC_TIME));
468 /* ldisc installation timeout,
469 * flush uart, power cycle BT_EN */
470 pr_err("ldisc installation timeout");
471 err = st_kim_stop(kim_gdata);
474 /* ldisc installed now */
475 pr_info("line discipline installed");
476 err = download_firmware(kim_gdata);
478 /* ldisc installed but fw download failed,
479 * flush uart & power cycle BT_EN */
480 pr_err("download firmware failed");
481 err = st_kim_stop(kim_gdata);
483 } else { /* on success don't retry */
492 * st_kim_stop - stop communication with chip.
493 * This can be called from ST Core/KIM, on the-
494 * (a) last un-register when chip need not be powered there-after,
495 * (b) upon failure to either install ldisc or download firmware.
496 * The function is responsible to (a) notify UIM about un-installation,
497 * (b) flush UART if the ldisc was installed.
498 * (c) invoke platform's chip disabling routine.
500 long st_kim_stop(void *kim_data)
503 struct kim_data_s *kim_gdata = (struct kim_data_s *)kim_data;
504 struct ti_st_plat_data *pdata =
505 kim_gdata->kim_pdev->dev.platform_data;
506 struct tty_struct *tty = kim_gdata->core_data->tty;
508 INIT_COMPLETION(kim_gdata->ldisc_installed);
510 if (tty) { /* can be called before ldisc is installed */
511 /* Flush any pending characters in the driver and discipline. */
512 tty_ldisc_flush(tty);
513 tty_driver_flush_buffer(tty);
514 tty->ops->flush_buffer(tty);
517 /* send uninstall notification to UIM */
518 pr_info("ldisc_install = 0");
519 kim_gdata->ldisc_install = 0;
520 sysfs_notify(&kim_gdata->kim_pdev->dev.kobj, NULL, "install");
522 /* wait for ldisc to be un-installed */
523 err = wait_for_completion_timeout(&kim_gdata->ldisc_installed,
524 msecs_to_jiffies(LDISC_TIME));
525 if (!err) { /* timeout */
526 pr_err(" timed out waiting for ldisc to be un-installed");
530 /* platform specific disable */
531 if (pdata->chip_disable)
532 pdata->chip_disable(kim_gdata);
536 /**********************************************************************/
537 /* functions called from subsystems */
538 /* called when debugfs entry is read from */
540 static int show_version(struct seq_file *s, void *unused)
542 struct kim_data_s *kim_gdata = (struct kim_data_s *)s->private;
543 seq_printf(s, "%04X %d.%d.%d\n", kim_gdata->version.full,
544 kim_gdata->version.chip, kim_gdata->version.maj_ver,
545 kim_gdata->version.min_ver);
549 static int show_list(struct seq_file *s, void *unused)
551 struct kim_data_s *kim_gdata = (struct kim_data_s *)s->private;
552 kim_st_list_protocols(kim_gdata->core_data, s);
556 static ssize_t show_install(struct device *dev,
557 struct device_attribute *attr, char *buf)
559 struct kim_data_s *kim_data = dev_get_drvdata(dev);
560 return sprintf(buf, "%d\n", kim_data->ldisc_install);
564 static ssize_t store_dev_name(struct device *dev,
565 struct device_attribute *attr, const char *buf, size_t count)
567 struct kim_data_s *kim_data = dev_get_drvdata(dev);
568 pr_debug("storing dev name >%s<", buf);
569 strncpy(kim_data->dev_name, buf, count);
570 pr_debug("stored dev name >%s<", kim_data->dev_name);
574 static ssize_t store_baud_rate(struct device *dev,
575 struct device_attribute *attr, const char *buf, size_t count)
577 struct kim_data_s *kim_data = dev_get_drvdata(dev);
578 pr_debug("storing baud rate >%s<", buf);
579 sscanf(buf, "%ld", &kim_data->baud_rate);
580 pr_debug("stored baud rate >%ld<", kim_data->baud_rate);
583 #endif /* if DEBUG */
585 static ssize_t show_dev_name(struct device *dev,
586 struct device_attribute *attr, char *buf)
588 struct kim_data_s *kim_data = dev_get_drvdata(dev);
589 return sprintf(buf, "%s\n", kim_data->dev_name);
592 static ssize_t show_baud_rate(struct device *dev,
593 struct device_attribute *attr, char *buf)
595 struct kim_data_s *kim_data = dev_get_drvdata(dev);
596 return sprintf(buf, "%ld\n", kim_data->baud_rate);
599 static ssize_t show_flow_cntrl(struct device *dev,
600 struct device_attribute *attr, char *buf)
602 struct kim_data_s *kim_data = dev_get_drvdata(dev);
603 return sprintf(buf, "%d\n", kim_data->flow_cntrl);
606 /* structures specific for sysfs entries */
607 static struct kobj_attribute ldisc_install =
608 __ATTR(install, 0444, (void *)show_install, NULL);
610 static struct kobj_attribute uart_dev_name =
611 #ifdef DEBUG /* TODO: move this to debug-fs if possible */
612 __ATTR(dev_name, 0644, (void *)show_dev_name, (void *)store_dev_name);
614 __ATTR(dev_name, 0444, (void *)show_dev_name, NULL);
617 static struct kobj_attribute uart_baud_rate =
618 #ifdef DEBUG /* TODO: move to debugfs */
619 __ATTR(baud_rate, 0644, (void *)show_baud_rate, (void *)store_baud_rate);
621 __ATTR(baud_rate, 0444, (void *)show_baud_rate, NULL);
624 static struct kobj_attribute uart_flow_cntrl =
625 __ATTR(flow_cntrl, 0444, (void *)show_flow_cntrl, NULL);
627 static struct attribute *uim_attrs[] = {
630 &uart_baud_rate.attr,
631 &uart_flow_cntrl.attr,
635 static struct attribute_group uim_attr_grp = {
640 * st_kim_ref - reference the core's data
641 * This references the per-ST platform device in the arch/xx/
643 * This would enable multiple such platform devices to exist
644 * on a given platform
646 void st_kim_ref(struct st_data_s **core_data, int id)
648 struct platform_device *pdev;
649 struct kim_data_s *kim_gdata;
650 /* get kim_gdata reference from platform device */
651 pdev = st_get_plat_device(id);
656 kim_gdata = dev_get_drvdata(&pdev->dev);
657 *core_data = kim_gdata->core_data;
660 static int kim_version_open(struct inode *i, struct file *f)
662 return single_open(f, show_version, i->i_private);
665 static int kim_list_open(struct inode *i, struct file *f)
667 return single_open(f, show_list, i->i_private);
670 static const struct file_operations version_debugfs_fops = {
672 .open = kim_version_open,
675 .release = single_release,
677 static const struct file_operations list_debugfs_fops = {
679 .open = kim_list_open,
682 .release = single_release,
685 /**********************************************************************/
686 /* functions called from platform device driver subsystem
687 * need to have a relevant platform device entry in the platform's
691 static struct dentry *kim_debugfs_dir;
692 static int kim_probe(struct platform_device *pdev)
695 struct kim_data_s *kim_gdata;
696 struct ti_st_plat_data *pdata = pdev->dev.platform_data;
698 if ((pdev->id != -1) && (pdev->id < MAX_ST_DEVICES)) {
699 /* multiple devices could exist */
700 st_kim_devices[pdev->id] = pdev;
702 /* platform's sure about existence of 1 device */
703 st_kim_devices[0] = pdev;
706 kim_gdata = kzalloc(sizeof(struct kim_data_s), GFP_ATOMIC);
708 pr_err("no mem to allocate");
711 dev_set_drvdata(&pdev->dev, kim_gdata);
713 status = st_core_init(&kim_gdata->core_data);
715 pr_err(" ST core init failed");
718 /* refer to itself */
719 kim_gdata->core_data->kim_data = kim_gdata;
721 /* get reference of pdev for request_firmware
723 kim_gdata->kim_pdev = pdev;
724 init_completion(&kim_gdata->kim_rcvd);
725 init_completion(&kim_gdata->ldisc_installed);
727 status = sysfs_create_group(&pdev->dev.kobj, &uim_attr_grp);
729 pr_err("failed to create sysfs entries");
733 /* copying platform data */
734 strncpy(kim_gdata->dev_name, pdata->dev_name, UART_DEV_NAME_LEN);
735 kim_gdata->flow_cntrl = pdata->flow_cntrl;
736 kim_gdata->baud_rate = pdata->baud_rate;
737 pr_info("sysfs entries created\n");
739 kim_debugfs_dir = debugfs_create_dir("ti-st", NULL);
740 if (IS_ERR(kim_debugfs_dir)) {
741 pr_err(" debugfs entries creation failed ");
742 kim_debugfs_dir = NULL;
746 debugfs_create_file("version", S_IRUGO, kim_debugfs_dir,
747 kim_gdata, &version_debugfs_fops);
748 debugfs_create_file("protocols", S_IRUGO, kim_debugfs_dir,
749 kim_gdata, &list_debugfs_fops);
750 pr_info(" debugfs entries created ");
754 static int kim_remove(struct platform_device *pdev)
756 struct kim_data_s *kim_gdata;
758 kim_gdata = dev_get_drvdata(&pdev->dev);
760 debugfs_remove_recursive(kim_debugfs_dir);
761 sysfs_remove_group(&pdev->dev.kobj, &uim_attr_grp);
762 pr_info("sysfs entries removed");
764 kim_gdata->kim_pdev = NULL;
765 st_core_exit(kim_gdata->core_data);
772 static int kim_suspend(struct platform_device *pdev, pm_message_t state)
774 struct ti_st_plat_data *pdata = pdev->dev.platform_data;
777 return pdata->suspend(pdev, state);
782 static int kim_resume(struct platform_device *pdev)
784 struct ti_st_plat_data *pdata = pdev->dev.platform_data;
787 return pdata->resume(pdev);
792 /**********************************************************************/
793 /* entry point for ST KIM module, called in from ST Core */
794 static struct platform_driver kim_platform_driver = {
796 .remove = kim_remove,
797 .suspend = kim_suspend,
798 .resume = kim_resume,
801 .owner = THIS_MODULE,
805 module_platform_driver(kim_platform_driver);
807 MODULE_AUTHOR("Pavan Savoy <pavan_savoy@ti.com>");
808 MODULE_DESCRIPTION("Shared Transport Driver for TI BT/FM/GPS combo chips ");
809 MODULE_LICENSE("GPL");