535181aa00975e9a6708dd76aeb7006e51110ae6
[people/xl0/gpxe.git] / src / include / dev.h
1 #ifndef DEV_H
2 #define DEV_H
3
4 #include "stdint.h"
5 #include "string.h"
6 #include "buffer.h"
7 #include "dhcp.h" /* for dhcp_dev_id */
8 #include <gpxe/tables.h>
9 #include <assert.h>
10
11 /*
12  * Forward declarations
13  *
14  */
15 struct type_dev;
16 struct type_driver;
17 struct bus_driver;
18 struct bus_dev;
19 struct device_driver;
20
21 /*
22  * When looking at the following data structures, mentally substitute
23  * "<bus>_" in place of "bus_" and everything will become clear.
24  * "struct bus_location" becomes "struct <bus>_location", which means
25  * "the location of a device on a <bus> bus", where <bus> is a
26  * particular type of bus such as "pci" or "isapnp".
27  *
28  */
29
30 /*
31  * A physical device location on a bus.
32  *
33  */
34 #define BUS_LOC_SIZE 8
35 struct bus_loc {
36         char bytes[BUS_LOC_SIZE];
37 };
38
39 /* 
40  * A structure fully describing a physical device on a bus.
41  *
42  */
43 #define BUS_DEV_SIZE 32
44 struct bus_dev {
45         char bytes[BUS_DEV_SIZE];
46 };
47
48 /*
49  * Individual buses will have different sizes for their <bus>_location
50  * and <bus>_device structures.  We need to be able to allocate static
51  * storage that's large enough to contain these structures for any
52  * bus type that's being used in the current binary.
53  *
54  * We can't just create a union of all the various types, because some
55  * may be architecture-dependent (and some are even embedded in
56  * specific drivers, e.g. 3c509), so this would quickly get messy.
57  *
58  * We could use the magic of common symbols.  Each bus could declare a
59  * common symbol with the name "_bus_dev" of the correct size; this
60  * is easily done using code like
61  *      struct pci_device _bus_dev;
62  * The linker would then use the largest size of the "_bus_dev" symbol
63  * in any included object, thus giving us a single _bus_dev symbol of
64  * *exactly* the required size.  However, there's no way to extract
65  * the size of this symbol, either directly as a linker symbol
66  * ("_bus_dev_size = SIZEOF(_bus_dev)"; the linker language just
67  * doesn't provide this construct) or via any linker trickery I can
68  * think of (such as creating a special common symbol section just for
69  * this symbol then using SIZE(section) to read the size of the
70  * section; ld recognises only a single common symbol section called
71  * "COMMON").
72  *
73  * Since there's no way to get the size of the symbol, this
74  * effectively limits us to just one instance of the symbol.  This is
75  * all very well for the simple case of "just boot from any single
76  * device you can", but becomes limiting when you want to do things
77  * like introducing PCMCIA buses (which must instantiate other devices
78  * such as PCMCIA controllers).
79  *
80  * So, we declare the maximum sizes of these constructions to be
81  * compile-time constants.  Each individual bus driver should define
82  * its own struct <bus>_location and struct <bus>_device however it
83  * likes, and can freely cast pointers from struct bus_loc to
84  * struct <bus>_location (and similarly for bus_dev).  To guard
85  * against bounding errors, each bus driver *MUST* use the macros
86  * BUS_LOC_CHECK() and BUS_DEV_CHECK(), as in:
87  *
88  *   BUS_LOC_CHECK ( struct pci_location );
89  *   BUS_DEV_CHECK ( struct pci_device );
90  *
91  * These macros will generate a link-time error if the size of the
92  * <bus> structure exceeds the declared maximum size.
93  *
94  * The macros will generate no binary object code, but must be placed
95  * inside a function (in order to generate syntactically valid C).
96  * The easiest wy to do this is to place them in the
97  * <bus>_next_location() function.
98  *
99  * If anyone can think of a better way of doing this that avoids *ALL*
100  * of the problems described above, please implement it!
101  *
102  */
103
104 #define BUS_LOC_CHECK(datatype)                                       \
105         linker_assert( ( sizeof (datatype) <= sizeof (struct bus_loc) ),  \
106                        __BUS_LOC_SIZE_is_too_small__see_dev_h )
107 #define BUS_DEV_CHECK(datatype)                                       \
108         linker_assert( ( sizeof (datatype) <= sizeof (struct bus_dev) ),    \
109                        __BUS_DEV_SIZE_is_too_small__see_dev_h )
110
111 /*
112  * Bus-level operations.
113  *
114  * int next_location ( struct bus_loc * bus_loc )
115  *
116  *      Increment bus_loc to point to the next possible device on
117  *      the bus (e.g. the next PCI busdevfn, or the next ISAPnP CSN).
118  *      If there are no more valid locations, return 0 and leave
119  *      struct bus_loc zeroed, otherwise return true.
120  *
121  * int fill_device ( struct bus_dev *bus_dev,
122  *                   struct bus_loc *bus_loc )
123  *
124  *      Fill out a bus_dev structure with the parameters for the
125  *      device at bus_loc.  (For example, fill in the PCI vendor
126  *      and device IDs).  Return true if there is a device physically
127  *      present at this location, otherwise 0.
128  *
129  * int check_driver ( struct bus_dev *bus_dev,
130  *                    struct device_driver *device_driver )
131  *
132  *      Test whether or not the specified driver is capable of driving
133  *      the specified device by, for example, comparing the device's
134  *      PCI IDs against the list of PCI IDs claimed by the driver.
135  *
136  * char * describe ( struct bus_dev *bus_dev )
137  *
138  *      Return a text string describing the bus device bus_dev
139  *      (e.g. "PCI 00:01.2")
140  *
141  * char * name ( struct bus_dev *bus_dev )
142  *
143  *      Return a text string describing the bus device bus_dev
144  *      (e.g. "dfe538")
145  *
146  */
147 struct bus_driver {
148         const char *name;
149         int ( *next_location ) ( struct bus_loc *bus_loc );
150         int ( *fill_device ) ( struct bus_dev *bus_dev,
151                                struct bus_loc *bus_loc );
152         int ( *check_driver ) ( struct bus_dev *bus_dev,
153                                 struct device_driver *device_driver );
154         char * ( *describe_device ) ( struct bus_dev *bus_dev );
155         const char * ( *name_device ) ( struct bus_dev *bus_dev );
156 };
157
158 #define __bus_driver __table ( bus_driver, 01 )
159
160 /*
161  * A structure fully describing the bus-independent parts of a
162  * particular type (e.g. nic or disk) of device.
163  *
164  * Unlike struct bus_dev, e can limit ourselves to having no more than
165  * one instance of this data structure.  We therefore place an
166  * instance in each type driver file (e.g. nic.c), and simply use a
167  * pointer to the struct type_dev in the struct dev.
168  *
169  */
170 struct type_dev;
171
172 /*
173  * A type driver (e.g. nic, disk)
174  *
175  */
176 struct type_driver {
177         char *name;
178         struct type_dev *type_dev; /* single instance */
179         char * ( * describe_device ) ( struct type_dev *type_dev );
180         int ( * configure ) ( struct type_dev *type_dev );
181         int ( * load ) ( struct type_dev *type_dev, struct buffer *buffer );
182 };
183
184 #define __type_driver __table ( type_driver, 01 )
185
186 /*
187  * A driver for a device.
188  *
189  */
190 struct device_driver {
191         const char *name;
192         struct type_driver *type_driver;
193         struct bus_driver *bus_driver;
194         struct bus_driver_info *bus_driver_info;
195         int ( * probe ) ( struct type_dev *type_dev,
196                           struct bus_dev *bus_dev );
197         void ( * disable ) ( struct type_dev *type_dev,
198                              struct bus_dev *bus_dev );
199 };
200
201 #define __device_driver __table ( device_driver, 01 )
202
203 #define DRIVER(_name,_type_driver,_bus_driver,_bus_info,                      \
204                _probe,_disable)                                               \
205         struct device_driver device_ ## _bus_info __device_driver = {  \
206                 .name = _name,                                                \
207                 .type_driver = &_type_driver,                                 \
208                 .bus_driver = &_bus_driver,                                   \
209                 .bus_driver_info = ( struct bus_driver_info * ) &_bus_info,   \
210                 .probe = ( int (*) () ) _probe,                               \
211                 .disable = ( void (*) () ) _disable,                          \
212         };
213
214 /*
215  * A bootable device, comprising a physical device on a bus, a driver
216  * for that device, and a type device
217  *
218  */
219 struct dev {
220         struct bus_driver       *bus_driver;
221         struct bus_loc          bus_loc;
222         struct bus_dev          bus_dev;
223         struct device_driver    *device_driver;
224         struct type_driver      *type_driver;
225         struct type_dev         *type_dev;
226 };
227
228 /* The current boot device */
229 extern struct dev dev;
230
231 /*
232  * Functions in dev.c 
233  *
234  */
235 extern void print_drivers ( void );
236 extern int find_any ( struct bus_driver **bus_driver, struct bus_loc *bus_loc,
237                       struct bus_dev *bus_dev, signed int skip );
238 extern int find_by_device ( struct device_driver **device_driver,
239                             struct bus_driver *bus_driver,
240                             struct bus_dev *bus_dev,
241                             signed int skip );
242 extern int find_by_driver ( struct bus_loc *bus_loc, struct bus_dev *bus_dev,
243                             struct device_driver *device_driver,
244                             signed int skip );
245 extern int find_any_with_driver ( struct dev *dev, signed int skip );
246
247 /*
248  * Functions inlined to save space
249  *
250  */
251
252 /* Probe a device */
253 static inline int probe ( struct dev *dev ) {
254         return dev->device_driver->probe ( dev->type_dev, &dev->bus_dev );
255 }
256 /* Disable a device */
257 static inline void disable ( struct dev *dev ) {
258         dev->device_driver->disable ( dev->type_dev, &dev->bus_dev );
259 }
260 /* Set the default boot device */
261 static inline void select_device ( struct dev *dev,
262                                    struct bus_driver *bus_driver,
263                                    struct bus_loc *bus_loc ) {
264         dev->bus_driver = bus_driver;
265         memcpy ( &dev->bus_loc, bus_loc, sizeof ( dev->bus_loc ) );
266 }
267 /* Configure a device */
268 static inline int configure ( struct dev *dev ) {
269         return dev->type_driver->configure ( dev->type_dev );
270 }
271 /* Boot from a device */
272 static inline int load ( struct dev *dev, struct buffer *buffer ) {
273         return dev->type_driver->load ( dev->type_dev, buffer );
274 }
275
276 #endif /* DEV_H */