From df5e787b13f9d7c0089ebbfdde5744cfeb94d0ce Mon Sep 17 00:00:00 2001 From: Suhaas Joshi Date: Wed, 2 Jul 2025 13:51:09 +0530 Subject: [PATCH] feat(debian): Armbian-ize Debian docs for all platforms Instead of building TI Debian images with ti-bdebstrap, we are now using Armbian. In e571245b230 ("feat(debian): AM62LX: Armbian-ize Debian docs for AM62L"), changes were made to migrate AM62L docs to Armbian from ti-bdebstrap. At the time of that commit, changes were specific to AM62L only since the other boards were still at Debian. With 11.01 release, all platforms will use Debian built from the Armbian build framework. Therefore, generalize that information. Specifically, do the following: * Remove references to ti-bdebstrap. * Explain the difference between Armbian and Debian briefly. * Move sources/devices/AM62LX/debian/Building_Debian_Image.rst to sources/debian/, and delete the file of the same name from the latter path. The new file was originally written for AM62L, and thus was placed in that directory, but is now (after a few changes also made in this commit) applicable to all platforms. * Do some formatting. Signed-off-by: Suhaas Joshi --- .../config/vocabularies/PSDK/accept.txt | 3 + configs/AM62LX/AM62LX_debian_toc.txt | 2 +- source/debian/Building_Debian_Image.rst | 254 +++++------------- source/debian/Overview.rst | 50 ++-- .../AM62LX/debian/Building_Debian_Image.rst | 73 ----- source/devices/AM62LX/debian/index.rst | 2 +- .../AM62PX/debian/Getting_Started_Guide.rst | 19 +- .../AM62X/debian/Getting_Started_Guide.rst | 17 +- .../AM64X/debian/Getting_Started_Guide.rst | 9 +- 9 files changed, 110 insertions(+), 319 deletions(-) delete mode 100644 source/devices/AM62LX/debian/Building_Debian_Image.rst diff --git a/.github/styles/config/vocabularies/PSDK/accept.txt b/.github/styles/config/vocabularies/PSDK/accept.txt index 4ce310492..f2bf20f4c 100644 --- a/.github/styles/config/vocabularies/PSDK/accept.txt +++ b/.github/styles/config/vocabularies/PSDK/accept.txt @@ -25,3 +25,6 @@ balenaEtcher Armbian Debian Weston +Trixie +mmdebstrap +bdebstrap diff --git a/configs/AM62LX/AM62LX_debian_toc.txt b/configs/AM62LX/AM62LX_debian_toc.txt index 558476dd1..e483a1929 100644 --- a/configs/AM62LX/AM62LX_debian_toc.txt +++ b/configs/AM62LX/AM62LX_debian_toc.txt @@ -2,7 +2,7 @@ devices/AM62LX/debian/index debian/Overview devices/AM62LX/debian/Getting_Started_Guide -devices/AM62LX/debian/Building_Debian_Image +debian/Building_Debian_Image debian/Building_Debian_Packages debian/How_to_Guides/index_How_to_Guides linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux diff --git a/source/debian/Building_Debian_Image.rst b/source/debian/Building_Debian_Image.rst index ceba65daa..94546a028 100644 --- a/source/debian/Building_Debian_Image.rst +++ b/source/debian/Building_Debian_Image.rst @@ -1,236 +1,106 @@ -====================== -Building Debian Images -====================== +==================================== +Building Debian Images Using Armbian +==================================== Introduction ============ -Building a Debian Image requires: +Texas Instruments uses the **Armbian** build framework to generate Debian images for its platforms. +*Armbian* describes itself to be a "base operating system"; that is, a build framework used to build +Linux images optimized for Single-Board Computers. - 1. Generating a chroot environment for the target architecture (Arm), if the host environment is on x86. - 2. Installing all the necessary packages - 3. Customizing configuration scripts if needed - 4. Building Bootloader - 5. Flashing the generated RootFS and Boot binaries to SD Card +|__SDK_DOWNLOAD_URL__| provides Debian images, but users can also build these, especially if users +require something custom (such as different kernel configurations or default desktop environments). -There are several opensource tools available for generating the RootFS in a chroot environment. Such as debootstrap (now deprecated), mmdebstrap (complex), bdebstrap (simple wrapper on top of mmdebstrap). +Armbian Usage +============= -`ti-bdebstrap `__ is a set of scripts that builds upon the ``bdebstrap`` tool to create custom Debian images for TI platforms. This includes creating the ``bdebstrap`` chroot environment itself, installing essential and useful TI and non-TI packages, setting up the configuations, Building the U-Boot etc. +This document provides high-level information about how to build Debian images for TI platforms, +using Armbian. For a full list of options available for users to configure these images at build +time, see `Armbian Documentation `__. -In other words, ``ti-bdebstrap`` offers users an easy way to create a full-fledged Debian image for supported TI platforms, using a single command. Once the image is built, the user can directly flash it onto a SD card. - -TI currently supports building Debian images for AM62Lx, AM62Px, AM62x and AM64x platforms. - -Usage -===== - -Get Scripts +Get Armbian ----------- -The scripts are hosted at https://github.com/TexasInstruments/ti-bdebstrap - -To clone the repository, run: +For the time being, TI's fork of Armbian maintains support for TI platforms. Therefore, the first +step is to fetch TI's fork: .. code-block:: console - git clone https://github.com/TexasInstruments/ti-bdebstrap.git - + git clone https://github.com/TexasInstruments/armbian-build.git Repository Structure -------------------- -.. code-block:: text - - tibdebstrap/ - ├── build.sh - ├── builds.toml - ├── configs - │   ├── bdebstrap_configs - │   │   ├── bookworm - │   │   │   ├── bookworm-.yaml - │   │   │   └── bookworm-rt-.yaml - │   │   └── trixie - │   │   ├── trixie-.yaml - │   │   └── trixie-rt-.yaml - │   ├── bsp_sources.toml - │   └── machines - │   ├── 09.02.00.010.toml - │   └── 11.00.05.02.toml - ├── create-sdcard.sh - ├── create-wic.sh - ├── LICENSE - ├── README.md - ├── scripts - │   ├── build_bsp.sh - │   ├── build_distro.sh - │   ├── common.sh - │   └── setup.sh - └── target --> Custom files to deploy in target. - -``build.sh``: the "main" script that the user should run to generate Debian images. - -``configs/``: contains details, configuration options and values for machines, bsp_sources and distro-variants (see below for details). - -``scripts/``: contains helper scripts for ``build.sh``. - -``target/``: contains files for target configs, like ``weston.service`` for the **weston** target. - -``builds.toml``: contains list of all valid builds along with their definitions (see below for details). - -Build Configurations --------------------- - -A ``build config`` represents an image with certain values for the ``machine``, ``rt_linux`` and ``distro_codename`` parameters. - -The ``builds.toml`` file contains a list of all valid builds in the ``builds[]`` list. Each ``build`` is then defined underneath. - -Values of ``machine`` and ``distro_codename`` must be defined in :file:`configs/machines.toml`, :file:`configs/bdebstrap_configs//-.yaml` and :file:`configs/bsp_sources.toml` files. If any of these is missing, the build will fail. - -So long as you conform to the rule above, you may also define your own builds. - -Building Images ---------------- - -All valid builds are listed in the :file:`builds.toml` file. To build an image, one of these must be chosen and supplied to the :file:`build.sh` command. :file:`build.sh` commences the build process. -The images are finally stored in the :file:`build/` directory. Each build also produces a log file inside :file:`log/`. - -Building images using ``ti-bdebstrap`` involves the following steps: - - 1. install the pre-requisite packages - 2. get the scripts using ``git clone`` - 3. checkout to the SDK release version tag that you want to build - 4. run the :file:`build.sh` script and with required build config as argument. - 5. creating a wic image using :file:`create-wic.sh`. - 6. flashing the image into a SD card - -Install Pre-requisite Packages ------------------------------- - -First, ensure that your repositories are up-to-date: - -.. code-block:: console - - sudo apt update - -Then, install packages as follows: - -.. code-block:: console - - sudo apt install -y \ - pigz expect pv \ - binfmtc binfmt-support \ - qemu-user qemu-user-static qemu-system-arm \ - debian-archive-keyring bdebstrap \ - build-essential autoconf automake \ - bison flex libssl-dev \ - bc u-boot-tools swig python3-pyelftools - - -Ensure that all packages were correctly installed using: - -.. code-block:: console - - sudo apt install --fix-broken - -Finally, install ``toml-cli`` and ``yamllint``: - -.. code-block:: console - - pip3 install toml-cli - pip3 install yamllint - -.. note:: - - Since the build script is run as ``root`` user, ``toml-cli`` and ``yamllint`` should also be installed with ``sudo`` for ``root`` user to be able to access it. - -.. note:: - - The scripts internally handle toolchain downloads based on Host architecture. So the same steps can be followed on both ``arm`` and ``x86_64`` hosts. - -Checkout to the Correct Release Tag ------------------------------------ - -ti-bdebstrap repository has tags corresponding to each release. - -Before building the image, it is important to ensure that you are on the correct release tag. First, view all the tags -using: - -.. code-block:: console - - git tag - -Then, select a release tag and checkout to it: - -.. code-block:: console - - git checkout +There are 4 files and directories of relevance to this high-level overview: -For example, to checkout to the `10.01.10.04-release` tag, use the following command: +- :file:`configs/`: This directory has configurations for boards, families, kernel configurations, + desktop or CLI environments and so on. To find configuration files relevant to TI, see: -.. code-block:: console - - git checkout 10.01.10.04-release - -The :file:`builds.toml` and other config files will now support building images corresponding to the `10.01.10.04` release. - -Building the Image -------------------- + - :file:`configs/sources/families/k3.conf` + - :file:`configs/kernel/linux-k3-current.conf` + - :file:`configs/kernel/linux-k3-rt-current.conf` -.. note:: +- :file:`compile.sh`: This is the script that the user should run for building Armbian images. - If you are behind a proxy, since the build is run with sudo, make sure to set the proxy for root user (preferably in :file:`/etc/environment`). +- :file:`lib/`: This directory stores the scripts that do most of the work in building Armbian images. -To build an image, you need to run the :file:`build.sh` script: +- :file:`extensions/`: This directory has files that define **extension hooks**. In Armbian, *extension + hooks* are function signatures, which the build framework calls in the process of building an + image. However, the build framework does not define these in ``lib/``. Users can define these + functions and integrate custom steps in the build process. TI has ``extensions/ti-debpkgs.sh`` + extension file. To customize the build process, create a new file in this directory, and define + your extension hooks there. Once the file is created, be sure to add the following line to + board/family config file: -.. code-block:: console + .. code-block:: console - sudo ./build.sh + enable_extension -The ```` must be one present inside :file:`builds.toml` file. +- :file:`userpatches/`: This directory stores files that define build parameters, user patches and so on. -After the build, the RootFS, Boot partition and bsp_sources are stored in :file:`build/`. The logs will be stored in :file:`logs/.log`. +Building Images +--------------- -Example: to build for ``trixie-am62pxx-evm``, run: +Armbian supports an interactive build process. To build interactively, go to TI's Armbian fork you +cloned, and use the following command: .. code-block:: console - sudo ./build.sh trixie-am62pxx-evm - -The RootFS, Boot partition and bsp_sources are then stored in :file:`build/trixie-am62pxx-evm`. The build log is saved as :file:`logs/trixie-am62pxx-evm.log`. + ./compile.sh -Generate an SD Card Image -------------------------- +The build framework will then display dialog boxes. The user can use this to select the board, CLI +or desktop environment, kernel configurations and so on. -This step can be skipped if you do not want to share the generated Image with anyone and want to proceed with testing with an SD card. - -To generate an SD Card Image with the generated RootFS and Boot partition files, run: - -.. code-block:: console - - ./create-wic.sh - -Example: to build for ``trixie-am62pxx-evm``, run: +To build the image non-interactively, specify all required **Build Switches** in the command: .. code-block:: console - ./create-wic.sh trixie-am62pxx-evm - -The wic image is generated under :file:`build/trixie-am62pxx-evm`. This can be used to flash an SD card using standard tools like balena-etcher. + ./compile.sh [command] [switch...] [command...] -Flash Image to SD Card using Script ------------------------------------ +A full list of build switches is available at `Build Switches `__. -To flash the SD card without generating a wic image, use the :file:`create-sdcard.sh` script. Run it using the below command and follow with the prompts. +For example, the following command builds the minimal non-RT Trixie image: .. code-block:: console - sudo ./create-sdcard.sh + ./compile.sh build BOARD= BRANCH=current BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie SKIP_ARMBIAN_REPO=yes -For example, if the image is ``trixie-am62pxx-evm``, type: - -.. code-block:: console +For a list of targets corresponding to each board, refer: - sudo ./create-sdcard.sh trixie-am62pxx-evm + +------------------------------+--------------+ + | Board | Target | + +==============================+==============+ + | AM62P | sk-am62p | + +------------------------------+--------------+ + | AM62x | sk-am62b | + +------------------------------+--------------+ + | AM62-LP | sk-am62-lp | + +------------------------------+--------------+ + | AM62SIP | sk-am62-sip | + +------------------------------+--------------+ + | AM64x | sk-am64b | + +------------------------------+--------------+ -This script will partition the SD Card and copy the contents of RootFS and Boot partitions that are generated to the SD Card. +``output/images/`` stores the built images. These images have a ``.img`` extension. diff --git a/source/debian/Overview.rst b/source/debian/Overview.rst index 553b47935..2a9f1116c 100644 --- a/source/debian/Overview.rst +++ b/source/debian/Overview.rst @@ -2,43 +2,37 @@ Overview ######## -.. ifconfig:: CONFIG_part_variant in ('AM62LX') +Debian, also known as Debian GNU/Linux, is a Linux distribution composed of free and open source +software. Community-supported Debian Project develops and maintains it. It offers a vast repository +of software packages, which the ``apt`` package manager can install. - Armbian is a highly-optimized **base operating system** (i.e. an extensive build framework) for building Debian-based images for Single-Board Computers (SBCs). +TI creates Debian images by using the popular project called **Armbian**. Armbian is a highly-optimized +**base operating system** (i.e. an extensive build framework) for building Debian-based images for +Single-Board Computers. Unlike other tools, such as mmdebstrap and bdebstrap, which are often +used for creating Debian images, Armbian focuses on creating images for Single-Board Computers. +TI's AM62LX, AM62Px, AM62x and AM64x platforms offer the Debian distribution. Few key highlights of +this project are: -Debian, also known as Debian GNU/Linux, is a Linux distribution composed of free and open-source software, developed by the community-supported Debian Project. +- The Debian filesystem image requires standard packages from debian.org and TI's customizations as + ``.deb`` packages. TI's package build infrastructure uses public sources of git repositories to build + deb packages. TI's official repository maintained on `Github/TexasInstruments/ti-debpkgs + `__ hosts these packages. -.. ifconfig:: CONFIG_part_variant in ('AM62LX') - - The Linux Debian distribution, built using Armbian, is enabled for TI's AM62Lx platform. Few key highlights of this project are: - -.. ifconfig:: CONFIG_part_variant not in ('AM62LX') - - The Linux Debian distribution is enabled for TI's AM62Px, AM62x and AM64x platforms. Few key highlights of this project are: - -- The Debian filesystem image requires standard packages from debian.org and TI's customizations as .deb packages. The deb packages for the components owned by TI are built using the public sources hosted on respective git repositories and the deb packages are hosted on TI's official PPA repository maintained on `Github/TexasInstruments `__. - -.. ifconfig:: CONFIG_part_variant not in ('AM62LX') - - - The entire Debian build process is made easy with a build script, the script "ti-bdebstrap" is hosted on `TI Debian Github `__. - -- This document also provides the required steps and instructions to customize the TI's components for AM62Lx, AM62Px, AM62x and AM64x SOCs and create the corresponding deb packages. - -- The entire project is made public and we accept community contributions as pull requests to github repositories. - -.. ifconfig:: CONFIG_part_variant not in ('AM62LX') - - - Github actions are enabled for the buildscripts workflow. So, any change in the config files, package additions or modifications in build scripts will result in auto generation of a new debian filesystem that reflects these changes. The new builds will store the filesystem image as an artifact hosted on the same repo, allowing other users to test the change without making a new build. These images are available via github for 90 days after which they may be purged to save disk space. +- This document also provides the required steps and instructions to customize the TI's components + for AM62Lx, AM62Px, AM62x and AM64x Systems-on-Chip and create the corresponding deb packages. +- The entire project is public and we accept community contributions as pull requests to GitHub + repositories. Debian vs Yocto =============== -TI provides both Debian and OpenEmbedded/Yocto based images as their Linux offering. Here's a quick comparision between both to let you choose which one to get started with. +TI provides both Debian and OpenEmbedded/Yocto based images as their Linux offering. Here's a quick +comparison between both to decide the one to start with: -Comparision ------------ +Comparison +---------- +-------------------+--------------------------------------+---------------------------------------+ | **File System** | **Debian** | **OpenEmbedded/Yocto (Arago)** | @@ -65,7 +59,7 @@ Comparision Acknowledgements ================ - - `beagleboard/image-builder `__ + - `armbian/build `__ - `beagleboard/repos-arm64 `__ diff --git a/source/devices/AM62LX/debian/Building_Debian_Image.rst b/source/devices/AM62LX/debian/Building_Debian_Image.rst deleted file mode 100644 index 3e15fece0..000000000 --- a/source/devices/AM62LX/debian/Building_Debian_Image.rst +++ /dev/null @@ -1,73 +0,0 @@ -====================== -Building Debian Images -====================== - -Introduction -============ - -Texas Instruments uses the **Armbian** build framework to generate Debian images for its platforms. *Armbian* describes itself to be a "base operating system"; that is, a build framework used to build Linux images optimized for Single-Board Computers. - -|__SDK_DOWNLOAD_URL__| provides Debian images for AM62L, but users can also build these, especially if users require something custom (such as different kernel configurations or default desktop environments). - -Armbian Usage -============= - -This document provides high-level information about how to build Debian images for AM62LX, using Armbian. For a full list of options available for users to configure these images at build time, see `Armbian Documentation `__. - -Get Armbian ------------ - -For the time being, TI's fork of Armbian maintains AM62L support. Therefore, the first step is to fetch TI's fork: - -.. code-block:: console - - git clone https://github.com/TexasInstruments/armbian-build.git - -Repository Structure --------------------- - -There are 4 files and directories of relevance to this high-level overview: - -- ``configs/``: This directory has configurations for boards, families, kernel configurations, desktop or CLI environments and so on. To find configuration files relevant to TI, see: - - ``configs/sources/families/k3.conf`` - - ``configs/kernel/linux-k3-current.conf`` - - ``configs/kernel/linux-k3-rt-current.conf`` - -- ``compile.sh``: This is the script that the user should run for building Armbian images. - -- ``lib/``: This directory stores the scripts that do most of the work in building Armbian images. - -- ``extensions/``: This directory has files that define **extension hooks**. In Armbian, *extension hooks* are function signatures, which the build framework calls in the process of building an image. However, the build framework does not define these in ``lib/``. Users can define these functions and integrate custom steps in the build process. TI has ``extensions/ti-debpkgs.sh`` extension file for AM62L. To customize the build process, create a new file in this directory, and define your extension hooks there. Once the file is created, be sure to add the following line to board/family config file: - - .. code-block:: console - - enable_extension - -- ``userpatches/``: This directory stores files that define build parameters, user patches and so on. - -Building Images ---------------- - -Armbian supports an interactive build process. To build interactively, go to TI's Armbian fork you cloned, and use the following command: - -.. code-block:: console - - ./compile.sh - -The build framework will then display dialog boxes. The user can use this to select the board, CLI or desktop environment, kernel configurations and so on. - -To build the image non-interactively, specify all required **Build Switches** in the command: - -.. code-block:: console - - ./compile.sh [command] [switch...] [command...] - -A full list of build switches is available at `Build Switches `__. - -For example, the following command builds the image at |__SDK_DOWNLOAD_URL__|: - -.. code-block:: console - - ./compile.sh build BOARD=am62l-evm BRANCH=current BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie SKIP_ARMBIAN_REPO=yes - -``output/images/`` stores the built images. These images have a ``.img`` extension. diff --git a/source/devices/AM62LX/debian/index.rst b/source/devices/AM62LX/debian/index.rst index ab91a0ca6..393853b53 100644 --- a/source/devices/AM62LX/debian/index.rst +++ b/source/devices/AM62LX/debian/index.rst @@ -16,7 +16,7 @@ Debian Developer's Guide /debian/Overview Getting_Started_Guide - Building_Debian_Image + /debian/Building_Debian_Image /debian/Building_Debian_Packages /debian/How_to_Guides/index_How_to_Guides /debian/Demo_User_Guides/index_Demos diff --git a/source/devices/AM62PX/debian/Getting_Started_Guide.rst b/source/devices/AM62PX/debian/Getting_Started_Guide.rst index bc18bd848..a3ab46981 100644 --- a/source/devices/AM62PX/debian/Getting_Started_Guide.rst +++ b/source/devices/AM62PX/debian/Getting_Started_Guide.rst @@ -6,7 +6,7 @@ Getting Started with Debian The SD card Image tisdk-debian-bookworm- provided on the |__SDK_DOWNLOAD_URL__| is all you need to get started and explore Debian on TI microprocessors. -The Debian Image provided has all the basic packages required to boot with weston as default window manager. The user can install any new package using inbuilt 'apt' utility +The Debian Image provided has all the basic packages required to boot with weston as default window manager. The user can install any new package by using inbuilt 'apt' utility and customize the filesystem as required. Follow the steps mentioned in this page to create an SD Card. @@ -14,7 +14,7 @@ Follow the steps mentioned in this page to create an SD Card. Hardware Setup -------------- -In addition to the SK EVM itself, the following hardware is needed: +In addition to the SK Evaluation Module (EVM) itself, use the following hardware: 1. USB Type-C 5V - 15V and 3A power supply 2. Micro-SD card reader @@ -43,7 +43,7 @@ Create SD Card using balenaEtcher Insert a micro SD card into the USB SD card reader and start Etcher. Choose the debian wic image to be flashed, choose the USB SD card reader as the target, and then click "Flash". - Etcher will decompress the image and write it to the SD card, as shown below: + Etcher will decompress the image and write it to the SD card, as shown in the following: .. Image:: /images/balena_etcher.png @@ -51,7 +51,7 @@ Create SD Card using balenaEtcher Set the EVM to SD card Boot mode -------------------------------- -The simplest way to run Linux on the SK EVM is through an SD card. For that, the EVM will need to be configured for SD card boot. Refer to `AM62Px SK EVM User's Guide `__ for detailed information about boot mode configurations. For quick reference, the figure below shows the boot mode switch setting for SD card boot. +The simplest way to run Linux on the SK EVM is through an SD card. For that, configure the EVM in SD card boot mode. Refer to `AM62Px SK EVM User's Guide `__ for detailed information about boot mode configurations. For quick reference, the following figure shows the boot mode switch setting for SD card boot. .. Image:: /images/AM62x_SD_boot.jpg @@ -59,15 +59,14 @@ Boot and Validate Debian ------------------------ Make sure to connect the Ethernet cable, HDMI Display, Mouse and Keyboard to the EVM. Insert the SD Card in the board and Power ON the EVM. -After approximately 20 seconds, the board should boot to weston home screen. +After a few moments, a configuration script will start running. This script will walk you through creating +a user account, setting a root password, configuring the date and other initial setup options. When +the setup finishes, restart the board. Upon reboot, the weston wallpaper should appear on your +display. .. Image:: /images/debian_homescreen.png -You've successfully booted Debian on AM62Px. - -To verify the distro, try running ``neofetch`` on the terminal. Click on the terminal icon on the top-left corner to open the weston-terminal and run neofetch. The output of the command can be observed on the screen as shown below. - -.. Image:: /images/debian_neofetch.png +You've successfully booted Debian on AM62x. If the board is connected to a private network, setup the proxy to be able to access the Internet. For more info, refer to `apt.conf(5) man page `__ diff --git a/source/devices/AM62X/debian/Getting_Started_Guide.rst b/source/devices/AM62X/debian/Getting_Started_Guide.rst index 38715b1c5..1f4e370f0 100644 --- a/source/devices/AM62X/debian/Getting_Started_Guide.rst +++ b/source/devices/AM62X/debian/Getting_Started_Guide.rst @@ -6,7 +6,7 @@ Getting Started with Debian The SD card Image tisdk-debian-bookworm- provided on the |__SDK_DOWNLOAD_URL__| is all you need to get started and explore Debian on TI microprocessors. -The Debian Image provided has all the basic packages required to boot with weston as default window manager. The user can install any new package using inbuilt 'apt' utility +The Debian Image provided has all the basic packages required to boot with weston as default window manager. The user can install any new package by using inbuilt 'apt' utility and customize the filesystem as required. Follow the steps mentioned in this page to create an SD Card. @@ -14,7 +14,7 @@ Follow the steps mentioned in this page to create an SD Card. Hardware Setup -------------- -In addition to the SK EVM itself, the following hardware is needed: +In addition to the SK Evaluation Module (EVM) itself, use the following hardware: 1. USB Type-C 5V - 15V and 3A power supply 2. Micro-SD card reader @@ -43,7 +43,7 @@ Create SD Card using balenaEtcher Insert a micro SD card into the USB SD card reader and start Etcher. Choose the debian wic image to be flashed, choose the USB SD card reader as the target, and then click "Flash". - Etcher will decompress the image and write it to the SD card, as shown below: + Etcher will decompress the image and write it to the SD card, as shown in the following: .. Image:: /images/balena_etcher.png @@ -51,7 +51,7 @@ Create SD Card using balenaEtcher Set the EVM to SD card Boot mode -------------------------------- -The simplest way to run Linux on the SK EVM is through an SD card. For that, the EVM will need to be configured for SD card boot. Refer to `AM62x SK EVM User's Guide `__ for detailed information about boot mode configurations. For quick reference, the figure below shows the boot mode switch setting for SD card boot. +The simplest way to run Linux on the SK EVM is through an SD card. For that, configure the EVM in SD card boot mode. Refer to `AM62x SK EVM User's Guide `__ for detailed information about boot mode configurations. For quick reference, the following figure shows the boot mode switch setting for SD card boot. .. Image:: /images/AM62x_SD_boot.jpg @@ -59,16 +59,15 @@ Boot and Validate Debian ------------------------ Make sure to connect the Ethernet cable, HDMI Display, Mouse and Keyboard to the EVM. Insert the SD Card in the board and Power ON the EVM. -After approximately 20 seconds, the board should boot to weston home screen. +After a few moments, a configuration script will start running. This script will walk you through creating +a user account, setting a root password, configuring the date and other initial setup options. When +the setup finishes, restart the board. Upon reboot, the weston wallpaper should appear on your +display. .. Image:: /images/debian_homescreen.png You've successfully booted Debian on AM62x. -To verify the distro, try running ``neofetch`` on the terminal. Click on the terminal icon on the top-left corner to open the weston-terminal and run neofetch. The output of the command can be observed on the screen as shown below. - -.. Image:: /images/debian_neofetch.png - If the board is connected to a private network, setup the proxy to be able to access the Internet. For more info, refer to `apt.conf(5) man page `__ diff --git a/source/devices/AM64X/debian/Getting_Started_Guide.rst b/source/devices/AM64X/debian/Getting_Started_Guide.rst index db017da03..239d5821e 100644 --- a/source/devices/AM64X/debian/Getting_Started_Guide.rst +++ b/source/devices/AM64X/debian/Getting_Started_Guide.rst @@ -6,15 +6,14 @@ Getting Started with Debian The SD card Image tisdk-debian-bookworm- provided on the |__SDK_DOWNLOAD_URL__| is all you need to get started and explore Debian on TI microprocessors. -The Debian Image provided has all the basic packages required to boot with weston as default window manager. The user can install any new package using inbuilt 'apt' utility -and customize the filesystem as required. +The user can install any new package by using inbuilt 'apt' utility and customize the filesystem as required. Follow the steps mentioned in this page to create an SD Card. Hardware Setup -------------- -In addition to the EVM itself, the following hardware is needed: +In addition to the Evaluation Module (EVM) or the Starter Kit itself, use the following hardware: 1. Barrel jack power supply 2. Micro-SD card reader @@ -41,7 +40,7 @@ Create SD Card using balenaEtcher Insert a micro SD card into the USB SD card reader and start Etcher. Choose the debian wic image to be flashed, choose the USB SD card reader as the target, and then click "Flash". - Etcher will decompress the image and write it to the SD card, as shown below: + Etcher will decompress the image and write it to the SD card, as shown in the following: .. Image:: /images/balena_etcher.png @@ -49,7 +48,7 @@ Create SD Card using balenaEtcher Set the EVM to SD card Boot mode -------------------------------- -The simplest way to run Linux on the SK EVM is through an SD card. For that, the EVM will need to be configured for SD card boot. Refer to `AM64x SK EVM User's Guide `__ for detailed information about boot mode configurations. For quick reference, the figure below shows the boot mode switch setting for SD card boot. +The simplest way to run Linux on the SK EVM is through an SD card. For that, configure the EVM in SD card boot mode. Refer to `AM64x SK EVM User's Guide `__ or the `TMDS64EVM User's Guide `__ (depending on the device) for detailed information about boot mode configurations. For quick reference, the following figure shows the boot mode switch setting for SD card boot. .. Image:: /images/AM64x_SD_boot.jpg