Skip to content

Commit

Permalink
Add How to Information for conf.ini and SPI Nor Flash boot process in…
Browse files Browse the repository at this point in the history 
… SG2044

conf.ini: explain its content, usage, file location, and how to update in SPI Nor Flash

SPI Nor Flash boot process: explain how to burn or update firmware.bin in SPI Nor Flash
  • Loading branch information
@hconion
hconion committed Dec 26, 2024
1 parent cc3b47a commit 18ea7dc
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 0 deletions.
121 changes: 121 additions & 0 deletions SG2044/HowTo/Configuraton Info in INI file.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
==================================
Configuration Info in ``conf.ini``
==================================

1. Introduction of ``conf.ini``
================================
The ``conf.ini`` is an artificial configuration file that contains necessary
evaluation board information for SG2044. The file consists of text-based
content with a structure and syntax comprising key-value pairs for properties,
and sections that organize the properties.

If you want to know more about the INI file, please access
`the introduction link <https://en.wikipedia.org/wiki/INI_file>`_.

2. Sorce Code Location, and File Location in Boot Process
============================================================
conf.ini for 2044 is in `zsbl/arch/riscv/boot/conf/sg2044-evb-conf.ini <https://github.com/sophgo/zsbl/blob/master/arch/riscv/boot/conf/sg2044-evb-conf.ini>`_

When boot with SD card, it should be put into ``0:riscv64``, which is in the EFI partition of the SD card.

When boot with SPI Nor Flash, it should be put into SPI Nor Flash 1.

3. Information in ``conf.ini``
==============================
The convention is that the ``conf.ini`` must start at byte 0 with a section
called ``sophgo-config``, and end with a section called ``eof``.
In addition, the current ``conf.ini`` contains the sections
listed in the following table.

+---------------------+-------------------------------------------------+------------+
| Section | Key - Vaule | Permission |
+=====================+=================================================+============+
| [sophgo-config] | | Compulsory |
+---------------------+-------------------------------------------------+------------+
| | bios_vendor = SOPHGO | Optional |
| [Bios Information] +-------------------------------------------------+------------+
| | bios_version = 1.0 | Optional |
| +-------------------------------------------------+------------+
| | date = 2024-12-25 | Optional |
| +-------------------------------------------------+------------+
| | time = 00:00:00 | Optional |
+---------------------+-------------------------------------------------+------------+
| | manufacturer = SOPHGO | Optional |
| +-------------------------------------------------+------------+
| | product_name = SG2044 | Optional |
| [product] +-------------------------------------------------+------------+
| | version = 1.0 | Optional |
| +-------------------------------------------------+------------+
| | serial-number = TYUI7890 | Optional |
+---------------------+-------------------------------------------------+------------+
| | product_name = SG2044_EVB | Optional |
| [board] +-------------------------------------------------+------------+
| | version = 1.1 | Optional |
+---------------------+-------------------------------------------------+------------+
| | processor_version = C920 | Optional |
| +-------------------------------------------------+------------+
| | frequency = 2800000000 | Optional |
| [CPU] +-------------------------------------------------+------------+
| | l1-i-cache-size = 65536 | Optional |
| +-------------------------------------------------+------------+
| | l1-d-cache-size = 65536 | Optional |
| +-------------------------------------------------+------------+
| | l2-cache-size = 2097152 | Optional |
| +-------------------------------------------------+------------+
| | l3-cache-size = 67108864 | Optional |
+---------------------+-------------------------------------------------+------------+
| | type = LPDDR5x | Optional |
| +-------------------------------------------------+------------+
| [DDR] | data-rate = 8533000000 | Optional |
| +-------------------------------------------------+------------+
| | rank = 2 | Optional |
+---------------------+-------------------------------------------------+------------+
| | mac0 = 0xAAAAAAAAAAAA | Optional |
| [mac-address] +-------------------------------------------------+------------+
| | mac1 = 0xAAAAAAAAAAAA | Optional |
+---------------------+-------------------------------------------------+------------+
| [eof] | | Compulsory |
+---------------------+-------------------------------------------------+------------+

Except for the section that is mandatory to be added to ``conf.ini``,
other sections or key-value pairs can be added as required configuration that contains necessary evaluation board information for SG2044.

Further explanation of the sections in ``conf.ini``
----------------------------------------------------

The file consists of text-based content with a structure and syntax comprising key-value pairs for properties, and sections that organize the properties.
Specifically, the sections are structures in SMBIOS (System Management BIOS) table, and the keys are members of the structures.
If you want to know more about SMBIOS, please access `SMBIOS specification <https://www.dmtf.org/sites/default/files/standards/documents/DSP0134_3.6.0.pdf>`_.

1. [Bios Information] corresponds to BIOS Information (Type 0) structure. bios_vendor, bios_version, date and time are members of the structure.

2. [product] corresponds to System Information (Type 1) structure. manufacturer, product_name, version, serial-number are members of the structure.

3. [board] corresponds to Baseboard (or Module) Information (Type 2) structure. product_name, version are members of the structure.

4. [CPU] corresponds to Processor Information (Type 4) structure. processor_version, frequency are members of the structure. But any field under [CPU] section related to cache is belonged to Cache Information (Type 7). One structure is specified for each cache device. l1-i-cache-size, l1-d-cache-size, l2-cache-size, l3-cache-size correspond to "Maximum Cache Size" and "Installed Size" of each cache structure separately. Maximum Cache Size and Installed Size have the same value.

5. [DDR] corresponds to Memory Device (Type 17) structure. type, data-rate, rank are members of the structure.

6. [mac-address] contains the MAC address of two NICs on the board. mac0 is the mac address for NIC0, which is a 1Gbps NIC, and mac1 is the mac address for NIC1, which is a 100Gbps NIC.

Notice: There are other Key-Value pairs that are not listed in the table above. They are not mandatory, and they have no effect on the boot process for now.

3. How to Update ``conf.ini`` in SPI Nor Flash 1
================================================

``conf.ini``, as introduced above, is the configuration file that contains board information for SG2044.
Reference code location is mentioned above, under the title **Source Code Location**. You can modify the file as needed.

To update the ``conf.ini``, you need to use a SD card which can be used to boot the SG2044 board.

Step 1. Put the new ``conf.ini`` into the media devices like SD card, USB flash drive, NVMe SSD etc.

Step 2. Use the SD card to boot the SG2044 board.

Step 3. In EDK II UEFI boot process, strike hotkey F2 to enter UEFI Setup Menu.

Step 4. Select "Firmware Management" -> "Update CONF.INI" -> Choose the Media Device -> Choose the File Location -> Confirm.
Then system will update ``conf.ini`` in SPI Nor Flash 1.

Step 5. Reboot.
46 changes: 46 additions & 0 deletions SG2044/HowTo/How to Boot Through SPI Nor Flash.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
==============================
How to Boot From SPI Nor Flash
==============================

Two Boot Selections
===================

This document describes how to boot from SPI Nor Flash on the SG2044 board.

There are two ways to boot the SG2044 board: from SPI Nor Flash and from SD card.

How to boot from SD card is described `here <https://github.com/hconion/sophgo-doc/blob/main/SG2044/HowTo/A%20Simple%20Method%20to%20Install%20Ubuntu%20Image%20on%20SG2044%20EVB.rst#5-boot-from-microsd-card>`_.

When both the SD card and SPI Nor Flash are inserted and contain the necessary firmware for booting, the system prioritizes loading the binary firmware from the SD card into RAM.

To be short, if the SD card is present and contains the required firmware, the SG2044 board will boot from SD card.

When SD card is not inserted, the SG2044 board will boot from SPI Nor Flash.

2. Boot Process from SPI Nor Flash
=====================================

There are two SPI Nor Flash chips on the SG2044 board, SPI Nor Flash 0 and SPI Nor Flash 1.

The first SPI Nor Flash is used to store ``firmware.bin``, and the second SPI Nor Flash is used to store the ``conf.ini``.

3. How to Burn or Update the ``firmware.bin`` in SPI Nor Flash 0
================================================================

``firmware.bin`` is the firmware image file that contains ``zsbl.bin``, ``fsbl.bin``, ``fw_dynamic.bin``, ``sg2044-evb.dtb``, ``SG2044.fd``.
The ``firmware.bin`` is generated by the ``build_rv_firmware_bin`` command.
It is stored in the ``install/soc_sg2044/single_chip/firmware`` directory.
If you want to boot the SG2044 board from SPI Nor Flash, you need to burn the ``firmware.bin`` into SPI Nor Flash 0.

To update the ``firmware.bin``, you need to use an SD card which can be used to boot the SG2044 board.

Step 1. Put the new ``firmware.bin`` into the media devices like SD card, USB flash drive, NVMe SSD, etc.

Step 2. Use the SD card to boot the SG2044 board.

Step 3. In the EDK II UEFI boot process, strike hotkey F2 to enter the UEFI Setup Menu.

Step 4. Select "Firmware Management" -> "Update Firmware" -> Choose the Media Device -> Choose the File Location -> Confirm.
Wait for a few seconds, and the system will update ``firmware.bin`` in SPI Nor Flash 0.

Step 5. Boot the SG2044 board again, and this time the SD card is not needed.

0 comments on commit 18ea7dc

Please sign in to comment.