3 functions for manipulating drivers
5 COMEDI - Linux Control and Measurement Device Interface
6 Copyright (C) 1997-2000 David A. Schleef <ds@schleef.org>
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #define __NO_VERSION__
27 #include "comedi_fops.h"
28 #include <linux/device.h>
29 #include <linux/module.h>
30 #include <linux/pci.h>
31 #include <linux/usb.h>
32 #include <linux/errno.h>
33 #include <linux/kernel.h>
34 #include <linux/sched.h>
35 #include <linux/fcntl.h>
36 #include <linux/delay.h>
37 #include <linux/ioport.h>
39 #include <linux/slab.h>
40 #include <linux/comedidev.h>
41 #include <linux/wrapper.h>
42 #include <linux/highmem.h> /* for SuSE brokenness */
43 #include <linux/vmalloc.h>
44 #include <linux/cdev.h>
45 #include <linux/dma-mapping.h>
48 #include <asm/system.h>
50 static int postconfig(comedi_device * dev);
51 static int insn_rw_emulate_bits(comedi_device * dev, comedi_subdevice * s,
52 comedi_insn * insn, lsampl_t * data);
53 static void *comedi_recognize(comedi_driver * driv, const char *name);
54 static void comedi_report_boards(comedi_driver * driv);
55 static int poll_invalid(comedi_device * dev, comedi_subdevice * s);
56 int comedi_buf_alloc(comedi_device * dev, comedi_subdevice * s,
57 unsigned long new_size);
59 comedi_driver *comedi_drivers;
61 int comedi_modprobe(int minor)
66 static void cleanup_device(comedi_device * dev)
71 if (dev->subdevices) {
72 for (i = 0; i < dev->n_subdevices; i++) {
73 s = dev->subdevices + i;
74 comedi_free_subdevice_minor(s);
76 comedi_buf_alloc(dev, s, 0);
80 kfree(dev->subdevices);
81 dev->subdevices = NULL;
82 dev->n_subdevices = 0;
89 dev->board_name = NULL;
90 dev->board_ptr = NULL;
93 dev->read_subdev = NULL;
94 dev->write_subdev = NULL;
97 comedi_set_hw_dev(dev, NULL);
100 static void __comedi_device_detach(comedi_device * dev)
104 dev->driver->detach(dev);
106 printk("BUG: dev->driver=NULL in comedi_device_detach()\n");
111 void comedi_device_detach(comedi_device * dev)
115 __comedi_device_detach(dev);
118 int comedi_device_attach(comedi_device * dev, comedi_devconfig * it)
126 for (driv = comedi_drivers; driv; driv = driv->next) {
127 if (!try_module_get(driv->module)) {
128 printk("comedi: failed to increment module count, skipping\n");
131 if (driv->num_names) {
132 dev->board_ptr = comedi_recognize(driv, it->board_name);
133 if (dev->board_ptr == NULL) {
134 module_put(driv->module);
138 if (strcmp(driv->driver_name, it->board_name)) {
139 module_put(driv->module);
143 //initialize dev->driver here so comedi_error() can be called from attach
145 ret = driv->attach(dev, it);
147 module_put(dev->driver->module);
148 __comedi_device_detach(dev);
154 // recognize has failed if we get here
155 // report valid board names before returning error
156 for (driv = comedi_drivers; driv; driv = driv->next) {
157 if (!try_module_get(driv->module)) {
158 printk("comedi: failed to increment module count\n");
161 comedi_report_boards(driv);
162 module_put(driv->module);
167 /* do a little post-config cleanup */
168 ret = postconfig(dev);
169 module_put(dev->driver->module);
171 __comedi_device_detach(dev);
175 if (!dev->board_name) {
176 printk("BUG: dev->board_name=<%p>\n", dev->board_name);
177 dev->board_name = "BUG";
185 int comedi_driver_register(comedi_driver * driver)
187 driver->next = comedi_drivers;
188 comedi_drivers = driver;
193 int comedi_driver_unregister(comedi_driver * driver)
198 /* check for devices using this driver */
199 for (i = 0; i < COMEDI_NUM_BOARD_MINORS; i++) {
200 struct comedi_device_file_info *dev_file_info = comedi_get_device_file_info(i);
203 if(dev_file_info == NULL) continue;
204 dev = dev_file_info->device;
206 mutex_lock(&dev->mutex);
207 if (dev->attached && dev->driver == driver) {
209 printk("BUG! detaching device with use_count=%d\n", dev->use_count);
210 comedi_device_detach(dev);
212 mutex_unlock(&dev->mutex);
215 if (comedi_drivers == driver) {
216 comedi_drivers = driver->next;
220 for (prev = comedi_drivers; prev->next; prev = prev->next) {
221 if (prev->next == driver) {
222 prev->next = driver->next;
229 static int postconfig(comedi_device * dev)
233 comedi_async *async = NULL;
236 for (i = 0; i < dev->n_subdevices; i++) {
237 s = dev->subdevices + i;
239 if (s->type == COMEDI_SUBD_UNUSED)
242 if (s->len_chanlist == 0)
246 BUG_ON((s->subdev_flags & (SDF_CMD_READ |
247 SDF_CMD_WRITE)) == 0);
248 BUG_ON(!s->do_cmdtest);
250 async = kzalloc(sizeof(comedi_async), GFP_KERNEL);
252 printk("failed to allocate async struct\n");
255 init_waitqueue_head(&async->wait_head);
256 async->subdevice = s;
259 #define DEFAULT_BUF_MAXSIZE (64*1024)
260 #define DEFAULT_BUF_SIZE (64*1024)
262 async->max_bufsize = DEFAULT_BUF_MAXSIZE;
264 async->prealloc_buf = NULL;
265 async->prealloc_bufsz = 0;
266 if (comedi_buf_alloc(dev, s, DEFAULT_BUF_SIZE) < 0) {
267 printk("Buffer allocation failed\n");
271 ret = s->buf_change(dev, s, DEFAULT_BUF_SIZE);
275 comedi_alloc_subdevice_minor(dev, s);
278 if (!s->range_table && !s->range_table_list)
279 s->range_table = &range_unknown;
281 if (!s->insn_read && s->insn_bits)
282 s->insn_read = insn_rw_emulate_bits;
283 if (!s->insn_write && s->insn_bits)
284 s->insn_write = insn_rw_emulate_bits;
287 s->insn_read = insn_inval;
289 s->insn_write = insn_inval;
291 s->insn_bits = insn_inval;
293 s->insn_config = insn_inval;
296 s->poll = poll_invalid;
302 // generic recognize function for drivers that register their supported board names
303 void *comedi_recognize(comedi_driver * driv, const char *name)
306 const char *const *name_ptr = driv->board_name;
307 for (i = 0; i < driv->num_names; i++) {
308 if (strcmp(*name_ptr, name) == 0)
309 return (void *)name_ptr;
311 (const char *const *)((const char *)name_ptr +
318 void comedi_report_boards(comedi_driver * driv)
321 const char *const *name_ptr;
323 printk("comedi: valid board names for %s driver are:\n",
326 name_ptr = driv->board_name;
327 for (i = 0; i < driv->num_names; i++) {
328 printk(" %s\n", *name_ptr);
329 name_ptr = (const char **)((char *)name_ptr + driv->offset);
332 if (driv->num_names == 0)
333 printk(" %s\n", driv->driver_name);
336 static int poll_invalid(comedi_device * dev, comedi_subdevice * s)
341 int insn_inval(comedi_device * dev, comedi_subdevice * s,
342 comedi_insn * insn, lsampl_t * data)
347 static int insn_rw_emulate_bits(comedi_device * dev, comedi_subdevice * s,
348 comedi_insn * insn, lsampl_t * data)
350 comedi_insn new_insn;
352 static const unsigned channels_per_bitfield = 32;
353 unsigned chan = CR_CHAN(insn->chanspec);
354 const unsigned base_bitfield_channel =
355 (chan < channels_per_bitfield) ? 0 : chan;
356 lsampl_t new_data[2];
358 if ((insn->insn == INSN_WRITE) && !(s->subdev_flags & SDF_WRITABLE))
364 memset(new_data, 0, sizeof(new_data));
365 memset(&new_insn, 0, sizeof(new_insn));
366 new_insn.insn = INSN_BITS;
367 new_insn.chanspec = base_bitfield_channel;
369 new_insn.data = new_data;
370 new_insn.subdev = insn->subdev;
372 if (insn->insn == INSN_WRITE) {
373 new_data[0] = 1 << (chan - base_bitfield_channel); /* mask */
374 new_data[1] = data[0] ? (1 << (chan - base_bitfield_channel)) : 0; /* bits */
377 ret = s->insn_bits(dev, s, &new_insn, new_data);
381 if (insn->insn == INSN_READ) {
382 data[0] = (new_data[1] >> (chan - base_bitfield_channel)) & 1;
388 static inline unsigned long uvirt_to_kva(pgd_t * pgd, unsigned long adr)
390 unsigned long ret = 0UL;
395 if (!pgd_none(*pgd)) {
396 pud = pud_offset(pgd, adr);
397 pmd = pmd_offset(pud, adr);
398 if (!pmd_none(*pmd)) {
399 ptep = pte_offset_kernel(pmd, adr);
401 if (pte_present(pte)) {
402 ret = (unsigned long)
403 page_address(pte_page(pte));
404 ret |= (adr & (PAGE_SIZE - 1));
411 static inline unsigned long kvirt_to_kva(unsigned long adr)
413 unsigned long va, kva;
416 kva = uvirt_to_kva(pgd_offset_k(va), va);
421 int comedi_buf_alloc(comedi_device * dev, comedi_subdevice * s,
422 unsigned long new_size)
424 comedi_async *async = s->async;
426 /* Round up new_size to multiple of PAGE_SIZE */
427 new_size = (new_size + PAGE_SIZE - 1) & PAGE_MASK;
429 /* if no change is required, do nothing */
430 if (async->prealloc_buf && async->prealloc_bufsz == new_size) {
433 // deallocate old buffer
434 if (async->prealloc_buf) {
435 vunmap(async->prealloc_buf);
436 async->prealloc_buf = NULL;
437 async->prealloc_bufsz = 0;
439 if (async->buf_page_list) {
441 for (i = 0; i < async->n_buf_pages; ++i) {
442 if (async->buf_page_list[i].virt_addr) {
443 mem_map_unreserve(virt_to_page(async->
444 buf_page_list[i].virt_addr));
445 if (s->async_dma_dir != DMA_NONE) {
446 dma_free_coherent(dev->hw_dev,
448 async->buf_page_list[i].
450 async->buf_page_list[i].
453 free_page((unsigned long)async->
454 buf_page_list[i].virt_addr);
458 vfree(async->buf_page_list);
459 async->buf_page_list = NULL;
460 async->n_buf_pages = 0;
462 // allocate new buffer
465 unsigned n_pages = new_size >> PAGE_SHIFT;
466 struct page **pages = NULL;
468 async->buf_page_list =
469 vmalloc(sizeof(struct comedi_buf_page) * n_pages);
470 if (async->buf_page_list) {
471 memset(async->buf_page_list, 0,
472 sizeof(struct comedi_buf_page) * n_pages);
473 pages = vmalloc(sizeof(struct page *) * n_pages);
476 for (i = 0; i < n_pages; i++) {
477 if (s->async_dma_dir != DMA_NONE) {
478 async->buf_page_list[i].virt_addr =
479 dma_alloc_coherent(dev->hw_dev,
481 &async->buf_page_list[i].
483 GFP_KERNEL | __GFP_COMP);
485 async->buf_page_list[i].virt_addr =
487 get_zeroed_page(GFP_KERNEL);
489 if (async->buf_page_list[i].virt_addr == NULL) {
492 mem_map_reserve(virt_to_page(async->
493 buf_page_list[i].virt_addr));
495 virt_to_page(async->buf_page_list[i].
500 async->prealloc_buf =
501 vmap(pages, n_pages, VM_MAP,
502 PAGE_KERNEL_NOCACHE);
507 if (async->prealloc_buf == NULL) {
508 /* Some allocation failed above. */
509 if (async->buf_page_list) {
510 for (i = 0; i < n_pages; i++) {
511 if (async->buf_page_list[i].virt_addr ==
515 mem_map_unreserve(virt_to_page(async->
518 if (s->async_dma_dir != DMA_NONE) {
519 dma_free_coherent(dev->hw_dev,
521 async->buf_page_list[i].
523 async->buf_page_list[i].
526 free_page((unsigned long)async->
531 vfree(async->buf_page_list);
532 async->buf_page_list = NULL;
536 async->n_buf_pages = n_pages;
538 async->prealloc_bufsz = new_size;
543 /* munging is applied to data by core as it passes between user
544 * and kernel space */
545 unsigned int comedi_buf_munge(comedi_async * async, unsigned int num_bytes)
547 comedi_subdevice *s = async->subdevice;
548 unsigned int count = 0;
549 const unsigned num_sample_bytes = bytes_per_sample(s);
551 if (s->munge == NULL || (async->cmd.flags & CMDF_RAWDATA)) {
552 async->munge_count += num_bytes;
553 if ((int)(async->munge_count - async->buf_write_count) > 0)
557 /* don't munge partial samples */
558 num_bytes -= num_bytes % num_sample_bytes;
559 while (count < num_bytes) {
562 block_size = num_bytes - count;
563 if (block_size < 0) {
564 rt_printk("%s: %s: bug! block_size is negative\n",
565 __FILE__, __FUNCTION__);
568 if ((int)(async->munge_ptr + block_size -
569 async->prealloc_bufsz) > 0)
570 block_size = async->prealloc_bufsz - async->munge_ptr;
572 s->munge(s->device, s, async->prealloc_buf + async->munge_ptr,
573 block_size, async->munge_chan);
575 smp_wmb(); //barrier insures data is munged in buffer before munge_count is incremented
577 async->munge_chan += block_size / num_sample_bytes;
578 async->munge_chan %= async->cmd.chanlist_len;
579 async->munge_count += block_size;
580 async->munge_ptr += block_size;
581 async->munge_ptr %= async->prealloc_bufsz;
584 if ((int)(async->munge_count - async->buf_write_count) > 0)
589 unsigned int comedi_buf_write_n_available(comedi_async * async)
591 unsigned int free_end;
597 free_end = async->buf_read_count + async->prealloc_bufsz;
598 nbytes = free_end - async->buf_write_alloc_count;
599 nbytes -= nbytes % bytes_per_sample(async->subdevice);
600 /* barrier insures the read of buf_read_count in this
601 query occurs before any following writes to the buffer which
602 might be based on the return value from this query.
608 /* allocates chunk for the writer from free buffer space */
609 unsigned int comedi_buf_write_alloc(comedi_async * async, unsigned int nbytes)
611 unsigned int free_end = async->buf_read_count + async->prealloc_bufsz;
613 if ((int)(async->buf_write_alloc_count + nbytes - free_end) > 0) {
614 nbytes = free_end - async->buf_write_alloc_count;
616 async->buf_write_alloc_count += nbytes;
617 /* barrier insures the read of buf_read_count above occurs before
618 we write data to the write-alloc'ed buffer space */
623 /* allocates nothing unless it can completely fulfill the request */
624 unsigned int comedi_buf_write_alloc_strict(comedi_async * async,
627 unsigned int free_end = async->buf_read_count + async->prealloc_bufsz;
629 if ((int)(async->buf_write_alloc_count + nbytes - free_end) > 0) {
632 async->buf_write_alloc_count += nbytes;
633 /* barrier insures the read of buf_read_count above occurs before
634 we write data to the write-alloc'ed buffer space */
639 /* transfers a chunk from writer to filled buffer space */
640 unsigned comedi_buf_write_free(comedi_async * async, unsigned int nbytes)
642 if ((int)(async->buf_write_count + nbytes -
643 async->buf_write_alloc_count) > 0) {
645 ("comedi: attempted to write-free more bytes than have been write-allocated.\n");
646 nbytes = async->buf_write_alloc_count - async->buf_write_count;
648 async->buf_write_count += nbytes;
649 async->buf_write_ptr += nbytes;
650 comedi_buf_munge(async, async->buf_write_count - async->munge_count);
651 if (async->buf_write_ptr >= async->prealloc_bufsz) {
652 async->buf_write_ptr %= async->prealloc_bufsz;
657 /* allocates a chunk for the reader from filled (and munged) buffer space */
658 unsigned comedi_buf_read_alloc(comedi_async * async, unsigned nbytes)
660 if ((int)(async->buf_read_alloc_count + nbytes - async->munge_count) >
662 nbytes = async->munge_count - async->buf_read_alloc_count;
664 async->buf_read_alloc_count += nbytes;
665 /* barrier insures read of munge_count occurs before we actually read
666 data out of buffer */
671 /* transfers control of a chunk from reader to free buffer space */
672 unsigned comedi_buf_read_free(comedi_async * async, unsigned int nbytes)
674 // barrier insures data has been read out of buffer before read count is incremented
676 if ((int)(async->buf_read_count + nbytes -
677 async->buf_read_alloc_count) > 0) {
679 ("comedi: attempted to read-free more bytes than have been read-allocated.\n");
680 nbytes = async->buf_read_alloc_count - async->buf_read_count;
682 async->buf_read_count += nbytes;
683 async->buf_read_ptr += nbytes;
684 async->buf_read_ptr %= async->prealloc_bufsz;
688 void comedi_buf_memcpy_to(comedi_async * async, unsigned int offset,
689 const void *data, unsigned int num_bytes)
691 unsigned int write_ptr = async->buf_write_ptr + offset;
693 if (write_ptr >= async->prealloc_bufsz)
694 write_ptr %= async->prealloc_bufsz;
697 unsigned int block_size;
699 if (write_ptr + num_bytes > async->prealloc_bufsz)
700 block_size = async->prealloc_bufsz - write_ptr;
702 block_size = num_bytes;
704 memcpy(async->prealloc_buf + write_ptr, data, block_size);
707 num_bytes -= block_size;
713 void comedi_buf_memcpy_from(comedi_async * async, unsigned int offset,
714 void *dest, unsigned int nbytes)
717 unsigned int read_ptr = async->buf_read_ptr + offset;
719 if (read_ptr >= async->prealloc_bufsz)
720 read_ptr %= async->prealloc_bufsz;
723 unsigned int block_size;
725 src = async->prealloc_buf + read_ptr;
727 if (nbytes >= async->prealloc_bufsz - read_ptr)
728 block_size = async->prealloc_bufsz - read_ptr;
732 memcpy(dest, src, block_size);
733 nbytes -= block_size;
739 unsigned int comedi_buf_read_n_available(comedi_async * async)
745 num_bytes = async->munge_count - async->buf_read_count;
746 /* barrier insures the read of munge_count in this
747 query occurs before any following reads of the buffer which
748 might be based on the return value from this query.
754 int comedi_buf_get(comedi_async * async, sampl_t * x)
756 unsigned int n = comedi_buf_read_n_available(async);
758 if (n < sizeof(sampl_t))
760 comedi_buf_read_alloc(async, sizeof(sampl_t));
761 *x = *(sampl_t *) (async->prealloc_buf + async->buf_read_ptr);
762 comedi_buf_read_free(async, sizeof(sampl_t));
766 int comedi_buf_put(comedi_async * async, sampl_t x)
768 unsigned int n = comedi_buf_write_alloc_strict(async, sizeof(sampl_t));
770 if (n < sizeof(sampl_t)) {
771 async->events |= COMEDI_CB_ERROR;
774 *(sampl_t *) (async->prealloc_buf + async->buf_write_ptr) = x;
775 comedi_buf_write_free(async, sizeof(sampl_t));
779 void comedi_reset_async_buf(comedi_async * async)
781 async->buf_write_alloc_count = 0;
782 async->buf_write_count = 0;
783 async->buf_read_alloc_count = 0;
784 async->buf_read_count = 0;
786 async->buf_write_ptr = 0;
787 async->buf_read_ptr = 0;
790 async->scan_progress = 0;
791 async->munge_chan = 0;
792 async->munge_count = 0;
793 async->munge_ptr = 0;
798 int comedi_auto_config(struct device *hardware_device, const char *board_name, const int *options, unsigned num_options)
802 struct comedi_device_file_info *dev_file_info;
804 unsigned *private_data = NULL;
806 if(!comedi_autoconfig) {
807 dev_set_drvdata(hardware_device, NULL);
811 minor = comedi_alloc_board_minor(hardware_device);
812 if(minor < 0) return minor;
814 private_data = kmalloc(sizeof(unsigned), GFP_KERNEL);
815 if(private_data == NULL) {
819 *private_data = minor;
820 dev_set_drvdata(hardware_device, private_data);
822 dev_file_info = comedi_get_device_file_info(minor);
824 memset(&it, 0, sizeof(it));
825 strncpy(it.board_name, board_name, COMEDI_NAMELEN);
826 it.board_name[COMEDI_NAMELEN - 1] = '\0';
827 BUG_ON(num_options > COMEDI_NDEVCONFOPTS);
828 memcpy(it.options, options, num_options * sizeof(int));
830 mutex_lock(&dev_file_info->device->mutex);
831 retval = comedi_device_attach(dev_file_info->device, &it);
832 mutex_unlock(&dev_file_info->device->mutex);
838 comedi_free_board_minor(minor);
843 void comedi_auto_unconfig(struct device *hardware_device)
845 unsigned *minor = (unsigned *)dev_get_drvdata(hardware_device);
846 if(minor == NULL) return;
848 BUG_ON(*minor >= COMEDI_NUM_BOARD_MINORS);
850 comedi_free_board_minor(*minor);
851 dev_set_drvdata(hardware_device, NULL);
855 int comedi_pci_auto_config(struct pci_dev *pcidev, const char *board_name)
860 options[0] = pcidev->bus->number;
862 options[1] = PCI_SLOT(pcidev->devfn);
864 return comedi_auto_config(&pcidev->dev, board_name, options, sizeof(options) / sizeof(options[0]));
867 void comedi_pci_auto_unconfig(struct pci_dev *pcidev)
869 comedi_auto_unconfig(&pcidev->dev);
872 int comedi_usb_auto_config(struct usb_device *usbdev,
873 const char *board_name)
875 BUG_ON(usbdev == NULL);
876 return comedi_auto_config(&usbdev->dev, board_name, NULL, 0);
879 void comedi_usb_auto_unconfig(struct usb_device *usbdev)
881 BUG_ON(usbdev == NULL);
882 comedi_auto_unconfig(&usbdev->dev);