xref: /OK3568_Linux_fs/kernel/drivers/media/i2c/smiapp/smiapp-regs.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * drivers/media/i2c/smiapp/smiapp-regs.c
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Generic driver for SMIA/SMIA++ compliant camera modules
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Copyright (C) 2011--2012 Nokia Corporation
8*4882a593Smuzhiyun  * Contact: Sakari Ailus <sakari.ailus@iki.fi>
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <asm/unaligned.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include <linux/delay.h>
14*4882a593Smuzhiyun #include <linux/i2c.h>
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #include "smiapp.h"
17*4882a593Smuzhiyun #include "smiapp-regs.h"
18*4882a593Smuzhiyun 
float_to_u32_mul_1000000(struct i2c_client * client,uint32_t phloat)19*4882a593Smuzhiyun static uint32_t float_to_u32_mul_1000000(struct i2c_client *client,
20*4882a593Smuzhiyun 					 uint32_t phloat)
21*4882a593Smuzhiyun {
22*4882a593Smuzhiyun 	int32_t exp;
23*4882a593Smuzhiyun 	uint64_t man;
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun 	if (phloat >= 0x80000000) {
26*4882a593Smuzhiyun 		dev_err(&client->dev, "this is a negative number\n");
27*4882a593Smuzhiyun 		return 0;
28*4882a593Smuzhiyun 	}
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun 	if (phloat == 0x7f800000)
31*4882a593Smuzhiyun 		return ~0; /* Inf. */
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun 	if ((phloat & 0x7f800000) == 0x7f800000) {
34*4882a593Smuzhiyun 		dev_err(&client->dev, "NaN or other special number\n");
35*4882a593Smuzhiyun 		return 0;
36*4882a593Smuzhiyun 	}
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun 	/* Valid cases begin here */
39*4882a593Smuzhiyun 	if (phloat == 0)
40*4882a593Smuzhiyun 		return 0; /* Valid zero */
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun 	if (phloat > 0x4f800000)
43*4882a593Smuzhiyun 		return ~0; /* larger than 4294967295 */
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun 	/*
46*4882a593Smuzhiyun 	 * Unbias exponent (note how phloat is now guaranteed to
47*4882a593Smuzhiyun 	 * have 0 in the high bit)
48*4882a593Smuzhiyun 	 */
49*4882a593Smuzhiyun 	exp = ((int32_t)phloat >> 23) - 127;
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun 	/* Extract mantissa, add missing '1' bit and it's in MHz */
52*4882a593Smuzhiyun 	man = ((phloat & 0x7fffff) | 0x800000) * 1000000ULL;
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun 	if (exp < 0)
55*4882a593Smuzhiyun 		man >>= -exp;
56*4882a593Smuzhiyun 	else
57*4882a593Smuzhiyun 		man <<= exp;
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun 	man >>= 23; /* Remove mantissa bias */
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun 	return man & 0xffffffff;
62*4882a593Smuzhiyun }
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun /*
66*4882a593Smuzhiyun  * Read a 8/16/32-bit i2c register.  The value is returned in 'val'.
67*4882a593Smuzhiyun  * Returns zero if successful, or non-zero otherwise.
68*4882a593Smuzhiyun  */
____smiapp_read(struct smiapp_sensor * sensor,u16 reg,u16 len,u32 * val)69*4882a593Smuzhiyun static int ____smiapp_read(struct smiapp_sensor *sensor, u16 reg,
70*4882a593Smuzhiyun 			   u16 len, u32 *val)
71*4882a593Smuzhiyun {
72*4882a593Smuzhiyun 	struct i2c_client *client = v4l2_get_subdevdata(&sensor->src->sd);
73*4882a593Smuzhiyun 	struct i2c_msg msg;
74*4882a593Smuzhiyun 	unsigned char data_buf[sizeof(u32)] = { 0 };
75*4882a593Smuzhiyun 	unsigned char offset_buf[sizeof(u16)];
76*4882a593Smuzhiyun 	int r;
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	if (len > sizeof(data_buf))
79*4882a593Smuzhiyun 		return -EINVAL;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	msg.addr = client->addr;
82*4882a593Smuzhiyun 	msg.flags = 0;
83*4882a593Smuzhiyun 	msg.len = sizeof(offset_buf);
84*4882a593Smuzhiyun 	msg.buf = offset_buf;
85*4882a593Smuzhiyun 	put_unaligned_be16(reg, offset_buf);
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	r = i2c_transfer(client->adapter, &msg, 1);
88*4882a593Smuzhiyun 	if (r != 1) {
89*4882a593Smuzhiyun 		if (r >= 0)
90*4882a593Smuzhiyun 			r = -EBUSY;
91*4882a593Smuzhiyun 		goto err;
92*4882a593Smuzhiyun 	}
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	msg.len = len;
95*4882a593Smuzhiyun 	msg.flags = I2C_M_RD;
96*4882a593Smuzhiyun 	msg.buf = &data_buf[sizeof(data_buf) - len];
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 	r = i2c_transfer(client->adapter, &msg, 1);
99*4882a593Smuzhiyun 	if (r != 1) {
100*4882a593Smuzhiyun 		if (r >= 0)
101*4882a593Smuzhiyun 			r = -EBUSY;
102*4882a593Smuzhiyun 		goto err;
103*4882a593Smuzhiyun 	}
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 	*val = get_unaligned_be32(data_buf);
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	return 0;
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun err:
110*4882a593Smuzhiyun 	dev_err(&client->dev, "read from offset 0x%x error %d\n", reg, r);
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	return r;
113*4882a593Smuzhiyun }
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun /* Read a register using 8-bit access only. */
____smiapp_read_8only(struct smiapp_sensor * sensor,u16 reg,u16 len,u32 * val)116*4882a593Smuzhiyun static int ____smiapp_read_8only(struct smiapp_sensor *sensor, u16 reg,
117*4882a593Smuzhiyun 				 u16 len, u32 *val)
118*4882a593Smuzhiyun {
119*4882a593Smuzhiyun 	unsigned int i;
120*4882a593Smuzhiyun 	int rval;
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun 	*val = 0;
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun 	for (i = 0; i < len; i++) {
125*4882a593Smuzhiyun 		u32 val8;
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun 		rval = ____smiapp_read(sensor, reg + i, 1, &val8);
128*4882a593Smuzhiyun 		if (rval < 0)
129*4882a593Smuzhiyun 			return rval;
130*4882a593Smuzhiyun 		*val |= val8 << ((len - i - 1) << 3);
131*4882a593Smuzhiyun 	}
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	return 0;
134*4882a593Smuzhiyun }
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun /*
137*4882a593Smuzhiyun  * Read a 8/16/32-bit i2c register.  The value is returned in 'val'.
138*4882a593Smuzhiyun  * Returns zero if successful, or non-zero otherwise.
139*4882a593Smuzhiyun  */
__smiapp_read(struct smiapp_sensor * sensor,u32 reg,u32 * val,bool only8)140*4882a593Smuzhiyun static int __smiapp_read(struct smiapp_sensor *sensor, u32 reg, u32 *val,
141*4882a593Smuzhiyun 			 bool only8)
142*4882a593Smuzhiyun {
143*4882a593Smuzhiyun 	struct i2c_client *client = v4l2_get_subdevdata(&sensor->src->sd);
144*4882a593Smuzhiyun 	u8 len = SMIAPP_REG_WIDTH(reg);
145*4882a593Smuzhiyun 	int rval;
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 	if (len != SMIAPP_REG_8BIT && len != SMIAPP_REG_16BIT
148*4882a593Smuzhiyun 	    && len != SMIAPP_REG_32BIT)
149*4882a593Smuzhiyun 		return -EINVAL;
150*4882a593Smuzhiyun 
151*4882a593Smuzhiyun 	if (!only8)
152*4882a593Smuzhiyun 		rval = ____smiapp_read(sensor, SMIAPP_REG_ADDR(reg), len, val);
153*4882a593Smuzhiyun 	else
154*4882a593Smuzhiyun 		rval = ____smiapp_read_8only(sensor, SMIAPP_REG_ADDR(reg), len,
155*4882a593Smuzhiyun 					     val);
156*4882a593Smuzhiyun 	if (rval < 0)
157*4882a593Smuzhiyun 		return rval;
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun 	if (reg & SMIAPP_REG_FLAG_FLOAT)
160*4882a593Smuzhiyun 		*val = float_to_u32_mul_1000000(client, *val);
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun 	return 0;
163*4882a593Smuzhiyun }
164*4882a593Smuzhiyun 
smiapp_read_no_quirk(struct smiapp_sensor * sensor,u32 reg,u32 * val)165*4882a593Smuzhiyun int smiapp_read_no_quirk(struct smiapp_sensor *sensor, u32 reg, u32 *val)
166*4882a593Smuzhiyun {
167*4882a593Smuzhiyun 	return __smiapp_read(
168*4882a593Smuzhiyun 		sensor, reg, val,
169*4882a593Smuzhiyun 		smiapp_needs_quirk(sensor,
170*4882a593Smuzhiyun 				   SMIAPP_QUIRK_FLAG_8BIT_READ_ONLY));
171*4882a593Smuzhiyun }
172*4882a593Smuzhiyun 
smiapp_read_quirk(struct smiapp_sensor * sensor,u32 reg,u32 * val,bool force8)173*4882a593Smuzhiyun static int smiapp_read_quirk(struct smiapp_sensor *sensor, u32 reg, u32 *val,
174*4882a593Smuzhiyun 			     bool force8)
175*4882a593Smuzhiyun {
176*4882a593Smuzhiyun 	int rval;
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun 	*val = 0;
179*4882a593Smuzhiyun 	rval = smiapp_call_quirk(sensor, reg_access, false, &reg, val);
180*4882a593Smuzhiyun 	if (rval == -ENOIOCTLCMD)
181*4882a593Smuzhiyun 		return 0;
182*4882a593Smuzhiyun 	if (rval < 0)
183*4882a593Smuzhiyun 		return rval;
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun 	if (force8)
186*4882a593Smuzhiyun 		return __smiapp_read(sensor, reg, val, true);
187*4882a593Smuzhiyun 
188*4882a593Smuzhiyun 	return smiapp_read_no_quirk(sensor, reg, val);
189*4882a593Smuzhiyun }
190*4882a593Smuzhiyun 
smiapp_read(struct smiapp_sensor * sensor,u32 reg,u32 * val)191*4882a593Smuzhiyun int smiapp_read(struct smiapp_sensor *sensor, u32 reg, u32 *val)
192*4882a593Smuzhiyun {
193*4882a593Smuzhiyun 	return smiapp_read_quirk(sensor, reg, val, false);
194*4882a593Smuzhiyun }
195*4882a593Smuzhiyun 
smiapp_read_8only(struct smiapp_sensor * sensor,u32 reg,u32 * val)196*4882a593Smuzhiyun int smiapp_read_8only(struct smiapp_sensor *sensor, u32 reg, u32 *val)
197*4882a593Smuzhiyun {
198*4882a593Smuzhiyun 	return smiapp_read_quirk(sensor, reg, val, true);
199*4882a593Smuzhiyun }
200*4882a593Smuzhiyun 
smiapp_write_no_quirk(struct smiapp_sensor * sensor,u32 reg,u32 val)201*4882a593Smuzhiyun int smiapp_write_no_quirk(struct smiapp_sensor *sensor, u32 reg, u32 val)
202*4882a593Smuzhiyun {
203*4882a593Smuzhiyun 	struct i2c_client *client = v4l2_get_subdevdata(&sensor->src->sd);
204*4882a593Smuzhiyun 	struct i2c_msg msg;
205*4882a593Smuzhiyun 	unsigned char data[6];
206*4882a593Smuzhiyun 	unsigned int retries;
207*4882a593Smuzhiyun 	u8 len = SMIAPP_REG_WIDTH(reg);
208*4882a593Smuzhiyun 	int r;
209*4882a593Smuzhiyun 
210*4882a593Smuzhiyun 	if (len > sizeof(data) - 2)
211*4882a593Smuzhiyun 		return -EINVAL;
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun 	msg.addr = client->addr;
214*4882a593Smuzhiyun 	msg.flags = 0; /* Write */
215*4882a593Smuzhiyun 	msg.len = 2 + len;
216*4882a593Smuzhiyun 	msg.buf = data;
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun 	put_unaligned_be16(SMIAPP_REG_ADDR(reg), data);
219*4882a593Smuzhiyun 	put_unaligned_be32(val << (8 * (sizeof(val) - len)), data + 2);
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun 	for (retries = 0; retries < 5; retries++) {
222*4882a593Smuzhiyun 		/*
223*4882a593Smuzhiyun 		 * Due to unknown reason sensor stops responding. This
224*4882a593Smuzhiyun 		 * loop is a temporaty solution until the root cause
225*4882a593Smuzhiyun 		 * is found.
226*4882a593Smuzhiyun 		 */
227*4882a593Smuzhiyun 		r = i2c_transfer(client->adapter, &msg, 1);
228*4882a593Smuzhiyun 		if (r == 1) {
229*4882a593Smuzhiyun 			if (retries)
230*4882a593Smuzhiyun 				dev_err(&client->dev,
231*4882a593Smuzhiyun 					"sensor i2c stall encountered. retries: %d\n",
232*4882a593Smuzhiyun 					retries);
233*4882a593Smuzhiyun 			return 0;
234*4882a593Smuzhiyun 		}
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun 		usleep_range(2000, 2000);
237*4882a593Smuzhiyun 	}
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 	dev_err(&client->dev,
240*4882a593Smuzhiyun 		"wrote 0x%x to offset 0x%x error %d\n", val,
241*4882a593Smuzhiyun 		SMIAPP_REG_ADDR(reg), r);
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun 	return r;
244*4882a593Smuzhiyun }
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun /*
247*4882a593Smuzhiyun  * Write to a 8/16-bit register.
248*4882a593Smuzhiyun  * Returns zero if successful, or non-zero otherwise.
249*4882a593Smuzhiyun  */
smiapp_write(struct smiapp_sensor * sensor,u32 reg,u32 val)250*4882a593Smuzhiyun int smiapp_write(struct smiapp_sensor *sensor, u32 reg, u32 val)
251*4882a593Smuzhiyun {
252*4882a593Smuzhiyun 	int rval;
253*4882a593Smuzhiyun 
254*4882a593Smuzhiyun 	rval = smiapp_call_quirk(sensor, reg_access, true, &reg, &val);
255*4882a593Smuzhiyun 	if (rval == -ENOIOCTLCMD)
256*4882a593Smuzhiyun 		return 0;
257*4882a593Smuzhiyun 	if (rval < 0)
258*4882a593Smuzhiyun 		return rval;
259*4882a593Smuzhiyun 
260*4882a593Smuzhiyun 	return smiapp_write_no_quirk(sensor, reg, val);
261*4882a593Smuzhiyun }
262