annotate wiki/Home.md @ 64:98b479d0618f

typo in info menu...
author heinrichsweikamp
date Tue, 14 Aug 2018 12:43:58 +0200
parents 5f11787b4f42
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
1 # Open Source Code for the OSTC4 Dive Computer #
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
2
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
3
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
4 ## Documentation ##
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
5
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
6 [Modules](Modules.md) page details the code organisation.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
7 [Hardware Ressources](Hardware Ressources.md) page details the hardware parts,
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
8 the low-level, and the middle-ware drivers used to manage them.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
9
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
10 ## How to Compile ? ##
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
11
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
12 Most of the code is written in _C-99_. A small glue is in assembly. Everything is compatible with
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
13 the _GCC_ toolchain for ARM processors.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
14
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
15 * [Using OpenSTM32](Using OpenSTM32.md), the free integrated IDE from the OpenSTM32 community, based on GCC cross compiler within an _Eclipse_ environment. Project management and configuration. Compile & Link. Hardware debugger through a JTAG/SWD probe.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
16
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
17 ## Other Tools ##
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
18
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
19 * [STM32F429I-DISC1](http://www.st.com/en/evaluation-tools/32f429idiscovery.html)
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
20 It is a chip (~ 20€) evaluation board, that contains a _STM32F429ZIT6_ CPU, 2MB flash ROM, 256KB RAM, a 320x240 LCD touch screen a few LEDs and a pair of buttons. Very cheap (~ 25 euro).
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
21 It should allows to run _OSTC4 Discovery code_, but just for basic testing as it lacks all specific sensors, LCD screen 800x640 resolution and the 3 interface buttons.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
22 _An interesting project would be to add a special compilation option to get some reasonable support on this chip debugging platform, emulating the screen and buttons..._
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
23
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
24 * [STM32 ST-LINK Utility](http://www.st.com/en/development-tools/stsw-link004.html) (**Windows only**) allow to do many things to the _discovery kit_ through its JTAG/SWD interface: upload & verify application code, dump memory. Provides both a _Graphical_ and a _Command Line_ interface.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
25
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
26 * [STMStudio](http://www.st.com/en/development-tools/stm-studio-stm32.html) (**WINDOWS ONLY**) allows real-time inspection of an application running on the _discovery kit_.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
27 It is connected through the JTAG/SWD interface.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
28 It allows to read and write variables defined in the application's binary (ELF file). To display or to trace graphs (eg. to display gas loading during dive simulation ?)
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
29
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
30 * [OpenOCD](http://openocd.org/) is another command utility to speak JTAG/SWD. Seems hard to use directly (very low level commands). But _OpenSTM32 IDE_ do use it for programming and debugging, and you can copy configuration files from a working project. Note version 0.10 (or above) seems mandatory to dump firmware contents.
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
31
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
32 * _**OSTC4 with 2 SWD connectors**_, the ultimate debugging tool: a specially made OSTC4, with a pair of extra SWD connectors you can connect to any JTAG/SWD probe. Cannot dive (absolutely not water tight), but allows to debug code on the real hardware (ie. set break points, single step the code and read/write variables), using a standard JTAG/SWD debuggers (eg. a low cost [ST-Link/V2](http://www.st.com/stlinkv2) for ~ 25 euro).
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
33 _Note that H&W will freely provide SWD OSTC4 platform to programmer serious about involving in code development._
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
34
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
35 ## Other Resources ##
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
36
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
37 * The **Ultimate Reference** for everyone serious about the OSTC4 firmware details
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
38 and _HAL_ programming (1800 pages): [UM1725 HAL Users Manual](www.st.com/resource/en/user_manual/dm00105879.pdf)
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
39 * Reserving memory from the linker script: https://mcuoneclipse.com/2012/11/01/defining-variables-at-absolute-addresses-with-gcc/
5f11787b4f42 include in ostc4 repository
heinrichsweikamp
parents:
diff changeset
40 * Placing a variable at an absolute address: https://sourceware.org/binutils/docs-2.24/ld/Source-Code-Reference.html#Source-Code-Reference