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 */ 18 19 #ifndef _DVBDEV_H_ 20 #define _DVBDEV_H_ 21 22 #include <linux/types.h> 23 #include <linux/poll.h> 24 #include <linux/fs.h> 25 #include <linux/list.h> 26 #include <media/media-device.h> 27 28 #define DVB_MAJOR 212 29 30 #if defined(CONFIG_DVB_MAX_ADAPTERS) && CONFIG_DVB_MAX_ADAPTERS > 0 31 #define DVB_MAX_ADAPTERS CONFIG_DVB_MAX_ADAPTERS 32 #else 33 #define DVB_MAX_ADAPTERS 16 34 #endif 35 36 #define DVB_UNSET (-1) 37 38 /* List of DVB device types */ 39 40 /** 41 * enum dvb_device_type - type of the Digital TV device 42 * 43 * @DVB_DEVICE_SEC: Digital TV standalone Common Interface (CI) 44 * @DVB_DEVICE_FRONTEND: Digital TV frontend. 45 * @DVB_DEVICE_DEMUX: Digital TV demux. 46 * @DVB_DEVICE_DVR: Digital TV digital video record (DVR). 47 * @DVB_DEVICE_CA: Digital TV Conditional Access (CA). 48 * @DVB_DEVICE_NET: Digital TV network. 49 * 50 * @DVB_DEVICE_VIDEO: Digital TV video decoder. 51 * Deprecated. Used only on av7110-av. 52 * @DVB_DEVICE_AUDIO: Digital TV audio decoder. 53 * Deprecated. Used only on av7110-av. 54 * @DVB_DEVICE_OSD: Digital TV On Screen Display (OSD). 55 * Deprecated. Used only on av7110. 56 */ 57 enum dvb_device_type { 58 DVB_DEVICE_SEC, 59 DVB_DEVICE_FRONTEND, 60 DVB_DEVICE_DEMUX, 61 DVB_DEVICE_DVR, 62 DVB_DEVICE_CA, 63 DVB_DEVICE_NET, 64 65 DVB_DEVICE_VIDEO, 66 DVB_DEVICE_AUDIO, 67 DVB_DEVICE_OSD, 68 }; 69 70 #define DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nr) \ 71 static short adapter_nr[] = \ 72 {[0 ... (DVB_MAX_ADAPTERS - 1)] = DVB_UNSET }; \ 73 module_param_array(adapter_nr, short, NULL, 0444); \ 74 MODULE_PARM_DESC(adapter_nr, "DVB adapter numbers") 75 76 struct dvb_frontend; 77 78 /** 79 * struct dvb_adapter - represents a Digital TV adapter using Linux DVB API 80 * 81 * @num: Number of the adapter 82 * @list_head: List with the DVB adapters 83 * @device_list: List with the DVB devices 84 * @name: Name of the adapter 85 * @proposed_mac: proposed MAC address for the adapter 86 * @priv: private data 87 * @device: pointer to struct device 88 * @module: pointer to struct module 89 * @mfe_shared: indicates mutually exclusive frontends. 90 * 1 = legacy exclusion behavior: blocking any open() call 91 * 2 = enhanced exclusion behavior, emulating the standard 92 * behavior of busy frontends: allowing read-only sharing 93 * and otherwise returning immediately with -EBUSY when any 94 * of the frontends is already opened with write access. 95 * @mfe_dvbdev: Frontend device in use, in the case of MFE 96 * @mfe_lock: Lock to prevent using the other frontends when MFE is 97 * used. 98 * @mdev_lock: Protect access to the mdev pointer. 99 * @mdev: pointer to struct media_device, used when the media 100 * controller is used. 101 * @conn: RF connector. Used only if the device has no separate 102 * tuner. 103 * @conn_pads: pointer to struct media_pad associated with @conn; 104 */ 105 struct dvb_adapter { 106 int num; 107 struct list_head list_head; 108 struct list_head device_list; 109 const char *name; 110 u8 proposed_mac [6]; 111 void* priv; 112 113 struct device *device; 114 115 struct module *module; 116 117 int mfe_shared; /* indicates mutually exclusive frontends */ 118 struct dvb_device *mfe_dvbdev; /* frontend device in use */ 119 struct mutex mfe_lock; /* access lock for thread creation */ 120 121 #if defined(CONFIG_MEDIA_CONTROLLER_DVB) 122 struct mutex mdev_lock; 123 struct media_device *mdev; 124 struct media_entity *conn; 125 struct media_pad *conn_pads; 126 #endif 127 }; 128 129 /** 130 * struct dvb_device - represents a DVB device node 131 * 132 * @list_head: List head with all DVB devices 133 * @fops: pointer to struct file_operations 134 * @adapter: pointer to the adapter that holds this device node 135 * @type: type of the device, as defined by &enum dvb_device_type. 136 * @minor: devnode minor number. Major number is always DVB_MAJOR. 137 * @id: device ID number, inside the adapter 138 * @readers: Initialized by the caller. Each call to open() in Read Only mode 139 * decreases this counter by one. 140 * @writers: Initialized by the caller. Each call to open() in Read/Write 141 * mode decreases this counter by one. 142 * @users: Initialized by the caller. Each call to open() in any mode 143 * decreases this counter by one. 144 * @wait_queue: wait queue, used to wait for certain events inside one of 145 * the DVB API callers 146 * @kernel_ioctl: callback function used to handle ioctl calls from userspace. 147 * @name: Name to be used for the device at the Media Controller 148 * @entity: pointer to struct media_entity associated with the device node 149 * @pads: pointer to struct media_pad associated with @entity; 150 * @priv: private data 151 * @intf_devnode: Pointer to media_intf_devnode. Used by the dvbdev core to 152 * store the MC device node interface 153 * @tsout_num_entities: Number of Transport Stream output entities 154 * @tsout_entity: array with MC entities associated to each TS output node 155 * @tsout_pads: array with the source pads for each @tsout_entity 156 * 157 * This structure is used by the DVB core (frontend, CA, net, demux) in 158 * order to create the device nodes. Usually, driver should not initialize 159 * this struct diretly. 160 */ 161 struct dvb_device { 162 struct list_head list_head; 163 const struct file_operations *fops; 164 struct dvb_adapter *adapter; 165 enum dvb_device_type type; 166 int minor; 167 u32 id; 168 169 /* in theory, 'users' can vanish now, 170 but I don't want to change too much now... */ 171 int readers; 172 int writers; 173 int users; 174 175 wait_queue_head_t wait_queue; 176 /* don't really need those !? -- FIXME: use video_usercopy */ 177 int (*kernel_ioctl)(struct file *file, unsigned int cmd, void *arg); 178 179 /* Needed for media controller register/unregister */ 180 #if defined(CONFIG_MEDIA_CONTROLLER_DVB) 181 const char *name; 182 183 /* Allocated and filled inside dvbdev.c */ 184 struct media_intf_devnode *intf_devnode; 185 186 unsigned tsout_num_entities; 187 struct media_entity *entity, *tsout_entity; 188 struct media_pad *pads, *tsout_pads; 189 #endif 190 191 void *priv; 192 }; 193 194 /** 195 * dvb_register_adapter - Registers a new DVB adapter 196 * 197 * @adap: pointer to struct dvb_adapter 198 * @name: Adapter's name 199 * @module: initialized with THIS_MODULE at the caller 200 * @device: pointer to struct device that corresponds to the device driver 201 * @adapter_nums: Array with a list of the numbers for @dvb_register_adapter; 202 * to select among them. Typically, initialized with: 203 * DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nums) 204 */ 205 int dvb_register_adapter(struct dvb_adapter *adap, const char *name, 206 struct module *module, struct device *device, 207 short *adapter_nums); 208 209 /** 210 * dvb_unregister_adapter - Unregisters a DVB adapter 211 * 212 * @adap: pointer to struct dvb_adapter 213 */ 214 int dvb_unregister_adapter(struct dvb_adapter *adap); 215 216 /** 217 * dvb_register_device - Registers a new DVB device 218 * 219 * @adap: pointer to struct dvb_adapter 220 * @pdvbdev: pointer to the place where the new struct dvb_device will be 221 * stored 222 * @template: Template used to create &pdvbdev; 223 * @priv: private data 224 * @type: type of the device, as defined by &enum dvb_device_type. 225 * @demux_sink_pads: Number of demux outputs, to be used to create the TS 226 * outputs via the Media Controller. 227 */ 228 int dvb_register_device(struct dvb_adapter *adap, 229 struct dvb_device **pdvbdev, 230 const struct dvb_device *template, 231 void *priv, 232 enum dvb_device_type type, 233 int demux_sink_pads); 234 235 /** 236 * dvb_remove_device - Remove a registered DVB device 237 * 238 * This does not free memory. To do that, call dvb_free_device(). 239 * 240 * @dvbdev: pointer to struct dvb_device 241 */ 242 void dvb_remove_device(struct dvb_device *dvbdev); 243 244 /** 245 * dvb_free_device - Free memory occupied by a DVB device. 246 * 247 * Call dvb_unregister_device() before calling this function. 248 * 249 * @dvbdev: pointer to struct dvb_device 250 */ 251 void dvb_free_device(struct dvb_device *dvbdev); 252 253 /** 254 * dvb_unregister_device - Unregisters a DVB device 255 * 256 * This is a combination of dvb_remove_device() and dvb_free_device(). 257 * Using this function is usually a mistake, and is often an indicator 258 * for a use-after-free bug (when a userspace process keeps a file 259 * handle to a detached device). 260 * 261 * @dvbdev: pointer to struct dvb_device 262 */ 263 void dvb_unregister_device(struct dvb_device *dvbdev); 264 265 #ifdef CONFIG_MEDIA_CONTROLLER_DVB 266 /** 267 * dvb_create_media_graph - Creates media graph for the Digital TV part of the 268 * device. 269 * 270 * @adap: pointer to &struct dvb_adapter 271 * @create_rf_connector: if true, it creates the RF connector too 272 * 273 * This function checks all DVB-related functions at the media controller 274 * entities and creates the needed links for the media graph. It is 275 * capable of working with multiple tuners or multiple frontends, but it 276 * won't create links if the device has multiple tuners and multiple frontends 277 * or if the device has multiple muxes. In such case, the caller driver should 278 * manually create the remaining links. 279 */ 280 __must_check int dvb_create_media_graph(struct dvb_adapter *adap, 281 bool create_rf_connector); 282 283 /** 284 * dvb_register_media_controller - registers a media controller at DVB adapter 285 * 286 * @adap: pointer to &struct dvb_adapter 287 * @mdev: pointer to &struct media_device 288 */ 289 static inline void dvb_register_media_controller(struct dvb_adapter *adap, 290 struct media_device *mdev) 291 { 292 adap->mdev = mdev; 293 } 294 295 /** 296 * dvb_get_media_controller - gets the associated media controller 297 * 298 * @adap: pointer to &struct dvb_adapter 299 */ 300 static inline struct media_device * 301 dvb_get_media_controller(struct dvb_adapter *adap) 302 { 303 return adap->mdev; 304 } 305 #else 306 static inline 307 int dvb_create_media_graph(struct dvb_adapter *adap, 308 bool create_rf_connector) 309 { 310 return 0; 311 }; 312 #define dvb_register_media_controller(a, b) {} 313 #define dvb_get_media_controller(a) NULL 314 #endif 315 316 /** 317 * dvb_generic_open - Digital TV open function, used by DVB devices 318 * 319 * @inode: pointer to &struct inode. 320 * @file: pointer to &struct file. 321 * 322 * Checks if a DVB devnode is still valid, and if the permissions are 323 * OK and increment negative use count. 324 */ 325 int dvb_generic_open(struct inode *inode, struct file *file); 326 327 /** 328 * dvb_generic_release - Digital TV close function, used by DVB devices 329 * 330 * @inode: pointer to &struct inode. 331 * @file: pointer to &struct file. 332 * 333 * Checks if a DVB devnode is still valid, and if the permissions are 334 * OK and decrement negative use count. 335 */ 336 int dvb_generic_release(struct inode *inode, struct file *file); 337 338 /** 339 * dvb_generic_ioctl - Digital TV close function, used by DVB devices 340 * 341 * @file: pointer to &struct file. 342 * @cmd: Ioctl name. 343 * @arg: Ioctl argument. 344 * 345 * Checks if a DVB devnode and struct dvbdev.kernel_ioctl is still valid. 346 * If so, calls dvb_usercopy(). 347 */ 348 long dvb_generic_ioctl(struct file *file, 349 unsigned int cmd, unsigned long arg); 350 351 /** 352 * dvb_usercopy - copies data from/to userspace memory when an ioctl is 353 * issued. 354 * 355 * @file: Pointer to struct &file. 356 * @cmd: Ioctl name. 357 * @arg: Ioctl argument. 358 * @func: function that will actually handle the ioctl 359 * 360 * Ancillary function that uses ioctl direction and size to copy from 361 * userspace. Then, it calls @func, and, if needed, data is copied back 362 * to userspace. 363 */ 364 int dvb_usercopy(struct file *file, unsigned int cmd, unsigned long arg, 365 int (*func)(struct file *file, unsigned int cmd, void *arg)); 366 367 #if IS_ENABLED(CONFIG_I2C) 368 369 struct i2c_adapter; 370 struct i2c_client; 371 /** 372 * dvb_module_probe - helper routine to probe an I2C module 373 * 374 * @module_name: 375 * Name of the I2C module to be probed 376 * @name: 377 * Optional name for the I2C module. Used for debug purposes. 378 * If %NULL, defaults to @module_name. 379 * @adap: 380 * pointer to &struct i2c_adapter that describes the I2C adapter where 381 * the module will be bound. 382 * @addr: 383 * I2C address of the adapter, in 7-bit notation. 384 * @platform_data: 385 * Platform data to be passed to the I2C module probed. 386 * 387 * This function binds an I2C device into the DVB core. Should be used by 388 * all drivers that use I2C bus to control the hardware. A module bound 389 * with dvb_module_probe() should use dvb_module_release() to unbind. 390 * 391 * Return: 392 * On success, return an &struct i2c_client, pointing to the bound 393 * I2C device. %NULL otherwise. 394 * 395 * .. note:: 396 * 397 * In the past, DVB modules (mainly, frontends) were bound via dvb_attach() 398 * macro, with does an ugly hack, using I2C low level functions. Such 399 * usage is deprecated and will be removed soon. Instead, use this routine. 400 */ 401 struct i2c_client *dvb_module_probe(const char *module_name, 402 const char *name, 403 struct i2c_adapter *adap, 404 unsigned char addr, 405 void *platform_data); 406 407 /** 408 * dvb_module_release - releases an I2C device allocated with 409 * dvb_module_probe(). 410 * 411 * @client: pointer to &struct i2c_client with the I2C client to be released. 412 * can be %NULL. 413 * 414 * This function should be used to free all resources reserved by 415 * dvb_module_probe() and unbinding the I2C hardware. 416 */ 417 void dvb_module_release(struct i2c_client *client); 418 419 #endif /* CONFIG_I2C */ 420 421 /* Legacy generic DVB attach function. */ 422 #ifdef CONFIG_MEDIA_ATTACH 423 424 /** 425 * dvb_attach - attaches a DVB frontend into the DVB core. 426 * 427 * @FUNCTION: function on a frontend module to be called. 428 * @ARGS: @FUNCTION arguments. 429 * 430 * This ancillary function loads a frontend module in runtime and runs 431 * the @FUNCTION function there, with @ARGS. 432 * As it increments symbol usage cont, at unregister, dvb_detach() 433 * should be called. 434 * 435 * .. note:: 436 * 437 * In the past, DVB modules (mainly, frontends) were bound via dvb_attach() 438 * macro, with does an ugly hack, using I2C low level functions. Such 439 * usage is deprecated and will be removed soon. Instead, you should use 440 * dvb_module_probe(). 441 */ 442 #define dvb_attach(FUNCTION, ARGS...) ({ \ 443 void *__r = NULL; \ 444 typeof(&FUNCTION) __a = symbol_request(FUNCTION); \ 445 if (__a) { \ 446 __r = (void *) __a(ARGS); \ 447 if (__r == NULL) \ 448 symbol_put(FUNCTION); \ 449 } else { \ 450 printk(KERN_ERR "DVB: Unable to find symbol "#FUNCTION"()\n"); \ 451 } \ 452 __r; \ 453 }) 454 455 /** 456 * dvb_detach - detaches a DVB frontend loaded via dvb_attach() 457 * 458 * @FUNC: attach function 459 * 460 * Decrements usage count for a function previously called via dvb_attach(). 461 */ 462 463 #define dvb_detach(FUNC) symbol_put_addr(FUNC) 464 465 #else 466 #define dvb_attach(FUNCTION, ARGS...) ({ \ 467 FUNCTION(ARGS); \ 468 }) 469 470 #define dvb_detach(FUNC) {} 471 472 #endif /* CONFIG_MEDIA_ATTACH */ 473 474 #endif /* #ifndef _DVBDEV_H_ */ 475