Initial import of binutils 2.22 on the new vendor branch
[dragonfly.git] / sys / boot / pc32 / libi386 / pxe.c
1 /*-
2  * Copyright (c) 2000 Alfred Perlstein <alfred@freebsd.org>
3  * Copyright (c) 2000 Paul Saab <ps@freebsd.org>
4  * Copyright (c) 2000 John Baldwin <jhb@freebsd.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD: src/sys/boot/i386/libi386/pxe.c,v 1.20 2003/08/25 23:28:31 obrien Exp $
29  * $DragonFly: src/sys/boot/pc32/libi386/pxe.c,v 1.8 2005/12/10 00:39:48 swildner Exp $
30  */
31
32 #include <sys/param.h>
33 #include <stand.h>
34 #include <string.h>
35 #include <stdarg.h>
36
37 #include <netinet/in_systm.h>
38 #include <netinet/in.h>
39 #include <netinet/udp.h>
40 #include <netinet/ip.h>
41
42 #include <net.h>
43 #include <netif.h>
44 #include <nfsv2.h>
45 #include <iodesc.h>
46
47 #include <bootp.h>
48 #include <bootstrap.h>
49 #include "btxv86.h"
50 #include "pxe.h"
51
52 /*
53  * Allocate the PXE buffers statically instead of sticking grimy fingers into
54  * BTX's private data area.  The scratch buffer is used to send information to
55  * the PXE BIOS, and the data buffer is used to receive data from the PXE BIOS.
56  */
57 #define PXE_BUFFER_SIZE         0x2000
58 #define PXE_TFTP_BUFFER_SIZE    512
59 static char     scratch_buffer[PXE_BUFFER_SIZE];
60 static char     data_buffer[PXE_BUFFER_SIZE];
61
62 static pxenv_t  *pxenv_p = NULL;        /* PXENV+ */
63 static pxe_t    *pxe_p   = NULL;        /* !PXE */
64 static BOOTPLAYER       bootplayer;     /* PXE Cached information. */
65
66 static int      pxe_debug = 0;
67 static int      pxe_sock = -1;
68 static int      pxe_opens = 0;
69
70 void            pxe_enable(void *pxeinfo);
71 static void     (*pxe_call)(int func);
72 static void     pxenv_call(int func);
73 static void     bangpxe_call(int func);
74
75 static int      pxe_init(void);
76 static int      pxe_strategy(void *devdata, int flag, daddr_t dblk,
77                              size_t size, char *buf, size_t *rsize);
78 static int      pxe_open(struct open_file *f, ...);
79 static int      pxe_close(struct open_file *f);
80 static void     pxe_print(int verbose);
81 static void     pxe_cleanup(void);
82 static void     pxe_setnfshandle(char *rootpath);
83
84 static void     pxe_perror(int error);
85 static int      pxe_netif_match(struct netif *nif, void *machdep_hint);
86 static int      pxe_netif_probe(struct netif *nif, void *machdep_hint);
87 static void     pxe_netif_init(struct iodesc *desc, void *machdep_hint);
88 static int      pxe_netif_get(struct iodesc *desc, void *pkt, size_t len,
89                               time_t timeout);
90 static int      pxe_netif_put(struct iodesc *desc, void *pkt, size_t len);
91 static void     pxe_netif_end(struct netif *nif);
92
93 extern struct netif_stats       pxe_st[];
94 extern u_int16_t                __bangpxeseg;
95 extern u_int16_t                __bangpxeoff;
96 extern void                     __bangpxeentry(void);
97 extern u_int16_t                __pxenvseg;
98 extern u_int16_t                __pxenvoff;
99 extern void                     __pxenventry(void);
100
101 struct netif_dif pxe_ifs[] = {
102 /*      dif_unit        dif_nsel        dif_stats       dif_private     */
103         {0,             1,              &pxe_st[0],     0}
104 };
105
106 struct netif_stats pxe_st[NENTS(pxe_ifs)];
107
108 struct netif_driver pxenetif = {
109         "pxenet",
110         pxe_netif_match,
111         pxe_netif_probe,
112         pxe_netif_init,
113         pxe_netif_get,
114         pxe_netif_put,
115         pxe_netif_end,
116         pxe_ifs,
117         NENTS(pxe_ifs)
118 };
119
120 struct netif_driver *netif_drivers[] = {
121         &pxenetif,
122         NULL
123 };
124
125 struct devsw pxedisk = {
126         "pxe", 
127         DEVT_NET,
128         pxe_init,
129         pxe_strategy, 
130         pxe_open, 
131         pxe_close, 
132         noioctl,
133         pxe_print,
134         pxe_cleanup
135 };
136
137 /*
138  * This function is called by the loader to enable PXE support if we
139  * are booted by PXE.  The passed in pointer is a pointer to the
140  * PXENV+ structure.
141  */
142 void
143 pxe_enable(void *pxeinfo)
144 {
145         pxenv_p  = (pxenv_t *)pxeinfo;
146         pxe_p    = (pxe_t *)PTOV(pxenv_p->PXEPtr.segment * 16 +
147                                  pxenv_p->PXEPtr.offset);
148         pxe_call = NULL;
149 }
150
151 /* 
152  * return true if pxe structures are found/initialized,
153  * also figures out our IP information via the pxe cached info struct 
154  */
155 static int
156 pxe_init(void)
157 {
158         t_PXENV_GET_CACHED_INFO *gci_p;
159         int     counter;
160         uint8_t checksum;
161         uint8_t *checkptr;
162         
163         if(pxenv_p == NULL)
164                 return (0);
165
166         /*  look for "PXENV+" */
167         if (bcmp((void *)pxenv_p->Signature, S_SIZE("PXENV+"))) {
168                 pxenv_p = NULL;
169                 return (0);
170         }
171
172         /* make sure the size is something we can handle */
173         if (pxenv_p->Length > sizeof(*pxenv_p)) {
174                 printf("PXENV+ structure too large, ignoring\n");
175                 pxenv_p = NULL;
176                 return (0);
177         }
178             
179         /* 
180          * do byte checksum:
181          * add up each byte in the structure, the total should be 0
182          */
183         checksum = 0;   
184         checkptr = (uint8_t *) pxenv_p;
185         for (counter = 0; counter < pxenv_p->Length; counter++)
186                 checksum += *checkptr++;
187         if (checksum != 0) {
188                 printf("PXENV+ structure failed checksum, ignoring\n");
189                 pxenv_p = NULL;
190                 return (0);
191         }
192
193         
194         /*
195          * PXENV+ passed, so use that if !PXE is not available or
196          * the checksum fails.
197          */
198         pxe_call = pxenv_call;
199         if (pxenv_p->Version >= 0x0200) {
200                 for (;;) {
201                         if (bcmp((void *)pxe_p->Signature, S_SIZE("!PXE"))) {
202                                 pxe_p = NULL;
203                                 break;
204                         }
205                         checksum = 0;
206                         checkptr = (uint8_t *)pxe_p;
207                         for (counter = 0; counter < pxe_p->StructLength;
208                              counter++)
209                                 checksum += *checkptr++;
210                         if (checksum != 0) {
211                                 pxe_p = NULL;
212                                 break;
213                         }
214                         pxe_call = bangpxe_call;
215                         break;
216                 }
217         }
218         
219         printf("\nPXE version %d.%d, real mode entry point ",
220                (uint8_t) (pxenv_p->Version >> 8),
221                (uint8_t) (pxenv_p->Version & 0xFF));
222         if (pxe_call == bangpxe_call)
223                 printf("@%04x:%04x\n",
224                        pxe_p->EntryPointSP.segment,
225                        pxe_p->EntryPointSP.offset);
226         else
227                 printf("@%04x:%04x\n",
228                        pxenv_p->RMEntry.segment, pxenv_p->RMEntry.offset);
229
230         gci_p = (t_PXENV_GET_CACHED_INFO *) scratch_buffer;
231         bzero(gci_p, sizeof(*gci_p));
232         gci_p->PacketType =  PXENV_PACKET_TYPE_BINL_REPLY;
233         pxe_call(PXENV_GET_CACHED_INFO);
234         if (gci_p->Status != 0) {
235                 pxe_perror(gci_p->Status);
236                 pxe_p = NULL;
237                 return (0);
238         }
239         bcopy(PTOV((gci_p->Buffer.segment << 4) + gci_p->Buffer.offset),
240               &bootplayer, gci_p->BufferSize);
241         return (1);
242 }
243
244
245 static int
246 pxe_strategy(void *devdata, int flag, daddr_t dblk, size_t size,
247                 char *buf, size_t *rsize)
248 {
249         return (EIO);
250 }
251
252 static int
253 pxe_open(struct open_file *f, ...)
254 {
255     va_list args;
256     char *devname;              /* Device part of file name (or NULL). */
257     char temp[FNAME_SIZE];
258     int error = 0;
259     int i;
260         
261     va_start(args, f);
262     devname = va_arg(args, char*);
263     va_end(args);
264
265     /* On first open, do netif open, mount, etc. */
266     if (pxe_opens == 0) {
267         /* Find network interface. */
268         if (pxe_sock < 0) {
269             pxe_sock = netif_open(devname);
270             if (pxe_sock < 0) {
271                 printf("pxe_open: netif_open() failed\n");
272                 return (ENXIO);
273             }
274             if (pxe_debug)
275                 printf("pxe_open: netif_open() succeeded\n");
276         }
277         if (rootip.s_addr == 0) {
278                 /*
279                  * Do a bootp/dhcp request to find out where our
280                  * NFS/TFTP server is.  Even if we dont get back
281                  * the proper information, fall back to the server
282                  * which brought us to life and a default rootpath.
283                  */
284                 bootp(pxe_sock, BOOTP_PXE);
285                 if (rootip.s_addr == 0)
286                         rootip.s_addr = bootplayer.sip;
287                 if (!rootpath[1])
288                         strcpy(rootpath, PXENFSROOTPATH);
289
290                 for (i = 0; rootpath[i] != '\0' && i < FNAME_SIZE; i++) {
291                         if (rootpath[i] == ':')
292                                 break;
293                 }
294                 if (i && i != FNAME_SIZE && rootpath[i] == ':') {
295                         rootpath[i++] = '\0';
296                         if (inet_addr(&rootpath[0]) != INADDR_NONE)
297                                 rootip.s_addr = inet_addr(&rootpath[0]);
298                         bcopy(&rootpath[i], &temp[0], strlen(&rootpath[i])+1);
299                         bcopy(&temp[0], &rootpath[0], strlen(&rootpath[i])+1);
300                 }
301                 printf("pxe_open: ip address : %s\n", inet_ntoa(myip));
302                 printf("pxe_open: ip netmask : %s\n", intoa(netmask));
303                 printf("pxe_open: nfs root mount: %s:%s\n", inet_ntoa(rootip), rootpath);
304                 printf("pxe_open: gateway ip:  %s\n", inet_ntoa(gateip));
305
306                 setenv("boot.netif.ip", inet_ntoa(myip), 1);
307                 setenv("boot.netif.netmask", intoa(netmask), 1);
308                 setenv("boot.netif.gateway", inet_ntoa(gateip), 1);
309                 if (bootplayer.Hardware == ETHER_TYPE) {
310                     sprintf(temp, "%6D", bootplayer.CAddr, ":");
311                     setenv("boot.netif.hwaddr", temp, 1);
312                 }
313                 setenv("boot.nfsroot.server", inet_ntoa(rootip), 1);
314                 setenv("boot.nfsroot.path", rootpath, 1);
315         }
316     }
317     pxe_opens++;
318     f->f_devdata = &pxe_sock;
319     return (error);
320 }
321
322 static int
323 pxe_close(struct open_file *f)
324 {
325
326 #ifdef  PXE_DEBUG
327     if (pxe_debug)
328         printf("pxe_close: opens=%d\n", pxe_opens);
329 #endif
330
331     /* On last close, do netif close, etc. */
332     f->f_devdata = NULL;
333     /* Extra close call? */
334     if (pxe_opens <= 0)
335         return (0);
336     pxe_opens--;
337     /* Not last close? */
338     if (pxe_opens > 0)
339         return(0);
340
341     /* get an NFS filehandle for our root filesystem */
342     pxe_setnfshandle(rootpath);
343
344     if (pxe_sock >= 0) {
345
346 #ifdef PXE_DEBUG
347         if (pxe_debug)
348             printf("pxe_close: calling netif_close()\n");
349 #endif
350         netif_close(pxe_sock);
351         pxe_sock = -1;
352     }
353     return (0);
354 }
355
356 static void
357 pxe_print(int verbose)
358 {
359         if (pxe_call != NULL) {
360                 if (*bootplayer.Sname == '\0') {
361                         printf("      "IP_STR":%s\n",
362                                IP_ARGS(htonl(bootplayer.sip)),
363                                bootplayer.bootfile);
364                 } else {
365                         printf("      %s:%s\n", bootplayer.Sname,
366                                bootplayer.bootfile);
367                 }
368         }
369
370         return;
371 }
372
373 static void
374 pxe_cleanup(void)
375 {
376 #ifdef PXE_DEBUG
377         t_PXENV_UNLOAD_STACK *unload_stack_p =
378             (t_PXENV_UNLOAD_STACK *)scratch_buffer;
379         t_PXENV_UNDI_SHUTDOWN *undi_shutdown_p =
380             (t_PXENV_UNDI_SHUTDOWN *)scratch_buffer;
381 #endif
382
383         if (pxe_call == NULL)
384                 return;
385
386         pxe_call(PXENV_UNDI_SHUTDOWN);
387
388 #ifdef PXE_DEBUG
389         if (pxe_debug && undi_shutdown_p->Status != 0)
390                 printf("pxe_cleanup: UNDI_SHUTDOWN failed %x\n",
391                        undi_shutdown_p->Status);
392 #endif
393
394         pxe_call(PXENV_UNLOAD_STACK);
395
396 #ifdef PXE_DEBUG        
397         if (pxe_debug && unload_stack_p->Status != 0)
398                 printf("pxe_cleanup: UNLOAD_STACK failed %x\n",
399                     unload_stack_p->Status);
400 #endif
401 }
402
403 void
404 pxe_perror(int err)
405 {
406         return;
407 }
408
409 /*
410  * Reach inside the libstand NFS code and dig out an NFS handle
411  * for the root filesystem.  If there is no nfs handle but a NFS root
412  * path was dynamically requested (not just as a default), then try
413  * to get the handle.  This occurs if we are compiled for TFTP operation
414  * but still want to pass an NFS root to the kernel.
415  */
416 struct nfs_iodesc {
417         struct  iodesc  *iodesc;
418         off_t   off;
419         u_char  fh[NFS_FHSIZE];
420         /* structure truncated here */
421 };
422 extern struct   nfs_iodesc nfs_root_node;
423
424 static void
425 pxe_setnfshandle(char *rootpath)
426 {
427         int     i;
428         u_char  *fh;
429         char    buf[2 * NFS_FHSIZE + 3], *cp;
430
431         fh = &nfs_root_node.fh[0];
432
433         /*
434          * If no file handle exists but a root path was dynamically
435          * requested, try to get a good handle.
436          */
437         for (i = 0; i < NFS_FHSIZE; ++i) {
438                 if (fh[i])
439                         break;
440         }
441         if (i != NFS_FHSIZE) {
442                 buf[0] = 'X';
443                 cp = &buf[1];
444                 for (i = 0; i < NFS_FHSIZE; i++, cp += 2)
445                         sprintf(cp, "%02x", fh[i]);
446                 sprintf(cp, "X");
447                 setenv("boot.nfsroot.nfshandle", buf, 1);
448         }
449 }
450
451 void
452 pxenv_call(int func)
453 {
454 #ifdef PXE_DEBUG
455         if (pxe_debug)
456                 printf("pxenv_call %x\n", func);
457 #endif
458         
459         bzero(&v86, sizeof(v86));
460         bzero(data_buffer, sizeof(data_buffer));
461
462         __pxenvseg = pxenv_p->RMEntry.segment;
463         __pxenvoff = pxenv_p->RMEntry.offset;
464         
465         v86.ctl  = V86_ADDR | V86_CALLF | V86_FLAGS;
466         v86.es   = VTOPSEG(scratch_buffer);
467         v86.edi  = VTOPOFF(scratch_buffer);
468         v86.addr = (VTOPSEG(__pxenventry) << 16) | VTOPOFF(__pxenventry);
469         v86.ebx  = func;
470         v86int();
471         v86.ctl  = V86_FLAGS;
472 }
473
474 void
475 bangpxe_call(int func)
476 {
477 #ifdef PXE_DEBUG
478         if (pxe_debug)
479                 printf("bangpxe_call %x\n", func);
480 #endif
481         
482         bzero(&v86, sizeof(v86));
483         bzero(data_buffer, sizeof(data_buffer));
484
485         __bangpxeseg = pxe_p->EntryPointSP.segment;
486         __bangpxeoff = pxe_p->EntryPointSP.offset;
487         
488         v86.ctl  = V86_ADDR | V86_CALLF | V86_FLAGS;
489         v86.edx  = VTOPSEG(scratch_buffer);
490         v86.eax  = VTOPOFF(scratch_buffer);
491         v86.addr = (VTOPSEG(__bangpxeentry) << 16) | VTOPOFF(__bangpxeentry);
492         v86.ebx  = func;
493         v86int();
494         v86.ctl  = V86_FLAGS;
495 }
496
497
498 time_t
499 getsecs(void)
500 {
501         time_t n = 0;
502         time(&n);
503         return n;
504 }
505
506 static int
507 pxe_netif_match(struct netif *nif, void *machdep_hint)
508 {
509         return 1;
510 }
511
512
513 static int
514 pxe_netif_probe(struct netif *nif, void *machdep_hint)
515 {
516         t_PXENV_UDP_OPEN *udpopen_p = (t_PXENV_UDP_OPEN *)scratch_buffer;
517
518         if (pxe_call == NULL)
519                 return -1;
520
521         bzero(udpopen_p, sizeof(*udpopen_p));
522         udpopen_p->src_ip = bootplayer.yip;
523         pxe_call(PXENV_UDP_OPEN);
524
525         if (udpopen_p->status != 0) {
526                 printf("pxe_netif_probe: failed %x\n", udpopen_p->status);
527                 return -1;
528         }
529         return 0;
530 }
531
532 static void
533 pxe_netif_end(struct netif *nif)
534 {
535         t_PXENV_UDP_CLOSE *udpclose_p = (t_PXENV_UDP_CLOSE *)scratch_buffer;
536         bzero(udpclose_p, sizeof(*udpclose_p));
537
538         pxe_call(PXENV_UDP_CLOSE);
539         if (udpclose_p->status != 0)
540                 printf("pxe_end failed %x\n", udpclose_p->status);
541 }
542
543 static void
544 pxe_netif_init(struct iodesc *desc, void *machdep_hint)
545 {
546         int i;
547         for (i = 0; i < 6; ++i)
548                 desc->myea[i] = bootplayer.CAddr[i];
549         desc->xid = bootplayer.ident;
550 }
551
552 static int
553 pxe_netif_get(struct iodesc *desc, void *pkt, size_t len, time_t timeout)
554 {
555         return len;
556 }
557
558 static int
559 pxe_netif_put(struct iodesc *desc, void *pkt, size_t len)
560 {
561         return len;
562 }
563
564 ssize_t
565 sendudp(struct iodesc *h, void *pkt, size_t len)
566 {
567         t_PXENV_UDP_WRITE *udpwrite_p = (t_PXENV_UDP_WRITE *)scratch_buffer;
568         bzero(udpwrite_p, sizeof(*udpwrite_p));
569         
570         udpwrite_p->ip             = h->destip.s_addr;
571         udpwrite_p->dst_port       = h->destport;
572         udpwrite_p->src_port       = h->myport;
573         udpwrite_p->buffer_size    = len;
574         udpwrite_p->buffer.segment = VTOPSEG(pkt);
575         udpwrite_p->buffer.offset  = VTOPOFF(pkt);
576
577         if (netmask == 0 || SAMENET(myip, h->destip, netmask))
578                 udpwrite_p->gw = 0;
579         else
580                 udpwrite_p->gw = gateip.s_addr;
581
582         pxe_call(PXENV_UDP_WRITE);
583
584 #if 0
585         /* XXX - I dont know why we need this. */
586         delay(1000);
587 #endif
588         if (udpwrite_p->status != 0) {
589                 /* XXX: This happens a lot.  It shouldn't. */
590                 if (udpwrite_p->status != 1)
591                         printf("sendudp failed %x\n", udpwrite_p->status);
592                 return -1;
593         }
594         return len;
595 }
596
597 ssize_t
598 readudp(struct iodesc *h, void *pkt, size_t len, time_t timeout)
599 {
600         t_PXENV_UDP_READ *udpread_p = (t_PXENV_UDP_READ *)scratch_buffer;
601         struct udphdr *uh;
602         struct ip *ip;
603         
604         uh = (struct udphdr *) pkt - 1;
605         ip = (struct ip *)uh - 1;
606         bzero(udpread_p, sizeof(*udpread_p));
607         
608         udpread_p->dest_ip        = h->myip.s_addr;
609         udpread_p->d_port         = h->myport;
610         udpread_p->buffer_size    = len;
611         udpread_p->buffer.segment = VTOPSEG(data_buffer);
612         udpread_p->buffer.offset  = VTOPOFF(data_buffer);
613
614         pxe_call(PXENV_UDP_READ);
615
616 #if 0
617         /* XXX - I dont know why we need this. */
618         delay(1000);
619 #endif
620         if (udpread_p->status != 0) {
621                 /* XXX: This happens a lot.  It shouldn't. */
622                 if (udpread_p->status != 1)
623                         printf("readudp failed %x\n", udpread_p->status);
624                 return -1;
625         }
626         bcopy(data_buffer, pkt, udpread_p->buffer_size);
627         uh->uh_sport = udpread_p->s_port;
628         ip->ip_src.s_addr = udpread_p->src_ip;
629         return udpread_p->buffer_size;
630 }