drivers/media/dvb/dvb-usb/dvb-usb.h

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