drivers/staging/go7007/go7007-priv.h

   1 /*
   2  * Copyright (C) 2005-2006 Micronas USA Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License (Version 2) as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software Foundation,
  15  * Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
  16  */
  17
  18 /*
  19  * This is the private include file for the go7007 driver.  It should not
  20  * be included by anybody but the driver itself, and especially not by
  21  * user-space applications.
  22  */
  23
  24 struct go7007;
  25
  26 /* IDs to activate board-specific support code */
  27 #define GO7007_BOARDID_MATRIX_II        0
  28 #define GO7007_BOARDID_MATRIX_RELOAD    1
  29 #define GO7007_BOARDID_STAR_TREK        2
  30 #define GO7007_BOARDID_PCI_VOYAGER      3
  31 #define GO7007_BOARDID_XMEN             4
  32 #define GO7007_BOARDID_XMEN_II          5
  33 #define GO7007_BOARDID_XMEN_III         6
  34 #define GO7007_BOARDID_MATRIX_REV       7
  35 #define GO7007_BOARDID_PX_M402U         16
  36 #define GO7007_BOARDID_PX_TV402U_ANY    17 /* need to check tuner model */
  37 #define GO7007_BOARDID_PX_TV402U_NA     18 /* detected NTSC tuner */
  38 #define GO7007_BOARDID_PX_TV402U_EU     19 /* detected PAL tuner */
  39 #define GO7007_BOARDID_PX_TV402U_JP     20 /* detected NTSC-J tuner */
  40 #define GO7007_BOARDID_LIFEVIEW_LR192   21 /* TV Walker Ultra */
  41 #define GO7007_BOARDID_ENDURA           22
  42 #define GO7007_BOARDID_ADLINK_MPG24     23
  43
  44 /* Various characteristics of each board */
  45 #define GO7007_BOARD_HAS_AUDIO          (1<<0)
  46 #define GO7007_BOARD_USE_ONBOARD_I2C    (1<<1)
  47 #define GO7007_BOARD_HAS_TUNER          (1<<2)
  48
  49 /* Characteristics of sensor devices */
  50 #define GO7007_SENSOR_VALID_POLAR       (1<<0)
  51 #define GO7007_SENSOR_HREF_POLAR        (1<<1)
  52 #define GO7007_SENSOR_VREF_POLAR        (1<<2)
  53 #define GO7007_SENSOR_FIELD_ID_POLAR    (1<<3)
  54 #define GO7007_SENSOR_BIT_WIDTH         (1<<4)
  55 #define GO7007_SENSOR_VALID_ENABLE      (1<<5)
  56 #define GO7007_SENSOR_656               (1<<6)
  57 #define GO7007_SENSOR_CONFIG_MASK       0x7f
  58 #define GO7007_SENSOR_TV                (1<<7)
  59 #define GO7007_SENSOR_VBI               (1<<8)
  60 #define GO7007_SENSOR_SCALING           (1<<9)
  61
  62 /* Characteristics of audio sensor devices */
  63 #define GO7007_AUDIO_I2S_MODE_1         (1)
  64 #define GO7007_AUDIO_I2S_MODE_2         (2)
  65 #define GO7007_AUDIO_I2S_MODE_3         (3)
  66 #define GO7007_AUDIO_BCLK_POLAR         (1<<2)
  67 #define GO7007_AUDIO_WORD_14            (14<<4)
  68 #define GO7007_AUDIO_WORD_16            (16<<4)
  69 #define GO7007_AUDIO_ONE_CHANNEL        (1<<11)
  70 #define GO7007_AUDIO_I2S_MASTER         (1<<16)
  71 #define GO7007_AUDIO_OKI_MODE           (1<<17)
  72
  73 struct go7007_board_info {
  74         char *firmware;
  75         unsigned int flags;
  76         int hpi_buffer_cap;
  77         unsigned int sensor_flags;
  78         int sensor_width;
  79         int sensor_height;
  80         int sensor_framerate;
  81         int sensor_h_offset;
  82         int sensor_v_offset;
  83         unsigned int audio_flags;
  84         int audio_rate;
  85         int audio_bclk_div;
  86         int audio_main_div;
  87         int num_i2c_devs;
  88         struct {
  89                 int id;
  90                 int addr;
  91         } i2c_devs[4];
  92         int num_inputs;
  93         struct {
  94                 int video_input;
  95                 int audio_input;
  96                 char *name;
  97         } inputs[4];
  98 };
  99
 100 struct go7007_hpi_ops {
 101         int (*interface_reset)(struct go7007 *go);
 102         int (*write_interrupt)(struct go7007 *go, int addr, int data);
 103         int (*read_interrupt)(struct go7007 *go);
 104         int (*stream_start)(struct go7007 *go);
 105         int (*stream_stop)(struct go7007 *go);
 106         int (*send_firmware)(struct go7007 *go, u8 *data, int len);
 107 };
 108
 109 /* The video buffer size must be a multiple of PAGE_SIZE */
 110 #define GO7007_BUF_PAGES        (128 * 1024 / PAGE_SIZE)
 111 #define GO7007_BUF_SIZE         (GO7007_BUF_PAGES << PAGE_SHIFT)
 112
 113 struct go7007_buffer {
 114         struct go7007 *go; /* Reverse reference for VMA ops */
 115         int index; /* Reverse reference for DQBUF */
 116         enum { BUF_STATE_IDLE, BUF_STATE_QUEUED, BUF_STATE_DONE } state;
 117         u32 seq;
 118         struct timeval timestamp;
 119         struct list_head stream;
 120         struct page *pages[GO7007_BUF_PAGES + 1]; /* extra for straddling */
 121         unsigned long user_addr;
 122         unsigned int page_count;
 123         unsigned int offset;
 124         unsigned int bytesused;
 125         unsigned int frame_offset;
 126         u32 modet_active;
 127         int mapped;
 128 };
 129
 130 struct go7007_file {
 131         struct go7007 *go;
 132         struct semaphore lock;
 133         int buf_count;
 134         struct go7007_buffer *bufs;
 135 };
 136
 137 #define GO7007_FORMAT_MJPEG     0
 138 #define GO7007_FORMAT_MPEG4     1
 139 #define GO7007_FORMAT_MPEG1     2
 140 #define GO7007_FORMAT_MPEG2     3
 141 #define GO7007_FORMAT_H263      4
 142
 143 #define GO7007_RATIO_1_1        0
 144 #define GO7007_RATIO_4_3        1
 145 #define GO7007_RATIO_16_9       2
 146
 147 enum go7007_parser_state {
 148         STATE_DATA,
 149         STATE_00,
 150         STATE_00_00,
 151         STATE_00_00_01,
 152         STATE_FF,
 153         STATE_VBI_LEN_A,
 154         STATE_VBI_LEN_B,
 155         STATE_MODET_MAP,
 156         STATE_UNPARSED,
 157 };
 158
 159 struct go7007 {
 160         struct device *dev;
 161         struct go7007_board_info *board_info;
 162         unsigned int board_id;
 163         int tuner_type;
 164         int channel_number; /* for multi-channel boards like Adlink PCI-MPG24 */
 165         char name[64];
 166         struct video_device *video_dev;
 167         int ref_count;
 168         enum { STATUS_INIT, STATUS_ONLINE, STATUS_SHUTDOWN } status;
 169         spinlock_t spinlock;
 170         struct semaphore hw_lock;
 171         int streaming;
 172         int in_use;
 173         int audio_enabled;
 174
 175         /* Video input */
 176         int input;
 177         enum { GO7007_STD_NTSC, GO7007_STD_PAL, GO7007_STD_OTHER } standard;
 178         int sensor_framerate;
 179         int width;
 180         int height;
 181         int encoder_h_offset;
 182         int encoder_v_offset;
 183         unsigned int encoder_h_halve:1;
 184         unsigned int encoder_v_halve:1;
 185         unsigned int encoder_subsample:1;
 186
 187         /* Encoder config */
 188         int format;
 189         int bitrate;
 190         int fps_scale;
 191         int pali;
 192         int aspect_ratio;
 193         int gop_size;
 194         unsigned int ipb:1;
 195         unsigned int closed_gop:1;
 196         unsigned int repeat_seqhead:1;
 197         unsigned int seq_header_enable:1;
 198         unsigned int gop_header_enable:1;
 199         unsigned int dvd_mode:1;
 200         unsigned int interlace_coding:1;
 201
 202         /* Motion detection */
 203         unsigned int modet_enable:1;
 204         struct {
 205                 unsigned int enable:1;
 206                 int pixel_threshold;
 207                 int motion_threshold;
 208                 int mb_threshold;
 209         } modet[4];
 210         unsigned char modet_map[1624];
 211         unsigned char active_map[216];
 212
 213         /* Video streaming */
 214         struct go7007_buffer *active_buf;
 215         enum go7007_parser_state state;
 216         int parse_length;
 217         u16 modet_word;
 218         int seen_frame;
 219         u32 next_seq;
 220         struct list_head stream;
 221         wait_queue_head_t frame_waitq;
 222
 223         /* Audio streaming */
 224         void (*audio_deliver)(struct go7007 *go, u8 *buf, int length);
 225         void *snd_context;
 226
 227         /* I2C */
 228         int i2c_adapter_online;
 229         struct i2c_adapter i2c_adapter;
 230
 231         /* HPI driver */
 232         struct go7007_hpi_ops *hpi_ops;
 233         void *hpi_context;
 234         int interrupt_available;
 235         wait_queue_head_t interrupt_waitq;
 236         unsigned short interrupt_value;
 237         unsigned short interrupt_data;
 238 };
 239
 240 /* All of these must be called with the hpi_lock semaphore held! */
 241 #define go7007_interface_reset(go) \
 242                         ((go)->hpi_ops->interface_reset(go))
 243 #define go7007_write_interrupt(go, x, y) \
 244                         ((go)->hpi_ops->write_interrupt)((go), (x), (y))
 245 #define go7007_stream_start(go) \
 246                         ((go)->hpi_ops->stream_start(go))
 247 #define go7007_stream_stop(go) \
 248                         ((go)->hpi_ops->stream_stop(go))
 249 #define go7007_send_firmware(go, x, y) \
 250                         ((go)->hpi_ops->send_firmware)((go), (x), (y))
 251 #define go7007_write_addr(go, x, y) \
 252                         ((go)->hpi_ops->write_interrupt)((go), (x)|0x8000, (y))
 253
 254 /* go7007-driver.c */
 255 int go7007_read_addr(struct go7007 *go, u16 addr, u16 *data);
 256 int go7007_read_interrupt(struct go7007 *go, u16 *value, u16 *data);
 257 int go7007_boot_encoder(struct go7007 *go, int init_i2c);
 258 int go7007_reset_encoder(struct go7007 *go);
 259 int go7007_register_encoder(struct go7007 *go);
 260 int go7007_start_encoder(struct go7007 *go);
 261 void go7007_parse_video_stream(struct go7007 *go, u8 *buf, int length);
 262 struct go7007 *go7007_alloc(struct go7007_board_info *board,
 263                                         struct device *dev);
 264 void go7007_remove(struct go7007 *go);
 265
 266 /* go7007-fw.c */
 267 int go7007_construct_fw_image(struct go7007 *go, u8 **fw, int *fwlen);
 268
 269 /* go7007-i2c.c */
 270 int go7007_i2c_init(struct go7007 *go);
 271 int go7007_i2c_remove(struct go7007 *go);
 272
 273 /* go7007-v4l2.c */
 274 int go7007_v4l2_init(struct go7007 *go);
 275 void go7007_v4l2_remove(struct go7007 *go);
 276
 277 /* snd-go7007.c */
 278 int go7007_snd_init(struct go7007 *go);
 279 int go7007_snd_remove(struct go7007 *go);