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 "comedidev.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(struct comedi_device *dev);
51 static int insn_rw_emulate_bits(struct comedi_device *dev, struct comedi_subdevice *s,
52 struct comedi_insn *insn, unsigned int *data);
53 static void *comedi_recognize(struct comedi_driver * driv, const char *name);
54 static void comedi_report_boards(struct comedi_driver *driv);
55 static int poll_invalid(struct comedi_device *dev, struct comedi_subdevice *s);
56 int comedi_buf_alloc(struct comedi_device *dev, struct comedi_subdevice *s,
57 unsigned long new_size);
59 struct comedi_driver *comedi_drivers;
61 int comedi_modprobe(int minor)
66 static void cleanup_device(struct comedi_device *dev)
69 struct comedi_subdevice *s;
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;
87 dev->board_name = NULL;
88 dev->board_ptr = NULL;
91 dev->read_subdev = NULL;
92 dev->write_subdev = NULL;
95 comedi_set_hw_dev(dev, NULL);
98 static void __comedi_device_detach(struct comedi_device *dev)
102 dev->driver->detach(dev);
104 printk("BUG: dev->driver=NULL in comedi_device_detach()\n");
109 void comedi_device_detach(struct comedi_device *dev)
113 __comedi_device_detach(dev);
116 int comedi_device_attach(struct comedi_device *dev, struct comedi_devconfig *it)
118 struct comedi_driver *driv;
124 for (driv = comedi_drivers; driv; driv = driv->next) {
125 if (!try_module_get(driv->module)) {
126 printk("comedi: failed to increment module count, skipping\n");
129 if (driv->num_names) {
130 dev->board_ptr = comedi_recognize(driv, it->board_name);
131 if (dev->board_ptr == NULL) {
132 module_put(driv->module);
136 if (strcmp(driv->driver_name, it->board_name)) {
137 module_put(driv->module);
141 /* initialize dev->driver here so comedi_error() can be called from attach */
143 ret = driv->attach(dev, it);
145 module_put(dev->driver->module);
146 __comedi_device_detach(dev);
152 /* recognize has failed if we get here */
153 /* report valid board names before returning error */
154 for (driv = comedi_drivers; driv; driv = driv->next) {
155 if (!try_module_get(driv->module)) {
156 printk("comedi: failed to increment module count\n");
159 comedi_report_boards(driv);
160 module_put(driv->module);
165 /* do a little post-config cleanup */
166 ret = postconfig(dev);
167 module_put(dev->driver->module);
169 __comedi_device_detach(dev);
173 if (!dev->board_name) {
174 printk("BUG: dev->board_name=<%p>\n", dev->board_name);
175 dev->board_name = "BUG";
183 int comedi_driver_register(struct comedi_driver *driver)
185 driver->next = comedi_drivers;
186 comedi_drivers = driver;
191 int comedi_driver_unregister(struct comedi_driver *driver)
193 struct comedi_driver *prev;
196 /* check for devices using this driver */
197 for (i = 0; i < COMEDI_NUM_BOARD_MINORS; i++) {
198 struct comedi_device_file_info *dev_file_info = comedi_get_device_file_info(i);
199 struct comedi_device *dev;
201 if(dev_file_info == NULL) continue;
202 dev = dev_file_info->device;
204 mutex_lock(&dev->mutex);
205 if (dev->attached && dev->driver == driver) {
207 printk("BUG! detaching device with use_count=%d\n", dev->use_count);
208 comedi_device_detach(dev);
210 mutex_unlock(&dev->mutex);
213 if (comedi_drivers == driver) {
214 comedi_drivers = driver->next;
218 for (prev = comedi_drivers; prev->next; prev = prev->next) {
219 if (prev->next == driver) {
220 prev->next = driver->next;
227 static int postconfig(struct comedi_device *dev)
230 struct comedi_subdevice *s;
231 struct comedi_async *async = NULL;
234 for (i = 0; i < dev->n_subdevices; i++) {
235 s = dev->subdevices + i;
237 if (s->type == COMEDI_SUBD_UNUSED)
240 if (s->len_chanlist == 0)
244 BUG_ON((s->subdev_flags & (SDF_CMD_READ |
245 SDF_CMD_WRITE)) == 0);
246 BUG_ON(!s->do_cmdtest);
248 async = kzalloc(sizeof(struct comedi_async), GFP_KERNEL);
250 printk("failed to allocate async struct\n");
253 init_waitqueue_head(&async->wait_head);
254 async->subdevice = s;
257 #define DEFAULT_BUF_MAXSIZE (64*1024)
258 #define DEFAULT_BUF_SIZE (64*1024)
260 async->max_bufsize = DEFAULT_BUF_MAXSIZE;
262 async->prealloc_buf = NULL;
263 async->prealloc_bufsz = 0;
264 if (comedi_buf_alloc(dev, s, DEFAULT_BUF_SIZE) < 0) {
265 printk("Buffer allocation failed\n");
269 ret = s->buf_change(dev, s, DEFAULT_BUF_SIZE);
273 comedi_alloc_subdevice_minor(dev, s);
276 if (!s->range_table && !s->range_table_list)
277 s->range_table = &range_unknown;
279 if (!s->insn_read && s->insn_bits)
280 s->insn_read = insn_rw_emulate_bits;
281 if (!s->insn_write && s->insn_bits)
282 s->insn_write = insn_rw_emulate_bits;
285 s->insn_read = insn_inval;
287 s->insn_write = insn_inval;
289 s->insn_bits = insn_inval;
291 s->insn_config = insn_inval;
294 s->poll = poll_invalid;
300 /* generic recognize function for drivers that register their supported board names */
301 void *comedi_recognize(struct comedi_driver * driv, const char *name)
304 const char *const *name_ptr = driv->board_name;
305 for (i = 0; i < driv->num_names; i++) {
306 if (strcmp(*name_ptr, name) == 0)
307 return (void *)name_ptr;
309 (const char *const *)((const char *)name_ptr +
316 void comedi_report_boards(struct comedi_driver *driv)
319 const char *const *name_ptr;
321 printk("comedi: valid board names for %s driver are:\n",
324 name_ptr = driv->board_name;
325 for (i = 0; i < driv->num_names; i++) {
326 printk(" %s\n", *name_ptr);
327 name_ptr = (const char **)((char *)name_ptr + driv->offset);
330 if (driv->num_names == 0)
331 printk(" %s\n", driv->driver_name);
334 static int poll_invalid(struct comedi_device *dev, struct comedi_subdevice *s)
339 int insn_inval(struct comedi_device *dev, struct comedi_subdevice *s,
340 struct comedi_insn *insn, unsigned int *data)
345 static int insn_rw_emulate_bits(struct comedi_device *dev, struct comedi_subdevice *s,
346 struct comedi_insn *insn, unsigned int *data)
348 struct comedi_insn new_insn;
350 static const unsigned channels_per_bitfield = 32;
352 unsigned chan = CR_CHAN(insn->chanspec);
353 const unsigned base_bitfield_channel =
354 (chan < channels_per_bitfield) ? 0 : chan;
355 unsigned int new_data[2];
356 memset(new_data, 0, sizeof(new_data));
357 memset(&new_insn, 0, sizeof(new_insn));
358 new_insn.insn = INSN_BITS;
359 new_insn.chanspec = base_bitfield_channel;
361 new_insn.data = new_data;
362 new_insn.subdev = insn->subdev;
364 if (insn->insn == INSN_WRITE) {
365 if (!(s->subdev_flags & SDF_WRITABLE))
367 new_data[0] = 1 << (chan - base_bitfield_channel); /* mask */
368 new_data[1] = data[0] ? (1 << (chan - base_bitfield_channel)) : 0; /* bits */
371 ret = s->insn_bits(dev, s, &new_insn, new_data);
375 if (insn->insn == INSN_READ) {
376 data[0] = (new_data[1] >> (chan - base_bitfield_channel)) & 1;
382 static inline unsigned long uvirt_to_kva(pgd_t *pgd, unsigned long adr)
384 unsigned long ret = 0UL;
389 if (!pgd_none(*pgd)) {
390 pud = pud_offset(pgd, adr);
391 pmd = pmd_offset(pud, adr);
392 if (!pmd_none(*pmd)) {
393 ptep = pte_offset_kernel(pmd, adr);
395 if (pte_present(pte)) {
396 ret = (unsigned long)
397 page_address(pte_page(pte));
398 ret |= (adr & (PAGE_SIZE - 1));
405 static inline unsigned long kvirt_to_kva(unsigned long adr)
407 unsigned long va, kva;
410 kva = uvirt_to_kva(pgd_offset_k(va), va);
415 int comedi_buf_alloc(struct comedi_device *dev, struct comedi_subdevice *s,
416 unsigned long new_size)
418 struct comedi_async *async = s->async;
420 /* Round up new_size to multiple of PAGE_SIZE */
421 new_size = (new_size + PAGE_SIZE - 1) & PAGE_MASK;
423 /* if no change is required, do nothing */
424 if (async->prealloc_buf && async->prealloc_bufsz == new_size) {
427 /* deallocate old buffer */
428 if (async->prealloc_buf) {
429 vunmap(async->prealloc_buf);
430 async->prealloc_buf = NULL;
431 async->prealloc_bufsz = 0;
433 if (async->buf_page_list) {
435 for (i = 0; i < async->n_buf_pages; ++i) {
436 if (async->buf_page_list[i].virt_addr) {
437 mem_map_unreserve(virt_to_page(async->
438 buf_page_list[i].virt_addr));
439 if (s->async_dma_dir != DMA_NONE) {
440 dma_free_coherent(dev->hw_dev,
442 async->buf_page_list[i].
444 async->buf_page_list[i].
447 free_page((unsigned long)async->
448 buf_page_list[i].virt_addr);
452 vfree(async->buf_page_list);
453 async->buf_page_list = NULL;
454 async->n_buf_pages = 0;
456 /* allocate new buffer */
459 unsigned n_pages = new_size >> PAGE_SHIFT;
460 struct page **pages = NULL;
462 async->buf_page_list =
463 vmalloc(sizeof(struct comedi_buf_page) * n_pages);
464 if (async->buf_page_list) {
465 memset(async->buf_page_list, 0,
466 sizeof(struct comedi_buf_page) * n_pages);
467 pages = vmalloc(sizeof(struct page *) * n_pages);
470 for (i = 0; i < n_pages; i++) {
471 if (s->async_dma_dir != DMA_NONE) {
472 async->buf_page_list[i].virt_addr =
473 dma_alloc_coherent(dev->hw_dev,
475 &async->buf_page_list[i].
477 GFP_KERNEL | __GFP_COMP);
479 async->buf_page_list[i].virt_addr =
481 get_zeroed_page(GFP_KERNEL);
483 if (async->buf_page_list[i].virt_addr == NULL) {
486 mem_map_reserve(virt_to_page(async->
487 buf_page_list[i].virt_addr));
489 virt_to_page(async->buf_page_list[i].
494 async->prealloc_buf =
495 vmap(pages, n_pages, VM_MAP,
496 PAGE_KERNEL_NOCACHE);
501 if (async->prealloc_buf == NULL) {
502 /* Some allocation failed above. */
503 if (async->buf_page_list) {
504 for (i = 0; i < n_pages; i++) {
505 if (async->buf_page_list[i].virt_addr ==
509 mem_map_unreserve(virt_to_page(async->
512 if (s->async_dma_dir != DMA_NONE) {
513 dma_free_coherent(dev->hw_dev,
515 async->buf_page_list[i].
517 async->buf_page_list[i].
520 free_page((unsigned long)async->
525 vfree(async->buf_page_list);
526 async->buf_page_list = NULL;
530 async->n_buf_pages = n_pages;
532 async->prealloc_bufsz = new_size;
537 /* munging is applied to data by core as it passes between user
538 * and kernel space */
539 unsigned int comedi_buf_munge(struct comedi_async *async, unsigned int num_bytes)
541 struct comedi_subdevice *s = async->subdevice;
542 unsigned int count = 0;
543 const unsigned num_sample_bytes = bytes_per_sample(s);
545 if (s->munge == NULL || (async->cmd.flags & CMDF_RAWDATA)) {
546 async->munge_count += num_bytes;
547 BUG_ON((int)(async->munge_count - async->buf_write_count) > 0);
550 /* don't munge partial samples */
551 num_bytes -= num_bytes % num_sample_bytes;
552 while (count < num_bytes) {
555 block_size = num_bytes - count;
556 if (block_size < 0) {
557 rt_printk("%s: %s: bug! block_size is negative\n",
561 if ((int)(async->munge_ptr + block_size -
562 async->prealloc_bufsz) > 0)
563 block_size = async->prealloc_bufsz - async->munge_ptr;
565 s->munge(s->device, s, async->prealloc_buf + async->munge_ptr,
566 block_size, async->munge_chan);
568 smp_wmb(); /* barrier insures data is munged in buffer before munge_count is incremented */
570 async->munge_chan += block_size / num_sample_bytes;
571 async->munge_chan %= async->cmd.chanlist_len;
572 async->munge_count += block_size;
573 async->munge_ptr += block_size;
574 async->munge_ptr %= async->prealloc_bufsz;
577 BUG_ON((int)(async->munge_count - async->buf_write_count) > 0);
581 unsigned int comedi_buf_write_n_available(struct comedi_async *async)
583 unsigned int free_end;
589 free_end = async->buf_read_count + async->prealloc_bufsz;
590 nbytes = free_end - async->buf_write_alloc_count;
591 nbytes -= nbytes % bytes_per_sample(async->subdevice);
592 /* barrier insures the read of buf_read_count in this
593 query occurs before any following writes to the buffer which
594 might be based on the return value from this query.
600 /* allocates chunk for the writer from free buffer space */
601 unsigned int comedi_buf_write_alloc(struct comedi_async *async, unsigned int nbytes)
603 unsigned int free_end = async->buf_read_count + async->prealloc_bufsz;
605 if ((int)(async->buf_write_alloc_count + nbytes - free_end) > 0) {
606 nbytes = free_end - async->buf_write_alloc_count;
608 async->buf_write_alloc_count += nbytes;
609 /* barrier insures the read of buf_read_count above occurs before
610 we write data to the write-alloc'ed buffer space */
615 /* allocates nothing unless it can completely fulfill the request */
616 unsigned int comedi_buf_write_alloc_strict(struct comedi_async *async,
619 unsigned int free_end = async->buf_read_count + async->prealloc_bufsz;
621 if ((int)(async->buf_write_alloc_count + nbytes - free_end) > 0) {
624 async->buf_write_alloc_count += nbytes;
625 /* barrier insures the read of buf_read_count above occurs before
626 we write data to the write-alloc'ed buffer space */
631 /* transfers a chunk from writer to filled buffer space */
632 unsigned comedi_buf_write_free(struct comedi_async *async, unsigned int nbytes)
634 if ((int)(async->buf_write_count + nbytes -
635 async->buf_write_alloc_count) > 0) {
637 ("comedi: attempted to write-free more bytes than have been write-allocated.\n");
638 nbytes = async->buf_write_alloc_count - async->buf_write_count;
640 async->buf_write_count += nbytes;
641 async->buf_write_ptr += nbytes;
642 comedi_buf_munge(async, async->buf_write_count - async->munge_count);
643 if (async->buf_write_ptr >= async->prealloc_bufsz) {
644 async->buf_write_ptr %= async->prealloc_bufsz;
649 /* allocates a chunk for the reader from filled (and munged) buffer space */
650 unsigned comedi_buf_read_alloc(struct comedi_async *async, unsigned nbytes)
652 if ((int)(async->buf_read_alloc_count + nbytes - async->munge_count) >
654 nbytes = async->munge_count - async->buf_read_alloc_count;
656 async->buf_read_alloc_count += nbytes;
657 /* barrier insures read of munge_count occurs before we actually read
658 data out of buffer */
663 /* transfers control of a chunk from reader to free buffer space */
664 unsigned comedi_buf_read_free(struct comedi_async *async, unsigned int nbytes)
666 /* barrier insures data has been read out of buffer before read count is incremented */
668 if ((int)(async->buf_read_count + nbytes -
669 async->buf_read_alloc_count) > 0) {
671 ("comedi: attempted to read-free more bytes than have been read-allocated.\n");
672 nbytes = async->buf_read_alloc_count - async->buf_read_count;
674 async->buf_read_count += nbytes;
675 async->buf_read_ptr += nbytes;
676 async->buf_read_ptr %= async->prealloc_bufsz;
680 void comedi_buf_memcpy_to(struct comedi_async *async, unsigned int offset,
681 const void *data, unsigned int num_bytes)
683 unsigned int write_ptr = async->buf_write_ptr + offset;
685 if (write_ptr >= async->prealloc_bufsz)
686 write_ptr %= async->prealloc_bufsz;
689 unsigned int block_size;
691 if (write_ptr + num_bytes > async->prealloc_bufsz)
692 block_size = async->prealloc_bufsz - write_ptr;
694 block_size = num_bytes;
696 memcpy(async->prealloc_buf + write_ptr, data, block_size);
699 num_bytes -= block_size;
705 void comedi_buf_memcpy_from(struct comedi_async *async, unsigned int offset,
706 void *dest, unsigned int nbytes)
709 unsigned int read_ptr = async->buf_read_ptr + offset;
711 if (read_ptr >= async->prealloc_bufsz)
712 read_ptr %= async->prealloc_bufsz;
715 unsigned int block_size;
717 src = async->prealloc_buf + read_ptr;
719 if (nbytes >= async->prealloc_bufsz - read_ptr)
720 block_size = async->prealloc_bufsz - read_ptr;
724 memcpy(dest, src, block_size);
725 nbytes -= block_size;
731 unsigned int comedi_buf_read_n_available(struct comedi_async *async)
737 num_bytes = async->munge_count - async->buf_read_count;
738 /* barrier insures the read of munge_count in this
739 query occurs before any following reads of the buffer which
740 might be based on the return value from this query.
746 int comedi_buf_get(struct comedi_async *async, short *x)
748 unsigned int n = comedi_buf_read_n_available(async);
750 if (n < sizeof(short))
752 comedi_buf_read_alloc(async, sizeof(short));
753 *x = *(short *) (async->prealloc_buf + async->buf_read_ptr);
754 comedi_buf_read_free(async, sizeof(short));
758 int comedi_buf_put(struct comedi_async *async, short x)
760 unsigned int n = comedi_buf_write_alloc_strict(async, sizeof(short));
762 if (n < sizeof(short)) {
763 async->events |= COMEDI_CB_ERROR;
766 *(short *) (async->prealloc_buf + async->buf_write_ptr) = x;
767 comedi_buf_write_free(async, sizeof(short));
771 void comedi_reset_async_buf(struct comedi_async *async)
773 async->buf_write_alloc_count = 0;
774 async->buf_write_count = 0;
775 async->buf_read_alloc_count = 0;
776 async->buf_read_count = 0;
778 async->buf_write_ptr = 0;
779 async->buf_read_ptr = 0;
782 async->scan_progress = 0;
783 async->munge_chan = 0;
784 async->munge_count = 0;
785 async->munge_ptr = 0;
790 int comedi_auto_config(struct device *hardware_device, const char *board_name, const int *options, unsigned num_options)
792 struct comedi_devconfig it;
794 struct comedi_device_file_info *dev_file_info;
796 unsigned *private_data = NULL;
798 if (!comedi_autoconfig) {
799 dev_set_drvdata(hardware_device, NULL);
803 minor = comedi_alloc_board_minor(hardware_device);
804 if(minor < 0) return minor;
806 private_data = kmalloc(sizeof(unsigned), GFP_KERNEL);
807 if (private_data == NULL) {
811 *private_data = minor;
812 dev_set_drvdata(hardware_device, private_data);
814 dev_file_info = comedi_get_device_file_info(minor);
816 memset(&it, 0, sizeof(it));
817 strncpy(it.board_name, board_name, COMEDI_NAMELEN);
818 it.board_name[COMEDI_NAMELEN - 1] = '\0';
819 BUG_ON(num_options > COMEDI_NDEVCONFOPTS);
820 memcpy(it.options, options, num_options * sizeof(int));
822 mutex_lock(&dev_file_info->device->mutex);
823 retval = comedi_device_attach(dev_file_info->device, &it);
824 mutex_unlock(&dev_file_info->device->mutex);
830 comedi_free_board_minor(minor);
835 void comedi_auto_unconfig(struct device *hardware_device)
837 unsigned *minor = (unsigned *)dev_get_drvdata(hardware_device);
838 if(minor == NULL) return;
840 BUG_ON(*minor >= COMEDI_NUM_BOARD_MINORS);
842 comedi_free_board_minor(*minor);
843 dev_set_drvdata(hardware_device, NULL);
847 int comedi_pci_auto_config(struct pci_dev *pcidev, const char *board_name)
852 options[0] = pcidev->bus->number;
854 options[1] = PCI_SLOT(pcidev->devfn);
856 return comedi_auto_config(&pcidev->dev, board_name, options, sizeof(options) / sizeof(options[0]));
859 void comedi_pci_auto_unconfig(struct pci_dev *pcidev)
861 comedi_auto_unconfig(&pcidev->dev);
864 int comedi_usb_auto_config(struct usb_device *usbdev,
865 const char *board_name)
867 BUG_ON(usbdev == NULL);
868 return comedi_auto_config(&usbdev->dev, board_name, NULL, 0);
871 void comedi_usb_auto_unconfig(struct usb_device *usbdev)
873 BUG_ON(usbdev == NULL);
874 comedi_auto_unconfig(&usbdev->dev);