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