1/* 2 * include/net/tipc/tipc_bearer.h: Include file for privileged access to TIPC bearers 3 * 4 * Copyright (c) 2003-2006, Ericsson AB 5 * Copyright (c) 2005, 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 _NET_TIPC_BEARER_H_ 38#define _NET_TIPC_BEARER_H_ 39 40#ifdef __KERNEL__ 41 42#include <linux/tipc_config.h> 43#include <linux/skbuff.h> 44#include <linux/spinlock.h> 45 46/* 47 * Identifiers of supported TIPC media types 48 */ 49 50#define TIPC_MEDIA_TYPE_ETH 1 51 52/* 53 * Destination address structure used by TIPC bearers when sending messages 54 * 55 * IMPORTANT: The fields of this structure MUST be stored using the specified 56 * byte order indicated below, as the structure is exchanged between nodes 57 * as part of a link setup process. 58 */ 59 60struct tipc_media_addr { 61 __be32 type; /* bearer type (network byte order) */ 62 union { 63 __u8 eth_addr[6]; /* 48 bit Ethernet addr (byte array) */ 64 } dev_addr; 65}; 66 67/** 68 * struct tipc_bearer - TIPC bearer info available to privileged users 69 * @usr_handle: pointer to additional user-defined information about bearer 70 * @mtu: max packet size bearer can support 71 * @blocked: non-zero if bearer is blocked 72 * @lock: spinlock for controlling access to bearer 73 * @addr: media-specific address associated with bearer 74 * @name: bearer name (format = media:interface) 75 * 76 * Note: TIPC initializes "name" and "lock" fields; user is responsible for 77 * initialization all other fields when a bearer is enabled. 78 */ 79 80struct tipc_bearer { 81 void *usr_handle; 82 u32 mtu; 83 int blocked; 84 spinlock_t lock; 85 struct tipc_media_addr addr; 86 char name[TIPC_MAX_BEARER_NAME]; 87}; 88 89/* 90 * TIPC routines available to supported media types 91 */ 92 93int tipc_register_media(u32 media_type, 94 char *media_name, 95 int (*enable)(struct tipc_bearer *), 96 void (*disable)(struct tipc_bearer *), 97 int (*send_msg)(struct sk_buff *, 98 struct tipc_bearer *, 99 struct tipc_media_addr *), 100 char *(*addr2str)(struct tipc_media_addr *a, 101 char *str_buf, 102 int str_size), 103 struct tipc_media_addr *bcast_addr, 104 const u32 bearer_priority, 105 const u32 link_tolerance, /* [ms] */ 106 const u32 send_window_limit); 107 108void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr); 109 110int tipc_block_bearer(const char *name); 111void tipc_continue(struct tipc_bearer *tb_ptr); 112 113int tipc_enable_bearer(const char *bearer_name, u32 bcast_scope, u32 priority); 114int tipc_disable_bearer(const char *name); 115 116/* 117 * Routines made available to TIPC by supported media types 118 */ 119 120int tipc_eth_media_start(void); 121void tipc_eth_media_stop(void); 122 123#endif 124 125#endif 126