xref: /openbmc/linux/arch/arm/mach-omap2/i2c.c (revision 3a8761c0)
1 /*
2  * Helper module for board specific I2C bus registration
3  *
4  * Copyright (C) 2009 Nokia Corporation.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * version 2 as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18  * 02110-1301 USA
19  *
20  */
21 
22 #include "common.h"
23 #include <plat/omap_hwmod.h>
24 #include <plat/omap_device.h>
25 
26 #include "mux.h"
27 #include "i2c.h"
28 
29 /* In register I2C_CON, Bit 15 is the I2C enable bit */
30 #define I2C_EN					BIT(15)
31 #define OMAP2_I2C_CON_OFFSET			0x24
32 #define OMAP4_I2C_CON_OFFSET			0xA4
33 
34 /* Maximum microseconds to wait for OMAP module to softreset */
35 #define MAX_MODULE_SOFTRESET_WAIT	10000
36 
37 #define MAX_OMAP_I2C_HWMOD_NAME_LEN	16
38 
39 static void __init omap2_i2c_mux_pins(int bus_id)
40 {
41 	char mux_name[sizeof("i2c2_scl.i2c2_scl")];
42 
43 	/* First I2C bus is not muxable */
44 	if (bus_id == 1)
45 		return;
46 
47 	sprintf(mux_name, "i2c%i_scl.i2c%i_scl", bus_id, bus_id);
48 	omap_mux_init_signal(mux_name, OMAP_PIN_INPUT);
49 	sprintf(mux_name, "i2c%i_sda.i2c%i_sda", bus_id, bus_id);
50 	omap_mux_init_signal(mux_name, OMAP_PIN_INPUT);
51 }
52 
53 /**
54  * omap_i2c_reset - reset the omap i2c module.
55  * @oh: struct omap_hwmod *
56  *
57  * The i2c moudle in omap2, omap3 had a special sequence to reset. The
58  * sequence is:
59  * - Disable the I2C.
60  * - Write to SOFTRESET bit.
61  * - Enable the I2C.
62  * - Poll on the RESETDONE bit.
63  * The sequence is implemented in below function. This is called for 2420,
64  * 2430 and omap3.
65  */
66 int omap_i2c_reset(struct omap_hwmod *oh)
67 {
68 	u32 v;
69 	u16 i2c_con;
70 	int c = 0;
71 
72 	if (oh->class->rev == OMAP_I2C_IP_VERSION_2) {
73 		i2c_con = OMAP4_I2C_CON_OFFSET;
74 	} else if (oh->class->rev == OMAP_I2C_IP_VERSION_1) {
75 		i2c_con = OMAP2_I2C_CON_OFFSET;
76 	} else {
77 		WARN(1, "Cannot reset I2C block %s: unsupported revision\n",
78 		     oh->name);
79 		return -EINVAL;
80 	}
81 
82 	/* Disable I2C */
83 	v = omap_hwmod_read(oh, i2c_con);
84 	v &= ~I2C_EN;
85 	omap_hwmod_write(v, oh, i2c_con);
86 
87 	/* Write to the SOFTRESET bit */
88 	omap_hwmod_softreset(oh);
89 
90 	/* Enable I2C */
91 	v = omap_hwmod_read(oh, i2c_con);
92 	v |= I2C_EN;
93 	omap_hwmod_write(v, oh, i2c_con);
94 
95 	/* Poll on RESETDONE bit */
96 	omap_test_timeout((omap_hwmod_read(oh,
97 				oh->class->sysc->syss_offs)
98 				& SYSS_RESETDONE_MASK),
99 				MAX_MODULE_SOFTRESET_WAIT, c);
100 
101 	if (c == MAX_MODULE_SOFTRESET_WAIT)
102 		pr_warning("%s: %s: softreset failed (waited %d usec)\n",
103 			__func__, oh->name, MAX_MODULE_SOFTRESET_WAIT);
104 	else
105 		pr_debug("%s: %s: softreset in %d usec\n", __func__,
106 			oh->name, c);
107 
108 	return 0;
109 }
110 
111 static const char name[] = "omap_i2c";
112 
113 int __init omap_i2c_add_bus(struct omap_i2c_bus_platform_data *i2c_pdata,
114 				int bus_id)
115 {
116 	int l;
117 	struct omap_hwmod *oh;
118 	struct platform_device *pdev;
119 	char oh_name[MAX_OMAP_I2C_HWMOD_NAME_LEN];
120 	struct omap_i2c_bus_platform_data *pdata;
121 	struct omap_i2c_dev_attr *dev_attr;
122 
123 	omap2_i2c_mux_pins(bus_id);
124 
125 	l = snprintf(oh_name, MAX_OMAP_I2C_HWMOD_NAME_LEN, "i2c%d", bus_id);
126 	WARN(l >= MAX_OMAP_I2C_HWMOD_NAME_LEN,
127 		"String buffer overflow in I2C%d device setup\n", bus_id);
128 	oh = omap_hwmod_lookup(oh_name);
129 	if (!oh) {
130 			pr_err("Could not look up %s\n", oh_name);
131 			return -EEXIST;
132 	}
133 
134 	pdata = i2c_pdata;
135 	/*
136 	 * pass the hwmod class's CPU-specific knowledge of I2C IP revision in
137 	 * use, and functionality implementation flags, up to the OMAP I2C
138 	 * driver via platform data
139 	 */
140 	pdata->rev = oh->class->rev;
141 
142 	dev_attr = (struct omap_i2c_dev_attr *)oh->dev_attr;
143 	pdata->flags = dev_attr->flags;
144 
145 	pdev = omap_device_build(name, bus_id, oh, pdata,
146 			sizeof(struct omap_i2c_bus_platform_data),
147 			NULL, 0, 0);
148 	WARN(IS_ERR(pdev), "Could not build omap_device for %s\n", name);
149 
150 	return PTR_RET(pdev);
151 }
152 
153