Loading...
1/*
2 * I2C bus driver for the Cadence I2C controller.
3 *
4 * Copyright (C) 2009 - 2014 Xilinx, Inc.
5 *
6 * This program is free software; you can redistribute it
7 * and/or modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation;
9 * either version 2 of the License, or (at your option) any
10 * later version.
11 */
12
13#include <linux/clk.h>
14#include <linux/delay.h>
15#include <linux/i2c.h>
16#include <linux/interrupt.h>
17#include <linux/io.h>
18#include <linux/module.h>
19#include <linux/platform_device.h>
20#include <linux/of.h>
21#include <linux/pm_runtime.h>
22
23/* Register offsets for the I2C device. */
24#define CDNS_I2C_CR_OFFSET 0x00 /* Control Register, RW */
25#define CDNS_I2C_SR_OFFSET 0x04 /* Status Register, RO */
26#define CDNS_I2C_ADDR_OFFSET 0x08 /* I2C Address Register, RW */
27#define CDNS_I2C_DATA_OFFSET 0x0C /* I2C Data Register, RW */
28#define CDNS_I2C_ISR_OFFSET 0x10 /* IRQ Status Register, RW */
29#define CDNS_I2C_XFER_SIZE_OFFSET 0x14 /* Transfer Size Register, RW */
30#define CDNS_I2C_TIME_OUT_OFFSET 0x1C /* Time Out Register, RW */
31#define CDNS_I2C_IER_OFFSET 0x24 /* IRQ Enable Register, WO */
32#define CDNS_I2C_IDR_OFFSET 0x28 /* IRQ Disable Register, WO */
33
34/* Control Register Bit mask definitions */
35#define CDNS_I2C_CR_HOLD BIT(4) /* Hold Bus bit */
36#define CDNS_I2C_CR_ACK_EN BIT(3)
37#define CDNS_I2C_CR_NEA BIT(2)
38#define CDNS_I2C_CR_MS BIT(1)
39/* Read or Write Master transfer 0 = Transmitter, 1 = Receiver */
40#define CDNS_I2C_CR_RW BIT(0)
41/* 1 = Auto init FIFO to zeroes */
42#define CDNS_I2C_CR_CLR_FIFO BIT(6)
43#define CDNS_I2C_CR_DIVA_SHIFT 14
44#define CDNS_I2C_CR_DIVA_MASK (3 << CDNS_I2C_CR_DIVA_SHIFT)
45#define CDNS_I2C_CR_DIVB_SHIFT 8
46#define CDNS_I2C_CR_DIVB_MASK (0x3f << CDNS_I2C_CR_DIVB_SHIFT)
47
48/* Status Register Bit mask definitions */
49#define CDNS_I2C_SR_BA BIT(8)
50#define CDNS_I2C_SR_RXDV BIT(5)
51
52/*
53 * I2C Address Register Bit mask definitions
54 * Normal addressing mode uses [6:0] bits. Extended addressing mode uses [9:0]
55 * bits. A write access to this register always initiates a transfer if the I2C
56 * is in master mode.
57 */
58#define CDNS_I2C_ADDR_MASK 0x000003FF /* I2C Address Mask */
59
60/*
61 * I2C Interrupt Registers Bit mask definitions
62 * All the four interrupt registers (Status/Mask/Enable/Disable) have the same
63 * bit definitions.
64 */
65#define CDNS_I2C_IXR_ARB_LOST BIT(9)
66#define CDNS_I2C_IXR_RX_UNF BIT(7)
67#define CDNS_I2C_IXR_TX_OVF BIT(6)
68#define CDNS_I2C_IXR_RX_OVF BIT(5)
69#define CDNS_I2C_IXR_SLV_RDY BIT(4)
70#define CDNS_I2C_IXR_TO BIT(3)
71#define CDNS_I2C_IXR_NACK BIT(2)
72#define CDNS_I2C_IXR_DATA BIT(1)
73#define CDNS_I2C_IXR_COMP BIT(0)
74
75#define CDNS_I2C_IXR_ALL_INTR_MASK (CDNS_I2C_IXR_ARB_LOST | \
76 CDNS_I2C_IXR_RX_UNF | \
77 CDNS_I2C_IXR_TX_OVF | \
78 CDNS_I2C_IXR_RX_OVF | \
79 CDNS_I2C_IXR_SLV_RDY | \
80 CDNS_I2C_IXR_TO | \
81 CDNS_I2C_IXR_NACK | \
82 CDNS_I2C_IXR_DATA | \
83 CDNS_I2C_IXR_COMP)
84
85#define CDNS_I2C_IXR_ERR_INTR_MASK (CDNS_I2C_IXR_ARB_LOST | \
86 CDNS_I2C_IXR_RX_UNF | \
87 CDNS_I2C_IXR_TX_OVF | \
88 CDNS_I2C_IXR_RX_OVF | \
89 CDNS_I2C_IXR_NACK)
90
91#define CDNS_I2C_ENABLED_INTR_MASK (CDNS_I2C_IXR_ARB_LOST | \
92 CDNS_I2C_IXR_RX_UNF | \
93 CDNS_I2C_IXR_TX_OVF | \
94 CDNS_I2C_IXR_RX_OVF | \
95 CDNS_I2C_IXR_NACK | \
96 CDNS_I2C_IXR_DATA | \
97 CDNS_I2C_IXR_COMP)
98
99#define CDNS_I2C_TIMEOUT msecs_to_jiffies(1000)
100/* timeout for pm runtime autosuspend */
101#define CNDS_I2C_PM_TIMEOUT 1000 /* ms */
102
103#define CDNS_I2C_FIFO_DEPTH 16
104/* FIFO depth at which the DATA interrupt occurs */
105#define CDNS_I2C_DATA_INTR_DEPTH (CDNS_I2C_FIFO_DEPTH - 2)
106#define CDNS_I2C_MAX_TRANSFER_SIZE 255
107/* Transfer size in multiples of data interrupt depth */
108#define CDNS_I2C_TRANSFER_SIZE (CDNS_I2C_MAX_TRANSFER_SIZE - 3)
109
110#define DRIVER_NAME "cdns-i2c"
111
112#define CDNS_I2C_SPEED_MAX 400000
113#define CDNS_I2C_SPEED_DEFAULT 100000
114
115#define CDNS_I2C_DIVA_MAX 4
116#define CDNS_I2C_DIVB_MAX 64
117
118#define CDNS_I2C_TIMEOUT_MAX 0xFF
119
120#define CDNS_I2C_BROKEN_HOLD_BIT BIT(0)
121
122#define cdns_i2c_readreg(offset) readl_relaxed(id->membase + offset)
123#define cdns_i2c_writereg(val, offset) writel_relaxed(val, id->membase + offset)
124
125/**
126 * struct cdns_i2c - I2C device private data structure
127 *
128 * @dev: Pointer to device structure
129 * @membase: Base address of the I2C device
130 * @adap: I2C adapter instance
131 * @p_msg: Message pointer
132 * @err_status: Error status in Interrupt Status Register
133 * @xfer_done: Transfer complete status
134 * @p_send_buf: Pointer to transmit buffer
135 * @p_recv_buf: Pointer to receive buffer
136 * @send_count: Number of bytes still expected to send
137 * @recv_count: Number of bytes still expected to receive
138 * @curr_recv_count: Number of bytes to be received in current transfer
139 * @irq: IRQ number
140 * @input_clk: Input clock to I2C controller
141 * @i2c_clk: Maximum I2C clock speed
142 * @bus_hold_flag: Flag used in repeated start for clearing HOLD bit
143 * @clk: Pointer to struct clk
144 * @clk_rate_change_nb: Notifier block for clock rate changes
145 * @quirks: flag for broken hold bit usage in r1p10
146 */
147struct cdns_i2c {
148 struct device *dev;
149 void __iomem *membase;
150 struct i2c_adapter adap;
151 struct i2c_msg *p_msg;
152 int err_status;
153 struct completion xfer_done;
154 unsigned char *p_send_buf;
155 unsigned char *p_recv_buf;
156 unsigned int send_count;
157 unsigned int recv_count;
158 unsigned int curr_recv_count;
159 int irq;
160 unsigned long input_clk;
161 unsigned int i2c_clk;
162 unsigned int bus_hold_flag;
163 struct clk *clk;
164 struct notifier_block clk_rate_change_nb;
165 u32 quirks;
166};
167
168struct cdns_platform_data {
169 u32 quirks;
170};
171
172#define to_cdns_i2c(_nb) container_of(_nb, struct cdns_i2c, \
173 clk_rate_change_nb)
174
175/**
176 * cdns_i2c_clear_bus_hold - Clear bus hold bit
177 * @id: Pointer to driver data struct
178 *
179 * Helper to clear the controller's bus hold bit.
180 */
181static void cdns_i2c_clear_bus_hold(struct cdns_i2c *id)
182{
183 u32 reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
184 if (reg & CDNS_I2C_CR_HOLD)
185 cdns_i2c_writereg(reg & ~CDNS_I2C_CR_HOLD, CDNS_I2C_CR_OFFSET);
186}
187
188static inline bool cdns_is_holdquirk(struct cdns_i2c *id, bool hold_wrkaround)
189{
190 return (hold_wrkaround &&
191 (id->curr_recv_count == CDNS_I2C_FIFO_DEPTH + 1));
192}
193
194/**
195 * cdns_i2c_isr - Interrupt handler for the I2C device
196 * @irq: irq number for the I2C device
197 * @ptr: void pointer to cdns_i2c structure
198 *
199 * This function handles the data interrupt, transfer complete interrupt and
200 * the error interrupts of the I2C device.
201 *
202 * Return: IRQ_HANDLED always
203 */
204static irqreturn_t cdns_i2c_isr(int irq, void *ptr)
205{
206 unsigned int isr_status, avail_bytes, updatetx;
207 unsigned int bytes_to_send;
208 bool hold_quirk;
209 struct cdns_i2c *id = ptr;
210 /* Signal completion only after everything is updated */
211 int done_flag = 0;
212 irqreturn_t status = IRQ_NONE;
213
214 isr_status = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
215 cdns_i2c_writereg(isr_status, CDNS_I2C_ISR_OFFSET);
216
217 /* Handling nack and arbitration lost interrupt */
218 if (isr_status & (CDNS_I2C_IXR_NACK | CDNS_I2C_IXR_ARB_LOST)) {
219 done_flag = 1;
220 status = IRQ_HANDLED;
221 }
222
223 /*
224 * Check if transfer size register needs to be updated again for a
225 * large data receive operation.
226 */
227 updatetx = 0;
228 if (id->recv_count > id->curr_recv_count)
229 updatetx = 1;
230
231 hold_quirk = (id->quirks & CDNS_I2C_BROKEN_HOLD_BIT) && updatetx;
232
233 /* When receiving, handle data interrupt and completion interrupt */
234 if (id->p_recv_buf &&
235 ((isr_status & CDNS_I2C_IXR_COMP) ||
236 (isr_status & CDNS_I2C_IXR_DATA))) {
237 /* Read data if receive data valid is set */
238 while (cdns_i2c_readreg(CDNS_I2C_SR_OFFSET) &
239 CDNS_I2C_SR_RXDV) {
240 /*
241 * Clear hold bit that was set for FIFO control if
242 * RX data left is less than FIFO depth, unless
243 * repeated start is selected.
244 */
245 if ((id->recv_count < CDNS_I2C_FIFO_DEPTH) &&
246 !id->bus_hold_flag)
247 cdns_i2c_clear_bus_hold(id);
248
249 *(id->p_recv_buf)++ =
250 cdns_i2c_readreg(CDNS_I2C_DATA_OFFSET);
251 id->recv_count--;
252 id->curr_recv_count--;
253
254 if (cdns_is_holdquirk(id, hold_quirk))
255 break;
256 }
257
258 /*
259 * The controller sends NACK to the slave when transfer size
260 * register reaches zero without considering the HOLD bit.
261 * This workaround is implemented for large data transfers to
262 * maintain transfer size non-zero while performing a large
263 * receive operation.
264 */
265 if (cdns_is_holdquirk(id, hold_quirk)) {
266 /* wait while fifo is full */
267 while (cdns_i2c_readreg(CDNS_I2C_XFER_SIZE_OFFSET) !=
268 (id->curr_recv_count - CDNS_I2C_FIFO_DEPTH))
269 ;
270
271 /*
272 * Check number of bytes to be received against maximum
273 * transfer size and update register accordingly.
274 */
275 if (((int)(id->recv_count) - CDNS_I2C_FIFO_DEPTH) >
276 CDNS_I2C_TRANSFER_SIZE) {
277 cdns_i2c_writereg(CDNS_I2C_TRANSFER_SIZE,
278 CDNS_I2C_XFER_SIZE_OFFSET);
279 id->curr_recv_count = CDNS_I2C_TRANSFER_SIZE +
280 CDNS_I2C_FIFO_DEPTH;
281 } else {
282 cdns_i2c_writereg(id->recv_count -
283 CDNS_I2C_FIFO_DEPTH,
284 CDNS_I2C_XFER_SIZE_OFFSET);
285 id->curr_recv_count = id->recv_count;
286 }
287 } else if (id->recv_count && !hold_quirk &&
288 !id->curr_recv_count) {
289
290 /* Set the slave address in address register*/
291 cdns_i2c_writereg(id->p_msg->addr & CDNS_I2C_ADDR_MASK,
292 CDNS_I2C_ADDR_OFFSET);
293
294 if (id->recv_count > CDNS_I2C_TRANSFER_SIZE) {
295 cdns_i2c_writereg(CDNS_I2C_TRANSFER_SIZE,
296 CDNS_I2C_XFER_SIZE_OFFSET);
297 id->curr_recv_count = CDNS_I2C_TRANSFER_SIZE;
298 } else {
299 cdns_i2c_writereg(id->recv_count,
300 CDNS_I2C_XFER_SIZE_OFFSET);
301 id->curr_recv_count = id->recv_count;
302 }
303 }
304
305 /* Clear hold (if not repeated start) and signal completion */
306 if ((isr_status & CDNS_I2C_IXR_COMP) && !id->recv_count) {
307 if (!id->bus_hold_flag)
308 cdns_i2c_clear_bus_hold(id);
309 done_flag = 1;
310 }
311
312 status = IRQ_HANDLED;
313 }
314
315 /* When sending, handle transfer complete interrupt */
316 if ((isr_status & CDNS_I2C_IXR_COMP) && !id->p_recv_buf) {
317 /*
318 * If there is more data to be sent, calculate the
319 * space available in FIFO and fill with that many bytes.
320 */
321 if (id->send_count) {
322 avail_bytes = CDNS_I2C_FIFO_DEPTH -
323 cdns_i2c_readreg(CDNS_I2C_XFER_SIZE_OFFSET);
324 if (id->send_count > avail_bytes)
325 bytes_to_send = avail_bytes;
326 else
327 bytes_to_send = id->send_count;
328
329 while (bytes_to_send--) {
330 cdns_i2c_writereg(
331 (*(id->p_send_buf)++),
332 CDNS_I2C_DATA_OFFSET);
333 id->send_count--;
334 }
335 } else {
336 /*
337 * Signal the completion of transaction and
338 * clear the hold bus bit if there are no
339 * further messages to be processed.
340 */
341 done_flag = 1;
342 }
343 if (!id->send_count && !id->bus_hold_flag)
344 cdns_i2c_clear_bus_hold(id);
345
346 status = IRQ_HANDLED;
347 }
348
349 /* Update the status for errors */
350 id->err_status = isr_status & CDNS_I2C_IXR_ERR_INTR_MASK;
351 if (id->err_status)
352 status = IRQ_HANDLED;
353
354 if (done_flag)
355 complete(&id->xfer_done);
356
357 return status;
358}
359
360/**
361 * cdns_i2c_mrecv - Prepare and start a master receive operation
362 * @id: pointer to the i2c device structure
363 */
364static void cdns_i2c_mrecv(struct cdns_i2c *id)
365{
366 unsigned int ctrl_reg;
367 unsigned int isr_status;
368
369 id->p_recv_buf = id->p_msg->buf;
370 id->recv_count = id->p_msg->len;
371
372 /* Put the controller in master receive mode and clear the FIFO */
373 ctrl_reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
374 ctrl_reg |= CDNS_I2C_CR_RW | CDNS_I2C_CR_CLR_FIFO;
375
376 if (id->p_msg->flags & I2C_M_RECV_LEN)
377 id->recv_count = I2C_SMBUS_BLOCK_MAX + 1;
378
379 id->curr_recv_count = id->recv_count;
380
381 /*
382 * Check for the message size against FIFO depth and set the
383 * 'hold bus' bit if it is greater than FIFO depth.
384 */
385 if (id->recv_count > CDNS_I2C_FIFO_DEPTH)
386 ctrl_reg |= CDNS_I2C_CR_HOLD;
387
388 cdns_i2c_writereg(ctrl_reg, CDNS_I2C_CR_OFFSET);
389
390 /* Clear the interrupts in interrupt status register */
391 isr_status = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
392 cdns_i2c_writereg(isr_status, CDNS_I2C_ISR_OFFSET);
393
394 /*
395 * The no. of bytes to receive is checked against the limit of
396 * max transfer size. Set transfer size register with no of bytes
397 * receive if it is less than transfer size and transfer size if
398 * it is more. Enable the interrupts.
399 */
400 if (id->recv_count > CDNS_I2C_TRANSFER_SIZE) {
401 cdns_i2c_writereg(CDNS_I2C_TRANSFER_SIZE,
402 CDNS_I2C_XFER_SIZE_OFFSET);
403 id->curr_recv_count = CDNS_I2C_TRANSFER_SIZE;
404 } else {
405 cdns_i2c_writereg(id->recv_count, CDNS_I2C_XFER_SIZE_OFFSET);
406 }
407
408 /* Clear the bus hold flag if bytes to receive is less than FIFO size */
409 if (!id->bus_hold_flag &&
410 ((id->p_msg->flags & I2C_M_RECV_LEN) != I2C_M_RECV_LEN) &&
411 (id->recv_count <= CDNS_I2C_FIFO_DEPTH))
412 cdns_i2c_clear_bus_hold(id);
413 /* Set the slave address in address register - triggers operation */
414 cdns_i2c_writereg(id->p_msg->addr & CDNS_I2C_ADDR_MASK,
415 CDNS_I2C_ADDR_OFFSET);
416 cdns_i2c_writereg(CDNS_I2C_ENABLED_INTR_MASK, CDNS_I2C_IER_OFFSET);
417}
418
419/**
420 * cdns_i2c_msend - Prepare and start a master send operation
421 * @id: pointer to the i2c device
422 */
423static void cdns_i2c_msend(struct cdns_i2c *id)
424{
425 unsigned int avail_bytes;
426 unsigned int bytes_to_send;
427 unsigned int ctrl_reg;
428 unsigned int isr_status;
429
430 id->p_recv_buf = NULL;
431 id->p_send_buf = id->p_msg->buf;
432 id->send_count = id->p_msg->len;
433
434 /* Set the controller in Master transmit mode and clear the FIFO. */
435 ctrl_reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
436 ctrl_reg &= ~CDNS_I2C_CR_RW;
437 ctrl_reg |= CDNS_I2C_CR_CLR_FIFO;
438
439 /*
440 * Check for the message size against FIFO depth and set the
441 * 'hold bus' bit if it is greater than FIFO depth.
442 */
443 if (id->send_count > CDNS_I2C_FIFO_DEPTH)
444 ctrl_reg |= CDNS_I2C_CR_HOLD;
445 cdns_i2c_writereg(ctrl_reg, CDNS_I2C_CR_OFFSET);
446
447 /* Clear the interrupts in interrupt status register. */
448 isr_status = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
449 cdns_i2c_writereg(isr_status, CDNS_I2C_ISR_OFFSET);
450
451 /*
452 * Calculate the space available in FIFO. Check the message length
453 * against the space available, and fill the FIFO accordingly.
454 * Enable the interrupts.
455 */
456 avail_bytes = CDNS_I2C_FIFO_DEPTH -
457 cdns_i2c_readreg(CDNS_I2C_XFER_SIZE_OFFSET);
458
459 if (id->send_count > avail_bytes)
460 bytes_to_send = avail_bytes;
461 else
462 bytes_to_send = id->send_count;
463
464 while (bytes_to_send--) {
465 cdns_i2c_writereg((*(id->p_send_buf)++), CDNS_I2C_DATA_OFFSET);
466 id->send_count--;
467 }
468
469 /*
470 * Clear the bus hold flag if there is no more data
471 * and if it is the last message.
472 */
473 if (!id->bus_hold_flag && !id->send_count)
474 cdns_i2c_clear_bus_hold(id);
475 /* Set the slave address in address register - triggers operation. */
476 cdns_i2c_writereg(id->p_msg->addr & CDNS_I2C_ADDR_MASK,
477 CDNS_I2C_ADDR_OFFSET);
478
479 cdns_i2c_writereg(CDNS_I2C_ENABLED_INTR_MASK, CDNS_I2C_IER_OFFSET);
480}
481
482/**
483 * cdns_i2c_master_reset - Reset the interface
484 * @adap: pointer to the i2c adapter driver instance
485 *
486 * This function cleanup the fifos, clear the hold bit and status
487 * and disable the interrupts.
488 */
489static void cdns_i2c_master_reset(struct i2c_adapter *adap)
490{
491 struct cdns_i2c *id = adap->algo_data;
492 u32 regval;
493
494 /* Disable the interrupts */
495 cdns_i2c_writereg(CDNS_I2C_IXR_ALL_INTR_MASK, CDNS_I2C_IDR_OFFSET);
496 /* Clear the hold bit and fifos */
497 regval = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
498 regval &= ~CDNS_I2C_CR_HOLD;
499 regval |= CDNS_I2C_CR_CLR_FIFO;
500 cdns_i2c_writereg(regval, CDNS_I2C_CR_OFFSET);
501 /* Update the transfercount register to zero */
502 cdns_i2c_writereg(0, CDNS_I2C_XFER_SIZE_OFFSET);
503 /* Clear the interupt status register */
504 regval = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
505 cdns_i2c_writereg(regval, CDNS_I2C_ISR_OFFSET);
506 /* Clear the status register */
507 regval = cdns_i2c_readreg(CDNS_I2C_SR_OFFSET);
508 cdns_i2c_writereg(regval, CDNS_I2C_SR_OFFSET);
509}
510
511static int cdns_i2c_process_msg(struct cdns_i2c *id, struct i2c_msg *msg,
512 struct i2c_adapter *adap)
513{
514 unsigned long time_left;
515 u32 reg;
516
517 id->p_msg = msg;
518 id->err_status = 0;
519 reinit_completion(&id->xfer_done);
520
521 /* Check for the TEN Bit mode on each msg */
522 reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
523 if (msg->flags & I2C_M_TEN) {
524 if (reg & CDNS_I2C_CR_NEA)
525 cdns_i2c_writereg(reg & ~CDNS_I2C_CR_NEA,
526 CDNS_I2C_CR_OFFSET);
527 } else {
528 if (!(reg & CDNS_I2C_CR_NEA))
529 cdns_i2c_writereg(reg | CDNS_I2C_CR_NEA,
530 CDNS_I2C_CR_OFFSET);
531 }
532
533 /* Check for the R/W flag on each msg */
534 if (msg->flags & I2C_M_RD)
535 cdns_i2c_mrecv(id);
536 else
537 cdns_i2c_msend(id);
538
539 /* Wait for the signal of completion */
540 time_left = wait_for_completion_timeout(&id->xfer_done, adap->timeout);
541 if (time_left == 0) {
542 cdns_i2c_master_reset(adap);
543 dev_err(id->adap.dev.parent,
544 "timeout waiting on completion\n");
545 return -ETIMEDOUT;
546 }
547
548 cdns_i2c_writereg(CDNS_I2C_IXR_ALL_INTR_MASK,
549 CDNS_I2C_IDR_OFFSET);
550
551 /* If it is bus arbitration error, try again */
552 if (id->err_status & CDNS_I2C_IXR_ARB_LOST)
553 return -EAGAIN;
554
555 return 0;
556}
557
558/**
559 * cdns_i2c_master_xfer - The main i2c transfer function
560 * @adap: pointer to the i2c adapter driver instance
561 * @msgs: pointer to the i2c message structure
562 * @num: the number of messages to transfer
563 *
564 * Initiates the send/recv activity based on the transfer message received.
565 *
566 * Return: number of msgs processed on success, negative error otherwise
567 */
568static int cdns_i2c_master_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
569 int num)
570{
571 int ret, count;
572 u32 reg;
573 struct cdns_i2c *id = adap->algo_data;
574 bool hold_quirk;
575
576 ret = pm_runtime_get_sync(id->dev);
577 if (ret < 0)
578 return ret;
579 /* Check if the bus is free */
580 if (cdns_i2c_readreg(CDNS_I2C_SR_OFFSET) & CDNS_I2C_SR_BA) {
581 ret = -EAGAIN;
582 goto out;
583 }
584
585 hold_quirk = !!(id->quirks & CDNS_I2C_BROKEN_HOLD_BIT);
586 /*
587 * Set the flag to one when multiple messages are to be
588 * processed with a repeated start.
589 */
590 if (num > 1) {
591 /*
592 * This controller does not give completion interrupt after a
593 * master receive message if HOLD bit is set (repeated start),
594 * resulting in SW timeout. Hence, if a receive message is
595 * followed by any other message, an error is returned
596 * indicating that this sequence is not supported.
597 */
598 for (count = 0; (count < num - 1 && hold_quirk); count++) {
599 if (msgs[count].flags & I2C_M_RD) {
600 dev_warn(adap->dev.parent,
601 "Can't do repeated start after a receive message\n");
602 ret = -EOPNOTSUPP;
603 goto out;
604 }
605 }
606 id->bus_hold_flag = 1;
607 reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
608 reg |= CDNS_I2C_CR_HOLD;
609 cdns_i2c_writereg(reg, CDNS_I2C_CR_OFFSET);
610 } else {
611 id->bus_hold_flag = 0;
612 }
613
614 /* Process the msg one by one */
615 for (count = 0; count < num; count++, msgs++) {
616 if (count == (num - 1))
617 id->bus_hold_flag = 0;
618
619 ret = cdns_i2c_process_msg(id, msgs, adap);
620 if (ret)
621 goto out;
622
623 /* Report the other error interrupts to application */
624 if (id->err_status) {
625 cdns_i2c_master_reset(adap);
626
627 if (id->err_status & CDNS_I2C_IXR_NACK) {
628 ret = -ENXIO;
629 goto out;
630 }
631 ret = -EIO;
632 goto out;
633 }
634 }
635
636 ret = num;
637out:
638 pm_runtime_mark_last_busy(id->dev);
639 pm_runtime_put_autosuspend(id->dev);
640 return ret;
641}
642
643/**
644 * cdns_i2c_func - Returns the supported features of the I2C driver
645 * @adap: pointer to the i2c adapter structure
646 *
647 * Return: 32 bit value, each bit corresponding to a feature
648 */
649static u32 cdns_i2c_func(struct i2c_adapter *adap)
650{
651 return I2C_FUNC_I2C | I2C_FUNC_10BIT_ADDR |
652 (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK) |
653 I2C_FUNC_SMBUS_BLOCK_DATA;
654}
655
656static const struct i2c_algorithm cdns_i2c_algo = {
657 .master_xfer = cdns_i2c_master_xfer,
658 .functionality = cdns_i2c_func,
659};
660
661/**
662 * cdns_i2c_calc_divs - Calculate clock dividers
663 * @f: I2C clock frequency
664 * @input_clk: Input clock frequency
665 * @a: First divider (return value)
666 * @b: Second divider (return value)
667 *
668 * f is used as input and output variable. As input it is used as target I2C
669 * frequency. On function exit f holds the actually resulting I2C frequency.
670 *
671 * Return: 0 on success, negative errno otherwise.
672 */
673static int cdns_i2c_calc_divs(unsigned long *f, unsigned long input_clk,
674 unsigned int *a, unsigned int *b)
675{
676 unsigned long fscl = *f, best_fscl = *f, actual_fscl, temp;
677 unsigned int div_a, div_b, calc_div_a = 0, calc_div_b = 0;
678 unsigned int last_error, current_error;
679
680 /* calculate (divisor_a+1) x (divisor_b+1) */
681 temp = input_clk / (22 * fscl);
682
683 /*
684 * If the calculated value is negative or 0, the fscl input is out of
685 * range. Return error.
686 */
687 if (!temp || (temp > (CDNS_I2C_DIVA_MAX * CDNS_I2C_DIVB_MAX)))
688 return -EINVAL;
689
690 last_error = -1;
691 for (div_a = 0; div_a < CDNS_I2C_DIVA_MAX; div_a++) {
692 div_b = DIV_ROUND_UP(input_clk, 22 * fscl * (div_a + 1));
693
694 if ((div_b < 1) || (div_b > CDNS_I2C_DIVB_MAX))
695 continue;
696 div_b--;
697
698 actual_fscl = input_clk / (22 * (div_a + 1) * (div_b + 1));
699
700 if (actual_fscl > fscl)
701 continue;
702
703 current_error = ((actual_fscl > fscl) ? (actual_fscl - fscl) :
704 (fscl - actual_fscl));
705
706 if (last_error > current_error) {
707 calc_div_a = div_a;
708 calc_div_b = div_b;
709 best_fscl = actual_fscl;
710 last_error = current_error;
711 }
712 }
713
714 *a = calc_div_a;
715 *b = calc_div_b;
716 *f = best_fscl;
717
718 return 0;
719}
720
721/**
722 * cdns_i2c_setclk - This function sets the serial clock rate for the I2C device
723 * @clk_in: I2C clock input frequency in Hz
724 * @id: Pointer to the I2C device structure
725 *
726 * The device must be idle rather than busy transferring data before setting
727 * these device options.
728 * The data rate is set by values in the control register.
729 * The formula for determining the correct register values is
730 * Fscl = Fpclk/(22 x (divisor_a+1) x (divisor_b+1))
731 * See the hardware data sheet for a full explanation of setting the serial
732 * clock rate. The clock can not be faster than the input clock divide by 22.
733 * The two most common clock rates are 100KHz and 400KHz.
734 *
735 * Return: 0 on success, negative error otherwise
736 */
737static int cdns_i2c_setclk(unsigned long clk_in, struct cdns_i2c *id)
738{
739 unsigned int div_a, div_b;
740 unsigned int ctrl_reg;
741 int ret = 0;
742 unsigned long fscl = id->i2c_clk;
743
744 ret = cdns_i2c_calc_divs(&fscl, clk_in, &div_a, &div_b);
745 if (ret)
746 return ret;
747
748 ctrl_reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
749 ctrl_reg &= ~(CDNS_I2C_CR_DIVA_MASK | CDNS_I2C_CR_DIVB_MASK);
750 ctrl_reg |= ((div_a << CDNS_I2C_CR_DIVA_SHIFT) |
751 (div_b << CDNS_I2C_CR_DIVB_SHIFT));
752 cdns_i2c_writereg(ctrl_reg, CDNS_I2C_CR_OFFSET);
753
754 return 0;
755}
756
757/**
758 * cdns_i2c_clk_notifier_cb - Clock rate change callback
759 * @nb: Pointer to notifier block
760 * @event: Notification reason
761 * @data: Pointer to notification data object
762 *
763 * This function is called when the cdns_i2c input clock frequency changes.
764 * The callback checks whether a valid bus frequency can be generated after the
765 * change. If so, the change is acknowledged, otherwise the change is aborted.
766 * New dividers are written to the HW in the pre- or post change notification
767 * depending on the scaling direction.
768 *
769 * Return: NOTIFY_STOP if the rate change should be aborted, NOTIFY_OK
770 * to acknowedge the change, NOTIFY_DONE if the notification is
771 * considered irrelevant.
772 */
773static int cdns_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long
774 event, void *data)
775{
776 struct clk_notifier_data *ndata = data;
777 struct cdns_i2c *id = to_cdns_i2c(nb);
778
779 if (pm_runtime_suspended(id->dev))
780 return NOTIFY_OK;
781
782 switch (event) {
783 case PRE_RATE_CHANGE:
784 {
785 unsigned long input_clk = ndata->new_rate;
786 unsigned long fscl = id->i2c_clk;
787 unsigned int div_a, div_b;
788 int ret;
789
790 ret = cdns_i2c_calc_divs(&fscl, input_clk, &div_a, &div_b);
791 if (ret) {
792 dev_warn(id->adap.dev.parent,
793 "clock rate change rejected\n");
794 return NOTIFY_STOP;
795 }
796
797 /* scale up */
798 if (ndata->new_rate > ndata->old_rate)
799 cdns_i2c_setclk(ndata->new_rate, id);
800
801 return NOTIFY_OK;
802 }
803 case POST_RATE_CHANGE:
804 id->input_clk = ndata->new_rate;
805 /* scale down */
806 if (ndata->new_rate < ndata->old_rate)
807 cdns_i2c_setclk(ndata->new_rate, id);
808 return NOTIFY_OK;
809 case ABORT_RATE_CHANGE:
810 /* scale up */
811 if (ndata->new_rate > ndata->old_rate)
812 cdns_i2c_setclk(ndata->old_rate, id);
813 return NOTIFY_OK;
814 default:
815 return NOTIFY_DONE;
816 }
817}
818
819/**
820 * cdns_i2c_runtime_suspend - Runtime suspend method for the driver
821 * @dev: Address of the platform_device structure
822 *
823 * Put the driver into low power mode.
824 *
825 * Return: 0 always
826 */
827static int __maybe_unused cdns_i2c_runtime_suspend(struct device *dev)
828{
829 struct platform_device *pdev = to_platform_device(dev);
830 struct cdns_i2c *xi2c = platform_get_drvdata(pdev);
831
832 clk_disable(xi2c->clk);
833
834 return 0;
835}
836
837/**
838 * cdns_i2c_runtime_resume - Runtime resume
839 * @dev: Address of the platform_device structure
840 *
841 * Runtime resume callback.
842 *
843 * Return: 0 on success and error value on error
844 */
845static int __maybe_unused cdns_i2c_runtime_resume(struct device *dev)
846{
847 struct platform_device *pdev = to_platform_device(dev);
848 struct cdns_i2c *xi2c = platform_get_drvdata(pdev);
849 int ret;
850
851 ret = clk_enable(xi2c->clk);
852 if (ret) {
853 dev_err(dev, "Cannot enable clock.\n");
854 return ret;
855 }
856
857 return 0;
858}
859
860static const struct dev_pm_ops cdns_i2c_dev_pm_ops = {
861 SET_RUNTIME_PM_OPS(cdns_i2c_runtime_suspend,
862 cdns_i2c_runtime_resume, NULL)
863};
864
865static const struct cdns_platform_data r1p10_i2c_def = {
866 .quirks = CDNS_I2C_BROKEN_HOLD_BIT,
867};
868
869static const struct of_device_id cdns_i2c_of_match[] = {
870 { .compatible = "cdns,i2c-r1p10", .data = &r1p10_i2c_def },
871 { .compatible = "cdns,i2c-r1p14",},
872 { /* end of table */ }
873};
874MODULE_DEVICE_TABLE(of, cdns_i2c_of_match);
875
876/**
877 * cdns_i2c_probe - Platform registration call
878 * @pdev: Handle to the platform device structure
879 *
880 * This function does all the memory allocation and registration for the i2c
881 * device. User can modify the address mode to 10 bit address mode using the
882 * ioctl call with option I2C_TENBIT.
883 *
884 * Return: 0 on success, negative error otherwise
885 */
886static int cdns_i2c_probe(struct platform_device *pdev)
887{
888 struct resource *r_mem;
889 struct cdns_i2c *id;
890 int ret;
891 const struct of_device_id *match;
892
893 id = devm_kzalloc(&pdev->dev, sizeof(*id), GFP_KERNEL);
894 if (!id)
895 return -ENOMEM;
896
897 id->dev = &pdev->dev;
898 platform_set_drvdata(pdev, id);
899
900 match = of_match_node(cdns_i2c_of_match, pdev->dev.of_node);
901 if (match && match->data) {
902 const struct cdns_platform_data *data = match->data;
903 id->quirks = data->quirks;
904 }
905
906 r_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
907 id->membase = devm_ioremap_resource(&pdev->dev, r_mem);
908 if (IS_ERR(id->membase))
909 return PTR_ERR(id->membase);
910
911 id->irq = platform_get_irq(pdev, 0);
912
913 id->adap.owner = THIS_MODULE;
914 id->adap.dev.of_node = pdev->dev.of_node;
915 id->adap.algo = &cdns_i2c_algo;
916 id->adap.timeout = CDNS_I2C_TIMEOUT;
917 id->adap.retries = 3; /* Default retry value. */
918 id->adap.algo_data = id;
919 id->adap.dev.parent = &pdev->dev;
920 init_completion(&id->xfer_done);
921 snprintf(id->adap.name, sizeof(id->adap.name),
922 "Cadence I2C at %08lx", (unsigned long)r_mem->start);
923
924 id->clk = devm_clk_get(&pdev->dev, NULL);
925 if (IS_ERR(id->clk)) {
926 dev_err(&pdev->dev, "input clock not found.\n");
927 return PTR_ERR(id->clk);
928 }
929 ret = clk_prepare_enable(id->clk);
930 if (ret)
931 dev_err(&pdev->dev, "Unable to enable clock.\n");
932
933 pm_runtime_enable(id->dev);
934 pm_runtime_set_autosuspend_delay(id->dev, CNDS_I2C_PM_TIMEOUT);
935 pm_runtime_use_autosuspend(id->dev);
936 pm_runtime_set_active(id->dev);
937
938 id->clk_rate_change_nb.notifier_call = cdns_i2c_clk_notifier_cb;
939 if (clk_notifier_register(id->clk, &id->clk_rate_change_nb))
940 dev_warn(&pdev->dev, "Unable to register clock notifier.\n");
941 id->input_clk = clk_get_rate(id->clk);
942
943 ret = of_property_read_u32(pdev->dev.of_node, "clock-frequency",
944 &id->i2c_clk);
945 if (ret || (id->i2c_clk > CDNS_I2C_SPEED_MAX))
946 id->i2c_clk = CDNS_I2C_SPEED_DEFAULT;
947
948 cdns_i2c_writereg(CDNS_I2C_CR_ACK_EN | CDNS_I2C_CR_NEA | CDNS_I2C_CR_MS,
949 CDNS_I2C_CR_OFFSET);
950
951 ret = cdns_i2c_setclk(id->input_clk, id);
952 if (ret) {
953 dev_err(&pdev->dev, "invalid SCL clock: %u Hz\n", id->i2c_clk);
954 ret = -EINVAL;
955 goto err_clk_dis;
956 }
957
958 ret = devm_request_irq(&pdev->dev, id->irq, cdns_i2c_isr, 0,
959 DRIVER_NAME, id);
960 if (ret) {
961 dev_err(&pdev->dev, "cannot get irq %d\n", id->irq);
962 goto err_clk_dis;
963 }
964
965 ret = i2c_add_adapter(&id->adap);
966 if (ret < 0) {
967 dev_err(&pdev->dev, "reg adap failed: %d\n", ret);
968 goto err_clk_dis;
969 }
970
971 /*
972 * Cadence I2C controller has a bug wherein it generates
973 * invalid read transaction after HW timeout in master receiver mode.
974 * HW timeout is not used by this driver and the interrupt is disabled.
975 * But the feature itself cannot be disabled. Hence maximum value
976 * is written to this register to reduce the chances of error.
977 */
978 cdns_i2c_writereg(CDNS_I2C_TIMEOUT_MAX, CDNS_I2C_TIME_OUT_OFFSET);
979
980 dev_info(&pdev->dev, "%u kHz mmio %08lx irq %d\n",
981 id->i2c_clk / 1000, (unsigned long)r_mem->start, id->irq);
982
983 return 0;
984
985err_clk_dis:
986 clk_disable_unprepare(id->clk);
987 pm_runtime_set_suspended(&pdev->dev);
988 pm_runtime_disable(&pdev->dev);
989 return ret;
990}
991
992/**
993 * cdns_i2c_remove - Unregister the device after releasing the resources
994 * @pdev: Handle to the platform device structure
995 *
996 * This function frees all the resources allocated to the device.
997 *
998 * Return: 0 always
999 */
1000static int cdns_i2c_remove(struct platform_device *pdev)
1001{
1002 struct cdns_i2c *id = platform_get_drvdata(pdev);
1003
1004 i2c_del_adapter(&id->adap);
1005 clk_notifier_unregister(id->clk, &id->clk_rate_change_nb);
1006 clk_disable_unprepare(id->clk);
1007 pm_runtime_disable(&pdev->dev);
1008
1009 return 0;
1010}
1011
1012static struct platform_driver cdns_i2c_drv = {
1013 .driver = {
1014 .name = DRIVER_NAME,
1015 .of_match_table = cdns_i2c_of_match,
1016 .pm = &cdns_i2c_dev_pm_ops,
1017 },
1018 .probe = cdns_i2c_probe,
1019 .remove = cdns_i2c_remove,
1020};
1021
1022module_platform_driver(cdns_i2c_drv);
1023
1024MODULE_AUTHOR("Xilinx Inc.");
1025MODULE_DESCRIPTION("Cadence I2C bus driver");
1026MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * I2C bus driver for the Cadence I2C controller.
4 *
5 * Copyright (C) 2009 - 2014 Xilinx, Inc.
6 */
7
8#include <linux/clk.h>
9#include <linux/delay.h>
10#include <linux/i2c.h>
11#include <linux/interrupt.h>
12#include <linux/io.h>
13#include <linux/iopoll.h>
14#include <linux/module.h>
15#include <linux/platform_device.h>
16#include <linux/of.h>
17#include <linux/pm_runtime.h>
18#include <linux/pinctrl/consumer.h>
19#include <linux/reset.h>
20
21/* Register offsets for the I2C device. */
22#define CDNS_I2C_CR_OFFSET 0x00 /* Control Register, RW */
23#define CDNS_I2C_SR_OFFSET 0x04 /* Status Register, RO */
24#define CDNS_I2C_ADDR_OFFSET 0x08 /* I2C Address Register, RW */
25#define CDNS_I2C_DATA_OFFSET 0x0C /* I2C Data Register, RW */
26#define CDNS_I2C_ISR_OFFSET 0x10 /* IRQ Status Register, RW */
27#define CDNS_I2C_XFER_SIZE_OFFSET 0x14 /* Transfer Size Register, RW */
28#define CDNS_I2C_TIME_OUT_OFFSET 0x1C /* Time Out Register, RW */
29#define CDNS_I2C_IMR_OFFSET 0x20 /* IRQ Mask Register, RO */
30#define CDNS_I2C_IER_OFFSET 0x24 /* IRQ Enable Register, WO */
31#define CDNS_I2C_IDR_OFFSET 0x28 /* IRQ Disable Register, WO */
32
33/* Control Register Bit mask definitions */
34#define CDNS_I2C_CR_HOLD BIT(4) /* Hold Bus bit */
35#define CDNS_I2C_CR_ACK_EN BIT(3)
36#define CDNS_I2C_CR_NEA BIT(2)
37#define CDNS_I2C_CR_MS BIT(1)
38/* Read or Write Master transfer 0 = Transmitter, 1 = Receiver */
39#define CDNS_I2C_CR_RW BIT(0)
40/* 1 = Auto init FIFO to zeroes */
41#define CDNS_I2C_CR_CLR_FIFO BIT(6)
42#define CDNS_I2C_CR_DIVA_SHIFT 14
43#define CDNS_I2C_CR_DIVA_MASK (3 << CDNS_I2C_CR_DIVA_SHIFT)
44#define CDNS_I2C_CR_DIVB_SHIFT 8
45#define CDNS_I2C_CR_DIVB_MASK (0x3f << CDNS_I2C_CR_DIVB_SHIFT)
46
47#define CDNS_I2C_CR_MASTER_EN_MASK (CDNS_I2C_CR_NEA | \
48 CDNS_I2C_CR_ACK_EN | \
49 CDNS_I2C_CR_MS)
50
51#define CDNS_I2C_CR_SLAVE_EN_MASK ~CDNS_I2C_CR_MASTER_EN_MASK
52
53/* Status Register Bit mask definitions */
54#define CDNS_I2C_SR_BA BIT(8)
55#define CDNS_I2C_SR_TXDV BIT(6)
56#define CDNS_I2C_SR_RXDV BIT(5)
57#define CDNS_I2C_SR_RXRW BIT(3)
58
59/*
60 * I2C Address Register Bit mask definitions
61 * Normal addressing mode uses [6:0] bits. Extended addressing mode uses [9:0]
62 * bits. A write access to this register always initiates a transfer if the I2C
63 * is in master mode.
64 */
65#define CDNS_I2C_ADDR_MASK 0x000003FF /* I2C Address Mask */
66
67/*
68 * I2C Interrupt Registers Bit mask definitions
69 * All the four interrupt registers (Status/Mask/Enable/Disable) have the same
70 * bit definitions.
71 */
72#define CDNS_I2C_IXR_ARB_LOST BIT(9)
73#define CDNS_I2C_IXR_RX_UNF BIT(7)
74#define CDNS_I2C_IXR_TX_OVF BIT(6)
75#define CDNS_I2C_IXR_RX_OVF BIT(5)
76#define CDNS_I2C_IXR_SLV_RDY BIT(4)
77#define CDNS_I2C_IXR_TO BIT(3)
78#define CDNS_I2C_IXR_NACK BIT(2)
79#define CDNS_I2C_IXR_DATA BIT(1)
80#define CDNS_I2C_IXR_COMP BIT(0)
81
82#define CDNS_I2C_IXR_ALL_INTR_MASK (CDNS_I2C_IXR_ARB_LOST | \
83 CDNS_I2C_IXR_RX_UNF | \
84 CDNS_I2C_IXR_TX_OVF | \
85 CDNS_I2C_IXR_RX_OVF | \
86 CDNS_I2C_IXR_SLV_RDY | \
87 CDNS_I2C_IXR_TO | \
88 CDNS_I2C_IXR_NACK | \
89 CDNS_I2C_IXR_DATA | \
90 CDNS_I2C_IXR_COMP)
91
92#define CDNS_I2C_IXR_ERR_INTR_MASK (CDNS_I2C_IXR_ARB_LOST | \
93 CDNS_I2C_IXR_RX_UNF | \
94 CDNS_I2C_IXR_TX_OVF | \
95 CDNS_I2C_IXR_RX_OVF | \
96 CDNS_I2C_IXR_NACK)
97
98#define CDNS_I2C_ENABLED_INTR_MASK (CDNS_I2C_IXR_ARB_LOST | \
99 CDNS_I2C_IXR_RX_UNF | \
100 CDNS_I2C_IXR_TX_OVF | \
101 CDNS_I2C_IXR_RX_OVF | \
102 CDNS_I2C_IXR_NACK | \
103 CDNS_I2C_IXR_DATA | \
104 CDNS_I2C_IXR_COMP)
105
106#define CDNS_I2C_IXR_SLAVE_INTR_MASK (CDNS_I2C_IXR_RX_UNF | \
107 CDNS_I2C_IXR_TX_OVF | \
108 CDNS_I2C_IXR_RX_OVF | \
109 CDNS_I2C_IXR_TO | \
110 CDNS_I2C_IXR_NACK | \
111 CDNS_I2C_IXR_DATA | \
112 CDNS_I2C_IXR_COMP)
113
114#define CDNS_I2C_TIMEOUT msecs_to_jiffies(1000)
115/* timeout for pm runtime autosuspend */
116#define CNDS_I2C_PM_TIMEOUT 1000 /* ms */
117
118#define CDNS_I2C_FIFO_DEPTH_DEFAULT 16
119#define CDNS_I2C_MAX_TRANSFER_SIZE 255
120/* Transfer size in multiples of data interrupt depth */
121#define CDNS_I2C_TRANSFER_SIZE(max) ((max) - 3)
122
123#define DRIVER_NAME "cdns-i2c"
124
125#define CDNS_I2C_DIVA_MAX 4
126#define CDNS_I2C_DIVB_MAX 64
127
128#define CDNS_I2C_TIMEOUT_MAX 0xFF
129
130#define CDNS_I2C_BROKEN_HOLD_BIT BIT(0)
131#define CDNS_I2C_POLL_US 100000
132#define CDNS_I2C_TIMEOUT_US 500000
133
134#define cdns_i2c_readreg(offset) readl_relaxed(id->membase + offset)
135#define cdns_i2c_writereg(val, offset) writel_relaxed(val, id->membase + offset)
136
137#if IS_ENABLED(CONFIG_I2C_SLAVE)
138/**
139 * enum cdns_i2c_mode - I2C Controller current operating mode
140 *
141 * @CDNS_I2C_MODE_SLAVE: I2C controller operating in slave mode
142 * @CDNS_I2C_MODE_MASTER: I2C Controller operating in master mode
143 */
144enum cdns_i2c_mode {
145 CDNS_I2C_MODE_SLAVE,
146 CDNS_I2C_MODE_MASTER,
147};
148
149/**
150 * enum cdns_i2c_slave_state - Slave state when I2C is operating in slave mode
151 *
152 * @CDNS_I2C_SLAVE_STATE_IDLE: I2C slave idle
153 * @CDNS_I2C_SLAVE_STATE_SEND: I2C slave sending data to master
154 * @CDNS_I2C_SLAVE_STATE_RECV: I2C slave receiving data from master
155 */
156enum cdns_i2c_slave_state {
157 CDNS_I2C_SLAVE_STATE_IDLE,
158 CDNS_I2C_SLAVE_STATE_SEND,
159 CDNS_I2C_SLAVE_STATE_RECV,
160};
161#endif
162
163/**
164 * struct cdns_i2c - I2C device private data structure
165 *
166 * @dev: Pointer to device structure
167 * @membase: Base address of the I2C device
168 * @adap: I2C adapter instance
169 * @p_msg: Message pointer
170 * @err_status: Error status in Interrupt Status Register
171 * @xfer_done: Transfer complete status
172 * @p_send_buf: Pointer to transmit buffer
173 * @p_recv_buf: Pointer to receive buffer
174 * @send_count: Number of bytes still expected to send
175 * @recv_count: Number of bytes still expected to receive
176 * @curr_recv_count: Number of bytes to be received in current transfer
177 * @input_clk: Input clock to I2C controller
178 * @i2c_clk: Maximum I2C clock speed
179 * @bus_hold_flag: Flag used in repeated start for clearing HOLD bit
180 * @clk: Pointer to struct clk
181 * @clk_rate_change_nb: Notifier block for clock rate changes
182 * @reset: Reset control for the device
183 * @quirks: flag for broken hold bit usage in r1p10
184 * @ctrl_reg: Cached value of the control register.
185 * @rinfo: I2C GPIO recovery information
186 * @ctrl_reg_diva_divb: value of fields DIV_A and DIV_B from CR register
187 * @slave: Registered slave instance.
188 * @dev_mode: I2C operating role(master/slave).
189 * @slave_state: I2C Slave state(idle/read/write).
190 * @fifo_depth: The depth of the transfer FIFO
191 * @transfer_size: The maximum number of bytes in one transfer
192 */
193struct cdns_i2c {
194 struct device *dev;
195 void __iomem *membase;
196 struct i2c_adapter adap;
197 struct i2c_msg *p_msg;
198 int err_status;
199 struct completion xfer_done;
200 unsigned char *p_send_buf;
201 unsigned char *p_recv_buf;
202 unsigned int send_count;
203 unsigned int recv_count;
204 unsigned int curr_recv_count;
205 unsigned long input_clk;
206 unsigned int i2c_clk;
207 unsigned int bus_hold_flag;
208 struct clk *clk;
209 struct notifier_block clk_rate_change_nb;
210 struct reset_control *reset;
211 u32 quirks;
212 u32 ctrl_reg;
213 struct i2c_bus_recovery_info rinfo;
214#if IS_ENABLED(CONFIG_I2C_SLAVE)
215 u16 ctrl_reg_diva_divb;
216 struct i2c_client *slave;
217 enum cdns_i2c_mode dev_mode;
218 enum cdns_i2c_slave_state slave_state;
219#endif
220 u32 fifo_depth;
221 unsigned int transfer_size;
222};
223
224struct cdns_platform_data {
225 u32 quirks;
226};
227
228#define to_cdns_i2c(_nb) container_of(_nb, struct cdns_i2c, \
229 clk_rate_change_nb)
230
231/**
232 * cdns_i2c_clear_bus_hold - Clear bus hold bit
233 * @id: Pointer to driver data struct
234 *
235 * Helper to clear the controller's bus hold bit.
236 */
237static void cdns_i2c_clear_bus_hold(struct cdns_i2c *id)
238{
239 u32 reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
240 if (reg & CDNS_I2C_CR_HOLD)
241 cdns_i2c_writereg(reg & ~CDNS_I2C_CR_HOLD, CDNS_I2C_CR_OFFSET);
242}
243
244static inline bool cdns_is_holdquirk(struct cdns_i2c *id, bool hold_wrkaround)
245{
246 return (hold_wrkaround &&
247 (id->curr_recv_count == id->fifo_depth + 1));
248}
249
250#if IS_ENABLED(CONFIG_I2C_SLAVE)
251static void cdns_i2c_set_mode(enum cdns_i2c_mode mode, struct cdns_i2c *id)
252{
253 /* Disable all interrupts */
254 cdns_i2c_writereg(CDNS_I2C_IXR_ALL_INTR_MASK, CDNS_I2C_IDR_OFFSET);
255
256 /* Clear FIFO and transfer size */
257 cdns_i2c_writereg(CDNS_I2C_CR_CLR_FIFO, CDNS_I2C_CR_OFFSET);
258
259 /* Update device mode and state */
260 id->dev_mode = mode;
261 id->slave_state = CDNS_I2C_SLAVE_STATE_IDLE;
262
263 switch (mode) {
264 case CDNS_I2C_MODE_MASTER:
265 /* Enable i2c master */
266 cdns_i2c_writereg(id->ctrl_reg_diva_divb |
267 CDNS_I2C_CR_MASTER_EN_MASK,
268 CDNS_I2C_CR_OFFSET);
269 /*
270 * This delay is needed to give the IP some time to switch to
271 * the master mode. With lower values(like 110 us) i2cdetect
272 * will not detect any slave and without this delay, the IP will
273 * trigger a timeout interrupt.
274 */
275 usleep_range(115, 125);
276 break;
277 case CDNS_I2C_MODE_SLAVE:
278 /* Enable i2c slave */
279 cdns_i2c_writereg(id->ctrl_reg_diva_divb &
280 CDNS_I2C_CR_SLAVE_EN_MASK,
281 CDNS_I2C_CR_OFFSET);
282
283 /* Setting slave address */
284 cdns_i2c_writereg(id->slave->addr & CDNS_I2C_ADDR_MASK,
285 CDNS_I2C_ADDR_OFFSET);
286
287 /* Enable slave send/receive interrupts */
288 cdns_i2c_writereg(CDNS_I2C_IXR_SLAVE_INTR_MASK,
289 CDNS_I2C_IER_OFFSET);
290 break;
291 }
292}
293
294static void cdns_i2c_slave_rcv_data(struct cdns_i2c *id)
295{
296 u8 bytes;
297 unsigned char data;
298
299 /* Prepare backend for data reception */
300 if (id->slave_state == CDNS_I2C_SLAVE_STATE_IDLE) {
301 id->slave_state = CDNS_I2C_SLAVE_STATE_RECV;
302 i2c_slave_event(id->slave, I2C_SLAVE_WRITE_REQUESTED, NULL);
303 }
304
305 /* Fetch number of bytes to receive */
306 bytes = cdns_i2c_readreg(CDNS_I2C_XFER_SIZE_OFFSET);
307
308 /* Read data and send to backend */
309 while (bytes--) {
310 data = cdns_i2c_readreg(CDNS_I2C_DATA_OFFSET);
311 i2c_slave_event(id->slave, I2C_SLAVE_WRITE_RECEIVED, &data);
312 }
313}
314
315static void cdns_i2c_slave_send_data(struct cdns_i2c *id)
316{
317 u8 data;
318
319 /* Prepare backend for data transmission */
320 if (id->slave_state == CDNS_I2C_SLAVE_STATE_IDLE) {
321 id->slave_state = CDNS_I2C_SLAVE_STATE_SEND;
322 i2c_slave_event(id->slave, I2C_SLAVE_READ_REQUESTED, &data);
323 } else {
324 i2c_slave_event(id->slave, I2C_SLAVE_READ_PROCESSED, &data);
325 }
326
327 /* Send data over bus */
328 cdns_i2c_writereg(data, CDNS_I2C_DATA_OFFSET);
329}
330
331/**
332 * cdns_i2c_slave_isr - Interrupt handler for the I2C device in slave role
333 * @ptr: Pointer to I2C device private data
334 *
335 * This function handles the data interrupt and transfer complete interrupt of
336 * the I2C device in slave role.
337 *
338 * Return: IRQ_HANDLED always
339 */
340static irqreturn_t cdns_i2c_slave_isr(void *ptr)
341{
342 struct cdns_i2c *id = ptr;
343 unsigned int isr_status, i2c_status;
344
345 /* Fetch the interrupt status */
346 isr_status = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
347 cdns_i2c_writereg(isr_status, CDNS_I2C_ISR_OFFSET);
348
349 /* Ignore masked interrupts */
350 isr_status &= ~cdns_i2c_readreg(CDNS_I2C_IMR_OFFSET);
351
352 /* Fetch transfer mode (send/receive) */
353 i2c_status = cdns_i2c_readreg(CDNS_I2C_SR_OFFSET);
354
355 /* Handle data send/receive */
356 if (i2c_status & CDNS_I2C_SR_RXRW) {
357 /* Send data to master */
358 if (isr_status & CDNS_I2C_IXR_DATA)
359 cdns_i2c_slave_send_data(id);
360
361 if (isr_status & CDNS_I2C_IXR_COMP) {
362 id->slave_state = CDNS_I2C_SLAVE_STATE_IDLE;
363 i2c_slave_event(id->slave, I2C_SLAVE_STOP, NULL);
364 }
365 } else {
366 /* Receive data from master */
367 if (isr_status & CDNS_I2C_IXR_DATA)
368 cdns_i2c_slave_rcv_data(id);
369
370 if (isr_status & CDNS_I2C_IXR_COMP) {
371 cdns_i2c_slave_rcv_data(id);
372 id->slave_state = CDNS_I2C_SLAVE_STATE_IDLE;
373 i2c_slave_event(id->slave, I2C_SLAVE_STOP, NULL);
374 }
375 }
376
377 /* Master indicated xfer stop or fifo underflow/overflow */
378 if (isr_status & (CDNS_I2C_IXR_NACK | CDNS_I2C_IXR_RX_OVF |
379 CDNS_I2C_IXR_RX_UNF | CDNS_I2C_IXR_TX_OVF)) {
380 id->slave_state = CDNS_I2C_SLAVE_STATE_IDLE;
381 i2c_slave_event(id->slave, I2C_SLAVE_STOP, NULL);
382 cdns_i2c_writereg(CDNS_I2C_CR_CLR_FIFO, CDNS_I2C_CR_OFFSET);
383 }
384
385 return IRQ_HANDLED;
386}
387#endif
388
389/**
390 * cdns_i2c_master_isr - Interrupt handler for the I2C device in master role
391 * @ptr: Pointer to I2C device private data
392 *
393 * This function handles the data interrupt, transfer complete interrupt and
394 * the error interrupts of the I2C device in master role.
395 *
396 * Return: IRQ_HANDLED always
397 */
398static irqreturn_t cdns_i2c_master_isr(void *ptr)
399{
400 unsigned int isr_status, avail_bytes;
401 unsigned int bytes_to_send;
402 bool updatetx;
403 struct cdns_i2c *id = ptr;
404 /* Signal completion only after everything is updated */
405 int done_flag = 0;
406 irqreturn_t status = IRQ_NONE;
407
408 isr_status = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
409 cdns_i2c_writereg(isr_status, CDNS_I2C_ISR_OFFSET);
410 id->err_status = 0;
411
412 /* Handling nack and arbitration lost interrupt */
413 if (isr_status & (CDNS_I2C_IXR_NACK | CDNS_I2C_IXR_ARB_LOST)) {
414 done_flag = 1;
415 status = IRQ_HANDLED;
416 }
417
418 /*
419 * Check if transfer size register needs to be updated again for a
420 * large data receive operation.
421 */
422 updatetx = id->recv_count > id->curr_recv_count;
423
424 /* When receiving, handle data interrupt and completion interrupt */
425 if (id->p_recv_buf &&
426 ((isr_status & CDNS_I2C_IXR_COMP) ||
427 (isr_status & CDNS_I2C_IXR_DATA))) {
428 /* Read data if receive data valid is set */
429 while (cdns_i2c_readreg(CDNS_I2C_SR_OFFSET) &
430 CDNS_I2C_SR_RXDV) {
431 if (id->recv_count > 0) {
432 *(id->p_recv_buf)++ =
433 cdns_i2c_readreg(CDNS_I2C_DATA_OFFSET);
434 id->recv_count--;
435 id->curr_recv_count--;
436
437 /*
438 * Clear hold bit that was set for FIFO control
439 * if RX data left is less than or equal to
440 * FIFO DEPTH unless repeated start is selected
441 */
442 if (id->recv_count <= id->fifo_depth &&
443 !id->bus_hold_flag)
444 cdns_i2c_clear_bus_hold(id);
445
446 } else {
447 dev_err(id->adap.dev.parent,
448 "xfer_size reg rollover. xfer aborted!\n");
449 id->err_status |= CDNS_I2C_IXR_TO;
450 break;
451 }
452
453 if (cdns_is_holdquirk(id, updatetx))
454 break;
455 }
456
457 /*
458 * The controller sends NACK to the slave when transfer size
459 * register reaches zero without considering the HOLD bit.
460 * This workaround is implemented for large data transfers to
461 * maintain transfer size non-zero while performing a large
462 * receive operation.
463 */
464 if (cdns_is_holdquirk(id, updatetx)) {
465 /* wait while fifo is full */
466 while (cdns_i2c_readreg(CDNS_I2C_XFER_SIZE_OFFSET) !=
467 (id->curr_recv_count - id->fifo_depth))
468 ;
469
470 /*
471 * Check number of bytes to be received against maximum
472 * transfer size and update register accordingly.
473 */
474 if (((int)(id->recv_count) - id->fifo_depth) >
475 id->transfer_size) {
476 cdns_i2c_writereg(id->transfer_size,
477 CDNS_I2C_XFER_SIZE_OFFSET);
478 id->curr_recv_count = id->transfer_size +
479 id->fifo_depth;
480 } else {
481 cdns_i2c_writereg(id->recv_count -
482 id->fifo_depth,
483 CDNS_I2C_XFER_SIZE_OFFSET);
484 id->curr_recv_count = id->recv_count;
485 }
486 }
487
488 /* Clear hold (if not repeated start) and signal completion */
489 if ((isr_status & CDNS_I2C_IXR_COMP) && !id->recv_count) {
490 if (!id->bus_hold_flag)
491 cdns_i2c_clear_bus_hold(id);
492 done_flag = 1;
493 }
494
495 status = IRQ_HANDLED;
496 }
497
498 /* When sending, handle transfer complete interrupt */
499 if ((isr_status & CDNS_I2C_IXR_COMP) && !id->p_recv_buf) {
500 /*
501 * If there is more data to be sent, calculate the
502 * space available in FIFO and fill with that many bytes.
503 */
504 if (id->send_count) {
505 avail_bytes = id->fifo_depth -
506 cdns_i2c_readreg(CDNS_I2C_XFER_SIZE_OFFSET);
507 if (id->send_count > avail_bytes)
508 bytes_to_send = avail_bytes;
509 else
510 bytes_to_send = id->send_count;
511
512 while (bytes_to_send--) {
513 cdns_i2c_writereg(
514 (*(id->p_send_buf)++),
515 CDNS_I2C_DATA_OFFSET);
516 id->send_count--;
517 }
518 } else {
519 /*
520 * Signal the completion of transaction and
521 * clear the hold bus bit if there are no
522 * further messages to be processed.
523 */
524 done_flag = 1;
525 }
526 if (!id->send_count && !id->bus_hold_flag)
527 cdns_i2c_clear_bus_hold(id);
528
529 status = IRQ_HANDLED;
530 }
531
532 /* Update the status for errors */
533 id->err_status |= isr_status & CDNS_I2C_IXR_ERR_INTR_MASK;
534 if (id->err_status)
535 status = IRQ_HANDLED;
536
537 if (done_flag)
538 complete(&id->xfer_done);
539
540 return status;
541}
542
543/**
544 * cdns_i2c_isr - Interrupt handler for the I2C device
545 * @irq: irq number for the I2C device
546 * @ptr: void pointer to cdns_i2c structure
547 *
548 * This function passes the control to slave/master based on current role of
549 * i2c controller.
550 *
551 * Return: IRQ_HANDLED always
552 */
553static irqreturn_t cdns_i2c_isr(int irq, void *ptr)
554{
555#if IS_ENABLED(CONFIG_I2C_SLAVE)
556 struct cdns_i2c *id = ptr;
557
558 if (id->dev_mode == CDNS_I2C_MODE_SLAVE)
559 return cdns_i2c_slave_isr(ptr);
560#endif
561 return cdns_i2c_master_isr(ptr);
562}
563
564/**
565 * cdns_i2c_mrecv - Prepare and start a master receive operation
566 * @id: pointer to the i2c device structure
567 */
568static void cdns_i2c_mrecv(struct cdns_i2c *id)
569{
570 unsigned int ctrl_reg;
571 unsigned int isr_status;
572 unsigned long flags;
573 bool hold_clear = false;
574 bool irq_save = false;
575
576 u32 addr;
577
578 id->p_recv_buf = id->p_msg->buf;
579 id->recv_count = id->p_msg->len;
580
581 /* Put the controller in master receive mode and clear the FIFO */
582 ctrl_reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
583 ctrl_reg |= CDNS_I2C_CR_RW | CDNS_I2C_CR_CLR_FIFO;
584
585 /*
586 * Receive up to I2C_SMBUS_BLOCK_MAX data bytes, plus one message length
587 * byte, plus one checksum byte if PEC is enabled. p_msg->len will be 2 if
588 * PEC is enabled, otherwise 1.
589 */
590 if (id->p_msg->flags & I2C_M_RECV_LEN)
591 id->recv_count = I2C_SMBUS_BLOCK_MAX + id->p_msg->len;
592
593 id->curr_recv_count = id->recv_count;
594
595 /*
596 * Check for the message size against FIFO depth and set the
597 * 'hold bus' bit if it is greater than FIFO depth.
598 */
599 if (id->recv_count > id->fifo_depth)
600 ctrl_reg |= CDNS_I2C_CR_HOLD;
601
602 cdns_i2c_writereg(ctrl_reg, CDNS_I2C_CR_OFFSET);
603
604 /* Clear the interrupts in interrupt status register */
605 isr_status = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
606 cdns_i2c_writereg(isr_status, CDNS_I2C_ISR_OFFSET);
607
608 /*
609 * The no. of bytes to receive is checked against the limit of
610 * max transfer size. Set transfer size register with no of bytes
611 * receive if it is less than transfer size and transfer size if
612 * it is more. Enable the interrupts.
613 */
614 if (id->recv_count > id->transfer_size) {
615 cdns_i2c_writereg(id->transfer_size,
616 CDNS_I2C_XFER_SIZE_OFFSET);
617 id->curr_recv_count = id->transfer_size;
618 } else {
619 cdns_i2c_writereg(id->recv_count, CDNS_I2C_XFER_SIZE_OFFSET);
620 }
621
622 /* Determine hold_clear based on number of bytes to receive and hold flag */
623 if (!id->bus_hold_flag && id->recv_count <= id->fifo_depth) {
624 if (ctrl_reg & CDNS_I2C_CR_HOLD) {
625 hold_clear = true;
626 if (id->quirks & CDNS_I2C_BROKEN_HOLD_BIT)
627 irq_save = true;
628 }
629 }
630
631 addr = id->p_msg->addr;
632 addr &= CDNS_I2C_ADDR_MASK;
633
634 if (hold_clear) {
635 ctrl_reg &= ~CDNS_I2C_CR_HOLD;
636 ctrl_reg &= ~CDNS_I2C_CR_CLR_FIFO;
637 /*
638 * In case of Xilinx Zynq SOC, clear the HOLD bit before transfer size
639 * register reaches '0'. This is an IP bug which causes transfer size
640 * register overflow to 0xFF. To satisfy this timing requirement,
641 * disable the interrupts on current processor core between register
642 * writes to slave address register and control register.
643 */
644 if (irq_save)
645 local_irq_save(flags);
646
647 cdns_i2c_writereg(addr, CDNS_I2C_ADDR_OFFSET);
648 cdns_i2c_writereg(ctrl_reg, CDNS_I2C_CR_OFFSET);
649 /* Read it back to avoid bufferring and make sure write happens */
650 cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
651
652 if (irq_save)
653 local_irq_restore(flags);
654 } else {
655 cdns_i2c_writereg(addr, CDNS_I2C_ADDR_OFFSET);
656 }
657
658 cdns_i2c_writereg(CDNS_I2C_ENABLED_INTR_MASK, CDNS_I2C_IER_OFFSET);
659}
660
661/**
662 * cdns_i2c_msend - Prepare and start a master send operation
663 * @id: pointer to the i2c device
664 */
665static void cdns_i2c_msend(struct cdns_i2c *id)
666{
667 unsigned int avail_bytes;
668 unsigned int bytes_to_send;
669 unsigned int ctrl_reg;
670 unsigned int isr_status;
671
672 id->p_recv_buf = NULL;
673 id->p_send_buf = id->p_msg->buf;
674 id->send_count = id->p_msg->len;
675
676 /* Set the controller in Master transmit mode and clear the FIFO. */
677 ctrl_reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
678 ctrl_reg &= ~CDNS_I2C_CR_RW;
679 ctrl_reg |= CDNS_I2C_CR_CLR_FIFO;
680
681 /*
682 * Check for the message size against FIFO depth and set the
683 * 'hold bus' bit if it is greater than FIFO depth.
684 */
685 if (id->send_count > id->fifo_depth)
686 ctrl_reg |= CDNS_I2C_CR_HOLD;
687 cdns_i2c_writereg(ctrl_reg, CDNS_I2C_CR_OFFSET);
688
689 /* Clear the interrupts in interrupt status register. */
690 isr_status = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
691 cdns_i2c_writereg(isr_status, CDNS_I2C_ISR_OFFSET);
692
693 /*
694 * Calculate the space available in FIFO. Check the message length
695 * against the space available, and fill the FIFO accordingly.
696 * Enable the interrupts.
697 */
698 avail_bytes = id->fifo_depth -
699 cdns_i2c_readreg(CDNS_I2C_XFER_SIZE_OFFSET);
700
701 if (id->send_count > avail_bytes)
702 bytes_to_send = avail_bytes;
703 else
704 bytes_to_send = id->send_count;
705
706 while (bytes_to_send--) {
707 cdns_i2c_writereg((*(id->p_send_buf)++), CDNS_I2C_DATA_OFFSET);
708 id->send_count--;
709 }
710
711 /*
712 * Clear the bus hold flag if there is no more data
713 * and if it is the last message.
714 */
715 if (!id->bus_hold_flag && !id->send_count)
716 cdns_i2c_clear_bus_hold(id);
717 /* Set the slave address in address register - triggers operation. */
718 cdns_i2c_writereg(id->p_msg->addr & CDNS_I2C_ADDR_MASK,
719 CDNS_I2C_ADDR_OFFSET);
720
721 cdns_i2c_writereg(CDNS_I2C_ENABLED_INTR_MASK, CDNS_I2C_IER_OFFSET);
722}
723
724/**
725 * cdns_i2c_master_reset - Reset the interface
726 * @adap: pointer to the i2c adapter driver instance
727 *
728 * This function cleanup the fifos, clear the hold bit and status
729 * and disable the interrupts.
730 */
731static void cdns_i2c_master_reset(struct i2c_adapter *adap)
732{
733 struct cdns_i2c *id = adap->algo_data;
734 u32 regval;
735
736 /* Disable the interrupts */
737 cdns_i2c_writereg(CDNS_I2C_IXR_ALL_INTR_MASK, CDNS_I2C_IDR_OFFSET);
738 /* Clear the hold bit and fifos */
739 regval = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
740 regval &= ~CDNS_I2C_CR_HOLD;
741 regval |= CDNS_I2C_CR_CLR_FIFO;
742 cdns_i2c_writereg(regval, CDNS_I2C_CR_OFFSET);
743 /* Update the transfercount register to zero */
744 cdns_i2c_writereg(0, CDNS_I2C_XFER_SIZE_OFFSET);
745 /* Clear the interrupt status register */
746 regval = cdns_i2c_readreg(CDNS_I2C_ISR_OFFSET);
747 cdns_i2c_writereg(regval, CDNS_I2C_ISR_OFFSET);
748 /* Clear the status register */
749 regval = cdns_i2c_readreg(CDNS_I2C_SR_OFFSET);
750 cdns_i2c_writereg(regval, CDNS_I2C_SR_OFFSET);
751}
752
753static int cdns_i2c_process_msg(struct cdns_i2c *id, struct i2c_msg *msg,
754 struct i2c_adapter *adap)
755{
756 unsigned long time_left, msg_timeout;
757 u32 reg;
758
759 id->p_msg = msg;
760 id->err_status = 0;
761 reinit_completion(&id->xfer_done);
762
763 /* Check for the TEN Bit mode on each msg */
764 reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
765 if (msg->flags & I2C_M_TEN) {
766 if (reg & CDNS_I2C_CR_NEA)
767 cdns_i2c_writereg(reg & ~CDNS_I2C_CR_NEA,
768 CDNS_I2C_CR_OFFSET);
769 } else {
770 if (!(reg & CDNS_I2C_CR_NEA))
771 cdns_i2c_writereg(reg | CDNS_I2C_CR_NEA,
772 CDNS_I2C_CR_OFFSET);
773 }
774
775 /* Check for the R/W flag on each msg */
776 if (msg->flags & I2C_M_RD)
777 cdns_i2c_mrecv(id);
778 else
779 cdns_i2c_msend(id);
780
781 /* Minimal time to execute this message */
782 msg_timeout = msecs_to_jiffies((1000 * msg->len * BITS_PER_BYTE) / id->i2c_clk);
783 /* Plus some wiggle room */
784 msg_timeout += msecs_to_jiffies(500);
785
786 if (msg_timeout < adap->timeout)
787 msg_timeout = adap->timeout;
788
789 /* Wait for the signal of completion */
790 time_left = wait_for_completion_timeout(&id->xfer_done, msg_timeout);
791 if (time_left == 0) {
792 cdns_i2c_master_reset(adap);
793 dev_err(id->adap.dev.parent,
794 "timeout waiting on completion\n");
795 return -ETIMEDOUT;
796 }
797
798 cdns_i2c_writereg(CDNS_I2C_IXR_ALL_INTR_MASK,
799 CDNS_I2C_IDR_OFFSET);
800
801 /* If it is bus arbitration error, try again */
802 if (id->err_status & CDNS_I2C_IXR_ARB_LOST)
803 return -EAGAIN;
804
805 if (msg->flags & I2C_M_RECV_LEN)
806 msg->len += min_t(unsigned int, msg->buf[0], I2C_SMBUS_BLOCK_MAX);
807
808 return 0;
809}
810
811/**
812 * cdns_i2c_master_xfer - The main i2c transfer function
813 * @adap: pointer to the i2c adapter driver instance
814 * @msgs: pointer to the i2c message structure
815 * @num: the number of messages to transfer
816 *
817 * Initiates the send/recv activity based on the transfer message received.
818 *
819 * Return: number of msgs processed on success, negative error otherwise
820 */
821static int cdns_i2c_master_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
822 int num)
823{
824 int ret, count;
825 u32 reg;
826 struct cdns_i2c *id = adap->algo_data;
827 bool hold_quirk;
828#if IS_ENABLED(CONFIG_I2C_SLAVE)
829 bool change_role = false;
830#endif
831
832 ret = pm_runtime_resume_and_get(id->dev);
833 if (ret < 0)
834 return ret;
835
836#if IS_ENABLED(CONFIG_I2C_SLAVE)
837 /* Check i2c operating mode and switch if possible */
838 if (id->dev_mode == CDNS_I2C_MODE_SLAVE) {
839 if (id->slave_state != CDNS_I2C_SLAVE_STATE_IDLE) {
840 ret = -EAGAIN;
841 goto out;
842 }
843
844 /* Set mode to master */
845 cdns_i2c_set_mode(CDNS_I2C_MODE_MASTER, id);
846
847 /* Mark flag to change role once xfer is completed */
848 change_role = true;
849 }
850#endif
851
852 /* Check if the bus is free */
853
854 ret = readl_relaxed_poll_timeout(id->membase + CDNS_I2C_SR_OFFSET,
855 reg,
856 !(reg & CDNS_I2C_SR_BA),
857 CDNS_I2C_POLL_US, CDNS_I2C_TIMEOUT_US);
858 if (ret) {
859 ret = -EAGAIN;
860 if (id->adap.bus_recovery_info)
861 i2c_recover_bus(adap);
862 goto out;
863 }
864
865 hold_quirk = !!(id->quirks & CDNS_I2C_BROKEN_HOLD_BIT);
866 /*
867 * Set the flag to one when multiple messages are to be
868 * processed with a repeated start.
869 */
870 if (num > 1) {
871 /*
872 * This controller does not give completion interrupt after a
873 * master receive message if HOLD bit is set (repeated start),
874 * resulting in SW timeout. Hence, if a receive message is
875 * followed by any other message, an error is returned
876 * indicating that this sequence is not supported.
877 */
878 for (count = 0; (count < num - 1 && hold_quirk); count++) {
879 if (msgs[count].flags & I2C_M_RD) {
880 dev_warn(adap->dev.parent,
881 "Can't do repeated start after a receive message\n");
882 ret = -EOPNOTSUPP;
883 goto out;
884 }
885 }
886 id->bus_hold_flag = 1;
887 reg = cdns_i2c_readreg(CDNS_I2C_CR_OFFSET);
888 reg |= CDNS_I2C_CR_HOLD;
889 cdns_i2c_writereg(reg, CDNS_I2C_CR_OFFSET);
890 } else {
891 id->bus_hold_flag = 0;
892 }
893
894 /* Process the msg one by one */
895 for (count = 0; count < num; count++, msgs++) {
896 if (count == (num - 1))
897 id->bus_hold_flag = 0;
898
899 ret = cdns_i2c_process_msg(id, msgs, adap);
900 if (ret)
901 goto out;
902
903 /* Report the other error interrupts to application */
904 if (id->err_status) {
905 cdns_i2c_master_reset(adap);
906
907 if (id->err_status & CDNS_I2C_IXR_NACK) {
908 ret = -ENXIO;
909 goto out;
910 }
911 ret = -EIO;
912 goto out;
913 }
914 }
915
916 ret = num;
917
918out:
919
920#if IS_ENABLED(CONFIG_I2C_SLAVE)
921 /* Switch i2c mode to slave */
922 if (change_role)
923 cdns_i2c_set_mode(CDNS_I2C_MODE_SLAVE, id);
924#endif
925
926 pm_runtime_mark_last_busy(id->dev);
927 pm_runtime_put_autosuspend(id->dev);
928 return ret;
929}
930
931/**
932 * cdns_i2c_func - Returns the supported features of the I2C driver
933 * @adap: pointer to the i2c adapter structure
934 *
935 * Return: 32 bit value, each bit corresponding to a feature
936 */
937static u32 cdns_i2c_func(struct i2c_adapter *adap)
938{
939 u32 func = I2C_FUNC_I2C | I2C_FUNC_10BIT_ADDR |
940 (I2C_FUNC_SMBUS_EMUL & ~I2C_FUNC_SMBUS_QUICK) |
941 I2C_FUNC_SMBUS_BLOCK_DATA;
942
943#if IS_ENABLED(CONFIG_I2C_SLAVE)
944 func |= I2C_FUNC_SLAVE;
945#endif
946
947 return func;
948}
949
950#if IS_ENABLED(CONFIG_I2C_SLAVE)
951static int cdns_reg_slave(struct i2c_client *slave)
952{
953 int ret;
954 struct cdns_i2c *id = container_of(slave->adapter, struct cdns_i2c,
955 adap);
956
957 if (id->slave)
958 return -EBUSY;
959
960 if (slave->flags & I2C_CLIENT_TEN)
961 return -EAFNOSUPPORT;
962
963 ret = pm_runtime_resume_and_get(id->dev);
964 if (ret < 0)
965 return ret;
966
967 /* Store slave information */
968 id->slave = slave;
969
970 /* Enable I2C slave */
971 cdns_i2c_set_mode(CDNS_I2C_MODE_SLAVE, id);
972
973 return 0;
974}
975
976static int cdns_unreg_slave(struct i2c_client *slave)
977{
978 struct cdns_i2c *id = container_of(slave->adapter, struct cdns_i2c,
979 adap);
980
981 pm_runtime_put(id->dev);
982
983 /* Remove slave information */
984 id->slave = NULL;
985
986 /* Enable I2C master */
987 cdns_i2c_set_mode(CDNS_I2C_MODE_MASTER, id);
988
989 return 0;
990}
991#endif
992
993static const struct i2c_algorithm cdns_i2c_algo = {
994 .master_xfer = cdns_i2c_master_xfer,
995 .functionality = cdns_i2c_func,
996#if IS_ENABLED(CONFIG_I2C_SLAVE)
997 .reg_slave = cdns_reg_slave,
998 .unreg_slave = cdns_unreg_slave,
999#endif
1000};
1001
1002/**
1003 * cdns_i2c_calc_divs - Calculate clock dividers
1004 * @f: I2C clock frequency
1005 * @input_clk: Input clock frequency
1006 * @a: First divider (return value)
1007 * @b: Second divider (return value)
1008 *
1009 * f is used as input and output variable. As input it is used as target I2C
1010 * frequency. On function exit f holds the actually resulting I2C frequency.
1011 *
1012 * Return: 0 on success, negative errno otherwise.
1013 */
1014static int cdns_i2c_calc_divs(unsigned long *f, unsigned long input_clk,
1015 unsigned int *a, unsigned int *b)
1016{
1017 unsigned long fscl = *f, best_fscl = *f, actual_fscl, temp;
1018 unsigned int div_a, div_b, calc_div_a = 0, calc_div_b = 0;
1019 unsigned int last_error, current_error;
1020
1021 /* calculate (divisor_a+1) x (divisor_b+1) */
1022 temp = input_clk / (22 * fscl);
1023
1024 /*
1025 * If the calculated value is negative or 0, the fscl input is out of
1026 * range. Return error.
1027 */
1028 if (!temp || (temp > (CDNS_I2C_DIVA_MAX * CDNS_I2C_DIVB_MAX)))
1029 return -EINVAL;
1030
1031 last_error = -1;
1032 for (div_a = 0; div_a < CDNS_I2C_DIVA_MAX; div_a++) {
1033 div_b = DIV_ROUND_UP(input_clk, 22 * fscl * (div_a + 1));
1034
1035 if ((div_b < 1) || (div_b > CDNS_I2C_DIVB_MAX))
1036 continue;
1037 div_b--;
1038
1039 actual_fscl = input_clk / (22 * (div_a + 1) * (div_b + 1));
1040
1041 if (actual_fscl > fscl)
1042 continue;
1043
1044 current_error = fscl - actual_fscl;
1045
1046 if (last_error > current_error) {
1047 calc_div_a = div_a;
1048 calc_div_b = div_b;
1049 best_fscl = actual_fscl;
1050 last_error = current_error;
1051 }
1052 }
1053
1054 *a = calc_div_a;
1055 *b = calc_div_b;
1056 *f = best_fscl;
1057
1058 return 0;
1059}
1060
1061/**
1062 * cdns_i2c_setclk - This function sets the serial clock rate for the I2C device
1063 * @clk_in: I2C clock input frequency in Hz
1064 * @id: Pointer to the I2C device structure
1065 *
1066 * The device must be idle rather than busy transferring data before setting
1067 * these device options.
1068 * The data rate is set by values in the control register.
1069 * The formula for determining the correct register values is
1070 * Fscl = Fpclk/(22 x (divisor_a+1) x (divisor_b+1))
1071 * See the hardware data sheet for a full explanation of setting the serial
1072 * clock rate. The clock can not be faster than the input clock divide by 22.
1073 * The two most common clock rates are 100KHz and 400KHz.
1074 *
1075 * Return: 0 on success, negative error otherwise
1076 */
1077static int cdns_i2c_setclk(unsigned long clk_in, struct cdns_i2c *id)
1078{
1079 unsigned int div_a, div_b;
1080 unsigned int ctrl_reg;
1081 int ret = 0;
1082 unsigned long fscl = id->i2c_clk;
1083
1084 ret = cdns_i2c_calc_divs(&fscl, clk_in, &div_a, &div_b);
1085 if (ret)
1086 return ret;
1087
1088 ctrl_reg = id->ctrl_reg;
1089 ctrl_reg &= ~(CDNS_I2C_CR_DIVA_MASK | CDNS_I2C_CR_DIVB_MASK);
1090 ctrl_reg |= ((div_a << CDNS_I2C_CR_DIVA_SHIFT) |
1091 (div_b << CDNS_I2C_CR_DIVB_SHIFT));
1092 id->ctrl_reg = ctrl_reg;
1093 cdns_i2c_writereg(ctrl_reg, CDNS_I2C_CR_OFFSET);
1094#if IS_ENABLED(CONFIG_I2C_SLAVE)
1095 id->ctrl_reg_diva_divb = ctrl_reg & (CDNS_I2C_CR_DIVA_MASK |
1096 CDNS_I2C_CR_DIVB_MASK);
1097#endif
1098 return 0;
1099}
1100
1101/**
1102 * cdns_i2c_clk_notifier_cb - Clock rate change callback
1103 * @nb: Pointer to notifier block
1104 * @event: Notification reason
1105 * @data: Pointer to notification data object
1106 *
1107 * This function is called when the cdns_i2c input clock frequency changes.
1108 * The callback checks whether a valid bus frequency can be generated after the
1109 * change. If so, the change is acknowledged, otherwise the change is aborted.
1110 * New dividers are written to the HW in the pre- or post change notification
1111 * depending on the scaling direction.
1112 *
1113 * Return: NOTIFY_STOP if the rate change should be aborted, NOTIFY_OK
1114 * to acknowledge the change, NOTIFY_DONE if the notification is
1115 * considered irrelevant.
1116 */
1117static int cdns_i2c_clk_notifier_cb(struct notifier_block *nb, unsigned long
1118 event, void *data)
1119{
1120 struct clk_notifier_data *ndata = data;
1121 struct cdns_i2c *id = to_cdns_i2c(nb);
1122
1123 if (pm_runtime_suspended(id->dev))
1124 return NOTIFY_OK;
1125
1126 switch (event) {
1127 case PRE_RATE_CHANGE:
1128 {
1129 unsigned long input_clk = ndata->new_rate;
1130 unsigned long fscl = id->i2c_clk;
1131 unsigned int div_a, div_b;
1132 int ret;
1133
1134 ret = cdns_i2c_calc_divs(&fscl, input_clk, &div_a, &div_b);
1135 if (ret) {
1136 dev_warn(id->adap.dev.parent,
1137 "clock rate change rejected\n");
1138 return NOTIFY_STOP;
1139 }
1140
1141 /* scale up */
1142 if (ndata->new_rate > ndata->old_rate)
1143 cdns_i2c_setclk(ndata->new_rate, id);
1144
1145 return NOTIFY_OK;
1146 }
1147 case POST_RATE_CHANGE:
1148 id->input_clk = ndata->new_rate;
1149 /* scale down */
1150 if (ndata->new_rate < ndata->old_rate)
1151 cdns_i2c_setclk(ndata->new_rate, id);
1152 return NOTIFY_OK;
1153 case ABORT_RATE_CHANGE:
1154 /* scale up */
1155 if (ndata->new_rate > ndata->old_rate)
1156 cdns_i2c_setclk(ndata->old_rate, id);
1157 return NOTIFY_OK;
1158 default:
1159 return NOTIFY_DONE;
1160 }
1161}
1162
1163/**
1164 * cdns_i2c_runtime_suspend - Runtime suspend method for the driver
1165 * @dev: Address of the platform_device structure
1166 *
1167 * Put the driver into low power mode.
1168 *
1169 * Return: 0 always
1170 */
1171static int __maybe_unused cdns_i2c_runtime_suspend(struct device *dev)
1172{
1173 struct cdns_i2c *xi2c = dev_get_drvdata(dev);
1174
1175 clk_disable(xi2c->clk);
1176
1177 return 0;
1178}
1179
1180static int __maybe_unused cdns_i2c_suspend(struct device *dev)
1181{
1182 struct cdns_i2c *xi2c = dev_get_drvdata(dev);
1183
1184 i2c_mark_adapter_suspended(&xi2c->adap);
1185
1186 if (!pm_runtime_status_suspended(dev))
1187 return cdns_i2c_runtime_suspend(dev);
1188
1189 return 0;
1190}
1191
1192/**
1193 * cdns_i2c_init - Controller initialisation
1194 * @id: Device private data structure
1195 *
1196 * Initialise the i2c controller.
1197 *
1198 */
1199static void cdns_i2c_init(struct cdns_i2c *id)
1200{
1201 cdns_i2c_writereg(id->ctrl_reg, CDNS_I2C_CR_OFFSET);
1202 /*
1203 * Cadence I2C controller has a bug wherein it generates
1204 * invalid read transaction after HW timeout in master receiver mode.
1205 * HW timeout is not used by this driver and the interrupt is disabled.
1206 * But the feature itself cannot be disabled. Hence maximum value
1207 * is written to this register to reduce the chances of error.
1208 */
1209 cdns_i2c_writereg(CDNS_I2C_TIMEOUT_MAX, CDNS_I2C_TIME_OUT_OFFSET);
1210}
1211
1212/**
1213 * cdns_i2c_runtime_resume - Runtime resume
1214 * @dev: Address of the platform_device structure
1215 *
1216 * Runtime resume callback.
1217 *
1218 * Return: 0 on success and error value on error
1219 */
1220static int __maybe_unused cdns_i2c_runtime_resume(struct device *dev)
1221{
1222 struct cdns_i2c *xi2c = dev_get_drvdata(dev);
1223 int ret;
1224
1225 ret = clk_enable(xi2c->clk);
1226 if (ret) {
1227 dev_err(dev, "Cannot enable clock.\n");
1228 return ret;
1229 }
1230 cdns_i2c_init(xi2c);
1231
1232 return 0;
1233}
1234
1235static int __maybe_unused cdns_i2c_resume(struct device *dev)
1236{
1237 struct cdns_i2c *xi2c = dev_get_drvdata(dev);
1238 int err;
1239
1240 err = cdns_i2c_runtime_resume(dev);
1241 if (err)
1242 return err;
1243
1244 if (pm_runtime_status_suspended(dev)) {
1245 err = cdns_i2c_runtime_suspend(dev);
1246 if (err)
1247 return err;
1248 }
1249
1250 i2c_mark_adapter_resumed(&xi2c->adap);
1251
1252 return 0;
1253}
1254
1255static const struct dev_pm_ops cdns_i2c_dev_pm_ops = {
1256 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(cdns_i2c_suspend, cdns_i2c_resume)
1257 SET_RUNTIME_PM_OPS(cdns_i2c_runtime_suspend,
1258 cdns_i2c_runtime_resume, NULL)
1259};
1260
1261static const struct cdns_platform_data r1p10_i2c_def = {
1262 .quirks = CDNS_I2C_BROKEN_HOLD_BIT,
1263};
1264
1265static const struct of_device_id cdns_i2c_of_match[] = {
1266 { .compatible = "cdns,i2c-r1p10", .data = &r1p10_i2c_def },
1267 { .compatible = "cdns,i2c-r1p14",},
1268 { /* end of table */ }
1269};
1270MODULE_DEVICE_TABLE(of, cdns_i2c_of_match);
1271
1272/**
1273 * cdns_i2c_detect_transfer_size - Detect the maximum transfer size supported
1274 * @id: Device private data structure
1275 *
1276 * Detect the maximum transfer size that is supported by this instance of the
1277 * Cadence I2C controller.
1278 */
1279static void cdns_i2c_detect_transfer_size(struct cdns_i2c *id)
1280{
1281 u32 val;
1282
1283 /*
1284 * Writing to the transfer size register is only possible if these two bits
1285 * are set in the control register.
1286 */
1287 cdns_i2c_writereg(CDNS_I2C_CR_MS | CDNS_I2C_CR_RW, CDNS_I2C_CR_OFFSET);
1288
1289 /*
1290 * The number of writable bits of the transfer size register can be between
1291 * 4 and 8. This is a controlled through a synthesis parameter of the IP
1292 * core and can vary from instance to instance. The unused MSBs always read
1293 * back as 0. Writing 0xff and then reading the value back will report the
1294 * maximum supported transfer size.
1295 */
1296 cdns_i2c_writereg(CDNS_I2C_MAX_TRANSFER_SIZE, CDNS_I2C_XFER_SIZE_OFFSET);
1297 val = cdns_i2c_readreg(CDNS_I2C_XFER_SIZE_OFFSET);
1298 id->transfer_size = CDNS_I2C_TRANSFER_SIZE(val);
1299 cdns_i2c_writereg(0, CDNS_I2C_XFER_SIZE_OFFSET);
1300 cdns_i2c_writereg(0, CDNS_I2C_CR_OFFSET);
1301}
1302
1303/**
1304 * cdns_i2c_probe - Platform registration call
1305 * @pdev: Handle to the platform device structure
1306 *
1307 * This function does all the memory allocation and registration for the i2c
1308 * device. User can modify the address mode to 10 bit address mode using the
1309 * ioctl call with option I2C_TENBIT.
1310 *
1311 * Return: 0 on success, negative error otherwise
1312 */
1313static int cdns_i2c_probe(struct platform_device *pdev)
1314{
1315 struct resource *r_mem;
1316 struct cdns_i2c *id;
1317 int ret, irq;
1318 const struct of_device_id *match;
1319
1320 id = devm_kzalloc(&pdev->dev, sizeof(*id), GFP_KERNEL);
1321 if (!id)
1322 return -ENOMEM;
1323
1324 id->dev = &pdev->dev;
1325 platform_set_drvdata(pdev, id);
1326
1327 match = of_match_node(cdns_i2c_of_match, pdev->dev.of_node);
1328 if (match && match->data) {
1329 const struct cdns_platform_data *data = match->data;
1330 id->quirks = data->quirks;
1331 }
1332
1333 id->rinfo.pinctrl = devm_pinctrl_get(&pdev->dev);
1334 if (IS_ERR(id->rinfo.pinctrl)) {
1335 int err = PTR_ERR(id->rinfo.pinctrl);
1336
1337 dev_info(&pdev->dev, "can't get pinctrl, bus recovery not supported\n");
1338 if (err != -ENODEV)
1339 return err;
1340 } else {
1341 id->adap.bus_recovery_info = &id->rinfo;
1342 }
1343
1344 id->membase = devm_platform_get_and_ioremap_resource(pdev, 0, &r_mem);
1345 if (IS_ERR(id->membase))
1346 return PTR_ERR(id->membase);
1347
1348 irq = platform_get_irq(pdev, 0);
1349 if (irq < 0)
1350 return irq;
1351
1352 id->adap.owner = THIS_MODULE;
1353 id->adap.dev.of_node = pdev->dev.of_node;
1354 id->adap.algo = &cdns_i2c_algo;
1355 id->adap.timeout = CDNS_I2C_TIMEOUT;
1356 id->adap.retries = 3; /* Default retry value. */
1357 id->adap.algo_data = id;
1358 id->adap.dev.parent = &pdev->dev;
1359 init_completion(&id->xfer_done);
1360 snprintf(id->adap.name, sizeof(id->adap.name),
1361 "Cadence I2C at %08lx", (unsigned long)r_mem->start);
1362
1363 id->clk = devm_clk_get(&pdev->dev, NULL);
1364 if (IS_ERR(id->clk))
1365 return dev_err_probe(&pdev->dev, PTR_ERR(id->clk),
1366 "input clock not found.\n");
1367
1368 id->reset = devm_reset_control_get_optional_shared(&pdev->dev, NULL);
1369 if (IS_ERR(id->reset))
1370 return dev_err_probe(&pdev->dev, PTR_ERR(id->reset),
1371 "Failed to request reset.\n");
1372
1373 ret = clk_prepare_enable(id->clk);
1374 if (ret)
1375 dev_err(&pdev->dev, "Unable to enable clock.\n");
1376
1377 ret = reset_control_deassert(id->reset);
1378 if (ret) {
1379 dev_err_probe(&pdev->dev, ret,
1380 "Failed to de-assert reset.\n");
1381 goto err_clk_dis;
1382 }
1383
1384 pm_runtime_set_autosuspend_delay(id->dev, CNDS_I2C_PM_TIMEOUT);
1385 pm_runtime_use_autosuspend(id->dev);
1386 pm_runtime_set_active(id->dev);
1387 pm_runtime_enable(id->dev);
1388
1389 id->clk_rate_change_nb.notifier_call = cdns_i2c_clk_notifier_cb;
1390 if (clk_notifier_register(id->clk, &id->clk_rate_change_nb))
1391 dev_warn(&pdev->dev, "Unable to register clock notifier.\n");
1392 id->input_clk = clk_get_rate(id->clk);
1393
1394 ret = of_property_read_u32(pdev->dev.of_node, "clock-frequency",
1395 &id->i2c_clk);
1396 if (ret || (id->i2c_clk > I2C_MAX_FAST_MODE_FREQ))
1397 id->i2c_clk = I2C_MAX_STANDARD_MODE_FREQ;
1398
1399#if IS_ENABLED(CONFIG_I2C_SLAVE)
1400 /* Set initial mode to master */
1401 id->dev_mode = CDNS_I2C_MODE_MASTER;
1402 id->slave_state = CDNS_I2C_SLAVE_STATE_IDLE;
1403#endif
1404 id->ctrl_reg = CDNS_I2C_CR_ACK_EN | CDNS_I2C_CR_NEA | CDNS_I2C_CR_MS;
1405
1406 id->fifo_depth = CDNS_I2C_FIFO_DEPTH_DEFAULT;
1407 of_property_read_u32(pdev->dev.of_node, "fifo-depth", &id->fifo_depth);
1408
1409 cdns_i2c_detect_transfer_size(id);
1410
1411 ret = cdns_i2c_setclk(id->input_clk, id);
1412 if (ret) {
1413 dev_err(&pdev->dev, "invalid SCL clock: %u Hz\n", id->i2c_clk);
1414 ret = -EINVAL;
1415 goto err_clk_notifier_unregister;
1416 }
1417
1418 ret = devm_request_irq(&pdev->dev, irq, cdns_i2c_isr, 0,
1419 DRIVER_NAME, id);
1420 if (ret) {
1421 dev_err(&pdev->dev, "cannot get irq %d\n", irq);
1422 goto err_clk_notifier_unregister;
1423 }
1424 cdns_i2c_init(id);
1425
1426 ret = i2c_add_adapter(&id->adap);
1427 if (ret < 0)
1428 goto err_clk_notifier_unregister;
1429
1430 dev_info(&pdev->dev, "%u kHz mmio %08lx irq %d\n",
1431 id->i2c_clk / 1000, (unsigned long)r_mem->start, irq);
1432
1433 return 0;
1434
1435err_clk_notifier_unregister:
1436 clk_notifier_unregister(id->clk, &id->clk_rate_change_nb);
1437 reset_control_assert(id->reset);
1438err_clk_dis:
1439 clk_disable_unprepare(id->clk);
1440 pm_runtime_disable(&pdev->dev);
1441 pm_runtime_set_suspended(&pdev->dev);
1442 return ret;
1443}
1444
1445/**
1446 * cdns_i2c_remove - Unregister the device after releasing the resources
1447 * @pdev: Handle to the platform device structure
1448 *
1449 * This function frees all the resources allocated to the device.
1450 *
1451 * Return: 0 always
1452 */
1453static void cdns_i2c_remove(struct platform_device *pdev)
1454{
1455 struct cdns_i2c *id = platform_get_drvdata(pdev);
1456
1457 pm_runtime_disable(&pdev->dev);
1458 pm_runtime_set_suspended(&pdev->dev);
1459 pm_runtime_dont_use_autosuspend(&pdev->dev);
1460
1461 i2c_del_adapter(&id->adap);
1462 clk_notifier_unregister(id->clk, &id->clk_rate_change_nb);
1463 reset_control_assert(id->reset);
1464 clk_disable_unprepare(id->clk);
1465}
1466
1467static struct platform_driver cdns_i2c_drv = {
1468 .driver = {
1469 .name = DRIVER_NAME,
1470 .of_match_table = cdns_i2c_of_match,
1471 .pm = &cdns_i2c_dev_pm_ops,
1472 },
1473 .probe = cdns_i2c_probe,
1474 .remove_new = cdns_i2c_remove,
1475};
1476
1477module_platform_driver(cdns_i2c_drv);
1478
1479MODULE_AUTHOR("Xilinx Inc.");
1480MODULE_DESCRIPTION("Cadence I2C bus driver");
1481MODULE_LICENSE("GPL");