Added PXE bus driver (with support only for using PXE structures found
[people/xl0/gpxe.git] / src / arch / i386 / drivers / bus / pxebus.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdint.h>
20 #include <stdlib.h>
21 #include <string.h>
22 #include <assert.h>
23 #include <pxe.h>
24 #include <realmode.h>
25 #include <gpxe/device.h>
26
27 /** @file
28  *
29  * PXE bus
30  *
31  */
32
33 /**
34  * UNDI parameter block
35  *
36  * Used as the paramter block for all UNDI API calls.  Resides in base
37  * memory.
38  */
39 static union u_PXENV_ANY __data16 ( pxe_params );
40 #define pxe_params __use_data16 ( pxe_params )
41
42 /** UNDI entry point */
43 static SEGOFF16_t __data16 ( pxe_entry_point );
44 #define pxe_entry_point __use_data16 ( pxe_entry_point )
45
46 /**
47  * Issue PXE API call
48  *
49  * @v pxe               PXE device
50  * @v function          API call number
51  * @v params            PXE parameter block
52  * @v params_len        Length of PXE parameter block
53  * @ret rc              Return status code
54  */
55 int pxe_call ( struct pxe_device *pxe, unsigned int function,
56                void *params, size_t params_len ) {
57         union u_PXENV_ANY *pxenv_any = params;
58         PXENV_EXIT_t exit;
59         int discard_b, discard_D;
60         int rc;
61
62         /* Copy parameter block and entry point */
63         assert ( params_len <= sizeof ( pxe_params ) );
64         memcpy ( &pxe_params, params, params_len );
65         pxe_entry_point = pxe->entry;
66
67         /* Call real-mode entry point.  This calling convention will
68          * work with both the !PXE and the PXENV+ entry points.
69          */
70         __asm__ __volatile__ ( REAL_CODE ( "pushw %%es\n\t"
71                                            "pushw %%di\n\t"
72                                            "pushw %%bx\n\t"
73                                            "lcall *%c3\n\t"
74                                            "addw $6, %%sp\n\t" )
75                                : "=a" ( exit ), "=b" ( discard_b ),
76                                  "=D" ( discard_D )
77                                : "p" ( & __from_data16 ( pxe_entry_point ) ),
78                                  "b" ( function ),
79                                  "D" ( & __from_data16 ( pxe_params ) ) );
80
81         /* UNDI API calls may rudely change the status of A20 and not
82          * bother to restore it afterwards.  Intel is known to be
83          * guilty of this.
84          *
85          * Note that we will return to this point even if A20 gets
86          * screwed up by the UNDI driver, because Etherboot always
87          * resides in an even megabyte of RAM.
88          */     
89         gateA20_set();
90
91         /* Copy parameter block back */
92         memcpy ( params, &pxe_params, params_len );
93
94         /* Determine return status code based on PXENV_EXIT and
95          * PXENV_STATUS
96          */
97         if ( exit == PXENV_EXIT_SUCCESS ) {
98                 rc = 0;
99         } else {
100                 rc = -pxenv_any->Status;
101                 /* Paranoia; don't return success for the combination
102                  * of PXENV_EXIT_FAILURE but PXENV_STATUS_SUCCESS
103                  */
104                 if ( rc == 0 )
105                         rc = -EIO;
106         }
107
108         return rc;
109 }
110
111 /**
112  * Byte checksum
113  *
114  * @v data              Data to checksum
115  * @v len               Length of data
116  * @ret sum             Byte checksum
117  */
118 static uint8_t checksum ( void *data, size_t len ) {
119         uint8_t *bytes = data;
120         unsigned int sum = 0;
121
122         while ( len-- )
123                 sum += *(bytes++);
124
125         return sum;
126 }
127
128 /**
129  * Get PXE device information for an instantiated device
130  *
131  * @v pxe               PXE device
132  * @ret rc              Return status code
133  */
134 static int pxedev_get_instance_info ( struct pxe_device *pxe ) {
135         struct s_PXENV pxenv;
136         struct s_PXE ppxe;
137         struct s_PXENV_UNDI_GET_INFORMATION undi_info;
138         int rc;
139
140         /* Determine entry point from PXENV+ structure */
141         DBGC ( pxe, "PXE %p has PXENV+ structure at %04x:%04x\n", pxe,
142               pxe->pxenv.segment, pxe->pxenv.offset );
143         copy_from_real ( &pxenv, pxe->pxenv.segment, pxe->pxenv.offset,
144                          sizeof ( pxenv ) );
145         if ( checksum ( &pxenv, sizeof ( pxenv ) ) != 0 ) {
146                 DBGC ( pxe, "PXE %p bad PXENV+ checksum\n", pxe );
147                 return -EINVAL;
148         }
149         pxe->entry = pxenv.RMEntry;
150
151         /* If API version is 2.1 or greater, use the !PXE structure instead */
152         if ( pxenv.Version >= 0x0201 ) {
153                 pxe->ppxe = pxenv.PXEPtr;
154                 DBGC ( pxe, "PXE %p has !PXE structure at %04x:%04x\n", pxe,
155                        pxe->ppxe.segment, pxe->ppxe.offset );
156                 copy_from_real ( &ppxe, pxe->ppxe.segment, pxe->ppxe.offset,
157                                  sizeof ( ppxe ) );
158                 if ( checksum ( &pxenv, sizeof ( pxenv ) ) != 0 ) {
159                         DBGC ( pxe, "PXE %p bad !PXE checksum\n", pxe );
160                         return -EINVAL;
161                 }
162                 pxe->entry = ppxe.EntryPointSP;
163         }
164
165         DBGC ( pxe, "PXE %p using entry point at %04x:%04x\n", pxe,
166                pxe->entry.segment, pxe->entry.offset );
167
168         /* Get device information */
169         memset ( &undi_info, 0, sizeof ( undi_info ) );
170         if ( ( rc = pxe_call ( pxe, PXENV_UNDI_GET_INFORMATION, &undi_info,
171                                sizeof ( undi_info ) ) ) != 0 ) {
172                 DBGC ( pxe, "PXE %p could not retrieve UNDI information: %s\n",
173                        pxe, strerror ( rc ) );
174                 return rc;
175         }
176         memcpy ( pxe->hwaddr, undi_info.PermNodeAddress,
177                  sizeof ( pxe->hwaddr ) );
178         pxe->irq = undi_info.IntNumber;
179         pxe->rom = undi_info.ROMAddress;
180
181         return 0;
182 }
183
184 /**
185  * Register PXE device
186  *
187  * @v pxe               PXE device
188  * @ret rc              Return status code
189  */
190 static int register_pxedev ( struct pxe_device *pxe ) {
191         int rc;
192
193         DBGC ( pxe, "PXE %p registering\n", pxe );
194
195         /* Register as an UNDI driver */
196         if ( ( rc = undi_probe ( pxe ) ) != 0 )
197                 return rc;
198
199         /* Add to device hierarchy and return */
200         list_add ( &pxe->dev.siblings, &pxe->dev.parent->children );
201         return 0;
202 }
203
204 /**
205  * Unregister a PXE device
206  *
207  * @v pxe               PXE device
208  *
209  */
210 static void unregister_pxedev ( struct pxe_device *pxe ) {
211         undi_remove ( pxe );
212         list_del ( &pxe->dev.siblings );
213         DBGC ( pxe, "PXE %p unregistered\n", pxe );
214 }
215
216 static void pxebus_remove ( struct root_device *rootdev );
217
218 /**
219  * Probe PXE root bus
220  *
221  * @v rootdev           PXE bus root device
222  *
223  * Scans the PXE bus for devices and registers all devices it can
224  * find.
225  */
226 static int pxebus_probe ( struct root_device *rootdev ) {
227         struct pxe_device *pxe;
228         uint16_t signature;
229         uint16_t pxenv_segment;
230         uint16_t pxenv_offset;
231         int rc;
232
233         /* PXE installation check */
234         __asm__ __volatile__ ( REAL_CODE ( "stc\n\t"
235                                            "int $0x1a\n\t"
236                                            "jnc 1f\n\t"
237                                            "xorw %%ax, %%ax\n\t"
238                                            "\n1:\n\t"
239                                            "movw %%es, %%dx\n\t" )
240                                : "=a" ( signature ), "=b" ( pxenv_offset ),
241                                  "=d" ( pxenv_segment )
242                                : "a" ( 0x5650 ) );
243         if ( signature != 0x564e ) {
244                 DBG ( "No pixies found\n" );
245                 return 0;
246         }
247
248         /* Allocate PXE device structure */
249         pxe = malloc ( sizeof ( *pxe ) );
250         if ( ! pxe ) {
251                 rc = -ENOMEM;
252                 goto err;
253         }
254         memset ( pxe, 0, sizeof ( *pxe ) );
255
256         /* Populate PXE device structure */
257         pxe->pxenv.segment = pxenv_segment;
258         pxe->pxenv.offset = pxenv_offset;
259         INIT_LIST_HEAD ( &pxe->dev.children );
260         pxe->dev.parent = &rootdev->dev;
261         if ( ( rc = pxedev_get_instance_info ( pxe ) ) != 0 )
262                 goto err;
263
264         /* Register PXE device */
265         if ( ( rc = register_pxedev ( pxe ) ) != 0 )
266                 goto err;
267
268         return 0;
269
270  err:
271         free ( pxe );
272         pxebus_remove ( rootdev );
273         return rc;
274 }
275
276 /**
277  * Remove PXE root bus
278  *
279  * @v rootdev           PXE bus root device
280  */
281 static void pxebus_remove ( struct root_device *rootdev ) {
282         struct pxe_device *pxe;
283         struct pxe_device *tmp;
284
285         list_for_each_entry_safe ( pxe, tmp, &rootdev->dev.children,
286                                    dev.siblings ) {
287                 unregister_pxedev ( pxe );
288                 free ( pxe );
289         }
290 }
291
292 /** PXE bus root device driver */
293 static struct root_driver pxe_root_driver = {
294         .probe = pxebus_probe,
295         .remove = pxebus_remove,
296 };
297
298 /** PXE bus root device */
299 struct root_device pxe_root_device __root_device = {
300         .name = "PXE",
301         .driver = &pxe_root_driver,
302         .dev = {
303                 .children = LIST_HEAD_INIT ( pxe_root_device.dev.children ),
304         },
305 };