kernel/2.4/can/af_can.h

   1 /*
   2  * af_can.h
   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 <llcf@volkswagen.de>
  42  *
  43  */
  44
  45 #ifndef AF_CAN_H
  46 #define AF_CAN_H
  47
  48 #ifdef __KERNEL__
  49 #include "version.h"
  50 RCSID("$Id$");
  51 #endif
  52
  53 #ifdef __KERNEL__
  54 #include <linux/skbuff.h>
  55 #include <linux/netdevice.h>
  56 #include <linux/proc_fs.h>
  57 #include <linux/if.h>
  58 #else
  59 #include <net/if.h>
  60 #endif
  61
  62 #include "can.h"
  63
  64 #define PF_CAN       30
  65 #define AF_CAN       PF_CAN
  66
  67 #define CAN_TP16     1
  68 #define CAN_TP20     2
  69 #define CAN_RAW      3
  70 #define CAN_BCM      4
  71 #define CAN_MCNET    5
  72 #define CAN_ISOTP    6
  73 #define CAN_BAP      7
  74 #define CAN_MAX      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 struct can_filter {
  89     canid_t can_id;
  90     canid_t can_mask;
  91 };
  92
  93 #define CAN_INV_FILTER 0x20000000U /* to be set in can_filter.can_id */
  94
  95 #ifdef __KERNEL__
  96
  97 #define CAN_PROC_DIR "sys/net/can" /* /proc/... */
  98
  99 void can_proto_register(int proto, struct proto_ops *ops);
 100 void can_proto_unregister(int proto);
 101 void can_rx_register(struct net_device *dev, canid_t can_id, canid_t mask,
 102         void (*func)(struct sk_buff *, void *), void *data, char *ident);
 103 void can_rx_unregister(struct net_device *dev, canid_t can_id, canid_t mask,
 104         void (*func)(struct sk_buff *, void *), void *data);
 105 void can_dev_register(struct net_device *dev,
 106         void (*func)(unsigned long msg, void *), void *data);
 107 void can_dev_unregister(struct net_device *dev,
 108         void (*func)(unsigned long msg, void *), void *data);
 109 int  can_send(struct sk_buff *skb);
 110
 111 unsigned long timeval2jiffies(struct timeval *tv, int round_up);
 112
 113 void can_debug_skb(struct sk_buff *skb);
 114 void can_debug_cframe(const char *msg, struct can_frame *cframe, ...);
 115
 116 /* af_can rx dispatcher structures */
 117
 118 struct rcv_list {
 119     struct rcv_list *next;
 120     canid_t can_id;
 121     canid_t mask;
 122     unsigned long matches;
 123     void (*func)(struct sk_buff *, void *);
 124     void *data;
 125     char *ident;
 126 };
 127
 128 struct rcv_dev_list {
 129     struct rcv_dev_list *next;
 130     struct net_device *dev;
 131     struct rcv_list *rx_all;
 132     struct rcv_list *rx_fil;
 133     struct rcv_list *rx_inv;
 134     struct rcv_list *rx_sff[0x800];
 135     struct rcv_list *rx_eff;
 136     int entries;
 137 };
 138
 139 /* statistic structures */
 140
 141 struct s_stats {
 142     unsigned long jiffies_init;
 143
 144     unsigned long rx_frames;
 145     unsigned long tx_frames;
 146     unsigned long matches;
 147
 148     unsigned long total_rx_rate;
 149     unsigned long total_tx_rate;
 150     unsigned long total_rx_match_ratio;
 151
 152     unsigned long current_rx_rate;
 153     unsigned long current_tx_rate;
 154     unsigned long current_rx_match_ratio;
 155
 156     unsigned long max_rx_rate;
 157     unsigned long max_tx_rate;
 158     unsigned long max_rx_match_ratio;
 159
 160     unsigned long rx_frames_delta;
 161     unsigned long tx_frames_delta;
 162     unsigned long matches_delta;
 163 }; /* can be reset e.g. by can_init_stats() */
 164
 165 struct s_pstats {
 166     unsigned long stats_reset;
 167     unsigned long rcv_entries;
 168     unsigned long rcv_entries_max;
 169 }; /* persistent statistics */
 170
 171 void can_init_proc(void);
 172 void can_remove_proc(void);
 173
 174 #endif
 175
 176 #endif /* AF_CAN_H */