Difference between revisions of "Board Support Package"

From SEGGER Wiki
Jump to: navigation, search
m
Line 1: Line 1:
Every embOS shipment comes with board support packages for different devices and evalboards.
+
Each embOS shipment contains various board support packages for different devices and evaluation boards.
Each board support package comes with all required initialization code and a project for the IDE of your choice.
+
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.
   
=== What is an embOS board support package? ===
+
=== Introduction to embOS board support packages ===
 
An embOS board support package (BSP) makes it easy to run embOS on a specific hardware.
 
An embOS board support package (BSP) makes it easy to run embOS on a specific hardware.
Although embOS for a specific core supports every device with that core some device and board specific routines needs to be implemented.
+
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:
 
An embOS board support package consists of two parts:
* The necessary device and board specific software routines.
+
* The required device and board specific software routines.
* A project for your IDE with which embOS runs on your hardware out of the box.
+
* A project for your IDE with which embOS allows to execute on your hardware out of the box.
   
Most of the routines are device specific. These are for example:
+
Most of the routines are specific to the selected device. For example, this includes
* Startup code and vector table
+
* the startup code and vector table
* Interrupt controller initialization
+
* the interrupt controller initialization
* Hardware timer initialization
+
* a hardware timer initialization
   
 
The board specific routines are for example:
 
The board specific routines are for example:
 
* LED initialization/control
 
* LED initialization/control
 
* External memory initialization
 
* External memory initialization
* Uart initialization for a specific board connector (used for embOSView)
+
* UART initialization for a specific board connector (used for embOSView)
   
An embOS BSP can easily be used on another hardware with the same device since most of the routines are device but not board specific. <br>
+
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''.
 
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.
 
Further BSP files like ''BSP_Uart.c'' are optional.
   
=== What is included? ===
+
=== What's included ===
 
All necessary initialization code to run embOS and a project for the IDE of your choice.
 
All necessary initialization code to run embOS and a project for the IDE of your choice.
   
=== What is not included? ===
+
=== What's not included ===
The embOS board support package does not include any code for additional peripherals like I2C or SPI.
+
The embOS board support package does not include any code for additional peripherals like I²C or SPI.<br>
But silicon vendor hardware abstraction layer like STM32Cube HAL can easily be used with embOS.
+
If those are required, hardware abstraction layers from your silicon vendor (e.g. [[Using_embOS_with_STM32CubeMX|STM32Cube HAL]]) seamlessly integrate with embOS.
   
=== Where can I find the BSPs in the embOS shipment? ===
+
=== Where to find the BSPs in the embOS shipment ===
Every embOS shipment includes a folder ''/Start/BoardSupport''.
+
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>''.
The sub-folders consist of the supported silicon and board vendors.
 
In each sub-folder you find one or more board support packages.
 
Every board support package is named like ''<device name>_<board name>''.
 
   
 
[[File:embOS_BSP_folders.png|none|alt=embOS BSP folders]]
 
[[File:embOS_BSP_folders.png|none|alt=embOS BSP folders]]
   
  +
=== What shall I do when no BSP for my specific hardware was included with the embOS shipment? ===
 
=== What can I do when no BSP for my hardware exists? ===
+
In case no BSP for your exact hardware was shipped with embOS, you may choose to:
When no BSP for your hardware exists you can choose to:
+
* use a BSP for another evaluation board but with the same device
* Create the BSP on your own or use a BSP for another hardware but with the same device.
+
* create the BSP on your own
* Ask SEGGER to create the BSP.
+
* contact SEGGER to create the BSP
   
 
In the latter case please send us detailed information about your hardware.
 
In the latter case please send us detailed information about your hardware.
Line 49: Line 47:
   
 
=== Conclusion ===
 
=== Conclusion ===
If you like to run embOS on a specific device and hardware please select the according embOS port first.
+
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.
 
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.
 
You can then check if an according BSP is already included.

Revision as of 07:35, 8 June 2020

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.

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 board specific routines are 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>.

embOS BSP folders

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.