- added most slk functions
[gpxe.git] / src / drivers / bus / isa.c
1 #include "string.h"
2 #include "console.h"
3 #include "config/isa.h"
4 #include "isa.h"
5
6 /*
7  * isa.c implements a "classical" port-scanning method of ISA device
8  * detection.  The driver must provide a list of probe addresses
9  * (probe_addrs), together with a function (probe_addr) that can be
10  * used to test for the physical presence of a device at any given
11  * address.
12  *
13  * Note that this should probably be considered the "last resort" for
14  * device probing.  If the card supports ISAPnP or EISA, use that
15  * instead.  Some cards (e.g. the 3c509) implement a proprietary
16  * ISAPnP-like mechanism.
17  *
18  * The ISA probe address list can be overridden by config.h; if the
19  * user specifies ISA_PROBE_ADDRS then that list will be used first.
20  * (If ISA_PROBE_ONLY is defined, the driver's own list will never be
21  * used).
22  */
23
24 /*
25  * User-supplied probe address list
26  *
27  */
28 static isa_probe_addr_t isa_extra_probe_addrs[] = {
29 #ifdef ISA_PROBE_ADDRS
30         ISA_PROBE_ADDRS
31 #endif
32 };
33 #define isa_extra_probe_addr_count \
34      ( sizeof ( isa_extra_probe_addrs ) / sizeof ( isa_extra_probe_addrs[0] ) )
35
36 #ifdef ISA_PROBE_ONLY
37 #define ISA_PROBE_ADDR_COUNT(driver) ( isa_extra_probe_addr_count )
38 #else
39 #define ISA_PROBE_ADDR_COUNT(driver) \
40         ( isa_extra_probe_addr_count + (driver)->addr_count )
41 #endif
42
43 /*
44  * Symbols defined by linker
45  *
46  */
47 static struct isa_driver isa_drivers[0] __table_start ( isa_driver );
48 static struct isa_driver isa_drivers_end[0] __table_end ( isa_driver );
49
50 /*
51  * Increment a bus_loc structure to the next possible ISA location.
52  * Leave the structure zeroed and return 0 if there are no more valid
53  * locations.
54  *
55  * There is no sensible concept of a device location on an ISA bus, so
56  * we use the probe address list for each ISA driver to define the
57  * list of ISA locations.
58  *
59  */
60 static int isa_next_location ( struct bus_loc *bus_loc ) {
61         struct isa_loc *isa_loc = ( struct isa_loc * ) bus_loc;
62         struct isa_driver *driver;
63
64         /*
65          * Ensure that there is sufficient space in the shared bus
66          * structures for a struct isa_loc and a struct
67          * isa_dev, as mandated by bus.h.
68          *
69          */
70         BUS_LOC_CHECK ( struct isa_loc );
71         BUS_DEV_CHECK ( struct isa_device );
72
73         /* Move to next probe address within this driver */
74         driver = &isa_drivers[isa_loc->driver];
75         if ( ++isa_loc->probe_idx < ISA_PROBE_ADDR_COUNT ( driver ) )
76                 return 1;
77
78         /* Move to next driver */
79         isa_loc->probe_idx = 0;
80         if ( ( ++isa_loc->driver, ++driver ) < isa_drivers_end )
81                 return 1;
82
83         isa_loc->driver = 0;
84         return 0;
85 }
86
87 /*
88  * Fill in parameters (vendor & device ids, class, membase etc.) for
89  * an ISA device based on bus_loc.
90  *
91  * Returns 1 if a device was found, 0 for no device present.
92  *
93  */
94 static int isa_fill_device ( struct bus_dev *bus_dev,
95                              struct bus_loc *bus_loc ) {
96         struct isa_loc *isa_loc = ( struct isa_loc * ) bus_loc;
97         struct isa_device *isa = ( struct isa_device * ) bus_dev;
98         signed int driver_probe_idx;
99         
100         /* Fill in struct isa from struct isa_loc */
101         isa->driver = &isa_drivers[isa_loc->driver];
102         driver_probe_idx = isa_loc->probe_idx - isa_extra_probe_addr_count;
103         if ( driver_probe_idx < 0 ) {
104                 isa->ioaddr = isa_extra_probe_addrs[isa_loc->probe_idx];
105         } else {
106                 isa->ioaddr = isa->driver->probe_addrs[driver_probe_idx];
107         }
108
109         /* Call driver's probe_addr method to determine if a device is
110          * physically present
111          */
112         if ( isa->driver->probe_addr ( isa->ioaddr ) ) {
113                 isa->name = isa->driver->name;
114                 isa->mfg_id = isa->driver->mfg_id;
115                 isa->prod_id = isa->driver->prod_id;
116                 DBG ( "ISA found %s device at address %hx\n",
117                       isa->name, isa->ioaddr );
118                 return 1;
119         }
120
121         return 0;
122 }
123
124 /*
125  * Test whether or not a driver is capable of driving the specified
126  * device.
127  *
128  */
129 int isa_check_driver ( struct bus_dev *bus_dev,
130                        struct device_driver *device_driver ) {
131         struct isa_device *isa = ( struct isa_device * ) bus_dev;
132         struct isa_driver *driver
133                 = ( struct isa_driver * ) device_driver->bus_driver_info;
134
135         return ( driver == isa->driver );
136 }
137
138 /*
139  * Describe a ISA device
140  *
141  */
142 static char * isa_describe_device ( struct bus_dev *bus_dev ) {
143         struct isa_device *isa = ( struct isa_device * ) bus_dev;
144         static char isa_description[] = "ISA 0000 (00)";
145
146         sprintf ( isa_description + 4, "%hx (%hhx)", isa->ioaddr,
147                   isa->driver - isa_drivers );
148         return isa_description;
149 }
150
151 /*
152  * Name a ISA device
153  *
154  */
155 static const char * isa_name_device ( struct bus_dev *bus_dev ) {
156         struct isa_device *isa = ( struct isa_device * ) bus_dev;
157         
158         return isa->name;
159 }
160
161 /*
162  * ISA bus operations table
163  *
164  */
165 struct bus_driver isa_driver __bus_driver = {
166         .name                   = "ISA",
167         .next_location          = isa_next_location,
168         .fill_device            = isa_fill_device,
169         .check_driver           = isa_check_driver,
170         .describe_device        = isa_describe_device,
171         .name_device            = isa_name_device,
172 };
173
174 /*
175  * Fill in a nic structure
176  *
177  */
178 void isa_fill_nic ( struct nic *nic, struct isa_device *isa ) {
179
180         /* Fill in ioaddr and irqno */
181         nic->ioaddr = isa->ioaddr;
182         nic->irqno = 0;
183
184         /* Fill in DHCP device ID structure */
185         nic->dhcp_dev_id.bus_type = ISA_BUS_TYPE;
186         nic->dhcp_dev_id.vendor_id = htons ( isa->mfg_id );
187         nic->dhcp_dev_id.device_id = htons ( isa->prod_id );
188 }