blob: ce31196bb5e7fcd81b0636a65a402dc9f298f213 [file] [log] [blame]
Darius Augulisaa11e382009-01-30 10:32:28 +02001/*
2 * Copyright (C) 2002 Motorola GSG-China
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
17 * USA.
18 *
19 * Author:
20 * Darius Augulis, Teltonika Inc.
21 *
22 * Desc.:
23 * Implementation of I2C Adapter/Algorithm Driver
24 * for I2C Bus integrated in Freescale i.MX/MXC processors
25 *
26 * Derived from Motorola GSG China I2C example driver
27 *
28 * Copyright (C) 2005 Torsten Koschorrek <koschorrek at synertronixx.de
29 * Copyright (C) 2005 Matthias Blaschke <blaschke at synertronixx.de
30 * Copyright (C) 2007 RightHand Technologies, Inc.
31 * Copyright (C) 2008 Darius Augulis <darius.augulis at teltonika.lt>
32 *
Jingchang Lud533f042013-08-07 17:05:36 +080033 * Copyright 2013 Freescale Semiconductor, Inc.
34 *
Darius Augulisaa11e382009-01-30 10:32:28 +020035 */
36
37/** Includes *******************************************************************
38*******************************************************************************/
39
40#include <linux/init.h>
41#include <linux/kernel.h>
42#include <linux/module.h>
43#include <linux/errno.h>
44#include <linux/err.h>
45#include <linux/interrupt.h>
46#include <linux/delay.h>
47#include <linux/i2c.h>
48#include <linux/io.h>
49#include <linux/sched.h>
50#include <linux/platform_device.h>
51#include <linux/clk.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090052#include <linux/slab.h>
Shawn Guodfcd04b2011-09-08 15:09:35 +080053#include <linux/of.h>
54#include <linux/of_device.h>
55#include <linux/of_i2c.h>
Arnd Bergmann82906b12012-08-24 15:14:29 +020056#include <linux/platform_data/i2c-imx.h>
Darius Augulisaa11e382009-01-30 10:32:28 +020057
58/** Defines ********************************************************************
59*******************************************************************************/
60
61/* This will be the driver name the kernel reports */
62#define DRIVER_NAME "imx-i2c"
63
64/* Default value */
65#define IMX_I2C_BIT_RATE 100000 /* 100kHz */
66
Jingchang Lu8cc73312013-08-07 17:05:40 +080067/* IMX I2C registers:
68 * the I2C register offset is different between SoCs,
69 * to provid support for all these chips, split the
70 * register offset into a fixed base address and a
71 * variable shift value, then the full register offset
72 * will be calculated by
73 * reg_off = ( reg_base_addr << reg_shift)
74 */
Darius Augulisaa11e382009-01-30 10:32:28 +020075#define IMX_I2C_IADR 0x00 /* i2c slave address */
Jingchang Lu8cc73312013-08-07 17:05:40 +080076#define IMX_I2C_IFDR 0x01 /* i2c frequency divider */
77#define IMX_I2C_I2CR 0x02 /* i2c control */
78#define IMX_I2C_I2SR 0x03 /* i2c status */
79#define IMX_I2C_I2DR 0x04 /* i2c transfer data */
80
81#define IMX_I2C_REGSHIFT 2
Darius Augulisaa11e382009-01-30 10:32:28 +020082
83/* Bits of IMX I2C registers */
84#define I2SR_RXAK 0x01
85#define I2SR_IIF 0x02
86#define I2SR_SRW 0x04
87#define I2SR_IAL 0x10
88#define I2SR_IBB 0x20
89#define I2SR_IAAS 0x40
90#define I2SR_ICF 0x80
91#define I2CR_RSTA 0x04
92#define I2CR_TXAK 0x08
93#define I2CR_MTX 0x10
94#define I2CR_MSTA 0x20
95#define I2CR_IIEN 0x40
96#define I2CR_IEN 0x80
97
Jingchang Lu171408c2013-08-07 17:05:41 +080098/* register bits different operating codes definition:
99 * 1) I2SR: Interrupt flags clear operation differ between SoCs:
100 * - write zero to clear(w0c) INT flag on i.MX,
101 * - but write one to clear(w1c) INT flag on Vybrid.
102 * 2) I2CR: I2C module enable operation also differ between SoCs:
103 * - set I2CR_IEN bit enable the module on i.MX,
104 * - but clear I2CR_IEN bit enable the module on Vybrid.
105 */
106#define I2SR_CLR_OPCODE_W0C 0x0
107#define I2SR_CLR_OPCODE_W1C (I2SR_IAL | I2SR_IIF)
108#define I2CR_IEN_OPCODE_0 0x0
109#define I2CR_IEN_OPCODE_1 I2CR_IEN
110
Darius Augulisaa11e382009-01-30 10:32:28 +0200111/** Variables ******************************************************************
112*******************************************************************************/
113
Darius Augulisaa11e382009-01-30 10:32:28 +0200114/*
115 * sorted list of clock divider, register value pairs
116 * taken from table 26-5, p.26-9, Freescale i.MX
117 * Integrated Portable System Processor Reference Manual
118 * Document Number: MC9328MXLRM, Rev. 5.1, 06/2007
119 *
120 * Duplicated divider values removed from list
121 */
Jingchang Lud533f042013-08-07 17:05:36 +0800122struct imx_i2c_clk_pair {
123 u16 div;
124 u16 val;
125};
Darius Augulisaa11e382009-01-30 10:32:28 +0200126
Jingchang Lu4b775022013-08-07 17:05:42 +0800127static struct imx_i2c_clk_pair imx_i2c_clk_div[] = {
Darius Augulisaa11e382009-01-30 10:32:28 +0200128 { 22, 0x20 }, { 24, 0x21 }, { 26, 0x22 }, { 28, 0x23 },
129 { 30, 0x00 }, { 32, 0x24 }, { 36, 0x25 }, { 40, 0x26 },
130 { 42, 0x03 }, { 44, 0x27 }, { 48, 0x28 }, { 52, 0x05 },
131 { 56, 0x29 }, { 60, 0x06 }, { 64, 0x2A }, { 72, 0x2B },
132 { 80, 0x2C }, { 88, 0x09 }, { 96, 0x2D }, { 104, 0x0A },
133 { 112, 0x2E }, { 128, 0x2F }, { 144, 0x0C }, { 160, 0x30 },
134 { 192, 0x31 }, { 224, 0x32 }, { 240, 0x0F }, { 256, 0x33 },
135 { 288, 0x10 }, { 320, 0x34 }, { 384, 0x35 }, { 448, 0x36 },
136 { 480, 0x13 }, { 512, 0x37 }, { 576, 0x14 }, { 640, 0x38 },
137 { 768, 0x39 }, { 896, 0x3A }, { 960, 0x17 }, { 1024, 0x3B },
138 { 1152, 0x18 }, { 1280, 0x3C }, { 1536, 0x3D }, { 1792, 0x3E },
139 { 1920, 0x1B }, { 2048, 0x3F }, { 2304, 0x1C }, { 2560, 0x1D },
140 { 3072, 0x1E }, { 3840, 0x1F }
141};
142
Shawn Guo5bdfba22012-09-14 15:19:00 +0800143enum imx_i2c_type {
144 IMX1_I2C,
145 IMX21_I2C,
146};
147
Jingchang Lu4b775022013-08-07 17:05:42 +0800148struct imx_i2c_hwdata {
149 enum imx_i2c_type devtype;
150 unsigned regshift;
151 struct imx_i2c_clk_pair *clk_div;
152 unsigned ndivs;
153 unsigned i2sr_clr_opcode;
154 unsigned i2cr_ien_opcode;
155};
156
Darius Augulisaa11e382009-01-30 10:32:28 +0200157struct imx_i2c_struct {
158 struct i2c_adapter adapter;
Darius Augulisaa11e382009-01-30 10:32:28 +0200159 struct clk *clk;
160 void __iomem *base;
Darius Augulisaa11e382009-01-30 10:32:28 +0200161 wait_queue_head_t queue;
162 unsigned long i2csr;
Wolfram Sang65de3942009-04-06 16:27:45 +0200163 unsigned int disable_delay;
Richard Zhao43309f32009-10-17 17:46:22 +0800164 int stopped;
Richard Zhaodb3a3d42009-10-17 17:46:24 +0800165 unsigned int ifdr; /* IMX_I2C_IFDR */
Jingchang Lu4b775022013-08-07 17:05:42 +0800166 const struct imx_i2c_hwdata *hwdata;
167};
168
169static const struct imx_i2c_hwdata imx1_i2c_hwdata = {
170 .devtype = IMX1_I2C,
171 .regshift = IMX_I2C_REGSHIFT,
172 .clk_div = imx_i2c_clk_div,
173 .ndivs = ARRAY_SIZE(imx_i2c_clk_div),
174 .i2sr_clr_opcode = I2SR_CLR_OPCODE_W0C,
175 .i2cr_ien_opcode = I2CR_IEN_OPCODE_1,
176
177};
178
179static const struct imx_i2c_hwdata imx21_i2c_hwdata = {
180 .devtype = IMX21_I2C,
181 .regshift = IMX_I2C_REGSHIFT,
182 .clk_div = imx_i2c_clk_div,
183 .ndivs = ARRAY_SIZE(imx_i2c_clk_div),
184 .i2sr_clr_opcode = I2SR_CLR_OPCODE_W0C,
185 .i2cr_ien_opcode = I2CR_IEN_OPCODE_1,
186
Darius Augulisaa11e382009-01-30 10:32:28 +0200187};
188
Shawn Guo5bdfba22012-09-14 15:19:00 +0800189static struct platform_device_id imx_i2c_devtype[] = {
190 {
191 .name = "imx1-i2c",
Jingchang Lu4b775022013-08-07 17:05:42 +0800192 .driver_data = (kernel_ulong_t)&imx1_i2c_hwdata,
Shawn Guo5bdfba22012-09-14 15:19:00 +0800193 }, {
194 .name = "imx21-i2c",
Jingchang Lu4b775022013-08-07 17:05:42 +0800195 .driver_data = (kernel_ulong_t)&imx21_i2c_hwdata,
Shawn Guo5bdfba22012-09-14 15:19:00 +0800196 }, {
197 /* sentinel */
198 }
199};
200MODULE_DEVICE_TABLE(platform, imx_i2c_devtype);
201
Shawn Guodfcd04b2011-09-08 15:09:35 +0800202static const struct of_device_id i2c_imx_dt_ids[] = {
Jingchang Lu4b775022013-08-07 17:05:42 +0800203 { .compatible = "fsl,imx1-i2c", .data = &imx1_i2c_hwdata, },
204 { .compatible = "fsl,imx21-i2c", .data = &imx21_i2c_hwdata, },
Shawn Guodfcd04b2011-09-08 15:09:35 +0800205 { /* sentinel */ }
206};
Arnaud Patard \(Rtp\)2f641a82013-06-20 23:07:06 +0200207MODULE_DEVICE_TABLE(of, i2c_imx_dt_ids);
Shawn Guodfcd04b2011-09-08 15:09:35 +0800208
Shawn Guo5bdfba22012-09-14 15:19:00 +0800209static inline int is_imx1_i2c(struct imx_i2c_struct *i2c_imx)
210{
Jingchang Lu4b775022013-08-07 17:05:42 +0800211 return i2c_imx->hwdata->devtype == IMX1_I2C;
Shawn Guo5bdfba22012-09-14 15:19:00 +0800212}
213
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800214static inline void imx_i2c_write_reg(unsigned int val,
215 struct imx_i2c_struct *i2c_imx, unsigned int reg)
216{
Jingchang Lu4b775022013-08-07 17:05:42 +0800217 writeb(val, i2c_imx->base + (reg << i2c_imx->hwdata->regshift));
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800218}
219
220static inline unsigned char imx_i2c_read_reg(struct imx_i2c_struct *i2c_imx,
221 unsigned int reg)
222{
Jingchang Lu4b775022013-08-07 17:05:42 +0800223 return readb(i2c_imx->base + (reg << i2c_imx->hwdata->regshift));
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800224}
225
Darius Augulisaa11e382009-01-30 10:32:28 +0200226/** Functions for IMX I2C adapter driver ***************************************
227*******************************************************************************/
228
Richard Zhao43309f32009-10-17 17:46:22 +0800229static int i2c_imx_bus_busy(struct imx_i2c_struct *i2c_imx, int for_busy)
Darius Augulisaa11e382009-01-30 10:32:28 +0200230{
231 unsigned long orig_jiffies = jiffies;
Richard Zhao43309f32009-10-17 17:46:22 +0800232 unsigned int temp;
Darius Augulisaa11e382009-01-30 10:32:28 +0200233
234 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
235
Richard Zhao43309f32009-10-17 17:46:22 +0800236 while (1) {
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800237 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
Richard Zhao43309f32009-10-17 17:46:22 +0800238 if (for_busy && (temp & I2SR_IBB))
239 break;
240 if (!for_busy && !(temp & I2SR_IBB))
241 break;
Arnaud Patardda9c99f2010-03-23 17:28:28 +0100242 if (time_after(jiffies, orig_jiffies + msecs_to_jiffies(500))) {
Darius Augulisaa11e382009-01-30 10:32:28 +0200243 dev_dbg(&i2c_imx->adapter.dev,
244 "<%s> I2C bus is busy\n", __func__);
Arnaud Patardda9c99f2010-03-23 17:28:28 +0100245 return -ETIMEDOUT;
Darius Augulisaa11e382009-01-30 10:32:28 +0200246 }
247 schedule();
248 }
249
250 return 0;
251}
252
253static int i2c_imx_trx_complete(struct imx_i2c_struct *i2c_imx)
254{
Marc Kleine-Buddee39428d2010-06-21 09:27:05 +0200255 wait_event_timeout(i2c_imx->queue, i2c_imx->i2csr & I2SR_IIF, HZ / 10);
Darius Augulisaa11e382009-01-30 10:32:28 +0200256
Marc Kleine-Buddee39428d2010-06-21 09:27:05 +0200257 if (unlikely(!(i2c_imx->i2csr & I2SR_IIF))) {
Darius Augulisaa11e382009-01-30 10:32:28 +0200258 dev_dbg(&i2c_imx->adapter.dev, "<%s> Timeout\n", __func__);
259 return -ETIMEDOUT;
260 }
261 dev_dbg(&i2c_imx->adapter.dev, "<%s> TRX complete\n", __func__);
262 i2c_imx->i2csr = 0;
263 return 0;
264}
265
266static int i2c_imx_acked(struct imx_i2c_struct *i2c_imx)
267{
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800268 if (imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR) & I2SR_RXAK) {
Darius Augulisaa11e382009-01-30 10:32:28 +0200269 dev_dbg(&i2c_imx->adapter.dev, "<%s> No ACK\n", __func__);
270 return -EIO; /* No ACK */
271 }
272
273 dev_dbg(&i2c_imx->adapter.dev, "<%s> ACK received\n", __func__);
274 return 0;
275}
276
Richard Zhao43309f32009-10-17 17:46:22 +0800277static int i2c_imx_start(struct imx_i2c_struct *i2c_imx)
Darius Augulisaa11e382009-01-30 10:32:28 +0200278{
279 unsigned int temp = 0;
Richard Zhao43309f32009-10-17 17:46:22 +0800280 int result;
Darius Augulisaa11e382009-01-30 10:32:28 +0200281
282 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
283
Richard Zhao83914332011-11-15 14:48:08 +0800284 clk_prepare_enable(i2c_imx->clk);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800285 imx_i2c_write_reg(i2c_imx->ifdr, i2c_imx, IMX_I2C_IFDR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200286 /* Enable I2C controller */
Jingchang Lu4b775022013-08-07 17:05:42 +0800287 imx_i2c_write_reg(i2c_imx->hwdata->i2sr_clr_opcode, i2c_imx, IMX_I2C_I2SR);
288 imx_i2c_write_reg(i2c_imx->hwdata->i2cr_ien_opcode, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800289
290 /* Wait controller to be stable */
291 udelay(50);
292
Darius Augulisaa11e382009-01-30 10:32:28 +0200293 /* Start I2C transaction */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800294 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200295 temp |= I2CR_MSTA;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800296 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800297 result = i2c_imx_bus_busy(i2c_imx, 1);
298 if (result)
299 return result;
300 i2c_imx->stopped = 0;
301
Darius Augulisaa11e382009-01-30 10:32:28 +0200302 temp |= I2CR_IIEN | I2CR_MTX | I2CR_TXAK;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800303 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800304 return result;
Darius Augulisaa11e382009-01-30 10:32:28 +0200305}
306
307static void i2c_imx_stop(struct imx_i2c_struct *i2c_imx)
308{
309 unsigned int temp = 0;
310
Richard Zhao43309f32009-10-17 17:46:22 +0800311 if (!i2c_imx->stopped) {
312 /* Stop I2C transaction */
313 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800314 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800315 temp &= ~(I2CR_MSTA | I2CR_MTX);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800316 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800317 }
Shawn Guo5bdfba22012-09-14 15:19:00 +0800318 if (is_imx1_i2c(i2c_imx)) {
Richard Zhaoa4094a72009-10-17 17:46:23 +0800319 /*
320 * This delay caused by an i.MXL hardware bug.
321 * If no (or too short) delay, no "STOP" bit will be generated.
322 */
323 udelay(i2c_imx->disable_delay);
324 }
Richard Zhao43309f32009-10-17 17:46:22 +0800325
Valentin Longchampa1ee06b2010-01-21 18:55:32 +0100326 if (!i2c_imx->stopped) {
Richard Zhao43309f32009-10-17 17:46:22 +0800327 i2c_imx_bus_busy(i2c_imx, 0);
Valentin Longchampa1ee06b2010-01-21 18:55:32 +0100328 i2c_imx->stopped = 1;
329 }
Richard Zhao43309f32009-10-17 17:46:22 +0800330
Darius Augulisaa11e382009-01-30 10:32:28 +0200331 /* Disable I2C controller */
Jingchang Lu4b775022013-08-07 17:05:42 +0800332 temp = i2c_imx->hwdata->i2cr_ien_opcode ^ I2CR_IEN,
333 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao83914332011-11-15 14:48:08 +0800334 clk_disable_unprepare(i2c_imx->clk);
Darius Augulisaa11e382009-01-30 10:32:28 +0200335}
336
337static void __init i2c_imx_set_clk(struct imx_i2c_struct *i2c_imx,
338 unsigned int rate)
339{
Jingchang Lu4b775022013-08-07 17:05:42 +0800340 struct imx_i2c_clk_pair *i2c_clk_div = i2c_imx->hwdata->clk_div;
Darius Augulisaa11e382009-01-30 10:32:28 +0200341 unsigned int i2c_clk_rate;
342 unsigned int div;
343 int i;
344
345 /* Divider value calculation */
346 i2c_clk_rate = clk_get_rate(i2c_imx->clk);
347 div = (i2c_clk_rate + rate - 1) / rate;
Jingchang Lud533f042013-08-07 17:05:36 +0800348 if (div < i2c_clk_div[0].div)
Darius Augulisaa11e382009-01-30 10:32:28 +0200349 i = 0;
Jingchang Lu4b775022013-08-07 17:05:42 +0800350 else if (div > i2c_clk_div[i2c_imx->hwdata->ndivs - 1].div)
351 i = i2c_imx->hwdata->ndivs - 1;
Darius Augulisaa11e382009-01-30 10:32:28 +0200352 else
Jingchang Lud533f042013-08-07 17:05:36 +0800353 for (i = 0; i2c_clk_div[i].div < div; i++);
Darius Augulisaa11e382009-01-30 10:32:28 +0200354
Richard Zhaodb3a3d42009-10-17 17:46:24 +0800355 /* Store divider value */
Jingchang Lud533f042013-08-07 17:05:36 +0800356 i2c_imx->ifdr = i2c_clk_div[i].val;
Darius Augulisaa11e382009-01-30 10:32:28 +0200357
358 /*
359 * There dummy delay is calculated.
360 * It should be about one I2C clock period long.
361 * This delay is used in I2C bus disable function
362 * to fix chip hardware bug.
363 */
Jingchang Lud533f042013-08-07 17:05:36 +0800364 i2c_imx->disable_delay = (500000U * i2c_clk_div[i].div
Darius Augulisaa11e382009-01-30 10:32:28 +0200365 + (i2c_clk_rate / 2) - 1) / (i2c_clk_rate / 2);
366
367 /* dev_dbg() can't be used, because adapter is not yet registered */
368#ifdef CONFIG_I2C_DEBUG_BUS
Fabio Estevam002f0022012-08-01 17:38:15 -0300369 dev_dbg(&i2c_imx->adapter.dev, "<%s> I2C_CLK=%d, REQ DIV=%d\n",
Darius Augulisaa11e382009-01-30 10:32:28 +0200370 __func__, i2c_clk_rate, div);
Fabio Estevam002f0022012-08-01 17:38:15 -0300371 dev_dbg(&i2c_imx->adapter.dev, "<%s> IFDR[IC]=0x%x, REAL DIV=%d\n",
Jingchang Lud533f042013-08-07 17:05:36 +0800372 __func__, i2c_clk_div[i].val, i2c_clk_div[i].div);
Darius Augulisaa11e382009-01-30 10:32:28 +0200373#endif
374}
375
376static irqreturn_t i2c_imx_isr(int irq, void *dev_id)
377{
378 struct imx_i2c_struct *i2c_imx = dev_id;
379 unsigned int temp;
380
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800381 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200382 if (temp & I2SR_IIF) {
383 /* save status register */
384 i2c_imx->i2csr = temp;
385 temp &= ~I2SR_IIF;
Jingchang Lu4b775022013-08-07 17:05:42 +0800386 temp |= (i2c_imx->hwdata->i2sr_clr_opcode & I2SR_IIF);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800387 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2SR);
Marc Kleine-Buddee39428d2010-06-21 09:27:05 +0200388 wake_up(&i2c_imx->queue);
Darius Augulisaa11e382009-01-30 10:32:28 +0200389 return IRQ_HANDLED;
390 }
391
392 return IRQ_NONE;
393}
394
395static int i2c_imx_write(struct imx_i2c_struct *i2c_imx, struct i2c_msg *msgs)
396{
397 int i, result;
398
399 dev_dbg(&i2c_imx->adapter.dev, "<%s> write slave address: addr=0x%x\n",
400 __func__, msgs->addr << 1);
401
402 /* write slave address */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800403 imx_i2c_write_reg(msgs->addr << 1, i2c_imx, IMX_I2C_I2DR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200404 result = i2c_imx_trx_complete(i2c_imx);
405 if (result)
406 return result;
407 result = i2c_imx_acked(i2c_imx);
408 if (result)
409 return result;
410 dev_dbg(&i2c_imx->adapter.dev, "<%s> write data\n", __func__);
411
412 /* write data */
413 for (i = 0; i < msgs->len; i++) {
414 dev_dbg(&i2c_imx->adapter.dev,
415 "<%s> write byte: B%d=0x%X\n",
416 __func__, i, msgs->buf[i]);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800417 imx_i2c_write_reg(msgs->buf[i], i2c_imx, IMX_I2C_I2DR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200418 result = i2c_imx_trx_complete(i2c_imx);
419 if (result)
420 return result;
421 result = i2c_imx_acked(i2c_imx);
422 if (result)
423 return result;
424 }
425 return 0;
426}
427
428static int i2c_imx_read(struct imx_i2c_struct *i2c_imx, struct i2c_msg *msgs)
429{
430 int i, result;
431 unsigned int temp;
432
433 dev_dbg(&i2c_imx->adapter.dev,
434 "<%s> write slave address: addr=0x%x\n",
435 __func__, (msgs->addr << 1) | 0x01);
436
437 /* write slave address */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800438 imx_i2c_write_reg((msgs->addr << 1) | 0x01, i2c_imx, IMX_I2C_I2DR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200439 result = i2c_imx_trx_complete(i2c_imx);
440 if (result)
441 return result;
442 result = i2c_imx_acked(i2c_imx);
443 if (result)
444 return result;
445
446 dev_dbg(&i2c_imx->adapter.dev, "<%s> setup bus\n", __func__);
447
448 /* setup bus to read data */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800449 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200450 temp &= ~I2CR_MTX;
451 if (msgs->len - 1)
452 temp &= ~I2CR_TXAK;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800453 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
454 imx_i2c_read_reg(i2c_imx, IMX_I2C_I2DR); /* dummy read */
Darius Augulisaa11e382009-01-30 10:32:28 +0200455
456 dev_dbg(&i2c_imx->adapter.dev, "<%s> read data\n", __func__);
457
458 /* read data */
459 for (i = 0; i < msgs->len; i++) {
460 result = i2c_imx_trx_complete(i2c_imx);
461 if (result)
462 return result;
463 if (i == (msgs->len - 1)) {
Richard Zhao43309f32009-10-17 17:46:22 +0800464 /* It must generate STOP before read I2DR to prevent
465 controller from generating another clock cycle */
Darius Augulisaa11e382009-01-30 10:32:28 +0200466 dev_dbg(&i2c_imx->adapter.dev,
467 "<%s> clear MSTA\n", __func__);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800468 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800469 temp &= ~(I2CR_MSTA | I2CR_MTX);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800470 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800471 i2c_imx_bus_busy(i2c_imx, 0);
472 i2c_imx->stopped = 1;
Darius Augulisaa11e382009-01-30 10:32:28 +0200473 } else if (i == (msgs->len - 2)) {
474 dev_dbg(&i2c_imx->adapter.dev,
475 "<%s> set TXAK\n", __func__);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800476 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200477 temp |= I2CR_TXAK;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800478 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200479 }
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800480 msgs->buf[i] = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2DR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200481 dev_dbg(&i2c_imx->adapter.dev,
482 "<%s> read byte: B%d=0x%X\n",
483 __func__, i, msgs->buf[i]);
484 }
485 return 0;
486}
487
488static int i2c_imx_xfer(struct i2c_adapter *adapter,
489 struct i2c_msg *msgs, int num)
490{
491 unsigned int i, temp;
492 int result;
493 struct imx_i2c_struct *i2c_imx = i2c_get_adapdata(adapter);
494
495 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
496
Richard Zhao43309f32009-10-17 17:46:22 +0800497 /* Start I2C transfer */
498 result = i2c_imx_start(i2c_imx);
Darius Augulisaa11e382009-01-30 10:32:28 +0200499 if (result)
500 goto fail0;
501
Darius Augulisaa11e382009-01-30 10:32:28 +0200502 /* read/write data */
503 for (i = 0; i < num; i++) {
504 if (i) {
505 dev_dbg(&i2c_imx->adapter.dev,
506 "<%s> repeated start\n", __func__);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800507 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200508 temp |= I2CR_RSTA;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800509 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800510 result = i2c_imx_bus_busy(i2c_imx, 1);
511 if (result)
512 goto fail0;
Darius Augulisaa11e382009-01-30 10:32:28 +0200513 }
514 dev_dbg(&i2c_imx->adapter.dev,
515 "<%s> transfer message: %d\n", __func__, i);
516 /* write/read data */
517#ifdef CONFIG_I2C_DEBUG_BUS
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800518 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200519 dev_dbg(&i2c_imx->adapter.dev, "<%s> CONTROL: IEN=%d, IIEN=%d, "
520 "MSTA=%d, MTX=%d, TXAK=%d, RSTA=%d\n", __func__,
521 (temp & I2CR_IEN ? 1 : 0), (temp & I2CR_IIEN ? 1 : 0),
522 (temp & I2CR_MSTA ? 1 : 0), (temp & I2CR_MTX ? 1 : 0),
523 (temp & I2CR_TXAK ? 1 : 0), (temp & I2CR_RSTA ? 1 : 0));
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800524 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200525 dev_dbg(&i2c_imx->adapter.dev,
526 "<%s> STATUS: ICF=%d, IAAS=%d, IBB=%d, "
527 "IAL=%d, SRW=%d, IIF=%d, RXAK=%d\n", __func__,
528 (temp & I2SR_ICF ? 1 : 0), (temp & I2SR_IAAS ? 1 : 0),
529 (temp & I2SR_IBB ? 1 : 0), (temp & I2SR_IAL ? 1 : 0),
530 (temp & I2SR_SRW ? 1 : 0), (temp & I2SR_IIF ? 1 : 0),
531 (temp & I2SR_RXAK ? 1 : 0));
532#endif
533 if (msgs[i].flags & I2C_M_RD)
534 result = i2c_imx_read(i2c_imx, &msgs[i]);
535 else
536 result = i2c_imx_write(i2c_imx, &msgs[i]);
Arnaud Patardda9c99f2010-03-23 17:28:28 +0100537 if (result)
538 goto fail0;
Darius Augulisaa11e382009-01-30 10:32:28 +0200539 }
540
541fail0:
542 /* Stop I2C transfer */
543 i2c_imx_stop(i2c_imx);
544
545 dev_dbg(&i2c_imx->adapter.dev, "<%s> exit with: %s: %d\n", __func__,
546 (result < 0) ? "error" : "success msg",
547 (result < 0) ? result : num);
548 return (result < 0) ? result : num;
549}
550
551static u32 i2c_imx_func(struct i2c_adapter *adapter)
552{
553 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
554}
555
556static struct i2c_algorithm i2c_imx_algo = {
557 .master_xfer = i2c_imx_xfer,
558 .functionality = i2c_imx_func,
559};
560
561static int __init i2c_imx_probe(struct platform_device *pdev)
562{
Shawn Guo5bdfba22012-09-14 15:19:00 +0800563 const struct of_device_id *of_id = of_match_device(i2c_imx_dt_ids,
564 &pdev->dev);
Darius Augulisaa11e382009-01-30 10:32:28 +0200565 struct imx_i2c_struct *i2c_imx;
566 struct resource *res;
Shawn Guo593702c2011-09-08 15:09:34 +0800567 struct imxi2c_platform_data *pdata = pdev->dev.platform_data;
Darius Augulisaa11e382009-01-30 10:32:28 +0200568 void __iomem *base;
Wolfram Sang8c88ab02012-07-08 13:11:43 +0200569 int irq, ret;
570 u32 bitrate;
Darius Augulisaa11e382009-01-30 10:32:28 +0200571
572 dev_dbg(&pdev->dev, "<%s>\n", __func__);
573
Darius Augulisaa11e382009-01-30 10:32:28 +0200574 irq = platform_get_irq(pdev, 0);
575 if (irq < 0) {
576 dev_err(&pdev->dev, "can't get irq number\n");
577 return -ENOENT;
578 }
579
Wolfram Sang3cc2d002013-05-10 10:16:54 +0200580 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Thierry Reding84dbf802013-01-21 11:09:03 +0100581 base = devm_ioremap_resource(&pdev->dev, res);
582 if (IS_ERR(base))
583 return PTR_ERR(base);
Uwe Kleine-König4927fbf2010-01-08 17:23:17 +0100584
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800585 i2c_imx = devm_kzalloc(&pdev->dev, sizeof(struct imx_i2c_struct),
586 GFP_KERNEL);
Darius Augulisaa11e382009-01-30 10:32:28 +0200587 if (!i2c_imx) {
588 dev_err(&pdev->dev, "can't allocate interface\n");
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800589 return -ENOMEM;
Darius Augulis309c18d2009-03-31 14:52:54 +0300590 }
591
Shawn Guo5bdfba22012-09-14 15:19:00 +0800592 if (of_id)
Jingchang Lu4b775022013-08-07 17:05:42 +0800593 i2c_imx->hwdata = of_id->data;
Jingchang Lu0fc13472013-08-07 17:05:38 +0800594 else
Jingchang Lu4b775022013-08-07 17:05:42 +0800595 i2c_imx->hwdata = (struct imx_i2c_hwdata *)
596 platform_get_device_id(pdev)->driver_data;
Shawn Guo5bdfba22012-09-14 15:19:00 +0800597
Darius Augulisaa11e382009-01-30 10:32:28 +0200598 /* Setup i2c_imx driver structure */
Wolfram Sang973c5ed2012-04-19 17:31:01 +0200599 strlcpy(i2c_imx->adapter.name, pdev->name, sizeof(i2c_imx->adapter.name));
Darius Augulisaa11e382009-01-30 10:32:28 +0200600 i2c_imx->adapter.owner = THIS_MODULE;
601 i2c_imx->adapter.algo = &i2c_imx_algo;
602 i2c_imx->adapter.dev.parent = &pdev->dev;
603 i2c_imx->adapter.nr = pdev->id;
Shawn Guodfcd04b2011-09-08 15:09:35 +0800604 i2c_imx->adapter.dev.of_node = pdev->dev.of_node;
Darius Augulisaa11e382009-01-30 10:32:28 +0200605 i2c_imx->base = base;
Darius Augulisaa11e382009-01-30 10:32:28 +0200606
607 /* Get I2C clock */
Fabio Estevam1f09c672012-07-06 15:31:32 -0300608 i2c_imx->clk = devm_clk_get(&pdev->dev, NULL);
Darius Augulisaa11e382009-01-30 10:32:28 +0200609 if (IS_ERR(i2c_imx->clk)) {
Darius Augulisaa11e382009-01-30 10:32:28 +0200610 dev_err(&pdev->dev, "can't get I2C clock\n");
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800611 return PTR_ERR(i2c_imx->clk);
Darius Augulisaa11e382009-01-30 10:32:28 +0200612 }
Darius Augulisaa11e382009-01-30 10:32:28 +0200613
Jingchang Lu46f28322013-08-07 17:05:37 +0800614 ret = clk_prepare_enable(i2c_imx->clk);
615 if (ret) {
616 dev_err(&pdev->dev, "can't enable I2C clock\n");
617 return ret;
618 }
Darius Augulisaa11e382009-01-30 10:32:28 +0200619 /* Request IRQ */
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800620 ret = devm_request_irq(&pdev->dev, irq, i2c_imx_isr, 0,
621 pdev->name, i2c_imx);
Darius Augulisaa11e382009-01-30 10:32:28 +0200622 if (ret) {
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800623 dev_err(&pdev->dev, "can't claim irq %d\n", irq);
624 return ret;
Darius Augulisaa11e382009-01-30 10:32:28 +0200625 }
626
627 /* Init queue */
628 init_waitqueue_head(&i2c_imx->queue);
629
630 /* Set up adapter data */
631 i2c_set_adapdata(&i2c_imx->adapter, i2c_imx);
632
633 /* Set up clock divider */
Shawn Guodfcd04b2011-09-08 15:09:35 +0800634 bitrate = IMX_I2C_BIT_RATE;
635 ret = of_property_read_u32(pdev->dev.of_node,
636 "clock-frequency", &bitrate);
637 if (ret < 0 && pdata && pdata->bitrate)
638 bitrate = pdata->bitrate;
639 i2c_imx_set_clk(i2c_imx, bitrate);
Darius Augulisaa11e382009-01-30 10:32:28 +0200640
641 /* Set up chip registers to defaults */
Jingchang Lu4b775022013-08-07 17:05:42 +0800642 imx_i2c_write_reg(i2c_imx->hwdata->i2cr_ien_opcode ^ I2CR_IEN,
643 i2c_imx, IMX_I2C_I2CR);
644 imx_i2c_write_reg(i2c_imx->hwdata->i2sr_clr_opcode, i2c_imx, IMX_I2C_I2SR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200645
646 /* Add I2C adapter */
647 ret = i2c_add_numbered_adapter(&i2c_imx->adapter);
648 if (ret < 0) {
649 dev_err(&pdev->dev, "registration failed\n");
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800650 return ret;
Darius Augulisaa11e382009-01-30 10:32:28 +0200651 }
652
Shawn Guodfcd04b2011-09-08 15:09:35 +0800653 of_i2c_register_devices(&i2c_imx->adapter);
654
Darius Augulisaa11e382009-01-30 10:32:28 +0200655 /* Set up platform driver data */
656 platform_set_drvdata(pdev, i2c_imx);
Jingchang Lu46f28322013-08-07 17:05:37 +0800657 clk_disable_unprepare(i2c_imx->clk);
Darius Augulisaa11e382009-01-30 10:32:28 +0200658
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800659 dev_dbg(&i2c_imx->adapter.dev, "claimed irq %d\n", irq);
Darius Augulisaa11e382009-01-30 10:32:28 +0200660 dev_dbg(&i2c_imx->adapter.dev, "device resources from 0x%x to 0x%x\n",
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800661 res->start, res->end);
662 dev_dbg(&i2c_imx->adapter.dev, "allocated %d bytes at 0x%x\n",
663 resource_size(res), res->start);
Darius Augulisaa11e382009-01-30 10:32:28 +0200664 dev_dbg(&i2c_imx->adapter.dev, "adapter name: \"%s\"\n",
665 i2c_imx->adapter.name);
Fabio Estevam06d141e2012-08-01 17:38:14 -0300666 dev_info(&i2c_imx->adapter.dev, "IMX I2C adapter registered\n");
Darius Augulisaa11e382009-01-30 10:32:28 +0200667
668 return 0; /* Return OK */
Darius Augulisaa11e382009-01-30 10:32:28 +0200669}
670
671static int __exit i2c_imx_remove(struct platform_device *pdev)
672{
673 struct imx_i2c_struct *i2c_imx = platform_get_drvdata(pdev);
Darius Augulisaa11e382009-01-30 10:32:28 +0200674
675 /* remove adapter */
676 dev_dbg(&i2c_imx->adapter.dev, "adapter removed\n");
677 i2c_del_adapter(&i2c_imx->adapter);
Darius Augulisaa11e382009-01-30 10:32:28 +0200678
Darius Augulisaa11e382009-01-30 10:32:28 +0200679 /* setup chip registers to defaults */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800680 imx_i2c_write_reg(0, i2c_imx, IMX_I2C_IADR);
681 imx_i2c_write_reg(0, i2c_imx, IMX_I2C_IFDR);
682 imx_i2c_write_reg(0, i2c_imx, IMX_I2C_I2CR);
683 imx_i2c_write_reg(0, i2c_imx, IMX_I2C_I2SR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200684
Darius Augulisaa11e382009-01-30 10:32:28 +0200685 return 0;
686}
687
688static struct platform_driver i2c_imx_driver = {
Darius Augulisaa11e382009-01-30 10:32:28 +0200689 .remove = __exit_p(i2c_imx_remove),
690 .driver = {
691 .name = DRIVER_NAME,
692 .owner = THIS_MODULE,
Shawn Guodfcd04b2011-09-08 15:09:35 +0800693 .of_match_table = i2c_imx_dt_ids,
Shawn Guo5bdfba22012-09-14 15:19:00 +0800694 },
695 .id_table = imx_i2c_devtype,
Darius Augulisaa11e382009-01-30 10:32:28 +0200696};
697
698static int __init i2c_adap_imx_init(void)
699{
700 return platform_driver_probe(&i2c_imx_driver, i2c_imx_probe);
701}
Wolfram Sang5d3f3332009-09-19 09:09:50 +0200702subsys_initcall(i2c_adap_imx_init);
Darius Augulisaa11e382009-01-30 10:32:28 +0200703
704static void __exit i2c_adap_imx_exit(void)
705{
706 platform_driver_unregister(&i2c_imx_driver);
707}
Darius Augulisaa11e382009-01-30 10:32:28 +0200708module_exit(i2c_adap_imx_exit);
709
710MODULE_LICENSE("GPL");
711MODULE_AUTHOR("Darius Augulis");
712MODULE_DESCRIPTION("I2C adapter driver for IMX I2C bus");
713MODULE_ALIAS("platform:" DRIVER_NAME);