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_min_value;  /* Get minimum allowed value */
  86         pvr2_ctlf_get_value get_max_value;  /* Get maximum allowed value */
  87         pvr2_ctlf_set_value set_value;      /* Set its value */
  88         pvr2_ctlf_check_value check_value;  /* Check that value is valid */
  89         pvr2_ctlf_val_to_sym val_to_sym;    /* Custom convert value->symbol */
  90         pvr2_ctlf_sym_to_val sym_to_val;    /* Custom convert symbol->value */
  91         pvr2_ctlf_is_dirty is_dirty;        /* Return true if dirty */
  92         pvr2_ctlf_clear_dirty clear_dirty;  /* Clear dirty state */
  93         pvr2_ctlf_get_v4lflags get_v4lflags;/* Retrieve v4l flags */
  94
  95         /* Control's type (int, enum, bitmask) */
  96         enum pvr2_ctl_type type;
  97
  98         /* Associated V4L control ID, if any */
  99         int v4l_id;
 100
 101         /* Associated driver internal ID, if any */
 102         int internal_id;
 103
 104         /* Don't implicitly initialize this control's value */
 105         int skip_init;
 106
 107         /* Starting value for this control */
 108         int default_value;
 109
 110         /* Type-specific control information */
 111         union {
 112                 struct { /* Integer control */
 113                         long min_value; /* lower limit */
 114                         long max_value; /* upper limit */
 115                 } type_int;
 116                 struct { /* enumerated control */
 117                         unsigned int count;       /* enum value count */
 118                         const char **value_names; /* symbol names */
 119                 } type_enum;
 120                 struct { /* bitmask control */
 121                         unsigned int valid_bits; /* bits in use */
 122                         const char **bit_names;  /* symbol name/bit */
 123                 } type_bitmask;
 124         } def;
 125 };
 126
 127
 128 /* Same as pvr2_ctl_info, but includes storage for the control description */
 129 #define PVR2_CTLD_INFO_DESC_SIZE 32
 130 struct pvr2_ctld_info {
 131         struct pvr2_ctl_info info;
 132         char desc[PVR2_CTLD_INFO_DESC_SIZE];
 133 };
 134
 135 struct pvr2_ctrl {
 136         const struct pvr2_ctl_info *info;
 137         struct pvr2_hdw *hdw;
 138 };
 139
 140
 141 struct pvr2_decoder_ctrl {
 142         void *ctxt;
 143         void (*detach)(void *);
 144         void (*enable)(void *,int);
 145         void (*force_reset)(void *);
 146 };
 147
 148 #define PVR2_I2C_PEND_DETECT  0x01  /* Need to detect a client type */
 149 #define PVR2_I2C_PEND_CLIENT  0x02  /* Client needs a specific update */
 150 #define PVR2_I2C_PEND_REFRESH 0x04  /* Client has specific pending bits */
 151 #define PVR2_I2C_PEND_STALE   0x08  /* Broadcast pending bits */
 152
 153 #define PVR2_I2C_PEND_ALL (PVR2_I2C_PEND_DETECT |\
 154                            PVR2_I2C_PEND_CLIENT |\
 155                            PVR2_I2C_PEND_REFRESH |\
 156                            PVR2_I2C_PEND_STALE)
 157
 158 /* Disposition of firmware1 loading situation */
 159 #define FW1_STATE_UNKNOWN 0
 160 #define FW1_STATE_MISSING 1
 161 #define FW1_STATE_FAILED 2
 162 #define FW1_STATE_RELOAD 3
 163 #define FW1_STATE_OK 4
 164
 165 /* What state the device is in if it is a hybrid */
 166 #define PVR2_PATHWAY_UNKNOWN 0
 167 #define PVR2_PATHWAY_ANALOG 1
 168 #define PVR2_PATHWAY_DIGITAL 2
 169
 170 typedef int (*pvr2_i2c_func)(struct pvr2_hdw *,u8,u8 *,u16,u8 *, u16);
 171 #define PVR2_I2C_FUNC_CNT 128
 172
 173 /* This structure contains all state data directly needed to
 174    manipulate the hardware (as opposed to complying with a kernel
 175    interface) */
 176 struct pvr2_hdw {
 177         /* Underlying USB device handle */
 178         struct usb_device *usb_dev;
 179         struct usb_interface *usb_intf;
 180
 181         /* Device description, anything that must adjust behavior based on
 182            device specific info will use information held here. */
 183         const struct pvr2_device_desc *hdw_desc;
 184
 185         /* Kernel worker thread handling */
 186         struct workqueue_struct *workqueue;
 187         struct work_struct workpoll;     /* Update driver state */
 188         struct work_struct worki2csync;  /* Update i2c clients */
 189
 190         /* Video spigot */
 191         struct pvr2_stream *vid_stream;
 192
 193         /* Mutex for all hardware state control */
 194         struct mutex big_lock_mutex;
 195         int big_lock_held;  /* For debugging */
 196
 197         char name[32];
 198
 199         /* I2C stuff */
 200         struct i2c_adapter i2c_adap;
 201         struct i2c_algorithm i2c_algo;
 202         pvr2_i2c_func i2c_func[PVR2_I2C_FUNC_CNT];
 203         int i2c_cx25840_hack_state;
 204         int i2c_linked;
 205         unsigned int i2c_pend_types;    /* Which types of update are needed */
 206         unsigned long i2c_pend_mask;    /* Change bits we need to scan */
 207         unsigned long i2c_stale_mask;   /* Pending broadcast change bits */
 208         unsigned long i2c_active_mask;  /* All change bits currently in use */
 209         struct list_head i2c_clients;
 210         struct mutex i2c_list_lock;
 211
 212         /* Frequency table */
 213         unsigned int freqTable[FREQTABLE_SIZE];
 214         unsigned int freqProgSlot;
 215
 216         /* Stuff for handling low level control interaction with device */
 217         struct mutex ctl_lock_mutex;
 218         int ctl_lock_held;  /* For debugging */
 219         struct urb *ctl_write_urb;
 220         struct urb *ctl_read_urb;
 221         unsigned char *ctl_write_buffer;
 222         unsigned char *ctl_read_buffer;
 223         int ctl_write_pend_flag;
 224         int ctl_read_pend_flag;
 225         int ctl_timeout_flag;
 226         struct completion ctl_done;
 227         unsigned char cmd_buffer[PVR2_CTL_BUFFSIZE];
 228         int cmd_debug_state;               // Low level command debugging info
 229         unsigned char cmd_debug_code;      //
 230         unsigned int cmd_debug_write_len;  //
 231         unsigned int cmd_debug_read_len;   //
 232
 233         /* Bits of state that describe what is going on with various parts
 234            of the driver. */
 235         int state_pathway_ok;         /* Pathway config is ok */
 236         int state_encoder_ok;         /* Encoder is operational */
 237         int state_encoder_run;        /* Encoder is running */
 238         int state_encoder_config;     /* Encoder is configured */
 239         int state_encoder_waitok;     /* Encoder pre-wait done */
 240         int state_encoder_runok;      /* Encoder has run for >= .25 sec */
 241         int state_decoder_run;        /* Decoder is running */
 242         int state_usbstream_run;      /* FX2 is streaming */
 243         int state_decoder_quiescent;  /* Decoder idle for > 50msec */
 244         int state_pipeline_config;    /* Pipeline is configured */
 245         int state_pipeline_req;       /* Somebody wants to stream */
 246         int state_pipeline_pause;     /* Pipeline must be paused */
 247         int state_pipeline_idle;      /* Pipeline not running */
 248
 249         /* This is the master state of the driver.  It is the combined
 250            result of other bits of state.  Examining this will indicate the
 251            overall state of the driver.  Values here are one of
 252            PVR2_STATE_xxxx */
 253         unsigned int master_state;
 254
 255         /* True if device led is currently on */
 256         int led_on;
 257
 258         /* True if states must be re-evaluated */
 259         int state_stale;
 260
 261         void (*state_func)(void *);
 262         void *state_data;
 263
 264         /* Timer for measuring decoder settling time */
 265         struct timer_list quiescent_timer;
 266
 267         /* Timer for measuring encoder pre-wait time */
 268         struct timer_list encoder_wait_timer;
 269
 270         /* Timer for measuring encoder minimum run time */
 271         struct timer_list encoder_run_timer;
 272
 273         /* Place to block while waiting for state changes */
 274         wait_queue_head_t state_wait_data;
 275
 276
 277         int flag_ok;            /* device in known good state */
 278         int flag_disconnected;  /* flag_ok == 0 due to disconnect */
 279         int flag_init_ok;       /* true if structure is fully initialized */
 280         int fw1_state;          /* current situation with fw1 */
 281         int pathway_state;      /* one of PVR2_PATHWAY_xxx */
 282         int flag_decoder_missed;/* We've noticed missing decoder */
 283         int flag_tripped;       /* Indicates overall failure to start */
 284
 285         struct pvr2_decoder_ctrl *decoder_ctrl;
 286
 287         // CPU firmware info (used to help find / save firmware data)
 288         char *fw_buffer;
 289         unsigned int fw_size;
 290         int fw_cpu_flag; /* True if we are dealing with the CPU */
 291
 292         // True if there is a request to trigger logging of state in each
 293         // module.
 294         int log_requested;
 295
 296         /* Tuner / frequency control stuff */
 297         unsigned int tuner_type;
 298         int tuner_updated;
 299         unsigned int freqValTelevision;  /* Current freq for tv mode */
 300         unsigned int freqValRadio;       /* Current freq for radio mode */
 301         unsigned int freqSlotTelevision; /* Current slot for tv mode */
 302         unsigned int freqSlotRadio;      /* Current slot for radio mode */
 303         unsigned int freqSelector;       /* 0=radio 1=television */
 304         int freqDirty;
 305
 306         /* Current tuner info - this information is polled from the I2C bus */
 307         struct v4l2_tuner tuner_signal_info;
 308         int tuner_signal_stale;
 309
 310         /* Video standard handling */
 311         v4l2_std_id std_mask_eeprom; // Hardware supported selections
 312         v4l2_std_id std_mask_avail;  // Which standards we may select from
 313         v4l2_std_id std_mask_cur;    // Currently selected standard(s)
 314         unsigned int std_enum_cnt;   // # of enumerated standards
 315         int std_enum_cur;            // selected standard enumeration value
 316         int std_dirty;               // True if std_mask_cur has changed
 317         struct pvr2_ctl_info std_info_enum;
 318         struct pvr2_ctl_info std_info_avail;
 319         struct pvr2_ctl_info std_info_cur;
 320         struct v4l2_standard *std_defs;
 321         const char **std_enum_names;
 322
 323         // Generated string names, one per actual V4L2 standard
 324         const char *std_mask_ptrs[32];
 325         char std_mask_names[32][10];
 326
 327         int unit_number;             /* ID for driver instance */
 328         unsigned long serial_number; /* ID for hardware itself */
 329
 330         char bus_info[32]; /* Bus location info */
 331
 332         /* Minor numbers used by v4l logic (yes, this is a hack, as there
 333            should be no v4l junk here).  Probably a better way to do this. */
 334         int v4l_minor_number_video;
 335         int v4l_minor_number_vbi;
 336         int v4l_minor_number_radio;
 337
 338         /* Bit mask of PVR2_CVAL_INPUT choices which are valid for the hardware */
 339         unsigned int input_avail_mask;
 340         /* Bit mask of PVR2_CVAL_INPUT choices which are currenly allowed */
 341         unsigned int input_allowed_mask;
 342
 343         /* Location of eeprom or a negative number if none */
 344         int eeprom_addr;
 345
 346         enum pvr2_config active_stream_type;
 347         enum pvr2_config desired_stream_type;
 348
 349         /* Control state needed for cx2341x module */
 350         struct cx2341x_mpeg_params enc_cur_state;
 351         struct cx2341x_mpeg_params enc_ctl_state;
 352         /* True if an encoder attribute has changed */
 353         int enc_stale;
 354         /* True if an unsafe encoder attribute has changed */
 355         int enc_unsafe_stale;
 356         /* True if enc_cur_state is valid */
 357         int enc_cur_valid;
 358
 359         /* Control state */
 360 #define VCREATE_DATA(lab) int lab##_val; int lab##_dirty
 361         VCREATE_DATA(brightness);
 362         VCREATE_DATA(contrast);
 363         VCREATE_DATA(saturation);
 364         VCREATE_DATA(hue);
 365         VCREATE_DATA(volume);
 366         VCREATE_DATA(balance);
 367         VCREATE_DATA(bass);
 368         VCREATE_DATA(treble);
 369         VCREATE_DATA(mute);
 370         VCREATE_DATA(input);
 371         VCREATE_DATA(audiomode);
 372         VCREATE_DATA(res_hor);
 373         VCREATE_DATA(res_ver);
 374         VCREATE_DATA(srate);
 375 #undef VCREATE_DATA
 376
 377         struct pvr2_ctld_info *mpeg_ctrl_info;
 378
 379         struct pvr2_ctrl *controls;
 380         unsigned int control_cnt;
 381 };
 382
 383 /* This function gets the current frequency */
 384 unsigned long pvr2_hdw_get_cur_freq(struct pvr2_hdw *);
 385 void pvr2_hdw_set_decoder(struct pvr2_hdw *,struct pvr2_decoder_ctrl *);
 386
 387 #endif /* __PVRUSB2_HDW_INTERNAL_H */
 388
 389 /*
 390   Stuff for Emacs to see, in order to encourage consistent editing style:
 391   *** Local Variables: ***
 392   *** mode: c ***
 393   *** fill-column: 75 ***
 394   *** tab-width: 8 ***
 395   *** c-basic-offset: 8 ***
 396   *** End: ***
 397   */