Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating documentation celadon_IoT stable release A12 #276

Open
wants to merge 22 commits into
base: master
Choose a base branch
from

Conversation

usivarax
Copy link
Contributor

Update the Documentaion for A12 with Split for A11 & A12 Stable Releases IoT
-Android 11
- Feature Delta Offered by Stable Releases (IoT)
- User Guide -Android 12
- Feature Delta Offered by Stable Releases (IoT) - User Guide

Signed-off-by: Sivaramakrishnan, UdhayanX udhayanx.sivaramakrishnan@intel.com

@usivarax usivarax force-pushed the C_IoT_android12 branch 2 times, most recently from d92348a to 9b997d5 Compare December 14, 2022 08:00
Update the Documentaion for A12 with Split for A11 & A12
Stable Releases IoT
-Android 11
	- Feature Delta Offered by Stable Releases (IoT)
	- User Guide
-Android 12
	- Feature Delta Offered by Stable Releases (IoT)
        - User Guide

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
@@ -6,13 +6,13 @@ Stable Releases IoT
Stable Releases (IoT) is an Internet of Things (IoT) overlay on top of |C|. The
Stable Releases (IoT) release provides users with an extensive set of features on
Comet Lake (CML), Tiger Lake (TGL), and Elkhart Lake (EHL) platforms with a single
Baseline/Image.
Baseline/Image of Andoird 11 and Alder Lake (ADL) platforms with a single Baseline/Image of Andoird 12

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stable Releases (IoT) release provides users with an extensive set of features on
Android 11: Comet Lake (CML), Tiger Lake (TGL), and Elkhart Lake (EHL) platforms with a single Baseline/Image.
Android 12: Alder Lake (ADL) platforms with a single Baseline/Image.


Hardware details:

* HW Alder Lake (CML) NUC DUT details

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its ADL - Remove NUC


* GVT-d : Intel® Graphics Virtualization Technology -g (Intel® GVT-g): virtual
graphics processing unit (vGPU) (multiple VMs to one physical GPU)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add for SRIOV
SR-IOV: Single Root IO Virtualization


# This will install kernel and firmware, and update grub
# If prompted, answer y to go ahead with changes
$ sudo ./sriov_setup_kernel.sh

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add note for SRIOV related content available under NDA

Android 11 Stable Releases (IoT) is an Internet of Things (IoT) overlay on top of |C|. The
Stable Releases (IoT) release provides users with an extensive set of features on
Comet Lake (CML), Tiger Lake (TGL), and Elkhart Lake (EHL) platforms with a single
Baseline/Image of Andoird 11

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please correct typo with "Android"


Android 12 Stable Releases (IoT) is an Internet of Things (IoT) overlay on top of |C|. The
Stable Releases (IoT) release provides users with an extensive set of features on
Alder Lake (ADL) platforms with a single Baseline/Image of Andoird 12

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

correct typo with "Android"

@@ -6,13 +6,13 @@ Stable Releases IoT
Stable Releases (IoT) is an Internet of Things (IoT) overlay on top of |C|. The
Stable Releases (IoT) release provides users with an extensive set of features on
Comet Lake (CML), Tiger Lake (TGL), and Elkhart Lake (EHL) platforms with a single
Baseline/Image.
Baseline/Image of Andoird 11 and Alder Lake (ADL) platforms with a single Baseline/Image of Andoird 12

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

correct typo with "Android"

$ git checkout lts-v5.15.71-adl-linux-221121T044440Z

# copy kernel config
$ cd <source path>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this step is not needed, already inside linux-intel-lts directory


Hardware details:

* HW Alder Lake (CML) NUC DUT details

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is CML mentioned here?


Enable PCIe Wi-Fi Adapter Device in Guest VM:

.. code-block:: bash

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not parsed in page

Enable logging for Android 12 Guest VM:

.. code-block:: bash
# Edit the extra section of the configuration ini file at <workspace>/.intel/.civ.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not parsed in page

For Android 12 guest VM, edit the extra section of the configuration ini file at <workspace>/.intel/.civ

.. code-block:: bash
# different according to the use cases.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not parsed

Shutdown Android VM via Android ADB connection

.. code-block:: bash
# Connect via ADB from remote machine via host machine IP

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not parsed


* ADL: ALDER LAKE

* GVT-d : Intel® Graphics Virtualization Technology -g (Intel® GVT-g): virtual

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to acronym for SRIOV


Manifest Link: [YET TO UPDATE THE FINAL MANIFEST] https://github.com/projectceladon/manifest/blob/master/stable-build/CIV_XX.XX.XX.XX_A12.xml

Prerequisites and host kernel build steps:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

U may need sub headers to highlight the various sections like here.
This is not a problem for me cos I am familiar, but it may be confusing for new users

.. code-block:: bash

# Create symbolic link for Python if not already exists in ‘/usr/bin’ directory
$ sudo ln -s /usr/bin/python3 /usr/bin/python

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should remove this on python. It belongs to the section above

Build Celadon from Source :

.. code-block:: bash
# Create symbolic link for Python if not already exists in ‘/usr/bin’ directory

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parse error, this is not displayed

$ lunch caas-userdebug

# Start the build
# Without this flag, default architecture is silvermont which exercises sse4.1 features.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is wrong. A different guest kernel will be selected without "BASE_LTS2020_YOCTO_KERNEL=true".
Let's remove the comment



# Build output (CIV flashfiles)
$ find out/target/product/caas/ -name caas-flashfiles-*.zip

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment and the find command are both wrong.
We want to search fro the releasefiles, not the flashfiles.

# Edit the passthrough section of the configuration ini file at <workspace>/.intel/.civ
#[passthrough]
#specified the PCI id here if you want to passthrough it to guest, separate them with comma
$ passthrough_pci=0000:00:14.0,0000:00:14.1,0000:05:00.0,0000:07:00.0,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks wrong. It should be:

[passthrough]
#specified the PCI id here if you want to passthrough it to guest, separate them with comma
passthrough_pci=0000:00:14.0,0000:00:14.1,0000:05:00.0,0000:07:00.0,

For Android 12 guest VM, find the PCI ID of the Wi-Fi device

Enable logging for Android 12 Guest VM:
This section describes to debug logging

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 355 and 356 are displayed in a single line... looks wrong

$ sudo socat unix-connect:/tmp/civ1-console stdio

Launch Guest VM on Single Display and Full Screen Mode:
For Android 12 guest VM, edit the extra section of the configuration ini file at <workspace>/.intel/.civ

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 372 and 373 are displayed in single line, looks wrong


.. note::
The amount of memory and cores allocated might be different according to each platform.
And the combination of multiple Guest VMs and multiple displays might be

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is no multiple displays in this particular user guide. Please correct it



Shutdown VMs and System:
Shutdown Android VM via Android ADB connection

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 386 and 387 are displayed in a single line, looks wrong

Copy link

@basilchew basilchew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I will be on leave, I will remove the "Request changes" to avoid blocking any merge

Copy link

@basilchew basilchew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I will be on leave, removing "Request changes" to avoid blocking merge

Update userguide with manifest link
* 99.97% Google* conformance on Alder Lake (ADL)platform with production ready
* Supporting Alder Lake (ADL) on single baseline and Single Image
* IoT configuration support SRIOV mode with 99.97% conformance
* IoT configuration support GVT-d with no conformance

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove below line, not applicable to ADL. Aligned with Basu for this.

  • IoT configuration support GVT-d with no conformance

* 99.97% Google\* conformance on Alder Lake (ADL)platform with production ready
* Supporting Alder Lake (ADL) on single baseline and Single Image
* IoT configuration support SRIOV mode with 99.97% conformance
* IoT configuration support GVT-d with no conformance

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this line

  • IoT configuration support GVT-d with no conformance

Added Release information for Android 12 and made correctiones from
basil & Basana

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
usivarax added a commit to usivarax/celadon-documentation that referenced this pull request Jan 11, 2023
…lease

Split for stable_release-iot with Android 11 & 12 Android 11:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 11
Android 12:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 12
This PR is rebase PR, Follow below PR's for review comments
projectceladon#277
projectceladon#276

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
usivarax added a commit to usivarax/celadon-documentation that referenced this pull request Jan 11, 2023
…lease

Split for stable_release-iot with Android 11 & 12 Android 11:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 11
Android 12:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 12
This PR is rebase PR, Follow below PR's for review comments
projectceladon#277
projectceladon#276

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
usivarax added a commit to usivarax/celadon-documentation that referenced this pull request Jan 11, 2023
…lease

Split for stable_release-iot with Android 11 & 12 Android 11:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 11
Android 12:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 12
This PR is rebase PR, Follow below PR's for review comments
projectceladon#277
projectceladon#276

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
usivarax added a commit to usivarax/celadon-documentation that referenced this pull request Jan 11, 2023
…lease

Split for stable_release-iot with Android 11 & 12 Android 11:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 11
Android 12:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 12
This PR is rebase PR, Follow below PR's for review comments
projectceladon#277
projectceladon#276

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
usivarax added a commit to usivarax/celadon-documentation that referenced this pull request Jan 11, 2023
…lease

Split for stable_release-iot with Android 11 & 12 Android 11:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 11
Android 12:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 12
This PR is rebase PR, Follow below PR's for review comments
projectceladon#277
projectceladon#276

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
usivarax added a commit to usivarax/celadon-documentation that referenced this pull request Jan 12, 2023
…lease

Split for stable_release-iot with Android 11 & 12 Android 11:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 11
Android 12:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 12
This PR is rebase PR, Follow below PR's for review comments
projectceladon#277
projectceladon#276

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
usivarax added a commit to usivarax/celadon-documentation that referenced this pull request Jan 13, 2023
…lease

Split for stable_release-iot with Android 11 & 12 Android 11:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 11
Android 12:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 12
This PR is rebase PR, Follow below PR's for review comments
projectceladon#277
projectceladon#276

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
swaroopbalan pushed a commit that referenced this pull request Jan 17, 2023
…lease (#279)

Split for stable_release-iot with Android 11 & 12 Android 11:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 11
Android 12:
Feature Delta Offered by Stable Releases (IoT)
User Guide -Android 12
This PR is rebase PR, Follow below PR's for review comments
#277
#276

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>

Signed-off-by: Sivaramakrishnan, UdhayanX <udhayanx.sivaramakrishnan@intel.com>
@sysopenci sysopenci added the Stale Stale label for inactive open prs label Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Stale Stale label for inactive open prs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants