update comment according to the new DOM
[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
9 struct device;
10 typedef struct device * device_t;
11 struct pci_operations;
12 struct pci_bus_operations;
13 struct smbus_bus_operations;
14
15 /* Chip operations */
16 struct chip_operations {
17         void (*enable_dev)(struct device *dev);
18 #if CONFIG_CHIP_NAME == 1
19         char *name;
20 #endif
21 };
22
23 #if CONFIG_CHIP_NAME == 1
24 #define CHIP_NAME(X) .name = X,
25 #else
26 #define CHIP_NAME(X)
27 #endif
28
29 struct device_operations {
30         void (*read_resources)(device_t dev);
31         void (*set_resources)(device_t dev);
32         void (*enable_resources)(device_t dev);
33         void (*init)(device_t dev);
34         unsigned int (*scan_bus)(device_t bus, unsigned int max);
35         void (*enable)(device_t dev);
36         const struct pci_operations *ops_pci;
37         const struct smbus_bus_operations *ops_smbus_bus;
38         const struct pci_bus_operations *ops_pci_bus;
39 };
40
41
42 struct bus {
43         device_t        dev;            /* This bridge device */
44         device_t        children;       /* devices behind this bridge */
45         unsigned        bridge_ctrl;    /* Bridge control register */
46         unsigned char   link;           /* The index of this link */
47         unsigned char   secondary;      /* secondary bus number */
48         unsigned char   subordinate;    /* max subordinate bus number */
49         unsigned char   cap;            /* PCi capability offset */
50 };
51
52 #define MAX_RESOURCES 12
53 #define MAX_LINKS     4
54 /*
55  * There is one device structure for each slot-number/function-number
56  * combination:
57  */
58
59 struct device {
60         struct bus *    bus;            /* bus this device is on, for bridge
61                                          * devices, it is the up stream bus */
62         device_t        sibling;        /* next device on this bus */
63         device_t        next;           /* chain of all devices */
64
65         struct device_path path;
66         unsigned        vendor;
67         unsigned        device;
68         unsigned int    class;          /* 3 bytes: (base,sub,prog-if) */
69         unsigned int    hdr_type;       /* PCI header type */
70         unsigned int    enabled : 1;    /* set if we should enable the device */
71         unsigned int    initialized : 1; /* set if we have initialized the device */
72         unsigned int    have_resources : 1; /* Set if we have read the devices resources */
73         unsigned int    on_mainboard : 1;
74
75         uint8_t command;
76
77         /* Base registers for this device, can be adjusted by
78          * pcibios_fixup() as necessary.
79          */
80         struct resource resource[MAX_RESOURCES];
81         unsigned int resources;
82
83         /* link are (down sream) buses attached to the device, usually a leaf
84          * device with no child have 0 bus attached and a bridge has 1 bus */
85         struct bus link[MAX_LINKS];
86         /* number of buses attached to the device */
87         unsigned int links;
88
89         unsigned long rom_address;
90         struct device_operations *ops;
91         struct chip_operations *chip_ops;
92         void *chip_info;
93 };
94
95 extern struct device    dev_root;       /* root bus */
96 extern struct device    *all_devices;   /* list of all devices */
97
98
99 /* Generic device interface functions */
100 extern device_t alloc_dev(struct bus *parent, struct device_path *path);
101 extern void dev_enumerate(void);
102 extern void dev_configure(void);
103 extern void dev_enable(void);
104 extern void dev_initialize(void);
105
106 /* Generic device helper functions */
107 extern void compute_allocate_resource(struct bus *bus, struct resource *bridge,
108         unsigned long type_mask, unsigned long type);
109 extern void assign_resources(struct bus *bus);
110 extern void enable_resources(struct device *dev);
111 extern void enumerate_static_device(void);
112 extern void enumerate_static_devices(void);
113 extern const char *dev_path(device_t dev);
114
115 /* Helper functions */
116 device_t find_dev_path(struct bus *parent, struct device_path *path);
117 device_t alloc_find_dev(struct bus *parent, struct device_path *path);
118 device_t dev_find_device (unsigned int vendor, unsigned int device, device_t from);
119 device_t dev_find_class (unsigned int class, device_t from);
120 device_t dev_find_slot (unsigned int bus, unsigned int devfn);
121
122 /* Rounding for boundaries. 
123  * Due to some chip bugs, go ahead and roung IO to 16
124  */
125 #define DEVICE_IO_ALIGN 16 
126 #define DEVICE_MEM_ALIGN 4096
127
128 struct device_operations default_dev_ops_root;
129 extern void root_dev_read_resources(device_t dev);
130 extern void root_dev_set_resources(device_t dev);
131 extern unsigned int scan_static_bus(device_t bus, unsigned int max);
132 extern void enable_childrens_resources(device_t dev);
133 extern void root_dev_enable_resources(device_t dev);
134 extern unsigned int root_dev_scan_bus(device_t root, unsigned int max);
135 extern void root_dev_init(device_t dev);
136
137 #endif /* DEVICE_H */