David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 1 | /* |
| 2 | include/linux/comedidev.h |
| 3 | header file for kernel-only structures, variables, and constants |
| 4 | |
| 5 | COMEDI - Linux Control and Measurement Device Interface |
| 6 | Copyright (C) 1997-2000 David A. Schleef <ds@schleef.org> |
| 7 | |
| 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. |
| 12 | |
| 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. |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 17 | */ |
| 18 | |
| 19 | #ifndef _COMEDIDEV_H |
| 20 | #define _COMEDIDEV_H |
| 21 | |
| 22 | #include <linux/kernel.h> |
| 23 | #include <linux/module.h> |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 24 | #include <linux/kdev_t.h> |
| 25 | #include <linux/slab.h> |
Randy Dunlap | f9c5137 | 2009-06-05 11:10:42 -0700 | [diff] [blame] | 26 | #include <linux/delay.h> |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 27 | #include <linux/errno.h> |
| 28 | #include <linux/spinlock.h> |
| 29 | #include <linux/mutex.h> |
| 30 | #include <linux/wait.h> |
| 31 | #include <linux/mm.h> |
| 32 | #include <linux/init.h> |
| 33 | #include <linux/vmalloc.h> |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 34 | #include <linux/dma-mapping.h> |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 35 | #include <linux/uaccess.h> |
| 36 | #include <linux/io.h> |
Greg Kroah-Hartman | c7a5d70 | 2009-06-19 11:04:32 -0700 | [diff] [blame] | 37 | #include <linux/timer.h> |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 38 | |
| 39 | #include "comedi.h" |
| 40 | |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 41 | #define DPRINTK(format, args...) do { \ |
| 42 | if (comedi_debug) \ |
Ian Abbott | 4f870fe | 2012-08-16 14:38:05 +0100 | [diff] [blame] | 43 | pr_debug("comedi: " format, ## args); \ |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 44 | } while (0) |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 45 | |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 46 | #define COMEDI_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c)) |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 47 | #define COMEDI_VERSION_CODE COMEDI_VERSION(COMEDI_MAJORVERSION, \ |
| 48 | COMEDI_MINORVERSION, COMEDI_MICROVERSION) |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 49 | #define COMEDI_RELEASE VERSION |
| 50 | |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 51 | #define COMEDI_NUM_BOARD_MINORS 0x30 |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 52 | |
Bill Pemberton | 34c4392 | 2009-03-16 22:05:14 -0400 | [diff] [blame] | 53 | struct comedi_subdevice { |
Bill Pemberton | 71b5f4f | 2009-03-16 22:05:08 -0400 | [diff] [blame] | 54 | struct comedi_device *device; |
H Hartley Sweeten | 90a35c1 | 2012-12-19 17:27:02 -0700 | [diff] [blame] | 55 | int index; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 56 | int type; |
| 57 | int n_chan; |
Greg Kroah-Hartman | baf22b6 | 2010-04-30 15:26:54 -0700 | [diff] [blame] | 58 | int subdev_flags; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 59 | int len_chanlist; /* maximum length of channel/gain list */ |
| 60 | |
| 61 | void *private; |
| 62 | |
Bill Pemberton | d163679 | 2009-03-16 22:05:20 -0400 | [diff] [blame] | 63 | struct comedi_async *async; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 64 | |
| 65 | void *lock; |
| 66 | void *busy; |
| 67 | unsigned runflags; |
| 68 | spinlock_t spin_lock; |
| 69 | |
H Hartley Sweeten | d4a7dc8 | 2012-06-18 14:45:42 -0700 | [diff] [blame] | 70 | unsigned int io_bits; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 71 | |
Bill Pemberton | 790c554 | 2009-03-16 22:05:02 -0400 | [diff] [blame] | 72 | unsigned int maxdata; /* if maxdata==0, use list */ |
| 73 | const unsigned int *maxdata_list; /* list is channel specific */ |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 74 | |
| 75 | unsigned int flags; |
| 76 | const unsigned int *flaglist; |
| 77 | |
| 78 | unsigned int settling_time_0; |
| 79 | |
Bill Pemberton | 9ced1de | 2009-03-16 22:05:31 -0400 | [diff] [blame] | 80 | const struct comedi_lrange *range_table; |
| 81 | const struct comedi_lrange *const *range_table_list; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 82 | |
| 83 | unsigned int *chanlist; /* driver-owned chanlist (not used) */ |
| 84 | |
Mithlesh Thukral | 0a85b6f | 2009-06-08 21:04:41 +0530 | [diff] [blame] | 85 | int (*insn_read) (struct comedi_device *, struct comedi_subdevice *, |
| 86 | struct comedi_insn *, unsigned int *); |
| 87 | int (*insn_write) (struct comedi_device *, struct comedi_subdevice *, |
| 88 | struct comedi_insn *, unsigned int *); |
| 89 | int (*insn_bits) (struct comedi_device *, struct comedi_subdevice *, |
| 90 | struct comedi_insn *, unsigned int *); |
| 91 | int (*insn_config) (struct comedi_device *, struct comedi_subdevice *, |
| 92 | struct comedi_insn *, unsigned int *); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 93 | |
Bill Pemberton | 34c4392 | 2009-03-16 22:05:14 -0400 | [diff] [blame] | 94 | int (*do_cmd) (struct comedi_device *, struct comedi_subdevice *); |
Mithlesh Thukral | 0a85b6f | 2009-06-08 21:04:41 +0530 | [diff] [blame] | 95 | int (*do_cmdtest) (struct comedi_device *, struct comedi_subdevice *, |
| 96 | struct comedi_cmd *); |
Bill Pemberton | 34c4392 | 2009-03-16 22:05:14 -0400 | [diff] [blame] | 97 | int (*poll) (struct comedi_device *, struct comedi_subdevice *); |
| 98 | int (*cancel) (struct comedi_device *, struct comedi_subdevice *); |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 99 | /* int (*do_lock)(struct comedi_device *, struct comedi_subdevice *); */ |
| 100 | /* int (*do_unlock)(struct comedi_device *, \ |
| 101 | struct comedi_subdevice *); */ |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 102 | |
| 103 | /* called when the buffer changes */ |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 104 | int (*buf_change) (struct comedi_device *dev, |
| 105 | struct comedi_subdevice *s, unsigned long new_size); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 106 | |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 107 | void (*munge) (struct comedi_device *dev, struct comedi_subdevice *s, |
Mithlesh Thukral | 0a85b6f | 2009-06-08 21:04:41 +0530 | [diff] [blame] | 108 | void *data, unsigned int num_bytes, |
| 109 | unsigned int start_chan_index); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 110 | enum dma_data_direction async_dma_dir; |
| 111 | |
| 112 | unsigned int state; |
| 113 | |
Bill Pemberton | 0bfbbe8 | 2009-03-16 22:05:36 -0400 | [diff] [blame] | 114 | struct device *class_dev; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 115 | int minor; |
| 116 | }; |
| 117 | |
| 118 | struct comedi_buf_page { |
| 119 | void *virt_addr; |
| 120 | dma_addr_t dma_addr; |
| 121 | }; |
| 122 | |
Bill Pemberton | d163679 | 2009-03-16 22:05:20 -0400 | [diff] [blame] | 123 | struct comedi_async { |
Bill Pemberton | 34c4392 | 2009-03-16 22:05:14 -0400 | [diff] [blame] | 124 | struct comedi_subdevice *subdevice; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 125 | |
| 126 | void *prealloc_buf; /* pre-allocated buffer */ |
| 127 | unsigned int prealloc_bufsz; /* buffer size, in bytes */ |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 128 | /* virtual and dma address of each page */ |
| 129 | struct comedi_buf_page *buf_page_list; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 130 | unsigned n_buf_pages; /* num elements in buf_page_list */ |
| 131 | |
| 132 | unsigned int max_bufsize; /* maximum buffer size, bytes */ |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 133 | /* current number of mmaps of prealloc_buf */ |
| 134 | unsigned int mmap_count; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 135 | |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 136 | /* byte count for writer (write completed) */ |
| 137 | unsigned int buf_write_count; |
| 138 | /* byte count for writer (allocated for writing) */ |
| 139 | unsigned int buf_write_alloc_count; |
| 140 | /* byte count for reader (read completed) */ |
| 141 | unsigned int buf_read_count; |
| 142 | /* byte count for reader (allocated for reading) */ |
| 143 | unsigned int buf_read_alloc_count; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 144 | |
| 145 | unsigned int buf_write_ptr; /* buffer marker for writer */ |
| 146 | unsigned int buf_read_ptr; /* buffer marker for reader */ |
| 147 | |
| 148 | unsigned int cur_chan; /* useless channel marker for interrupt */ |
| 149 | /* number of bytes that have been received for current scan */ |
| 150 | unsigned int scan_progress; |
| 151 | /* keeps track of where we are in chanlist as for munging */ |
| 152 | unsigned int munge_chan; |
| 153 | /* number of bytes that have been munged */ |
| 154 | unsigned int munge_count; |
| 155 | /* buffer marker for munging */ |
| 156 | unsigned int munge_ptr; |
| 157 | |
| 158 | unsigned int events; /* events that have occurred */ |
| 159 | |
Bill Pemberton | ea6d0d4 | 2009-03-16 22:05:47 -0400 | [diff] [blame] | 160 | struct comedi_cmd cmd; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 161 | |
| 162 | wait_queue_head_t wait_head; |
| 163 | |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 164 | /* callback stuff */ |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 165 | unsigned int cb_mask; |
| 166 | int (*cb_func) (unsigned int flags, void *); |
| 167 | void *cb_arg; |
| 168 | |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 169 | int (*inttrig) (struct comedi_device *dev, struct comedi_subdevice *s, |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 170 | unsigned int x); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 171 | }; |
| 172 | |
Bill Pemberton | 139dfbd | 2009-03-16 22:05:25 -0400 | [diff] [blame] | 173 | struct comedi_driver { |
| 174 | struct comedi_driver *next; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 175 | |
| 176 | const char *driver_name; |
| 177 | struct module *module; |
Bill Pemberton | 0707bb0 | 2009-03-16 22:06:20 -0400 | [diff] [blame] | 178 | int (*attach) (struct comedi_device *, struct comedi_devconfig *); |
H Hartley Sweeten | 484ecc9 | 2012-05-17 17:11:14 -0700 | [diff] [blame] | 179 | void (*detach) (struct comedi_device *); |
Ian Abbott | 8ed705a | 2012-10-27 21:44:14 +0100 | [diff] [blame] | 180 | int (*auto_attach) (struct comedi_device *, unsigned long); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 181 | |
| 182 | /* number of elements in board_name and board_id arrays */ |
| 183 | unsigned int num_names; |
| 184 | const char *const *board_name; |
| 185 | /* offset in bytes from one board name pointer to the next */ |
| 186 | int offset; |
| 187 | }; |
| 188 | |
Bill Pemberton | 71b5f4f | 2009-03-16 22:05:08 -0400 | [diff] [blame] | 189 | struct comedi_device { |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 190 | int use_count; |
Bill Pemberton | 139dfbd | 2009-03-16 22:05:25 -0400 | [diff] [blame] | 191 | struct comedi_driver *driver; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 192 | void *private; |
| 193 | |
Bill Pemberton | 0bfbbe8 | 2009-03-16 22:05:36 -0400 | [diff] [blame] | 194 | struct device *class_dev; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 195 | int minor; |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 196 | /* hw_dev is passed to dma_alloc_coherent when allocating async buffers |
| 197 | * for subdevices that have async_dma_dir set to something other than |
| 198 | * DMA_NONE */ |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 199 | struct device *hw_dev; |
| 200 | |
| 201 | const char *board_name; |
| 202 | const void *board_ptr; |
Ian Abbott | a7401cd | 2013-03-15 13:15:33 +0000 | [diff] [blame] | 203 | bool attached:1; |
Ian Abbott | 13f12b5 | 2013-03-15 13:15:34 +0000 | [diff] [blame] | 204 | bool in_request_module:1; |
Ian Abbott | 00ca6884 | 2013-03-15 13:15:35 +0000 | [diff] [blame] | 205 | bool ioenabled:1; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 206 | spinlock_t spinlock; |
| 207 | struct mutex mutex; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 208 | |
| 209 | int n_subdevices; |
Bill Pemberton | 34c4392 | 2009-03-16 22:05:14 -0400 | [diff] [blame] | 210 | struct comedi_subdevice *subdevices; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 211 | |
| 212 | /* dumb */ |
| 213 | unsigned long iobase; |
H Hartley Sweeten | 316f97f | 2013-04-18 14:31:29 -0700 | [diff] [blame] | 214 | unsigned long iolen; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 215 | unsigned int irq; |
| 216 | |
Bill Pemberton | 34c4392 | 2009-03-16 22:05:14 -0400 | [diff] [blame] | 217 | struct comedi_subdevice *read_subdev; |
| 218 | struct comedi_subdevice *write_subdev; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 219 | |
| 220 | struct fasync_struct *async_queue; |
| 221 | |
Ian Abbott | 3c17ba07 | 2010-05-19 14:10:00 +0100 | [diff] [blame] | 222 | int (*open) (struct comedi_device *dev); |
Shane Warden | 62eeae9 | 2009-09-22 16:13:04 -0700 | [diff] [blame] | 223 | void (*close) (struct comedi_device *dev); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 224 | }; |
| 225 | |
Ian Abbott | 4dba6c0 | 2012-11-02 19:18:00 +0000 | [diff] [blame] | 226 | static inline const void *comedi_board(const struct comedi_device *dev) |
H Hartley Sweeten | 37859f8 | 2012-04-27 14:10:15 -0700 | [diff] [blame] | 227 | { |
| 228 | return dev->board_ptr; |
| 229 | } |
| 230 | |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 231 | #ifdef CONFIG_COMEDI_DEBUG |
| 232 | extern int comedi_debug; |
| 233 | #else |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 234 | static const int comedi_debug; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 235 | #endif |
| 236 | |
| 237 | /* |
| 238 | * function prototypes |
| 239 | */ |
| 240 | |
Bill Pemberton | 34c4392 | 2009-03-16 22:05:14 -0400 | [diff] [blame] | 241 | void comedi_event(struct comedi_device *dev, struct comedi_subdevice *s); |
Bill Pemberton | 71b5f4f | 2009-03-16 22:05:08 -0400 | [diff] [blame] | 242 | void comedi_error(const struct comedi_device *dev, const char *s); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 243 | |
| 244 | /* we can expand the number of bits used to encode devices/subdevices into |
| 245 | the minor number soon, after more distros support > 8 bit minor numbers |
| 246 | (like after Debian Etch gets released) */ |
| 247 | enum comedi_minor_bits { |
| 248 | COMEDI_DEVICE_MINOR_MASK = 0xf, |
| 249 | COMEDI_SUBDEVICE_MINOR_MASK = 0xf0 |
| 250 | }; |
| 251 | static const unsigned COMEDI_SUBDEVICE_MINOR_SHIFT = 4; |
| 252 | static const unsigned COMEDI_SUBDEVICE_MINOR_OFFSET = 1; |
| 253 | |
H Hartley Sweeten | 85104e9 | 2012-12-19 15:34:40 -0700 | [diff] [blame] | 254 | struct comedi_device *comedi_dev_from_minor(unsigned minor); |
| 255 | |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 256 | void init_polling(void); |
| 257 | void cleanup_polling(void); |
Bill Pemberton | 71b5f4f | 2009-03-16 22:05:08 -0400 | [diff] [blame] | 258 | void start_polling(struct comedi_device *); |
| 259 | void stop_polling(struct comedi_device *); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 260 | |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 261 | /* subdevice runflags */ |
| 262 | enum subdevice_runflags { |
| 263 | SRF_USER = 0x00000001, |
| 264 | SRF_RT = 0x00000002, |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 265 | /* indicates an COMEDI_CB_ERROR event has occurred since the last |
| 266 | * command was started */ |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 267 | SRF_ERROR = 0x00000004, |
H Hartley Sweeten | 588ba6d | 2013-06-11 11:32:29 -0700 | [diff] [blame] | 268 | SRF_RUNNING = 0x08000000, |
| 269 | SRF_FREE_SPRIV = 0x80000000, /* free s->private on detach */ |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 270 | }; |
| 271 | |
H Hartley Sweeten | e0dac31 | 2012-12-19 15:42:47 -0700 | [diff] [blame] | 272 | bool comedi_is_subdevice_running(struct comedi_subdevice *s); |
H Hartley Sweeten | 0480bcb | 2013-06-19 15:24:36 -0700 | [diff] [blame] | 273 | |
| 274 | void *comedi_alloc_spriv(struct comedi_subdevice *s, size_t size); |
H Hartley Sweeten | e0dac31 | 2012-12-19 15:42:47 -0700 | [diff] [blame] | 275 | |
Mark Rankilor | 5e22011 | 2010-05-06 17:49:37 +0800 | [diff] [blame] | 276 | int comedi_check_chanlist(struct comedi_subdevice *s, |
| 277 | int n, |
| 278 | unsigned int *chanlist); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 279 | |
| 280 | /* range stuff */ |
| 281 | |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 282 | #define RANGE(a, b) {(a)*1e6, (b)*1e6, 0} |
| 283 | #define RANGE_ext(a, b) {(a)*1e6, (b)*1e6, RF_EXTERNAL} |
| 284 | #define RANGE_mA(a, b) {(a)*1e6, (b)*1e6, UNIT_mA} |
Greg Kroah-Hartman | baf22b6 | 2010-04-30 15:26:54 -0700 | [diff] [blame] | 285 | #define RANGE_unitless(a, b) {(a)*1e6, (b)*1e6, 0} |
Greg Kroah-Hartman | e0dcef7 | 2008-11-13 16:36:22 -0800 | [diff] [blame] | 286 | #define BIP_RANGE(a) {-(a)*1e6, (a)*1e6, 0} |
| 287 | #define UNI_RANGE(a) {0, (a)*1e6, 0} |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 288 | |
Bill Pemberton | 9ced1de | 2009-03-16 22:05:31 -0400 | [diff] [blame] | 289 | extern const struct comedi_lrange range_bipolar10; |
| 290 | extern const struct comedi_lrange range_bipolar5; |
| 291 | extern const struct comedi_lrange range_bipolar2_5; |
| 292 | extern const struct comedi_lrange range_unipolar10; |
| 293 | extern const struct comedi_lrange range_unipolar5; |
H Hartley Sweeten | 5f8eb72 | 2013-04-03 13:38:26 -0700 | [diff] [blame] | 294 | extern const struct comedi_lrange range_unipolar2_5; |
H Hartley Sweeten | 2c71c4f | 2013-04-03 13:40:13 -0700 | [diff] [blame] | 295 | extern const struct comedi_lrange range_0_20mA; |
| 296 | extern const struct comedi_lrange range_4_20mA; |
| 297 | extern const struct comedi_lrange range_0_32mA; |
Bill Pemberton | 9ced1de | 2009-03-16 22:05:31 -0400 | [diff] [blame] | 298 | extern const struct comedi_lrange range_unknown; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 299 | |
| 300 | #define range_digital range_unipolar5 |
| 301 | |
| 302 | #if __GNUC__ >= 3 |
| 303 | #define GCC_ZERO_LENGTH_ARRAY |
| 304 | #else |
| 305 | #define GCC_ZERO_LENGTH_ARRAY 0 |
| 306 | #endif |
| 307 | |
Bill Pemberton | 9ced1de | 2009-03-16 22:05:31 -0400 | [diff] [blame] | 308 | struct comedi_lrange { |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 309 | int length; |
Bill Pemberton | 1f6325d | 2009-03-16 22:06:31 -0400 | [diff] [blame] | 310 | struct comedi_krange range[GCC_ZERO_LENGTH_ARRAY]; |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 311 | }; |
| 312 | |
H Hartley Sweeten | e3693fd | 2013-06-05 15:52:31 -0700 | [diff] [blame] | 313 | static inline bool comedi_range_is_bipolar(struct comedi_subdevice *s, |
| 314 | unsigned int range) |
| 315 | { |
| 316 | return s->range_table->range[range].min < 0; |
| 317 | } |
| 318 | |
| 319 | static inline bool comedi_range_is_unipolar(struct comedi_subdevice *s, |
| 320 | unsigned int range) |
| 321 | { |
| 322 | return s->range_table->range[range].min >= 0; |
| 323 | } |
| 324 | |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 325 | /* some silly little inline functions */ |
| 326 | |
Bill Pemberton | 34c4392 | 2009-03-16 22:05:14 -0400 | [diff] [blame] | 327 | static inline unsigned int bytes_per_sample(const struct comedi_subdevice *subd) |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 328 | { |
| 329 | if (subd->subdev_flags & SDF_LSAMPL) |
Bill Pemberton | 790c554 | 2009-03-16 22:05:02 -0400 | [diff] [blame] | 330 | return sizeof(unsigned int); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 331 | else |
Bill Pemberton | 790c554 | 2009-03-16 22:05:02 -0400 | [diff] [blame] | 332 | return sizeof(short); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 333 | } |
| 334 | |
Ian Abbott | bc3954b | 2013-01-29 16:20:17 +0000 | [diff] [blame] | 335 | /* |
| 336 | * Must set dev->hw_dev if you wish to dma directly into comedi's buffer. |
| 337 | * Also useful for retrieving a previously configured hardware device of |
| 338 | * known bus type. Set automatically for auto-configured devices. |
| 339 | * Automatically set to NULL when detaching hardware device. |
| 340 | */ |
Ian Abbott | da71751 | 2013-02-01 13:23:19 +0000 | [diff] [blame] | 341 | int comedi_set_hw_dev(struct comedi_device *dev, struct device *hw_dev); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 342 | |
H Hartley Sweeten | 8ae560a | 2013-01-09 13:32:56 -0700 | [diff] [blame] | 343 | unsigned int comedi_buf_write_alloc(struct comedi_async *, unsigned int); |
| 344 | unsigned int comedi_buf_write_free(struct comedi_async *, unsigned int); |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 345 | |
H Hartley Sweeten | 8ae560a | 2013-01-09 13:32:56 -0700 | [diff] [blame] | 346 | unsigned int comedi_buf_read_n_available(struct comedi_async *); |
| 347 | unsigned int comedi_buf_read_alloc(struct comedi_async *, unsigned int); |
| 348 | unsigned int comedi_buf_read_free(struct comedi_async *, unsigned int); |
| 349 | |
| 350 | int comedi_buf_put(struct comedi_async *, short); |
| 351 | int comedi_buf_get(struct comedi_async *, short *); |
| 352 | |
Bill Pemberton | d163679 | 2009-03-16 22:05:20 -0400 | [diff] [blame] | 353 | void comedi_buf_memcpy_to(struct comedi_async *async, unsigned int offset, |
Mithlesh Thukral | 0a85b6f | 2009-06-08 21:04:41 +0530 | [diff] [blame] | 354 | const void *source, unsigned int num_bytes); |
Bill Pemberton | d163679 | 2009-03-16 22:05:20 -0400 | [diff] [blame] | 355 | void comedi_buf_memcpy_from(struct comedi_async *async, unsigned int offset, |
Mithlesh Thukral | 0a85b6f | 2009-06-08 21:04:41 +0530 | [diff] [blame] | 356 | void *destination, unsigned int num_bytes); |
Mithlesh Thukral | 0a85b6f | 2009-06-08 21:04:41 +0530 | [diff] [blame] | 357 | |
H Hartley Sweeten | 1ae6b20 | 2013-01-30 15:24:38 -0700 | [diff] [blame] | 358 | /* drivers.c - general comedi driver functions */ |
| 359 | |
| 360 | int comedi_alloc_subdevices(struct comedi_device *, int); |
| 361 | |
H Hartley Sweeten | 9ff8b15 | 2013-05-17 11:17:00 -0700 | [diff] [blame] | 362 | int comedi_load_firmware(struct comedi_device *, struct device *, |
| 363 | const char *name, |
| 364 | int (*cb)(struct comedi_device *, |
H Hartley Sweeten | d569541 | 2013-05-17 11:18:01 -0700 | [diff] [blame] | 365 | const u8 *data, size_t size, |
| 366 | unsigned long context), |
| 367 | unsigned long context); |
H Hartley Sweeten | 9ff8b15 | 2013-05-17 11:17:00 -0700 | [diff] [blame] | 368 | |
H Hartley Sweeten | ca8b296 | 2013-04-09 16:30:11 -0700 | [diff] [blame] | 369 | int __comedi_request_region(struct comedi_device *, |
| 370 | unsigned long start, unsigned long len); |
H Hartley Sweeten | f375ac5 | 2013-04-09 16:05:54 -0700 | [diff] [blame] | 371 | int comedi_request_region(struct comedi_device *, |
| 372 | unsigned long start, unsigned long len); |
H Hartley Sweeten | 316f97f | 2013-04-18 14:31:29 -0700 | [diff] [blame] | 373 | void comedi_legacy_detach(struct comedi_device *); |
H Hartley Sweeten | f375ac5 | 2013-04-09 16:05:54 -0700 | [diff] [blame] | 374 | |
H Hartley Sweeten | 1ae6b20 | 2013-01-30 15:24:38 -0700 | [diff] [blame] | 375 | int comedi_auto_config(struct device *, struct comedi_driver *, |
| 376 | unsigned long context); |
| 377 | void comedi_auto_unconfig(struct device *); |
| 378 | |
| 379 | int comedi_driver_register(struct comedi_driver *); |
| 380 | int comedi_driver_unregister(struct comedi_driver *); |
| 381 | |
| 382 | /** |
| 383 | * module_comedi_driver() - Helper macro for registering a comedi driver |
| 384 | * @__comedi_driver: comedi_driver struct |
| 385 | * |
| 386 | * Helper macro for comedi drivers which do not do anything special in module |
| 387 | * init/exit. This eliminates a lot of boilerplate. Each module may only use |
| 388 | * this macro once, and calling it replaces module_init() and module_exit(). |
| 389 | */ |
| 390 | #define module_comedi_driver(__comedi_driver) \ |
| 391 | module_driver(__comedi_driver, comedi_driver_register, \ |
| 392 | comedi_driver_unregister) |
Ian Abbott | 581a7dd | 2012-11-14 13:10:40 +0000 | [diff] [blame] | 393 | |
H Hartley Sweeten | 33782dd | 2013-01-30 15:22:21 -0700 | [diff] [blame] | 394 | #ifdef CONFIG_COMEDI_PCI_DRIVERS |
| 395 | |
| 396 | /* comedi_pci.c - comedi PCI driver specific functions */ |
| 397 | |
| 398 | /* |
| 399 | * PCI Vendor IDs not in <linux/pci_ids.h> |
| 400 | */ |
| 401 | #define PCI_VENDOR_ID_KOLTER 0x1001 |
| 402 | #define PCI_VENDOR_ID_ICP 0x104c |
| 403 | #define PCI_VENDOR_ID_AMCC 0x10e8 |
| 404 | #define PCI_VENDOR_ID_DT 0x1116 |
| 405 | #define PCI_VENDOR_ID_IOTECH 0x1616 |
| 406 | #define PCI_VENDOR_ID_CONTEC 0x1221 |
H Hartley Sweeten | 33782dd | 2013-01-30 15:22:21 -0700 | [diff] [blame] | 407 | #define PCI_VENDOR_ID_RTD 0x1435 |
H Hartley Sweeten | 33782dd | 2013-01-30 15:22:21 -0700 | [diff] [blame] | 408 | |
| 409 | struct pci_dev; |
| 410 | struct pci_driver; |
| 411 | |
| 412 | struct pci_dev *comedi_to_pci_dev(struct comedi_device *); |
| 413 | |
H Hartley Sweeten | 818f569 | 2013-03-13 10:36:31 -0700 | [diff] [blame] | 414 | int comedi_pci_enable(struct comedi_device *); |
H Hartley Sweeten | 7f072f5 | 2013-03-13 10:35:51 -0700 | [diff] [blame] | 415 | void comedi_pci_disable(struct comedi_device *); |
H Hartley Sweeten | 33782dd | 2013-01-30 15:22:21 -0700 | [diff] [blame] | 416 | |
H Hartley Sweeten | b8f4ac2 | 2013-03-05 09:53:41 -0700 | [diff] [blame] | 417 | int comedi_pci_auto_config(struct pci_dev *, struct comedi_driver *, |
| 418 | unsigned long context); |
H Hartley Sweeten | 33782dd | 2013-01-30 15:22:21 -0700 | [diff] [blame] | 419 | void comedi_pci_auto_unconfig(struct pci_dev *); |
| 420 | |
| 421 | int comedi_pci_driver_register(struct comedi_driver *, struct pci_driver *); |
| 422 | void comedi_pci_driver_unregister(struct comedi_driver *, struct pci_driver *); |
| 423 | |
| 424 | /** |
| 425 | * module_comedi_pci_driver() - Helper macro for registering a comedi PCI driver |
| 426 | * @__comedi_driver: comedi_driver struct |
| 427 | * @__pci_driver: pci_driver struct |
| 428 | * |
| 429 | * Helper macro for comedi PCI drivers which do not do anything special |
| 430 | * in module init/exit. This eliminates a lot of boilerplate. Each |
| 431 | * module may only use this macro once, and calling it replaces |
| 432 | * module_init() and module_exit() |
| 433 | */ |
| 434 | #define module_comedi_pci_driver(__comedi_driver, __pci_driver) \ |
| 435 | module_driver(__comedi_driver, comedi_pci_driver_register, \ |
| 436 | comedi_pci_driver_unregister, &(__pci_driver)) |
| 437 | |
| 438 | #else |
| 439 | |
| 440 | /* |
| 441 | * Some of the comedi mixed ISA/PCI drivers call the PCI specific |
| 442 | * functions. Provide some dummy functions if CONFIG_COMEDI_PCI_DRIVERS |
| 443 | * is not enabled. |
| 444 | */ |
| 445 | |
| 446 | static inline struct pci_dev *comedi_to_pci_dev(struct comedi_device *dev) |
Ian Abbott | 581a7dd | 2012-11-14 13:10:40 +0000 | [diff] [blame] | 447 | { |
H Hartley Sweeten | 33782dd | 2013-01-30 15:22:21 -0700 | [diff] [blame] | 448 | return NULL; |
Ian Abbott | 581a7dd | 2012-11-14 13:10:40 +0000 | [diff] [blame] | 449 | } |
| 450 | |
H Hartley Sweeten | 818f569 | 2013-03-13 10:36:31 -0700 | [diff] [blame] | 451 | static inline int comedi_pci_enable(struct comedi_device *dev) |
H Hartley Sweeten | 33782dd | 2013-01-30 15:22:21 -0700 | [diff] [blame] | 452 | { |
| 453 | return -ENOSYS; |
| 454 | } |
| 455 | |
H Hartley Sweeten | 7f072f5 | 2013-03-13 10:35:51 -0700 | [diff] [blame] | 456 | static inline void comedi_pci_disable(struct comedi_device *dev) |
H Hartley Sweeten | 33782dd | 2013-01-30 15:22:21 -0700 | [diff] [blame] | 457 | { |
| 458 | } |
| 459 | |
| 460 | #endif /* CONFIG_COMEDI_PCI_DRIVERS */ |
Ian Abbott | 581a7dd | 2012-11-14 13:10:40 +0000 | [diff] [blame] | 461 | |
H Hartley Sweeten | 309231d | 2013-01-30 15:22:44 -0700 | [diff] [blame] | 462 | #ifdef CONFIG_COMEDI_PCMCIA_DRIVERS |
| 463 | |
| 464 | /* comedi_pcmcia.c - comedi PCMCIA driver specific functions */ |
| 465 | |
| 466 | struct pcmcia_driver; |
H Hartley Sweeten | 1f021e1f | 2013-01-30 15:23:06 -0700 | [diff] [blame] | 467 | struct pcmcia_device; |
| 468 | |
| 469 | struct pcmcia_device *comedi_to_pcmcia_dev(struct comedi_device *); |
| 470 | |
H Hartley Sweeten | a3ac951 | 2013-02-05 18:16:07 -0700 | [diff] [blame] | 471 | int comedi_pcmcia_enable(struct comedi_device *, |
| 472 | int (*conf_check)(struct pcmcia_device *, void *)); |
H Hartley Sweeten | ddb2d0a | 2013-02-04 14:19:35 -0700 | [diff] [blame] | 473 | void comedi_pcmcia_disable(struct comedi_device *); |
| 474 | |
H Hartley Sweeten | 1f021e1f | 2013-01-30 15:23:06 -0700 | [diff] [blame] | 475 | int comedi_pcmcia_auto_config(struct pcmcia_device *, struct comedi_driver *); |
| 476 | void comedi_pcmcia_auto_unconfig(struct pcmcia_device *); |
H Hartley Sweeten | 309231d | 2013-01-30 15:22:44 -0700 | [diff] [blame] | 477 | |
| 478 | int comedi_pcmcia_driver_register(struct comedi_driver *, |
| 479 | struct pcmcia_driver *); |
| 480 | void comedi_pcmcia_driver_unregister(struct comedi_driver *, |
| 481 | struct pcmcia_driver *); |
| 482 | |
| 483 | /** |
| 484 | * module_comedi_pcmcia_driver() - Helper macro for registering a comedi PCMCIA driver |
| 485 | * @__comedi_driver: comedi_driver struct |
| 486 | * @__pcmcia_driver: pcmcia_driver struct |
| 487 | * |
| 488 | * Helper macro for comedi PCMCIA drivers which do not do anything special |
| 489 | * in module init/exit. This eliminates a lot of boilerplate. Each |
| 490 | * module may only use this macro once, and calling it replaces |
| 491 | * module_init() and module_exit() |
| 492 | */ |
| 493 | #define module_comedi_pcmcia_driver(__comedi_driver, __pcmcia_driver) \ |
| 494 | module_driver(__comedi_driver, comedi_pcmcia_driver_register, \ |
| 495 | comedi_pcmcia_driver_unregister, &(__pcmcia_driver)) |
| 496 | |
| 497 | #endif /* CONFIG_COMEDI_PCMCIA_DRIVERS */ |
| 498 | |
H Hartley Sweeten | abac8b5 | 2013-01-30 15:21:49 -0700 | [diff] [blame] | 499 | #ifdef CONFIG_COMEDI_USB_DRIVERS |
Ian Abbott | 581a7dd | 2012-11-14 13:10:40 +0000 | [diff] [blame] | 500 | |
H Hartley Sweeten | abac8b5 | 2013-01-30 15:21:49 -0700 | [diff] [blame] | 501 | /* comedi_usb.c - comedi USB driver specific functions */ |
| 502 | |
| 503 | struct usb_driver; |
| 504 | struct usb_interface; |
| 505 | |
| 506 | struct usb_interface *comedi_to_usb_interface(struct comedi_device *); |
H Hartley Sweeten | 61dd149 | 2013-05-20 14:20:02 -0700 | [diff] [blame] | 507 | struct usb_device *comedi_to_usb_dev(struct comedi_device *); |
H Hartley Sweeten | abac8b5 | 2013-01-30 15:21:49 -0700 | [diff] [blame] | 508 | |
H Hartley Sweeten | 55ab4f6 | 2013-02-05 17:23:40 -0700 | [diff] [blame] | 509 | int comedi_usb_auto_config(struct usb_interface *, struct comedi_driver *, |
| 510 | unsigned long context); |
H Hartley Sweeten | abac8b5 | 2013-01-30 15:21:49 -0700 | [diff] [blame] | 511 | void comedi_usb_auto_unconfig(struct usb_interface *); |
| 512 | |
| 513 | int comedi_usb_driver_register(struct comedi_driver *, struct usb_driver *); |
| 514 | void comedi_usb_driver_unregister(struct comedi_driver *, struct usb_driver *); |
| 515 | |
| 516 | /** |
| 517 | * module_comedi_usb_driver() - Helper macro for registering a comedi USB driver |
| 518 | * @__comedi_driver: comedi_driver struct |
| 519 | * @__usb_driver: usb_driver struct |
| 520 | * |
| 521 | * Helper macro for comedi USB drivers which do not do anything special |
| 522 | * in module init/exit. This eliminates a lot of boilerplate. Each |
| 523 | * module may only use this macro once, and calling it replaces |
| 524 | * module_init() and module_exit() |
| 525 | */ |
| 526 | #define module_comedi_usb_driver(__comedi_driver, __usb_driver) \ |
| 527 | module_driver(__comedi_driver, comedi_usb_driver_register, \ |
| 528 | comedi_usb_driver_unregister, &(__usb_driver)) |
| 529 | |
| 530 | #endif /* CONFIG_COMEDI_USB_DRIVERS */ |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 531 | |
David Schleef | ed9eccb | 2008-11-04 20:29:31 -0800 | [diff] [blame] | 532 | #endif /* _COMEDIDEV_H */ |