The interrupt controller lives at I/O 0x4d0/0x4d1.
[coreboot.git] / src / devices / device_util.c
1 /*
2  * This file is part of the coreboot project.
3  *
4  * Copyright (C) 2003-2004 Linux Networx
5  * (Written by Eric Biederman <ebiederman@lnxi.com> for Linux Networx)
6  * Copyright (C) 2003 Greg Watson <jarrah@users.sourceforge.net>
7  * Copyright (C) 2004 Li-Ta Lo <ollie@lanl.gov>
8  * Copyright (C) 2005-2006 Tyan
9  * (Written by Yinghai Lu <yhlu@tyan.com> for Tyan)
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; version 2 of the License.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
23  */
24
25 #include <console/console.h>
26 #include <device/device.h>
27 #include <device/path.h>
28 #include <device/pci.h>
29 #include <device/resource.h>
30 #include <string.h>
31
32 /**
33  * @brief See if a device structure exists for path
34  *
35  * @param bus The bus to find the device on
36  * @param path The relative path from the bus to the appropriate device
37  * @return pointer to a device structure for the device on bus at path
38  *         or 0/NULL if no device is found
39  */
40 device_t find_dev_path(struct bus *parent, struct device_path *path)
41 {
42         device_t child;
43         for(child = parent->children; child; child = child->sibling) {
44                 if (path_eq(path, &child->path)) {
45                         break;
46                 }
47         }
48         return child;
49 }
50
51 /**
52  * @brief See if a device structure already exists and if not allocate it
53  *
54  * @param bus The bus to find the device on
55  * @param path The relative path from the bus to the appropriate device
56  * @return pointer to a device structure for the device on bus at path
57  */
58 device_t alloc_find_dev(struct bus *parent, struct device_path *path)
59 {
60         device_t child;
61         child = find_dev_path(parent, path);
62         if (!child) {
63                 child = alloc_dev(parent, path);
64         }
65         return child;
66 }
67
68 /**
69  * @brief Given a PCI bus and a devfn number, find the device structure
70  *
71  * @param bus The bus number
72  * @param devfn a device/function number
73  * @return pointer to the device structure
74  */
75 struct device *dev_find_slot(unsigned int bus, unsigned int devfn)
76 {
77         struct device *dev, *result;
78
79         result = 0;
80         for (dev = all_devices; dev; dev = dev->next) {
81                 if ((dev->path.type == DEVICE_PATH_PCI) &&
82                         (dev->bus->secondary == bus) &&
83                         (dev->path.pci.devfn == devfn)) {
84                         result = dev;
85                         break;
86                 }
87         }
88         return result;
89 }
90
91 /**
92  * @brief Given a smbus bus and a device number, find the device structure
93  *
94  * @param bus The bus number
95  * @param addr a device number
96  * @return pointer to the device structure
97  */
98 struct device *dev_find_slot_on_smbus(unsigned int bus, unsigned int addr)
99 {
100         struct device *dev, *result;
101
102         result = 0;
103         for (dev = all_devices; dev; dev = dev->next) {
104                 if ((dev->path.type == DEVICE_PATH_I2C) &&
105                         (dev->bus->secondary == bus) &&
106                         (dev->path.i2c.device == addr)) {
107                         result = dev;
108                         break;
109                 }
110         }
111         return result;
112 }
113
114 /** Find a device of a given vendor and type
115  * @param vendor Vendor ID (e.g. 0x8086 for Intel)
116  * @param device Device ID
117  * @param from Pointer to the device structure, used as a starting point
118  *        in the linked list of all_devices, which can be 0 to start at the
119  *        head of the list (i.e. all_devices)
120  * @return Pointer to the device struct
121  */
122 struct device *dev_find_device(unsigned int vendor, unsigned int device, struct device *from)
123 {
124         if (!from)
125                 from = all_devices;
126         else
127                 from = from->next;
128         while (from && (from->vendor != vendor || from->device != device)) {
129                 from = from->next;
130         }
131         return from;
132 }
133
134 /** Find a device of a given class
135  * @param class Class of the device
136  * @param from Pointer to the device structure, used as a starting point
137  *        in the linked list of all_devices, which can be 0 to start at the
138  *        head of the list (i.e. all_devices)
139  * @return Pointer to the device struct
140  */
141 struct device *dev_find_class(unsigned int class, struct device *from)
142 {
143         if (!from)
144                 from = all_devices;
145         else
146                 from = from->next;
147         while (from && (from->class & 0xffffff00) != class)
148                 from = from->next;
149         return from;
150 }
151
152 /* Warning: This function uses a static buffer.  Don't call it more than once
153  * from the same print statement! */
154
155 const char *dev_path(device_t dev)
156 {
157         static char buffer[DEVICE_PATH_MAX];
158         buffer[0] = '\0';
159         if (!dev) {
160                 memcpy(buffer, "<null>", 7);
161         }
162         else {
163                 switch(dev->path.type) {
164                 case DEVICE_PATH_ROOT:
165                         memcpy(buffer, "Root Device", 12);
166                         break;
167                 case DEVICE_PATH_PCI:
168 #if CONFIG_PCI_BUS_SEGN_BITS
169                         sprintf(buffer, "PCI: %04x:%02x:%02x.%01x",
170                                 dev->bus->secondary>>8, dev->bus->secondary & 0xff,
171                                 PCI_SLOT(dev->path.pci.devfn), PCI_FUNC(dev->path.pci.devfn));
172 #else
173                         sprintf(buffer, "PCI: %02x:%02x.%01x",
174                                 dev->bus->secondary,
175                                 PCI_SLOT(dev->path.pci.devfn), PCI_FUNC(dev->path.pci.devfn));
176 #endif
177                         break;
178                 case DEVICE_PATH_PNP:
179                         sprintf(buffer, "PNP: %04x.%01x",
180                                 dev->path.pnp.port, dev->path.pnp.device);
181                         break;
182                 case DEVICE_PATH_I2C:
183                         sprintf(buffer, "I2C: %02x:%02x",
184                                 dev->bus->secondary,
185                                 dev->path.i2c.device);
186                         break;
187                 case DEVICE_PATH_APIC:
188                         sprintf(buffer, "APIC: %02x",
189                                 dev->path.apic.apic_id);
190                         break;
191                 case DEVICE_PATH_PCI_DOMAIN:
192                         sprintf(buffer, "PCI_DOMAIN: %04x",
193                                 dev->path.pci_domain.domain);
194                         break;
195                 case DEVICE_PATH_APIC_CLUSTER:
196                         sprintf(buffer, "APIC_CLUSTER: %01x",
197                                 dev->path.apic_cluster.cluster);
198                         break;
199                 case DEVICE_PATH_CPU:
200                         sprintf(buffer, "CPU: %02x", dev->path.cpu.id);
201                         break;
202                 case DEVICE_PATH_CPU_BUS:
203                         sprintf(buffer, "CPU_BUS: %02x", dev->path.cpu_bus.id);
204                         break;
205                 default:
206                         printk(BIOS_ERR, "Unknown device path type: %d\n", dev->path.type);
207                         break;
208                 }
209         }
210         return buffer;
211 }
212
213 const char *bus_path(struct bus *bus)
214 {
215         static char buffer[BUS_PATH_MAX];
216         sprintf(buffer, "%s,%d", dev_path(bus->dev), bus->link);
217         return buffer;
218 }
219
220 int path_eq(struct device_path *path1, struct device_path *path2)
221 {
222         int equal = 0;
223         if (path1->type == path2->type) {
224                 switch(path1->type) {
225                 case DEVICE_PATH_NONE:
226                         break;
227                 case DEVICE_PATH_ROOT:
228                         equal = 1;
229                         break;
230                 case DEVICE_PATH_PCI:
231                         equal = (path1->pci.devfn == path2->pci.devfn);
232                         break;
233                 case DEVICE_PATH_PNP:
234                         equal = (path1->pnp.port == path2->pnp.port) &&
235                                 (path1->pnp.device == path2->pnp.device);
236                         break;
237                 case DEVICE_PATH_I2C:
238                         equal = (path1->i2c.device == path2->i2c.device);
239                         break;
240                 case DEVICE_PATH_APIC:
241                         equal = (path1->apic.apic_id == path2->apic.apic_id);
242                         break;
243                 case DEVICE_PATH_PCI_DOMAIN:
244                         equal = (path1->pci_domain.domain == path2->pci_domain.domain);
245                         break;
246                 case DEVICE_PATH_APIC_CLUSTER:
247                         equal = (path1->apic_cluster.cluster == path2->apic_cluster.cluster);
248                         break;
249                 case DEVICE_PATH_CPU:
250                         equal = (path1->cpu.id == path2->cpu.id);
251                         break;
252                 case DEVICE_PATH_CPU_BUS:
253                         equal = (path1->cpu_bus.id == path2->cpu_bus.id);
254                         break;
255                 default:
256                         printk(BIOS_ERR, "Uknown device type: %d\n", path1->type);
257                         break;
258                 }
259         }
260         return equal;
261 }
262
263 /**
264  * Allocate 64 more resources to the free list.
265  */
266 static int allocate_more_resources(void)
267 {
268         int i;
269         struct resource *new_res_list;
270         new_res_list = malloc(64 * sizeof(*new_res_list));
271
272         if (new_res_list == NULL)
273                 return 0;
274
275         memset(new_res_list, 0, 64 * sizeof(*new_res_list));
276
277         for (i = 0; i < 64-1; i++)
278                 new_res_list[i].next = &new_res_list[i+1];
279
280         free_resources = new_res_list;
281         return 1;
282 }
283
284 /**
285  * Remove resource res from the device's list and add it to the free list.
286  */
287 static void free_resource(device_t dev, struct resource *res, struct resource *prev)
288 {
289         if (prev)
290                 prev->next = res->next;
291         else
292                 dev->resource_list = res->next;
293         res->next = free_resources;
294         free_resources = res;
295 }
296
297 /**
298  * See if we have unused but allocated resource structures.
299  * If so remove the allocation.
300  * @param dev The device to find the resource on
301  */
302 void compact_resources(device_t dev)
303 {
304         struct resource *res, *next, *prev = NULL;
305         /* Move all of the free resources to the end */
306         for(res = dev->resource_list; res; res = next) {
307                 next = res->next;
308                 if (!res->flags)
309                         free_resource(dev, res, prev);
310                 else
311                         prev = res;
312         }
313 }
314
315
316 /**
317  * See if a resource structure already exists for a given index
318  * @param dev The device to find the resource on
319  * @param index  The index of the resource on the device.
320  * @return the resource if it already exists
321  */
322 struct resource *probe_resource(device_t dev, unsigned index)
323 {
324         struct resource *res;
325         /* See if there is a resource with the appropriate index */
326         for(res = dev->resource_list; res; res = res->next) {
327                 if (res->index == index)
328                         break;
329         }
330         return res;
331 }
332
333 /**
334  * See if a resource structure already exists for a given index and if
335  * not allocate one.  Then initialize the initialize the resource
336  * to default values.
337  * @param dev The device to find the resource on
338  * @param index  The index of the resource on the device.
339  */
340 struct resource *new_resource(device_t dev, unsigned index)
341 {
342         struct resource *resource, *tail;
343
344         /* First move all of the free resources to the end */
345         compact_resources(dev);
346
347         /* See if there is a resource with the appropriate index */
348         resource = probe_resource(dev, index);
349         if (!resource) {
350                 if (free_resources == NULL && !allocate_more_resources())
351                         die("Couldn't allocate more resources.");
352
353                 resource = free_resources;
354                 free_resources = free_resources->next;
355                 memset(resource, 0, sizeof(*resource));
356                 resource->next = NULL;
357                 tail = dev->resource_list;
358                 if (tail) {
359                         while (tail->next) tail = tail->next;
360                         tail->next = resource;
361                 }
362                 else
363                         dev->resource_list = resource;
364         }
365         /* Initialize the resource values */
366         if (!(resource->flags & IORESOURCE_FIXED)) {
367                 resource->flags = 0;
368                 resource->base = 0;
369         }
370         resource->size  = 0;
371         resource->limit = 0;
372         resource->index = index;
373         resource->align = 0;
374         resource->gran  = 0;
375
376         return resource;
377 }
378
379 /**
380  * Return an existing resource structure for a given index.
381  * @param dev The device to find the resource on
382  * @param index  The index of the resource on the device.
383  */
384 struct resource *find_resource(device_t dev, unsigned index)
385 {
386         struct resource *resource;
387
388         /* See if there is a resource with the appropriate index */
389         resource = probe_resource(dev, index);
390         if (!resource) {
391                 printk(BIOS_EMERG, "%s missing resource: %02x\n",
392                         dev_path(dev), index);
393                 die("");
394         }
395         return resource;
396 }
397
398
399 /**
400  * @brief round a number up to the next multiple of gran
401  * @param val the starting value
402  * @param gran granularity we are aligning the number to.
403  * @returns aligned value
404  */
405 static resource_t align_up(resource_t val, unsigned long gran)
406 {
407         resource_t mask;
408         mask = (1ULL << gran) - 1ULL;
409         val += mask;
410         val &= ~mask;
411         return val;
412 }
413
414 /**
415  * @brief round a number up to the previous multiple of gran
416  * @param val the starting value
417  * @param gran granularity we are aligning the number to.
418  * @returns aligned value
419  */
420 static resource_t align_down(resource_t val, unsigned long gran)
421 {
422         resource_t mask;
423         mask = (1ULL << gran) - 1ULL;
424         val &= ~mask;
425         return val;
426 }
427
428 /**
429  * @brief Compute the maximum address that is part of a resource
430  * @param resource the resource whose limit is desired
431  * @returns the end
432  */
433 resource_t resource_end(struct resource *resource)
434 {
435         resource_t base, end;
436         /* get the base address */
437         base = resource->base;
438
439         /* For a non bridge resource granularity and alignment are the same.
440          * For a bridge resource align is the largest needed alignment below
441          * the bridge.  While the granularity is simply how many low bits of the
442          * address cannot be set.
443          */
444
445         /* Get the end (rounded up) */
446         end = base + align_up(resource->size, resource->gran) - 1;
447
448         return end;
449 }
450
451 /**
452  * @brief Compute the maximum legal value for resource->base
453  * @param resource the resource whose maximum is desired
454  * @returns the maximum
455  */
456 resource_t resource_max(struct resource *resource)
457 {
458         resource_t max;
459
460         max = align_down(resource->limit - resource->size + 1, resource->align);
461
462         return max;
463 }
464
465 /**
466  * @brief return the resource type of a resource
467  * @param resource the resource type to decode.
468  */
469 const char *resource_type(struct resource *resource)
470 {
471         static char buffer[RESOURCE_TYPE_MAX];
472         sprintf(buffer, "%s%s%s%s",
473                 ((resource->flags & IORESOURCE_READONLY)? "ro": ""),
474                 ((resource->flags & IORESOURCE_PREFETCH)? "pref":""),
475                 ((resource->flags == 0)? "unused":
476                 (resource->flags & IORESOURCE_IO)? "io":
477                 (resource->flags & IORESOURCE_DRQ)? "drq":
478                 (resource->flags & IORESOURCE_IRQ)? "irq":
479                 (resource->flags & IORESOURCE_MEM)? "mem":"??????"),
480                 ((resource->flags & IORESOURCE_PCI64)?"64":""));
481         return buffer;
482 }
483
484 /**
485  * @brief print the resource that was just stored.
486  * @param dev the device the stored resorce lives on
487  * @param resource the resource that was just stored.
488  */
489 void report_resource_stored(device_t dev, struct resource *resource, const char *comment)
490 {
491         if (resource->flags & IORESOURCE_STORED) {
492                 char buf[10];
493                 unsigned long long base, end;
494                 base = resource->base;
495                 end = resource_end(resource);
496                 buf[0] = '\0';
497                 if (resource->flags & IORESOURCE_PCI_BRIDGE) {
498 #if CONFIG_PCI_BUS_SEGN_BITS
499                         sprintf(buf, "bus %04x:%02x ", dev->bus->secondary>>8, dev->link[0].secondary & 0xff);
500 #else
501                         sprintf(buf, "bus %02x ", dev->link[0].secondary);
502 #endif
503                 }
504                 printk(BIOS_DEBUG,
505                         "%s %02lx <- [0x%010Lx - 0x%010Lx] size 0x%08Lx gran 0x%02x %s%s%s\n",
506                         dev_path(dev),
507                         resource->index,
508                         base, end,
509                         resource->size, resource->gran,
510                         buf,
511                         resource_type(resource),
512                         comment);
513         }
514 }
515
516 void search_bus_resources(struct bus *bus,
517         unsigned long type_mask, unsigned long type,
518         resource_search_t search, void *gp)
519 {
520         struct device *curdev;
521         for(curdev = bus->children; curdev; curdev = curdev->sibling) {
522                 struct resource *res;
523                 /* Ignore disabled devices */
524                 if (!curdev->enabled) continue;
525                 for(res = curdev->resource_list; res; res = res->next) {
526                         /* If it isn't the right kind of resource ignore it */
527                         if ((res->flags & type_mask) != type) {
528                                 continue;
529                         }
530                         /* If it is a subtractive resource recurse */
531                         if (res->flags & IORESOURCE_SUBTRACTIVE) {
532                                 struct bus * subbus;
533                                 subbus = &curdev->link[IOINDEX_SUBTRACTIVE_LINK(res->index)];
534                                 search_bus_resources(subbus, type_mask, type, search, gp);
535                                 continue;
536                         }
537                         search(gp, curdev, res);
538                 }
539         }
540 }
541
542 void search_global_resources(
543         unsigned long type_mask, unsigned long type,
544         resource_search_t search, void *gp)
545 {
546         struct device *curdev;
547         for(curdev = all_devices; curdev; curdev = curdev->next) {
548                 struct resource *res;
549                 /* Ignore disabled devices */
550                 if (!curdev->enabled) continue;
551                 for(res = curdev->resource_list; res; res = res->next) {
552                         /* If it isn't the right kind of resource ignore it */
553                         if ((res->flags & type_mask) != type) {
554                                 continue;
555                         }
556                         /* If it is a subtractive resource ignore it */
557                         if (res->flags & IORESOURCE_SUBTRACTIVE) {
558                                 continue;
559                         }
560                         search(gp, curdev, res);
561                 }
562         }
563 }
564
565 void dev_set_enabled(device_t dev, int enable)
566 {
567         if (dev->enabled == enable) {
568                 return;
569         }
570         dev->enabled = enable;
571         if (dev->ops && dev->ops->enable) {
572                 dev->ops->enable(dev);
573         }
574         else if (dev->chip_ops && dev->chip_ops->enable_dev) {
575                 dev->chip_ops->enable_dev(dev);
576         }
577 }
578
579 void disable_children(struct bus *bus)
580 {
581         device_t child;
582         for(child = bus->children; child; child = child->sibling) {
583                 int link;
584                 for(link = 0; link < child->links; link++) {
585                         disable_children(&child->link[link]);
586                 }
587                 dev_set_enabled(child, 0);
588         }
589 }
590
591 static void resource_tree(struct device *root, int debug_level, int depth)
592 {
593         int i = 0, link = 0;
594         struct device *child;
595         struct resource *res;
596         char indent[30];        /* If your tree has more levels, it's wrong. */
597
598         for (i = 0; i < depth + 1 && i < 29; i++)
599                 indent[i] = ' ';
600         indent[i] = '\0';
601
602         do_printk(debug_level, "%s%s links %x child on link 0", indent,
603                   dev_path(root), root->links);
604         do_printk(debug_level, " %s\n", root->link[0].children ?
605                   dev_path(root->link[0].children) : "NULL");
606         for (res = root->resource_list; res; res = res->next) {
607                 do_printk(debug_level,
608                           "%s%s resource base %llx size %llx align %d gran %d limit %llx flags %lx index %lx\n",
609                           indent, dev_path(root), res->base,
610                           res->size, res->align,
611                           res->gran, res->limit,
612                           res->flags, res->index);
613         }
614
615         for (link = 0; link < root->links; link++) {
616                 for (child = root->link[link].children; child;
617                      child = child->sibling)
618                         resource_tree(child, debug_level, depth + 1);
619         }
620 }
621
622 void print_resource_tree(struct device * root, int debug_level,
623                          const char *msg)
624 {
625         /* Bail if root is null. */
626         if (!root) {
627                 do_printk(debug_level, "%s passed NULL for root!\n", __func__);
628                 return;
629         }
630
631         /* Bail if not printing to screen. */
632         if (!do_printk(debug_level, "Show resources in subtree (%s)...%s\n",
633                     dev_path(root), msg))
634                 return;
635         resource_tree(root, debug_level, 0);
636 }
637
638 void show_devs_tree(struct device *dev, int debug_level, int depth, int linknum)
639 {
640         char depth_str[20] = "";
641         int i;
642         struct device *sibling;
643         for (i = 0; i < depth; i++)
644                 depth_str[i] = ' ';
645         depth_str[i] = '\0';
646         do_printk(debug_level, "%s%s: enabled %d\n",
647                   depth_str, dev_path(dev), dev->enabled);
648         for (i = 0; i < dev->links; i++) {
649                 for (sibling = dev->link[i].children; sibling;
650                      sibling = sibling->sibling)
651                         show_devs_tree(sibling, debug_level, depth + 1, i);
652         }
653 }
654
655 void show_all_devs_tree(int debug_level, const char *msg)
656 {
657         /* Bail if not printing to screen. */
658         if (!do_printk(debug_level, "Show all devs in tree form...%s\n", msg))
659                 return;
660         show_devs_tree(all_devices, debug_level, 0, -1);
661 }
662
663 void show_devs_subtree(struct device *root, int debug_level, const char *msg)
664 {
665         /* Bail if not printing to screen. */
666         if (!do_printk(debug_level, "Show all devs in subtree %s...%s\n",
667                     dev_path(root), msg))
668                 return;
669         do_printk(debug_level, "%s\n", msg);
670         show_devs_tree(root, debug_level, 0, -1);
671 }
672
673 void show_all_devs(int debug_level, const char *msg)
674 {
675         struct device *dev;
676
677         /* Bail if not printing to screen. */
678         if (!do_printk(debug_level, "Show all devs...%s\n", msg))
679                 return;
680         for (dev = all_devices; dev; dev = dev->next) {
681                 do_printk(debug_level, "%s: enabled %d\n",
682                           dev_path(dev), dev->enabled);
683         }
684 }
685
686 void show_one_resource(int debug_level, struct device *dev,
687                        struct resource *resource, const char *comment)
688 {
689         char buf[10];
690         unsigned long long base, end;
691         base = resource->base;
692         end = resource_end(resource);
693         buf[0] = '\0';
694 /*
695         if (resource->flags & IORESOURCE_BRIDGE) {
696 #if CONFIG_PCI_BUS_SEGN_BITS
697                 sprintf(buf, "bus %04x:%02x ", dev->bus->secondary >> 8,
698                         dev->link[0].secondary & 0xff);
699 #else
700                 sprintf(buf, "bus %02x ", dev->link[0].secondary);
701 #endif
702         }
703 */
704         do_printk(debug_level, "%s %02lx <- [0x%010llx - 0x%010llx] "
705                   "size 0x%08Lx gran 0x%02x %s%s%s\n",
706                   dev_path(dev), resource->index, base, end,
707                   resource->size, resource->gran, buf,
708                   resource_type(resource), comment);
709
710 }
711
712 void show_all_devs_resources(int debug_level, const char* msg)
713 {
714         struct device *dev;
715
716         if(!do_printk(debug_level, "Show all devs with resources...%s\n", msg))
717                 return;
718
719         for (dev = all_devices; dev; dev = dev->next) {
720                 struct resource *res;
721                 do_printk(debug_level, "%s: enabled %d\n",
722                           dev_path(dev), dev->enabled);
723                 for (res = dev->resource_list; res; res = res->next)
724                         show_one_resource(debug_level, dev, res, "");
725         }
726 }