1 /* 2 * net/tipc/bearer.h: Include file for TIPC bearer code 3 * 4 * Copyright (c) 1996-2006, 2013, Ericsson AB 5 * Copyright (c) 2005, 2010-2011, Wind River Systems 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions are met: 10 * 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. 19 * 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 34 * POSSIBILITY OF SUCH DAMAGE. 35 */ 36 37 #ifndef _TIPC_BEARER_H 38 #define _TIPC_BEARER_H 39 40 #include "bcast.h" 41 42 #define MAX_BEARERS 2 43 #define MAX_MEDIA 2 44 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 49 */ 50 #define TIPC_MEDIA_ADDR_SIZE 32 51 #define TIPC_MEDIA_TYPE_OFFSET 3 52 53 /* 54 * Identifiers of supported TIPC media types 55 */ 56 #define TIPC_MEDIA_TYPE_ETH 1 57 #define TIPC_MEDIA_TYPE_IB 2 58 59 /** 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 64 */ 65 struct tipc_media_addr { 66 u8 value[TIPC_MEDIA_ADDR_SIZE]; 67 u8 media_id; 68 u8 broadcast; 69 }; 70 71 struct tipc_bearer; 72 73 /** 74 * struct tipc_media - Media specific info exposed to generic bearer layer 75 * @send_msg: routine which handles buffer transmission 76 * @enable_media: routine which enables a media 77 * @disable_media: routine which disables a media 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 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 85 * @type_id: TIPC media identifier 86 * @hwaddr_len: TIPC media address len 87 * @name: media name 88 */ 89 struct tipc_media { 90 int (*send_msg)(struct sk_buff *buf, 91 struct tipc_bearer *b_ptr, 92 struct tipc_media_addr *dest); 93 int (*enable_media)(struct tipc_bearer *b_ptr); 94 void (*disable_media)(struct tipc_bearer *b_ptr); 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); 105 u32 priority; 106 u32 tolerance; 107 u32 window; 108 u32 type_id; 109 u32 hwaddr_len; 110 char name[TIPC_MAX_MEDIA_NAME]; 111 }; 112 113 /** 114 * struct tipc_bearer - Generic TIPC bearer structure 115 * @media_ptr: pointer to additional media-specific information about bearer 116 * @mtu: max packet size bearer can support 117 * @addr: media-specific address associated with bearer 118 * @name: bearer name (format = media:interface) 119 * @media: ptr to media structure associated with bearer 120 * @bcast_addr: media address used in broadcasting 121 * @rcu: rcu struct for tipc_bearer 122 * @priority: default link priority for bearer 123 * @window: default window size for bearer 124 * @tolerance: default link tolerance for bearer 125 * @domain: network domain to which links can be established 126 * @identity: array index of this bearer within TIPC bearer array 127 * @link_req: ptr to (optional) structure making periodic link setup requests 128 * @net_plane: network plane ('A' through 'H') currently associated with bearer 129 * @nodes: indicates which nodes in cluster can be reached through bearer 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. 134 */ 135 struct tipc_bearer { 136 void __rcu *media_ptr; /* initalized by media */ 137 u32 mtu; /* initalized by media */ 138 struct tipc_media_addr addr; /* initalized by media */ 139 char name[TIPC_MAX_BEARER_NAME]; 140 struct tipc_media *media; 141 struct tipc_media_addr bcast_addr; 142 struct rcu_head rcu; 143 u32 priority; 144 u32 window; 145 u32 tolerance; 146 u32 domain; 147 u32 identity; 148 struct tipc_link_req *link_req; 149 char net_plane; 150 struct tipc_node_map nodes; 151 }; 152 153 struct tipc_bearer_names { 154 char media_name[TIPC_MAX_MEDIA_NAME]; 155 char if_name[TIPC_MAX_IF_NAME]; 156 }; 157 158 struct tipc_link; 159 160 extern struct tipc_bearer __rcu *bearer_list[]; 161 162 /* 163 * TIPC routines available to supported media types 164 */ 165 166 void tipc_rcv(struct sk_buff *buf, struct tipc_bearer *tb_ptr); 167 int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority); 168 int tipc_disable_bearer(const char *name); 169 170 /* 171 * Routines made available to TIPC by supported media types 172 */ 173 extern struct tipc_media eth_media_info; 174 175 #ifdef CONFIG_TIPC_MEDIA_IB 176 extern struct tipc_media ib_media_info; 177 #endif 178 179 int tipc_media_set_priority(const char *name, u32 new_value); 180 int tipc_media_set_window(const char *name, u32 new_value); 181 void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a); 182 struct sk_buff *tipc_media_get_names(void); 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); 187 188 struct sk_buff *tipc_bearer_get_names(void); 189 void tipc_bearer_add_dest(u32 bearer_id, u32 dest); 190 void tipc_bearer_remove_dest(u32 bearer_id, u32 dest); 191 struct tipc_bearer *tipc_bearer_find(const char *name); 192 struct tipc_media *tipc_media_find(const char *name); 193 int tipc_bearer_setup(void); 194 void tipc_bearer_cleanup(void); 195 void tipc_bearer_stop(void); 196 void tipc_bearer_send(u32 bearer_id, struct sk_buff *buf, 197 struct tipc_media_addr *dest); 198 199 #endif /* _TIPC_BEARER_H */ 200