drivers/staging/solo6x10/solo6010.h

   1 /*
   2  * Copyright (C) 2010 Bluecherry, LLC www.bluecherrydvr.com
   3  * Copyright (C) 2010 Ben Collins <bcollins@bluecherry.net>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   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 __SOLO6010_H
  21 #define __SOLO6010_H
  22
  23 #include <linux/version.h>
  24 #include <linux/pci.h>
  25 #include <linux/i2c.h>
  26 #include <linux/semaphore.h>
  27 #include <linux/mutex.h>
  28 #include <linux/list.h>
  29 #include <linux/wait.h>
  30 #include <asm/io.h>
  31 #include <asm/atomic.h>
  32
  33 #include <linux/videodev2.h>
  34 #include <media/v4l2-dev.h>
  35 #include <media/videobuf-core.h>
  36
  37 #include "solo6010-registers.h"
  38
  39 #ifndef PCI_VENDOR_ID_SOFTLOGIC
  40 #define PCI_VENDOR_ID_SOFTLOGIC         0x9413
  41 #define PCI_DEVICE_ID_SOLO6010          0x6010
  42 #endif
  43
  44 #ifndef PCI_VENDOR_ID_BLUECHERRY
  45 #define PCI_VENDOR_ID_BLUECHERRY        0x1BB3
  46 /* Neugent Softlogic 6010 based cards */
  47 #define PCI_DEVICE_ID_NEUSOLO_4         0x4304
  48 #define PCI_DEVICE_ID_NEUSOLO_9         0x4309
  49 #define PCI_DEVICE_ID_NEUSOLO_16        0x4310
  50 /* Commell Softlogic 6010 based cards */
  51 #define PCI_DEVICE_ID_COMMSOLO_4        0x4E04
  52 #define PCI_DEVICE_ID_COMMSOLO_9        0x4E09
  53 #define PCI_DEVICE_ID_COMMSOLO_16       0x4E10
  54 #endif /* Bluecherry */
  55
  56 #define SOLO6010_NAME                   "solo6010"
  57
  58 #define SOLO_MAX_CHANNELS               16
  59
  60 /* Make sure these two match */
  61 #define SOLO6010_VERSION                "2.0.0"
  62 #define SOLO6010_VER_MAJOR              2
  63 #define SOLO6010_VER_MINOR              0
  64 #define SOLO6010_VER_SUB                0
  65 #define SOLO6010_VER_NUM \
  66     KERNEL_VERSION(SOLO6010_VER_MAJOR, SOLO6010_VER_MINOR, SOLO6010_VER_SUB)
  67
  68 /*
  69  * The SOLO6010 actually has 8 i2c channels, but we only use 2.
  70  * 0 - Techwell chip(s)
  71  * 1 - SAA7128
  72  */
  73 #define SOLO_I2C_ADAPTERS               2
  74 #define SOLO_I2C_TW                     0
  75 #define SOLO_I2C_SAA                    1
  76
  77 /* DMA Engine setup */
  78 #define SOLO_NR_P2M                     4
  79 #define SOLO_NR_P2M_DESC                256
  80 #define SOLO_P2M_DESC_SIZE              (SOLO_NR_P2M_DESC * 16)
  81 /* MPEG and JPEG share the same interrupt and locks so they must be together
  82  * in the same dma channel. */
  83 #define SOLO_P2M_DMA_ID_MP4E            0
  84 #define SOLO_P2M_DMA_ID_JPEG            0
  85 #define SOLO_P2M_DMA_ID_MP4D            1
  86 #define SOLO_P2M_DMA_ID_G723D           1
  87 #define SOLO_P2M_DMA_ID_DISP            2
  88 #define SOLO_P2M_DMA_ID_OSG             2
  89 #define SOLO_P2M_DMA_ID_G723E           3
  90 #define SOLO_P2M_DMA_ID_VIN             3
  91
  92 /* Encoder standard modes */
  93 #define SOLO_ENC_MODE_CIF               2
  94 #define SOLO_ENC_MODE_HD1               1
  95 #define SOLO_ENC_MODE_D1                9
  96
  97 #define SOLO_DEFAULT_GOP                30
  98 #define SOLO_DEFAULT_QP                 3
  99
 100 /* There is 8MB memory available for solo to buffer MPEG4 frames.
 101  * This gives us 512 * 16kbyte queues. */
 102 #define SOLO_NR_RING_BUFS               512
 103
 104 #define SOLO_CLOCK_MHZ                  108
 105
 106 #ifndef V4L2_BUF_FLAG_MOTION_ON
 107 #define V4L2_BUF_FLAG_MOTION_ON         0x0400
 108 #define V4L2_BUF_FLAG_MOTION_DETECTED   0x0800
 109 #endif
 110 #ifndef V4L2_CID_MOTION_ENABLE
 111 #define PRIVATE_CIDS
 112 #define V4L2_CID_MOTION_ENABLE          (V4L2_CID_PRIVATE_BASE+0)
 113 #define V4L2_CID_MOTION_THRESHOLD       (V4L2_CID_PRIVATE_BASE+1)
 114 #define V4L2_CID_MOTION_TRACE           (V4L2_CID_PRIVATE_BASE+2)
 115 #endif
 116
 117 enum SOLO_I2C_STATE {
 118         IIC_STATE_IDLE,
 119         IIC_STATE_START,
 120         IIC_STATE_READ,
 121         IIC_STATE_WRITE,
 122         IIC_STATE_STOP
 123 };
 124
 125 struct solo_p2m_dev {
 126         struct semaphore        sem;
 127         struct completion       completion;
 128         int                     error;
 129         u8                      desc[SOLO_P2M_DESC_SIZE];
 130 };
 131
 132 #define OSD_TEXT_MAX            30
 133
 134 enum solo_enc_types {
 135         SOLO_ENC_TYPE_STD,
 136         SOLO_ENC_TYPE_EXT,
 137 };
 138
 139 struct solo_enc_dev {
 140         struct solo6010_dev     *solo_dev;
 141         /* V4L2 Items */
 142         struct video_device     *vfd;
 143         /* General accounting */
 144         wait_queue_head_t       thread_wait;
 145         spinlock_t              lock;
 146         atomic_t                readers;
 147         u8                      ch;
 148         u8                      mode, gop, qp, interlaced, interval;
 149         u8                      reset_gop;
 150         u8                      bw_weight;
 151         u8                      motion_detected;
 152         u16                     motion_thresh;
 153         u16                     width;
 154         u16                     height;
 155         char                    osd_text[OSD_TEXT_MAX + 1];
 156 };
 157
 158 struct solo_enc_buf {
 159         u8                      vop;
 160         u8                      ch;
 161         enum solo_enc_types     type;
 162         u32                     off;
 163         u32                     size;
 164         u32                     jpeg_off;
 165         u32                     jpeg_size;
 166         struct timeval          ts;
 167 };
 168
 169 /* The SOLO6010 PCI Device */
 170 struct solo6010_dev {
 171         /* General stuff */
 172         struct pci_dev          *pdev;
 173         u8 __iomem              *reg_base;
 174         int                     nr_chans;
 175         int                     nr_ext;
 176         u32                     irq_mask;
 177         u32                     motion_mask;
 178         spinlock_t              reg_io_lock;
 179
 180         /* tw28xx accounting */
 181         u8                      tw2865, tw2864, tw2815;
 182         u8                      tw28_cnt;
 183
 184         /* i2c related items */
 185         struct i2c_adapter      i2c_adap[SOLO_I2C_ADAPTERS];
 186         enum SOLO_I2C_STATE     i2c_state;
 187         struct semaphore        i2c_sem;
 188         int                     i2c_id;
 189         wait_queue_head_t       i2c_wait;
 190         struct i2c_msg          *i2c_msg;
 191         unsigned int            i2c_msg_num;
 192         unsigned int            i2c_msg_ptr;
 193
 194         /* P2M DMA Engine */
 195         struct solo_p2m_dev     p2m_dev[SOLO_NR_P2M];
 196
 197         /* V4L2 Display items */
 198         struct video_device     *vfd;
 199         unsigned int            erasing;
 200         unsigned int            frame_blank;
 201         u8                      cur_disp_ch;
 202         wait_queue_head_t       disp_thread_wait;
 203
 204         /* V4L2 Encoder items */
 205         struct solo_enc_dev     *v4l2_enc[SOLO_MAX_CHANNELS];
 206         u16                     enc_bw_remain;
 207         /* IDX into hw mp4 encoder */
 208         u8                      enc_idx;
 209         /* Our software ring of enc buf references */
 210         u16                     enc_wr_idx;
 211         struct solo_enc_buf     enc_buf[SOLO_NR_RING_BUFS];
 212
 213         /* Current video settings */
 214         u32                     video_type;
 215         u16                     video_hsize, video_vsize;
 216         u16                     vout_hstart, vout_vstart;
 217         u16                     vin_hstart, vin_vstart;
 218         u8                      fps;
 219
 220         /* Audio components */
 221         struct snd_card         *snd_card;
 222         struct snd_pcm          *snd_pcm;
 223         atomic_t                snd_users;
 224         int                     g723_hw_idx;
 225 };
 226
 227 static inline u32 solo_reg_read(struct solo6010_dev *solo_dev, int reg)
 228 {
 229         unsigned long flags;
 230         u32 ret;
 231         u16 val;
 232
 233         spin_lock_irqsave(&solo_dev->reg_io_lock, flags);
 234
 235         ret = readl(solo_dev->reg_base + reg);
 236         rmb();
 237         pci_read_config_word(solo_dev->pdev, PCI_STATUS, &val);
 238         rmb();
 239
 240         spin_unlock_irqrestore(&solo_dev->reg_io_lock, flags);
 241
 242         return ret;
 243 }
 244
 245 static inline void solo_reg_write(struct solo6010_dev *solo_dev, int reg,
 246                                       u32 data)
 247 {
 248         unsigned long flags;
 249         u16 val;
 250
 251         spin_lock_irqsave(&solo_dev->reg_io_lock, flags);
 252
 253         writel(data, solo_dev->reg_base + reg);
 254         wmb();
 255         pci_read_config_word(solo_dev->pdev, PCI_STATUS, &val);
 256         rmb();
 257
 258         spin_unlock_irqrestore(&solo_dev->reg_io_lock, flags);
 259 }
 260
 261 void solo6010_irq_on(struct solo6010_dev *solo_dev, u32 mask);
 262 void solo6010_irq_off(struct solo6010_dev *solo_dev, u32 mask);
 263
 264 /* Init/exit routeines for subsystems */
 265 int solo_disp_init(struct solo6010_dev *solo_dev);
 266 void solo_disp_exit(struct solo6010_dev *solo_dev);
 267
 268 int solo_gpio_init(struct solo6010_dev *solo_dev);
 269 void solo_gpio_exit(struct solo6010_dev *solo_dev);
 270
 271 int solo_i2c_init(struct solo6010_dev *solo_dev);
 272 void solo_i2c_exit(struct solo6010_dev *solo_dev);
 273
 274 int solo_p2m_init(struct solo6010_dev *solo_dev);
 275 void solo_p2m_exit(struct solo6010_dev *solo_dev);
 276
 277 int solo_v4l2_init(struct solo6010_dev *solo_dev);
 278 void solo_v4l2_exit(struct solo6010_dev *solo_dev);
 279
 280 int solo_enc_init(struct solo6010_dev *solo_dev);
 281 void solo_enc_exit(struct solo6010_dev *solo_dev);
 282
 283 int solo_enc_v4l2_init(struct solo6010_dev *solo_dev);
 284 void solo_enc_v4l2_exit(struct solo6010_dev *solo_dev);
 285
 286 int solo_g723_init(struct solo6010_dev *solo_dev);
 287 void solo_g723_exit(struct solo6010_dev *solo_dev);
 288
 289 /* ISR's */
 290 int solo_i2c_isr(struct solo6010_dev *solo_dev);
 291 void solo_p2m_isr(struct solo6010_dev *solo_dev, int id);
 292 void solo_p2m_error_isr(struct solo6010_dev *solo_dev, u32 status);
 293 void solo_enc_v4l2_isr(struct solo6010_dev *solo_dev);
 294 void solo_g723_isr(struct solo6010_dev *solo_dev);
 295 void solo_motion_isr(struct solo6010_dev *solo_dev);
 296 void solo_video_in_isr(struct solo6010_dev *solo_dev);
 297
 298 /* i2c read/write */
 299 u8 solo_i2c_readbyte(struct solo6010_dev *solo_dev, int id, u8 addr, u8 off);
 300 void solo_i2c_writebyte(struct solo6010_dev *solo_dev, int id, u8 addr, u8 off,
 301                         u8 data);
 302
 303 /* P2M DMA */
 304 int solo_p2m_dma_t(struct solo6010_dev *solo_dev, u8 id, int wr,
 305                    dma_addr_t dma_addr, u32 ext_addr, u32 size);
 306 int solo_p2m_dma(struct solo6010_dev *solo_dev, u8 id, int wr,
 307                  void *sys_addr, u32 ext_addr, u32 size);
 308
 309 /* Set the threshold for motion detection */
 310 void solo_set_motion_threshold(struct solo6010_dev *solo_dev, u8 ch, u16 val);
 311 #define SOLO_DEF_MOT_THRESH             0x0300
 312
 313 /* Write text on OSD */
 314 int solo_osd_print(struct solo_enc_dev *solo_enc);
 315
 316 #endif /* __SOLO6010_H */