123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471 |
- /**
- *
- * @file ioctl.c
- * @author Guillermo Marcus
- * @date 2009-04-05
- * @brief Contains the functions handling the different ioctl calls.
- *
- */
- #include <linux/version.h>
- #include <linux/string.h>
- #include <linux/slab.h>
- #include <linux/types.h>
- #include <linux/init.h>
- #include <linux/module.h>
- #include <linux/pci.h>
- #include <linux/kernel.h>
- #include <linux/errno.h>
- #include <linux/fs.h>
- #include <linux/cdev.h>
- #include <linux/sysfs.h>
- #include <asm/atomic.h>
- #include <linux/pagemap.h>
- #include <linux/spinlock.h>
- #include <linux/list.h>
- #include <asm/scatterlist.h>
- #include <linux/vmalloc.h>
- #include <linux/stat.h>
- #include <linux/interrupt.h>
- #include <linux/wait.h>
- #include <linux/sched.h>
- #include "config.h" /* Configuration for the driver */
- #include "compat.h" /* Compatibility functions/definitions */
- #include "pciDriver.h" /* External interface for the driver */
- #include "common.h" /* Internal definitions for all parts */
- #include "kmem.h" /* Internal definitions for kernel memory */
- #include "umem.h" /* Internal definitions for user space memory */
- #include "ioctl.h" /* Internal definitions for the ioctl part */
- /** Declares a variable of the given type with the given name and copies it from userspace */
- #define READ_FROM_USER(type, name) \
- type name; \
- if ((ret = copy_from_user(&name, (type*)arg, sizeof(name))) != 0) \
- return -EFAULT;
- /** Writes back the given variable with the given type to userspace */
- #define WRITE_TO_USER(type, name) \
- if ((ret = copy_to_user((type*)arg, &name, sizeof(name))) != 0) \
- return -EFAULT;
- /**
- *
- * Sets the mmap mode for following mmap() calls.
- *
- * @param arg Not a pointer, but either PCIDRIVER_MMAP_PCI or PCIDRIVER_MMAP_KMEM
- *
- */
- static int ioctl_mmap_mode(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- if ((arg != PCIDRIVER_MMAP_PCI) && (arg != PCIDRIVER_MMAP_KMEM))
- return -EINVAL;
- /* change the mode */
- privdata->mmap_mode = arg;
- return 0;
- }
- /**
- *
- * Sets the mmap area (BAR) for following mmap() calls.
- *
- */
- static int ioctl_mmap_area(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- /* validate input */
- if ((arg < PCIDRIVER_BAR0) || (arg > PCIDRIVER_BAR5))
- return -EINVAL;
- /* change the PCI area to mmap */
- privdata->mmap_area = arg;
- return 0;
- }
- /**
- *
- * Reads/writes a byte/word/dword of the device's PCI config.
- *
- * @see pcidriver_pci_read
- * @see pcidriver_pci_write
- *
- */
- static int ioctl_pci_config_read_write(pcidriver_privdata_t *privdata, unsigned int cmd, unsigned long arg)
- {
- int ret;
- READ_FROM_USER(pci_cfg_cmd, pci_cmd);
- if (cmd == PCIDRIVER_IOC_PCI_CFG_RD) {
- switch (pci_cmd.size) {
- case PCIDRIVER_PCI_CFG_SZ_BYTE:
- ret = pci_read_config_byte( privdata->pdev, pci_cmd.addr, &(pci_cmd.val.byte) );
- break;
- case PCIDRIVER_PCI_CFG_SZ_WORD:
- ret = pci_read_config_word( privdata->pdev, pci_cmd.addr, &(pci_cmd.val.word) );
- break;
- case PCIDRIVER_PCI_CFG_SZ_DWORD:
- ret = pci_read_config_dword( privdata->pdev, pci_cmd.addr, &(pci_cmd.val.dword) );
- break;
- default:
- return -EINVAL; /* Wrong size setting */
- }
- } else {
- switch (pci_cmd.size) {
- case PCIDRIVER_PCI_CFG_SZ_BYTE:
- ret = pci_write_config_byte( privdata->pdev, pci_cmd.addr, pci_cmd.val.byte );
- break;
- case PCIDRIVER_PCI_CFG_SZ_WORD:
- ret = pci_write_config_word( privdata->pdev, pci_cmd.addr, pci_cmd.val.word );
- break;
- case PCIDRIVER_PCI_CFG_SZ_DWORD:
- ret = pci_write_config_dword( privdata->pdev, pci_cmd.addr, pci_cmd.val.dword );
- break;
- default:
- return -EINVAL; /* Wrong size setting */
- break;
- }
- }
- WRITE_TO_USER(pci_cfg_cmd, pci_cmd);
- return 0;
- }
- /**
- *
- * Gets the PCI information for the device.
- *
- * @see pcidriver_pci_info
- *
- */
- static int ioctl_pci_info(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- int ret;
- int bar;
- READ_FROM_USER(pcilib_board_info_t, pci_info);
- pci_info.vendor_id = privdata->pdev->vendor;
- pci_info.device_id = privdata->pdev->device;
- pci_info.bus = privdata->pdev->bus->number;
- pci_info.slot = PCI_SLOT(privdata->pdev->devfn);
- pci_info.devfn = privdata->pdev->devfn;
- pci_info.func = PCI_FUNC(privdata->pdev->devfn);
- if ((ret = pci_read_config_byte(privdata->pdev, PCI_INTERRUPT_PIN, &(pci_info.interrupt_pin))) != 0)
- return ret;
- if ((ret = pci_read_config_byte(privdata->pdev, PCI_INTERRUPT_LINE, &(pci_info.interrupt_line))) != 0)
- return ret;
- for (bar = 0; bar < 6; bar++) {
- pci_info.bar_start[bar] = pci_resource_start(privdata->pdev, bar);
- pci_info.bar_length[bar] = pci_resource_len(privdata->pdev, bar);
- pci_info.bar_flags[bar] = pci_resource_flags(privdata->pdev, bar);
- }
- WRITE_TO_USER(pcilib_board_info_t, pci_info);
- return 0;
- }
- /**
- *
- * Allocates kernel memory.
- *
- * @see pcidriver_kmem_alloc
- *
- */
- static int ioctl_kmem_alloc(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- int ret;
- READ_FROM_USER(kmem_handle_t, khandle);
- if ((ret = pcidriver_kmem_alloc(privdata, &khandle)) != 0)
- return ret;
- WRITE_TO_USER(kmem_handle_t, khandle);
- return 0;
- }
- /**
- *
- * Frees kernel memory.
- *
- * @see pcidriver_kmem_free
- *
- */
- static int ioctl_kmem_free(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- int ret;
- READ_FROM_USER(kmem_handle_t, khandle);
- if ((ret = pcidriver_kmem_free(privdata, &khandle)) != 0)
- return ret;
- return 0;
- }
- /**
- *
- * Syncs kernel memory.
- *
- * @see pcidriver_kmem_sync
- *
- */
- static int ioctl_kmem_sync(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- int ret;
- READ_FROM_USER(kmem_sync_t, ksync);
- if ((ret = pcidriver_kmem_sync(privdata, &ksync)) != 0)
- return ret;
-
- WRITE_TO_USER(kmem_sync_t, ksync);
-
- return 0;
- }
- /*
- *
- * Maps the given scatter/gather list from memory to PCI bus addresses.
- *
- * @see pcidriver_umem_sgmap
- *
- */
- static int ioctl_umem_sgmap(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- int ret;
- READ_FROM_USER(umem_handle_t, uhandle);
- if ((ret = pcidriver_umem_sgmap(privdata, &uhandle)) != 0)
- return ret;
- WRITE_TO_USER(umem_handle_t, uhandle);
- return 0;
- }
- /**
- *
- * Unmaps the given scatter/gather list.
- *
- * @see pcidriver_umem_sgunmap
- *
- */
- static int ioctl_umem_sgunmap(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- int ret;
- pcidriver_umem_entry_t *umem_entry;
- READ_FROM_USER(umem_handle_t, uhandle);
- /* Find the associated umem_entry for this buffer,
- * return -EINVAL if the specified handle id is invalid */
- if ((umem_entry = pcidriver_umem_find_entry_id(privdata, uhandle.handle_id)) == NULL)
- return -EINVAL;
- if ((ret = pcidriver_umem_sgunmap(privdata, umem_entry)) != 0)
- return ret;
- return 0;
- }
- /**
- *
- * Copies the scatter/gather list from kernelspace to userspace.
- *
- * @see pcidriver_umem_sgget
- *
- */
- static int ioctl_umem_sgget(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- int ret;
- READ_FROM_USER(umem_sglist_t, usglist);
- /* The umem_sglist_t has a pointer to the scatter/gather list itself which
- * needs to be copied separately. The number of elements is stored in ->nents.
- * As the list can get very big, we need to use vmalloc. */
- if ((usglist.sg = vmalloc(usglist.nents * sizeof(umem_sgentry_t))) == NULL)
- return -ENOMEM;
- /* copy array to kernel structure */
- ret = copy_from_user(usglist.sg, ((umem_sglist_t *)arg)->sg, (usglist.nents)*sizeof(umem_sgentry_t));
- if (ret) return -EFAULT;
- if ((ret = pcidriver_umem_sgget(privdata, &usglist)) != 0)
- return ret;
- /* write data to user space */
- ret = copy_to_user(((umem_sglist_t *)arg)->sg, usglist.sg, (usglist.nents)*sizeof(umem_sgentry_t));
- if (ret) return -EFAULT;
- /* free array memory */
- vfree(usglist.sg);
- /* restore sg pointer to vma address in user space before copying */
- usglist.sg = ((umem_sglist_t *)arg)->sg;
- WRITE_TO_USER(umem_sglist_t, usglist);
- return 0;
- }
- /**
- *
- * Syncs user memory.
- *
- * @see pcidriver_umem_sync
- *
- */
- static int ioctl_umem_sync(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- int ret;
- READ_FROM_USER(umem_handle_t, uhandle);
- return pcidriver_umem_sync( privdata, &uhandle );
- }
- /**
- *
- * Waits for an interrupt
- *
- * @param arg Not a pointer, but the irq source to wait for (unsigned int)
- *
- */
- static int ioctl_wait_interrupt(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- #ifdef ENABLE_IRQ
- int ret;
- unsigned long timeout;
- unsigned int irq_source;
- unsigned long temp = 0;
- READ_FROM_USER(interrupt_wait_t, irq_handle);
- irq_source = irq_handle.source;
- if (irq_source >= PCIDRIVER_INT_MAXSOURCES)
- return -EFAULT; /* User tried to overrun the IRQ_SOURCES array */
- timeout = jiffies + (irq_handle.timeout * HZ / 1000000);
- /* Thanks to Joern for the correction and tips! */
- /* done this way to avoid wrong behaviour (endless loop) of the compiler in AMD platforms */
- do {
- /* We wait here with an interruptible timeout. This will be interrupted
- * by int.c:check_acknowledge_channel() as soon as in interrupt for
- * the specified source arrives. */
- wait_event_interruptible_timeout( (privdata->irq_queues[irq_source]), (atomic_read(&(privdata->irq_outstanding[irq_source])) > 0), (10*HZ/1000) );
- if (atomic_add_negative( -1, &(privdata->irq_outstanding[irq_source])) )
- atomic_inc( &(privdata->irq_outstanding[irq_source]) );
- else
- temp = 1;
- } while ((!temp)&&(jiffies < timeout));
-
- if ((temp)&&(irq_handle.count)) {
- while (!atomic_add_negative( -1, &(privdata->irq_outstanding[irq_source]))) temp++;
- atomic_inc( &(privdata->irq_outstanding[irq_source]) );
- }
-
- irq_handle.count = temp;
- WRITE_TO_USER(interrupt_wait_t, irq_handle);
- return 0;
- #else
- mod_info("Asked to wait for interrupt but interrupts are not enabled in the driver\n");
- return -EFAULT;
- #endif
- }
- /**
- *
- * Clears the interrupt wait queue.
- *
- * @param arg Not a pointer, but the irq source (unsigned int)
- * @returns -EFAULT if the user specified an irq source out of range
- *
- */
- static int ioctl_clear_ioq(pcidriver_privdata_t *privdata, unsigned long arg)
- {
- #ifdef ENABLE_IRQ
- unsigned int irq_source;
- if (arg >= PCIDRIVER_INT_MAXSOURCES)
- return -EFAULT;
- irq_source = arg;
- atomic_set(&(privdata->irq_outstanding[irq_source]), 0);
- return 0;
- #else
- mod_info("Asked to wait for interrupt but interrupts are not enabled in the driver\n");
- return -EFAULT;
- #endif
- }
- /**
- *
- * This function handles all ioctl file operations.
- * Generally, the data of the ioctl is copied from userspace to kernelspace, a separate
- * function is called to handle the ioctl itself, then the data is copied back to userspace.
- *
- * @returns -EFAULT when an invalid memory pointer is passed
- *
- */
- #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,11)
- int pcidriver_ioctl(struct inode *inode, struct file *filp, unsigned int cmd, unsigned long arg)
- #else
- long pcidriver_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
- #endif
- {
- pcidriver_privdata_t *privdata = filp->private_data;
- /* Select the appropiate command */
- switch (cmd) {
- case PCIDRIVER_IOC_MMAP_MODE:
- return ioctl_mmap_mode(privdata, arg);
- case PCIDRIVER_IOC_MMAP_AREA:
- return ioctl_mmap_area(privdata, arg);
- case PCIDRIVER_IOC_PCI_CFG_RD:
- case PCIDRIVER_IOC_PCI_CFG_WR:
- return ioctl_pci_config_read_write(privdata, cmd, arg);
- case PCIDRIVER_IOC_PCI_INFO:
- return ioctl_pci_info(privdata, arg);
- case PCIDRIVER_IOC_KMEM_ALLOC:
- return ioctl_kmem_alloc(privdata, arg);
- case PCIDRIVER_IOC_KMEM_FREE:
- return ioctl_kmem_free(privdata, arg);
- case PCIDRIVER_IOC_KMEM_SYNC:
- return ioctl_kmem_sync(privdata, arg);
- case PCIDRIVER_IOC_UMEM_SGMAP:
- return ioctl_umem_sgmap(privdata, arg);
- case PCIDRIVER_IOC_UMEM_SGUNMAP:
- return ioctl_umem_sgunmap(privdata, arg);
- case PCIDRIVER_IOC_UMEM_SGGET:
- return ioctl_umem_sgget(privdata, arg);
- case PCIDRIVER_IOC_UMEM_SYNC:
- return ioctl_umem_sync(privdata, arg);
- case PCIDRIVER_IOC_WAITI:
- return ioctl_wait_interrupt(privdata, arg);
- case PCIDRIVER_IOC_CLEAR_IOQ:
- return ioctl_clear_ioq(privdata, arg);
- default:
- return -EINVAL;
- }
- }
|