2017-05-17 13:15:09 -04:00
namespace QP {
2016-06-10 21:51:18 -04:00
/*##########################################################################*/
/*! @page exa_native Native Examples (Built-in Kernels)
2018-02-12 18:51:22 -05:00
<p>The QP/C++ framework contains real-time kernels (@ref comp_qv and @ref comp_qk), so it can run natively ("bare-metal") on single-chip microcontrollers, completely replacing a traditional RTOS. Click on the following links to see examples for the specified built-in kernels:
2016-06-10 21:51:18 -04:00
</p>
- @subpage exa_qv
- @subpage exa_qk
- @subpage exa_qxk
------------------------------------------------------------------------------
Click on the following links to see examples for the specified CPU architectures:
- @subpage exa_arm-cm
2017-02-07 19:55:33 -05:00
- @subpage exa_arm-cr
2016-06-10 21:51:18 -04:00
- @subpage exa_arm7-9
- @subpage exa_msp430
*/
/*##########################################################################*/
/*! @page exa_qv QV Kernel (Non-Preemptive, Priority-Based, Non-Blocking)
2015-05-14 16:05:04 -04:00
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
2016-06-10 21:51:18 -04:00
@note
You can hover the mouse cursor over the <span class="board"></span> icon in the list below to see the picture of the board.
- @ref arm-cm_blinky_ek-tm4c123gxl <a class="preview board" href="bd_EK-TM4C123GXL.jpg" title="EK-TM4C123GXL"></a>
- @ref arm-cm_blinky_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
- @ref arm-cm_dpp_ek-tm4c123gxl <a class="preview board" href="bd_EK-TM4C123GXL.jpg" title="EK-TM4C123GXL"></a>
- @ref arm-cm_dpp_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
- @ref arm-cm_dpp_mbed-lpc1768 <a class="preview board" href="bd_mbed-LPC1768.jpg" title="mbed-LPC1768"></a>
- @ref arm-cm_dpp_nucleo-l053r8 <a class="preview board" href="bd_nucleo-l053r8.jpg" title="NUCLEO-L053R8"></a>
- @ref arm-cm_dpp_nucleo-l152re <a class="preview board" href="bd_nucleo-l152re.jpg" title="NUCLEO-L152RE"></a>
- @ref arm-cm_game_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
2017-02-07 19:55:33 -05:00
- @ref arm-cm_dpp_stm32f746g-disco <a class="preview board" href="bd_STM32F746G-Disco.jpg" title="STM32F746G-Discovery"></a>
- @ref arm-cr_blinky_launchxl2-tms57012 <a class="preview board" href="bd_LAUNCHXL2-TMS57012.jpg" title="LAUNCHXL2-TMS57012"></a>
- @ref arm-cr_dpp_launchxl2-tms57012 <a class="preview board" href="bd_LAUNCHXL2-TMS57012.jpg" title="LAUNCHXL2-TMS57012"></a>
2016-06-10 21:51:18 -04:00
- @ref arm7-9_dpp_at91sam7s-ek <a class="preview board" href="bd_AT91SAM7S-EK.jpg" title="AT91SAM7S-EK"></a>
- @ref msp430_blinky_msp-exp430g2 <a class="preview board" href="bd_MSP-EXP430G2.jpg" title="MSP-EXP430G2"></a>
- @ref msp430_blinky_msp-exp430f5529lp <a class="preview board" href="bd_MSP-EXP430F5529LP.jpg" title="MSP-EXP430F5529LP"></a>
- @ref msp430_dpp_msp-exp430g2 <a class="preview board" href="bd_MSP-EXP430G2.jpg" title="MSP-EXP430G2"></a>
*/
/*##########################################################################*/
2018-02-12 18:51:22 -05:00
/*! @page exa_qk QK Kernel (Preemptive, Run-To-Completion/Non-Blocking)
2015-05-14 16:05:04 -04:00
2016-06-10 21:51:18 -04:00
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
2015-05-14 16:05:04 -04:00
@note
You can hover the mouse cursor over the <span class="board"></span> icon in the list below to see the picture of the board.
2016-06-10 21:51:18 -04:00
- @ref arm-cm_blinky_ek-tm4c123gxl <a class="preview board" href="bd_EK-TM4C123GXL.jpg" title="EK-TM4C123GXL"></a>
- @ref arm-cm_blinky_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
- @ref arm-cm_dpp_ek-tm4c123gxl <a class="preview board" href="bd_EK-TM4C123GXL.jpg" title="EK-TM4C123GXL"></a>
- @ref arm-cm_dpp_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
- @ref arm-cm_dpp_mbed-lpc1768 <a class="preview board" href="bd_mbed-LPC1768.jpg" title="mbed-LPC1768"></a>
- @ref arm-cm_dpp_nucleo-l053r8 <a class="preview board" href="bd_nucleo-l053r8.jpg" title="NUCLEO-L053R8"></a>
- @ref arm-cm_dpp_nucleo-l152re <a class="preview board" href="bd_nucleo-l152re.jpg" title="NUCLEO-L152RE"></a>
- @ref arm-cm_game_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
2017-02-07 19:55:33 -05:00
- @ref arm-cm_dpp_stm32f746g-disco <a class="preview board" href="bd_STM32F746G-Disco.jpg" title="STM32F746G-Discovery"></a>
2018-02-12 18:51:22 -05:00
- @ref arm-cm_dpp_nucleo-h743zi <a class="preview board" href="bd_NUCLEO-H743ZI.jpg" title="NUCLEO-H743ZI"></a>
2017-02-07 19:55:33 -05:00
- @ref arm-cr_blinky_launchxl2-tms57012 <a class="preview board" href="bd_LAUNCHXL2-TMS57012.jpg" title="LAUNCHXL2-TMS57012"></a>
- @ref arm-cr_dpp_launchxl2-tms57012 <a class="preview board" href="bd_LAUNCHXL2-TMS57012.jpg" title="LAUNCHXL2-TMS57012"></a>
2016-06-10 21:51:18 -04:00
- @ref arm7-9_dpp_at91sam7s-ek <a class="preview board" href="bd_AT91SAM7S-EK.jpg" title="AT91SAM7S-EK"></a>
- @ref msp430_blinky_msp-exp430g2 <a class="preview board" href="bd_MSP-EXP430G2.jpg" title="MSP-EXP430G2"></a>
- @ref msp430_blinky_msp-exp430f5529lp <a class="preview board" href="bd_MSP-EXP430F5529LP.jpg" title="MSP-EXP430F5529LP"></a>
- @ref msp430_dpp_msp-exp430g2 <a class="preview board" href="bd_MSP-EXP430G2.jpg" title="MSP-EXP430G2"></a>
*/
/*##########################################################################*/
2018-02-12 18:51:22 -05:00
/*! @page exa_qxk QXK Kernel (Preemptive, Run-To-Completion/Blocking)
2015-05-14 16:05:04 -04:00
2016-06-10 21:51:18 -04:00
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
2015-05-14 16:05:04 -04:00
2016-06-10 21:51:18 -04:00
@note
You can hover the mouse cursor over the <span class="board"></span> icon in the list below to see the picture of the board.
2015-05-14 16:05:04 -04:00
2016-06-10 21:51:18 -04:00
- @ref arm-cm_dpp_ek-tm4c123gxl <a class="preview board" href="bd_EK-TM4C123GXL.jpg" title="EK-TM4C123GXL"></a>
- @ref arm-cm_dpp_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
2017-02-07 19:55:33 -05:00
- @ref arm-cm_dpp_stm32f746g-disco <a class="preview board" href="bd_STM32F746G-Disco.jpg" title="STM32F746G-Discovery"></a>
2018-02-12 18:51:22 -05:00
- @ref arm-cm_dpp_nucleo-h743zi <a class="preview board" href="bd_NUCLEO-H743ZI.jpg" title="NUCLEO-H743ZI"></a>
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
2017-02-07 19:55:33 -05:00
/*! @page exa_arm-cm ARM Cortex-M (Cortex-M0/M0+/M3/M4/M7)
2015-05-14 16:05:04 -04:00
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
2016-06-10 21:51:18 -04:00
@note
You can hover the mouse cursor over the <span class="board"></span> icon in the list below to see the picture of the board.
2015-05-14 16:05:04 -04:00
- @subpage arm-cm_blinky_ek-tm4c123gxl <a class="preview board" href="bd_EK-TM4C123GXL.jpg" title="EK-TM4C123GXL"></a>
2016-06-10 21:51:18 -04:00
- @subpage arm-cm_blinky_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
2015-05-14 16:05:04 -04:00
- @subpage arm-cm_dpp_ek-tm4c123gxl <a class="preview board" href="bd_EK-TM4C123GXL.jpg" title="EK-TM4C123GXL"></a>
2016-06-10 21:51:18 -04:00
- @subpage arm-cm_dpp_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
2015-05-14 16:05:04 -04:00
- @subpage arm-cm_dpp_mbed-lpc1768 <a class="preview board" href="bd_mbed-LPC1768.jpg" title="mbed-LPC1768"></a>
- @subpage arm-cm_dpp_nucleo-l053r8 <a class="preview board" href="bd_nucleo-l053r8.jpg" title="NUCLEO-L053R8"></a>
- @subpage arm-cm_dpp_nucleo-l152re <a class="preview board" href="bd_nucleo-l152re.jpg" title="NUCLEO-L152RE"></a>
2017-02-07 19:55:33 -05:00
- @subpage arm-cm_dpp_stm32f746g-disco <a class="preview board" href="bd_STM32F746G-Disco.jpg" title="STM32F746G-Disco"></a>
2018-02-12 18:51:22 -05:00
- @subpage arm-cm_dpp_nucleo-h743zi <a class="preview board" href="bd_NUCLEO-H743ZI.jpg" title="NUCLEO-H743ZI"></a>
2016-06-10 21:51:18 -04:00
- @subpage arm-cm_game_efm32-slstk3401a <a class="preview board" href="bd_EFM32-SLSTK3401A.jpg" title="EFM32-SLSTK3401A"></a>
*/
/*##########################################################################*/
2017-02-07 19:55:33 -05:00
/*! @page exa_arm-cr ARM Cortex-R
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
@note
You can hover the mouse cursor over the <span class="board"></span> icon in the list below to see the picture of the board.
- @subpage arm-cr_blinky_launchxl2-tms57012 <a class="preview board" href="bd_LAUNCHXL2-TMS57012.jpg" title="LAUNCHXL2-TMS57012"></a>
- @subpage arm-cr_dpp_launchxl2-tms57012 <a class="preview board" href="bd_LAUNCHXL2-TMS57012.jpg" title="LAUNCHXL2-TMS57012"></a>
*/
/*##########################################################################*/
2016-06-10 21:51:18 -04:00
/*! @page exa_arm7-9 ARM7/ARM9 ("classic" ARM)
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
@note
You can hover the mouse cursor over the <span class="board"></span> icon in the list below to see the picture of the board.
- @subpage arm7-9_dpp_at91sam7s-ek <a class="preview board" href="bd_AT91SAM7S-EK.jpg" title="AT91SAM7S-EK"></a>
*/
/*##########################################################################*/
/*! @page exa_msp430 MSP430 ("classic" MSP430 and "extended" MSP430x)
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
@note
You can hover the mouse cursor over the <span class="board"></span> icon in the list below to see the picture of the board.
- @subpage msp430_blinky_msp-exp430g2 <a class="preview board" href="bd_MSP-EXP430G2.jpg" title="MSP-EXP430G2"></a>
- @subpage msp430_blinky_msp-exp430f5529lp <a class="preview board" href="bd_MSP-EXP430F5529LP.jpg" title="MSP-EXP430F5529LP"></a>
- @subpage msp430_dpp_msp-exp430g2 <a class="preview board" href="bd_MSP-EXP430G2.jpg" title="MSP-EXP430G2"></a>
2015-05-14 16:05:04 -04:00
*/
2018-02-12 18:51:22 -05:00
2015-05-14 16:05:04 -04:00
/*##########################################################################*/
/*! @page arm-cm_blinky_ek-tm4c123gxl Blinky on EK-TM4C123GXL
2018-02-12 18:51:22 -05:00
@tableofcontents
<p>This example implements the @ref blinky "Blinky sample application" on the EK-TM4C123GLX board (ARM Cortex-M4F).
</p>
2017-05-17 13:15:09 -04:00
@image html bd_EK-TM4C123GXL.jpg EK-TM4C123GXL board
2018-02-12 18:51:22 -05:00
The Blinky example is located in the directory <span class="img folder">qpc/examples/arm-cm/blinky_ek-tm4c123gxl</span>, which is organized as follows:
@code{.x}
qpc/ - QP/C++ installation directory
+-examples/ - QP/C++ examples directory (application)
| +-arm-cm/ - QP/C++ examples for ARM Cortex-M
| | +-blinky_ek-tm4c123gxl/ - Blinky example on the EK-TM4C123GLX board
| | | +-qk/ - QK version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-blinky-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-blinky-qk.eww - IAR EW-ARM workspace
| | | | +-bsp.c - BSP for the QK kernel
| | | +-qv/ - QV version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-blinky-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project with GNU-ARM
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-blinky-qk.eww - IAR EW-ARM workspace
| | | | +-bsp.c - BSP for the QV kernel
| | | +-win32/ - Windows emulation (multithreaded)
| | | | +-Makefile - Makefile for building the project with MinGW
| | | | +-bsp.c - BSP for the Win32
| | | +-win32-qv/ - Windows emulation (single thread)
| | | | +-Makefile - Makefile for building the project with MinGW
| | | | +-bsp.c - BSP for the Win32-QV
@endcode
------------------------------------------------------------------------------
@section arm-cm_blinky_ek-tm4c123gxl_feat Features Demonstrated
- cooperative QV kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
- preemptive run-to-completion QK kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
- Windows emulation (console multithreaded)
- Windows emulation (console, single threaded: win32-qv)
------------------------------------------------------------------------------
@section arm-cm_blinky_ek-tm4c123gxl_run Running the Example
Once programmed into the board, the example blinks the on-board LED about once a second.
2015-06-06 18:30:55 -04:00
@image html blinky_ek-tm4c123gxl.gif Blinky on EK-TM4C123GLX (TivaC LaunchPad)
2018-02-12 18:51:22 -05:00
------------------------------------------------------------------------------
@section arm-cm_blinky_ek-tm4c123gxl_win Windows Emulation
The Windows emulation is a simple console application that produces the following output:
2016-06-10 21:51:18 -04:00
@image html blinky_win32.png Blinky emulation running in a Windows console
2018-02-12 18:51:22 -05:00
@next{arm-cm_blinky_efm32-slstk3401a}
2016-06-10 21:51:18 -04:00
*/
/*##########################################################################*/
/*! @page arm-cm_blinky_efm32-slstk3401a Blinky on EFM32-SLSTK3401A
2018-02-12 18:51:22 -05:00
@tableofcontents
<p>This example implements the @ref blinky "Blinky sample application" on the EFM32-SLSTK3401A board (ARM Cortex-M4F).
</p>
2017-05-17 13:15:09 -04:00
@image html bd_EFM32-SLSTK3401A.jpg EFM32-SLSTK3401A board
2018-02-12 18:51:22 -05:00
The Blinky example is located in the directory <span class="img folder">qpc/examples/arm-cm/blinky_efm32-slstk3401a</span>, which is organized as follows:
@code{.x}
qpc/ - QP/C++ installation directory
+-examples/ - QP/C++ examples directory (application)
| +-arm-cm/ - QP/C++ examples for ARM Cortex-M
| | +-blinky_efm32-slstk3401a/ - Blinky example on the EFM32-SLSTK3401A board
| | | +-qk/ - QK version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-blinky-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-blinky-qk.eww - IAR EW-ARM workspace
| | | | +-bsp.c - BSP for the QK kernel
| | | +-qv/ - QV version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-blinky-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project with GNU-ARM
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-blinky-qk.eww - IAR EW-ARM workspace
| | | | +-bsp.c - BSP for the QV kernel
| | | +-win32/ - Windows emulation (multithreaded)
| | | | +-Makefile - Makefile for building the project with MinGW
| | | | +-bsp.c - BSP for the Win32
| | | +-win32-qv/ - Windows emulation (single thread)
| | | | +-Makefile - Makefile for building the project with MinGW
| | | | +-bsp.c - BSP for the Win32-QV
@endcode
------------------------------------------------------------------------------
@section arm-cm_blinky_efm32-slstk3401a_feat Features Demonstrated
- cooperative QV kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
- preemptive run-to-completion QK kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
- Windows emulation (console multithreaded)
- Windows emulation (console, single threaded: win32-qv)
------------------------------------------------------------------------------
@section arm-cm_blinky_efm32-slstk3401a_run Running the Example
Once programmed into the board, the example blinks the on-board LED about once a second.
------------------------------------------------------------------------------
@section arm-cm_blinky_efm32-slstk3401a_win Windows Emulation
The Windows emulation is a simple console application that produces the following output:
2016-06-10 21:51:18 -04:00
@image html blinky_win32.png Blinky emulation running in a Windows console
2018-02-12 18:51:22 -05:00
@next{arm-cm_dpp_ek-tm4c123gxl}
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
/*! @page arm-cm_dpp_ek-tm4c123gxl DPP on EK-TM4C123GXL
2018-02-12 18:51:22 -05:00
@tableofcontents
<p>This example implements the @ref dpp "Dining Philosophers Problem" sample application on the EK-TM4C123GLX board (ARM Cortex-M4F).
</p>
2017-05-17 13:15:09 -04:00
@image html bd_EK-TM4C123GXL.jpg EK-TM4C123GXL board
2015-05-14 16:05:04 -04:00
2018-02-12 18:51:22 -05:00
The DPP example is located in the directory <span class="img folder">qpc/examples/arm-cm/dpp_ek-tm4c123gxl</span>, which is organized as follows:
@code{.x}
qpc/ - QP/C++ installation directory
+-examples/ - QP/C++ examples directory (applications)
| +-arm-cm/ - QP/C++ examples for ARM Cortex-M
| | +-dpp_ek-tm4c123gxl/ - DPP example on the EK-TM4C123GLX board
| | | +-lint/ - PC-Lint version (static analysis of the application code)
| | | | +-lin.bat - batch file for running the PC-Lint
| | | | +-options.lnt - PC-Lint options file for the DPP application code
| | | +-qk/ - QK version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-dpp-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-dpp-qk.eww - IAR EW-ARM workspace
| | | | +-ti/ - TI-ARM toolchain (CCS)
| | | | | +-.ccsproject - CCS project
| | | | | +-.cproject - C Eclipse project
| | | | | +-.project - Eclipse project
| | | | +-bsp.c - BSP for the QK kernel
| | | | +-main.c - main() for the QK kernel
| | | +-qv/ - QV version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-dpp-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project with GNU-ARM
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-blinky-qk.eww - IAR EW-ARM workspace
| | | | +-bsp.c - BSP for the QV kernel
| | | | +-main.c - main() for the QV kernel
| | | +-qxk/ - QXK version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-dpp-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-dpp-qk.eww - IAR EW-ARM workspace
| | | | +-ti/ - TI-ARM toolchain (CCS)
| | | | | +-.ccsproject - CCS project
| | | | | +-.cproject - C Eclipse project
| | | | | +-.project - Eclipse project
| | | | +-bsp.c - BSP for the QXK kernel
| | | | +-main.c - main() for the QXK kernel
| | | | +-test.c - extended (blocking) test threads
| | | +-qspyview/ - visualization and monitoring for the DPP example
| | | | +-dpp.tcl - QSpyView specialization for the DPP
| | | | +-qspyview.bat - batch file for launching QSpyView for DPP
@endcode
------------------------------------------------------------------------------
@section arm-cm_dpp_ek-tm4c123gxl_feat Features Demonstrated
- cooperative QV kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
+ with TI-ARM toolchain (CCS)
- preemptive run-to-completion QK kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
+ with TI-ARM toolchain (CCS)
- preemptive dual-mode QXK kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
+ with TI-ARM toolchain (CCS)
- QP/Spy software tracing (output)
- QP/Spy software tracing (input QS-RX)
- Unit Testing with QUTest
- Windows emulation with GUI (multithreaded)
- Windows emulation with GUI (single threaded, win32-qv)
------------------------------------------------------------------------------
@section arm-cm_dpp_ek-tm4c123gxl_run Running the Example
Once programmed into the board, the example rapidly toggles the Blue LED from the idle loop (blue LED glows) and toggles the Red and Green LEDs as the Philosophers change their state. Additionally, you can depress and hold the SW1 button (left) to PAUSE the application (Table transitions into the "paused" state). Releasing the SW1 button causes transition back to the "serving" state.
------------------------------------------------------------------------------
@section arm-cm_dpp_ek-tm4c123gxl_qutest Unit Testing
The examples demonstrates the QUTest unit tests for the application.
------------------------------------------------------------------------------
@section arm-cm_dpp_ek-tm4c123gxl_spy QP/Spy Software Tracing
The application also demonstrates <a href="https://state-machine.com/qtools/qpspy.html" target="_blank" class="extern">QP/Spy</a> software tracing output and input. To exercise this feature, you need to build and upload the Spy build configuration into the board.
2015-05-14 16:05:04 -04:00
2016-06-10 21:51:18 -04:00
*/
/*##########################################################################*/
/*! @page arm-cm_dpp_efm32-slstk3401a DPP on EFM32-SLSTK3401A
2018-02-12 18:51:22 -05:00
@tableofcontents
<p>This example implements the @ref dpp "Dining Philosophers Problem" sample application on the EFM32-SLSTK3401A board (ARM Cortex-M4F).
</p>
2017-05-17 13:15:09 -04:00
@image html bd_EFM32-SLSTK3401A.jpg EFM32-SLSTK3401A board
2018-02-12 18:51:22 -05:00
The DPP example is located in the directory <span class="img folder">qpc/examples/arm-cm/dpp_efm32-slstk3401a</span> and includes versions for @ref qv "cooperative QV kernel", the @ref qk "preemptive QK kernel", and the @ref qxk "preemptive dual mode QXK RTOS kernel" each provided for the ARM-KEIL, GNU-ARM, and IAR-ARM. The following annotated directory listing describes the contents of the example folder:
@code{.x}
qpc/ - QP/C++ installation directory
+-examples/ - QP/C++ examples directory (application)
| +-arm-cm/ - QP/C++ examples for ARM Cortex-M
| | +-dpp_efm32-slstk3401a/ - DPP example on the EK-TM4C123GLX board
| | | +-lint/ - PC-Lint version (static analysis of the application code)
| | | | +-lin.bat - batch file for running the PC-Lint
| | | | +-options.lnt - PC-Lint options file for the DPP application code
| | | +-qk/ - QK version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-dpp-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-dpp-qk.eww - IAR EW-ARM workspace
| | | | +-bsp.c - BSP for the QK kernel
| | | | +-main.c - main() for the QK kernel
| | | +-qv/ - QV version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-dpp-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project with GNU-ARM
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-blinky-qk.eww - IAR EW-ARM workspace
| | | | +-bsp.c - BSP for the QV kernel
| | | | +-main.c - main() for the QV kernel
| | | +-qxk/ - QXK version
| | | | +-arm/ - ARM-KEIL toolchain
| | | | | +-dpp-qk.uvprojx - uVision project
| | | | +-gnu/ - GNU-ARM toolchain
| | | | | +-Makefile - Makefile for building the project
| | | | +-iar/ - IAR-ARM toolchain
| | | | | +-dpp-qk.eww - IAR EW-ARM workspace
| | | | +-bsp.c - BSP for the QXK kernel
| | | | +-main.c - main() for the QXK kernel
| | | | +-test.c - extended (blocking) test threads
| | | +-qspyview/ - visualization and monitoring for the DPP example
| | | | +-dpp.tcl - QSpyView specialization for the DPP
| | | | +-qspyview.bat - batch file for launching QSpyView for DPP
@endcode
------------------------------------------------------------------------------
@section arm-cm_dpp_efm32-slstk3401a_feat Features Demonstrated
- cooperative QV kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
- preemptive run-to-completion QK kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
- preemptive dual-mode QXK kernel
+ with ARM-KEIL toolchain
+ with GNU-ARM toolchain
+ with IAR-ARM toolchain
- QP/Spy software tracing (output)
- QP/Spy software tracing (input QS-RX)
- Unit Testing with QUTest
- Windows emulation with GUI (multithreaded)
- Windows emulation with GUI (single threaded, win32-qv)
------------------------------------------------------------------------------
@section arm-cm_dpp_efm32-slstk3401a_run Running the Example
Once programmed into the board, the example rapidly toggles the LED1 from the idle loop (LED1 glows) and toggles LED0 as the Philosophers change their state. Additionally, you can depress and hold the BTN0 button (left) to PAUSE the application (Table transitions into the "paused" state). Releasing the BTN0 button causes transition back to the "serving" state.
------------------------------------------------------------------------------
@section arm-cm_dpp_efm32-slstk3401a_spy QP/Spy Software Tracing
The application also demonstrates <a href="https://state-machine.com/qtools/qpspy.html" target="_blank" class="extern">QP/Spy</a> software tracing output and input. To exercise this feature, you need to build and upload the Spy build configuration into the board.
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
/*! @page arm-cm_dpp_mbed-lpc1768 DPP on mbed-LPC1768
2017-05-17 13:15:09 -04:00
@image html bd_mbed-LPC1768.jpg mbed-LPC1768 board
2015-05-14 16:05:04 -04:00
2018-02-12 18:51:22 -05:00
Dining Philosophers Problem (DPP) example for NXP LPC1768 MCU (Cortex-M3) with GNU-ARM toolchain.
2015-05-14 16:05:04 -04:00
2017-05-17 13:15:09 -04:00
@image html mbed-LPC1768_button.jpg Adding External Button to mbed-LPC1768
2015-06-06 18:30:55 -04:00
@n
@n
2017-05-17 13:15:09 -04:00
@image html under_construction.jpg
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
/*! @page arm-cm_dpp_nucleo-l053r8 DPP on NUCLEO-L053R8
2017-05-17 13:15:09 -04:00
@image html bd_nucleo-l053r8.jpg NUCLEO-L053R8 board
2015-05-14 16:05:04 -04:00
2018-02-18 12:08:21 -05:00
@ref dpp "Dining Philosophers Problem (DPP)" example for NUCLEO-L053R8 MCU (Cortex-M0+).
Demonstrated built-in kernels:
- cooperative @ref qv with ARM-Clang, ARM-Keil, GNU-ARM (Makefile and Atollic TRUEstudio), and IAR-ARM toolchains
- preemptive, run-to-completion @ref qk with ARM-Clang, ARM-Keil, GNU-ARM, and IAR-ARM toolchains
- dual-mode (run-to-completion/blocking) @ref qxk with ARM-Clang, ARM-Keil, GNU-ARM, and IAR-ARM toolchains
Features:
- multiple active objects, including 5 instances of the same AO class (Philo)
- extended threads (the QXK version)
- [QP/Spy software tracing](https://www.state-machine.com/qtools/qpspy.html) using the virtual COM-port
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
/*! @page arm-cm_dpp_nucleo-l152re DPP on NUCLEO-L152RE
2017-05-17 13:15:09 -04:00
@image html bd_nucleo-l152re.jpg NUCLEO-L152RE board
2015-05-14 16:05:04 -04:00
2018-02-18 12:08:21 -05:00
@ref dpp "Dining Philosophers Problem (DPP)" example for NUCLEO-L152RE MCU (Cortex-M3).
Demonstrated built-in kernels:
- cooperative @ref qv with ARM-Clang, ARM-Keil, GNU-ARM, and IAR-ARM toolchains
- preemptive, run-to-completion @ref qk with ARM-Clang, ARM-Keil, GNU-ARM, and IAR-ARM toolchains
Features:
- multiple active objects, including 5 instances of the same AO class (Philo)
- [QP/Spy software tracing](https://www.state-machine.com/qtools/qpspy.html) using the virtual COM-port
2015-05-14 16:05:04 -04:00
2017-02-07 19:55:33 -05:00
*/
/*##########################################################################*/
/*! @page arm-cm_dpp_stm32f746g-disco DPP on STM32F746G-Discovery
2017-05-17 13:15:09 -04:00
@image html bd_STM32F746G-Disco.jpg STM32F746G-Discovery
2017-02-07 19:55:33 -05:00
2018-02-12 18:51:22 -05:00
@ref dpp "Dining Philosophers Problem (DPP)" example for STM32F746G-Discovery (Cortex-M7).
Demonstrated built-in kernels:
- cooperative @ref qv with ARM-Keil, GNU-ARM, and IAR-ARM toolchains
- preemptive, run-to-completion @ref qk with ARM-Keil, GNU-ARM, and IAR-ARM toolchains
- dual-mode (run-to-completion/blocking) @ref qxk with ARM-Keil, GNU-ARM, and IAR-ARM toolchains
Features:
- multiple active objects, including 5 instances of the same AO class (Philo)
- extended threads (the QXK version)
- [QP/Spy software tracing](https://www.state-machine.com/qtools/qpspy.html) using the virtual COM-port
- bi-directional [QP/Spy](https://www.state-machine.com/qtools/qs.html#qs_rx) (sending commands to the target)
*/
/*##########################################################################*/
/*! @page arm-cm_dpp_nucleo-h743zi DPP on NUCLEO-H743ZI
@image html bd_NUCLEO-H743ZI.jpg NUCLEO-H743ZI
@ref dpp "Dining Philosophers Problem (DPP)" example for NUCLEO-H743ZI MCU (Cortex-M7).
Demonstrated built-in kernels:
2018-02-18 12:08:21 -05:00
- cooperative @ref qv with ARM-Clang, ARM-Keil, GNU-ARM (Makefile and Atollic TRUEstudio), and IAR-ARM toolchains
2018-02-12 18:51:22 -05:00
- preemptive, run-to-completion @ref qk with ARM-Clang, ARM-Keil, GNU-ARM, and IAR-ARM toolchains
- dual-mode (run-to-completion/blocking) @ref qxk with ARM-Clang, ARM-Keil, GNU-ARM, and IAR-ARM toolchains
Features:
- multiple active objects, including 5 instances of the same AO class (Philo)
- extended threads (the QXK version)
- [QP/Spy software tracing](https://www.state-machine.com/qtools/qpspy.html) using the virtual COM-port
- bi-directional [QP/Spy](https://www.state-machine.com/qtools/qs.html#qs_rx) (sending commands to the target)
2017-02-07 19:55:33 -05:00
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
2016-06-10 21:51:18 -04:00
/*! @page arm-cm_game_efm32-slstk3401a "Fly 'n' Shoot" Game on EFM32-SLSTK3401A
2015-05-14 16:05:04 -04:00
2017-05-17 13:15:09 -04:00
@image html bd_EFM32-SLSTK3401A.jpg EFM32-SLSTK3401A board
2015-05-14 16:05:04 -04:00
2018-02-12 18:51:22 -05:00
"Fly 'n' Shoot" game example for Silicon Labs Pearl Gecko MCU (Cortex-M4F), ARM (MDK-ARM), GNU-ARM, IAR EWARM toolchains.
2015-05-14 16:05:04 -04:00
2016-06-10 21:51:18 -04:00
@image html game_win32.png Game emulation running in Windows GUI
2015-06-06 18:30:55 -04:00
@n
@n
2017-05-17 13:15:09 -04:00
@image html under_construction.jpg
2015-05-14 16:05:04 -04:00
*/
2017-02-07 19:55:33 -05:00
/*##########################################################################*/
/*! @page arm-cr_blinky_launchxl2-tms57012 Blinky on LAUNCHXL2-TMS57012
2017-05-17 13:15:09 -04:00
@image html bd_LAUNCHXL2-TMS57012.jpg LAUNCHXL2-TMS57012
2017-02-07 19:55:33 -05:00
2018-02-12 18:51:22 -05:00
@ref blinky "Blinky" example for LAUNCHXL2-TMS57012 MCU (Cortex-R, Hercules) with IAR-ARM and TI toolchains.
2017-02-07 19:55:33 -05:00
2017-05-17 13:15:09 -04:00
@image html under_construction.jpg
2017-02-07 19:55:33 -05:00
*/
/*##########################################################################*/
/*! @page arm-cr_dpp_launchxl2-tms57012 DPP on LAUNCHXL2-TMS57012
2017-05-17 13:15:09 -04:00
@image html bd_LAUNCHXL2-TMS57012.jpg LAUNCHXL2-TMS57012
2017-02-07 19:55:33 -05:00
2018-02-12 18:51:22 -05:00
Dining Philosophers Problem (DPP) example for LAUNCHXL2-TMS57012 MCU (Cortex-R, Hercules) with IAR-ARM and TI toolchains.
2017-02-07 19:55:33 -05:00
2017-05-17 13:15:09 -04:00
@image html under_construction.jpg
2017-02-07 19:55:33 -05:00
*/
2015-05-14 16:05:04 -04:00
/*##########################################################################*/
/*! @page exa_arm7-9 ARM7 / ARM9
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
2018-02-12 18:51:22 -05:00
The native (bare-metal) QP/C++ examples for the "classic" ARM7/ARM9 are as follows:
2015-05-14 16:05:04 -04:00
- @subpage arm7-9_dpp_at91sam7s-ek <a class="preview board" href="bd_AT91SAM7S-EK.jpg" title="AT91SAM7S-EK"></a>
*/
/*##########################################################################*/
/*! @page arm7-9_dpp_at91sam7s-ek DPP on AT91SAM7S-EK
2017-05-17 13:15:09 -04:00
@image html bd_AT91SAM7S-EK.jpg AT91SAM7S-EK board
2015-05-14 16:05:04 -04:00
2018-02-12 18:51:22 -05:00
Dining Philosophers Problem (DPP) example for Atmel AT91SAM7S MCU (ARM7) with GNU-ARM toolchain.
2015-05-14 16:05:04 -04:00
2017-05-17 13:15:09 -04:00
@image html under_construction.jpg
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
/*! @page exa_msp430 MSP430
@htmlonly
<script src="preview.js" type="text/javascript"></script>
@endhtmlonly
2018-02-12 18:51:22 -05:00
The native (bare-metal) QP/C++ examples for MSP430 are as follows:
2015-05-14 16:05:04 -04:00
- @subpage msp430_blinky_msp-exp430g2 <a class="preview board" href="bd_MSP-EXP430G2.jpg" title="MSP-EXP430G2"></a>
- @subpage msp430_blinky_msp-exp430f5529lp <a class="preview board" href="bd_MSP-EXP430F5529LP.jpg" title="MSP-EXP430F5529LP"></a>
- @subpage msp430_dpp_msp-exp430g2 <a class="preview board" href="bd_MSP-EXP430G2.jpg" title="MSP-EXP430G2"></a>
*/
/*##########################################################################*/
/*! @page msp430_blinky_msp-exp430g2 Blinky on MSP-EXP430G2
2017-05-17 13:15:09 -04:00
@image html bd_MSP-EXP430G2.jpg MSP-EXP430G2 board
2015-05-14 16:05:04 -04:00
2018-02-12 18:51:22 -05:00
Simple Blinky example for MSP-EXP430G2 with CCS-430 and IAR-430 toolchains.
2015-05-14 16:05:04 -04:00
2017-05-17 13:15:09 -04:00
@image html under_construction.jpg
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
/*! @page msp430_blinky_msp-exp430f5529lp Blinky on MSP-EXP430F5529LP
2017-05-17 13:15:09 -04:00
@image html bd_MSP-EXP430F5529LP.jpg MSP-EXP430F5529LP board
2015-05-14 16:05:04 -04:00
2018-02-12 18:51:22 -05:00
Simple Blinky example for MSP-EXP430F5529LP with CCS-430 and IAR-430 toolchains.
2015-05-14 16:05:04 -04:00
2017-05-17 13:15:09 -04:00
@image html under_construction.jpg
2015-05-14 16:05:04 -04:00
*/
/*##########################################################################*/
/*! @page msp430_dpp_msp-exp430g2 DPP on MSP-EXP430G2
2017-05-17 13:15:09 -04:00
@image html bd_MSP-EXP430G2.jpg MSP-EXP430G2 board
2015-05-14 16:05:04 -04:00
2018-02-12 18:51:22 -05:00
DPP example for MSP-EXP430G2 with CCS-430 and IAR-430 toolchains.
2015-05-14 16:05:04 -04:00
@section msp430_dpp_msp-exp430g2_qs QS Output
This example demonstrates the QS software tracing output in the Spy build configuration. QS uses the hardware UART of the MSP-EXP430G2 board connected to the Virtual COM Port on the debugger. This means that you don't need any additional wiring to receive the QS output on your development workstation.
The QS trace date requires the following setting of the QSPY host utility
@verbatim
qspy -cCOM_PORT -b9600 -O2 -F2 -E1 -P1 -B1
2016-06-10 21:51:18 -04:00
@endverbatim
2015-05-14 16:05:04 -04:00
where `COM_PORT` denotes the Virtual COM port, which you can find out in the Device Manager (see the screen shot below):
2017-05-17 13:15:09 -04:00
@image html com_msp-exp430g2.png Virtual COM port of the MSP-EXP430G2 board
2015-05-14 16:05:04 -04:00
@note
2016-06-10 21:51:18 -04:00
To receive the QS data over the Virtual COM Port, you need to make sure that the jumper J3 on the MSP-EXP430G2 board is configured for the "Hardware UART" (the first two jumpers should be in the horizontal setting, as shown in the picture of the MSP-EXP430G2 board on top of this page.
2015-05-14 16:05:04 -04:00
2017-05-17 13:15:09 -04:00
@image html under_construction.jpg
2015-05-14 16:05:04 -04:00
*/
2017-05-17 13:15:09 -04:00
2015-05-22 20:38:16 -04:00
} // namespace QP