/*
   * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in the
   *    documentation and/or other materials provided with the distribution.
   * 3. Neither the name of Volkswagen nor the names of its contributors
   *    may be used to endorse or promote products derived from this software
   *    without specific prior written permission.
   *
   * Alternatively, provided that this notice is retained in full, this
   * software may be distributed under the terms of the GNU General
   * Public License ("GPL") version 2, in which case the provisions of the
   * GPL apply INSTEAD OF those given above.
   *
   * The provided data structures and external interfaces from this code
   * are not restricted to be used by modules with a GPL compatible license.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
   * DAMAGE.
   *
   */
  
  #ifndef AF_CAN_H
  #define AF_CAN_H
  
  #include <linux/skbuff.h>
  #include <linux/netdevice.h>
  #include <linux/list.h>
  #include <linux/rcupdate.h>
  #include <linux/can.h>
  
  /* af_can rx dispatcher structures */
  
  struct receiver {
  	struct hlist_node list;
  	struct rcu_head rcu;
  	canid_t can_id;
  	canid_t mask;
  	unsigned long matches;
  	void (*func)(struct sk_buff *, void *);
  	void *data;
  	char *ident;
  };
  
  enum { RX_ERR, RX_ALL, RX_FIL, RX_INV, RX_EFF, RX_MAX };
  
  /* per device receive filters linked at dev->ml_priv */
  struct dev_rcv_lists {
  	struct hlist_head rx[RX_MAX];
  	struct hlist_head rx_sff[0x800];
  	int remove_on_zero_entries;
  	int entries;
  };
  
  /* statistic structures */
  
  /* can be reset e.g. by can_init_stats() */
  struct s_stats {
  	unsigned long jiffies_init;
  
  	unsigned long rx_frames;
  	unsigned long tx_frames;
  	unsigned long matches;
  
  	unsigned long total_rx_rate;
  	unsigned long total_tx_rate;
  	unsigned long total_rx_match_ratio;
  
  	unsigned long current_rx_rate;
  	unsigned long current_tx_rate;
  	unsigned long current_rx_match_ratio;
  
  	unsigned long max_rx_rate;
  	unsigned long max_tx_rate;
  	unsigned long max_rx_match_ratio;
  
  	unsigned long rx_frames_delta;
  	unsigned long tx_frames_delta;
  	unsigned long matches_delta;
  };
  
  /* persistent statistics */
  struct s_pstats {
  	unsigned long stats_reset;
  	unsigned long user_reset;
  	unsigned long rcv_entries;
  	unsigned long rcv_entries_max;
  };
  
  /* receive filters subscribed for 'all' CAN devices */
  extern struct dev_rcv_lists can_rx_alldev_list;
  
  /* function prototypes for the CAN networklayer procfs (proc.c) */
  void can_init_proc(void);
  void can_remove_proc(void);
  void can_stat_update(unsigned long data);
  
  /* structures and variables from af_can.c needed in proc.c for reading */
  extern struct timer_list can_stattimer;    /* timer for statistics update */
  extern struct s_stats    can_stats;        /* packet statistics */
  extern struct s_pstats   can_pstats;       /* receive list statistics */
  extern struct hlist_head can_rx_dev_list;  /* rx dispatcher structures */
  
  #endif /* AF_CAN_H */