Linux-libre 5.4.48-gnu
[librecmc/linux-libre.git] / drivers / media / usb / gspca / m5602 / m5602_bridge.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * USB Driver for ALi m5602 based webcams
4  *
5  * Copyright (C) 2008 Erik AndrĂ©n
6  * Copyright (C) 2007 Ilyes Gouta. Based on the m5603x Linux Driver Project.
7  * Copyright (C) 2005 m5603x Linux Driver Project <m5602@x3ng.com.br>
8  *
9  * Portions of code to USB interface and ALi driver software,
10  * Copyright (c) 2006 Willem Duinker
11  * v4l2 interface modeled after the V4L2 driver
12  * for SN9C10x PC Camera Controllers
13  */
14
15 #ifndef M5602_BRIDGE_H_
16 #define M5602_BRIDGE_H_
17
18 #include <linux/slab.h>
19 #include "gspca.h"
20
21 #define MODULE_NAME "ALi m5602"
22
23 /*****************************************************************************/
24
25 #define M5602_XB_SENSOR_TYPE            0x00
26 #define M5602_XB_SENSOR_CTRL            0x01
27 #define M5602_XB_LINE_OF_FRAME_H        0x02
28 #define M5602_XB_LINE_OF_FRAME_L        0x03
29 #define M5602_XB_PIX_OF_LINE_H          0x04
30 #define M5602_XB_PIX_OF_LINE_L          0x05
31 #define M5602_XB_VSYNC_PARA             0x06
32 #define M5602_XB_HSYNC_PARA             0x07
33 #define M5602_XB_TEST_MODE_1            0x08
34 #define M5602_XB_TEST_MODE_2            0x09
35 #define M5602_XB_SIG_INI                0x0a
36 #define M5602_XB_DS_PARA                0x0e
37 #define M5602_XB_TRIG_PARA              0x0f
38 #define M5602_XB_CLK_PD                 0x10
39 #define M5602_XB_MCU_CLK_CTRL           0x12
40 #define M5602_XB_MCU_CLK_DIV            0x13
41 #define M5602_XB_SEN_CLK_CTRL           0x14
42 #define M5602_XB_SEN_CLK_DIV            0x15
43 #define M5602_XB_AUD_CLK_CTRL           0x16
44 #define M5602_XB_AUD_CLK_DIV            0x17
45 #define M5602_OB_AC_LINK_STATE          0x22
46 #define M5602_OB_PCM_SLOT_INDEX         0x24
47 #define M5602_OB_GPIO_SLOT_INDEX        0x25
48 #define M5602_OB_ACRX_STATUS_ADDRESS_H  0x28
49 #define M5602_OB_ACRX_STATUS_DATA_L     0x29
50 #define M5602_OB_ACRX_STATUS_DATA_H     0x2a
51 #define M5602_OB_ACTX_COMMAND_ADDRESS   0x31
52 #define M5602_OB_ACRX_COMMAND_DATA_L    0x32
53 #define M5602_OB_ACTX_COMMAND_DATA_H    0X33
54 #define M5602_XB_DEVCTR1                0x41
55 #define M5602_XB_EPSETR0                0x42
56 #define M5602_XB_EPAFCTR                0x47
57 #define M5602_XB_EPBFCTR                0x49
58 #define M5602_XB_EPEFCTR                0x4f
59 #define M5602_XB_TEST_REG               0x53
60 #define M5602_XB_ALT2SIZE               0x54
61 #define M5602_XB_ALT3SIZE               0x55
62 #define M5602_XB_OBSFRAME               0x56
63 #define M5602_XB_PWR_CTL                0x59
64 #define M5602_XB_ADC_CTRL               0x60
65 #define M5602_XB_ADC_DATA               0x61
66 #define M5602_XB_MISC_CTRL              0x62
67 #define M5602_XB_SNAPSHOT               0x63
68 #define M5602_XB_SCRATCH_1              0x64
69 #define M5602_XB_SCRATCH_2              0x65
70 #define M5602_XB_SCRATCH_3              0x66
71 #define M5602_XB_SCRATCH_4              0x67
72 #define M5602_XB_I2C_CTRL               0x68
73 #define M5602_XB_I2C_CLK_DIV            0x69
74 #define M5602_XB_I2C_DEV_ADDR           0x6a
75 #define M5602_XB_I2C_REG_ADDR           0x6b
76 #define M5602_XB_I2C_DATA               0x6c
77 #define M5602_XB_I2C_STATUS             0x6d
78 #define M5602_XB_GPIO_DAT_H             0x70
79 #define M5602_XB_GPIO_DAT_L             0x71
80 #define M5602_XB_GPIO_DIR_H             0x72
81 #define M5602_XB_GPIO_DIR_L             0x73
82 #define M5602_XB_GPIO_EN_H              0x74
83 #define M5602_XB_GPIO_EN_L              0x75
84 #define M5602_XB_GPIO_DAT               0x76
85 #define M5602_XB_GPIO_DIR               0x77
86 #define M5602_XB_SEN_CLK_CONTROL        0x80
87 #define M5602_XB_SEN_CLK_DIVISION       0x81
88 #define M5602_XB_CPR_CLK_CONTROL        0x82
89 #define M5602_XB_CPR_CLK_DIVISION       0x83
90 #define M5602_XB_MCU_CLK_CONTROL        0x84
91 #define M5602_XB_MCU_CLK_DIVISION       0x85
92 #define M5602_XB_DCT_CLK_CONTROL        0x86
93 #define M5602_XB_DCT_CLK_DIVISION       0x87
94 #define M5602_XB_EC_CLK_CONTROL         0x88
95 #define M5602_XB_EC_CLK_DIVISION        0x89
96 #define M5602_XB_LBUF_CLK_CONTROL       0x8a
97 #define M5602_XB_LBUF_CLK_DIVISION      0x8b
98
99 #define I2C_BUSY 0x80
100
101 /*****************************************************************************/
102
103 /* Driver info */
104 #define DRIVER_AUTHOR "ALi m5602 Linux Driver Project"
105 #define DRIVER_DESC "ALi m5602 webcam driver"
106
107 #define M5602_ISOC_ENDPOINT_ADDR 0x81
108 #define M5602_INTR_ENDPOINT_ADDR 0x82
109
110 #define M5602_URB_MSG_TIMEOUT   5000
111
112 /*****************************************************************************/
113
114 struct sd {
115         struct gspca_dev gspca_dev;
116
117         /* A pointer to the currently connected sensor */
118         const struct m5602_sensor *sensor;
119
120         /* The current frame's id, used to detect frame boundaries */
121         u8 frame_id;
122
123         /* The current frame count */
124         u32 frame_count;
125
126         /* Camera rotation polling thread for "flipable" cams */
127         struct task_struct *rotation_thread;
128
129         struct { /* auto-white-bal + green/red/blue balance control cluster */
130                 struct v4l2_ctrl *auto_white_bal;
131                 struct v4l2_ctrl *red_bal;
132                 struct v4l2_ctrl *blue_bal;
133                 struct v4l2_ctrl *green_bal;
134         };
135         struct { /* autoexpo / expo cluster */
136                 struct v4l2_ctrl *autoexpo;
137                 struct v4l2_ctrl *expo;
138         };
139         struct { /* autogain / gain cluster */
140                 struct v4l2_ctrl *autogain;
141                 struct v4l2_ctrl *gain;
142         };
143         struct { /* hflip/vflip cluster */
144                 struct v4l2_ctrl *hflip;
145                 struct v4l2_ctrl *vflip;
146         };
147 };
148
149 int m5602_read_bridge(
150         struct sd *sd, const u8 address, u8 *i2c_data);
151
152 int m5602_write_bridge(
153         struct sd *sd, const u8 address, const u8 i2c_data);
154
155 int m5602_write_sensor(struct sd *sd, const u8 address,
156                        u8 *i2c_data, const u8 len);
157
158 int m5602_read_sensor(struct sd *sd, const u8 address,
159                       u8 *i2c_data, const u8 len);
160
161 #endif