[TIPC] Update of file headers
[linux-2.6.git] / include / net / tipc / tipc_bearer.h
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 struct tipc_media_addr {
53         __u32  type;
54         union {
55                 __u8   eth_addr[6];     /* Ethernet bearer */ 
56 #if 0
57                 /* Prototypes for other possible bearer types */
58
59                 struct {
60                         __u16 sin_family;
61                         __u16 sin_port;
62                         struct {
63                                 __u32 s_addr;
64                         } sin_addr;
65                         char pad[4];
66                 } addr_in;              /* IP-based bearer */
67                 __u16  sock_descr;      /* generic socket bearer */
68 #endif
69         } dev_addr;
70 };
71
72 /**
73  * struct tipc_bearer - TIPC bearer info available to privileged users
74  * @usr_handle: pointer to additional user-defined information about bearer
75  * @mtu: max packet size bearer can support
76  * @blocked: non-zero if bearer is blocked
77  * @lock: spinlock for controlling access to bearer
78  * @addr: media-specific address associated with bearer
79  * @name: bearer name (format = media:interface)
80  * 
81  * Note: TIPC initializes "name" and "lock" fields; user is responsible for
82  * initialization all other fields when a bearer is enabled.
83  */
84
85 struct tipc_bearer {
86         void *usr_handle;
87         u32 mtu;
88         int blocked;
89         spinlock_t lock;
90         struct tipc_media_addr addr;
91         char name[TIPC_MAX_BEARER_NAME];
92 };
93
94
95 int  tipc_register_media(u32 media_type,
96                          char *media_name, 
97                          int (*enable)(struct tipc_bearer *), 
98                          void (*disable)(struct tipc_bearer *), 
99                          int (*send_msg)(struct sk_buff *, 
100                                          struct tipc_bearer *,
101                                          struct tipc_media_addr *), 
102                          char *(*addr2str)(struct tipc_media_addr *a,
103                                            char *str_buf,
104                                            int str_size),
105                          struct tipc_media_addr *bcast_addr,
106                          const u32 bearer_priority,
107                          const u32 link_tolerance,  /* [ms] */
108                          const u32 send_window_limit); 
109
110 void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
111
112 int  tipc_block_bearer(const char *name);
113 void tipc_continue(struct tipc_bearer *tb_ptr); 
114
115 int tipc_enable_bearer(const char *bearer_name, u32 bcast_scope, u32 priority);
116 int tipc_disable_bearer(const char *name);
117
118
119 #endif
120
121 #endif