Loading...
1/*
2 * Shared Transport Line discipline driver Core
3 * This hooks up ST KIM driver and ST LL driver
4 * Copyright (C) 2009-2010 Texas Instruments
5 * Author: Pavan Savoy <pavan_savoy@ti.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 */
21
22#define pr_fmt(fmt) "(stc): " fmt
23#include <linux/module.h>
24#include <linux/kernel.h>
25#include <linux/init.h>
26#include <linux/tty.h>
27
28#include <linux/seq_file.h>
29#include <linux/skbuff.h>
30
31#include <linux/ti_wilink_st.h>
32
33/* function pointer pointing to either,
34 * st_kim_recv during registration to receive fw download responses
35 * st_int_recv after registration to receive proto stack responses
36 */
37void (*st_recv) (void*, const unsigned char*, long);
38
39/********************************************************************/
40static void add_channel_to_table(struct st_data_s *st_gdata,
41 struct st_proto_s *new_proto)
42{
43 pr_info("%s: id %d\n", __func__, new_proto->chnl_id);
44 /* list now has the channel id as index itself */
45 st_gdata->list[new_proto->chnl_id] = new_proto;
46 st_gdata->is_registered[new_proto->chnl_id] = true;
47}
48
49static void remove_channel_from_table(struct st_data_s *st_gdata,
50 struct st_proto_s *proto)
51{
52 pr_info("%s: id %d\n", __func__, proto->chnl_id);
53/* st_gdata->list[proto->chnl_id] = NULL; */
54 st_gdata->is_registered[proto->chnl_id] = false;
55}
56
57/*
58 * called from KIM during firmware download.
59 *
60 * This is a wrapper function to tty->ops->write_room.
61 * It returns number of free space available in
62 * uart tx buffer.
63 */
64int st_get_uart_wr_room(struct st_data_s *st_gdata)
65{
66 struct tty_struct *tty;
67 if (unlikely(st_gdata == NULL || st_gdata->tty == NULL)) {
68 pr_err("tty unavailable to perform write");
69 return -1;
70 }
71 tty = st_gdata->tty;
72 return tty->ops->write_room(tty);
73}
74
75/* can be called in from
76 * -- KIM (during fw download)
77 * -- ST Core (during st_write)
78 *
79 * This is the internal write function - a wrapper
80 * to tty->ops->write
81 */
82int st_int_write(struct st_data_s *st_gdata,
83 const unsigned char *data, int count)
84{
85 struct tty_struct *tty;
86 if (unlikely(st_gdata == NULL || st_gdata->tty == NULL)) {
87 pr_err("tty unavailable to perform write");
88 return -EINVAL;
89 }
90 tty = st_gdata->tty;
91#ifdef VERBOSE
92 print_hex_dump(KERN_DEBUG, "<out<", DUMP_PREFIX_NONE,
93 16, 1, data, count, 0);
94#endif
95 return tty->ops->write(tty, data, count);
96
97}
98
99/*
100 * push the skb received to relevant
101 * protocol stacks
102 */
103void st_send_frame(unsigned char chnl_id, struct st_data_s *st_gdata)
104{
105 pr_debug(" %s(prot:%d) ", __func__, chnl_id);
106
107 if (unlikely
108 (st_gdata == NULL || st_gdata->rx_skb == NULL
109 || st_gdata->is_registered[chnl_id] == false)) {
110 pr_err("chnl_id %d not registered, no data to send?",
111 chnl_id);
112 kfree_skb(st_gdata->rx_skb);
113 return;
114 }
115 /* this cannot fail
116 * this shouldn't take long
117 * - should be just skb_queue_tail for the
118 * protocol stack driver
119 */
120 if (likely(st_gdata->list[chnl_id]->recv != NULL)) {
121 if (unlikely
122 (st_gdata->list[chnl_id]->recv
123 (st_gdata->list[chnl_id]->priv_data, st_gdata->rx_skb)
124 != 0)) {
125 pr_err(" proto stack %d's ->recv failed", chnl_id);
126 kfree_skb(st_gdata->rx_skb);
127 return;
128 }
129 } else {
130 pr_err(" proto stack %d's ->recv null", chnl_id);
131 kfree_skb(st_gdata->rx_skb);
132 }
133 return;
134}
135
136/**
137 * st_reg_complete -
138 * to call registration complete callbacks
139 * of all protocol stack drivers
140 */
141void st_reg_complete(struct st_data_s *st_gdata, char err)
142{
143 unsigned char i = 0;
144 pr_info(" %s ", __func__);
145 for (i = 0; i < ST_MAX_CHANNELS; i++) {
146 if (likely(st_gdata != NULL &&
147 st_gdata->is_registered[i] == true &&
148 st_gdata->list[i]->reg_complete_cb != NULL)) {
149 st_gdata->list[i]->reg_complete_cb
150 (st_gdata->list[i]->priv_data, err);
151 pr_info("protocol %d's cb sent %d\n", i, err);
152 if (err) { /* cleanup registered protocol */
153 st_gdata->protos_registered--;
154 st_gdata->is_registered[i] = false;
155 }
156 }
157 }
158}
159
160static inline int st_check_data_len(struct st_data_s *st_gdata,
161 unsigned char chnl_id, int len)
162{
163 int room = skb_tailroom(st_gdata->rx_skb);
164
165 pr_debug("len %d room %d", len, room);
166
167 if (!len) {
168 /* Received packet has only packet header and
169 * has zero length payload. So, ask ST CORE to
170 * forward the packet to protocol driver (BT/FM/GPS)
171 */
172 st_send_frame(chnl_id, st_gdata);
173
174 } else if (len > room) {
175 /* Received packet's payload length is larger.
176 * We can't accommodate it in created skb.
177 */
178 pr_err("Data length is too large len %d room %d", len,
179 room);
180 kfree_skb(st_gdata->rx_skb);
181 } else {
182 /* Packet header has non-zero payload length and
183 * we have enough space in created skb. Lets read
184 * payload data */
185 st_gdata->rx_state = ST_W4_DATA;
186 st_gdata->rx_count = len;
187 return len;
188 }
189
190 /* Change ST state to continue to process next
191 * packet */
192 st_gdata->rx_state = ST_W4_PACKET_TYPE;
193 st_gdata->rx_skb = NULL;
194 st_gdata->rx_count = 0;
195 st_gdata->rx_chnl = 0;
196
197 return 0;
198}
199
200/**
201 * st_wakeup_ack - internal function for action when wake-up ack
202 * received
203 */
204static inline void st_wakeup_ack(struct st_data_s *st_gdata,
205 unsigned char cmd)
206{
207 struct sk_buff *waiting_skb;
208 unsigned long flags = 0;
209
210 spin_lock_irqsave(&st_gdata->lock, flags);
211 /* de-Q from waitQ and Q in txQ now that the
212 * chip is awake
213 */
214 while ((waiting_skb = skb_dequeue(&st_gdata->tx_waitq)))
215 skb_queue_tail(&st_gdata->txq, waiting_skb);
216
217 /* state forwarded to ST LL */
218 st_ll_sleep_state(st_gdata, (unsigned long)cmd);
219 spin_unlock_irqrestore(&st_gdata->lock, flags);
220
221 /* wake up to send the recently copied skbs from waitQ */
222 st_tx_wakeup(st_gdata);
223}
224
225/**
226 * st_int_recv - ST's internal receive function.
227 * Decodes received RAW data and forwards to corresponding
228 * client drivers (Bluetooth,FM,GPS..etc).
229 * This can receive various types of packets,
230 * HCI-Events, ACL, SCO, 4 types of HCI-LL PM packets
231 * CH-8 packets from FM, CH-9 packets from GPS cores.
232 */
233void st_int_recv(void *disc_data,
234 const unsigned char *data, long count)
235{
236 char *ptr;
237 struct st_proto_s *proto;
238 unsigned short payload_len = 0;
239 int len = 0, type = 0;
240 unsigned char *plen;
241 struct st_data_s *st_gdata = (struct st_data_s *)disc_data;
242 unsigned long flags;
243
244 ptr = (char *)data;
245 /* tty_receive sent null ? */
246 if (unlikely(ptr == NULL) || (st_gdata == NULL)) {
247 pr_err(" received null from TTY ");
248 return;
249 }
250
251 pr_debug("count %ld rx_state %ld"
252 "rx_count %ld", count, st_gdata->rx_state,
253 st_gdata->rx_count);
254
255 spin_lock_irqsave(&st_gdata->lock, flags);
256 /* Decode received bytes here */
257 while (count) {
258 if (st_gdata->rx_count) {
259 len = min_t(unsigned int, st_gdata->rx_count, count);
260 memcpy(skb_put(st_gdata->rx_skb, len), ptr, len);
261 st_gdata->rx_count -= len;
262 count -= len;
263 ptr += len;
264
265 if (st_gdata->rx_count)
266 continue;
267
268 /* Check ST RX state machine , where are we? */
269 switch (st_gdata->rx_state) {
270 /* Waiting for complete packet ? */
271 case ST_W4_DATA:
272 pr_debug("Complete pkt received");
273 /* Ask ST CORE to forward
274 * the packet to protocol driver */
275 st_send_frame(st_gdata->rx_chnl, st_gdata);
276
277 st_gdata->rx_state = ST_W4_PACKET_TYPE;
278 st_gdata->rx_skb = NULL;
279 continue;
280 /* parse the header to know details */
281 case ST_W4_HEADER:
282 proto = st_gdata->list[st_gdata->rx_chnl];
283 plen =
284 &st_gdata->rx_skb->data
285 [proto->offset_len_in_hdr];
286 pr_debug("plen pointing to %x\n", *plen);
287 if (proto->len_size == 1)/* 1 byte len field */
288 payload_len = *(unsigned char *)plen;
289 else if (proto->len_size == 2)
290 payload_len =
291 __le16_to_cpu(*(unsigned short *)plen);
292 else
293 pr_info("%s: invalid length "
294 "for id %d\n",
295 __func__, proto->chnl_id);
296 st_check_data_len(st_gdata, proto->chnl_id,
297 payload_len);
298 pr_debug("off %d, pay len %d\n",
299 proto->offset_len_in_hdr, payload_len);
300 continue;
301 } /* end of switch rx_state */
302 }
303
304 /* end of if rx_count */
305 /* Check first byte of packet and identify module
306 * owner (BT/FM/GPS) */
307 switch (*ptr) {
308 case LL_SLEEP_IND:
309 case LL_SLEEP_ACK:
310 case LL_WAKE_UP_IND:
311 pr_debug("PM packet");
312 /* this takes appropriate action based on
313 * sleep state received --
314 */
315 st_ll_sleep_state(st_gdata, *ptr);
316 /* if WAKEUP_IND collides copy from waitq to txq
317 * and assume chip awake
318 */
319 spin_unlock_irqrestore(&st_gdata->lock, flags);
320 if (st_ll_getstate(st_gdata) == ST_LL_AWAKE)
321 st_wakeup_ack(st_gdata, LL_WAKE_UP_ACK);
322 spin_lock_irqsave(&st_gdata->lock, flags);
323
324 ptr++;
325 count--;
326 continue;
327 case LL_WAKE_UP_ACK:
328 pr_debug("PM packet");
329
330 spin_unlock_irqrestore(&st_gdata->lock, flags);
331 /* wake up ack received */
332 st_wakeup_ack(st_gdata, *ptr);
333 spin_lock_irqsave(&st_gdata->lock, flags);
334
335 ptr++;
336 count--;
337 continue;
338 /* Unknow packet? */
339 default:
340 type = *ptr;
341 if (st_gdata->list[type] == NULL) {
342 pr_err("chip/interface misbehavior dropping"
343 " frame starting with 0x%02x", type);
344 goto done;
345
346 }
347 st_gdata->rx_skb = alloc_skb(
348 st_gdata->list[type]->max_frame_size,
349 GFP_ATOMIC);
350 skb_reserve(st_gdata->rx_skb,
351 st_gdata->list[type]->reserve);
352 /* next 2 required for BT only */
353 st_gdata->rx_skb->cb[0] = type; /*pkt_type*/
354 st_gdata->rx_skb->cb[1] = 0; /*incoming*/
355 st_gdata->rx_chnl = *ptr;
356 st_gdata->rx_state = ST_W4_HEADER;
357 st_gdata->rx_count = st_gdata->list[type]->hdr_len;
358 pr_debug("rx_count %ld\n", st_gdata->rx_count);
359 };
360 ptr++;
361 count--;
362 }
363done:
364 spin_unlock_irqrestore(&st_gdata->lock, flags);
365 pr_debug("done %s", __func__);
366 return;
367}
368
369/**
370 * st_int_dequeue - internal de-Q function.
371 * If the previous data set was not written
372 * completely, return that skb which has the pending data.
373 * In normal cases, return top of txq.
374 */
375struct sk_buff *st_int_dequeue(struct st_data_s *st_gdata)
376{
377 struct sk_buff *returning_skb;
378
379 pr_debug("%s", __func__);
380 if (st_gdata->tx_skb != NULL) {
381 returning_skb = st_gdata->tx_skb;
382 st_gdata->tx_skb = NULL;
383 return returning_skb;
384 }
385 return skb_dequeue(&st_gdata->txq);
386}
387
388/**
389 * st_int_enqueue - internal Q-ing function.
390 * Will either Q the skb to txq or the tx_waitq
391 * depending on the ST LL state.
392 * If the chip is asleep, then Q it onto waitq and
393 * wakeup the chip.
394 * txq and waitq needs protection since the other contexts
395 * may be sending data, waking up chip.
396 */
397void st_int_enqueue(struct st_data_s *st_gdata, struct sk_buff *skb)
398{
399 unsigned long flags = 0;
400
401 pr_debug("%s", __func__);
402 spin_lock_irqsave(&st_gdata->lock, flags);
403
404 switch (st_ll_getstate(st_gdata)) {
405 case ST_LL_AWAKE:
406 pr_debug("ST LL is AWAKE, sending normally");
407 skb_queue_tail(&st_gdata->txq, skb);
408 break;
409 case ST_LL_ASLEEP_TO_AWAKE:
410 skb_queue_tail(&st_gdata->tx_waitq, skb);
411 break;
412 case ST_LL_AWAKE_TO_ASLEEP:
413 pr_err("ST LL is illegal state(%ld),"
414 "purging received skb.", st_ll_getstate(st_gdata));
415 kfree_skb(skb);
416 break;
417 case ST_LL_ASLEEP:
418 skb_queue_tail(&st_gdata->tx_waitq, skb);
419 st_ll_wakeup(st_gdata);
420 break;
421 default:
422 pr_err("ST LL is illegal state(%ld),"
423 "purging received skb.", st_ll_getstate(st_gdata));
424 kfree_skb(skb);
425 break;
426 }
427
428 spin_unlock_irqrestore(&st_gdata->lock, flags);
429 pr_debug("done %s", __func__);
430 return;
431}
432
433/*
434 * internal wakeup function
435 * called from either
436 * - TTY layer when write's finished
437 * - st_write (in context of the protocol stack)
438 */
439void st_tx_wakeup(struct st_data_s *st_data)
440{
441 struct sk_buff *skb;
442 unsigned long flags; /* for irq save flags */
443 pr_debug("%s", __func__);
444 /* check for sending & set flag sending here */
445 if (test_and_set_bit(ST_TX_SENDING, &st_data->tx_state)) {
446 pr_debug("ST already sending");
447 /* keep sending */
448 set_bit(ST_TX_WAKEUP, &st_data->tx_state);
449 return;
450 /* TX_WAKEUP will be checked in another
451 * context
452 */
453 }
454 do { /* come back if st_tx_wakeup is set */
455 /* woke-up to write */
456 clear_bit(ST_TX_WAKEUP, &st_data->tx_state);
457 while ((skb = st_int_dequeue(st_data))) {
458 int len;
459 spin_lock_irqsave(&st_data->lock, flags);
460 /* enable wake-up from TTY */
461 set_bit(TTY_DO_WRITE_WAKEUP, &st_data->tty->flags);
462 len = st_int_write(st_data, skb->data, skb->len);
463 skb_pull(skb, len);
464 /* if skb->len = len as expected, skb->len=0 */
465 if (skb->len) {
466 /* would be the next skb to be sent */
467 st_data->tx_skb = skb;
468 spin_unlock_irqrestore(&st_data->lock, flags);
469 break;
470 }
471 kfree_skb(skb);
472 spin_unlock_irqrestore(&st_data->lock, flags);
473 }
474 /* if wake-up is set in another context- restart sending */
475 } while (test_bit(ST_TX_WAKEUP, &st_data->tx_state));
476
477 /* clear flag sending */
478 clear_bit(ST_TX_SENDING, &st_data->tx_state);
479}
480
481/********************************************************************/
482/* functions called from ST KIM
483*/
484void kim_st_list_protocols(struct st_data_s *st_gdata, void *buf)
485{
486 seq_printf(buf, "[%d]\nBT=%c\nFM=%c\nGPS=%c\n",
487 st_gdata->protos_registered,
488 st_gdata->is_registered[0x04] == true ? 'R' : 'U',
489 st_gdata->is_registered[0x08] == true ? 'R' : 'U',
490 st_gdata->is_registered[0x09] == true ? 'R' : 'U');
491}
492
493/********************************************************************/
494/*
495 * functions called from protocol stack drivers
496 * to be EXPORT-ed
497 */
498long st_register(struct st_proto_s *new_proto)
499{
500 struct st_data_s *st_gdata;
501 long err = 0;
502 unsigned long flags = 0;
503
504 st_kim_ref(&st_gdata, 0);
505 pr_info("%s(%d) ", __func__, new_proto->chnl_id);
506 if (st_gdata == NULL || new_proto == NULL || new_proto->recv == NULL
507 || new_proto->reg_complete_cb == NULL) {
508 pr_err("gdata/new_proto/recv or reg_complete_cb not ready");
509 return -EINVAL;
510 }
511
512 if (new_proto->chnl_id >= ST_MAX_CHANNELS) {
513 pr_err("chnl_id %d not supported", new_proto->chnl_id);
514 return -EPROTONOSUPPORT;
515 }
516
517 if (st_gdata->is_registered[new_proto->chnl_id] == true) {
518 pr_err("chnl_id %d already registered", new_proto->chnl_id);
519 return -EALREADY;
520 }
521
522 /* can be from process context only */
523 spin_lock_irqsave(&st_gdata->lock, flags);
524
525 if (test_bit(ST_REG_IN_PROGRESS, &st_gdata->st_state)) {
526 pr_info(" ST_REG_IN_PROGRESS:%d ", new_proto->chnl_id);
527 /* fw download in progress */
528
529 add_channel_to_table(st_gdata, new_proto);
530 st_gdata->protos_registered++;
531 new_proto->write = st_write;
532
533 set_bit(ST_REG_PENDING, &st_gdata->st_state);
534 spin_unlock_irqrestore(&st_gdata->lock, flags);
535 return -EINPROGRESS;
536 } else if (st_gdata->protos_registered == ST_EMPTY) {
537 pr_info(" chnl_id list empty :%d ", new_proto->chnl_id);
538 set_bit(ST_REG_IN_PROGRESS, &st_gdata->st_state);
539 st_recv = st_kim_recv;
540
541 /* release lock previously held - re-locked below */
542 spin_unlock_irqrestore(&st_gdata->lock, flags);
543
544 /* enable the ST LL - to set default chip state */
545 st_ll_enable(st_gdata);
546 /* this may take a while to complete
547 * since it involves BT fw download
548 */
549 err = st_kim_start(st_gdata->kim_data);
550 if (err != 0) {
551 clear_bit(ST_REG_IN_PROGRESS, &st_gdata->st_state);
552 if ((st_gdata->protos_registered != ST_EMPTY) &&
553 (test_bit(ST_REG_PENDING, &st_gdata->st_state))) {
554 pr_err(" KIM failure complete callback ");
555 st_reg_complete(st_gdata, err);
556 }
557 return -EINVAL;
558 }
559
560 clear_bit(ST_REG_IN_PROGRESS, &st_gdata->st_state);
561 st_recv = st_int_recv;
562
563 /* this is where all pending registration
564 * are signalled to be complete by calling callback functions
565 */
566 if ((st_gdata->protos_registered != ST_EMPTY) &&
567 (test_bit(ST_REG_PENDING, &st_gdata->st_state))) {
568 pr_debug(" call reg complete callback ");
569 st_reg_complete(st_gdata, 0);
570 }
571 clear_bit(ST_REG_PENDING, &st_gdata->st_state);
572
573 /* check for already registered once more,
574 * since the above check is old
575 */
576 if (st_gdata->is_registered[new_proto->chnl_id] == true) {
577 pr_err(" proto %d already registered ",
578 new_proto->chnl_id);
579 return -EALREADY;
580 }
581
582 spin_lock_irqsave(&st_gdata->lock, flags);
583 add_channel_to_table(st_gdata, new_proto);
584 st_gdata->protos_registered++;
585 new_proto->write = st_write;
586 spin_unlock_irqrestore(&st_gdata->lock, flags);
587 return err;
588 }
589 /* if fw is already downloaded & new stack registers protocol */
590 else {
591 add_channel_to_table(st_gdata, new_proto);
592 st_gdata->protos_registered++;
593 new_proto->write = st_write;
594
595 /* lock already held before entering else */
596 spin_unlock_irqrestore(&st_gdata->lock, flags);
597 return err;
598 }
599 pr_debug("done %s(%d) ", __func__, new_proto->chnl_id);
600}
601EXPORT_SYMBOL_GPL(st_register);
602
603/* to unregister a protocol -
604 * to be called from protocol stack driver
605 */
606long st_unregister(struct st_proto_s *proto)
607{
608 long err = 0;
609 unsigned long flags = 0;
610 struct st_data_s *st_gdata;
611
612 pr_debug("%s: %d ", __func__, proto->chnl_id);
613
614 st_kim_ref(&st_gdata, 0);
615 if (!st_gdata || proto->chnl_id >= ST_MAX_CHANNELS) {
616 pr_err(" chnl_id %d not supported", proto->chnl_id);
617 return -EPROTONOSUPPORT;
618 }
619
620 spin_lock_irqsave(&st_gdata->lock, flags);
621
622 if (st_gdata->list[proto->chnl_id] == NULL) {
623 pr_err(" chnl_id %d not registered", proto->chnl_id);
624 spin_unlock_irqrestore(&st_gdata->lock, flags);
625 return -EPROTONOSUPPORT;
626 }
627
628 st_gdata->protos_registered--;
629 remove_channel_from_table(st_gdata, proto);
630 spin_unlock_irqrestore(&st_gdata->lock, flags);
631
632 if ((st_gdata->protos_registered == ST_EMPTY) &&
633 (!test_bit(ST_REG_PENDING, &st_gdata->st_state))) {
634 pr_info(" all chnl_ids unregistered ");
635
636 /* stop traffic on tty */
637 if (st_gdata->tty) {
638 tty_ldisc_flush(st_gdata->tty);
639 stop_tty(st_gdata->tty);
640 }
641
642 /* all chnl_ids now unregistered */
643 st_kim_stop(st_gdata->kim_data);
644 /* disable ST LL */
645 st_ll_disable(st_gdata);
646 }
647 return err;
648}
649
650/*
651 * called in protocol stack drivers
652 * via the write function pointer
653 */
654long st_write(struct sk_buff *skb)
655{
656 struct st_data_s *st_gdata;
657 long len;
658
659 st_kim_ref(&st_gdata, 0);
660 if (unlikely(skb == NULL || st_gdata == NULL
661 || st_gdata->tty == NULL)) {
662 pr_err("data/tty unavailable to perform write");
663 return -EINVAL;
664 }
665
666 pr_debug("%d to be written", skb->len);
667 len = skb->len;
668
669 /* st_ll to decide where to enqueue the skb */
670 st_int_enqueue(st_gdata, skb);
671 /* wake up */
672 st_tx_wakeup(st_gdata);
673
674 /* return number of bytes written */
675 return len;
676}
677
678/* for protocols making use of shared transport */
679EXPORT_SYMBOL_GPL(st_unregister);
680
681/********************************************************************/
682/*
683 * functions called from TTY layer
684 */
685static int st_tty_open(struct tty_struct *tty)
686{
687 int err = 0;
688 struct st_data_s *st_gdata;
689 pr_info("%s ", __func__);
690
691 st_kim_ref(&st_gdata, 0);
692 st_gdata->tty = tty;
693 tty->disc_data = st_gdata;
694
695 /* don't do an wakeup for now */
696 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
697
698 /* mem already allocated
699 */
700 tty->receive_room = 65536;
701 /* Flush any pending characters in the driver and discipline. */
702 tty_ldisc_flush(tty);
703 tty_driver_flush_buffer(tty);
704 /*
705 * signal to UIM via KIM that -
706 * installation of N_TI_WL ldisc is complete
707 */
708 st_kim_complete(st_gdata->kim_data);
709 pr_debug("done %s", __func__);
710 return err;
711}
712
713static void st_tty_close(struct tty_struct *tty)
714{
715 unsigned char i = ST_MAX_CHANNELS;
716 unsigned long flags = 0;
717 struct st_data_s *st_gdata = tty->disc_data;
718
719 pr_info("%s ", __func__);
720
721 /* TODO:
722 * if a protocol has been registered & line discipline
723 * un-installed for some reason - what should be done ?
724 */
725 spin_lock_irqsave(&st_gdata->lock, flags);
726 for (i = ST_BT; i < ST_MAX_CHANNELS; i++) {
727 if (st_gdata->is_registered[i] == true)
728 pr_err("%d not un-registered", i);
729 st_gdata->list[i] = NULL;
730 st_gdata->is_registered[i] = false;
731 }
732 st_gdata->protos_registered = 0;
733 spin_unlock_irqrestore(&st_gdata->lock, flags);
734 /*
735 * signal to UIM via KIM that -
736 * N_TI_WL ldisc is un-installed
737 */
738 st_kim_complete(st_gdata->kim_data);
739 st_gdata->tty = NULL;
740 /* Flush any pending characters in the driver and discipline. */
741 tty_ldisc_flush(tty);
742 tty_driver_flush_buffer(tty);
743
744 spin_lock_irqsave(&st_gdata->lock, flags);
745 /* empty out txq and tx_waitq */
746 skb_queue_purge(&st_gdata->txq);
747 skb_queue_purge(&st_gdata->tx_waitq);
748 /* reset the TTY Rx states of ST */
749 st_gdata->rx_count = 0;
750 st_gdata->rx_state = ST_W4_PACKET_TYPE;
751 kfree_skb(st_gdata->rx_skb);
752 st_gdata->rx_skb = NULL;
753 spin_unlock_irqrestore(&st_gdata->lock, flags);
754
755 pr_debug("%s: done ", __func__);
756}
757
758static void st_tty_receive(struct tty_struct *tty, const unsigned char *data,
759 char *tty_flags, int count)
760{
761#ifdef VERBOSE
762 print_hex_dump(KERN_DEBUG, ">in>", DUMP_PREFIX_NONE,
763 16, 1, data, count, 0);
764#endif
765
766 /*
767 * if fw download is in progress then route incoming data
768 * to KIM for validation
769 */
770 st_recv(tty->disc_data, data, count);
771 pr_debug("done %s", __func__);
772}
773
774/* wake-up function called in from the TTY layer
775 * inside the internal wakeup function will be called
776 */
777static void st_tty_wakeup(struct tty_struct *tty)
778{
779 struct st_data_s *st_gdata = tty->disc_data;
780 pr_debug("%s ", __func__);
781 /* don't do an wakeup for now */
782 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
783
784 /* call our internal wakeup */
785 st_tx_wakeup((void *)st_gdata);
786}
787
788static void st_tty_flush_buffer(struct tty_struct *tty)
789{
790 struct st_data_s *st_gdata = tty->disc_data;
791 pr_debug("%s ", __func__);
792
793 kfree_skb(st_gdata->tx_skb);
794 st_gdata->tx_skb = NULL;
795
796 tty->ops->flush_buffer(tty);
797 return;
798}
799
800static struct tty_ldisc_ops st_ldisc_ops = {
801 .magic = TTY_LDISC_MAGIC,
802 .name = "n_st",
803 .open = st_tty_open,
804 .close = st_tty_close,
805 .receive_buf = st_tty_receive,
806 .write_wakeup = st_tty_wakeup,
807 .flush_buffer = st_tty_flush_buffer,
808 .owner = THIS_MODULE
809};
810
811/********************************************************************/
812int st_core_init(struct st_data_s **core_data)
813{
814 struct st_data_s *st_gdata;
815 long err;
816
817 err = tty_register_ldisc(N_TI_WL, &st_ldisc_ops);
818 if (err) {
819 pr_err("error registering %d line discipline %ld",
820 N_TI_WL, err);
821 return err;
822 }
823 pr_debug("registered n_shared line discipline");
824
825 st_gdata = kzalloc(sizeof(struct st_data_s), GFP_KERNEL);
826 if (!st_gdata) {
827 pr_err("memory allocation failed");
828 err = tty_unregister_ldisc(N_TI_WL);
829 if (err)
830 pr_err("unable to un-register ldisc %ld", err);
831 err = -ENOMEM;
832 return err;
833 }
834
835 /* Initialize ST TxQ and Tx waitQ queue head. All BT/FM/GPS module skb's
836 * will be pushed in this queue for actual transmission.
837 */
838 skb_queue_head_init(&st_gdata->txq);
839 skb_queue_head_init(&st_gdata->tx_waitq);
840
841 /* Locking used in st_int_enqueue() to avoid multiple execution */
842 spin_lock_init(&st_gdata->lock);
843
844 err = st_ll_init(st_gdata);
845 if (err) {
846 pr_err("error during st_ll initialization(%ld)", err);
847 kfree(st_gdata);
848 err = tty_unregister_ldisc(N_TI_WL);
849 if (err)
850 pr_err("unable to un-register ldisc");
851 return err;
852 }
853 *core_data = st_gdata;
854 return 0;
855}
856
857void st_core_exit(struct st_data_s *st_gdata)
858{
859 long err;
860 /* internal module cleanup */
861 err = st_ll_deinit(st_gdata);
862 if (err)
863 pr_err("error during deinit of ST LL %ld", err);
864
865 if (st_gdata != NULL) {
866 /* Free ST Tx Qs and skbs */
867 skb_queue_purge(&st_gdata->txq);
868 skb_queue_purge(&st_gdata->tx_waitq);
869 kfree_skb(st_gdata->rx_skb);
870 kfree_skb(st_gdata->tx_skb);
871 /* TTY ldisc cleanup */
872 err = tty_unregister_ldisc(N_TI_WL);
873 if (err)
874 pr_err("unable to un-register ldisc %ld", err);
875 /* free the global data pointer */
876 kfree(st_gdata);
877 }
878}
879
880
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Shared Transport Line discipline driver Core
4 * This hooks up ST KIM driver and ST LL driver
5 * Copyright (C) 2009-2010 Texas Instruments
6 * Author: Pavan Savoy <pavan_savoy@ti.com>
7 */
8
9#define pr_fmt(fmt) "(stc): " fmt
10#include <linux/module.h>
11#include <linux/kernel.h>
12#include <linux/tty.h>
13
14#include <linux/seq_file.h>
15#include <linux/skbuff.h>
16
17#include <linux/ti_wilink_st.h>
18
19extern void st_kim_recv(void *, const unsigned char *, long);
20void st_int_recv(void *, const unsigned char *, long);
21/*
22 * function pointer pointing to either,
23 * st_kim_recv during registration to receive fw download responses
24 * st_int_recv after registration to receive proto stack responses
25 */
26static void (*st_recv) (void *, const unsigned char *, long);
27
28/********************************************************************/
29static void add_channel_to_table(struct st_data_s *st_gdata,
30 struct st_proto_s *new_proto)
31{
32 pr_info("%s: id %d\n", __func__, new_proto->chnl_id);
33 /* list now has the channel id as index itself */
34 st_gdata->list[new_proto->chnl_id] = new_proto;
35 st_gdata->is_registered[new_proto->chnl_id] = true;
36}
37
38static void remove_channel_from_table(struct st_data_s *st_gdata,
39 struct st_proto_s *proto)
40{
41 pr_info("%s: id %d\n", __func__, proto->chnl_id);
42/* st_gdata->list[proto->chnl_id] = NULL; */
43 st_gdata->is_registered[proto->chnl_id] = false;
44}
45
46/*
47 * called from KIM during firmware download.
48 *
49 * This is a wrapper function to tty->ops->write_room.
50 * It returns number of free space available in
51 * uart tx buffer.
52 */
53int st_get_uart_wr_room(struct st_data_s *st_gdata)
54{
55 if (unlikely(st_gdata == NULL || st_gdata->tty == NULL)) {
56 pr_err("tty unavailable to perform write");
57 return -1;
58 }
59
60 return tty_write_room(st_gdata->tty);
61}
62
63/*
64 * can be called in from
65 * -- KIM (during fw download)
66 * -- ST Core (during st_write)
67 *
68 * This is the internal write function - a wrapper
69 * to tty->ops->write
70 */
71int st_int_write(struct st_data_s *st_gdata,
72 const unsigned char *data, int count)
73{
74 struct tty_struct *tty;
75 if (unlikely(st_gdata == NULL || st_gdata->tty == NULL)) {
76 pr_err("tty unavailable to perform write");
77 return -EINVAL;
78 }
79 tty = st_gdata->tty;
80#ifdef VERBOSE
81 print_hex_dump(KERN_DEBUG, "<out<", DUMP_PREFIX_NONE,
82 16, 1, data, count, 0);
83#endif
84 return tty->ops->write(tty, data, count);
85
86}
87
88/*
89 * push the skb received to relevant
90 * protocol stacks
91 */
92static void st_send_frame(unsigned char chnl_id, struct st_data_s *st_gdata)
93{
94 pr_debug(" %s(prot:%d) ", __func__, chnl_id);
95
96 if (unlikely
97 (st_gdata == NULL || st_gdata->rx_skb == NULL
98 || st_gdata->is_registered[chnl_id] == false)) {
99 pr_err("chnl_id %d not registered, no data to send?",
100 chnl_id);
101 kfree_skb(st_gdata->rx_skb);
102 return;
103 }
104 /*
105 * this cannot fail
106 * this shouldn't take long
107 * - should be just skb_queue_tail for the
108 * protocol stack driver
109 */
110 if (likely(st_gdata->list[chnl_id]->recv != NULL)) {
111 if (unlikely
112 (st_gdata->list[chnl_id]->recv
113 (st_gdata->list[chnl_id]->priv_data, st_gdata->rx_skb)
114 != 0)) {
115 pr_err(" proto stack %d's ->recv failed", chnl_id);
116 kfree_skb(st_gdata->rx_skb);
117 return;
118 }
119 } else {
120 pr_err(" proto stack %d's ->recv null", chnl_id);
121 kfree_skb(st_gdata->rx_skb);
122 }
123 return;
124}
125
126/*
127 * st_reg_complete - to call registration complete callbacks
128 * of all protocol stack drivers
129 * This function is being called with spin lock held, protocol drivers are
130 * only expected to complete their waits and do nothing more than that.
131 */
132static void st_reg_complete(struct st_data_s *st_gdata, int err)
133{
134 unsigned char i = 0;
135 pr_info(" %s ", __func__);
136 for (i = 0; i < ST_MAX_CHANNELS; i++) {
137 if (likely(st_gdata != NULL &&
138 st_gdata->is_registered[i] == true &&
139 st_gdata->list[i]->reg_complete_cb != NULL)) {
140 st_gdata->list[i]->reg_complete_cb
141 (st_gdata->list[i]->priv_data, err);
142 pr_info("protocol %d's cb sent %d\n", i, err);
143 if (err) { /* cleanup registered protocol */
144 st_gdata->is_registered[i] = false;
145 if (st_gdata->protos_registered)
146 st_gdata->protos_registered--;
147 }
148 }
149 }
150}
151
152static inline int st_check_data_len(struct st_data_s *st_gdata,
153 unsigned char chnl_id, int len)
154{
155 int room = skb_tailroom(st_gdata->rx_skb);
156
157 pr_debug("len %d room %d", len, room);
158
159 if (!len) {
160 /*
161 * Received packet has only packet header and
162 * has zero length payload. So, ask ST CORE to
163 * forward the packet to protocol driver (BT/FM/GPS)
164 */
165 st_send_frame(chnl_id, st_gdata);
166
167 } else if (len > room) {
168 /*
169 * Received packet's payload length is larger.
170 * We can't accommodate it in created skb.
171 */
172 pr_err("Data length is too large len %d room %d", len,
173 room);
174 kfree_skb(st_gdata->rx_skb);
175 } else {
176 /*
177 * Packet header has non-zero payload length and
178 * we have enough space in created skb. Lets read
179 * payload data */
180 st_gdata->rx_state = ST_W4_DATA;
181 st_gdata->rx_count = len;
182 return len;
183 }
184
185 /* Change ST state to continue to process next packet */
186 st_gdata->rx_state = ST_W4_PACKET_TYPE;
187 st_gdata->rx_skb = NULL;
188 st_gdata->rx_count = 0;
189 st_gdata->rx_chnl = 0;
190
191 return 0;
192}
193
194/*
195 * st_wakeup_ack - internal function for action when wake-up ack
196 * received
197 */
198static inline void st_wakeup_ack(struct st_data_s *st_gdata,
199 unsigned char cmd)
200{
201 struct sk_buff *waiting_skb;
202 unsigned long flags = 0;
203
204 spin_lock_irqsave(&st_gdata->lock, flags);
205 /*
206 * de-Q from waitQ and Q in txQ now that the
207 * chip is awake
208 */
209 while ((waiting_skb = skb_dequeue(&st_gdata->tx_waitq)))
210 skb_queue_tail(&st_gdata->txq, waiting_skb);
211
212 /* state forwarded to ST LL */
213 st_ll_sleep_state(st_gdata, (unsigned long)cmd);
214 spin_unlock_irqrestore(&st_gdata->lock, flags);
215
216 /* wake up to send the recently copied skbs from waitQ */
217 st_tx_wakeup(st_gdata);
218}
219
220/*
221 * st_int_recv - ST's internal receive function.
222 * Decodes received RAW data and forwards to corresponding
223 * client drivers (Bluetooth,FM,GPS..etc).
224 * This can receive various types of packets,
225 * HCI-Events, ACL, SCO, 4 types of HCI-LL PM packets
226 * CH-8 packets from FM, CH-9 packets from GPS cores.
227 */
228void st_int_recv(void *disc_data,
229 const unsigned char *data, long count)
230{
231 char *ptr;
232 struct st_proto_s *proto;
233 unsigned short payload_len = 0;
234 int len = 0;
235 unsigned char type = 0;
236 unsigned char *plen;
237 struct st_data_s *st_gdata = (struct st_data_s *)disc_data;
238 unsigned long flags;
239
240 ptr = (char *)data;
241 /* tty_receive sent null ? */
242 if (unlikely(ptr == NULL) || (st_gdata == NULL)) {
243 pr_err(" received null from TTY ");
244 return;
245 }
246
247 pr_debug("count %ld rx_state %ld"
248 "rx_count %ld", count, st_gdata->rx_state,
249 st_gdata->rx_count);
250
251 spin_lock_irqsave(&st_gdata->lock, flags);
252 /* Decode received bytes here */
253 while (count) {
254 if (st_gdata->rx_count) {
255 len = min_t(unsigned int, st_gdata->rx_count, count);
256 skb_put_data(st_gdata->rx_skb, ptr, len);
257 st_gdata->rx_count -= len;
258 count -= len;
259 ptr += len;
260
261 if (st_gdata->rx_count)
262 continue;
263
264 /* Check ST RX state machine , where are we? */
265 switch (st_gdata->rx_state) {
266 /* Waiting for complete packet ? */
267 case ST_W4_DATA:
268 pr_debug("Complete pkt received");
269 /*
270 * Ask ST CORE to forward
271 * the packet to protocol driver
272 */
273 st_send_frame(st_gdata->rx_chnl, st_gdata);
274
275 st_gdata->rx_state = ST_W4_PACKET_TYPE;
276 st_gdata->rx_skb = NULL;
277 continue;
278 /* parse the header to know details */
279 case ST_W4_HEADER:
280 proto = st_gdata->list[st_gdata->rx_chnl];
281 plen =
282 &st_gdata->rx_skb->data
283 [proto->offset_len_in_hdr];
284 pr_debug("plen pointing to %x\n", *plen);
285 if (proto->len_size == 1) /* 1 byte len field */
286 payload_len = *(unsigned char *)plen;
287 else if (proto->len_size == 2)
288 payload_len =
289 __le16_to_cpu(*(unsigned short *)plen);
290 else
291 pr_info("%s: invalid length "
292 "for id %d\n",
293 __func__, proto->chnl_id);
294 st_check_data_len(st_gdata, proto->chnl_id,
295 payload_len);
296 pr_debug("off %d, pay len %d\n",
297 proto->offset_len_in_hdr, payload_len);
298 continue;
299 } /* end of switch rx_state */
300 }
301
302 /* end of if rx_count */
303
304 /*
305 * Check first byte of packet and identify module
306 * owner (BT/FM/GPS)
307 */
308 switch (*ptr) {
309 case LL_SLEEP_IND:
310 case LL_SLEEP_ACK:
311 case LL_WAKE_UP_IND:
312 pr_debug("PM packet");
313 /*
314 * this takes appropriate action based on
315 * sleep state received --
316 */
317 st_ll_sleep_state(st_gdata, *ptr);
318 /*
319 * if WAKEUP_IND collides copy from waitq to txq
320 * and assume chip awake
321 */
322 spin_unlock_irqrestore(&st_gdata->lock, flags);
323 if (st_ll_getstate(st_gdata) == ST_LL_AWAKE)
324 st_wakeup_ack(st_gdata, LL_WAKE_UP_ACK);
325 spin_lock_irqsave(&st_gdata->lock, flags);
326
327 ptr++;
328 count--;
329 continue;
330 case LL_WAKE_UP_ACK:
331 pr_debug("PM packet");
332
333 spin_unlock_irqrestore(&st_gdata->lock, flags);
334 /* wake up ack received */
335 st_wakeup_ack(st_gdata, *ptr);
336 spin_lock_irqsave(&st_gdata->lock, flags);
337
338 ptr++;
339 count--;
340 continue;
341 /* Unknow packet? */
342 default:
343 type = *ptr;
344
345 /*
346 * Default case means non-HCILL packets,
347 * possibilities are packets for:
348 * (a) valid protocol - Supported Protocols within
349 * the ST_MAX_CHANNELS.
350 * (b) registered protocol - Checked by
351 * "st_gdata->list[type] == NULL)" are supported
352 * protocols only.
353 * Rules out any invalid protocol and
354 * unregistered protocols with channel ID < 16.
355 */
356
357 if ((type >= ST_MAX_CHANNELS) ||
358 (st_gdata->list[type] == NULL)) {
359 pr_err("chip/interface misbehavior: "
360 "dropping frame starting "
361 "with 0x%02x\n", type);
362 goto done;
363 }
364
365 st_gdata->rx_skb = alloc_skb(
366 st_gdata->list[type]->max_frame_size,
367 GFP_ATOMIC);
368 if (st_gdata->rx_skb == NULL) {
369 pr_err("out of memory: dropping\n");
370 goto done;
371 }
372
373 skb_reserve(st_gdata->rx_skb,
374 st_gdata->list[type]->reserve);
375 /* next 2 required for BT only */
376 st_gdata->rx_skb->cb[0] = type; /*pkt_type*/
377 st_gdata->rx_skb->cb[1] = 0; /*incoming*/
378 st_gdata->rx_chnl = *ptr;
379 st_gdata->rx_state = ST_W4_HEADER;
380 st_gdata->rx_count = st_gdata->list[type]->hdr_len;
381 pr_debug("rx_count %ld\n", st_gdata->rx_count);
382 }
383 ptr++;
384 count--;
385 }
386done:
387 spin_unlock_irqrestore(&st_gdata->lock, flags);
388 pr_debug("done %s", __func__);
389 return;
390}
391
392/*
393 * st_int_dequeue - internal de-Q function.
394 * If the previous data set was not written
395 * completely, return that skb which has the pending data.
396 * In normal cases, return top of txq.
397 */
398static struct sk_buff *st_int_dequeue(struct st_data_s *st_gdata)
399{
400 struct sk_buff *returning_skb;
401
402 pr_debug("%s", __func__);
403 if (st_gdata->tx_skb != NULL) {
404 returning_skb = st_gdata->tx_skb;
405 st_gdata->tx_skb = NULL;
406 return returning_skb;
407 }
408 return skb_dequeue(&st_gdata->txq);
409}
410
411/*
412 * st_int_enqueue - internal Q-ing function.
413 * Will either Q the skb to txq or the tx_waitq
414 * depending on the ST LL state.
415 * If the chip is asleep, then Q it onto waitq and
416 * wakeup the chip.
417 * txq and waitq needs protection since the other contexts
418 * may be sending data, waking up chip.
419 */
420static void st_int_enqueue(struct st_data_s *st_gdata, struct sk_buff *skb)
421{
422 unsigned long flags = 0;
423
424 pr_debug("%s", __func__);
425 spin_lock_irqsave(&st_gdata->lock, flags);
426
427 switch (st_ll_getstate(st_gdata)) {
428 case ST_LL_AWAKE:
429 pr_debug("ST LL is AWAKE, sending normally");
430 skb_queue_tail(&st_gdata->txq, skb);
431 break;
432 case ST_LL_ASLEEP_TO_AWAKE:
433 skb_queue_tail(&st_gdata->tx_waitq, skb);
434 break;
435 case ST_LL_AWAKE_TO_ASLEEP:
436 pr_err("ST LL is illegal state(%ld),"
437 "purging received skb.", st_ll_getstate(st_gdata));
438 kfree_skb(skb);
439 break;
440 case ST_LL_ASLEEP:
441 skb_queue_tail(&st_gdata->tx_waitq, skb);
442 st_ll_wakeup(st_gdata);
443 break;
444 default:
445 pr_err("ST LL is illegal state(%ld),"
446 "purging received skb.", st_ll_getstate(st_gdata));
447 kfree_skb(skb);
448 break;
449 }
450
451 spin_unlock_irqrestore(&st_gdata->lock, flags);
452 pr_debug("done %s", __func__);
453 return;
454}
455
456/*
457 * internal wakeup function
458 * called from either
459 * - TTY layer when write's finished
460 * - st_write (in context of the protocol stack)
461 */
462static void work_fn_write_wakeup(struct work_struct *work)
463{
464 struct st_data_s *st_gdata = container_of(work, struct st_data_s,
465 work_write_wakeup);
466
467 st_tx_wakeup((void *)st_gdata);
468}
469void st_tx_wakeup(struct st_data_s *st_data)
470{
471 struct sk_buff *skb;
472 unsigned long flags; /* for irq save flags */
473 pr_debug("%s", __func__);
474 /* check for sending & set flag sending here */
475 if (test_and_set_bit(ST_TX_SENDING, &st_data->tx_state)) {
476 pr_debug("ST already sending");
477 /* keep sending */
478 set_bit(ST_TX_WAKEUP, &st_data->tx_state);
479 return;
480 /* TX_WAKEUP will be checked in another
481 * context
482 */
483 }
484 do { /* come back if st_tx_wakeup is set */
485 /* woke-up to write */
486 clear_bit(ST_TX_WAKEUP, &st_data->tx_state);
487 while ((skb = st_int_dequeue(st_data))) {
488 int len;
489 spin_lock_irqsave(&st_data->lock, flags);
490 /* enable wake-up from TTY */
491 set_bit(TTY_DO_WRITE_WAKEUP, &st_data->tty->flags);
492 len = st_int_write(st_data, skb->data, skb->len);
493 skb_pull(skb, len);
494 /* if skb->len = len as expected, skb->len=0 */
495 if (skb->len) {
496 /* would be the next skb to be sent */
497 st_data->tx_skb = skb;
498 spin_unlock_irqrestore(&st_data->lock, flags);
499 break;
500 }
501 kfree_skb(skb);
502 spin_unlock_irqrestore(&st_data->lock, flags);
503 }
504 /* if wake-up is set in another context- restart sending */
505 } while (test_bit(ST_TX_WAKEUP, &st_data->tx_state));
506
507 /* clear flag sending */
508 clear_bit(ST_TX_SENDING, &st_data->tx_state);
509}
510
511/********************************************************************/
512/* functions called from ST KIM
513*/
514void kim_st_list_protocols(struct st_data_s *st_gdata, void *buf)
515{
516 seq_printf(buf, "[%d]\nBT=%c\nFM=%c\nGPS=%c\n",
517 st_gdata->protos_registered,
518 st_gdata->is_registered[0x04] == true ? 'R' : 'U',
519 st_gdata->is_registered[0x08] == true ? 'R' : 'U',
520 st_gdata->is_registered[0x09] == true ? 'R' : 'U');
521}
522
523/********************************************************************/
524/*
525 * functions called from protocol stack drivers
526 * to be EXPORT-ed
527 */
528long st_register(struct st_proto_s *new_proto)
529{
530 struct st_data_s *st_gdata;
531 long err = 0;
532 unsigned long flags = 0;
533
534 st_kim_ref(&st_gdata, 0);
535 if (st_gdata == NULL || new_proto == NULL || new_proto->recv == NULL
536 || new_proto->reg_complete_cb == NULL) {
537 pr_err("gdata/new_proto/recv or reg_complete_cb not ready");
538 return -EINVAL;
539 }
540
541 if (new_proto->chnl_id >= ST_MAX_CHANNELS) {
542 pr_err("chnl_id %d not supported", new_proto->chnl_id);
543 return -EPROTONOSUPPORT;
544 }
545
546 if (st_gdata->is_registered[new_proto->chnl_id] == true) {
547 pr_err("chnl_id %d already registered", new_proto->chnl_id);
548 return -EALREADY;
549 }
550
551 /* can be from process context only */
552 spin_lock_irqsave(&st_gdata->lock, flags);
553
554 if (test_bit(ST_REG_IN_PROGRESS, &st_gdata->st_state)) {
555 pr_info(" ST_REG_IN_PROGRESS:%d ", new_proto->chnl_id);
556 /* fw download in progress */
557
558 add_channel_to_table(st_gdata, new_proto);
559 st_gdata->protos_registered++;
560 new_proto->write = st_write;
561
562 set_bit(ST_REG_PENDING, &st_gdata->st_state);
563 spin_unlock_irqrestore(&st_gdata->lock, flags);
564 return -EINPROGRESS;
565 } else if (st_gdata->protos_registered == ST_EMPTY) {
566 pr_info(" chnl_id list empty :%d ", new_proto->chnl_id);
567 set_bit(ST_REG_IN_PROGRESS, &st_gdata->st_state);
568 st_recv = st_kim_recv;
569
570 /* enable the ST LL - to set default chip state */
571 st_ll_enable(st_gdata);
572
573 /* release lock previously held - re-locked below */
574 spin_unlock_irqrestore(&st_gdata->lock, flags);
575
576 /*
577 * this may take a while to complete
578 * since it involves BT fw download
579 */
580 err = st_kim_start(st_gdata->kim_data);
581 if (err != 0) {
582 clear_bit(ST_REG_IN_PROGRESS, &st_gdata->st_state);
583 if ((st_gdata->protos_registered != ST_EMPTY) &&
584 (test_bit(ST_REG_PENDING, &st_gdata->st_state))) {
585 pr_err(" KIM failure complete callback ");
586 spin_lock_irqsave(&st_gdata->lock, flags);
587 st_reg_complete(st_gdata, err);
588 spin_unlock_irqrestore(&st_gdata->lock, flags);
589 clear_bit(ST_REG_PENDING, &st_gdata->st_state);
590 }
591 return -EINVAL;
592 }
593
594 spin_lock_irqsave(&st_gdata->lock, flags);
595
596 clear_bit(ST_REG_IN_PROGRESS, &st_gdata->st_state);
597 st_recv = st_int_recv;
598
599 /*
600 * this is where all pending registration
601 * are signalled to be complete by calling callback functions
602 */
603 if ((st_gdata->protos_registered != ST_EMPTY) &&
604 (test_bit(ST_REG_PENDING, &st_gdata->st_state))) {
605 pr_debug(" call reg complete callback ");
606 st_reg_complete(st_gdata, 0);
607 }
608 clear_bit(ST_REG_PENDING, &st_gdata->st_state);
609
610 /*
611 * check for already registered once more,
612 * since the above check is old
613 */
614 if (st_gdata->is_registered[new_proto->chnl_id] == true) {
615 pr_err(" proto %d already registered ",
616 new_proto->chnl_id);
617 spin_unlock_irqrestore(&st_gdata->lock, flags);
618 return -EALREADY;
619 }
620
621 add_channel_to_table(st_gdata, new_proto);
622 st_gdata->protos_registered++;
623 new_proto->write = st_write;
624 spin_unlock_irqrestore(&st_gdata->lock, flags);
625 return err;
626 }
627 /* if fw is already downloaded & new stack registers protocol */
628 else {
629 add_channel_to_table(st_gdata, new_proto);
630 st_gdata->protos_registered++;
631 new_proto->write = st_write;
632
633 /* lock already held before entering else */
634 spin_unlock_irqrestore(&st_gdata->lock, flags);
635 return err;
636 }
637}
638EXPORT_SYMBOL_GPL(st_register);
639
640/*
641 * to unregister a protocol -
642 * to be called from protocol stack driver
643 */
644long st_unregister(struct st_proto_s *proto)
645{
646 long err = 0;
647 unsigned long flags = 0;
648 struct st_data_s *st_gdata;
649
650 pr_debug("%s: %d ", __func__, proto->chnl_id);
651
652 st_kim_ref(&st_gdata, 0);
653 if (!st_gdata || proto->chnl_id >= ST_MAX_CHANNELS) {
654 pr_err(" chnl_id %d not supported", proto->chnl_id);
655 return -EPROTONOSUPPORT;
656 }
657
658 spin_lock_irqsave(&st_gdata->lock, flags);
659
660 if (st_gdata->is_registered[proto->chnl_id] == false) {
661 pr_err(" chnl_id %d not registered", proto->chnl_id);
662 spin_unlock_irqrestore(&st_gdata->lock, flags);
663 return -EPROTONOSUPPORT;
664 }
665
666 if (st_gdata->protos_registered)
667 st_gdata->protos_registered--;
668
669 remove_channel_from_table(st_gdata, proto);
670 spin_unlock_irqrestore(&st_gdata->lock, flags);
671
672 if ((st_gdata->protos_registered == ST_EMPTY) &&
673 (!test_bit(ST_REG_PENDING, &st_gdata->st_state))) {
674 pr_info(" all chnl_ids unregistered ");
675
676 /* stop traffic on tty */
677 if (st_gdata->tty) {
678 tty_ldisc_flush(st_gdata->tty);
679 stop_tty(st_gdata->tty);
680 }
681
682 /* all chnl_ids now unregistered */
683 st_kim_stop(st_gdata->kim_data);
684 /* disable ST LL */
685 st_ll_disable(st_gdata);
686 }
687 return err;
688}
689
690/*
691 * called in protocol stack drivers
692 * via the write function pointer
693 */
694long st_write(struct sk_buff *skb)
695{
696 struct st_data_s *st_gdata;
697 long len;
698
699 st_kim_ref(&st_gdata, 0);
700 if (unlikely(skb == NULL || st_gdata == NULL
701 || st_gdata->tty == NULL)) {
702 pr_err("data/tty unavailable to perform write");
703 return -EINVAL;
704 }
705
706 pr_debug("%d to be written", skb->len);
707 len = skb->len;
708
709 /* st_ll to decide where to enqueue the skb */
710 st_int_enqueue(st_gdata, skb);
711 /* wake up */
712 st_tx_wakeup(st_gdata);
713
714 /* return number of bytes written */
715 return len;
716}
717
718/* for protocols making use of shared transport */
719EXPORT_SYMBOL_GPL(st_unregister);
720
721/********************************************************************/
722/*
723 * functions called from TTY layer
724 */
725static int st_tty_open(struct tty_struct *tty)
726{
727 struct st_data_s *st_gdata;
728 pr_info("%s ", __func__);
729
730 st_kim_ref(&st_gdata, 0);
731 st_gdata->tty = tty;
732 tty->disc_data = st_gdata;
733
734 /* don't do an wakeup for now */
735 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
736
737 /* mem already allocated
738 */
739 tty->receive_room = 65536;
740 /* Flush any pending characters in the driver and discipline. */
741 tty_ldisc_flush(tty);
742 tty_driver_flush_buffer(tty);
743 /*
744 * signal to UIM via KIM that -
745 * installation of N_TI_WL ldisc is complete
746 */
747 st_kim_complete(st_gdata->kim_data);
748 pr_debug("done %s", __func__);
749
750 return 0;
751}
752
753static void st_tty_close(struct tty_struct *tty)
754{
755 unsigned char i;
756 unsigned long flags;
757 struct st_data_s *st_gdata = tty->disc_data;
758
759 pr_info("%s ", __func__);
760
761 /*
762 * TODO:
763 * if a protocol has been registered & line discipline
764 * un-installed for some reason - what should be done ?
765 */
766 spin_lock_irqsave(&st_gdata->lock, flags);
767 for (i = ST_BT; i < ST_MAX_CHANNELS; i++) {
768 if (st_gdata->is_registered[i] == true)
769 pr_err("%d not un-registered", i);
770 st_gdata->list[i] = NULL;
771 st_gdata->is_registered[i] = false;
772 }
773 st_gdata->protos_registered = 0;
774 spin_unlock_irqrestore(&st_gdata->lock, flags);
775 /*
776 * signal to UIM via KIM that -
777 * N_TI_WL ldisc is un-installed
778 */
779 st_kim_complete(st_gdata->kim_data);
780 st_gdata->tty = NULL;
781 /* Flush any pending characters in the driver and discipline. */
782 tty_ldisc_flush(tty);
783 tty_driver_flush_buffer(tty);
784
785 spin_lock_irqsave(&st_gdata->lock, flags);
786 /* empty out txq and tx_waitq */
787 skb_queue_purge(&st_gdata->txq);
788 skb_queue_purge(&st_gdata->tx_waitq);
789 /* reset the TTY Rx states of ST */
790 st_gdata->rx_count = 0;
791 st_gdata->rx_state = ST_W4_PACKET_TYPE;
792 kfree_skb(st_gdata->rx_skb);
793 st_gdata->rx_skb = NULL;
794 spin_unlock_irqrestore(&st_gdata->lock, flags);
795
796 pr_debug("%s: done ", __func__);
797}
798
799static void st_tty_receive(struct tty_struct *tty, const unsigned char *data,
800 const char *tty_flags, int count)
801{
802#ifdef VERBOSE
803 print_hex_dump(KERN_DEBUG, ">in>", DUMP_PREFIX_NONE,
804 16, 1, data, count, 0);
805#endif
806
807 /*
808 * if fw download is in progress then route incoming data
809 * to KIM for validation
810 */
811 st_recv(tty->disc_data, data, count);
812 pr_debug("done %s", __func__);
813}
814
815/*
816 * wake-up function called in from the TTY layer
817 * inside the internal wakeup function will be called
818 */
819static void st_tty_wakeup(struct tty_struct *tty)
820{
821 struct st_data_s *st_gdata = tty->disc_data;
822 pr_debug("%s ", __func__);
823 /* don't do an wakeup for now */
824 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
825
826 /*
827 * schedule the internal wakeup instead of calling directly to
828 * avoid lockup (port->lock needed in tty->ops->write is
829 * already taken here
830 */
831 schedule_work(&st_gdata->work_write_wakeup);
832}
833
834static void st_tty_flush_buffer(struct tty_struct *tty)
835{
836 struct st_data_s *st_gdata = tty->disc_data;
837 pr_debug("%s ", __func__);
838
839 kfree_skb(st_gdata->tx_skb);
840 st_gdata->tx_skb = NULL;
841
842 tty_driver_flush_buffer(tty);
843 return;
844}
845
846static struct tty_ldisc_ops st_ldisc_ops = {
847 .num = N_TI_WL,
848 .name = "n_st",
849 .open = st_tty_open,
850 .close = st_tty_close,
851 .receive_buf = st_tty_receive,
852 .write_wakeup = st_tty_wakeup,
853 .flush_buffer = st_tty_flush_buffer,
854 .owner = THIS_MODULE
855};
856
857/********************************************************************/
858int st_core_init(struct st_data_s **core_data)
859{
860 struct st_data_s *st_gdata;
861 long err;
862
863 err = tty_register_ldisc(&st_ldisc_ops);
864 if (err) {
865 pr_err("error registering %d line discipline %ld",
866 N_TI_WL, err);
867 return err;
868 }
869 pr_debug("registered n_shared line discipline");
870
871 st_gdata = kzalloc(sizeof(struct st_data_s), GFP_KERNEL);
872 if (!st_gdata) {
873 pr_err("memory allocation failed");
874 err = -ENOMEM;
875 goto err_unreg_ldisc;
876 }
877
878 /* Initialize ST TxQ and Tx waitQ queue head. All BT/FM/GPS module skb's
879 * will be pushed in this queue for actual transmission.
880 */
881 skb_queue_head_init(&st_gdata->txq);
882 skb_queue_head_init(&st_gdata->tx_waitq);
883
884 /* Locking used in st_int_enqueue() to avoid multiple execution */
885 spin_lock_init(&st_gdata->lock);
886
887 err = st_ll_init(st_gdata);
888 if (err) {
889 pr_err("error during st_ll initialization(%ld)", err);
890 goto err_free_gdata;
891 }
892
893 INIT_WORK(&st_gdata->work_write_wakeup, work_fn_write_wakeup);
894
895 *core_data = st_gdata;
896 return 0;
897err_free_gdata:
898 kfree(st_gdata);
899err_unreg_ldisc:
900 tty_unregister_ldisc(&st_ldisc_ops);
901 return err;
902}
903
904void st_core_exit(struct st_data_s *st_gdata)
905{
906 long err;
907 /* internal module cleanup */
908 err = st_ll_deinit(st_gdata);
909 if (err)
910 pr_err("error during deinit of ST LL %ld", err);
911
912 if (st_gdata != NULL) {
913 /* Free ST Tx Qs and skbs */
914 skb_queue_purge(&st_gdata->txq);
915 skb_queue_purge(&st_gdata->tx_waitq);
916 kfree_skb(st_gdata->rx_skb);
917 kfree_skb(st_gdata->tx_skb);
918 /* TTY ldisc cleanup */
919 tty_unregister_ldisc(&st_ldisc_ops);
920 /* free the global data pointer */
921 kfree(st_gdata);
922 }
923}