Khadas Docs

Amazing Khadas, always amazes you!

User Tools

Site Tools


products:sbc:common:development:kbi

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
products:sbc:common:development:kbi [2026/02/27 04:31]
gray old revision restored (2026/02/02 00:44)
products:sbc:common:development:kbi [2026/02/27 04:31] (current)
gray old revision restored (2026/02/23 21:44)
Line 1: Line 1:
 ====== KBI - Khadas Bootloader Instructions ====== ====== KBI - Khadas Bootloader Instructions ======
  
-This page introduces KBI. You will learn how to manage the status of Khadas SBC through KBI.+This page introduces about KBI. You will learn how to manage the status of Khadas SBC through KBI.
  
 <WRAP important > <WRAP important >
-Khadas Bootloader Instructions (KBI) can be used to: +Khadas Bootloader Instructions(KBI) can be used to: 
-  * Manage the programmable MCU +  * Manage the programmable MCU 
-  * Perform low-level hardware management +  * Carry out low level hardware management 
-  * Enable developers to utilize all the features of Khadas SBCs. </WRAP>+  * Let developers utilise all the features of Khadas SBCs. 
 +</WRAP>
  
 <WRAP info > <WRAP info >
-This page uses VIM2 as an example. +This page takes VIM2 as an example.
 </WRAP> </WRAP>
  
 ===== Uboot usage ===== ===== Uboot usage =====
  
-To get started, ensure you have booted into U-Boot:+To get started, make sure you have booted into U-Boot:
  
 ```shell ```shell
Line 86: Line 87:
 ``` ```
  
-The ADC value can be used to distinguish between different hardware modules.+The ADC value can distinguish between hardware modules.
  
 ==== Power Off ==== ==== Power Off ====
Line 105: Line 106:
 ==== LED Control ==== ==== LED Control ====
  
-The blue LED has four operating modes''Always Off'', ''Always On'', ''Breathe'', and ''Heartbeat''. It indicates the VIM's operating status.+Setup the blue LED:
  
-The MCUwhich handles system power managementcontrols the blue LEDThe CPU controls the white LED. +The blue LED has 4 working modes: ''Always Off''''Always on''''Breathe'' and ''Heartbeat''It indicates VIM working modes.
-Therefore, the blue LED continues to function even when the VIM2 is powered off.+
  
-KBI can be used to program the blue LED for two operating modes:+The MCU,in charge of system power management, controls the blue LED. The CPU controls the white LED.  
 +In this case, the blue LED still work even VIM2 was powered off.
  
-  * system off / idle: Power-off status, the CPU is in a power-down mode. +The KBI can be used to program the blue LED for two working modes:
-  * system on / working: Power-on status, the CPU is in working mode.+
  
-Example:+  * system off / idle: power off status, the CPU is in power-down mode. 
 +  * system on / working: power on status, the CPU is in working mode. 
 + 
 +For example:
  
 To check the blue LED’s setting for ''system off'' / idle status: To check the blue LED’s setting for ''system off'' / idle status:
Line 124: Line 127:
 ``` ```
  
-Check the blue LED setting for ''system on'' / working status:+To check the blue LED’s setting for ''system on'' / working status:
  
 ```shell ```shell
Line 130: Line 133:
 led mode: off  [systemon] led mode: off  [systemon]
 ``` ```
-When the VIM2 is powered on, the blue LED is set to ''Always Off'' by default.+When VIM2 is powered on,the blue LED is ''Always off''
  
-You can reset it to ''breathe'' mode: +You can also reset it to ''breathe'' mode:
 ```shell ```shell
 kvim2# kbi led systemon w breathe kvim2# kbi led systemon w breathe
Line 145: Line 148:
 ==== Boot Mode ==== ==== Boot Mode ====
  
-You can flash images to either SPI flash or eMMC storage on the VIM2, and use KBI to set one of them as the default boot media.+You can flash the images to SPI or eMMC storage in VIM2, and setup one of them as the default boot media by KBI. 
 + 
 +Set the default boot media as the SPI:
  
-Set the default boot media to SPI flash: 
 ```shell ```shell
 kvim2# kbi bootmode w spi kvim2# kbi bootmode w spi
 ``` ```
  
-Set default boot media to eMMC storage:+Set default boot media as eMMC storage:
  
 ```shell ```shell
Line 158: Line 162:
 ``` ```
  
-You can check the current default boot media setting:+You can take a review on the default boot media by running:
  
 ```shell ```shell
Line 167: Line 171:
 ==== Boot Trigger Events ==== ==== Boot Trigger Events ====
  
-The VIM2 supports several events to trigger boot-up: +VIM2 supports different events for triggering boot-up: 
-  * WOL: Wake-on-Lan+  * WOL: Wake on Lan
   * RTC: RTC timer   * RTC: RTC timer
   * IR: IR remote controller   * IR: IR remote controller
Line 174: Line 178:
   * Key: Power Key/Button   * Key: Power Key/Button
   * GPIO: External GPIO events   * GPIO: External GPIO events
-This means any of the above events can trigger the VIM2 to power on, provided that the specific trigger event has been enabled.+It means any of the above events can trigger VIM2 to power-on after that trigger event has been set to the ''enabled'' status.
  
 For example: For example:
  
-  * Get the status of the WOL trigger event: +  * Get the status of the WOL trigger event: \\ ```shell
-```shell+
 kvim2# kbi trigger wol r kvim2# kbi trigger wol r
 boot wol: disable boot wol: disable
 ``` ```
-  * WOL is disabled by default in the pre-installed ROM. You can enable it: +  * WOL is disabled for the pre-installed ROM by default, you can enable it by writing a new value\\ ```shell
-```shell+
 kvim2# kbi trigger wol w 1 kvim2# kbi trigger wol w 1
 set_wol: 1 set_wol: 1
 ``` ```
-  * For security reasons, you may want to disable WOLreasons. :  +  * In general, you will disable the WOL for security reasons. : \\ ```shell
-```shell+
 kvim2# kbi trigger wol w 0 kvim2# kbi trigger wol w 0
 set_wol: 0 set_wol: 0
Last modified: 2026/02/27 04:31 by gray