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 <jhnikula@gmail.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 <linux/i2c-omap.h>
  30 #include <linux/slab.h>
  31 #include <linux/err.h>
  32 #include <linux/clk.h>
  33
  34 #include <mach/irqs.h>
  35 #include <plat/mux.h>
  36 #include <plat/i2c.h>
  37 #include <plat/omap-pm.h>
  38 #include <plat/omap_device.h>
  39
  40 #define OMAP_I2C_SIZE           0x3f
  41 #define OMAP1_I2C_BASE          0xfffb3800
  42 #define OMAP1_INT_I2C           (32 + 4)
  43
  44 static const char name[] = "omap_i2c";
  45
  46 #define I2C_RESOURCE_BUILDER(base, irq)                 \
  47         {                                               \
  48                 .start  = (base),                       \
  49                 .end    = (base) + OMAP_I2C_SIZE,       \
  50                 .flags  = IORESOURCE_MEM,               \
  51         },                                              \
  52         {                                               \
  53                 .start  = (irq),                        \
  54                 .flags  = IORESOURCE_IRQ,               \
  55         },
  56
  57 static struct resource i2c_resources[][2] = {
  58         { I2C_RESOURCE_BUILDER(0, 0) },
  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 #define MAX_OMAP_I2C_HWMOD_NAME_LEN     16
  73 #define OMAP_I2C_MAX_CONTROLLERS 4
  74 static struct omap_i2c_bus_platform_data i2c_pdata[OMAP_I2C_MAX_CONTROLLERS];
  75 static struct platform_device omap_i2c_devices[] = {
  76         I2C_DEV_BUILDER(1, i2c_resources[0], &i2c_pdata[0]),
  77 };
  78
  79 #define OMAP_I2C_CMDLINE_SETUP  (BIT(31))
  80
  81 static int __init omap_i2c_nr_ports(void)
  82 {
  83         int ports = 0;
  84
  85         if (cpu_class_is_omap1())
  86                 ports = 1;
  87         else if (cpu_is_omap24xx())
  88                 ports = 2;
  89         else if (cpu_is_omap34xx())
  90                 ports = 3;
  91         else if (cpu_is_omap44xx())
  92                 ports = 4;
  93
  94         return ports;
  95 }
  96
  97 static inline int omap1_i2c_add_bus(int bus_id)
  98 {
  99         struct platform_device *pdev;
 100         struct omap_i2c_bus_platform_data *pdata;
 101         struct resource *res;
 102
 103         omap1_i2c_mux_pins(bus_id);
 104
 105         pdev = &omap_i2c_devices[bus_id - 1];
 106         res = pdev->resource;
 107         res[0].start = OMAP1_I2C_BASE;
 108         res[0].end = res[0].start + OMAP_I2C_SIZE;
 109         res[1].start = OMAP1_INT_I2C;
 110         pdata = &i2c_pdata[bus_id - 1];
 111
 112         /* all OMAP1 have IP version 1 register set */
 113         pdata->rev = OMAP_I2C_IP_VERSION_1;
 114
 115         /* all OMAP1 I2C are implemented like this */
 116         pdata->flags = OMAP_I2C_FLAG_NO_FIFO |
 117                        OMAP_I2C_FLAG_SIMPLE_CLOCK |
 118                        OMAP_I2C_FLAG_16BIT_DATA_REG |
 119                        OMAP_I2C_FLAG_ALWAYS_ARMXOR_CLK;
 120
 121         /* how the cpu bus is wired up differs for 7xx only */
 122
 123         if (cpu_is_omap7xx())
 124                 pdata->flags |= OMAP_I2C_FLAG_BUS_SHIFT_1;
 125         else
 126                 pdata->flags |= OMAP_I2C_FLAG_BUS_SHIFT_2;
 127
 128         return platform_device_register(pdev);
 129 }
 130
 131
 132 #ifdef CONFIG_ARCH_OMAP2PLUS
 133 /*
 134  * XXX This function is a temporary compatibility wrapper - only
 135  * needed until the I2C driver can be converted to call
 136  * omap_pm_set_max_dev_wakeup_lat() and handle a return code.
 137  */
 138 static void omap_pm_set_max_mpu_wakeup_lat_compat(struct device *dev, long t)
 139 {
 140         omap_pm_set_max_mpu_wakeup_lat(dev, t);
 141 }
 142
 143 static inline int omap2_i2c_add_bus(int bus_id)
 144 {
 145         int l;
 146         struct omap_hwmod *oh;
 147         struct platform_device *pdev;
 148         char oh_name[MAX_OMAP_I2C_HWMOD_NAME_LEN];
 149         struct omap_i2c_bus_platform_data *pdata;
 150         struct omap_i2c_dev_attr *dev_attr;
 151
 152         omap2_i2c_mux_pins(bus_id);
 153
 154         l = snprintf(oh_name, MAX_OMAP_I2C_HWMOD_NAME_LEN, "i2c%d", bus_id);
 155         WARN(l >= MAX_OMAP_I2C_HWMOD_NAME_LEN,
 156                 "String buffer overflow in I2C%d device setup\n", bus_id);
 157         oh = omap_hwmod_lookup(oh_name);
 158         if (!oh) {
 159                         pr_err("Could not look up %s\n", oh_name);
 160                         return -EEXIST;
 161         }
 162
 163         pdata = &i2c_pdata[bus_id - 1];
 164         /*
 165          * pass the hwmod class's CPU-specific knowledge of I2C IP revision in
 166          * use, and functionality implementation flags, up to the OMAP I2C
 167          * driver via platform data
 168          */
 169         pdata->rev = oh->class->rev;
 170
 171         dev_attr = (struct omap_i2c_dev_attr *)oh->dev_attr;
 172         pdata->flags = dev_attr->flags;
 173
 174         /*
 175          * When waiting for completion of a i2c transfer, we need to
 176          * set a wake up latency constraint for the MPU. This is to
 177          * ensure quick enough wakeup from idle, when transfer
 178          * completes.
 179          * Only omap3 has support for constraints
 180          */
 181         if (cpu_is_omap34xx())
 182                 pdata->set_mpu_wkup_lat = omap_pm_set_max_mpu_wakeup_lat_compat;
 183         pdev = omap_device_build(name, bus_id, oh, pdata,
 184                         sizeof(struct omap_i2c_bus_platform_data),
 185                         NULL, 0, 0);
 186         WARN(IS_ERR(pdev), "Could not build omap_device for %s\n", name);
 187
 188         return PTR_RET(pdev);
 189 }
 190 #else
 191 static inline int omap2_i2c_add_bus(int bus_id)
 192 {
 193         return 0;
 194 }
 195 #endif
 196
 197 static int __init omap_i2c_add_bus(int bus_id)
 198 {
 199         if (cpu_class_is_omap1())
 200                 return omap1_i2c_add_bus(bus_id);
 201         else
 202                 return omap2_i2c_add_bus(bus_id);
 203 }
 204
 205 /**
 206  * omap_i2c_bus_setup - Process command line options for the I2C bus speed
 207  * @str: String of options
 208  *
 209  * This function allow to override the default I2C bus speed for given I2C
 210  * bus with a command line option.
 211  *
 212  * Format: i2c_bus=bus_id,clkrate (in kHz)
 213  *
 214  * Returns 1 on success, 0 otherwise.
 215  */
 216 static int __init omap_i2c_bus_setup(char *str)
 217 {
 218         int ports;
 219         int ints[3];
 220
 221         ports = omap_i2c_nr_ports();
 222         get_options(str, 3, ints);
 223         if (ints[0] < 2 || ints[1] < 1 || ints[1] > ports)
 224                 return 0;
 225         i2c_pdata[ints[1] - 1].clkrate = ints[2];
 226         i2c_pdata[ints[1] - 1].clkrate |= OMAP_I2C_CMDLINE_SETUP;
 227
 228         return 1;
 229 }
 230 __setup("i2c_bus=", omap_i2c_bus_setup);
 231
 232 /*
 233  * Register busses defined in command line but that are not registered with
 234  * omap_register_i2c_bus from board initialization code.
 235  */
 236 static int __init omap_register_i2c_bus_cmdline(void)
 237 {
 238         int i, err = 0;
 239
 240         for (i = 0; i < ARRAY_SIZE(i2c_pdata); i++)
 241                 if (i2c_pdata[i].clkrate & OMAP_I2C_CMDLINE_SETUP) {
 242                         i2c_pdata[i].clkrate &= ~OMAP_I2C_CMDLINE_SETUP;
 243                         err = omap_i2c_add_bus(i + 1);
 244                         if (err)
 245                                 goto out;
 246                 }
 247
 248 out:
 249         return err;
 250 }
 251 subsys_initcall(omap_register_i2c_bus_cmdline);
 252
 253 /**
 254  * omap_register_i2c_bus - register I2C bus with device descriptors
 255  * @bus_id: bus id counting from number 1
 256  * @clkrate: clock rate of the bus in kHz
 257  * @info: pointer into I2C device descriptor table or NULL
 258  * @len: number of descriptors in the table
 259  *
 260  * Returns 0 on success or an error code.
 261  */
 262 int __init omap_register_i2c_bus(int bus_id, u32 clkrate,
 263                           struct i2c_board_info const *info,
 264                           unsigned len)
 265 {
 266         int err;
 267
 268         BUG_ON(bus_id < 1 || bus_id > omap_i2c_nr_ports());
 269
 270         if (info) {
 271                 err = i2c_register_board_info(bus_id, info, len);
 272                 if (err)
 273                         return err;
 274         }
 275
 276         if (!i2c_pdata[bus_id - 1].clkrate)
 277                 i2c_pdata[bus_id - 1].clkrate = clkrate;
 278
 279         i2c_pdata[bus_id - 1].clkrate &= ~OMAP_I2C_CMDLINE_SETUP;
 280
 281         return omap_i2c_add_bus(bus_id);
 282 }