Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 1 | /* |
| 2 | * net/tipc/bearer.h: Include file for TIPC bearer code |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 3 | * |
Jon Paul Maloy | 5702dba | 2013-12-10 20:45:39 -0800 | [diff] [blame] | 4 | * Copyright (c) 1996-2006, 2013, Ericsson AB |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 5 | * Copyright (c) 2005, 2010-2011, Wind River Systems |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 6 | * All rights reserved. |
| 7 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 8 | * Redistribution and use in source and binary forms, with or without |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 9 | * modification, are permitted provided that the following conditions are met: |
| 10 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 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. |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 19 | * |
Per Liden | 9ea1fd3 | 2006-01-11 13:30:43 +0100 | [diff] [blame] | 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 |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 34 | * POSSIBILITY OF SUCH DAMAGE. |
| 35 | */ |
| 36 | |
| 37 | #ifndef _TIPC_BEARER_H |
| 38 | #define _TIPC_BEARER_H |
| 39 | |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 40 | #include "bcast.h" |
| 41 | |
Allan Stephens | 909234c | 2011-05-27 15:09:40 -0400 | [diff] [blame] | 42 | #define MAX_BEARERS 2 |
| 43 | #define MAX_MEDIA 2 |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 44 | |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 45 | /* |
Allan Stephens | 4d163a3 | 2011-10-07 13:37:34 -0400 | [diff] [blame] | 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 | */ |
Allan Stephens | 4d163a3 | 2011-10-07 13:37:34 -0400 | [diff] [blame] | 52 | #define TIPC_MEDIA_ADDR_SIZE 20 |
| 53 | #define TIPC_MEDIA_TYPE_OFFSET 3 |
| 54 | |
| 55 | /* |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 56 | * Identifiers of supported TIPC media types |
| 57 | */ |
| 58 | #define TIPC_MEDIA_TYPE_ETH 1 |
Patrick McHardy | a29a194 | 2013-04-17 06:18:28 +0000 | [diff] [blame] | 59 | #define TIPC_MEDIA_TYPE_IB 2 |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 60 | |
Ben Hutchings | 2c53040 | 2012-07-10 10:55:09 +0000 | [diff] [blame] | 61 | /** |
Allan Stephens | 3d749a6 | 2011-10-07 15:19:11 -0400 | [diff] [blame] | 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 |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 66 | */ |
| 67 | struct tipc_media_addr { |
Allan Stephens | 3d749a6 | 2011-10-07 15:19:11 -0400 | [diff] [blame] | 68 | u8 value[TIPC_MEDIA_ADDR_SIZE]; |
| 69 | u8 media_id; |
| 70 | u8 broadcast; |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 71 | }; |
| 72 | |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 73 | struct tipc_bearer; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 74 | |
| 75 | /** |
Jon Paul Maloy | ef72a7e | 2013-12-10 20:45:40 -0800 | [diff] [blame] | 76 | * struct tipc_media - Media specific info exposed to generic bearer layer |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 77 | * @send_msg: routine which handles buffer transmission |
Ying Xue | 4babbaa | 2013-10-18 07:23:17 +0200 | [diff] [blame] | 78 | * @enable_media: routine which enables a media |
| 79 | * @disable_media: routine which disables a media |
Allan Stephens | 4d163a3 | 2011-10-07 13:37:34 -0400 | [diff] [blame] | 80 | * @addr2str: routine which converts media address to string |
Allan Stephens | 4d163a3 | 2011-10-07 13:37:34 -0400 | [diff] [blame] | 81 | * @addr2msg: routine which converts media address to protocol message area |
| 82 | * @msg2addr: routine which converts media address from protocol message area |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 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 |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 86 | * @type_id: TIPC media identifier |
Ying Xue | e4d050c | 2013-12-10 20:45:43 -0800 | [diff] [blame] | 87 | * @hwaddr_len: TIPC media address len |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 88 | * @name: media name |
| 89 | */ |
Paul Gortmaker | 358a0d1 | 2011-12-29 20:19:42 -0500 | [diff] [blame] | 90 | struct tipc_media { |
YOSHIFUJI Hideaki | c430728 | 2007-02-09 23:25:21 +0900 | [diff] [blame] | 91 | int (*send_msg)(struct sk_buff *buf, |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 92 | struct tipc_bearer *b_ptr, |
| 93 | struct tipc_media_addr *dest); |
Ying Xue | 4babbaa | 2013-10-18 07:23:17 +0200 | [diff] [blame] | 94 | int (*enable_media)(struct tipc_bearer *b_ptr); |
| 95 | void (*disable_media)(struct tipc_bearer *b_ptr); |
Allan Stephens | c61b666 | 2011-10-07 11:31:49 -0400 | [diff] [blame] | 96 | int (*addr2str)(struct tipc_media_addr *a, char *str_buf, int str_size); |
Allan Stephens | 4d163a3 | 2011-10-07 13:37:34 -0400 | [diff] [blame] | 97 | int (*addr2msg)(struct tipc_media_addr *a, char *msg_area); |
Patrick McHardy | 8aeb89f | 2013-04-17 06:18:26 +0000 | [diff] [blame] | 98 | int (*msg2addr)(const struct tipc_bearer *b_ptr, |
| 99 | struct tipc_media_addr *a, char *msg_area); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 100 | u32 priority; |
| 101 | u32 tolerance; |
| 102 | u32 window; |
| 103 | u32 type_id; |
Ying Xue | e4d050c | 2013-12-10 20:45:43 -0800 | [diff] [blame] | 104 | u32 hwaddr_len; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 105 | char name[TIPC_MAX_MEDIA_NAME]; |
| 106 | }; |
| 107 | |
| 108 | /** |
Jon Paul Maloy | ef72a7e | 2013-12-10 20:45:40 -0800 | [diff] [blame] | 109 | * struct tipc_bearer - Generic TIPC bearer structure |
Ying Xue | 37cb062 | 2013-12-10 20:45:41 -0800 | [diff] [blame] | 110 | * @dev: ptr to associated network device |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 111 | * @usr_handle: pointer to additional media-specific information about bearer |
| 112 | * @mtu: max packet size bearer can support |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 113 | * @lock: spinlock for controlling access to bearer |
| 114 | * @addr: media-specific address associated with bearer |
| 115 | * @name: bearer name (format = media:interface) |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 116 | * @media: ptr to media structure associated with bearer |
Jon Paul Maloy | ef72a7e | 2013-12-10 20:45:40 -0800 | [diff] [blame] | 117 | * @bcast_addr: media address used in broadcasting |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 118 | * @priority: default link priority for bearer |
Allan Stephens | 5c216e1 | 2011-10-18 11:34:29 -0400 | [diff] [blame] | 119 | * @window: default window size for bearer |
| 120 | * @tolerance: default link tolerance for bearer |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 121 | * @identity: array index of this bearer within TIPC bearer array |
| 122 | * @link_req: ptr to (optional) structure making periodic link setup requests |
| 123 | * @links: list of non-congested links associated with bearer |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 124 | * @active: non-zero if bearer structure is represents a bearer |
| 125 | * @net_plane: network plane ('A' through 'H') currently associated with bearer |
| 126 | * @nodes: indicates which nodes in cluster can be reached through bearer |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 127 | * |
| 128 | * Note: media-specific code is responsible for initialization of the fields |
| 129 | * indicated below when a bearer is enabled; TIPC's generic bearer code takes |
| 130 | * care of initializing all other fields. |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 131 | */ |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 132 | struct tipc_bearer { |
Ying Xue | e4d050c | 2013-12-10 20:45:43 -0800 | [diff] [blame] | 133 | void *media_ptr; /* initalized by media */ |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 134 | u32 mtu; /* initalized by media */ |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 135 | struct tipc_media_addr addr; /* initalized by media */ |
| 136 | char name[TIPC_MAX_BEARER_NAME]; |
| 137 | spinlock_t lock; |
Paul Gortmaker | 358a0d1 | 2011-12-29 20:19:42 -0500 | [diff] [blame] | 138 | struct tipc_media *media; |
Patrick McHardy | 8aeb89f | 2013-04-17 06:18:26 +0000 | [diff] [blame] | 139 | struct tipc_media_addr bcast_addr; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 140 | u32 priority; |
Allan Stephens | 5c216e1 | 2011-10-18 11:34:29 -0400 | [diff] [blame] | 141 | u32 window; |
| 142 | u32 tolerance; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 143 | u32 identity; |
Paul Gortmaker | a18c4bc | 2011-12-29 20:58:42 -0500 | [diff] [blame] | 144 | struct tipc_link_req *link_req; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 145 | struct list_head links; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 146 | int active; |
| 147 | char net_plane; |
David S. Miller | 6c00055 | 2008-09-02 23:38:32 -0700 | [diff] [blame] | 148 | struct tipc_node_map nodes; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 149 | }; |
| 150 | |
Paul Gortmaker | f19765f | 2011-12-29 21:39:49 -0500 | [diff] [blame] | 151 | struct tipc_bearer_names { |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 152 | char media_name[TIPC_MAX_MEDIA_NAME]; |
| 153 | char if_name[TIPC_MAX_IF_NAME]; |
| 154 | }; |
| 155 | |
Paul Gortmaker | a18c4bc | 2011-12-29 20:58:42 -0500 | [diff] [blame] | 156 | struct tipc_link; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 157 | |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 158 | extern struct tipc_bearer tipc_bearers[]; |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 159 | |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 160 | /* |
| 161 | * TIPC routines available to supported media types |
| 162 | */ |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 163 | |
Jon Paul Maloy | 170b392 | 2014-01-07 17:02:41 -0500 | [diff] [blame] | 164 | void tipc_rcv(struct sk_buff *buf, struct tipc_bearer *tb_ptr); |
Allan Stephens | 50d3e63 | 2011-02-28 14:56:15 -0500 | [diff] [blame] | 165 | int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority); |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 166 | int tipc_disable_bearer(const char *name); |
| 167 | |
| 168 | /* |
| 169 | * Routines made available to TIPC by supported media types |
| 170 | */ |
Jon Paul Maloy | 5702dba | 2013-12-10 20:45:39 -0800 | [diff] [blame] | 171 | extern struct tipc_media eth_media_info; |
Allan Stephens | d265fef | 2010-11-30 12:00:53 +0000 | [diff] [blame] | 172 | |
Patrick McHardy | a29a194 | 2013-04-17 06:18:28 +0000 | [diff] [blame] | 173 | #ifdef CONFIG_TIPC_MEDIA_IB |
Jon Paul Maloy | 5702dba | 2013-12-10 20:45:39 -0800 | [diff] [blame] | 174 | extern struct tipc_media ib_media_info; |
Patrick McHardy | a29a194 | 2013-04-17 06:18:28 +0000 | [diff] [blame] | 175 | #endif |
| 176 | |
Allan Stephens | 5c216e1 | 2011-10-18 11:34:29 -0400 | [diff] [blame] | 177 | int tipc_media_set_priority(const char *name, u32 new_value); |
| 178 | int tipc_media_set_window(const char *name, u32 new_value); |
Erik Hugne | dc1aed3 | 2012-06-29 00:50:23 -0400 | [diff] [blame] | 179 | void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a); |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 180 | struct sk_buff *tipc_media_get_names(void); |
Ying Xue | e4d050c | 2013-12-10 20:45:43 -0800 | [diff] [blame] | 181 | void tipc_l2_media_addr_set(const struct tipc_bearer *b, |
| 182 | struct tipc_media_addr *a, char *mac); |
| 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); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 187 | |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 188 | struct sk_buff *tipc_bearer_get_names(void); |
Allan Stephens | 2d627b9 | 2011-01-07 13:00:11 -0500 | [diff] [blame] | 189 | void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest); |
| 190 | void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest); |
Allan Stephens | 5c216e1 | 2011-10-18 11:34:29 -0400 | [diff] [blame] | 191 | struct tipc_bearer *tipc_bearer_find(const char *name); |
Paul Gortmaker | 358a0d1 | 2011-12-29 20:19:42 -0500 | [diff] [blame] | 192 | struct tipc_media *tipc_media_find(const char *name); |
Ying Xue | 6e967ad | 2013-12-10 20:45:42 -0800 | [diff] [blame] | 193 | int tipc_bearer_setup(void); |
| 194 | void tipc_bearer_cleanup(void); |
Per Liden | 4323add | 2006-01-18 00:38:21 +0100 | [diff] [blame] | 195 | void tipc_bearer_stop(void); |
Ying Xue | e4d050c | 2013-12-10 20:45:43 -0800 | [diff] [blame] | 196 | void tipc_bearer_send(struct tipc_bearer *b, struct sk_buff *buf, |
| 197 | struct tipc_media_addr *dest); |
Per Liden | b97bf3f | 2006-01-02 19:04:38 +0100 | [diff] [blame] | 198 | |
Allan Stephens | b274f4a | 2010-05-11 14:30:16 +0000 | [diff] [blame] | 199 | #endif /* _TIPC_BEARER_H */ |