1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* dvb-usb.h is part of the DVB USB library. 3 * 4 * Copyright (C) 2004-6 Patrick Boettcher (patrick.boettcher@posteo.de) 5 * see dvb-usb-init.c for copyright information. 6 * 7 * the headerfile, all dvb-usb-drivers have to include. 8 * 9 * TODO: clean-up the structures for unused fields and update the comments 10 */ 11 #ifndef __DVB_USB_H__ 12 #define __DVB_USB_H__ 13 14 #include <linux/input.h> 15 #include <linux/usb.h> 16 #include <linux/firmware.h> 17 #include <linux/mutex.h> 18 #include <media/rc-core.h> 19 20 #include <media/dvb_frontend.h> 21 #include <media/dvb_demux.h> 22 #include <media/dvb_net.h> 23 #include <media/dmxdev.h> 24 25 #include "dvb-pll.h" 26 27 #include <media/dvb-usb-ids.h> 28 29 /* debug */ 30 #ifdef CONFIG_DVB_USB_DEBUG 31 #define dprintk(var,level,args...) \ 32 do { if ((var & level)) { printk(args); } } while (0) 33 34 #define debug_dump(b,l,func) {\ 35 int loop_; \ 36 for (loop_ = 0; loop_ < l; loop_++) func("%02x ", b[loop_]); \ 37 func("\n");\ 38 } 39 #define DVB_USB_DEBUG_STATUS 40 #else 41 #define dprintk(args...) 42 #define debug_dump(b,l,func) 43 44 #define DVB_USB_DEBUG_STATUS " (debugging is not enabled)" 45 46 #endif 47 48 /* generic log methods - taken from usb.h */ 49 #ifndef DVB_USB_LOG_PREFIX 50 #define DVB_USB_LOG_PREFIX "dvb-usb (please define a log prefix)" 51 #endif 52 53 #undef err 54 #define err(format, arg...) printk(KERN_ERR DVB_USB_LOG_PREFIX ": " format "\n" , ## arg) 55 #undef info 56 #define info(format, arg...) printk(KERN_INFO DVB_USB_LOG_PREFIX ": " format "\n" , ## arg) 57 #undef warn 58 #define warn(format, arg...) printk(KERN_WARNING DVB_USB_LOG_PREFIX ": " format "\n" , ## arg) 59 60 /** 61 * struct dvb_usb_device_description - name and its according USB IDs 62 * @name: real name of the box, regardless which DVB USB device class is in use 63 * @cold_ids: array of struct usb_device_id which describe the device in 64 * pre-firmware state 65 * @warm_ids: array of struct usb_device_id which describe the device in 66 * post-firmware state 67 * 68 * Each DVB USB device class can have one or more actual devices, this struct 69 * assigns a name to it. 70 */ 71 struct dvb_usb_device_description { 72 const char *name; 73 74 #define DVB_USB_ID_MAX_NUM 15 75 struct usb_device_id *cold_ids[DVB_USB_ID_MAX_NUM]; 76 struct usb_device_id *warm_ids[DVB_USB_ID_MAX_NUM]; 77 }; 78 79 static inline u8 rc5_custom(struct rc_map_table *key) 80 { 81 return (key->scancode >> 8) & 0xff; 82 } 83 84 static inline u8 rc5_data(struct rc_map_table *key) 85 { 86 return key->scancode & 0xff; 87 } 88 89 static inline u16 rc5_scan(struct rc_map_table *key) 90 { 91 return key->scancode & 0xffff; 92 } 93 94 struct dvb_usb_device; 95 struct dvb_usb_adapter; 96 struct usb_data_stream; 97 98 /* 99 * Properties of USB streaming - TODO this structure should be somewhere else 100 * describes the kind of USB transfer used for data-streaming. 101 * (BULK or ISOC) 102 */ 103 struct usb_data_stream_properties { 104 #define USB_BULK 1 105 #define USB_ISOC 2 106 int type; 107 int count; 108 int endpoint; 109 110 union { 111 struct { 112 int buffersize; /* per URB */ 113 } bulk; 114 struct { 115 int framesperurb; 116 int framesize; 117 int interval; 118 } isoc; 119 } u; 120 }; 121 122 /** 123 * struct dvb_usb_adapter_fe_properties - properties of a dvb-usb-adapter. 124 * A DVB-USB-Adapter is basically a dvb_adapter which is present on a USB-device. 125 * @caps: capabilities of the DVB USB device. 126 * @pid_filter_count: number of PID filter position in the optional hardware 127 * PID-filter. 128 * @num_frontends: number of frontends of the DVB USB adapter. 129 * @frontend_ctrl: called to power on/off active frontend. 130 * @streaming_ctrl: called to start and stop the MPEG2-TS streaming of the 131 * device (not URB submitting/killing). 132 * This callback will be called without data URBs being active - data URBs 133 * will be submitted only after streaming_ctrl(1) returns successfully and 134 * they will be killed before streaming_ctrl(0) gets called. 135 * @pid_filter_ctrl: called to en/disable the PID filter, if any. 136 * @pid_filter: called to set/unset a PID for filtering. 137 * @frontend_attach: called to attach the possible frontends (fill fe-field 138 * of struct dvb_usb_device). 139 * @tuner_attach: called to attach the correct tuner and to fill pll_addr, 140 * pll_desc and pll_init_buf of struct dvb_usb_device). 141 * @stream: configuration of the USB streaming 142 * @size_of_priv: size of the priv memory in struct dvb_usb_adapter 143 */ 144 struct dvb_usb_adapter_fe_properties { 145 #define DVB_USB_ADAP_HAS_PID_FILTER 0x01 146 #define DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF 0x02 147 #define DVB_USB_ADAP_NEED_PID_FILTERING 0x04 148 #define DVB_USB_ADAP_RECEIVES_204_BYTE_TS 0x08 149 #define DVB_USB_ADAP_RECEIVES_RAW_PAYLOAD 0x10 150 int caps; 151 int pid_filter_count; 152 153 int (*streaming_ctrl) (struct dvb_usb_adapter *, int); 154 int (*pid_filter_ctrl) (struct dvb_usb_adapter *, int); 155 int (*pid_filter) (struct dvb_usb_adapter *, int, u16, int); 156 157 int (*frontend_attach) (struct dvb_usb_adapter *); 158 int (*tuner_attach) (struct dvb_usb_adapter *); 159 160 struct usb_data_stream_properties stream; 161 162 int size_of_priv; 163 }; 164 165 #define MAX_NO_OF_FE_PER_ADAP 3 166 struct dvb_usb_adapter_properties { 167 int size_of_priv; 168 169 int (*frontend_ctrl) (struct dvb_frontend *, int); 170 171 int num_frontends; 172 struct dvb_usb_adapter_fe_properties fe[MAX_NO_OF_FE_PER_ADAP]; 173 }; 174 175 /** 176 * struct dvb_rc_legacy - old properties of remote controller 177 * @rc_map_table: a hard-wired array of struct rc_map_table (NULL to disable 178 * remote control handling). 179 * @rc_map_size: number of items in @rc_map_table. 180 * @rc_query: called to query an event event. 181 * @rc_interval: time in ms between two queries. 182 */ 183 struct dvb_rc_legacy { 184 /* remote control properties */ 185 #define REMOTE_NO_KEY_PRESSED 0x00 186 #define REMOTE_KEY_PRESSED 0x01 187 #define REMOTE_KEY_REPEAT 0x02 188 struct rc_map_table *rc_map_table; 189 int rc_map_size; 190 int (*rc_query) (struct dvb_usb_device *, u32 *, int *); 191 int rc_interval; 192 }; 193 194 /** 195 * struct dvb_rc - properties of remote controller, using rc-core 196 * @rc_codes: name of rc codes table 197 * @protocol: type of protocol(s) currently used by the driver 198 * @allowed_protos: protocol(s) supported by the driver 199 * @driver_type: Used to point if a device supports raw mode 200 * @change_protocol: callback to change protocol 201 * @module_name: module name 202 * @rc_query: called to query an event event. 203 * @rc_interval: time in ms between two queries. 204 * @bulk_mode: device supports bulk mode for RC (disable polling mode) 205 * @scancode_mask: scancode mask 206 */ 207 struct dvb_rc { 208 char *rc_codes; 209 u64 protocol; 210 u64 allowed_protos; 211 enum rc_driver_type driver_type; 212 int (*change_protocol)(struct rc_dev *dev, u64 *rc_proto); 213 char *module_name; 214 int (*rc_query) (struct dvb_usb_device *d); 215 int rc_interval; 216 bool bulk_mode; /* uses bulk mode */ 217 u32 scancode_mask; 218 }; 219 220 /** 221 * enum dvb_usb_mode - Specifies if it is using a legacy driver or a new one 222 * based on rc-core 223 * This is initialized/used only inside dvb-usb-remote.c. 224 * It shouldn't be set by the drivers. 225 * 226 * @DVB_RC_LEGACY: legacy driver 227 * @DVB_RC_CORE: rc-core driver 228 */ 229 enum dvb_usb_mode { 230 DVB_RC_LEGACY, 231 DVB_RC_CORE, 232 }; 233 234 /** 235 * struct dvb_usb_device_properties - properties of a dvb-usb-device 236 * @caps: capabilities 237 * @usb_ctrl: which USB device-side controller is in use. Needed for firmware 238 * download. 239 * @firmware: name of the firmware file. 240 * @download_firmware: called to download the firmware when the usb_ctrl is 241 * DEVICE_SPECIFIC. 242 * @no_reconnect: device doesn't do a reconnect after downloading the firmware, 243 * so do the warm initialization right after it 244 * 245 * @size_of_priv: how many bytes shall be allocated for the private field 246 * of struct dvb_usb_device. 247 * @priv_init: optional callback to initialize the variable that private field 248 * of struct dvb_usb_device has pointer to just after it had been allocated and 249 * zeroed. 250 * @priv_destroy: just like priv_init, only called before deallocating 251 * the memory pointed by private field of struct dvb_usb_device. 252 * 253 * @num_adapters: the number of adapters in @adapters 254 * @adapter: the adapters 255 * @power_ctrl: called to enable/disable power of the device. 256 * @read_mac_address: called to read the MAC address of the device. 257 * @identify_state: called to determine the state (cold or warm), when it 258 * is not distinguishable by the USB IDs. 259 * 260 * @rc: remote controller properties 261 * 262 * @i2c_algo: i2c_algorithm if the device has I2CoverUSB. 263 * 264 * @generic_bulk_ctrl_endpoint: most of the DVB USB devices have a generic 265 * endpoint which received control messages with bulk transfers. When this 266 * is non-zero, one can use dvb_usb_generic_rw and dvb_usb_generic_write- 267 * helper functions. 268 * 269 * @generic_bulk_ctrl_endpoint_response: some DVB USB devices use a separate 270 * endpoint for responses to control messages sent with bulk transfers via 271 * the generic_bulk_ctrl_endpoint. When this is non-zero, this will be used 272 * instead of the generic_bulk_ctrl_endpoint when reading usb responses in 273 * the dvb_usb_generic_rw helper function. 274 * 275 * @num_device_descs: number of struct dvb_usb_device_description in @devices 276 * @devices: array of struct dvb_usb_device_description compatibles with these 277 * properties. 278 */ 279 struct dvb_usb_device_properties { 280 #define MAX_NO_OF_ADAPTER_PER_DEVICE 2 281 #define DVB_USB_IS_AN_I2C_ADAPTER 0x01 282 int caps; 283 284 #define DEVICE_SPECIFIC 0 285 #define CYPRESS_AN2135 1 286 #define CYPRESS_AN2235 2 287 #define CYPRESS_FX2 3 288 int usb_ctrl; 289 int (*download_firmware) (struct usb_device *, const struct firmware *); 290 const char *firmware; 291 int no_reconnect; 292 293 int size_of_priv; 294 int (*priv_init)(struct dvb_usb_device *); 295 void (*priv_destroy)(struct dvb_usb_device *); 296 297 int num_adapters; 298 struct dvb_usb_adapter_properties adapter[MAX_NO_OF_ADAPTER_PER_DEVICE]; 299 300 int (*power_ctrl) (struct dvb_usb_device *, int); 301 int (*read_mac_address) (struct dvb_usb_device *, u8 []); 302 int (*identify_state)(struct usb_device *udev, 303 const struct dvb_usb_device_properties *props, 304 const struct dvb_usb_device_description **desc, 305 int *cold); 306 307 struct { 308 enum dvb_usb_mode mode; /* Drivers shouldn't touch on it */ 309 struct dvb_rc_legacy legacy; 310 struct dvb_rc core; 311 } rc; 312 313 struct i2c_algorithm *i2c_algo; 314 315 int generic_bulk_ctrl_endpoint; 316 int generic_bulk_ctrl_endpoint_response; 317 318 int num_device_descs; 319 struct dvb_usb_device_description devices[12]; 320 }; 321 322 /** 323 * struct usb_data_stream - generic object of an USB stream 324 * @udev: the USB device 325 * @props: data stream properties 326 * @state: state of the stream 327 * @complete: complete callback 328 * @urb_list: list of URBs 329 * @buf_num: number of buffer allocated. 330 * @buf_size: size of each buffer in buf_list. 331 * @buf_list: array containing all allocate buffers for streaming. 332 * @dma_addr: list of dma_addr_t for each buffer in buf_list. 333 * 334 * @urbs_initialized: number of URBs initialized. 335 * @urbs_submitted: number of URBs submitted. 336 * @user_priv: for private use. 337 */ 338 struct usb_data_stream { 339 #define MAX_NO_URBS_FOR_DATA_STREAM 10 340 struct usb_device *udev; 341 struct usb_data_stream_properties props; 342 343 #define USB_STATE_INIT 0x00 344 #define USB_STATE_URB_BUF 0x01 345 int state; 346 347 void (*complete) (struct usb_data_stream *, u8 *, size_t); 348 349 struct urb *urb_list[MAX_NO_URBS_FOR_DATA_STREAM]; 350 int buf_num; 351 unsigned long buf_size; 352 u8 *buf_list[MAX_NO_URBS_FOR_DATA_STREAM]; 353 dma_addr_t dma_addr[MAX_NO_URBS_FOR_DATA_STREAM]; 354 355 int urbs_initialized; 356 int urbs_submitted; 357 358 void *user_priv; 359 }; 360 361 /** 362 * struct dvb_usb_fe_adapter - a DVB adapter on a USB device 363 * @fe: frontend 364 * @fe_init: rerouted frontend-init (wakeup) function. 365 * @fe_sleep: rerouted frontend-sleep function. 366 * @stream: the usb data stream. 367 * @pid_filtering: is hardware pid_filtering used or not. 368 * @max_feed_count: how many feeds can be handled simultaneously by this 369 * device 370 * @priv: private pointer 371 */ 372 struct dvb_usb_fe_adapter { 373 struct dvb_frontend *fe; 374 375 int (*fe_init) (struct dvb_frontend *); 376 int (*fe_sleep) (struct dvb_frontend *); 377 378 struct usb_data_stream stream; 379 380 int pid_filtering; 381 int max_feed_count; 382 383 void *priv; 384 }; 385 386 /** 387 * struct dvb_usb_adapter - a DVB adapter on a USB device 388 * @dev: DVB USB device pointer 389 * @props: properties 390 * @state: status 391 * @id: index of this adapter (starting with 0). 392 * 393 * @feedcount: number of requested feeds (used for streaming-activation) 394 * 395 * @dvb_adap: device's dvb_adapter. 396 * @dmxdev: device's dmxdev. 397 * @demux: device's software demuxer. 398 * @dvb_net: device's dvb_net interfaces. 399 * 400 * @fe_adap: frontend adapters 401 * @active_fe: active frontend 402 * @num_frontends_initialized: number of initialized frontends 403 * @priv: private pointer 404 */ 405 struct dvb_usb_adapter { 406 struct dvb_usb_device *dev; 407 struct dvb_usb_adapter_properties props; 408 409 #define DVB_USB_ADAP_STATE_INIT 0x000 410 #define DVB_USB_ADAP_STATE_DVB 0x001 411 int state; 412 413 u8 id; 414 415 int feedcount; 416 417 /* dvb */ 418 struct dvb_adapter dvb_adap; 419 struct dmxdev dmxdev; 420 struct dvb_demux demux; 421 struct dvb_net dvb_net; 422 423 struct dvb_usb_fe_adapter fe_adap[MAX_NO_OF_FE_PER_ADAP]; 424 int active_fe; 425 int num_frontends_initialized; 426 427 void *priv; 428 }; 429 430 /** 431 * struct dvb_usb_device - object of a DVB USB device 432 * @props: copy of the struct dvb_usb_properties this device belongs to. 433 * @desc: pointer to the device's struct dvb_usb_device_description. 434 * @state: initialization and runtime state of the device. 435 * 436 * @powered: indicated whether the device is power or not. 437 * Powered is in/decremented for each call to modify the state. 438 * @udev: pointer to the device's struct usb_device. 439 * 440 * @data_mutex: mutex to protect the data structure used to store URB data 441 * @usb_mutex: mutex of USB control messages (reading needs two messages). 442 * Please notice that this mutex is used internally at the generic 443 * URB control functions. So, drivers using dvb_usb_generic_rw() and 444 * derivated functions should not lock it internally. 445 * @i2c_mutex: mutex for i2c-transfers 446 * 447 * @i2c_adap: device's i2c_adapter if it uses I2CoverUSB 448 * 449 * @num_adapters_initialized: number of initialized adapters 450 * @adapter: adapters 451 * 452 * @rc_dev: rc device for the remote control (rc-core mode) 453 * @input_dev: input device for the remote control (legacy mode) 454 * @rc_phys: rc device path 455 * @rc_query_work: struct work_struct frequent rc queries 456 * @last_event: last triggered event 457 * @last_state: last state (no, pressed, repeat) 458 * @owner: owner of the dvb_adapter 459 * @priv: private data of the actual driver (allocate by dvb-usb, size defined 460 * in size_of_priv of dvb_usb_properties). 461 */ 462 struct dvb_usb_device { 463 struct dvb_usb_device_properties props; 464 const struct dvb_usb_device_description *desc; 465 466 struct usb_device *udev; 467 468 #define DVB_USB_STATE_INIT 0x000 469 #define DVB_USB_STATE_I2C 0x001 470 #define DVB_USB_STATE_DVB 0x002 471 #define DVB_USB_STATE_REMOTE 0x004 472 int state; 473 474 int powered; 475 476 /* locking */ 477 struct mutex data_mutex; 478 struct mutex usb_mutex; 479 480 /* i2c */ 481 struct mutex i2c_mutex; 482 struct i2c_adapter i2c_adap; 483 484 int num_adapters_initialized; 485 struct dvb_usb_adapter adapter[MAX_NO_OF_ADAPTER_PER_DEVICE]; 486 487 /* remote control */ 488 struct rc_dev *rc_dev; 489 struct input_dev *input_dev; 490 char rc_phys[64]; 491 struct delayed_work rc_query_work; 492 u32 last_event; 493 int last_state; 494 495 struct module *owner; 496 497 void *priv; 498 }; 499 500 extern int dvb_usb_device_init(struct usb_interface *, 501 const struct dvb_usb_device_properties *, 502 struct module *, struct dvb_usb_device **, 503 short *adapter_nums); 504 extern void dvb_usb_device_exit(struct usb_interface *); 505 506 /* the generic read/write method for device control */ 507 extern int __must_check 508 dvb_usb_generic_rw(struct dvb_usb_device *, u8 *, u16, u8 *, u16, int); 509 extern int __must_check 510 dvb_usb_generic_write(struct dvb_usb_device *, u8 *, u16); 511 512 /* commonly used remote control parsing */ 513 extern int dvb_usb_nec_rc_key_to_event(struct dvb_usb_device *, u8[], u32 *, int *); 514 515 /* commonly used firmware download types and function */ 516 struct hexline { 517 u8 len; 518 u32 addr; 519 u8 type; 520 u8 data[255]; 521 u8 chk; 522 }; 523 extern int usb_cypress_load_firmware(struct usb_device *udev, const struct firmware *fw, int type); 524 extern int dvb_usb_get_hexline(const struct firmware *fw, struct hexline *hx, int *pos); 525 526 527 #endif 528