Pileus Git - ~andy/linux/blob - drivers/i2c/busses/i2c-powermac.c

   1 /*
   2     i2c Support for Apple SMU Controller
   3
   4     Copyright (c) 2005 Benjamin Herrenschmidt, IBM Corp.
   5                        <benh@kernel.crashing.org>
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program; if not, write to the Free Software
  19     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 */
  22
  23 #include <linux/module.h>
  24 #include <linux/kernel.h>
  25 #include <linux/types.h>
  26 #include <linux/i2c.h>
  27 #include <linux/init.h>
  28 #include <linux/device.h>
  29 #include <linux/platform_device.h>
  30 #include <asm/prom.h>
  31 #include <asm/pmac_low_i2c.h>
  32
  33 MODULE_AUTHOR("Benjamin Herrenschmidt <benh@kernel.crashing.org>");
  34 MODULE_DESCRIPTION("I2C driver for Apple PowerMac");
  35 MODULE_LICENSE("GPL");
  36
  37 /*
  38  * SMBUS-type transfer entrypoint
  39  */
  40 static s32 i2c_powermac_smbus_xfer(     struct i2c_adapter*     adap,
  41                                         u16                     addr,
  42                                         unsigned short          flags,
  43                                         char                    read_write,
  44                                         u8                      command,
  45                                         int                     size,
  46                                         union i2c_smbus_data*   data)
  47 {
  48         struct pmac_i2c_bus     *bus = i2c_get_adapdata(adap);
  49         int                     rc = 0;
  50         int                     read = (read_write == I2C_SMBUS_READ);
  51         int                     addrdir = (addr << 1) | read;
  52         int                     mode, subsize, len;
  53         u32                     subaddr;
  54         u8                      *buf;
  55         u8                      local[2];
  56
  57         if (size == I2C_SMBUS_QUICK || size == I2C_SMBUS_BYTE) {
  58                 mode = pmac_i2c_mode_std;
  59                 subsize = 0;
  60                 subaddr = 0;
  61         } else {
  62                 mode = read ? pmac_i2c_mode_combined : pmac_i2c_mode_stdsub;
  63                 subsize = 1;
  64                 subaddr = command;
  65         }
  66
  67         switch (size) {
  68         case I2C_SMBUS_QUICK:
  69                 buf = NULL;
  70                 len = 0;
  71                 break;
  72         case I2C_SMBUS_BYTE:
  73         case I2C_SMBUS_BYTE_DATA:
  74                 buf = &data->byte;
  75                 len = 1;
  76                 break;
  77         case I2C_SMBUS_WORD_DATA:
  78                 if (!read) {
  79                         local[0] = data->word & 0xff;
  80                         local[1] = (data->word >> 8) & 0xff;
  81                 }
  82                 buf = local;
  83                 len = 2;
  84                 break;
  85
  86         /* Note that these are broken vs. the expected smbus API where
  87          * on reads, the length is actually returned from the function,
  88          * but I think the current API makes no sense and I don't want
  89          * any driver that I haven't verified for correctness to go
  90          * anywhere near a pmac i2c bus anyway ...
  91          *
  92          * I'm also not completely sure what kind of phases to do between
  93          * the actual command and the data (what I am _supposed_ to do that
  94          * is). For now, I assume writes are a single stream and reads have
  95          * a repeat start/addr phase (but not stop in between)
  96          */
  97         case I2C_SMBUS_BLOCK_DATA:
  98                 buf = data->block;
  99                 len = data->block[0] + 1;
 100                 break;
 101         case I2C_SMBUS_I2C_BLOCK_DATA:
 102                 buf = &data->block[1];
 103                 len = data->block[0];
 104                 break;
 105
 106         default:
 107                 return -EINVAL;
 108         }
 109
 110         rc = pmac_i2c_open(bus, 0);
 111         if (rc) {
 112                 dev_err(&adap->dev, "Failed to open I2C, err %d\n", rc);
 113                 return rc;
 114         }
 115
 116         rc = pmac_i2c_setmode(bus, mode);
 117         if (rc) {
 118                 dev_err(&adap->dev, "Failed to set I2C mode %d, err %d\n",
 119                         mode, rc);
 120                 goto bail;
 121         }
 122
 123         rc = pmac_i2c_xfer(bus, addrdir, subsize, subaddr, buf, len);
 124         if (rc) {
 125                 if (rc == -ENXIO)
 126                         dev_dbg(&adap->dev,
 127                                 "I2C transfer at 0x%02x failed, size %d, "
 128                                 "err %d\n", addrdir >> 1, size, rc);
 129                 else
 130                         dev_err(&adap->dev,
 131                                 "I2C transfer at 0x%02x failed, size %d, "
 132                                 "err %d\n", addrdir >> 1, size, rc);
 133                 goto bail;
 134         }
 135
 136         if (size == I2C_SMBUS_WORD_DATA && read) {
 137                 data->word = ((u16)local[1]) << 8;
 138                 data->word |= local[0];
 139         }
 140
 141  bail:
 142         pmac_i2c_close(bus);
 143         return rc;
 144 }
 145
 146 /*
 147  * Generic i2c master transfer entrypoint. This driver only support single
 148  * messages (for "lame i2c" transfers). Anything else should use the smbus
 149  * entry point
 150  */
 151 static int i2c_powermac_master_xfer(    struct i2c_adapter *adap,
 152                                         struct i2c_msg *msgs,
 153                                         int num)
 154 {
 155         struct pmac_i2c_bus     *bus = i2c_get_adapdata(adap);
 156         int                     rc = 0;
 157         int                     read;
 158         int                     addrdir;
 159
 160         if (num != 1) {
 161                 dev_err(&adap->dev,
 162                         "Multi-message I2C transactions not supported\n");
 163                 return -EOPNOTSUPP;
 164         }
 165
 166         if (msgs->flags & I2C_M_TEN)
 167                 return -EINVAL;
 168         read = (msgs->flags & I2C_M_RD) != 0;
 169         addrdir = (msgs->addr << 1) | read;
 170
 171         rc = pmac_i2c_open(bus, 0);
 172         if (rc) {
 173                 dev_err(&adap->dev, "Failed to open I2C, err %d\n", rc);
 174                 return rc;
 175         }
 176         rc = pmac_i2c_setmode(bus, pmac_i2c_mode_std);
 177         if (rc) {
 178                 dev_err(&adap->dev, "Failed to set I2C mode %d, err %d\n",
 179                         pmac_i2c_mode_std, rc);
 180                 goto bail;
 181         }
 182         rc = pmac_i2c_xfer(bus, addrdir, 0, 0, msgs->buf, msgs->len);
 183         if (rc < 0) {
 184                 if (rc == -ENXIO)
 185                         dev_dbg(&adap->dev, "I2C %s 0x%02x failed, err %d\n",
 186                                 addrdir & 1 ? "read from" : "write to",
 187                                 addrdir >> 1, rc);
 188                 else
 189                         dev_err(&adap->dev, "I2C %s 0x%02x failed, err %d\n",
 190                                 addrdir & 1 ? "read from" : "write to",
 191                                 addrdir >> 1, rc);
 192         }
 193  bail:
 194         pmac_i2c_close(bus);
 195         return rc < 0 ? rc : 1;
 196 }
 197
 198 static u32 i2c_powermac_func(struct i2c_adapter * adapter)
 199 {
 200         return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
 201                 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
 202                 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_I2C;
 203 }
 204
 205 /* For now, we only handle smbus */
 206 static const struct i2c_algorithm i2c_powermac_algorithm = {
 207         .smbus_xfer     = i2c_powermac_smbus_xfer,
 208         .master_xfer    = i2c_powermac_master_xfer,
 209         .functionality  = i2c_powermac_func,
 210 };
 211
 212
 213 static int __devexit i2c_powermac_remove(struct platform_device *dev)
 214 {
 215         struct i2c_adapter      *adapter = platform_get_drvdata(dev);
 216         int                     rc;
 217
 218         rc = i2c_del_adapter(adapter);
 219         /* We aren't that prepared to deal with this... */
 220         if (rc)
 221                 printk(KERN_WARNING
 222                        "i2c-powermac.c: Failed to remove bus %s !\n",
 223                        adapter->name);
 224         platform_set_drvdata(dev, NULL);
 225         memset(adapter, 0, sizeof(*adapter));
 226
 227         return 0;
 228 }
 229
 230 static void __devinit i2c_powermac_register_devices(struct i2c_adapter *adap,
 231                                                     struct pmac_i2c_bus *bus)
 232 {
 233         struct i2c_client *newdev;
 234         struct device_node *node;
 235
 236         for_each_child_of_node(adap->dev.of_node, node) {
 237                 struct i2c_board_info info = {};
 238                 struct dev_archdata dev_ad = {};
 239                 const __be32 *reg;
 240                 char tmp[16];
 241                 u32 addr;
 242                 int len;
 243
 244                 /* Get address & channel */
 245                 reg = of_get_property(node, "reg", &len);
 246                 if (!reg || (len < sizeof(int))) {
 247                         dev_err(&adap->dev, "i2c-powermac: invalid reg on %s\n",
 248                                 node->full_name);
 249                         continue;
 250                 }
 251                 addr = be32_to_cpup(reg);
 252
 253                 /* Multibus setup, check channel */
 254                 if (!pmac_i2c_match_adapter(node, adap))
 255                         continue;
 256
 257                 dev_dbg(&adap->dev, "i2c-powermac: register %s\n",
 258                         node->full_name);
 259
 260                 /* Make up a modalias. Note: we to _NOT_ want the standard
 261                  * i2c drivers to match with any of our powermac stuff
 262                  * unless they have been specifically modified to handle
 263                  * it on a case by case basis. For example, for thermal
 264                  * control, things like lm75 etc... shall match with their
 265                  * corresponding windfarm drivers, _NOT_ the generic ones,
 266                  * so we force a prefix of AAPL, onto the modalias to
 267                  * make that happen
 268                  */
 269                 if (of_modalias_node(node, tmp, sizeof(tmp)) < 0) {
 270                         dev_err(&adap->dev, "i2c-powermac: modalias failure"
 271                                 " on %s\n", node->full_name);
 272                         continue;
 273                 }
 274                 snprintf(info.type, sizeof(info.type), "MAC,%s", tmp);
 275
 276                 /* Fill out the rest of the info structure */
 277                 info.addr = (addr & 0xff) >> 1;
 278                 info.irq = irq_of_parse_and_map(node, 0);
 279                 info.of_node = of_node_get(node);
 280                 info.archdata = &dev_ad;
 281
 282                 newdev = i2c_new_device(adap, &info);
 283                 if (!newdev) {
 284                         dev_err(&adap->dev, "i2c-powermac: Failure to register"
 285                                 " %s\n", node->full_name);
 286                         of_node_put(node);
 287                         /* We do not dispose of the interrupt mapping on
 288                          * purpose. It's not necessary (interrupt cannot be
 289                          * re-used) and somebody else might have grabbed it
 290                          * via direct DT lookup so let's not bother
 291                          */
 292                         continue;
 293                 }
 294         }
 295 }
 296
 297 static int __devinit i2c_powermac_probe(struct platform_device *dev)
 298 {
 299         struct pmac_i2c_bus *bus = dev->dev.platform_data;
 300         struct device_node *parent = NULL;
 301         struct i2c_adapter *adapter;
 302         const char *basename;
 303         int rc;
 304
 305         if (bus == NULL)
 306                 return -EINVAL;
 307         adapter = pmac_i2c_get_adapter(bus);
 308
 309         /* Ok, now we need to make up a name for the interface that will
 310          * match what we used to do in the past, that is basically the
 311          * controller's parent device node for keywest. PMU didn't have a
 312          * naming convention and SMU has a different one
 313          */
 314         switch(pmac_i2c_get_type(bus)) {
 315         case pmac_i2c_bus_keywest:
 316                 parent = of_get_parent(pmac_i2c_get_controller(bus));
 317                 if (parent == NULL)
 318                         return -EINVAL;
 319                 basename = parent->name;
 320                 break;
 321         case pmac_i2c_bus_pmu:
 322                 basename = "pmu";
 323                 break;
 324         case pmac_i2c_bus_smu:
 325                 /* This is not what we used to do but I'm fixing drivers at
 326                  * the same time as this change
 327                  */
 328                 basename = "smu";
 329                 break;
 330         default:
 331                 return -EINVAL;
 332         }
 333         snprintf(adapter->name, sizeof(adapter->name), "%s %d", basename,
 334                  pmac_i2c_get_channel(bus));
 335         of_node_put(parent);
 336
 337         platform_set_drvdata(dev, adapter);
 338         adapter->algo = &i2c_powermac_algorithm;
 339         i2c_set_adapdata(adapter, bus);
 340         adapter->dev.parent = &dev->dev;
 341         adapter->dev.of_node = dev->dev.of_node;
 342         rc = i2c_add_adapter(adapter);
 343         if (rc) {
 344                 printk(KERN_ERR "i2c-powermac: Adapter %s registration "
 345                        "failed\n", adapter->name);
 346                 memset(adapter, 0, sizeof(*adapter));
 347         }
 348
 349         printk(KERN_INFO "PowerMac i2c bus %s registered\n", adapter->name);
 350
 351         /* Cannot use of_i2c_register_devices() due to Apple device-tree
 352          * funkyness
 353          */
 354         i2c_powermac_register_devices(adapter, bus);
 355
 356         return rc;
 357 }
 358
 359 static struct platform_driver i2c_powermac_driver = {
 360         .probe = i2c_powermac_probe,
 361         .remove = __devexit_p(i2c_powermac_remove),
 362         .driver = {
 363                 .name = "i2c-powermac",
 364                 .bus = &platform_bus_type,
 365         },
 366 };
 367
 368 module_platform_driver(i2c_powermac_driver);
 369
 370 MODULE_ALIAS("platform:i2c-powermac");