2 * net/tipc/bearer.h: Include file for TIPC bearer code
4 * Copyright (c) 1996-2006, 2013, Ericsson AB
5 * Copyright (c) 2005, 2010-2011, Wind River Systems
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_BEARER_H
38 #define _TIPC_BEARER_H
46 * Identifiers associated with TIPC message header media address info
48 * - address info field is 20 bytes long
49 * - media type identifier located at offset 3
50 * - remaining bytes vary according to media type
52 #define TIPC_MEDIA_ADDR_SIZE 20
53 #define TIPC_MEDIA_TYPE_OFFSET 3
56 * Identifiers of supported TIPC media types
58 #define TIPC_MEDIA_TYPE_ETH 1
59 #define TIPC_MEDIA_TYPE_IB 2
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
67 struct tipc_media_addr
{
68 u8 value
[TIPC_MEDIA_ADDR_SIZE
];
76 * struct tipc_media - Media specific info exposed to generic bearer layer
77 * @send_msg: routine which handles buffer transmission
78 * @enable_media: routine which enables a media
79 * @disable_media: routine which disables a media
80 * @addr2str: routine which converts media address to string
81 * @addr2msg: routine which converts media address to protocol message area
82 * @msg2addr: routine which converts media address from protocol message area
83 * @priority: default link (and bearer) priority
84 * @tolerance: default time (in ms) before declaring link failure
85 * @window: default window (in packets) before declaring link congestion
86 * @type_id: TIPC media identifier
87 * @hwaddr_len: TIPC media address len
91 int (*send_msg
)(struct sk_buff
*buf
,
92 struct tipc_bearer
*b_ptr
,
93 struct tipc_media_addr
*dest
);
94 int (*enable_media
)(struct tipc_bearer
*b_ptr
);
95 void (*disable_media
)(struct tipc_bearer
*b_ptr
);
96 int (*addr2str
)(struct tipc_media_addr
*a
, char *str_buf
, int str_size
);
97 int (*addr2msg
)(struct tipc_media_addr
*a
, char *msg_area
);
98 int (*msg2addr
)(const struct tipc_bearer
*b_ptr
,
99 struct tipc_media_addr
*a
, char *msg_area
);
105 char name
[TIPC_MAX_MEDIA_NAME
];
109 * struct tipc_bearer - Generic TIPC bearer structure
110 * @media_ptr: pointer to additional media-specific information about bearer
111 * @mtu: max packet size bearer can support
112 * @addr: media-specific address associated with bearer
113 * @name: bearer name (format = media:interface)
114 * @media: ptr to media structure associated with bearer
115 * @bcast_addr: media address used in broadcasting
116 * @rcu: rcu struct for tipc_bearer
117 * @priority: default link priority for bearer
118 * @window: default window size for bearer
119 * @tolerance: default link tolerance for bearer
120 * @domain: network domain to which links can be established
121 * @identity: array index of this bearer within TIPC bearer array
122 * @link_req: ptr to (optional) structure making periodic link setup requests
123 * @net_plane: network plane ('A' through 'H') currently associated with bearer
124 * @nodes: indicates which nodes in cluster can be reached through bearer
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.
131 void __rcu
*media_ptr
; /* initalized by media */
132 u32 mtu
; /* initalized by media */
133 struct tipc_media_addr addr
; /* initalized by media */
134 char name
[TIPC_MAX_BEARER_NAME
];
135 struct tipc_media
*media
;
136 struct tipc_media_addr bcast_addr
;
143 struct tipc_link_req
*link_req
;
145 struct tipc_node_map nodes
;
148 struct tipc_bearer_names
{
149 char media_name
[TIPC_MAX_MEDIA_NAME
];
150 char if_name
[TIPC_MAX_IF_NAME
];
155 extern struct tipc_bearer __rcu
*bearer_list
[];
158 * TIPC routines available to supported media types
161 void tipc_rcv(struct sk_buff
*buf
, struct tipc_bearer
*tb_ptr
);
162 int tipc_enable_bearer(const char *bearer_name
, u32 disc_domain
, u32 priority
);
163 int tipc_disable_bearer(const char *name
);
166 * Routines made available to TIPC by supported media types
168 extern struct tipc_media eth_media_info
;
170 #ifdef CONFIG_TIPC_MEDIA_IB
171 extern struct tipc_media ib_media_info
;
174 int tipc_media_set_priority(const char *name
, u32 new_value
);
175 int tipc_media_set_window(const char *name
, u32 new_value
);
176 void tipc_media_addr_printf(char *buf
, int len
, struct tipc_media_addr
*a
);
177 struct sk_buff
*tipc_media_get_names(void);
178 void tipc_l2_media_addr_set(const struct tipc_bearer
*b
,
179 struct tipc_media_addr
*a
, char *mac
);
180 int tipc_enable_l2_media(struct tipc_bearer
*b
);
181 void tipc_disable_l2_media(struct tipc_bearer
*b
);
182 int tipc_l2_send_msg(struct sk_buff
*buf
, struct tipc_bearer
*b
,
183 struct tipc_media_addr
*dest
);
185 struct sk_buff
*tipc_bearer_get_names(void);
186 void tipc_bearer_add_dest(u32 bearer_id
, u32 dest
);
187 void tipc_bearer_remove_dest(u32 bearer_id
, u32 dest
);
188 struct tipc_bearer
*tipc_bearer_find(const char *name
);
189 struct tipc_media
*tipc_media_find(const char *name
);
190 int tipc_bearer_setup(void);
191 void tipc_bearer_cleanup(void);
192 void tipc_bearer_stop(void);
193 void tipc_bearer_send(u32 bearer_id
, struct sk_buff
*buf
,
194 struct tipc_media_addr
*dest
);
196 #endif /* _TIPC_BEARER_H */