[linux-2.6-block.git] / net / can / af_can.h

/*
 * 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.
 *
 * Send feedback to <socketcan-users@lists.berlios.de>
 *
 */

#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 };

struct dev_rcv_lists {
	struct hlist_node list;
	struct rcu_head rcu;
	struct net_device *dev;
	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;
};

/* function prototypes for the CAN networklayer procfs (proc.c) */
extern void can_init_proc(void);
extern void can_remove_proc(void);
extern 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 */
Commit	Line	Data
0d66548a OH	1	/*
	2	* Copyright (c) 2002-2007 Volkswagen Group Electronic Research
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	* 3. Neither the name of Volkswagen nor the names of its contributors
	14	* may be used to endorse or promote products derived from this software
	15	* without specific prior written permission.
	16	*
	17	* Alternatively, provided that this notice is retained in full, this
	18	* software may be distributed under the terms of the GNU General
	19	* Public License ("GPL") version 2, in which case the provisions of the
	20	* GPL apply INSTEAD OF those given above.
	21	*
	22	* The provided data structures and external interfaces from this code
	23	* are not restricted to be used by modules with a GPL compatible license.
	24	*
	25	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	26	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	27	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	28	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	29	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	30	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	31	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	32	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	33	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	34	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	35	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
	36	* DAMAGE.
	37	*
	38	* Send feedback to <socketcan-users@lists.berlios.de>
	39	*
	40	*/
	41
	42	#ifndef AF_CAN_H
	43	#define AF_CAN_H
	44
	45	#include <linux/skbuff.h>
	46	#include <linux/netdevice.h>
	47	#include <linux/list.h>
	48	#include <linux/rcupdate.h>
	49	#include <linux/can.h>
	50
	51	/* af_can rx dispatcher structures */
	52
	53	struct receiver {
	54	struct hlist_node list;
	55	struct rcu_head rcu;
	56	canid_t can_id;
	57	canid_t mask;
	58	unsigned long matches;
	59	void (func)(struct sk_buff , void *);
	60	void *data;
	61	char *ident;
	62	};
	63
	64	enum { RX_ERR, RX_ALL, RX_FIL, RX_INV, RX_EFF, RX_MAX };
65
66	struct dev_rcv_lists {
67	struct hlist_node list;
68	struct rcu_head rcu;
69	struct net_device *dev;
70	struct hlist_head rx[RX_MAX];
71	struct hlist_head rx_sff[0x800];
72	int remove_on_zero_entries;
73	int entries;
74	};
75
76	/* statistic structures */
77
78	/* can be reset e.g. by can_init_stats() */
79	struct s_stats {
80	unsigned long jiffies_init;
81
82	unsigned long rx_frames;
83	unsigned long tx_frames;
84	unsigned long matches;
85
86	unsigned long total_rx_rate;
87	unsigned long total_tx_rate;
88	unsigned long total_rx_match_ratio;
89
90	unsigned long current_rx_rate;
91	unsigned long current_tx_rate;
92	unsigned long current_rx_match_ratio;
93
94	unsigned long max_rx_rate;
95	unsigned long max_tx_rate;
96	unsigned long max_rx_match_ratio;
97
98	unsigned long rx_frames_delta;
99	unsigned long tx_frames_delta;
100	unsigned long matches_delta;
101	};
102
103	/* persistent statistics */
104	struct s_pstats {
105	unsigned long stats_reset;
106	unsigned long user_reset;
107	unsigned long rcv_entries;
108	unsigned long rcv_entries_max;
109	};
110
111	/* function prototypes for the CAN networklayer procfs (proc.c) */
112	extern void can_init_proc(void);
113	extern void can_remove_proc(void);
114	extern void can_stat_update(unsigned long data);
115
116	/* structures and variables from af_can.c needed in proc.c for reading */
117	extern struct timer_list can_stattimer; /* timer for statistics update */
118	extern struct s_stats can_stats; /* packet statistics */
119	extern struct s_pstats can_pstats; /* receive list statistics */
120	extern struct hlist_head can_rx_dev_list; /* rx dispatcher structures */
121
122	#endif /* AF_CAN_H */