annotate wiki/Home.md @ 816:c4ee952b9425

Fix a bug that disables arbitrary menu lines in dive mode if lines are disabled / inactive in surface mode. (mikeller)
author heinrichsweikamp
date Sun, 10 Sep 2023 11:46:45 +0200
parents 0e7c16dd774d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
489
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
1 # Open Source Code for the OSTC4 Dive Computer #
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
2
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
3
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
4 ## Documentation ##
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
5
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
6 [Modules](Modules.md) page details the code organisation.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
7 [Hardware Resources](Hardware Resources.md) page details the hardware parts,
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
8 the low-level, and the middle-ware drivers used to manage them.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
9
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
10 ## How to Compile ? ##
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
11
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
12 Most of the code is written in _C-99_. A small glue is in assembly. Everything is compatible with
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
13 the _GCC_ toolchain for ARM processors.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
14
0e7c16dd774d add wiki sub-directory
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.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
16
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
17 ## Other Tools ##
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
18
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
19 * [STM32F429I-DISC1](http://www.st.com/en/evaluation-tools/32f429idiscovery.html)
0e7c16dd774d add wiki sub-directory
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).
0e7c16dd774d add wiki sub-directory
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.
0e7c16dd774d add wiki sub-directory
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..._
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
23
0e7c16dd774d add wiki sub-directory
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.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
25
0e7c16dd774d add wiki sub-directory
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_.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
27 It is connected through the JTAG/SWD interface.
0e7c16dd774d add wiki sub-directory
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 ?)
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
29
0e7c16dd774d add wiki sub-directory
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.
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
31
0e7c16dd774d add wiki sub-directory
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).
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
33 _Note that heinrichs weikamp will freely provide SWD OSTC4 platform to programmer serious about involving in code development._
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
34
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
35 ## Other Resources ##
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
36
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
37 * The **Ultimate Reference** for everyone serious about the OSTC4 firmware details
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
38 and _HAL_ programming (1800 pages): [UM1725 HAL Users Manual] https://www.st.com/resource/en/user_manual/dm00105879.pdf
0e7c16dd774d add wiki sub-directory
heinrichsweikamp
parents:
diff changeset
39 * Reserving memory from the linker script: https://mcuoneclipse.com/2012/11/01/defining-variables-at-absolute-addresses-with-gcc/
0e7c16dd774d add wiki sub-directory
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