Commit | Line | Data |
---|---|---|
d3465872 SIG |
1 | /* |
2 | * Industry-pack bus support functions. | |
3 | * | |
76859725 SIG |
4 | * Copyright (C) 2011-2012 CERN (www.cern.ch) |
5 | * Author: Samuel Iglesias Gonsalvez <siglesias@igalia.com> | |
d3465872 SIG |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify it | |
8 | * under the terms of the GNU General Public License as published by the Free | |
416289b1 | 9 | * Software Foundation; version 2 of the License. |
d3465872 SIG |
10 | */ |
11 | ||
d3465872 | 12 | #include <linux/module.h> |
ec440335 | 13 | #include <linux/slab.h> |
3b86bb2e | 14 | #include <linux/idr.h> |
0a8f4a07 | 15 | #include <linux/io.h> |
7dbce021 | 16 | #include <linux/ipack.h> |
d3465872 SIG |
17 | |
18 | #define to_ipack_dev(device) container_of(device, struct ipack_device, dev) | |
19 | #define to_ipack_driver(drv) container_of(drv, struct ipack_driver, driver) | |
20 | ||
3b86bb2e | 21 | static DEFINE_IDA(ipack_ida); |
d3465872 | 22 | |
ec440335 SIG |
23 | static void ipack_device_release(struct device *dev) |
24 | { | |
25 | struct ipack_device *device = to_ipack_dev(dev); | |
187e4782 | 26 | kfree(device->id); |
1e91795c | 27 | device->release(device); |
ec440335 SIG |
28 | } |
29 | ||
4aa09d47 JT |
30 | static inline const struct ipack_device_id * |
31 | ipack_match_one_device(const struct ipack_device_id *id, | |
32 | const struct ipack_device *device) | |
d3465872 | 33 | { |
5948ae27 JT |
34 | if ((id->format == IPACK_ANY_FORMAT || |
35 | id->format == device->id_format) && | |
4aa09d47 JT |
36 | (id->vendor == IPACK_ANY_ID || id->vendor == device->id_vendor) && |
37 | (id->device == IPACK_ANY_ID || id->device == device->id_device)) | |
38 | return id; | |
39 | return NULL; | |
40 | } | |
d3465872 | 41 | |
4aa09d47 JT |
42 | static const struct ipack_device_id * |
43 | ipack_match_id(const struct ipack_device_id *ids, struct ipack_device *idev) | |
44 | { | |
45 | if (ids) { | |
46 | while (ids->vendor || ids->device) { | |
47 | if (ipack_match_one_device(ids, idev)) | |
48 | return ids; | |
49 | ids++; | |
50 | } | |
51 | } | |
52 | return NULL; | |
53 | } | |
54 | ||
55 | static int ipack_bus_match(struct device *dev, struct device_driver *drv) | |
56 | { | |
57 | struct ipack_device *idev = to_ipack_dev(dev); | |
58 | struct ipack_driver *idrv = to_ipack_driver(drv); | |
59 | const struct ipack_device_id *found_id; | |
d3465872 | 60 | |
4aa09d47 | 61 | found_id = ipack_match_id(idrv->id_table, idev); |
3bea7fcb | 62 | return found_id ? 1 : 0; |
d3465872 SIG |
63 | } |
64 | ||
65 | static int ipack_bus_probe(struct device *device) | |
66 | { | |
67 | struct ipack_device *dev = to_ipack_dev(device); | |
3bea7fcb | 68 | struct ipack_driver *drv = to_ipack_driver(device->driver); |
d3465872 | 69 | |
3bea7fcb | 70 | if (!drv->ops->probe) |
d3465872 SIG |
71 | return -EINVAL; |
72 | ||
3bea7fcb | 73 | return drv->ops->probe(dev); |
d3465872 SIG |
74 | } |
75 | ||
76 | static int ipack_bus_remove(struct device *device) | |
77 | { | |
78 | struct ipack_device *dev = to_ipack_dev(device); | |
3bea7fcb | 79 | struct ipack_driver *drv = to_ipack_driver(device->driver); |
d3465872 | 80 | |
3bea7fcb | 81 | if (!drv->ops->remove) |
d3465872 SIG |
82 | return -EINVAL; |
83 | ||
3bea7fcb | 84 | drv->ops->remove(dev); |
d3465872 SIG |
85 | return 0; |
86 | } | |
87 | ||
35eb97bb JT |
88 | static int ipack_uevent(struct device *dev, struct kobj_uevent_env *env) |
89 | { | |
90 | struct ipack_device *idev; | |
91 | ||
92 | if (!dev) | |
93 | return -ENODEV; | |
94 | ||
95 | idev = to_ipack_dev(dev); | |
96 | ||
97 | if (add_uevent_var(env, | |
98 | "MODALIAS=ipack:f%02Xv%08Xd%08X", idev->id_format, | |
99 | idev->id_vendor, idev->id_device)) | |
100 | return -ENOMEM; | |
101 | ||
102 | return 0; | |
103 | } | |
104 | ||
e8ed3276 JT |
105 | #define ipack_device_attr(field, format_string) \ |
106 | static ssize_t \ | |
107 | field##_show(struct device *dev, struct device_attribute *attr, \ | |
108 | char *buf) \ | |
109 | { \ | |
110 | struct ipack_device *idev = to_ipack_dev(dev); \ | |
111 | return sprintf(buf, format_string, idev->field); \ | |
112 | } | |
113 | ||
5d72c848 JT |
114 | static ssize_t id_show(struct device *dev, |
115 | struct device_attribute *attr, char *buf) | |
116 | { | |
117 | unsigned int i, c, l, s; | |
118 | struct ipack_device *idev = to_ipack_dev(dev); | |
119 | ||
120 | ||
121 | switch (idev->id_format) { | |
122 | case IPACK_ID_VERSION_1: | |
123 | l = 0x7; s = 1; break; | |
124 | case IPACK_ID_VERSION_2: | |
125 | l = 0xf; s = 2; break; | |
126 | default: | |
127 | return -EIO; | |
128 | } | |
129 | c = 0; | |
130 | for (i = 0; i < idev->id_avail; i++) { | |
131 | if (i > 0) { | |
132 | if ((i & l) == 0) | |
133 | buf[c++] = '\n'; | |
134 | else if ((i & s) == 0) | |
135 | buf[c++] = ' '; | |
136 | } | |
137 | sprintf(&buf[c], "%02x", idev->id[i]); | |
138 | c += 2; | |
139 | } | |
140 | buf[c++] = '\n'; | |
141 | return c; | |
142 | } | |
143 | ||
e8ed3276 JT |
144 | static ssize_t |
145 | id_vendor_show(struct device *dev, struct device_attribute *attr, char *buf) | |
146 | { | |
147 | struct ipack_device *idev = to_ipack_dev(dev); | |
148 | switch (idev->id_format) { | |
149 | case IPACK_ID_VERSION_1: | |
150 | return sprintf(buf, "0x%02x\n", idev->id_vendor); | |
151 | case IPACK_ID_VERSION_2: | |
152 | return sprintf(buf, "0x%06x\n", idev->id_vendor); | |
153 | default: | |
154 | return -EIO; | |
155 | } | |
156 | } | |
157 | ||
158 | static ssize_t | |
159 | id_device_show(struct device *dev, struct device_attribute *attr, char *buf) | |
160 | { | |
161 | struct ipack_device *idev = to_ipack_dev(dev); | |
162 | switch (idev->id_format) { | |
163 | case IPACK_ID_VERSION_1: | |
164 | return sprintf(buf, "0x%02x\n", idev->id_device); | |
165 | case IPACK_ID_VERSION_2: | |
166 | return sprintf(buf, "0x%04x\n", idev->id_device); | |
167 | default: | |
168 | return -EIO; | |
169 | } | |
170 | } | |
171 | ||
35eb97bb JT |
172 | static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, |
173 | char *buf) | |
174 | { | |
175 | struct ipack_device *idev = to_ipack_dev(dev); | |
176 | ||
177 | return sprintf(buf, "ipac:f%02Xv%08Xd%08X", idev->id_format, | |
178 | idev->id_vendor, idev->id_device); | |
179 | } | |
180 | ||
e8ed3276 JT |
181 | ipack_device_attr(id_format, "0x%hhu\n"); |
182 | ||
5152a509 GKH |
183 | static DEVICE_ATTR_RO(id); |
184 | static DEVICE_ATTR_RO(id_device); | |
185 | static DEVICE_ATTR_RO(id_format); | |
186 | static DEVICE_ATTR_RO(id_vendor); | |
187 | static DEVICE_ATTR_RO(modalias); | |
188 | ||
189 | static struct attribute *ipack_attrs[] = { | |
190 | &dev_attr_id.attr, | |
191 | &dev_attr_id_device.attr, | |
192 | &dev_attr_id_format.attr, | |
193 | &dev_attr_id_vendor.attr, | |
194 | &dev_attr_modalias.attr, | |
195 | NULL, | |
e8ed3276 | 196 | }; |
5152a509 | 197 | ATTRIBUTE_GROUPS(ipack); |
e8ed3276 | 198 | |
d3465872 | 199 | static struct bus_type ipack_bus_type = { |
e8ed3276 JT |
200 | .name = "ipack", |
201 | .probe = ipack_bus_probe, | |
202 | .match = ipack_bus_match, | |
203 | .remove = ipack_bus_remove, | |
5152a509 | 204 | .dev_groups = ipack_groups, |
35eb97bb | 205 | .uevent = ipack_uevent, |
d3465872 SIG |
206 | }; |
207 | ||
ec440335 | 208 | struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots, |
9869a937 | 209 | const struct ipack_bus_ops *ops) |
d3465872 SIG |
210 | { |
211 | int bus_nr; | |
ec440335 SIG |
212 | struct ipack_bus_device *bus; |
213 | ||
214 | bus = kzalloc(sizeof(struct ipack_bus_device), GFP_KERNEL); | |
215 | if (!bus) | |
216 | return NULL; | |
d3465872 | 217 | |
3b86bb2e | 218 | bus_nr = ida_simple_get(&ipack_ida, 0, 0, GFP_KERNEL); |
ec440335 SIG |
219 | if (bus_nr < 0) { |
220 | kfree(bus); | |
221 | return NULL; | |
222 | } | |
d3465872 SIG |
223 | |
224 | bus->bus_nr = bus_nr; | |
ec440335 SIG |
225 | bus->parent = parent; |
226 | bus->slots = slots; | |
227 | bus->ops = ops; | |
228 | return bus; | |
d3465872 SIG |
229 | } |
230 | EXPORT_SYMBOL_GPL(ipack_bus_register); | |
231 | ||
bffe0fd0 SIG |
232 | static int ipack_unregister_bus_member(struct device *dev, void *data) |
233 | { | |
234 | struct ipack_device *idev = to_ipack_dev(dev); | |
235 | struct ipack_bus_device *bus = data; | |
236 | ||
f9e314d2 | 237 | if (idev->bus == bus) |
e926301b | 238 | ipack_device_del(idev); |
bffe0fd0 SIG |
239 | |
240 | return 1; | |
241 | } | |
242 | ||
d3465872 SIG |
243 | int ipack_bus_unregister(struct ipack_bus_device *bus) |
244 | { | |
0a8f4a07 JM |
245 | bus_for_each_dev(&ipack_bus_type, NULL, bus, |
246 | ipack_unregister_bus_member); | |
3b86bb2e | 247 | ida_simple_remove(&ipack_ida, bus->bus_nr); |
ec440335 | 248 | kfree(bus); |
d3465872 SIG |
249 | return 0; |
250 | } | |
251 | EXPORT_SYMBOL_GPL(ipack_bus_unregister); | |
252 | ||
ec440335 | 253 | int ipack_driver_register(struct ipack_driver *edrv, struct module *owner, |
9869a937 | 254 | const char *name) |
d3465872 | 255 | { |
ec440335 SIG |
256 | edrv->driver.owner = owner; |
257 | edrv->driver.name = name; | |
d3465872 SIG |
258 | edrv->driver.bus = &ipack_bus_type; |
259 | return driver_register(&edrv->driver); | |
260 | } | |
261 | EXPORT_SYMBOL_GPL(ipack_driver_register); | |
262 | ||
263 | void ipack_driver_unregister(struct ipack_driver *edrv) | |
264 | { | |
265 | driver_unregister(&edrv->driver); | |
266 | } | |
267 | EXPORT_SYMBOL_GPL(ipack_driver_unregister); | |
268 | ||
a92caeb8 JT |
269 | static u16 ipack_crc_byte(u16 crc, u8 c) |
270 | { | |
271 | int i; | |
272 | ||
273 | crc ^= c << 8; | |
274 | for (i = 0; i < 8; i++) | |
275 | crc = (crc << 1) ^ ((crc & 0x8000) ? 0x1021 : 0); | |
276 | return crc; | |
277 | } | |
278 | ||
279 | /* | |
280 | * The algorithm in lib/crc-ccitt.c does not seem to apply since it uses the | |
281 | * opposite bit ordering. | |
282 | */ | |
283 | static u8 ipack_calc_crc1(struct ipack_device *dev) | |
284 | { | |
285 | u8 c; | |
286 | u16 crc; | |
287 | unsigned int i; | |
288 | ||
289 | crc = 0xffff; | |
290 | for (i = 0; i < dev->id_avail; i++) { | |
291 | c = (i != 11) ? dev->id[i] : 0; | |
292 | crc = ipack_crc_byte(crc, c); | |
293 | } | |
294 | crc = ~crc; | |
295 | return crc & 0xff; | |
296 | } | |
297 | ||
298 | static u16 ipack_calc_crc2(struct ipack_device *dev) | |
299 | { | |
300 | u8 c; | |
301 | u16 crc; | |
302 | unsigned int i; | |
303 | ||
304 | crc = 0xffff; | |
305 | for (i = 0; i < dev->id_avail; i++) { | |
306 | c = ((i != 0x18) && (i != 0x19)) ? dev->id[i] : 0; | |
307 | crc = ipack_crc_byte(crc, c); | |
308 | } | |
309 | crc = ~crc; | |
310 | return crc; | |
311 | } | |
312 | ||
e8ed3276 JT |
313 | static void ipack_parse_id1(struct ipack_device *dev) |
314 | { | |
315 | u8 *id = dev->id; | |
a92caeb8 | 316 | u8 crc; |
e8ed3276 JT |
317 | |
318 | dev->id_vendor = id[4]; | |
319 | dev->id_device = id[5]; | |
0b0f3a1b JT |
320 | dev->speed_8mhz = 1; |
321 | dev->speed_32mhz = (id[7] == 'H'); | |
a92caeb8 JT |
322 | crc = ipack_calc_crc1(dev); |
323 | dev->id_crc_correct = (crc == id[11]); | |
324 | if (!dev->id_crc_correct) { | |
325 | dev_warn(&dev->dev, "ID CRC invalid found 0x%x, expected 0x%x.\n", | |
326 | id[11], crc); | |
327 | } | |
e8ed3276 JT |
328 | } |
329 | ||
330 | static void ipack_parse_id2(struct ipack_device *dev) | |
331 | { | |
332 | __be16 *id = (__be16 *) dev->id; | |
a92caeb8 | 333 | u16 flags, crc; |
e8ed3276 JT |
334 | |
335 | dev->id_vendor = ((be16_to_cpu(id[3]) & 0xff) << 16) | |
336 | + be16_to_cpu(id[4]); | |
337 | dev->id_device = be16_to_cpu(id[5]); | |
0b0f3a1b JT |
338 | flags = be16_to_cpu(id[10]); |
339 | dev->speed_8mhz = !!(flags & 2); | |
340 | dev->speed_32mhz = !!(flags & 4); | |
a92caeb8 JT |
341 | crc = ipack_calc_crc2(dev); |
342 | dev->id_crc_correct = (crc == be16_to_cpu(id[12])); | |
343 | if (!dev->id_crc_correct) { | |
344 | dev_warn(&dev->dev, "ID CRC invalid found 0x%x, expected 0x%x.\n", | |
345 | id[11], crc); | |
346 | } | |
e8ed3276 JT |
347 | } |
348 | ||
187e4782 JT |
349 | static int ipack_device_read_id(struct ipack_device *dev) |
350 | { | |
351 | u8 __iomem *idmem; | |
352 | int i; | |
353 | int ret = 0; | |
354 | ||
402228db JT |
355 | idmem = ioremap(dev->region[IPACK_ID_SPACE].start, |
356 | dev->region[IPACK_ID_SPACE].size); | |
357 | if (!idmem) { | |
187e4782 | 358 | dev_err(&dev->dev, "error mapping memory\n"); |
58b2c0ca | 359 | return -ENOMEM; |
187e4782 | 360 | } |
187e4782 JT |
361 | |
362 | /* Determine ID PROM Data Format. If we find the ids "IPAC" or "IPAH" | |
363 | * we are dealing with a IndustryPack format 1 device. If we detect | |
364 | * "VITA4 " (16 bit big endian formatted) we are dealing with a | |
365 | * IndustryPack format 2 device */ | |
366 | if ((ioread8(idmem + 1) == 'I') && | |
367 | (ioread8(idmem + 3) == 'P') && | |
368 | (ioread8(idmem + 5) == 'A') && | |
369 | ((ioread8(idmem + 7) == 'C') || | |
370 | (ioread8(idmem + 7) == 'H'))) { | |
371 | dev->id_format = IPACK_ID_VERSION_1; | |
372 | dev->id_avail = ioread8(idmem + 0x15); | |
373 | if ((dev->id_avail < 0x0c) || (dev->id_avail > 0x40)) { | |
374 | dev_warn(&dev->dev, "invalid id size"); | |
375 | dev->id_avail = 0x0c; | |
376 | } | |
377 | } else if ((ioread8(idmem + 0) == 'I') && | |
378 | (ioread8(idmem + 1) == 'V') && | |
379 | (ioread8(idmem + 2) == 'A') && | |
380 | (ioread8(idmem + 3) == 'T') && | |
381 | (ioread8(idmem + 4) == ' ') && | |
382 | (ioread8(idmem + 5) == '4')) { | |
383 | dev->id_format = IPACK_ID_VERSION_2; | |
384 | dev->id_avail = ioread16be(idmem + 0x16); | |
385 | if ((dev->id_avail < 0x1a) || (dev->id_avail > 0x40)) { | |
386 | dev_warn(&dev->dev, "invalid id size"); | |
387 | dev->id_avail = 0x1a; | |
388 | } | |
389 | } else { | |
390 | dev->id_format = IPACK_ID_VERSION_INVALID; | |
391 | dev->id_avail = 0; | |
392 | } | |
393 | ||
394 | if (!dev->id_avail) { | |
395 | ret = -ENODEV; | |
396 | goto out; | |
397 | } | |
398 | ||
399 | /* Obtain the amount of memory required to store a copy of the complete | |
400 | * ID ROM contents */ | |
401 | dev->id = kmalloc(dev->id_avail, GFP_KERNEL); | |
402 | if (!dev->id) { | |
403 | dev_err(&dev->dev, "dev->id alloc failed.\n"); | |
404 | ret = -ENOMEM; | |
405 | goto out; | |
406 | } | |
407 | for (i = 0; i < dev->id_avail; i++) { | |
408 | if (dev->id_format == IPACK_ID_VERSION_1) | |
409 | dev->id[i] = ioread8(idmem + (i << 1) + 1); | |
410 | else | |
411 | dev->id[i] = ioread8(idmem + i); | |
412 | } | |
413 | ||
e8ed3276 JT |
414 | /* now we can finally work with the copy */ |
415 | switch (dev->id_format) { | |
416 | case IPACK_ID_VERSION_1: | |
417 | ipack_parse_id1(dev); | |
418 | break; | |
419 | case IPACK_ID_VERSION_2: | |
420 | ipack_parse_id2(dev); | |
421 | break; | |
422 | } | |
423 | ||
187e4782 | 424 | out: |
402228db | 425 | iounmap(idmem); |
187e4782 JT |
426 | |
427 | return ret; | |
428 | } | |
429 | ||
e926301b | 430 | int ipack_device_init(struct ipack_device *dev) |
d3465872 SIG |
431 | { |
432 | int ret; | |
433 | ||
434 | dev->dev.bus = &ipack_bus_type; | |
435 | dev->dev.release = ipack_device_release; | |
1e91795c | 436 | dev->dev.parent = dev->bus->parent; |
d3465872 | 437 | dev_set_name(&dev->dev, |
f9e314d2 | 438 | "ipack-dev.%u.%u", dev->bus->bus_nr, dev->slot); |
e926301b | 439 | device_initialize(&dev->dev); |
d3465872 | 440 | |
1e91795c | 441 | if (dev->bus->ops->set_clockrate(dev, 8)) |
07766ab0 | 442 | dev_warn(&dev->dev, "failed to switch to 8 MHz operation for reading of device ID.\n"); |
1e91795c | 443 | if (dev->bus->ops->reset_timeout(dev)) |
8a3ae16e | 444 | dev_warn(&dev->dev, "failed to reset potential timeout."); |
07766ab0 | 445 | |
187e4782 JT |
446 | ret = ipack_device_read_id(dev); |
447 | if (ret < 0) { | |
448 | dev_err(&dev->dev, "error reading device id section.\n"); | |
1e91795c | 449 | return ret; |
187e4782 JT |
450 | } |
451 | ||
90cb6194 | 452 | /* if the device supports 32 MHz operation, use it. */ |
07766ab0 | 453 | if (dev->speed_32mhz) { |
1e91795c | 454 | ret = dev->bus->ops->set_clockrate(dev, 32); |
07766ab0 JT |
455 | if (ret < 0) |
456 | dev_err(&dev->dev, "failed to switch to 32 MHz operation.\n"); | |
457 | } | |
90cb6194 | 458 | |
e926301b SIG |
459 | return 0; |
460 | } | |
461 | EXPORT_SYMBOL_GPL(ipack_device_init); | |
d3465872 | 462 | |
e926301b SIG |
463 | int ipack_device_add(struct ipack_device *dev) |
464 | { | |
465 | return device_add(&dev->dev); | |
d3465872 | 466 | } |
e926301b | 467 | EXPORT_SYMBOL_GPL(ipack_device_add); |
d3465872 | 468 | |
e926301b | 469 | void ipack_device_del(struct ipack_device *dev) |
d3465872 | 470 | { |
e926301b SIG |
471 | device_del(&dev->dev); |
472 | ipack_put_device(dev); | |
d3465872 | 473 | } |
e926301b | 474 | EXPORT_SYMBOL_GPL(ipack_device_del); |
d3465872 | 475 | |
fa882867 SIG |
476 | void ipack_get_device(struct ipack_device *dev) |
477 | { | |
478 | get_device(&dev->dev); | |
479 | } | |
480 | EXPORT_SYMBOL_GPL(ipack_get_device); | |
481 | ||
482 | void ipack_put_device(struct ipack_device *dev) | |
483 | { | |
484 | put_device(&dev->dev); | |
485 | } | |
486 | EXPORT_SYMBOL_GPL(ipack_put_device); | |
487 | ||
d3465872 SIG |
488 | static int __init ipack_init(void) |
489 | { | |
3b86bb2e | 490 | ida_init(&ipack_ida); |
d3465872 SIG |
491 | return bus_register(&ipack_bus_type); |
492 | } | |
493 | ||
494 | static void __exit ipack_exit(void) | |
495 | { | |
496 | bus_unregister(&ipack_bus_type); | |
3b86bb2e | 497 | ida_destroy(&ipack_ida); |
d3465872 SIG |
498 | } |
499 | ||
500 | module_init(ipack_init); | |
501 | module_exit(ipack_exit); | |
502 | ||
503 | MODULE_AUTHOR("Samuel Iglesias Gonsalvez <siglesias@igalia.com>"); | |
504 | MODULE_LICENSE("GPL"); | |
505 | MODULE_DESCRIPTION("Industry-pack bus core"); |