Merge branch 'feature/docs-move-release-notes' into 'main'

docs: Split release notes and update content

See merge request !34

docs/mkdocs.yml

-site_name: Kontron Electronics Docs - Meta Kontron
+site_name: Kontron Electronics Docs - Meta KED BSP
 
 repo_url: 'https://git.kontron-electronics.de/sw/ked/meta-ked-bsp'
 docs_dir: src
@@ -31,4 +31,6 @@ nav:
  - Prerequisites: prerequisites.md
  - Build: build.md
  - Customization: customization.md
- - Release Information: release.md
+ - Release Information:
+     - v6.1.0-dev: release/6.1.0.md
+     - v6.0.0: release/6.0.0.md

docs/src/release.md → docs/src/release/6.0.0.md

-# Release Information
+## Initial Release 6.0.0
 
 !!! info "Prebuilt Image Download"
 
@@ -7,81 +7,26 @@
     you can find download links for prebuilt binary images for our reference
     hardware.
 
-## Changes from 6.0.0 to 6.1.0-dev (work in progress)
-
-### Integrated Components
-
-* Yocto 4.0 LTS "Kirkstone" (4.0.10). Layers compatible with 3.1 LTS "Dunfell"
-* Linux 6.1 LTS (6.1.29+) with KED backports and patches
-* U-Boot 2023.04 with KED backports and patches
-
-### Supported Hardware
-
-| Product Numbers | Product Name | Product Type | Status |
-| --------------- | ------------ | ------------ | ------ |
-| 40099 122 | SL i.MX6 UL | SoM | Not Supported (Unverified) |
-| 40099 145 | SL i.MX6 ULL | SoM | Not Supported (Unverified) |
-| 40099 167 | SL STM32 MP157 | SoM | Not Supported (Planned) |
-| 40099 175<br>40099 185<br>40099 242<br>40099 212 | SL i.MX8M Mini Quad | SoM | Supported |
-| 40099 227<br>40099 229<br>40099 239<br>40099 231 | OSM-S i.MX8M Mini Quad | SoM | Supported |
-| 41099 248 | OSM-S i.MX8M Plus | SoM | Not Supported (Planned) |
-| 40099 148 | BL i.MX6 ULL | Board | Not Supported (Unverified) |
-| 40099 176 | BL STM32 MP157 | Board | Not Supported (Planned) |
-| 40099 187<br>40099 220 | BL i.MX8M-Mini Quad | Board | Supported (Basic[^1]) |
-
-### Common changes for all plattforms
-
-- Start of virtual terminal on tty0 deactivated in ktn distro (`USE_VT = "0"`)
-  
-### Changes for i.MX8 plattform
-
-- none
-
-### Changes for i.MX6 plattform
-
-- Added support for DPI display interface on BL boards (configuration `imx6ull-kontron-dl`)
-- u-boot: Default device tree boot configuration changed from `imx6ul-kontron-bl`
-  to `imx6ull-kontron-dl`
-- linux: Changes in kernel config
-  - Virtual terminals deactivated (`CONFIG_VT`)
-  - Most resistive touch drivers removed
-
-### Changes for STM32 MP1 plattform
-
-- none
-
-### Breaking Changes
-
-- i.MX6: Default u-boot configuration changed from SOC `ul` variant to `ull`
-  variant. So for `ul` variants the boot config has to be adapted manually in
-  u-boot environment now!
-
-### Known Issues
-
-Currently none
-
-## v6.0.0
-
 !!! note "Version Number"
 
     The v6.0 release is the first version of the BSP. We are using this
     version number to indicate that this is the successor of the legacy
     i.MX Dunfell BSP with version number v5.0.
 
-### General
+### General Information
 
 * Usage of `kas` integration tool, replacing the custom scripts used in previous
   BSPs
 * Usage of a new monorepo `meta-ked-bsp`, replacing the build and meta layer
   repositories used in previous BSPs
 
-### Components
+### Integrated Components
 
 * Yocto 4.0 LTS "Kirkstone" (layers compatible with 3.1 LTS "Dunfell")
 * Linux 6.1 LTS with KED backports and patches
 * U-Boot 2023.04 with KED backports and patches
 
-### Hardware
+### Supported Hardware
 
 | Product Numbers | Product Name | Product Type | Status |
 | --------------- | ------------ | ------------ | ------ |
@@ -95,7 +40,7 @@ Currently none
 | 40099 176 | BL STM32 MP157 | Board | Not Supported (Planned) |
 | 40099 187<br>40099 220 | BL i.MX8M-Mini Quad | Board | Supported (Basic[^1]) |
 
-### Breaking Changes compared to Dunfell BSP (5.0)
+### Breaking Changes Compared to Dunfell BSP (5.0)
 
 * SPL and U-Boot proper images are now merged into a single `flash.bin` instead
   of two separate images.
@@ -112,6 +57,13 @@ Currently none
 * The onboard USB hub on the BL i.MX8MM doesn't work in U-Boot.
 * The A/B boot scheme can be bricked by multiple updates with a broken kernel
   image.
+* The fw_getenv/setenv tools can't deal with the different possibilities for
+  the location of the U-Boot environment on i.MX8MM (SPI NOR, SD card, eMMC).
+* If the U-Boot environment for i.MX8MM is placed in the eMMC hardware partition
+  (boot0) it is not aligned to the end of the partition, but uses the same
+  fixed offset as on SPI NOR and SD card.
+* There is misconfigured dependency that requires the `xxd` tool to be installed
+  on the build host/container.
 
 [^1]: Basic support doesn't include all features of the board. Especially
       advanced peripherals like display, graphics, hardware acceleration units,

docs/src/release/6.1.0.md

+## Changes from 6.0.0 to 6.1.0-dev (work in progress)
+
+### Integrated Components
+
+* Yocto 4.0 LTS "Kirkstone" (4.0.10). Layers compatible with 3.1 LTS "Dunfell"
+* Linux 6.1 LTS (6.1.29+) with KED backports and patches
+* U-Boot 2023.04 with KED backports and patches
+
+### Supported Hardware
+
+| Product Numbers | Product Name | Product Type | Status |
+| --------------- | ------------ | ------------ | ------ |
+| 40099 122 | SL i.MX6 UL | SoM | Not Supported (Unverified) |
+| 40099 145 | SL i.MX6 ULL | SoM | Not Supported (Unverified) |
+| 40099 167 | SL STM32 MP157 | SoM | Not Supported (Planned) |
+| 40099 175<br>40099 185<br>40099 242<br>40099 212 | SL i.MX8M Mini Quad | SoM | Supported |
+| 40099 227<br>40099 229<br>40099 239<br>40099 231 | OSM-S i.MX8M Mini Quad | SoM | Supported |
+| 41099 248 | OSM-S i.MX8M Plus | SoM | Not Supported (Planned) |
+| 40099 148 | BL i.MX6 ULL | Board | Not Supported (Unverified) |
+| 40099 176 | BL STM32 MP157 | Board | Not Supported (Planned) |
+| 40099 187<br>40099 220 | BL i.MX8M-Mini Quad | Board | Supported (Basic[^1]) |
+
+### Core/Distro Changes (all HW Platforms)
+
+* Start of virtual terminal on `tty0` deactivated in `ked` distro (`USE_VT =
+  "0"`)
+* Small CI improvements
+* Fix `xxd` host tool dependency (move to `goodix-touchconfig` recipe)
+
+### Changes for i.MX Platforms
+
+* Improve devshell settings for `u-boot-ktn` and `linux-ktn`
+* Enable `CONFIG_DYNAMIC_DEBUG` in `linux-ktn`
+* Fix an issue with fitImage selection in A/B boot flow
+
+#### Changes for i.MX8 Platform
+
+* none
+
+#### Changes for i.MX6 Platform
+
+* Added support for DPI display interface on BL boards (configuration `imx6ull-kontron-dl`)
+* u-boot: Default device tree boot configuration changed from `imx6ul-kontron-bl`
+  to `imx6ull-kontron-dl`
+* linux: Changes in kernel config
+  * Virtual terminals deactivated (`CONFIG_VT`)
+  * Most resistive touch drivers removed
+
+### Changes for STM32MP1 Platform
+
+* none
+
+### Breaking Changes
+
+* i.MX6: Default u-boot configuration changed from SOC `ul` variant to `ull`
+  variant. So for `ul` variants the boot config has to be adapted manually in
+  u-boot environment now!
+
+### Known Issues
+
+* The onboard USB hub on the BL i.MX8MM doesn't work in U-Boot.
+* The fw_getenv/setenv tools can't deal with the different possibilities for
+  the location of the U-Boot environment on i.MX8MM (SPI NOR, SD card, eMMC).
+* If the U-Boot environment for i.MX8MM is placed in the eMMC hardware partition
+  (boot0) it is not aligned to the end of the partition, but uses the same
+  fixed offset as on SPI NOR and SD card.
+
+[^1]: Basic support doesn't include all features of the board. Especially
+      advanced peripherals like display, graphics, hardware acceleration units,
+      camera interfaces, etc. might not be supported or tested yet.