Hardware and Software Assumptions
- The boot loader described in this topic is developed for an example hardware platform containing the following hardware specifications:
- ARM V4I CPU
- 64 MB RAM
- 32 MB Intel Strataflash (28F128)
- A supported Ethernet controller, such as NE2000 or SMC9000. As a simplification for this boot loader development process, the controller is built-in and not a PCI or PCMCIA device.
The following table shows the memory map for this hardware platform.
Physical address Length Description 0000.0000 - 01FF.FFFF 32 MB Flash A000.0000 - A3FF.FFFF 64 MB RAM The boot loader design assumes that the CPU begins fetching code at physical address 0 following a reset.
- You are developing a new boot loader, using as much from the included support libraries as possible.
- This procedure used a sample boot loader with the following design simplifications:
- The boot loader resides in system flash memory and runs at every hardware reboot.
- Use Ethernet for the download transport. This is built in with no PCMCIA or PCI interface.
- Download a Windows CE .bin file, for example, Nk.bin, to RAM.
- There is no support for booting a local run-time image, although the flash memory routines are covered. Memory management unit (MMU) or caches are not used. The ROMOFFSET configuration option in the run-time image Config.bib file should reflect the fact that all addresses are physical.
The following procedure explains the boot loader development process from the beginning. However, you can save development time by modifying an existing boot loader image for a hardware platform of similar design.
Platform Builder includes tested boot loader source code for various hardware platforms, which you can use as the basis for further development.
To track your progress in the following table, select the check box next to each step.
Note In the following steps, code examples are used to demonstrate each step. In some cases, these examples are code fragments and might be brought together from different parts of the boot loader development process. Because of this, not all code examples compile.
Step | Topic | |
---|---|---|
1. Create a directory for your new boot loader code. For example: %_WINCEROOT%/Platform/MyPlatform/Src/Bootloader/Eboot. The boot loader code directory is typically in a hardware platform directory. You must include the directory in the hardware platform dirs file to build it as part of Platform Builder. | Not applicable | |
2. Set up a command-line build shell to create and build the boot loader.
Note All further steps rely on the assumption that the boot loader development process takes place in a build shell environment. | Setting Up a Command-Line Build Shell | |
3. Generate all static libraries required by the boot loader image.
For more information about Sysgen.bat, see tabindex="tabindex" keywords="wce50conSysgenTool">Sysgen Tool. | Not applicable | |
4. Create a file for your boot loader's StartUp function, and then establish a function framework as a starting point. | Creating a File for the Boot Loader StartUp Function | |
5. Create a sources file and makefile file in the boot loader directory. | Creating the Boot Loader Sources and Makefile Files | |
6. Build your first boot loader executable (.exe) file. | Building the Boot Loader Source Code | |
7. Implement the boot loader's StartUp function. | Implementing the Boot Loader StartUp Function | |
8. Create a boot loader main function. This is typically using C programming language. Starting with this step, all boot loader code should be able to operate in C instead of assembly language. Note If you build during this step, you receive a number of undefined values, because BLCOMMON expects to call a number of functions that have not yet been implemented. Therefore, you should at least implement stub versions of these functions. | Creating the Boot Loader Main Function | |
9. Create stub versions for a number of OEM functions, including generic hardware platform routines and flash memory operations. | Creating Stubs for the Boot Loader OEM Functions | |
10. Add the new source files, Main.c. and Flash.c, created in the previous step to the SOURCES line in the sources file.
| Editing the Boot Loader Sources File | |
11. Create the .bib file, which will be used by Romimage.exe to convert the boot loader .exe file into .bin and .nb0 files. | Creating the Boot Loader .bib File | |
12. Rebuild the boot loader.
Note After this point, the basic boot loader source infrastructure is in place. To complete the remaining steps of this procedure, you must do the following:
| Rebuilding the Boot Loader | |
13. Implement the following serial debug functions in your boot loader code:
These functions are required BLCOMMON callback functions that you must implement in your boot loader code. You can use other libraries to help implement the functions. You can copy and possibly modify much of the code from existing hardware platforms. You should choose a hardware platform that is as similar to your own as possible to minimize the need for changes. | Implementing the Serial Debug Functions | |
14. Rebuild the boot loader and verify that your code works by testing it on the target device. You should now be able to verify the following:
If you encounter problems, verify that you correctly implemented serial debug functions. | Rebuilding the Boot Loader | |
15. Create the driver globals and boot args shared data areas. | Creating Driver Globals and Boot Args | |
16. Implement the remaining hardware platform initialization code by implementing the OEMPlatformInit function. | Implementing the OEMPlatformInit Function | |
17. Add Ethernet debug libraries that have routines referenced in OEMPlatformInit to the TARGETLIBS entry in the boot loader sources file.
Note After this point in the development process, the CPU, board-level logic, and network controller are all initialized. To complete the remaining steps in this procedure, you must do the following:
| Editing the Boot Loader Sources File | |
18. Implement the following Ethernet controller-related functions: | Implementing the Ethernet Controller-Related Functions | |
19. Implement the OEMPreDownload function. | Implementing the OEMPreDownload Function | |
20. Test boot loader communications by doing the following:
| Not applicable | |
21. Create a test .bin file to download from Platform Builder. | Creating a Test .bin File for Download | |
22. Verify that the boot loader can use Platform Builder to download a .bin file. | Verifying .bin File Download | |
23. Implement the OEMLaunch function.
Note After you complete this step, you have essentially completed development of the boot loader. The boot loader should now be able to
To complete the remaining steps in this procedure, you must add support for writing the downloaded boot loader image to flash memory. By doing so, the boot loader can update its own saved image. You can also do the following:
For more information about design tradeoffs, especially NOR versus NAND flash memory, see this Microsoft Web site. | Implementing the OEMLaunch Function | |
24. Implement the OEMIsFlashAddr function. | Implementing the OEMIsFlashAddr Function | |
25. Implement the OEMMapMemAddr function. | Implementing the OEMMapMemAddr Function | |
26. Implement the following flash memory erase functions: | Implementing the Flash Memory Erase Functions | |
27. Implement the OEMWriteFlash function. | Implementing the OEMWriteFlash Function | |
28. Modify the .bib file to produce a boot loader image that downloads to flash memory.
Note After you complete this step, you have completed development of a basic Ethernet boot loader that can download a run-time image to RAM or to flash memory. You can now add additional functionality to enhance the basic boot loader. The following list shows some of the additional functionality you can include in an enhanced boot loader:
Because the boot loader can have many variations, the following steps show only a few enhancements you can add to a basic boot loader. | Modifying the .bib File to Produce a Downloadable Image | |
29. To add support for download progress indication, implement the OEMShowProgress function. You do not need to add functionality to the OEMShowProgress function, but you must leave the stub version in your boot loader code to prevent errors when the compiler compiles the code. | Adding Support for Download Progress Indication | |
30. To verify the RAM or flash memory used by the run-time image before the run-time image is downloaded completely, add support for memory verification. | Adding Support for Memory Verification | |
31. If you are developing a multi-BIN run-time image and you would find multi-BIN run-time image notification useful, add support for multi-BIN run-time image notification. | Adding Support for Multiple-BIN Image Notification | |
32. To have your boot loader validate the run-time image before downloading or running it, add support for run-time image signatures. |