david/ipxe
david
/
ipxe
Archived
1
0
Fork 0
Code
This repository has been archived on 2020-12-06. You can view files and clone it, but cannot push or open issues or pull requests.
ipxe/src/config/config.c

353 lines
7.2 KiB
C
Raw Permalink Normal View History

Initial revision
2005-03-08 19:53:11 +01:00
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
[legal] Include full licence text for all GPL2_OR_LATER files Add the standard warranty disclaimer and Free Software Foundation address paragraphs to the licence text where these are not currently present. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2015-02-26 18:49:38 +01:00
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
[legal] Relicense files under GPL2_OR_LATER_OR_UBDL These files cannot be automatically relicensed by util/relicense.pl since they either contain unusual but trivial contributions (such as the addition of __nonnull function attributes), or contain lines dating back to the initial git revision (and so require manual knowledge of the code's origin). Signed-off-by: Michael Brown <mcb30@ipxe.org>
2015-03-02 14:29:46 +01:00
*
* You can also choose to distribute this program under the terms of
* the Unmodified Binary Distribution Licence (as given in the file
* COPYING.UBDL), provided that you have satisfied its requirements.
Initial revision
2005-03-08 19:53:11 +01:00
*/
[legal] Relicense files under GPL2_OR_LATER_OR_UBDL These files cannot be automatically relicensed by util/relicense.pl since they either contain unusual but trivial contributions (such as the addition of __nonnull function attributes), or contain lines dating back to the initial git revision (and so require manual knowledge of the code's origin). Signed-off-by: Michael Brown <mcb30@ipxe.org>
2015-03-02 14:29:46 +01:00
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
[legal] Add a selection of FILE_LICENCE declarations Add FILE_LICENCE declarations to almost all files that make up the various standard builds of gPXE.
2009-05-01 16:41:06 +02:00
[config] Split console configuration out to config/console.h
2008-10-12 03:30:31 +02:00
#include <config/general.h>
#include <config/console.h>
[bofm] Add support for BOFM under EFI Signed-off-by: Michael Brown <mcb30@ipxe.org>
2011-02-17 01:31:38 +01:00
#include <config/sideband.h>
[settings] Add config/settings.h Move VMWARE_SETTINGS build configuration option from config/sideband.h to a new config/settings.h. Existing instances of config/local/sideband.h will not be affected, since config.c still #includes config/sideband.h. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-07-09 17:01:52 +02:00
#include <config/settings.h>
Move RELOCATE into config.h Move ISA probe address logic from config.c into isa.c, create header file config/isa.h.
2005-04-18 13:00:42 +02:00
[linker] Add mechanism for subsystem-dependent configuration options It is often the case that some module of gPXE is only relevant if the subsystem it depends on is already being included. For instance, commands to manage wireless interfaces are quite useless if no compiled-in driver has pulled in the wireless networking stack. There may be a user-modifiable configuration options for these dependent modules, but even if enabled, they should not be included when they would be useless. Solve this by allowing the creation of config_subsystem.c, for configuration directives like those in the global config.c that should only be considered when subsystem.c is included in the final gPXE build. For consistency, move core/config.c to the config/ directory, where the other config_subsystem.c files will eventually reside. Signed-off-by: Marty Connor <mdc@etherboot.org>
2009-08-07 03:52:06 +02:00
/** @file
*
* Configuration options
*
* This file contains macros that pull various objects into the link
* based on definitions in configuration header files. Ideally it
[build] Rename gPXE to iPXE Access to the gpxe.org and etherboot.org domains and associated resources has been revoked by the registrant of the domain. Work around this problem by renaming project from gPXE to iPXE, and updating URLs to match. Also update README, LOG and COPYRIGHTS to remove obsolete information. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2010-04-19 21:16:01 +02:00
* should be the only place in iPXE where one might need to use #ifdef
[linker] Add mechanism for subsystem-dependent configuration options It is often the case that some module of gPXE is only relevant if the subsystem it depends on is already being included. For instance, commands to manage wireless interfaces are quite useless if no compiled-in driver has pulled in the wireless networking stack. There may be a user-modifiable configuration options for these dependent modules, but even if enabled, they should not be included when they would be useless. Solve this by allowing the creation of config_subsystem.c, for configuration directives like those in the global config.c that should only be considered when subsystem.c is included in the final gPXE build. For consistency, move core/config.c to the config/ directory, where the other config_subsystem.c files will eventually reside. Signed-off-by: Marty Connor <mdc@etherboot.org>
2009-08-07 03:52:06 +02:00
* for compile-time options.
*
* In the fairly common case where an object should only be considered
* for inclusion if the subsystem it depends on is present, its
* configuration macros should be placed in a file named
* <tt>config_<i>subsystem</i>.c</tt>, where @e subsystem is the
* object basename of the main source file for that subsystem. The
* build system will pull in that file if @c subsystem.c is included
[build] Rename gPXE to iPXE Access to the gpxe.org and etherboot.org domains and associated resources has been revoked by the registrant of the domain. Work around this problem by renaming project from gPXE to iPXE, and updating URLs to match. Also update README, LOG and COPYRIGHTS to remove obsolete information. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2010-04-19 21:16:01 +02:00
* in the final iPXE executable built.
[linker] Add mechanism for subsystem-dependent configuration options It is often the case that some module of gPXE is only relevant if the subsystem it depends on is already being included. For instance, commands to manage wireless interfaces are quite useless if no compiled-in driver has pulled in the wireless networking stack. There may be a user-modifiable configuration options for these dependent modules, but even if enabled, they should not be included when they would be useless. Solve this by allowing the creation of config_subsystem.c, for configuration directives like those in the global config.c that should only be considered when subsystem.c is included in the final gPXE build. For consistency, move core/config.c to the config/ directory, where the other config_subsystem.c files will eventually reside. Signed-off-by: Marty Connor <mdc@etherboot.org>
2009-08-07 03:52:06 +02:00
*/
[build] Fix the REQUIRE_SYMBOL mechanism At some point in the past few years, binutils became more aggressive at removing unused symbols. To function as a symbol requirement, a relocation record must now be in a section marked with @progbits and must not be in a section which gets discarded during the link (either via --gc-sections or via /DISCARD/). Update REQUIRE_SYMBOL() to generate relocation records meeting these criteria. To minimise the impact upon the final binary size, we use existing symbols (specified via the REQUIRING_SYMBOL() macro) as the relocation targets where possible. We use R_386_NONE or R_X86_64_NONE relocation types to prevent any actual unwanted relocation taking place. Where no suitable symbol exists for REQUIRING_SYMBOL() (such as in config.c), the macro PROVIDE_REQUIRING_SYMBOL() can be used to generate a one-byte-long symbol to act as the relocation target. If there are versions of binutils for which this approach fails, then the fallback will probably involve killing off REQUEST_SYMBOL(), redefining REQUIRE_SYMBOL() to use the current definition of REQUEST_SYMBOL(), and postprocessing the linked ELF file with something along the lines of "nm -u | wc -l" to check that there are no undefined symbols remaining. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2015-03-04 19:48:19 +01:00
PROVIDE_REQUIRING_SYMBOL();
Merged mcb30-realmode-redesign back to HEAD
2005-04-08 17:01:17 +02:00
/*
* Drag in all requested console types
*
*/
Fix BUILD_SERIAL. Change from using #if to #ifdef, since #if can't cope with string constants.
2005-04-18 14:43:18 +02:00
#ifdef CONSOLE_SERIAL
[serial] Use new UART abstraction in serial console driver Signed-off-by: Michael Brown <mcb30@ipxe.org>
2015-06-29 09:43:16 +02:00
REQUIRE_OBJECT ( serial );
Merged mcb30-realmode-redesign back to HEAD
2005-04-08 17:01:17 +02:00
#endif
Fix BUILD_SERIAL. Change from using #if to #ifdef, since #if can't cope with string constants.
2005-04-18 14:43:18 +02:00
#ifdef CONSOLE_DIRECT_VGA
Merged mcb30-realmode-redesign back to HEAD
2005-04-08 17:01:17 +02:00
REQUIRE_OBJECT ( video_subr );
#endif
Fix BUILD_SERIAL. Change from using #if to #ifdef, since #if can't cope with string constants.
2005-04-18 14:43:18 +02:00
#ifdef CONSOLE_PC_KBD
Merged mcb30-realmode-redesign back to HEAD
2005-04-08 17:01:17 +02:00
REQUIRE_OBJECT ( pc_kbd );
#endif
hoffmeis: Preparations for syslog support (LOGSERVER in DHCP, linewise output buffering defintions and the like)
2007-04-09 20:01:43 +02:00
#ifdef CONSOLE_SYSLOG
REQUIRE_OBJECT ( syslog );
#endif
[syslog] Add basic support for encrypted syslog via TLS Encrypted syslog seems not yet to be standardised, but is supported by some existing syslog servers. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-04-10 12:54:31 +02:00
#ifdef CONSOLE_SYSLOGS
REQUIRE_OBJECT ( syslogs );
#endif
[efi] Add EFI image format and basic runtime environment We have EFI APIs for CPU I/O, PCI I/O, timers, console I/O, user access and user memory allocation. EFI executables are created using the vanilla GNU toolchain, with the EXE header handcrafted in assembly and relocations generated by a custom efilink utility.
2008-10-12 02:55:55 +02:00
#ifdef CONSOLE_EFI
REQUIRE_OBJECT ( efi_console );
#endif
[linux] Add console Add linux console using stdin/out. Configure the attached terminal for readline use. Signed-off-by: Piotr Jaroszyński <p.jaroszynski@gmail.com> Signed-off-by: Michael Brown <mcb30@ipxe.org>
2010-04-08 01:40:31 +02:00
#ifdef CONSOLE_LINUX
REQUIRE_OBJECT ( linux_console );
#endif
[vmware] Add VMware logfile console (CONSOLE_VMWARE) Allow iPXE console output to be sent to the VMware logfile via the GuestRPC mechanism. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-02-29 00:09:06 +01:00
#ifdef CONSOLE_VMWARE
REQUIRE_OBJECT ( vmconsole );
#endif
[console] Add support for the bochs/qemu debug port console Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-09-10 16:58:02 +02:00
#ifdef CONSOLE_DEBUGCON
REQUIRE_OBJECT ( debugcon );
#endif
hoffmeis: Preparations for syslog support (LOGSERVER in DHCP, linewise output buffering defintions and the like)
2007-04-09 20:01:43 +02:00
Moved DOWNLOAD_PROTO_XXX options to config.h
2005-05-02 13:13:47 +02:00
/*
[IPv4] Add a config option for IPv4 IPv4 may not always be dragged into the link, so add a specific configuration option for it.
2008-03-21 01:06:28 +01:00
* Drag in all requested network protocols
*
*/
#ifdef NET_PROTO_IPV4
REQUIRE_OBJECT ( ipv4 );
#endif
[ipv6] Replace IPv6 stack Replace the existing partially-implemented IPv6 stack with a fresh implementation. This implementation is not yet complete. The IPv6 transmit and receive datapaths are functional (including fragment reassembly and parsing of arbitrary extension headers). NDP neighbour solicitations and advertisements are supported. ICMPv6 echo is supported. At present, only link-local addresses may be used, and there is no way to specify an IPv6 address as part of a URI (either directly or via a DNS lookup). Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-08-26 15:23:54 +02:00
#ifdef NET_PROTO_IPV6
REQUIRE_OBJECT ( ipv6 );
#endif
[IPv4] Add a config option for IPv4 IPv4 may not always be dragged into the link, so add a specific configuration option for it.
2008-03-21 01:06:28 +01:00
[config] Make PXE stack a compile-time option For extremely tight space requirements and specific applications, it is sometimes desirable to create gPXE images that cannot provide the PXE API functionality to client programs. Add a configuration header option, PXE_STACK, that can be removed to remove this stack. Also add PXE_MENU to control the PXE boot menu, which most uses of gPXE do not need. Signed-off-by: Marty Connor <mdc@etherboot.org>
2009-10-07 01:15:06 +02:00
/*
* Drag in all requested PXE support
*
*/
#ifdef PXE_MENU
REQUIRE_OBJECT ( pxemenu );
#endif
#ifdef PXE_STACK
REQUIRE_OBJECT ( pxe_call );
#endif
[IPv4] Add a config option for IPv4 IPv4 may not always be dragged into the link, so add a specific configuration option for it.
2008-03-21 01:06:28 +01:00
/*
* Drag in all requested download protocols
Moved DOWNLOAD_PROTO_XXX options to config.h
2005-05-02 13:13:47 +02:00
*
*/
#ifdef DOWNLOAD_PROTO_TFTP
REQUIRE_OBJECT ( tftp );
#endif
#ifdef DOWNLOAD_PROTO_HTTP
REQUIRE_OBJECT ( http );
#endif
Allowed HTTPS to be a separately configurable feature.
2007-07-30 04:01:04 +02:00
#ifdef DOWNLOAD_PROTO_HTTPS
REQUIRE_OBJECT ( https );
#endif
Added missing config.[ch] lines for FTP protocol
2007-06-28 19:49:57 +02:00
#ifdef DOWNLOAD_PROTO_FTP
REQUIRE_OBJECT ( ftp );
#endif
[nfs] Add support for NFS protocol Tested-by: Robin Smidsrød <robin@smidsrod.no> Signed-off-by: Marin Hannache <git@mareo.fr> Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-07-15 17:56:29 +02:00
#ifdef DOWNLOAD_PROTO_NFS
REQUIRE_OBJECT ( nfs_open );
#endif
Moved DOWNLOAD_PROTO_XXX options to config.h
2005-05-02 13:13:47 +02:00
#ifdef DOWNLOAD_PROTO_SLAM
REQUIRE_OBJECT ( slam );
#endif
[sanboot] Quick and dirty hack to make SAN boot protocols selectable
2008-10-13 11:05:23 +02:00
/*
* Drag in all requested SAN boot protocols
*
*/
#ifdef SANBOOT_PROTO_ISCSI
[block] Replace gPXE block-device API with an iPXE asynchronous interface The block device interface used in gPXE predates the invention of even the old gPXE data-transfer interface, let alone the current iPXE generic asynchronous interface mechanism. Bring this old code up to date, with the following benefits: o Block device commands can be cancelled by the requestor. The INT 13 layer uses this to provide a global timeout on all INT 13 calls, with the result that an unexpected passive failure mode (such as an iSCSI target ACKing the request but never sending a response) will lead to a timeout that gets reported back to the INT 13 user, rather than simply freezing the system. o INT 13,00 (reset drive) is now able to reset the underlying block device. INT 13 users, such as DOS, that use INT 13,00 as a method for error recovery now have a chance of recovering. o All block device commands are tagged, with a numerical tag that will show up in debugging output and in packet captures; this will allow easier interpretation of bug reports that include both sources of information. o The extremely ugly hacks used to generate the boot firmware tables have been eradicated and replaced with a generic acpi_describe() method (exploiting the ability of iPXE interfaces to pass through methods to an underlying interface). The ACPI tables are now built in a shared data block within .bss16, rather than each requiring dedicated space in .data16. o The architecture-independent concept of a SAN device has been exposed to the iPXE core through the sanboot API, which provides calls to hook, unhook, boot, and describe SAN devices. This allows for much more flexible usage patterns (such as hooking an empty SAN device and then running an OS installer via TFTP). Signed-off-by: Michael Brown <mcb30@ipxe.org>
2010-09-03 17:11:51 +02:00
REQUIRE_OBJECT ( iscsi );
[sanboot] Quick and dirty hack to make SAN boot protocols selectable
2008-10-13 11:05:23 +02:00
#endif
[http] Rewrite HTTP core to support content encodings Rewrite the HTTP core to allow for the addition of arbitrary content encoding mechanisms, such as PeerDist and gzip. The core now exposes http_open() which can be used to create requests with an explicitly selected HTTP method, an optional requested content range, and an optional request body. A simple wrapper provides the preexisting behaviour of creating either a GET request or an application/x-www-form-urlencoded POST request (if the URI includes parameters). The HTTP SAN interface is now implemented using the generic block device translator. Individual blocks are requested using http_open() to create a range request. Server connections are now managed via a connection pool; this allows for multiple requests to the same server (e.g. for SAN blocks) to be completely unaware of each other. Repeated HTTPS connections to the same server can reuse a pooled connection, avoiding the per-connection overhead of establishing a TLS session (which can take several seconds if using a client certificate). Support for HTTP SAN booting and for the Basic and Digest authentication schemes is now optional and can be controlled via the SANBOOT_PROTO_HTTP, HTTP_AUTH_BASIC, and HTTP_AUTH_DIGEST build configuration options in config/general.h. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2015-08-17 14:16:26 +02:00
#ifdef SANBOOT_PROTO_HTTP
REQUIRE_OBJECT ( httpblock );
#endif
[sanboot] Quick and dirty hack to make SAN boot protocols selectable
2008-10-13 11:05:23 +02:00
Added DNS resolver configuration option.
2005-04-30 16:39:21 +02:00
/*
[IPv4] Add a config option for IPv4 IPv4 may not always be dragged into the link, so add a specific configuration option for it.
2008-03-21 01:06:28 +01:00
* Drag in all requested resolvers
Added DNS resolver configuration option.
2005-04-30 16:39:21 +02:00
*
*/
#ifdef DNS_RESOLVER
"dns_resolver" changed to "dns"
2005-04-30 16:49:41 +02:00
REQUIRE_OBJECT ( dns );
Added DNS resolver configuration option.
2005-04-30 16:39:21 +02:00
#endif
Image formats moved into the new config system
2005-05-17 15:33:49 +02:00
/*
* Drag in all requested image formats
*
*/
I prefer IMAGE_XXX to XXX_IMAGE. Add IMAGE_PXE to use the new image format framework. "kernel pxelinux.0" now works.
2007-01-13 18:28:51 +01:00
#ifdef IMAGE_NBI
Image formats moved into the new config system
2005-05-17 15:33:49 +02:00
REQUIRE_OBJECT ( nbi );
#endif
I prefer IMAGE_XXX to XXX_IMAGE. Add IMAGE_PXE to use the new image format framework. "kernel pxelinux.0" now works.
2007-01-13 18:28:51 +01:00
#ifdef IMAGE_ELF
[ELF] Add ability to boot ELF images generated by wraplinux and mkelfImage Delete ELF as a generic image type. The method for invoking an ELF-based image (as well as any tables that must be set up to allow it to boot) will always depend on the specific architecture. core/elf.c now only provides the elf_load() function, to avoid duplicating functionality between ELF-based image types. Add arch/i386/image/elfboot.c, to handle the generic case of 32-bit x86 ELF images. We don't currently set up any multiboot tables, ELF notes, etc. This seems to be sufficient for loading kernels generated using both wraplinux and coreboot's mkelfImage. Note that while Etherboot 5.4 allowed ELF images to return, we don't. There is no callback mechanism for the loaded image to shut down gPXE, which means that we have to shut down before invoking the image. This means that we lose device state, protection against being trampled on, etc. It is not safe to continue afterwards.
2008-06-09 14:11:46 +02:00
REQUIRE_OBJECT ( elfboot );
Image formats moved into the new config system
2005-05-17 15:33:49 +02:00
#endif
I prefer IMAGE_XXX to XXX_IMAGE. Add IMAGE_PXE to use the new image format framework. "kernel pxelinux.0" now works.
2007-01-13 18:28:51 +01:00
#ifdef IMAGE_MULTIBOOT
Image formats moved into the new config system
2005-05-17 15:33:49 +02:00
REQUIRE_OBJECT ( multiboot );
#endif
I prefer IMAGE_XXX to XXX_IMAGE. Add IMAGE_PXE to use the new image format framework. "kernel pxelinux.0" now works.
2007-01-13 18:28:51 +01:00
#ifdef IMAGE_PXE
REQUIRE_OBJECT ( pxe_image );
Image formats moved into the new config system
2005-05-17 15:33:49 +02:00
#endif
I prefer IMAGE_XXX to XXX_IMAGE. Add IMAGE_PXE to use the new image format framework. "kernel pxelinux.0" now works.
2007-01-13 18:28:51 +01:00
#ifdef IMAGE_SCRIPT
Use systematic names for XXX_IMAGE. Add scripts as an image format (since it's trivial to do).
2007-01-12 10:00:48 +01:00
REQUIRE_OBJECT ( script );
#endif
Placeholder bzImage support
2007-01-14 05:27:25 +01:00
#ifdef IMAGE_BZIMAGE
REQUIRE_OBJECT ( bzimage );
#endif
Split bootsector execution code out into bootsector.c. Added basic El Torito ISO image boot capability
2007-01-29 05:21:38 +01:00
#ifdef IMAGE_ELTORITO
REQUIRE_OBJECT ( eltorito );
#endif
[comboot] Add COMBOOT and COM32 support
2008-08-29 00:52:19 +02:00
#ifdef IMAGE_COMBOOT
REQUIRE_OBJECT ( comboot );
REQUIRE_OBJECT ( com32 );
REQUIRE_OBJECT ( comboot_call );
REQUIRE_OBJECT ( com32_call );
REQUIRE_OBJECT ( com32_wrapper );
REQUIRE_OBJECT ( comboot_resolv );
#endif
[efi] Add EFI image format and basic runtime environment We have EFI APIs for CPU I/O, PCI I/O, timers, console I/O, user access and user memory allocation. EFI executables are created using the vanilla GNU toolchain, with the EXE header handcrafted in assembly and relocations generated by a custom efilink utility.
2008-10-12 02:55:55 +02:00
#ifdef IMAGE_EFI
REQUIRE_OBJECT ( efi_image );
#endif
[sdi] Add support for SDI images Add support (disabled by default) for booting .sdi images as used by Windows XP Embedded. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-09-04 02:26:48 +02:00
#ifdef IMAGE_SDI
REQUIRE_OBJECT ( sdi );
#endif
Add NULL_TRAP as a config option
2006-06-11 03:55:43 +02:00
Select required commands via config.h
2006-12-20 01:39:06 +01:00
/*
* Drag in all requested commands
*
*/
Rename "boot" to "autoboot"
2007-01-14 01:06:23 +01:00
#ifdef AUTOBOOT_CMD
REQUIRE_OBJECT ( autoboot_cmd );
Split the (quick hack) boot logic out from main.c to autoboot.c, add a "boot" command to attempt booting from within the command shell, fall back to shell if boot fails for any reason.
2006-12-20 08:04:08 +01:00
#endif
Select required commands via config.h
2006-12-20 01:39:06 +01:00
#ifdef NVO_CMD
REQUIRE_OBJECT ( nvo_cmd );
#endif
Add "config" command to access config UI
2006-12-20 06:37:33 +01:00
#ifdef CONFIG_CMD
REQUIRE_OBJECT ( config_cmd );
#endif
Added network interface management commands
2007-01-10 02:55:07 +01:00
#ifdef IFMGMT_CMD
REQUIRE_OBJECT ( ifmgmt_cmd );
#endif
[iwmgmt] Add wireless management commands and text for common errors Add commands `iwstat' (to list 802.11-specific status information for 802.11 devices) and `iwlist' (to scan for available networks and print a list along with security information). Signed-off-by: Marty Connor <mdc@etherboot.org>
2009-08-08 05:17:50 +02:00
/* IWMGMT_CMD is brought in by net80211.c if requested */
Add "route" command (which currently only displays the routing table; it can't modify it).
2007-01-10 21:51:14 +01:00
#ifdef ROUTE_CMD
REQUIRE_OBJECT ( route_cmd );
#endif
Add basic "fetch" and "imgstat" commands.
2007-01-12 07:05:27 +01:00
#ifdef IMAGE_CMD
REQUIRE_OBJECT ( image_cmd );
#endif
[image] Add the "imgtrust" and "imgverify" commands Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-03-22 14:46:38 +01:00
#ifdef IMAGE_TRUST_CMD
REQUIRE_OBJECT ( image_trust_cmd );
#endif
Add "dhcp" command
2007-01-12 10:53:28 +01:00
#ifdef DHCP_CMD
REQUIRE_OBJECT ( dhcp_cmd );
#endif
[Command] Add "sanboot" command.
2008-03-04 18:59:26 +01:00
#ifdef SANBOOT_CMD
REQUIRE_OBJECT ( sanboot_cmd );
#endif
[menu] Add menu commands Allow iPXE scripts to create menus. For example: #!ipxe menu iSCSI boot demonstration item install Install Fedora to ${root-path} item --default boot Boot from ${root-path} item shell Enter iPXE shell item exit Exit to BIOS choose label && goto ${label} :boot sanboot ${root-path} :install sanhook ${root-path} chain http://${next-server}/fedora.ipxe :shell shell :exit Inspired-by: Robin Smidsrød <robin@smidsrod.no> Tested-by: Robin Smidsrød <robin@smidsrod.no> Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-03-29 01:05:22 +02:00
#ifdef MENU_CMD
REQUIRE_OBJECT ( menu_cmd );
#endif
[login] Add "login" command and UI
2009-02-17 13:01:47 +01:00
#ifdef LOGIN_CMD
REQUIRE_OBJECT ( login_cmd );
#endif
[time] Add the time command Signed-off-by: Michael Brown <mcb30@etherboot.org>
2009-03-04 06:17:06 +01:00
#ifdef TIME_CMD
REQUIRE_OBJECT ( time_cmd );
#endif
[digest] md5sum and sha1sum commands Modified-by: Michael Brown <mcb30@etherboot.org> Signed-off-by: Michael Brown <mcb30@etherboot.org>
2009-03-26 23:04:31 +01:00
#ifdef DIGEST_CMD
REQUIRE_OBJECT ( digest_cmd );
#endif
[pxe] Add startpxe and stoppxe commands These commands can be used to activate or deactivate the PXE API (on a specifiable network interface). This is currently of limited use, since most image formats will call shutdown() before booting the image, meaning that the underlying net device gets shut down during remove_devices() anyway.
2009-06-28 21:50:23 +02:00
#ifdef PXE_CMD
REQUIRE_OBJECT ( pxe_cmd );
#endif
[lotest] Add loopback testing commands Signed-off-by: Michael Brown <mcb30@ipxe.org>
2010-09-20 14:04:17 +02:00
#ifdef LOTEST_CMD
REQUIRE_OBJECT ( lotest_cmd );
#endif
[vlan] Add support for IEEE 802.1Q VLANs Originally-implemented-by: michael-dev@fami-braun.de Signed-off-by: Michael Brown <mcb30@ipxe.org>
2010-11-19 01:23:26 +01:00
#ifdef VLAN_CMD
REQUIRE_OBJECT ( vlan_cmd );
#endif
[cmdline] Add "poweroff" command Modified-by: Michael Brown <mcb30@ipxe.org> Signed-off-by: Marin Hannache <git@mareo.fr> Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-07-13 14:31:15 +02:00
#ifdef POWEROFF_CMD
REQUIRE_OBJECT ( poweroff_cmd );
#endif
[cmdline] Add "reboot" command Signed-off-by: Michael Brown <mcb30@ipxe.org>
2010-12-04 03:51:26 +01:00
#ifdef REBOOT_CMD
REQUIRE_OBJECT ( reboot_cmd );
#endif
[cmdline] Add "cpuid" command Allow x86 CPU feature flags (such as support for 64-bit mode) to be checked using the "cpuid" command. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-06-06 17:08:24 +02:00
#ifdef CPUID_CMD
REQUIRE_OBJECT ( cpuid_cmd );
#endif
[cmdline] Add "sync" command Add "sync" command (loosely based on the Unix "sync"), which will wait for any pending operations to complete. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-06-09 20:00:04 +02:00
#ifdef SYNC_CMD
REQUIRE_OBJECT ( sync_cmd );
#endif
[shell] Enable "shell" command even when BANNER_TIMEOUT is zero Setting BANNER_TIMEOUT to zero removes the only symbol reference to shell.o, causing the "shell" command to become unavailable. Add SHELL_CMD in config/general.h (enabled by default) which will explicitly drag in shell.o regardless of the value of BANNER_TIMEOUT. Reported-by: Julian Brost <julian@0x4a42.net> Signed-off-by: Michael Brown <mcb30@ipxe.org>
2017-08-01 21:25:28 +02:00
#ifdef SHELL_CMD
REQUIRE_OBJECT ( shell );
#endif
[cmdline] Add standalone "nslookup" command Modified-by: Michael Brown <mcb30@ipxe.org> Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-08-30 01:21:33 +02:00
#ifdef NSLOOKUP_CMD
REQUIRE_OBJECT ( nslookup_cmd );
#endif
[cmdline] Add "pciscan" command to allow iteration over PCI devices Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-08-01 17:53:17 +02:00
#ifdef PCI_CMD
REQUIRE_OBJECT ( pci_cmd );
#endif
[cmdline] Add "params" and "param" commands to manage form parameter lists Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-08-13 23:32:45 +02:00
#ifdef PARAM_CMD
REQUIRE_OBJECT ( param_cmd );
#endif
[cmdline] Add "nstat" command Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-09-25 15:35:07 +02:00
#ifdef NEIGHBOUR_CMD
REQUIRE_OBJECT ( neighbour_cmd );
#endif
[cmdline] Add "ping" command Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-10-21 15:20:32 +02:00
#ifdef PING_CMD
REQUIRE_OBJECT ( ping_cmd );
#endif
[cmdline] Add "console" command to configure console Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-11-27 20:43:25 +01:00
#ifdef CONSOLE_CMD
REQUIRE_OBJECT ( console_cmd );
#endif
[cmdline] Add the "ipstat" command Signed-off-by: Michael Brown <mcb30@ipxe.org>
2014-03-02 21:35:13 +01:00
#ifdef IPSTAT_CMD
REQUIRE_OBJECT ( ipstat_cmd );
#endif
[cmdline] Add "profstat" command to display profiling statistics Signed-off-by: Michael Brown <mcb30@ipxe.org>
2014-04-27 20:31:25 +02:00
#ifdef PROFSTAT_CMD
REQUIRE_OBJECT ( profstat_cmd );
#endif
[cmdline] Add "ntp" command Signed-off-by: Michael Brown <mcb30@ipxe.org>
2016-06-13 16:57:16 +02:00
#ifdef NTP_CMD
REQUIRE_OBJECT ( ntp_cmd );
#endif
[cmdline] Add certificate management commands Signed-off-by: Michael Brown <mcb30@ipxe.org>
2016-08-25 16:40:27 +02:00
#ifdef CERT_CMD
REQUIRE_OBJECT ( cert_cmd );
#endif
Select required commands via config.h
2006-12-20 01:39:06 +01:00
Add NULL_TRAP as a config option
2006-06-11 03:55:43 +02:00
/*
* Drag in miscellaneous objects
*
*/
Add gdbsym.c object to help with running gdb-to-qemu
2007-06-30 23:43:31 +02:00
#ifdef NULL_TRAP
Add NULL_TRAP as a config option
2006-06-11 03:55:43 +02:00
REQUIRE_OBJECT ( nulltrap );
#endif
[GDB] Remote debugging over UDP This commit implements GDB over UDP. Using UDP is more complex than serial and has required some restructuring. The GDB stub is now built using one or both of GDBSERIAL and GDBUDP config.h options. To enter the debugger, execute the gPXE shell command: gdbstub <transport> [<options>...] Where <transport> is "serial" or "udp". For "udp", the name of a configured network device is required: gdbstub udp net0 The GDB stub listens on UDP port 43770 by default.
2008-06-11 13:12:46 +02:00
#ifdef GDBSERIAL
[GDB] Add GDB stub for remote debugging See http://etherboot.org/wiki/dev/gdbstub for documentation.
2008-06-04 22:09:59 +02:00
REQUIRE_OBJECT ( gdbidt );
[GDB] Remote debugging over UDP This commit implements GDB over UDP. Using UDP is more complex than serial and has required some restructuring. The GDB stub is now built using one or both of GDBSERIAL and GDBUDP config.h options. To enter the debugger, execute the gPXE shell command: gdbstub <transport> [<options>...] Where <transport> is "serial" or "udp". For "udp", the name of a configured network device is required: gdbstub udp net0 The GDB stub listens on UDP port 43770 by default.
2008-06-11 13:12:46 +02:00
REQUIRE_OBJECT ( gdbserial );
REQUIRE_OBJECT ( gdbstub_cmd );
#endif
#ifdef GDBUDP
REQUIRE_OBJECT ( gdbidt );
REQUIRE_OBJECT ( gdbudp );
REQUIRE_OBJECT ( gdbstub_cmd );
[GDB] Add GDB stub for remote debugging See http://etherboot.org/wiki/dev/gdbstub for documentation.
2008-06-04 22:09:59 +02:00
#endif
[iSCSI] Support Windows Server 2008 direct iSCSI installation Add yet another ugly hack to iscsiboot.c, this time to allow the user to inhibit the shutdown/removal of the iSCSI INT13 device (and the network devices, since they are required for the iSCSI device to function). On the plus side, the fact that shutdown() now takes flags to differentiate between shutdown-for-exit and shutdown-for-boot means that another ugly hack (to allow returning via the PXE stack on BIOSes that have broken INT 18 calls) will be easier. I feel dirty.
2008-07-17 18:45:17 +02:00
/*
* Drag in objects that are always required, but not dragged in via
* symbol dependencies.
*
*/
REQUIRE_OBJECT ( device );
[image] Allow multiple embedded images This patch extends the embedded image feature to allow multiple embedded images instead of just one. gPXE now always boots the first embedded image on startup instead of doing the hardcoded DHCP boot (aka autoboot). Based heavily upon a patch by Stefan Hajnoczi <stefanha@gmail.com>.
2009-02-16 01:28:30 +01:00
REQUIRE_OBJECT ( embedded );
[linux] Add the tap driver Add the tap driver that can be used like: $ ./ipxe.linux --net tap,if=tap0,mac=00:0c:29:c5:39:a1 The if setting is mandatory. Signed-off-by: Piotr Jaroszyński <p.jaroszynski@gmail.com> Signed-off-by: Michael Brown <mcb30@ipxe.org>
2010-05-28 01:09:22 +02:00
/* linux drivers aren't picked up by the parserom utility so drag them in here */
#ifdef DRIVERS_LINUX
REQUIRE_OBJECT ( tap );
#endif
[bofm] Add support for BOFM under EFI Signed-off-by: Michael Brown <mcb30@ipxe.org>
2011-02-17 01:31:38 +01:00
/*
[vmware] Allow settings to be specified in the VMware .vmx file Allow iPXE settings to be specified in the .vmx file via the VMware GuestInfo mechanism. For example: guestinfo.ipxe.filename = "http://boot.ipxe.org/demo/boot.php" guestinfo.ipxe.dns = "192.168.0.1" guestinfo.ipxe.net0.ip = "192.168.0.15" guestinfo.ipxe.net0.netmask = "255.255.255.0" guestinfo.ipxe.net0.gateway = "192.168.0.1" Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-03-01 16:58:08 +01:00
* Drag in relevant sideband entry points
[bofm] Add support for BOFM under EFI Signed-off-by: Michael Brown <mcb30@ipxe.org>
2011-02-17 01:31:38 +01:00
*/
#ifdef CONFIG_BOFM
#ifdef BOFM_EFI
REQUIRE_OBJECT ( efi_bofm );
#endif /* BOFM_EFI */
#endif /* CONFIG_BOFM */
[settings] Add config/settings.h Move VMWARE_SETTINGS build configuration option from config/sideband.h to a new config/settings.h. Existing instances of config/local/sideband.h will not be affected, since config.c still #includes config/sideband.h. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-07-09 17:01:52 +02:00
/*
* Drag in relevant settings sources
*/
[settings] Expose PCI configuration space via settings mechanism Allow values to be read from PCI configuration space using the syntax ${pci/<busdevfn>.<offset>.<length>} where <busdevfn> is the bus:dev.fn address of the PCI device (expressed as a single integer, as returned by ${net0/busloc}), <offset> is the offset within PCI configuration space, and <length> is the length within PCI configuration space. Values are returned in reverse byte order, since PCI configuration space is little-endian by definition. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-07-09 17:03:35 +02:00
#ifdef PCI_SETTINGS
REQUIRE_OBJECT ( pci_settings );
#endif
[vmware] Allow settings to be specified in the VMware .vmx file Allow iPXE settings to be specified in the .vmx file via the VMware GuestInfo mechanism. For example: guestinfo.ipxe.filename = "http://boot.ipxe.org/demo/boot.php" guestinfo.ipxe.dns = "192.168.0.1" guestinfo.ipxe.net0.ip = "192.168.0.15" guestinfo.ipxe.net0.netmask = "255.255.255.0" guestinfo.ipxe.net0.gateway = "192.168.0.1" Signed-off-by: Michael Brown <mcb30@ipxe.org>
2012-03-01 16:58:08 +01:00
#ifdef VMWARE_SETTINGS
REQUIRE_OBJECT ( guestinfo );
[settings] Add config/settings.h Move VMWARE_SETTINGS build configuration option from config/sideband.h to a new config/settings.h. Existing instances of config/local/sideband.h will not be affected, since config.c still #includes config/sideband.h. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-07-09 17:01:52 +02:00
#endif
[settings] Expose CPUID instruction via settings mechanism Allow CPUID values to be read using the syntax ${cpuid/<register>.<function>} For example, ${cpuid/2.0x80000001} will give the value of %ecx after calling CPUID with %eax=0x80000001. Values for <register> are encoded as %eax=0, %ebx=1, %ecx=2, %edx=3. The numeric encoding is more sophisticated than described above, allowing for settings such as the CPU model (obtained by calling CPUID with %eax=0x80000002-0x80000004 inclusive and concatenating the values returned in %eax:%ebx:%ecx:%edx). See the source code for details. The "cpuvendor" and "cpumodel" settings provide easy access to these more complex CPUID settings. This functionality is intended to complement the "cpuid" command, which allows for testing individual CPUID feature bits. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-08-06 20:16:30 +02:00
#ifdef CPUID_SETTINGS
REQUIRE_OBJECT ( cpuid_settings );
#endif
[settings] Expose memory map via settings mechanism Allow memory map entries to be read using the syntax ${memmap/<region>.<properties>.<scale>} where <region> is the index of the memory region, <properties> is a bitmask where bit 0 represents the start address and bit 1 represents the length (allowing the end address to be encoded by having both bits 0 and 1 set), and <scale> is the number of bits by which to shift the result. This allows for several values of interest to be encoded. For example: ${memmap/<region>.1.0:hexraw} # 64-bit start address of <region> ${memmap/<region>.2.0:hexraw} # 64-bit length of <region>, in bytes ${memmap/<region>.3.0:hexraw} # 64-bit end address of <region> ${memmap/<region>.2.10:int32} # Length of <region>, in kB ${memmap/<region>.2.20:int32} # Length of <region>, in MB The numeric encoding is slightly more sophisticated than described here, allowing a single encoding to cover multiple regions. (See the source code for details.) The primary use case for this feature is to provide the total system memory size (in MB) via the "memsize" predefined setting. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2013-08-12 14:42:12 +02:00
#ifdef MEMMAP_SETTINGS
REQUIRE_OBJECT ( memmap_settings );
#endif
[vram] Add "vram" built-in setting to dump video RAM The "vram" setting returns the (Base64-encoded) contents of video RAM, and can be used to capture a screenshot. For example: after running memtest.0 and encountering an error, the output can be captured and sent to a remote server for later diagnosis: #!ipxe chain -a http://server/memtest.0 && goto ok || goto bad :bad params param errno ${errno} param vram ${vram} chain -a http://server/report.php##params :ok Inspired-by: Christian Nilsson <nikize@gmail.com> Originally-implemented-by: Christian Nilsson <nikize@gmail.com> Signed-off-by: Michael Brown <mcb30@ipxe.org>
2015-04-24 17:05:59 +02:00
#ifdef VRAM_SETTINGS
REQUIRE_OBJECT ( vram_settings );
#endif
[acpi] Expose ACPI tables via settings mechanism Allow values to be read from ACPI tables using the syntax ${acpi/<signature>.<index>.0.<offset>.<length>} where <signature> is the ACPI table signature as a 32-bit hexadecimal number (e.g. 0x41504093 for the 'APIC' signature on the MADT), <index> is the index into the array of tables matching this signature, <offset> is the byte offset within the table, and <length> is the field length in bytes. Numeric values are returned in reverse byte order, since ACPI numeric values are usually little-endian. For example: ${acpi/0x41504943.0.0.0.0} - entire MADT table in raw hex ${acpi/0x41504943.0.0.0x0a.6:string} - MADT table OEM ID ${acpi/0x41504943.0.0.0x24.4:uint32} - local APIC address Signed-off-by: Michael Brown <mcb30@ipxe.org>
2017-05-23 16:44:22 +02:00
#ifdef ACPI_SETTINGS
REQUIRE_OBJECT ( acpi_settings );
#endif
[console] Add keyboard map selection The active keyboard map may be selected by editing KEYBOARD_MAP in config/console.h. Signed-off-by: Michael Brown <mcb30@ipxe.org>
2011-03-16 13:01:48 +01:00
/*
* Drag in selected keyboard map
*/
#define REQUIRE_KEYMAP_OBJECT( _map ) REQUIRE_OBJECT ( keymap_ ## _map )
#define REQUIRE_KEYMAP( _map ) REQUIRE_KEYMAP_OBJECT ( _map )
REQUIRE_KEYMAP ( KEYBOARD_MAP );