FreeCalypso > hg > freecalypso-sw
diff doc/Compiling @ 864:4fa939eada22
documentation update: how to compile and flash experimental gsm-fw for gtamodem
author | Space Falcon <falcon@ivan.Harhan.ORG> |
---|---|
date | Sun, 10 May 2015 19:35:29 +0000 |
parents | aad742029813 |
children | 2d986b8c0e4e |
line wrap: on
line diff
--- a/doc/Compiling Sun May 10 05:28:05 2015 +0000 +++ b/doc/Compiling Sun May 10 19:35:29 2015 +0000 @@ -65,3 +65,58 @@ Run 'make all' in target-utils to build some other components that aren't really needed. + +Compiling FreeCalypso GSM firmware +================================== + +The firmware in our gsm-fw tree can be built in many different configurations, +hence there is no singular build for it. The configuration choices consist of: + +* Which target device the firmware should be built for: the target device + selection is made at compile time; do not attempt to take a firmware image + built for one target device and flash or fc-xram it into another! + +* What functionality is to be included. As the FreeCalypso firmware subproject + moves forward, we gradually add chunks of functionality, slowly approaching + what each target device is ultimately capable of. However, each time we add + a new piece of functionality, the ability to build a firmware image that works + like before, without the newly added functionality, still remains. Each + feature to be included needs to be explicitly selected. + +* Miscellaneous configuration: which Calypso UART should be used for what, + should the firmware use a real FFS (flash file system) in flash or a fake one + in RAM, etc. + +The GSM firmware build configuration is set by way of an editable text file +named build.conf; the configuration and build procedure is as follows: + +1. Look at the available repertoire of standard configurations under + gsm-fw/configs and choose which one you would like to use, either as-is or + as a basis for your own; + +2. Copy the configuration you selected to build.conf in the gsm-fw directory; + +3. Optionally edit it to taste - the configuration language is Bourne shell; + +4. Run 'make' in the gsm-fw directory. + +Depending on the configuration, either a flashable or a RAM-loadable image will +be built by default. A flashable image will appear in finlink/flashImage.bin; +these images are meant to be programmed with fc-loadtool's flash program-bin +command; the starting flash address at which the image needs to be programmed +depends on the target device - see target-specific notes. A RAM-loadable image +will appear in finlink/ramImage.srec; these images are meant to be loaded and +run with the fc-xram utility. + +It is possible to build either a flashable or a RAM-loadable image, or both, +without changing build.conf: run 'make flashImage' or 'make ramImage' as +desired. (The compilation of each module from source into a .o and all +intermediate linking steps are agnostic to whether a flashImage or a ramImage +is being built, only the very final link step differs.) Any otherwise working +configuration can be built into a flashImage, even if it makes no logical sense +to do so, but the ability to build a ramImage for a given configuration depends +on the code image size (which in turn depends on the selected feature set) and +the amount of RAM available on the target in question: most Calypso GSM devices +have small RAM, enough to satisfy a GSM firmware's data space requirements, but +not enough to hold the entire firmware code in RAM as well. Please see target- +specific notes for more details.