Merge pull request #717 from ArsalanHAwan/release-hardknott-vermeer-ga-202110hardknott-vermeer-ga-202110

release/hardknott-vermeer-ga-202110: add release docs and tag

4 files changed, 49 insertions, 19 deletions

diff --git a/CUSTOMIZE.md b/CUSTOMIZE.md
index 71eeffc9..76156f27 100644
--- a/CUSTOMIZE.md
+++ b/CUSTOMIZE.md
@@ -55,6 +55,32 @@ EXTRA_IMAGE_FEATURES_append = " tools-profile"
 RT_KERNEL_AMD = "yes"
 ```
 
+Furthermore, the `vermeer` platform does not have an on-board RS232
+serial port. Therefore, the graphical console is enabled on this
+machine by default and the user is required to interact with the
+machine using a display device plugged into a dGPU connected via the
+PCIe slot.
+
+In case the user does not have a dGPU, and wants to interact with the
+machine over the RS232 serial interface, the user needs to have an
+`LPC to UART Adapter` module plugged into the LPC header on the
+motherboard.
+
+Using a serial cable connected between the host machine's RS232 port
+and this module, the user will be able to interact with the machine
+using the serial interface, but will still not be able to install the
+OS to a harddrive using the serial interface. For that, the graphical
+console has to be disabled. In order to achieve that, add the
+following to the `local.conf` and rebuild an image.
+
+```sh
+MACHINE_FEATURES_remove = "screen-console"
+```
+
+The resulting image will have no graphical console support and will
+only have the serial console support. After this, the user will also
+be able to install the OS to a harddrive using the serial interface.
+
 ---
 #### What's next
 
diff --git a/FEATURES.md b/FEATURES.md
index 9165c6f1..0c0057f2 100644
--- a/FEATURES.md
+++ b/FEATURES.md
@@ -20,7 +20,7 @@ on this machine.
 |                                 | NVMe                                    | Y     | Y    | Y       |
 |                                 | M.2 SATA                                |       |      | Y       |
 |                                 | I2C                                     | Y     | Y    | Y       |
-|                                 | UART                                    | Y     | Y    | Y       |
+|                                 | UART                                    | Y     | Y    |         |
 |                                 | eMMC                                    |       |      |         |
 |                                 | SMP                                     | Y     | Y    | Y       |
 |                                 | SPI                                     | Y     | Y    | Y       |
@@ -28,7 +28,8 @@ on this machine.
 |                                 | USB Host                                | Y     | Y    | Y       |
 |                                 | USB Mass Storage                        | Y     | Y    | Y       |
 |                                 | Audio                                   |       |      |         |
-|                                 | UART                                    | Y     | Y    | Y       |
+|                                 | UART                                    | Y     | Y    | Y*      |
+|                                 | _* via LPC to UART Adapter module_      |       |      |         |
 |                                 | Bluetooth                               |       |      |         |
 |                                 | USB Wi-Fi                               |       |      |         |
 |                                 | HDD/SATA                                | Y     | Y    | Y       |
diff --git a/RELEASE.md b/RELEASE.md
index 65019784..635923f1 100644
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -1,24 +1,24 @@
 # Release notes
 
-This is the release notes document for the AMD machine ETHANOLX. This document
+This is the release notes document for the AMD machine VERMEER. This document
 contains information about the Yocto layers' git repos, their branches
 and commit hashes, software versions, and known/fixed issues/limitations.
 
 ## Bitbake layers
 | Layer             | Git Repo                                     | Branch    | Commit Hash/Tag                          |
 |:------------------|:---------------------------------------------|:----------|:-----------------------------------------|
-| poky              | git://git.yoctoproject.org/poky              | hardknott | tags/yocto-3.3                           |
-| meta-openembedded | git://git.openembedded.org/meta-openembedded | hardknott | cf5bd6a8308108b4313a1e45ce8aa87e73125bf9 |
-| meta-dpdk         | git://git.yoctoproject.org/meta-dpdk         | master    | c011004a49ffb1304f376f0fdc65066913102d5f |
-| meta-amd          | git://git.yoctoproject.org/meta-amd          | hardknott | tags/hardknott-ethanolx-ga-202107                                     |
+| poky              | git://git.yoctoproject.org/poky              | hardknott | tags/yocto-3.3.2                         |
+| meta-openembedded | git://git.openembedded.org/meta-openembedded | hardknott | aaa1c12b2cdea197d420953c8df873e8af5cc507 |
+| meta-dpdk         | git://git.yoctoproject.org/meta-dpdk         | hardknott | c011004a49ffb1304f376f0fdc65066913102d5f |
+| meta-amd          | git://git.yoctoproject.org/meta-amd          | hardknott | tags/hardknott-vermeer-ga-202110                                     |
 
 ## Software versions
 | Software        | Version  |
 |:----------------|:---------|
-| Yocto Poky base | 3.3      |
+| Yocto Poky base | 3.3.2    |
 | grub            | 2.06-rc1 |
-| linux-yocto     | 5.10.25  |
-| linux-yocto-rt  | 5.10.25  |
+| linux-yocto     | 5.10.47  |
+| linux-yocto-rt  | 5.10.47  |
 | gcc             | 10.2.0   |
 | util-linux      | 2.36.2   |
 | lttng           | 2.12     |
@@ -29,13 +29,16 @@ and commit hashes, software versions, and known/fixed issues/limitations.
 | strongswan      | 5.9.2    |
 
 ## Fixed issues
-| __ETHANOLX Fixed Issues__ |
-|:--------------------------|
-| None                      |
+| __VERMEER Fixed Issues__ |
+|:-------------------------|
+| None                     |
 
 ## Known issues
-| __ETHANOLX Known Issues/Limitations__                                                       |
-|:--------------------------------------------------------------------------------------------|
-| Network is detected from only one NIC card when two NIC cards are connected on the platform |
-| AMD SPI Kernel Driver fails to access the SPI ROM registers                                 |
-| _** Workaround: Disable ‘Rom Armor’ setting under ‘Chipset’ tab in BIOS_                    |
+| __VERMEER Known Issues/Limitations__                                                                                                                                                                            |
+|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| The Qogir board for Vermeer does not have an RS232/UART serial port/header.                                                                                                                                     |
+| _** Workaround: Use an LPC to UART Adapter module for serial communication_                                                                                                                                     |
+| The serial communication from a host machine with Vermeer using an LPC to UART Adapter module may not work properly with some hosts because the module lacks Hardware Flow Control signals such as CTS and RTS. |
+| _** Workaround: Connect the RTS & CTS pins on the host side with each other in order to achieve a No Handshake based serial communication_                                                                      |
+| Install option in the GRUB menu does not work by default using the serial interface and only works on the graphical console.                                                                                    |
+| _** Workaround: Disable the graphical console by setting `MACHINE_FEATURES_remove = “screen-console”` in the `local.conf` and rebuild an image_                                                                 |
diff --git a/SETUP.md b/SETUP.md
index 752c576d..4e589640 100644
--- a/SETUP.md
+++ b/SETUP.md
@@ -48,7 +48,7 @@ git checkout --quiet aaa1c12b2cdea197d420953c8df873e8af5cc507
 cd ../meta-dpdk
 git checkout --quiet c011004a49ffb1304f376f0fdc65066913102d5f
 cd ../meta-amd
-git checkout --quiet HEAD
+git checkout --quiet tags/hardknott-vermeer-ga-202110
 cd ..
 ```