2 * net/tipc/eth_media.c: Ethernet bearer support for TIPC
4 * Copyright (c) 2001-2007, Ericsson AB
5 * Copyright (c) 2005-2008, 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.
40 #define MAX_ETH_BEARERS MAX_BEARERS
42 #define ETH_ADDR_OFFSET 4 /* message header offset of MAC address */
45 * struct eth_bearer - Ethernet bearer data structure
46 * @bearer: ptr to associated "generic" bearer structure
47 * @dev: ptr to associated Ethernet network device
48 * @tipc_packet_type: used in binding TIPC to Ethernet driver
49 * @setup: work item used when enabling bearer
50 * @cleanup: work item used when disabling bearer
53 struct tipc_bearer
*bearer
;
54 struct net_device
*dev
;
55 struct packet_type tipc_packet_type
;
56 struct work_struct setup
;
57 struct work_struct cleanup
;
60 static struct tipc_media eth_media_info
;
61 static struct eth_bearer eth_bearers
[MAX_ETH_BEARERS
];
62 static int eth_started
;
64 static int recv_notification(struct notifier_block
*nb
, unsigned long evt
,
67 * Network device notifier info
69 static struct notifier_block notifier
= {
70 .notifier_call
= recv_notification
,
75 * eth_media_addr_set - initialize Ethernet media address structure
77 * Media-dependent "value" field stores MAC address in first 6 bytes
78 * and zeroes out the remaining bytes.
80 static void eth_media_addr_set(struct tipc_media_addr
*a
, char *mac
)
82 memcpy(a
->value
, mac
, ETH_ALEN
);
83 memset(a
->value
+ ETH_ALEN
, 0, sizeof(a
->value
) - ETH_ALEN
);
84 a
->media_id
= TIPC_MEDIA_TYPE_ETH
;
85 a
->broadcast
= !memcmp(mac
, eth_media_info
.bcast_addr
.value
, ETH_ALEN
);
89 * send_msg - send a TIPC message out over an Ethernet interface
91 static int send_msg(struct sk_buff
*buf
, struct tipc_bearer
*tb_ptr
,
92 struct tipc_media_addr
*dest
)
94 struct sk_buff
*clone
;
95 struct net_device
*dev
;
98 clone
= skb_clone(buf
, GFP_ATOMIC
);
102 dev
= ((struct eth_bearer
*)(tb_ptr
->usr_handle
))->dev
;
103 delta
= dev
->hard_header_len
- skb_headroom(buf
);
106 pskb_expand_head(clone
, SKB_DATA_ALIGN(delta
), 0, GFP_ATOMIC
)) {
111 skb_reset_network_header(clone
);
113 dev_hard_header(clone
, dev
, ETH_P_TIPC
, dest
->value
,
114 dev
->dev_addr
, clone
->len
);
115 dev_queue_xmit(clone
);
120 * recv_msg - handle incoming TIPC message from an Ethernet interface
122 * Accept only packets explicitly sent to this node, or broadcast packets;
123 * ignores packets sent using Ethernet multicast, and traffic sent to other
124 * nodes (which can happen if interface is running in promiscuous mode).
126 static int recv_msg(struct sk_buff
*buf
, struct net_device
*dev
,
127 struct packet_type
*pt
, struct net_device
*orig_dev
)
129 struct eth_bearer
*eb_ptr
= (struct eth_bearer
*)pt
->af_packet_priv
;
131 if (!net_eq(dev_net(dev
), &init_net
)) {
136 if (likely(eb_ptr
->bearer
)) {
137 if (likely(buf
->pkt_type
<= PACKET_BROADCAST
)) {
139 tipc_recv_msg(buf
, eb_ptr
->bearer
);
148 * setup_bearer - setup association between Ethernet bearer and interface
150 static void setup_bearer(struct work_struct
*work
)
152 struct eth_bearer
*eb_ptr
=
153 container_of(work
, struct eth_bearer
, setup
);
155 dev_add_pack(&eb_ptr
->tipc_packet_type
);
159 * enable_bearer - attach TIPC bearer to an Ethernet interface
161 static int enable_bearer(struct tipc_bearer
*tb_ptr
)
163 struct net_device
*dev
= NULL
;
164 struct net_device
*pdev
= NULL
;
165 struct eth_bearer
*eb_ptr
= ð_bearers
[0];
166 struct eth_bearer
*stop
= ð_bearers
[MAX_ETH_BEARERS
];
167 char *driver_name
= strchr((const char *)tb_ptr
->name
, ':') + 1;
170 /* Find unused Ethernet bearer structure */
171 while (eb_ptr
->dev
) {
174 if (++eb_ptr
== stop
)
175 return pending_dev
? -EAGAIN
: -EDQUOT
;
178 /* Find device with specified name */
179 read_lock(&dev_base_lock
);
180 for_each_netdev(&init_net
, pdev
) {
181 if (!strncmp(pdev
->name
, driver_name
, IFNAMSIZ
)) {
187 read_unlock(&dev_base_lock
);
191 /* Create Ethernet bearer for device */
193 eb_ptr
->tipc_packet_type
.type
= htons(ETH_P_TIPC
);
194 eb_ptr
->tipc_packet_type
.dev
= dev
;
195 eb_ptr
->tipc_packet_type
.func
= recv_msg
;
196 eb_ptr
->tipc_packet_type
.af_packet_priv
= eb_ptr
;
197 INIT_LIST_HEAD(&(eb_ptr
->tipc_packet_type
.list
));
198 INIT_WORK(&eb_ptr
->setup
, setup_bearer
);
199 schedule_work(&eb_ptr
->setup
);
201 /* Associate TIPC bearer with Ethernet bearer */
202 eb_ptr
->bearer
= tb_ptr
;
203 tb_ptr
->usr_handle
= (void *)eb_ptr
;
204 tb_ptr
->mtu
= dev
->mtu
;
206 eth_media_addr_set(&tb_ptr
->addr
, (char *)dev
->dev_addr
);
211 * cleanup_bearer - break association between Ethernet bearer and interface
213 * This routine must be invoked from a work queue because it can sleep.
215 static void cleanup_bearer(struct work_struct
*work
)
217 struct eth_bearer
*eb_ptr
=
218 container_of(work
, struct eth_bearer
, cleanup
);
220 dev_remove_pack(&eb_ptr
->tipc_packet_type
);
221 dev_put(eb_ptr
->dev
);
226 * disable_bearer - detach TIPC bearer from an Ethernet interface
228 * Mark Ethernet bearer as inactive so that incoming buffers are thrown away,
229 * then get worker thread to complete bearer cleanup. (Can't do cleanup
230 * here because cleanup code needs to sleep and caller holds spinlocks.)
232 static void disable_bearer(struct tipc_bearer
*tb_ptr
)
234 struct eth_bearer
*eb_ptr
= (struct eth_bearer
*)tb_ptr
->usr_handle
;
236 eb_ptr
->bearer
= NULL
;
237 INIT_WORK(&eb_ptr
->cleanup
, cleanup_bearer
);
238 schedule_work(&eb_ptr
->cleanup
);
242 * recv_notification - handle device updates from OS
244 * Change the state of the Ethernet bearer (if any) associated with the
247 static int recv_notification(struct notifier_block
*nb
, unsigned long evt
,
250 struct net_device
*dev
= (struct net_device
*)dv
;
251 struct eth_bearer
*eb_ptr
= ð_bearers
[0];
252 struct eth_bearer
*stop
= ð_bearers
[MAX_ETH_BEARERS
];
254 if (!net_eq(dev_net(dev
), &init_net
))
257 while ((eb_ptr
->dev
!= dev
)) {
258 if (++eb_ptr
== stop
)
259 return NOTIFY_DONE
; /* couldn't find device */
262 return NOTIFY_DONE
; /* bearer had been disabled */
264 eb_ptr
->bearer
->mtu
= dev
->mtu
;
268 if (netif_carrier_ok(dev
))
269 tipc_continue(eb_ptr
->bearer
);
271 tipc_block_bearer(eb_ptr
->bearer
->name
);
274 tipc_continue(eb_ptr
->bearer
);
277 tipc_block_bearer(eb_ptr
->bearer
->name
);
279 case NETDEV_CHANGEMTU
:
280 case NETDEV_CHANGEADDR
:
281 tipc_block_bearer(eb_ptr
->bearer
->name
);
282 tipc_continue(eb_ptr
->bearer
);
284 case NETDEV_UNREGISTER
:
285 case NETDEV_CHANGENAME
:
286 tipc_disable_bearer(eb_ptr
->bearer
->name
);
293 * eth_addr2str - convert Ethernet address to string
295 static int eth_addr2str(struct tipc_media_addr
*a
, char *str_buf
, int str_size
)
297 if (str_size
< 18) /* 18 = strlen("aa:bb:cc:dd:ee:ff\0") */
300 sprintf(str_buf
, "%pM", a
->value
);
305 * eth_str2addr - convert string to Ethernet address
307 static int eth_str2addr(struct tipc_media_addr
*a
, char *str_buf
)
312 r
= sscanf(str_buf
, "%02x:%02x:%02x:%02x:%02x:%02x",
313 (u32
*)&mac
[0], (u32
*)&mac
[1], (u32
*)&mac
[2],
314 (u32
*)&mac
[3], (u32
*)&mac
[4], (u32
*)&mac
[5]);
319 eth_media_addr_set(a
, mac
);
324 * eth_str2addr - convert Ethernet address format to message header format
326 static int eth_addr2msg(struct tipc_media_addr
*a
, char *msg_area
)
328 memset(msg_area
, 0, TIPC_MEDIA_ADDR_SIZE
);
329 msg_area
[TIPC_MEDIA_TYPE_OFFSET
] = TIPC_MEDIA_TYPE_ETH
;
330 memcpy(msg_area
+ ETH_ADDR_OFFSET
, a
->value
, ETH_ALEN
);
335 * eth_str2addr - convert message header address format to Ethernet format
337 static int eth_msg2addr(struct tipc_media_addr
*a
, char *msg_area
)
339 if (msg_area
[TIPC_MEDIA_TYPE_OFFSET
] != TIPC_MEDIA_TYPE_ETH
)
342 eth_media_addr_set(a
, msg_area
+ ETH_ADDR_OFFSET
);
347 * Ethernet media registration info
349 static struct tipc_media eth_media_info
= {
350 .send_msg
= send_msg
,
351 .enable_bearer
= enable_bearer
,
352 .disable_bearer
= disable_bearer
,
353 .addr2str
= eth_addr2str
,
354 .str2addr
= eth_str2addr
,
355 .addr2msg
= eth_addr2msg
,
356 .msg2addr
= eth_msg2addr
,
357 .bcast_addr
= { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff },
358 TIPC_MEDIA_TYPE_ETH
, 1 },
359 .priority
= TIPC_DEF_LINK_PRI
,
360 .tolerance
= TIPC_DEF_LINK_TOL
,
361 .window
= TIPC_DEF_LINK_WIN
,
362 .type_id
= TIPC_MEDIA_TYPE_ETH
,
367 * tipc_eth_media_start - activate Ethernet bearer support
369 * Register Ethernet media type with TIPC bearer code. Also register
370 * with OS for notifications about device state changes.
372 int tipc_eth_media_start(void)
379 res
= tipc_register_media(ð_media_info
);
383 res
= register_netdevice_notifier(¬ifier
);
390 * tipc_eth_media_stop - deactivate Ethernet bearer support
392 void tipc_eth_media_stop(void)
397 flush_scheduled_work();
398 unregister_netdevice_notifier(¬ifier
);