devfs - Change make_dev_covering to use dev_ops
[dragonfly.git] / sys / sys / device.h
CommitLineData
335dda38 1/*
0e9b9130 2 * Copyright (c) 2003,2004,2007 The DragonFly Project. All rights reserved.
07dfa375 3 *
8c10bfcf
MD
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
07dfa375 6 *
335dda38
MD
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
07dfa375 10 *
335dda38
MD
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
8c10bfcf
MD
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.
07dfa375 20 *
8c10bfcf
MD
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
335dda38 32 * SUCH DAMAGE.
07dfa375 33 *
ca464209 34 * $DragonFly: src/sys/sys/device.h,v 1.11 2007/05/17 03:02:00 dillon Exp $
335dda38
MD
35 */
36
37#ifndef _SYS_DEVICE_H_
38#define _SYS_DEVICE_H_
39
1bd40720
MD
40#ifndef _SYS_TYPES_H_
41#include <sys/types.h>
42#endif
0e9b9130
MD
43#ifndef _SYS_TREE_H_
44#include <sys/tree.h>
45#endif
a3d02589
MD
46#ifndef _SYS_SYSLINK_RPC_H_
47#include <sys/syslink_rpc.h>
335dda38
MD
48#endif
49
b13267a5 50struct cdev;
cd29885a 51struct ucred;
b96f3782 52struct devfs_bitmap;
b13267a5 53
335dda38 54/*
fef8985e 55 * This structure is at the base of every device args structure
335dda38 56 */
fef8985e
MD
57struct dev_generic_args {
58 struct syslink_desc *a_desc;
b13267a5 59 struct cdev *a_dev;
335dda38
MD
60};
61
fef8985e
MD
62typedef struct dev_generic_args dev_default_args;
63
335dda38 64/*
b13267a5 65 * int d_open(cdev_t dev, int oflags, int devtype, struct ucred *cred)
335dda38 66 */
fef8985e
MD
67struct dev_open_args {
68 struct dev_generic_args a_head;
69 int a_oflags;
70 int a_devtype;
71 struct ucred *a_cred;
335dda38
MD
72};
73
74/*
b13267a5 75 * int d_close(cdev_t dev, int fflag, int devtype)
335dda38 76 */
fef8985e
MD
77struct dev_close_args {
78 struct dev_generic_args a_head;
79 int a_fflag;
80 int a_devtype;
335dda38
MD
81};
82
83/*
b13267a5 84 * int d_read(cdev_t dev, struct uio *uio, int ioflag)
335dda38 85 */
fef8985e
MD
86struct dev_read_args {
87 struct dev_generic_args a_head;
88 struct uio *a_uio;
89 int a_ioflag;
335dda38
MD
90};
91
92/*
b13267a5 93 * int d_write(cdev_t dev, struct uio *uio, int ioflag)
335dda38 94 */
fef8985e
MD
95struct dev_write_args {
96 struct dev_generic_args a_head;
97 struct uio *a_uio;
98 int a_ioflag;
335dda38
MD
99};
100
101/*
b13267a5 102 * int d_ioctl(cdev_t dev, u_long cmd, caddr_t data, int fflag,
87baaf0c 103 * struct ucred *cred, struct sysmsg *msg)
335dda38 104 */
fef8985e
MD
105struct dev_ioctl_args {
106 struct dev_generic_args a_head;
107 u_long a_cmd;
108 caddr_t a_data;
109 int a_fflag;
110 struct ucred *a_cred;
87baaf0c 111 struct sysmsg *a_sysmsg;
335dda38
MD
112};
113
114/*
b13267a5 115 * int d_poll(cdev_t dev, int events)
335dda38 116 */
fef8985e
MD
117struct dev_poll_args {
118 struct dev_generic_args a_head;
119 int a_events;
335dda38
MD
120};
121
122/*
b13267a5 123 * int d_mmap(cdev_t dev, vm_offset_t offset, int nprot)
335dda38 124 */
fef8985e
MD
125struct dev_mmap_args {
126 struct dev_generic_args a_head;
127 vm_offset_t a_offset;
128 int a_nprot;
129 int a_result; /* page number */
335dda38
MD
130};
131
132/*
b13267a5 133 * void d_strategy(cdev_t dev, struct bio *bio)
335dda38 134 */
fef8985e
MD
135struct dev_strategy_args {
136 struct dev_generic_args a_head;
137 struct bio *a_bio;
335dda38
MD
138};
139
140/*
b13267a5 141 * void d_dump(cdev_t dev)
335dda38 142 */
fef8985e
MD
143struct dev_dump_args {
144 struct dev_generic_args a_head;
e0fc5693
MD
145 u_int64_t a_count;
146 u_int64_t a_blkno;
fef8985e
MD
147 u_int a_secsize;
148};
149
150/*
b13267a5 151 * int d_psize(cdev_t dev)
fef8985e
MD
152 */
153struct dev_psize_args {
154 struct dev_generic_args a_head;
e0fc5693 155 int64_t a_result;
335dda38
MD
156};
157
158/*
b13267a5 159 * int d_kqfilter(cdev_t dev, struct knote *kn)
335dda38 160 */
fef8985e
MD
161struct dev_kqfilter_args {
162 struct dev_generic_args a_head;
163 struct knote *a_kn;
164 int a_result;
165};
166
a32446b7
MD
167/*
168 * int d_clone(cdev_t dev);
169 */
fef8985e
MD
170struct dev_clone_args {
171 struct dev_generic_args a_head;
cd29885a 172
07dfa375
AH
173 struct cdev *a_dev;
174 const char *a_name;
175 size_t a_namelen;
176 struct ucred *a_cred;
177 int a_mode;
335dda38
MD
178};
179
180/*
a32446b7
MD
181 * int d_revoke(cdev_t dev)
182 */
183struct dev_revoke_args {
184 struct dev_generic_args a_head;
185};
186
187/*
fef8985e
MD
188 * Typedefs to help drivers declare the driver routines and such
189 */
190typedef int d_default_t (struct dev_generic_args *ap);
191typedef int d_open_t (struct dev_open_args *ap);
192typedef int d_close_t (struct dev_close_args *ap);
193typedef int d_read_t (struct dev_read_args *ap);
194typedef int d_write_t (struct dev_write_args *ap);
195typedef int d_ioctl_t (struct dev_ioctl_args *ap);
196typedef int d_poll_t (struct dev_poll_args *ap);
197typedef int d_mmap_t (struct dev_mmap_args *ap);
198typedef int d_strategy_t (struct dev_strategy_args *ap);
199typedef int d_dump_t (struct dev_dump_args *ap);
200typedef int d_psize_t (struct dev_psize_args *ap);
201typedef int d_kqfilter_t (struct dev_kqfilter_args *ap);
202typedef int d_clone_t (struct dev_clone_args *ap);
a32446b7 203typedef int d_revoke_t (struct dev_revoke_args *ap);
fef8985e
MD
204
205/*
206 * Character device switch table.
207 *
208 * NOTE: positions are hard coded for static structure initialization.
209 */
210struct dev_ops {
211 struct {
212 const char *name; /* base name, e.g. 'da' */
e94d6677
SW
213 int maj; /* major device number */
214 u_int flags; /* D_XXX flags */
7cbab9da 215 void *data; /* custom driver data */
e94d6677
SW
216 int refs; /* ref count */
217 int id;
fef8985e
MD
218 } head;
219
220#define dev_ops_first_field d_default
221 d_default_t *d_default;
222 d_open_t *d_open;
223 d_close_t *d_close;
224 d_read_t *d_read;
225 d_write_t *d_write;
226 d_ioctl_t *d_ioctl;
227 d_poll_t *d_poll;
228 d_mmap_t *d_mmap;
229 d_strategy_t *d_strategy;
230 d_dump_t *d_dump;
231 d_psize_t *d_psize;
232 d_kqfilter_t *d_kqfilter;
233 d_clone_t *d_clone; /* clone from base dev_ops */
a32446b7
MD
234 d_revoke_t *d_revoke;
235#define dev_ops_last_field d_revoke
fef8985e
MD
236};
237
238/*
239 * Types for d_flags.
335dda38 240 */
fef8985e
MD
241#define D_TAPE 0x0001
242#define D_DISK 0x0002
243#define D_TTY 0x0004
244#define D_MEM 0x0008
245
246#define D_TYPEMASK 0xffff
c0885fab 247#define D_SEEKABLE (D_TAPE | D_DISK | D_MEM)
fef8985e
MD
248
249/*
250 * Flags for d_flags.
251 */
252#define D_MEMDISK 0x00010000 /* memory type disk */
253#define D_NAGGED 0x00020000 /* nagged about missing make_dev() */
254#define D_CANFREE 0x00040000 /* can free blocks */
255#define D_TRACKCLOSE 0x00080000 /* track all closes */
256#define D_MASTER 0x00100000 /* used by pty/tty code */
257#define D_KQFILTER 0x00200000 /* has kqfilter entry */
258
259/*
260 * A union of all possible argument structures.
261 */
262union dev_args_union {
263 struct dev_generic_args du_head;
264 struct dev_open_args du_open;
265 struct dev_close_args du_close;
266 struct dev_read_args du_read;
267 struct dev_write_args du_write;
268 struct dev_ioctl_args du_ioctl;
269 struct dev_poll_args du_poll;
270 struct dev_mmap_args du_mmap;
271 struct dev_strategy_args du_strategy;
272 struct dev_dump_args du_dump;
273 struct dev_psize_args du_psize;
274 struct dev_kqfilter_args du_kqfilter;
275 struct dev_clone_args du_clone;
276};
277
278/*
279 * Linking structure for mask/match registration
280 */
281struct dev_ops_link {
282 struct dev_ops_link *next;
283 u_int mask;
284 u_int match;
285 struct dev_ops *ops;
286};
335dda38 287
0e9b9130
MD
288struct dev_ops_maj {
289 RB_ENTRY(dev_ops_maj) rbnode; /* red-black tree of major nums */
290 struct dev_ops_link *link;
291 int maj;
292};
293
294RB_HEAD(dev_ops_rb_tree, dev_ops_maj);
295RB_PROTOTYPE2(dev_ops_rb_tree, dev_ops_maj, rbnode, rb_dev_ops_compare, int);
296
335dda38
MD
297#ifdef _KERNEL
298
fef8985e
MD
299extern struct dev_ops dead_dev_ops;
300
335dda38 301struct disk;
87baaf0c 302struct sysmsg;
335dda38 303
b13267a5
MD
304int dev_dopen(cdev_t dev, int oflags, int devtype, struct ucred *cred);
305int dev_dclose(cdev_t dev, int fflag, int devtype);
306void dev_dstrategy(cdev_t dev, struct bio *bio);
307void dev_dstrategy_chain(cdev_t dev, struct bio *bio);
308int dev_dioctl(cdev_t dev, u_long cmd, caddr_t data, int fflag,
87baaf0c 309 struct ucred *cred, struct sysmsg *msg);
b13267a5 310int dev_ddump(cdev_t dev);
e0fc5693 311int64_t dev_dpsize(cdev_t dev);
b13267a5
MD
312int dev_dread(cdev_t dev, struct uio *uio, int ioflag);
313int dev_dwrite(cdev_t dev, struct uio *uio, int ioflag);
314int dev_dpoll(cdev_t dev, int events);
315int dev_dkqfilter(cdev_t dev, struct knote *kn);
316int dev_dmmap(cdev_t dev, vm_offset_t offset, int nprot);
317int dev_dclone(cdev_t dev);
a32446b7 318int dev_drevoke(cdev_t dev);
b13267a5 319
ca464209 320int dev_drefs(cdev_t dev);
b13267a5
MD
321const char *dev_dname(cdev_t dev);
322int dev_dmaj(cdev_t dev);
323int dev_dflags(cdev_t dev);
fef8985e
MD
324int dev_doperate(struct dev_generic_args *ap);
325int dev_doperate_ops(struct dev_ops *, struct dev_generic_args *ap);
326
327d_default_t nodefault;
328d_open_t noopen;
329d_close_t noclose;
330d_read_t noread;
331d_write_t nowrite;
332d_ioctl_t noioctl;
333d_poll_t nopoll;
334d_mmap_t nommap;
335d_strategy_t nostrategy;
336d_dump_t nodump;
337d_psize_t nopsize;
338d_kqfilter_t nokqfilter;
339d_clone_t noclone;
a32446b7 340d_revoke_t norevoke;
fef8985e
MD
341
342d_open_t nullopen;
343d_close_t nullclose;
344
345extern struct syslink_desc dev_default_desc;
346extern struct syslink_desc dev_open_desc;
347extern struct syslink_desc dev_close_desc;
348extern struct syslink_desc dev_read_desc;
349extern struct syslink_desc dev_write_desc;
350extern struct syslink_desc dev_ioctl_desc;
351extern struct syslink_desc dev_dump_desc;
352extern struct syslink_desc dev_psize_desc;
353extern struct syslink_desc dev_poll_desc;
354extern struct syslink_desc dev_mmap_desc;
355extern struct syslink_desc dev_strategu_desc;
356extern struct syslink_desc dev_kqfilter_desc;
357extern struct syslink_desc dev_clone_desc;
358
359void compile_dev_ops(struct dev_ops *);
cd29885a
MD
360int dev_ops_remove_all(struct dev_ops *ops);
361int dev_ops_remove_minor(struct dev_ops *ops, int minor);
b13267a5
MD
362struct dev_ops *dev_ops_intercept(cdev_t, struct dev_ops *);
363void dev_ops_restore(cdev_t, struct dev_ops *);
fef8985e 364
b13267a5 365cdev_t make_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid,
fef8985e 366 int perms, const char *fmt, ...) __printflike(6, 7);
b17f0c0d
AH
367cdev_t make_dev_covering(struct dev_ops *ops, struct dev_ops *bops, int minor,
368 uid_t uid, gid_t gid, int perms, const char *fmt, ...) __printflike(7, 8);
cd29885a
MD
369cdev_t make_only_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid,
370 int perms, const char *fmt, ...) __printflike(6, 7);
371cdev_t make_only_devfs_dev(struct dev_ops *ops, int minor, uid_t uid, gid_t gid,
372 int perms, const char *fmt, ...) __printflike(6, 7);
373void destroy_only_dev(cdev_t dev);
374int make_dev_alias(cdev_t target, const char *fmt, ...);
b96f3782
AH
375cdev_t make_autoclone_dev(struct dev_ops *ops, struct devfs_bitmap *bitmap,
376 d_clone_t *nhandler, uid_t uid, gid_t gid, int perms, const char *fmt, ...);
07dfa375 377void destroy_autoclone_dev(cdev_t dev, struct devfs_bitmap *bitmap);
2a32d680
MD
378void sync_devs(void);
379
335dda38
MD
380#endif
381
382#endif
383