Commit | Line | Data |
---|---|---|
cf4b9211 LP |
1 | /* |
2 | * Media device node | |
3 | * | |
4 | * Copyright (C) 2010 Nokia Corporation | |
5 | * | |
6 | * Based on drivers/media/video/v4l2_dev.c code authored by | |
7 | * Mauro Carvalho Chehab <mchehab@infradead.org> (version 2) | |
8 | * Alan Cox, <alan@lxorguk.ukuu.org.uk> (version 1) | |
9 | * | |
10 | * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com> | |
11 | * Sakari Ailus <sakari.ailus@iki.fi> | |
12 | * | |
13 | * This program is free software; you can redistribute it and/or modify | |
14 | * it under the terms of the GNU General Public License version 2 as | |
15 | * published by the Free Software Foundation. | |
16 | * | |
17 | * This program is distributed in the hope that it will be useful, | |
18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | * GNU General Public License for more details. | |
21 | * | |
cf4b9211 LP |
22 | * -- |
23 | * | |
24 | * Generic media device node infrastructure to register and unregister | |
25 | * character devices using a dynamic major number and proper reference | |
26 | * counting. | |
27 | */ | |
28 | ||
3c16b2b3 SK |
29 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
30 | ||
cf4b9211 LP |
31 | #include <linux/errno.h> |
32 | #include <linux/init.h> | |
33 | #include <linux/module.h> | |
34 | #include <linux/kernel.h> | |
35 | #include <linux/kmod.h> | |
36 | #include <linux/slab.h> | |
37 | #include <linux/mm.h> | |
38 | #include <linux/string.h> | |
39 | #include <linux/types.h> | |
40 | #include <linux/uaccess.h> | |
cf4b9211 LP |
41 | |
42 | #include <media/media-devnode.h> | |
a087ce70 | 43 | #include <media/media-device.h> |
cf4b9211 LP |
44 | |
45 | #define MEDIA_NUM_DEVICES 256 | |
46 | #define MEDIA_NAME "media" | |
47 | ||
48 | static dev_t media_dev_t; | |
49 | ||
50 | /* | |
51 | * Active devices | |
52 | */ | |
53 | static DEFINE_MUTEX(media_devnode_lock); | |
54 | static DECLARE_BITMAP(media_devnode_nums, MEDIA_NUM_DEVICES); | |
55 | ||
56 | /* Called when the last user of the media device exits. */ | |
57 | static void media_devnode_release(struct device *cd) | |
58 | { | |
163f1e93 | 59 | struct media_devnode *devnode = to_media_devnode(cd); |
cf4b9211 LP |
60 | |
61 | mutex_lock(&media_devnode_lock); | |
cf4b9211 | 62 | /* Mark device node number as free */ |
163f1e93 | 63 | clear_bit(devnode->minor, media_devnode_nums); |
cf4b9211 LP |
64 | mutex_unlock(&media_devnode_lock); |
65 | ||
66 | /* Release media_devnode and perform other cleanups as needed. */ | |
163f1e93 MCC |
67 | if (devnode->release) |
68 | devnode->release(devnode); | |
a087ce70 MCC |
69 | |
70 | kfree(devnode); | |
5b28dde5 | 71 | pr_debug("%s: Media Devnode Deallocated\n", __func__); |
cf4b9211 LP |
72 | } |
73 | ||
74 | static struct bus_type media_bus_type = { | |
75 | .name = MEDIA_NAME, | |
76 | }; | |
77 | ||
78 | static ssize_t media_read(struct file *filp, char __user *buf, | |
79 | size_t sz, loff_t *off) | |
80 | { | |
163f1e93 | 81 | struct media_devnode *devnode = media_devnode_data(filp); |
cf4b9211 | 82 | |
163f1e93 | 83 | if (!devnode->fops->read) |
cf4b9211 | 84 | return -EINVAL; |
163f1e93 | 85 | if (!media_devnode_is_registered(devnode)) |
cf4b9211 | 86 | return -EIO; |
163f1e93 | 87 | return devnode->fops->read(filp, buf, sz, off); |
cf4b9211 LP |
88 | } |
89 | ||
90 | static ssize_t media_write(struct file *filp, const char __user *buf, | |
91 | size_t sz, loff_t *off) | |
92 | { | |
163f1e93 | 93 | struct media_devnode *devnode = media_devnode_data(filp); |
cf4b9211 | 94 | |
163f1e93 | 95 | if (!devnode->fops->write) |
cf4b9211 | 96 | return -EINVAL; |
163f1e93 | 97 | if (!media_devnode_is_registered(devnode)) |
cf4b9211 | 98 | return -EIO; |
163f1e93 | 99 | return devnode->fops->write(filp, buf, sz, off); |
cf4b9211 LP |
100 | } |
101 | ||
c23e0cb8 | 102 | static __poll_t media_poll(struct file *filp, |
cf4b9211 LP |
103 | struct poll_table_struct *poll) |
104 | { | |
163f1e93 | 105 | struct media_devnode *devnode = media_devnode_data(filp); |
cf4b9211 | 106 | |
163f1e93 | 107 | if (!media_devnode_is_registered(devnode)) |
cf4b9211 | 108 | return POLLERR | POLLHUP; |
163f1e93 | 109 | if (!devnode->fops->poll) |
cf4b9211 | 110 | return DEFAULT_POLLMASK; |
163f1e93 | 111 | return devnode->fops->poll(filp, poll); |
cf4b9211 LP |
112 | } |
113 | ||
c6c1d50b SA |
114 | static long |
115 | __media_ioctl(struct file *filp, unsigned int cmd, unsigned long arg, | |
116 | long (*ioctl_func)(struct file *filp, unsigned int cmd, | |
117 | unsigned long arg)) | |
cf4b9211 | 118 | { |
163f1e93 | 119 | struct media_devnode *devnode = media_devnode_data(filp); |
cf4b9211 | 120 | |
c6c1d50b | 121 | if (!ioctl_func) |
cf4b9211 LP |
122 | return -ENOTTY; |
123 | ||
163f1e93 | 124 | if (!media_devnode_is_registered(devnode)) |
cf4b9211 LP |
125 | return -EIO; |
126 | ||
c6c1d50b SA |
127 | return ioctl_func(filp, cmd, arg); |
128 | } | |
129 | ||
130 | static long media_ioctl(struct file *filp, unsigned int cmd, unsigned long arg) | |
131 | { | |
163f1e93 | 132 | struct media_devnode *devnode = media_devnode_data(filp); |
c6c1d50b | 133 | |
163f1e93 | 134 | return __media_ioctl(filp, cmd, arg, devnode->fops->ioctl); |
cf4b9211 LP |
135 | } |
136 | ||
c6c1d50b SA |
137 | #ifdef CONFIG_COMPAT |
138 | ||
139 | static long media_compat_ioctl(struct file *filp, unsigned int cmd, | |
140 | unsigned long arg) | |
141 | { | |
163f1e93 | 142 | struct media_devnode *devnode = media_devnode_data(filp); |
c6c1d50b | 143 | |
163f1e93 | 144 | return __media_ioctl(filp, cmd, arg, devnode->fops->compat_ioctl); |
c6c1d50b SA |
145 | } |
146 | ||
147 | #endif /* CONFIG_COMPAT */ | |
148 | ||
cf4b9211 LP |
149 | /* Override for the open function */ |
150 | static int media_open(struct inode *inode, struct file *filp) | |
151 | { | |
163f1e93 | 152 | struct media_devnode *devnode; |
cf4b9211 LP |
153 | int ret; |
154 | ||
155 | /* Check if the media device is available. This needs to be done with | |
156 | * the media_devnode_lock held to prevent an open/unregister race: | |
157 | * without the lock, the device could be unregistered and freed between | |
158 | * the media_devnode_is_registered() and get_device() calls, leading to | |
159 | * a crash. | |
160 | */ | |
161 | mutex_lock(&media_devnode_lock); | |
163f1e93 | 162 | devnode = container_of(inode->i_cdev, struct media_devnode, cdev); |
cf4b9211 LP |
163 | /* return ENXIO if the media device has been removed |
164 | already or if it is not registered anymore. */ | |
163f1e93 | 165 | if (!media_devnode_is_registered(devnode)) { |
cf4b9211 LP |
166 | mutex_unlock(&media_devnode_lock); |
167 | return -ENXIO; | |
168 | } | |
169 | /* and increase the device refcount */ | |
163f1e93 | 170 | get_device(&devnode->dev); |
cf4b9211 LP |
171 | mutex_unlock(&media_devnode_lock); |
172 | ||
163f1e93 | 173 | filp->private_data = devnode; |
cf4b9211 | 174 | |
163f1e93 MCC |
175 | if (devnode->fops->open) { |
176 | ret = devnode->fops->open(filp); | |
cf4b9211 | 177 | if (ret) { |
163f1e93 | 178 | put_device(&devnode->dev); |
d40ec6fd | 179 | filp->private_data = NULL; |
cf4b9211 LP |
180 | return ret; |
181 | } | |
182 | } | |
183 | ||
184 | return 0; | |
185 | } | |
186 | ||
187 | /* Override for the release function */ | |
188 | static int media_release(struct inode *inode, struct file *filp) | |
189 | { | |
163f1e93 | 190 | struct media_devnode *devnode = media_devnode_data(filp); |
cf4b9211 | 191 | |
163f1e93 MCC |
192 | if (devnode->fops->release) |
193 | devnode->fops->release(filp); | |
cf4b9211 | 194 | |
bf244f66 MK |
195 | filp->private_data = NULL; |
196 | ||
cf4b9211 LP |
197 | /* decrease the refcount unconditionally since the release() |
198 | return value is ignored. */ | |
163f1e93 | 199 | put_device(&devnode->dev); |
5b28dde5 SK |
200 | |
201 | pr_debug("%s: Media Release\n", __func__); | |
8b37c645 | 202 | return 0; |
cf4b9211 LP |
203 | } |
204 | ||
205 | static const struct file_operations media_devnode_fops = { | |
206 | .owner = THIS_MODULE, | |
207 | .read = media_read, | |
208 | .write = media_write, | |
209 | .open = media_open, | |
210 | .unlocked_ioctl = media_ioctl, | |
c6c1d50b SA |
211 | #ifdef CONFIG_COMPAT |
212 | .compat_ioctl = media_compat_ioctl, | |
213 | #endif /* CONFIG_COMPAT */ | |
cf4b9211 LP |
214 | .release = media_release, |
215 | .poll = media_poll, | |
216 | .llseek = no_llseek, | |
217 | }; | |
218 | ||
a087ce70 MCC |
219 | int __must_check media_devnode_register(struct media_device *mdev, |
220 | struct media_devnode *devnode, | |
85de721c | 221 | struct module *owner) |
cf4b9211 LP |
222 | { |
223 | int minor; | |
224 | int ret; | |
225 | ||
226 | /* Part 1: Find a free minor number */ | |
227 | mutex_lock(&media_devnode_lock); | |
8c89ddd5 | 228 | minor = find_next_zero_bit(media_devnode_nums, MEDIA_NUM_DEVICES, 0); |
cf4b9211 LP |
229 | if (minor == MEDIA_NUM_DEVICES) { |
230 | mutex_unlock(&media_devnode_lock); | |
3c16b2b3 | 231 | pr_err("could not get a free minor\n"); |
5b28dde5 | 232 | kfree(devnode); |
cf4b9211 LP |
233 | return -ENFILE; |
234 | } | |
235 | ||
8c89ddd5 | 236 | set_bit(minor, media_devnode_nums); |
cf4b9211 LP |
237 | mutex_unlock(&media_devnode_lock); |
238 | ||
163f1e93 | 239 | devnode->minor = minor; |
a087ce70 | 240 | devnode->media_dev = mdev; |
cf4b9211 | 241 | |
5b28dde5 SK |
242 | /* Part 1: Initialize dev now to use dev.kobj for cdev.kobj.parent */ |
243 | devnode->dev.bus = &media_bus_type; | |
244 | devnode->dev.devt = MKDEV(MAJOR(media_dev_t), devnode->minor); | |
245 | devnode->dev.release = media_devnode_release; | |
246 | if (devnode->parent) | |
247 | devnode->dev.parent = devnode->parent; | |
248 | dev_set_name(&devnode->dev, "media%d", devnode->minor); | |
249 | device_initialize(&devnode->dev); | |
250 | ||
857313e5 | 251 | /* Part 2: Initialize the character device */ |
163f1e93 MCC |
252 | cdev_init(&devnode->cdev, &media_devnode_fops); |
253 | devnode->cdev.owner = owner; | |
cf4b9211 | 254 | |
857313e5 LG |
255 | /* Part 3: Add the media and char device */ |
256 | ret = cdev_device_add(&devnode->cdev, &devnode->dev); | |
cf4b9211 | 257 | if (ret < 0) { |
857313e5 | 258 | pr_err("%s: cdev_device_add failed\n", __func__); |
5b28dde5 | 259 | goto cdev_add_error; |
cf4b9211 LP |
260 | } |
261 | ||
cf4b9211 | 262 | /* Part 4: Activate this minor. The char device can now be used. */ |
163f1e93 | 263 | set_bit(MEDIA_FLAG_REGISTERED, &devnode->flags); |
cf4b9211 LP |
264 | |
265 | return 0; | |
266 | ||
5b28dde5 SK |
267 | cdev_add_error: |
268 | mutex_lock(&media_devnode_lock); | |
163f1e93 | 269 | clear_bit(devnode->minor, media_devnode_nums); |
5b28dde5 | 270 | devnode->media_dev = NULL; |
88336e17 MK |
271 | mutex_unlock(&media_devnode_lock); |
272 | ||
5b28dde5 | 273 | put_device(&devnode->dev); |
cf4b9211 LP |
274 | return ret; |
275 | } | |
276 | ||
6f0dd24a | 277 | void media_devnode_unregister_prepare(struct media_devnode *devnode) |
cf4b9211 | 278 | { |
163f1e93 MCC |
279 | /* Check if devnode was ever registered at all */ |
280 | if (!media_devnode_is_registered(devnode)) | |
cf4b9211 LP |
281 | return; |
282 | ||
283 | mutex_lock(&media_devnode_lock); | |
163f1e93 | 284 | clear_bit(MEDIA_FLAG_REGISTERED, &devnode->flags); |
6f0dd24a SK |
285 | mutex_unlock(&media_devnode_lock); |
286 | } | |
287 | ||
288 | void media_devnode_unregister(struct media_devnode *devnode) | |
289 | { | |
290 | mutex_lock(&media_devnode_lock); | |
5b28dde5 | 291 | /* Delete the cdev on this minor as well */ |
857313e5 | 292 | cdev_device_del(&devnode->cdev, &devnode->dev); |
cf4b9211 | 293 | mutex_unlock(&media_devnode_lock); |
5b28dde5 SK |
294 | devnode->media_dev = NULL; |
295 | put_device(&devnode->dev); | |
cf4b9211 LP |
296 | } |
297 | ||
298 | /* | |
299 | * Initialise media for linux | |
300 | */ | |
301 | static int __init media_devnode_init(void) | |
302 | { | |
303 | int ret; | |
304 | ||
3c16b2b3 | 305 | pr_info("Linux media interface: v0.10\n"); |
cf4b9211 LP |
306 | ret = alloc_chrdev_region(&media_dev_t, 0, MEDIA_NUM_DEVICES, |
307 | MEDIA_NAME); | |
308 | if (ret < 0) { | |
3c16b2b3 | 309 | pr_warn("unable to allocate major\n"); |
cf4b9211 LP |
310 | return ret; |
311 | } | |
312 | ||
313 | ret = bus_register(&media_bus_type); | |
314 | if (ret < 0) { | |
315 | unregister_chrdev_region(media_dev_t, MEDIA_NUM_DEVICES); | |
3c16b2b3 | 316 | pr_warn("bus_register failed\n"); |
cf4b9211 LP |
317 | return -EIO; |
318 | } | |
319 | ||
320 | return 0; | |
321 | } | |
322 | ||
323 | static void __exit media_devnode_exit(void) | |
324 | { | |
325 | bus_unregister(&media_bus_type); | |
326 | unregister_chrdev_region(media_dev_t, MEDIA_NUM_DEVICES); | |
327 | } | |
328 | ||
ff732d28 | 329 | subsys_initcall(media_devnode_init); |
cf4b9211 LP |
330 | module_exit(media_devnode_exit) |
331 | ||
332 | MODULE_AUTHOR("Laurent Pinchart <laurent.pinchart@ideasonboard.com>"); | |
333 | MODULE_DESCRIPTION("Device node registration for media drivers"); | |
334 | MODULE_LICENSE("GPL"); |