4 * Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
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.
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.
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.
21 * Contact Information:
26 #include <linux/module.h>
27 #include <linux/miscdevice.h>
28 #include <linux/netdevice.h>
29 #include <linux/pci.h>
30 #include <linux/kthread.h>
32 #include <exec-env/rte_kni_common.h>
34 #include <rte_config.h>
36 MODULE_LICENSE("Dual BSD/GPL");
37 MODULE_AUTHOR("Intel Corporation");
38 MODULE_DESCRIPTION("Kernel Module for managing kni devices");
40 #define KNI_RX_LOOP_NUM 1000
42 #define KNI_MAX_DEVICES 32
44 extern void kni_net_rx(struct kni_dev *kni);
45 extern void kni_net_init(struct net_device *dev);
46 extern void kni_net_config_lo_mode(char *lo_str);
47 extern void kni_net_poll_resp(struct kni_dev *kni);
48 extern void kni_set_ethtool_ops(struct net_device *netdev);
50 extern int ixgbe_kni_probe(struct pci_dev *pdev, struct net_device **lad_dev);
51 extern void ixgbe_kni_remove(struct pci_dev *pdev);
52 extern int igb_kni_probe(struct pci_dev *pdev, struct net_device **lad_dev);
53 extern void igb_kni_remove(struct pci_dev *pdev);
55 static int kni_open(struct inode *inode, struct file *file);
56 static int kni_release(struct inode *inode, struct file *file);
57 static int kni_ioctl(struct inode *inode, unsigned int ioctl_num,
58 unsigned long ioctl_param);
59 static int kni_compat_ioctl(struct inode *inode, unsigned int ioctl_num,
60 unsigned long ioctl_param);
62 /* kni kernel thread for rx */
63 static int kni_thread(void *unused);
65 static struct file_operations kni_fops = {
68 .release = kni_release,
69 .unlocked_ioctl = (void *)kni_ioctl,
70 .compat_ioctl = (void *)kni_compat_ioctl,
73 static struct miscdevice kni_misc = {
74 .minor = MISC_DYNAMIC_MINOR,
80 static char *lo_mode = NULL;
82 static struct kni_dev *kni_devs[KNI_MAX_DEVICES];
83 static volatile int num_devs; /* number of kni devices */
85 #define KNI_DEV_IN_USE_BIT_NUM 0 /* Bit number for device in use */
87 static volatile unsigned long device_in_use; /* device in use flag */
88 static struct task_struct *kni_kthread;
93 KNI_PRINT("######## DPDK kni module loading ########\n");
95 if (misc_register(&kni_misc) != 0) {
96 KNI_ERR("Misc registration failed\n");
100 /* Clear the bit of device in use */
101 clear_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use);
103 /* Configure the lo mode according to the input parameter */
104 kni_net_config_lo_mode(lo_mode);
106 KNI_PRINT("######## DPDK kni module loaded ########\n");
114 misc_deregister(&kni_misc);
115 KNI_PRINT("####### DPDK kni module unloaded #######\n");
119 kni_open(struct inode *inode, struct file *file)
121 /* kni device can be opened by one user only, test and set bit */
122 if (test_and_set_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use))
125 memset(kni_devs, 0, sizeof(kni_devs));
128 /* Create kernel thread for RX */
129 kni_kthread = kthread_run(kni_thread, NULL, "kni_thread");
130 if (IS_ERR(kni_kthread)) {
131 KNI_ERR("Unable to create kernel threaed\n");
132 return PTR_ERR(kni_kthread);
135 KNI_PRINT("/dev/kni opened\n");
141 kni_release(struct inode *inode, struct file *file)
145 KNI_PRINT("Stopping KNI thread...");
147 /* Stop kernel thread */
148 kthread_stop(kni_kthread);
151 for (i = 0; i < KNI_MAX_DEVICES; i++) {
152 if (kni_devs[i] != NULL) {
153 /* Call the remove part to restore pci dev */
154 switch (kni_devs[i]->device_id) {
155 #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
156 #include <rte_pci_dev_ids.h>
157 igb_kni_remove(kni_devs[i]->pci_dev);
159 #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) case (dev):
160 #include <rte_pci_dev_ids.h>
161 ixgbe_kni_remove(kni_devs[i]->pci_dev);
167 unregister_netdev(kni_devs[i]->net_dev);
168 free_netdev(kni_devs[i]->net_dev);
174 /* Clear the bit of device in use */
175 clear_bit(KNI_DEV_IN_USE_BIT_NUM, &device_in_use);
177 KNI_PRINT("/dev/kni closed\n");
183 kni_thread(void *unused)
187 KNI_PRINT("Kernel thread for KNI started\n");
188 while (!kthread_should_stop()) {
189 int n_devs = num_devs;
190 for (j = 0; j < KNI_RX_LOOP_NUM; j++) {
191 for (i = 0; i < n_devs; i++) {
192 /* This shouldn't be needed */
194 kni_net_rx(kni_devs[i]);
195 kni_net_poll_resp(kni_devs[i]);
198 KNI_ERR("kni_thread -no kni found!!!");
201 /* reschedule out for a while */
202 schedule_timeout_interruptible(usecs_to_jiffies( \
203 KNI_KTHREAD_RESCHEDULE_INTERVAL));
205 KNI_PRINT("Kernel thread for KNI stopped\n");
211 kni_ioctl_create(unsigned int ioctl_num, unsigned long ioctl_param)
214 struct rte_kni_device_info dev_info;
215 struct pci_dev *pci = NULL;
216 struct pci_dev *found_pci = NULL;
217 struct net_device *net_dev = NULL;
218 struct net_device *lad_dev = NULL;
221 if (num_devs == KNI_MAX_DEVICES)
224 /* Check the buffer size, to avoid warning */
225 if (_IOC_SIZE(ioctl_num) > sizeof(dev_info))
228 /* Copy kni info from user space */
229 ret = copy_from_user(&dev_info, (void *)ioctl_param,
230 _IOC_SIZE(ioctl_num));
232 KNI_ERR("copy_from_user");
236 net_dev = alloc_netdev(sizeof(struct kni_dev), dev_info.name,
238 if (net_dev == NULL) {
239 KNI_ERR("error allocating device \"%s\"\n", dev_info.name);
243 kni = netdev_priv(net_dev);
245 kni->net_dev = net_dev;
248 /* Translate user space info into kernel space info */
249 kni->tx_q = phys_to_virt(dev_info.tx_phys);
250 kni->rx_q = phys_to_virt(dev_info.rx_phys);
251 kni->alloc_q = phys_to_virt(dev_info.alloc_phys);
252 kni->free_q = phys_to_virt(dev_info.free_phys);
254 kni->req_q = phys_to_virt(dev_info.req_phys);
255 kni->resp_q = phys_to_virt(dev_info.resp_phys);
257 kni->sync_va = dev_info.sync_va;
258 kni->sync_kva = phys_to_virt(dev_info.sync_phys);
260 kni->mbuf_kva = phys_to_virt(dev_info.mbuf_phys);
261 kni->mbuf_va = dev_info.mbuf_va;
263 kni->mbuf_size = dev_info.mbuf_size;
265 KNI_PRINT("tx_phys: 0x%016llx, tx_q addr: 0x%p\n",
266 dev_info.tx_phys, kni->tx_q);
267 KNI_PRINT("rx_phys: 0x%016llx, rx_q addr: 0x%p\n",
268 dev_info.rx_phys, kni->rx_q);
269 KNI_PRINT("alloc_phys: 0x%016llx, alloc_q addr: 0x%p\n",
270 dev_info.alloc_phys, kni->alloc_q);
271 KNI_PRINT("free_phys: 0x%016llx, free_q addr: 0x%p\n",
272 dev_info.free_phys, kni->free_q);
273 KNI_PRINT("req_phys: 0x%016llx, req_q addr: 0x%p\n",
274 dev_info.req_phys, kni->req_q);
275 KNI_PRINT("resp_phys: 0x%016llx, resp_q addr: 0x%p\n",
276 dev_info.resp_phys, kni->resp_q);
277 KNI_PRINT("mbuf_phys: 0x%016llx, mbuf_kva: 0x%p\n",
278 dev_info.mbuf_phys, kni->mbuf_kva);
279 KNI_PRINT("mbuf_va: 0x%p\n", dev_info.mbuf_va);
280 KNI_PRINT("mbuf_size: %u\n", kni->mbuf_size);
282 KNI_DBG("PCI: %02x:%02x.%02x %04x:%04x\n", dev_info.bus, dev_info.devid,
283 dev_info.function, dev_info.vendor_id, dev_info.device_id);
285 pci = pci_get_device(dev_info.vendor_id, dev_info.device_id, NULL);
287 /* Support Ethtool */
289 KNI_PRINT("pci_bus: %02x:%02x:%02x \n", pci->bus->number,
290 PCI_SLOT(pci->devfn), PCI_FUNC(pci->devfn));
292 if ((pci->bus->number == dev_info.bus) &&
293 (PCI_SLOT(pci->devfn) == dev_info.devid) &&
294 (PCI_FUNC(pci->devfn) == dev_info.function)) {
297 switch (dev_info.device_id) {
298 #define RTE_PCI_DEV_ID_DECL_IGB(vend, dev) case (dev):
299 #include <rte_pci_dev_ids.h>
300 ret = igb_kni_probe(found_pci, &lad_dev);
302 #define RTE_PCI_DEV_ID_DECL_IXGBE(vend, dev) case (dev):
303 #include <rte_pci_dev_ids.h>
304 ret = ixgbe_kni_probe(found_pci, &lad_dev);
311 KNI_DBG("PCI found: pci=0x%p, lad_dev=0x%p\n", pci, lad_dev);
313 kni->lad_dev = lad_dev;
314 kni_set_ethtool_ops(kni->net_dev);
317 KNI_ERR("Device not supported by ethtool");
321 kni->pci_dev = found_pci;
322 kni->device_id = dev_info.device_id;
325 pci = pci_get_device(dev_info.vendor_id, dev_info.device_id,
332 ret = register_netdev(net_dev);
334 KNI_ERR("error %i registering device \"%s\"\n", ret,
336 free_netdev(net_dev);
340 kni_devs[num_devs++] = kni;
346 kni_ioctl(struct inode *inode,
347 unsigned int ioctl_num,
348 unsigned long ioctl_param)
352 KNI_DBG("IOCTL num=0x%0x param=0x%0lx \n", ioctl_num, ioctl_param);
355 * Switch according to the ioctl called
357 switch (_IOC_NR(ioctl_num)) {
358 case _IOC_NR(RTE_KNI_IOCTL_TEST):
359 /* For test only, not used */
361 case _IOC_NR(RTE_KNI_IOCTL_CREATE):
362 ret = kni_ioctl_create(ioctl_num, ioctl_param);
365 KNI_DBG("IOCTL default \n");
373 kni_compat_ioctl(struct inode *inode,
374 unsigned int ioctl_num,
375 unsigned long ioctl_param)
377 /* 32 bits app on 64 bits OS to be supported later */
378 KNI_PRINT("Not implemented.\n");
383 module_init(kni_init);
384 module_exit(kni_exit);
386 module_param(lo_mode, charp, S_IRUGO | S_IWUSR);
387 MODULE_PARM_DESC(lo_mode,
388 "KNI loopback mode (default=lo_mode_none):\n"
389 " lo_mode_none Kernel loopback disabled\n"
390 " lo_mode_fifo Enable kernel loopback with fifo\n"
391 " lo_mode_fifo_skb Enable kernel loopback with fifo and skb buffer\n"