]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - arch/arm/plat-omap/i2c.c
ARM: OMAP: Add documentation for function omap_register_i2c_bus
[linux-2.6-omap-h63xx.git] / arch / arm / plat-omap / i2c.c
1 /*
2  * linux/arch/arm/plat-omap/i2c.c
3  *
4  * Helper module for board specific I2C bus registration
5  *
6  * Copyright (C) 2007 Nokia Corporation.
7  *
8  * Contact: Jarkko Nikula <jarkko.nikula@nokia.com>
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * version 2 as published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22  * 02110-1301 USA
23  *
24  */
25
26 #include <linux/kernel.h>
27 #include <linux/platform_device.h>
28 #include <linux/i2c.h>
29 #include <mach/irqs.h>
30 #include <mach/mux.h>
31
32 #define OMAP_I2C_SIZE           0x3f
33 #define OMAP1_I2C_BASE          0xfffb3800
34 #define OMAP2_I2C_BASE1         0x48070000
35 #define OMAP2_I2C_BASE2         0x48072000
36 #define OMAP2_I2C_BASE3         0x48060000
37
38 static const char name[] = "i2c_omap";
39
40 #define I2C_RESOURCE_BUILDER(base, irq)                 \
41         {                                               \
42                 .start  = (base),                       \
43                 .end    = (base) + OMAP_I2C_SIZE,       \
44                 .flags  = IORESOURCE_MEM,               \
45         },                                              \
46         {                                               \
47                 .start  = (irq),                        \
48                 .flags  = IORESOURCE_IRQ,               \
49         },
50
51 static struct resource i2c_resources[][2] = {
52         { I2C_RESOURCE_BUILDER(0, 0) },
53 #if     defined(CONFIG_ARCH_OMAP24XX) || defined(CONFIG_ARCH_OMAP34XX)
54         { I2C_RESOURCE_BUILDER(OMAP2_I2C_BASE2, INT_24XX_I2C2_IRQ) },
55 #endif
56 #if     defined(CONFIG_ARCH_OMAP34XX)
57         { I2C_RESOURCE_BUILDER(OMAP2_I2C_BASE3, INT_34XX_I2C3_IRQ) },
58 #endif
59 };
60
61 #define I2C_DEV_BUILDER(bus_id, res, data)              \
62         {                                               \
63                 .id     = (bus_id),                     \
64                 .name   = name,                         \
65                 .num_resources  = ARRAY_SIZE(res),      \
66                 .resource       = (res),                \
67                 .dev            = {                     \
68                         .platform_data  = (data),       \
69                 },                                      \
70         }
71
72 static u32 i2c_rate[ARRAY_SIZE(i2c_resources)];
73 static struct platform_device omap_i2c_devices[] = {
74         I2C_DEV_BUILDER(1, i2c_resources[0], &i2c_rate[0]),
75 #if     defined(CONFIG_ARCH_OMAP24XX) || defined(CONFIG_ARCH_OMAP34XX)
76         I2C_DEV_BUILDER(2, i2c_resources[1], &i2c_rate[1]),
77 #endif
78 #if     defined(CONFIG_ARCH_OMAP34XX)
79         I2C_DEV_BUILDER(3, i2c_resources[2], &i2c_rate[2]),
80 #endif
81 };
82
83 #if defined(CONFIG_ARCH_OMAP24XX)
84 static const int omap24xx_pins[][2] = {
85         { M19_24XX_I2C1_SCL, L15_24XX_I2C1_SDA },
86         { J15_24XX_I2C2_SCL, H19_24XX_I2C2_SDA },
87 };
88 #else
89 static const int omap24xx_pins[][2] = {};
90 #endif
91 #if defined(CONFIG_ARCH_OMAP34XX)
92 static const int omap34xx_pins[][2] = {
93         { K21_34XX_I2C1_SCL, J21_34XX_I2C1_SDA},
94         { AF15_34XX_I2C2_SCL, AE15_34XX_I2C2_SDA},
95         { AF14_34XX_I2C3_SCL, AG14_34XX_I2C3_SDA},
96 };
97 #else
98 static const int omap34xx_pins[][2] = {};
99 #endif
100
101 static void __init omap_i2c_mux_pins(int bus)
102 {
103         int scl, sda;
104
105         if (cpu_class_is_omap1()) {
106                 scl = I2C_SCL;
107                 sda = I2C_SDA;
108         } else if (cpu_is_omap24xx()) {
109                 scl = omap24xx_pins[bus][0];
110                 sda = omap24xx_pins[bus][1];
111         } else if (cpu_is_omap34xx()) {
112                 scl = omap34xx_pins[bus][0];
113                 sda = omap34xx_pins[bus][1];
114         } else {
115                 return;
116         }
117
118         omap_cfg_reg(sda);
119         omap_cfg_reg(scl);
120 }
121
122 /**
123  * omap_register_i2c_bus - register I2C bus with device descriptors
124  * @bus_id: bus id counting from number 1
125  * @clkrate: clock rate of the bus in kHz
126  * @info: pointer into I2C device descriptor table or NULL
127  * @len: number of descriptors in the table
128  *
129  * Returns 0 on success or an error code.
130  */
131 int __init omap_register_i2c_bus(int bus_id, u32 clkrate,
132                           struct i2c_board_info const *info,
133                           unsigned len)
134 {
135         int ports, err;
136         struct platform_device *pdev;
137         struct resource *res;
138         resource_size_t base, irq;
139
140         if (cpu_class_is_omap1())
141                 ports = 1;
142         else if (cpu_is_omap24xx())
143                 ports = 2;
144         else if (cpu_is_omap34xx())
145                 ports = 3;
146
147         BUG_ON(bus_id < 1 || bus_id > ports);
148
149         if (info) {
150                 err = i2c_register_board_info(bus_id, info, len);
151                 if (err)
152                         return err;
153         }
154
155         pdev = &omap_i2c_devices[bus_id - 1];
156         *(u32 *)pdev->dev.platform_data = clkrate;
157
158         if (bus_id == 1) {
159                 res = pdev->resource;
160                 if (cpu_class_is_omap1()) {
161                         base = OMAP1_I2C_BASE;
162                         irq = INT_I2C;
163                 } else {
164                         base = OMAP2_I2C_BASE1;
165                         irq = INT_24XX_I2C1_IRQ;
166                 }
167                 res[0].start = base;
168                 res[0].end = base + OMAP_I2C_SIZE;
169                 res[1].start = irq;
170         }
171
172         omap_i2c_mux_pins(bus_id - 1);
173         return platform_device_register(pdev);
174 }