Pileus Git - ~andy/linux/blob - 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-2005, Ericsson Research Canada
   5  * Copyright (c) 2005, Wind River Systems
   6  * Copyright (c) 2005-2006, Ericsson AB
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the names of the copyright holders nor the names of its
  18  *    contributors may be used to endorse or promote products derived from
  19  *    this software without specific prior written permission.
  20  *
  21  * Alternatively, this software may be distributed under the terms of the
  22  * GNU General Public License ("GPL") version 2 as published by the Free
  23  * Software Foundation.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef _NET_TIPC_BEARER_H_
  39 #define _NET_TIPC_BEARER_H_
  40
  41 #ifdef __KERNEL__
  42
  43 #include <linux/tipc_config.h>
  44 #include <linux/skbuff.h>
  45 #include <linux/spinlock.h>
  46
  47 /*
  48  * Identifiers of supported TIPC media types
  49  */
  50
  51 #define TIPC_MEDIA_TYPE_ETH     1
  52
  53 struct tipc_media_addr {
  54         __u32  type;
  55         union {
  56                 __u8   eth_addr[6];     /* Ethernet bearer */
  57 #if 0
  58                 /* Prototypes for other possible bearer types */
  59
  60                 struct {
  61                         __u16 sin_family;
  62                         __u16 sin_port;
  63                         struct {
  64                                 __u32 s_addr;
  65                         } sin_addr;
  66                         char pad[4];
  67                 } addr_in;              /* IP-based bearer */
  68                 __u16  sock_descr;      /* generic socket bearer */
  69 #endif
  70         } dev_addr;
  71 };
  72
  73 /**
  74  * struct tipc_bearer - TIPC bearer info available to privileged users
  75  * @usr_handle: pointer to additional user-defined information about bearer
  76  * @mtu: max packet size bearer can support
  77  * @blocked: non-zero if bearer is blocked
  78  * @lock: spinlock for controlling access to bearer
  79  * @addr: media-specific address associated with bearer
  80  * @name: bearer name (format = media:interface)
  81  *
  82  * Note: TIPC initializes "name" and "lock" fields; user is responsible for
  83  * initialization all other fields when a bearer is enabled.
  84  */
  85
  86 struct tipc_bearer {
  87         void *usr_handle;
  88         u32 mtu;
  89         int blocked;
  90         spinlock_t lock;
  91         struct tipc_media_addr addr;
  92         char name[TIPC_MAX_BEARER_NAME];
  93 };
  94
  95
  96 int  tipc_register_media(u32 media_type,
  97                          char *media_name,
  98                          int (*enable)(struct tipc_bearer *),
  99                          void (*disable)(struct tipc_bearer *),
 100                          int (*send_msg)(struct sk_buff *,
 101                                          struct tipc_bearer *,
 102                                          struct tipc_media_addr *),
 103                          char *(*addr2str)(struct tipc_media_addr *a,
 104                                            char *str_buf,
 105                                            int str_size),
 106                          struct tipc_media_addr *bcast_addr,
 107                          const u32 bearer_priority,
 108                          const u32 link_tolerance,  /* [ms] */
 109                          const u32 send_window_limit);
 110
 111 void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
 112
 113 int  tipc_block_bearer(const char *name);
 114 void tipc_continue(struct tipc_bearer *tb_ptr);
 115
 116 int tipc_enable_bearer(const char *bearer_name, u32 bcast_scope, u32 priority);
 117 int tipc_disable_bearer(const char *name);
 118
 119
 120 #endif
 121
 122 #endif