1 /* -----------------------------------------------------------------------------
2 * Copyright (c) 2011 Ozmo Inc
3 * Released under the GNU General Public License Version 2 (GPLv2).
4 * -----------------------------------------------------------------------------
7 #include <linux/module.h>
8 #include <linux/timer.h>
9 #include <linux/sched.h>
10 #include <linux/netdevice.h>
11 #include <linux/etherdevice.h>
12 #include <linux/errno.h>
13 #include <linux/ieee80211.h>
15 #include "ozprotocol.h"
22 #include <asm/unaligned.h>
23 #include <linux/uaccess.h>
24 #include <net/psnap.h>
26 #define OZ_CF_CONN_SUCCESS 1
27 #define OZ_CF_CONN_FAILURE 2
32 #define OZ_MAX_TIMER_POOL_SIZE 16
35 struct packet_type ptype;
36 char name[OZ_MAX_BINDING_LEN];
37 struct list_head link;
44 DEFINE_SPINLOCK(g_polling_lock);
46 * Static external variables.
48 static LIST_HEAD(g_pd_list);
49 static LIST_HEAD(g_binding);
50 static DEFINE_SPINLOCK(g_binding_lock);
51 static struct sk_buff_head g_rx_queue;
52 static u8 g_session_id;
53 static u16 g_apps = 0x1;
54 static int g_processing_rx;
57 * Context: softirq-serialized
59 static u8 oz_get_new_session_id(u8 exclude)
61 if (++g_session_id == 0)
63 if (g_session_id == exclude) {
64 if (++g_session_id == 0)
71 * Context: softirq-serialized
73 static void oz_send_conn_rsp(struct oz_pd *pd, u8 status)
76 struct net_device *dev = pd->net_dev;
77 struct oz_hdr *oz_hdr;
79 struct oz_elt_connect_rsp *body;
81 int sz = sizeof(struct oz_hdr) + sizeof(struct oz_elt) +
82 sizeof(struct oz_elt_connect_rsp);
83 skb = alloc_skb(sz + OZ_ALLOCATED_SPACE(dev), GFP_ATOMIC);
86 skb_reserve(skb, LL_RESERVED_SPACE(dev));
87 skb_reset_network_header(skb);
88 oz_hdr = (struct oz_hdr *)skb_put(skb, sz);
89 elt = (struct oz_elt *)(oz_hdr+1);
90 body = (struct oz_elt_connect_rsp *)(elt+1);
92 skb->protocol = htons(OZ_ETHERTYPE);
93 /* Fill in device header */
94 if (dev_hard_header(skb, dev, OZ_ETHERTYPE, pd->mac_addr,
95 dev->dev_addr, skb->len) < 0) {
99 oz_hdr->control = (OZ_PROTOCOL_VERSION<<OZ_VERSION_SHIFT);
100 oz_hdr->last_pkt_num = 0;
101 put_unaligned(0, &oz_hdr->pkt_num);
102 elt->type = OZ_ELT_CONNECT_RSP;
103 elt->length = sizeof(struct oz_elt_connect_rsp);
104 memset(body, 0, sizeof(struct oz_elt_connect_rsp));
105 body->status = status;
107 body->mode = pd->mode;
108 body->session_id = pd->session_id;
109 put_unaligned(cpu_to_le16(pd->total_apps), &body->apps);
111 oz_dbg(ON, "TX: OZ_ELT_CONNECT_RSP %d", status);
117 * Context: softirq-serialized
119 static void pd_set_keepalive(struct oz_pd *pd, u8 kalive)
121 unsigned long keep_alive = kalive & OZ_KALIVE_VALUE_MASK;
123 switch (kalive & OZ_KALIVE_TYPE_MASK) {
124 case OZ_KALIVE_SPECIAL:
125 pd->keep_alive = keep_alive * 1000*60*60*24*20;
128 pd->keep_alive = keep_alive*1000;
131 pd->keep_alive = keep_alive*1000*60;
133 case OZ_KALIVE_HOURS:
134 pd->keep_alive = keep_alive*1000*60*60;
139 oz_dbg(ON, "Keepalive = %lu mSec\n", pd->keep_alive);
143 * Context: softirq-serialized
145 static void pd_set_presleep(struct oz_pd *pd, u8 presleep, u8 start_timer)
148 pd->presleep = presleep*100;
150 pd->presleep = OZ_PRESLEEP_TOUT;
152 spin_unlock(&g_polling_lock);
153 oz_timer_add(pd, OZ_TIMER_TOUT, pd->presleep);
154 spin_lock(&g_polling_lock);
156 oz_dbg(ON, "Presleep time = %lu mSec\n", pd->presleep);
160 * Context: softirq-serialized
162 static struct oz_pd *oz_connect_req(struct oz_pd *cur_pd, struct oz_elt *elt,
163 const u8 *pd_addr, struct net_device *net_dev)
166 struct oz_elt_connect_req *body =
167 (struct oz_elt_connect_req *)(elt+1);
168 u8 rsp_status = OZ_STATUS_SUCCESS;
170 u16 new_apps = g_apps;
171 struct net_device *old_net_dev = NULL;
172 struct oz_pd *free_pd = NULL;
176 spin_lock_bh(&g_polling_lock);
178 struct oz_pd *pd2 = NULL;
180 pd = oz_pd_alloc(pd_addr);
183 getnstimeofday(&pd->last_rx_timestamp);
184 spin_lock_bh(&g_polling_lock);
185 list_for_each(e, &g_pd_list) {
186 pd2 = container_of(e, struct oz_pd, link);
187 if (ether_addr_equal(pd2->mac_addr, pd_addr)) {
194 list_add_tail(&pd->link, &g_pd_list);
197 spin_unlock_bh(&g_polling_lock);
200 if (pd->net_dev != net_dev) {
201 old_net_dev = pd->net_dev;
203 pd->net_dev = net_dev;
205 oz_dbg(ON, "Host vendor: %d\n", body->host_vendor);
206 pd->max_tx_size = OZ_MAX_TX_SIZE;
207 pd->mode = body->mode;
208 pd->pd_info = body->pd_info;
209 if (pd->mode & OZ_F_ISOC_NO_ELTS) {
210 pd->ms_per_isoc = body->ms_per_isoc;
211 if (!pd->ms_per_isoc)
214 switch (body->ms_isoc_latency & OZ_LATENCY_MASK) {
215 case OZ_ONE_MS_LATENCY:
216 pd->isoc_latency = (body->ms_isoc_latency &
217 ~OZ_LATENCY_MASK) / pd->ms_per_isoc;
219 case OZ_TEN_MS_LATENCY:
220 pd->isoc_latency = ((body->ms_isoc_latency &
221 ~OZ_LATENCY_MASK) * 10) / pd->ms_per_isoc;
224 pd->isoc_latency = OZ_MAX_TX_QUEUE_ISOC;
227 if (body->max_len_div16)
228 pd->max_tx_size = ((u16)body->max_len_div16)<<4;
229 oz_dbg(ON, "Max frame:%u Ms per isoc:%u\n",
230 pd->max_tx_size, pd->ms_per_isoc);
231 pd->max_stream_buffering = 3*1024;
232 pd->pulse_period = OZ_QUANTUM;
233 pd_set_presleep(pd, body->presleep, 0);
234 pd_set_keepalive(pd, body->keep_alive);
236 new_apps &= le16_to_cpu(get_unaligned(&body->apps));
237 if ((new_apps & 0x1) && (body->session_id)) {
238 if (pd->session_id) {
239 if (pd->session_id != body->session_id) {
240 rsp_status = OZ_STATUS_SESSION_MISMATCH;
244 new_apps &= ~0x1; /* Resume not permitted */
246 oz_get_new_session_id(body->session_id);
249 if (pd->session_id && !body->session_id) {
250 rsp_status = OZ_STATUS_SESSION_TEARDOWN;
253 new_apps &= ~0x1; /* Resume not permitted */
255 oz_get_new_session_id(body->session_id);
259 if (rsp_status == OZ_STATUS_SUCCESS) {
260 u16 start_apps = new_apps & ~pd->total_apps & ~0x1;
261 u16 stop_apps = pd->total_apps & ~new_apps & ~0x1;
262 u16 resume_apps = new_apps & pd->paused_apps & ~0x1;
263 spin_unlock_bh(&g_polling_lock);
264 oz_pd_set_state(pd, OZ_PD_S_CONNECTED);
265 oz_dbg(ON, "new_apps=0x%x total_apps=0x%x paused_apps=0x%x\n",
266 new_apps, pd->total_apps, pd->paused_apps);
268 if (oz_services_start(pd, start_apps, 0))
269 rsp_status = OZ_STATUS_TOO_MANY_PDS;
272 if (oz_services_start(pd, resume_apps, 1))
273 rsp_status = OZ_STATUS_TOO_MANY_PDS;
275 oz_services_stop(pd, stop_apps, 0);
276 oz_pd_request_heartbeat(pd);
278 spin_unlock_bh(&g_polling_lock);
280 oz_send_conn_rsp(pd, rsp_status);
281 if (rsp_status != OZ_STATUS_SUCCESS) {
288 dev_put(old_net_dev);
290 oz_pd_destroy(free_pd);
295 * Context: softirq-serialized
297 static void oz_add_farewell(struct oz_pd *pd, u8 ep_num, u8 index,
298 const u8 *report, u8 len)
300 struct oz_farewell *f;
301 struct oz_farewell *f2;
304 f = kmalloc(sizeof(struct oz_farewell) + len, GFP_ATOMIC);
310 memcpy(f->report, report, len);
311 oz_dbg(ON, "RX: Adding farewell report\n");
312 spin_lock(&g_polling_lock);
313 list_for_each_entry(f2, &pd->farewell_list, link) {
314 if ((f2->ep_num == ep_num) && (f2->index == index)) {
320 list_add_tail(&f->link, &pd->farewell_list);
321 spin_unlock(&g_polling_lock);
327 * Context: softirq-serialized
329 static void oz_rx_frame(struct sk_buff *skb)
335 struct oz_pd *pd = NULL;
336 struct oz_hdr *oz_hdr = (struct oz_hdr *)skb_network_header(skb);
337 struct timespec current_time;
341 oz_dbg(RX_FRAMES, "RX frame PN=0x%x LPN=0x%x control=0x%x\n",
342 oz_hdr->pkt_num, oz_hdr->last_pkt_num, oz_hdr->control);
343 mac_hdr = skb_mac_header(skb);
344 src_addr = &mac_hdr[ETH_ALEN];
347 /* Check the version field */
348 if (oz_get_prot_ver(oz_hdr->control) != OZ_PROTOCOL_VERSION) {
349 oz_dbg(ON, "Incorrect protocol version: %d\n",
350 oz_get_prot_ver(oz_hdr->control));
354 pkt_num = le32_to_cpu(get_unaligned(&oz_hdr->pkt_num));
356 pd = oz_pd_find(src_addr);
358 if (!(pd->state & OZ_PD_S_CONNECTED))
359 oz_pd_set_state(pd, OZ_PD_S_CONNECTED);
360 getnstimeofday(¤t_time);
361 if ((current_time.tv_sec != pd->last_rx_timestamp.tv_sec) ||
362 (pd->presleep < MSEC_PER_SEC)) {
363 oz_timer_add(pd, OZ_TIMER_TOUT, pd->presleep);
364 pd->last_rx_timestamp = current_time;
366 if (pkt_num != pd->last_rx_pkt_num) {
367 pd->last_rx_pkt_num = pkt_num;
370 oz_dbg(ON, "Duplicate frame\n");
374 if (pd && !dup && ((pd->mode & OZ_MODE_MASK) == OZ_MODE_TRIGGERED)) {
375 oz_dbg(RX_FRAMES, "Received TRIGGER Frame\n");
376 pd->last_sent_frame = &pd->tx_queue;
377 if (oz_hdr->control & OZ_F_ACK) {
378 /* Retire completed frames */
379 oz_retire_tx_frames(pd, oz_hdr->last_pkt_num);
381 if ((oz_hdr->control & OZ_F_ACK_REQUESTED) &&
382 (pd->state == OZ_PD_S_CONNECTED)) {
383 int backlog = pd->nb_queued_frames;
384 pd->trigger_pkt_num = pkt_num;
385 /* Send queued frames */
386 oz_send_queued_frames(pd, backlog);
390 length -= sizeof(struct oz_hdr);
391 elt = (struct oz_elt *)((u8 *)oz_hdr + sizeof(struct oz_hdr));
393 while (length >= sizeof(struct oz_elt)) {
394 length -= sizeof(struct oz_elt) + elt->length;
398 case OZ_ELT_CONNECT_REQ:
399 oz_dbg(ON, "RX: OZ_ELT_CONNECT_REQ\n");
400 pd = oz_connect_req(pd, elt, src_addr, skb->dev);
402 case OZ_ELT_DISCONNECT:
403 oz_dbg(ON, "RX: OZ_ELT_DISCONNECT\n");
407 case OZ_ELT_UPDATE_PARAM_REQ: {
408 struct oz_elt_update_param *body =
409 (struct oz_elt_update_param *)(elt + 1);
410 oz_dbg(ON, "RX: OZ_ELT_UPDATE_PARAM_REQ\n");
411 if (pd && (pd->state & OZ_PD_S_CONNECTED)) {
412 spin_lock(&g_polling_lock);
413 pd_set_keepalive(pd, body->keepalive);
414 pd_set_presleep(pd, body->presleep, 1);
415 spin_unlock(&g_polling_lock);
419 case OZ_ELT_FAREWELL_REQ: {
420 struct oz_elt_farewell *body =
421 (struct oz_elt_farewell *)(elt + 1);
422 oz_dbg(ON, "RX: OZ_ELT_FAREWELL_REQ\n");
423 oz_add_farewell(pd, body->ep_num,
424 body->index, body->report,
425 elt->length + 1 - sizeof(*body));
428 case OZ_ELT_APP_DATA:
429 if (pd && (pd->state & OZ_PD_S_CONNECTED)) {
430 struct oz_app_hdr *app_hdr =
431 (struct oz_app_hdr *)(elt+1);
434 oz_handle_app_elt(pd, app_hdr->app_id, elt);
438 oz_dbg(ON, "RX: Unknown elt %02x\n", elt->type);
440 elt = oz_next_elt(elt);
451 void oz_protocol_term(void)
453 struct oz_binding *b, *t;
455 /* Walk the list of bindings and remove each one.
457 spin_lock_bh(&g_binding_lock);
458 list_for_each_entry_safe(b, t, &g_binding, link) {
460 spin_unlock_bh(&g_binding_lock);
461 dev_remove_pack(&b->ptype);
463 dev_put(b->ptype.dev);
465 spin_lock_bh(&g_binding_lock);
467 spin_unlock_bh(&g_binding_lock);
468 /* Walk the list of PDs and stop each one. This causes the PD to be
469 * removed from the list so we can just pull each one from the head
472 spin_lock_bh(&g_polling_lock);
473 while (!list_empty(&g_pd_list)) {
475 list_first_entry(&g_pd_list, struct oz_pd, link);
477 spin_unlock_bh(&g_polling_lock);
480 spin_lock_bh(&g_polling_lock);
482 spin_unlock_bh(&g_polling_lock);
483 oz_dbg(ON, "Protocol stopped\n");
489 void oz_pd_heartbeat_handler(unsigned long data)
491 struct oz_pd *pd = (struct oz_pd *)data;
494 spin_lock_bh(&g_polling_lock);
495 if (pd->state & OZ_PD_S_CONNECTED)
496 apps = pd->total_apps;
497 spin_unlock_bh(&g_polling_lock);
499 oz_pd_heartbeat(pd, apps);
506 void oz_pd_timeout_handler(unsigned long data)
509 struct oz_pd *pd = (struct oz_pd *)data;
511 spin_lock_bh(&g_polling_lock);
512 type = pd->timeout_type;
513 spin_unlock_bh(&g_polling_lock);
528 enum hrtimer_restart oz_pd_heartbeat_event(struct hrtimer *timer)
532 pd = container_of(timer, struct oz_pd, heartbeat);
533 hrtimer_forward_now(timer, ktime_set(pd->pulse_period /
534 MSEC_PER_SEC, (pd->pulse_period % MSEC_PER_SEC) * NSEC_PER_MSEC));
536 tasklet_schedule(&pd->heartbeat_tasklet);
537 return HRTIMER_RESTART;
543 enum hrtimer_restart oz_pd_timeout_event(struct hrtimer *timer)
547 pd = container_of(timer, struct oz_pd, timeout);
549 tasklet_schedule(&pd->timeout_tasklet);
550 return HRTIMER_NORESTART;
554 * Context: softirq or process
556 void oz_timer_add(struct oz_pd *pd, int type, unsigned long due_time)
558 spin_lock_bh(&g_polling_lock);
562 if (hrtimer_active(&pd->timeout)) {
563 hrtimer_set_expires(&pd->timeout, ktime_set(due_time /
564 MSEC_PER_SEC, (due_time % MSEC_PER_SEC) *
566 hrtimer_start_expires(&pd->timeout, HRTIMER_MODE_REL);
568 hrtimer_start(&pd->timeout, ktime_set(due_time /
569 MSEC_PER_SEC, (due_time % MSEC_PER_SEC) *
570 NSEC_PER_MSEC), HRTIMER_MODE_REL);
572 pd->timeout_type = type;
574 case OZ_TIMER_HEARTBEAT:
575 if (!hrtimer_active(&pd->heartbeat))
576 hrtimer_start(&pd->heartbeat, ktime_set(due_time /
577 MSEC_PER_SEC, (due_time % MSEC_PER_SEC) *
578 NSEC_PER_MSEC), HRTIMER_MODE_REL);
581 spin_unlock_bh(&g_polling_lock);
585 * Context: softirq or process
587 void oz_pd_request_heartbeat(struct oz_pd *pd)
589 oz_timer_add(pd, OZ_TIMER_HEARTBEAT, pd->pulse_period > 0 ?
590 pd->pulse_period : OZ_QUANTUM);
594 * Context: softirq or process
596 struct oz_pd *oz_pd_find(const u8 *mac_addr)
601 spin_lock_bh(&g_polling_lock);
602 list_for_each(e, &g_pd_list) {
603 pd = container_of(e, struct oz_pd, link);
604 if (ether_addr_equal(pd->mac_addr, mac_addr)) {
605 atomic_inc(&pd->ref_count);
606 spin_unlock_bh(&g_polling_lock);
610 spin_unlock_bh(&g_polling_lock);
617 void oz_app_enable(int app_id, int enable)
619 if (app_id <= OZ_APPID_MAX) {
620 spin_lock_bh(&g_polling_lock);
622 g_apps |= (1<<app_id);
624 g_apps &= ~(1<<app_id);
625 spin_unlock_bh(&g_polling_lock);
632 static int oz_pkt_recv(struct sk_buff *skb, struct net_device *dev,
633 struct packet_type *pt, struct net_device *orig_dev)
635 skb = skb_share_check(skb, GFP_ATOMIC);
638 spin_lock_bh(&g_rx_queue.lock);
639 if (g_processing_rx) {
640 /* We already hold the lock so use __ variant.
642 __skb_queue_head(&g_rx_queue, skb);
643 spin_unlock_bh(&g_rx_queue.lock);
648 spin_unlock_bh(&g_rx_queue.lock);
650 spin_lock_bh(&g_rx_queue.lock);
651 if (skb_queue_empty(&g_rx_queue)) {
653 spin_unlock_bh(&g_rx_queue.lock);
656 /* We already hold the lock so use __ variant.
658 skb = __skb_dequeue(&g_rx_queue);
667 void oz_binding_add(const char *net_dev)
669 struct oz_binding *binding;
671 binding = kzalloc(sizeof(struct oz_binding), GFP_KERNEL);
675 binding->ptype.type = htons(OZ_ETHERTYPE);
676 binding->ptype.func = oz_pkt_recv;
677 if (net_dev && *net_dev) {
678 memcpy(binding->name, net_dev, OZ_MAX_BINDING_LEN);
679 oz_dbg(ON, "Adding binding: %s\n", net_dev);
680 binding->ptype.dev = dev_get_by_name(&init_net, net_dev);
681 if (binding->ptype.dev == NULL) {
682 oz_dbg(ON, "Netdev %s not found\n", net_dev);
687 dev_add_pack(&binding->ptype);
688 spin_lock_bh(&g_binding_lock);
689 list_add_tail(&binding->link, &g_binding);
690 spin_unlock_bh(&g_binding_lock);
696 static void pd_stop_all_for_device(struct net_device *net_dev)
703 spin_lock_bh(&g_polling_lock);
704 list_for_each_entry_safe(pd, n, &g_pd_list, link) {
705 if (pd->net_dev == net_dev) {
706 list_move(&pd->link, &h);
710 spin_unlock_bh(&g_polling_lock);
711 while (!list_empty(&h)) {
712 pd = list_first_entry(&h, struct oz_pd, link);
721 void oz_binding_remove(const char *net_dev)
723 struct oz_binding *binding;
726 oz_dbg(ON, "Removing binding: %s\n", net_dev);
727 spin_lock_bh(&g_binding_lock);
728 list_for_each_entry(binding, &g_binding, link) {
729 if (strncmp(binding->name, net_dev, OZ_MAX_BINDING_LEN) == 0) {
730 oz_dbg(ON, "Binding '%s' found\n", net_dev);
735 spin_unlock_bh(&g_binding_lock);
737 dev_remove_pack(&binding->ptype);
738 if (binding->ptype.dev) {
739 dev_put(binding->ptype.dev);
740 pd_stop_all_for_device(binding->ptype.dev);
742 list_del(&binding->link);
750 static char *oz_get_next_device_name(char *s, char *dname, int max_size)
754 while (*s && (*s != ',') && max_size > 1) {
765 int oz_protocol_init(char *devs)
767 skb_queue_head_init(&g_rx_queue);
768 if (devs[0] == '*') {
769 oz_binding_add(NULL);
773 devs = oz_get_next_device_name(devs, d, sizeof(d));
784 int oz_get_pd_list(struct oz_mac_addr *addr, int max_count)
790 spin_lock_bh(&g_polling_lock);
791 list_for_each(e, &g_pd_list) {
792 if (count >= max_count)
794 pd = container_of(e, struct oz_pd, link);
795 ether_addr_copy((u8 *)&addr[count++], pd->mac_addr);
797 spin_unlock_bh(&g_polling_lock);