Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * i2c-xiic.c
4 * Copyright (c) 2002-2007 Xilinx Inc.
5 * Copyright (c) 2009-2010 Intel Corporation
6 *
7 * This code was implemented by Mocean Laboratories AB when porting linux
8 * to the automotive development board Russellville. The copyright holder
9 * as seen in the header is Intel corporation.
10 * Mocean Laboratories forked off the GNU/Linux platform work into a
11 * separate company called Pelagicore AB, which committed the code to the
12 * kernel.
13 */
14
15/* Supports:
16 * Xilinx IIC
17 */
18#include <linux/kernel.h>
19#include <linux/module.h>
20#include <linux/errno.h>
21#include <linux/err.h>
22#include <linux/delay.h>
23#include <linux/platform_device.h>
24#include <linux/i2c.h>
25#include <linux/interrupt.h>
26#include <linux/completion.h>
27#include <linux/platform_data/i2c-xiic.h>
28#include <linux/io.h>
29#include <linux/slab.h>
30#include <linux/of.h>
31#include <linux/clk.h>
32#include <linux/pm_runtime.h>
33
34#define DRIVER_NAME "xiic-i2c"
35#define DYNAMIC_MODE_READ_BROKEN_BIT BIT(0)
36#define SMBUS_BLOCK_READ_MIN_LEN 3
37
38enum xilinx_i2c_state {
39 STATE_DONE,
40 STATE_ERROR,
41 STATE_START
42};
43
44enum xiic_endian {
45 LITTLE,
46 BIG
47};
48
49enum i2c_scl_freq {
50 REG_VALUES_100KHZ = 0,
51 REG_VALUES_400KHZ = 1,
52 REG_VALUES_1MHZ = 2
53};
54
55/**
56 * struct xiic_i2c - Internal representation of the XIIC I2C bus
57 * @dev: Pointer to device structure
58 * @base: Memory base of the HW registers
59 * @completion: Completion for callers
60 * @adap: Kernel adapter representation
61 * @tx_msg: Messages from above to be sent
62 * @lock: Mutual exclusion
63 * @tx_pos: Current pos in TX message
64 * @nmsgs: Number of messages in tx_msg
65 * @rx_msg: Current RX message
66 * @rx_pos: Position within current RX message
67 * @endianness: big/little-endian byte order
68 * @clk: Pointer to AXI4-lite input clock
69 * @state: See STATE_
70 * @singlemaster: Indicates bus is single master
71 * @dynamic: Mode of controller
72 * @prev_msg_tx: Previous message is Tx
73 * @quirks: To hold platform specific bug info
74 * @smbus_block_read: Flag to handle block read
75 * @input_clk: Input clock to I2C controller
76 * @i2c_clk: I2C SCL frequency
77 */
78struct xiic_i2c {
79 struct device *dev;
80 void __iomem *base;
81 struct completion completion;
82 struct i2c_adapter adap;
83 struct i2c_msg *tx_msg;
84 struct mutex lock;
85 unsigned int tx_pos;
86 unsigned int nmsgs;
87 struct i2c_msg *rx_msg;
88 int rx_pos;
89 enum xiic_endian endianness;
90 struct clk *clk;
91 enum xilinx_i2c_state state;
92 bool singlemaster;
93 bool dynamic;
94 bool prev_msg_tx;
95 u32 quirks;
96 bool smbus_block_read;
97 unsigned long input_clk;
98 unsigned int i2c_clk;
99};
100
101struct xiic_version_data {
102 u32 quirks;
103};
104
105/**
106 * struct timing_regs - AXI I2C timing registers that depend on I2C spec
107 * @tsusta: setup time for a repeated START condition
108 * @tsusto: setup time for a STOP condition
109 * @thdsta: hold time for a repeated START condition
110 * @tsudat: setup time for data
111 * @tbuf: bus free time between STOP and START
112 */
113struct timing_regs {
114 unsigned int tsusta;
115 unsigned int tsusto;
116 unsigned int thdsta;
117 unsigned int tsudat;
118 unsigned int tbuf;
119};
120
121/* Reg values in ns derived from I2C spec and AXI I2C PG for different frequencies */
122static const struct timing_regs timing_reg_values[] = {
123 { 5700, 5000, 4300, 550, 5000 }, /* Reg values for 100KHz */
124 { 900, 900, 900, 400, 1600 }, /* Reg values for 400KHz */
125 { 380, 380, 380, 170, 620 }, /* Reg values for 1MHz */
126};
127
128#define XIIC_MSB_OFFSET 0
129#define XIIC_REG_OFFSET (0x100 + XIIC_MSB_OFFSET)
130
131/*
132 * Register offsets in bytes from RegisterBase. Three is added to the
133 * base offset to access LSB (IBM style) of the word
134 */
135#define XIIC_CR_REG_OFFSET (0x00 + XIIC_REG_OFFSET) /* Control Register */
136#define XIIC_SR_REG_OFFSET (0x04 + XIIC_REG_OFFSET) /* Status Register */
137#define XIIC_DTR_REG_OFFSET (0x08 + XIIC_REG_OFFSET) /* Data Tx Register */
138#define XIIC_DRR_REG_OFFSET (0x0C + XIIC_REG_OFFSET) /* Data Rx Register */
139#define XIIC_ADR_REG_OFFSET (0x10 + XIIC_REG_OFFSET) /* Address Register */
140#define XIIC_TFO_REG_OFFSET (0x14 + XIIC_REG_OFFSET) /* Tx FIFO Occupancy */
141#define XIIC_RFO_REG_OFFSET (0x18 + XIIC_REG_OFFSET) /* Rx FIFO Occupancy */
142#define XIIC_TBA_REG_OFFSET (0x1C + XIIC_REG_OFFSET) /* 10 Bit Address reg */
143#define XIIC_RFD_REG_OFFSET (0x20 + XIIC_REG_OFFSET) /* Rx FIFO Depth reg */
144#define XIIC_GPO_REG_OFFSET (0x24 + XIIC_REG_OFFSET) /* Output Register */
145
146/*
147 * Timing register offsets from RegisterBase. These are used only for
148 * setting i2c clock frequency for the line.
149 */
150#define XIIC_TSUSTA_REG_OFFSET (0x28 + XIIC_REG_OFFSET) /* TSUSTA Register */
151#define XIIC_TSUSTO_REG_OFFSET (0x2C + XIIC_REG_OFFSET) /* TSUSTO Register */
152#define XIIC_THDSTA_REG_OFFSET (0x30 + XIIC_REG_OFFSET) /* THDSTA Register */
153#define XIIC_TSUDAT_REG_OFFSET (0x34 + XIIC_REG_OFFSET) /* TSUDAT Register */
154#define XIIC_TBUF_REG_OFFSET (0x38 + XIIC_REG_OFFSET) /* TBUF Register */
155#define XIIC_THIGH_REG_OFFSET (0x3C + XIIC_REG_OFFSET) /* THIGH Register */
156#define XIIC_TLOW_REG_OFFSET (0x40 + XIIC_REG_OFFSET) /* TLOW Register */
157#define XIIC_THDDAT_REG_OFFSET (0x44 + XIIC_REG_OFFSET) /* THDDAT Register */
158
159/* Control Register masks */
160#define XIIC_CR_ENABLE_DEVICE_MASK 0x01 /* Device enable = 1 */
161#define XIIC_CR_TX_FIFO_RESET_MASK 0x02 /* Transmit FIFO reset=1 */
162#define XIIC_CR_MSMS_MASK 0x04 /* Master starts Txing=1 */
163#define XIIC_CR_DIR_IS_TX_MASK 0x08 /* Dir of tx. Txing=1 */
164#define XIIC_CR_NO_ACK_MASK 0x10 /* Tx Ack. NO ack = 1 */
165#define XIIC_CR_REPEATED_START_MASK 0x20 /* Repeated start = 1 */
166#define XIIC_CR_GENERAL_CALL_MASK 0x40 /* Gen Call enabled = 1 */
167
168/* Status Register masks */
169#define XIIC_SR_GEN_CALL_MASK 0x01 /* 1=a mstr issued a GC */
170#define XIIC_SR_ADDR_AS_SLAVE_MASK 0x02 /* 1=when addr as slave */
171#define XIIC_SR_BUS_BUSY_MASK 0x04 /* 1 = bus is busy */
172#define XIIC_SR_MSTR_RDING_SLAVE_MASK 0x08 /* 1=Dir: mstr <-- slave */
173#define XIIC_SR_TX_FIFO_FULL_MASK 0x10 /* 1 = Tx FIFO full */
174#define XIIC_SR_RX_FIFO_FULL_MASK 0x20 /* 1 = Rx FIFO full */
175#define XIIC_SR_RX_FIFO_EMPTY_MASK 0x40 /* 1 = Rx FIFO empty */
176#define XIIC_SR_TX_FIFO_EMPTY_MASK 0x80 /* 1 = Tx FIFO empty */
177
178/* Interrupt Status Register masks Interrupt occurs when... */
179#define XIIC_INTR_ARB_LOST_MASK 0x01 /* 1 = arbitration lost */
180#define XIIC_INTR_TX_ERROR_MASK 0x02 /* 1=Tx error/msg complete */
181#define XIIC_INTR_TX_EMPTY_MASK 0x04 /* 1 = Tx FIFO/reg empty */
182#define XIIC_INTR_RX_FULL_MASK 0x08 /* 1=Rx FIFO/reg=OCY level */
183#define XIIC_INTR_BNB_MASK 0x10 /* 1 = Bus not busy */
184#define XIIC_INTR_AAS_MASK 0x20 /* 1 = when addr as slave */
185#define XIIC_INTR_NAAS_MASK 0x40 /* 1 = not addr as slave */
186#define XIIC_INTR_TX_HALF_MASK 0x80 /* 1 = TX FIFO half empty */
187
188/* The following constants specify the depth of the FIFOs */
189#define IIC_RX_FIFO_DEPTH 16 /* Rx fifo capacity */
190#define IIC_TX_FIFO_DEPTH 16 /* Tx fifo capacity */
191
192/* The following constants specify groups of interrupts that are typically
193 * enabled or disables at the same time
194 */
195#define XIIC_TX_INTERRUPTS \
196(XIIC_INTR_TX_ERROR_MASK | XIIC_INTR_TX_EMPTY_MASK | XIIC_INTR_TX_HALF_MASK)
197
198#define XIIC_TX_RX_INTERRUPTS (XIIC_INTR_RX_FULL_MASK | XIIC_TX_INTERRUPTS)
199
200/*
201 * Tx Fifo upper bit masks.
202 */
203#define XIIC_TX_DYN_START_MASK 0x0100 /* 1 = Set dynamic start */
204#define XIIC_TX_DYN_STOP_MASK 0x0200 /* 1 = Set dynamic stop */
205
206/* Dynamic mode constants */
207#define MAX_READ_LENGTH_DYNAMIC 255 /* Max length for dynamic read */
208
209/*
210 * The following constants define the register offsets for the Interrupt
211 * registers. There are some holes in the memory map for reserved addresses
212 * to allow other registers to be added and still match the memory map of the
213 * interrupt controller registers
214 */
215#define XIIC_DGIER_OFFSET 0x1C /* Device Global Interrupt Enable Register */
216#define XIIC_IISR_OFFSET 0x20 /* Interrupt Status Register */
217#define XIIC_IIER_OFFSET 0x28 /* Interrupt Enable Register */
218#define XIIC_RESETR_OFFSET 0x40 /* Reset Register */
219
220#define XIIC_RESET_MASK 0xAUL
221
222#define XIIC_PM_TIMEOUT 1000 /* ms */
223/* timeout waiting for the controller to respond */
224#define XIIC_I2C_TIMEOUT (msecs_to_jiffies(1000))
225/* timeout waiting for the controller finish transfers */
226#define XIIC_XFER_TIMEOUT (msecs_to_jiffies(10000))
227
228/*
229 * The following constant is used for the device global interrupt enable
230 * register, to enable all interrupts for the device, this is the only bit
231 * in the register
232 */
233#define XIIC_GINTR_ENABLE_MASK 0x80000000UL
234
235#define xiic_tx_space(i2c) ((i2c)->tx_msg->len - (i2c)->tx_pos)
236#define xiic_rx_space(i2c) ((i2c)->rx_msg->len - (i2c)->rx_pos)
237
238static int xiic_start_xfer(struct xiic_i2c *i2c, struct i2c_msg *msgs, int num);
239static void __xiic_start_xfer(struct xiic_i2c *i2c);
240
241/*
242 * For the register read and write functions, a little-endian and big-endian
243 * version are necessary. Endianness is detected during the probe function.
244 * Only the least significant byte [doublet] of the register are ever
245 * accessed. This requires an offset of 3 [2] from the base address for
246 * big-endian systems.
247 */
248
249static inline void xiic_setreg8(struct xiic_i2c *i2c, int reg, u8 value)
250{
251 if (i2c->endianness == LITTLE)
252 iowrite8(value, i2c->base + reg);
253 else
254 iowrite8(value, i2c->base + reg + 3);
255}
256
257static inline u8 xiic_getreg8(struct xiic_i2c *i2c, int reg)
258{
259 u8 ret;
260
261 if (i2c->endianness == LITTLE)
262 ret = ioread8(i2c->base + reg);
263 else
264 ret = ioread8(i2c->base + reg + 3);
265 return ret;
266}
267
268static inline void xiic_setreg16(struct xiic_i2c *i2c, int reg, u16 value)
269{
270 if (i2c->endianness == LITTLE)
271 iowrite16(value, i2c->base + reg);
272 else
273 iowrite16be(value, i2c->base + reg + 2);
274}
275
276static inline void xiic_setreg32(struct xiic_i2c *i2c, int reg, int value)
277{
278 if (i2c->endianness == LITTLE)
279 iowrite32(value, i2c->base + reg);
280 else
281 iowrite32be(value, i2c->base + reg);
282}
283
284static inline int xiic_getreg32(struct xiic_i2c *i2c, int reg)
285{
286 u32 ret;
287
288 if (i2c->endianness == LITTLE)
289 ret = ioread32(i2c->base + reg);
290 else
291 ret = ioread32be(i2c->base + reg);
292 return ret;
293}
294
295static inline void xiic_irq_dis(struct xiic_i2c *i2c, u32 mask)
296{
297 u32 ier = xiic_getreg32(i2c, XIIC_IIER_OFFSET);
298
299 xiic_setreg32(i2c, XIIC_IIER_OFFSET, ier & ~mask);
300}
301
302static inline void xiic_irq_en(struct xiic_i2c *i2c, u32 mask)
303{
304 u32 ier = xiic_getreg32(i2c, XIIC_IIER_OFFSET);
305
306 xiic_setreg32(i2c, XIIC_IIER_OFFSET, ier | mask);
307}
308
309static inline void xiic_irq_clr(struct xiic_i2c *i2c, u32 mask)
310{
311 u32 isr = xiic_getreg32(i2c, XIIC_IISR_OFFSET);
312
313 xiic_setreg32(i2c, XIIC_IISR_OFFSET, isr & mask);
314}
315
316static inline void xiic_irq_clr_en(struct xiic_i2c *i2c, u32 mask)
317{
318 xiic_irq_clr(i2c, mask);
319 xiic_irq_en(i2c, mask);
320}
321
322static int xiic_clear_rx_fifo(struct xiic_i2c *i2c)
323{
324 u8 sr;
325 unsigned long timeout;
326
327 timeout = jiffies + XIIC_I2C_TIMEOUT;
328 for (sr = xiic_getreg8(i2c, XIIC_SR_REG_OFFSET);
329 !(sr & XIIC_SR_RX_FIFO_EMPTY_MASK);
330 sr = xiic_getreg8(i2c, XIIC_SR_REG_OFFSET)) {
331 xiic_getreg8(i2c, XIIC_DRR_REG_OFFSET);
332 if (time_after(jiffies, timeout)) {
333 dev_err(i2c->dev, "Failed to clear rx fifo\n");
334 return -ETIMEDOUT;
335 }
336 }
337
338 return 0;
339}
340
341static int xiic_wait_tx_empty(struct xiic_i2c *i2c)
342{
343 u8 isr;
344 unsigned long timeout;
345
346 timeout = jiffies + XIIC_I2C_TIMEOUT;
347 for (isr = xiic_getreg32(i2c, XIIC_IISR_OFFSET);
348 !(isr & XIIC_INTR_TX_EMPTY_MASK);
349 isr = xiic_getreg32(i2c, XIIC_IISR_OFFSET)) {
350 if (time_after(jiffies, timeout)) {
351 dev_err(i2c->dev, "Timeout waiting at Tx empty\n");
352 return -ETIMEDOUT;
353 }
354 }
355
356 return 0;
357}
358
359/**
360 * xiic_setclk - Sets the configured clock rate
361 * @i2c: Pointer to the xiic device structure
362 *
363 * The timing register values are calculated according to the input clock
364 * frequency and configured scl frequency. For details, please refer the
365 * AXI I2C PG and NXP I2C Spec.
366 * Supported frequencies are 100KHz, 400KHz and 1MHz.
367 *
368 * Return: 0 on success (Supported frequency selected or not configurable in SW)
369 * -EINVAL on failure (scl frequency not supported or THIGH is 0)
370 */
371static int xiic_setclk(struct xiic_i2c *i2c)
372{
373 unsigned int clk_in_mhz;
374 unsigned int index = 0;
375 u32 reg_val;
376
377 dev_dbg(i2c->adap.dev.parent,
378 "%s entry, i2c->input_clk: %ld, i2c->i2c_clk: %d\n",
379 __func__, i2c->input_clk, i2c->i2c_clk);
380
381 /* If not specified in DT, do not configure in SW. Rely only on Vivado design */
382 if (!i2c->i2c_clk || !i2c->input_clk)
383 return 0;
384
385 clk_in_mhz = DIV_ROUND_UP(i2c->input_clk, 1000000);
386
387 switch (i2c->i2c_clk) {
388 case I2C_MAX_FAST_MODE_PLUS_FREQ:
389 index = REG_VALUES_1MHZ;
390 break;
391 case I2C_MAX_FAST_MODE_FREQ:
392 index = REG_VALUES_400KHZ;
393 break;
394 case I2C_MAX_STANDARD_MODE_FREQ:
395 index = REG_VALUES_100KHZ;
396 break;
397 default:
398 dev_warn(i2c->adap.dev.parent, "Unsupported scl frequency\n");
399 return -EINVAL;
400 }
401
402 /*
403 * Value to be stored in a register is the number of clock cycles required
404 * for the time duration. So the time is divided by the input clock time
405 * period to get the number of clock cycles required. Refer Xilinx AXI I2C
406 * PG document and I2C specification for further details.
407 */
408
409 /* THIGH - Depends on SCL clock frequency(i2c_clk) as below */
410 reg_val = (DIV_ROUND_UP(i2c->input_clk, 2 * i2c->i2c_clk)) - 7;
411 if (reg_val == 0)
412 return -EINVAL;
413
414 xiic_setreg32(i2c, XIIC_THIGH_REG_OFFSET, reg_val - 1);
415
416 /* TLOW - Value same as THIGH */
417 xiic_setreg32(i2c, XIIC_TLOW_REG_OFFSET, reg_val - 1);
418
419 /* TSUSTA */
420 reg_val = (timing_reg_values[index].tsusta * clk_in_mhz) / 1000;
421 xiic_setreg32(i2c, XIIC_TSUSTA_REG_OFFSET, reg_val - 1);
422
423 /* TSUSTO */
424 reg_val = (timing_reg_values[index].tsusto * clk_in_mhz) / 1000;
425 xiic_setreg32(i2c, XIIC_TSUSTO_REG_OFFSET, reg_val - 1);
426
427 /* THDSTA */
428 reg_val = (timing_reg_values[index].thdsta * clk_in_mhz) / 1000;
429 xiic_setreg32(i2c, XIIC_THDSTA_REG_OFFSET, reg_val - 1);
430
431 /* TSUDAT */
432 reg_val = (timing_reg_values[index].tsudat * clk_in_mhz) / 1000;
433 xiic_setreg32(i2c, XIIC_TSUDAT_REG_OFFSET, reg_val - 1);
434
435 /* TBUF */
436 reg_val = (timing_reg_values[index].tbuf * clk_in_mhz) / 1000;
437 xiic_setreg32(i2c, XIIC_TBUF_REG_OFFSET, reg_val - 1);
438
439 /* THDDAT */
440 xiic_setreg32(i2c, XIIC_THDDAT_REG_OFFSET, 1);
441
442 return 0;
443}
444
445static int xiic_reinit(struct xiic_i2c *i2c)
446{
447 int ret;
448
449 xiic_setreg32(i2c, XIIC_RESETR_OFFSET, XIIC_RESET_MASK);
450
451 ret = xiic_setclk(i2c);
452 if (ret)
453 return ret;
454
455 /* Set receive Fifo depth to maximum (zero based). */
456 xiic_setreg8(i2c, XIIC_RFD_REG_OFFSET, IIC_RX_FIFO_DEPTH - 1);
457
458 /* Reset Tx Fifo. */
459 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, XIIC_CR_TX_FIFO_RESET_MASK);
460
461 /* Enable IIC Device, remove Tx Fifo reset & disable general call. */
462 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, XIIC_CR_ENABLE_DEVICE_MASK);
463
464 /* make sure RX fifo is empty */
465 ret = xiic_clear_rx_fifo(i2c);
466 if (ret)
467 return ret;
468
469 /* Enable interrupts */
470 xiic_setreg32(i2c, XIIC_DGIER_OFFSET, XIIC_GINTR_ENABLE_MASK);
471
472 xiic_irq_clr_en(i2c, XIIC_INTR_ARB_LOST_MASK);
473
474 return 0;
475}
476
477static void xiic_deinit(struct xiic_i2c *i2c)
478{
479 u8 cr;
480
481 xiic_setreg32(i2c, XIIC_RESETR_OFFSET, XIIC_RESET_MASK);
482
483 /* Disable IIC Device. */
484 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
485 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, cr & ~XIIC_CR_ENABLE_DEVICE_MASK);
486}
487
488static void xiic_smbus_block_read_setup(struct xiic_i2c *i2c)
489{
490 u8 rxmsg_len, rfd_set = 0;
491
492 /*
493 * Clear the I2C_M_RECV_LEN flag to avoid setting
494 * message length again
495 */
496 i2c->rx_msg->flags &= ~I2C_M_RECV_LEN;
497
498 /* Set smbus_block_read flag to identify in isr */
499 i2c->smbus_block_read = true;
500
501 /* Read byte from rx fifo and set message length */
502 rxmsg_len = xiic_getreg8(i2c, XIIC_DRR_REG_OFFSET);
503
504 i2c->rx_msg->buf[i2c->rx_pos++] = rxmsg_len;
505
506 /* Check if received length is valid */
507 if (rxmsg_len <= I2C_SMBUS_BLOCK_MAX) {
508 /* Set Receive fifo depth */
509 if (rxmsg_len > IIC_RX_FIFO_DEPTH) {
510 /*
511 * When Rx msg len greater than or equal to Rx fifo capacity
512 * Receive fifo depth should set to Rx fifo capacity minus 1
513 */
514 rfd_set = IIC_RX_FIFO_DEPTH - 1;
515 i2c->rx_msg->len = rxmsg_len + 1;
516 } else if ((rxmsg_len == 1) ||
517 (rxmsg_len == 0)) {
518 /*
519 * Minimum of 3 bytes required to exit cleanly. 1 byte
520 * already received, Second byte is being received. Have
521 * to set NACK in read_rx before receiving the last byte
522 */
523 rfd_set = 0;
524 i2c->rx_msg->len = SMBUS_BLOCK_READ_MIN_LEN;
525 } else {
526 /*
527 * When Rx msg len less than Rx fifo capacity
528 * Receive fifo depth should set to Rx msg len minus 2
529 */
530 rfd_set = rxmsg_len - 2;
531 i2c->rx_msg->len = rxmsg_len + 1;
532 }
533 xiic_setreg8(i2c, XIIC_RFD_REG_OFFSET, rfd_set);
534
535 return;
536 }
537
538 /* Invalid message length, trigger STATE_ERROR with tx_msg_len in ISR */
539 i2c->tx_msg->len = 3;
540 i2c->smbus_block_read = false;
541 dev_err(i2c->adap.dev.parent, "smbus_block_read Invalid msg length\n");
542}
543
544static void xiic_read_rx(struct xiic_i2c *i2c)
545{
546 u8 bytes_in_fifo, cr = 0, bytes_to_read = 0;
547 u32 bytes_rem = 0;
548 int i;
549
550 bytes_in_fifo = xiic_getreg8(i2c, XIIC_RFO_REG_OFFSET) + 1;
551
552 dev_dbg(i2c->adap.dev.parent,
553 "%s entry, bytes in fifo: %d, rem: %d, SR: 0x%x, CR: 0x%x\n",
554 __func__, bytes_in_fifo, xiic_rx_space(i2c),
555 xiic_getreg8(i2c, XIIC_SR_REG_OFFSET),
556 xiic_getreg8(i2c, XIIC_CR_REG_OFFSET));
557
558 if (bytes_in_fifo > xiic_rx_space(i2c))
559 bytes_in_fifo = xiic_rx_space(i2c);
560
561 bytes_to_read = bytes_in_fifo;
562
563 if (!i2c->dynamic) {
564 bytes_rem = xiic_rx_space(i2c) - bytes_in_fifo;
565
566 /* Set msg length if smbus_block_read */
567 if (i2c->rx_msg->flags & I2C_M_RECV_LEN) {
568 xiic_smbus_block_read_setup(i2c);
569 return;
570 }
571
572 if (bytes_rem > IIC_RX_FIFO_DEPTH) {
573 bytes_to_read = bytes_in_fifo;
574 } else if (bytes_rem > 1) {
575 bytes_to_read = bytes_rem - 1;
576 } else if (bytes_rem == 1) {
577 bytes_to_read = 1;
578 /* Set NACK in CR to indicate slave transmitter */
579 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
580 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, cr |
581 XIIC_CR_NO_ACK_MASK);
582 } else if (bytes_rem == 0) {
583 bytes_to_read = bytes_in_fifo;
584
585 /* Generate stop on the bus if it is last message */
586 if (i2c->nmsgs == 1) {
587 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
588 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, cr &
589 ~XIIC_CR_MSMS_MASK);
590 }
591
592 /* Make TXACK=0, clean up for next transaction */
593 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
594 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, cr &
595 ~XIIC_CR_NO_ACK_MASK);
596 }
597 }
598
599 /* Read the fifo */
600 for (i = 0; i < bytes_to_read; i++) {
601 i2c->rx_msg->buf[i2c->rx_pos++] =
602 xiic_getreg8(i2c, XIIC_DRR_REG_OFFSET);
603 }
604
605 if (i2c->dynamic) {
606 u8 bytes;
607
608 /* Receive remaining bytes if less than fifo depth */
609 bytes = min_t(u8, xiic_rx_space(i2c), IIC_RX_FIFO_DEPTH);
610 bytes--;
611 xiic_setreg8(i2c, XIIC_RFD_REG_OFFSET, bytes);
612 }
613}
614
615static int xiic_tx_fifo_space(struct xiic_i2c *i2c)
616{
617 /* return the actual space left in the FIFO */
618 return IIC_TX_FIFO_DEPTH - xiic_getreg8(i2c, XIIC_TFO_REG_OFFSET) - 1;
619}
620
621static void xiic_fill_tx_fifo(struct xiic_i2c *i2c)
622{
623 u8 fifo_space = xiic_tx_fifo_space(i2c);
624 int len = xiic_tx_space(i2c);
625
626 len = (len > fifo_space) ? fifo_space : len;
627
628 dev_dbg(i2c->adap.dev.parent, "%s entry, len: %d, fifo space: %d\n",
629 __func__, len, fifo_space);
630
631 while (len--) {
632 u16 data = i2c->tx_msg->buf[i2c->tx_pos++];
633
634 if (!xiic_tx_space(i2c) && i2c->nmsgs == 1) {
635 /* last message in transfer -> STOP */
636 if (i2c->dynamic) {
637 data |= XIIC_TX_DYN_STOP_MASK;
638 } else {
639 u8 cr;
640 int status;
641
642 /* Wait till FIFO is empty so STOP is sent last */
643 status = xiic_wait_tx_empty(i2c);
644 if (status)
645 return;
646
647 /* Write to CR to stop */
648 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
649 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, cr &
650 ~XIIC_CR_MSMS_MASK);
651 }
652 dev_dbg(i2c->adap.dev.parent, "%s TX STOP\n", __func__);
653 }
654 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET, data);
655 }
656}
657
658static void xiic_wakeup(struct xiic_i2c *i2c, enum xilinx_i2c_state code)
659{
660 i2c->tx_msg = NULL;
661 i2c->rx_msg = NULL;
662 i2c->nmsgs = 0;
663 i2c->state = code;
664 complete(&i2c->completion);
665}
666
667static irqreturn_t xiic_process(int irq, void *dev_id)
668{
669 struct xiic_i2c *i2c = dev_id;
670 u32 pend, isr, ier;
671 u32 clr = 0;
672 int xfer_more = 0;
673 int wakeup_req = 0;
674 enum xilinx_i2c_state wakeup_code = STATE_DONE;
675 int ret;
676
677 /* Get the interrupt Status from the IPIF. There is no clearing of
678 * interrupts in the IPIF. Interrupts must be cleared at the source.
679 * To find which interrupts are pending; AND interrupts pending with
680 * interrupts masked.
681 */
682 mutex_lock(&i2c->lock);
683 isr = xiic_getreg32(i2c, XIIC_IISR_OFFSET);
684 ier = xiic_getreg32(i2c, XIIC_IIER_OFFSET);
685 pend = isr & ier;
686
687 dev_dbg(i2c->adap.dev.parent, "%s: IER: 0x%x, ISR: 0x%x, pend: 0x%x\n",
688 __func__, ier, isr, pend);
689 dev_dbg(i2c->adap.dev.parent, "%s: SR: 0x%x, msg: %p, nmsgs: %d\n",
690 __func__, xiic_getreg8(i2c, XIIC_SR_REG_OFFSET),
691 i2c->tx_msg, i2c->nmsgs);
692 dev_dbg(i2c->adap.dev.parent, "%s, ISR: 0x%x, CR: 0x%x\n",
693 __func__, xiic_getreg32(i2c, XIIC_IISR_OFFSET),
694 xiic_getreg8(i2c, XIIC_CR_REG_OFFSET));
695
696 /* Service requesting interrupt */
697 if ((pend & XIIC_INTR_ARB_LOST_MASK) ||
698 ((pend & XIIC_INTR_TX_ERROR_MASK) &&
699 !(pend & XIIC_INTR_RX_FULL_MASK))) {
700 /* bus arbritration lost, or...
701 * Transmit error _OR_ RX completed
702 * if this happens when RX_FULL is not set
703 * this is probably a TX error
704 */
705
706 dev_dbg(i2c->adap.dev.parent, "%s error\n", __func__);
707
708 /* dynamic mode seem to suffer from problems if we just flushes
709 * fifos and the next message is a TX with len 0 (only addr)
710 * reset the IP instead of just flush fifos
711 */
712 ret = xiic_reinit(i2c);
713 if (ret < 0)
714 dev_dbg(i2c->adap.dev.parent, "reinit failed\n");
715
716 if (i2c->rx_msg) {
717 wakeup_req = 1;
718 wakeup_code = STATE_ERROR;
719 }
720 if (i2c->tx_msg) {
721 wakeup_req = 1;
722 wakeup_code = STATE_ERROR;
723 }
724 /* don't try to handle other events */
725 goto out;
726 }
727 if (pend & XIIC_INTR_RX_FULL_MASK) {
728 /* Receive register/FIFO is full */
729
730 clr |= XIIC_INTR_RX_FULL_MASK;
731 if (!i2c->rx_msg) {
732 dev_dbg(i2c->adap.dev.parent,
733 "%s unexpected RX IRQ\n", __func__);
734 xiic_clear_rx_fifo(i2c);
735 goto out;
736 }
737
738 xiic_read_rx(i2c);
739 if (xiic_rx_space(i2c) == 0) {
740 /* this is the last part of the message */
741 i2c->rx_msg = NULL;
742
743 /* also clear TX error if there (RX complete) */
744 clr |= (isr & XIIC_INTR_TX_ERROR_MASK);
745
746 dev_dbg(i2c->adap.dev.parent,
747 "%s end of message, nmsgs: %d\n",
748 __func__, i2c->nmsgs);
749
750 /* send next message if this wasn't the last,
751 * otherwise the transfer will be finialise when
752 * receiving the bus not busy interrupt
753 */
754 if (i2c->nmsgs > 1) {
755 i2c->nmsgs--;
756 i2c->tx_msg++;
757 dev_dbg(i2c->adap.dev.parent,
758 "%s will start next...\n", __func__);
759 xfer_more = 1;
760 }
761 }
762 }
763 if (pend & (XIIC_INTR_TX_EMPTY_MASK | XIIC_INTR_TX_HALF_MASK)) {
764 /* Transmit register/FIFO is empty or ½ empty */
765
766 clr |= (pend &
767 (XIIC_INTR_TX_EMPTY_MASK | XIIC_INTR_TX_HALF_MASK));
768
769 if (!i2c->tx_msg) {
770 dev_dbg(i2c->adap.dev.parent,
771 "%s unexpected TX IRQ\n", __func__);
772 goto out;
773 }
774
775 xiic_fill_tx_fifo(i2c);
776
777 /* current message sent and there is space in the fifo */
778 if (!xiic_tx_space(i2c) && xiic_tx_fifo_space(i2c) >= 2) {
779 dev_dbg(i2c->adap.dev.parent,
780 "%s end of message sent, nmsgs: %d\n",
781 __func__, i2c->nmsgs);
782 if (i2c->nmsgs > 1) {
783 i2c->nmsgs--;
784 i2c->tx_msg++;
785 xfer_more = 1;
786 } else {
787 xiic_irq_dis(i2c, XIIC_INTR_TX_HALF_MASK);
788
789 dev_dbg(i2c->adap.dev.parent,
790 "%s Got TX IRQ but no more to do...\n",
791 __func__);
792 }
793 } else if (!xiic_tx_space(i2c) && (i2c->nmsgs == 1))
794 /* current frame is sent and is last,
795 * make sure to disable tx half
796 */
797 xiic_irq_dis(i2c, XIIC_INTR_TX_HALF_MASK);
798 }
799
800 if (pend & XIIC_INTR_BNB_MASK) {
801 /* IIC bus has transitioned to not busy */
802 clr |= XIIC_INTR_BNB_MASK;
803
804 /* The bus is not busy, disable BusNotBusy interrupt */
805 xiic_irq_dis(i2c, XIIC_INTR_BNB_MASK);
806
807 if (i2c->tx_msg && i2c->smbus_block_read) {
808 i2c->smbus_block_read = false;
809 /* Set requested message len=1 to indicate STATE_DONE */
810 i2c->tx_msg->len = 1;
811 }
812
813 if (!i2c->tx_msg)
814 goto out;
815
816 wakeup_req = 1;
817
818 if (i2c->nmsgs == 1 && !i2c->rx_msg &&
819 xiic_tx_space(i2c) == 0)
820 wakeup_code = STATE_DONE;
821 else
822 wakeup_code = STATE_ERROR;
823 }
824
825out:
826 dev_dbg(i2c->adap.dev.parent, "%s clr: 0x%x\n", __func__, clr);
827
828 xiic_setreg32(i2c, XIIC_IISR_OFFSET, clr);
829 if (xfer_more)
830 __xiic_start_xfer(i2c);
831 if (wakeup_req)
832 xiic_wakeup(i2c, wakeup_code);
833
834 WARN_ON(xfer_more && wakeup_req);
835
836 mutex_unlock(&i2c->lock);
837 return IRQ_HANDLED;
838}
839
840static int xiic_bus_busy(struct xiic_i2c *i2c)
841{
842 u8 sr = xiic_getreg8(i2c, XIIC_SR_REG_OFFSET);
843
844 return (sr & XIIC_SR_BUS_BUSY_MASK) ? -EBUSY : 0;
845}
846
847static int xiic_busy(struct xiic_i2c *i2c)
848{
849 int tries = 3;
850 int err;
851
852 if (i2c->tx_msg || i2c->rx_msg)
853 return -EBUSY;
854
855 /* In single master mode bus can only be busy, when in use by this
856 * driver. If the register indicates bus being busy for some reason we
857 * should ignore it, since bus will never be released and i2c will be
858 * stuck forever.
859 */
860 if (i2c->singlemaster) {
861 return 0;
862 }
863
864 /* for instance if previous transfer was terminated due to TX error
865 * it might be that the bus is on it's way to become available
866 * give it at most 3 ms to wake
867 */
868 err = xiic_bus_busy(i2c);
869 while (err && tries--) {
870 msleep(1);
871 err = xiic_bus_busy(i2c);
872 }
873
874 return err;
875}
876
877static void xiic_start_recv(struct xiic_i2c *i2c)
878{
879 u16 rx_watermark;
880 u8 cr = 0, rfd_set = 0;
881 struct i2c_msg *msg = i2c->rx_msg = i2c->tx_msg;
882
883 dev_dbg(i2c->adap.dev.parent, "%s entry, ISR: 0x%x, CR: 0x%x\n",
884 __func__, xiic_getreg32(i2c, XIIC_IISR_OFFSET),
885 xiic_getreg8(i2c, XIIC_CR_REG_OFFSET));
886
887 /* Disable Tx interrupts */
888 xiic_irq_dis(i2c, XIIC_INTR_TX_HALF_MASK | XIIC_INTR_TX_EMPTY_MASK);
889
890 if (i2c->dynamic) {
891 u8 bytes;
892 u16 val;
893
894 /* Clear and enable Rx full interrupt. */
895 xiic_irq_clr_en(i2c, XIIC_INTR_RX_FULL_MASK |
896 XIIC_INTR_TX_ERROR_MASK);
897
898 /*
899 * We want to get all but last byte, because the TX_ERROR IRQ
900 * is used to indicate error ACK on the address, and
901 * negative ack on the last received byte, so to not mix
902 * them receive all but last.
903 * In the case where there is only one byte to receive
904 * we can check if ERROR and RX full is set at the same time
905 */
906 rx_watermark = msg->len;
907 bytes = min_t(u8, rx_watermark, IIC_RX_FIFO_DEPTH);
908
909 if (rx_watermark > 0)
910 bytes--;
911 xiic_setreg8(i2c, XIIC_RFD_REG_OFFSET, bytes);
912
913 /* write the address */
914 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET,
915 i2c_8bit_addr_from_msg(msg) |
916 XIIC_TX_DYN_START_MASK);
917
918 /* If last message, include dynamic stop bit with length */
919 val = (i2c->nmsgs == 1) ? XIIC_TX_DYN_STOP_MASK : 0;
920 val |= msg->len;
921
922 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET, val);
923
924 xiic_irq_clr_en(i2c, XIIC_INTR_BNB_MASK);
925 } else {
926 /*
927 * If previous message is Tx, make sure that Tx FIFO is empty
928 * before starting a new transfer as the repeated start in
929 * standard mode can corrupt the transaction if there are
930 * still bytes to be transmitted in FIFO
931 */
932 if (i2c->prev_msg_tx) {
933 int status;
934
935 status = xiic_wait_tx_empty(i2c);
936 if (status)
937 return;
938 }
939
940 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
941
942 /* Set Receive fifo depth */
943 rx_watermark = msg->len;
944 if (rx_watermark > IIC_RX_FIFO_DEPTH) {
945 rfd_set = IIC_RX_FIFO_DEPTH - 1;
946 } else if (rx_watermark == 1) {
947 rfd_set = rx_watermark - 1;
948
949 /* Set No_ACK, except for smbus_block_read */
950 if (!(i2c->rx_msg->flags & I2C_M_RECV_LEN)) {
951 /* Handle single byte transfer separately */
952 cr |= XIIC_CR_NO_ACK_MASK;
953 }
954 } else if (rx_watermark == 0) {
955 rfd_set = rx_watermark;
956 } else {
957 rfd_set = rx_watermark - 2;
958 }
959 /* Check if RSTA should be set */
960 if (cr & XIIC_CR_MSMS_MASK) {
961 /* Already a master, RSTA should be set */
962 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, (cr |
963 XIIC_CR_REPEATED_START_MASK) &
964 ~(XIIC_CR_DIR_IS_TX_MASK));
965 }
966
967 xiic_setreg8(i2c, XIIC_RFD_REG_OFFSET, rfd_set);
968
969 /* Clear and enable Rx full and transmit complete interrupts */
970 xiic_irq_clr_en(i2c, XIIC_INTR_RX_FULL_MASK |
971 XIIC_INTR_TX_ERROR_MASK);
972
973 /* Write the address */
974 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET,
975 i2c_8bit_addr_from_msg(msg));
976
977 /* Write to Control Register,to start transaction in Rx mode */
978 if ((cr & XIIC_CR_MSMS_MASK) == 0) {
979 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, (cr |
980 XIIC_CR_MSMS_MASK)
981 & ~(XIIC_CR_DIR_IS_TX_MASK));
982 }
983 dev_dbg(i2c->adap.dev.parent, "%s end, ISR: 0x%x, CR: 0x%x\n",
984 __func__, xiic_getreg32(i2c, XIIC_IISR_OFFSET),
985 xiic_getreg8(i2c, XIIC_CR_REG_OFFSET));
986 }
987
988 if (i2c->nmsgs == 1)
989 /* very last, enable bus not busy as well */
990 xiic_irq_clr_en(i2c, XIIC_INTR_BNB_MASK);
991
992 /* the message is tx:ed */
993 i2c->tx_pos = msg->len;
994
995 /* Enable interrupts */
996 xiic_setreg32(i2c, XIIC_DGIER_OFFSET, XIIC_GINTR_ENABLE_MASK);
997
998 i2c->prev_msg_tx = false;
999}
1000
1001static void xiic_start_send(struct xiic_i2c *i2c)
1002{
1003 u8 cr = 0;
1004 u16 data;
1005 struct i2c_msg *msg = i2c->tx_msg;
1006
1007 dev_dbg(i2c->adap.dev.parent, "%s entry, msg: %p, len: %d",
1008 __func__, msg, msg->len);
1009 dev_dbg(i2c->adap.dev.parent, "%s entry, ISR: 0x%x, CR: 0x%x\n",
1010 __func__, xiic_getreg32(i2c, XIIC_IISR_OFFSET),
1011 xiic_getreg8(i2c, XIIC_CR_REG_OFFSET));
1012
1013 if (i2c->dynamic) {
1014 /* write the address */
1015 data = i2c_8bit_addr_from_msg(msg) |
1016 XIIC_TX_DYN_START_MASK;
1017
1018 if (i2c->nmsgs == 1 && msg->len == 0)
1019 /* no data and last message -> add STOP */
1020 data |= XIIC_TX_DYN_STOP_MASK;
1021
1022 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET, data);
1023
1024 /* Clear any pending Tx empty, Tx Error and then enable them */
1025 xiic_irq_clr_en(i2c, XIIC_INTR_TX_EMPTY_MASK |
1026 XIIC_INTR_TX_ERROR_MASK |
1027 XIIC_INTR_BNB_MASK |
1028 ((i2c->nmsgs > 1 || xiic_tx_space(i2c)) ?
1029 XIIC_INTR_TX_HALF_MASK : 0));
1030
1031 xiic_fill_tx_fifo(i2c);
1032 } else {
1033 /*
1034 * If previous message is Tx, make sure that Tx FIFO is empty
1035 * before starting a new transfer as the repeated start in
1036 * standard mode can corrupt the transaction if there are
1037 * still bytes to be transmitted in FIFO
1038 */
1039 if (i2c->prev_msg_tx) {
1040 int status;
1041
1042 status = xiic_wait_tx_empty(i2c);
1043 if (status)
1044 return;
1045 }
1046 /* Check if RSTA should be set */
1047 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
1048 if (cr & XIIC_CR_MSMS_MASK) {
1049 /* Already a master, RSTA should be set */
1050 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, (cr |
1051 XIIC_CR_REPEATED_START_MASK |
1052 XIIC_CR_DIR_IS_TX_MASK) &
1053 ~(XIIC_CR_NO_ACK_MASK));
1054 }
1055
1056 /* Write address to FIFO */
1057 data = i2c_8bit_addr_from_msg(msg);
1058 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET, data);
1059
1060 /* Fill fifo */
1061 xiic_fill_tx_fifo(i2c);
1062
1063 if ((cr & XIIC_CR_MSMS_MASK) == 0) {
1064 /* Start Tx by writing to CR */
1065 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
1066 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, cr |
1067 XIIC_CR_MSMS_MASK |
1068 XIIC_CR_DIR_IS_TX_MASK);
1069 }
1070
1071 /* Clear any pending Tx empty, Tx Error and then enable them */
1072 xiic_irq_clr_en(i2c, XIIC_INTR_TX_EMPTY_MASK |
1073 XIIC_INTR_TX_ERROR_MASK |
1074 XIIC_INTR_BNB_MASK);
1075 }
1076 i2c->prev_msg_tx = true;
1077}
1078
1079static void __xiic_start_xfer(struct xiic_i2c *i2c)
1080{
1081 int fifo_space = xiic_tx_fifo_space(i2c);
1082
1083 dev_dbg(i2c->adap.dev.parent, "%s entry, msg: %p, fifos space: %d\n",
1084 __func__, i2c->tx_msg, fifo_space);
1085
1086 if (!i2c->tx_msg)
1087 return;
1088
1089 i2c->rx_pos = 0;
1090 i2c->tx_pos = 0;
1091 i2c->state = STATE_START;
1092 if (i2c->tx_msg->flags & I2C_M_RD) {
1093 /* we dont date putting several reads in the FIFO */
1094 xiic_start_recv(i2c);
1095 } else {
1096 xiic_start_send(i2c);
1097 }
1098}
1099
1100static int xiic_start_xfer(struct xiic_i2c *i2c, struct i2c_msg *msgs, int num)
1101{
1102 bool broken_read, max_read_len, smbus_blk_read;
1103 int ret, count;
1104
1105 mutex_lock(&i2c->lock);
1106
1107 ret = xiic_busy(i2c);
1108 if (ret)
1109 goto out;
1110
1111 i2c->tx_msg = msgs;
1112 i2c->rx_msg = NULL;
1113 i2c->nmsgs = num;
1114 init_completion(&i2c->completion);
1115
1116 /* Decide standard mode or Dynamic mode */
1117 i2c->dynamic = true;
1118
1119 /* Initialize prev message type */
1120 i2c->prev_msg_tx = false;
1121
1122 /*
1123 * Scan through nmsgs, use dynamic mode when none of the below three
1124 * conditions occur. We need standard mode even if one condition holds
1125 * true in the entire array of messages in a single transfer.
1126 * If read transaction as dynamic mode is broken for delayed reads
1127 * in xlnx,axi-iic-2.0 / xlnx,xps-iic-2.00.a IP versions.
1128 * If read length is > 255 bytes.
1129 * If smbus_block_read transaction.
1130 */
1131 for (count = 0; count < i2c->nmsgs; count++) {
1132 broken_read = (i2c->quirks & DYNAMIC_MODE_READ_BROKEN_BIT) &&
1133 (i2c->tx_msg[count].flags & I2C_M_RD);
1134 max_read_len = (i2c->tx_msg[count].flags & I2C_M_RD) &&
1135 (i2c->tx_msg[count].len > MAX_READ_LENGTH_DYNAMIC);
1136 smbus_blk_read = (i2c->tx_msg[count].flags & I2C_M_RECV_LEN);
1137
1138 if (broken_read || max_read_len || smbus_blk_read) {
1139 i2c->dynamic = false;
1140 break;
1141 }
1142 }
1143
1144 ret = xiic_reinit(i2c);
1145 if (!ret)
1146 __xiic_start_xfer(i2c);
1147
1148out:
1149 mutex_unlock(&i2c->lock);
1150
1151 return ret;
1152}
1153
1154static int xiic_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
1155{
1156 struct xiic_i2c *i2c = i2c_get_adapdata(adap);
1157 int err;
1158
1159 dev_dbg(adap->dev.parent, "%s entry SR: 0x%x\n", __func__,
1160 xiic_getreg8(i2c, XIIC_SR_REG_OFFSET));
1161
1162 err = pm_runtime_resume_and_get(i2c->dev);
1163 if (err < 0)
1164 return err;
1165
1166 err = xiic_start_xfer(i2c, msgs, num);
1167 if (err < 0) {
1168 dev_err(adap->dev.parent, "Error xiic_start_xfer\n");
1169 goto out;
1170 }
1171
1172 err = wait_for_completion_timeout(&i2c->completion, XIIC_XFER_TIMEOUT);
1173 mutex_lock(&i2c->lock);
1174 if (err == 0) { /* Timeout */
1175 i2c->tx_msg = NULL;
1176 i2c->rx_msg = NULL;
1177 i2c->nmsgs = 0;
1178 err = -ETIMEDOUT;
1179 } else {
1180 err = (i2c->state == STATE_DONE) ? num : -EIO;
1181 }
1182 mutex_unlock(&i2c->lock);
1183
1184out:
1185 pm_runtime_mark_last_busy(i2c->dev);
1186 pm_runtime_put_autosuspend(i2c->dev);
1187 return err;
1188}
1189
1190static u32 xiic_func(struct i2c_adapter *adap)
1191{
1192 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_SMBUS_BLOCK_DATA;
1193}
1194
1195static const struct i2c_algorithm xiic_algorithm = {
1196 .master_xfer = xiic_xfer,
1197 .functionality = xiic_func,
1198};
1199
1200static const struct i2c_adapter xiic_adapter = {
1201 .owner = THIS_MODULE,
1202 .class = I2C_CLASS_DEPRECATED,
1203 .algo = &xiic_algorithm,
1204};
1205
1206#if defined(CONFIG_OF)
1207static const struct xiic_version_data xiic_2_00 = {
1208 .quirks = DYNAMIC_MODE_READ_BROKEN_BIT,
1209};
1210
1211static const struct of_device_id xiic_of_match[] = {
1212 { .compatible = "xlnx,xps-iic-2.00.a", .data = &xiic_2_00 },
1213 { .compatible = "xlnx,axi-iic-2.1", },
1214 {},
1215};
1216MODULE_DEVICE_TABLE(of, xiic_of_match);
1217#endif
1218
1219static int xiic_i2c_probe(struct platform_device *pdev)
1220{
1221 struct xiic_i2c *i2c;
1222 struct xiic_i2c_platform_data *pdata;
1223 const struct of_device_id *match;
1224 struct resource *res;
1225 int ret, irq;
1226 u8 i;
1227 u32 sr;
1228
1229 i2c = devm_kzalloc(&pdev->dev, sizeof(*i2c), GFP_KERNEL);
1230 if (!i2c)
1231 return -ENOMEM;
1232
1233 match = of_match_node(xiic_of_match, pdev->dev.of_node);
1234 if (match && match->data) {
1235 const struct xiic_version_data *data = match->data;
1236
1237 i2c->quirks = data->quirks;
1238 }
1239
1240 i2c->base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
1241 if (IS_ERR(i2c->base))
1242 return PTR_ERR(i2c->base);
1243
1244 irq = platform_get_irq(pdev, 0);
1245 if (irq < 0)
1246 return irq;
1247
1248 pdata = dev_get_platdata(&pdev->dev);
1249
1250 /* hook up driver to tree */
1251 platform_set_drvdata(pdev, i2c);
1252 i2c->adap = xiic_adapter;
1253 i2c_set_adapdata(&i2c->adap, i2c);
1254 i2c->adap.dev.parent = &pdev->dev;
1255 i2c->adap.dev.of_node = pdev->dev.of_node;
1256 snprintf(i2c->adap.name, sizeof(i2c->adap.name),
1257 DRIVER_NAME " %s", pdev->name);
1258
1259 mutex_init(&i2c->lock);
1260
1261 i2c->clk = devm_clk_get_enabled(&pdev->dev, NULL);
1262 if (IS_ERR(i2c->clk))
1263 return dev_err_probe(&pdev->dev, PTR_ERR(i2c->clk),
1264 "failed to enable input clock.\n");
1265
1266 i2c->dev = &pdev->dev;
1267 pm_runtime_set_autosuspend_delay(i2c->dev, XIIC_PM_TIMEOUT);
1268 pm_runtime_use_autosuspend(i2c->dev);
1269 pm_runtime_set_active(i2c->dev);
1270 pm_runtime_enable(i2c->dev);
1271
1272 /* SCL frequency configuration */
1273 i2c->input_clk = clk_get_rate(i2c->clk);
1274 ret = of_property_read_u32(pdev->dev.of_node, "clock-frequency",
1275 &i2c->i2c_clk);
1276 /* If clock-frequency not specified in DT, do not configure in SW */
1277 if (ret || i2c->i2c_clk > I2C_MAX_FAST_MODE_PLUS_FREQ)
1278 i2c->i2c_clk = 0;
1279
1280 ret = devm_request_threaded_irq(&pdev->dev, irq, NULL,
1281 xiic_process, IRQF_ONESHOT,
1282 pdev->name, i2c);
1283
1284 if (ret < 0) {
1285 dev_err(&pdev->dev, "Cannot claim IRQ\n");
1286 goto err_pm_disable;
1287 }
1288
1289 i2c->singlemaster =
1290 of_property_read_bool(pdev->dev.of_node, "single-master");
1291
1292 /*
1293 * Detect endianness
1294 * Try to reset the TX FIFO. Then check the EMPTY flag. If it is not
1295 * set, assume that the endianness was wrong and swap.
1296 */
1297 i2c->endianness = LITTLE;
1298 xiic_setreg32(i2c, XIIC_CR_REG_OFFSET, XIIC_CR_TX_FIFO_RESET_MASK);
1299 /* Reset is cleared in xiic_reinit */
1300 sr = xiic_getreg32(i2c, XIIC_SR_REG_OFFSET);
1301 if (!(sr & XIIC_SR_TX_FIFO_EMPTY_MASK))
1302 i2c->endianness = BIG;
1303
1304 ret = xiic_reinit(i2c);
1305 if (ret < 0) {
1306 dev_err(&pdev->dev, "Cannot xiic_reinit\n");
1307 goto err_pm_disable;
1308 }
1309
1310 /* add i2c adapter to i2c tree */
1311 ret = i2c_add_adapter(&i2c->adap);
1312 if (ret) {
1313 xiic_deinit(i2c);
1314 goto err_pm_disable;
1315 }
1316
1317 if (pdata) {
1318 /* add in known devices to the bus */
1319 for (i = 0; i < pdata->num_devices; i++)
1320 i2c_new_client_device(&i2c->adap, pdata->devices + i);
1321 }
1322
1323 dev_dbg(&pdev->dev, "mmio %08lx irq %d scl clock frequency %d\n",
1324 (unsigned long)res->start, irq, i2c->i2c_clk);
1325
1326 return 0;
1327
1328err_pm_disable:
1329 pm_runtime_set_suspended(&pdev->dev);
1330 pm_runtime_disable(&pdev->dev);
1331
1332 return ret;
1333}
1334
1335static void xiic_i2c_remove(struct platform_device *pdev)
1336{
1337 struct xiic_i2c *i2c = platform_get_drvdata(pdev);
1338 int ret;
1339
1340 /* remove adapter & data */
1341 i2c_del_adapter(&i2c->adap);
1342
1343 ret = pm_runtime_get_sync(i2c->dev);
1344
1345 if (ret < 0)
1346 dev_warn(&pdev->dev, "Failed to activate device for removal (%pe)\n",
1347 ERR_PTR(ret));
1348 else
1349 xiic_deinit(i2c);
1350
1351 pm_runtime_put_sync(i2c->dev);
1352 pm_runtime_disable(&pdev->dev);
1353 pm_runtime_set_suspended(&pdev->dev);
1354 pm_runtime_dont_use_autosuspend(&pdev->dev);
1355}
1356
1357static int __maybe_unused xiic_i2c_runtime_suspend(struct device *dev)
1358{
1359 struct xiic_i2c *i2c = dev_get_drvdata(dev);
1360
1361 clk_disable(i2c->clk);
1362
1363 return 0;
1364}
1365
1366static int __maybe_unused xiic_i2c_runtime_resume(struct device *dev)
1367{
1368 struct xiic_i2c *i2c = dev_get_drvdata(dev);
1369 int ret;
1370
1371 ret = clk_enable(i2c->clk);
1372 if (ret) {
1373 dev_err(dev, "Cannot enable clock.\n");
1374 return ret;
1375 }
1376
1377 return 0;
1378}
1379
1380static const struct dev_pm_ops xiic_dev_pm_ops = {
1381 SET_RUNTIME_PM_OPS(xiic_i2c_runtime_suspend,
1382 xiic_i2c_runtime_resume, NULL)
1383};
1384
1385static struct platform_driver xiic_i2c_driver = {
1386 .probe = xiic_i2c_probe,
1387 .remove_new = xiic_i2c_remove,
1388 .driver = {
1389 .name = DRIVER_NAME,
1390 .of_match_table = of_match_ptr(xiic_of_match),
1391 .pm = &xiic_dev_pm_ops,
1392 },
1393};
1394
1395module_platform_driver(xiic_i2c_driver);
1396
1397MODULE_ALIAS("platform:" DRIVER_NAME);
1398MODULE_AUTHOR("info@mocean-labs.com");
1399MODULE_DESCRIPTION("Xilinx I2C bus driver");
1400MODULE_LICENSE("GPL v2");
1/*
2 * i2c-xiic.c
3 * Copyright (c) 2002-2007 Xilinx Inc.
4 * Copyright (c) 2009-2010 Intel Corporation
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 *
16 * This code was implemented by Mocean Laboratories AB when porting linux
17 * to the automotive development board Russellville. The copyright holder
18 * as seen in the header is Intel corporation.
19 * Mocean Laboratories forked off the GNU/Linux platform work into a
20 * separate company called Pelagicore AB, which committed the code to the
21 * kernel.
22 */
23
24/* Supports:
25 * Xilinx IIC
26 */
27#include <linux/kernel.h>
28#include <linux/module.h>
29#include <linux/errno.h>
30#include <linux/err.h>
31#include <linux/delay.h>
32#include <linux/platform_device.h>
33#include <linux/i2c.h>
34#include <linux/interrupt.h>
35#include <linux/wait.h>
36#include <linux/i2c-xiic.h>
37#include <linux/io.h>
38#include <linux/slab.h>
39#include <linux/of.h>
40#include <linux/clk.h>
41#include <linux/pm_runtime.h>
42
43#define DRIVER_NAME "xiic-i2c"
44
45enum xilinx_i2c_state {
46 STATE_DONE,
47 STATE_ERROR,
48 STATE_START
49};
50
51enum xiic_endian {
52 LITTLE,
53 BIG
54};
55
56/**
57 * struct xiic_i2c - Internal representation of the XIIC I2C bus
58 * @base: Memory base of the HW registers
59 * @wait: Wait queue for callers
60 * @adap: Kernel adapter representation
61 * @tx_msg: Messages from above to be sent
62 * @lock: Mutual exclusion
63 * @tx_pos: Current pos in TX message
64 * @nmsgs: Number of messages in tx_msg
65 * @state: See STATE_
66 * @rx_msg: Current RX message
67 * @rx_pos: Position within current RX message
68 * @endianness: big/little-endian byte order
69 */
70struct xiic_i2c {
71 struct device *dev;
72 void __iomem *base;
73 wait_queue_head_t wait;
74 struct i2c_adapter adap;
75 struct i2c_msg *tx_msg;
76 struct mutex lock;
77 unsigned int tx_pos;
78 unsigned int nmsgs;
79 enum xilinx_i2c_state state;
80 struct i2c_msg *rx_msg;
81 int rx_pos;
82 enum xiic_endian endianness;
83 struct clk *clk;
84};
85
86
87#define XIIC_MSB_OFFSET 0
88#define XIIC_REG_OFFSET (0x100+XIIC_MSB_OFFSET)
89
90/*
91 * Register offsets in bytes from RegisterBase. Three is added to the
92 * base offset to access LSB (IBM style) of the word
93 */
94#define XIIC_CR_REG_OFFSET (0x00+XIIC_REG_OFFSET) /* Control Register */
95#define XIIC_SR_REG_OFFSET (0x04+XIIC_REG_OFFSET) /* Status Register */
96#define XIIC_DTR_REG_OFFSET (0x08+XIIC_REG_OFFSET) /* Data Tx Register */
97#define XIIC_DRR_REG_OFFSET (0x0C+XIIC_REG_OFFSET) /* Data Rx Register */
98#define XIIC_ADR_REG_OFFSET (0x10+XIIC_REG_OFFSET) /* Address Register */
99#define XIIC_TFO_REG_OFFSET (0x14+XIIC_REG_OFFSET) /* Tx FIFO Occupancy */
100#define XIIC_RFO_REG_OFFSET (0x18+XIIC_REG_OFFSET) /* Rx FIFO Occupancy */
101#define XIIC_TBA_REG_OFFSET (0x1C+XIIC_REG_OFFSET) /* 10 Bit Address reg */
102#define XIIC_RFD_REG_OFFSET (0x20+XIIC_REG_OFFSET) /* Rx FIFO Depth reg */
103#define XIIC_GPO_REG_OFFSET (0x24+XIIC_REG_OFFSET) /* Output Register */
104
105/* Control Register masks */
106#define XIIC_CR_ENABLE_DEVICE_MASK 0x01 /* Device enable = 1 */
107#define XIIC_CR_TX_FIFO_RESET_MASK 0x02 /* Transmit FIFO reset=1 */
108#define XIIC_CR_MSMS_MASK 0x04 /* Master starts Txing=1 */
109#define XIIC_CR_DIR_IS_TX_MASK 0x08 /* Dir of tx. Txing=1 */
110#define XIIC_CR_NO_ACK_MASK 0x10 /* Tx Ack. NO ack = 1 */
111#define XIIC_CR_REPEATED_START_MASK 0x20 /* Repeated start = 1 */
112#define XIIC_CR_GENERAL_CALL_MASK 0x40 /* Gen Call enabled = 1 */
113
114/* Status Register masks */
115#define XIIC_SR_GEN_CALL_MASK 0x01 /* 1=a mstr issued a GC */
116#define XIIC_SR_ADDR_AS_SLAVE_MASK 0x02 /* 1=when addr as slave */
117#define XIIC_SR_BUS_BUSY_MASK 0x04 /* 1 = bus is busy */
118#define XIIC_SR_MSTR_RDING_SLAVE_MASK 0x08 /* 1=Dir: mstr <-- slave */
119#define XIIC_SR_TX_FIFO_FULL_MASK 0x10 /* 1 = Tx FIFO full */
120#define XIIC_SR_RX_FIFO_FULL_MASK 0x20 /* 1 = Rx FIFO full */
121#define XIIC_SR_RX_FIFO_EMPTY_MASK 0x40 /* 1 = Rx FIFO empty */
122#define XIIC_SR_TX_FIFO_EMPTY_MASK 0x80 /* 1 = Tx FIFO empty */
123
124/* Interrupt Status Register masks Interrupt occurs when... */
125#define XIIC_INTR_ARB_LOST_MASK 0x01 /* 1 = arbitration lost */
126#define XIIC_INTR_TX_ERROR_MASK 0x02 /* 1=Tx error/msg complete */
127#define XIIC_INTR_TX_EMPTY_MASK 0x04 /* 1 = Tx FIFO/reg empty */
128#define XIIC_INTR_RX_FULL_MASK 0x08 /* 1=Rx FIFO/reg=OCY level */
129#define XIIC_INTR_BNB_MASK 0x10 /* 1 = Bus not busy */
130#define XIIC_INTR_AAS_MASK 0x20 /* 1 = when addr as slave */
131#define XIIC_INTR_NAAS_MASK 0x40 /* 1 = not addr as slave */
132#define XIIC_INTR_TX_HALF_MASK 0x80 /* 1 = TX FIFO half empty */
133
134/* The following constants specify the depth of the FIFOs */
135#define IIC_RX_FIFO_DEPTH 16 /* Rx fifo capacity */
136#define IIC_TX_FIFO_DEPTH 16 /* Tx fifo capacity */
137
138/* The following constants specify groups of interrupts that are typically
139 * enabled or disables at the same time
140 */
141#define XIIC_TX_INTERRUPTS \
142(XIIC_INTR_TX_ERROR_MASK | XIIC_INTR_TX_EMPTY_MASK | XIIC_INTR_TX_HALF_MASK)
143
144#define XIIC_TX_RX_INTERRUPTS (XIIC_INTR_RX_FULL_MASK | XIIC_TX_INTERRUPTS)
145
146/* The following constants are used with the following macros to specify the
147 * operation, a read or write operation.
148 */
149#define XIIC_READ_OPERATION 1
150#define XIIC_WRITE_OPERATION 0
151
152/*
153 * Tx Fifo upper bit masks.
154 */
155#define XIIC_TX_DYN_START_MASK 0x0100 /* 1 = Set dynamic start */
156#define XIIC_TX_DYN_STOP_MASK 0x0200 /* 1 = Set dynamic stop */
157
158/*
159 * The following constants define the register offsets for the Interrupt
160 * registers. There are some holes in the memory map for reserved addresses
161 * to allow other registers to be added and still match the memory map of the
162 * interrupt controller registers
163 */
164#define XIIC_DGIER_OFFSET 0x1C /* Device Global Interrupt Enable Register */
165#define XIIC_IISR_OFFSET 0x20 /* Interrupt Status Register */
166#define XIIC_IIER_OFFSET 0x28 /* Interrupt Enable Register */
167#define XIIC_RESETR_OFFSET 0x40 /* Reset Register */
168
169#define XIIC_RESET_MASK 0xAUL
170
171#define XIIC_PM_TIMEOUT 1000 /* ms */
172/*
173 * The following constant is used for the device global interrupt enable
174 * register, to enable all interrupts for the device, this is the only bit
175 * in the register
176 */
177#define XIIC_GINTR_ENABLE_MASK 0x80000000UL
178
179#define xiic_tx_space(i2c) ((i2c)->tx_msg->len - (i2c)->tx_pos)
180#define xiic_rx_space(i2c) ((i2c)->rx_msg->len - (i2c)->rx_pos)
181
182static void xiic_start_xfer(struct xiic_i2c *i2c);
183static void __xiic_start_xfer(struct xiic_i2c *i2c);
184
185/*
186 * For the register read and write functions, a little-endian and big-endian
187 * version are necessary. Endianness is detected during the probe function.
188 * Only the least significant byte [doublet] of the register are ever
189 * accessed. This requires an offset of 3 [2] from the base address for
190 * big-endian systems.
191 */
192
193static inline void xiic_setreg8(struct xiic_i2c *i2c, int reg, u8 value)
194{
195 if (i2c->endianness == LITTLE)
196 iowrite8(value, i2c->base + reg);
197 else
198 iowrite8(value, i2c->base + reg + 3);
199}
200
201static inline u8 xiic_getreg8(struct xiic_i2c *i2c, int reg)
202{
203 u8 ret;
204
205 if (i2c->endianness == LITTLE)
206 ret = ioread8(i2c->base + reg);
207 else
208 ret = ioread8(i2c->base + reg + 3);
209 return ret;
210}
211
212static inline void xiic_setreg16(struct xiic_i2c *i2c, int reg, u16 value)
213{
214 if (i2c->endianness == LITTLE)
215 iowrite16(value, i2c->base + reg);
216 else
217 iowrite16be(value, i2c->base + reg + 2);
218}
219
220static inline void xiic_setreg32(struct xiic_i2c *i2c, int reg, int value)
221{
222 if (i2c->endianness == LITTLE)
223 iowrite32(value, i2c->base + reg);
224 else
225 iowrite32be(value, i2c->base + reg);
226}
227
228static inline int xiic_getreg32(struct xiic_i2c *i2c, int reg)
229{
230 u32 ret;
231
232 if (i2c->endianness == LITTLE)
233 ret = ioread32(i2c->base + reg);
234 else
235 ret = ioread32be(i2c->base + reg);
236 return ret;
237}
238
239static inline void xiic_irq_dis(struct xiic_i2c *i2c, u32 mask)
240{
241 u32 ier = xiic_getreg32(i2c, XIIC_IIER_OFFSET);
242 xiic_setreg32(i2c, XIIC_IIER_OFFSET, ier & ~mask);
243}
244
245static inline void xiic_irq_en(struct xiic_i2c *i2c, u32 mask)
246{
247 u32 ier = xiic_getreg32(i2c, XIIC_IIER_OFFSET);
248 xiic_setreg32(i2c, XIIC_IIER_OFFSET, ier | mask);
249}
250
251static inline void xiic_irq_clr(struct xiic_i2c *i2c, u32 mask)
252{
253 u32 isr = xiic_getreg32(i2c, XIIC_IISR_OFFSET);
254 xiic_setreg32(i2c, XIIC_IISR_OFFSET, isr & mask);
255}
256
257static inline void xiic_irq_clr_en(struct xiic_i2c *i2c, u32 mask)
258{
259 xiic_irq_clr(i2c, mask);
260 xiic_irq_en(i2c, mask);
261}
262
263static void xiic_clear_rx_fifo(struct xiic_i2c *i2c)
264{
265 u8 sr;
266 for (sr = xiic_getreg8(i2c, XIIC_SR_REG_OFFSET);
267 !(sr & XIIC_SR_RX_FIFO_EMPTY_MASK);
268 sr = xiic_getreg8(i2c, XIIC_SR_REG_OFFSET))
269 xiic_getreg8(i2c, XIIC_DRR_REG_OFFSET);
270}
271
272static void xiic_reinit(struct xiic_i2c *i2c)
273{
274 xiic_setreg32(i2c, XIIC_RESETR_OFFSET, XIIC_RESET_MASK);
275
276 /* Set receive Fifo depth to maximum (zero based). */
277 xiic_setreg8(i2c, XIIC_RFD_REG_OFFSET, IIC_RX_FIFO_DEPTH - 1);
278
279 /* Reset Tx Fifo. */
280 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, XIIC_CR_TX_FIFO_RESET_MASK);
281
282 /* Enable IIC Device, remove Tx Fifo reset & disable general call. */
283 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, XIIC_CR_ENABLE_DEVICE_MASK);
284
285 /* make sure RX fifo is empty */
286 xiic_clear_rx_fifo(i2c);
287
288 /* Enable interrupts */
289 xiic_setreg32(i2c, XIIC_DGIER_OFFSET, XIIC_GINTR_ENABLE_MASK);
290
291 xiic_irq_clr_en(i2c, XIIC_INTR_ARB_LOST_MASK);
292}
293
294static void xiic_deinit(struct xiic_i2c *i2c)
295{
296 u8 cr;
297
298 xiic_setreg32(i2c, XIIC_RESETR_OFFSET, XIIC_RESET_MASK);
299
300 /* Disable IIC Device. */
301 cr = xiic_getreg8(i2c, XIIC_CR_REG_OFFSET);
302 xiic_setreg8(i2c, XIIC_CR_REG_OFFSET, cr & ~XIIC_CR_ENABLE_DEVICE_MASK);
303}
304
305static void xiic_read_rx(struct xiic_i2c *i2c)
306{
307 u8 bytes_in_fifo;
308 int i;
309
310 bytes_in_fifo = xiic_getreg8(i2c, XIIC_RFO_REG_OFFSET) + 1;
311
312 dev_dbg(i2c->adap.dev.parent,
313 "%s entry, bytes in fifo: %d, msg: %d, SR: 0x%x, CR: 0x%x\n",
314 __func__, bytes_in_fifo, xiic_rx_space(i2c),
315 xiic_getreg8(i2c, XIIC_SR_REG_OFFSET),
316 xiic_getreg8(i2c, XIIC_CR_REG_OFFSET));
317
318 if (bytes_in_fifo > xiic_rx_space(i2c))
319 bytes_in_fifo = xiic_rx_space(i2c);
320
321 for (i = 0; i < bytes_in_fifo; i++)
322 i2c->rx_msg->buf[i2c->rx_pos++] =
323 xiic_getreg8(i2c, XIIC_DRR_REG_OFFSET);
324
325 xiic_setreg8(i2c, XIIC_RFD_REG_OFFSET,
326 (xiic_rx_space(i2c) > IIC_RX_FIFO_DEPTH) ?
327 IIC_RX_FIFO_DEPTH - 1 : xiic_rx_space(i2c) - 1);
328}
329
330static int xiic_tx_fifo_space(struct xiic_i2c *i2c)
331{
332 /* return the actual space left in the FIFO */
333 return IIC_TX_FIFO_DEPTH - xiic_getreg8(i2c, XIIC_TFO_REG_OFFSET) - 1;
334}
335
336static void xiic_fill_tx_fifo(struct xiic_i2c *i2c)
337{
338 u8 fifo_space = xiic_tx_fifo_space(i2c);
339 int len = xiic_tx_space(i2c);
340
341 len = (len > fifo_space) ? fifo_space : len;
342
343 dev_dbg(i2c->adap.dev.parent, "%s entry, len: %d, fifo space: %d\n",
344 __func__, len, fifo_space);
345
346 while (len--) {
347 u16 data = i2c->tx_msg->buf[i2c->tx_pos++];
348 if ((xiic_tx_space(i2c) == 0) && (i2c->nmsgs == 1)) {
349 /* last message in transfer -> STOP */
350 data |= XIIC_TX_DYN_STOP_MASK;
351 dev_dbg(i2c->adap.dev.parent, "%s TX STOP\n", __func__);
352 }
353 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET, data);
354 }
355}
356
357static void xiic_wakeup(struct xiic_i2c *i2c, int code)
358{
359 i2c->tx_msg = NULL;
360 i2c->rx_msg = NULL;
361 i2c->nmsgs = 0;
362 i2c->state = code;
363 wake_up(&i2c->wait);
364}
365
366static irqreturn_t xiic_process(int irq, void *dev_id)
367{
368 struct xiic_i2c *i2c = dev_id;
369 u32 pend, isr, ier;
370 u32 clr = 0;
371
372 /* Get the interrupt Status from the IPIF. There is no clearing of
373 * interrupts in the IPIF. Interrupts must be cleared at the source.
374 * To find which interrupts are pending; AND interrupts pending with
375 * interrupts masked.
376 */
377 mutex_lock(&i2c->lock);
378 isr = xiic_getreg32(i2c, XIIC_IISR_OFFSET);
379 ier = xiic_getreg32(i2c, XIIC_IIER_OFFSET);
380 pend = isr & ier;
381
382 dev_dbg(i2c->adap.dev.parent, "%s: IER: 0x%x, ISR: 0x%x, pend: 0x%x\n",
383 __func__, ier, isr, pend);
384 dev_dbg(i2c->adap.dev.parent, "%s: SR: 0x%x, msg: %p, nmsgs: %d\n",
385 __func__, xiic_getreg8(i2c, XIIC_SR_REG_OFFSET),
386 i2c->tx_msg, i2c->nmsgs);
387
388
389 /* Service requesting interrupt */
390 if ((pend & XIIC_INTR_ARB_LOST_MASK) ||
391 ((pend & XIIC_INTR_TX_ERROR_MASK) &&
392 !(pend & XIIC_INTR_RX_FULL_MASK))) {
393 /* bus arbritration lost, or...
394 * Transmit error _OR_ RX completed
395 * if this happens when RX_FULL is not set
396 * this is probably a TX error
397 */
398
399 dev_dbg(i2c->adap.dev.parent, "%s error\n", __func__);
400
401 /* dynamic mode seem to suffer from problems if we just flushes
402 * fifos and the next message is a TX with len 0 (only addr)
403 * reset the IP instead of just flush fifos
404 */
405 xiic_reinit(i2c);
406
407 if (i2c->rx_msg)
408 xiic_wakeup(i2c, STATE_ERROR);
409 if (i2c->tx_msg)
410 xiic_wakeup(i2c, STATE_ERROR);
411 }
412 if (pend & XIIC_INTR_RX_FULL_MASK) {
413 /* Receive register/FIFO is full */
414
415 clr |= XIIC_INTR_RX_FULL_MASK;
416 if (!i2c->rx_msg) {
417 dev_dbg(i2c->adap.dev.parent,
418 "%s unexpexted RX IRQ\n", __func__);
419 xiic_clear_rx_fifo(i2c);
420 goto out;
421 }
422
423 xiic_read_rx(i2c);
424 if (xiic_rx_space(i2c) == 0) {
425 /* this is the last part of the message */
426 i2c->rx_msg = NULL;
427
428 /* also clear TX error if there (RX complete) */
429 clr |= (isr & XIIC_INTR_TX_ERROR_MASK);
430
431 dev_dbg(i2c->adap.dev.parent,
432 "%s end of message, nmsgs: %d\n",
433 __func__, i2c->nmsgs);
434
435 /* send next message if this wasn't the last,
436 * otherwise the transfer will be finialise when
437 * receiving the bus not busy interrupt
438 */
439 if (i2c->nmsgs > 1) {
440 i2c->nmsgs--;
441 i2c->tx_msg++;
442 dev_dbg(i2c->adap.dev.parent,
443 "%s will start next...\n", __func__);
444
445 __xiic_start_xfer(i2c);
446 }
447 }
448 }
449 if (pend & XIIC_INTR_BNB_MASK) {
450 /* IIC bus has transitioned to not busy */
451 clr |= XIIC_INTR_BNB_MASK;
452
453 /* The bus is not busy, disable BusNotBusy interrupt */
454 xiic_irq_dis(i2c, XIIC_INTR_BNB_MASK);
455
456 if (!i2c->tx_msg)
457 goto out;
458
459 if ((i2c->nmsgs == 1) && !i2c->rx_msg &&
460 xiic_tx_space(i2c) == 0)
461 xiic_wakeup(i2c, STATE_DONE);
462 else
463 xiic_wakeup(i2c, STATE_ERROR);
464 }
465 if (pend & (XIIC_INTR_TX_EMPTY_MASK | XIIC_INTR_TX_HALF_MASK)) {
466 /* Transmit register/FIFO is empty or ½ empty */
467
468 clr |= (pend &
469 (XIIC_INTR_TX_EMPTY_MASK | XIIC_INTR_TX_HALF_MASK));
470
471 if (!i2c->tx_msg) {
472 dev_dbg(i2c->adap.dev.parent,
473 "%s unexpexted TX IRQ\n", __func__);
474 goto out;
475 }
476
477 xiic_fill_tx_fifo(i2c);
478
479 /* current message sent and there is space in the fifo */
480 if (!xiic_tx_space(i2c) && xiic_tx_fifo_space(i2c) >= 2) {
481 dev_dbg(i2c->adap.dev.parent,
482 "%s end of message sent, nmsgs: %d\n",
483 __func__, i2c->nmsgs);
484 if (i2c->nmsgs > 1) {
485 i2c->nmsgs--;
486 i2c->tx_msg++;
487 __xiic_start_xfer(i2c);
488 } else {
489 xiic_irq_dis(i2c, XIIC_INTR_TX_HALF_MASK);
490
491 dev_dbg(i2c->adap.dev.parent,
492 "%s Got TX IRQ but no more to do...\n",
493 __func__);
494 }
495 } else if (!xiic_tx_space(i2c) && (i2c->nmsgs == 1))
496 /* current frame is sent and is last,
497 * make sure to disable tx half
498 */
499 xiic_irq_dis(i2c, XIIC_INTR_TX_HALF_MASK);
500 }
501out:
502 dev_dbg(i2c->adap.dev.parent, "%s clr: 0x%x\n", __func__, clr);
503
504 xiic_setreg32(i2c, XIIC_IISR_OFFSET, clr);
505 mutex_unlock(&i2c->lock);
506 return IRQ_HANDLED;
507}
508
509static int xiic_bus_busy(struct xiic_i2c *i2c)
510{
511 u8 sr = xiic_getreg8(i2c, XIIC_SR_REG_OFFSET);
512
513 return (sr & XIIC_SR_BUS_BUSY_MASK) ? -EBUSY : 0;
514}
515
516static int xiic_busy(struct xiic_i2c *i2c)
517{
518 int tries = 3;
519 int err;
520
521 if (i2c->tx_msg)
522 return -EBUSY;
523
524 /* for instance if previous transfer was terminated due to TX error
525 * it might be that the bus is on it's way to become available
526 * give it at most 3 ms to wake
527 */
528 err = xiic_bus_busy(i2c);
529 while (err && tries--) {
530 msleep(1);
531 err = xiic_bus_busy(i2c);
532 }
533
534 return err;
535}
536
537static void xiic_start_recv(struct xiic_i2c *i2c)
538{
539 u8 rx_watermark;
540 struct i2c_msg *msg = i2c->rx_msg = i2c->tx_msg;
541
542 /* Clear and enable Rx full interrupt. */
543 xiic_irq_clr_en(i2c, XIIC_INTR_RX_FULL_MASK | XIIC_INTR_TX_ERROR_MASK);
544
545 /* we want to get all but last byte, because the TX_ERROR IRQ is used
546 * to inidicate error ACK on the address, and negative ack on the last
547 * received byte, so to not mix them receive all but last.
548 * In the case where there is only one byte to receive
549 * we can check if ERROR and RX full is set at the same time
550 */
551 rx_watermark = msg->len;
552 if (rx_watermark > IIC_RX_FIFO_DEPTH)
553 rx_watermark = IIC_RX_FIFO_DEPTH;
554 xiic_setreg8(i2c, XIIC_RFD_REG_OFFSET, rx_watermark - 1);
555
556 if (!(msg->flags & I2C_M_NOSTART))
557 /* write the address */
558 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET,
559 (msg->addr << 1) | XIIC_READ_OPERATION |
560 XIIC_TX_DYN_START_MASK);
561
562 xiic_irq_clr_en(i2c, XIIC_INTR_BNB_MASK);
563
564 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET,
565 msg->len | ((i2c->nmsgs == 1) ? XIIC_TX_DYN_STOP_MASK : 0));
566 if (i2c->nmsgs == 1)
567 /* very last, enable bus not busy as well */
568 xiic_irq_clr_en(i2c, XIIC_INTR_BNB_MASK);
569
570 /* the message is tx:ed */
571 i2c->tx_pos = msg->len;
572}
573
574static void xiic_start_send(struct xiic_i2c *i2c)
575{
576 struct i2c_msg *msg = i2c->tx_msg;
577
578 xiic_irq_clr(i2c, XIIC_INTR_TX_ERROR_MASK);
579
580 dev_dbg(i2c->adap.dev.parent, "%s entry, msg: %p, len: %d",
581 __func__, msg, msg->len);
582 dev_dbg(i2c->adap.dev.parent, "%s entry, ISR: 0x%x, CR: 0x%x\n",
583 __func__, xiic_getreg32(i2c, XIIC_IISR_OFFSET),
584 xiic_getreg8(i2c, XIIC_CR_REG_OFFSET));
585
586 if (!(msg->flags & I2C_M_NOSTART)) {
587 /* write the address */
588 u16 data = ((msg->addr << 1) & 0xfe) | XIIC_WRITE_OPERATION |
589 XIIC_TX_DYN_START_MASK;
590 if ((i2c->nmsgs == 1) && msg->len == 0)
591 /* no data and last message -> add STOP */
592 data |= XIIC_TX_DYN_STOP_MASK;
593
594 xiic_setreg16(i2c, XIIC_DTR_REG_OFFSET, data);
595 }
596
597 xiic_fill_tx_fifo(i2c);
598
599 /* Clear any pending Tx empty, Tx Error and then enable them. */
600 xiic_irq_clr_en(i2c, XIIC_INTR_TX_EMPTY_MASK | XIIC_INTR_TX_ERROR_MASK |
601 XIIC_INTR_BNB_MASK);
602}
603
604static irqreturn_t xiic_isr(int irq, void *dev_id)
605{
606 struct xiic_i2c *i2c = dev_id;
607 u32 pend, isr, ier;
608 irqreturn_t ret = IRQ_NONE;
609 /* Do not processes a devices interrupts if the device has no
610 * interrupts pending
611 */
612
613 dev_dbg(i2c->adap.dev.parent, "%s entry\n", __func__);
614
615 isr = xiic_getreg32(i2c, XIIC_IISR_OFFSET);
616 ier = xiic_getreg32(i2c, XIIC_IIER_OFFSET);
617 pend = isr & ier;
618 if (pend)
619 ret = IRQ_WAKE_THREAD;
620
621 return ret;
622}
623
624static void __xiic_start_xfer(struct xiic_i2c *i2c)
625{
626 int first = 1;
627 int fifo_space = xiic_tx_fifo_space(i2c);
628 dev_dbg(i2c->adap.dev.parent, "%s entry, msg: %p, fifos space: %d\n",
629 __func__, i2c->tx_msg, fifo_space);
630
631 if (!i2c->tx_msg)
632 return;
633
634 i2c->rx_pos = 0;
635 i2c->tx_pos = 0;
636 i2c->state = STATE_START;
637 while ((fifo_space >= 2) && (first || (i2c->nmsgs > 1))) {
638 if (!first) {
639 i2c->nmsgs--;
640 i2c->tx_msg++;
641 i2c->tx_pos = 0;
642 } else
643 first = 0;
644
645 if (i2c->tx_msg->flags & I2C_M_RD) {
646 /* we dont date putting several reads in the FIFO */
647 xiic_start_recv(i2c);
648 return;
649 } else {
650 xiic_start_send(i2c);
651 if (xiic_tx_space(i2c) != 0) {
652 /* the message could not be completely sent */
653 break;
654 }
655 }
656
657 fifo_space = xiic_tx_fifo_space(i2c);
658 }
659
660 /* there are more messages or the current one could not be completely
661 * put into the FIFO, also enable the half empty interrupt
662 */
663 if (i2c->nmsgs > 1 || xiic_tx_space(i2c))
664 xiic_irq_clr_en(i2c, XIIC_INTR_TX_HALF_MASK);
665
666}
667
668static void xiic_start_xfer(struct xiic_i2c *i2c)
669{
670 mutex_lock(&i2c->lock);
671 xiic_reinit(i2c);
672 __xiic_start_xfer(i2c);
673 mutex_unlock(&i2c->lock);
674}
675
676static int xiic_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
677{
678 struct xiic_i2c *i2c = i2c_get_adapdata(adap);
679 int err;
680
681 dev_dbg(adap->dev.parent, "%s entry SR: 0x%x\n", __func__,
682 xiic_getreg8(i2c, XIIC_SR_REG_OFFSET));
683
684 err = pm_runtime_get_sync(i2c->dev);
685 if (err < 0)
686 return err;
687
688 err = xiic_busy(i2c);
689 if (err)
690 goto out;
691
692 i2c->tx_msg = msgs;
693 i2c->nmsgs = num;
694
695 xiic_start_xfer(i2c);
696
697 if (wait_event_timeout(i2c->wait, (i2c->state == STATE_ERROR) ||
698 (i2c->state == STATE_DONE), HZ)) {
699 err = (i2c->state == STATE_DONE) ? num : -EIO;
700 goto out;
701 } else {
702 i2c->tx_msg = NULL;
703 i2c->rx_msg = NULL;
704 i2c->nmsgs = 0;
705 err = -ETIMEDOUT;
706 goto out;
707 }
708out:
709 pm_runtime_mark_last_busy(i2c->dev);
710 pm_runtime_put_autosuspend(i2c->dev);
711 return err;
712}
713
714static u32 xiic_func(struct i2c_adapter *adap)
715{
716 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
717}
718
719static const struct i2c_algorithm xiic_algorithm = {
720 .master_xfer = xiic_xfer,
721 .functionality = xiic_func,
722};
723
724static struct i2c_adapter xiic_adapter = {
725 .owner = THIS_MODULE,
726 .name = DRIVER_NAME,
727 .class = I2C_CLASS_DEPRECATED,
728 .algo = &xiic_algorithm,
729};
730
731
732static int xiic_i2c_probe(struct platform_device *pdev)
733{
734 struct xiic_i2c *i2c;
735 struct xiic_i2c_platform_data *pdata;
736 struct resource *res;
737 int ret, irq;
738 u8 i;
739 u32 sr;
740
741 i2c = devm_kzalloc(&pdev->dev, sizeof(*i2c), GFP_KERNEL);
742 if (!i2c)
743 return -ENOMEM;
744
745 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
746 i2c->base = devm_ioremap_resource(&pdev->dev, res);
747 if (IS_ERR(i2c->base))
748 return PTR_ERR(i2c->base);
749
750 irq = platform_get_irq(pdev, 0);
751 if (irq < 0)
752 return irq;
753
754 pdata = dev_get_platdata(&pdev->dev);
755
756 /* hook up driver to tree */
757 platform_set_drvdata(pdev, i2c);
758 i2c->adap = xiic_adapter;
759 i2c_set_adapdata(&i2c->adap, i2c);
760 i2c->adap.dev.parent = &pdev->dev;
761 i2c->adap.dev.of_node = pdev->dev.of_node;
762
763 mutex_init(&i2c->lock);
764 init_waitqueue_head(&i2c->wait);
765
766 i2c->clk = devm_clk_get(&pdev->dev, NULL);
767 if (IS_ERR(i2c->clk)) {
768 dev_err(&pdev->dev, "input clock not found.\n");
769 return PTR_ERR(i2c->clk);
770 }
771 ret = clk_prepare_enable(i2c->clk);
772 if (ret) {
773 dev_err(&pdev->dev, "Unable to enable clock.\n");
774 return ret;
775 }
776 i2c->dev = &pdev->dev;
777 pm_runtime_enable(i2c->dev);
778 pm_runtime_set_autosuspend_delay(i2c->dev, XIIC_PM_TIMEOUT);
779 pm_runtime_use_autosuspend(i2c->dev);
780 pm_runtime_set_active(i2c->dev);
781 ret = devm_request_threaded_irq(&pdev->dev, irq, xiic_isr,
782 xiic_process, IRQF_ONESHOT,
783 pdev->name, i2c);
784
785 if (ret < 0) {
786 dev_err(&pdev->dev, "Cannot claim IRQ\n");
787 goto err_clk_dis;
788 }
789
790 /*
791 * Detect endianness
792 * Try to reset the TX FIFO. Then check the EMPTY flag. If it is not
793 * set, assume that the endianness was wrong and swap.
794 */
795 i2c->endianness = LITTLE;
796 xiic_setreg32(i2c, XIIC_CR_REG_OFFSET, XIIC_CR_TX_FIFO_RESET_MASK);
797 /* Reset is cleared in xiic_reinit */
798 sr = xiic_getreg32(i2c, XIIC_SR_REG_OFFSET);
799 if (!(sr & XIIC_SR_TX_FIFO_EMPTY_MASK))
800 i2c->endianness = BIG;
801
802 xiic_reinit(i2c);
803
804 /* add i2c adapter to i2c tree */
805 ret = i2c_add_adapter(&i2c->adap);
806 if (ret) {
807 xiic_deinit(i2c);
808 goto err_clk_dis;
809 }
810
811 if (pdata) {
812 /* add in known devices to the bus */
813 for (i = 0; i < pdata->num_devices; i++)
814 i2c_new_device(&i2c->adap, pdata->devices + i);
815 }
816
817 return 0;
818
819err_clk_dis:
820 pm_runtime_set_suspended(&pdev->dev);
821 pm_runtime_disable(&pdev->dev);
822 clk_disable_unprepare(i2c->clk);
823 return ret;
824}
825
826static int xiic_i2c_remove(struct platform_device *pdev)
827{
828 struct xiic_i2c *i2c = platform_get_drvdata(pdev);
829 int ret;
830
831 /* remove adapter & data */
832 i2c_del_adapter(&i2c->adap);
833
834 ret = clk_prepare_enable(i2c->clk);
835 if (ret) {
836 dev_err(&pdev->dev, "Unable to enable clock.\n");
837 return ret;
838 }
839 xiic_deinit(i2c);
840 clk_disable_unprepare(i2c->clk);
841 pm_runtime_disable(&pdev->dev);
842
843 return 0;
844}
845
846#if defined(CONFIG_OF)
847static const struct of_device_id xiic_of_match[] = {
848 { .compatible = "xlnx,xps-iic-2.00.a", },
849 {},
850};
851MODULE_DEVICE_TABLE(of, xiic_of_match);
852#endif
853
854static int __maybe_unused cdns_i2c_runtime_suspend(struct device *dev)
855{
856 struct platform_device *pdev = to_platform_device(dev);
857 struct xiic_i2c *i2c = platform_get_drvdata(pdev);
858
859 clk_disable(i2c->clk);
860
861 return 0;
862}
863
864static int __maybe_unused cdns_i2c_runtime_resume(struct device *dev)
865{
866 struct platform_device *pdev = to_platform_device(dev);
867 struct xiic_i2c *i2c = platform_get_drvdata(pdev);
868 int ret;
869
870 ret = clk_enable(i2c->clk);
871 if (ret) {
872 dev_err(dev, "Cannot enable clock.\n");
873 return ret;
874 }
875
876 return 0;
877}
878
879static const struct dev_pm_ops xiic_dev_pm_ops = {
880 SET_RUNTIME_PM_OPS(cdns_i2c_runtime_suspend,
881 cdns_i2c_runtime_resume, NULL)
882};
883static struct platform_driver xiic_i2c_driver = {
884 .probe = xiic_i2c_probe,
885 .remove = xiic_i2c_remove,
886 .driver = {
887 .name = DRIVER_NAME,
888 .of_match_table = of_match_ptr(xiic_of_match),
889 .pm = &xiic_dev_pm_ops,
890 },
891};
892
893module_platform_driver(xiic_i2c_driver);
894
895MODULE_AUTHOR("info@mocean-labs.com");
896MODULE_DESCRIPTION("Xilinx I2C bus driver");
897MODULE_LICENSE("GPL v2");
898MODULE_ALIAS("platform:"DRIVER_NAME);