media-devnode.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. /*
  2. * Media device node
  3. *
  4. * Copyright (C) 2010 Nokia Corporation
  5. *
  6. * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
  7. * Sakari Ailus <sakari.ailus@iki.fi>
  8. *
  9. * This program is free software; you can redistribute it and/or modify
  10. * it under the terms of the GNU General Public License version 2 as
  11. * published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21. *
  22. * --
  23. *
  24. * Common functions for media-related drivers to register and unregister media
  25. * device nodes.
  26. */
  27. #ifndef _MEDIA_DEVNODE_H
  28. #define _MEDIA_DEVNODE_H
  29. #include <linux/poll.h>
  30. #include <linux/fs.h>
  31. #include <linux/device.h>
  32. #include <linux/cdev.h>
  33. /*
  34. * Flag to mark the media_devnode struct as registered. Drivers must not touch
  35. * this flag directly, it will be set and cleared by media_devnode_register and
  36. * media_devnode_unregister.
  37. */
  38. #define MEDIA_FLAG_REGISTERED 0
  39. struct media_file_operations {
  40. struct module *owner;
  41. ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
  42. ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
  43. unsigned int (*poll) (struct file *, struct poll_table_struct *);
  44. long (*ioctl) (struct file *, unsigned int, unsigned long);
  45. long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
  46. int (*open) (struct file *);
  47. int (*release) (struct file *);
  48. };
  49. /**
  50. * struct media_devnode - Media device node
  51. * @fops: pointer to struct media_file_operations with media device ops
  52. * @dev: struct device pointer for the media controller device
  53. * @cdev: struct cdev pointer character device
  54. * @parent: parent device
  55. * @minor: device node minor number
  56. * @flags: flags, combination of the MEDIA_FLAG_* constants
  57. * @release: release callback called at the end of media_devnode_release()
  58. *
  59. * This structure represents a media-related device node.
  60. *
  61. * The @parent is a physical device. It must be set by core or device drivers
  62. * before registering the node.
  63. */
  64. struct media_devnode {
  65. /* device ops */
  66. const struct media_file_operations *fops;
  67. /* sysfs */
  68. struct device dev; /* media device */
  69. struct cdev cdev; /* character device */
  70. struct device *parent; /* device parent */
  71. /* device info */
  72. int minor;
  73. unsigned long flags; /* Use bitops to access flags */
  74. /* callbacks */
  75. void (*release)(struct media_devnode *mdev);
  76. };
  77. /* dev to media_devnode */
  78. #define to_media_devnode(cd) container_of(cd, struct media_devnode, dev)
  79. int __must_check media_devnode_register(struct media_devnode *mdev,
  80. struct module *owner);
  81. void media_devnode_unregister(struct media_devnode *mdev);
  82. static inline struct media_devnode *media_devnode_data(struct file *filp)
  83. {
  84. return filp->private_data;
  85. }
  86. static inline int media_devnode_is_registered(struct media_devnode *mdev)
  87. {
  88. return test_bit(MEDIA_FLAG_REGISTERED, &mdev->flags);
  89. }
  90. #endif /* _MEDIA_DEVNODE_H */