1 /* -----------------------------------------------------------------------------
2 * Copyright (c) 2011 Ozmo Inc
3 * Released under the GNU General Public License Version 2 (GPLv2).
4 * -----------------------------------------------------------------------------
7 #include <linux/init.h>
8 #include <linux/module.h>
9 #include <linux/timer.h>
10 #include <linux/sched.h>
11 #include <linux/netdevice.h>
12 #include <linux/etherdevice.h>
13 #include <linux/errno.h>
14 #include <linux/ieee80211.h>
16 #include "ozprotocol.h"
23 #include <asm/unaligned.h>
24 #include <linux/uaccess.h>
25 #include <net/psnap.h>
27 #define OZ_CF_CONN_SUCCESS 1
28 #define OZ_CF_CONN_FAILURE 2
33 #define OZ_MAX_TIMER_POOL_SIZE 16
36 struct packet_type ptype;
37 char name[OZ_MAX_BINDING_LEN];
38 struct list_head link;
42 * Static external variables.
44 static DEFINE_SPINLOCK(g_polling_lock);
45 static LIST_HEAD(g_pd_list);
46 static LIST_HEAD(g_binding);
47 static DEFINE_SPINLOCK(g_binding_lock);
48 static struct sk_buff_head g_rx_queue;
49 static u8 g_session_id;
50 static u16 g_apps = 0x1;
51 static int g_processing_rx;
54 * Context: softirq-serialized
56 static u8 oz_get_new_session_id(u8 exclude)
58 if (++g_session_id == 0)
60 if (g_session_id == exclude) {
61 if (++g_session_id == 0)
68 * Context: softirq-serialized
70 static void oz_send_conn_rsp(struct oz_pd *pd, u8 status)
73 struct net_device *dev = pd->net_dev;
74 struct oz_hdr *oz_hdr;
76 struct oz_elt_connect_rsp *body;
78 int sz = sizeof(struct oz_hdr) + sizeof(struct oz_elt) +
79 sizeof(struct oz_elt_connect_rsp);
80 skb = alloc_skb(sz + OZ_ALLOCATED_SPACE(dev), GFP_ATOMIC);
83 skb_reserve(skb, LL_RESERVED_SPACE(dev));
84 skb_reset_network_header(skb);
85 oz_hdr = (struct oz_hdr *)skb_put(skb, sz);
86 elt = (struct oz_elt *)(oz_hdr+1);
87 body = (struct oz_elt_connect_rsp *)(elt+1);
89 skb->protocol = htons(OZ_ETHERTYPE);
90 /* Fill in device header */
91 if (dev_hard_header(skb, dev, OZ_ETHERTYPE, pd->mac_addr,
92 dev->dev_addr, skb->len) < 0) {
96 oz_hdr->control = (OZ_PROTOCOL_VERSION<<OZ_VERSION_SHIFT);
97 oz_hdr->last_pkt_num = 0;
98 put_unaligned(0, &oz_hdr->pkt_num);
99 elt->type = OZ_ELT_CONNECT_RSP;
100 elt->length = sizeof(struct oz_elt_connect_rsp);
101 memset(body, 0, sizeof(struct oz_elt_connect_rsp));
102 body->status = status;
104 body->mode = pd->mode;
105 body->session_id = pd->session_id;
106 put_unaligned(cpu_to_le16(pd->total_apps), &body->apps);
108 oz_dbg(ON, "TX: OZ_ELT_CONNECT_RSP %d", status);
114 * Context: softirq-serialized
116 static void pd_set_keepalive(struct oz_pd *pd, u8 kalive)
118 unsigned long keep_alive = kalive & OZ_KALIVE_VALUE_MASK;
120 switch (kalive & OZ_KALIVE_TYPE_MASK) {
121 case OZ_KALIVE_SPECIAL:
122 pd->keep_alive = keep_alive * 1000*60*60*24*20;
125 pd->keep_alive = keep_alive*1000;
128 pd->keep_alive = keep_alive*1000*60;
130 case OZ_KALIVE_HOURS:
131 pd->keep_alive = keep_alive*1000*60*60;
136 oz_dbg(ON, "Keepalive = %lu mSec\n", pd->keep_alive);
140 * Context: softirq-serialized
142 static void pd_set_presleep(struct oz_pd *pd, u8 presleep, u8 start_timer)
145 pd->presleep = presleep*100;
147 pd->presleep = OZ_PRESLEEP_TOUT;
149 spin_unlock(&g_polling_lock);
150 oz_timer_add(pd, OZ_TIMER_TOUT, pd->presleep);
151 spin_lock(&g_polling_lock);
153 oz_dbg(ON, "Presleep time = %lu mSec\n", pd->presleep);
157 * Context: softirq-serialized
159 static struct oz_pd *oz_connect_req(struct oz_pd *cur_pd, struct oz_elt *elt,
160 const u8 *pd_addr, struct net_device *net_dev)
163 struct oz_elt_connect_req *body =
164 (struct oz_elt_connect_req *)(elt+1);
165 u8 rsp_status = OZ_STATUS_SUCCESS;
167 u16 new_apps = g_apps;
168 struct net_device *old_net_dev = NULL;
169 struct oz_pd *free_pd = NULL;
173 spin_lock_bh(&g_polling_lock);
175 struct oz_pd *pd2 = NULL;
177 pd = oz_pd_alloc(pd_addr);
180 getnstimeofday(&pd->last_rx_timestamp);
181 spin_lock_bh(&g_polling_lock);
182 list_for_each(e, &g_pd_list) {
183 pd2 = container_of(e, struct oz_pd, link);
184 if (ether_addr_equal(pd2->mac_addr, pd_addr)) {
191 list_add_tail(&pd->link, &g_pd_list);
194 spin_unlock_bh(&g_polling_lock);
197 if (pd->net_dev != net_dev) {
198 old_net_dev = pd->net_dev;
200 pd->net_dev = net_dev;
202 oz_dbg(ON, "Host vendor: %d\n", body->host_vendor);
203 pd->max_tx_size = OZ_MAX_TX_SIZE;
204 pd->mode = body->mode;
205 pd->pd_info = body->pd_info;
206 if (pd->mode & OZ_F_ISOC_NO_ELTS) {
207 pd->ms_per_isoc = body->ms_per_isoc;
208 if (!pd->ms_per_isoc)
211 switch (body->ms_isoc_latency & OZ_LATENCY_MASK) {
212 case OZ_ONE_MS_LATENCY:
213 pd->isoc_latency = (body->ms_isoc_latency &
214 ~OZ_LATENCY_MASK) / pd->ms_per_isoc;
216 case OZ_TEN_MS_LATENCY:
217 pd->isoc_latency = ((body->ms_isoc_latency &
218 ~OZ_LATENCY_MASK) * 10) / pd->ms_per_isoc;
221 pd->isoc_latency = OZ_MAX_TX_QUEUE_ISOC;
224 if (body->max_len_div16)
225 pd->max_tx_size = ((u16)body->max_len_div16)<<4;
226 oz_dbg(ON, "Max frame:%u Ms per isoc:%u\n",
227 pd->max_tx_size, pd->ms_per_isoc);
228 pd->max_stream_buffering = 3*1024;
229 pd->pulse_period = OZ_QUANTUM;
230 pd_set_presleep(pd, body->presleep, 0);
231 pd_set_keepalive(pd, body->keep_alive);
233 new_apps &= le16_to_cpu(get_unaligned(&body->apps));
234 if ((new_apps & 0x1) && (body->session_id)) {
235 if (pd->session_id) {
236 if (pd->session_id != body->session_id) {
237 rsp_status = OZ_STATUS_SESSION_MISMATCH;
241 new_apps &= ~0x1; /* Resume not permitted */
243 oz_get_new_session_id(body->session_id);
246 if (pd->session_id && !body->session_id) {
247 rsp_status = OZ_STATUS_SESSION_TEARDOWN;
250 new_apps &= ~0x1; /* Resume not permitted */
252 oz_get_new_session_id(body->session_id);
256 if (rsp_status == OZ_STATUS_SUCCESS) {
257 u16 start_apps = new_apps & ~pd->total_apps & ~0x1;
258 u16 stop_apps = pd->total_apps & ~new_apps & ~0x1;
259 u16 resume_apps = new_apps & pd->paused_apps & ~0x1;
260 spin_unlock_bh(&g_polling_lock);
261 oz_pd_set_state(pd, OZ_PD_S_CONNECTED);
262 oz_dbg(ON, "new_apps=0x%x total_apps=0x%x paused_apps=0x%x\n",
263 new_apps, pd->total_apps, pd->paused_apps);
265 if (oz_services_start(pd, start_apps, 0))
266 rsp_status = OZ_STATUS_TOO_MANY_PDS;
269 if (oz_services_start(pd, resume_apps, 1))
270 rsp_status = OZ_STATUS_TOO_MANY_PDS;
272 oz_services_stop(pd, stop_apps, 0);
273 oz_pd_request_heartbeat(pd);
275 spin_unlock_bh(&g_polling_lock);
277 oz_send_conn_rsp(pd, rsp_status);
278 if (rsp_status != OZ_STATUS_SUCCESS) {
285 dev_put(old_net_dev);
287 oz_pd_destroy(free_pd);
292 * Context: softirq-serialized
294 static void oz_add_farewell(struct oz_pd *pd, u8 ep_num, u8 index,
295 const u8 *report, u8 len)
297 struct oz_farewell *f;
298 struct oz_farewell *f2;
301 f = kmalloc(sizeof(struct oz_farewell) + len, GFP_ATOMIC);
307 memcpy(f->report, report, len);
308 oz_dbg(ON, "RX: Adding farewell report\n");
309 spin_lock(&g_polling_lock);
310 list_for_each_entry(f2, &pd->farewell_list, link) {
311 if ((f2->ep_num == ep_num) && (f2->index == index)) {
317 list_add_tail(&f->link, &pd->farewell_list);
318 spin_unlock(&g_polling_lock);
324 * Context: softirq-serialized
326 static void oz_rx_frame(struct sk_buff *skb)
332 struct oz_pd *pd = NULL;
333 struct oz_hdr *oz_hdr = (struct oz_hdr *)skb_network_header(skb);
334 struct timespec current_time;
338 oz_dbg(RX_FRAMES, "RX frame PN=0x%x LPN=0x%x control=0x%x\n",
339 oz_hdr->pkt_num, oz_hdr->last_pkt_num, oz_hdr->control);
340 mac_hdr = skb_mac_header(skb);
341 src_addr = &mac_hdr[ETH_ALEN] ;
344 /* Check the version field */
345 if (oz_get_prot_ver(oz_hdr->control) != OZ_PROTOCOL_VERSION) {
346 oz_dbg(ON, "Incorrect protocol version: %d\n",
347 oz_get_prot_ver(oz_hdr->control));
351 pkt_num = le32_to_cpu(get_unaligned(&oz_hdr->pkt_num));
353 pd = oz_pd_find(src_addr);
355 if (!(pd->state & OZ_PD_S_CONNECTED))
356 oz_pd_set_state(pd, OZ_PD_S_CONNECTED);
357 getnstimeofday(¤t_time);
358 if ((current_time.tv_sec != pd->last_rx_timestamp.tv_sec) ||
359 (pd->presleep < MSEC_PER_SEC)) {
360 oz_timer_add(pd, OZ_TIMER_TOUT, pd->presleep);
361 pd->last_rx_timestamp = current_time;
363 if (pkt_num != pd->last_rx_pkt_num) {
364 pd->last_rx_pkt_num = pkt_num;
367 oz_dbg(ON, "Duplicate frame\n");
371 if (pd && !dup && ((pd->mode & OZ_MODE_MASK) == OZ_MODE_TRIGGERED)) {
372 oz_dbg(RX_FRAMES, "Received TRIGGER Frame\n");
373 pd->last_sent_frame = &pd->tx_queue;
374 if (oz_hdr->control & OZ_F_ACK) {
375 /* Retire completed frames */
376 oz_retire_tx_frames(pd, oz_hdr->last_pkt_num);
378 if ((oz_hdr->control & OZ_F_ACK_REQUESTED) &&
379 (pd->state == OZ_PD_S_CONNECTED)) {
380 int backlog = pd->nb_queued_frames;
381 pd->trigger_pkt_num = pkt_num;
382 /* Send queued frames */
383 oz_send_queued_frames(pd, backlog);
387 length -= sizeof(struct oz_hdr);
388 elt = (struct oz_elt *)((u8 *)oz_hdr + sizeof(struct oz_hdr));
390 while (length >= sizeof(struct oz_elt)) {
391 length -= sizeof(struct oz_elt) + elt->length;
395 case OZ_ELT_CONNECT_REQ:
396 oz_dbg(ON, "RX: OZ_ELT_CONNECT_REQ\n");
397 pd = oz_connect_req(pd, elt, src_addr, skb->dev);
399 case OZ_ELT_DISCONNECT:
400 oz_dbg(ON, "RX: OZ_ELT_DISCONNECT\n");
404 case OZ_ELT_UPDATE_PARAM_REQ: {
405 struct oz_elt_update_param *body =
406 (struct oz_elt_update_param *)(elt + 1);
407 oz_dbg(ON, "RX: OZ_ELT_UPDATE_PARAM_REQ\n");
408 if (pd && (pd->state & OZ_PD_S_CONNECTED)) {
409 spin_lock(&g_polling_lock);
410 pd_set_keepalive(pd, body->keepalive);
411 pd_set_presleep(pd, body->presleep, 1);
412 spin_unlock(&g_polling_lock);
416 case OZ_ELT_FAREWELL_REQ: {
417 struct oz_elt_farewell *body =
418 (struct oz_elt_farewell *)(elt + 1);
419 oz_dbg(ON, "RX: OZ_ELT_FAREWELL_REQ\n");
420 oz_add_farewell(pd, body->ep_num,
421 body->index, body->report,
422 elt->length + 1 - sizeof(*body));
425 case OZ_ELT_APP_DATA:
426 if (pd && (pd->state & OZ_PD_S_CONNECTED)) {
427 struct oz_app_hdr *app_hdr =
428 (struct oz_app_hdr *)(elt+1);
431 oz_handle_app_elt(pd, app_hdr->app_id, elt);
435 oz_dbg(ON, "RX: Unknown elt %02x\n", elt->type);
437 elt = oz_next_elt(elt);
448 void oz_protocol_term(void)
450 struct oz_binding *b, *t;
452 /* Walk the list of bindings and remove each one.
454 spin_lock_bh(&g_binding_lock);
455 list_for_each_entry_safe(b, t, &g_binding, link) {
457 spin_unlock_bh(&g_binding_lock);
458 dev_remove_pack(&b->ptype);
460 dev_put(b->ptype.dev);
462 spin_lock_bh(&g_binding_lock);
464 spin_unlock_bh(&g_binding_lock);
465 /* Walk the list of PDs and stop each one. This causes the PD to be
466 * removed from the list so we can just pull each one from the head
469 spin_lock_bh(&g_polling_lock);
470 while (!list_empty(&g_pd_list)) {
472 list_first_entry(&g_pd_list, struct oz_pd, link);
474 spin_unlock_bh(&g_polling_lock);
477 spin_lock_bh(&g_polling_lock);
479 spin_unlock_bh(&g_polling_lock);
480 oz_dbg(ON, "Protocol stopped\n");
486 void oz_pd_heartbeat_handler(unsigned long data)
488 struct oz_pd *pd = (struct oz_pd *)data;
491 spin_lock_bh(&g_polling_lock);
492 if (pd->state & OZ_PD_S_CONNECTED)
493 apps = pd->total_apps;
494 spin_unlock_bh(&g_polling_lock);
496 oz_pd_heartbeat(pd, apps);
503 void oz_pd_timeout_handler(unsigned long data)
506 struct oz_pd *pd = (struct oz_pd *)data;
508 spin_lock_bh(&g_polling_lock);
509 type = pd->timeout_type;
510 spin_unlock_bh(&g_polling_lock);
525 enum hrtimer_restart oz_pd_heartbeat_event(struct hrtimer *timer)
529 pd = container_of(timer, struct oz_pd, heartbeat);
530 hrtimer_forward_now(timer, ktime_set(pd->pulse_period /
531 MSEC_PER_SEC, (pd->pulse_period % MSEC_PER_SEC) * NSEC_PER_MSEC));
533 tasklet_schedule(&pd->heartbeat_tasklet);
534 return HRTIMER_RESTART;
540 enum hrtimer_restart oz_pd_timeout_event(struct hrtimer *timer)
544 pd = container_of(timer, struct oz_pd, timeout);
546 tasklet_schedule(&pd->timeout_tasklet);
547 return HRTIMER_NORESTART;
551 * Context: softirq or process
553 void oz_timer_add(struct oz_pd *pd, int type, unsigned long due_time)
555 spin_lock_bh(&g_polling_lock);
559 if (hrtimer_active(&pd->timeout)) {
560 hrtimer_set_expires(&pd->timeout, ktime_set(due_time /
561 MSEC_PER_SEC, (due_time % MSEC_PER_SEC) *
563 hrtimer_start_expires(&pd->timeout, HRTIMER_MODE_REL);
565 hrtimer_start(&pd->timeout, ktime_set(due_time /
566 MSEC_PER_SEC, (due_time % MSEC_PER_SEC) *
567 NSEC_PER_MSEC), HRTIMER_MODE_REL);
569 pd->timeout_type = type;
571 case OZ_TIMER_HEARTBEAT:
572 if (!hrtimer_active(&pd->heartbeat))
573 hrtimer_start(&pd->heartbeat, ktime_set(due_time /
574 MSEC_PER_SEC, (due_time % MSEC_PER_SEC) *
575 NSEC_PER_MSEC), HRTIMER_MODE_REL);
578 spin_unlock_bh(&g_polling_lock);
582 * Context: softirq or process
584 void oz_pd_request_heartbeat(struct oz_pd *pd)
586 oz_timer_add(pd, OZ_TIMER_HEARTBEAT, pd->pulse_period > 0 ?
587 pd->pulse_period : OZ_QUANTUM);
591 * Context: softirq or process
593 struct oz_pd *oz_pd_find(const u8 *mac_addr)
598 spin_lock_bh(&g_polling_lock);
599 list_for_each(e, &g_pd_list) {
600 pd = container_of(e, struct oz_pd, link);
601 if (ether_addr_equal(pd->mac_addr, mac_addr)) {
602 atomic_inc(&pd->ref_count);
603 spin_unlock_bh(&g_polling_lock);
607 spin_unlock_bh(&g_polling_lock);
614 void oz_app_enable(int app_id, int enable)
616 if (app_id <= OZ_APPID_MAX) {
617 spin_lock_bh(&g_polling_lock);
619 g_apps |= (1<<app_id);
621 g_apps &= ~(1<<app_id);
622 spin_unlock_bh(&g_polling_lock);
629 static int oz_pkt_recv(struct sk_buff *skb, struct net_device *dev,
630 struct packet_type *pt, struct net_device *orig_dev)
632 skb = skb_share_check(skb, GFP_ATOMIC);
635 spin_lock_bh(&g_rx_queue.lock);
636 if (g_processing_rx) {
637 /* We already hold the lock so use __ variant.
639 __skb_queue_head(&g_rx_queue, skb);
640 spin_unlock_bh(&g_rx_queue.lock);
645 spin_unlock_bh(&g_rx_queue.lock);
647 spin_lock_bh(&g_rx_queue.lock);
648 if (skb_queue_empty(&g_rx_queue)) {
650 spin_unlock_bh(&g_rx_queue.lock);
653 /* We already hold the lock so use __ variant.
655 skb = __skb_dequeue(&g_rx_queue);
664 void oz_binding_add(const char *net_dev)
666 struct oz_binding *binding;
668 binding = kmalloc(sizeof(struct oz_binding), GFP_KERNEL);
670 binding->ptype.type = __constant_htons(OZ_ETHERTYPE);
671 binding->ptype.func = oz_pkt_recv;
672 memcpy(binding->name, net_dev, OZ_MAX_BINDING_LEN);
673 if (net_dev && *net_dev) {
674 oz_dbg(ON, "Adding binding: %s\n", net_dev);
676 dev_get_by_name(&init_net, net_dev);
677 if (binding->ptype.dev == NULL) {
678 oz_dbg(ON, "Netdev %s not found\n", net_dev);
683 oz_dbg(ON, "Binding to all netcards\n");
684 binding->ptype.dev = NULL;
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);
698 static void pd_stop_all_for_device(struct net_device *net_dev)
705 spin_lock_bh(&g_polling_lock);
706 list_for_each_entry_safe(pd, n, &g_pd_list, link) {
707 if (pd->net_dev == net_dev) {
708 list_move(&pd->link, &h);
712 spin_unlock_bh(&g_polling_lock);
713 while (!list_empty(&h)) {
714 pd = list_first_entry(&h, struct oz_pd, link);
723 void oz_binding_remove(const char *net_dev)
725 struct oz_binding *binding;
728 oz_dbg(ON, "Removing binding: %s\n", net_dev);
729 spin_lock_bh(&g_binding_lock);
730 list_for_each_entry(binding, &g_binding, link) {
731 if (strncmp(binding->name, net_dev, OZ_MAX_BINDING_LEN) == 0) {
732 oz_dbg(ON, "Binding '%s' found\n", net_dev);
737 spin_unlock_bh(&g_binding_lock);
739 dev_remove_pack(&binding->ptype);
740 if (binding->ptype.dev) {
741 dev_put(binding->ptype.dev);
742 pd_stop_all_for_device(binding->ptype.dev);
744 list_del(&binding->link);
752 static char *oz_get_next_device_name(char *s, char *dname, int max_size)
756 while (*s && (*s != ',') && max_size > 1) {
767 int oz_protocol_init(char *devs)
769 skb_queue_head_init(&g_rx_queue);
770 if (devs && (devs[0] == '*')) {
771 oz_binding_add(NULL);
775 devs = oz_get_next_device_name(devs, d, sizeof(d));
786 int oz_get_pd_list(struct oz_mac_addr *addr, int max_count)
792 spin_lock_bh(&g_polling_lock);
793 list_for_each(e, &g_pd_list) {
794 if (count >= max_count)
796 pd = container_of(e, struct oz_pd, link);
797 memcpy(&addr[count++], pd->mac_addr, ETH_ALEN);
799 spin_unlock_bh(&g_polling_lock);
803 void oz_polling_lock_bh(void)
805 spin_lock_bh(&g_polling_lock);
808 void oz_polling_unlock_bh(void)
810 spin_unlock_bh(&g_polling_lock);