Difference between revisions of "Board Support Package"
(Created page with "embOS comes with board support packages for different device and evalboards. Further board support packages may easily be created on your own or can be requested by SEGGER. Us...") |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | embOS |
+ | Each embOS shipment contains various board support packages for different devices and evaluation boards. |
| + | Each board support package comes with the required initialization code to execute embOS on that device, as well as a sample project for the IDE of your choice. |
||
| − | Usually we suggest to start with one of these board support packages and add your application code to it. |
||
| − | This guidance covers the case you want to add embOS to an existing project. |
||
| − | === |
+ | === Introduction to embOS board support packages === |
| + | An embOS board support package (BSP) makes it easy to run embOS on a specific hardware. |
||
| − | If you evaluate embOS or your are working on a non commercial project you can download and use the embOS Free edition from [https://www.segger.com/downloads/embos]. |
||
| + | Although embOS for one specific core supports every device with that core, some device and board specific routines need to be implemented. |
||
| − | Once you licensed embOS you will get a download link to our download portal. In either case please download the zip file. |
||
| − | Extract the zip-file to any folder of your choice, preserving the directory structure of this file. Keep all files in their respective sub directories. |
||
| + | An embOS board support package consists of two parts: |
||
| − | === How can I add embOS to my existing project? === |
||
| + | * The required device and board specific software routines. |
||
| − | The following screenshots are taken from Embedded Studio but the description should work for other Compiler/IDEs as well. |
||
| + | * A project for your IDE with which embOS allows to execute on your hardware out of the box. |
||
| + | Most of the routines are specific to the selected device. For example, this includes |
||
| − | This is a simple project for a SEGGER emPower board (NXP K66FN2M0) without embOS: |
||
| + | * the startup code and vector table |
||
| + | * the interrupt controller initialization |
||
| + | * a hardware timer initialization |
||
| + | The optional board specific routines could be for example: |
||
| − | [[File:K66_emPower_SimpleProject.png|none|alt=Active Simple project]] |
||
| + | * LED initialization/control |
||
| + | * External memory initialization |
||
| + | * UART initialization for a specific board connector (used for embOSView) |
||
| + | An embOS BSP for one hardware may also be used on another hardware that features the same device, since most of the routines are device specific, but not board specific. <br> |
||
| + | The embOS BSP code is implemented as source code in the files ''RTOSInit.c'' and ''BSP.c''. |
||
| + | Further BSP files like ''BSP_Uart.c'' are optional. |
||
| + | === What's included === |
||
| − | As a first step please add the new folder "embOS" to your project and add the following files: |
||
| + | All necessary initialization code to run embOS and a project for the IDE of your choice. |
||
| − | # One embOS library from Start/Lib. |
||
| − | # All files from the according embOS BSP Setup folder, e.g. Start/BoardSupport/Segger/K66FN2M0_emPower/Setup. |
||
| − | # In case of Cortex-M all files from the BSP SEGGER folder, e.g. Start/BoardSupport/Segger/K66FN2M0_emPower/SEGGER. |
||
| + | === What's not included === |
||
| − | [[File:embOS_files.png|none|alt=Active Simple project]] |
||
| + | The embOS board support package does not include any code for additional peripherals like I²C or SPI.<br> |
||
| + | If those are required, hardware abstraction layers from your silicon vendor (e.g. [[Using_embOS_with_STM32CubeMX|STM32Cube HAL]]) seamlessly integrate with embOS. |
||
| + | === Where to find the BSPs in the embOS shipment === |
||
| + | Every embOS shipment includes a folder ''/Start/BoardSupport'', which includes further sub-folders grouped by silicon and board vendors. |
||
| + | In each of these sub-folders you will find one or more board support packages. Each board support package is named ''<device name>_<board name>''. |
||
| + | [[File:embOS_BSP_folders.png|none|alt=embOS BSP folders]] |
||
| − | Please add the following includes paths to your preprocessor settings and add the define "DEBUG=1: |
||
| + | === What shall I do when no BSP for my specific hardware was included with the embOS shipment? === |
||
| − | [[File:embOS_Includes.png|none|alt=Active Simple project]] |
||
| + | In case no BSP for your exact hardware was shipped with embOS, you may choose to: |
||
| + | * use a BSP for another evaluation board but with the same device |
||
| + | * create the BSP on your own |
||
| + | * contact SEGGER to create the BSP |
||
| + | In the latter case please send us detailed information about your hardware. |
||
| − | [[File:embOS_Defines.png|none|alt=Active Simple project]] |
||
| + | The hardware can be an evalboard or even your custom hardware. |
||
| + | === Conclusion === |
||
| + | If you want to run embOS on a specific device and hardware please select the according embOS port first. |
||
| + | This embOS port must support the core of your device and the compiler of your choice. |
||
| + | You can then check if an according BSP is already included. |
||
| + | In case of doubt please don't hesitate to contact us. |
||
| − | You can now use embOS in your application. Every embOS application files needs to include "RTOS.h". |
||
| − | You can also add the necessary code to create to your first task. Every task needs a separate task stack, a separate task control block and a task function. |
||
| − | The task simply executes the code from the main() function. |
||
| − | |||
| − | [[File:embOS_RTOS_h.png|none|alt=Active Simple project]] |
||
| − | |||
| − | [[File:embOS_Stack_TCB.png|none|alt=Active Simple project]] |
||
| − | |||
| − | The main() function needs to initialize the RTOS; the hardware, the task and to start embOS: |
||
| − | |||
| − | [[File:embOS_main.png|none|alt=Active Simple project]] |
||
| − | |||
| − | You can run this embOS application in hardware. |
||
Latest revision as of 11:07, 29 November 2022
Each embOS shipment contains various board support packages for different devices and evaluation boards. Each board support package comes with the required initialization code to execute embOS on that device, as well as a sample project for the IDE of your choice.
Contents
Introduction to embOS board support packages
An embOS board support package (BSP) makes it easy to run embOS on a specific hardware. Although embOS for one specific core supports every device with that core, some device and board specific routines need to be implemented.
An embOS board support package consists of two parts:
- The required device and board specific software routines.
- A project for your IDE with which embOS allows to execute on your hardware out of the box.
Most of the routines are specific to the selected device. For example, this includes
- the startup code and vector table
- the interrupt controller initialization
- a hardware timer initialization
The optional board specific routines could be for example:
- LED initialization/control
- External memory initialization
- UART initialization for a specific board connector (used for embOSView)
An embOS BSP for one hardware may also be used on another hardware that features the same device, since most of the routines are device specific, but not board specific.
The embOS BSP code is implemented as source code in the files RTOSInit.c and BSP.c.
Further BSP files like BSP_Uart.c are optional.
What's included
All necessary initialization code to run embOS and a project for the IDE of your choice.
What's not included
The embOS board support package does not include any code for additional peripherals like I²C or SPI.
If those are required, hardware abstraction layers from your silicon vendor (e.g. STM32Cube HAL) seamlessly integrate with embOS.
Where to find the BSPs in the embOS shipment
Every embOS shipment includes a folder /Start/BoardSupport, which includes further sub-folders grouped by silicon and board vendors. In each of these sub-folders you will find one or more board support packages. Each board support package is named <device name>_<board name>.
What shall I do when no BSP for my specific hardware was included with the embOS shipment?
In case no BSP for your exact hardware was shipped with embOS, you may choose to:
- use a BSP for another evaluation board but with the same device
- create the BSP on your own
- contact SEGGER to create the BSP
In the latter case please send us detailed information about your hardware. The hardware can be an evalboard or even your custom hardware.
Conclusion
If you want to run embOS on a specific device and hardware please select the according embOS port first. This embOS port must support the core of your device and the compiler of your choice. You can then check if an according BSP is already included.
In case of doubt please don't hesitate to contact us.
