6731a9fdb07739a82cc807fd2921f31e12fba499
[people/xl0/gpxe.git] / src / interface / pxe / pxe.c
1 /** @file
2  *
3  * 
4  *
5  */
6
7 /*
8  * Copyright (C) 2004 Michael Brown <mbrown@fensystems.co.uk>.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License as
12  * published by the Free Software Foundation; either version 2 of the
13  * License, or any later version.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  */
24
25 #include "dev.h"
26 #include "pxe.h"
27
28 #if 0
29
30 /* Global pointer to currently installed PXE stack */
31 pxe_stack_t *pxe_stack = NULL;
32
33 /* Various startup/shutdown routines.  The startup/shutdown call
34  * sequence is incredibly badly defined in the Intel PXE spec, for
35  * example:
36  *
37  *   PXENV_UNDI_INITIALIZE says that the parameters used to initialize
38  *   the adaptor should be those supplied to the most recent
39  *   PXENV_UNDI_STARTUP call.  PXENV_UNDI_STARTUP takes no parameters.
40  *
41  *   PXENV_UNDI_CLEANUP says that the rest of the API will not be
42  *   available after making this call.  Figure 3-3 ("Early UNDI API
43  *   usage") shows a call to PXENV_UNDI_CLEANUP being followed by a
44  *   call to the supposedly now unavailable PXENV_STOP_UNDI.
45  *
46  *   PXENV_UNLOAD_BASE_STACK talks about freeing up the memory
47  *   occupied by the PXE stack.  Figure 4-3 ("PXE IPL") shows a call
48  *   to PXENV_STOP_UNDI being made after the call to
49  *   PXENV_UNLOAD_BASE_STACK, by which time the entire PXE stack
50  *   should have been freed (and, potentially, zeroed).
51  *
52  *   Nothing, anywhere, seems to mention who's responsible for freeing
53  *   up the base memory allocated for the stack segment.  It's not
54  *   even clear whether or not this is expected to be in free base
55  *   memory rather than claimed base memory.
56  *
57  * Consequently, we adopt a rather defensive strategy, designed to
58  * work with any conceivable sequence of initialisation or shutdown
59  * calls.  We have only two things that we care about:
60  *
61  *   1. Have we hooked INT 1A and INT 15,E820(etc.)?
62  *   2. Is the NIC initialised?
63  *
64  * The NIC should never be initialised without the vectors being
65  * hooked, similarly the vectors should never be unhooked with the NIC
66  * still initialised.  We do, however, want to be able to have the
67  * vectors hooked with the NIC shutdown.  We therefore have three
68  * possible states:
69  *
70  *   1. Ready to unload: interrupts unhooked, NIC shutdown.
71  *   2. Midway: interrupts hooked, NIC shutdown.
72  *   3. Fully ready: interrupts hooked, NIC initialised.
73  *
74  * We provide the three states CAN_UNLOAD, MIDWAY and READY to define
75  * these, and the call pxe_ensure_state() to ensure that the stack is
76  * in the specified state.  All our PXE API call implementations
77  * should use this call to ensure that the state is as required for
78  * that PXE API call.  This enables us to cope with whatever the
79  * end-user's interpretation of the PXE spec may be.  It even allows
80  * for someone calling e.g. PXENV_START_UNDI followed by
81  * PXENV_UDP_WRITE, without bothering with any of the intervening
82  * calls.
83  *
84  * pxe_ensure_state() returns 1 for success, 0 for failure.  In the
85  * event of failure (which can arise from e.g. asking for state READY
86  * when we don't know where our NIC is), the error code
87  * PXENV_STATUS_UNDI_INVALID_STATE should be returned to the user.
88  * The macros ENSURE_XXX() can be used to achieve this without lots of
89  * duplicated code.
90  */
91
92 /* pxe_[un]hook_stack are architecture-specific and provided in
93  * pxe_callbacks.c
94  */
95
96 int pxe_initialise_nic ( void ) {
97         if ( pxe_stack->state >= READY ) return 1;
98
99 #warning "device probing mechanism has completely changed"
100 #if 0
101
102         /* Check if NIC is initialised.  dev.disable is set to 0
103          * when disable() is called, so we use this.
104          */
105         if ( dev.disable ) {
106                 /* NIC may have been initialised independently
107                  * (e.g. when we set up the stack prior to calling the
108                  * NBP).
109                  */
110                 pxe_stack->state = READY;
111                 return 1;
112         }
113
114         /* If we already have a NIC defined, reuse that one with
115          * PROBE_AWAKE.  If one was specifed via PXENV_START_UNDI, try
116          * that one first.  Otherwise, set PROBE_FIRST.
117          */
118
119         if ( dev.state.pci.dev.use_specified == 1 ) {
120                 dev.how_probe = PROBE_NEXT;
121                 DBG ( " initialising NIC specified via START_UNDI" );
122         } else if ( dev.state.pci.dev.driver ) {
123                 DBG ( " reinitialising NIC" );
124                 dev.how_probe = PROBE_AWAKE;
125         } else {
126                 DBG ( " probing for any NIC" );
127                 dev.how_probe = PROBE_FIRST;
128         }
129
130         /* Call probe routine to bring up the NIC */
131         if ( eth_probe ( &dev ) != PROBE_WORKED ) {
132                 DBG ( " failed" );
133                 return 0;
134         }
135 #endif
136         
137
138         pxe_stack->state = READY;
139         return 1;
140 }
141
142 int pxe_shutdown_nic ( void ) {
143         if ( pxe_stack->state <= MIDWAY ) return 1;
144
145         eth_irq ( DISABLE );
146         disable ( &dev );
147         pxe_stack->state = MIDWAY;
148         return 1;
149 }
150
151 int ensure_pxe_state ( pxe_stack_state_t wanted ) {
152         int success = 1;
153
154         if ( ! pxe_stack ) return 0;
155         if ( wanted >= MIDWAY )
156                 success = success & hook_pxe_stack();
157         if ( wanted > MIDWAY ) {
158                 success = success & pxe_initialise_nic();
159         } else {
160                 success = success & pxe_shutdown_nic();
161         }
162         if ( wanted < MIDWAY )
163                 success = success & unhook_pxe_stack();
164         return success;
165 }
166
167 #endif