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