blob: 0f36db3aa40fa59c001733e50f3e6ff606419425 [file] [log] [blame]
Pavan Savoyd0088ce2010-04-08 13:16:54 -05001/*
2 * Shared Transport Line discipline driver Core
3 * Init Manager module responsible for GPIO control
4 * and firmware download
Pavan Savoya0cc2f32010-10-06 12:18:14 -04005 * Copyright (C) 2009-2010 Texas Instruments
6 * Author: Pavan Savoy <pavan_savoy@ti.com>
Pavan Savoyd0088ce2010-04-08 13:16:54 -05007 *
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>
Pavan Savoyc1afac12010-07-28 02:25:59 -050030#include <linux/debugfs.h>
31#include <linux/seq_file.h>
Pavan Savoyd0088ce2010-04-08 13:16:54 -050032#include <linux/sched.h>
Randy Dunlap773d6792011-04-26 09:18:51 -070033#include <linux/sysfs.h>
Pavan Savoyec60d0a2011-02-04 02:23:10 -060034#include <linux/tty.h>
Pavan Savoyd0088ce2010-04-08 13:16:54 -050035
Pavan Savoy5c88b022011-02-04 02:23:09 -060036#include <linux/skbuff.h>
Pavan Savoye5558672010-09-30 16:13:30 -040037#include <linux/ti_wilink_st.h>
Paul Gortmakereb12a672011-07-03 15:14:56 -040038#include <linux/module.h>
Pavan Savoy83ef41f2010-09-17 12:06:11 -040039
Pavan Savoyd0088ce2010-04-08 13:16:54 -050040
Pavan Savoydbd3a872010-08-19 14:08:51 -040041#define MAX_ST_DEVICES 3 /* Imagine 1 on each UART for now */
Pavan Savoy73f12e82010-10-12 16:27:38 -040042static struct platform_device *st_kim_devices[MAX_ST_DEVICES];
Pavan Savoyd0088ce2010-04-08 13:16:54 -050043
44/**********************************************************************/
45/* internal functions */
46
Pavan Savoy36b5aee2010-07-22 05:32:06 -050047/**
Pavan Savoydbd3a872010-08-19 14:08:51 -040048 * 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/**
Pavan Savoy36b5aee2010-07-22 05:32:06 -050061 * 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
Pavan Savoyd0088ce2010-04-08 13:16:54 -050065 */
Pavan Savoy27712b32012-08-03 14:49:40 -050066static void validate_firmware_response(struct kim_data_s *kim_gdata)
Pavan Savoyd0088ce2010-04-08 13:16:54 -050067{
Pavan Savoy38d9df42010-07-08 08:55:17 -050068 struct sk_buff *skb = kim_gdata->rx_skb;
Pavan Savoyd0088ce2010-04-08 13:16:54 -050069 if (unlikely(skb->data[5] != 0)) {
70 pr_err("no proper response during fw download");
71 pr_err("data6 %x", skb->data[5]);
Pavan Savoy76ff0e62011-08-10 10:18:36 -050072 kfree_skb(skb);
Pavan Savoyd0088ce2010-04-08 13:16:54 -050073 return; /* keep waiting for the proper response */
74 }
75 /* becos of all the script being downloaded */
76 complete_all(&kim_gdata->kim_rcvd);
77 kfree_skb(skb);
78}
79
80/* check for data len received inside kim_int_recv
81 * most often hit the last case to update state to waiting for data
82 */
Pavan Savoy38d9df42010-07-08 08:55:17 -050083static inline int kim_check_data_len(struct kim_data_s *kim_gdata, int len)
Pavan Savoyd0088ce2010-04-08 13:16:54 -050084{
85 register int room = skb_tailroom(kim_gdata->rx_skb);
86
Pavan Savoye6d9e642010-07-22 05:32:05 -050087 pr_debug("len %d room %d", len, room);
Pavan Savoyd0088ce2010-04-08 13:16:54 -050088
89 if (!len) {
Pavan Savoy38d9df42010-07-08 08:55:17 -050090 validate_firmware_response(kim_gdata);
Pavan Savoyd0088ce2010-04-08 13:16:54 -050091 } else if (len > room) {
92 /* Received packet's payload length is larger.
93 * We can't accommodate it in created skb.
94 */
95 pr_err("Data length is too large len %d room %d", len,
96 room);
97 kfree_skb(kim_gdata->rx_skb);
98 } else {
99 /* Packet header has non-zero payload length and
100 * we have enough space in created skb. Lets read
101 * payload data */
Pavan Savoy5c88b022011-02-04 02:23:09 -0600102 kim_gdata->rx_state = ST_W4_DATA;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500103 kim_gdata->rx_count = len;
104 return len;
105 }
106
107 /* Change ST LL state to continue to process next
108 * packet */
109 kim_gdata->rx_state = ST_W4_PACKET_TYPE;
110 kim_gdata->rx_skb = NULL;
111 kim_gdata->rx_count = 0;
112
113 return 0;
114}
115
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500116/**
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
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500121 */
Pavan Savoy27712b32012-08-03 14:49:40 -0500122static void kim_int_recv(struct kim_data_s *kim_gdata,
Pavan Savoy38d9df42010-07-08 08:55:17 -0500123 const unsigned char *data, long count)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500124{
Pavan Savoy73f12e82010-10-12 16:27:38 -0400125 const unsigned char *ptr;
Pavan Savoy73f12e82010-10-12 16:27:38 -0400126 int len = 0, type = 0;
Pavan Savoy5c88b022011-02-04 02:23:09 -0600127 unsigned char *plen;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500128
Pavan Savoye6d9e642010-07-22 05:32:05 -0500129 pr_debug("%s", __func__);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500130 /* Decode received bytes here */
Pavan Savoy73f12e82010-10-12 16:27:38 -0400131 ptr = data;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500132 if (unlikely(ptr == NULL)) {
133 pr_err(" received null from TTY ");
134 return;
135 }
Pavan Savoy73f12e82010-10-12 16:27:38 -0400136
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500137 while (count) {
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;
142 count -= len;
143 ptr += len;
144
145 if (kim_gdata->rx_count)
146 continue;
147
148 /* Check ST RX state machine , where are we? */
149 switch (kim_gdata->rx_state) {
150 /* Waiting for complete packet ? */
Pavan Savoy5c88b022011-02-04 02:23:09 -0600151 case ST_W4_DATA:
Pavan Savoye6d9e642010-07-22 05:32:05 -0500152 pr_debug("Complete pkt received");
Pavan Savoy38d9df42010-07-08 08:55:17 -0500153 validate_firmware_response(kim_gdata);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500154 kim_gdata->rx_state = ST_W4_PACKET_TYPE;
155 kim_gdata->rx_skb = NULL;
156 continue;
157 /* Waiting for Bluetooth event header ? */
Pavan Savoy5c88b022011-02-04 02:23:09 -0600158 case ST_W4_HEADER:
159 plen =
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);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500163 continue;
164 } /* end of switch */
165 } /* end of if rx_state */
166 switch (*ptr) {
167 /* Bluetooth event packet? */
Pavan Savoy5c88b022011-02-04 02:23:09 -0600168 case 0x04:
169 kim_gdata->rx_state = ST_W4_HEADER;
170 kim_gdata->rx_count = 2;
171 type = *ptr;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500172 break;
173 default:
174 pr_info("unknown packet");
175 ptr++;
176 count--;
177 continue;
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500178 }
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500179 ptr++;
180 count--;
181 kim_gdata->rx_skb =
Pavan Savoy5c88b022011-02-04 02:23:09 -0600182 alloc_skb(1024+8, GFP_ATOMIC);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500183 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;
187 return;
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500188 }
Pavan Savoy5c88b022011-02-04 02:23:09 -0600189 skb_reserve(kim_gdata->rx_skb, 8);
190 kim_gdata->rx_skb->cb[0] = 4;
191 kim_gdata->rx_skb->cb[1] = 0;
192
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500193 }
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500194 return;
195}
196
Pavan Savoy38d9df42010-07-08 08:55:17 -0500197static long read_local_version(struct kim_data_s *kim_gdata, char *bts_scr_name)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500198{
199 unsigned short version = 0, chip = 0, min_ver = 0, maj_ver = 0;
Pavan Savoy73f12e82010-10-12 16:27:38 -0400200 const char read_ver_cmd[] = { 0x01, 0x01, 0x10, 0x00 };
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500201
Pavan Savoye6d9e642010-07-22 05:32:05 -0500202 pr_debug("%s", __func__);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500203
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");
Pavan Savoy70442662011-02-04 02:23:11 -0600207 return -EIO;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500208 }
209
Pavan Savoy53702352012-08-03 14:49:42 -0500210 if (!wait_for_completion_interruptible_timeout(
211 &kim_gdata->kim_rcvd, msecs_to_jiffies(CMD_RESP_TIME))) {
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500212 pr_err(" waiting for ver info- timed out ");
Pavan Savoy70442662011-02-04 02:23:11 -0600213 return -ETIMEDOUT;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500214 }
Pavan Savoy74a4fcf2011-08-10 10:18:32 -0500215 INIT_COMPLETION(kim_gdata->kim_rcvd);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500216
217 version =
Naveen Jaine2a53282010-06-09 03:45:33 -0500218 MAKEWORD(kim_gdata->resp_buffer[13],
219 kim_gdata->resp_buffer[14]);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500220 chip = (version & 0x7C00) >> 10;
221 min_ver = (version & 0x007F);
222 maj_ver = (version & 0x0380) >> 7;
223
224 if (version & 0x8000)
225 maj_ver |= 0x0008;
226
227 sprintf(bts_scr_name, "TIInit_%d.%d.%d.bts", chip, maj_ver, min_ver);
Naveen Jaine2a53282010-06-09 03:45:33 -0500228
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;
234
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500235 pr_info("%s", bts_scr_name);
Pavan Savoy320920c2010-07-14 08:21:12 -0500236 return 0;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500237}
238
Pavan Savoy27712b32012-08-03 14:49:40 -0500239static void skip_change_remote_baud(unsigned char **ptr, long *len)
Pavan Savoyef04d122011-02-04 02:23:13 -0600240{
241 unsigned char *nxt_action, *cur_action;
242 cur_action = *ptr;
243
244 nxt_action = cur_action + sizeof(struct bts_action) +
245 ((struct bts_action *) cur_action)->size;
246
247 if (((struct bts_action *) nxt_action)->type != ACTION_WAIT_EVENT) {
248 pr_err("invalid action after change remote baud command");
249 } else {
250 *ptr = *ptr + sizeof(struct bts_action) +
Shahar Lev9d031d92011-05-23 11:36:11 +0300251 ((struct bts_action *)cur_action)->size;
Pavan Savoyef04d122011-02-04 02:23:13 -0600252 *len = *len - (sizeof(struct bts_action) +
Shahar Lev9d031d92011-05-23 11:36:11 +0300253 ((struct bts_action *)cur_action)->size);
Pavan Savoyef04d122011-02-04 02:23:13 -0600254 /* warn user on not commenting these in firmware */
255 pr_warn("skipping the wait event of change remote baud");
256 }
257}
258
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500259/**
260 * download_firmware -
261 * internal function which parses through the .bts firmware
262 * script file intreprets SEND, DELAY actions only as of now
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500263 */
Pavan Savoy38d9df42010-07-08 08:55:17 -0500264static long download_firmware(struct kim_data_s *kim_gdata)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500265{
Pavan Savoy320920c2010-07-14 08:21:12 -0500266 long err = 0;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500267 long len = 0;
Pavan Savoy73f12e82010-10-12 16:27:38 -0400268 unsigned char *ptr = NULL;
269 unsigned char *action_ptr = NULL;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500270 unsigned char bts_scr_name[30] = { 0 }; /* 30 char long bts scr name? */
Pavan Savoyef04d122011-02-04 02:23:13 -0600271 int wr_room_space;
272 int cmd_size;
273 unsigned long timeout;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500274
Pavan Savoy38d9df42010-07-08 08:55:17 -0500275 err = read_local_version(kim_gdata, bts_scr_name);
Pavan Savoy320920c2010-07-14 08:21:12 -0500276 if (err != 0) {
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500277 pr_err("kim: failed to read local ver");
278 return err;
279 }
280 err =
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,
286 bts_scr_name);
Pavan Savoy70442662011-02-04 02:23:11 -0600287 return -EINVAL;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500288 }
289 ptr = (void *)kim_gdata->fw_entry->data;
290 len = kim_gdata->fw_entry->size;
291 /* bts_header to remove out magic number and
292 * version
293 */
294 ptr += sizeof(struct bts_header);
295 len -= sizeof(struct bts_header);
296
297 while (len > 0 && ptr) {
Pavan Savoye6d9e642010-07-22 05:32:05 -0500298 pr_debug(" action size %d, type %d ",
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500299 ((struct bts_action *)ptr)->size,
300 ((struct bts_action *)ptr)->type);
301
302 switch (((struct bts_action *)ptr)->type) {
303 case ACTION_SEND_COMMAND: /* action send */
Pavan Savoy2f81a022011-08-10 10:18:34 -0500304 pr_debug("S");
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500305 action_ptr = &(((struct bts_action *)ptr)->data[0]);
306 if (unlikely
307 (((struct hci_command *)action_ptr)->opcode ==
308 0xFF36)) {
309 /* ignore remote change
310 * baud rate HCI VS command */
Pavan Savoyef04d122011-02-04 02:23:13 -0600311 pr_warn("change remote baud"
Pavan Savoye6d9e642010-07-22 05:32:05 -0500312 " rate command in firmware");
Pavan Savoyef04d122011-02-04 02:23:13 -0600313 skip_change_remote_baud(&ptr, &len);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500314 break;
315 }
Pavan Savoyef04d122011-02-04 02:23:13 -0600316 /*
317 * Make sure we have enough free space in uart
318 * tx buffer to write current firmware command
319 */
320 cmd_size = ((struct bts_action *)ptr)->size;
321 timeout = jiffies + msecs_to_jiffies(CMD_WR_TIME);
322 do {
323 wr_room_space =
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;
330 }
331 mdelay(1); /* wait 1ms before checking room */
332 } while ((wr_room_space < cmd_size) &&
333 time_before(jiffies, timeout));
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500334
Pavan Savoyef04d122011-02-04 02:23:13 -0600335 /* 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);
340 return -ETIMEDOUT;
341 }
Pavan Savoy2f81a022011-08-10 10:18:34 -0500342 /* reinit completion before sending for the
343 * relevant wait
344 */
345 INIT_COMPLETION(kim_gdata->kim_rcvd);
Pavan Savoyef04d122011-02-04 02:23:13 -0600346
347 /*
348 * Free space found in uart buffer, call st_int_write
349 * to send current firmware command to the uart tx
350 * buffer.
351 */
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500352 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);
Pavan Savoy70442662011-02-04 02:23:11 -0600357 return err;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500358 }
Pavan Savoyef04d122011-02-04 02:23:13 -0600359 /*
360 * Check number of bytes written to the uart tx buffer
361 * and requested command write size
362 */
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);
368 return -EIO;
369 }
370 break;
371 case ACTION_WAIT_EVENT: /* wait */
Pavan Savoy2f81a022011-08-10 10:18:34 -0500372 pr_debug("W");
Pavan Savoy53702352012-08-03 14:49:42 -0500373 if (!wait_for_completion_interruptible_timeout(
374 &kim_gdata->kim_rcvd,
375 msecs_to_jiffies(CMD_RESP_TIME))) {
Pavan Savoyef04d122011-02-04 02:23:13 -0600376 pr_err("response timeout during fw download ");
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500377 /* timed out */
378 release_firmware(kim_gdata->fw_entry);
Pavan Savoy70442662011-02-04 02:23:11 -0600379 return -ETIMEDOUT;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500380 }
Pavan Savoyef04d122011-02-04 02:23:13 -0600381 INIT_COMPLETION(kim_gdata->kim_rcvd);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500382 break;
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);
387 break;
388 }
389 len =
390 len - (sizeof(struct bts_action) +
391 ((struct bts_action *)ptr)->size);
392 ptr =
393 ptr + sizeof(struct bts_action) +
394 ((struct bts_action *)ptr)->size;
395 }
396 /* fw download complete */
397 release_firmware(kim_gdata->fw_entry);
Pavan Savoy320920c2010-07-14 08:21:12 -0500398 return 0;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500399}
400
401/**********************************************************************/
402/* functions called from ST core */
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500403/* called from ST Core, when REG_IN_PROGRESS (registration in progress)
404 * can be because of
405 * 1. response to read local version
406 * 2. during send/recv's of firmware download
407 */
408void st_kim_recv(void *disc_data, const unsigned char *data, long count)
409{
Pavan Savoy38d9df42010-07-08 08:55:17 -0500410 struct st_data_s *st_gdata = (struct st_data_s *)disc_data;
411 struct kim_data_s *kim_gdata = st_gdata->kim_data;
412
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500413 /* 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);
418 return;
419 } else {
Pavan Savoy38d9df42010-07-08 08:55:17 -0500420 kim_int_recv(kim_gdata, data, count);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500421 /* either completes or times out */
422 }
423 return;
424}
425
426/* to signal completion of line discipline installation
427 * called from ST Core, upon tty_open
428 */
Pavan Savoy38d9df42010-07-08 08:55:17 -0500429void st_kim_complete(void *kim_data)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500430{
Pavan Savoy38d9df42010-07-08 08:55:17 -0500431 struct kim_data_s *kim_gdata = (struct kim_data_s *)kim_data;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500432 complete(&kim_gdata->ldisc_installed);
433}
434
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500435/**
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).
441 */
Pavan Savoy38d9df42010-07-08 08:55:17 -0500442long st_kim_start(void *kim_data)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500443{
Pavan Savoy320920c2010-07-14 08:21:12 -0500444 long err = 0;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500445 long retry = POR_RETRY_COUNT;
Pavan Savoy0d7c5f22011-08-10 10:18:31 -0500446 struct ti_st_plat_data *pdata;
Pavan Savoy38d9df42010-07-08 08:55:17 -0500447 struct kim_data_s *kim_gdata = (struct kim_data_s *)kim_data;
448
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500449 pr_info(" %s", __func__);
Pavan Savoy0d7c5f22011-08-10 10:18:31 -0500450 pdata = kim_gdata->kim_pdev->dev.platform_data;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500451
452 do {
Pavan Savoy0d7c5f22011-08-10 10:18:31 -0500453 /* platform specific enabling code here */
454 if (pdata->chip_enable)
455 pdata->chip_enable(kim_gdata);
456
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500457 /* re-initialize the completion */
458 INIT_COMPLETION(kim_gdata->ldisc_installed);
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600459 /* 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,
463 NULL, "install");
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500464 /* wait for ldisc to be installed */
Pavan Savoy53702352012-08-03 14:49:42 -0500465 err = wait_for_completion_interruptible_timeout(
466 &kim_gdata->ldisc_installed, msecs_to_jiffies(LDISC_TIME));
Pavan Savoy18ccecf2011-12-15 10:38:21 -0600467 if (!err) {
468 /* ldisc installation timeout,
469 * flush uart, power cycle BT_EN */
470 pr_err("ldisc installation timeout");
471 err = st_kim_stop(kim_gdata);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500472 continue;
473 } else {
474 /* ldisc installed now */
Pavan Savoy18ccecf2011-12-15 10:38:21 -0600475 pr_info("line discipline installed");
Pavan Savoy38d9df42010-07-08 08:55:17 -0500476 err = download_firmware(kim_gdata);
Pavan Savoy320920c2010-07-14 08:21:12 -0500477 if (err != 0) {
Pavan Savoy18ccecf2011-12-15 10:38:21 -0600478 /* ldisc installed but fw download failed,
479 * flush uart & power cycle BT_EN */
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500480 pr_err("download firmware failed");
Pavan Savoy18ccecf2011-12-15 10:38:21 -0600481 err = st_kim_stop(kim_gdata);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500482 continue;
483 } else { /* on success don't retry */
484 break;
485 }
486 }
487 } while (retry--);
488 return err;
489}
490
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500491/**
Pavan Savoy18ccecf2011-12-15 10:38:21 -0600492 * 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.
Pavan Savoyeccf2972012-08-03 14:49:39 -0500498 * (c) invoke platform's chip disabling routine.
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500499 */
Pavan Savoy38d9df42010-07-08 08:55:17 -0500500long st_kim_stop(void *kim_data)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500501{
Pavan Savoy320920c2010-07-14 08:21:12 -0500502 long err = 0;
Pavan Savoy38d9df42010-07-08 08:55:17 -0500503 struct kim_data_s *kim_gdata = (struct kim_data_s *)kim_data;
Pavan Savoy0d7c5f22011-08-10 10:18:31 -0500504 struct ti_st_plat_data *pdata =
505 kim_gdata->kim_pdev->dev.platform_data;
Pavan Savoy18ccecf2011-12-15 10:38:21 -0600506 struct tty_struct *tty = kim_gdata->core_data->tty;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500507
508 INIT_COMPLETION(kim_gdata->ldisc_installed);
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600509
Pavan Savoy18ccecf2011-12-15 10:38:21 -0600510 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);
515 }
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600516
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");
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500521
522 /* wait for ldisc to be un-installed */
Pavan Savoy53702352012-08-03 14:49:42 -0500523 err = wait_for_completion_interruptible_timeout(
524 &kim_gdata->ldisc_installed, msecs_to_jiffies(LDISC_TIME));
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500525 if (!err) { /* timeout */
526 pr_err(" timed out waiting for ldisc to be un-installed");
Pavan Savoyb64365a2012-08-03 14:49:41 -0500527 err = -ETIMEDOUT;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500528 }
529
Pavan Savoy0d7c5f22011-08-10 10:18:31 -0500530 /* platform specific disable */
531 if (pdata->chip_disable)
532 pdata->chip_disable(kim_gdata);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500533 return err;
534}
535
536/**********************************************************************/
537/* functions called from subsystems */
Pavan Savoyc1afac12010-07-28 02:25:59 -0500538/* called when debugfs entry is read from */
Naveen Jaine2a53282010-06-09 03:45:33 -0500539
Pavan Savoyc1afac12010-07-28 02:25:59 -0500540static int show_version(struct seq_file *s, void *unused)
Naveen Jaine2a53282010-06-09 03:45:33 -0500541{
Pavan Savoyc1afac12010-07-28 02:25:59 -0500542 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,
Naveen Jaine2a53282010-06-09 03:45:33 -0500544 kim_gdata->version.chip, kim_gdata->version.maj_ver,
545 kim_gdata->version.min_ver);
Pavan Savoyc1afac12010-07-28 02:25:59 -0500546 return 0;
Naveen Jaine2a53282010-06-09 03:45:33 -0500547}
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500548
Pavan Savoyc1afac12010-07-28 02:25:59 -0500549static int show_list(struct seq_file *s, void *unused)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500550{
Pavan Savoyc1afac12010-07-28 02:25:59 -0500551 struct kim_data_s *kim_gdata = (struct kim_data_s *)s->private;
552 kim_st_list_protocols(kim_gdata->core_data, s);
553 return 0;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500554}
555
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600556static ssize_t show_install(struct device *dev,
557 struct device_attribute *attr, char *buf)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500558{
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600559 struct kim_data_s *kim_data = dev_get_drvdata(dev);
560 return sprintf(buf, "%d\n", kim_data->ldisc_install);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500561}
562
Pavan Savoy933aae52011-12-15 10:38:22 -0600563#ifdef DEBUG
564static ssize_t store_dev_name(struct device *dev,
565 struct device_attribute *attr, const char *buf, size_t count)
566{
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);
571 return count;
572}
573
574static ssize_t store_baud_rate(struct device *dev,
575 struct device_attribute *attr, const char *buf, size_t count)
576{
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);
581 return count;
582}
583#endif /* if DEBUG */
584
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600585static ssize_t show_dev_name(struct device *dev,
586 struct device_attribute *attr, char *buf)
587{
588 struct kim_data_s *kim_data = dev_get_drvdata(dev);
589 return sprintf(buf, "%s\n", kim_data->dev_name);
590}
591
592static ssize_t show_baud_rate(struct device *dev,
593 struct device_attribute *attr, char *buf)
594{
595 struct kim_data_s *kim_data = dev_get_drvdata(dev);
596 return sprintf(buf, "%ld\n", kim_data->baud_rate);
597}
598
599static ssize_t show_flow_cntrl(struct device *dev,
600 struct device_attribute *attr, char *buf)
601{
602 struct kim_data_s *kim_data = dev_get_drvdata(dev);
603 return sprintf(buf, "%d\n", kim_data->flow_cntrl);
604}
605
606/* structures specific for sysfs entries */
607static struct kobj_attribute ldisc_install =
608__ATTR(install, 0444, (void *)show_install, NULL);
609
610static struct kobj_attribute uart_dev_name =
Pavan Savoy933aae52011-12-15 10:38:22 -0600611#ifdef DEBUG /* TODO: move this to debug-fs if possible */
612__ATTR(dev_name, 0644, (void *)show_dev_name, (void *)store_dev_name);
613#else
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600614__ATTR(dev_name, 0444, (void *)show_dev_name, NULL);
Pavan Savoy933aae52011-12-15 10:38:22 -0600615#endif
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600616
617static struct kobj_attribute uart_baud_rate =
Pavan Savoy933aae52011-12-15 10:38:22 -0600618#ifdef DEBUG /* TODO: move to debugfs */
619__ATTR(baud_rate, 0644, (void *)show_baud_rate, (void *)store_baud_rate);
620#else
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600621__ATTR(baud_rate, 0444, (void *)show_baud_rate, NULL);
Pavan Savoy933aae52011-12-15 10:38:22 -0600622#endif
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600623
624static struct kobj_attribute uart_flow_cntrl =
625__ATTR(flow_cntrl, 0444, (void *)show_flow_cntrl, NULL);
626
627static struct attribute *uim_attrs[] = {
628 &ldisc_install.attr,
629 &uart_dev_name.attr,
630 &uart_baud_rate.attr,
631 &uart_flow_cntrl.attr,
632 NULL,
633};
634
635static struct attribute_group uim_attr_grp = {
636 .attrs = uim_attrs,
637};
638
Pavan Savoy36b5aee2010-07-22 05:32:06 -0500639/**
640 * st_kim_ref - reference the core's data
641 * This references the per-ST platform device in the arch/xx/
642 * board-xx.c file.
643 * This would enable multiple such platform devices to exist
644 * on a given platform
645 */
Pavan Savoydbd3a872010-08-19 14:08:51 -0400646void st_kim_ref(struct st_data_s **core_data, int id)
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500647{
Pavan Savoy38d9df42010-07-08 08:55:17 -0500648 struct platform_device *pdev;
649 struct kim_data_s *kim_gdata;
650 /* get kim_gdata reference from platform device */
Pavan Savoydbd3a872010-08-19 14:08:51 -0400651 pdev = st_get_plat_device(id);
Steven Rostedt7316a9f2011-05-23 16:45:32 -0400652 if (!pdev) {
653 *core_data = NULL;
654 return;
655 }
Pavan Savoy38d9df42010-07-08 08:55:17 -0500656 kim_gdata = dev_get_drvdata(&pdev->dev);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500657 *core_data = kim_gdata->core_data;
658}
659
Pavan Savoyc1afac12010-07-28 02:25:59 -0500660static int kim_version_open(struct inode *i, struct file *f)
661{
662 return single_open(f, show_version, i->i_private);
663}
664
665static int kim_list_open(struct inode *i, struct file *f)
666{
667 return single_open(f, show_list, i->i_private);
668}
669
670static const struct file_operations version_debugfs_fops = {
671 /* version info */
672 .open = kim_version_open,
673 .read = seq_read,
674 .llseek = seq_lseek,
675 .release = single_release,
676};
677static const struct file_operations list_debugfs_fops = {
678 /* protocols info */
679 .open = kim_list_open,
680 .read = seq_read,
681 .llseek = seq_lseek,
682 .release = single_release,
683};
684
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500685/**********************************************************************/
686/* functions called from platform device driver subsystem
687 * need to have a relevant platform device entry in the platform's
688 * board-*.c file
689 */
690
Pavan Savoy27712b32012-08-03 14:49:40 -0500691static struct dentry *kim_debugfs_dir;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500692static int kim_probe(struct platform_device *pdev)
693{
694 long status;
Pavan Savoy38d9df42010-07-08 08:55:17 -0500695 struct kim_data_s *kim_gdata;
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600696 struct ti_st_plat_data *pdata = pdev->dev.platform_data;
Pavan Savoy38d9df42010-07-08 08:55:17 -0500697
Pavan Savoydfb7ef72010-09-10 15:58:55 -0400698 if ((pdev->id != -1) && (pdev->id < MAX_ST_DEVICES)) {
699 /* multiple devices could exist */
700 st_kim_devices[pdev->id] = pdev;
701 } else {
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300702 /* platform's sure about existence of 1 device */
Pavan Savoydfb7ef72010-09-10 15:58:55 -0400703 st_kim_devices[0] = pdev;
704 }
705
Pavan Savoy38d9df42010-07-08 08:55:17 -0500706 kim_gdata = kzalloc(sizeof(struct kim_data_s), GFP_ATOMIC);
707 if (!kim_gdata) {
708 pr_err("no mem to allocate");
709 return -ENOMEM;
710 }
711 dev_set_drvdata(&pdev->dev, kim_gdata);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500712
713 status = st_core_init(&kim_gdata->core_data);
714 if (status != 0) {
715 pr_err(" ST core init failed");
Pavan Savoy70442662011-02-04 02:23:11 -0600716 return -EIO;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500717 }
Pavan Savoy38d9df42010-07-08 08:55:17 -0500718 /* refer to itself */
719 kim_gdata->core_data->kim_data = kim_gdata;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500720
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500721 /* get reference of pdev for request_firmware
722 */
723 kim_gdata->kim_pdev = pdev;
724 init_completion(&kim_gdata->kim_rcvd);
725 init_completion(&kim_gdata->ldisc_installed);
Naveen Jainb38fc2d2010-06-09 03:45:32 -0500726
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600727 status = sysfs_create_group(&pdev->dev.kobj, &uim_attr_grp);
728 if (status) {
729 pr_err("failed to create sysfs entries");
730 return status;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500731 }
Naveen Jaine2a53282010-06-09 03:45:33 -0500732
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600733 /* 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");
738
Pavan Savoyc1afac12010-07-28 02:25:59 -0500739 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;
Pavan Savoy70442662011-02-04 02:23:11 -0600743 return -EIO;
Naveen Jaine2a53282010-06-09 03:45:33 -0500744 }
Pavan Savoyc1afac12010-07-28 02:25:59 -0500745
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 ");
Pavan Savoy320920c2010-07-14 08:21:12 -0500751 return 0;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500752}
753
754static int kim_remove(struct platform_device *pdev)
755{
Pavan Savoy38d9df42010-07-08 08:55:17 -0500756 struct kim_data_s *kim_gdata;
757
758 kim_gdata = dev_get_drvdata(&pdev->dev);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500759
Pavan Savoy781a7392011-02-04 02:23:15 -0600760 debugfs_remove_recursive(kim_debugfs_dir);
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600761 sysfs_remove_group(&pdev->dev.kobj, &uim_attr_grp);
Pavan Savoy781a7392011-02-04 02:23:15 -0600762 pr_info("sysfs entries removed");
763
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500764 kim_gdata->kim_pdev = NULL;
765 st_core_exit(kim_gdata->core_data);
Pavan Savoy38d9df42010-07-08 08:55:17 -0500766
767 kfree(kim_gdata);
768 kim_gdata = NULL;
Pavan Savoy320920c2010-07-14 08:21:12 -0500769 return 0;
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500770}
771
Pavan Savoy27712b32012-08-03 14:49:40 -0500772static int kim_suspend(struct platform_device *pdev, pm_message_t state)
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600773{
774 struct ti_st_plat_data *pdata = pdev->dev.platform_data;
775
776 if (pdata->suspend)
777 return pdata->suspend(pdev, state);
778
779 return -EOPNOTSUPP;
780}
781
Pavan Savoy27712b32012-08-03 14:49:40 -0500782static int kim_resume(struct platform_device *pdev)
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600783{
784 struct ti_st_plat_data *pdata = pdev->dev.platform_data;
785
786 if (pdata->resume)
787 return pdata->resume(pdev);
788
789 return -EOPNOTSUPP;
790}
791
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500792/**********************************************************************/
793/* entry point for ST KIM module, called in from ST Core */
Pavan Savoyec60d0a2011-02-04 02:23:10 -0600794static struct platform_driver kim_platform_driver = {
795 .probe = kim_probe,
796 .remove = kim_remove,
797 .suspend = kim_suspend,
798 .resume = kim_resume,
799 .driver = {
800 .name = "kim",
801 .owner = THIS_MODULE,
802 },
803};
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500804
Axel Linb00e1262012-01-22 15:33:49 +0800805module_platform_driver(kim_platform_driver);
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500806
Pavan Savoyd0088ce2010-04-08 13:16:54 -0500807MODULE_AUTHOR("Pavan Savoy <pavan_savoy@ti.com>");
808MODULE_DESCRIPTION("Shared Transport Driver for TI BT/FM/GPS combo chips ");
809MODULE_LICENSE("GPL");