xref: /freebsd/sys/compat/linuxkpi/common/include/linux/cdev.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
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-2021 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 device;
42 struct file_operations;
43 struct inode;
44 struct module;
45 
46 extern struct cdevsw linuxcdevsw;
47 extern const struct kobj_type linux_cdev_ktype;
48 extern const struct kobj_type linux_cdev_static_ktype;
49 
50 struct linux_cdev {
51 	struct kobject	kobj;
52 	struct module	*owner;
53 	struct cdev	*cdev;
54 	dev_t		dev;
55 	const struct file_operations *ops;
56 	u_int		refs;
57 	u_int		siref;
58 };
59 
60 static inline void
61 cdev_init(struct linux_cdev *cdev, const struct file_operations *ops)
62 {
63 
64 	kobject_init(&cdev->kobj, &linux_cdev_static_ktype);
65 	cdev->ops = ops;
66 	cdev->refs = 1;
67 }
68 
69 static inline struct linux_cdev *
70 cdev_alloc(void)
71 {
72 	struct linux_cdev *cdev;
73 
74 	cdev = kzalloc(sizeof(struct linux_cdev), M_WAITOK);
75 	kobject_init(&cdev->kobj, &linux_cdev_ktype);
76 	cdev->refs = 1;
77 	return (cdev);
78 }
79 
80 static inline void
81 cdev_put(struct linux_cdev *p)
82 {
83 	kobject_put(&p->kobj);
84 }
85 
86 static inline int
87 cdev_add(struct linux_cdev *cdev, dev_t dev, unsigned count)
88 {
89 	struct make_dev_args args;
90 	int error;
91 
92 	if (count != 1)
93 		return (-EINVAL);
94 
95 	cdev->dev = dev;
96 
97 	/* Setup arguments for make_dev_s() */
98 	make_dev_args_init(&args);
99 	args.mda_devsw = &linuxcdevsw;
100 	args.mda_uid = 0;
101 	args.mda_gid = 0;
102 	args.mda_mode = 0700;
103 	args.mda_si_drv1 = cdev;
104 
105 	error = make_dev_s(&args, &cdev->cdev, "%s",
106 	    kobject_name(&cdev->kobj));
107 	if (error)
108 		return (-error);
109 
110 	kobject_get(cdev->kobj.parent);
111 	return (0);
112 }
113 
114 static inline int
115 cdev_add_ext(struct linux_cdev *cdev, dev_t dev, uid_t uid, gid_t gid, int mode)
116 {
117 	struct make_dev_args args;
118 	int error;
119 
120 	cdev->dev = dev;
121 
122 	/* Setup arguments for make_dev_s() */
123 	make_dev_args_init(&args);
124 	args.mda_devsw = &linuxcdevsw;
125 	args.mda_uid = uid;
126 	args.mda_gid = gid;
127 	args.mda_mode = mode;
128 	args.mda_si_drv1 = cdev;
129 
130 	error = make_dev_s(&args, &cdev->cdev, "%s/%d",
131 	    kobject_name(&cdev->kobj), MINOR(dev));
132 	if (error)
133 		return (-error);
134 
135 	kobject_get(cdev->kobj.parent);
136 	return (0);
137 }
138 
139 static inline void
140 cdev_del(struct linux_cdev *cdev)
141 {
142 	kobject_put(&cdev->kobj);
143 }
144 
145 struct linux_cdev *linux_find_cdev(const char *name, unsigned major, unsigned minor);
146 
147 int linux_cdev_device_add(struct linux_cdev *, struct device *);
148 void linux_cdev_device_del(struct linux_cdev *, struct device *);
149 
150 #define	cdev_device_add(...)		\
151   linux_cdev_device_add(__VA_ARGS__)
152 #define	cdev_device_del(...)		\
153   linux_cdev_device_del(__VA_ARGS__)
154 
155 #define	cdev	linux_cdev
156 
157 #endif	/* _LINUX_CDEV_H_ */
158