Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/bearer.h: Include file for TIPC bearer code | |
c4307285 | 3 | * |
593a5f22 | 4 | * Copyright (c) 1996-2006, 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 | |
4d163a32 AS |
45 | /* |
46 | * Identifiers associated with TIPC message header media address info | |
47 | * | |
48 | * - address info field is 20 bytes long | |
49 | * - media type identifier located at offset 3 | |
50 | * - remaining bytes vary according to media type | |
51 | */ | |
4d163a32 AS |
52 | #define TIPC_MEDIA_ADDR_SIZE 20 |
53 | #define TIPC_MEDIA_TYPE_OFFSET 3 | |
54 | ||
d265fef6 AS |
55 | /* |
56 | * Identifiers of supported TIPC media types | |
57 | */ | |
58 | #define TIPC_MEDIA_TYPE_ETH 1 | |
a29a194a | 59 | #define TIPC_MEDIA_TYPE_IB 2 |
d265fef6 | 60 | |
2c53040f | 61 | /** |
3d749a6a AS |
62 | * struct tipc_media_addr - destination address used by TIPC bearers |
63 | * @value: address info (format defined by media) | |
64 | * @media_id: TIPC media type identifier | |
65 | * @broadcast: non-zero if address is a broadcast address | |
d265fef6 AS |
66 | */ |
67 | struct tipc_media_addr { | |
3d749a6a AS |
68 | u8 value[TIPC_MEDIA_ADDR_SIZE]; |
69 | u8 media_id; | |
70 | u8 broadcast; | |
d265fef6 AS |
71 | }; |
72 | ||
2d627b92 | 73 | struct tipc_bearer; |
b97bf3fd PL |
74 | |
75 | /** | |
358a0d1c | 76 | * struct tipc_media - TIPC media information available to internal users |
b97bf3fd PL |
77 | * @send_msg: routine which handles buffer transmission |
78 | * @enable_bearer: routine which enables a bearer | |
79 | * @disable_bearer: routine which disables a bearer | |
4d163a32 | 80 | * @addr2str: routine which converts media address to string |
4d163a32 AS |
81 | * @addr2msg: routine which converts media address to protocol message area |
82 | * @msg2addr: routine which converts media address from protocol message area | |
b97bf3fd | 83 | * @bcast_addr: media address used in broadcasting |
b97bf3fd PL |
84 | * @priority: default link (and bearer) priority |
85 | * @tolerance: default time (in ms) before declaring link failure | |
86 | * @window: default window (in packets) before declaring link congestion | |
d265fef6 | 87 | * @type_id: TIPC media identifier |
b97bf3fd PL |
88 | * @name: media name |
89 | */ | |
358a0d1c | 90 | struct tipc_media { |
c4307285 | 91 | int (*send_msg)(struct sk_buff *buf, |
b97bf3fd PL |
92 | struct tipc_bearer *b_ptr, |
93 | struct tipc_media_addr *dest); | |
94 | int (*enable_bearer)(struct tipc_bearer *b_ptr); | |
95 | void (*disable_bearer)(struct tipc_bearer *b_ptr); | |
c61b666e | 96 | int (*addr2str)(struct tipc_media_addr *a, char *str_buf, int str_size); |
4d163a32 | 97 | int (*addr2msg)(struct tipc_media_addr *a, char *msg_area); |
8aeb89f2 PM |
98 | int (*msg2addr)(const struct tipc_bearer *b_ptr, |
99 | struct tipc_media_addr *a, char *msg_area); | |
b97bf3fd PL |
100 | u32 priority; |
101 | u32 tolerance; | |
102 | u32 window; | |
103 | u32 type_id; | |
104 | char name[TIPC_MAX_MEDIA_NAME]; | |
105 | }; | |
106 | ||
107 | /** | |
2d627b92 AS |
108 | * struct tipc_bearer - TIPC bearer structure |
109 | * @usr_handle: pointer to additional media-specific information about bearer | |
110 | * @mtu: max packet size bearer can support | |
111 | * @blocked: non-zero if bearer is blocked | |
112 | * @lock: spinlock for controlling access to bearer | |
113 | * @addr: media-specific address associated with bearer | |
114 | * @name: bearer name (format = media:interface) | |
b97bf3fd PL |
115 | * @media: ptr to media structure associated with bearer |
116 | * @priority: default link priority for bearer | |
5c216e1d AS |
117 | * @window: default window size for bearer |
118 | * @tolerance: default link tolerance for bearer | |
b97bf3fd PL |
119 | * @identity: array index of this bearer within TIPC bearer array |
120 | * @link_req: ptr to (optional) structure making periodic link setup requests | |
121 | * @links: list of non-congested links associated with bearer | |
b97bf3fd PL |
122 | * @active: non-zero if bearer structure is represents a bearer |
123 | * @net_plane: network plane ('A' through 'H') currently associated with bearer | |
124 | * @nodes: indicates which nodes in cluster can be reached through bearer | |
2d627b92 AS |
125 | * |
126 | * Note: media-specific code is responsible for initialization of the fields | |
127 | * indicated below when a bearer is enabled; TIPC's generic bearer code takes | |
128 | * care of initializing all other fields. | |
b97bf3fd | 129 | */ |
2d627b92 AS |
130 | struct tipc_bearer { |
131 | void *usr_handle; /* initalized by media */ | |
132 | u32 mtu; /* initalized by media */ | |
133 | int blocked; /* initalized by media */ | |
134 | struct tipc_media_addr addr; /* initalized by media */ | |
135 | char name[TIPC_MAX_BEARER_NAME]; | |
136 | spinlock_t lock; | |
358a0d1c | 137 | struct tipc_media *media; |
8aeb89f2 | 138 | struct tipc_media_addr bcast_addr; |
b97bf3fd | 139 | u32 priority; |
5c216e1d AS |
140 | u32 window; |
141 | u32 tolerance; | |
b97bf3fd | 142 | u32 identity; |
a18c4bc3 | 143 | struct tipc_link_req *link_req; |
b97bf3fd | 144 | struct list_head links; |
b97bf3fd PL |
145 | int active; |
146 | char net_plane; | |
6c00055a | 147 | struct tipc_node_map nodes; |
b97bf3fd PL |
148 | }; |
149 | ||
f19765f4 | 150 | struct tipc_bearer_names { |
b97bf3fd PL |
151 | char media_name[TIPC_MAX_MEDIA_NAME]; |
152 | char if_name[TIPC_MAX_IF_NAME]; | |
153 | }; | |
154 | ||
a18c4bc3 | 155 | struct tipc_link; |
b97bf3fd | 156 | |
2d627b92 | 157 | extern struct tipc_bearer tipc_bearers[]; |
b97bf3fd | 158 | |
d265fef6 AS |
159 | /* |
160 | * TIPC routines available to supported media types | |
161 | */ | |
358a0d1c | 162 | int tipc_register_media(struct tipc_media *m_ptr); |
d265fef6 AS |
163 | |
164 | void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr); | |
165 | ||
166 | int tipc_block_bearer(const char *name); | |
167 | void tipc_continue(struct tipc_bearer *tb_ptr); | |
168 | ||
50d3e639 | 169 | int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority); |
d265fef6 AS |
170 | int tipc_disable_bearer(const char *name); |
171 | ||
172 | /* | |
173 | * Routines made available to TIPC by supported media types | |
174 | */ | |
175 | int tipc_eth_media_start(void); | |
176 | void tipc_eth_media_stop(void); | |
177 | ||
a29a194a PM |
178 | #ifdef CONFIG_TIPC_MEDIA_IB |
179 | int tipc_ib_media_start(void); | |
180 | void tipc_ib_media_stop(void); | |
181 | #else | |
182 | static inline int tipc_ib_media_start(void) { return 0; } | |
183 | static inline void tipc_ib_media_stop(void) { return; } | |
184 | #endif | |
185 | ||
5c216e1d AS |
186 | int tipc_media_set_priority(const char *name, u32 new_value); |
187 | int tipc_media_set_window(const char *name, u32 new_value); | |
dc1aed37 | 188 | void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a); |
4323add6 | 189 | struct sk_buff *tipc_media_get_names(void); |
b97bf3fd | 190 | |
4323add6 | 191 | struct sk_buff *tipc_bearer_get_names(void); |
2d627b92 AS |
192 | void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest); |
193 | void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest); | |
5c216e1d | 194 | struct tipc_bearer *tipc_bearer_find(const char *name); |
2d627b92 | 195 | struct tipc_bearer *tipc_bearer_find_interface(const char *if_name); |
358a0d1c | 196 | struct tipc_media *tipc_media_find(const char *name); |
3c294cb3 | 197 | int tipc_bearer_blocked(struct tipc_bearer *b_ptr); |
4323add6 | 198 | void tipc_bearer_stop(void); |
b97bf3fd PL |
199 | |
200 | /** | |
c4307285 YH |
201 | * tipc_bearer_send- sends buffer to destination over bearer |
202 | * | |
b97bf3fd PL |
203 | * IMPORTANT: |
204 | * The media send routine must not alter the buffer being passed in | |
205 | * as it may be needed for later retransmission! | |
b97bf3fd | 206 | */ |
3c294cb3 | 207 | static inline void tipc_bearer_send(struct tipc_bearer *b, struct sk_buff *buf, |
4323add6 | 208 | struct tipc_media_addr *dest) |
b97bf3fd | 209 | { |
3c294cb3 | 210 | b->media->send_msg(buf, b, dest); |
b97bf3fd PL |
211 | } |
212 | ||
b274f4ab | 213 | #endif /* _TIPC_BEARER_H */ |