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.
19 #include <linux/device.h>
20 #include <linux/module.h>
21 #include <linux/errno.h>
22 #include <linux/kconfig.h>
23 #include <linux/kernel.h>
24 #include <linux/sched.h>
25 #include <linux/fcntl.h>
26 #include <linux/ioport.h>
28 #include <linux/slab.h>
29 #include <linux/highmem.h> /* for SuSE brokenness */
30 #include <linux/vmalloc.h>
31 #include <linux/cdev.h>
32 #include <linux/dma-mapping.h>
34 #include <linux/interrupt.h>
35 #include <linux/firmware.h>
37 #include "comedidev.h"
38 #include "comedi_internal.h"
40 struct comedi_driver
*comedi_drivers
;
41 DEFINE_MUTEX(comedi_drivers_list_lock
);
43 int comedi_set_hw_dev(struct comedi_device
*dev
, struct device
*hw_dev
)
45 if (hw_dev
== dev
->hw_dev
)
47 if (dev
->hw_dev
!= NULL
)
49 dev
->hw_dev
= get_device(hw_dev
);
52 EXPORT_SYMBOL_GPL(comedi_set_hw_dev
);
54 static void comedi_clear_hw_dev(struct comedi_device
*dev
)
56 put_device(dev
->hw_dev
);
61 * comedi_alloc_devpriv() - Allocate memory for the device private data.
62 * @dev: comedi_device struct
63 * @size: size of the memory to allocate
65 void *comedi_alloc_devpriv(struct comedi_device
*dev
, size_t size
)
67 dev
->private = kzalloc(size
, GFP_KERNEL
);
70 EXPORT_SYMBOL_GPL(comedi_alloc_devpriv
);
72 int comedi_alloc_subdevices(struct comedi_device
*dev
, int num_subdevices
)
74 struct comedi_subdevice
*s
;
77 if (num_subdevices
< 1)
80 s
= kcalloc(num_subdevices
, sizeof(*s
), GFP_KERNEL
);
84 dev
->n_subdevices
= num_subdevices
;
86 for (i
= 0; i
< num_subdevices
; ++i
) {
87 s
= &dev
->subdevices
[i
];
90 s
->async_dma_dir
= DMA_NONE
;
91 spin_lock_init(&s
->spin_lock
);
96 EXPORT_SYMBOL_GPL(comedi_alloc_subdevices
);
98 static void comedi_device_detach_cleanup(struct comedi_device
*dev
)
101 struct comedi_subdevice
*s
;
103 if (dev
->subdevices
) {
104 for (i
= 0; i
< dev
->n_subdevices
; i
++) {
105 s
= &dev
->subdevices
[i
];
106 if (s
->runflags
& SRF_FREE_SPRIV
)
108 comedi_free_subdevice_minor(s
);
110 comedi_buf_alloc(dev
, s
, 0);
114 kfree(dev
->subdevices
);
115 dev
->subdevices
= NULL
;
116 dev
->n_subdevices
= 0;
121 dev
->board_name
= NULL
;
122 dev
->board_ptr
= NULL
;
125 dev
->ioenabled
= false;
127 dev
->read_subdev
= NULL
;
128 dev
->write_subdev
= NULL
;
131 comedi_clear_hw_dev(dev
);
134 void comedi_device_detach(struct comedi_device
*dev
)
136 comedi_device_cancel_all(dev
);
137 down_write(&dev
->attach_lock
);
138 dev
->attached
= false;
141 dev
->driver
->detach(dev
);
142 comedi_device_detach_cleanup(dev
);
143 up_write(&dev
->attach_lock
);
146 static int poll_invalid(struct comedi_device
*dev
, struct comedi_subdevice
*s
)
151 int insn_inval(struct comedi_device
*dev
, struct comedi_subdevice
*s
,
152 struct comedi_insn
*insn
, unsigned int *data
)
158 * comedi_timeout() - busy-wait for a driver condition to occur.
159 * @dev: comedi_device struct
160 * @s: comedi_subdevice struct
161 * @insn: comedi_insn struct
162 * @cb: callback to check for the condition
163 * @context: private context from the driver
165 int comedi_timeout(struct comedi_device
*dev
,
166 struct comedi_subdevice
*s
,
167 struct comedi_insn
*insn
,
168 int (*cb
)(struct comedi_device
*dev
,
169 struct comedi_subdevice
*s
,
170 struct comedi_insn
*insn
,
171 unsigned long context
),
172 unsigned long context
)
174 unsigned long timeout
= jiffies
+ msecs_to_jiffies(COMEDI_TIMEOUT_MS
);
177 while (time_before(jiffies
, timeout
)) {
178 ret
= cb(dev
, s
, insn
, context
);
180 return ret
; /* success (0) or non EBUSY errno */
185 EXPORT_SYMBOL_GPL(comedi_timeout
);
188 * comedi_dio_insn_config() - boilerplate (*insn_config) for DIO subdevices.
189 * @dev: comedi_device struct
190 * @s: comedi_subdevice struct
191 * @insn: comedi_insn struct
192 * @data: parameters for the @insn
193 * @mask: io_bits mask for grouped channels
195 int comedi_dio_insn_config(struct comedi_device
*dev
,
196 struct comedi_subdevice
*s
,
197 struct comedi_insn
*insn
,
201 unsigned int chan_mask
= 1 << CR_CHAN(insn
->chanspec
);
207 case INSN_CONFIG_DIO_INPUT
:
211 case INSN_CONFIG_DIO_OUTPUT
:
215 case INSN_CONFIG_DIO_QUERY
:
216 data
[1] = (s
->io_bits
& mask
) ? COMEDI_OUTPUT
: COMEDI_INPUT
;
225 EXPORT_SYMBOL_GPL(comedi_dio_insn_config
);
228 * comedi_dio_update_state() - update the internal state of DIO subdevices.
229 * @s: comedi_subdevice struct
230 * @data: the channel mask and bits to update
232 unsigned int comedi_dio_update_state(struct comedi_subdevice
*s
,
235 unsigned int chanmask
= (s
->n_chan
< 32) ? ((1 << s
->n_chan
) - 1)
237 unsigned int mask
= data
[0] & chanmask
;
238 unsigned int bits
= data
[1];
242 s
->state
|= (bits
& mask
);
247 EXPORT_SYMBOL_GPL(comedi_dio_update_state
);
249 static int insn_rw_emulate_bits(struct comedi_device
*dev
,
250 struct comedi_subdevice
*s
,
251 struct comedi_insn
*insn
, unsigned int *data
)
253 struct comedi_insn new_insn
;
255 static const unsigned channels_per_bitfield
= 32;
257 unsigned chan
= CR_CHAN(insn
->chanspec
);
258 const unsigned base_bitfield_channel
=
259 (chan
< channels_per_bitfield
) ? 0 : chan
;
260 unsigned int new_data
[2];
261 memset(new_data
, 0, sizeof(new_data
));
262 memset(&new_insn
, 0, sizeof(new_insn
));
263 new_insn
.insn
= INSN_BITS
;
264 new_insn
.chanspec
= base_bitfield_channel
;
266 new_insn
.subdev
= insn
->subdev
;
268 if (insn
->insn
== INSN_WRITE
) {
269 if (!(s
->subdev_flags
& SDF_WRITABLE
))
271 new_data
[0] = 1 << (chan
- base_bitfield_channel
); /* mask */
272 new_data
[1] = data
[0] ? (1 << (chan
- base_bitfield_channel
))
276 ret
= s
->insn_bits(dev
, s
, &new_insn
, new_data
);
280 if (insn
->insn
== INSN_READ
)
281 data
[0] = (new_data
[1] >> (chan
- base_bitfield_channel
)) & 1;
286 static int __comedi_device_postconfig_async(struct comedi_device
*dev
,
287 struct comedi_subdevice
*s
)
289 struct comedi_async
*async
;
290 unsigned int buf_size
;
293 if ((s
->subdev_flags
& (SDF_CMD_READ
| SDF_CMD_WRITE
)) == 0) {
294 dev_warn(dev
->class_dev
,
295 "async subdevices must support SDF_CMD_READ or SDF_CMD_WRITE\n");
298 if (!s
->do_cmdtest
) {
299 dev_warn(dev
->class_dev
,
300 "async subdevices must have a do_cmdtest() function\n");
304 async
= kzalloc(sizeof(*async
), GFP_KERNEL
);
308 init_waitqueue_head(&async
->wait_head
);
309 async
->subdevice
= s
;
312 async
->max_bufsize
= comedi_default_buf_maxsize_kb
* 1024;
313 buf_size
= comedi_default_buf_size_kb
* 1024;
314 if (buf_size
> async
->max_bufsize
)
315 buf_size
= async
->max_bufsize
;
317 if (comedi_buf_alloc(dev
, s
, buf_size
) < 0) {
318 dev_warn(dev
->class_dev
, "Buffer allocation failed\n");
322 ret
= s
->buf_change(dev
, s
, buf_size
);
327 comedi_alloc_subdevice_minor(s
);
332 static int __comedi_device_postconfig(struct comedi_device
*dev
)
334 struct comedi_subdevice
*s
;
338 for (i
= 0; i
< dev
->n_subdevices
; i
++) {
339 s
= &dev
->subdevices
[i
];
341 if (s
->type
== COMEDI_SUBD_UNUSED
)
344 if (s
->type
== COMEDI_SUBD_DO
) {
346 s
->io_bits
= (1 << s
->n_chan
) - 1;
348 s
->io_bits
= 0xffffffff;
351 if (s
->len_chanlist
== 0)
355 ret
= __comedi_device_postconfig_async(dev
, s
);
360 if (!s
->range_table
&& !s
->range_table_list
)
361 s
->range_table
= &range_unknown
;
363 if (!s
->insn_read
&& s
->insn_bits
)
364 s
->insn_read
= insn_rw_emulate_bits
;
365 if (!s
->insn_write
&& s
->insn_bits
)
366 s
->insn_write
= insn_rw_emulate_bits
;
369 s
->insn_read
= insn_inval
;
371 s
->insn_write
= insn_inval
;
373 s
->insn_bits
= insn_inval
;
375 s
->insn_config
= insn_inval
;
378 s
->poll
= poll_invalid
;
384 /* do a little post-config cleanup */
385 static int comedi_device_postconfig(struct comedi_device
*dev
)
389 ret
= __comedi_device_postconfig(dev
);
392 down_write(&dev
->attach_lock
);
393 dev
->attached
= true;
394 up_write(&dev
->attach_lock
);
399 * Generic recognize function for drivers that register their supported
402 * 'driv->board_name' points to a 'const char *' member within the
403 * zeroth element of an array of some private board information
404 * structure, say 'struct foo_board' containing a member 'const char
405 * *board_name' that is initialized to point to a board name string that
406 * is one of the candidates matched against this function's 'name'
409 * 'driv->offset' is the size of the private board information
410 * structure, say 'sizeof(struct foo_board)', and 'driv->num_names' is
411 * the length of the array of private board information structures.
413 * If one of the board names in the array of private board information
414 * structures matches the name supplied to this function, the function
415 * returns a pointer to the pointer to the board name, otherwise it
416 * returns NULL. The return value ends up in the 'board_ptr' member of
417 * a 'struct comedi_device' that the low-level comedi driver's
418 * 'attach()' hook can convert to a point to a particular element of its
419 * array of private board information structures by subtracting the
420 * offset of the member that points to the board name. (No subtraction
421 * is required if the board name pointer is the first member of the
422 * private board information structure, which is generally the case.)
424 static void *comedi_recognize(struct comedi_driver
*driv
, const char *name
)
426 char **name_ptr
= (char **)driv
->board_name
;
429 for (i
= 0; i
< driv
->num_names
; i
++) {
430 if (strcmp(*name_ptr
, name
) == 0)
432 name_ptr
= (void *)name_ptr
+ driv
->offset
;
438 static void comedi_report_boards(struct comedi_driver
*driv
)
441 const char *const *name_ptr
;
443 pr_info("comedi: valid board names for %s driver are:\n",
446 name_ptr
= driv
->board_name
;
447 for (i
= 0; i
< driv
->num_names
; i
++) {
448 pr_info(" %s\n", *name_ptr
);
449 name_ptr
= (const char **)((char *)name_ptr
+ driv
->offset
);
452 if (driv
->num_names
== 0)
453 pr_info(" %s\n", driv
->driver_name
);
457 * comedi_load_firmware() - Request and load firmware for a device.
458 * @dev: comedi_device struct
459 * @hw_device: device struct for the comedi_device
460 * @name: the name of the firmware image
461 * @cb: callback to the upload the firmware image
462 * @context: private context from the driver
464 int comedi_load_firmware(struct comedi_device
*dev
,
465 struct device
*device
,
467 int (*cb
)(struct comedi_device
*dev
,
468 const u8
*data
, size_t size
,
469 unsigned long context
),
470 unsigned long context
)
472 const struct firmware
*fw
;
478 ret
= request_firmware(&fw
, name
, device
);
480 ret
= cb(dev
, fw
->data
, fw
->size
, context
);
481 release_firmware(fw
);
484 return ret
< 0 ? ret
: 0;
486 EXPORT_SYMBOL_GPL(comedi_load_firmware
);
489 * __comedi_request_region() - Request an I/O reqion for a legacy driver.
490 * @dev: comedi_device struct
491 * @start: base address of the I/O reqion
492 * @len: length of the I/O region
494 int __comedi_request_region(struct comedi_device
*dev
,
495 unsigned long start
, unsigned long len
)
498 dev_warn(dev
->class_dev
,
499 "%s: a I/O base address must be specified\n",
504 if (!request_region(start
, len
, dev
->board_name
)) {
505 dev_warn(dev
->class_dev
, "%s: I/O port conflict (%#lx,%lu)\n",
506 dev
->board_name
, start
, len
);
512 EXPORT_SYMBOL_GPL(__comedi_request_region
);
515 * comedi_request_region() - Request an I/O reqion for a legacy driver.
516 * @dev: comedi_device struct
517 * @start: base address of the I/O reqion
518 * @len: length of the I/O region
520 int comedi_request_region(struct comedi_device
*dev
,
521 unsigned long start
, unsigned long len
)
525 ret
= __comedi_request_region(dev
, start
, len
);
533 EXPORT_SYMBOL_GPL(comedi_request_region
);
536 * comedi_legacy_detach() - A generic (*detach) function for legacy drivers.
537 * @dev: comedi_device struct
539 void comedi_legacy_detach(struct comedi_device
*dev
)
542 free_irq(dev
->irq
, dev
);
545 if (dev
->iobase
&& dev
->iolen
) {
546 release_region(dev
->iobase
, dev
->iolen
);
551 EXPORT_SYMBOL_GPL(comedi_legacy_detach
);
553 int comedi_device_attach(struct comedi_device
*dev
, struct comedi_devconfig
*it
)
555 struct comedi_driver
*driv
;
561 mutex_lock(&comedi_drivers_list_lock
);
562 for (driv
= comedi_drivers
; driv
; driv
= driv
->next
) {
563 if (!try_module_get(driv
->module
))
565 if (driv
->num_names
) {
566 dev
->board_ptr
= comedi_recognize(driv
, it
->board_name
);
569 } else if (strcmp(driv
->driver_name
, it
->board_name
) == 0)
571 module_put(driv
->module
);
574 /* recognize has failed if we get here */
575 /* report valid board names before returning error */
576 for (driv
= comedi_drivers
; driv
; driv
= driv
->next
) {
577 if (!try_module_get(driv
->module
))
579 comedi_report_boards(driv
);
580 module_put(driv
->module
);
585 if (driv
->attach
== NULL
) {
586 /* driver does not support manual configuration */
587 dev_warn(dev
->class_dev
,
588 "driver '%s' does not support attach using comedi_config\n",
590 module_put(driv
->module
);
594 /* initialize dev->driver here so
595 * comedi_error() can be called from attach */
597 dev
->board_name
= dev
->board_ptr
? *(const char **)dev
->board_ptr
598 : dev
->driver
->driver_name
;
599 ret
= driv
->attach(dev
, it
);
601 ret
= comedi_device_postconfig(dev
);
603 comedi_device_detach(dev
);
604 module_put(driv
->module
);
606 /* On success, the driver module count has been incremented. */
608 mutex_unlock(&comedi_drivers_list_lock
);
612 int comedi_auto_config(struct device
*hardware_device
,
613 struct comedi_driver
*driver
, unsigned long context
)
615 struct comedi_device
*dev
;
618 if (!hardware_device
) {
619 pr_warn("BUG! comedi_auto_config called with NULL hardware_device\n");
623 dev_warn(hardware_device
,
624 "BUG! comedi_auto_config called with NULL comedi driver\n");
628 if (!driver
->auto_attach
) {
629 dev_warn(hardware_device
,
630 "BUG! comedi driver '%s' has no auto_attach handler\n",
631 driver
->driver_name
);
635 dev
= comedi_alloc_board_minor(hardware_device
);
637 dev_warn(hardware_device
,
638 "driver '%s' could not create device.\n",
639 driver
->driver_name
);
642 /* Note: comedi_alloc_board_minor() locked dev->mutex. */
644 dev
->driver
= driver
;
645 dev
->board_name
= dev
->driver
->driver_name
;
646 ret
= driver
->auto_attach(dev
, context
);
648 ret
= comedi_device_postconfig(dev
);
649 mutex_unlock(&dev
->mutex
);
652 dev_warn(hardware_device
,
653 "driver '%s' failed to auto-configure device.\n",
654 driver
->driver_name
);
655 comedi_release_hardware_device(hardware_device
);
658 * class_dev should be set properly here
659 * after a successful auto config
661 dev_info(dev
->class_dev
,
662 "driver '%s' has successfully auto-configured '%s'.\n",
663 driver
->driver_name
, dev
->board_name
);
667 EXPORT_SYMBOL_GPL(comedi_auto_config
);
669 void comedi_auto_unconfig(struct device
*hardware_device
)
671 if (hardware_device
== NULL
)
673 comedi_release_hardware_device(hardware_device
);
675 EXPORT_SYMBOL_GPL(comedi_auto_unconfig
);
677 int comedi_driver_register(struct comedi_driver
*driver
)
679 mutex_lock(&comedi_drivers_list_lock
);
680 driver
->next
= comedi_drivers
;
681 comedi_drivers
= driver
;
682 mutex_unlock(&comedi_drivers_list_lock
);
686 EXPORT_SYMBOL_GPL(comedi_driver_register
);
688 void comedi_driver_unregister(struct comedi_driver
*driver
)
690 struct comedi_driver
*prev
;
693 /* unlink the driver */
694 mutex_lock(&comedi_drivers_list_lock
);
695 if (comedi_drivers
== driver
) {
696 comedi_drivers
= driver
->next
;
698 for (prev
= comedi_drivers
; prev
->next
; prev
= prev
->next
) {
699 if (prev
->next
== driver
) {
700 prev
->next
= driver
->next
;
705 mutex_unlock(&comedi_drivers_list_lock
);
707 /* check for devices using this driver */
708 for (i
= 0; i
< COMEDI_NUM_BOARD_MINORS
; i
++) {
709 struct comedi_device
*dev
= comedi_dev_get_from_minor(i
);
714 mutex_lock(&dev
->mutex
);
715 if (dev
->attached
&& dev
->driver
== driver
) {
717 dev_warn(dev
->class_dev
,
718 "BUG! detaching device with use_count=%d\n",
720 comedi_device_detach(dev
);
722 mutex_unlock(&dev
->mutex
);
726 EXPORT_SYMBOL_GPL(comedi_driver_unregister
);