1 /*********************************************************************
5 * Description: IrLAP QoS parameter negotiation
7 * Author: Dag Brattli <dagb@cs.uit.no>
8 * Created at: Tue Sep 9 00:00:26 1997
9 * Modified at: Sun Jan 30 14:29:16 2000
10 * Modified by: Dag Brattli <dagb@cs.uit.no>
12 * Copyright (c) 1998-2000 Dag Brattli <dagb@cs.uit.no>,
13 * All Rights Reserved.
14 * Copyright (c) 2000-2001 Jean Tourrilhes <jt@hpl.hp.com>
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License as
18 * published by the Free Software Foundation; either version 2 of
19 * the License, or (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
31 ********************************************************************/
33 #include <linux/config.h>
34 #include <asm/byteorder.h>
36 #include <net/irda/irda.h>
37 #include <net/irda/parameters.h>
38 #include <net/irda/qos.h>
39 #include <net/irda/irlap.h>
42 * Maximum values of the baud rate we negociate with the other end.
43 * Most often, you don't have to change that, because Linux-IrDA will
44 * use the maximum offered by the link layer, which usually works fine.
45 * In some very rare cases, you may want to limit it to lower speeds...
47 int sysctl_max_baud_rate = 16000000;
49 * Maximum value of the lap disconnect timer we negociate with the other end.
50 * Most often, the value below represent the best compromise, but some user
51 * may want to keep the LAP alive longuer or shorter in case of link failure.
52 * Remember that the threshold time (early warning) is fixed to 3s...
54 int sysctl_max_noreply_time = 12;
56 * Minimum turn time to be applied before transmitting to the peer.
57 * Nonzero values (usec) are used as lower limit to the per-connection
58 * mtt value which was announced by the other end during negotiation.
59 * Might be helpful if the peer device provides too short mtt.
60 * Default is 10 which means using the unmodified value given by the peer
61 * except if it's 0 (0 is likely a bug in the other stack).
63 unsigned sysctl_min_tx_turn_time = 10;
65 static int irlap_param_baud_rate(void *instance, irda_param_t *param, int get);
66 static int irlap_param_link_disconnect(void *instance, irda_param_t *parm,
68 static int irlap_param_max_turn_time(void *instance, irda_param_t *param,
70 static int irlap_param_data_size(void *instance, irda_param_t *param, int get);
71 static int irlap_param_window_size(void *instance, irda_param_t *param,
73 static int irlap_param_additional_bofs(void *instance, irda_param_t *parm,
75 static int irlap_param_min_turn_time(void *instance, irda_param_t *param,
78 __u32 min_turn_times[] = { 10000, 5000, 1000, 500, 100, 50, 10, 0 }; /* us */
79 __u32 baud_rates[] = { 2400, 9600, 19200, 38400, 57600, 115200, 576000,
80 1152000, 4000000, 16000000 }; /* bps */
81 __u32 data_sizes[] = { 64, 128, 256, 512, 1024, 2048 }; /* bytes */
82 __u32 add_bofs[] = { 48, 24, 12, 5, 3, 2, 1, 0 }; /* bytes */
83 __u32 max_turn_times[] = { 500, 250, 100, 50 }; /* ms */
84 __u32 link_disc_times[] = { 3, 8, 12, 16, 20, 25, 30, 40 }; /* secs */
86 __u32 max_line_capacities[10][4] = {
87 /* 500 ms 250 ms 100 ms 50 ms (max turn time) */
88 { 100, 0, 0, 0 }, /* 2400 bps */
89 { 400, 0, 0, 0 }, /* 9600 bps */
90 { 800, 0, 0, 0 }, /* 19200 bps */
91 { 1600, 0, 0, 0 }, /* 38400 bps */
92 { 2360, 0, 0, 0 }, /* 57600 bps */
93 { 4800, 2400, 960, 480 }, /* 115200 bps */
94 { 28800, 11520, 5760, 2880 }, /* 576000 bps */
95 { 57600, 28800, 11520, 5760 }, /* 1152000 bps */
96 { 200000, 100000, 40000, 20000 }, /* 4000000 bps */
97 { 800000, 400000, 160000, 80000 }, /* 16000000 bps */
100 static pi_minor_info_t pi_minor_call_table_type_0[] = {
102 /* 01 */{ irlap_param_baud_rate, PV_INTEGER | PV_LITTLE_ENDIAN },
109 /* 08 */{ irlap_param_link_disconnect, PV_INT_8_BITS }
112 static pi_minor_info_t pi_minor_call_table_type_1[] = {
115 /* 82 */{ irlap_param_max_turn_time, PV_INT_8_BITS },
116 /* 83 */{ irlap_param_data_size, PV_INT_8_BITS },
117 /* 84 */{ irlap_param_window_size, PV_INT_8_BITS },
118 /* 85 */{ irlap_param_additional_bofs, PV_INT_8_BITS },
119 /* 86 */{ irlap_param_min_turn_time, PV_INT_8_BITS },
122 static pi_major_info_t pi_major_call_table[] = {
123 { pi_minor_call_table_type_0, 9 },
124 { pi_minor_call_table_type_1, 7 },
127 static pi_param_info_t irlap_param_info = { pi_major_call_table, 2, 0x7f, 7 };
129 /* ---------------------- LOCAL SUBROUTINES ---------------------- */
130 /* Note : we start with a bunch of local subroutines.
131 * As the compiler is "one pass", this is the only way to get them to
136 * Function value_index (value, array, size)
138 * Returns the index to the value in the specified array
140 static inline int value_index(__u32 value, __u32 *array, int size)
144 for (i=0; i < size; i++)
145 if (array[i] == value)
151 * Function index_value (index, array)
153 * Returns value to index in array, easy!
156 static inline __u32 index_value(int index, __u32 *array)
162 * Function msb_index (word)
164 * Returns index to most significant bit (MSB) in word
167 int msb_index (__u16 word)
170 int index = 15; /* Current MSB */
174 break; /* Found it! */
181 static inline __u32 byte_value(__u8 byte, __u32 *array)
185 ASSERT(array != NULL, return -1;);
187 index = msb_index(byte);
189 return index_value(index, array);
193 * Function value_lower_bits (value, array)
195 * Returns a bit field marking all possibility lower than value.
197 static inline int value_lower_bits(__u32 value, __u32 *array, int size, __u16 *field)
203 for (i=0; i < size; i++) {
204 /* Add the current value to the bit field, shift mask */
208 if (array[i] >= value)
211 /* Send back a valid index */
213 i = size - 1; /* Last item */
219 * Function value_highest_bit (value, array)
221 * Returns a bit field marking the highest possibility lower than value.
223 static inline int value_highest_bit(__u32 value, __u32 *array, int size, __u16 *field)
229 for (i=0; i < size; i++) {
231 if (array[i] <= value)
236 /* Set the current value to the bit field */
238 /* Send back a valid index */
240 i = size - 1; /* Last item */
245 /* -------------------------- MAIN CALLS -------------------------- */
248 * Function irda_qos_compute_intersection (qos, new)
250 * Compute the intersection of the old QoS capabilites with new ones
253 void irda_qos_compute_intersection(struct qos_info *qos, struct qos_info *new)
255 ASSERT(qos != NULL, return;);
256 ASSERT(new != NULL, return;);
259 qos->baud_rate.bits &= new->baud_rate.bits;
260 qos->window_size.bits &= new->window_size.bits;
261 qos->min_turn_time.bits &= new->min_turn_time.bits;
262 qos->max_turn_time.bits &= new->max_turn_time.bits;
263 qos->data_size.bits &= new->data_size.bits;
264 qos->link_disc_time.bits &= new->link_disc_time.bits;
265 qos->additional_bofs.bits &= new->additional_bofs.bits;
267 irda_qos_bits_to_value(qos);
271 * Function irda_init_max_qos_capabilies (qos)
273 * The purpose of this function is for layers and drivers to be able to
274 * set the maximum QoS possible and then "and in" their own limitations
277 void irda_init_max_qos_capabilies(struct qos_info *qos)
281 * These are the maximum supported values as specified on pages
285 /* Use sysctl to set some configurable values... */
286 /* Set configured max speed */
287 i = value_lower_bits(sysctl_max_baud_rate, baud_rates, 10,
288 &qos->baud_rate.bits);
289 sysctl_max_baud_rate = index_value(i, baud_rates);
291 /* Set configured max disc time */
292 i = value_lower_bits(sysctl_max_noreply_time, link_disc_times, 8,
293 &qos->link_disc_time.bits);
294 sysctl_max_noreply_time = index_value(i, link_disc_times);
296 /* LSB is first byte, MSB is second byte */
297 qos->baud_rate.bits &= 0x03ff;
299 qos->window_size.bits = 0x7f;
300 qos->min_turn_time.bits = 0xff;
301 qos->max_turn_time.bits = 0x0f;
302 qos->data_size.bits = 0x3f;
303 qos->link_disc_time.bits &= 0xff;
304 qos->additional_bofs.bits = 0xff;
308 * Function irlap_adjust_qos_settings (qos)
310 * Adjust QoS settings in case some values are not possible to use because
313 void irlap_adjust_qos_settings(struct qos_info *qos)
318 IRDA_DEBUG(2, __FUNCTION__ "()\n");
321 * Make sure the mintt is sensible.
323 if (sysctl_min_tx_turn_time > qos->min_turn_time.value) {
326 /* We don't really need bits, but easier this way */
327 i = value_highest_bit(sysctl_min_tx_turn_time, min_turn_times,
328 8, &qos->min_turn_time.bits);
329 sysctl_min_tx_turn_time = index_value(i, min_turn_times);
330 qos->min_turn_time.value = sysctl_min_tx_turn_time;
334 * Not allowed to use a max turn time less than 500 ms if the baudrate
335 * is less than 115200
337 if ((qos->baud_rate.value < 115200) &&
338 (qos->max_turn_time.value < 500))
340 IRDA_DEBUG(0, __FUNCTION__
341 "(), adjusting max turn time from %d to 500 ms\n",
342 qos->max_turn_time.value);
343 qos->max_turn_time.value = 500;
347 * The data size must be adjusted according to the baud rate and max
350 index = value_index(qos->data_size.value, data_sizes, 6);
351 line_capacity = irlap_max_line_capacity(qos->baud_rate.value,
352 qos->max_turn_time.value);
354 #ifdef CONFIG_IRDA_DYNAMIC_WINDOW
355 while ((qos->data_size.value > line_capacity) && (index > 0)) {
356 qos->data_size.value = data_sizes[index--];
357 IRDA_DEBUG(2, __FUNCTION__
358 "(), redusing data size to %d\n",
359 qos->data_size.value);
361 #else /* Use method descibed in section 6.6.11 of IrLAP */
362 while (irlap_requested_line_capacity(qos) > line_capacity) {
363 ASSERT(index != 0, return;);
365 /* Must be able to send at least one frame */
366 if (qos->window_size.value > 1) {
367 qos->window_size.value--;
368 IRDA_DEBUG(2, __FUNCTION__
369 "(), redusing window size to %d\n",
370 qos->window_size.value);
371 } else if (index > 1) {
372 qos->data_size.value = data_sizes[index--];
373 IRDA_DEBUG(2, __FUNCTION__
374 "(), redusing data size to %d\n",
375 qos->data_size.value);
377 WARNING(__FUNCTION__ "(), nothing more we can do!\n");
380 #endif /* CONFIG_IRDA_DYNAMIC_WINDOW */
384 * Function irlap_negotiate (qos_device, qos_session, skb)
386 * Negotiate QoS values, not really that much negotiation :-)
387 * We just set the QoS capabilities for the peer station
390 int irlap_qos_negotiate(struct irlap_cb *self, struct sk_buff *skb)
394 ret = irda_param_extract_all(self, skb->data, skb->len,
397 /* Convert the negotiated bits to values */
398 irda_qos_bits_to_value(&self->qos_tx);
399 irda_qos_bits_to_value(&self->qos_rx);
401 irlap_adjust_qos_settings(&self->qos_tx);
403 IRDA_DEBUG(2, "Setting BAUD_RATE to %d bps.\n",
404 self->qos_tx.baud_rate.value);
405 IRDA_DEBUG(2, "Setting DATA_SIZE to %d bytes\n",
406 self->qos_tx.data_size.value);
407 IRDA_DEBUG(2, "Setting WINDOW_SIZE to %d\n",
408 self->qos_tx.window_size.value);
409 IRDA_DEBUG(2, "Setting XBOFS to %d\n",
410 self->qos_tx.additional_bofs.value);
411 IRDA_DEBUG(2, "Setting MAX_TURN_TIME to %d ms.\n",
412 self->qos_tx.max_turn_time.value);
413 IRDA_DEBUG(2, "Setting MIN_TURN_TIME to %d usecs.\n",
414 self->qos_tx.min_turn_time.value);
415 IRDA_DEBUG(2, "Setting LINK_DISC to %d secs.\n",
416 self->qos_tx.link_disc_time.value);
421 * Function irlap_insert_negotiation_params (qos, fp)
423 * Insert QoS negotiaion pararameters into frame
426 int irlap_insert_qos_negotiation_params(struct irlap_cb *self,
431 /* Insert data rate */
432 ret = irda_param_insert(self, PI_BAUD_RATE, skb->tail,
433 skb_tailroom(skb), &irlap_param_info);
438 /* Insert max turnaround time */
439 ret = irda_param_insert(self, PI_MAX_TURN_TIME, skb->tail,
440 skb_tailroom(skb), &irlap_param_info);
445 /* Insert data size */
446 ret = irda_param_insert(self, PI_DATA_SIZE, skb->tail,
447 skb_tailroom(skb), &irlap_param_info);
452 /* Insert window size */
453 ret = irda_param_insert(self, PI_WINDOW_SIZE, skb->tail,
454 skb_tailroom(skb), &irlap_param_info);
459 /* Insert additional BOFs */
460 ret = irda_param_insert(self, PI_ADD_BOFS, skb->tail,
461 skb_tailroom(skb), &irlap_param_info);
466 /* Insert minimum turnaround time */
467 ret = irda_param_insert(self, PI_MIN_TURN_TIME, skb->tail,
468 skb_tailroom(skb), &irlap_param_info);
473 /* Insert link disconnect/threshold time */
474 ret = irda_param_insert(self, PI_LINK_DISC, skb->tail,
475 skb_tailroom(skb), &irlap_param_info);
484 * Function irlap_param_baud_rate (instance, param, get)
486 * Negotiate data-rate
489 static int irlap_param_baud_rate(void *instance, irda_param_t *param, int get)
493 struct irlap_cb *self = (struct irlap_cb *) instance;
495 ASSERT(self != NULL, return -1;);
496 ASSERT(self->magic == LAP_MAGIC, return -1;);
499 param->pv.i = self->qos_rx.baud_rate.bits;
500 IRDA_DEBUG(2, __FUNCTION__ "(), baud rate = 0x%02x\n",
504 * Stations must agree on baud rate, so calculate
507 IRDA_DEBUG(2, "Requested BAUD_RATE: 0x%04x\n", (__u16) param->pv.i);
508 final = (__u16) param->pv.i & self->qos_rx.baud_rate.bits;
510 IRDA_DEBUG(2, "Final BAUD_RATE: 0x%04x\n", final);
511 self->qos_tx.baud_rate.bits = final;
512 self->qos_rx.baud_rate.bits = final;
519 * Function irlap_param_link_disconnect (instance, param, get)
521 * Negotiate link disconnect/threshold time.
524 static int irlap_param_link_disconnect(void *instance, irda_param_t *param,
529 struct irlap_cb *self = (struct irlap_cb *) instance;
531 ASSERT(self != NULL, return -1;);
532 ASSERT(self->magic == LAP_MAGIC, return -1;);
535 param->pv.i = self->qos_rx.link_disc_time.bits;
538 * Stations must agree on link disconnect/threshold
541 IRDA_DEBUG(2, "LINK_DISC: %02x\n", (__u8) param->pv.i);
542 final = (__u8) param->pv.i & self->qos_rx.link_disc_time.bits;
544 IRDA_DEBUG(2, "Final LINK_DISC: %02x\n", final);
545 self->qos_tx.link_disc_time.bits = final;
546 self->qos_rx.link_disc_time.bits = final;
552 * Function irlap_param_max_turn_time (instance, param, get)
554 * Negotiate the maximum turnaround time. This is a type 1 parameter and
555 * will be negotiated independently for each station
558 static int irlap_param_max_turn_time(void *instance, irda_param_t *param,
561 struct irlap_cb *self = (struct irlap_cb *) instance;
563 ASSERT(self != NULL, return -1;);
564 ASSERT(self->magic == LAP_MAGIC, return -1;);
567 param->pv.i = self->qos_rx.max_turn_time.bits;
569 self->qos_tx.max_turn_time.bits = (__u8) param->pv.i;
575 * Function irlap_param_data_size (instance, param, get)
577 * Negotiate the data size. This is a type 1 parameter and
578 * will be negotiated independently for each station
581 static int irlap_param_data_size(void *instance, irda_param_t *param, int get)
583 struct irlap_cb *self = (struct irlap_cb *) instance;
585 ASSERT(self != NULL, return -1;);
586 ASSERT(self->magic == LAP_MAGIC, return -1;);
589 param->pv.i = self->qos_rx.data_size.bits;
591 self->qos_tx.data_size.bits = (__u8) param->pv.i;
597 * Function irlap_param_window_size (instance, param, get)
599 * Negotiate the window size. This is a type 1 parameter and
600 * will be negotiated independently for each station
603 static int irlap_param_window_size(void *instance, irda_param_t *param,
606 struct irlap_cb *self = (struct irlap_cb *) instance;
608 ASSERT(self != NULL, return -1;);
609 ASSERT(self->magic == LAP_MAGIC, return -1;);
612 param->pv.i = self->qos_rx.window_size.bits;
614 self->qos_tx.window_size.bits = (__u8) param->pv.i;
620 * Function irlap_param_additional_bofs (instance, param, get)
622 * Negotiate additional BOF characters. This is a type 1 parameter and
623 * will be negotiated independently for each station.
625 static int irlap_param_additional_bofs(void *instance, irda_param_t *param, int get)
627 struct irlap_cb *self = (struct irlap_cb *) instance;
629 ASSERT(self != NULL, return -1;);
630 ASSERT(self->magic == LAP_MAGIC, return -1;);
633 param->pv.i = self->qos_rx.additional_bofs.bits;
635 self->qos_tx.additional_bofs.bits = (__u8) param->pv.i;
641 * Function irlap_param_min_turn_time (instance, param, get)
643 * Negotiate the minimum turn around time. This is a type 1 parameter and
644 * will be negotiated independently for each station
646 static int irlap_param_min_turn_time(void *instance, irda_param_t *param,
649 struct irlap_cb *self = (struct irlap_cb *) instance;
651 ASSERT(self != NULL, return -1;);
652 ASSERT(self->magic == LAP_MAGIC, return -1;);
655 param->pv.i = self->qos_rx.min_turn_time.bits;
657 self->qos_tx.min_turn_time.bits = (__u8) param->pv.i;
663 * Function irlap_max_line_capacity (speed, max_turn_time, min_turn_time)
665 * Calculate the maximum line capacity
668 __u32 irlap_max_line_capacity(__u32 speed, __u32 max_turn_time)
673 IRDA_DEBUG(2, __FUNCTION__ "(), speed=%d, max_turn_time=%d\n",
674 speed, max_turn_time);
676 i = value_index(speed, baud_rates, 10);
677 j = value_index(max_turn_time, max_turn_times, 4);
679 ASSERT(((i >=0) && (i <=10)), return 0;);
680 ASSERT(((j >=0) && (j <=4)), return 0;);
682 line_capacity = max_line_capacities[i][j];
684 IRDA_DEBUG(2, __FUNCTION__ "(), line capacity=%d bytes\n",
687 return line_capacity;
690 __u32 irlap_requested_line_capacity(struct qos_info *qos)
691 { __u32 line_capacity;
693 line_capacity = qos->window_size.value *
694 (qos->data_size.value + 6 + qos->additional_bofs.value) +
695 irlap_min_turn_time_in_bytes(qos->baud_rate.value,
696 qos->min_turn_time.value);
698 IRDA_DEBUG(2, __FUNCTION__ "(), requested line capacity=%d\n",
701 return line_capacity;
704 void irda_qos_bits_to_value(struct qos_info *qos)
708 ASSERT(qos != NULL, return;);
710 index = msb_index(qos->baud_rate.bits);
711 qos->baud_rate.value = baud_rates[index];
713 index = msb_index(qos->data_size.bits);
714 qos->data_size.value = data_sizes[index];
716 index = msb_index(qos->window_size.bits);
717 qos->window_size.value = index+1;
719 index = msb_index(qos->min_turn_time.bits);
720 qos->min_turn_time.value = min_turn_times[index];
722 index = msb_index(qos->max_turn_time.bits);
723 qos->max_turn_time.value = max_turn_times[index];
725 index = msb_index(qos->link_disc_time.bits);
726 qos->link_disc_time.value = link_disc_times[index];
728 index = msb_index(qos->additional_bofs.bits);
729 qos->additional_bofs.value = add_bofs[index];