Code Review / AGL / documentation.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Bulk documentation updates for needlefish
[AGL/documentation.git] / docs / 1_Hardware_Support / Overview.md
diff --git a/docs/1_Hardware_Support/Overview.md b/docs/1_Hardware_Support/Overview.md
index 86f0783..8c404f0 100644 (file)
--- a/docs/1_Hardware_Support/Overview.md
+++ b/docs/1_Hardware_Support/Overview.md
@@ -2,44 +2,49 @@
 title: Supported Boards
 ---
 
+
+
+AGL makes two types of hardware support available: Reference BSPs and Community BSPs.
+
+1) **Reference Boards** have Board Support Packages (BSPs) that are maintained by their sponsoring companies and are included in our Jenkins CI system. Reference BSPs have snapshot builds that are made available daily and are fully validated with test results made available for every major AGL release.
+
+2) **Community Boards** have BSPs that are maintained as a best effort by the AGL community based on upstream BSPs. Community Boards include some of the most-used Hobbyist boards such as older automotive boards.
+
 The following table briefs about the various hardware platforms, supported by AGL :
 
 ### AGL Reference Machines
 
-|      BOARD      |    $MACHINE    | ARCHITECHTURE |
-|:---------------:|:--------------:|:-------------:|
-|       QEMU      |   qemu-x86-64  |      x86      |
-|                 |    qemu-arm    |     arm 32    |
-|                 |   qemu-arm64   |     arm 64    |
+|      BOARD      |     MACHINE    | ARCHITECHTURE | QUICK START GUIDE|
+|:---------------:|:--------------:|:-------------:|:----------------:|
+|       QEMU      |   qemu-x86-64  |      x86      |[QEMU Quick Start](https://docs.automotivelinux.org/en/needlefish/#0_Getting_Started/1_Quickstart/Using_Ready_Made_Images/#_top)|
+|                 |    qemu-arm    |     arm32     |
+|                 |   qemu-arm64   |     arm64     |
 |                 |                |               |
-|    RCar Gen 3   |     h3ulcb     |     arm 64    |
-|                 | h3-salvator-x  |     arm 64    |
-|                 |      h3-kf     |     arm 64    |
-|                 |     m3ulcb     |     arm 64    |
-|                 | m3-salvator-x  |     arm 64    |
-|                 |      m3-kf     |     arm 64    |
+|    RCar Gen 3   |     h3ulcb     |     arm64     |[RCar Gen 3 Quick Start](https://docs.automotivelinux.org/en/needlefish/#0_Getting_Started/1_Quickstart/Using_Ready_Made_Images/#3-r-car-h3sk-h3ulcb-board)|
+|                 | h3-salvator-x  |     arm64     |
+|                 |      h3-kf     |     arm64     |
+|                 |     m3ulcb     |     arm64     |
+|                 | m3-salvator-x  |     arm64     |
+|                 |      m3-kf     |     arm64     |
+|                 |   agl-refhw    |     arm64     |
 |                 |                |               |
-|  Raspberry Pi   |  raspberrypi4  |     arm 64    |
-
-### Community supported Machines
-
-|    BOARD     |     $MACHINE          | ARCHITECHTURE |
-|:-------------:|:-----------------:|:-------------:|
-|  BeagleBone  |        bbe            |     arm 32    |
-|              |    beaglebone         |     arm 32    |
-|              |                       |               |
-|   i. MX 6    |      cubox-i          |     arm 32    |
-|              | imx6qdlsabreauto      |     arm 32    |
-|              |    nitrogen6x         |     arm 32    |
-|              |                       |               |
-|   i. MX 8    |     imx8mqevk         |     arm 64    |
-|              |   imx8mqevk-viv       |     arm 64    |
-|              |                       |               |
-|  Snapdragon  | dragonboard-410c      |     arm 64    |
-|              | dragonboard-820c      |     arm 64    |
-|              |                       |               |
-|    ARC HS    |       hsdk            |      ARC      |
+|  Raspberry Pi   |  raspberrypi4  |     arm64     |[Raspberry Pi Quick Start](https://docs.automotivelinux.org/en/needlefish/#0_Getting_Started/1_Quickstart/Using_Ready_Made_Images/#2-raspberry-pi-4)|
+
+
+### Community Supported Boards
 
+|    BOARD      |      MACHINE          | ARCHITECHTURE |
+|:-------------:|:---------------------:|:-------------:|
+|  BeagleBone   |        bbe            |     arm32     |
+|               |    beaglebone         |     arm32     |
+|               |                       |               |
+|   i.MX 6      |      cubox-i          |     arm32     |
+|               | imx6qdlsabreauto      |     arm32     |
+|               |                       |               |
+|   i.MX 8      |     imx8mqevk         |     arm64     |
+|               |   imx8mqevk-viv       |     arm64     |
+|               |                       |               |
+|     virtio    | virtio-aarch64        |     arm64     |
 
 ### Supported Images
 
@@ -49,9 +54,9 @@ AGL supports a variety of interfaces, each requiring unique setup configuration.
 
 **Supported boards** :
 
-AGL Reference Boards (QEMU, RCar Gen 3 & Raspberry Pi 4)
+AGL Reference Boards (QEMU, RCar Gen 3, agl-refhw & Raspberry Pi 4)
 
-Community supported Machines (i. MX 6, i. MX 8, Snapdragon & ARC HS)
+Community supported Machines (BBE, i. MX 6, i. MX 8)
 
 * Qt Based :
 
@@ -75,10 +80,10 @@ Community supported Machines (i. MX 6, i. MX 8, Snapdragon & ARC HS)
     * Setting up flags at `aglsetup` script :
 
         ```sh
-        $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo agl-profile-graphical-html5
+        $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo
 
-        #To enable Developer Options
-        $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo agl-profile-graphical-html5 agl-devel
+        # To enable Developer Options
+        $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo agl-devel
         ```
 
     * Building target image :
@@ -87,6 +92,24 @@ Community supported Machines (i. MX 6, i. MX 8, Snapdragon & ARC HS)
         $ time bitbake agl-demo-platform-html5
         ```
 
+* Flutter-based Image:
+
+    * Setting up flags at `aglsetup` script :
+
+        ```sh
+        $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo agl-flutter
+
+        # To enable Developer Options
+        $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo agl-flutter agl-devel
+        ```
+
+    * Building target image :
+
+        ```sh
+        $ time bitbake agl-ivi-demo-platform-flutter
+        ```
+
+
 
 #### 2. Instrument Cluster
 
@@ -97,10 +120,10 @@ AGL Reference Boards (QEMU, RCar Gen 3 & Raspberry Pi 4)
 * Setting up flags at `aglsetup` script :
 
     ```sh
-    $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-cluster-demo
+    $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo
 
-    #To enable Developer Options
-    $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-cluster-demo agl-devel
+    # To enable Developer Options
+    $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo agl-devel
     ```
 
 * Building target image :
@@ -121,14 +144,14 @@ Community supported Machines (BeagleBone)
 * Setting up flags at `aglsetup` script :
 
     ```sh
-    $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-telematics-demo
+    $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo
 
-    #To enable Developer Options
-    $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-telematics-demo agl-devel
+    # To enable Developer Options
+    $ source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b build-$MACHINE agl-demo agl-devel
     ```
 
 * Building target image :
 
     ```sh
     $ time bitbake agl-telematics-demo
-    ```
\ No newline at end of file
+    ```
This holds the documentation hosted on readthedocs.io