Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/bearer.h: Include file for TIPC bearer code | |
c4307285 | 3 | * |
5702dbab | 4 | * Copyright (c) 1996-2006, 2013, Ericsson AB |
2d627b92 | 5 | * Copyright (c) 2005, 2010-2011, Wind River Systems |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
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. | |
23 | * | |
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 | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #ifndef _TIPC_BEARER_H | |
38 | #define _TIPC_BEARER_H | |
39 | ||
b97bf3fd PL |
40 | #include "bcast.h" |
41 | ||
909234cd AS |
42 | #define MAX_BEARERS 2 |
43 | #define MAX_MEDIA 2 | |
b97bf3fd | 44 | |
38504c28 JPM |
45 | /* Identifiers associated with TIPC message header media address info |
46 | * - address info field is 32 bytes long | |
47 | * - the field's actual content and length is defined per media | |
48 | * - remaining unused bytes in the field are set to zero | |
4d163a32 | 49 | */ |
38504c28 | 50 | #define TIPC_MEDIA_ADDR_SIZE 32 |
4d163a32 AS |
51 | #define TIPC_MEDIA_TYPE_OFFSET 3 |
52 | ||
d265fef6 AS |
53 | /* |
54 | * Identifiers of supported TIPC media types | |
55 | */ | |
56 | #define TIPC_MEDIA_TYPE_ETH 1 | |
a29a194a | 57 | #define TIPC_MEDIA_TYPE_IB 2 |
d265fef6 | 58 | |
2c53040f | 59 | /** |
3d749a6a AS |
60 | * struct tipc_media_addr - destination address used by TIPC bearers |
61 | * @value: address info (format defined by media) | |
62 | * @media_id: TIPC media type identifier | |
63 | * @broadcast: non-zero if address is a broadcast address | |
d265fef6 AS |
64 | */ |
65 | struct tipc_media_addr { | |
3d749a6a AS |
66 | u8 value[TIPC_MEDIA_ADDR_SIZE]; |
67 | u8 media_id; | |
68 | u8 broadcast; | |
d265fef6 AS |
69 | }; |
70 | ||
2d627b92 | 71 | struct tipc_bearer; |
b97bf3fd PL |
72 | |
73 | /** | |
ef72a7e0 | 74 | * struct tipc_media - Media specific info exposed to generic bearer layer |
b97bf3fd | 75 | * @send_msg: routine which handles buffer transmission |
4babbaa8 YX |
76 | * @enable_media: routine which enables a media |
77 | * @disable_media: routine which disables a media | |
38504c28 JPM |
78 | * @addr2str: convert media address format to string |
79 | * @addr2msg: convert from media addr format to discovery msg addr format | |
80 | * @msg2addr: convert from discovery msg addr format to media addr format | |
81 | * @raw2addr: convert from raw addr format to media addr format | |
b97bf3fd PL |
82 | * @priority: default link (and bearer) priority |
83 | * @tolerance: default time (in ms) before declaring link failure | |
84 | * @window: default window (in packets) before declaring link congestion | |
d265fef6 | 85 | * @type_id: TIPC media identifier |
e4d050cb | 86 | * @hwaddr_len: TIPC media address len |
b97bf3fd PL |
87 | * @name: media name |
88 | */ | |
358a0d1c | 89 | struct tipc_media { |
c4307285 | 90 | int (*send_msg)(struct sk_buff *buf, |
b97bf3fd PL |
91 | struct tipc_bearer *b_ptr, |
92 | struct tipc_media_addr *dest); | |
4babbaa8 YX |
93 | int (*enable_media)(struct tipc_bearer *b_ptr); |
94 | void (*disable_media)(struct tipc_bearer *b_ptr); | |
38504c28 JPM |
95 | int (*addr2str)(struct tipc_media_addr *addr, |
96 | char *strbuf, | |
97 | int bufsz); | |
98 | int (*addr2msg)(char *msg, struct tipc_media_addr *addr); | |
99 | int (*msg2addr)(struct tipc_bearer *b, | |
100 | struct tipc_media_addr *addr, | |
101 | char *msg); | |
102 | int (*raw2addr)(struct tipc_bearer *b, | |
103 | struct tipc_media_addr *addr, | |
104 | char *raw); | |
b97bf3fd PL |
105 | u32 priority; |
106 | u32 tolerance; | |
107 | u32 window; | |
108 | u32 type_id; | |
e4d050cb | 109 | u32 hwaddr_len; |
b97bf3fd PL |
110 | char name[TIPC_MAX_MEDIA_NAME]; |
111 | }; | |
112 | ||
113 | /** | |
ef72a7e0 | 114 | * struct tipc_bearer - Generic TIPC bearer structure |
a8304529 | 115 | * @media_ptr: pointer to additional media-specific information about bearer |
2d627b92 | 116 | * @mtu: max packet size bearer can support |
2d627b92 AS |
117 | * @addr: media-specific address associated with bearer |
118 | * @name: bearer name (format = media:interface) | |
b97bf3fd | 119 | * @media: ptr to media structure associated with bearer |
ef72a7e0 | 120 | * @bcast_addr: media address used in broadcasting |
f8322dfc | 121 | * @rcu: rcu struct for tipc_bearer |
b97bf3fd | 122 | * @priority: default link priority for bearer |
5c216e1d AS |
123 | * @window: default window size for bearer |
124 | * @tolerance: default link tolerance for bearer | |
a21a584d | 125 | * @domain: network domain to which links can be established |
b97bf3fd PL |
126 | * @identity: array index of this bearer within TIPC bearer array |
127 | * @link_req: ptr to (optional) structure making periodic link setup requests | |
b97bf3fd PL |
128 | * @net_plane: network plane ('A' through 'H') currently associated with bearer |
129 | * @nodes: indicates which nodes in cluster can be reached through bearer | |
2d627b92 AS |
130 | * |
131 | * Note: media-specific code is responsible for initialization of the fields | |
132 | * indicated below when a bearer is enabled; TIPC's generic bearer code takes | |
133 | * care of initializing all other fields. | |
b97bf3fd | 134 | */ |
2d627b92 | 135 | struct tipc_bearer { |
2231c5af | 136 | void __rcu *media_ptr; /* initalized by media */ |
2d627b92 | 137 | u32 mtu; /* initalized by media */ |
2d627b92 AS |
138 | struct tipc_media_addr addr; /* initalized by media */ |
139 | char name[TIPC_MAX_BEARER_NAME]; | |
358a0d1c | 140 | struct tipc_media *media; |
8aeb89f2 | 141 | struct tipc_media_addr bcast_addr; |
f8322dfc | 142 | struct rcu_head rcu; |
b97bf3fd | 143 | u32 priority; |
5c216e1d AS |
144 | u32 window; |
145 | u32 tolerance; | |
a21a584d | 146 | u32 domain; |
b97bf3fd | 147 | u32 identity; |
a18c4bc3 | 148 | struct tipc_link_req *link_req; |
b97bf3fd | 149 | char net_plane; |
6c00055a | 150 | struct tipc_node_map nodes; |
b97bf3fd PL |
151 | }; |
152 | ||
f19765f4 | 153 | struct tipc_bearer_names { |
b97bf3fd PL |
154 | char media_name[TIPC_MAX_MEDIA_NAME]; |
155 | char if_name[TIPC_MAX_IF_NAME]; | |
156 | }; | |
157 | ||
a18c4bc3 | 158 | struct tipc_link; |
b97bf3fd | 159 | |
f8322dfc | 160 | extern struct tipc_bearer __rcu *bearer_list[]; |
b97bf3fd | 161 | |
d265fef6 AS |
162 | /* |
163 | * TIPC routines available to supported media types | |
164 | */ | |
d265fef6 | 165 | |
170b3927 | 166 | void tipc_rcv(struct sk_buff *buf, struct tipc_bearer *tb_ptr); |
50d3e639 | 167 | int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority); |
d265fef6 AS |
168 | int tipc_disable_bearer(const char *name); |
169 | ||
170 | /* | |
171 | * Routines made available to TIPC by supported media types | |
172 | */ | |
5702dbab | 173 | extern struct tipc_media eth_media_info; |
d265fef6 | 174 | |
a29a194a | 175 | #ifdef CONFIG_TIPC_MEDIA_IB |
5702dbab | 176 | extern struct tipc_media ib_media_info; |
a29a194a PM |
177 | #endif |
178 | ||
5c216e1d AS |
179 | int tipc_media_set_priority(const char *name, u32 new_value); |
180 | int tipc_media_set_window(const char *name, u32 new_value); | |
dc1aed37 | 181 | void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a); |
4323add6 | 182 | struct sk_buff *tipc_media_get_names(void); |
e4d050cb YX |
183 | int tipc_enable_l2_media(struct tipc_bearer *b); |
184 | void tipc_disable_l2_media(struct tipc_bearer *b); | |
185 | int tipc_l2_send_msg(struct sk_buff *buf, struct tipc_bearer *b, | |
186 | struct tipc_media_addr *dest); | |
b97bf3fd | 187 | |
4323add6 | 188 | struct sk_buff *tipc_bearer_get_names(void); |
7a2f7d18 YX |
189 | void tipc_bearer_add_dest(u32 bearer_id, u32 dest); |
190 | void tipc_bearer_remove_dest(u32 bearer_id, u32 dest); | |
5c216e1d | 191 | struct tipc_bearer *tipc_bearer_find(const char *name); |
358a0d1c | 192 | struct tipc_media *tipc_media_find(const char *name); |
6e967adf YX |
193 | int tipc_bearer_setup(void); |
194 | void tipc_bearer_cleanup(void); | |
4323add6 | 195 | void tipc_bearer_stop(void); |
7a2f7d18 | 196 | void tipc_bearer_send(u32 bearer_id, struct sk_buff *buf, |
e4d050cb | 197 | struct tipc_media_addr *dest); |
b97bf3fd | 198 | |
b274f4ab | 199 | #endif /* _TIPC_BEARER_H */ |