i2c-sh_mobile.c 28.4 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2
3
4
/*
 * SuperH Mobile I2C Controller
 *
5
 * Copyright (C) 2014-19 Wolfram Sang <wsa@sang-engineering.com>
6
7
8
9
10
11
 * Copyright (C) 2008 Magnus Damm
 *
 * Portions of the code based on out-of-tree driver i2c-sh7343.c
 * Copyright (c) 2006 Carlos Munoz <carlos@kenati.com>
 */

12
13
#include <linux/clk.h>
#include <linux/delay.h>
Wolfram Sang's avatar
Wolfram Sang committed
14
15
#include <linux/dmaengine.h>
#include <linux/dma-mapping.h>
16
17
18
19
20
#include <linux/err.h>
#include <linux/i2c.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/io.h>
21
22
#include <linux/kernel.h>
#include <linux/module.h>
23
#include <linux/of_device.h>
24
#include <linux/platform_device.h>
25
#include <linux/pm_runtime.h>
26
#include <linux/slab.h>
27

28
29
30
/* Transmit operation:                                                      */
/*                                                                          */
/* 0 byte transmit                                                          */
31
/* BUS:     S     A8     ACK   P(*)                                         */
32
33
/* IRQ:       DTE   WAIT                                                    */
/* ICIC:                                                                    */
34
/* ICCR: 0x94       0x90                                                    */
35
36
37
/* ICDR:      A8                                                            */
/*                                                                          */
/* 1 byte transmit                                                          */
38
/* BUS:     S     A8     ACK   D8(1)   ACK   P(*)                           */
39
40
/* IRQ:       DTE   WAIT         WAIT                                       */
/* ICIC:      -DTE                                                          */
41
/* ICCR: 0x94                    0x90                                       */
42
43
44
/* ICDR:      A8    D8(1)                                                   */
/*                                                                          */
/* 2 byte transmit                                                          */
45
/* BUS:     S     A8     ACK   D8(1)   ACK   D8(2)   ACK   P(*)             */
46
47
/* IRQ:       DTE   WAIT         WAIT          WAIT                         */
/* ICIC:      -DTE                                                          */
48
/* ICCR: 0x94                                  0x90                         */
49
50
51
52
53
54
55
56
57
58
/* ICDR:      A8    D8(1)        D8(2)                                      */
/*                                                                          */
/* 3 bytes or more, +---------+ gets repeated                               */
/*                                                                          */
/*                                                                          */
/* Receive operation:                                                       */
/*                                                                          */
/* 0 byte receive - not supported since slave may hold SDA low              */
/*                                                                          */
/* 1 byte receive       [TX] | [RX]                                         */
59
/* BUS:     S     A8     ACK | D8(1)   ACK   P(*)                           */
60
61
62
63
64
65
/* IRQ:       DTE   WAIT     |   WAIT     DTE                               */
/* ICIC:      -DTE           |   +DTE                                       */
/* ICCR: 0x94       0x81     |   0xc0                                       */
/* ICDR:      A8             |            D8(1)                             */
/*                                                                          */
/* 2 byte receive        [TX]| [RX]                                         */
66
/* BUS:     S     A8     ACK | D8(1)   ACK   D8(2)   ACK   P(*)             */
67
68
69
70
71
/* IRQ:       DTE   WAIT     |   WAIT          WAIT     DTE                 */
/* ICIC:      -DTE           |                 +DTE                         */
/* ICCR: 0x94       0x81     |                 0xc0                         */
/* ICDR:      A8             |                 D8(1)    D8(2)               */
/*                                                                          */
72
/* 3 byte receive       [TX] | [RX]                                     (*) */
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/* BUS:     S     A8     ACK | D8(1)   ACK   D8(2)   ACK   D8(3)   ACK    P */
/* IRQ:       DTE   WAIT     |   WAIT          WAIT         WAIT      DTE   */
/* ICIC:      -DTE           |                              +DTE            */
/* ICCR: 0x94       0x81     |                              0xc0            */
/* ICDR:      A8             |                 D8(1)        D8(2)     D8(3) */
/*                                                                          */
/* 4 bytes or more, this part is repeated    +---------+                    */
/*                                                                          */
/*                                                                          */
/* Interrupt order and BUSY flag                                            */
/*     ___                                                 _                */
/* SDA ___\___XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXAAAAAAAAA___/                 */
/* SCL      \_/1\_/2\_/3\_/4\_/5\_/6\_/7\_/8\___/9\_____/                   */
/*                                                                          */
87
/*        S   D7  D6  D5  D4  D3  D2  D1  D0              P(*)              */
88
89
90
91
92
93
94
95
/*                                           ___                            */
/* WAIT IRQ ________________________________/   \___________                */
/* TACK IRQ ____________________________________/   \_______                */
/* DTE  IRQ __________________________________________/   \_                */
/* AL   IRQ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX                */
/*         _______________________________________________                  */
/* BUSY __/                                               \_                */
/*                                                                          */
96
97
98
99
100
/* (*) The STOP condition is only sent by the master at the end of the last */
/* I2C message or if the I2C_M_STOP flag is set. Similarly, the BUSY bit is */
/* only cleared after the STOP condition, so, between messages we have to   */
/* poll for the DTE bit.                                                    */
/*                                                                          */
101

102
103
enum sh_mobile_i2c_op {
	OP_START = 0,
104
105
	OP_TX_FIRST,
	OP_TX,
106
107
	OP_TX_STOP,
	OP_TX_TO_RX,
108
	OP_RX,
109
	OP_RX_STOP,
110
	OP_RX_STOP_DATA,
111
112
113
114
115
116
};

struct sh_mobile_i2c_data {
	struct device *dev;
	void __iomem *reg;
	struct i2c_adapter adap;
117
	unsigned long bus_speed;
118
	unsigned int clks_per_count;
119
	struct clk *clk;
120
121
	u_int8_t icic;
	u_int8_t flags;
122
123
	u_int16_t iccl;
	u_int16_t icch;
124
125
126
127
128
129

	spinlock_t lock;
	wait_queue_head_t wait;
	struct i2c_msg *msg;
	int pos;
	int sr;
130
	bool send_stop;
131
	bool stop_after_dma;
132
	bool atomic_xfer;
Wolfram Sang's avatar
Wolfram Sang committed
133

134
	struct resource *res;
Wolfram Sang's avatar
Wolfram Sang committed
135
136
137
138
	struct dma_chan *dma_tx;
	struct dma_chan *dma_rx;
	struct scatterlist sg;
	enum dma_data_direction dma_direction;
139
	u8 *dma_buf;
140
141
};

142
143
struct sh_mobile_dt_config {
	int clks_per_count;
144
	int (*setup)(struct sh_mobile_i2c_data *pd);
145
146
};

147
148
#define IIC_FLAG_HAS_ICIC67	(1 << 0)

149
/* Register offsets */
150
151
152
153
154
155
#define ICDR			0x00
#define ICCR			0x04
#define ICSR			0x08
#define ICIC			0x0c
#define ICCL			0x10
#define ICCH			0x14
156
#define ICSTART			0x70
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

/* Register bits */
#define ICCR_ICE		0x80
#define ICCR_RACK		0x40
#define ICCR_TRS		0x10
#define ICCR_BBSY		0x04
#define ICCR_SCP		0x01

#define ICSR_SCLM		0x80
#define ICSR_SDAM		0x40
#define SW_DONE			0x20
#define ICSR_BUSY		0x10
#define ICSR_AL			0x08
#define ICSR_TACK		0x04
#define ICSR_WAIT		0x02
#define ICSR_DTE		0x01

174
175
#define ICIC_ICCLB8		0x80
#define ICIC_ICCHB8		0x40
Wolfram Sang's avatar
Wolfram Sang committed
176
177
#define ICIC_TDMAE		0x20
#define ICIC_RDMAE		0x10
178
179
180
181
182
#define ICIC_ALE		0x08
#define ICIC_TACKE		0x04
#define ICIC_WAITE		0x02
#define ICIC_DTEE		0x01

183
184
#define ICSTART_ICSTART		0x10

185
186
static void iic_wr(struct sh_mobile_i2c_data *pd, int offs, unsigned char data)
{
187
188
189
	if (offs == ICIC)
		data |= pd->icic;

190
191
192
193
194
195
196
197
198
199
200
201
202
203
	iowrite8(data, pd->reg + offs);
}

static unsigned char iic_rd(struct sh_mobile_i2c_data *pd, int offs)
{
	return ioread8(pd->reg + offs);
}

static void iic_set_clr(struct sh_mobile_i2c_data *pd, int offs,
			unsigned char set, unsigned char clr)
{
	iic_wr(pd, offs, (iic_rd(pd, offs) | set) & ~clr);
}

204
static u32 sh_mobile_i2c_iccl(unsigned long count_khz, u32 tLOW, u32 tf)
205
206
207
208
209
210
211
212
213
214
215
{
	/*
	 * Conditional expression:
	 *   ICCL >= COUNT_CLK * (tLOW + tf)
	 *
	 * SH-Mobile IIC hardware starts counting the LOW period of
	 * the SCL signal (tLOW) as soon as it pulls the SCL line.
	 * In order to meet the tLOW timing spec, we need to take into
	 * account the fall time of SCL signal (tf).  Default tf value
	 * should be 0.3 us, for safety.
	 */
216
	return (((count_khz * (tLOW + tf)) + 5000) / 10000);
217
218
}

219
static u32 sh_mobile_i2c_icch(unsigned long count_khz, u32 tHIGH, u32 tf)
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
{
	/*
	 * Conditional expression:
	 *   ICCH >= COUNT_CLK * (tHIGH + tf)
	 *
	 * SH-Mobile IIC hardware is aware of SCL transition period 'tr',
	 * and can ignore it.  SH-Mobile IIC controller starts counting
	 * the HIGH period of the SCL signal (tHIGH) after the SCL input
	 * voltage increases at VIH.
	 *
	 * Afterward it turned out calculating ICCH using only tHIGH spec
	 * will result in violation of the tHD;STA timing spec.  We need
	 * to take into account the fall time of SDA signal (tf) at START
	 * condition, in order to meet both tHIGH and tHD;STA specs.
	 */
235
	return (((count_khz * (tHIGH + tf)) + 5000) / 10000);
236
237
}

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
static int sh_mobile_i2c_check_timing(struct sh_mobile_i2c_data *pd)
{
	u16 max_val = pd->flags & IIC_FLAG_HAS_ICIC67 ? 0x1ff : 0xff;

	if (pd->iccl > max_val || pd->icch > max_val) {
		dev_err(pd->dev, "timing values out of range: L/H=0x%x/0x%x\n",
			pd->iccl, pd->icch);
		return -EINVAL;
	}

	/* one more bit of ICCL in ICIC */
	if (pd->iccl & 0x100)
		pd->icic |= ICIC_ICCLB8;
	else
		pd->icic &= ~ICIC_ICCLB8;

	/* one more bit of ICCH in ICIC */
	if (pd->icch & 0x100)
		pd->icic |= ICIC_ICCHB8;
	else
		pd->icic &= ~ICIC_ICCHB8;

	dev_dbg(pd->dev, "timing values: L/H=0x%x/0x%x\n", pd->iccl, pd->icch);
	return 0;
}

264
static int sh_mobile_i2c_init(struct sh_mobile_i2c_data *pd)
265
{
266
267
	unsigned long i2c_clk_khz;
	u32 tHIGH, tLOW, tf;
268

269
	i2c_clk_khz = clk_get_rate(pd->clk) / 1000 / pd->clks_per_count;
270

271
	if (pd->bus_speed == I2C_MAX_STANDARD_MODE_FREQ) {
272
273
274
		tLOW	= 47;	/* tLOW = 4.7 us */
		tHIGH	= 40;	/* tHD;STA = tHIGH = 4.0 us */
		tf	= 3;	/* tf = 0.3 us */
275
	} else if (pd->bus_speed == I2C_MAX_FAST_MODE_FREQ) {
276
277
278
279
280
281
		tLOW	= 13;	/* tLOW = 1.3 us */
		tHIGH	= 6;	/* tHD;STA = tHIGH = 0.6 us */
		tf	= 3;	/* tf = 0.3 us */
	} else {
		dev_err(pd->dev, "unrecognized bus speed %lu Hz\n",
			pd->bus_speed);
282
		return -EINVAL;
283
284
	}

285
	pd->iccl = sh_mobile_i2c_iccl(i2c_clk_khz, tLOW, tf);
286
287
	pd->icch = sh_mobile_i2c_icch(i2c_clk_khz, tHIGH, tf);

288
	return sh_mobile_i2c_check_timing(pd);
289
290
}

291
292
293
294
295
296
297
298
299
300
301
302
static int sh_mobile_i2c_v2_init(struct sh_mobile_i2c_data *pd)
{
	unsigned long clks_per_cycle;

	/* L = 5, H = 4, L + H = 9 */
	clks_per_cycle = clk_get_rate(pd->clk) / pd->bus_speed;
	pd->iccl = DIV_ROUND_UP(clks_per_cycle * 5 / 9 - 1, pd->clks_per_count);
	pd->icch = DIV_ROUND_UP(clks_per_cycle * 4 / 9 - 5, pd->clks_per_count);

	return sh_mobile_i2c_check_timing(pd);
}

303
static unsigned char i2c_op(struct sh_mobile_i2c_data *pd, enum sh_mobile_i2c_op op)
304
305
306
307
{
	unsigned char ret = 0;
	unsigned long flags;

308
	dev_dbg(pd->dev, "op %d\n", op);
309
310
311
312

	spin_lock_irqsave(&pd->lock, flags);

	switch (op) {
313
	case OP_START: /* issue start and trigger DTE interrupt */
314
		iic_wr(pd, ICCR, ICCR_ICE | ICCR_TRS | ICCR_BBSY);
315
		break;
316
	case OP_TX_FIRST: /* disable DTE interrupt and write client address */
317
		iic_wr(pd, ICIC, ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
318
		iic_wr(pd, ICDR, i2c_8bit_addr_from_msg(pd->msg));
319
		break;
320
	case OP_TX: /* write data */
321
		iic_wr(pd, ICDR, pd->msg->buf[pd->pos]);
322
		break;
323
	case OP_TX_STOP: /* issue a stop (or rep_start) */
324
325
		iic_wr(pd, ICCR, pd->send_stop ? ICCR_ICE | ICCR_TRS
					       : ICCR_ICE | ICCR_TRS | ICCR_BBSY);
326
327
		break;
	case OP_TX_TO_RX: /* select read mode */
328
		iic_wr(pd, ICCR, ICCR_ICE | ICCR_SCP);
329
		break;
330
	case OP_RX: /* just read data */
331
		ret = iic_rd(pd, ICDR);
332
		break;
333
	case OP_RX_STOP: /* enable DTE interrupt, issue stop */
334
335
336
		if (!pd->atomic_xfer)
			iic_wr(pd, ICIC,
			       ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
337
		iic_wr(pd, ICCR, ICCR_ICE | ICCR_RACK);
338
339
		break;
	case OP_RX_STOP_DATA: /* enable DTE interrupt, read data, issue stop */
340
341
342
		if (!pd->atomic_xfer)
			iic_wr(pd, ICIC,
			       ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
343
		ret = iic_rd(pd, ICDR);
344
		iic_wr(pd, ICCR, ICCR_ICE | ICCR_RACK);
345
346
347
348
349
350
351
352
353
		break;
	}

	spin_unlock_irqrestore(&pd->lock, flags);

	dev_dbg(pd->dev, "op %d, data out 0x%02x\n", op, ret);
	return ret;
}

354
355
static int sh_mobile_i2c_isr_tx(struct sh_mobile_i2c_data *pd)
{
Wolfram Sang's avatar
Wolfram Sang committed
356
	if (pd->pos == pd->msg->len) {
357
		i2c_op(pd, OP_TX_STOP);
358
		return 1;
Wolfram Sang's avatar
Wolfram Sang committed
359
	}
360

361
	if (pd->pos == -1)
362
363
364
		i2c_op(pd, OP_TX_FIRST);
	else
		i2c_op(pd, OP_TX);
365
366
367
368
369
370
371
372
373

	pd->pos++;
	return 0;
}

static int sh_mobile_i2c_isr_rx(struct sh_mobile_i2c_data *pd)
{
	int real_pos;

374
	/* switch from TX (address) to RX (data) adds two interrupts */
Wolfram Sang's avatar
Wolfram Sang committed
375
	real_pos = pd->pos - 2;
376

Wolfram Sang's avatar
Wolfram Sang committed
377
378
379
380
381
382
383
384
385
386
	if (pd->pos == -1) {
		i2c_op(pd, OP_TX_FIRST);
	} else if (pd->pos == 0) {
		i2c_op(pd, OP_TX_TO_RX);
	} else if (pd->pos == pd->msg->len) {
		if (pd->stop_after_dma) {
			/* Simulate PIO end condition after DMA transfer */
			i2c_op(pd, OP_RX_STOP);
			pd->pos++;
			goto done;
387
		}
388

Wolfram Sang's avatar
Wolfram Sang committed
389
390
391
		if (real_pos < 0)
			i2c_op(pd, OP_RX_STOP);
		else
392
			pd->msg->buf[real_pos] = i2c_op(pd, OP_RX_STOP_DATA);
Wolfram Sang's avatar
Wolfram Sang committed
393
	} else if (real_pos >= 0) {
394
		pd->msg->buf[real_pos] = i2c_op(pd, OP_RX);
Wolfram Sang's avatar
Wolfram Sang committed
395
	}
396

Wolfram Sang's avatar
Wolfram Sang committed
397
 done:
398
399
400
401
	pd->pos++;
	return pd->pos == (pd->msg->len + 2);
}

402
403
static irqreturn_t sh_mobile_i2c_isr(int irq, void *dev_id)
{
404
	struct sh_mobile_i2c_data *pd = dev_id;
405
	unsigned char sr;
Wolfram Sang's avatar
Wolfram Sang committed
406
	int wakeup = 0;
407

408
	sr = iic_rd(pd, ICSR);
409
	pd->sr |= sr; /* remember state */
410
411

	dev_dbg(pd->dev, "i2c_isr 0x%02x 0x%02x %s %d %d!\n", sr, pd->sr,
412
413
	       (pd->msg->flags & I2C_M_RD) ? "read" : "write",
	       pd->pos, pd->msg->len);
414

Wolfram Sang's avatar
Wolfram Sang committed
415
416
417
418
	/* Kick off TxDMA after preface was done */
	if (pd->dma_direction == DMA_TO_DEVICE && pd->pos == 0)
		iic_set_clr(pd, ICIC, ICIC_TDMAE, 0);
	else if (sr & (ICSR_AL | ICSR_TACK))
419
		/* don't interrupt transaction - continue to issue stop */
420
		iic_wr(pd, ICSR, sr & ~(ICSR_AL | ICSR_TACK));
Wolfram Sang's avatar
Wolfram Sang committed
421
	else if (pd->msg->flags & I2C_M_RD)
422
423
424
		wakeup = sh_mobile_i2c_isr_rx(pd);
	else
		wakeup = sh_mobile_i2c_isr_tx(pd);
425

Wolfram Sang's avatar
Wolfram Sang committed
426
427
428
429
	/* Kick off RxDMA after preface was done */
	if (pd->dma_direction == DMA_FROM_DEVICE && pd->pos == 1)
		iic_set_clr(pd, ICIC, ICIC_RDMAE, 0);

430
	if (sr & ICSR_WAIT) /* TODO: add delay here to support slow acks */
431
		iic_wr(pd, ICSR, sr & ~ICSR_WAIT);
432
433
434

	if (wakeup) {
		pd->sr |= SW_DONE;
435
436
		if (!pd->atomic_xfer)
			wake_up(&pd->wait);
437
438
	}

439
440
441
	/* defeat write posting to avoid spurious WAIT interrupts */
	iic_rd(pd, ICSR);

442
443
444
	return IRQ_HANDLED;
}

445
446
447
448
449
450
451
452
453
454
455
static void sh_mobile_i2c_dma_unmap(struct sh_mobile_i2c_data *pd)
{
	struct dma_chan *chan = pd->dma_direction == DMA_FROM_DEVICE
				? pd->dma_rx : pd->dma_tx;

	dma_unmap_single(chan->device->dev, sg_dma_address(&pd->sg),
			 pd->msg->len, pd->dma_direction);

	pd->dma_direction = DMA_NONE;
}

Wolfram Sang's avatar
Wolfram Sang committed
456
457
458
459
460
461
462
463
464
static void sh_mobile_i2c_cleanup_dma(struct sh_mobile_i2c_data *pd)
{
	if (pd->dma_direction == DMA_NONE)
		return;
	else if (pd->dma_direction == DMA_FROM_DEVICE)
		dmaengine_terminate_all(pd->dma_rx);
	else if (pd->dma_direction == DMA_TO_DEVICE)
		dmaengine_terminate_all(pd->dma_tx);

465
	sh_mobile_i2c_dma_unmap(pd);
Wolfram Sang's avatar
Wolfram Sang committed
466
467
468
469
470
471
}

static void sh_mobile_i2c_dma_callback(void *data)
{
	struct sh_mobile_i2c_data *pd = data;

472
	sh_mobile_i2c_dma_unmap(pd);
Wolfram Sang's avatar
Wolfram Sang committed
473
	pd->pos = pd->msg->len;
474
	pd->stop_after_dma = true;
Wolfram Sang's avatar
Wolfram Sang committed
475
476
477
478

	iic_set_clr(pd, ICIC, 0, ICIC_TDMAE | ICIC_RDMAE);
}

479
480
481
482
483
484
485
486
static struct dma_chan *sh_mobile_i2c_request_dma_chan(struct device *dev,
				enum dma_transfer_direction dir, dma_addr_t port_addr)
{
	struct dma_chan *chan;
	struct dma_slave_config cfg;
	char *chan_name = dir == DMA_MEM_TO_DEV ? "tx" : "rx";
	int ret;

487
	chan = dma_request_chan(dev, chan_name);
488
	if (IS_ERR(chan)) {
489
490
		dev_dbg(dev, "request_channel failed for %s (%ld)\n", chan_name,
			PTR_ERR(chan));
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
		return chan;
	}

	memset(&cfg, 0, sizeof(cfg));
	cfg.direction = dir;
	if (dir == DMA_MEM_TO_DEV) {
		cfg.dst_addr = port_addr;
		cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
	} else {
		cfg.src_addr = port_addr;
		cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE;
	}

	ret = dmaengine_slave_config(chan, &cfg);
	if (ret) {
		dev_dbg(dev, "slave_config failed for %s (%d)\n", chan_name, ret);
		dma_release_channel(chan);
		return ERR_PTR(ret);
	}

	dev_dbg(dev, "got DMA channel for %s\n", chan_name);
	return chan;
}

Wolfram Sang's avatar
Wolfram Sang committed
515
516
517
518
519
520
521
522
523
static void sh_mobile_i2c_xfer_dma(struct sh_mobile_i2c_data *pd)
{
	bool read = pd->msg->flags & I2C_M_RD;
	enum dma_data_direction dir = read ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
	struct dma_chan *chan = read ? pd->dma_rx : pd->dma_tx;
	struct dma_async_tx_descriptor *txdesc;
	dma_addr_t dma_addr;
	dma_cookie_t cookie;

524
525
526
527
528
529
530
531
532
	if (PTR_ERR(chan) == -EPROBE_DEFER) {
		if (read)
			chan = pd->dma_rx = sh_mobile_i2c_request_dma_chan(pd->dev, DMA_DEV_TO_MEM,
									   pd->res->start + ICDR);
		else
			chan = pd->dma_tx = sh_mobile_i2c_request_dma_chan(pd->dev, DMA_MEM_TO_DEV,
									   pd->res->start + ICDR);
	}

533
	if (IS_ERR(chan))
Wolfram Sang's avatar
Wolfram Sang committed
534
535
		return;

536
	dma_addr = dma_map_single(chan->device->dev, pd->dma_buf, pd->msg->len, dir);
537
	if (dma_mapping_error(chan->device->dev, dma_addr)) {
Wolfram Sang's avatar
Wolfram Sang committed
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
		dev_dbg(pd->dev, "dma map failed, using PIO\n");
		return;
	}

	sg_dma_len(&pd->sg) = pd->msg->len;
	sg_dma_address(&pd->sg) = dma_addr;

	pd->dma_direction = dir;

	txdesc = dmaengine_prep_slave_sg(chan, &pd->sg, 1,
					 read ? DMA_DEV_TO_MEM : DMA_MEM_TO_DEV,
					 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
	if (!txdesc) {
		dev_dbg(pd->dev, "dma prep slave sg failed, using PIO\n");
		sh_mobile_i2c_cleanup_dma(pd);
		return;
	}

	txdesc->callback = sh_mobile_i2c_dma_callback;
	txdesc->callback_param = pd;

	cookie = dmaengine_submit(txdesc);
	if (dma_submit_error(cookie)) {
		dev_dbg(pd->dev, "submitting dma failed, using PIO\n");
		sh_mobile_i2c_cleanup_dma(pd);
		return;
	}

	dma_async_issue_pending(chan);
}

569
570
static void start_ch(struct sh_mobile_i2c_data *pd, struct i2c_msg *usr_msg,
		     bool do_init)
571
{
572
573
	if (do_init) {
		/* Initialize channel registers */
574
		iic_wr(pd, ICCR, ICCR_SCP);
575

576
		/* Enable channel and configure rx ack */
577
		iic_wr(pd, ICCR, ICCR_ICE | ICCR_SCP);
578

579
580
581
582
		/* Set the clock */
		iic_wr(pd, ICCL, pd->iccl & 0xff);
		iic_wr(pd, ICCH, pd->icch & 0xff);
	}
583
584
585
586
587

	pd->msg = usr_msg;
	pd->pos = -1;
	pd->sr = 0;

588
589
590
	if (pd->atomic_xfer)
		return;

591
592
	pd->dma_buf = i2c_get_dma_safe_msg_buf(pd->msg, 8);
	if (pd->dma_buf)
Wolfram Sang's avatar
Wolfram Sang committed
593
594
		sh_mobile_i2c_xfer_dma(pd);

595
	/* Enable all interrupts to begin with */
596
	iic_wr(pd, ICIC, ICIC_DTEE | ICIC_WAITE | ICIC_ALE | ICIC_TACKE);
597
598
}

599
600
601
602
603
604
605
606
607
608
609
static int poll_dte(struct sh_mobile_i2c_data *pd)
{
	int i;

	for (i = 1000; i; i--) {
		u_int8_t val = iic_rd(pd, ICSR);

		if (val & ICSR_DTE)
			break;

		if (val & ICSR_TACK)
610
			return -ENXIO;
611
612
613
614

		udelay(10);
	}

615
	return i ? 0 : -ETIMEDOUT;
616
617
}

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
static int poll_busy(struct sh_mobile_i2c_data *pd)
{
	int i;

	for (i = 1000; i; i--) {
		u_int8_t val = iic_rd(pd, ICSR);

		dev_dbg(pd->dev, "val 0x%02x pd->sr 0x%02x\n", val, pd->sr);

		/* the interrupt handler may wake us up before the
		 * transfer is finished, so poll the hardware
		 * until we're done.
		 */
		if (!(val & ICSR_BUSY)) {
			/* handle missing acknowledge and arbitration lost */
633
634
635
636
637
			val |= pd->sr;
			if (val & ICSR_TACK)
				return -ENXIO;
			if (val & ICSR_AL)
				return -EAGAIN;
638
639
640
641
642
643
			break;
		}

		udelay(10);
	}

644
	return i ? 0 : -ETIMEDOUT;
645
646
}

647
648
static int sh_mobile_xfer(struct sh_mobile_i2c_data *pd,
			 struct i2c_msg *msgs, int num)
649
650
651
{
	struct i2c_msg	*msg;
	int err = 0;
652
	int i;
653
	long time_left;
654

655
656
	/* Wake up device and enable clock */
	pm_runtime_get_sync(pd->dev);
657
658
659

	/* Process all messages */
	for (i = 0; i < num; i++) {
660
		bool do_start = pd->send_stop || !i;
661
		msg = &msgs[i];
662
		pd->send_stop = i == num - 1 || msg->flags & I2C_M_STOP;
663
		pd->stop_after_dma = false;
664

665
		start_ch(pd, msg, do_start);
666

667
		if (do_start)
668
			i2c_op(pd, OP_START);
669

670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
		if (pd->atomic_xfer) {
			unsigned long j = jiffies + pd->adap.timeout;

			time_left = time_before_eq(jiffies, j);
			while (time_left &&
			       !(pd->sr & (ICSR_TACK | SW_DONE))) {
				unsigned char sr = iic_rd(pd, ICSR);

				if (sr & (ICSR_AL   | ICSR_TACK |
					  ICSR_WAIT | ICSR_DTE)) {
					sh_mobile_i2c_isr(0, pd);
					udelay(150);
				} else {
					cpu_relax();
				}
				time_left = time_before_eq(jiffies, j);
			}
		} else {
			/* The interrupt handler takes care of the rest... */
			time_left = wait_event_timeout(pd->wait,
					pd->sr & (ICSR_TACK | SW_DONE),
					pd->adap.timeout);

			/* 'stop_after_dma' tells if DMA xfer was complete */
			i2c_put_dma_safe_msg_buf(pd->dma_buf, pd->msg,
						 pd->stop_after_dma);
		}
697

698
		if (!time_left) {
699
			dev_err(pd->dev, "Transfer request timed out\n");
Wolfram Sang's avatar
Wolfram Sang committed
700
701
702
			if (pd->dma_direction != DMA_NONE)
				sh_mobile_i2c_cleanup_dma(pd);

703
704
705
			err = -ETIMEDOUT;
			break;
		}
706

707
708
709
710
		if (pd->send_stop)
			err = poll_busy(pd);
		else
			err = poll_dte(pd);
711
		if (err < 0)
712
713
714
			break;
	}

715
	/* Disable channel */
716
	iic_wr(pd, ICCR, ICCR_SCP);
717
718
719

	/* Disable clock and mark device as idle */
	pm_runtime_put_sync(pd->dev);
720

721
	return err ?: num;
722
723
}

724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
static int sh_mobile_i2c_xfer(struct i2c_adapter *adapter,
			      struct i2c_msg *msgs,
			      int num)
{
	struct sh_mobile_i2c_data *pd = i2c_get_adapdata(adapter);

	pd->atomic_xfer = false;
	return sh_mobile_xfer(pd, msgs, num);
}

static int sh_mobile_i2c_xfer_atomic(struct i2c_adapter *adapter,
				     struct i2c_msg *msgs,
				     int num)
{
	struct sh_mobile_i2c_data *pd = i2c_get_adapdata(adapter);

	pd->atomic_xfer = true;
	return sh_mobile_xfer(pd, msgs, num);
}

744
745
static u32 sh_mobile_i2c_func(struct i2c_adapter *adapter)
{
746
	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_PROTOCOL_MANGLING;
747
748
}

749
static const struct i2c_algorithm sh_mobile_i2c_algorithm = {
750
751
752
	.functionality = sh_mobile_i2c_func,
	.master_xfer = sh_mobile_i2c_xfer,
	.master_xfer_atomic = sh_mobile_i2c_xfer_atomic,
753
754
};

755
756
757
758
static const struct i2c_adapter_quirks sh_mobile_i2c_quirks = {
	.flags = I2C_AQ_NO_ZERO_LEN_READ,
};

759
/*
760
 * r8a7740 has an errata regarding I2C I/O pad reset needing this workaround.
761
 */
762
static int sh_mobile_i2c_r8a7740_workaround(struct sh_mobile_i2c_data *pd)
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
{
	iic_set_clr(pd, ICCR, ICCR_ICE, 0);
	iic_rd(pd, ICCR); /* dummy read */

	iic_set_clr(pd, ICSTART, ICSTART_ICSTART, 0);
	iic_rd(pd, ICSTART); /* dummy read */

	udelay(10);

	iic_wr(pd, ICCR, ICCR_SCP);
	iic_wr(pd, ICSTART, 0);

	udelay(10);

	iic_wr(pd, ICCR, ICCR_TRS);
	udelay(10);
	iic_wr(pd, ICCR, 0);
	udelay(10);
	iic_wr(pd, ICCR, ICCR_TRS);
	udelay(10);
783

784
	return sh_mobile_i2c_init(pd);
785
786
}

787
788
static const struct sh_mobile_dt_config default_dt_config = {
	.clks_per_count = 1,
789
	.setup = sh_mobile_i2c_init,
790
791
};

792
static const struct sh_mobile_dt_config fast_clock_dt_config = {
793
	.clks_per_count = 2,
794
	.setup = sh_mobile_i2c_init,
795
796
};

797
798
799
800
801
static const struct sh_mobile_dt_config v2_freq_calc_dt_config = {
	.clks_per_count = 2,
	.setup = sh_mobile_i2c_v2_init,
};

802
803
804
805
806
static const struct sh_mobile_dt_config r8a7740_dt_config = {
	.clks_per_count = 1,
	.setup = sh_mobile_i2c_r8a7740_workaround,
};

807
static const struct of_device_id sh_mobile_i2c_dt_ids[] = {
808
	{ .compatible = "renesas,iic-r8a73a4", .data = &fast_clock_dt_config },
809
	{ .compatible = "renesas,iic-r8a7740", .data = &r8a7740_dt_config },
810
	{ .compatible = "renesas,iic-r8a774c0", .data = &v2_freq_calc_dt_config },
811
	{ .compatible = "renesas,iic-r8a7790", .data = &v2_freq_calc_dt_config },
812
813
814
815
	{ .compatible = "renesas,iic-r8a7791", .data = &v2_freq_calc_dt_config },
	{ .compatible = "renesas,iic-r8a7792", .data = &v2_freq_calc_dt_config },
	{ .compatible = "renesas,iic-r8a7793", .data = &v2_freq_calc_dt_config },
	{ .compatible = "renesas,iic-r8a7794", .data = &v2_freq_calc_dt_config },
816
817
	{ .compatible = "renesas,iic-r8a7795", .data = &v2_freq_calc_dt_config },
	{ .compatible = "renesas,iic-r8a77990", .data = &v2_freq_calc_dt_config },
818
	{ .compatible = "renesas,iic-sh73a0", .data = &fast_clock_dt_config },
819
	{ .compatible = "renesas,rcar-gen2-iic", .data = &v2_freq_calc_dt_config },
820
	{ .compatible = "renesas,rcar-gen3-iic", .data = &v2_freq_calc_dt_config },
821
	{ .compatible = "renesas,rmobile-iic", .data = &default_dt_config },
822
823
824
825
	{},
};
MODULE_DEVICE_TABLE(of, sh_mobile_i2c_dt_ids);

Wolfram Sang's avatar
Wolfram Sang committed
826
827
static void sh_mobile_i2c_release_dma(struct sh_mobile_i2c_data *pd)
{
828
	if (!IS_ERR(pd->dma_tx)) {
Wolfram Sang's avatar
Wolfram Sang committed
829
		dma_release_channel(pd->dma_tx);
830
		pd->dma_tx = ERR_PTR(-EPROBE_DEFER);
Wolfram Sang's avatar
Wolfram Sang committed
831
832
	}

833
	if (!IS_ERR(pd->dma_rx)) {
Wolfram Sang's avatar
Wolfram Sang committed
834
		dma_release_channel(pd->dma_rx);
835
		pd->dma_rx = ERR_PTR(-EPROBE_DEFER);
Wolfram Sang's avatar
Wolfram Sang committed
836
837
838
	}
}

839
static int sh_mobile_i2c_hook_irqs(struct platform_device *dev, struct sh_mobile_i2c_data *pd)
840
841
{
	struct resource *res;
842
843
	resource_size_t n;
	int k = 0, ret;
844
845

	while ((res = platform_get_resource(dev, IORESOURCE_IRQ, k))) {
846
847
		for (n = res->start; n <= res->end; n++) {
			ret = devm_request_irq(&dev->dev, n, sh_mobile_i2c_isr,
848
					  0, dev_name(&dev->dev), pd);
849
850
851
			if (ret) {
				dev_err(&dev->dev, "cannot request IRQ %pa\n", &n);
				return ret;
852
			}
853
854
855
856
		}
		k++;
	}

857
	return k > 0 ? 0 : -ENOENT;
858
859
860
861
862
863
864
}

static int sh_mobile_i2c_probe(struct platform_device *dev)
{
	struct sh_mobile_i2c_data *pd;
	struct i2c_adapter *adap;
	struct resource *res;
865
	const struct sh_mobile_dt_config *config;
866
	int ret;
867
	u32 bus_speed;
868

869
870
	pd = devm_kzalloc(&dev->dev, sizeof(struct sh_mobile_i2c_data), GFP_KERNEL);
	if (!pd)
871
872
		return -ENOMEM;

873
	pd->clk = devm_clk_get(&dev->dev, NULL);
874
	if (IS_ERR(pd->clk)) {
875
		dev_err(&dev->dev, "cannot get clock\n");
876
		return PTR_ERR(pd->clk);
877
878
	}

879
	ret = sh_mobile_i2c_hook_irqs(dev, pd);
880
	if (ret)
881
		return ret;
882
883
884
885
886
887

	pd->dev = &dev->dev;
	platform_set_drvdata(dev, pd);

	res = platform_get_resource(dev, IORESOURCE_MEM, 0);

888
	pd->res = res;
889
	pd->reg = devm_ioremap_resource(&dev->dev, res);
890
891
	if (IS_ERR(pd->reg))
		return PTR_ERR(pd->reg);
892

893
	ret = of_property_read_u32(dev->dev.of_node, "clock-frequency", &bus_speed);
894
	pd->bus_speed = (ret || !bus_speed) ? I2C_MAX_STANDARD_MODE_FREQ : bus_speed;
895
	pd->clks_per_count = 1;
896

897
898
899
900
	/* Newer variants come with two new bits in ICIC */
	if (resource_size(res) > 0x17)
		pd->flags |= IIC_FLAG_HAS_ICIC67;

901
902
903
	pm_runtime_enable(&dev->dev);
	pm_runtime_get_sync(&dev->dev);

904
905
	config = of_device_get_match_data(&dev->dev);
	if (config) {
906
		pd->clks_per_count = config->clks_per_count;
907
908
909
		ret = config->setup(pd);
	} else {
		ret = sh_mobile_i2c_init(pd);
910
	}
911
912

	pm_runtime_put_sync(&dev->dev);
913
914
	if (ret)
		return ret;
915

Wolfram Sang's avatar
Wolfram Sang committed
916
917
918
	/* Init DMA */
	sg_init_table(&pd->sg, 1);
	pd->dma_direction = DMA_NONE;
919
	pd->dma_rx = pd->dma_tx = ERR_PTR(-EPROBE_DEFER);
Wolfram Sang's avatar
Wolfram Sang committed
920

921
922
923
924
925
926
	/* setup the private data */
	adap = &pd->adap;
	i2c_set_adapdata(adap, pd);

	adap->owner = THIS_MODULE;
	adap->algo = &sh_mobile_i2c_algorithm;
927
	adap->quirks = &sh_mobile_i2c_quirks;
928
929
930
	adap->dev.parent = &dev->dev;
	adap->retries = 5;
	adap->nr = dev->id;
931
	adap->dev.of_node = dev->dev.of_node;
932
933
934

	strlcpy(adap->name, dev->name, sizeof(adap->name));

935
936
	spin_lock_init(&pd->lock);
	init_waitqueue_head(&pd->wait);
937
938
939

	ret = i2c_add_numbered_adapter(adap);
	if (ret < 0) {
Wolfram Sang's avatar
Wolfram Sang committed
940
		sh_mobile_i2c_release_dma(pd);
941
		return ret;
942
943
	}

944
	dev_info(&dev->dev, "I2C adapter %d, bus speed %lu Hz\n", adap->nr, pd->bus_speed);
945

946
947
948
949
950
951
952
953
	return 0;
}

static int sh_mobile_i2c_remove(struct platform_device *dev)
{
	struct sh_mobile_i2c_data *pd = platform_get_drvdata(dev);

	i2c_del_adapter(&pd->adap);
Wolfram Sang's avatar
Wolfram Sang committed
954
	sh_mobile_i2c_release_dma(pd);
955
	pm_runtime_disable(&dev->dev);
956
957
958
	return 0;
}

959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
#ifdef CONFIG_PM_SLEEP
static int sh_mobile_i2c_suspend(struct device *dev)
{
	struct sh_mobile_i2c_data *pd = dev_get_drvdata(dev);

	i2c_mark_adapter_suspended(&pd->adap);
	return 0;
}

static int sh_mobile_i2c_resume(struct device *dev)
{
	struct sh_mobile_i2c_data *pd = dev_get_drvdata(dev);

	i2c_mark_adapter_resumed(&pd->adap);
	return 0;
}

static const struct dev_pm_ops sh_mobile_i2c_pm_ops = {
	SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(sh_mobile_i2c_suspend,
				      sh_mobile_i2c_resume)
};

#define DEV_PM_OPS (&sh_mobile_i2c_pm_ops)
#else
#define DEV_PM_OPS NULL
#endif /* CONFIG_PM_SLEEP */

986
987
988
static struct platform_driver sh_mobile_i2c_driver = {
	.driver		= {
		.name		= "i2c-sh_mobile",
989
		.of_match_table = sh_mobile_i2c_dt_ids,
990
		.pm	= DEV_PM_OPS,
991
992
993
994
995
996
997
998
999
	},
	.probe		= sh_mobile_i2c_probe,
	.remove		= sh_mobile_i2c_remove,
};

static int __init sh_mobile_i2c_adap_init(void)
{
	return platform_driver_register(&sh_mobile_i2c_driver);
}
Wolfram Sang's avatar
Wolfram Sang committed
1000
subsys_initcall(sh_mobile_i2c_adap_init);
1001
1002
1003
1004
1005
1006
1007
1008

static void __exit sh_mobile_i2c_adap_exit(void)
{
	platform_driver_unregister(&sh_mobile_i2c_driver);
}
module_exit(sh_mobile_i2c_adap_exit);

MODULE_DESCRIPTION("SuperH Mobile I2C Bus Controller driver");
1009
1010
MODULE_AUTHOR("Magnus Damm");
MODULE_AUTHOR("Wolfram Sang");
1011
MODULE_LICENSE("GPL v2");
1012
MODULE_ALIAS("platform:i2c-sh_mobile");