1/* 2 * net/tipc/bearer.h: Include file for TIPC bearer code 3 * 4 * Copyright (c) 1996-2006, 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/* 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 */ 52#define TIPC_MEDIA_ADDR_SIZE 20 53#define TIPC_MEDIA_TYPE_OFFSET 3 54 55/* 56 * Identifiers of supported TIPC media types 57 */ 58#define TIPC_MEDIA_TYPE_ETH 1 59#define TIPC_MEDIA_TYPE_IB 2 60 61/** 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 66 */ 67struct tipc_media_addr { 68 u8 value[TIPC_MEDIA_ADDR_SIZE]; 69 u8 media_id; 70 u8 broadcast; 71}; 72 73struct tipc_bearer; 74 75/** 76 * struct tipc_media - TIPC media information available to internal users 77 * @send_msg: routine which handles buffer transmission 78 * @enable_bearer: routine which enables a bearer 79 * @disable_bearer: routine which disables a bearer 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 * @bcast_addr: media address used in broadcasting 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 87 * @type_id: TIPC media identifier 88 * @name: media name 89 */ 90struct tipc_media { 91 int (*send_msg)(struct sk_buff *buf, 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); 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); 100 u32 priority; 101 u32 tolerance; 102 u32 window; 103 u32 type_id; 104 char name[TIPC_MAX_MEDIA_NAME]; 105}; 106 107/** 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) 115 * @media: ptr to media structure associated with bearer 116 * @priority: default link priority for bearer 117 * @window: default window size for bearer 118 * @tolerance: default link tolerance for bearer 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 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 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. 129 */ 130struct 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; 137 struct tipc_media *media; 138 struct tipc_media_addr bcast_addr; 139 u32 priority; 140 u32 window; 141 u32 tolerance; 142 u32 identity; 143 struct tipc_link_req *link_req; 144 struct list_head links; 145 int active; 146 char net_plane; 147 struct tipc_node_map nodes; 148}; 149 150struct tipc_bearer_names { 151 char media_name[TIPC_MAX_MEDIA_NAME]; 152 char if_name[TIPC_MAX_IF_NAME]; 153}; 154 155struct tipc_link; 156 157extern struct tipc_bearer tipc_bearers[]; 158 159/* 160 * TIPC routines available to supported media types 161 */ 162int tipc_register_media(struct tipc_media *m_ptr); 163 164void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr); 165 166int tipc_block_bearer(const char *name); 167void tipc_continue(struct tipc_bearer *tb_ptr); 168 169int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority); 170int tipc_disable_bearer(const char *name); 171 172/* 173 * Routines made available to TIPC by supported media types 174 */ 175int tipc_eth_media_start(void); 176void tipc_eth_media_stop(void); 177 178#ifdef CONFIG_TIPC_MEDIA_IB 179int tipc_ib_media_start(void); 180void tipc_ib_media_stop(void); 181#else 182static inline int tipc_ib_media_start(void) { return 0; } 183static inline void tipc_ib_media_stop(void) { return; } 184#endif 185 186int tipc_media_set_priority(const char *name, u32 new_value); 187int tipc_media_set_window(const char *name, u32 new_value); 188void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a); 189struct sk_buff *tipc_media_get_names(void); 190 191struct sk_buff *tipc_bearer_get_names(void); 192void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest); 193void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest); 194struct tipc_bearer *tipc_bearer_find(const char *name); 195struct tipc_bearer *tipc_bearer_find_interface(const char *if_name); 196struct tipc_media *tipc_media_find(const char *name); 197int tipc_bearer_blocked(struct tipc_bearer *b_ptr); 198void tipc_bearer_stop(void); 199 200/** 201 * tipc_bearer_send- sends buffer to destination over bearer 202 * 203 * IMPORTANT: 204 * The media send routine must not alter the buffer being passed in 205 * as it may be needed for later retransmission! 206 */ 207static inline void tipc_bearer_send(struct tipc_bearer *b, struct sk_buff *buf, 208 struct tipc_media_addr *dest) 209{ 210 b->media->send_msg(buf, b, dest); 211} 212 213#endif /* _TIPC_BEARER_H */ 214