Merge from vendor branch BZIP:
[dragonfly.git] / sys / sys / mapped_ioctl.h
1 /*
2  * Copyright (c) 2004, 2005 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Simon 'corecode' Schubert <corecode@fs.ei.tum.de>.
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  * 
34  * $DragonFly: src/sys/sys/mapped_ioctl.h,v 1.2 2005/03/01 00:43:02 corecode Exp $
35  */
36 #ifndef _SYS_MAPPED_IOCTL_H_
37 #define _SYS_MAPPED_IOCTL_H_
38
39 #include <sys/queue.h>
40
41 struct file;
42 struct thread;
43 struct ioctl_map_entry;
44
45 typedef int     (ioctl_wrap_func)(struct file *, u_long, u_long, caddr_t,
46                                  struct thread *);
47 typedef u_long  (ioctl_map_func)(u_long, u_long, u_long, u_long, u_long, u_long);
48
49 struct ioctl_map_range {
50         u_long          start;          /* Start of source range; inclusive */
51         u_long          end;            /* End of source range; inclusive */
52         u_long          maptocmd;       /* Start of destination range */
53         u_long          maptoend;       /* End of destination range */
54         ioctl_wrap_func *wrapfunc;      /* Ioctl handler to use */
55         ioctl_map_func  *mapfunc;       /* Handler to map source to dest */
56 };
57
58 #define MAPPED_IOCTL_MAPRANGE(c,e,t,r,f,m)      { (c), (e), (t), (r), (f), (m) }
59 #define MAPPED_IOCTL_MAPF(c,t,f)                MAPPED_IOCTL_MAPRANGE((c), (c), (t), (t), (f), NULL)
60 #define MAPPED_IOCTL_MAP(c,t)                   MAPPED_IOCTL_MAPF((c), (t), NULL)
61 #define MAPPED_IOCTL_IO(c,f)                    MAPPED_IOCTL_MAPF((c), _IO(0, 0), (f))
62 #define MAPPED_IOCTL_IOR(c,f,t)                 MAPPED_IOCTL_MAPF((c), _IOR(0, 0, t), (f))
63 #define MAPPED_IOCTL_IOW(c,f,t)                 MAPPED_IOCTL_MAPF((c), _IOW(0, 0, t), (f))
64 #define MAPPED_IOCTL_IOWR(c,f,t)                MAPPED_IOCTL_MAPF((c), _IOWR(0, 0, t), (f))
65
66 struct ioctl_map {
67         u_long mask;
68         const char *sys;
69         LIST_HEAD(, ioctl_map_entry) mapping;
70 };
71
72 struct ioctl_map_handler {
73         struct ioctl_map        *map;
74         const char              *subsys;
75         struct ioctl_map_range  *cmd_ranges;
76 };
77
78 int mapped_ioctl(int fd, u_long com, caddr_t uspc_data, struct ioctl_map *map);
79 int mapped_ioctl_register_handler(struct ioctl_map_handler *he);
80 int mapped_ioctl_unregister_handler(struct ioctl_map_handler *he);
81
82 #endif /* !_SYS_MAPPED_IOCTL_H_ */