Skip to content

Latest commit

 

History

History
152 lines (99 loc) · 5.12 KB

RELEASE_NOTES.md

File metadata and controls

152 lines (99 loc) · 5.12 KB
Raw

VEE Port Release Notes for <BOARD_MANUFACTURER> <BOARD_NAME>

Description

This is the release notes of the VEE Port for <BOARD_NAME>.

Versions

VEE Port

<VEEPORT_VER>

Dependencies

This VEE Port contains the following dependencies:

Dependency Name Version
Architecture ()
... ...

Please refer to the VEE Port module description file for more details.

Board Support Package

  • BSP provider and name:
  • BSP version:

Please refer to the git repository available here.

Third Party Software

Third party software used in BSP can be found here. Here is a list of the most important ones:

RTOS
... ... ...

Features

Graphical User Interface

VEE Port features a graphical user interface. <It includes ...>

Display

<VEE Port features a XXX * XXX LCD display. The pixel format is XXX bits-per-pixel. The display device is clocked at XXXHz and it is connected to the MCU via a XXX link...>

MicroUI requires a RAM buffer to store the dynamic images data. A dynamic image is an image decoded at runtime (PNG image) or an image created by the Application using the Image.create(width, height) API. This buffer is located in external RAM.

Leds

Network

<VEE Port features a network interface with XXX as an underlying hardware media. A limited number of XXX sockets could be used for TCP connections, XXX for TCP listening (server) connections and XXX for UDP connections. A DHCP client can be activated to retrieve a dynamic IP address. All DNS requests are handled by the XXX TCP/IP stack.>

SSL

<VEE Port features a network secure interface. Available secured protocols are SSL 3.0, TLS 1.0, TLS 1.1, TLS 1., XXX. Supported keys and certificates formats are PKCS#5 and PKCS#12, PEM or DER encoded, XXX.>

File System

<VEE Port features a file system interface. XXX is used for the storage (previously formated to a XXX file system). Up to XXX files can be opened simultaneously.>

MISRA Compliance

This VEE Port has a list of components that are MISRA-compliant (MISRA C:2012) with some noted exception. Below is the list of folders that have been verified:

  • <microej/folder_1>
  • <microej/folder_2>

Among the folders verified, below is the list of files that have not been verified:

  • <microej/folder_1/file1>
  • <microej/folder_1/file2>
  • <microej/folder_2/file3>

It has been verified with Cppcheck v2.10. Here is the list of deviations from MISRA standard:

Deviation Category Justification
Rule x.y Required The justification of the deviation

Known Issues/Limitations

Known issues:

  • <Known issue 1>
  • <Known issue 2>

Limitations:

  • <Limitation issue 1>
  • <Limitation issue 2>

VEE Port Memory Layout

Memory Sections

Each memory section is described in the XXX linker file available here.

Memory Layout

Section Content Section Source Section Destination Memory Type
MicroEJ Application static .bss.soar .bss
MicroEJ Application threads stack blocks .bss.vm.stacks.java .ext_ram.bss
MicroEJ Core Engine internal heap ICETEA_HEAP .ext_ram.bss
MicroEJ Application heap _java_heap .ext_ram.bss
MicroEJ Application Immortal Heap _java_immortals .ext_ram.bss
MicroEJ Application resources .rodata.resources .rodata
MicroEJ System Applications code and resources .rodata.soar.features .rodata
MicroEJ System Application statics .bss.features.installed .ext_ram.bss
MicroEJ Shielded Plug data .shieldedplug .rodata
MicroEJ Application and Library code .text.soar .rodata
MicroUI frame buffer - .ext_ram.bss

<For the C heap, please refer to the <BOARD_MANUFACTURER> documentation available here>.

Information on MicroEJ memory sections can be found here.

Please also refer to the MicroEJ docs website page available here for more details.