USB: root hubs don't lie about their number of TTs
[linux-2.6/mini2440.git] / net / tipc / msg.h
blob6ad070d87702b6f09a4d1da40930aca10f862829
1 /*
2 * net/tipc/msg.h: Include file for TIPC message header routines
4 * Copyright (c) 2000-2007, Ericsson AB
5 * Copyright (c) 2005-2007, Wind River Systems
6 * All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the names of the copyright holders nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * Alternatively, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") version 2 as published by the Free
22 * Software Foundation.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
37 #ifndef _TIPC_MSG_H
38 #define _TIPC_MSG_H
40 #include "core.h"
42 #define TIPC_VERSION 2
44 #define SHORT_H_SIZE 24 /* Connected, in-cluster messages */
45 #define DIR_MSG_H_SIZE 32 /* Directly addressed messages */
46 #define LONG_H_SIZE 40 /* Named messages */
47 #define MCAST_H_SIZE 44 /* Multicast messages */
48 #define INT_H_SIZE 40 /* Internal messages */
49 #define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
50 #define MAX_H_SIZE 60 /* Largest possible TIPC header size */
52 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
56 TIPC user data message header format, version 2
58 - Fundamental definitions available to privileged TIPC users
59 are located in tipc_msg.h.
60 - Remaining definitions available to TIPC internal users appear below.
64 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
66 m->hdr[w] = htonl(val);
69 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
70 u32 pos, u32 mask, u32 val)
72 val = (val & mask) << pos;
73 val = htonl(val);
74 mask = htonl(mask << pos);
75 m->hdr[w] &= ~mask;
76 m->hdr[w] |= val;
80 * Word 0
83 static inline u32 msg_version(struct tipc_msg *m)
85 return msg_bits(m, 0, 29, 7);
88 static inline void msg_set_version(struct tipc_msg *m)
90 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
93 static inline u32 msg_user(struct tipc_msg *m)
95 return msg_bits(m, 0, 25, 0xf);
98 static inline u32 msg_isdata(struct tipc_msg *m)
100 return (msg_user(m) <= TIPC_CRITICAL_IMPORTANCE);
103 static inline void msg_set_user(struct tipc_msg *m, u32 n)
105 msg_set_bits(m, 0, 25, 0xf, n);
108 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
110 msg_set_user(m, i);
113 static inline void msg_set_hdr_sz(struct tipc_msg *m,u32 n)
115 msg_set_bits(m, 0, 21, 0xf, n>>2);
118 static inline int msg_non_seq(struct tipc_msg *m)
120 return msg_bits(m, 0, 20, 1);
123 static inline void msg_set_non_seq(struct tipc_msg *m)
125 msg_set_bits(m, 0, 20, 1, 1);
128 static inline int msg_dest_droppable(struct tipc_msg *m)
130 return msg_bits(m, 0, 19, 1);
133 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
135 msg_set_bits(m, 0, 19, 1, d);
138 static inline int msg_src_droppable(struct tipc_msg *m)
140 return msg_bits(m, 0, 18, 1);
143 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
145 msg_set_bits(m, 0, 18, 1, d);
148 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
150 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
155 * Word 1
158 static inline void msg_set_type(struct tipc_msg *m, u32 n)
160 msg_set_bits(m, 1, 29, 0x7, n);
163 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
165 msg_set_bits(m, 1, 25, 0xf, err);
168 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
170 return msg_bits(m, 1, 21, 0xf);
173 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
175 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
178 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
180 msg_set_bits(m, 1, 21, 0xf, 0);
183 static inline u32 msg_lookup_scope(struct tipc_msg *m)
185 return msg_bits(m, 1, 19, 0x3);
188 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
190 msg_set_bits(m, 1, 19, 0x3, n);
193 static inline u32 msg_bcast_ack(struct tipc_msg *m)
195 return msg_bits(m, 1, 0, 0xffff);
198 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
200 msg_set_bits(m, 1, 0, 0xffff, n);
205 * Word 2
208 static inline u32 msg_ack(struct tipc_msg *m)
210 return msg_bits(m, 2, 16, 0xffff);
213 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
215 msg_set_bits(m, 2, 16, 0xffff, n);
218 static inline u32 msg_seqno(struct tipc_msg *m)
220 return msg_bits(m, 2, 0, 0xffff);
223 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
225 msg_set_bits(m, 2, 0, 0xffff, n);
230 * Words 3-10
234 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
236 msg_set_word(m, 3, a);
239 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
241 msg_set_word(m, 4, p);
244 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
246 msg_set_word(m, 5, p);
249 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
251 msg_set_word(m, 5, p);
254 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
256 msg_set_word(m, 6, a);
259 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
261 msg_set_word(m, 7, a);
264 static inline int msg_is_dest(struct tipc_msg *m, u32 d)
266 return(msg_short(m) || (msg_destnode(m) == d));
269 static inline u32 msg_routed(struct tipc_msg *m)
271 if (likely(msg_short(m)))
272 return 0;
273 return(msg_destnode(m) ^ msg_orignode(m)) >> 11;
276 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
278 msg_set_word(m, 8, n);
281 static inline u32 msg_transp_seqno(struct tipc_msg *m)
283 return msg_word(m, 8);
286 static inline void msg_set_timestamp(struct tipc_msg *m, u32 n)
288 msg_set_word(m, 8, n);
291 static inline u32 msg_timestamp(struct tipc_msg *m)
293 return msg_word(m, 8);
296 static inline void msg_set_transp_seqno(struct tipc_msg *m, u32 n)
298 msg_set_word(m, 8, n);
301 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
303 msg_set_word(m, 9, n);
306 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
308 msg_set_namelower(m, n);
311 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
313 msg_set_word(m, 10, n);
316 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
318 return (struct tipc_msg *)msg_data(m);
323 TIPC internal message header format, version 2
325 1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0
326 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
327 w0:|vers |msg usr|hdr sz |n|resrv| packet size |
328 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
329 w1:|m typ|rsv=0| sequence gap | broadcast ack no |
330 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
331 w2:| link level ack no/bc_gap_from | seq no / bcast_gap_to |
332 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
333 w3:| previous node |
334 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
335 w4:| next sent broadcast/fragm no | next sent pkt/ fragm msg no |
336 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
337 w5:| session no |rsv=0|r|berid|link prio|netpl|p|
338 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
339 w6:| originating node |
340 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
341 w7:| destination node |
342 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
343 w8:| transport sequence number |
344 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
345 w9:| msg count / bcast tag | link tolerance |
346 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
348 / User Specific Data /
350 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
352 NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
356 * Internal users
359 #define BCAST_PROTOCOL 5
360 #define MSG_BUNDLER 6
361 #define LINK_PROTOCOL 7
362 #define CONN_MANAGER 8
363 #define ROUTE_DISTRIBUTOR 9
364 #define CHANGEOVER_PROTOCOL 10
365 #define NAME_DISTRIBUTOR 11
366 #define MSG_FRAGMENTER 12
367 #define LINK_CONFIG 13
368 #define DSC_H_SIZE 40
371 * Connection management protocol messages
374 #define CONN_PROBE 0
375 #define CONN_PROBE_REPLY 1
376 #define CONN_ACK 2
379 * Name distributor messages
382 #define PUBLICATION 0
383 #define WITHDRAWAL 1
387 * Word 1
390 static inline u32 msg_seq_gap(struct tipc_msg *m)
392 return msg_bits(m, 1, 16, 0xff);
395 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
397 msg_set_bits(m, 1, 16, 0xff, n);
400 static inline u32 msg_req_links(struct tipc_msg *m)
402 return msg_bits(m, 1, 16, 0xfff);
405 static inline void msg_set_req_links(struct tipc_msg *m, u32 n)
407 msg_set_bits(m, 1, 16, 0xfff, n);
412 * Word 2
415 static inline u32 msg_dest_domain(struct tipc_msg *m)
417 return msg_word(m, 2);
420 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
422 msg_set_word(m, 2, n);
425 static inline u32 msg_bcgap_after(struct tipc_msg *m)
427 return msg_bits(m, 2, 16, 0xffff);
430 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
432 msg_set_bits(m, 2, 16, 0xffff, n);
435 static inline u32 msg_bcgap_to(struct tipc_msg *m)
437 return msg_bits(m, 2, 0, 0xffff);
440 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
442 msg_set_bits(m, 2, 0, 0xffff, n);
447 * Word 4
450 static inline u32 msg_last_bcast(struct tipc_msg *m)
452 return msg_bits(m, 4, 16, 0xffff);
455 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
457 msg_set_bits(m, 4, 16, 0xffff, n);
461 static inline u32 msg_fragm_no(struct tipc_msg *m)
463 return msg_bits(m, 4, 16, 0xffff);
466 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
468 msg_set_bits(m, 4, 16, 0xffff, n);
472 static inline u32 msg_next_sent(struct tipc_msg *m)
474 return msg_bits(m, 4, 0, 0xffff);
477 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
479 msg_set_bits(m, 4, 0, 0xffff, n);
483 static inline u32 msg_long_msgno(struct tipc_msg *m)
485 return msg_bits(m, 4, 0, 0xffff);
488 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
490 msg_set_bits(m, 4, 0, 0xffff, n);
493 static inline u32 msg_bc_netid(struct tipc_msg *m)
495 return msg_word(m, 4);
498 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
500 msg_set_word(m, 4, id);
503 static inline u32 msg_link_selector(struct tipc_msg *m)
505 return msg_bits(m, 4, 0, 1);
508 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
510 msg_set_bits(m, 4, 0, 1, (n & 1));
514 * Word 5
517 static inline u32 msg_session(struct tipc_msg *m)
519 return msg_bits(m, 5, 16, 0xffff);
522 static inline void msg_set_session(struct tipc_msg *m, u32 n)
524 msg_set_bits(m, 5, 16, 0xffff, n);
527 static inline u32 msg_probe(struct tipc_msg *m)
529 return msg_bits(m, 5, 0, 1);
532 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
534 msg_set_bits(m, 5, 0, 1, (val & 1));
537 static inline char msg_net_plane(struct tipc_msg *m)
539 return msg_bits(m, 5, 1, 7) + 'A';
542 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
544 msg_set_bits(m, 5, 1, 7, (n - 'A'));
547 static inline u32 msg_linkprio(struct tipc_msg *m)
549 return msg_bits(m, 5, 4, 0x1f);
552 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
554 msg_set_bits(m, 5, 4, 0x1f, n);
557 static inline u32 msg_bearer_id(struct tipc_msg *m)
559 return msg_bits(m, 5, 9, 0x7);
562 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
564 msg_set_bits(m, 5, 9, 0x7, n);
567 static inline u32 msg_redundant_link(struct tipc_msg *m)
569 return msg_bits(m, 5, 12, 0x1);
572 static inline void msg_set_redundant_link(struct tipc_msg *m)
574 msg_set_bits(m, 5, 12, 0x1, 1);
577 static inline void msg_clear_redundant_link(struct tipc_msg *m)
579 msg_set_bits(m, 5, 12, 0x1, 0);
584 * Word 9
587 static inline u32 msg_msgcnt(struct tipc_msg *m)
589 return msg_bits(m, 9, 16, 0xffff);
592 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
594 msg_set_bits(m, 9, 16, 0xffff, n);
597 static inline u32 msg_bcast_tag(struct tipc_msg *m)
599 return msg_bits(m, 9, 16, 0xffff);
602 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
604 msg_set_bits(m, 9, 16, 0xffff, n);
607 static inline u32 msg_max_pkt(struct tipc_msg *m)
609 return (msg_bits(m, 9, 16, 0xffff) * 4);
612 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
614 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
617 static inline u32 msg_link_tolerance(struct tipc_msg *m)
619 return msg_bits(m, 9, 0, 0xffff);
622 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
624 msg_set_bits(m, 9, 0, 0xffff, n);
628 * Routing table message data
632 static inline u32 msg_remote_node(struct tipc_msg *m)
634 return msg_word(m, msg_hdr_sz(m)/4);
637 static inline void msg_set_remote_node(struct tipc_msg *m, u32 a)
639 msg_set_word(m, msg_hdr_sz(m)/4, a);
642 static inline void msg_set_dataoctet(struct tipc_msg *m, u32 pos)
644 msg_data(m)[pos + 4] = 1;
648 * Segmentation message types
651 #define FIRST_FRAGMENT 0
652 #define FRAGMENT 1
653 #define LAST_FRAGMENT 2
656 * Link management protocol message types
659 #define STATE_MSG 0
660 #define RESET_MSG 1
661 #define ACTIVATE_MSG 2
664 * Changeover tunnel message types
666 #define DUPLICATE_MSG 0
667 #define ORIGINAL_MSG 1
670 * Routing table message types
672 #define EXT_ROUTING_TABLE 0
673 #define LOCAL_ROUTING_TABLE 1
674 #define SLAVE_ROUTING_TABLE 2
675 #define ROUTE_ADDITION 3
676 #define ROUTE_REMOVAL 4
679 * Config protocol message types
682 #define DSC_REQ_MSG 0
683 #define DSC_RESP_MSG 1
685 static inline u32 msg_tot_importance(struct tipc_msg *m)
687 if (likely(msg_isdata(m))) {
688 if (likely(msg_orignode(m) == tipc_own_addr))
689 return msg_importance(m);
690 return msg_importance(m) + 4;
692 if ((msg_user(m) == MSG_FRAGMENTER) &&
693 (msg_type(m) == FIRST_FRAGMENT))
694 return msg_importance(msg_get_wrapped(m));
695 return msg_importance(m);
699 static inline void msg_init(struct tipc_msg *m, u32 user, u32 type,
700 u32 err, u32 hsize, u32 destnode)
702 memset(m, 0, hsize);
703 msg_set_version(m);
704 msg_set_user(m, user);
705 msg_set_hdr_sz(m, hsize);
706 msg_set_size(m, hsize);
707 msg_set_prevnode(m, tipc_own_addr);
708 msg_set_type(m, type);
709 msg_set_errcode(m, err);
710 if (!msg_short(m)) {
711 msg_set_orignode(m, tipc_own_addr);
712 msg_set_destnode(m, destnode);
717 * msg_calc_data_size - determine total data size for message
720 static inline int msg_calc_data_size(struct iovec const *msg_sect, u32 num_sect)
722 int dsz = 0;
723 int i;
725 for (i = 0; i < num_sect; i++)
726 dsz += msg_sect[i].iov_len;
727 return dsz;
731 * msg_build - create message using specified header and data
733 * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
735 * Returns message data size or errno
738 static inline int msg_build(struct tipc_msg *hdr,
739 struct iovec const *msg_sect, u32 num_sect,
740 int max_size, int usrmem, struct sk_buff** buf)
742 int dsz, sz, hsz, pos, res, cnt;
744 dsz = msg_calc_data_size(msg_sect, num_sect);
745 if (unlikely(dsz > TIPC_MAX_USER_MSG_SIZE)) {
746 *buf = NULL;
747 return -EINVAL;
750 pos = hsz = msg_hdr_sz(hdr);
751 sz = hsz + dsz;
752 msg_set_size(hdr, sz);
753 if (unlikely(sz > max_size)) {
754 *buf = NULL;
755 return dsz;
758 *buf = buf_acquire(sz);
759 if (!(*buf))
760 return -ENOMEM;
761 skb_copy_to_linear_data(*buf, hdr, hsz);
762 for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
763 if (likely(usrmem))
764 res = !copy_from_user((*buf)->data + pos,
765 msg_sect[cnt].iov_base,
766 msg_sect[cnt].iov_len);
767 else
768 skb_copy_to_linear_data_offset(*buf, pos,
769 msg_sect[cnt].iov_base,
770 msg_sect[cnt].iov_len);
771 pos += msg_sect[cnt].iov_len;
773 if (likely(res))
774 return dsz;
776 buf_discard(*buf);
777 *buf = NULL;
778 return -EFAULT;
781 static inline void msg_set_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
783 memcpy(&((int *)m)[5], a, sizeof(*a));
786 static inline void msg_get_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
788 memcpy(a, &((int*)m)[5], sizeof(*a));
791 #endif