blob: 4f5db9ad5bf639056bc56f1284d7400e87095dcc [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/bearer.h: Include file for TIPC bearer code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Jon Paul Maloy5702dba2013-12-10 20:45:39 -08004 * Copyright (c) 1996-2006, 2013, Ericsson AB
Allan Stephens2d627b92011-01-07 13:00:11 -05005 * Copyright (c) 2005, 2010-2011, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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 Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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 Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_BEARER_H
38#define _TIPC_BEARER_H
39
Per Lidenb97bf3f2006-01-02 19:04:38 +010040#include "bcast.h"
41
Allan Stephens909234c2011-05-27 15:09:40 -040042#define MAX_BEARERS 2
43#define MAX_MEDIA 2
Per Lidenb97bf3f2006-01-02 19:04:38 +010044
Allan Stephensd265fef2010-11-30 12:00:53 +000045/*
Allan Stephens4d163a32011-10-07 13:37:34 -040046 * 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 Stephens4d163a32011-10-07 13:37:34 -040052#define TIPC_MEDIA_ADDR_SIZE 20
53#define TIPC_MEDIA_TYPE_OFFSET 3
54
55/*
Allan Stephensd265fef2010-11-30 12:00:53 +000056 * Identifiers of supported TIPC media types
57 */
58#define TIPC_MEDIA_TYPE_ETH 1
Patrick McHardya29a1942013-04-17 06:18:28 +000059#define TIPC_MEDIA_TYPE_IB 2
Allan Stephensd265fef2010-11-30 12:00:53 +000060
Ben Hutchings2c530402012-07-10 10:55:09 +000061/**
Allan Stephens3d749a62011-10-07 15:19:11 -040062 * 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 Stephensd265fef2010-11-30 12:00:53 +000066 */
67struct tipc_media_addr {
Allan Stephens3d749a62011-10-07 15:19:11 -040068 u8 value[TIPC_MEDIA_ADDR_SIZE];
69 u8 media_id;
70 u8 broadcast;
Allan Stephensd265fef2010-11-30 12:00:53 +000071};
72
Allan Stephens2d627b92011-01-07 13:00:11 -050073struct tipc_bearer;
Per Lidenb97bf3f2006-01-02 19:04:38 +010074
75/**
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -080076 * struct tipc_media - Media specific info exposed to generic bearer layer
Per Lidenb97bf3f2006-01-02 19:04:38 +010077 * @send_msg: routine which handles buffer transmission
Ying Xue4babbaa2013-10-18 07:23:17 +020078 * @enable_media: routine which enables a media
79 * @disable_media: routine which disables a media
Allan Stephens4d163a32011-10-07 13:37:34 -040080 * @addr2str: routine which converts media address to string
Allan Stephens4d163a32011-10-07 13:37:34 -040081 * @addr2msg: routine which converts media address to protocol message area
82 * @msg2addr: routine which converts media address from protocol message area
Per Lidenb97bf3f2006-01-02 19:04:38 +010083 * @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 Stephensd265fef2010-11-30 12:00:53 +000086 * @type_id: TIPC media identifier
Ying Xuee4d050c2013-12-10 20:45:43 -080087 * @hwaddr_len: TIPC media address len
Per Lidenb97bf3f2006-01-02 19:04:38 +010088 * @name: media name
89 */
Paul Gortmaker358a0d12011-12-29 20:19:42 -050090struct tipc_media {
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090091 int (*send_msg)(struct sk_buff *buf,
Per Lidenb97bf3f2006-01-02 19:04:38 +010092 struct tipc_bearer *b_ptr,
93 struct tipc_media_addr *dest);
Ying Xue4babbaa2013-10-18 07:23:17 +020094 int (*enable_media)(struct tipc_bearer *b_ptr);
95 void (*disable_media)(struct tipc_bearer *b_ptr);
Allan Stephensc61b6662011-10-07 11:31:49 -040096 int (*addr2str)(struct tipc_media_addr *a, char *str_buf, int str_size);
Allan Stephens4d163a32011-10-07 13:37:34 -040097 int (*addr2msg)(struct tipc_media_addr *a, char *msg_area);
Patrick McHardy8aeb89f2013-04-17 06:18:26 +000098 int (*msg2addr)(const struct tipc_bearer *b_ptr,
99 struct tipc_media_addr *a, char *msg_area);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100100 u32 priority;
101 u32 tolerance;
102 u32 window;
103 u32 type_id;
Ying Xuee4d050c2013-12-10 20:45:43 -0800104 u32 hwaddr_len;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100105 char name[TIPC_MAX_MEDIA_NAME];
106};
107
108/**
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -0800109 * struct tipc_bearer - Generic TIPC bearer structure
Ying Xue37cb0622013-12-10 20:45:41 -0800110 * @dev: ptr to associated network device
Allan Stephens2d627b92011-01-07 13:00:11 -0500111 * @usr_handle: pointer to additional media-specific information about bearer
112 * @mtu: max packet size bearer can support
Allan Stephens2d627b92011-01-07 13:00:11 -0500113 * @lock: spinlock for controlling access to bearer
114 * @addr: media-specific address associated with bearer
115 * @name: bearer name (format = media:interface)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100116 * @media: ptr to media structure associated with bearer
Jon Paul Maloyef72a7e2013-12-10 20:45:40 -0800117 * @bcast_addr: media address used in broadcasting
Per Lidenb97bf3f2006-01-02 19:04:38 +0100118 * @priority: default link priority for bearer
Allan Stephens5c216e12011-10-18 11:34:29 -0400119 * @window: default window size for bearer
120 * @tolerance: default link tolerance for bearer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100121 * @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 Lidenb97bf3f2006-01-02 19:04:38 +0100124 * @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 Stephens2d627b92011-01-07 13:00:11 -0500127 *
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 Lidenb97bf3f2006-01-02 19:04:38 +0100131 */
Allan Stephens2d627b92011-01-07 13:00:11 -0500132struct tipc_bearer {
Ying Xuee4d050c2013-12-10 20:45:43 -0800133 void *media_ptr; /* initalized by media */
Allan Stephens2d627b92011-01-07 13:00:11 -0500134 u32 mtu; /* initalized by media */
Allan Stephens2d627b92011-01-07 13:00:11 -0500135 struct tipc_media_addr addr; /* initalized by media */
136 char name[TIPC_MAX_BEARER_NAME];
137 spinlock_t lock;
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500138 struct tipc_media *media;
Patrick McHardy8aeb89f2013-04-17 06:18:26 +0000139 struct tipc_media_addr bcast_addr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100140 u32 priority;
Allan Stephens5c216e12011-10-18 11:34:29 -0400141 u32 window;
142 u32 tolerance;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100143 u32 identity;
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500144 struct tipc_link_req *link_req;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100145 struct list_head links;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100146 int active;
147 char net_plane;
David S. Miller6c000552008-09-02 23:38:32 -0700148 struct tipc_node_map nodes;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100149};
150
Paul Gortmakerf19765f2011-12-29 21:39:49 -0500151struct tipc_bearer_names {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100152 char media_name[TIPC_MAX_MEDIA_NAME];
153 char if_name[TIPC_MAX_IF_NAME];
154};
155
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500156struct tipc_link;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100157
Allan Stephens2d627b92011-01-07 13:00:11 -0500158extern struct tipc_bearer tipc_bearers[];
Per Lidenb97bf3f2006-01-02 19:04:38 +0100159
Allan Stephensd265fef2010-11-30 12:00:53 +0000160/*
161 * TIPC routines available to supported media types
162 */
Allan Stephensd265fef2010-11-30 12:00:53 +0000163
Jon Paul Maloy170b3922014-01-07 17:02:41 -0500164void tipc_rcv(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
Allan Stephens50d3e632011-02-28 14:56:15 -0500165int tipc_enable_bearer(const char *bearer_name, u32 disc_domain, u32 priority);
Allan Stephensd265fef2010-11-30 12:00:53 +0000166int tipc_disable_bearer(const char *name);
167
168/*
169 * Routines made available to TIPC by supported media types
170 */
Jon Paul Maloy5702dba2013-12-10 20:45:39 -0800171extern struct tipc_media eth_media_info;
Allan Stephensd265fef2010-11-30 12:00:53 +0000172
Patrick McHardya29a1942013-04-17 06:18:28 +0000173#ifdef CONFIG_TIPC_MEDIA_IB
Jon Paul Maloy5702dba2013-12-10 20:45:39 -0800174extern struct tipc_media ib_media_info;
Patrick McHardya29a1942013-04-17 06:18:28 +0000175#endif
176
Allan Stephens5c216e12011-10-18 11:34:29 -0400177int tipc_media_set_priority(const char *name, u32 new_value);
178int tipc_media_set_window(const char *name, u32 new_value);
Erik Hugnedc1aed32012-06-29 00:50:23 -0400179void tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a);
Per Liden4323add2006-01-18 00:38:21 +0100180struct sk_buff *tipc_media_get_names(void);
Ying Xuee4d050c2013-12-10 20:45:43 -0800181void tipc_l2_media_addr_set(const struct tipc_bearer *b,
182 struct tipc_media_addr *a, char *mac);
183int tipc_enable_l2_media(struct tipc_bearer *b);
184void tipc_disable_l2_media(struct tipc_bearer *b);
185int tipc_l2_send_msg(struct sk_buff *buf, struct tipc_bearer *b,
186 struct tipc_media_addr *dest);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100187
Per Liden4323add2006-01-18 00:38:21 +0100188struct sk_buff *tipc_bearer_get_names(void);
Allan Stephens2d627b92011-01-07 13:00:11 -0500189void tipc_bearer_add_dest(struct tipc_bearer *b_ptr, u32 dest);
190void tipc_bearer_remove_dest(struct tipc_bearer *b_ptr, u32 dest);
Allan Stephens5c216e12011-10-18 11:34:29 -0400191struct tipc_bearer *tipc_bearer_find(const char *name);
Paul Gortmaker358a0d12011-12-29 20:19:42 -0500192struct tipc_media *tipc_media_find(const char *name);
Ying Xue6e967ad2013-12-10 20:45:42 -0800193int tipc_bearer_setup(void);
194void tipc_bearer_cleanup(void);
Per Liden4323add2006-01-18 00:38:21 +0100195void tipc_bearer_stop(void);
Ying Xuee4d050c2013-12-10 20:45:43 -0800196void tipc_bearer_send(struct tipc_bearer *b, struct sk_buff *buf,
197 struct tipc_media_addr *dest);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100198
Allan Stephensb274f4a2010-05-11 14:30:16 +0000199#endif /* _TIPC_BEARER_H */