This is an old revision of the document!


A PCRE internal error occured. This might be caused by a faulty plugin

====== Etherboot User Manual ====== Ken Yap - Markus Gutschke - Version 5.2.2 Copyright (C) 2001,2002,2003 Ken Yap and Markus Gutschke 2003-09-30 Revision History * Revision 5.2.2 2003-09-30 Revised by: KY * Revision 5.2.0 2003-08-11 Revised by: KY This User Manual explains how to install, configure and compile the Etherboot package. The instructions here apply to version 5.2 of Etherboot. ===== About this User Manual ===== ==== Obtaining the most recent version of this document ==== This document and related documents are also kept online at the Etherboot Home Page. This will in general have the latest source distributions and documentation. ==== Feedback ==== Comments on and corrections for this User Manual may be directed to the primary author. ==== Copyrights and Trademarks ==== This manual may be reproduced in whole or in part, without fee, subject to the following restrictions: * The copyright notice above and this permission notice must be preserved complete on all complete or partial copies. * Any translation or derived work must be approved by the author in writing before distribution. * If you distribute this work in part, instructions for obtaining the complete version of this manual must be included, and a means for obtaining a complete version provided. * Small portions may be reproduced as illustrations for reviews or quotes in other works without this permission notice if proper citation is given. Exceptions to these rules may be granted for academic purposes: Write to the author and ask. These restrictions are here to protect us as authors, not to restrict you as learners and educators. * All trademarks mentioned in this document belong to their respective owners. ==== Acknowledgments and Thanks ==== Thanks to Markus Gutschke who wrote the first version of this document, and to all the people who have contributed information and corrections to this document. For a list of people who have contributed substantially to the code, please see the *FIXME* Section called Acknowledgements section. ===== Introduction to Etherboot ===== ==== What is Etherboot? ==== Etherboot is a software package for creating ROM images that can download code over an Ethernet network to be executed on a computer. Many network adapters have a socket where a ROM chip can be installed. Etherboot is code that can be put in such a ROM. Etherboot can also be booted from floppies (mainly for testing purposes but some people have been known to use this all the time) and hard disk, as a [[http://lilo.go.dyndns.org/|LILO]]/[[http://www.zytor.com/syslinux|SYSLINUX]] compatible image, or from a hard disk partition, or via PXE. Etherboot works on the x86, Itanium and Hammer architectures. It has not been ported to other platforms yet. Typically the computer is diskless and the code is Linux or FreeBSD, but these are not the only possibilities. The code uses the DHCP, tftp and NFS Internet Protocols, amongst others. For a rather out of date but short talk/tutorial type introduction to what Etherboot does, see my SLUG talk. ==== License ==== Etherboot is Open Source under the GNU General Public License Version 2 (GPL2). The license conditions can be obtained from the file COPYING in the top directory of the distribution or viewed at [[http://www.gnu.org|www.gnu.org]]. In particular note that if you are distributing binaries generated from Etherboot, such as ROMs or ROM images, you must provide or promise to provide the user with the source. If you have not made private changes to the code, you can do this by pointing the user to the Etherboot home page, noting the release version of course. If you have made private changes to the code, then you must distribute those changes too with binary distributions. The following is not legal advice and you should seek your own legal advice but it is a reasonable interpretation of the GPL with respect to Etherboot and BIOS code. Installing Etherboot, either as an extension BIOS or combined in the BIOS chip is mere aggregation. The GPL does not extend to other works that a GPLed binary is aggregated with on a storage medium. The rationale is this: The BIOS does not need an Etherboot ROM to function and the Etherboot ROM can work equally well with another BIOS implementation. Therefore putting Etherboot either on a ROM chip or in the same chip as the BIOS does not cause the two to become a combined work. Under this interpretation, there is no fear that you have to GPL your BIOS if you ship Etherboot with your BIOS. The GPL applies to the whole package but a few files may be used under other licenses for historical reasons. See the Section called Source copyrights for details. Please support Open Source by joining the community and sharing. See the Etherboot home page for some ways you can help Etherboot. No Warranty or Support: Etherboot comes with NO warranties of any kind. It is hoped that it will be useful to you, but NO responsibility is accepted for any outcome of using it. Etherboot also comes with NO support, although you may get helpful advice from the mailing lists listed on the Etherboot home page. ==== What hardware is supported? ==== See Appendix A for a list of supported NICs. All Etherboot drivers are autoprobing, which means they attempt to detect the hardware addresses at which the card is installed. It's fairly easy to write a driver if you know C and are familiar with Ethernet hardware interfacing. Please read the developer manual if you wish to do so. ==== Getting help ==== Please join the Etherboot mailing lists. These are listed on the Etherboot home page. There is a users mailing list and a developers mailing list. The users list is for issues with building and running the software, while the developers list is for issues with features and coding. Please post questions or bug reports to the Etherboot mailing lists, please do not mail me, because: 1. you get the benefit of a lot of experts seeing your question (no, I don't know everything, if only because there are many configurations I have never used); 2. a lot of people see the question and answer and this helps them too; 3. I have other demands on my time, like a job, and answering individual email is an unsustainable practice. You will probably not get any reply from me if you email me directly. I want to make the best use of my time and that is by making sure that as many people as possible see the questions and answers. Note that I will post my replies to the mailing lists so to see the answers you should subscribe, or be willing to check the archives later. On the other hand, if you have a code or document contribution, then email to me is definitely appropriate. Please ask first before you send large files. Diffs are preferred to entire archives. If you are really keen to volunteer, and have the skills, ask to join the developer team. Other lists you can join are the Linux Terminal Server Project mailing lists at LTSP. The LTSP list is focused more on the LTSP packages. However there is a fair amount of overlap between the lists and many key people are on all lists. ===== Unpacking, compiling and testing the package ===== ==== A short cut to getting Etherboot images ==== Marty Connor has set up a web form for creating an Etherboot image [[http://www.rom-o-matic.net/|Rom-o-Matic]] on the fly and returning it as the output of the form. If all you want is an Etherboot image, this could save you having to build the distribution. ==== Unpacking the distribution ==== Unpack the distribution using ''gunzip'' and ''tar'', using one of the following commands, where you replace ''x'' by the patchlevel number: <file> tar zxvf etherboot-5.2.x.tar.gz tar jxvf etherboot-5.2.x.tar.bz2 gunzip < etherboot-5.2.x.tar.gz | tar xvf - bunzip2 < etherboot-5.2.x.tar.bz2 | tar xvf - </file> If the documentation tarball was provided separately, then in addition do this: <file>cd etherboot-5.2.x</file> followed by one of the following: <file> tar zxvf ../etherboot-doc-5.2.x.tar.gz tar jxvf ../etherboot-doc-5.2.x.tar.bz2 gunzip < ../etherboot-doc-5.2.x.tar.gz | tar xvf - bunzip2 < ../etherboot-doc-5.2.x.tar.bz2 | tar xvf - </file> which will extract the documentation in a subdirectory of the Etherboot top directory. ==== Making an Etherboot image ==== To build an Etherboot image you need a recent release of gcc and the binutils tools. This package has been compiled with the tools from a SuSE 8.2 distribution but it should work with any recent Linux or FreeBSD distribution. gas 2.9.1 is too old to handle the 16-bit code in loader.S. Use gas 2.9.5 at least. Also the "gcc 2.96" used in RedHat 7.0 (and later versions maybe) generates faulty machine code compiling Etherboot. Use kgcc from those distributions instead. Go to ''src/'', edit the options in ''Config'' and ''make'' the image that you want. A full list of options is in Appendix B. We suggest you accept the default options for now if you are not sure what to select. Unlike 5.0, 5.2 does not make all the images by default, you have to explicitly state which ones you want. You can test the image with a floppy before programming a ROM. On Linux just put a blank floppy in fd0 and say <file>make bin/card.zfd0</file> where ''card'' is the name of your network card and it will copy a bootable image onto the floppy. If you wish to do this by hand, perhaps because your floppy drive is elsewhere, just ''make bin/card.zdsk'' and copy this binary to the floppy raw, i.e. starting at the boot block. <file>cat bin/3c509.zdsk > /dev/fd0</file> You can also use utilities such as rawrite to write the image onto the floppy. Make sure the floppy has no bad blocks. It is best if it has been formatted just before use. You do not need to put any kind of filesystem on it. If you wish, you could substitute ''/dev/fd0'' with the actual device suitable for the floppy size you are using, for example ''/dev/fd0H1440'' for 1.44 MB floppies. This may be more reliable than using the autodetecting device ''/dev/fd0''. When you boot with this floppy it will load the Etherboot image from floppy and execute it. If you chose the correct image, it should be able to detect your card. To get the bootrom to acquire an IP address and load the intended code, you need to set up DHCP, tftp and NFS services, which we will discuss in the next section. We suggest you continue to use floppy booting until you have completed the setup of the server and are satisfied that diskless booting works. In addition, you can generate images with the suffixes ''.zlilo'', ''.zpxe'', ''.com'', and ''.zrom'' by saying: <file>make bin/3c509.zlilo</file> and so forth. The ones ending in ''.zlilo'' look sufficiently like Linux kernel images to be accepted by [[http://lilo.go.dyndns.org/|LILO]], [[http://www.gnu.org/software/grub/grub.html|GRUB]] and [[http://www.zytor.com/syslinux/|SYSLINUX]] for installation. Unfortunately loadlin uses a slightly different method of booting for Linux kernels from LILO and SYSLINUX and will not work with these images. The fact that ''.zlilo'' images look like a Linux kernel to LILO and SYSLINUX allows some interesting booting possibilities. For example, you could use LILO to select between DOS/Windows and Etherboot images from a disk that contains no Linux partitions, only FAT based partitions. *FIXME* This HOWTO shows you how this can be arranged. The ones ending in ''.zpxe'' can be booted by a PXE booter. This is useful to chain to Etherboot from PXE. *FIXME* Here are some notes on how to combine PXE and Etherboot. The ones ending in ''.com'' are DOS format executables, suitable for starting from DOS. It requires a real DOS environment, not a virtual DOS environment such as that provided by the DOS prompt window under Windows. Also it requires that there be no XMS drivers or other memory handlers loaded. It is not guaranteed to work if the environment is not clean, and sometimes not even if it is. The best chance of this format working is when DOS is booted with no device drivers whatsoever. If you can, use raw floppy or an intermediate bootloader for booting instead. The ones ending in ''.zrom'' are images suitable for writing onto ROMs. If you are making a ''.zrom'' image, you must set the PCI vendor and device IDs correctly for PCI NICs. Look at the file NIC. Locate the line that has the correct PCI IDs for your NIC. This will give you the name of the ROM image you should use. The PCI IDs are usually displayed by the BIOS on booting up. They can also be read out from a running Linux system using the Linux PCI Utilities. If you do not use the ROM with the correct IDs, the floppy version will work, but the ROM will not since the BIOS will check for a match. There are also ''.fd0'', ''.dsk'', ''.lilo'', ''.pxe'' and ''.rom'' counterparts to the ''.z*'' versions of the images. The difference is the ''.z*'' versions are compressed. Unless you doubt the (de)compression process, there is usually no reason to use the uncompressed versions.. ===== Setting up a diskless boot ===== In this section I assume you want to boot a Linux kernel. Booting a FreeBSD kernel is documented elsewhere and does not require a generating a boot image. Booting a DOS kernel is similar, the main differences being in the way you set up the boot image. ==== Making a boot image ==== Etherboot expects to download a boot image in either ELF or tagged format containing the code to be executed. Briefly explained, a boot image has a wrapper around the pieces of code or data that need to be put in various places in the computer's memory. It contains a directory telling how large the pieces are and where they go in memory. It also says where to start execution. A boot image is created using a utility program. The utility program is specific to the kernel you want to load. The version for Linux is called ''mkelf-linux'' or ''mknbi-linux'' and that for DOS is ''mknbi-dos''. These utilities are distributed separately and can be obtained from Etherboot web site. ==== Compiling a custom kernel ==== The preferred method of running applications on the booted machine is to package an initial ramdisk (initrd) along with the kernel. This initrd can either provide all the files necessary for running the application (at a cost of using RAM to hold the files) or mount NFS filesystems to obtain other files. Therefore you will need to compile ramdisk options in your kernel. For an example of how an initrd is created and packaged, see the LTSP project sources. After you have compiled the kernel, make the boot image, like this: <file>mkelf-linux --output=/tftpdir/xterm.nb zImage initrd.gz</file> This puts the image in where the tftp daemon expects to find it, in this example ''/tftpdir''. Make sure it is world-readable because typically the tftp daemon runs as an unprivileged user. It is recommended that you set a path explicitly for tftpd instead of relying on any defaults. For example, for inetd, the entry in ''/etc/inetd.conf'' looks like this (xinetd uses a different syntax, check the documentation): <file>tftp dgram udp wait root /usr/sbin/tcpd in.tftpd /tftpdir</file> ==== Setting up a DHCP daemon ==== You need to set up a DHCP server to hand out an IP address and other configuration information to the client. The main requirement of the DHCP server is that it needs to send out suitable configuration information. Prior to version 5.0.7, Etherboot accepted any DHCP offer (but see ''REQUIRE_VCI_ETHERBOOT'' below for an exception). Since version 5.0.7 Etherboot will not accept any DHCP offer where the server IP is empty (all zero) or the filename is empty. These offers are useless to Etherboot anyway so ignoring these offers will give it a better chance of picking the right DHCP server. If you already have a DHCP server on your network for providing Windows clients with IP addresses, chances are that it is not a suitable DHCP server because it's only tailored to the single purpose of handing out client addresses. Suitable DHCP servers include the ISC DHCPD, available for most Unix/Linux systems. You can run such a DHCP server in parallel with the Windows one, provided you do not attempt to give Windows clients leases, in which case there would be a clash. You can exclude Windows clients in two ways. One is to register the only the MAC addresses of the diskless clients in ''/etc/dhcpd.conf'', and to make sure that the server is declared "''not authoritative''". The second is to look for the Vendor Class Identifier of "Etherboot-5.x" in the DHCP discover packet. If you already have a DHCP server on your network that does provide the server IP and the filename, then you have to either use that DHCP server by editing its configuration file. This may require the cooperation of the system admin if you are not the admin. If you are not able to configure the DHCP server, then proceed to the section on ''REQUIRE_VCI_ETHERBOOT''. The minimum information you need to put in ''/etc/dhcpd.conf'' is: * The domain name of the machine. * The Ethernet (MAC) address of the network card, which you generally obtain from a sticker on the card, a configuration program for the card, or in the last resort, from watching the output of Etherboot or from the packets sent from the card when trying to boot, using the debug option of DHCPD. * The name of the boot image file, relative to the tftpdir directory. * The IP address you intend to give it, or the dynamic range it is to come from. * The TFTP server defaults to the DHCP server if not specified with next-server. * (Update AMH2006) The "''next-server''" parameter must be set to the TFTP server IP for recent ISC DHCPD (version 3.0.3? and newer) because default value changed to 0.0.0.0 Here is a sample DHCP configuration for ISC dhcpd: <file> option domain-name "ken.net.au"; option domain-name-servers 192.168.0.1; option broadcast-address 192.168.0.255; use-host-decl-names on; subnet 192.168.0.0 netmask 255.255.255.0 { host xterm { hardware ethernet 08:00:2B:B7:F3:80; fixed-address xterm.ken.net.au; filename "/tftpdir/xterm.nb"; } } </file> The declaration "''use-host-decl-names on''" tells dhcpd to include the name xterm in the reply so that it can be used as part of pathname to mount by NFS, etc. If your tftp server is not the same as the DHCP server, use the ''next-server'' declaration to specify a tftp server. (Update AMH2006: Always specify ''next-server'' for ISC DHCPD newer than 3.0.3) The 2.4.4 and above kernels can do a separate DHCP request to obtain an address. Kernels in the 2.2 series use BOOTP. However user space DHCP configuration is now preferred. More information about DHCP can be found at the [[http://www.dhcp-handbook.com/dhcp_faq.html|DHCP FAQ]]. If you are on a local network that is not directly connected to the Internet, you can use the "private" IP addresses ''192.168.x.y'' (or in the other ranges mentioned in [[http://www.ietf.org/rfc/rfc1918.txt|RFC1918]], i.e. ''10.x.y.z'', ''172.16.x.y - 172.31.x.y''). Otherwise please ask either your network administrator or your Internet service provider for your own IP address(es). You could use a bootp daemon instead of a DHCP daemon. However DHCP is preferred as DHCP provides more information to control the boot process. Also there is a bug in some old versions of bootpd where unnecessarily large reply packets are sent, causing packet fragmentation at the UDP level, and dropping of the packets by Etherboot. DHCPD can emulate bootpd if that's what you really want. ==== REQUIRE_VCI_ETHERBOOT ==== You may need to Etherboot in an environment where you have to install your own DHCP server, and it may interfere with the existing DHCP server. Etherboot has a feature designed to overcome this problem. It consists of two parts: The first part is Etherboot contains code that when it sends out a ''DHCPDISCOVER'' request, a tag containing a Vendor Class Identifier of "Etherboot-x.y" is sent out, where x.y is the version number, currently 5.2. The 5 and the 2 are printable digits, not binary values, i.e. byte values 53 and 50 respectively. This allows the server to identify Etherboot clients and ignore all others. The second part is Etherboot can be conditionally compiled to require a Vendor Encapsulated Option containing a VCI of "Etherboot", otherwise it will ignore the DHCPOFFER. The option is not compiled in by default because it would cause Etherboot to not boot in plain setups. The server we want to respond will include this tag in DHCPOFFERs and while other servers (e.g. Windows servers) may respond, they will be ignored. Vendor Encapsulated Option is supported in ISC DHCPD 2 or 3. (It's not documented in DHCPD 2, but it works.) Other DHCP servers may support VEO. (It's a RFC2132 option.) In ISC DHCPD 3, follow the documentation for declaring a VEO scope. In ISC DHCPD 2 the magic line required is: <file> option vendor-encapsulated-options 3c:09:45:74:68:65:72:62:6f:6f:74:ff; </file> Put this in the appropriate scope. Translation: Vendor Encapsulation Options (Option 43) encloses: Vendor Class Identifier (Option 60 = 0x3c), length 9, value "Etherboot"; End of Options (Option 255 = 0xff). If you have a DHCP server already running for the subnet, you probably should specify that your additional ISC DHCPD server is not authoritative for the the subnet, or it will veto (NAK) existing client IP address allocations, upsetting the status quo. See the ISC DHCPD options documentation. Here is a practical document describing how it is done. ==== Setting up a tftp daemon ==== Now set up a tftp daemon. This means installing the tftp package and making sure that the tftp service is active in ''/etc/inetd.conf''. If you want to be very careful you may wish to use the secure (-s) option of tftpd, this chroots to the specified directory, but then your pathnames in ''/etc/dhcpd.conf'' must be relative to the new root directory. If you are booting many clients you should be aware of the limitations of running tftpd from inetd. Typically inetd has limits on how often a daemon can be spawned, to detect runaway daemons. If many clients request the tftp service within a short period, inetd may shutdown that service. If you have a setup where there are many clients, it may be better to use an improved replacement for inetd, such as xinetd. Another possibility is to install a better tftp daemon like atftp at the Etherboot web site. This one can be run as a standalone daemon, avoiding *inetd limitations and it multithreads internally. ===== Testing the network booting ===== Now when you start up Etherboot, it should obtain an IP address and print out what it received. If you do not get this to work, turn on debugging in DHCPD and see if any query was received. You may also wish to use the tcpdump or ethereal utilities to watch the network for DHCP packets (port bootps). If not, check your network hardware (cables, etc). If a query was received, check if DHCPD was able to give an answer. If not, then the Ethernet address was not found in ''/etc/dhcpd.conf''. If a reply was sent, then only faulty hardware or a bug in Etherboot would prevent it being received by Etherboot. Assuming an IP address was received, the next thing Etherboot tries to do is load a file using tftp. Check your system logs to see if a tftp daemon was started up and a file requested. Generally if you run tftpd under tcpwrapper security, a log entry will be generated. If not, it could be a path problem or file permission problem (the file needs to be readable by tftpd). Another problem could be that tftpd needs to reverse map the IP address to a name for security checking, and you don't have the client's details in ''/etc/hosts'' or in DNS, or your tcpwrapper config files (''/etc/hosts.deny'', ''/etc/hosts/allow'') do not allow the access. Fix the problem. After the boot image is loaded, Etherboot will jump to it. If it crashes here, check that the image is a boot image. If it executes and stops at the point where it's trying to mount NFS filesystems, then you need to check your NFS mounts. Another common problem is the shared libraries on the NFS partition are not suitable for your CPU, e.g. i586 libraries but a 486 diskless client. ==== Setting up an initrd filesystem ==== Recent advances in the Linux kernel (2.4 and above) have made the use of an initrd that does user space autoconfiguration and mounting of a NFS root filesystem, followed by a pivot_root, a more flexible alternative to kernel autoconfiguration and mounting of a NFS root filesystem. Postings on the kernel mailing lists indicate that at some point in the future, kernel level autoconfiguration (BOOTP/DHCP from the kernel) may be removed from the Linux kernel and initrds will be the recommended way to start up a diskless system. Until I have time to write detailed instructions on how to construct the initrd, I refer you to the LTSP distribution which uses this technique. Mknbi supports initrds, see the ramdisk argument of mkelf-linux. The Linux kernel documentation describes the extra arguments should be passed to the kernel to make it use an initrd, and how to arrange the initrd so that the startup script within it is called when it's mounted. If the initrd mounts a NFS root filesystem then it should still have all the needed structure as explained in the next section. Initrds can also be used for mounting other network filesystems instead of NFS root. Some applications could even run totally out of initrd, e.g. Floppy Firewall, provided you have the memory, of course. ==== Other filesystem setups ==== This tutorial does not cover all possible ways of setting up a diskless client's initial filesystem. You could even mount a conventional hard disk. Why would you want to boot "diskless" if you have a hard disk? Reasons might be: you do not wish to administer the local disk; you want the assurance that a system is running a kernel from a central server; or you like the speed of network booting. Network booting is one technique in a toolbox. Techniques can be combined to do what you want. If you are interested in running the diskless client as an X-terminal, a very common use, you may wish to investigate the Linux Terminal Server Project. ==== Swap over NFS ==== Swap over NFS can be arranged but you have to patch the kernel source. See here. Be aware that opinions are divided on NFS swap. Some people think it's a bad thing because it just kills the network if you have lots of diskless computers and that you shouldn't be running into a swap regime on a diskless computer anyway. Some other people like having a bit of insurance. Also have a look at the NBD Network Block Device for swapping over that. There is also the follow-on project ENBD, the Enhanced Network Block Driver. I have no experience with this for swapping. Comments welcome. ===== Booting DOS ===== What about DOS? The deal with DOS is that one is loading a virtual floppy called A: into extended memory and then booting from this floppy. So you have to capture an image of a bootable DOS floppy first. Some more details can be found in the mknbi-dos utility. I have booted DOS (both M$ versions up to 5.0 and DR versions up to 7.03) diskless this way. A mknbi-fdos is available for building boot images for booting FreeDOS, the procedure differs slightly from booting M$ or DR DOS. If you were thinking of booting a Windows machine via the network, it seems (I'm not masochistic enough to do this) the problem is not the network booting but the mounting of a file system over NetBIOS (Windows does not do remote mounts of root filesystems over NetBIOS on TCP). So that rules out a Samba server. It appears to be possible over a Netware server, for which Linux or FreeBSD has workalikes. Also it is said that only certain versions of Windows will allow diskless booting. You will also have problems with pathnames and the usual Windows hassles. Do you really want to do this? You do know that you can run lots of desktop applications like Netscape, StarOffice, etc. on Linux, FreeBSD, etc. now? Why pay good money when you can use equally good free replacements? Anyway if you are still determined, in the Etherboot home page, there are links to external Web pages, one explaining how this was done with a commercial TCP/IP boot ROM, another explaining how to do it using Etherboot and Netbios over IPX. A recent user experience is here. Good luck and send us your experiences or better still a URL to a page explaining how you did it. ===== Making an Etherboot EPROM or EEPROM ===== Assuming you have satisfactorily set up your server environment, you may now wish to put the Etherboot onto an EPROM or EEPROM. Naturally this assumes access to hardware to program (and possibly erase) EPROMs. Access to a friendly electronics engineer and/or lab is one way to program and erase EPROMs. Otherwise you can look at the commercial links page for places you can buy programmed EPROMs from. Some high-end network cards, for example the 3Com 905B, have a socket for an EEPROM which can be programmed in situ with the right utilities. See any release notes accompanying Etherboot for more information. ==== Choosing the EPROM ==== Most network cards come with a blank (E)EPROM socket even though it is seldom used. When it is used, it is typically filled with a proprietary EPROM from the network card manufacturer. You can put an Etherboot EPROM there instead. ==== Enabling the EPROM ==== First you must discover how to enable the EPROM socket on your card. Typically the EPROM is not enabled from the factory and a jumper or a software configuration program is used to enable it. ==== Size and speed of the EPROM ==== Secondly, you must discover what size and speed of EPROM is needed. This can be difficult as network card manufacturers often neglect to provide this information. The smallest EPROM that is accepted by network cards is an 8k EPROM (2764). 16kB (27128), 32kB (27256), 64kB (27512) or even 128kB (27010) EPROMs are possible. (You will often see a C after the 27, e.g. 27C256. This indicates a CMOS EPROM, which is equivalent to the non-C version and is a good thing because of lower power consumption.) You want to use the smallest EPROM you can so that you don't take up more of the upper memory area than needed as other extensions BIOSes may need the space. However you also want to get a good price for the EPROM. Currently the 32kB and 64kB EPROMs (27256 and 27512) seem to be the cheapest per unit. Smaller EPROMs appear to be more expensive because they are out of mainstream production. If you cannot find out from the documentation what capacity of EPROM your card takes, for ISA NICs only, you could do it by trial and error. (PCI NICs do not enable the EPROM until the BIOS tells the NIC to.) Take a ROM with some data on it (say a character generator ROM) and plug it into the socket. Be careful not to use an extension BIOS for this test because it may be detected and activated and prevent you from booting your computer. Using the debug program under DOS, dump various regions of the memory space. Say you discover that you can see the data in a memory window from CC00:0 to CC00:3FFF (= 4000 hex = 16384 decimal locations). This indicates that a 16kB EPROM is needed. However if you see an alias in parts of the memory space, say the region from CC00:0 to CC00:1FFF is duplicated in CC00:2000 to CC00:3FFF, then you have put an 8kB EPROM into a 16kB slot and you need to try a larger EPROM. Note that because pinouts for 28 pin EPROMs are upward compatible after a fashion, you can probably use a larger capacity EPROM in a slot intended for a smaller one. The higher address lines will probably be held high so you will need to program the image in the upper half or upper quarter of the larger EPROM, as the case may be. However you should double check the voltages on the pins armed with data sheet and a meter because CMOS EPROMs don't like floating pins. If the ROM is larger than the size of the image, for example, a 32 kB ROM containing a 16 kB image, then you can put the image in either half of the ROM. You will sometimes see advice to put two copies of the image in the ROM. This will work but is not recommended because the ROM will be activated twice if it's a legacy ROM and may not work at all if it's a PCI/PnP ROM. It is tolerated by Etherboot because the code checks to see if it's been activated already and the second activation will do nothing. The recommended method is to fill the unused half with blank data. All ones data is recommended because it is the natural state of the EPROM and involves less work for the PROM programmer. Here is a Unix command line that will generate 16384 bytes of 0xFF and combine it with a 16 kB ROM into a 32 kB image for your PROM programmer. <file> (perl -e 'print "\xFF" x 16384'; cat bin/3c509.zrom) > 32kbimage </file> The speed of the EPROM needed depends on how it is connected to the computer bus. If the EPROM is directly connected to the computer bus, as in the case of many cheap NE2000 clones, then you will probably have to get an EPROM that is at least as fast as the ROMs used for the main BIOS. This is typically 120-150 ns. Some network cards mediate access to the EPROM via circuitry and this may insert wait states so that slower EPROMs can be used. Incidentally the slowness of the EPROM doesn't affect Etherboot execution speed much because Etherboot copies itself to RAM before executing. If you have your own EPROM programming hardware, there is a nice collection of EPROM file format conversion utilities here. The files produced by the Etherboot build process are plain binary. A simple binary to Intel hex format converter can be found at the Etherboot web site here. Etherboot is believed to make PnP compliant ROMs for PCI NICs. A long-standing bug in the headers has been tracked down. However some faulty old BIOSes are out there so I have written a Perl script swapdevids.pl to switch the header around if necessary. You'll have to experiment with it both ways to find out which works. Or you could dump a ROM image that works (e.g. RPL, PXE ROM) using the Perl script disrom.pl. The fields to look at are Device (base, sub, interface) Type. It should be 02 00 00, but some BIOSes want 00 00 02 due to ambiguity in the original specification. ===== Troubleshooting tips ===== * Floppy boot doesn't work. Is the floppy error-free? Have you copied the ROM image (with the disk loader prepended) to the floppy raw? Is that size of floppy bootable by your computer? Are you trying to run Etherboot on a 16 bit machine (286, 086/088)? Have you selected too many compile time options? The real limit on Etherboot is not the size of the EPROM but the fact that it executes in the 48kB region between 0x94000 and 0xA0000. If the sum of code, stack and bss is greater than 48kB, then Etherboot might crash at unexpected places. * Floppy version works but EPROM version doesn't work. There is a program called rom-scan (Linux, FreeBSD and DOS versions) in the directory contrib/rom-scan which will help detect problems. Rom-scan will only work on ISA ROMs though. * If the EPROM is not detected at all then the contents of the EPROM are not visible to the BIOS. Check that you have enabled the EPROM with any jumpers or soft configuration settings. Check that you do not have any conflicts in the memory address of the EPROM and any other hardware. Perhaps you have to prevent it from being mapped out by your BIOS settings. Or perhaps you have to shadow it with RAM. Maybe you put the code in the wrong half or wrong quarter of the EPROM. Maybe the access time of the EPROM is not low enough. You can also use the debug program under BIOS to examine the memory area in question. * If rom-scan says the EPROM is present but not active, then something prevented the BIOS from seeing it as a valid extension BIOS. This could be truncation of the EPROM window, maybe you have a larger EPROM in a slot meant for a smaller one. Maybe there is a checksum error in the EPROM due to some bits not properly programmed or the EPROM not being fast enough. In one case that we know of, the 3c503 network card, the ASIC actually returns 2 bytes of 80 80 in the end locations of the EPROM space. This apparently is a kind of signature. The makerom program in Etherboot compensates for this, but if the pattern is not 80 80, then the code needs to be modified. * If rom-scan says the EPROM is present and active, but BIOS does not see it, then perhaps the EPROM is located in an area that the BIOS does not scan. The range scanned is supposed to be 0xC0000 to 0xEF800 in increments of 2kB but I have seen some BIOSes that continue the scan into the 0xF0000 page. * Note that rom-scan will also detect other extension BIOSes mounted on your computer, for example VGA BIOSes and SCSI adapter BIOSes. This is normal. * For PCI NICs there may be a different reason why the ROM does not work. The PCI IDs of the ROM must match those of the NIC controller chip or the BIOS will ignore the ROM. The floppy version does not undergo this check since it isn't directly called from the BIOS. You must use the ROM image with the correct PCI IDs for your NIC. * Etherboot does not detect card. Are you using the right ROM image? Is the card properly seated in the computer? Can you see the card with other software? Are there any address conflicts with other hardware? Is the PCI id of the card one that is not known to Etherboot yet? In this case and where you think there is a bug in Etherboot, please submit a report to the Etherboot-users mailing list. * Etherboot detects card but hangs computer after detection. Some cards are booby traps while they are enabled. The typical offenders are NE2000s which will hang the bus if any access is made to the reset addresses while interrupts are active. You may need to do a hard reset of the computer, i.e. power down and up again before running Etherboot. * Etherboot detects card but does nothing after saying Searching for server. Check your network hardware. Did you select the right hardware interface (AUI, BNC, RJ45)? Is the cabling ok? If you have a Unix computer on the network and have root privileges, you could run tcpdump or ethereal looking for broadcast packets on the bootps port. If the requests are getting sent out but no replies are getting back, check your DHCPD setup. Also check if the server has a route to the client. * Etherboot obtains IP address but fails to load file. Check the tftp server. Is the boot image file installed? Is the file world readable? Is the path to the file allowed by the configuration of tftpd? Is the client denied by tcpwrapper rules? Did you put the right home directory and filename in /etc/dhcpd.conf? If you are booting lots of clients, is inetd shutting down tftpd for being spawned too often? If so, you need to get a better inetd or a a dedicated tftpd that runs as an independent daemon. * Etherboot loads file but hangs halfway through the transfer. We have one report that this happens if the Fast A20 Gate option is selected in the BIOS setup. The A20 issue is explained here. In effect this causes the loaded kernel to overwrite Etherboot and kill it. Try deselecting the option. You don't need it for Linux anyway. * Etherboot loads file via tftp but Linux fails to mount the root filesystem, either on an initrd or on NFSroot. This is a large category. Here are some suggestions: * You do not have a private copy of the /, /etc, /var, ... directories * Your ''/dev'' directory is missing entries for ''/dev/zero'' and/or ''/dev/null'' or is sharing device entries from a server that uses different major and minor numbers (i.e. a server that is not running Linux). * Your ''/lib'' directory is missing libraries (most notably ''libc*'' and/or ''libm*'') or does not have the loader files ''ld*.so*'' * You neglected to run ldconfig to update /etc/ldconfig.cache or you do not have a configuration file for ldconfig. * Your ''/etc/inittab'' and/or ''/etc/rc.d/*'' files have not been customised for the clients. For example if you set the wrong IP address in your client's init files you could interfere with the server. * Your kernel is missing some crucial compile-time feature (such as NFS filesystem support, booting from the net, transname (optional), ELF file support, networking support_. * Missing ''init'' executable (in one of the directories known by the kernel: ''/etc'', ''/sbin'', ?). Remember ''/sbin/init'' must be a real file, not a symlink. * Missing ''/etc/inittab'' * Missing ''/dev/tty?'' * Missing ''/bin/sh'' * System programs that insist on creating/writing to files outside of ''/var'' (''mount'' and ''/etc/mtab*'' is the canonical example) * The essence is that you must provide whatever is needed in the root filesystem that your kernel needs to boot. ===== Frequently Answered Questions ===== Please check this section if you have a problem before asking on the mailing lists. ==== Building Etherboot ==== * What do I need to build Etherboot? * You need gcc, gas and binutils, as well as any accompanying libraries and include files. Generally speaking on a package based system using RPM or DEB, you will need the C compiler package, the include file package, the C library package, the assembler package and the binutils package (this may include the assembler). You will also need perl if you modify the file NIC or use a different RELOCADDR value in the Makefile than the default, and m4 if you modify this file userman.xsgml. * I get an error from as saying data32 is an unknown directive or it has errors with assembler files. * Your gas is too old, upgrade to 2.9.5. * I get warnings about ljmp *. * They are harmless, you can ignore these. They are due to changes in the assembler syntax between gas versions. We could get rid of the warnings if we could easily detect which patches are installed in the version of gas you are using (it's not just a matter of detecting the gas version) but we'd rather just wait for the old gas versions to disappear since they are just warnings. * The documentation talks about mkelf-linux and mknbi-dos. Where are they? * These are distributed from the Etherboot web site. * Why don't you provide prebuilt ROM images? * [[http://www.rom-o-matic.net/|rom-o-matic.net]] is the answer. This is a site that makes ROM images for you on demand from specifications given to a web form and returns the image as the result of the form. ==== Testing Etherboot ==== * I put the ROM image on floppy like you wrote (''cat bin/boot1a.bin bin/foo.rom > /dev/fd0, or make bin/foo.fd0'') but the loader prints out an error. * The floppy you use should be an error-free, preferably a recently formatted floppy. Do not trust new floppies; they have been known to lose their manufacturer formatting in storage. You don't need to put a filesystem of any sort on it, FAT or ext2 or otherwise. Another possible cause is that there are alignment differences between the drive used to write the floppy and that used on the target machine. * My network adapter is detected but I get no reply to the BOOTP/DHCP request. * Do you have a BOOTP or DHCP server running on the same Ethernet segment? On many operating systems the server is not enabled by default. Review the instructions in the Troubleshooting section. Another thing to note is that the BOOTP (or DHCP in fixed address mode) server will not reply if it does not know the network adapter's Ethernet address. Since the address may be hard to determine if it is not printed on the card or you do not have the adapter's setup program, you can copy it from Etherboot's startup message. Did you also provide a filename with the DHCP offer? Offers with no filenames are ignored by Etherboot. Remember to restart the server if you have edited the config file and the server does not automatically reread when it discovers an updated config file. * Another thing to check is that the BOOTP or DHCP server is allowed to receive the query. You may have some protection mechanism such as tcpwrappers or a firewall in front of it. As the booting computer does not have an IP address, the request will come from 0.0.0.0 so your rules must allow through packets from this address. * If the BOOTP or DHCP server is on another Ethernet segment, things get more complicated. You need to run a BOOTP or DHCP relay. You will probably also need to set the gateway field in the reply so that TFTP will work across the gateway. You should read a good explanation of how these work, in say, W. Richard Steven's book TCP/IP Illustrated. * Etherboot gets the BOOTP/DHCP parameters but cannot find a TFTP server. * Do you have a TFTP server installed and running and is it allowed to serve the client in question? For example the tcpwrapper rules may not allow TFTPD to respond to the IP address the booting computer is at. You should look at the log files on the server for any clues. * The TFTP server is found but it replies Access violation. * Access violation is a blanket reply for many different problems but essentially the TFTP server cannot give Etherboot the file requested. Did you put the file where TFTPD expects to find it, e.g. on a directory that is on its path? Did you make the file world readable? Case of the filename is important too. Check the log files on the TFTP server to see what the actual filename it tried to open was, sometimes directory prefixes are prepended to the name due to the program options specified. * I made this kernel and put it in /tftpdir like you wrote but Etherboot says Unable to load file. * Is the file a boot image? You cannot use a ordinary kernel image, you must process it with mkelf-linux first. * I have this proprietary boot ROM (e.g. LanWorks, PXE, etc) and I used mkelf-linux or mknbi-linux to make a boot image, (or I got this boot image from the LTSP project), but the boot ROM doesn't load it, or it fails to run. * The boot image format is specific to Etherboot. It will not work with proprietary boot ROMs. You have to find out from the supplier what boot procedures you should use. For example, if you are using a LanWorks boot ROM, the information you need is here. For PXE the utility you need is PXELINUX. ==== Hardware capabilities ==== * What network cards are supported? * See the list of supported NICs in the Appendix. * I have a machine with the X processor and Y megabytes of memory. What can I expect to run on it? * Please note that these estimates are approximate: * On a 386 with at least 4MB of memory you can boot Linux. With 4MB perhaps only a few telnet sessions are possible. With 8MB you might be able to run a text based web browser like Lynx or W3M. You can also run firewalls such as floppyfw. * On a 486 with 16MB of memory you can run X to make an X-terminal. * On a Pentium with 32MB of memory you can run an X-terminal and some applications locally, say perhaps printing, daemons to control devices, etc. * On anything faster and with more memory you could perhaps do distributed computation, e.g. a cluster. ==== Booting Linux ==== * The kernel loads but it cannot find a NFS server for the filesystem. * Do you have a NFS server running and is it allowed to serve this client? NFS is actually several services. On Linux at least you need: nfsd (either kernel or userland version), rpc.mountd and portmapper. Check if the tcpwrappers config file is allowing portmapper to receive the request. Look at the log files for clues. Did we already mention that log files are your friends? * The filesystem mounts but it says something about not being able to open an initial console. Or alternatively, various services complain about not being able to write to the filesystem. * A common mistake in Linux NFS servers is to put extra spaces in /etc/exports. Please see the NFS FAQ for frequently answered questions about Linux NFS services. * Please review the Troubleshooting section for what is required on this root filesystem. The situation is complicated by the fact that there are many possible ways of setting this up, including using a root filesystem that is on ramdisk. If you wish to avoid many of the troubles, try using a packaged solution such as LTSP. ==== Running X ==== * I tried to run X on the client but it aborted. * Remember that the config files used by the X server should pertain to the client's video adapter and display hardware. If you used a LTSP package, please review the configuration directions. If you used the copy files from server solution, then you need to customise the X server configuration. Another thing that may cause the server to abort is lack of a mouse device. * ''X -query server'' runs but all I get is a gray stippled screen. * Either you don't have an XDM server running on the server machine or it is not allowed to serve this client. In the latter case check XDM's Xaccess file, because for security reasons, the ability for clients to connect is usually disabled. * When I am logged in using an X-terminal, I find that the floppy drive, sound card and name of the computer are those of the server!? * This is to be expected! This is exactly how an X-terminal works. You are indeed logged onto the server and the client just provides display (screen) and input device (keyboard and mouse) services to the application. This is one of the beauties of the X Windowing system model, it's network transparent. * So how do I run applications on the client? I have this (smartcard reader, printer, sound card, etc) program that must execute locally. * The client can be configured to allow you to run programs locally. What you have to do is either start the application from the init scripts run during bootup, as would be the case for the printer and sound daemons mentioned later; or to start a shell interpreter on the client, either through an interactive login to the client or a remote execution of a command from the server to the client. Common methods are rsh (insecure) and ssh (better). * X applications cannot find (some) fonts. * Do you have an X font server (XFS) running on the server machine, is it allowed to serve this client, and has the client been told to use the font server? The last point is usually configured in the XF86Config file, or by a xset command to modify the font path after logging in. * Also note that RedHat (and possibly other distributions) has made XFS by default serve only the local machine using a Unix socket. You need to modify the startup script to tell XFS to use a TCP/IP socket. * How much CPU power and memory do I need on the client? On the server? * It depends on the configuration. There are two major cases: where the client is an X-terminal, and not much more; and where the client is configured to run applications locally. * An X server will fit in 16MB of memory, and 32MB is quite adequate. Performance depends on the CPU, video card and your expectations. An old Pentium 200 with a PCI video card does very well, but if you are not fussy, a high-end 486 with a VLB video card can be satisfying too. * If you want to run apps locally, well how long is a piece of string? Netscape will need say another 16MB. It all depends. Whatever you do, it's worth trimming down on the services you run on the client. Don't run more virtual consoles than you need and don't run unneeded daemons. * As for the server, in the X-terminal case this has all the applications running on it, so it should be adequate for the multiuser aspect. A high-end Pentium, with 64 MB of memory to start with, and between 8 and 16MB for each extra client is a good starting point. It will also depend on your mix of client access, statistically perhaps not everybody will be running at the same time. Remember that you don't have to have one big server for all your clients, you can and you should distribute the load across servers. ==== Other client applications ==== * How can I print to a printer attached to a diskless client? * There is a server program called p910nd at the Etherboot web site that funnels data from a TCP/IP connection to the printer port. You can instruct lpd or CUPS on the server to send jobs across the network to p910nd. * How can I output sound on the client? * There is a package called virtualfs that proxies the sound devices across the network. It can also proxy the floppy drive. * Another solution is EsounD * You may wish to check the LTSP site and mailing lists for other proposed solutions. * How can I access the floppy on the client? * Besides virtualfs mentioned above, recent distributions of mtools have a floppyd. This only works with the mtools utilities though. ==== Booting FreeBSD ==== * Where are the instructions for booting FreeBSD? * For now, there is just a short document in the doc directory. Better versions of this document depend on contributions from the FreeBSD community, I am unable to test FreeBSD because I don't run it. ==== Booting other operating systems (DOS, Windows) ==== * I want to boot FreeDOS. * The new mknbi utility supports creating boot images from FreeDOS kernels now. See the man page for details. FreeDOS is under development and if the layout of the kernel image changes, please send any corrections to me. * I cannot boot DR-DOS 7.03. * There is some difference between the DR-DOS 7.03 and 7.02 bootblock that causes it not to boot. But a 7.02 bootblock works just as well with the DR-DOS 7.03 kernel, so you can substitute that. * DOS dies when I load HIMEM.SYS. * Use the /testmem:off option to prevent HIMEM from scribbling over the ramdisk which is the floppy A:. * How do I make A: my real floppy again after booting is complete? * Use the rmrd.com program supplied with mknbi. * I want to use the real floppy at the same time I am using the ramdisk image of the boot floppy. * The ''--harddisk'' option of ''mknbi-dos'' is intended for this. It causes your boot drive to be C:, so you can use A: for the real floppy. See the man page for more details * I want to boot Windows. * I pass on this one, as I do not have (by choice) any Windows systems running on my computers. Perhaps others can contribute to this section. However I gather that it is only possible on Windows95A, as other versions don't have the necessary support for diskless booting. ==== Hardware issues ==== * Where can I get an EPROM made? * Depending on where you live, you might find a supplier listed on the Commercial Links page. Another possibility is to seek the help of someone working in a university or industrial lab who has an EPROM programmer. If you are handy with hardware, you could buy a kit or build your own. There are links to kit suppliers in the Commercial Links part of the home page. * Some high end adapters, for example the 3Com and Intel ones, accept an EEPROM in the socket. This can be programmed in-situ using utility programs, some of which or information about are under the contrib directory in the Etherboot distribution. * Finally some recent motherboard have flash BIOSes which contain space where an extension BIOS such as Etherboot can be inserted. The Phoenix Award BIOSes can be modified using a program called cbrom.exe possibly here. Or do a Web search for it. No success has been reported for AMI BIOSes. Dirk von Suchodoletz maintains a list of successes and failures here. Here is some text contributed by Dirk von Suchodoletz. He hopes to put it on a web site someday: <file> 6.4 Using your mainboard's BIOS to integrate etherboot-code Newer mainboards that have an AWARD-BIOS can use etherboot without separate EPROMS and therefore without the necessity of having a EPROM-programmer[?]. (Heinrich Rebehn wishes to add: Flashing the BIOS is always a (small) risk. Flashing with unsupported, hacked BIOS image is *dangerous* and may render your PC unbootable. If you don't have access to a PROM burner you should stay away from experimenting.) In order to do this, you need 2 software tools: awdflash.exe, which should be included in your mainboard package, and cbrom.exe, which is an OEM-tool that allows modifications of the BIOS. awdflash.exe reads and writes the flashrom content, whereas cbrom.exe is used to analyse the content of the AWARD BIOS image. cbrom.exe can also add code to the BIOS image or remove components. This way you can easily integrate etherboot into your mainboards without even opening the PC's case. After the BIOS image has been saved (e.g. as bios.bin), or in case the current version of the BIOS has been copied from the board manufacturer's website, 'cbrom bios.bin /d' shows how much space is left on the image for your code. As the flashrom holds the compressed BIOS, cbrom will also compress the code when adding it to the BIOS. Therefore, 8 to 20 kbyte of free memory is needed, depending on the network adapter's driver. In case not enough memory is left, unneeded BIOS components can be removed from the BIOS image to regain space: the manufacturer's logo or the Symbios/NCR SCSI-code are note needed for diskless systems. 'cbrom bios.bin /[pci|ncr|logo|isa] release' will remove those unnecessary components. The command line "cbrom bios.bin /[pci|isa] bootimg.rom [D000:0]" adds the compiled etherboot code to the bios. bootimg.rom is the code we would use to burn onto EEPROMs in other cases. Depending on your network card, either the pci or isa options have to be used. With isa cards you have to tell cbrom to which RAM location the code will be extracted at boot time. Attention: Compile the etherboot with the -DASK_BOOT or -DEMERGENCYDISKBOOT option to be able to access a disk. The code added by cbrom will be executed before the computer seeks for a boot disk or floppy. 6.5 Booting with a DOS executable (COM) file If the computer has to be used with more than one operating systems, for example using the computer as an X-Terminal in addition to the already installed NT on the harddrive, etherboot has to be used with the compile-time option -DASK_BOOT. In case hardware-conflicts between Windows NT and the installed EPROM exist, creating DOS Executables (e.g. using 'make rtl8139.com') can provide a useful remedy. Those DOS Executables are comparable in their functionality to .rom images and can be used as substitutes. In case an existing DOS-bootsector, stored in BOOTSECT.DOS, cannot be used, creating one has to be done by formatting and installing a harddrive using DOS before installing NT (see Win-NT Multiboot-HOWTO). In addition the DOS system files are needed (IO.SYS, MSDOS.SYS, or KERNEL.SYS when using FreeDOS) and have to be copied into the directory of the NT loader. If using Autoexec.bat to start the .COM file is desired, either the particular COMMAND.COM has to be provided or the etherboot file needs to be renamed as COMMAND.COM. This file will then be started instead of the DOS-Shell which is useful for avoiding unwanted user interaction. Afterwards a line has to be added to BOOT.INI as if DOS was to be booted: [boot loader] timeout=20 default=C:\bootsect.dos #add this line if dhcp/tftp should be default action [operating systems] multi(0)disk(0)rdisk(0)partition(2)\WINNT="Windows NT Workstation, Version 4.0" [VGA-Modus]" /basevideo /sos C:\bootsect.dos="DHCP/TFTP (Linux diskless via etherboot)" #our boot option </file> And here are some comments by Rapp Informatik Systeme GmbH about cbrom.exe versions: <file> Some more remarks for cbrom.. There are several version numbers of cbrom.exe p.e. 1.x and 2.x. and there is a cbrom called cbrom6.exe. First cbrom.exe with Version 1.x (newest 1.32) is for Award Bios Version 4.5x and cbrom6.exe is for Award Bios Version 6.xx. So because it seems a lot people become confused and use cbrom 1.x for the new 6.x Bios Award merged this together to a cbrom.exe with Version number 2.x ( newest know 2.04) witch now runs on Award 4.5x and 6.xx Bioses. Now how to find cbrom.exe. Different 1.x Versions of cbrom.exe could be found on the net, cbrom6.exe seems to be gone. It seems that Award/Phoenix do all that cbrom is deleted from servers of board manufactures. So cbrom.exe Vers 2.04 is not available on the net. If somebody need this please try to send a demand question to the list - I hope somebody will mail it to you. </file> * How do I enable the ROM socket on my network adapter? There are no jumpers on the card. * These jumperless cards need a card-specific utility program to enable the ROM. Normally the manufacturer supplies it on a diskette or CDROM. You lost the diskette? If you know the manufacturer, you might be able to get the program from their website. You have a mystery card? Well the first thing to do is to identify the card. If it is an ISA card and made in Taiwan or China it's almost certainly a NE2000 clone. For some information, try here. If it's a PCI card, then either the BIOS or the Linux PCI Utilities should be able to tell you the manufacturer and device IDs, which you can then look up to convert to names. * I would like to boot my laptop diskless from a floppy containing Etherboot. * The problem is that laptops these days use PCMCIA network adapter cards. These in turn connect to the PCMCIA controller when docked. To be able to communicate with the PCMCIA card, Etherboot would first have to talk to the PCMCIA controller. Until somebody writes the code to do this... Booting from disk is different because the kernel will load the PCMCIA controller code from disk first. You could always put a Linux kernel on the boot floppy. ==== Drivers ==== * There is no Etherboot driver for my network adapter. Can you write me one? * If I were independently wealthy and had nothing else to do in life, sure! But unfortunately I have a day job and Etherboot is a hobby. A couple of the drivers were written for pay and the others were written by volunteers. Perhaps you might like to volunteer? If you have a good grasp of C, and understand basic hardware concepts, it is quite doable, and not nearly as difficult as writing a Linux device driver. See the developer manual. You will have the reward of understanding hardware intimately and seeing your work benefit users worldwide. * If you are a commercial entity, you might consider assigning staff or hiring a volunteer to write the driver. You get the benefit of the rest of the Etherboot code infrastructure and users worldwide get to appreciate your contribution. Bear in mind license conditions detailed in the Section called License, of course. NIC manufacturers note, this may be one way to attract users to your hardware products. NIC users note, petition your NIC manufacturer to support Etherboot. * I see that my network adapter is supported in Linux but not in Etherboot. Can I use the Linux driver in Etherboot? Or maybe you can adapt the Linux source for me. I can send you the Linux driver source if you just say the word. * No, the structure of Linux and Etherboot drivers are rather different. There are several reasons: Linux drivers are more complicated and written to give good performance, whereas Etherboot drivers are written to be simple. Linux drivers are interrupt driven, whereas Etherboot drivers are polling. Linux drivers have an elaborate support structure, whereas Etherboot drivers are fairly self-standing. * But... you can use Linux drivers as a source of reverse-engineering information. Several of the drivers in Etherboot were adapted from Linux drivers. But don't send me the driver source; see previous FAQ about volunteering. And I have the latest Linux source anyway, doesn't everyone? ==== Miscellaneous ==== * I don't understand something, or I have a question not covered by this list. * Please see the Section called Getting help earlier in this document. ===== Acknowledgements ===== The following people have contributed substantially to Etherboot. If you feel your name has been left out, just let me know and I will fix it up. * Markus Gutschke - Co-author of Etherboot. He was the person who ported the Netboot suite from FreeBSD. He has enhanced Etherboot with many features, one new driver and has contributed various utilities and addons. * Gero Kuhlmann - The original mknbi utilities used by Etherboot are from Netboot. He has also clarified the original specification by Jamie Honan. * Jamie Honan - Jamie started Netboot off by writing the first version that used code from a packet driver. * Martin Renters et. al - The original authors of Netboot on FreeBSD. * Bruce Evans - Created bcc compiler used by Etherboot/16 (16 bit ROMs are no longer supported). * Rob de Bath - Current maintainer of bcc and associated tools like as86, used in older versions of Etherboot to assemble the x86 assembly language files. * Gerd Knorr - Contributed MASQ for making a boot floppy without DOS. * Adam Richter - Contributed comboot for making a boot floppy without DOS. * Claus-Justus Heine - Contributed patch for serial console and NFS swapping. See the contrib/nfs-swap directory for his Web page. * Dickon Reed - Contributed display of loading status and a hack for the 3c509 card. * David Munro - Contributed PCI detection code originally from Linux sources. * Charlie Brady - Donated NE2100 card so that a driver could be written, and helped test the LancePCI driver. Spotted bug with 4.1 header code. * Rogier Wolff - Created Intel EtherExpressPro 100 driver and binary to hex converter. * Vlag Lungu - Contributed patches to work with DHCP. Also contributed a fix to match the received XID against the transmitted one, important in a network with many requesters. * William Arbaugh - Patches for eepro to work with 3.2. * Jean Marc Lacroix - Contributed an improved bin2intelhex. * Jim Hague - Contributed fixes to 3c503 driver for PIO mode, fix to makerom for presetting EPROM bytes, and various endian fixes. * Andrew Coulthurst - Contributed patch for making Intel eepro work in 4.0. * Doug Ambrisko - Contributed patches to start32.S from FreeBSD version to make it boot Windoze after answering N to Boot from Network question. Contributed FreeBSD support and improved serial console support which is now merged into distribution since version 4.2.8. Minor patches to 4.7.21 to make compilation under FreeBSD easier. * Alex Harin - Contributed patches for prepended loaders and makerom to make bootrom PnP and PCI compatible. * Peter Dobcsanyi - Contributed vendor and device IDs for the Netvin NE2000/PCI clone. * adam AT mudlist PERIOD eorbit PERIOD net - Contributed RARP code as alternative to BOOTP/DHCP. Activated by RARP_NOT_BOOTP define. * Daniel Engstrom - Contributed a SMC9000 driver. * Didier Poirot - Contributed an Etherpower II (EPIC 100) driver. * Martin Atkins - Contributed mntnbi for mounting DOS NBIs. * Attila Bogar - Contributed a bug fix to the bootmenu code and a patch to main.c to remove looping menus on failure. Also code for ARP replies and TFTP retransmit (#ifdef CONGESTED). Cleanup of tftp and tftpd. * Nathan R. Neulinger - Found bug due to tu_block being declared signed short in arpa/tftp.h on many platforms when it should be unsigned short. * David Sharp - Contributed a FreeBSD driver for Tulip based cards. Ken Yap ported it to Etherboot. Not tested because code needs to be written for all the variants of the Tulip and also because no hardware available to me. * Greg Beeley - Contributed a 3c905b driver. Be sure to read the release notes in 3c905b.txt before using. * Alex Nemirovsky - Contributed patches to use BIOS call to size memory otherwise Etherboot was trampling on top of 640kB area, which is used by some extended BIOSes. Also contributed patches to pci.c to implement PCI bus support on BIOSes that do not implement BIOS32, or incorrectly. * Günter Knauf - Suggested making the ASK_BOOT prompts more generic and clearer. Also contributed a DOS utility for extracting the identifier string and PCI IDs, if any, out of the boot ROM. Contributed a wake on LAN CGI script. * Klaus Espenlaub - Contributed various cleanup patches to the code especially in the bootmenu area, fixes for the NE2000 driver, as well as a completely revamped start32.S. Also introduced Rainer Bawidamann's code, see next paragraph. Contributed further improvements in Realtek 8139 driver. Did a major rewrite from 4.4.5 to 4.5.5, see doc/maint/LOG. * Rainer Bawidamann - Contributed a Realtek 8139 driver. * Georg Baum - contributed a Schneider & Koch G16 driver. * jluke AT deakin PERIOD edu PERIOD au - sent in a fix for the WD/SMC8013 which I finally verified. * Mark Burazin - contributed a fix for Compex RL2000 NICs. * Matthias Meixner - found a receive status bug in the RTL8139 driver. * Jim McQuillan - provided changes to support the SMC1211 which uses the RTL8139 chip. * Steve Smith - Extended the 3c905b driver for other members of the 90x family. Be sure to read the release notes in 3c90x.txt before using. Modified loader.S for some BIOSes that don't behave correctly with INT19H. * John Finlay - Wrote a utility for programming EEPROMs on 3c90x in situ. * Nick Lopez - Contributed change to tulip.c to handle Macronix 98715 (Tulip clone). * Matt Hortman - Contributed fix to eepro100 driver that fixes incorrect latency setting. Also Makefile rule for .lzfd0. * Marty Connor - Contributed new Tulip driver ntulip.c. Reduced RTL8139 footprint. Added support for Netgear FA310TX (Tulip clone, LC82C168 chip). Support for 3Com905C. Romutil for 905C, which have block erase EEPROMs. Contributed the development of liloprefix.S through thinguin.org. Finally made the ROM images conformant PnP boot ROM images. Wrote the SiS900 driver. Made Tulip driver work for many more variants. Wrote the National Semiconductor DP83815 driver, under funding from Sicom System. * Anders Larsen - contributed mkQNXnbi, for generating boot images from QNX kernels. * Bernd Wiebelt - contributed code to request vendor tags in DHCP. * Paolo Marini - contributed the Via-Rhine driver. * Adam Fritzler - contributed 3c529 (MCA version of 3c509) support in driver. * Shusuke Nisiyama - contributed a 3c595 (may work for 3c590) driver. * Igor V. Kovalenko - contributed a Winbind W89C840 driver. * Gary Byers - of thinguin.org wrote the LILO prefix program liloprefix.S. * Donald Christensen - converted all the as86/nasm .S files to gas format, thus allowing Etherboot to be built without requiring as86/nasm. * Luigi Rizzo - contributed a bootloader from FreeBSD that works for both floppy and hard disk partitions. This obsoletes floppyload.S. Patch to do adaptive timeout in NFS booting. * Michael Sinz - contributed patches for loading debug symbols when booting FreeBSD. * Jean-Jacques Michel - contributed patches to the via-rhine.c driver to make it work for the VT6102 model as used on some DFE530-TX Rev.A3 NICs. * Peter Kögel - contributed patches to the SiS900 driver to make it work for the SiS630e/SiS730s. * Eric Biederman - improved the recovery logic of main.c and lots of other changes. Contributed E820H memory sizing logic. Reworked PCI logic. Made more compatible with LinuxBIOS. Lots of small fixes. Reworked the architecture completely to be much more portable. Wrote a lot of new code. A list of his contributions would take several paragraphs. * Peter Lister and Vasil Vasilev - contributed changes to generate .pxe image that can be booted using a PXE booter. * Fred Gray - contributed changes in tulip.c to check for a duplex connection and to modify the controller register if so. * Mark G - of Inprimis Technologies contributed another FA311 (National Semiconductor DP83815) driver, also based on the Donald Becker Linux driver. * Armin Schindler - contributed a patch to allow booting LynxOS KDI images. * Christopher Li - contributed an Intel E1000 gigabit Ethernet driver. * Rohit Jalan - contributed a patch for FreeBSD style PXE booting. * Andrew Bettison - sent in a patch to run the SMC EtherEZ in PIO mode, required for some motherboards. * Michael Brown - contributed the first wireless NIC drivers for the Prism chipset. * Timothy Legge - contributed a 3c515 driver, ISA PnP implementation, sundance, tlan, and pcnet32 drivers, enabled multicast in 3c509, 3c515, 3c595, pcnet32, rtl8139, sundance, tlan, and via-rhine drivers, and contributed new multicast tftp implementation (proto_tftm). * Cai Qiang - fixed the WinCE loader.


Navigation

* [[:start|Home]] * [[:about|About our Project]] * [[:download|Download]] * [[:screenshots|Screenshots]] * Documentation * [[:howtos|HowTo Guides]] * [[:appnotes|Application Notes]] * [[:faq:|FAQs]] * [[:doc|General Doc]] * [[:talks|Videos, Talks, and Papers]] * [[:hardwareissues|Hardware Issues]] * [[:mailinglists|Mailing lists]] * [[http://support.etherboot.org/|Bugtracker]] * [[:contributing|Contributing]] * [[:editing_permission|Wiki Edit Permission]] * [[:wiki:syntax|Wiki Syntax]] * [[:contact|Contact]] * [[:relatedlinks|Related Links]] * [[:commerciallinks|Commercial Links]] * [[:acknowledgements|Acknowledgements]] * [[:logos|Logo Art]]

QR Code
QR Code usermanual (generated for current page)