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 /*
  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
  60 struct 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 #if 0
  65                 /* Prototypes for other possible bearer types */
  66
  67                 struct {
  68                         __u16 sin_family;
  69                         __u16 sin_port;
  70                         struct {
  71                                 __u32 s_addr;
  72                         } sin_addr;
  73                         char pad[4];
  74                 } addr_in;              /* IP-based bearer */
  75                 __u16  sock_descr;      /* generic socket bearer */
  76 #endif
  77         } dev_addr;
  78 };
  79
  80 /**
  81  * struct tipc_bearer - TIPC bearer info available to privileged users
  82  * @usr_handle: pointer to additional user-defined information about bearer
  83  * @mtu: max packet size bearer can support
  84  * @blocked: non-zero if bearer is blocked
  85  * @lock: spinlock for controlling access to bearer
  86  * @addr: media-specific address associated with bearer
  87  * @name: bearer name (format = media:interface)
  88  *
  89  * Note: TIPC initializes "name" and "lock" fields; user is responsible for
  90  * initialization all other fields when a bearer is enabled.
  91  */
  92
  93 struct tipc_bearer {
  94         void *usr_handle;
  95         u32 mtu;
  96         int blocked;
  97         spinlock_t lock;
  98         struct tipc_media_addr addr;
  99         char name[TIPC_MAX_BEARER_NAME];
 100 };
 101
 102 /*
 103  * TIPC routines available to supported media types
 104  */
 105
 106 int  tipc_register_media(u32 media_type,
 107                          char *media_name,
 108                          int (*enable)(struct tipc_bearer *),
 109                          void (*disable)(struct tipc_bearer *),
 110                          int (*send_msg)(struct sk_buff *,
 111                                          struct tipc_bearer *,
 112                                          struct tipc_media_addr *),
 113                          char *(*addr2str)(struct tipc_media_addr *a,
 114                                            char *str_buf,
 115                                            int str_size),
 116                          struct tipc_media_addr *bcast_addr,
 117                          const u32 bearer_priority,
 118                          const u32 link_tolerance,  /* [ms] */
 119                          const u32 send_window_limit);
 120
 121 void tipc_recv_msg(struct sk_buff *buf, struct tipc_bearer *tb_ptr);
 122
 123 int  tipc_block_bearer(const char *name);
 124 void tipc_continue(struct tipc_bearer *tb_ptr);
 125
 126 int tipc_enable_bearer(const char *bearer_name, u32 bcast_scope, u32 priority);
 127 int tipc_disable_bearer(const char *name);
 128
 129 /*
 130  * Routines made available to TIPC by supported media types
 131  */
 132
 133 int  tipc_eth_media_start(void);
 134 void tipc_eth_media_stop(void);
 135
 136 #endif
 137
 138 #endif