Ported bnx2 driver from Etherboot 5.4.
[gpxe.git] / src / arch / i386 / drivers / net / undiload.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 <pxe.h>
23 #include <realmode.h>
24 #include <bios.h>
25 #include <pnpbios.h>
26 #include <basemem.h>
27 #include <gpxe/pci.h>
28 #include <undi.h>
29 #include <undirom.h>
30 #include <undiload.h>
31
32 /** @file
33  *
34  * UNDI load/unload
35  *
36  */
37
38 /** Parameter block for calling UNDI loader */
39 static struct s_UNDI_LOADER __data16 ( undi_loader );
40 #define undi_loader __use_data16 ( undi_loader )
41
42 /** UNDI loader entry point */
43 static SEGOFF16_t __data16 ( undi_loader_entry );
44 #define undi_loader_entry __use_data16 ( undi_loader_entry )
45
46 /**
47  * Call UNDI loader to create a pixie
48  *
49  * @v undi              UNDI device
50  * @v undirom           UNDI ROM
51  * @ret rc              Return status code
52  */
53 int undi_load ( struct undi_device *undi, struct undi_rom *undirom ) {
54         struct s_PXE ppxe;
55         unsigned int fbms_seg;
56         uint16_t exit;
57         int rc;
58
59         /* Set up START_UNDI parameters */
60         memset ( &undi_loader, 0, sizeof ( undi_loader ) );
61         undi_loader.AX = undi->pci_busdevfn;
62         undi_loader.BX = undi->isapnp_csn;
63         undi_loader.DX = undi->isapnp_read_port;
64         undi_loader.ES = BIOS_SEG;
65         undi_loader.DI = find_pnp_bios();
66
67         /* Allocate base memory for PXE stack */
68         undi->restore_fbms = get_fbms();
69         fbms_seg = ( undi->restore_fbms << 6 );
70         fbms_seg -= ( ( undirom->code_size + 0x0f ) >> 4 );
71         undi_loader.UNDI_CS = fbms_seg;
72         fbms_seg -= ( ( undirom->data_size + 0x0f ) >> 4 );
73         undi_loader.UNDI_DS = fbms_seg;
74
75         /* Debug info */
76         DBGC ( undi, "UNDI %p loading UNDI ROM %p to CS %04x DS %04x for ",
77                undi, undirom, undi_loader.UNDI_CS, undi_loader.UNDI_DS );
78         if ( undi->pci_busdevfn != UNDI_NO_PCI_BUSDEVFN ) {
79                 unsigned int bus = ( undi->pci_busdevfn >> 8 );
80                 unsigned int devfn = ( undi->pci_busdevfn & 0xff );
81                 DBGC ( undi, "PCI %02x:%02x.%x\n",
82                        bus, PCI_SLOT ( devfn ), PCI_FUNC ( devfn ) );
83         }
84         if ( undi->isapnp_csn != UNDI_NO_ISAPNP_CSN ) {
85                 DBGC ( undi, "ISAPnP(%04x) CSN %04x\n",
86                        undi->isapnp_read_port, undi->isapnp_csn );
87         }
88
89         /* Call loader */
90         undi_loader_entry = undirom->loader_entry;
91         __asm__ __volatile__ ( REAL_CODE ( "pushw %%ds\n\t"
92                                            "pushw %%ax\n\t"
93                                            "lcall *%c2\n\t"
94                                            "addw $4, %%sp\n\t" )
95                                : "=a" ( exit )
96                                : "a" ( & __from_data16 ( undi_loader ) ),
97                                  "p" ( & __from_data16 ( undi_loader_entry ) )
98                                : "ebx", "ecx", "edx", "esi", "edi", "ebp" );
99
100         /* UNDI API calls may rudely change the status of A20 and not
101          * bother to restore it afterwards.  Intel is known to be
102          * guilty of this.
103          *
104          * Note that we will return to this point even if A20 gets
105          * screwed up by the UNDI driver, because Etherboot always
106          * resides in an even megabyte of RAM.
107          */     
108         gateA20_set();
109
110         if ( exit != PXENV_EXIT_SUCCESS ) {
111                 rc = -undi_loader.Status;
112                 if ( rc == 0 ) /* Paranoia */
113                         rc = -EIO;
114                 DBGC ( undi, "UNDI %p loader failed: %s\n",
115                        undi, strerror ( rc ) );
116                 return rc;
117         }
118
119         /* Populate PXE device structure */
120         undi->pxenv = undi_loader.PXENVptr;
121         undi->ppxe = undi_loader.PXEptr;
122         copy_from_real ( &ppxe, undi->ppxe.segment, undi->ppxe.offset,
123                          sizeof ( ppxe ) );
124         undi->entry = ppxe.EntryPointSP;
125         DBGC ( undi, "UNDI %p loaded PXENV+ %04x:%04x !PXE %04x:%04x "
126                "entry %04x:%04x\n", undi, undi->pxenv.segment,
127                undi->pxenv.offset, undi->ppxe.segment, undi->ppxe.offset,
128                undi->entry.segment, undi->entry.offset );
129
130         /* Update free base memory counter */
131         undi->fbms = ( fbms_seg >> 6 );
132         set_fbms ( undi->fbms );
133         DBGC ( undi, "UNDI %p using [%d,%d) kB of base memory\n",
134                undi, undi->fbms, undi->restore_fbms );
135
136         return 0;
137 }
138
139 /**
140  * Unload a pixie
141  *
142  * @v undi              UNDI device
143  * @ret rc              Return status code
144  *
145  * Erases the PXENV+ and !PXE signatures, and frees the used base
146  * memory (if possible).
147  */
148 int undi_unload ( struct undi_device *undi ) {
149         static uint32_t dead = 0xdeaddead;
150
151         DBGC ( undi, "UNDI %p unloading\n", undi );
152
153         /* Erase signatures */
154         if ( undi->pxenv.segment )
155                 put_real ( dead, undi->pxenv.segment, undi->pxenv.offset );
156         if ( undi->ppxe.segment )
157                 put_real ( dead, undi->ppxe.segment, undi->ppxe.offset );
158
159         /* Free base memory, if possible */
160         if ( undi->fbms == get_fbms() ) {
161                 DBGC ( undi, "UNDI %p freeing [%d,%d) kB of base memory\n",
162                        undi, undi->fbms, undi->restore_fbms );
163                 set_fbms ( undi->restore_fbms );
164                 return 0;
165         } else {
166                 DBGC ( undi, "UNDI %p leaking [%d,%d) kB of base memory\n",
167                        undi, undi->fbms, undi->restore_fbms );
168                 return -EBUSY;
169         }
170 }