cb13888c0daa02890add06db785f96c243e83a2c
[dpdk.git] / lib / librte_eal / linuxapp / kni / kni_dev.h
1 /*-
2  * GPL LICENSE SUMMARY
3  * 
4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
5  * 
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of version 2 of the GNU General Public License as
8  *   published by the Free Software Foundation.
9  * 
10  *   This program is distributed in the hope that it will be useful, but
11  *   WITHOUT ANY WARRANTY; without even the implied warranty of
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *   General Public License for more details.
14  * 
15  *   You should have received a copy of the GNU General Public License
16  *   along with this program; if not, write to the Free Software
17  *   Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18  *   The full GNU General Public License is included in this distribution
19  *   in the file called LICENSE.GPL.
20  * 
21  *   Contact Information:
22  *   Intel Corporation
23  */
24
25 #ifndef _KNI_DEV_H_
26 #define _KNI_DEV_H_
27
28 #include <linux/if.h>
29 #include <linux/wait.h>
30 #include <linux/sched.h>
31 #include <linux/netdevice.h>
32 #include <linux/spinlock.h>
33 #include <linux/list.h>
34
35 #include <exec-env/rte_kni_common.h>
36 #define KNI_KTHREAD_RESCHEDULE_INTERVAL 10 /* us */
37
38 /**
39  * A structure describing the private information for a kni device.
40  */
41
42 struct kni_dev {
43         /* kni list */
44         struct list_head list;
45
46         struct net_device_stats stats;
47         int status;
48         uint16_t group_id;           /* Group ID of a group of KNI devices */
49         char name[RTE_KNI_NAMESIZE]; /* Network device name */
50
51         /* wait queue for req/resp */
52         wait_queue_head_t wq;
53         struct mutex sync_lock;
54
55         /* PCI device id */
56         uint16_t device_id;
57
58         /* kni device */
59         struct net_device *net_dev;
60         struct net_device *lad_dev;
61         struct pci_dev *pci_dev;
62
63         /* queue for packets to be sent out */
64         void *tx_q;
65
66         /* queue for the packets received */
67         void *rx_q;
68
69         /* queue for the allocated mbufs those can be used to save sk buffs */
70         void *alloc_q;
71
72         /* free queue for the mbufs to be freed */
73         void *free_q;
74
75         /* request queue */
76         void *req_q;
77
78         /* response queue */
79         void *resp_q;
80
81         void * sync_kva;
82         void *sync_va;
83
84         void *mbuf_kva;
85         void *mbuf_va;
86
87         /* mbuf size */
88         unsigned mbuf_size;
89
90         /* synchro for request processing */
91         unsigned long synchro;
92 };
93
94
95 #define KNI_ERR(args...) printk(KERN_DEBUG "KNI: Error: " args)
96 #define KNI_PRINT(args...) printk(KERN_DEBUG "KNI: " args)
97 #ifdef RTE_KNI_KO_DEBUG
98         #define KNI_DBG(args...) printk(KERN_DEBUG "KNI: " args)
99 #else
100         #define KNI_DBG(args...)
101 #endif
102
103 #endif