[pxeprefix] Add .kkpxe image type and ability to return via PXE stack
[people/lynusvaz/gpxe.git] / src / arch / i386 / drivers / net / undionly.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 <gpxe/device.h>
23 #include <gpxe/init.h>
24 #include <undi.h>
25 #include <undinet.h>
26 #include <undipreload.h>
27
28 /** @file
29  *
30  * "Pure" UNDI driver
31  *
32  * This is the UNDI driver without explicit support for PCI or any
33  * other bus type.  It is capable only of using the preloaded UNDI
34  * device.  It must not be combined in an image with any other
35  * drivers.
36  *
37  * If you want a PXE-loadable image that contains only the UNDI
38  * driver, build "bin/undionly.kpxe".
39  *
40  * If you want any other image format, or any other drivers in
41  * addition to the UNDI driver, build e.g. "bin/undi.dsk".
42  */
43
44 /**
45  * Probe UNDI root bus
46  *
47  * @v rootdev           UNDI bus root device
48  *
49  * Scans the UNDI bus for devices and registers all devices it can
50  * find.
51  */
52 static int undibus_probe ( struct root_device *rootdev ) {
53         struct undi_device *undi = &preloaded_undi;
54         int rc;
55
56         /* Check for a valie preloaded UNDI device */
57         if ( ! undi->entry.segment ) {
58                 DBG ( "No preloaded UNDI device found!\n" );
59                 return -ENODEV;
60         }
61
62         /* Add to device hierarchy */
63         strncpy ( undi->dev.name, "UNDI",
64                   ( sizeof ( undi->dev.name ) - 1 ) );
65         if ( undi->pci_busdevfn != UNDI_NO_PCI_BUSDEVFN ) {
66                 undi->dev.desc.bus_type = BUS_TYPE_PCI;
67                 undi->dev.desc.location = undi->pci_busdevfn;
68                 undi->dev.desc.vendor = undi->pci_vendor;
69                 undi->dev.desc.device = undi->pci_device;
70         } else if ( undi->isapnp_csn != UNDI_NO_ISAPNP_CSN ) {
71                 undi->dev.desc.bus_type = BUS_TYPE_ISAPNP;
72         }
73         undi->dev.parent = &rootdev->dev;
74         list_add ( &undi->dev.siblings, &rootdev->dev.children);
75         INIT_LIST_HEAD ( &undi->dev.children );
76
77         /* Create network device */
78         if ( ( rc = undinet_probe ( undi ) ) != 0 )
79                 goto err;
80
81         return 0;
82
83  err:
84         list_del ( &undi->dev.siblings );
85         return rc;
86 }
87
88 /**
89  * Remove UNDI root bus
90  *
91  * @v rootdev           UNDI bus root device
92  */
93 static void undibus_remove ( struct root_device *rootdev __unused ) {
94         struct undi_device *undi = &preloaded_undi;
95
96         undinet_remove ( undi );
97         list_del ( &undi->dev.siblings );
98 }
99
100 /** UNDI bus root device driver */
101 static struct root_driver undi_root_driver = {
102         .probe = undibus_probe,
103         .remove = undibus_remove,
104 };
105
106 /** UNDI bus root device */
107 struct root_device undi_root_device __root_device = {
108         .dev = { .name = "UNDI" },
109         .driver = &undi_root_driver,
110 };
111
112 /**
113  * Prepare for exit
114  *
115  * @v flags             Shutdown flags
116  */
117 static void undionly_shutdown ( int flags ) {
118         /* If we are shutting down to boot an OS, clear the "keep PXE
119          * stack" flag.
120          */
121         if ( flags & SHUTDOWN_BOOT )
122                 preloaded_undi.flags &= ~UNDI_FL_KEEP_ALL;
123 }
124
125 struct startup_fn startup_undionly __startup_fn ( STARTUP_LATE ) = {
126         .shutdown = undionly_shutdown,
127 };