blob: 9c0f8bda692ae55ff7dce1bcd9c68c93a9a80a5c [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
Jingchang Luad90efa2013-08-07 17:05:43 +080082#define VF610_I2C_REGSHIFT 0
Darius Augulisaa11e382009-01-30 10:32:28 +020083
84/* Bits of IMX I2C registers */
85#define I2SR_RXAK 0x01
86#define I2SR_IIF 0x02
87#define I2SR_SRW 0x04
88#define I2SR_IAL 0x10
89#define I2SR_IBB 0x20
90#define I2SR_IAAS 0x40
91#define I2SR_ICF 0x80
92#define I2CR_RSTA 0x04
93#define I2CR_TXAK 0x08
94#define I2CR_MTX 0x10
95#define I2CR_MSTA 0x20
96#define I2CR_IIEN 0x40
97#define I2CR_IEN 0x80
98
Jingchang Lu171408c2013-08-07 17:05:41 +080099/* register bits different operating codes definition:
100 * 1) I2SR: Interrupt flags clear operation differ between SoCs:
101 * - write zero to clear(w0c) INT flag on i.MX,
102 * - but write one to clear(w1c) INT flag on Vybrid.
103 * 2) I2CR: I2C module enable operation also differ between SoCs:
104 * - set I2CR_IEN bit enable the module on i.MX,
105 * - but clear I2CR_IEN bit enable the module on Vybrid.
106 */
107#define I2SR_CLR_OPCODE_W0C 0x0
108#define I2SR_CLR_OPCODE_W1C (I2SR_IAL | I2SR_IIF)
109#define I2CR_IEN_OPCODE_0 0x0
110#define I2CR_IEN_OPCODE_1 I2CR_IEN
111
Darius Augulisaa11e382009-01-30 10:32:28 +0200112/** Variables ******************************************************************
113*******************************************************************************/
114
Darius Augulisaa11e382009-01-30 10:32:28 +0200115/*
116 * sorted list of clock divider, register value pairs
117 * taken from table 26-5, p.26-9, Freescale i.MX
118 * Integrated Portable System Processor Reference Manual
119 * Document Number: MC9328MXLRM, Rev. 5.1, 06/2007
120 *
121 * Duplicated divider values removed from list
122 */
Jingchang Lud533f042013-08-07 17:05:36 +0800123struct imx_i2c_clk_pair {
124 u16 div;
125 u16 val;
126};
Darius Augulisaa11e382009-01-30 10:32:28 +0200127
Jingchang Lu4b775022013-08-07 17:05:42 +0800128static struct imx_i2c_clk_pair imx_i2c_clk_div[] = {
Darius Augulisaa11e382009-01-30 10:32:28 +0200129 { 22, 0x20 }, { 24, 0x21 }, { 26, 0x22 }, { 28, 0x23 },
130 { 30, 0x00 }, { 32, 0x24 }, { 36, 0x25 }, { 40, 0x26 },
131 { 42, 0x03 }, { 44, 0x27 }, { 48, 0x28 }, { 52, 0x05 },
132 { 56, 0x29 }, { 60, 0x06 }, { 64, 0x2A }, { 72, 0x2B },
133 { 80, 0x2C }, { 88, 0x09 }, { 96, 0x2D }, { 104, 0x0A },
134 { 112, 0x2E }, { 128, 0x2F }, { 144, 0x0C }, { 160, 0x30 },
135 { 192, 0x31 }, { 224, 0x32 }, { 240, 0x0F }, { 256, 0x33 },
136 { 288, 0x10 }, { 320, 0x34 }, { 384, 0x35 }, { 448, 0x36 },
137 { 480, 0x13 }, { 512, 0x37 }, { 576, 0x14 }, { 640, 0x38 },
138 { 768, 0x39 }, { 896, 0x3A }, { 960, 0x17 }, { 1024, 0x3B },
139 { 1152, 0x18 }, { 1280, 0x3C }, { 1536, 0x3D }, { 1792, 0x3E },
140 { 1920, 0x1B }, { 2048, 0x3F }, { 2304, 0x1C }, { 2560, 0x1D },
141 { 3072, 0x1E }, { 3840, 0x1F }
142};
143
Jingchang Luad90efa2013-08-07 17:05:43 +0800144/* Vybrid VF610 clock divider, register value pairs */
145static struct imx_i2c_clk_pair vf610_i2c_clk_div[] = {
146 { 20, 0x00 }, { 22, 0x01 }, { 24, 0x02 }, { 26, 0x03 },
147 { 28, 0x04 }, { 30, 0x05 }, { 32, 0x09 }, { 34, 0x06 },
148 { 36, 0x0A }, { 40, 0x07 }, { 44, 0x0C }, { 48, 0x0D },
149 { 52, 0x43 }, { 56, 0x0E }, { 60, 0x45 }, { 64, 0x12 },
150 { 68, 0x0F }, { 72, 0x13 }, { 80, 0x14 }, { 88, 0x15 },
151 { 96, 0x19 }, { 104, 0x16 }, { 112, 0x1A }, { 128, 0x17 },
152 { 136, 0x4F }, { 144, 0x1C }, { 160, 0x1D }, { 176, 0x55 },
153 { 192, 0x1E }, { 208, 0x56 }, { 224, 0x22 }, { 228, 0x24 },
154 { 240, 0x1F }, { 256, 0x23 }, { 288, 0x5C }, { 320, 0x25 },
155 { 384, 0x26 }, { 448, 0x2A }, { 480, 0x27 }, { 512, 0x2B },
156 { 576, 0x2C }, { 640, 0x2D }, { 768, 0x31 }, { 896, 0x32 },
157 { 960, 0x2F }, { 1024, 0x33 }, { 1152, 0x34 }, { 1280, 0x35 },
158 { 1536, 0x36 }, { 1792, 0x3A }, { 1920, 0x37 }, { 2048, 0x3B },
159 { 2304, 0x3C }, { 2560, 0x3D }, { 3072, 0x3E }, { 3584, 0x7A },
160 { 3840, 0x3F }, { 4096, 0x7B }, { 5120, 0x7D }, { 6144, 0x7E },
161};
162
Shawn Guo5bdfba22012-09-14 15:19:00 +0800163enum imx_i2c_type {
164 IMX1_I2C,
165 IMX21_I2C,
Jingchang Luad90efa2013-08-07 17:05:43 +0800166 VF610_I2C,
Shawn Guo5bdfba22012-09-14 15:19:00 +0800167};
168
Jingchang Lu4b775022013-08-07 17:05:42 +0800169struct imx_i2c_hwdata {
170 enum imx_i2c_type devtype;
171 unsigned regshift;
172 struct imx_i2c_clk_pair *clk_div;
173 unsigned ndivs;
174 unsigned i2sr_clr_opcode;
175 unsigned i2cr_ien_opcode;
176};
177
Darius Augulisaa11e382009-01-30 10:32:28 +0200178struct imx_i2c_struct {
179 struct i2c_adapter adapter;
Darius Augulisaa11e382009-01-30 10:32:28 +0200180 struct clk *clk;
181 void __iomem *base;
Darius Augulisaa11e382009-01-30 10:32:28 +0200182 wait_queue_head_t queue;
183 unsigned long i2csr;
Wolfram Sang65de3942009-04-06 16:27:45 +0200184 unsigned int disable_delay;
Richard Zhao43309f32009-10-17 17:46:22 +0800185 int stopped;
Richard Zhaodb3a3d42009-10-17 17:46:24 +0800186 unsigned int ifdr; /* IMX_I2C_IFDR */
Jingchang Lu4b775022013-08-07 17:05:42 +0800187 const struct imx_i2c_hwdata *hwdata;
188};
189
190static const struct imx_i2c_hwdata imx1_i2c_hwdata = {
191 .devtype = IMX1_I2C,
192 .regshift = IMX_I2C_REGSHIFT,
193 .clk_div = imx_i2c_clk_div,
194 .ndivs = ARRAY_SIZE(imx_i2c_clk_div),
195 .i2sr_clr_opcode = I2SR_CLR_OPCODE_W0C,
196 .i2cr_ien_opcode = I2CR_IEN_OPCODE_1,
197
198};
199
200static const struct imx_i2c_hwdata imx21_i2c_hwdata = {
201 .devtype = IMX21_I2C,
202 .regshift = IMX_I2C_REGSHIFT,
203 .clk_div = imx_i2c_clk_div,
204 .ndivs = ARRAY_SIZE(imx_i2c_clk_div),
205 .i2sr_clr_opcode = I2SR_CLR_OPCODE_W0C,
206 .i2cr_ien_opcode = I2CR_IEN_OPCODE_1,
207
Darius Augulisaa11e382009-01-30 10:32:28 +0200208};
209
Jingchang Luad90efa2013-08-07 17:05:43 +0800210static struct imx_i2c_hwdata vf610_i2c_hwdata = {
211 .devtype = VF610_I2C,
212 .regshift = VF610_I2C_REGSHIFT,
213 .clk_div = vf610_i2c_clk_div,
214 .ndivs = ARRAY_SIZE(vf610_i2c_clk_div),
215 .i2sr_clr_opcode = I2SR_CLR_OPCODE_W1C,
216 .i2cr_ien_opcode = I2CR_IEN_OPCODE_0,
217
218};
219
Shawn Guo5bdfba22012-09-14 15:19:00 +0800220static struct platform_device_id imx_i2c_devtype[] = {
221 {
222 .name = "imx1-i2c",
Jingchang Lu4b775022013-08-07 17:05:42 +0800223 .driver_data = (kernel_ulong_t)&imx1_i2c_hwdata,
Shawn Guo5bdfba22012-09-14 15:19:00 +0800224 }, {
225 .name = "imx21-i2c",
Jingchang Lu4b775022013-08-07 17:05:42 +0800226 .driver_data = (kernel_ulong_t)&imx21_i2c_hwdata,
Shawn Guo5bdfba22012-09-14 15:19:00 +0800227 }, {
228 /* sentinel */
229 }
230};
231MODULE_DEVICE_TABLE(platform, imx_i2c_devtype);
232
Shawn Guodfcd04b2011-09-08 15:09:35 +0800233static const struct of_device_id i2c_imx_dt_ids[] = {
Jingchang Lu4b775022013-08-07 17:05:42 +0800234 { .compatible = "fsl,imx1-i2c", .data = &imx1_i2c_hwdata, },
235 { .compatible = "fsl,imx21-i2c", .data = &imx21_i2c_hwdata, },
Jingchang Luad90efa2013-08-07 17:05:43 +0800236 { .compatible = "fsl,vf610-i2c", .data = &vf610_i2c_hwdata, },
Shawn Guodfcd04b2011-09-08 15:09:35 +0800237 { /* sentinel */ }
238};
Arnaud Patard \(Rtp\)2f641a82013-06-20 23:07:06 +0200239MODULE_DEVICE_TABLE(of, i2c_imx_dt_ids);
Shawn Guodfcd04b2011-09-08 15:09:35 +0800240
Shawn Guo5bdfba22012-09-14 15:19:00 +0800241static inline int is_imx1_i2c(struct imx_i2c_struct *i2c_imx)
242{
Jingchang Lu4b775022013-08-07 17:05:42 +0800243 return i2c_imx->hwdata->devtype == IMX1_I2C;
Shawn Guo5bdfba22012-09-14 15:19:00 +0800244}
245
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800246static inline void imx_i2c_write_reg(unsigned int val,
247 struct imx_i2c_struct *i2c_imx, unsigned int reg)
248{
Jingchang Lu4b775022013-08-07 17:05:42 +0800249 writeb(val, i2c_imx->base + (reg << i2c_imx->hwdata->regshift));
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800250}
251
252static inline unsigned char imx_i2c_read_reg(struct imx_i2c_struct *i2c_imx,
253 unsigned int reg)
254{
Jingchang Lu4b775022013-08-07 17:05:42 +0800255 return readb(i2c_imx->base + (reg << i2c_imx->hwdata->regshift));
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800256}
257
Darius Augulisaa11e382009-01-30 10:32:28 +0200258/** Functions for IMX I2C adapter driver ***************************************
259*******************************************************************************/
260
Richard Zhao43309f32009-10-17 17:46:22 +0800261static int i2c_imx_bus_busy(struct imx_i2c_struct *i2c_imx, int for_busy)
Darius Augulisaa11e382009-01-30 10:32:28 +0200262{
263 unsigned long orig_jiffies = jiffies;
Richard Zhao43309f32009-10-17 17:46:22 +0800264 unsigned int temp;
Darius Augulisaa11e382009-01-30 10:32:28 +0200265
266 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
267
Richard Zhao43309f32009-10-17 17:46:22 +0800268 while (1) {
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800269 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
Richard Zhao43309f32009-10-17 17:46:22 +0800270 if (for_busy && (temp & I2SR_IBB))
271 break;
272 if (!for_busy && !(temp & I2SR_IBB))
273 break;
Arnaud Patardda9c99f2010-03-23 17:28:28 +0100274 if (time_after(jiffies, orig_jiffies + msecs_to_jiffies(500))) {
Darius Augulisaa11e382009-01-30 10:32:28 +0200275 dev_dbg(&i2c_imx->adapter.dev,
276 "<%s> I2C bus is busy\n", __func__);
Arnaud Patardda9c99f2010-03-23 17:28:28 +0100277 return -ETIMEDOUT;
Darius Augulisaa11e382009-01-30 10:32:28 +0200278 }
279 schedule();
280 }
281
282 return 0;
283}
284
285static int i2c_imx_trx_complete(struct imx_i2c_struct *i2c_imx)
286{
Marc Kleine-Buddee39428d2010-06-21 09:27:05 +0200287 wait_event_timeout(i2c_imx->queue, i2c_imx->i2csr & I2SR_IIF, HZ / 10);
Darius Augulisaa11e382009-01-30 10:32:28 +0200288
Marc Kleine-Buddee39428d2010-06-21 09:27:05 +0200289 if (unlikely(!(i2c_imx->i2csr & I2SR_IIF))) {
Darius Augulisaa11e382009-01-30 10:32:28 +0200290 dev_dbg(&i2c_imx->adapter.dev, "<%s> Timeout\n", __func__);
291 return -ETIMEDOUT;
292 }
293 dev_dbg(&i2c_imx->adapter.dev, "<%s> TRX complete\n", __func__);
294 i2c_imx->i2csr = 0;
295 return 0;
296}
297
298static int i2c_imx_acked(struct imx_i2c_struct *i2c_imx)
299{
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800300 if (imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR) & I2SR_RXAK) {
Darius Augulisaa11e382009-01-30 10:32:28 +0200301 dev_dbg(&i2c_imx->adapter.dev, "<%s> No ACK\n", __func__);
302 return -EIO; /* No ACK */
303 }
304
305 dev_dbg(&i2c_imx->adapter.dev, "<%s> ACK received\n", __func__);
306 return 0;
307}
308
Richard Zhao43309f32009-10-17 17:46:22 +0800309static int i2c_imx_start(struct imx_i2c_struct *i2c_imx)
Darius Augulisaa11e382009-01-30 10:32:28 +0200310{
311 unsigned int temp = 0;
Richard Zhao43309f32009-10-17 17:46:22 +0800312 int result;
Darius Augulisaa11e382009-01-30 10:32:28 +0200313
314 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
315
Richard Zhao83914332011-11-15 14:48:08 +0800316 clk_prepare_enable(i2c_imx->clk);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800317 imx_i2c_write_reg(i2c_imx->ifdr, i2c_imx, IMX_I2C_IFDR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200318 /* Enable I2C controller */
Jingchang Lu4b775022013-08-07 17:05:42 +0800319 imx_i2c_write_reg(i2c_imx->hwdata->i2sr_clr_opcode, i2c_imx, IMX_I2C_I2SR);
320 imx_i2c_write_reg(i2c_imx->hwdata->i2cr_ien_opcode, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800321
322 /* Wait controller to be stable */
323 udelay(50);
324
Darius Augulisaa11e382009-01-30 10:32:28 +0200325 /* Start I2C transaction */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800326 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200327 temp |= I2CR_MSTA;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800328 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800329 result = i2c_imx_bus_busy(i2c_imx, 1);
330 if (result)
331 return result;
332 i2c_imx->stopped = 0;
333
Darius Augulisaa11e382009-01-30 10:32:28 +0200334 temp |= I2CR_IIEN | I2CR_MTX | I2CR_TXAK;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800335 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800336 return result;
Darius Augulisaa11e382009-01-30 10:32:28 +0200337}
338
339static void i2c_imx_stop(struct imx_i2c_struct *i2c_imx)
340{
341 unsigned int temp = 0;
342
Richard Zhao43309f32009-10-17 17:46:22 +0800343 if (!i2c_imx->stopped) {
344 /* Stop I2C transaction */
345 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800346 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800347 temp &= ~(I2CR_MSTA | I2CR_MTX);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800348 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800349 }
Shawn Guo5bdfba22012-09-14 15:19:00 +0800350 if (is_imx1_i2c(i2c_imx)) {
Richard Zhaoa4094a72009-10-17 17:46:23 +0800351 /*
352 * This delay caused by an i.MXL hardware bug.
353 * If no (or too short) delay, no "STOP" bit will be generated.
354 */
355 udelay(i2c_imx->disable_delay);
356 }
Richard Zhao43309f32009-10-17 17:46:22 +0800357
Valentin Longchampa1ee06b2010-01-21 18:55:32 +0100358 if (!i2c_imx->stopped) {
Richard Zhao43309f32009-10-17 17:46:22 +0800359 i2c_imx_bus_busy(i2c_imx, 0);
Valentin Longchampa1ee06b2010-01-21 18:55:32 +0100360 i2c_imx->stopped = 1;
361 }
Richard Zhao43309f32009-10-17 17:46:22 +0800362
Darius Augulisaa11e382009-01-30 10:32:28 +0200363 /* Disable I2C controller */
Jingchang Lu4b775022013-08-07 17:05:42 +0800364 temp = i2c_imx->hwdata->i2cr_ien_opcode ^ I2CR_IEN,
365 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao83914332011-11-15 14:48:08 +0800366 clk_disable_unprepare(i2c_imx->clk);
Darius Augulisaa11e382009-01-30 10:32:28 +0200367}
368
369static void __init i2c_imx_set_clk(struct imx_i2c_struct *i2c_imx,
370 unsigned int rate)
371{
Jingchang Lu4b775022013-08-07 17:05:42 +0800372 struct imx_i2c_clk_pair *i2c_clk_div = i2c_imx->hwdata->clk_div;
Darius Augulisaa11e382009-01-30 10:32:28 +0200373 unsigned int i2c_clk_rate;
374 unsigned int div;
375 int i;
376
377 /* Divider value calculation */
378 i2c_clk_rate = clk_get_rate(i2c_imx->clk);
379 div = (i2c_clk_rate + rate - 1) / rate;
Jingchang Lud533f042013-08-07 17:05:36 +0800380 if (div < i2c_clk_div[0].div)
Darius Augulisaa11e382009-01-30 10:32:28 +0200381 i = 0;
Jingchang Lu4b775022013-08-07 17:05:42 +0800382 else if (div > i2c_clk_div[i2c_imx->hwdata->ndivs - 1].div)
383 i = i2c_imx->hwdata->ndivs - 1;
Darius Augulisaa11e382009-01-30 10:32:28 +0200384 else
Jingchang Lud533f042013-08-07 17:05:36 +0800385 for (i = 0; i2c_clk_div[i].div < div; i++);
Darius Augulisaa11e382009-01-30 10:32:28 +0200386
Richard Zhaodb3a3d42009-10-17 17:46:24 +0800387 /* Store divider value */
Jingchang Lud533f042013-08-07 17:05:36 +0800388 i2c_imx->ifdr = i2c_clk_div[i].val;
Darius Augulisaa11e382009-01-30 10:32:28 +0200389
390 /*
391 * There dummy delay is calculated.
392 * It should be about one I2C clock period long.
393 * This delay is used in I2C bus disable function
394 * to fix chip hardware bug.
395 */
Jingchang Lud533f042013-08-07 17:05:36 +0800396 i2c_imx->disable_delay = (500000U * i2c_clk_div[i].div
Darius Augulisaa11e382009-01-30 10:32:28 +0200397 + (i2c_clk_rate / 2) - 1) / (i2c_clk_rate / 2);
398
399 /* dev_dbg() can't be used, because adapter is not yet registered */
400#ifdef CONFIG_I2C_DEBUG_BUS
Fabio Estevam002f0022012-08-01 17:38:15 -0300401 dev_dbg(&i2c_imx->adapter.dev, "<%s> I2C_CLK=%d, REQ DIV=%d\n",
Darius Augulisaa11e382009-01-30 10:32:28 +0200402 __func__, i2c_clk_rate, div);
Fabio Estevam002f0022012-08-01 17:38:15 -0300403 dev_dbg(&i2c_imx->adapter.dev, "<%s> IFDR[IC]=0x%x, REAL DIV=%d\n",
Jingchang Lud533f042013-08-07 17:05:36 +0800404 __func__, i2c_clk_div[i].val, i2c_clk_div[i].div);
Darius Augulisaa11e382009-01-30 10:32:28 +0200405#endif
406}
407
408static irqreturn_t i2c_imx_isr(int irq, void *dev_id)
409{
410 struct imx_i2c_struct *i2c_imx = dev_id;
411 unsigned int temp;
412
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800413 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200414 if (temp & I2SR_IIF) {
415 /* save status register */
416 i2c_imx->i2csr = temp;
417 temp &= ~I2SR_IIF;
Jingchang Lu4b775022013-08-07 17:05:42 +0800418 temp |= (i2c_imx->hwdata->i2sr_clr_opcode & I2SR_IIF);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800419 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2SR);
Marc Kleine-Buddee39428d2010-06-21 09:27:05 +0200420 wake_up(&i2c_imx->queue);
Darius Augulisaa11e382009-01-30 10:32:28 +0200421 return IRQ_HANDLED;
422 }
423
424 return IRQ_NONE;
425}
426
427static int i2c_imx_write(struct imx_i2c_struct *i2c_imx, struct i2c_msg *msgs)
428{
429 int i, result;
430
431 dev_dbg(&i2c_imx->adapter.dev, "<%s> write slave address: addr=0x%x\n",
432 __func__, msgs->addr << 1);
433
434 /* write slave address */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800435 imx_i2c_write_reg(msgs->addr << 1, i2c_imx, IMX_I2C_I2DR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200436 result = i2c_imx_trx_complete(i2c_imx);
437 if (result)
438 return result;
439 result = i2c_imx_acked(i2c_imx);
440 if (result)
441 return result;
442 dev_dbg(&i2c_imx->adapter.dev, "<%s> write data\n", __func__);
443
444 /* write data */
445 for (i = 0; i < msgs->len; i++) {
446 dev_dbg(&i2c_imx->adapter.dev,
447 "<%s> write byte: B%d=0x%X\n",
448 __func__, i, msgs->buf[i]);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800449 imx_i2c_write_reg(msgs->buf[i], i2c_imx, IMX_I2C_I2DR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200450 result = i2c_imx_trx_complete(i2c_imx);
451 if (result)
452 return result;
453 result = i2c_imx_acked(i2c_imx);
454 if (result)
455 return result;
456 }
457 return 0;
458}
459
460static int i2c_imx_read(struct imx_i2c_struct *i2c_imx, struct i2c_msg *msgs)
461{
462 int i, result;
463 unsigned int temp;
464
465 dev_dbg(&i2c_imx->adapter.dev,
466 "<%s> write slave address: addr=0x%x\n",
467 __func__, (msgs->addr << 1) | 0x01);
468
469 /* write slave address */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800470 imx_i2c_write_reg((msgs->addr << 1) | 0x01, i2c_imx, IMX_I2C_I2DR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200471 result = i2c_imx_trx_complete(i2c_imx);
472 if (result)
473 return result;
474 result = i2c_imx_acked(i2c_imx);
475 if (result)
476 return result;
477
478 dev_dbg(&i2c_imx->adapter.dev, "<%s> setup bus\n", __func__);
479
480 /* setup bus to read data */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800481 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200482 temp &= ~I2CR_MTX;
483 if (msgs->len - 1)
484 temp &= ~I2CR_TXAK;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800485 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
486 imx_i2c_read_reg(i2c_imx, IMX_I2C_I2DR); /* dummy read */
Darius Augulisaa11e382009-01-30 10:32:28 +0200487
488 dev_dbg(&i2c_imx->adapter.dev, "<%s> read data\n", __func__);
489
490 /* read data */
491 for (i = 0; i < msgs->len; i++) {
492 result = i2c_imx_trx_complete(i2c_imx);
493 if (result)
494 return result;
495 if (i == (msgs->len - 1)) {
Richard Zhao43309f32009-10-17 17:46:22 +0800496 /* It must generate STOP before read I2DR to prevent
497 controller from generating another clock cycle */
Darius Augulisaa11e382009-01-30 10:32:28 +0200498 dev_dbg(&i2c_imx->adapter.dev,
499 "<%s> clear MSTA\n", __func__);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800500 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800501 temp &= ~(I2CR_MSTA | I2CR_MTX);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800502 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800503 i2c_imx_bus_busy(i2c_imx, 0);
504 i2c_imx->stopped = 1;
Darius Augulisaa11e382009-01-30 10:32:28 +0200505 } else if (i == (msgs->len - 2)) {
506 dev_dbg(&i2c_imx->adapter.dev,
507 "<%s> set TXAK\n", __func__);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800508 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200509 temp |= I2CR_TXAK;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800510 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200511 }
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800512 msgs->buf[i] = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2DR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200513 dev_dbg(&i2c_imx->adapter.dev,
514 "<%s> read byte: B%d=0x%X\n",
515 __func__, i, msgs->buf[i]);
516 }
517 return 0;
518}
519
520static int i2c_imx_xfer(struct i2c_adapter *adapter,
521 struct i2c_msg *msgs, int num)
522{
523 unsigned int i, temp;
524 int result;
525 struct imx_i2c_struct *i2c_imx = i2c_get_adapdata(adapter);
526
527 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
528
Richard Zhao43309f32009-10-17 17:46:22 +0800529 /* Start I2C transfer */
530 result = i2c_imx_start(i2c_imx);
Darius Augulisaa11e382009-01-30 10:32:28 +0200531 if (result)
532 goto fail0;
533
Darius Augulisaa11e382009-01-30 10:32:28 +0200534 /* read/write data */
535 for (i = 0; i < num; i++) {
536 if (i) {
537 dev_dbg(&i2c_imx->adapter.dev,
538 "<%s> repeated start\n", __func__);
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800539 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200540 temp |= I2CR_RSTA;
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800541 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
Richard Zhao43309f32009-10-17 17:46:22 +0800542 result = i2c_imx_bus_busy(i2c_imx, 1);
543 if (result)
544 goto fail0;
Darius Augulisaa11e382009-01-30 10:32:28 +0200545 }
546 dev_dbg(&i2c_imx->adapter.dev,
547 "<%s> transfer message: %d\n", __func__, i);
548 /* write/read data */
549#ifdef CONFIG_I2C_DEBUG_BUS
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800550 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200551 dev_dbg(&i2c_imx->adapter.dev, "<%s> CONTROL: IEN=%d, IIEN=%d, "
552 "MSTA=%d, MTX=%d, TXAK=%d, RSTA=%d\n", __func__,
553 (temp & I2CR_IEN ? 1 : 0), (temp & I2CR_IIEN ? 1 : 0),
554 (temp & I2CR_MSTA ? 1 : 0), (temp & I2CR_MTX ? 1 : 0),
555 (temp & I2CR_TXAK ? 1 : 0), (temp & I2CR_RSTA ? 1 : 0));
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800556 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2SR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200557 dev_dbg(&i2c_imx->adapter.dev,
558 "<%s> STATUS: ICF=%d, IAAS=%d, IBB=%d, "
559 "IAL=%d, SRW=%d, IIF=%d, RXAK=%d\n", __func__,
560 (temp & I2SR_ICF ? 1 : 0), (temp & I2SR_IAAS ? 1 : 0),
561 (temp & I2SR_IBB ? 1 : 0), (temp & I2SR_IAL ? 1 : 0),
562 (temp & I2SR_SRW ? 1 : 0), (temp & I2SR_IIF ? 1 : 0),
563 (temp & I2SR_RXAK ? 1 : 0));
564#endif
565 if (msgs[i].flags & I2C_M_RD)
566 result = i2c_imx_read(i2c_imx, &msgs[i]);
567 else
568 result = i2c_imx_write(i2c_imx, &msgs[i]);
Arnaud Patardda9c99f2010-03-23 17:28:28 +0100569 if (result)
570 goto fail0;
Darius Augulisaa11e382009-01-30 10:32:28 +0200571 }
572
573fail0:
574 /* Stop I2C transfer */
575 i2c_imx_stop(i2c_imx);
576
577 dev_dbg(&i2c_imx->adapter.dev, "<%s> exit with: %s: %d\n", __func__,
578 (result < 0) ? "error" : "success msg",
579 (result < 0) ? result : num);
580 return (result < 0) ? result : num;
581}
582
583static u32 i2c_imx_func(struct i2c_adapter *adapter)
584{
585 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL;
586}
587
588static struct i2c_algorithm i2c_imx_algo = {
589 .master_xfer = i2c_imx_xfer,
590 .functionality = i2c_imx_func,
591};
592
593static int __init i2c_imx_probe(struct platform_device *pdev)
594{
Shawn Guo5bdfba22012-09-14 15:19:00 +0800595 const struct of_device_id *of_id = of_match_device(i2c_imx_dt_ids,
596 &pdev->dev);
Darius Augulisaa11e382009-01-30 10:32:28 +0200597 struct imx_i2c_struct *i2c_imx;
598 struct resource *res;
Shawn Guo593702c2011-09-08 15:09:34 +0800599 struct imxi2c_platform_data *pdata = pdev->dev.platform_data;
Darius Augulisaa11e382009-01-30 10:32:28 +0200600 void __iomem *base;
Wolfram Sang8c88ab02012-07-08 13:11:43 +0200601 int irq, ret;
602 u32 bitrate;
Darius Augulisaa11e382009-01-30 10:32:28 +0200603
604 dev_dbg(&pdev->dev, "<%s>\n", __func__);
605
Darius Augulisaa11e382009-01-30 10:32:28 +0200606 irq = platform_get_irq(pdev, 0);
607 if (irq < 0) {
608 dev_err(&pdev->dev, "can't get irq number\n");
609 return -ENOENT;
610 }
611
Wolfram Sang3cc2d002013-05-10 10:16:54 +0200612 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
Thierry Reding84dbf802013-01-21 11:09:03 +0100613 base = devm_ioremap_resource(&pdev->dev, res);
614 if (IS_ERR(base))
615 return PTR_ERR(base);
Uwe Kleine-König4927fbf2010-01-08 17:23:17 +0100616
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800617 i2c_imx = devm_kzalloc(&pdev->dev, sizeof(struct imx_i2c_struct),
618 GFP_KERNEL);
Darius Augulisaa11e382009-01-30 10:32:28 +0200619 if (!i2c_imx) {
620 dev_err(&pdev->dev, "can't allocate interface\n");
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800621 return -ENOMEM;
Darius Augulis309c18d2009-03-31 14:52:54 +0300622 }
623
Shawn Guo5bdfba22012-09-14 15:19:00 +0800624 if (of_id)
Jingchang Lu4b775022013-08-07 17:05:42 +0800625 i2c_imx->hwdata = of_id->data;
Jingchang Lu0fc13472013-08-07 17:05:38 +0800626 else
Jingchang Lu4b775022013-08-07 17:05:42 +0800627 i2c_imx->hwdata = (struct imx_i2c_hwdata *)
628 platform_get_device_id(pdev)->driver_data;
Shawn Guo5bdfba22012-09-14 15:19:00 +0800629
Darius Augulisaa11e382009-01-30 10:32:28 +0200630 /* Setup i2c_imx driver structure */
Wolfram Sang973c5ed2012-04-19 17:31:01 +0200631 strlcpy(i2c_imx->adapter.name, pdev->name, sizeof(i2c_imx->adapter.name));
Darius Augulisaa11e382009-01-30 10:32:28 +0200632 i2c_imx->adapter.owner = THIS_MODULE;
633 i2c_imx->adapter.algo = &i2c_imx_algo;
634 i2c_imx->adapter.dev.parent = &pdev->dev;
635 i2c_imx->adapter.nr = pdev->id;
Shawn Guodfcd04b2011-09-08 15:09:35 +0800636 i2c_imx->adapter.dev.of_node = pdev->dev.of_node;
Darius Augulisaa11e382009-01-30 10:32:28 +0200637 i2c_imx->base = base;
Darius Augulisaa11e382009-01-30 10:32:28 +0200638
639 /* Get I2C clock */
Fabio Estevam1f09c672012-07-06 15:31:32 -0300640 i2c_imx->clk = devm_clk_get(&pdev->dev, NULL);
Darius Augulisaa11e382009-01-30 10:32:28 +0200641 if (IS_ERR(i2c_imx->clk)) {
Darius Augulisaa11e382009-01-30 10:32:28 +0200642 dev_err(&pdev->dev, "can't get I2C clock\n");
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800643 return PTR_ERR(i2c_imx->clk);
Darius Augulisaa11e382009-01-30 10:32:28 +0200644 }
Darius Augulisaa11e382009-01-30 10:32:28 +0200645
Jingchang Lu46f28322013-08-07 17:05:37 +0800646 ret = clk_prepare_enable(i2c_imx->clk);
647 if (ret) {
648 dev_err(&pdev->dev, "can't enable I2C clock\n");
649 return ret;
650 }
Darius Augulisaa11e382009-01-30 10:32:28 +0200651 /* Request IRQ */
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800652 ret = devm_request_irq(&pdev->dev, irq, i2c_imx_isr, 0,
653 pdev->name, i2c_imx);
Darius Augulisaa11e382009-01-30 10:32:28 +0200654 if (ret) {
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800655 dev_err(&pdev->dev, "can't claim irq %d\n", irq);
656 return ret;
Darius Augulisaa11e382009-01-30 10:32:28 +0200657 }
658
659 /* Init queue */
660 init_waitqueue_head(&i2c_imx->queue);
661
662 /* Set up adapter data */
663 i2c_set_adapdata(&i2c_imx->adapter, i2c_imx);
664
665 /* Set up clock divider */
Shawn Guodfcd04b2011-09-08 15:09:35 +0800666 bitrate = IMX_I2C_BIT_RATE;
667 ret = of_property_read_u32(pdev->dev.of_node,
668 "clock-frequency", &bitrate);
669 if (ret < 0 && pdata && pdata->bitrate)
670 bitrate = pdata->bitrate;
671 i2c_imx_set_clk(i2c_imx, bitrate);
Darius Augulisaa11e382009-01-30 10:32:28 +0200672
673 /* Set up chip registers to defaults */
Jingchang Lu4b775022013-08-07 17:05:42 +0800674 imx_i2c_write_reg(i2c_imx->hwdata->i2cr_ien_opcode ^ I2CR_IEN,
675 i2c_imx, IMX_I2C_I2CR);
676 imx_i2c_write_reg(i2c_imx->hwdata->i2sr_clr_opcode, i2c_imx, IMX_I2C_I2SR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200677
678 /* Add I2C adapter */
679 ret = i2c_add_numbered_adapter(&i2c_imx->adapter);
680 if (ret < 0) {
681 dev_err(&pdev->dev, "registration failed\n");
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800682 return ret;
Darius Augulisaa11e382009-01-30 10:32:28 +0200683 }
684
Shawn Guodfcd04b2011-09-08 15:09:35 +0800685 of_i2c_register_devices(&i2c_imx->adapter);
686
Darius Augulisaa11e382009-01-30 10:32:28 +0200687 /* Set up platform driver data */
688 platform_set_drvdata(pdev, i2c_imx);
Jingchang Lu46f28322013-08-07 17:05:37 +0800689 clk_disable_unprepare(i2c_imx->clk);
Darius Augulisaa11e382009-01-30 10:32:28 +0200690
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800691 dev_dbg(&i2c_imx->adapter.dev, "claimed irq %d\n", irq);
Darius Augulisaa11e382009-01-30 10:32:28 +0200692 dev_dbg(&i2c_imx->adapter.dev, "device resources from 0x%x to 0x%x\n",
Richard Zhao9f8a3e72012-06-04 19:04:25 +0800693 res->start, res->end);
694 dev_dbg(&i2c_imx->adapter.dev, "allocated %d bytes at 0x%x\n",
695 resource_size(res), res->start);
Darius Augulisaa11e382009-01-30 10:32:28 +0200696 dev_dbg(&i2c_imx->adapter.dev, "adapter name: \"%s\"\n",
697 i2c_imx->adapter.name);
Fabio Estevam06d141e2012-08-01 17:38:14 -0300698 dev_info(&i2c_imx->adapter.dev, "IMX I2C adapter registered\n");
Darius Augulisaa11e382009-01-30 10:32:28 +0200699
700 return 0; /* Return OK */
Darius Augulisaa11e382009-01-30 10:32:28 +0200701}
702
703static int __exit i2c_imx_remove(struct platform_device *pdev)
704{
705 struct imx_i2c_struct *i2c_imx = platform_get_drvdata(pdev);
Darius Augulisaa11e382009-01-30 10:32:28 +0200706
707 /* remove adapter */
708 dev_dbg(&i2c_imx->adapter.dev, "adapter removed\n");
709 i2c_del_adapter(&i2c_imx->adapter);
Darius Augulisaa11e382009-01-30 10:32:28 +0200710
Darius Augulisaa11e382009-01-30 10:32:28 +0200711 /* setup chip registers to defaults */
Jingchang Lu1d5ef2a2013-08-07 17:05:39 +0800712 imx_i2c_write_reg(0, i2c_imx, IMX_I2C_IADR);
713 imx_i2c_write_reg(0, i2c_imx, IMX_I2C_IFDR);
714 imx_i2c_write_reg(0, i2c_imx, IMX_I2C_I2CR);
715 imx_i2c_write_reg(0, i2c_imx, IMX_I2C_I2SR);
Darius Augulisaa11e382009-01-30 10:32:28 +0200716
Darius Augulisaa11e382009-01-30 10:32:28 +0200717 return 0;
718}
719
720static struct platform_driver i2c_imx_driver = {
Darius Augulisaa11e382009-01-30 10:32:28 +0200721 .remove = __exit_p(i2c_imx_remove),
722 .driver = {
723 .name = DRIVER_NAME,
724 .owner = THIS_MODULE,
Shawn Guodfcd04b2011-09-08 15:09:35 +0800725 .of_match_table = i2c_imx_dt_ids,
Shawn Guo5bdfba22012-09-14 15:19:00 +0800726 },
727 .id_table = imx_i2c_devtype,
Darius Augulisaa11e382009-01-30 10:32:28 +0200728};
729
730static int __init i2c_adap_imx_init(void)
731{
732 return platform_driver_probe(&i2c_imx_driver, i2c_imx_probe);
733}
Wolfram Sang5d3f3332009-09-19 09:09:50 +0200734subsys_initcall(i2c_adap_imx_init);
Darius Augulisaa11e382009-01-30 10:32:28 +0200735
736static void __exit i2c_adap_imx_exit(void)
737{
738 platform_driver_unregister(&i2c_imx_driver);
739}
Darius Augulisaa11e382009-01-30 10:32:28 +0200740module_exit(i2c_adap_imx_exit);
741
742MODULE_LICENSE("GPL");
743MODULE_AUTHOR("Darius Augulis");
744MODULE_DESCRIPTION("I2C adapter driver for IMX I2C bus");
745MODULE_ALIAS("platform:" DRIVER_NAME);