kernel/2.6/include/linux/can/af_can.h

   1 /*
   2  * $Id$
   3  *
   4  * Copyright (c) 2002-2005 Volkswagen Group Electronic Research
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions, the following disclaimer and
  12  *    the referenced file 'COPYING'.
  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 name of Volkswagen nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * Alternatively, provided that this notice is retained in full, this
  21  * software may be distributed under the terms of the GNU General
  22  * Public License ("GPL") version 2 as distributed in the 'COPYING'
  23  * file from the main directory of the linux kernel source.
  24  *
  25  * The provided data structures and external interfaces from this code
  26  * are not restricted to be used by modules with a GPL compatible license.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  39  * DAMAGE.
  40  *
  41  * Send feedback to <socketcan-users@lists.berlios.de>
  42  *
  43  */
  44
  45 #ifndef AF_CAN_H
  46 #define AF_CAN_H
  47
  48 #ifdef __KERNEL__
  49 #include <linux/version.h>
  50 #include <linux/skbuff.h>
  51 #include <linux/netdevice.h>
  52 #include <linux/proc_fs.h>
  53 #include <linux/if.h>
  54 #include <linux/list.h>
  55 #else
  56 #include <net/if.h>
  57 #endif
  58
  59 #include <linux/can/can.h>
  60
  61 /* CAN socket protocol family definition */
  62 /* to be moved to include/linux/socket.h */
  63 #define PF_CAN          29      /* Controller Area Network      */
  64 #define AF_CAN          PF_CAN
  65
  66 /* particular protocols of the protocol family PF_CAN */
  67 #define CAN_RAW         1 /* RAW sockets */
  68 #define CAN_BCM         2 /* Broadcast Manager */
  69 #define CAN_TP16        3 /* VAG Transport Protocol v1.6 */
  70 #define CAN_TP20        4 /* VAG Transport Protocol v2.0 */
  71 #define CAN_MCNET       5 /* Bosch MCNet */
  72 #define CAN_ISOTP       6 /* ISO 15765-2 Transport Protocol */
  73 #define CAN_BAP         7 /* VAG Bedien- und Anzeigeprotokoll */
  74 #define CAN_NPROTO      8
  75
  76 #define SOL_CAN_BASE 100
  77
  78 struct sockaddr_can {
  79         sa_family_t   can_family;
  80         int           can_ifindex;
  81         union {
  82                 struct { canid_t rx_id, tx_id; } tp16;
  83                 struct { canid_t rx_id, tx_id; } tp20;
  84                 struct { canid_t rx_id, tx_id; } mcnet;
  85         } can_addr;
  86 };
  87
  88 typedef canid_t can_err_mask_t;
  89
  90 struct can_filter {
  91         canid_t can_id;
  92         canid_t can_mask;
  93 };
  94
  95 #define CAN_INV_FILTER 0x20000000U /* to be set in can_filter.can_id */
  96
  97 #ifdef __KERNEL__
  98
  99 #define CAN_PROC_DIR "net/can" /* /proc/... */
 100
 101 struct can_proto {
 102         int              type;
 103         int              protocol;
 104         int              capability;
 105         struct proto_ops *ops;
 106 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,13)
 107         struct proto     *prot;
 108 #else
 109         struct module    *owner;
 110         int              (*init)(struct sock *sk);
 111         size_t           obj_size;
 112 #endif
 113 };
 114
 115 void can_proto_register(struct can_proto *cp);
 116 void can_proto_unregister(struct can_proto *cp);
 117 void can_rx_register(struct net_device *dev, canid_t can_id, canid_t mask,
 118                      void (*func)(struct sk_buff *, void *), void *data,
 119                      char *ident);
 120 void can_rx_unregister(struct net_device *dev, canid_t can_id, canid_t mask,
 121                        void (*func)(struct sk_buff *, void *), void *data);
 122 void can_dev_register(struct net_device *dev,
 123                       void (*func)(unsigned long msg, void *), void *data);
 124 void can_dev_unregister(struct net_device *dev,
 125                         void (*func)(unsigned long msg, void *), void *data);
 126 int  can_send(struct sk_buff *skb, int loop);
 127
 128 unsigned long timeval2jiffies(struct timeval *tv, int round_up);
 129
 130 void can_debug_skb(struct sk_buff *skb);
 131 void can_debug_cframe(const char *msg, struct can_frame *cframe, ...);
 132
 133 /* af_can rx dispatcher structures */
 134
 135 struct receiver {
 136         struct hlist_node list;
 137         struct rcu_head rcu;
 138         canid_t can_id;
 139         canid_t mask;
 140         unsigned long matches;
 141         void (*func)(struct sk_buff *, void *);
 142         void *data;
 143         char *ident;
 144 };
 145
 146 struct dev_rcv_lists {
 147         struct hlist_node list;
 148         struct rcu_head rcu;
 149         struct net_device *dev;
 150         struct hlist_head rx_err;
 151         struct hlist_head rx_all;
 152         struct hlist_head rx_fil;
 153         struct hlist_head rx_inv;
 154         struct hlist_head rx_sff[0x800];
 155         struct hlist_head rx_eff;
 156         int entries;
 157 };
 158
 159 /* statistic structures */
 160
 161 struct s_stats {
 162         unsigned long jiffies_init;
 163
 164         unsigned long rx_frames;
 165         unsigned long tx_frames;
 166         unsigned long matches;
 167
 168         unsigned long total_rx_rate;
 169         unsigned long total_tx_rate;
 170         unsigned long total_rx_match_ratio;
 171
 172         unsigned long current_rx_rate;
 173         unsigned long current_tx_rate;
 174         unsigned long current_rx_match_ratio;
 175
 176         unsigned long max_rx_rate;
 177         unsigned long max_tx_rate;
 178         unsigned long max_rx_match_ratio;
 179
 180         unsigned long rx_frames_delta;
 181         unsigned long tx_frames_delta;
 182         unsigned long matches_delta;
 183 }; /* can be reset e.g. by can_init_stats() */
 184
 185 struct s_pstats {
 186         unsigned long stats_reset;
 187         unsigned long rcv_entries;
 188         unsigned long rcv_entries_max;
 189 }; /* persistent statistics */
 190
 191 void can_init_proc(void);
 192 void can_remove_proc(void);
 193
 194 #endif
 195
 196 #endif /* AF_CAN_H */