pxeparent.c File Reference

Call interface to parent PXE stack. More...

#include <gpxe/dhcp.h>
#include <pxeparent.h>
#include <pxe_api.h>
#include <pxe_types.h>
#include <pxe.h>

Go to the source code of this file.

Defines

#define pxeparent_params __use_data16 ( pxeparent_params )

#define pxeparent_entry_point __use_data16 ( pxeparent_entry_point )

Functions

FILE_LICENCE (GPL2_OR_LATER)

static const char * pxeparent_function_name (unsigned int function)

Name PXE API call.

static union u_PXENV_ANY __bss16 (pxeparent_params)

PXE parent parameter block.

SEGOFF16_t __bss16 (pxeparent_entry_point)

PXE parent entry point.

int pxeparent_call (SEGOFF16_t entry, unsigned int function, void *params, size_t params_len)

Issue parent PXE API call.

Detailed Description

Call interface to parent PXE stack.

Definition in file pxeparent.c.

Define Documentation

#define pxeparent_params __use_data16 ( pxeparent_params )

Definition at line 106 of file pxeparent.c.

Referenced by pxeparent_call().

#define pxeparent_entry_point __use_data16 ( pxeparent_entry_point )

Definition at line 114 of file pxeparent.c.

Referenced by pxeparent_call().

Function Documentation

FILE_LICENCE ( GPL2_OR_LATER )

static const char* pxeparent_function_name ( unsigned int function ) [inline, static]

Name PXE API call.

Parameters:

function

API call number

Return values:

name

API call name

Definition at line 40 of file pxeparent.c.

References PXENV_GET_CACHED_INFO, PXENV_START_UNDI, PXENV_STOP_UNDI, PXENV_UNDI_CLEANUP, PXENV_UNDI_CLEAR_STATISTICS, PXENV_UNDI_CLOSE, PXENV_UNDI_FORCE_INTERRUPT, PXENV_UNDI_GET_IFACE_INFO, PXENV_UNDI_GET_INFORMATION, PXENV_UNDI_GET_MCAST_ADDRESS, PXENV_UNDI_GET_NIC_TYPE, PXENV_UNDI_GET_STATISTICS, PXENV_UNDI_INITIALIZE, PXENV_UNDI_INITIATE_DIAGS, PXENV_UNDI_ISR, PXENV_UNDI_OPEN, PXENV_UNDI_RESET_ADAPTER, PXENV_UNDI_SET_MCAST_ADDRESS, PXENV_UNDI_SET_PACKET_FILTER, PXENV_UNDI_SET_STATION_ADDRESS, PXENV_UNDI_SHUTDOWN, PXENV_UNDI_STARTUP, and PXENV_UNDI_TRANSMIT.

Referenced by pxeparent_call().

00040                                                   {
00041         switch ( function ) {
00042         case PXENV_START_UNDI:
00043                 return "PXENV_START_UNDI";
00044         case PXENV_STOP_UNDI:
00045                 return "PXENV_STOP_UNDI";
00046         case PXENV_UNDI_STARTUP:
00047                 return "PXENV_UNDI_STARTUP";
00048         case PXENV_UNDI_CLEANUP:
00049                 return "PXENV_UNDI_CLEANUP";
00050         case PXENV_UNDI_INITIALIZE:
00051                 return "PXENV_UNDI_INITIALIZE";
00052         case PXENV_UNDI_RESET_ADAPTER:
00053                 return "PXENV_UNDI_RESET_ADAPTER";
00054         case PXENV_UNDI_SHUTDOWN:
00055                 return "PXENV_UNDI_SHUTDOWN";
00056         case PXENV_UNDI_OPEN:
00057                 return "PXENV_UNDI_OPEN";
00058         case PXENV_UNDI_CLOSE:
00059                 return "PXENV_UNDI_CLOSE";
00060         case PXENV_UNDI_TRANSMIT:
00061                 return "PXENV_UNDI_TRANSMIT";
00062         case PXENV_UNDI_SET_MCAST_ADDRESS:
00063                 return "PXENV_UNDI_SET_MCAST_ADDRESS";
00064         case PXENV_UNDI_SET_STATION_ADDRESS:
00065                 return "PXENV_UNDI_SET_STATION_ADDRESS";
00066         case PXENV_UNDI_SET_PACKET_FILTER:
00067                 return "PXENV_UNDI_SET_PACKET_FILTER";
00068         case PXENV_UNDI_GET_INFORMATION:
00069                 return "PXENV_UNDI_GET_INFORMATION";
00070         case PXENV_UNDI_GET_STATISTICS:
00071                 return "PXENV_UNDI_GET_STATISTICS";
00072         case PXENV_UNDI_CLEAR_STATISTICS:
00073                 return "PXENV_UNDI_CLEAR_STATISTICS";
00074         case PXENV_UNDI_INITIATE_DIAGS:
00075                 return "PXENV_UNDI_INITIATE_DIAGS";
00076         case PXENV_UNDI_FORCE_INTERRUPT:
00077                 return "PXENV_UNDI_FORCE_INTERRUPT";
00078         case PXENV_UNDI_GET_MCAST_ADDRESS:
00079                 return "PXENV_UNDI_GET_MCAST_ADDRESS";
00080         case PXENV_UNDI_GET_NIC_TYPE:
00081                 return "PXENV_UNDI_GET_NIC_TYPE";
00082         case PXENV_UNDI_GET_IFACE_INFO:
00083                 return "PXENV_UNDI_GET_IFACE_INFO";
00084         /*
00085          * Duplicate case value; this is a bug in the PXE specification.
00086          *
00087          *      case PXENV_UNDI_GET_STATE:
00088          *              return "PXENV_UNDI_GET_STATE";
00089          */
00090         case PXENV_UNDI_ISR:
00091                 return "PXENV_UNDI_ISR";
00092         case PXENV_GET_CACHED_INFO:
00093                 return "PXENV_GET_CACHED_INFO";
00094         default:
00095                 return "UNKNOWN API CALL";
00096         }
00097 }

static union u_PXENV_ANY __bss16 ( pxeparent_params ) [static, write]

PXE parent parameter block.

Used as the paramter block for all parent PXE API calls. Resides in base memory.

SEGOFF16_t __bss16 ( pxeparent_entry_point )

PXE parent entry point.

Used as the indirection vector for all parent PXE API calls. Resides in base memory.

int pxeparent_call	(	SEGOFF16_t	entry,
		unsigned int	function,
		void *	params,
		size_t	params_len
	)

Issue parent PXE API call.

Parameters:

	entry	Parent PXE stack entry point
	function	API call number
	params	PXE parameter block
	params_len	Length of PXE parameter block

Return values:

rc

Return status code

Definition at line 125 of file pxeparent.c.

References __asm__(), __from_data16, assert, DBG, DBG_HDA, EIO, gateA20_set(), memcpy, s_SEGOFF16::offset, PXENV_EXIT_SUCCESS, pxeparent_entry_point, pxeparent_function_name(), pxeparent_params, REAL_CODE, rm_ds, s_SEGOFF16::segment, and strerror().

Referenced by get_cached_dhcpack(), undinet_close(), undinet_open(), undinet_poll(), undinet_probe(), undinet_remove(), and undinet_transmit().

00126                                                        {
00127         PXENV_EXIT_t exit;
00128         int discard_b, discard_D;
00129         int rc;
00130 
00131         /* Copy parameter block and entry point */
00132         assert ( params_len <= sizeof ( pxeparent_params ) );
00133         memcpy ( &pxeparent_params, params, params_len );
00134         memcpy ( &pxeparent_entry_point, &entry, sizeof ( entry ) );
00135 
00136         /* Call real-mode entry point.  This calling convention will
00137          * work with both the !PXE and the PXENV+ entry points.
00138          */
00139         __asm__ __volatile__ ( REAL_CODE ( "pushw %%es\n\t"
00140                                            "pushw %%di\n\t"
00141                                            "pushw %%bx\n\t"
00142                                            "lcall *pxeparent_entry_point\n\t"
00143                                            "addw $6, %%sp\n\t" )
00144                                : "=a" ( exit ), "=b" ( discard_b ),
00145                                  "=D" ( discard_D )
00146                                : "b" ( function ),
00147                                  "D" ( __from_data16 ( &pxeparent_params ) )
00148                                : "ecx", "edx", "esi", "ebp" );
00149 
00150         /* PXE API calls may rudely change the status of A20 and not
00151          * bother to restore it afterwards.  Intel is known to be
00152          * guilty of this.
00153          *
00154          * Note that we will return to this point even if A20 gets
00155          * screwed up by the parent PXE stack, because Etherboot always
00156          * resides in an even megabyte of RAM.
00157          */
00158         gateA20_set();
00159 
00160         /* Determine return status code based on PXENV_EXIT and
00161          * PXENV_STATUS
00162          */
00163         if ( exit == PXENV_EXIT_SUCCESS ) {
00164                 rc = 0;
00165         } else {
00166                 rc = -pxeparent_params.Status;
00167                 /* Paranoia; don't return success for the combination
00168                  * of PXENV_EXIT_FAILURE but PXENV_STATUS_SUCCESS
00169                  */
00170                 if ( rc == 0 )
00171                         rc = -EIO;
00172         }
00173 
00174         /* If anything goes wrong, print as much debug information as
00175          * it's possible to give.
00176          */
00177         if ( rc != 0 ) {
00178                 SEGOFF16_t rm_params = {
00179                         .segment = rm_ds,
00180                         .offset = __from_data16 ( &pxeparent_params ),
00181                 };
00182 
00183                 DBG ( "PXEPARENT %s failed: %s\n",
00184                        pxeparent_function_name ( function ), strerror ( rc ) );
00185                 DBG ( "PXEPARENT parameters at %04x:%04x length "
00186                        "%#02zx, entry point at %04x:%04x\n",
00187                        rm_params.segment, rm_params.offset, params_len,
00188                        pxeparent_entry_point.segment,
00189                        pxeparent_entry_point.offset );
00190                 DBG ( "PXEPARENT parameters provided:\n" );
00191                 DBG_HDA ( rm_params, params, params_len );
00192                 DBG ( "PXEPARENT parameters returned:\n" );
00193                 DBG_HDA ( rm_params, &pxeparent_params, params_len );
00194         }
00195 
00196         /* Copy parameter block back */
00197         memcpy ( params, &pxeparent_params, params_len );
00198 
00199         return rc;
00200 }


Defines
#define	pxeparent_params __use_data16 ( pxeparent_params )
#define	pxeparent_entry_point __use_data16 ( pxeparent_entry_point )
Functions
	FILE_LICENCE (GPL2_OR_LATER)
static const char *	pxeparent_function_name (unsigned int function)
	Name PXE API call.
static union u_PXENV_ANY	__bss16 (pxeparent_params)
	PXE parent parameter block.
SEGOFF16_t	__bss16 (pxeparent_entry_point)
	PXE parent entry point.
int	pxeparent_call (SEGOFF16_t entry, unsigned int function, void *params, size_t params_len)
	Issue parent PXE API call.