1d6ffb630SEddie James // SPDX-License-Identifier: GPL-2.0+
2d6ffb630SEddie James /*
3d6ffb630SEddie James * FSI-attached I2C master algorithm
4d6ffb630SEddie James *
5d6ffb630SEddie James * Copyright 2018 IBM Corporation
6d6ffb630SEddie James *
7d6ffb630SEddie James * This program is free software; you can redistribute it and/or
8d6ffb630SEddie James * modify it under the terms of the GNU General Public License
9d6ffb630SEddie James * as published by the Free Software Foundation; either version
10d6ffb630SEddie James * 2 of the License, or (at your option) any later version.
11d6ffb630SEddie James */
12d6ffb630SEddie James
13d6ffb630SEddie James #include <linux/bitfield.h>
14d6ffb630SEddie James #include <linux/bitops.h>
156cdf5e39SEddie James #include <linux/delay.h>
16d6ffb630SEddie James #include <linux/device.h>
17d6ffb630SEddie James #include <linux/errno.h>
18d6ffb630SEddie James #include <linux/fsi.h>
19d6ffb630SEddie James #include <linux/i2c.h>
206cdf5e39SEddie James #include <linux/jiffies.h>
21d6ffb630SEddie James #include <linux/kernel.h>
2219b4887aSEddie James #include <linux/list.h>
23d6ffb630SEddie James #include <linux/module.h>
24f4cdc319SEddie James #include <linux/mutex.h>
2519b4887aSEddie James #include <linux/of.h>
2619b4887aSEddie James #include <linux/slab.h>
27d6ffb630SEddie James
28d6ffb630SEddie James #define FSI_ENGID_I2C 0x7
29d6ffb630SEddie James
30d6ffb630SEddie James #define I2C_DEFAULT_CLK_DIV 6
31d6ffb630SEddie James
32d6ffb630SEddie James /* i2c registers */
33d6ffb630SEddie James #define I2C_FSI_FIFO 0x00
34d6ffb630SEddie James #define I2C_FSI_CMD 0x04
35d6ffb630SEddie James #define I2C_FSI_MODE 0x08
36d6ffb630SEddie James #define I2C_FSI_WATER_MARK 0x0C
37d6ffb630SEddie James #define I2C_FSI_INT_MASK 0x10
38d6ffb630SEddie James #define I2C_FSI_INT_COND 0x14
39d6ffb630SEddie James #define I2C_FSI_OR_INT_MASK 0x14
40d6ffb630SEddie James #define I2C_FSI_INTS 0x18
41d6ffb630SEddie James #define I2C_FSI_AND_INT_MASK 0x18
42d6ffb630SEddie James #define I2C_FSI_STAT 0x1C
43d6ffb630SEddie James #define I2C_FSI_RESET_I2C 0x1C
44d6ffb630SEddie James #define I2C_FSI_ESTAT 0x20
45d6ffb630SEddie James #define I2C_FSI_RESET_ERR 0x20
46d6ffb630SEddie James #define I2C_FSI_RESID_LEN 0x24
47d6ffb630SEddie James #define I2C_FSI_SET_SCL 0x24
48d6ffb630SEddie James #define I2C_FSI_PORT_BUSY 0x28
49d6ffb630SEddie James #define I2C_FSI_RESET_SCL 0x2C
50d6ffb630SEddie James #define I2C_FSI_SET_SDA 0x30
51d6ffb630SEddie James #define I2C_FSI_RESET_SDA 0x34
52d6ffb630SEddie James
53d6ffb630SEddie James /* cmd register */
54d6ffb630SEddie James #define I2C_CMD_WITH_START BIT(31)
55d6ffb630SEddie James #define I2C_CMD_WITH_ADDR BIT(30)
56d6ffb630SEddie James #define I2C_CMD_RD_CONT BIT(29)
57d6ffb630SEddie James #define I2C_CMD_WITH_STOP BIT(28)
58d6ffb630SEddie James #define I2C_CMD_FORCELAUNCH BIT(27)
59d6ffb630SEddie James #define I2C_CMD_ADDR GENMASK(23, 17)
60d6ffb630SEddie James #define I2C_CMD_READ BIT(16)
61d6ffb630SEddie James #define I2C_CMD_LEN GENMASK(15, 0)
62d6ffb630SEddie James
63d6ffb630SEddie James /* mode register */
64d6ffb630SEddie James #define I2C_MODE_CLKDIV GENMASK(31, 16)
65d6ffb630SEddie James #define I2C_MODE_PORT GENMASK(15, 10)
66d6ffb630SEddie James #define I2C_MODE_ENHANCED BIT(3)
67d6ffb630SEddie James #define I2C_MODE_DIAG BIT(2)
68d6ffb630SEddie James #define I2C_MODE_PACE_ALLOW BIT(1)
69d6ffb630SEddie James #define I2C_MODE_WRAP BIT(0)
70d6ffb630SEddie James
71d6ffb630SEddie James /* watermark register */
72d6ffb630SEddie James #define I2C_WATERMARK_HI GENMASK(15, 12)
73d6ffb630SEddie James #define I2C_WATERMARK_LO GENMASK(7, 4)
74d6ffb630SEddie James
75d6ffb630SEddie James #define I2C_FIFO_HI_LVL 4
76d6ffb630SEddie James #define I2C_FIFO_LO_LVL 4
77d6ffb630SEddie James
78d6ffb630SEddie James /* interrupt register */
79d6ffb630SEddie James #define I2C_INT_INV_CMD BIT(15)
80d6ffb630SEddie James #define I2C_INT_PARITY BIT(14)
81d6ffb630SEddie James #define I2C_INT_BE_OVERRUN BIT(13)
82d6ffb630SEddie James #define I2C_INT_BE_ACCESS BIT(12)
83d6ffb630SEddie James #define I2C_INT_LOST_ARB BIT(11)
84d6ffb630SEddie James #define I2C_INT_NACK BIT(10)
85d6ffb630SEddie James #define I2C_INT_DAT_REQ BIT(9)
86d6ffb630SEddie James #define I2C_INT_CMD_COMP BIT(8)
87d6ffb630SEddie James #define I2C_INT_STOP_ERR BIT(7)
88d6ffb630SEddie James #define I2C_INT_BUSY BIT(6)
89d6ffb630SEddie James #define I2C_INT_IDLE BIT(5)
90d6ffb630SEddie James
91d6ffb630SEddie James /* status register */
92d6ffb630SEddie James #define I2C_STAT_INV_CMD BIT(31)
93d6ffb630SEddie James #define I2C_STAT_PARITY BIT(30)
94d6ffb630SEddie James #define I2C_STAT_BE_OVERRUN BIT(29)
95d6ffb630SEddie James #define I2C_STAT_BE_ACCESS BIT(28)
96d6ffb630SEddie James #define I2C_STAT_LOST_ARB BIT(27)
97d6ffb630SEddie James #define I2C_STAT_NACK BIT(26)
98d6ffb630SEddie James #define I2C_STAT_DAT_REQ BIT(25)
99d6ffb630SEddie James #define I2C_STAT_CMD_COMP BIT(24)
100d6ffb630SEddie James #define I2C_STAT_STOP_ERR BIT(23)
101502035e2SEddie James #define I2C_STAT_MAX_PORT GENMASK(22, 16)
102d6ffb630SEddie James #define I2C_STAT_ANY_INT BIT(15)
103d6ffb630SEddie James #define I2C_STAT_SCL_IN BIT(11)
104d6ffb630SEddie James #define I2C_STAT_SDA_IN BIT(10)
105d6ffb630SEddie James #define I2C_STAT_PORT_BUSY BIT(9)
106d6ffb630SEddie James #define I2C_STAT_SELF_BUSY BIT(8)
107d6ffb630SEddie James #define I2C_STAT_FIFO_COUNT GENMASK(7, 0)
108d6ffb630SEddie James
109d6ffb630SEddie James #define I2C_STAT_ERR (I2C_STAT_INV_CMD | \
110d6ffb630SEddie James I2C_STAT_PARITY | \
111d6ffb630SEddie James I2C_STAT_BE_OVERRUN | \
112d6ffb630SEddie James I2C_STAT_BE_ACCESS | \
113d6ffb630SEddie James I2C_STAT_LOST_ARB | \
114d6ffb630SEddie James I2C_STAT_NACK | \
115d6ffb630SEddie James I2C_STAT_STOP_ERR)
116d6ffb630SEddie James #define I2C_STAT_ANY_RESP (I2C_STAT_ERR | \
117d6ffb630SEddie James I2C_STAT_DAT_REQ | \
118d6ffb630SEddie James I2C_STAT_CMD_COMP)
119d6ffb630SEddie James
120d6ffb630SEddie James /* extended status register */
121d6ffb630SEddie James #define I2C_ESTAT_FIFO_SZ GENMASK(31, 24)
122d6ffb630SEddie James #define I2C_ESTAT_SCL_IN_SY BIT(15)
123d6ffb630SEddie James #define I2C_ESTAT_SDA_IN_SY BIT(14)
124d6ffb630SEddie James #define I2C_ESTAT_S_SCL BIT(13)
125d6ffb630SEddie James #define I2C_ESTAT_S_SDA BIT(12)
126d6ffb630SEddie James #define I2C_ESTAT_M_SCL BIT(11)
127d6ffb630SEddie James #define I2C_ESTAT_M_SDA BIT(10)
128d6ffb630SEddie James #define I2C_ESTAT_HI_WATER BIT(9)
129d6ffb630SEddie James #define I2C_ESTAT_LO_WATER BIT(8)
130d6ffb630SEddie James #define I2C_ESTAT_PORT_BUSY BIT(7)
131d6ffb630SEddie James #define I2C_ESTAT_SELF_BUSY BIT(6)
132d6ffb630SEddie James #define I2C_ESTAT_VERSION GENMASK(4, 0)
133d6ffb630SEddie James
1346cdf5e39SEddie James /* port busy register */
1356cdf5e39SEddie James #define I2C_PORT_BUSY_RESET BIT(31)
1366cdf5e39SEddie James
1376cdf5e39SEddie James /* wait for command complete or data request */
1386cdf5e39SEddie James #define I2C_CMD_SLEEP_MAX_US 500
1396cdf5e39SEddie James #define I2C_CMD_SLEEP_MIN_US 50
1406cdf5e39SEddie James
1416cdf5e39SEddie James /* wait after reset; choose time from legacy driver */
1426cdf5e39SEddie James #define I2C_RESET_SLEEP_MAX_US 2000
1436cdf5e39SEddie James #define I2C_RESET_SLEEP_MIN_US 1000
1446cdf5e39SEddie James
1456cdf5e39SEddie James /* choose timeout length from legacy driver; it's well tested */
1466cdf5e39SEddie James #define I2C_ABORT_TIMEOUT msecs_to_jiffies(100)
1476cdf5e39SEddie James
148d6ffb630SEddie James struct fsi_i2c_master {
149d6ffb630SEddie James struct fsi_device *fsi;
150d6ffb630SEddie James u8 fifo_size;
15119b4887aSEddie James struct list_head ports;
152f4cdc319SEddie James struct mutex lock;
15319b4887aSEddie James };
15419b4887aSEddie James
15519b4887aSEddie James struct fsi_i2c_port {
15619b4887aSEddie James struct list_head list;
15719b4887aSEddie James struct i2c_adapter adapter;
15819b4887aSEddie James struct fsi_i2c_master *master;
15919b4887aSEddie James u16 port;
160504b8277SEddie James u16 xfrd;
161d6ffb630SEddie James };
162d6ffb630SEddie James
fsi_i2c_read_reg(struct fsi_device * fsi,unsigned int reg,u32 * data)163d6ffb630SEddie James static int fsi_i2c_read_reg(struct fsi_device *fsi, unsigned int reg,
164d6ffb630SEddie James u32 *data)
165d6ffb630SEddie James {
166d6ffb630SEddie James int rc;
167d6ffb630SEddie James __be32 data_be;
168d6ffb630SEddie James
169d6ffb630SEddie James rc = fsi_device_read(fsi, reg, &data_be, sizeof(data_be));
170d6ffb630SEddie James if (rc)
171d6ffb630SEddie James return rc;
172d6ffb630SEddie James
173d6ffb630SEddie James *data = be32_to_cpu(data_be);
174d6ffb630SEddie James
175d6ffb630SEddie James return 0;
176d6ffb630SEddie James }
177d6ffb630SEddie James
fsi_i2c_write_reg(struct fsi_device * fsi,unsigned int reg,u32 * data)178d6ffb630SEddie James static int fsi_i2c_write_reg(struct fsi_device *fsi, unsigned int reg,
179d6ffb630SEddie James u32 *data)
180d6ffb630SEddie James {
181d6ffb630SEddie James __be32 data_be = cpu_to_be32p(data);
182d6ffb630SEddie James
183d6ffb630SEddie James return fsi_device_write(fsi, reg, &data_be, sizeof(data_be));
184d6ffb630SEddie James }
185d6ffb630SEddie James
fsi_i2c_dev_init(struct fsi_i2c_master * i2c)186d6ffb630SEddie James static int fsi_i2c_dev_init(struct fsi_i2c_master *i2c)
187d6ffb630SEddie James {
188d6ffb630SEddie James int rc;
189d6ffb630SEddie James u32 mode = I2C_MODE_ENHANCED, extended_status, watermark;
190d6ffb630SEddie James u32 interrupt = 0;
191d6ffb630SEddie James
192d6ffb630SEddie James /* since we use polling, disable interrupts */
193d6ffb630SEddie James rc = fsi_i2c_write_reg(i2c->fsi, I2C_FSI_INT_MASK, &interrupt);
194d6ffb630SEddie James if (rc)
195d6ffb630SEddie James return rc;
196d6ffb630SEddie James
197d6ffb630SEddie James mode |= FIELD_PREP(I2C_MODE_CLKDIV, I2C_DEFAULT_CLK_DIV);
198d6ffb630SEddie James rc = fsi_i2c_write_reg(i2c->fsi, I2C_FSI_MODE, &mode);
199d6ffb630SEddie James if (rc)
200d6ffb630SEddie James return rc;
201d6ffb630SEddie James
202d6ffb630SEddie James rc = fsi_i2c_read_reg(i2c->fsi, I2C_FSI_ESTAT, &extended_status);
203d6ffb630SEddie James if (rc)
204d6ffb630SEddie James return rc;
205d6ffb630SEddie James
206d6ffb630SEddie James i2c->fifo_size = FIELD_GET(I2C_ESTAT_FIFO_SZ, extended_status);
207d6ffb630SEddie James watermark = FIELD_PREP(I2C_WATERMARK_HI,
208d6ffb630SEddie James i2c->fifo_size - I2C_FIFO_HI_LVL);
209d6ffb630SEddie James watermark |= FIELD_PREP(I2C_WATERMARK_LO, I2C_FIFO_LO_LVL);
210d6ffb630SEddie James
211d6ffb630SEddie James return fsi_i2c_write_reg(i2c->fsi, I2C_FSI_WATER_MARK, &watermark);
212d6ffb630SEddie James }
213d6ffb630SEddie James
fsi_i2c_set_port(struct fsi_i2c_port * port)21419b4887aSEddie James static int fsi_i2c_set_port(struct fsi_i2c_port *port)
21519b4887aSEddie James {
21619b4887aSEddie James int rc;
21719b4887aSEddie James struct fsi_device *fsi = port->master->fsi;
21819b4887aSEddie James u32 mode, dummy = 0;
21919b4887aSEddie James
22019b4887aSEddie James rc = fsi_i2c_read_reg(fsi, I2C_FSI_MODE, &mode);
22119b4887aSEddie James if (rc)
22219b4887aSEddie James return rc;
22319b4887aSEddie James
22419b4887aSEddie James if (FIELD_GET(I2C_MODE_PORT, mode) == port->port)
22519b4887aSEddie James return 0;
22619b4887aSEddie James
22719b4887aSEddie James mode = (mode & ~I2C_MODE_PORT) | FIELD_PREP(I2C_MODE_PORT, port->port);
22819b4887aSEddie James rc = fsi_i2c_write_reg(fsi, I2C_FSI_MODE, &mode);
22919b4887aSEddie James if (rc)
23019b4887aSEddie James return rc;
23119b4887aSEddie James
23219b4887aSEddie James /* reset engine when port is changed */
23319b4887aSEddie James return fsi_i2c_write_reg(fsi, I2C_FSI_RESET_ERR, &dummy);
23419b4887aSEddie James }
23519b4887aSEddie James
fsi_i2c_start(struct fsi_i2c_port * port,struct i2c_msg * msg,bool stop)236504b8277SEddie James static int fsi_i2c_start(struct fsi_i2c_port *port, struct i2c_msg *msg,
237504b8277SEddie James bool stop)
238504b8277SEddie James {
239504b8277SEddie James struct fsi_i2c_master *i2c = port->master;
240504b8277SEddie James u32 cmd = I2C_CMD_WITH_START | I2C_CMD_WITH_ADDR;
241504b8277SEddie James
242504b8277SEddie James port->xfrd = 0;
243504b8277SEddie James
244504b8277SEddie James if (msg->flags & I2C_M_RD)
245504b8277SEddie James cmd |= I2C_CMD_READ;
246504b8277SEddie James
247504b8277SEddie James if (stop || msg->flags & I2C_M_STOP)
248504b8277SEddie James cmd |= I2C_CMD_WITH_STOP;
249504b8277SEddie James
250504b8277SEddie James cmd |= FIELD_PREP(I2C_CMD_ADDR, msg->addr);
251504b8277SEddie James cmd |= FIELD_PREP(I2C_CMD_LEN, msg->len);
252504b8277SEddie James
253504b8277SEddie James return fsi_i2c_write_reg(i2c->fsi, I2C_FSI_CMD, &cmd);
254504b8277SEddie James }
255504b8277SEddie James
fsi_i2c_get_op_bytes(int op_bytes)256504b8277SEddie James static int fsi_i2c_get_op_bytes(int op_bytes)
257504b8277SEddie James {
258504b8277SEddie James /* fsi is limited to max 4 byte aligned ops */
259504b8277SEddie James if (op_bytes > 4)
260504b8277SEddie James return 4;
261504b8277SEddie James else if (op_bytes == 3)
262504b8277SEddie James return 2;
263504b8277SEddie James return op_bytes;
264504b8277SEddie James }
265504b8277SEddie James
fsi_i2c_write_fifo(struct fsi_i2c_port * port,struct i2c_msg * msg,u8 fifo_count)266504b8277SEddie James static int fsi_i2c_write_fifo(struct fsi_i2c_port *port, struct i2c_msg *msg,
267504b8277SEddie James u8 fifo_count)
268504b8277SEddie James {
269504b8277SEddie James int write;
270504b8277SEddie James int rc;
271504b8277SEddie James struct fsi_i2c_master *i2c = port->master;
272504b8277SEddie James int bytes_to_write = i2c->fifo_size - fifo_count;
273504b8277SEddie James int bytes_remaining = msg->len - port->xfrd;
274504b8277SEddie James
275504b8277SEddie James bytes_to_write = min(bytes_to_write, bytes_remaining);
276504b8277SEddie James
277504b8277SEddie James while (bytes_to_write) {
278504b8277SEddie James write = fsi_i2c_get_op_bytes(bytes_to_write);
279504b8277SEddie James
280504b8277SEddie James rc = fsi_device_write(i2c->fsi, I2C_FSI_FIFO,
281504b8277SEddie James &msg->buf[port->xfrd], write);
282504b8277SEddie James if (rc)
283504b8277SEddie James return rc;
284504b8277SEddie James
285504b8277SEddie James port->xfrd += write;
286504b8277SEddie James bytes_to_write -= write;
287504b8277SEddie James }
288504b8277SEddie James
289504b8277SEddie James return 0;
290504b8277SEddie James }
291504b8277SEddie James
fsi_i2c_read_fifo(struct fsi_i2c_port * port,struct i2c_msg * msg,u8 fifo_count)292504b8277SEddie James static int fsi_i2c_read_fifo(struct fsi_i2c_port *port, struct i2c_msg *msg,
293504b8277SEddie James u8 fifo_count)
294504b8277SEddie James {
295504b8277SEddie James int read;
296504b8277SEddie James int rc;
297504b8277SEddie James struct fsi_i2c_master *i2c = port->master;
298504b8277SEddie James int bytes_to_read;
299504b8277SEddie James int xfr_remaining = msg->len - port->xfrd;
300504b8277SEddie James u32 dummy;
301504b8277SEddie James
302504b8277SEddie James bytes_to_read = min_t(int, fifo_count, xfr_remaining);
303504b8277SEddie James
304504b8277SEddie James while (bytes_to_read) {
305504b8277SEddie James read = fsi_i2c_get_op_bytes(bytes_to_read);
306504b8277SEddie James
307504b8277SEddie James if (xfr_remaining) {
308504b8277SEddie James rc = fsi_device_read(i2c->fsi, I2C_FSI_FIFO,
309504b8277SEddie James &msg->buf[port->xfrd], read);
310504b8277SEddie James if (rc)
311504b8277SEddie James return rc;
312504b8277SEddie James
313504b8277SEddie James port->xfrd += read;
314504b8277SEddie James xfr_remaining -= read;
315504b8277SEddie James } else {
316504b8277SEddie James /* no more buffer but data in fifo, need to clear it */
317504b8277SEddie James rc = fsi_device_read(i2c->fsi, I2C_FSI_FIFO, &dummy,
318504b8277SEddie James read);
319504b8277SEddie James if (rc)
320504b8277SEddie James return rc;
321504b8277SEddie James }
322504b8277SEddie James
323504b8277SEddie James bytes_to_read -= read;
324504b8277SEddie James }
325504b8277SEddie James
326504b8277SEddie James return 0;
327504b8277SEddie James }
328504b8277SEddie James
fsi_i2c_get_scl(struct i2c_adapter * adap)329720d5ce9SEddie James static int fsi_i2c_get_scl(struct i2c_adapter *adap)
330720d5ce9SEddie James {
331720d5ce9SEddie James u32 stat = 0;
332720d5ce9SEddie James struct fsi_i2c_port *port = adap->algo_data;
333720d5ce9SEddie James struct fsi_i2c_master *i2c = port->master;
334720d5ce9SEddie James
335720d5ce9SEddie James fsi_i2c_read_reg(i2c->fsi, I2C_FSI_STAT, &stat);
336720d5ce9SEddie James
337720d5ce9SEddie James return !!(stat & I2C_STAT_SCL_IN);
338720d5ce9SEddie James }
339720d5ce9SEddie James
fsi_i2c_set_scl(struct i2c_adapter * adap,int val)340720d5ce9SEddie James static void fsi_i2c_set_scl(struct i2c_adapter *adap, int val)
341720d5ce9SEddie James {
342720d5ce9SEddie James u32 dummy = 0;
343720d5ce9SEddie James struct fsi_i2c_port *port = adap->algo_data;
344720d5ce9SEddie James struct fsi_i2c_master *i2c = port->master;
345720d5ce9SEddie James
346720d5ce9SEddie James if (val)
347720d5ce9SEddie James fsi_i2c_write_reg(i2c->fsi, I2C_FSI_SET_SCL, &dummy);
348720d5ce9SEddie James else
349720d5ce9SEddie James fsi_i2c_write_reg(i2c->fsi, I2C_FSI_RESET_SCL, &dummy);
350720d5ce9SEddie James }
351720d5ce9SEddie James
fsi_i2c_get_sda(struct i2c_adapter * adap)352720d5ce9SEddie James static int fsi_i2c_get_sda(struct i2c_adapter *adap)
353720d5ce9SEddie James {
354720d5ce9SEddie James u32 stat = 0;
355720d5ce9SEddie James struct fsi_i2c_port *port = adap->algo_data;
356720d5ce9SEddie James struct fsi_i2c_master *i2c = port->master;
357720d5ce9SEddie James
358720d5ce9SEddie James fsi_i2c_read_reg(i2c->fsi, I2C_FSI_STAT, &stat);
359720d5ce9SEddie James
360720d5ce9SEddie James return !!(stat & I2C_STAT_SDA_IN);
361720d5ce9SEddie James }
362720d5ce9SEddie James
fsi_i2c_set_sda(struct i2c_adapter * adap,int val)363720d5ce9SEddie James static void fsi_i2c_set_sda(struct i2c_adapter *adap, int val)
364720d5ce9SEddie James {
365720d5ce9SEddie James u32 dummy = 0;
366720d5ce9SEddie James struct fsi_i2c_port *port = adap->algo_data;
367720d5ce9SEddie James struct fsi_i2c_master *i2c = port->master;
368720d5ce9SEddie James
369720d5ce9SEddie James if (val)
370720d5ce9SEddie James fsi_i2c_write_reg(i2c->fsi, I2C_FSI_SET_SDA, &dummy);
371720d5ce9SEddie James else
372720d5ce9SEddie James fsi_i2c_write_reg(i2c->fsi, I2C_FSI_RESET_SDA, &dummy);
373720d5ce9SEddie James }
374720d5ce9SEddie James
fsi_i2c_prepare_recovery(struct i2c_adapter * adap)375720d5ce9SEddie James static void fsi_i2c_prepare_recovery(struct i2c_adapter *adap)
376720d5ce9SEddie James {
377720d5ce9SEddie James int rc;
378720d5ce9SEddie James u32 mode;
379720d5ce9SEddie James struct fsi_i2c_port *port = adap->algo_data;
380720d5ce9SEddie James struct fsi_i2c_master *i2c = port->master;
381720d5ce9SEddie James
382720d5ce9SEddie James rc = fsi_i2c_read_reg(i2c->fsi, I2C_FSI_MODE, &mode);
383720d5ce9SEddie James if (rc)
384720d5ce9SEddie James return;
385720d5ce9SEddie James
386720d5ce9SEddie James mode |= I2C_MODE_DIAG;
387720d5ce9SEddie James fsi_i2c_write_reg(i2c->fsi, I2C_FSI_MODE, &mode);
388720d5ce9SEddie James }
389720d5ce9SEddie James
fsi_i2c_unprepare_recovery(struct i2c_adapter * adap)390720d5ce9SEddie James static void fsi_i2c_unprepare_recovery(struct i2c_adapter *adap)
391720d5ce9SEddie James {
392720d5ce9SEddie James int rc;
393720d5ce9SEddie James u32 mode;
394720d5ce9SEddie James struct fsi_i2c_port *port = adap->algo_data;
395720d5ce9SEddie James struct fsi_i2c_master *i2c = port->master;
396720d5ce9SEddie James
397720d5ce9SEddie James rc = fsi_i2c_read_reg(i2c->fsi, I2C_FSI_MODE, &mode);
398720d5ce9SEddie James if (rc)
399720d5ce9SEddie James return;
400720d5ce9SEddie James
401720d5ce9SEddie James mode &= ~I2C_MODE_DIAG;
402720d5ce9SEddie James fsi_i2c_write_reg(i2c->fsi, I2C_FSI_MODE, &mode);
403720d5ce9SEddie James }
404720d5ce9SEddie James
fsi_i2c_reset_bus(struct fsi_i2c_master * i2c,struct fsi_i2c_port * port)405720d5ce9SEddie James static int fsi_i2c_reset_bus(struct fsi_i2c_master *i2c,
406720d5ce9SEddie James struct fsi_i2c_port *port)
407720d5ce9SEddie James {
408720d5ce9SEddie James int rc;
409720d5ce9SEddie James u32 stat, dummy = 0;
410720d5ce9SEddie James
411720d5ce9SEddie James /* force bus reset, ignore errors */
412720d5ce9SEddie James i2c_recover_bus(&port->adapter);
413720d5ce9SEddie James
414720d5ce9SEddie James /* reset errors */
415720d5ce9SEddie James rc = fsi_i2c_write_reg(i2c->fsi, I2C_FSI_RESET_ERR, &dummy);
416720d5ce9SEddie James if (rc)
417720d5ce9SEddie James return rc;
418720d5ce9SEddie James
419720d5ce9SEddie James /* wait for command complete */
420720d5ce9SEddie James usleep_range(I2C_RESET_SLEEP_MIN_US, I2C_RESET_SLEEP_MAX_US);
421720d5ce9SEddie James
422720d5ce9SEddie James rc = fsi_i2c_read_reg(i2c->fsi, I2C_FSI_STAT, &stat);
423720d5ce9SEddie James if (rc)
424720d5ce9SEddie James return rc;
425720d5ce9SEddie James
426720d5ce9SEddie James if (stat & I2C_STAT_CMD_COMP)
427720d5ce9SEddie James return 0;
428720d5ce9SEddie James
429720d5ce9SEddie James /* failed to get command complete; reset engine again */
430720d5ce9SEddie James rc = fsi_i2c_write_reg(i2c->fsi, I2C_FSI_RESET_I2C, &dummy);
431720d5ce9SEddie James if (rc)
432720d5ce9SEddie James return rc;
433720d5ce9SEddie James
434720d5ce9SEddie James /* re-init engine again */
435720d5ce9SEddie James return fsi_i2c_dev_init(i2c);
436720d5ce9SEddie James }
437720d5ce9SEddie James
fsi_i2c_reset_engine(struct fsi_i2c_master * i2c,u16 port)4386cdf5e39SEddie James static int fsi_i2c_reset_engine(struct fsi_i2c_master *i2c, u16 port)
4396cdf5e39SEddie James {
4406cdf5e39SEddie James int rc;
4416cdf5e39SEddie James u32 mode, dummy = 0;
4426cdf5e39SEddie James
4436cdf5e39SEddie James /* reset engine */
4446cdf5e39SEddie James rc = fsi_i2c_write_reg(i2c->fsi, I2C_FSI_RESET_I2C, &dummy);
4456cdf5e39SEddie James if (rc)
4466cdf5e39SEddie James return rc;
4476cdf5e39SEddie James
4486cdf5e39SEddie James /* re-init engine */
4496cdf5e39SEddie James rc = fsi_i2c_dev_init(i2c);
4506cdf5e39SEddie James if (rc)
4516cdf5e39SEddie James return rc;
4526cdf5e39SEddie James
4536cdf5e39SEddie James rc = fsi_i2c_read_reg(i2c->fsi, I2C_FSI_MODE, &mode);
4546cdf5e39SEddie James if (rc)
4556cdf5e39SEddie James return rc;
4566cdf5e39SEddie James
4576cdf5e39SEddie James /* set port; default after reset is 0 */
4586cdf5e39SEddie James if (port) {
4596cdf5e39SEddie James mode &= ~I2C_MODE_PORT;
4606cdf5e39SEddie James mode |= FIELD_PREP(I2C_MODE_PORT, port);
4616cdf5e39SEddie James rc = fsi_i2c_write_reg(i2c->fsi, I2C_FSI_MODE, &mode);
4626cdf5e39SEddie James if (rc)
4636cdf5e39SEddie James return rc;
4646cdf5e39SEddie James }
4656cdf5e39SEddie James
4666cdf5e39SEddie James /* reset busy register; hw workaround */
4676cdf5e39SEddie James dummy = I2C_PORT_BUSY_RESET;
4686cdf5e39SEddie James rc = fsi_i2c_write_reg(i2c->fsi, I2C_FSI_PORT_BUSY, &dummy);
4696cdf5e39SEddie James if (rc)
4706cdf5e39SEddie James return rc;
4716cdf5e39SEddie James
4726cdf5e39SEddie James return 0;
4736cdf5e39SEddie James }
4746cdf5e39SEddie James
fsi_i2c_abort(struct fsi_i2c_port * port,u32 status)4756cdf5e39SEddie James static int fsi_i2c_abort(struct fsi_i2c_port *port, u32 status)
4766cdf5e39SEddie James {
4776cdf5e39SEddie James int rc;
4786cdf5e39SEddie James unsigned long start;
4796cdf5e39SEddie James u32 cmd = I2C_CMD_WITH_STOP;
480720d5ce9SEddie James u32 stat;
4816cdf5e39SEddie James struct fsi_i2c_master *i2c = port->master;
4826cdf5e39SEddie James struct fsi_device *fsi = i2c->fsi;
4836cdf5e39SEddie James
4846cdf5e39SEddie James rc = fsi_i2c_reset_engine(i2c, port->port);
4856cdf5e39SEddie James if (rc)
4866cdf5e39SEddie James return rc;
4876cdf5e39SEddie James
488720d5ce9SEddie James rc = fsi_i2c_read_reg(fsi, I2C_FSI_STAT, &stat);
489720d5ce9SEddie James if (rc)
490720d5ce9SEddie James return rc;
491720d5ce9SEddie James
492720d5ce9SEddie James /* if sda is low, peform full bus reset */
493720d5ce9SEddie James if (!(stat & I2C_STAT_SDA_IN)) {
494720d5ce9SEddie James rc = fsi_i2c_reset_bus(i2c, port);
495720d5ce9SEddie James if (rc)
496720d5ce9SEddie James return rc;
497720d5ce9SEddie James }
498720d5ce9SEddie James
4996cdf5e39SEddie James /* skip final stop command for these errors */
5006cdf5e39SEddie James if (status & (I2C_STAT_PARITY | I2C_STAT_LOST_ARB | I2C_STAT_STOP_ERR))
5016cdf5e39SEddie James return 0;
5026cdf5e39SEddie James
5036cdf5e39SEddie James /* write stop command */
5046cdf5e39SEddie James rc = fsi_i2c_write_reg(fsi, I2C_FSI_CMD, &cmd);
5056cdf5e39SEddie James if (rc)
5066cdf5e39SEddie James return rc;
5076cdf5e39SEddie James
5086cdf5e39SEddie James /* wait until we see command complete in the master */
5096cdf5e39SEddie James start = jiffies;
5106cdf5e39SEddie James
5116cdf5e39SEddie James do {
5126cdf5e39SEddie James rc = fsi_i2c_read_reg(fsi, I2C_FSI_STAT, &status);
5136cdf5e39SEddie James if (rc)
5146cdf5e39SEddie James return rc;
5156cdf5e39SEddie James
5166cdf5e39SEddie James if (status & I2C_STAT_CMD_COMP)
5176cdf5e39SEddie James return 0;
5186cdf5e39SEddie James
5196cdf5e39SEddie James usleep_range(I2C_CMD_SLEEP_MIN_US, I2C_CMD_SLEEP_MAX_US);
5206cdf5e39SEddie James } while (time_after(start + I2C_ABORT_TIMEOUT, jiffies));
5216cdf5e39SEddie James
5226cdf5e39SEddie James return -ETIMEDOUT;
5236cdf5e39SEddie James }
5246cdf5e39SEddie James
fsi_i2c_handle_status(struct fsi_i2c_port * port,struct i2c_msg * msg,u32 status)525504b8277SEddie James static int fsi_i2c_handle_status(struct fsi_i2c_port *port,
526504b8277SEddie James struct i2c_msg *msg, u32 status)
527504b8277SEddie James {
528504b8277SEddie James int rc;
529504b8277SEddie James u8 fifo_count;
530504b8277SEddie James
531504b8277SEddie James if (status & I2C_STAT_ERR) {
532504b8277SEddie James rc = fsi_i2c_abort(port, status);
533504b8277SEddie James if (rc)
534504b8277SEddie James return rc;
535504b8277SEddie James
536504b8277SEddie James if (status & I2C_STAT_INV_CMD)
537504b8277SEddie James return -EINVAL;
538504b8277SEddie James
539504b8277SEddie James if (status & (I2C_STAT_PARITY | I2C_STAT_BE_OVERRUN |
540504b8277SEddie James I2C_STAT_BE_ACCESS))
541504b8277SEddie James return -EPROTO;
542504b8277SEddie James
543504b8277SEddie James if (status & I2C_STAT_NACK)
544504b8277SEddie James return -ENXIO;
545504b8277SEddie James
546504b8277SEddie James if (status & I2C_STAT_LOST_ARB)
547504b8277SEddie James return -EAGAIN;
548504b8277SEddie James
549504b8277SEddie James if (status & I2C_STAT_STOP_ERR)
550504b8277SEddie James return -EBADMSG;
551504b8277SEddie James
552504b8277SEddie James return -EIO;
553504b8277SEddie James }
554504b8277SEddie James
555504b8277SEddie James if (status & I2C_STAT_DAT_REQ) {
556504b8277SEddie James fifo_count = FIELD_GET(I2C_STAT_FIFO_COUNT, status);
557504b8277SEddie James
558504b8277SEddie James if (msg->flags & I2C_M_RD)
559504b8277SEddie James return fsi_i2c_read_fifo(port, msg, fifo_count);
560504b8277SEddie James
561504b8277SEddie James return fsi_i2c_write_fifo(port, msg, fifo_count);
562504b8277SEddie James }
563504b8277SEddie James
564504b8277SEddie James if (status & I2C_STAT_CMD_COMP) {
565504b8277SEddie James if (port->xfrd < msg->len)
566504b8277SEddie James return -ENODATA;
567504b8277SEddie James
568504b8277SEddie James return msg->len;
569504b8277SEddie James }
570504b8277SEddie James
571504b8277SEddie James return 0;
572504b8277SEddie James }
573504b8277SEddie James
fsi_i2c_wait(struct fsi_i2c_port * port,struct i2c_msg * msg,unsigned long timeout)574504b8277SEddie James static int fsi_i2c_wait(struct fsi_i2c_port *port, struct i2c_msg *msg,
575504b8277SEddie James unsigned long timeout)
576504b8277SEddie James {
577504b8277SEddie James u32 status = 0;
578504b8277SEddie James int rc;
579504b8277SEddie James unsigned long start = jiffies;
580504b8277SEddie James
581504b8277SEddie James do {
582504b8277SEddie James rc = fsi_i2c_read_reg(port->master->fsi, I2C_FSI_STAT,
583504b8277SEddie James &status);
584504b8277SEddie James if (rc)
585504b8277SEddie James return rc;
586504b8277SEddie James
587504b8277SEddie James if (status & I2C_STAT_ANY_RESP) {
588504b8277SEddie James rc = fsi_i2c_handle_status(port, msg, status);
589504b8277SEddie James if (rc < 0)
590504b8277SEddie James return rc;
591504b8277SEddie James
592504b8277SEddie James /* cmd complete and all data xfrd */
593504b8277SEddie James if (rc == msg->len)
594504b8277SEddie James return 0;
595504b8277SEddie James
596504b8277SEddie James /* need to xfr more data, but maybe don't need wait */
597504b8277SEddie James continue;
598504b8277SEddie James }
599504b8277SEddie James
600504b8277SEddie James usleep_range(I2C_CMD_SLEEP_MIN_US, I2C_CMD_SLEEP_MAX_US);
601504b8277SEddie James } while (time_after(start + timeout, jiffies));
602504b8277SEddie James
603504b8277SEddie James return -ETIMEDOUT;
604504b8277SEddie James }
605504b8277SEddie James
fsi_i2c_xfer(struct i2c_adapter * adap,struct i2c_msg * msgs,int num)606d6ffb630SEddie James static int fsi_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
607d6ffb630SEddie James int num)
608d6ffb630SEddie James {
609504b8277SEddie James int i, rc;
610504b8277SEddie James unsigned long start_time;
61119b4887aSEddie James struct fsi_i2c_port *port = adap->algo_data;
612f4cdc319SEddie James struct fsi_i2c_master *master = port->master;
613504b8277SEddie James struct i2c_msg *msg;
61419b4887aSEddie James
615f4cdc319SEddie James mutex_lock(&master->lock);
616f4cdc319SEddie James
61719b4887aSEddie James rc = fsi_i2c_set_port(port);
61819b4887aSEddie James if (rc)
619f4cdc319SEddie James goto unlock;
62019b4887aSEddie James
621504b8277SEddie James for (i = 0; i < num; i++) {
622504b8277SEddie James msg = msgs + i;
623504b8277SEddie James start_time = jiffies;
624504b8277SEddie James
625504b8277SEddie James rc = fsi_i2c_start(port, msg, i == num - 1);
626504b8277SEddie James if (rc)
627f4cdc319SEddie James goto unlock;
628504b8277SEddie James
629504b8277SEddie James rc = fsi_i2c_wait(port, msg,
630504b8277SEddie James adap->timeout - (jiffies - start_time));
631504b8277SEddie James if (rc)
632f4cdc319SEddie James goto unlock;
633504b8277SEddie James }
634504b8277SEddie James
635f4cdc319SEddie James unlock:
636f4cdc319SEddie James mutex_unlock(&master->lock);
637f4cdc319SEddie James return rc ? : num;
638d6ffb630SEddie James }
639d6ffb630SEddie James
fsi_i2c_functionality(struct i2c_adapter * adap)640d6ffb630SEddie James static u32 fsi_i2c_functionality(struct i2c_adapter *adap)
641d6ffb630SEddie James {
642d6ffb630SEddie James return I2C_FUNC_I2C | I2C_FUNC_PROTOCOL_MANGLING |
643d6ffb630SEddie James I2C_FUNC_SMBUS_EMUL | I2C_FUNC_SMBUS_BLOCK_DATA;
644d6ffb630SEddie James }
645d6ffb630SEddie James
646720d5ce9SEddie James static struct i2c_bus_recovery_info fsi_i2c_bus_recovery_info = {
647720d5ce9SEddie James .recover_bus = i2c_generic_scl_recovery,
648720d5ce9SEddie James .get_scl = fsi_i2c_get_scl,
649720d5ce9SEddie James .set_scl = fsi_i2c_set_scl,
650720d5ce9SEddie James .get_sda = fsi_i2c_get_sda,
651720d5ce9SEddie James .set_sda = fsi_i2c_set_sda,
652720d5ce9SEddie James .prepare_recovery = fsi_i2c_prepare_recovery,
653720d5ce9SEddie James .unprepare_recovery = fsi_i2c_unprepare_recovery,
654720d5ce9SEddie James };
655720d5ce9SEddie James
656d6ffb630SEddie James static const struct i2c_algorithm fsi_i2c_algorithm = {
657d6ffb630SEddie James .master_xfer = fsi_i2c_xfer,
658d6ffb630SEddie James .functionality = fsi_i2c_functionality,
659d6ffb630SEddie James };
660d6ffb630SEddie James
fsi_i2c_find_port_of_node(struct device_node * fsi,int port)661095561f4SOliver O'Halloran static struct device_node *fsi_i2c_find_port_of_node(struct device_node *fsi,
662095561f4SOliver O'Halloran int port)
663095561f4SOliver O'Halloran {
664095561f4SOliver O'Halloran struct device_node *np;
665095561f4SOliver O'Halloran u32 port_no;
666095561f4SOliver O'Halloran int rc;
667095561f4SOliver O'Halloran
668095561f4SOliver O'Halloran for_each_child_of_node(fsi, np) {
669095561f4SOliver O'Halloran rc = of_property_read_u32(np, "reg", &port_no);
670095561f4SOliver O'Halloran if (!rc && port_no == port)
671095561f4SOliver O'Halloran return np;
672095561f4SOliver O'Halloran }
673095561f4SOliver O'Halloran
674095561f4SOliver O'Halloran return NULL;
675095561f4SOliver O'Halloran }
676095561f4SOliver O'Halloran
fsi_i2c_probe(struct device * dev)677d6ffb630SEddie James static int fsi_i2c_probe(struct device *dev)
678d6ffb630SEddie James {
679d6ffb630SEddie James struct fsi_i2c_master *i2c;
68019b4887aSEddie James struct fsi_i2c_port *port;
68119b4887aSEddie James struct device_node *np;
682095561f4SOliver O'Halloran u32 port_no, ports, stat;
683d6ffb630SEddie James int rc;
684d6ffb630SEddie James
685d6ffb630SEddie James i2c = devm_kzalloc(dev, sizeof(*i2c), GFP_KERNEL);
686d6ffb630SEddie James if (!i2c)
687d6ffb630SEddie James return -ENOMEM;
688d6ffb630SEddie James
689f4cdc319SEddie James mutex_init(&i2c->lock);
690d6ffb630SEddie James i2c->fsi = to_fsi_dev(dev);
69119b4887aSEddie James INIT_LIST_HEAD(&i2c->ports);
692d6ffb630SEddie James
693d6ffb630SEddie James rc = fsi_i2c_dev_init(i2c);
694d6ffb630SEddie James if (rc)
695d6ffb630SEddie James return rc;
696d6ffb630SEddie James
697095561f4SOliver O'Halloran rc = fsi_i2c_read_reg(i2c->fsi, I2C_FSI_STAT, &stat);
698095561f4SOliver O'Halloran if (rc)
699095561f4SOliver O'Halloran return rc;
700095561f4SOliver O'Halloran
701095561f4SOliver O'Halloran ports = FIELD_GET(I2C_STAT_MAX_PORT, stat) + 1;
702095561f4SOliver O'Halloran dev_dbg(dev, "I2C master has %d ports\n", ports);
703095561f4SOliver O'Halloran
704095561f4SOliver O'Halloran for (port_no = 0; port_no < ports; port_no++) {
705095561f4SOliver O'Halloran np = fsi_i2c_find_port_of_node(dev->of_node, port_no);
706*58031a26SEddie James if (!of_device_is_available(np))
70719b4887aSEddie James continue;
70819b4887aSEddie James
70919b4887aSEddie James port = kzalloc(sizeof(*port), GFP_KERNEL);
7100a321b97SNishka Dasgupta if (!port) {
7110a321b97SNishka Dasgupta of_node_put(np);
71219b4887aSEddie James break;
7130a321b97SNishka Dasgupta }
71419b4887aSEddie James
71519b4887aSEddie James port->master = i2c;
71619b4887aSEddie James port->port = port_no;
71719b4887aSEddie James
71819b4887aSEddie James port->adapter.owner = THIS_MODULE;
71919b4887aSEddie James port->adapter.dev.of_node = np;
72019b4887aSEddie James port->adapter.dev.parent = dev;
72119b4887aSEddie James port->adapter.algo = &fsi_i2c_algorithm;
722720d5ce9SEddie James port->adapter.bus_recovery_info = &fsi_i2c_bus_recovery_info;
72319b4887aSEddie James port->adapter.algo_data = port;
72419b4887aSEddie James
72519b4887aSEddie James snprintf(port->adapter.name, sizeof(port->adapter.name),
72619b4887aSEddie James "i2c_bus-%u", port_no);
72719b4887aSEddie James
72819b4887aSEddie James rc = i2c_add_adapter(&port->adapter);
72919b4887aSEddie James if (rc < 0) {
73019b4887aSEddie James dev_err(dev, "Failed to register adapter: %d\n", rc);
73119b4887aSEddie James kfree(port);
73219b4887aSEddie James continue;
73319b4887aSEddie James }
73419b4887aSEddie James
73519b4887aSEddie James list_add(&port->list, &i2c->ports);
73619b4887aSEddie James }
73719b4887aSEddie James
738d6ffb630SEddie James dev_set_drvdata(dev, i2c);
739d6ffb630SEddie James
740d6ffb630SEddie James return 0;
741d6ffb630SEddie James }
742d6ffb630SEddie James
fsi_i2c_remove(struct device * dev)74319b4887aSEddie James static int fsi_i2c_remove(struct device *dev)
74419b4887aSEddie James {
74519b4887aSEddie James struct fsi_i2c_master *i2c = dev_get_drvdata(dev);
74619b4887aSEddie James struct fsi_i2c_port *port, *tmp;
74719b4887aSEddie James
74819b4887aSEddie James list_for_each_entry_safe(port, tmp, &i2c->ports, list) {
74919b4887aSEddie James list_del(&port->list);
75019b4887aSEddie James i2c_del_adapter(&port->adapter);
75119b4887aSEddie James kfree(port);
75219b4887aSEddie James }
75319b4887aSEddie James
75419b4887aSEddie James return 0;
75519b4887aSEddie James }
75619b4887aSEddie James
757d6ffb630SEddie James static const struct fsi_device_id fsi_i2c_ids[] = {
758d6ffb630SEddie James { FSI_ENGID_I2C, FSI_VERSION_ANY },
759d6ffb630SEddie James { }
760d6ffb630SEddie James };
761d6ffb630SEddie James
762d6ffb630SEddie James static struct fsi_driver fsi_i2c_driver = {
763d6ffb630SEddie James .id_table = fsi_i2c_ids,
764d6ffb630SEddie James .drv = {
765d6ffb630SEddie James .name = "i2c-fsi",
766d6ffb630SEddie James .bus = &fsi_bus_type,
767d6ffb630SEddie James .probe = fsi_i2c_probe,
76819b4887aSEddie James .remove = fsi_i2c_remove,
769d6ffb630SEddie James },
770d6ffb630SEddie James };
771d6ffb630SEddie James
772d6ffb630SEddie James module_fsi_driver(fsi_i2c_driver);
773d6ffb630SEddie James
774d6ffb630SEddie James MODULE_AUTHOR("Eddie James <eajames@us.ibm.com>");
775d6ffb630SEddie James MODULE_DESCRIPTION("FSI attached I2C master");
776d6ffb630SEddie James MODULE_LICENSE("GPL");
777