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