Skip to content

products/adsp/setup: update getting started for bringup bundle and Fedora rootfs #573

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.

Sign up for GitHub

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

Open
katiaTsaruk wants to merge 2 commits into
base: main
Choose a base branch
from
+51 −30
Open

products/adsp/setup: update getting started for bringup bundle and Fedora rootfs #573

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6405ec3
products/adsp/setup: switch to bringup bundle for release download
katiaTsaruk Aug 12, 2026
bcec60c
products/adsp/setup: update eMMC installer and first boot flow
katiaTsaruk Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 51 additions & 30 deletions docs/products/adsp/setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,15 +172,15 @@
~~~~~~~~~~~~~~~~~~

Navigate to the :git-br2-external:`br2-external releases page <releases+>` and
download both release archives that match your hardware (``images-bootstrap-*``
and ``images-debug-*``), then extract them into the same directory:
download the bringup archive (``adi_sc598_ezkit_defconfig-*``). This single

Check failure on line 175 in docs/products/adsp/setup.rst

View workflow job for this annotation

GitHub Actions / check-doc 

vale:Vale.Spelling:14 Did you really mean 'bringup'?
archive combines the bootstrap, debug, and Fedora rootfs artifacts.

.. code-block:: sh
Extract the archive:

$ tar -xf images-bootstrap-*.tar.xz
$ tar -xf images-debug-*.tar.xz
.. code-block:: sh

Both archives extract to ``buildroot/output/images/``.
$ tar -xf adi_sc598_ezkit_defconfig-*.tar.xz
$ cd images-bringup

Boot U-Boot Proper
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -221,15 +221,13 @@

.. shell:: sh

$ cd buildroot/output/images
$ gdb-multiarch -x u-boot.gdb
$ gdb-multiarch -x bootstrap/u-boot.gdb

.. tab-item:: Windows/Fedora/RHEL

.. shell:: sh

$ cd buildroot/output/images
$ gdb -x u-boot.gdb
$ gdb -x bootstrap/u-boot.gdb

Boot Linux
~~~~~~~~~~
Expand All @@ -242,14 +240,14 @@

.. shell:: sh

$ cd buildroot/output/images
$ cd images-bringup
$ python3 -m http.server

.. tab-item:: Windows

.. shell:: sh

$ cd buildroot/output/images
$ cd images-bringup
$ python -m http.server

Find your IP address:
Expand All @@ -273,8 +271,8 @@
.. code-block:: console

=> dhcp
=> wget ${kernel_addr_r} <your-pc-ip>:/Image
=> wget ${fdt_addr_r} <your-pc-ip>:/sc598-som-ezkit.dtb
=> wget ${kernel_addr_r} <your-pc-ip>:/debug/Image
=> wget ${fdt_addr_r} <your-pc-ip>:/debug/sc598-som-ezkit.dtb
=> booti ${kernel_addr_r} - ${fdt_addr_r}

Note: Make sure to use the ``.dtb`` file name that matches your board (e.g. ``sc598-som-ezkit.dtb``).
Expand All @@ -294,26 +292,39 @@
This will erase and program SPI flash.
Continue? [y/N]:

Type ``y`` to erase the flash contents and install U-Boot. After programming completes,
the installer proceeds to write the eMMC image.
Type ``y`` to erase the flash contents and install U-Boot. After programming
completes, the installer proceeds to the eMMC install step.

Install eMMC Image
~~~~~~~~~~~~~~~~~~

The serial console prompts for your PC's IP address:
The serial console presents a menu to select what to install on eMMC:

.. code-block:: console

======== Install eMMC Image ========
======== Install Image on eMMC ========

This will download emmc.img.gz from your PC and write it to /dev/mmcblk0.
Select what to install:
1) Buildroot kernel and root filesystem
2) Buildroot kernel and Fedora root filesystem
0) Skip
Comment on lines +308 to +310

@ozan956 ozan956 Aug 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

1
2
0

is this the type of ordering in other formatters as well? Like making the negative selection as zero in the bottom?

@katiaTsaruk katiaTsaruk Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I thought it is nice to have the skip option as the last in the list and 0 is kind of neutral choice, so it is clear that it is not like another option, especially if we will add more options soon. I can also flip it if you think it will be better like that


Enter your PC's IP address:
Choice [0/1/2]:

The board configures its network interface, downloads
``emmc.img.gz`` from your PC, decompresses it, and writes it directly to the
eMMC. After the write completes, the console instructs you to move the S1 boot
mode switch:
After selecting, enter your PC's IP address when prompted:

.. code-block:: console

To continue, enter your PC's IP address. Leave empty to abort.
PC IP address:

The board configures its network interface, downloads ``emmc.img.gz`` from your
PC, decompresses it, and writes it to the eMMC. If you selected option ``2``,
the installer also downloads and extracts ``adsp-sc598-rootfs.tar.zst`` from your
PC to the Fedora root partition.

After the install completes, the console instructs you to move the S1 boot mode
switch:

.. code-block:: console

Expand All @@ -338,14 +349,24 @@
U-Boot loads the kernel and device tree from the eMMC boot partition and starts
Linux with the root filesystem on eMMC.

Login
~~~~~
First Boot Setup
~~~~~~~~~~~~~~~~

When the boot completes, a login prompt appears:
On first boot, a setup service prompts you to create a user account:

.. code-block:: console

Welcome to the ADI SC598 EZ-Kit
sc598-ezkit login:
======== First Boot Setup ========
Create your user account.

Username:

Enter a username and set a password when prompted. The user is created with
``wheel`` group membership. After setup completes, the board displays its IP
address for SSH access:

.. code-block:: console

Log in as ``root`` with no password (press Enter).
User '<username>' created.
Waiting for network....
SSH: ssh <username>@<board-ip>
Comment on lines +371 to +372

@ozan956 ozan956 Aug 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Cant we just use the console or console appears after those messages ? Its bit hard to understand now, from a user perspective I would think that I have to ssh to acces to board.

@katiaTsaruk katiaTsaruk Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You do need to ssh to access the board, as the console issue is still there I just shut it down so it does not spam and you can create a user.

Loading