drivers/media/video/pvrusb2/pvrusb2-hdw-internal.h

   1 /*
   2  *
   3  *
   4  *  Copyright (C) 2005 Mike Isely <isely@pobox.com>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  *
  19  */
  20 #ifndef __PVRUSB2_HDW_INTERNAL_H
  21 #define __PVRUSB2_HDW_INTERNAL_H
  22
  23 /*
  24
  25   This header sets up all the internal structures and definitions needed to
  26   track and coordinate the driver's interaction with the hardware.  ONLY
  27   source files which actually implement part of that whole circus should be
  28   including this header.  Higher levels, like the external layers to the
  29   various public APIs (V4L, sysfs, etc) should NOT ever include this
  30   private, internal header.  This means that pvrusb2-hdw, pvrusb2-encoder,
  31   etc will include this, but pvrusb2-v4l should not.
  32
  33 */
  34
  35 #include <linux/videodev2.h>
  36 #include <linux/i2c.h>
  37 #include <linux/workqueue.h>
  38 #include <linux/mutex.h>
  39 #include "pvrusb2-hdw.h"
  40 #include "pvrusb2-io.h"
  41 #include <media/cx2341x.h>
  42 #include "pvrusb2-devattr.h"
  43
  44 /* Legal values for PVR2_CID_HSM */
  45 #define PVR2_CVAL_HSM_FAIL 0
  46 #define PVR2_CVAL_HSM_FULL 1
  47 #define PVR2_CVAL_HSM_HIGH 2
  48
  49 #define PVR2_VID_ENDPOINT        0x84
  50 #define PVR2_UNK_ENDPOINT        0x86    /* maybe raw yuv ? */
  51 #define PVR2_VBI_ENDPOINT        0x88
  52
  53 #define PVR2_CTL_BUFFSIZE        64
  54
  55 #define FREQTABLE_SIZE 500
  56
  57 #define LOCK_TAKE(x) do { mutex_lock(&x##_mutex); x##_held = !0; } while (0)
  58 #define LOCK_GIVE(x) do { x##_held = 0; mutex_unlock(&x##_mutex); } while (0)
  59
  60 struct pvr2_decoder;
  61
  62 typedef int (*pvr2_ctlf_is_dirty)(struct pvr2_ctrl *);
  63 typedef void (*pvr2_ctlf_clear_dirty)(struct pvr2_ctrl *);
  64 typedef int (*pvr2_ctlf_check_value)(struct pvr2_ctrl *,int);
  65 typedef int (*pvr2_ctlf_get_value)(struct pvr2_ctrl *,int *);
  66 typedef int (*pvr2_ctlf_set_value)(struct pvr2_ctrl *,int msk,int val);
  67 typedef int (*pvr2_ctlf_val_to_sym)(struct pvr2_ctrl *,int msk,int val,
  68                                     char *,unsigned int,unsigned int *);
  69 typedef int (*pvr2_ctlf_sym_to_val)(struct pvr2_ctrl *,
  70                                     const char *,unsigned int,
  71                                     int *mskp,int *valp);
  72 typedef unsigned int (*pvr2_ctlf_get_v4lflags)(struct pvr2_ctrl *);
  73
  74 /* This structure describes a specific control.  A table of these is set up
  75    in pvrusb2-hdw.c. */
  76 struct pvr2_ctl_info {
  77         /* Control's name suitable for use as an identifier */
  78         const char *name;
  79
  80         /* Short description of control */
  81         const char *desc;
  82
  83         /* Control's implementation */
  84         pvr2_ctlf_get_value get_value;      /* Get its value */
  85         pvr2_ctlf_get_value get_def_value;  /* Get its default value */
  86         pvr2_ctlf_get_value get_min_value;  /* Get minimum allowed value */
  87         pvr2_ctlf_get_value get_max_value;  /* Get maximum allowed value */
  88         pvr2_ctlf_set_value set_value;      /* Set its value */
  89         pvr2_ctlf_check_value check_value;  /* Check that value is valid */
  90         pvr2_ctlf_val_to_sym val_to_sym;    /* Custom convert value->symbol */
  91         pvr2_ctlf_sym_to_val sym_to_val;    /* Custom convert symbol->value */
  92         pvr2_ctlf_is_dirty is_dirty;        /* Return true if dirty */
  93         pvr2_ctlf_clear_dirty clear_dirty;  /* Clear dirty state */
  94         pvr2_ctlf_get_v4lflags get_v4lflags;/* Retrieve v4l flags */
  95
  96         /* Control's type (int, enum, bitmask) */
  97         enum pvr2_ctl_type type;
  98
  99         /* Associated V4L control ID, if any */
 100         int v4l_id;
 101
 102         /* Associated driver internal ID, if any */
 103         int internal_id;
 104
 105         /* Don't implicitly initialize this control's value */
 106         int skip_init;
 107
 108         /* Starting value for this control */
 109         int default_value;
 110
 111         /* Type-specific control information */
 112         union {
 113                 struct { /* Integer control */
 114                         long min_value; /* lower limit */
 115                         long max_value; /* upper limit */
 116                 } type_int;
 117                 struct { /* enumerated control */
 118                         unsigned int count;       /* enum value count */
 119                         const char **value_names; /* symbol names */
 120                 } type_enum;
 121                 struct { /* bitmask control */
 122                         unsigned int valid_bits; /* bits in use */
 123                         const char **bit_names;  /* symbol name/bit */
 124                 } type_bitmask;
 125         } def;
 126 };
 127
 128
 129 /* Same as pvr2_ctl_info, but includes storage for the control description */
 130 #define PVR2_CTLD_INFO_DESC_SIZE 32
 131 struct pvr2_ctld_info {
 132         struct pvr2_ctl_info info;
 133         char desc[PVR2_CTLD_INFO_DESC_SIZE];
 134 };
 135
 136 struct pvr2_ctrl {
 137         const struct pvr2_ctl_info *info;
 138         struct pvr2_hdw *hdw;
 139 };
 140
 141
 142 struct pvr2_decoder_ctrl {
 143         void *ctxt;
 144         void (*detach)(void *);
 145         void (*enable)(void *,int);
 146         void (*force_reset)(void *);
 147 };
 148
 149 #define PVR2_I2C_PEND_DETECT  0x01  /* Need to detect a client type */
 150 #define PVR2_I2C_PEND_CLIENT  0x02  /* Client needs a specific update */
 151 #define PVR2_I2C_PEND_REFRESH 0x04  /* Client has specific pending bits */
 152 #define PVR2_I2C_PEND_STALE   0x08  /* Broadcast pending bits */
 153
 154 #define PVR2_I2C_PEND_ALL (PVR2_I2C_PEND_DETECT |\
 155                            PVR2_I2C_PEND_CLIENT |\
 156                            PVR2_I2C_PEND_REFRESH |\
 157                            PVR2_I2C_PEND_STALE)
 158
 159 /* Disposition of firmware1 loading situation */
 160 #define FW1_STATE_UNKNOWN 0
 161 #define FW1_STATE_MISSING 1
 162 #define FW1_STATE_FAILED 2
 163 #define FW1_STATE_RELOAD 3
 164 #define FW1_STATE_OK 4
 165
 166 /* What state the device is in if it is a hybrid */
 167 #define PVR2_PATHWAY_UNKNOWN 0
 168 #define PVR2_PATHWAY_ANALOG 1
 169 #define PVR2_PATHWAY_DIGITAL 2
 170
 171 typedef int (*pvr2_i2c_func)(struct pvr2_hdw *,u8,u8 *,u16,u8 *, u16);
 172 #define PVR2_I2C_FUNC_CNT 128
 173
 174 /* This structure contains all state data directly needed to
 175    manipulate the hardware (as opposed to complying with a kernel
 176    interface) */
 177 struct pvr2_hdw {
 178         /* Underlying USB device handle */
 179         struct usb_device *usb_dev;
 180         struct usb_interface *usb_intf;
 181
 182         /* Device description, anything that must adjust behavior based on
 183            device specific info will use information held here. */
 184         const struct pvr2_device_desc *hdw_desc;
 185
 186         /* Kernel worker thread handling */
 187         struct workqueue_struct *workqueue;
 188         struct work_struct workpoll;     /* Update driver state */
 189         struct work_struct worki2csync;  /* Update i2c clients */
 190
 191         /* Video spigot */
 192         struct pvr2_stream *vid_stream;
 193
 194         /* Mutex for all hardware state control */
 195         struct mutex big_lock_mutex;
 196         int big_lock_held;  /* For debugging */
 197
 198         /* This is a simple string which identifies the instance of this
 199            driver.  It is unique within the set of existing devices, but
 200            there is no attempt to keep the name consistent with the same
 201            physical device each time. */
 202         char name[32];
 203
 204         /* This is a simple string which identifies the physical device
 205            instance itself - if possible.  (If not possible, then it is
 206            based on the specific driver instance, similar to name above.)
 207            The idea here is that userspace might hopefully be able to use
 208            this recognize specific tuners.  It will encode a serial number,
 209            if available. */
 210         char identifier[32];
 211
 212         /* I2C stuff */
 213         struct i2c_adapter i2c_adap;
 214         struct i2c_algorithm i2c_algo;
 215         pvr2_i2c_func i2c_func[PVR2_I2C_FUNC_CNT];
 216         int i2c_cx25840_hack_state;
 217         int i2c_linked;
 218         unsigned int i2c_pend_types;    /* Which types of update are needed */
 219         unsigned long i2c_pend_mask;    /* Change bits we need to scan */
 220         unsigned long i2c_stale_mask;   /* Pending broadcast change bits */
 221         unsigned long i2c_active_mask;  /* All change bits currently in use */
 222         struct list_head i2c_clients;
 223         struct mutex i2c_list_lock;
 224
 225         /* Frequency table */
 226         unsigned int freqTable[FREQTABLE_SIZE];
 227         unsigned int freqProgSlot;
 228
 229         /* Stuff for handling low level control interaction with device */
 230         struct mutex ctl_lock_mutex;
 231         int ctl_lock_held;  /* For debugging */
 232         struct urb *ctl_write_urb;
 233         struct urb *ctl_read_urb;
 234         unsigned char *ctl_write_buffer;
 235         unsigned char *ctl_read_buffer;
 236         int ctl_write_pend_flag;
 237         int ctl_read_pend_flag;
 238         int ctl_timeout_flag;
 239         struct completion ctl_done;
 240         unsigned char cmd_buffer[PVR2_CTL_BUFFSIZE];
 241         int cmd_debug_state;               // Low level command debugging info
 242         unsigned char cmd_debug_code;      //
 243         unsigned int cmd_debug_write_len;  //
 244         unsigned int cmd_debug_read_len;   //
 245
 246         /* Bits of state that describe what is going on with various parts
 247            of the driver. */
 248         int state_pathway_ok;         /* Pathway config is ok */
 249         int state_encoder_ok;         /* Encoder is operational */
 250         int state_encoder_run;        /* Encoder is running */
 251         int state_encoder_config;     /* Encoder is configured */
 252         int state_encoder_waitok;     /* Encoder pre-wait done */
 253         int state_encoder_runok;      /* Encoder has run for >= .25 sec */
 254         int state_decoder_run;        /* Decoder is running */
 255         int state_usbstream_run;      /* FX2 is streaming */
 256         int state_decoder_quiescent;  /* Decoder idle for > 50msec */
 257         int state_pipeline_config;    /* Pipeline is configured */
 258         int state_pipeline_req;       /* Somebody wants to stream */
 259         int state_pipeline_pause;     /* Pipeline must be paused */
 260         int state_pipeline_idle;      /* Pipeline not running */
 261
 262         /* This is the master state of the driver.  It is the combined
 263            result of other bits of state.  Examining this will indicate the
 264            overall state of the driver.  Values here are one of
 265            PVR2_STATE_xxxx */
 266         unsigned int master_state;
 267
 268         /* True if device led is currently on */
 269         int led_on;
 270
 271         /* True if states must be re-evaluated */
 272         int state_stale;
 273
 274         void (*state_func)(void *);
 275         void *state_data;
 276
 277         /* Timer for measuring decoder settling time */
 278         struct timer_list quiescent_timer;
 279
 280         /* Timer for measuring encoder pre-wait time */
 281         struct timer_list encoder_wait_timer;
 282
 283         /* Timer for measuring encoder minimum run time */
 284         struct timer_list encoder_run_timer;
 285
 286         /* Place to block while waiting for state changes */
 287         wait_queue_head_t state_wait_data;
 288
 289
 290         int flag_ok;            /* device in known good state */
 291         int flag_disconnected;  /* flag_ok == 0 due to disconnect */
 292         int flag_init_ok;       /* true if structure is fully initialized */
 293         int fw1_state;          /* current situation with fw1 */
 294         int pathway_state;      /* one of PVR2_PATHWAY_xxx */
 295         int flag_decoder_missed;/* We've noticed missing decoder */
 296         int flag_tripped;       /* Indicates overall failure to start */
 297
 298         struct pvr2_decoder_ctrl *decoder_ctrl;
 299
 300         // CPU firmware info (used to help find / save firmware data)
 301         char *fw_buffer;
 302         unsigned int fw_size;
 303         int fw_cpu_flag; /* True if we are dealing with the CPU */
 304
 305         // True if there is a request to trigger logging of state in each
 306         // module.
 307         int log_requested;
 308
 309         /* Tuner / frequency control stuff */
 310         unsigned int tuner_type;
 311         int tuner_updated;
 312         unsigned int freqValTelevision;  /* Current freq for tv mode */
 313         unsigned int freqValRadio;       /* Current freq for radio mode */
 314         unsigned int freqSlotTelevision; /* Current slot for tv mode */
 315         unsigned int freqSlotRadio;      /* Current slot for radio mode */
 316         unsigned int freqSelector;       /* 0=radio 1=television */
 317         int freqDirty;
 318
 319         /* Current tuner info - this information is polled from the I2C bus */
 320         struct v4l2_tuner tuner_signal_info;
 321         int tuner_signal_stale;
 322
 323         /* Cropping capability info */
 324         struct v4l2_cropcap cropcap_info;
 325         int cropcap_stale;
 326
 327         /* Video standard handling */
 328         v4l2_std_id std_mask_eeprom; // Hardware supported selections
 329         v4l2_std_id std_mask_avail;  // Which standards we may select from
 330         v4l2_std_id std_mask_cur;    // Currently selected standard(s)
 331         unsigned int std_enum_cnt;   // # of enumerated standards
 332         int std_enum_cur;            // selected standard enumeration value
 333         int std_dirty;               // True if std_mask_cur has changed
 334         struct pvr2_ctl_info std_info_enum;
 335         struct pvr2_ctl_info std_info_avail;
 336         struct pvr2_ctl_info std_info_cur;
 337         struct v4l2_standard *std_defs;
 338         const char **std_enum_names;
 339
 340         // Generated string names, one per actual V4L2 standard
 341         const char *std_mask_ptrs[32];
 342         char std_mask_names[32][10];
 343
 344         int unit_number;             /* ID for driver instance */
 345         unsigned long serial_number; /* ID for hardware itself */
 346
 347         char bus_info[32]; /* Bus location info */
 348
 349         /* Minor numbers used by v4l logic (yes, this is a hack, as there
 350            should be no v4l junk here).  Probably a better way to do this. */
 351         int v4l_minor_number_video;
 352         int v4l_minor_number_vbi;
 353         int v4l_minor_number_radio;
 354
 355         /* Bit mask of PVR2_CVAL_INPUT choices which are valid for the hardware */
 356         unsigned int input_avail_mask;
 357         /* Bit mask of PVR2_CVAL_INPUT choices which are currenly allowed */
 358         unsigned int input_allowed_mask;
 359
 360         /* Location of eeprom or a negative number if none */
 361         int eeprom_addr;
 362
 363         enum pvr2_config active_stream_type;
 364         enum pvr2_config desired_stream_type;
 365
 366         /* Control state needed for cx2341x module */
 367         struct cx2341x_mpeg_params enc_cur_state;
 368         struct cx2341x_mpeg_params enc_ctl_state;
 369         /* True if an encoder attribute has changed */
 370         int enc_stale;
 371         /* True if an unsafe encoder attribute has changed */
 372         int enc_unsafe_stale;
 373         /* True if enc_cur_state is valid */
 374         int enc_cur_valid;
 375
 376         /* Control state */
 377 #define VCREATE_DATA(lab) int lab##_val; int lab##_dirty
 378         VCREATE_DATA(brightness);
 379         VCREATE_DATA(contrast);
 380         VCREATE_DATA(saturation);
 381         VCREATE_DATA(hue);
 382         VCREATE_DATA(volume);
 383         VCREATE_DATA(balance);
 384         VCREATE_DATA(bass);
 385         VCREATE_DATA(treble);
 386         VCREATE_DATA(mute);
 387         VCREATE_DATA(cropl);
 388         VCREATE_DATA(cropt);
 389         VCREATE_DATA(cropw);
 390         VCREATE_DATA(croph);
 391         VCREATE_DATA(input);
 392         VCREATE_DATA(audiomode);
 393         VCREATE_DATA(res_hor);
 394         VCREATE_DATA(res_ver);
 395         VCREATE_DATA(srate);
 396 #undef VCREATE_DATA
 397
 398         struct pvr2_ctld_info *mpeg_ctrl_info;
 399
 400         struct pvr2_ctrl *controls;
 401         unsigned int control_cnt;
 402 };
 403
 404 /* This function gets the current frequency */
 405 unsigned long pvr2_hdw_get_cur_freq(struct pvr2_hdw *);
 406 void pvr2_hdw_set_decoder(struct pvr2_hdw *,struct pvr2_decoder_ctrl *);
 407
 408 #endif /* __PVRUSB2_HDW_INTERNAL_H */
 409
 410 /*
 411   Stuff for Emacs to see, in order to encourage consistent editing style:
 412   *** Local Variables: ***
 413   *** mode: c ***
 414   *** fill-column: 75 ***
 415   *** tab-width: 8 ***
 416   *** c-basic-offset: 8 ***
 417   *** End: ***
 418   */