/*! @page exa Examples @htmlonly @endhtmlonly @tableofcontents @section exa_gen General Comments The QP/C distribution contains many @subpage exa_ref "example projects" to demonstrate various QP/C features. Each example project is described on its own dedicated page that you can find using several criteria (see @ref exa_ref). The example projects have the following main goals: - to help you learn how to use QP/C — the examples show the intended way of using QP/C features and structuring QP/C applications. - to provide you with a starting point for your own projects — the examples are complete working projects, with correctly pre-configured tools, such as compiler options, linker script, debugger setup, etc. @note It is highly recommended that you create your own projects by **copying and modifying** existing example projects rather than starting your QP/C projects from scratch.
@subsection exa_code Example Code Structure Starting with QP/C release 5.4.0, **all** examples are bundled into the QP/C download, as opposed to being distributed as separate QP Development Kits (QDKs). The main benefit is of this approach is that it greatly reduces chances of mistakes in combining the mainline QP/C code with various QDKs. The downside is that the QP/C distribution becomes quite large and that examples can't be added or updated independently from the QP/C baseline code. All examples are located in sub-directories of the examples top-level folder, with the hierarchical organization outlined below: @note Because the QP distribution contains *all* examples, the number of sub-directories and files in the examples folder may seem daunting. However, knowing the structure of the examples folder, you can simply **delete** the sub-directories that are not interesting to you.
@subsection exa_sec_apps Example Applications To demonstrate QP/C features on an embedded board, you need to create an application that does "something interesting". Instead of inventing this "something interesting" for each and every example, the example projects implement one of the three @subpage exa_apps "example applications", which are described on the separate pages: - @ref blinky - @ref dpp - @ref game With the exception of the game application, all other example applications can be implemented on a board with just a couple of LEDs. The @ref game application is a bit more involved and requires a small graphic display on the board. Beyond these basic applications for demonstrating and testing the various @ref ports "QP/C ports", the QP/C distribution contains all examples described in the book Practical UML Statecharts in C/C++, 2nd Edition. @sa @ref exa_win32
@subsection exa_sec_boards Development Boards While some provided examples can run on your @ref exa_os "desktop computer", most embedded example projects require special hardware in form of @ref exa_sec_boards, which you need to acquire to be able to run the examples. The boards chosen for the examples are generally inexpensive and self-contained with no need for external hardware (such as external JTAG debuggers or power supplies).
@subsection exa_sec_tools Development Tools Most provided examples require special embedded cross-development tools, such as embedded compilers, linkers, debuggers and IDEs, which you need to acquire independently from the QP/C distribution. Generally, the examples work with the free (size limited) evaluation versions of the commercial tools. The examples list the versions of tools they were developed and tested with. Please refer to the @ref exa_ref "cross-reference section" @ref exa_sec_tools to see which embedded toolchains are used.
@subsection exa_sec_conf Build Configurations QP examples @ref ports "QP ports" are provided in the following three **build configurations**: - **Debug** — this configuration is built with full debugging information and minimal optimization. When the QP framework finds no events to process, the framework busy-idles until there are new events to process. The @ref comp_qs "QS trace instrumentation" is **disabled**. - **Release** — this configuration is built with no debugging information and high optimization. Single-stepping and debugging at the source-code level is effectively impossible due to the lack of debugging information and optimized code, but the debugger can be used to download and start the executable. When the QP framework finds no events to process, the framework puts the CPU to sleep until there are new events to process. The @ref comp_qs "QS trace instrumentation" is **disabled**. - **Spy** — like the debug variant, this variant is built with full debugging information and minimal optimization. Additionally, it is build with the @ref comp_qs "QS trace instrumentation" enabled. The on-board serial port and the Q-Spy host application are used for sending and viewing trace data. Like the Debug configuration, the QP framework busy-idles until there are new events to process. @remark Why do you need multiple build configurations?@n The different phases of embedded software life cycle pose different challenges. During the development and maintenance phase, for example, the emphasis is on the ease of debugging and verifying the correctness of the code, which require lower levels of optimization and special scaffolding code. In contrast, for releasing the code in the final product, the emphasis is on small memory footprint and CPU time efficiency, which require high-level of optimization and removal of any scaffolding code. To address these conflicting needs, the same source code is compiled into multiple **build configurations** that differ in the use of compiler options and activation of the scaffolding code.
@subsection exa_sec_qm QM Models Many example projects contain code auto-generated by the QM modeling tool. Such projects always contain the corresponding **QM model** file, which you can open in QM, modify, and re-generate the code. @note The auto-generated files are saved as **read-only**. This protects them from inadvertent modifications, which will get lost when the files are re-generated by QM (or QMC). All modifications to the auto-generated code should be done in the QM model, not in the code.
@subsection exa_sec_3rd Third-Party Code The QP/C example projects often need to use various additional code, such as MCU register definition files, startup code, device drivers, etc., which are provided by Third-Party vendors. All such code is located in the 3rd_party top-level folder. @note As far as possible, the code in the 3rd_party folder has been left unchanged from the original source. (Any modified code is clearly identified by top-level comments that detail the applied changes.) For that reason, the Third-Party code might produce **compilation warnings** in your builds. The code in the 3rd_party folder comes from various sources, and Quantum Leaps, LLC expressly makes **no claims of ownership** to any of this code, even though some of the code might be customized or modified by Quantum Leaps. @attention The Third-Party software components included in the 3rd_party folder are licensed under a variety of different licensing terms that are defined by the respective owners of this software and are spelled out in the `README.txt` or `LICENSE.txt` files included in the respective sub-folders. ------------------------------------------------------------------------------ @section exa_own Creating your Own QP/C Projects Perhaps the most important fact of life to remember is that in embedded systems nothing works until everything works. This means that you should always start with a working system and gradually evolve it, changing one thing at a time and making sure that it keeps working every step of the way. Keeping this in mind, the provided QP/C application examples, such as the super-simple Blinky, or a bit more advanced @ref dpp or @ref game, allow you to get started with a working project rather than starting from scratch. You should also always try one of the provided example projects on the same evaluation board that it was designed for, before making any changes. Only after convincing yourself that the example project works "as is", you can think about creating your own projects. At this point, the easiest and recommended way is to copy the existing working example project folder (such as the Blinky example) and rename it. After copying the project folder, you still need to change the name of the project/workspace. The easiest and safest way to do this is to open the project/workspace in the corresponding IDE and use the Save As... option to save the project under a different name. You can do this also with the QM model file, which you can open in QM and "Save As" a different model. @note By copying and re-naming an existing, working project, as opposed to creating a new one from scratch, you inherit the correct compiler and linker options an other project settings, which will help you get started much faster. ------------------------------------------------------------------------------ @section exa_doc Next Steps and Further Reading About QP and QM To work with QP/C effectively, you need to learn a bit more about active objects and state machines. Below is a list of links to enable you to further your knowledge: 1. The book “Practical UML Statecharts in C/C++, 2nd Edition” [PSiCC2] and the companion web-page to the book (https://www.state-machine.com/psicc2/ 2. Free Support Forum for QP/QM (https://sourceforge.net/p/qpc/discussion/668726 ) 3. QP Code Downloads summary (https://www.state-machine.com/downloads ) 4. QP Application Notes (https://www.state-machine.com/doc/an ) 5. "State Space" Blog (http://embeddedgurus.com/state-space/ ) @next{exa_ref} */ /*##########################################################################*/ /*! @page exa_ref Cross-Reference @htmlonly @endhtmlonly @tableofcontents ------------------------------------------------------------------------------ @section exa_ref_kernel Native Examples (by Built-in Kernel) - @ref exa_qv - @ref exa_qk - @ref exa_qxk ------------------------------------------------------------------------------ @section exa_ref_tool Native Examples (by Development Toolchain) @n @subsection exa_ref_arm-clang ARM-Clang Toolchain (ARM Compiler 6) - @ref arm-cm_dpp_nucleo-l053r8   (Cortex-M0+) - @ref arm-cm_dpp_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_stm32f746g-disco   (Cortex-M7) - @ref arm-cm_dpp_nucleo-h743zi   (Cortex-M7)
@subsection exa_ref_arm-keil ARM-Keil Toolchain (ARM Compiler 5) - @ref arm-cm_blinky_ek-tm4c123gxl   (Cortex-M4) - @ref arm-cm_blinky_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_ek-tm4c123gxl   (Cortex-M4) - @ref arm-cm_dpp_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_mbed-lpc1768   (Cortex-M4) - @ref arm-cm_dpp_nucleo-l053r8   (Cortex-M0+) - @ref arm-cm_dpp_nucleo-l152re   (Cortex-M3) - @ref arm-cm_game_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_stm32f4-discovery - @ref arm-cm_dpp_stm32f746g-disco   (Cortex-M7)
@subsection exa_ref_gnu-arm GNU-ARM (command-line with Makefile, importable to Eclipse) - @ref arm-cm_blinky_ek-tm4c123gxl   (Cortex-M4) - @ref arm-cm_blinky_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_ek-tm4c123gxl   (Cortex-M4) - @ref arm-cm_dpp_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_mbed-lpc1768   (Cortex-M4) - @ref arm-cm_dpp_nucleo-l053r8   (Cortex-M0+) - @ref arm-cm_dpp_nucleo-l152re   (Cortex-M3) - @ref arm-cm_game_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_stm32f4-discovery - @ref arm-cm_dpp_stm32f746g-disco   (Cortex-M7) - @ref lwip_ek-lm3s6965   (Cortex-M3) - @ref arm7-9_dpp_at91sam7s-ek   (ARM7TDMI)
@subsection exa_ref_gnu-ccs GNU-ARM with TI CCS IDE - @ref arm-cm_dpp_ek-tm4c123gxl   (Cortex-M4)
@subsection exa_ref_iar-arm IAR EWARM - @ref arm-cm_blinky_ek-tm4c123gxl   (Cortex-M4) - @ref arm-cm_blinky_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_ek-tm4c123gxl   (Cortex-M4) - @ref arm-cm_dpp_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_mbed-lpc1768   (Cortex-M4) - @ref arm-cm_dpp_nucleo-l053r8   (Cortex-M0+) - @ref arm-cm_dpp_nucleo-l152re   (Cortex-M3) - @ref arm-cm_game_efm32-slstk3401a   (Cortex-M4) - @ref arm-cm_dpp_stm32f746g-disco   (Cortex-M7) - @ref arm-cr_blinky_launchxl2-tms57012   (Cortex-R4) - @ref arm-cr_dpp_launchxl2-tms57012   (Cortex-R4) - @ref lwip_ek-lm3s6965   (Cortex-M3) - @ref arm7-9_dpp_at91sam7s-ek   (ARM7TDMI)
@subsection exa_ref_ti-arm TI ARM with CCS IDE - @ref arm-cm_dpp_ek-tm4c123gxl   (Cortex-M4) - @ref arm-cr_blinky_launchxl2-tms57012   (Cortex-R4) - @ref arm-cr_dpp_launchxl2-tms57012   (Cortex-R4)
@subsection exa_ref_ccs-430 CCS for MSP430 - @ref msp430_blinky_msp-exp430g2 - @ref msp430_dpp_msp-exp430g2
@subsection exa_ref_iar-430 IAR EW430 - @ref msp430_blinky_msp-exp430g2 - @ref msp430_blinky_msp-exp430f5529lp - @ref msp430_dpp_msp-exp430g2 ------------------------------------------------------------------------------ @section exa_ref_native Native Examples (by Processor) - @ref exa_arm-cm - @ref exa_arm-cr - @ref exa_arm7-9 ("classic ARM") - @ref exa_msp430 ("classic" MSP430 and "extended" MSP430x) ------------------------------------------------------------------------------ @section exa_ref_rtos Examples for Third-Party RTOS - @ref exa_embos (SEGGER) - @ref exa_freertos (Amazon Web Services) - @ref exa_threadx (Express Logic) - @ref exa_ti-rtos (Texas Instruments) - @ref exa_ucos-ii (Micrium/SiLabs) ------------------------------------------------------------------------------ @section exa_ref_os Examples for Third-Party OS - @ref exa_posix - @ref exa_win32 - @ref exa_win32-qv ------------------------------------------------------------------------------ @section exa_ref_mware Examples for Third-Party Middleware - @ref exa_lwip (open source, see http://lwip.wikia.com/wiki/LwIP_Wiki ) - @ref exa_emwin (SEGGER, a.k.a. uC/GUI by Micrium) ------------------------------------------------------------------------------ @section exa_ref_boards Examples by Development Board The boards chosen for the examples are generally inexpensive and self-contained with minimal need for external hardware (such as external JTAG debuggers or power supplies). Also, all the selected boards provide a virtual COM port (ideally) or can be easily connected to a TTL-to-USB serial converter cable for @ref comp_qs "QS software tracing" output. @note You can hover the mouse cursor over the    icon in the list below to see the picture of the board. - ARM Cortex-M Boards: - EK-TM4C123GXL   (TivaC LaunchPad) - EFM32-SLSTK3401A - mbed-LPC1768 - NUCLEO-L053R8 - NUCLEO-L152RE - EK-LM3S6965 - NUCLEO-H743ZI - STM32F4-Discovery - STM32F746G-Discovery - NUCLEO-L152RE - ARM Cortex-R Boards: - LAUNCHXL2-TMS57012 - ARM7 Boards: - AT91SAM7S-EK - MSP430 Boards: - MSP-EXP430G2   (MSP430 LaunchPad) - MSP-EXP430F5529LP   (MSP430X LaunchPad) ------------------------------------------------------------------------------ @section exa_ref_mcu Examples by MCU Architecture - ARM Cortex-M0/M0+ - @ref arm-cm_dpp_nucleo-l053r8 - ARM Cortex-M3 - @ref arm-cm_dpp_nucleo-l152re - @ref arm-cm_dpp_mbed-lpc1768 - @ref lwip_ek-lm3s6965 - ARM Cortex-M4 (with hardware FPU) - @ref arm-cm_blinky_ek-tm4c123gxl - @ref arm-cm_blinky_efm32-slstk3401a - @ref arm-cm_dpp_ek-tm4c123gxl - @ref arm-cm_dpp_efm32-slstk3401a - @ref arm-cm_game_efm32-slstk3401a - @ref arm-cm_dpp_stm32f4-discovery - ARM Cortex-M7 (with hardware single-precision FPU) - @ref arm-cm_dpp_stm32f746g-disco - ARM Cortex-M7 (with hardware double-precision FPU) - @ref arm-cm_dpp_nucleo-h743zi - ARM Cortex-R - @ref arm-cr_blinky_launchxl2-tms57012 - @ref arm-cr_dpp_launchxl2-tms57012 - ARM7 / ARM9 - @ref arm7-9_dpp_at91sam7s-ek - MSP430 - @ref msp430_blinky_msp-exp430g2 - @ref msp430_blinky_msp-exp430f5529lp - @ref msp430_dpp_msp-exp430g2 ------------------------------------------------------------------------------ @section exa_ref_vendor Examples by MCU Vendor - Atmel - @ref arm7-9_dpp_at91sam7s-ek - NXP - @ref arm-cm_dpp_mbed-lpc1768 - Silicon Labs - @ref arm-cm_blinky_efm32-slstk3401a - @ref arm-cm_dpp_efm32-slstk3401a - @ref arm-cm_game_efm32-slstk3401a - ST Microelectronics - @ref arm-cm_dpp_nucleo-l053r8 - @ref arm-cm_dpp_nucleo-l152re - @ref arm-cm_dpp_stm32f4-discovery - @ref arm-cm_dpp_stm32f746g-disco - Texas Instruments - @ref arm-cm_blinky_ek-tm4c123gxl - @ref arm-cm_dpp_ek-tm4c123gxl - @ref arm-cm_game_efm32-slstk3401a - @ref arm-cr_blinky_launchxl2-tms57012 - @ref arm-cr_dpp_launchxl2-tms57012 - @ref lwip_ek-lm3s6965 @next{exa_native} */