LXR linux/drivers/media/usb/stk1160/stk1160.h

   1/* SPDX-License-Identifier: GPL-2.0-or-later */
   2/*
   3 * STK1160 driver
   4 *
   5 * Copyright (C) 2012 Ezequiel Garcia
   6 * <elezegarcia--a.t--gmail.com>
   7 *
   8 * Based on Easycap driver by R.M. Thomas
   9 *      Copyright (C) 2010 R.M. Thomas
  10 *      <rmthomas--a.t--sciolus.org>
  11 */
  12
  13#include <linux/i2c.h>
  14#include <sound/core.h>
  15#include <sound/ac97_codec.h>
  16#include <media/videobuf2-v4l2.h>
  17#include <media/v4l2-device.h>
  18#include <media/v4l2-ctrls.h>
  19
  20#define STK1160_VERSION         "0.9.5"
  21#define STK1160_VERSION_NUM     0x000905
  22
  23/* Decide on number of packets for each buffer */
  24#define STK1160_NUM_PACKETS 64
  25
  26/* Number of buffers for isoc transfers */
  27#define STK1160_NUM_BUFS 16
  28#define STK1160_MIN_BUFS 1
  29
  30/* TODO: This endpoint address should be retrieved */
  31#define STK1160_EP_VIDEO 0x82
  32#define STK1160_EP_AUDIO 0x81
  33
  34/* Max and min video buffers */
  35#define STK1160_MIN_VIDEO_BUFFERS 8
  36#define STK1160_MAX_VIDEO_BUFFERS 32
  37
  38#define STK1160_MIN_PKT_SIZE 3072
  39
  40#define STK1160_MAX_INPUT 4
  41#define STK1160_SVIDEO_INPUT 4
  42
  43#define STK1160_AC97_TIMEOUT 50
  44
  45#define STK1160_I2C_TIMEOUT 100
  46
  47/* TODO: Print helpers
  48 * I could use dev_xxx, pr_xxx, v4l2_xxx or printk.
  49 * However, there isn't a solid consensus on which
  50 * new drivers should use.
  51 *
  52 */
  53#ifdef DEBUG
  54#define stk1160_dbg(fmt, args...) \
  55        printk(KERN_DEBUG "stk1160: " fmt,  ## args)
  56#else
  57#define stk1160_dbg(fmt, args...)
  58#endif
  59
  60#define stk1160_info(fmt, args...) \
  61        pr_info("stk1160: " fmt, ## args)
  62
  63#define stk1160_warn(fmt, args...) \
  64        pr_warn("stk1160: " fmt, ## args)
  65
  66#define stk1160_err(fmt, args...) \
  67        pr_err("stk1160: " fmt, ## args)
  68
  69/* Buffer for one video frame */
  70struct stk1160_buffer {
  71        /* common v4l buffer stuff -- must be first */
  72        struct vb2_v4l2_buffer vb;
  73        struct list_head list;
  74
  75        void *mem;
  76        unsigned int length;            /* buffer length */
  77        unsigned int bytesused;         /* bytes written */
  78        int odd;                        /* current oddity */
  79
  80        /*
  81         * Since we interlace two fields per frame,
  82         * this is different from bytesused.
  83         */
  84        unsigned int pos;               /* current pos inside buffer */
  85};
  86
  87struct stk1160_isoc_ctl {
  88        /* max packet size of isoc transaction */
  89        int max_pkt_size;
  90
  91        /* number of allocated urbs */
  92        int num_bufs;
  93
  94        /* urb for isoc transfers */
  95        struct urb **urb;
  96
  97        /* transfer buffers for isoc transfer */
  98        char **transfer_buffer;
  99
 100        /* current buffer */
 101        struct stk1160_buffer *buf;
 102};
 103
 104struct stk1160_fmt {
 105        char  *name;
 106        u32   fourcc;          /* v4l2 format id */
 107        int   depth;
 108};
 109
 110struct stk1160 {
 111        struct v4l2_device v4l2_dev;
 112        struct video_device vdev;
 113        struct v4l2_ctrl_handler ctrl_handler;
 114
 115        struct device *dev;
 116        struct usb_device *udev;
 117
 118        /* saa7115 subdev */
 119        struct v4l2_subdev *sd_saa7115;
 120
 121        /* isoc control struct */
 122        struct list_head avail_bufs;
 123
 124        /* video capture */
 125        struct vb2_queue vb_vidq;
 126
 127        /* max packet size of isoc transaction */
 128        int max_pkt_size;
 129        /* array of wMaxPacketSize */
 130        unsigned int *alt_max_pkt_size;
 131        /* alternate */
 132        int alt;
 133        /* Number of alternative settings */
 134        int num_alt;
 135
 136        struct stk1160_isoc_ctl isoc_ctl;
 137
 138        /* frame properties */
 139        int width;                /* current frame width */
 140        int height;               /* current frame height */
 141        unsigned int ctl_input;   /* selected input */
 142        v4l2_std_id norm;         /* current norm */
 143        struct stk1160_fmt *fmt;  /* selected format */
 144
 145        unsigned int sequence;
 146
 147        /* i2c i/o */
 148        struct i2c_adapter i2c_adap;
 149        struct i2c_client i2c_client;
 150
 151        struct mutex v4l_lock;
 152        struct mutex vb_queue_lock;
 153        spinlock_t buf_lock;
 154
 155        struct file *fh_owner;  /* filehandle ownership */
 156
 157        /* EXPERIMENTAL */
 158        struct snd_card *snd_card;
 159};
 160
 161struct regval {
 162        u16 reg;
 163        u16 val;
 164};
 165
 166/* Provided by stk1160-v4l.c */
 167int stk1160_vb2_setup(struct stk1160 *dev);
 168int stk1160_video_register(struct stk1160 *dev);
 169void stk1160_video_unregister(struct stk1160 *dev);
 170void stk1160_clear_queue(struct stk1160 *dev);
 171
 172/* Provided by stk1160-video.c */
 173int stk1160_alloc_isoc(struct stk1160 *dev);
 174void stk1160_free_isoc(struct stk1160 *dev);
 175void stk1160_cancel_isoc(struct stk1160 *dev);
 176void stk1160_uninit_isoc(struct stk1160 *dev);
 177
 178/* Provided by stk1160-i2c.c */
 179int stk1160_i2c_register(struct stk1160 *dev);
 180int stk1160_i2c_unregister(struct stk1160 *dev);
 181
 182/* Provided by stk1160-core.c */
 183int stk1160_read_reg(struct stk1160 *dev, u16 reg, u8 *value);
 184int stk1160_write_reg(struct stk1160 *dev, u16 reg, u16 value);
 185int stk1160_write_regs_req(struct stk1160 *dev, u8 req, u16 reg,
 186                char *buf, int len);
 187int stk1160_read_reg_req_len(struct stk1160 *dev, u8 req, u16 reg,
 188                char *buf, int len);
 189void stk1160_select_input(struct stk1160 *dev);
 190
 191/* Provided by stk1160-ac97.c */
 192void stk1160_ac97_setup(struct stk1160 *dev);
 193