i2c: Remove unneeded xxx_set_drvdata(..., NULL) calls
[linux-2.6-block.git] / drivers / i2c / busses / i2c-powermac.c
CommitLineData
a28d3af2
BH
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
a28d3af2
BH
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>
a28d3af2
BH
28#include <linux/device.h>
29#include <linux/platform_device.h>
30#include <asm/prom.h>
31#include <asm/pmac_low_i2c.h>
32
33MODULE_AUTHOR("Benjamin Herrenschmidt <benh@kernel.crashing.org>");
34MODULE_DESCRIPTION("I2C driver for Apple PowerMac");
35MODULE_LICENSE("GPL");
36
37/*
38 * SMBUS-type transfer entrypoint
39 */
40static 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;
02864d58
JD
52 int mode, subsize, len;
53 u32 subaddr;
54 u8 *buf;
a28d3af2
BH
55 u8 local[2];
56
02864d58
JD
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 }
a28d3af2
BH
66
67 switch (size) {
68 case I2C_SMBUS_QUICK:
02864d58
JD
69 buf = NULL;
70 len = 0;
a28d3af2
BH
71 break;
72 case I2C_SMBUS_BYTE:
a28d3af2 73 case I2C_SMBUS_BYTE_DATA:
02864d58
JD
74 buf = &data->byte;
75 len = 1;
a28d3af2
BH
76 break;
77 case I2C_SMBUS_WORD_DATA:
a28d3af2
BH
78 if (!read) {
79 local[0] = data->word & 0xff;
80 local[1] = (data->word >> 8) & 0xff;
81 }
02864d58
JD
82 buf = local;
83 len = 2;
a28d3af2
BH
84 break;
85
86 /* Note that these are broken vs. the expected smbus API where
96acafe0 87 * on reads, the length is actually returned from the function,
a28d3af2
BH
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:
02864d58
JD
98 buf = data->block;
99 len = data->block[0] + 1;
a28d3af2
BH
100 break;
101 case I2C_SMBUS_I2C_BLOCK_DATA:
02864d58
JD
102 buf = &data->block[1];
103 len = data->block[0];
a28d3af2
BH
104 break;
105
106 default:
02864d58 107 return -EINVAL;
a28d3af2 108 }
02864d58
JD
109
110 rc = pmac_i2c_open(bus, 0);
d7d838a6
JD
111 if (rc) {
112 dev_err(&adap->dev, "Failed to open I2C, err %d\n", rc);
02864d58 113 return rc;
d7d838a6 114 }
02864d58
JD
115
116 rc = pmac_i2c_setmode(bus, mode);
d7d838a6
JD
117 if (rc) {
118 dev_err(&adap->dev, "Failed to set I2C mode %d, err %d\n",
119 mode, rc);
02864d58 120 goto bail;
d7d838a6 121 }
02864d58
JD
122
123 rc = pmac_i2c_xfer(bus, addrdir, subsize, subaddr, buf, len);
d7d838a6 124 if (rc) {
8e4b980c
JD
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);
02864d58 133 goto bail;
d7d838a6 134 }
02864d58
JD
135
136 if (size == I2C_SMBUS_WORD_DATA && read) {
137 data->word = ((u16)local[1]) << 8;
138 data->word |= local[0];
139 }
140
a28d3af2
BH
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 */
151static 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
6f7e549f
JD
160 if (num != 1) {
161 dev_err(&adap->dev,
162 "Multi-message I2C transactions not supported\n");
163 return -EOPNOTSUPP;
164 }
165
a28d3af2
BH
166 if (msgs->flags & I2C_M_TEN)
167 return -EINVAL;
168 read = (msgs->flags & I2C_M_RD) != 0;
169 addrdir = (msgs->addr << 1) | read;
a28d3af2
BH
170
171 rc = pmac_i2c_open(bus, 0);
d7d838a6
JD
172 if (rc) {
173 dev_err(&adap->dev, "Failed to open I2C, err %d\n", rc);
a28d3af2 174 return rc;
d7d838a6 175 }
a28d3af2 176 rc = pmac_i2c_setmode(bus, pmac_i2c_mode_std);
d7d838a6
JD
177 if (rc) {
178 dev_err(&adap->dev, "Failed to set I2C mode %d, err %d\n",
179 pmac_i2c_mode_std, rc);
a28d3af2 180 goto bail;
d7d838a6 181 }
a28d3af2 182 rc = pmac_i2c_xfer(bus, addrdir, 0, 0, msgs->buf, msgs->len);
8e4b980c
JD
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 }
a28d3af2
BH
193 bail:
194 pmac_i2c_close(bus);
8ced8eee 195 return rc < 0 ? rc : 1;
a28d3af2
BH
196}
197
198static 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 */
8f9082c5 206static const struct i2c_algorithm i2c_powermac_algorithm = {
a28d3af2
BH
207 .smbus_xfer = i2c_powermac_smbus_xfer,
208 .master_xfer = i2c_powermac_master_xfer,
209 .functionality = i2c_powermac_func,
210};
211
212
0b255e92 213static int i2c_powermac_remove(struct platform_device *dev)
a28d3af2 214{
9f2545c1 215 struct i2c_adapter *adapter = platform_get_drvdata(dev);
a28d3af2
BH
216 int rc;
217
218 rc = i2c_del_adapter(adapter);
a28d3af2
BH
219 /* We aren't that prepared to deal with this... */
220 if (rc)
154d22b0
FS
221 printk(KERN_WARNING
222 "i2c-powermac.c: Failed to remove bus %s !\n",
a28d3af2 223 adapter->name);
6dfa5ca3 224 memset(adapter, 0, sizeof(*adapter));
a28d3af2
BH
225
226 return 0;
227}
228
0b255e92 229static u32 i2c_powermac_get_addr(struct i2c_adapter *adap,
3a3dd018
BH
230 struct pmac_i2c_bus *bus,
231 struct device_node *node)
232{
233 const __be32 *prop;
234 int len;
235
236 /* First check for valid "reg" */
237 prop = of_get_property(node, "reg", &len);
238 if (prop && (len >= sizeof(int)))
239 return (be32_to_cpup(prop) & 0xff) >> 1;
240
241 /* Then check old-style "i2c-address" */
242 prop = of_get_property(node, "i2c-address", &len);
243 if (prop && (len >= sizeof(int)))
244 return (be32_to_cpup(prop) & 0xff) >> 1;
245
246 /* Now handle some devices with missing "reg" properties */
247 if (!strcmp(node->name, "cereal"))
248 return 0x60;
249 else if (!strcmp(node->name, "deq"))
250 return 0x34;
251
252 dev_warn(&adap->dev, "No i2c address for %s\n", node->full_name);
253
254 return 0xffffffff;
255}
256
0b255e92 257static void i2c_powermac_create_one(struct i2c_adapter *adap,
3a3dd018
BH
258 const char *type,
259 u32 addr)
260{
261 struct i2c_board_info info = {};
262 struct i2c_client *newdev;
263
264 strncpy(info.type, type, sizeof(info.type));
265 info.addr = addr;
266 newdev = i2c_new_device(adap, &info);
267 if (!newdev)
268 dev_err(&adap->dev,
269 "i2c-powermac: Failure to register missing %s\n",
270 type);
271}
272
0b255e92 273static void i2c_powermac_add_missing(struct i2c_adapter *adap,
3a3dd018
BH
274 struct pmac_i2c_bus *bus,
275 bool found_onyx)
276{
277 struct device_node *busnode = pmac_i2c_get_bus_node(bus);
278 int rc;
279
280 /* Check for the onyx audio codec */
281#define ONYX_REG_CONTROL 67
282 if (of_device_is_compatible(busnode, "k2-i2c") && !found_onyx) {
283 union i2c_smbus_data data;
284
285 rc = i2c_smbus_xfer(adap, 0x46, 0, I2C_SMBUS_READ,
286 ONYX_REG_CONTROL, I2C_SMBUS_BYTE_DATA,
287 &data);
288 if (rc >= 0)
289 i2c_powermac_create_one(adap, "MAC,pcm3052", 0x46);
290
291 rc = i2c_smbus_xfer(adap, 0x47, 0, I2C_SMBUS_READ,
292 ONYX_REG_CONTROL, I2C_SMBUS_BYTE_DATA,
293 &data);
294 if (rc >= 0)
295 i2c_powermac_create_one(adap, "MAC,pcm3052", 0x47);
296 }
297}
298
0b255e92 299static bool i2c_powermac_get_type(struct i2c_adapter *adap,
3a3dd018
BH
300 struct device_node *node,
301 u32 addr, char *type, int type_size)
302{
303 char tmp[16];
304
305 /* Note: we to _NOT_ want the standard
306 * i2c drivers to match with any of our powermac stuff
307 * unless they have been specifically modified to handle
308 * it on a case by case basis. For example, for thermal
309 * control, things like lm75 etc... shall match with their
310 * corresponding windfarm drivers, _NOT_ the generic ones,
311 * so we force a prefix of AAPL, onto the modalias to
312 * make that happen
313 */
314
315 /* First try proper modalias */
316 if (of_modalias_node(node, tmp, sizeof(tmp)) >= 0) {
317 snprintf(type, type_size, "MAC,%s", tmp);
318 return true;
319 }
320
321 /* Now look for known workarounds */
322 if (!strcmp(node->name, "deq")) {
323 /* Apple uses address 0x34 for TAS3001 and 0x35 for TAS3004 */
324 if (addr == 0x34) {
325 snprintf(type, type_size, "MAC,tas3001");
326 return true;
327 } else if (addr == 0x35) {
328 snprintf(type, type_size, "MAC,tas3004");
329 return true;
330 }
331 }
332
333 dev_err(&adap->dev, "i2c-powermac: modalias failure"
334 " on %s\n", node->full_name);
335 return false;
336}
337
0b255e92 338static void i2c_powermac_register_devices(struct i2c_adapter *adap,
81e5d864
BH
339 struct pmac_i2c_bus *bus)
340{
341 struct i2c_client *newdev;
342 struct device_node *node;
3a3dd018
BH
343 bool found_onyx = 0;
344
345 /*
346 * In some cases we end up with the via-pmu node itself, in this
347 * case we skip this function completely as the device-tree will
348 * not contain anything useful.
349 */
350 if (!strcmp(adap->dev.of_node->name, "via-pmu"))
351 return;
81e5d864
BH
352
353 for_each_child_of_node(adap->dev.of_node, node) {
354 struct i2c_board_info info = {};
81e5d864 355 u32 addr;
81e5d864
BH
356
357 /* Get address & channel */
3a3dd018
BH
358 addr = i2c_powermac_get_addr(adap, bus, node);
359 if (addr == 0xffffffff)
81e5d864 360 continue;
81e5d864
BH
361
362 /* Multibus setup, check channel */
363 if (!pmac_i2c_match_adapter(node, adap))
364 continue;
365
366 dev_dbg(&adap->dev, "i2c-powermac: register %s\n",
367 node->full_name);
368
3a3dd018
BH
369 /*
370 * Keep track of some device existence to handle
371 * workarounds later.
81e5d864 372 */
3a3dd018
BH
373 if (of_device_is_compatible(node, "pcm3052"))
374 found_onyx = true;
375
376 /* Make up a modalias */
377 if (!i2c_powermac_get_type(adap, node, addr,
378 info.type, sizeof(info.type))) {
81e5d864
BH
379 continue;
380 }
81e5d864
BH
381
382 /* Fill out the rest of the info structure */
3a3dd018 383 info.addr = addr;
81e5d864
BH
384 info.irq = irq_of_parse_and_map(node, 0);
385 info.of_node = of_node_get(node);
81e5d864
BH
386
387 newdev = i2c_new_device(adap, &info);
388 if (!newdev) {
389 dev_err(&adap->dev, "i2c-powermac: Failure to register"
390 " %s\n", node->full_name);
391 of_node_put(node);
392 /* We do not dispose of the interrupt mapping on
393 * purpose. It's not necessary (interrupt cannot be
394 * re-used) and somebody else might have grabbed it
395 * via direct DT lookup so let's not bother
396 */
397 continue;
398 }
399 }
3a3dd018
BH
400
401 /* Additional workarounds */
402 i2c_powermac_add_missing(adap, bus, found_onyx);
81e5d864 403}
a28d3af2 404
0b255e92 405static int i2c_powermac_probe(struct platform_device *dev)
a28d3af2 406{
9f2545c1 407 struct pmac_i2c_bus *bus = dev->dev.platform_data;
a28d3af2
BH
408 struct device_node *parent = NULL;
409 struct i2c_adapter *adapter;
018a3d1d 410 const char *basename;
a28d3af2
BH
411 int rc;
412
413 if (bus == NULL)
414 return -EINVAL;
bc6286e5 415 adapter = pmac_i2c_get_adapter(bus);
a28d3af2
BH
416
417 /* Ok, now we need to make up a name for the interface that will
418 * match what we used to do in the past, that is basically the
419 * controller's parent device node for keywest. PMU didn't have a
420 * naming convention and SMU has a different one
421 */
422 switch(pmac_i2c_get_type(bus)) {
423 case pmac_i2c_bus_keywest:
424 parent = of_get_parent(pmac_i2c_get_controller(bus));
425 if (parent == NULL)
426 return -EINVAL;
427 basename = parent->name;
428 break;
429 case pmac_i2c_bus_pmu:
430 basename = "pmu";
431 break;
432 case pmac_i2c_bus_smu:
433 /* This is not what we used to do but I'm fixing drivers at
434 * the same time as this change
435 */
436 basename = "smu";
437 break;
438 default:
439 return -EINVAL;
440 }
bc6286e5
JD
441 snprintf(adapter->name, sizeof(adapter->name), "%s %d", basename,
442 pmac_i2c_get_channel(bus));
a28d3af2
BH
443 of_node_put(parent);
444
9f2545c1 445 platform_set_drvdata(dev, adapter);
a28d3af2
BH
446 adapter->algo = &i2c_powermac_algorithm;
447 i2c_set_adapdata(adapter, bus);
9f2545c1 448 adapter->dev.parent = &dev->dev;
81e5d864 449 adapter->dev.of_node = dev->dev.of_node;
a28d3af2
BH
450 rc = i2c_add_adapter(adapter);
451 if (rc) {
452 printk(KERN_ERR "i2c-powermac: Adapter %s registration "
bc6286e5 453 "failed\n", adapter->name);
6dfa5ca3 454 memset(adapter, 0, sizeof(*adapter));
a28d3af2
BH
455 }
456
bc6286e5 457 printk(KERN_INFO "PowerMac i2c bus %s registered\n", adapter->name);
810ad7b6 458
81e5d864
BH
459 /* Cannot use of_i2c_register_devices() due to Apple device-tree
460 * funkyness
461 */
462 i2c_powermac_register_devices(adapter, bus);
810ad7b6 463
a28d3af2
BH
464 return rc;
465}
466
9f2545c1 467static struct platform_driver i2c_powermac_driver = {
a28d3af2 468 .probe = i2c_powermac_probe,
0b255e92 469 .remove = i2c_powermac_remove,
9f2545c1
BH
470 .driver = {
471 .name = "i2c-powermac",
472 .bus = &platform_bus_type,
473 },
a28d3af2
BH
474};
475
a3664b51 476module_platform_driver(i2c_powermac_driver);
a28d3af2 477
a3664b51 478MODULE_ALIAS("platform:i2c-powermac");