drivers/media/dvb-core/dvbdev.h

   1 /*
   2  * dvbdev.h
   3  *
   4  * Copyright (C) 2000 Ralph Metzler & Marcus Metzler
   5  *                    for convergence integrated media GmbH
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Lesser Public License
   9  * as published by the Free Software Foundation; either version 2.1
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20  *
  21  */
  22
  23 #ifndef _DVBDEV_H_
  24 #define _DVBDEV_H_
  25
  26 #include <linux/types.h>
  27 #include <linux/poll.h>
  28 #include <linux/fs.h>
  29 #include <linux/list.h>
  30 #include <media/media-device.h>
  31
  32 #define DVB_MAJOR 212
  33
  34 #if defined(CONFIG_DVB_MAX_ADAPTERS) && CONFIG_DVB_MAX_ADAPTERS > 0
  35   #define DVB_MAX_ADAPTERS CONFIG_DVB_MAX_ADAPTERS
  36 #else
  37   #define DVB_MAX_ADAPTERS 8
  38 #endif
  39
  40 #define DVB_UNSET (-1)
  41
  42 #define DVB_DEVICE_VIDEO      0
  43 #define DVB_DEVICE_AUDIO      1
  44 #define DVB_DEVICE_SEC        2
  45 #define DVB_DEVICE_FRONTEND   3
  46 #define DVB_DEVICE_DEMUX      4
  47 #define DVB_DEVICE_DVR        5
  48 #define DVB_DEVICE_CA         6
  49 #define DVB_DEVICE_NET        7
  50 #define DVB_DEVICE_OSD        8
  51
  52 #define DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nr) \
  53         static short adapter_nr[] = \
  54                 {[0 ... (DVB_MAX_ADAPTERS - 1)] = DVB_UNSET }; \
  55         module_param_array(adapter_nr, short, NULL, 0444); \
  56         MODULE_PARM_DESC(adapter_nr, "DVB adapter numbers")
  57
  58 struct dvb_frontend;
  59
  60 /**
  61  * struct dvb_adapter - represents a Digital TV adapter using Linux DVB API
  62  *
  63  * @num:                Number of the adapter
  64  * @list_head:          List with the DVB adapters
  65  * @device_list:        List with the DVB devices
  66  * @name:               Name of the adapter
  67  * @proposed_mac:       proposed MAC address for the adapter
  68  * @priv:               private data
  69  * @device:             pointer to struct device
  70  * @module:             pointer to struct module
  71  * @mfe_shared:         mfe shared: indicates mutually exclusive frontends
  72  *                      Thie usage of this flag is currently deprecated
  73  * @mfe_dvbdev:         Frontend device in use, in the case of MFE
  74  * @mfe_lock:           Lock to prevent using the other frontends when MFE is
  75  *                      used.
  76  * @mdev:               pointer to struct media_device, used when the media
  77  *                      controller is used.
  78  */
  79 struct dvb_adapter {
  80         int num;
  81         struct list_head list_head;
  82         struct list_head device_list;
  83         const char *name;
  84         u8 proposed_mac [6];
  85         void* priv;
  86
  87         struct device *device;
  88
  89         struct module *module;
  90
  91         int mfe_shared;                 /* indicates mutually exclusive frontends */
  92         struct dvb_device *mfe_dvbdev;  /* frontend device in use */
  93         struct mutex mfe_lock;          /* access lock for thread creation */
  94
  95 #if defined(CONFIG_MEDIA_CONTROLLER_DVB)
  96         struct media_device *mdev;
  97 #endif
  98 };
  99
 100 /**
 101  * struct dvb_device - represents a DVB device node
 102  *
 103  * @list_head:  List head with all DVB devices
 104  * @fops:       pointer to struct file_operations
 105  * @adapter:    pointer to the adapter that holds this device node
 106  * @type:       type of the device: DVB_DEVICE_SEC, DVB_DEVICE_FRONTEND,
 107  *              DVB_DEVICE_DEMUX, DVB_DEVICE_DVR, DVB_DEVICE_CA, DVB_DEVICE_NET
 108  * @minor:      devnode minor number. Major number is always DVB_MAJOR.
 109  * @id:         device ID number, inside the adapter
 110  * @readers:    Initialized by the caller. Each call to open() in Read Only mode
 111  *              decreases this counter by one.
 112  * @writers:    Initialized by the caller. Each call to open() in Read/Write
 113  *              mode decreases this counter by one.
 114  * @users:      Initialized by the caller. Each call to open() in any mode
 115  *              decreases this counter by one.
 116  * @wait_queue: wait queue, used to wait for certain events inside one of
 117  *              the DVB API callers
 118  * @kernel_ioctl: callback function used to handle ioctl calls from userspace.
 119  * @name:       Name to be used for the device at the Media Controller
 120  * @entity:     pointer to struct media_entity associated with the device node
 121  * @pads:       pointer to struct media_pad associated with @entity;
 122  * @priv:       private data
 123  *
 124  * This structure is used by the DVB core (frontend, CA, net, demux) in
 125  * order to create the device nodes. Usually, driver should not initialize
 126  * this struct diretly.
 127  */
 128 struct dvb_device {
 129         struct list_head list_head;
 130         const struct file_operations *fops;
 131         struct dvb_adapter *adapter;
 132         int type;
 133         int minor;
 134         u32 id;
 135
 136         /* in theory, 'users' can vanish now,
 137            but I don't want to change too much now... */
 138         int readers;
 139         int writers;
 140         int users;
 141
 142         wait_queue_head_t         wait_queue;
 143         /* don't really need those !? -- FIXME: use video_usercopy  */
 144         int (*kernel_ioctl)(struct file *file, unsigned int cmd, void *arg);
 145
 146         /* Needed for media controller register/unregister */
 147 #if defined(CONFIG_MEDIA_CONTROLLER_DVB)
 148         const char *name;
 149
 150         /* Allocated and filled inside dvbdev.c */
 151         struct media_entity *entity;
 152         struct media_pad *pads;
 153 #endif
 154
 155         void *priv;
 156 };
 157
 158 /**
 159  * dvb_register_adapter - Registers a new DVB adapter
 160  *
 161  * @adap:       pointer to struct dvb_adapter
 162  * @name:       Adapter's name
 163  * @module:     initialized with THIS_MODULE at the caller
 164  * @device:     pointer to struct device that corresponds to the device driver
 165  * @adapter_nums: Array with a list of the numbers for @dvb_register_adapter;
 166  *              to select among them. Typically, initialized with:
 167  *              DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nums)
 168  */
 169 int dvb_register_adapter(struct dvb_adapter *adap, const char *name,
 170                          struct module *module, struct device *device,
 171                          short *adapter_nums);
 172
 173 /**
 174  * dvb_unregister_adapter - Unregisters a DVB adapter
 175  *
 176  * @adap:       pointer to struct dvb_adapter
 177  */
 178 int dvb_unregister_adapter(struct dvb_adapter *adap);
 179
 180 /**
 181  * dvb_register_device - Registers a new DVB device
 182  *
 183  * @adap:       pointer to struct dvb_adapter
 184  * @pdvbdev:    pointer to the place where the new struct dvb_device will be
 185  *              stored
 186  * @template:   Template used to create &pdvbdev;
 187  * @device:     pointer to struct device that corresponds to the device driver
 188  * @adapter_nums: Array with a list of the numbers for @dvb_register_adapter;
 189  *              to select among them. Typically, initialized with:
 190  *              DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nums)
 191  * @priv:       private data
 192  * @type:       type of the device: DVB_DEVICE_SEC, DVB_DEVICE_FRONTEND,
 193  *              DVB_DEVICE_DEMUX, DVB_DEVICE_DVR, DVB_DEVICE_CA, DVB_DEVICE_NET
 194  */
 195 int dvb_register_device(struct dvb_adapter *adap,
 196                         struct dvb_device **pdvbdev,
 197                         const struct dvb_device *template,
 198                         void *priv,
 199                         int type);
 200
 201 /**
 202  * dvb_unregister_device - Unregisters a DVB device
 203  *
 204  * @dvbdev:     pointer to struct dvb_device
 205  */
 206 void dvb_unregister_device(struct dvb_device *dvbdev);
 207
 208 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
 209 void dvb_create_media_graph(struct dvb_adapter *adap);
 210 static inline void dvb_register_media_controller(struct dvb_adapter *adap,
 211                                                  struct media_device *mdev)
 212 {
 213         adap->mdev = mdev;
 214 }
 215
 216 #else
 217 static inline void dvb_create_media_graph(struct dvb_adapter *adap) {}
 218 #define dvb_register_media_controller(a, b) {}
 219 #endif
 220
 221 int dvb_generic_open (struct inode *inode, struct file *file);
 222 int dvb_generic_release (struct inode *inode, struct file *file);
 223 long dvb_generic_ioctl (struct file *file,
 224                               unsigned int cmd, unsigned long arg);
 225
 226 /* we don't mess with video_usercopy() any more,
 227 we simply define out own dvb_usercopy(), which will hopefully become
 228 generic_usercopy()  someday... */
 229
 230 int dvb_usercopy(struct file *file, unsigned int cmd, unsigned long arg,
 231                  int (*func)(struct file *file, unsigned int cmd, void *arg));
 232
 233 /** generic DVB attach function. */
 234 #ifdef CONFIG_MEDIA_ATTACH
 235 #define dvb_attach(FUNCTION, ARGS...) ({ \
 236         void *__r = NULL; \
 237         typeof(&FUNCTION) __a = symbol_request(FUNCTION); \
 238         if (__a) { \
 239                 __r = (void *) __a(ARGS); \
 240                 if (__r == NULL) \
 241                         symbol_put(FUNCTION); \
 242         } else { \
 243                 printk(KERN_ERR "DVB: Unable to find symbol "#FUNCTION"()\n"); \
 244         } \
 245         __r; \
 246 })
 247
 248 #define dvb_detach(FUNC)        symbol_put_addr(FUNC)
 249
 250 #else
 251 #define dvb_attach(FUNCTION, ARGS...) ({ \
 252         FUNCTION(ARGS); \
 253 })
 254
 255 #define dvb_detach(FUNC)        {}
 256
 257 #endif
 258
 259 #endif /* #ifndef _DVBDEV_H_ */