2 comedi/comedi_compat32.c
3 32-bit ioctl compatibility for 64-bit comedi kernel module.
5 Author: Ian Abbott, MEV Ltd. <abbotti@mev.co.uk>
6 Copyright (C) 2007 MEV Ltd. <http://www.mev.co.uk/>
8 COMEDI - Linux Control and Measurement Device Interface
9 Copyright (C) 1997-2007 David A. Schleef <ds@schleef.org>
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #define __NO_VERSION__
29 #include <linux/smp_lock.h>
30 #include <asm/uaccess.h>
32 #include "comedi_compat32.h"
36 #ifndef HAVE_COMPAT_IOCTL
37 #include <linux/ioctl32.h> /* for (un)register_ioctl32_conversion */
40 #define COMEDI32_CHANINFO _IOR(CIO, 3, struct comedi32_chaninfo_struct)
41 #define COMEDI32_RANGEINFO _IOR(CIO, 8, struct comedi32_rangeinfo_struct)
42 /* N.B. COMEDI32_CMD and COMEDI_CMD ought to use _IOWR, not _IOR.
43 * It's too late to change it now, but it only affects the command number. */
44 #define COMEDI32_CMD _IOR(CIO, 9, struct comedi32_cmd_struct)
45 /* N.B. COMEDI32_CMDTEST and COMEDI_CMDTEST ought to use _IOWR, not _IOR.
46 * It's too late to change it now, but it only affects the command number. */
47 #define COMEDI32_CMDTEST _IOR(CIO, 10, struct comedi32_cmd_struct)
48 #define COMEDI32_INSNLIST _IOR(CIO, 11, struct comedi32_insnlist_struct)
49 #define COMEDI32_INSN _IOR(CIO, 12, struct comedi32_insn_struct)
51 struct comedi32_chaninfo_struct
{
53 compat_uptr_t maxdata_list
; /* 32-bit 'unsigned int *' */
54 compat_uptr_t flaglist
; /* 32-bit 'unsigned int *' */
55 compat_uptr_t rangelist
; /* 32-bit 'unsigned int *' */
56 unsigned int unused
[4];
59 struct comedi32_rangeinfo_struct
{
60 unsigned int range_type
;
61 compat_uptr_t range_ptr
; /* 32-bit 'void *' */
64 struct comedi32_cmd_struct
{
67 unsigned int start_src
;
68 unsigned int start_arg
;
69 unsigned int scan_begin_src
;
70 unsigned int scan_begin_arg
;
71 unsigned int convert_src
;
72 unsigned int convert_arg
;
73 unsigned int scan_end_src
;
74 unsigned int scan_end_arg
;
75 unsigned int stop_src
;
76 unsigned int stop_arg
;
77 compat_uptr_t chanlist
; /* 32-bit 'unsigned int *' */
78 unsigned int chanlist_len
;
79 compat_uptr_t data
; /* 32-bit 'short *' */
80 unsigned int data_len
;
83 struct comedi32_insn_struct
{
86 compat_uptr_t data
; /* 32-bit 'unsigned int *' */
88 unsigned int chanspec
;
89 unsigned int unused
[3];
92 struct comedi32_insnlist_struct
{
94 compat_uptr_t insns
; /* 32-bit 'struct comedi_insn *' */
97 /* Handle translated ioctl. */
98 static int translated_ioctl(struct file
*file
, unsigned int cmd
,
104 #ifdef HAVE_UNLOCKED_IOCTL
105 if (file
->f_op
->unlocked_ioctl
) {
106 int rc
= (int)(*file
->f_op
->unlocked_ioctl
) (file
, cmd
, arg
);
107 if (rc
== -ENOIOCTLCMD
)
112 if (file
->f_op
->ioctl
) {
115 rc
= (*file
->f_op
->ioctl
) (file
->f_dentry
->d_inode
,
123 /* Handle 32-bit COMEDI_CHANINFO ioctl. */
124 static int compat_chaninfo(struct file
*file
, unsigned long arg
)
126 struct comedi_chaninfo __user
*chaninfo
;
127 struct comedi32_chaninfo_struct __user
*chaninfo32
;
134 chaninfo32
= compat_ptr(arg
);
135 chaninfo
= compat_alloc_user_space(sizeof(*chaninfo
));
137 /* Copy chaninfo structure. Ignore unused members. */
138 if (!access_ok(VERIFY_READ
, chaninfo32
, sizeof(*chaninfo32
))
139 || !access_ok(VERIFY_WRITE
, chaninfo
, sizeof(*chaninfo
))) {
143 err
|= __get_user(temp
.uint
, &chaninfo32
->subdev
);
144 err
|= __put_user(temp
.uint
, &chaninfo
->subdev
);
145 err
|= __get_user(temp
.uptr
, &chaninfo32
->maxdata_list
);
146 err
|= __put_user(compat_ptr(temp
.uptr
), &chaninfo
->maxdata_list
);
147 err
|= __get_user(temp
.uptr
, &chaninfo32
->flaglist
);
148 err
|= __put_user(compat_ptr(temp
.uptr
), &chaninfo
->flaglist
);
149 err
|= __get_user(temp
.uptr
, &chaninfo32
->rangelist
);
150 err
|= __put_user(compat_ptr(temp
.uptr
), &chaninfo
->rangelist
);
154 return translated_ioctl(file
, COMEDI_CHANINFO
, (unsigned long)chaninfo
);
157 /* Handle 32-bit COMEDI_RANGEINFO ioctl. */
158 static int compat_rangeinfo(struct file
*file
, unsigned long arg
)
160 struct comedi_rangeinfo __user
*rangeinfo
;
161 struct comedi32_rangeinfo_struct __user
*rangeinfo32
;
168 rangeinfo32
= compat_ptr(arg
);
169 rangeinfo
= compat_alloc_user_space(sizeof(*rangeinfo
));
171 /* Copy rangeinfo structure. */
172 if (!access_ok(VERIFY_READ
, rangeinfo32
, sizeof(*rangeinfo32
))
173 || !access_ok(VERIFY_WRITE
, rangeinfo
, sizeof(*rangeinfo
))) {
177 err
|= __get_user(temp
.uint
, &rangeinfo32
->range_type
);
178 err
|= __put_user(temp
.uint
, &rangeinfo
->range_type
);
179 err
|= __get_user(temp
.uptr
, &rangeinfo32
->range_ptr
);
180 err
|= __put_user(compat_ptr(temp
.uptr
), &rangeinfo
->range_ptr
);
184 return translated_ioctl(file
, COMEDI_RANGEINFO
,
185 (unsigned long)rangeinfo
);
188 /* Copy 32-bit cmd structure to native cmd structure. */
189 static int get_compat_cmd(struct comedi_cmd __user
* cmd
,
190 struct comedi32_cmd_struct __user
* cmd32
)
198 /* Copy cmd structure. */
199 if (!access_ok(VERIFY_READ
, cmd32
, sizeof(*cmd32
))
200 || !access_ok(VERIFY_WRITE
, cmd
, sizeof(*cmd
))) {
204 err
|= __get_user(temp
.uint
, &cmd32
->subdev
);
205 err
|= __put_user(temp
.uint
, &cmd
->subdev
);
206 err
|= __get_user(temp
.uint
, &cmd32
->flags
);
207 err
|= __put_user(temp
.uint
, &cmd
->flags
);
208 err
|= __get_user(temp
.uint
, &cmd32
->start_src
);
209 err
|= __put_user(temp
.uint
, &cmd
->start_src
);
210 err
|= __get_user(temp
.uint
, &cmd32
->start_arg
);
211 err
|= __put_user(temp
.uint
, &cmd
->start_arg
);
212 err
|= __get_user(temp
.uint
, &cmd32
->scan_begin_src
);
213 err
|= __put_user(temp
.uint
, &cmd
->scan_begin_src
);
214 err
|= __get_user(temp
.uint
, &cmd32
->scan_begin_arg
);
215 err
|= __put_user(temp
.uint
, &cmd
->scan_begin_arg
);
216 err
|= __get_user(temp
.uint
, &cmd32
->convert_src
);
217 err
|= __put_user(temp
.uint
, &cmd
->convert_src
);
218 err
|= __get_user(temp
.uint
, &cmd32
->convert_arg
);
219 err
|= __put_user(temp
.uint
, &cmd
->convert_arg
);
220 err
|= __get_user(temp
.uint
, &cmd32
->scan_end_src
);
221 err
|= __put_user(temp
.uint
, &cmd
->scan_end_src
);
222 err
|= __get_user(temp
.uint
, &cmd32
->scan_end_arg
);
223 err
|= __put_user(temp
.uint
, &cmd
->scan_end_arg
);
224 err
|= __get_user(temp
.uint
, &cmd32
->stop_src
);
225 err
|= __put_user(temp
.uint
, &cmd
->stop_src
);
226 err
|= __get_user(temp
.uint
, &cmd32
->stop_arg
);
227 err
|= __put_user(temp
.uint
, &cmd
->stop_arg
);
228 err
|= __get_user(temp
.uptr
, &cmd32
->chanlist
);
229 err
|= __put_user(compat_ptr(temp
.uptr
), &cmd
->chanlist
);
230 err
|= __get_user(temp
.uint
, &cmd32
->chanlist_len
);
231 err
|= __put_user(temp
.uint
, &cmd
->chanlist_len
);
232 err
|= __get_user(temp
.uptr
, &cmd32
->data
);
233 err
|= __put_user(compat_ptr(temp
.uptr
), &cmd
->data
);
234 err
|= __get_user(temp
.uint
, &cmd32
->data_len
);
235 err
|= __put_user(temp
.uint
, &cmd
->data_len
);
236 return err
? -EFAULT
: 0;
239 /* Copy native cmd structure to 32-bit cmd structure. */
240 static int put_compat_cmd(struct comedi32_cmd_struct __user
* cmd32
,
241 struct comedi_cmd __user
* cmd
)
246 /* Copy back most of cmd structure. */
247 /* Assume the pointer values are already valid. */
248 /* (Could use ptr_to_compat() to set them, but that wasn't implemented
249 * until kernel version 2.6.11.) */
250 if (!access_ok(VERIFY_READ
, cmd
, sizeof(*cmd
))
251 || !access_ok(VERIFY_WRITE
, cmd32
, sizeof(*cmd32
))) {
255 err
|= __get_user(temp
, &cmd
->subdev
);
256 err
|= __put_user(temp
, &cmd32
->subdev
);
257 err
|= __get_user(temp
, &cmd
->flags
);
258 err
|= __put_user(temp
, &cmd32
->flags
);
259 err
|= __get_user(temp
, &cmd
->start_src
);
260 err
|= __put_user(temp
, &cmd32
->start_src
);
261 err
|= __get_user(temp
, &cmd
->start_arg
);
262 err
|= __put_user(temp
, &cmd32
->start_arg
);
263 err
|= __get_user(temp
, &cmd
->scan_begin_src
);
264 err
|= __put_user(temp
, &cmd32
->scan_begin_src
);
265 err
|= __get_user(temp
, &cmd
->scan_begin_arg
);
266 err
|= __put_user(temp
, &cmd32
->scan_begin_arg
);
267 err
|= __get_user(temp
, &cmd
->convert_src
);
268 err
|= __put_user(temp
, &cmd32
->convert_src
);
269 err
|= __get_user(temp
, &cmd
->convert_arg
);
270 err
|= __put_user(temp
, &cmd32
->convert_arg
);
271 err
|= __get_user(temp
, &cmd
->scan_end_src
);
272 err
|= __put_user(temp
, &cmd32
->scan_end_src
);
273 err
|= __get_user(temp
, &cmd
->scan_end_arg
);
274 err
|= __put_user(temp
, &cmd32
->scan_end_arg
);
275 err
|= __get_user(temp
, &cmd
->stop_src
);
276 err
|= __put_user(temp
, &cmd32
->stop_src
);
277 err
|= __get_user(temp
, &cmd
->stop_arg
);
278 err
|= __put_user(temp
, &cmd32
->stop_arg
);
279 /* Assume chanlist pointer is unchanged. */
280 err
|= __get_user(temp
, &cmd
->chanlist_len
);
281 err
|= __put_user(temp
, &cmd32
->chanlist_len
);
282 /* Assume data pointer is unchanged. */
283 err
|= __get_user(temp
, &cmd
->data_len
);
284 err
|= __put_user(temp
, &cmd32
->data_len
);
285 return err
? -EFAULT
: 0;
288 /* Handle 32-bit COMEDI_CMD ioctl. */
289 static int compat_cmd(struct file
*file
, unsigned long arg
)
291 struct comedi_cmd __user
*cmd
;
292 struct comedi32_cmd_struct __user
*cmd32
;
295 cmd32
= compat_ptr(arg
);
296 cmd
= compat_alloc_user_space(sizeof(*cmd
));
298 rc
= get_compat_cmd(cmd
, cmd32
);
302 return translated_ioctl(file
, COMEDI_CMD
, (unsigned long)cmd
);
305 /* Handle 32-bit COMEDI_CMDTEST ioctl. */
306 static int compat_cmdtest(struct file
*file
, unsigned long arg
)
308 struct comedi_cmd __user
*cmd
;
309 struct comedi32_cmd_struct __user
*cmd32
;
312 cmd32
= compat_ptr(arg
);
313 cmd
= compat_alloc_user_space(sizeof(*cmd
));
315 rc
= get_compat_cmd(cmd
, cmd32
);
319 rc
= translated_ioctl(file
, COMEDI_CMDTEST
, (unsigned long)cmd
);
323 err
= put_compat_cmd(cmd32
, cmd
);
330 /* Copy 32-bit insn structure to native insn structure. */
331 static int get_compat_insn(struct comedi_insn __user
* insn
,
332 struct comedi32_insn_struct __user
* insn32
)
340 /* Copy insn structure. Ignore the unused members. */
342 if (!access_ok(VERIFY_READ
, insn32
, sizeof(*insn32
))
343 || !access_ok(VERIFY_WRITE
, insn
, sizeof(*insn
)))
346 err
|= __get_user(temp
.uint
, &insn32
->insn
);
347 err
|= __put_user(temp
.uint
, &insn
->insn
);
348 err
|= __get_user(temp
.uint
, &insn32
->n
);
349 err
|= __put_user(temp
.uint
, &insn
->n
);
350 err
|= __get_user(temp
.uptr
, &insn32
->data
);
351 err
|= __put_user(compat_ptr(temp
.uptr
), &insn
->data
);
352 err
|= __get_user(temp
.uint
, &insn32
->subdev
);
353 err
|= __put_user(temp
.uint
, &insn
->subdev
);
354 err
|= __get_user(temp
.uint
, &insn32
->chanspec
);
355 err
|= __put_user(temp
.uint
, &insn
->chanspec
);
356 return err
? -EFAULT
: 0;
359 /* Handle 32-bit COMEDI_INSNLIST ioctl. */
360 static int compat_insnlist(struct file
*file
, unsigned long arg
)
362 struct combined_insnlist
{
363 struct comedi_insnlist insnlist
;
364 struct comedi_insn insn
[1];
366 struct comedi32_insnlist_struct __user
*insnlist32
;
367 struct comedi32_insn_struct __user
*insn32
;
369 unsigned int n_insns
, n
;
372 insnlist32
= compat_ptr(arg
);
374 /* Get 32-bit insnlist structure. */
375 if (!access_ok(VERIFY_READ
, insnlist32
, sizeof(*insnlist32
))) {
379 err
|= __get_user(n_insns
, &insnlist32
->n_insns
);
380 err
|= __get_user(uptr
, &insnlist32
->insns
);
381 insn32
= compat_ptr(uptr
);
385 /* Allocate user memory to copy insnlist and insns into. */
386 s
= compat_alloc_user_space(offsetof(struct combined_insnlist
,
389 /* Set native insnlist structure. */
390 if (!access_ok(VERIFY_WRITE
, &s
->insnlist
, sizeof(s
->insnlist
))) {
393 err
|= __put_user(n_insns
, &s
->insnlist
.n_insns
);
394 err
|= __put_user(&s
->insn
[0], &s
->insnlist
.insns
);
398 /* Copy insn structures. */
399 for (n
= 0; n
< n_insns
; n
++) {
400 rc
= get_compat_insn(&s
->insn
[n
], &insn32
[n
]);
405 return translated_ioctl(file
, COMEDI_INSNLIST
,
406 (unsigned long)&s
->insnlist
);
409 /* Handle 32-bit COMEDI_INSN ioctl. */
410 static int compat_insn(struct file
*file
, unsigned long arg
)
412 struct comedi_insn __user
*insn
;
413 struct comedi32_insn_struct __user
*insn32
;
416 insn32
= compat_ptr(arg
);
417 insn
= compat_alloc_user_space(sizeof(*insn
));
419 rc
= get_compat_insn(insn
, insn32
);
423 return translated_ioctl(file
, COMEDI_INSN
, (unsigned long)insn
);
426 /* Process untranslated ioctl. */
427 /* Returns -ENOIOCTLCMD for unrecognised ioctl codes. */
428 static inline int raw_ioctl(struct file
*file
, unsigned int cmd
,
434 case COMEDI_DEVCONFIG
:
436 case COMEDI_SUBDINFO
:
437 case COMEDI_BUFCONFIG
:
439 /* Just need to translate the pointer argument. */
440 arg
= (unsigned long)compat_ptr(arg
);
441 rc
= translated_ioctl(file
, cmd
, arg
);
447 /* No translation needed. */
448 rc
= translated_ioctl(file
, cmd
, arg
);
450 case COMEDI32_CHANINFO
:
451 rc
= compat_chaninfo(file
, arg
);
453 case COMEDI32_RANGEINFO
:
454 rc
= compat_rangeinfo(file
, arg
);
457 rc
= compat_cmd(file
, arg
);
459 case COMEDI32_CMDTEST
:
460 rc
= compat_cmdtest(file
, arg
);
462 case COMEDI32_INSNLIST
:
463 rc
= compat_insnlist(file
, arg
);
466 rc
= compat_insn(file
, arg
);
475 #ifdef HAVE_COMPAT_IOCTL /* defined in <linux/fs.h> 2.6.11 onwards */
477 /* compat_ioctl file operation. */
478 /* Returns -ENOIOCTLCMD for unrecognised ioctl codes. */
479 long comedi_compat_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
481 return raw_ioctl(file
, cmd
, arg
);
484 #else /* HAVE_COMPAT_IOCTL */
487 * Brain-dead ioctl compatibility for 2.6.10 and earlier.
489 * It's brain-dead because cmd numbers need to be unique system-wide!
490 * The comedi driver could end up attempting to execute ioctls for non-Comedi
491 * devices because it registered the system-wide cmd code first. Similarly,
492 * another driver could end up attempting to execute ioctls for a Comedi
493 * device because it registered the cmd code first. Chaos ensues.
496 /* Handler for all 32-bit ioctl codes registered by this driver. */
497 static int mapped_ioctl(unsigned int fd
, unsigned int cmd
, unsigned long arg
,
502 /* Make sure we are dealing with a Comedi device. */
503 if (imajor(file
->f_dentry
->d_inode
) != COMEDI_MAJOR
)
506 rc
= raw_ioctl(file
, cmd
, arg
);
507 /* Do not return -ENOIOCTLCMD. */
508 if (rc
== -ENOIOCTLCMD
)
516 int (*handler
) (unsigned int, unsigned int, unsigned long,
521 static struct ioctl32_map comedi_ioctl32_map
[] = {
522 {COMEDI_DEVCONFIG
, mapped_ioctl
, 0},
523 {COMEDI_DEVINFO
, mapped_ioctl
, 0},
524 {COMEDI_SUBDINFO
, mapped_ioctl
, 0},
525 {COMEDI_BUFCONFIG
, mapped_ioctl
, 0},
526 {COMEDI_BUFINFO
, mapped_ioctl
, 0},
527 {COMEDI_LOCK
, mapped_ioctl
, 0},
528 {COMEDI_UNLOCK
, mapped_ioctl
, 0},
529 {COMEDI_CANCEL
, mapped_ioctl
, 0},
530 {COMEDI_POLL
, mapped_ioctl
, 0},
531 {COMEDI32_CHANINFO
, mapped_ioctl
, 0},
532 {COMEDI32_RANGEINFO
, mapped_ioctl
, 0},
533 {COMEDI32_CMD
, mapped_ioctl
, 0},
534 {COMEDI32_CMDTEST
, mapped_ioctl
, 0},
535 {COMEDI32_INSNLIST
, mapped_ioctl
, 0},
536 {COMEDI32_INSN
, mapped_ioctl
, 0},
539 #define NUM_IOCTL32_MAPS ARRAY_SIZE(comedi_ioctl32_map)
541 /* Register system-wide 32-bit ioctl handlers. */
542 void comedi_register_ioctl32(void)
546 for (n
= 0; n
< NUM_IOCTL32_MAPS
; n
++) {
547 rc
= register_ioctl32_conversion(comedi_ioctl32_map
[n
].cmd
,
548 comedi_ioctl32_map
[n
].handler
);
551 "comedi: failed to register 32-bit "
552 "compatible ioctl handler for 0x%X - "
553 "expect bad things to happen!\n",
554 comedi_ioctl32_map
[n
].cmd
);
556 comedi_ioctl32_map
[n
].registered
= !rc
;
560 /* Unregister system-wide 32-bit ioctl translations. */
561 void comedi_unregister_ioctl32(void)
565 for (n
= 0; n
< NUM_IOCTL32_MAPS
; n
++) {
566 if (comedi_ioctl32_map
[n
].registered
) {
567 rc
= unregister_ioctl32_conversion(comedi_ioctl32_map
573 "comedi: failed to unregister 32-bit "
574 "compatible ioctl handler for 0x%X - "
575 "expect kernel Oops!\n",
576 comedi_ioctl32_map
[n
].cmd
);
578 comedi_ioctl32_map
[n
].registered
= 0;
584 #endif /* HAVE_COMPAT_IOCTL */
586 #endif /* CONFIG_COMPAT */