treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 157
[sfrench/cifs-2.6.git] / drivers / media / usb / gspca / stv06xx / stv06xx.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Copyright (c) 2001 Jean-Fredric Clere, Nikolas Zimmermann, Georg Acher
4  *                    Mark Cave-Ayland, Carlo E Prelz, Dick Streefland
5  * Copyright (c) 2002, 2003 Tuukka Toivonen
6  * Copyright (c) 2008 Erik AndrĂ©n
7  *
8  * P/N 861037:      Sensor HDCS1000        ASIC STV0600
9  * P/N 861050-0010: Sensor HDCS1000        ASIC STV0600
10  * P/N 861050-0020: Sensor Photobit PB100  ASIC STV0600-1 - QuickCam Express
11  * P/N 861055:      Sensor ST VV6410       ASIC STV0610   - LEGO cam
12  * P/N 861075-0040: Sensor HDCS1000        ASIC
13  * P/N 961179-0700: Sensor ST VV6410       ASIC STV0602   - Dexxa WebCam USB
14  * P/N 861040-0000: Sensor ST VV6410       ASIC STV0610   - QuickCam Web
15  */
16
17 #ifndef STV06XX_H_
18 #define STV06XX_H_
19
20 #include <linux/slab.h>
21 #include "gspca.h"
22
23 #define MODULE_NAME "STV06xx"
24
25 #define STV_ISOC_ENDPOINT_ADDR          0x81
26
27 #define STV_R                           0x0509
28
29 #define STV_REG23                       0x0423
30
31 /* Control registers of the STV0600 ASIC */
32 #define STV_I2C_PARTNER                 0x1420
33 #define STV_I2C_VAL_REG_VAL_PAIRS_MIN1  0x1421
34 #define STV_I2C_READ_WRITE_TOGGLE       0x1422
35 #define STV_I2C_FLUSH                   0x1423
36 #define STV_I2C_SUCC_READ_REG_VALS      0x1424
37
38 #define STV_ISO_ENABLE                  0x1440
39 #define STV_SCAN_RATE                   0x1443
40 #define STV_LED_CTRL                    0x1445
41 #define STV_STV0600_EMULATION           0x1446
42 #define STV_REG00                       0x1500
43 #define STV_REG01                       0x1501
44 #define STV_REG02                       0x1502
45 #define STV_REG03                       0x1503
46 #define STV_REG04                       0x1504
47
48 #define STV_ISO_SIZE_L                  0x15c1
49 #define STV_ISO_SIZE_H                  0x15c2
50
51 /* Refers to the CIF 352x288 and QCIF 176x144 */
52 /* 1: 288 lines, 2: 144 lines */
53 #define STV_Y_CTRL                      0x15c3
54
55 #define STV_RESET                       0x1620
56
57 /* 0xa: 352 columns, 0x6: 176 columns */
58 #define STV_X_CTRL                      0x1680
59
60 #define STV06XX_URB_MSG_TIMEOUT         5000
61
62 #define I2C_MAX_BYTES                   16
63 #define I2C_MAX_WORDS                   8
64
65 #define I2C_BUFFER_LENGTH               0x23
66 #define I2C_READ_CMD                    3
67 #define I2C_WRITE_CMD                   1
68
69 #define LED_ON                          1
70 #define LED_OFF                         0
71
72 /* STV06xx device descriptor */
73 struct sd {
74         struct gspca_dev gspca_dev;
75
76         /* A pointer to the currently connected sensor */
77         const struct stv06xx_sensor *sensor;
78
79         /* Sensor private data */
80         void *sensor_priv;
81
82         /* The first 4 lines produced by the stv6422 are no good, this keeps
83            track of how many bytes we still need to skip during a frame */
84         int to_skip;
85
86         /* Bridge / Camera type */
87         u8 bridge;
88         #define BRIDGE_STV600 0
89         #define BRIDGE_STV602 1
90         #define BRIDGE_STV610 2
91         #define BRIDGE_ST6422 3 /* With integrated sensor */
92 };
93
94 int stv06xx_write_bridge(struct sd *sd, u16 address, u16 i2c_data);
95 int stv06xx_read_bridge(struct sd *sd, u16 address, u8 *i2c_data);
96
97 int stv06xx_write_sensor_bytes(struct sd *sd, const u8 *data, u8 len);
98 int stv06xx_write_sensor_words(struct sd *sd, const u16 *data, u8 len);
99
100 int stv06xx_read_sensor(struct sd *sd, const u8 address, u16 *value);
101 int stv06xx_write_sensor(struct sd *sd, u8 address, u16 value);
102
103 #endif