diff options
author | Harald Welte <laforge@gnumonks.org> | 2017-02-27 20:31:09 +0100 |
---|---|---|
committer | Harald Welte <laforge@gnumonks.org> | 2017-02-27 22:18:45 +0100 |
commit | d8a003dfd7dbef3d4772e750be34abd48def0072 (patch) | |
tree | eed57eca7603c84fd4f16a93a6766b29e5532ff3 /firmware/README.txt | |
parent | a1cd0f31c86d0b0eb3e3024e63eb10f1295c2525 (diff) |
Structure build system to build for multiple boards/apps/environments
Diffstat (limited to 'firmware/README.txt')
-rw-r--r-- | firmware/README.txt | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/firmware/README.txt b/firmware/README.txt new file mode 100644 index 0000000..67a28d9 --- /dev/null +++ b/firmware/README.txt @@ -0,0 +1,33 @@ + +== BOARDS + +A board defines a given circuit board, i.e. SIMtrace, OWHW, QMOD + +It defines the given hardware model for which the program is to be +compiled. + +Current boards supported are: +* simtrace: The good old Osmocom SIMtrace PCB with SAM3 instead of + SAM7, open hardware. +* qmod: A sysmocom-proprietary quad mPCIe carrier board, publicly available +* owhw: An undisclosed sysmocom-internal board, not publicly available + +== APPLICATIONS + +An application is a specific piece of software with given +functionality. + +== ENVIRONMENTS + +An environment is a runtime environment, typically defined by a linker +script. The current runtime environments include +* flash: Run natively from start of flash memory +* dfu: Run after a DFU bootloader from an offset after the first 16k + of flash (the first 16k are reserved for the bootloader) +* ram: Run from within the RAM of the chip, downloaded via JTAG/SWD + + +== Building + +A given software build is made for a specific combination of an APP +running in a certain ENVIRONMENT on a given BOARD. |