xref: /freebsd/sys/compat/linuxkpi/common/include/linux/cdev.h (revision 08c4a937a6685f05667996228898521fc453f8f3)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 #ifndef	_LINUX_CDEV_H_
32 #define	_LINUX_CDEV_H_
33 
34 #include <linux/kobject.h>
35 #include <linux/sysfs.h>
36 #include <linux/kdev_t.h>
37 #include <linux/list.h>
38 
39 #include <asm/atomic-long.h>
40 
41 struct file_operations;
42 struct inode;
43 struct module;
44 
45 extern struct cdevsw linuxcdevsw;
46 extern const struct kobj_type linux_cdev_ktype;
47 extern const struct kobj_type linux_cdev_static_ktype;
48 
49 struct linux_cdev {
50 	struct kobject	kobj;
51 	struct module	*owner;
52 	struct cdev	*cdev;
53 	dev_t		dev;
54 	const struct file_operations *ops;
55 	atomic_long_t	refs;
56 };
57 
58 static inline void
59 cdev_init(struct linux_cdev *cdev, const struct file_operations *ops)
60 {
61 
62 	kobject_init(&cdev->kobj, &linux_cdev_static_ktype);
63 	cdev->ops = ops;
64 	atomic_long_set(&cdev->refs, 0);
65 }
66 
67 static inline struct linux_cdev *
68 cdev_alloc(void)
69 {
70 	struct linux_cdev *cdev;
71 
72 	cdev = kzalloc(sizeof(struct linux_cdev), M_WAITOK);
73 	if (cdev)
74 		kobject_init(&cdev->kobj, &linux_cdev_ktype);
75 	return (cdev);
76 }
77 
78 static inline void
79 cdev_put(struct linux_cdev *p)
80 {
81 	kobject_put(&p->kobj);
82 }
83 
84 static inline int
85 cdev_add(struct linux_cdev *cdev, dev_t dev, unsigned count)
86 {
87 	struct make_dev_args args;
88 	int error;
89 
90 	if (count != 1)
91 		return (-EINVAL);
92 
93 	cdev->dev = dev;
94 
95 	/* Setup arguments for make_dev_s() */
96 	make_dev_args_init(&args);
97 	args.mda_devsw = &linuxcdevsw;
98 	args.mda_uid = 0;
99 	args.mda_gid = 0;
100 	args.mda_mode = 0700;
101 	args.mda_si_drv1 = cdev;
102 
103 	error = make_dev_s(&args, &cdev->cdev, "%s",
104 	    kobject_name(&cdev->kobj));
105 	if (error)
106 		return (-error);
107 
108 	kobject_get(cdev->kobj.parent);
109 	return (0);
110 }
111 
112 static inline int
113 cdev_add_ext(struct linux_cdev *cdev, dev_t dev, uid_t uid, gid_t gid, int mode)
114 {
115 	struct make_dev_args args;
116 	int error;
117 
118 	cdev->dev = dev;
119 
120 	/* Setup arguments for make_dev_s() */
121 	make_dev_args_init(&args);
122 	args.mda_devsw = &linuxcdevsw;
123 	args.mda_uid = uid;
124 	args.mda_gid = gid;
125 	args.mda_mode = mode;
126 	args.mda_si_drv1 = cdev;
127 
128 	error = make_dev_s(&args, &cdev->cdev, "%s/%d",
129 	    kobject_name(&cdev->kobj), MINOR(dev));
130 	if (error)
131 		return (-error);
132 
133 	kobject_get(cdev->kobj.parent);
134 	return (0);
135 }
136 
137 void linux_destroy_dev(struct linux_cdev *);
138 
139 static inline void
140 cdev_del(struct linux_cdev *cdev)
141 {
142 
143 	linux_destroy_dev(cdev);
144 	kobject_put(&cdev->kobj);
145 }
146 
147 struct linux_cdev *linux_find_cdev(const char *name, unsigned major, unsigned minor);
148 
149 #define	cdev	linux_cdev
150 
151 #endif	/* _LINUX_CDEV_H_ */
152