Doxidization, reformat
[coreboot.git] / src / include / device / device.h
1 #ifndef DEVICE_H
2 #define DEVICE_H
3
4 #include <stdint.h>
5 #include <device/resource.h>
6 #include <device/path.h>
7
8 struct device;
9 typedef struct device * device_t;
10
11 struct device_operations {
12         void (*read_resources)(device_t dev);
13         void (*set_resources)(device_t dev);
14         void (*enable_resources)(device_t dev);
15         void (*init)(device_t dev);
16         unsigned int (*scan_bus)(device_t  bus, unsigned int max);
17         void (*enable)(device_t dev);
18 };
19
20
21 struct bus {
22         device_t        dev;            /* This bridge device */
23         device_t        children;       /* devices behind this bridge */
24         unsigned        bridge_ctrl;    /* Bridge control register */
25         unsigned char   link;           /* The index of this link */
26         unsigned char   secondary;      /* secondary bus number */
27         unsigned char   subordinate;    /* max subordinate bus number */
28         unsigned char   cap;            /* PCi capability offset */
29 };
30
31 #define MAX_RESOURCES 8
32 #define MAX_LINKS     3
33 /*
34  * There is one device structure for each slot-number/function-number
35  * combination:
36  */
37
38 struct chip;
39 struct device {
40         struct bus *    bus;            /* bus this device is on */
41         device_t        sibling;        /* next device on this bus */
42         device_t        next;           /* chain of all devices */
43
44         struct device_path path;
45         unsigned short  vendor;
46         unsigned short  device;
47         unsigned int    class;          /* 3 bytes: (base,sub,prog-if) */
48         unsigned int    hdr_type;       /* PCI header type */
49         /* @todo rename this to 'enabled' */
50         unsigned int    enable : 1;     /* set if we should enable the device */
51
52         uint8_t command;
53
54         /* Base registers for this device, can be adjusted by
55          * pcibios_fixup() as necessary.
56          */
57         struct resource resource[MAX_RESOURCES];
58         unsigned int resources;
59
60         struct bus link[MAX_LINKS];
61         unsigned int links;
62
63         unsigned long rom_address;
64         struct device_operations *ops;
65         struct chip *chip;
66 };
67
68 extern struct device    dev_root;       /* root bus */
69 extern struct device    *all_devices;   /* list of all devices */
70
71
72 /* Generic device interface functions */
73 extern device_t alloc_dev(struct bus *parent, struct device_path *path);
74 extern void dev_enumerate(void);
75 extern void dev_configure(void);
76 extern void dev_enable(void);
77 extern void dev_initialize(void);
78
79 /* Generic device helper functions */
80 extern void compute_allocate_resource(struct bus *bus, struct resource *bridge,
81         unsigned long type_mask, unsigned long type);
82 extern void assign_resources(struct bus *bus);
83 extern void enable_resources(struct device *dev);
84 extern void enumerate_static_device(void);
85 extern const char *dev_path(device_t dev);
86 extern void compact_resources(device_t dev);
87 extern struct resource *get_resource(device_t dev, unsigned index);
88
89 /* Helper functions */
90 device_t alloc_find_dev(struct bus *parent, struct device_path *path);
91 device_t dev_find_device (unsigned int vendor, unsigned int device, device_t from);
92 device_t dev_find_class (unsigned int class, device_t from);
93 device_t dev_find_slot (unsigned int bus, unsigned int devfn);
94
95 /* Rounding for boundaries. 
96  * Due to some chip bugs, go ahead and roung IO to 16
97  */
98 #define DEVICE_IO_ALIGN 16 
99 #define DEVICE_MEM_ALIGN 4096
100
101 struct device_operations default_dev_ops_root;
102 extern void root_dev_read_resources(device_t dev);
103 extern void root_dev_set_resources(device_t dev);
104 extern unsigned int walk_static_devices(device_t bus, unsigned int max);
105 extern void enable_childrens_resources(device_t dev);
106 extern unsigned int root_dev_scan_pci_bus(device_t root, unsigned int max);
107
108 #endif /* DEVICE_H */