Merge pull request #95 from vicharak-in/utsav

Update Vicharak Vaaman linux docs
vicharak-in · Nov 17, 2023 · b966dd7 · b966dd7
2 parents 1ac64d9 + 2a1824a
commit b966dd7
Show file tree

Hide file tree

Showing 34 changed files with 930 additions and 225 deletions.
diff --git a/.spelling b/.spelling
@@ -88,11 +88,26 @@ update_defconfig
 init
 gpios
 submodule
+multimediacard
+ums
+debian
+yocto
+kirkstone
+mickledore
+rockdev
  - source/vaaman-linux/linux-development-guide/u-boot.md
 build-u-boot
 idbloader.img
 rk3399_loader_v1.xx.xxx.bin
 flash-u-boot
+mainline-u-boot-important
+7zip
+mmcblk
+mmcblkX
+rm
+resizepart
+dd
+u-boot-rockchip
  - source/vaaman-linux/linux-development-guide/linux-kernel.md
 modules_install
 INSTALL_MOD_DIR
@@ -112,6 +127,31 @@ wipe_all-misc
 rockchip_rk3399_recovery
 userdata.img
 u
+debian-bullseye-v1
+ubuntu-focal-v1
+ubuntu-jammy-v1
+yocto-kirkstone-v1
+yocto-mickledore-v1
+buildroot-v1
+android-12
+1-v1
+RK_ROOTFS_SYSTEM
+RK_UBUNTU_VERSION
+xfce
+UBUNTU_FLAVOR
+VICHARKA_BOOT_ENABLE_OVERLAYS
+packbuild.shdevice
+mkRK_UBUNTU_VERSIONjammydevice
+RK_DEBIAN_VERSION
+lxde
+DEBIAN_FLAVOR
+linaro-rootfs
+bitbake
+core-image-sato
+core-image-weston
+wayland
+extboot
+updateimg
  - source/vaaman-linux/linux-configuration-guide/change-uboot-logo.md
 logo.h
  - source/vaaman-linux/linux-usage-guide/linux-start-guide.md
@@ -213,5 +253,9 @@ GPIO_66
 GPIO_62
 RX29_CLK2_N
 1500000bps
+40-pin
+40-FPGA
  - source/vaaman-linux/linux-usage-guide/custom-linux-kernel.md
 dd
+ - source/vaaman-linux/linux-usage-guide/u-boot-ums.md
+u-boot-ums-mode
diff --git a/source/_static/css/custom.css b/source/_static/css/custom.css
@@ -1,5 +1,5 @@
 body {
-	font-family: "Inter", "Manrope", sans-serif !important;
+	font-family: "Geist", "Inter", sans-serif !important;
 }
 
 .contents .caption,

diff --git a/source/_static/css/fonts.css b/source/_static/css/fonts.css
@@ -1,51 +1,65 @@
 @font-face {
-  font-family: "Manrope";
+  font-family: "Geist";
+  font-style: normal;
+  font-display: auto;
+  font-weight: 100;
+  src: url("../fonts/Geist-UltraLight.woff2") format("woff2");
+}
+@font-face {
+  font-family: "Geist";
   font-style: normal;
   font-display: auto;
   font-weight: 200;
-  src: url("../fonts/Manrope-ExtraLight.woff2") format("woff2");
+  src: url("../fonts/Geist-Thin.woff2") format("woff2");
 }
 @font-face {
-  font-family: "Manrope";
+  font-family: "Geist";
   font-style: normal;
   font-display: auto;
   font-weight: 300;
-  src: url("../fonts/Manrope-Light.woff2") format("woff2");
+  src: url("../fonts/Geist-Light.woff2") format("woff2");
 }
 @font-face {
-  font-family: "Manrope";
+  font-family: "Geist";
   font-style: normal;
   font-display: auto;
   font-weight: 400;
-  src: url("../fonts/Manrope-Regular.woff2") format("woff2");
+  src: url("../fonts/Geist-Regular.woff2") format("woff2");
 }
 @font-face {
-  font-family: "Manrope";
+  font-family: "Geist";
   font-style: normal;
   font-display: auto;
   font-weight: 500;
-  src: url("../fonts/Manrope-Medium.woff2") format("woff2");
+  src: url("../fonts/Geist-Medium.woff2") format("woff2");
 }
 @font-face {
-  font-family: "Manrope";
+  font-family: "Geist";
   font-style: normal;
   font-display: auto;
   font-weight: 600;
-  src: url("../fonts/Manrope-SemiBold.woff2") format("woff2");
+  src: url("../fonts/Geist-SemiBold.woff2") format("woff2");
 }
 @font-face {
-  font-family: "Manrope";
+  font-family: "Geist";
   font-style: normal;
   font-display: auto;
   font-weight: 700;
-  src: url("../fonts/Manrope-Bold.woff2") format("woff2");
+  src: url("../fonts/Geist-Bold.woff2") format("woff2");
 }
 @font-face {
-  font-family: "Manrope";
+  font-family: "Geist";
   font-style: normal;
   font-display: auto;
   font-weight: 800;
-  src: url("../fonts/Manrope-ExtraBold.woff2") format("woff2");
+  src: url("../fonts/Geist-Black.woff2") format("woff2");
+}
+@font-face {
+  font-family: "Geist";
+  font-style: normal;
+  font-display: auto;
+  font-weight: 1000;
+  src: url("../fonts/Geist-UltraBlack.woff2") format("woff2");
 }
 
 @font-face {

diff --git a/source/_static/fonts/Geist-Black.woff2 b/source/_static/fonts/Geist-Black.woff2
diff --git a/source/_static/fonts/Geist-Bold.woff2 b/source/_static/fonts/Geist-Bold.woff2
diff --git a/source/_static/fonts/Geist-Light.woff2 b/source/_static/fonts/Geist-Light.woff2
diff --git a/source/_static/fonts/Geist-Medium.woff2 b/source/_static/fonts/Geist-Medium.woff2
diff --git a/source/_static/fonts/Geist-Regular.woff2 b/source/_static/fonts/Geist-Regular.woff2
diff --git a/source/_static/fonts/Geist-SemiBold.woff2 b/source/_static/fonts/Geist-SemiBold.woff2
diff --git a/source/_static/fonts/Geist-Thin.woff2 b/source/_static/fonts/Geist-Thin.woff2
diff --git a/source/_static/fonts/Geist-UltraBlack.woff2 b/source/_static/fonts/Geist-UltraBlack.woff2
diff --git a/source/_static/fonts/Geist-UltraLight.woff2 b/source/_static/fonts/Geist-UltraLight.woff2
diff --git a/source/_static/fonts/Manrope-Bold.woff2 b/source/_static/fonts/Manrope-Bold.woff2
diff --git a/source/_static/fonts/Manrope-ExtraBold.woff2 b/source/_static/fonts/Manrope-ExtraBold.woff2
diff --git a/source/_static/fonts/Manrope-ExtraLight.woff2 b/source/_static/fonts/Manrope-ExtraLight.woff2
diff --git a/source/_static/fonts/Manrope-Light.woff2 b/source/_static/fonts/Manrope-Light.woff2
diff --git a/source/_static/fonts/Manrope-Medium.woff2 b/source/_static/fonts/Manrope-Medium.woff2
diff --git a/source/_static/fonts/Manrope-Regular.woff2 b/source/_static/fonts/Manrope-Regular.woff2
diff --git a/source/_static/fonts/Manrope-SemiBold.woff2 b/source/_static/fonts/Manrope-SemiBold.woff2
diff --git a/source/conf.py b/source/conf.py
@@ -88,12 +88,18 @@
     "logo_light": "_static/images/vicharak-logo-light.svg",
     "logo_dark": "_static/images/vicharak-logo-dark.svg",
     "show_breadcrumbs": True,
+    "show_prev_next": True,
 }
 # HTML favicon
 html_favicon = "_static/images/favicon.ico"
 # HTML Permalinks icon
 html_permalinks_icon = Icons.permalinks_icon
 
+html_baseurl = "https://docs.vicharak.in/"
+html_sidebars = {
+  "**": ["sidebar_main_nav_links.html", "sidebar_toc.html"]
+}
+
 favicons = [
     "images/android-chrome-192x192.png",
     "images/android-chrome-512x512.png",

diff --git a/source/contributing.rst b/source/contributing.rst
@@ -1,7 +1,7 @@
-.. _contributing:
-
 :orphan:
 
+.. _contributing:
+
 ##############
  Contribution
 ##############
diff --git a/source/drm_fpga_write_api.rst b/source/drm_fpga_write_api.rst
@@ -1,7 +1,7 @@
-.. _drm_fpga_write_api:
-
 :orphan:
 
+.. _drm_fpga_write_api:
+
 .. toctree::
    :glob:
 

diff --git a/source/index.rst b/source/index.rst
@@ -6,6 +6,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+.. rst-class:: lead
+
 ####################################
  Welcome to Vaaman's documentation!
 ####################################
@@ -27,8 +29,8 @@ that require both processing power and hardware customization.
 
 .. toctree::
    :glob:
-   :maxdepth: 1
    :caption: Contents
+   :titlesonly:
 
    Overview <overview>
    Getting Started <getting-started>
@@ -38,18 +40,18 @@ that require both processing power and hardware customization.
    Vaaman Linux Documentation <vaaman-linux/index>
    Vaaman FPGA Programming Documentation <vaaman-fpga>
    Vaaman Remote Upload Documentation <vaaman-remote-upload>
-   
+
 .. toctree::
    :glob:
-   :maxdepth: 1
+   :titlesonly:
    :caption: Downloads
 
    downloads
 
 .. toctree::
    :glob:
-   :maxdepth: 1
    :caption: Accessories
+   :titlesonly:
 
    accessories
 

diff --git a/source/nvme-boot.rst b/source/nvme-boot.rst
@@ -1,7 +1,7 @@
-.. _booting-from-nvme:
-
 :orphan:
 
+.. _booting-from-nvme:
+
 #########################
  Booting from NVMe drive
 #########################

diff --git a/source/sdcard-boot.rst b/source/sdcard-boot.rst
@@ -1,7 +1,7 @@
-.. _booting-from-sd-card:
-
 :orphan:
 
+.. _booting-from-sd-card:
+
 Booting from SD-card
 ====================
 

diff --git a/source/vaaman-linux/index.rst b/source/vaaman-linux/index.rst
@@ -4,13 +4,13 @@
 
 |
 |     This documentation pertains to the specific documentation for
-      Vicharak Vaaman Linux.
+      Linux on the Vaaman board.
 |     It encompasses information about the development, configuration,
-      and usage of the Vaaman Linux Operating System.
+      and usage of the Linux Operating System on Vaaman.
 
 .. toctree::
-   :maxdepth: 2
    :caption: List of Guides
+   :titlesonly:
 
    linux-development-guide/index
    linux-configuration-guide/index

diff --git a/source/vaaman-linux/linux-configuration-guide/index.rst b/source/vaaman-linux/linux-configuration-guide/index.rst
@@ -7,8 +7,8 @@ Operating System. It covers the tools and scripts used to configure
 elements such as the bootloader, kernel, and rootfs.
 
 .. toctree::
-   :maxdepth: 2
    :caption: Configuration Guides
+   :titlesonly:
 
    Vicharak Linux Configuration Utility <vicharak-config-tool>
    Change U-Boot Logo <change-uboot-logo>
diff --git a/source/vaaman-linux/linux-development-guide/index.rst b/source/vaaman-linux/linux-development-guide/index.rst
@@ -8,8 +8,8 @@ kernel, and rootfs.
 
 U-Boot (Universal Bootloader)
 ------------------------------
-U-Boot, or the Universal Bootloader, plays a crucial role in booting the
-Linux kernel on your target hardware. It provides essential features for
+U-Boot, or the Universal Bootloader, plays an important role in booting the
+Linux kernel on your Vicharak board. It provides essential features for
 initializing hardware and loading the kernel.
 
 Linux Kernel
@@ -26,8 +26,8 @@ and cross-compiling software for your embedded system. We will demonstrate
 how to build your own Debian, Ubuntu, Yocto or Android system.
 
 .. toctree::
-   :maxdepth: 2
    :caption: Development Guide
+   :titlesonly:
 
    U-Boot <u-boot>
    Linux Kernel <linux-kernel>

diff --git a/source/vaaman-linux/linux-development-guide/linux-kernel.md b/source/vaaman-linux/linux-development-guide/linux-kernel.md
@@ -6,8 +6,47 @@ Vicharak provides multiple revisions of Linux kernels for Vaaman board. There
 are several differences across the revisions, mostly bug fixes and upstream
 improvements. But, the hardware functionality is the same.
 
-:::{admonition} Please Refer to the types of kernels available for
-[Vaaman for more information](#available-custom-kernel-types)
+## Types of kernels available for Vaaman
+
+Vicharak offers four version of linux kernels for Vaaman board.
+Each kernel is based on a different version of the Linux kernel.
+
+These kernel revisions are based on the sources of Rockchip RK3399 SoC with
+necessary changes and optimizations for Vaaman.
+
+Rockchip is responsible for updating the `RK3399` SoC support in the
+Linux kernel. They have provided support for Linux Kernel **4.4, 4.19 and 5.10**.
+Additionally Vicharak has introduced the support for the Mainline Linux Kernel.
+
+```{list-table}
+:header-rows: 1
+:class: feature-table
+
+* - Kernel version
+  - Status
+  - Git Link
+
+* - Kernel 4.4
+  - Stable but deprecated
+  - https://github.com/vicharak-in/linux-kernel/tree/vaaman-4.4
+
+* - Kernel 4.19
+  - Stable but deprecated
+  - https://github.com/vicharak-in/linux-kernel/tree/vaaman-4.19
+
+* - Kernel 5.10
+  - Stable (Recommended)
+  - https://github.com/vicharak-in/linux-kernel/tree/vicharak-5.10
+
+* - Kernel Mainline
+  - Experimental
+  - https://github.com/vicharak-in/linux-kernel/tree/vicharak-mainline
+```
+
+:::{warning}
+Some of the kernel versions might not contain all the features supported or required by Vaaman.
+Please take a look at the [Vaaman Kernel Status](vaaman-kernel-status) table
+for the status of the different kernels available for Vaaman.
 :::
 
 ## Build Linux Kernel
@@ -141,7 +180,9 @@ to compile and test the kernel with ease.
 
 ## Compiling Kernel Modules
 
+```bash
 make O=out ARCH=arm64 modules_install INSTALL_MOD_DIR=out/modules -j$(nproc --all)
+```
 
 **Confirm the modules files in `out/modules/lib` folder**