System transplant

Add a custom solution

Several key warehouses related to product solutions are as follows:

build: Add build whitelist, mainly modify the files: compile_standard_whitelist.json and subsystem_compoents_whitelist.json

vendor/spacemit: Iteration vendor customized adaptation directory

device/board/spacemit: Iterate the manufacturer's board-level adaptation directory

device/soc/spacemit: Iteration manufacturer chip adaptation directory

kernel/linux/spacemit_kernel-6.6: Iteration of the vendor kernel

There are 2 ways to add a custom solution:

Adapt the new solution by modifying the existing solution. For example, if you need to re-adapt a development board, the adapted development board in the source code is deb1. You can adapt the new development board by modifying the configuration in this solution. Add a new solution

The following describes the operations of the two customized solutions:

Customize by modifying existing plans

Customize uboot

Currently, the uboot source code has not been uploaded, but the schematic diagram can be provided. After configuration and compilation, the uboot-related bin files can be provided. The following describes how to add the uboot file to the system. The general uboot files are in the device/soc/spacemit/k1/kernel/boot directory. These uboot files are applicable to all solutions, as follows:

|-- bootfs
|   |-- boot_logo_spacemit_0.bmp
|   |-- boot_logo_spacemit_180.bmp
|   |-- boot_logo_spacemit_270.bmp
|   `-- boot_logo_spacemit_90.bmp
|-- env.bin
|-- factory
|   |-- bootinfo_emmc.bin
|   |-- bootinfo_sd.bin
|   |-- bootinfo_spinand.bin
|   |-- bootinfo_spinor.bin
|   `-- FSBL.bin
|-- fastboot.yaml
|-- fw_dynamic.itb
|-- genimage.cfg
|-- partition_2M.json
|-- partition_flash.json
`-- u-boot.itb

Frequently updated files include env.bin, FSBL.bin, and u-boot.bin. These files are copied to the packaging directory in device/board/spacemit/xxx/kernel/build_kernel.sh as follows:

cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/bootfs/boot_logo_spacemit_0.bmp ${OHOS_IMAGES_DIR}/bootfs/bianbu.bmp
cp ${OHOS_SOURCE_ROOT}/device/board/${DEVICE_BOARD}/${DEVICE_NAME}/kernel/boot/bootfs/env_k1-x.txt ${OHOS_IMAGES_DIR}/bootfs/env_k1-x.txt
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/env.bin ${OHOS_IMAGES_DIR}/env.bin
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/u-boot.itb ${OHOS_IMAGES_DIR}/u-boot.itb
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/fw_dynamic.itb ${OHOS_IMAGES_DIR}/fw_dynamic.itb
cp ${OHOS_SOURCE_ROOT}/device/board/${DEVICE_BOARD}/${DEVICE_NAME}/kernel/boot/partition_universal.json ${OHOS_IMAGES_DIR}/partition_universal.json
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/fastboot.yaml ${OHOS_IMAGES_DIR}/fastboot.yaml
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/genimage.cfg ${OHOS_IMAGES_DIR}/genimage.cfg
cp -r ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/factory ${OHOS_IMAGES_DIR}/

If the uboot of some solutions is specially customized, you need to place the uboot bin separately in the directory device/board/spacemit/xxx/kernel/boot of the solution. At the same time, you also need to modify the build_kernel.sh file and copy the uboot file in the solution directory to the packaging directory.

Custom kernel

Modify dts

The kernel's dts files are uniformly placed in: kernel/linux/spacemit_kernel-6.6/arch/riscv/boot/dts/spacemit, as shown below:

|-- k1-x-camera-reserved-mm.dtsi
|-- k1-x-camera-sdk.dtsi
|-- k1-x-camera-sensor.dtsi
|-- k1-x_deb1.dts
|-- k1-x_deb2.dts
|-- k1-x.dtsi
|-- k1-x-efuse.dtsi
|-- k1-x_evb.dts
|-- k1-x-hdmi.dtsi
|-- k1-x_hs450.dts
|-- k1-x_kx312.dts
|-- k1-x-lcd.dtsi
|-- k1-x_lpi3a.dts
|-- k1-x_milkv-jupiter.dts
|-- k1-x_mingo.dts
|-- k1-x_MINI-PC.dts
|-- k1-x_MUSE-Book.dts
|-- k1-x_MUSE-Card.dts
|-- k1-x_MUSE-N1.dts
|-- k1-x_MUSE-Paper2.dts
|-- k1-x_MUSE-Paper.dts
|-- k1-x_MUSE-Paper-mini-4g.dts
|-- k1-x_MUSE-Pi.dts
|-- k1-x_opp_table.dtsi
|-- k1-x_pinctrl.dtsi
|-- k1-x_SMT001.dts
|-- k1-x_thermal_cooling.dtsi
|-- k1-x_ZT001H.dts
|-- lcd
|   |-- lcd_ft8201sinx101_mipi.dtsi
|   |-- lcd_gc9503v_mipi.dtsi
|   |-- lcd_gx09inx101_mipi.dtsi
|   |-- lcd_icnl9911c_mipi.dtsi
|   |-- lcd_icnl9951r_mipi.dtsi
|   |-- lcd_jd9365dah3_mipi.dtsi
|   |-- lcd_jd9365da_mipi_1280x800.dtsi
|   |-- lcd_lt8911_edp_1920x1080.dtsi
|   |-- lcd_lt8911_edp_1920x1200.dtsi
|   |-- lcd_lt9711_dp_1920x1080.dtsi
|   `-- lcd_orisetech_ota7290b_mipi.dtsi
|-- m1-x_milkv-jupiter.dts
`-- Makefile

You can modify the corresponding dts file according to the scheme name. After the modification is completed, recompile the kernel as follows:

./build.sh --product-name xxx --ccache -T build_kernel

Modify defconfig

The kernel defconfig file is placed in: kernel/linux/spacemit_kernel-6.6/arch/riscv/configs/k1_defconfig. This defconfig is shared by all schemes. After modification, it will take effect on all schemes. If you only want to modify a specific scheme, you need to modify it in the form of patching. The process is as follows:

Generate patch: fix.patch Place fix.patch in device/board/spacemit/xxx/kernel/kernel_patch Device/board/spacemit/musebook/kernel/build_kernel.sh Apply the patch as follows:

patch -p1 <${OHOS_SOURCE_ROOT}/device/board/${DEVICE_BOARD}/${DEVICE_NAME}/kernel/kernel_patch/fix.patch

Customizing the vendor directory

Here is a brief description of the purpose of the directories and files under vendor/spacemit/xxx:

bluetooth: Bluetooth vendor adaptation layer; modify this folder primarily for adapting Bluetooth modules  
config.json: Components included in the solution, allowing addition/removal of components and property configuration for components  
default_app_config: No modifications needed yet  
etc: Add system properties, such as `const.product.name="XXX"`  
hals: The internal `audio` directory mainly adapts audio signal pathways, etc.  
hdf_config: HDF configuration files for the solution  
image_conf: No modifications needed yet  
ohos.build: Add build modules  
power_config: Configure power management modes (NORMAL, POWER_SAVE, PERFORMANCE, EXTREME_POWER_SAVE), defining behaviors for each mode including screen-off timeout, standby duration, etc.  
preinstall-config: Management of pre-installed HAP packages and permission settings  
product.gni: Property configuration settings  
resourceschedule: No modifications needed yet  
security_config: No modifications needed yet  
updater_config: No modifications needed yet  
window_config: Window-related configurations, such as screen rotation orientation and transition animation timing settings, etc.

Customizing the device directory

The directory structure under device is divided into two directories: board and soc. The content in soc is adapted for the K1 chip, and the content in board is adapted for individual product solutions. The directory structure under device is as follows:

|-- board
|   `-- spacemit
|       |-- common
|       |-- deb1
|       |-- kernel_patches
|       |-- musebook
|       |-- musecard
|       |-- musepi
|       |-- smt001
|       `-- zt001h
`-- soc
    `-- spacemit
        |-- common
        `-- k1

The main modifications to device/board/spacemit/xxx include:

cfg/default.para: System configuration parameters  
cfg/fstab.xxx: File system mount configuration  
cfg/init.xxx.cfg: Boot configuration  
cfg/init.xxx.usb.cfg: USB boot configuration  
kernel: Kernel-related configurations and files  
kernel/boot: U-Boot-related files  
kernel/build_kernel.sh: Kernel build script  
kernel/kernel_patch: Kernel patches  
kernel/ko: Kernel modules (KO files) to be loaded  

Key modification points under `device/soc/spacemit/k1` include:  
hardware: Hardware adaptation layer for K1, including hardware codecs, GPU, etc.  
kernel/boot: U-Boot-related files  
tools: Command-line tools

Customize by adding new schemes

Customize uboot

Currently, uboot source code has not been uploaded, but you can provide a schematic diagram and a solution code, such as ABC. After the configuration and compilation of Jindi, you can provide uboot related bin files. The following describes how to add the uboot files provided by Jindi to the system.

The general uboot file is in the device/soc/spacemit/k1/kernel/boot directory, as follows:

|-- bootfs
|   |-- boot_logo_spacemit_0.bmp
|   |-- boot_logo_spacemit_180.bmp
|   |-- boot_logo_spacemit_270.bmp
|   `-- boot_logo_spacemit_90.bmp
|-- env.bin
|-- factory
|   |-- bootinfo_emmc.bin
|   |-- bootinfo_sd.bin
|   |-- bootinfo_spinand.bin
|   |-- bootinfo_spinor.bin
|   `-- FSBL.bin
|-- fastboot.yaml
|-- fw_dynamic.itb
|-- genimage.cfg
|-- partition_2M.json
|-- partition_flash.json
`-- u-boot.itb

Frequently updated files include env.bin, FSBL.bin, and u-boot.bin. These files are copied to the packaging directory in device/board/spacemit/xxx/kernel/build_kernel.sh as follows:

cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/bootfs/boot_logo_spacemit_0.bmp ${OHOS_IMAGES_DIR}/bootfs/bianbu.bmp
cp ${OHOS_SOURCE_ROOT}/device/board/${DEVICE_BOARD}/${DEVICE_NAME}/kernel/boot/bootfs/env_k1-x.txt ${OHOS_IMAGES_DIR}/bootfs/env_k1-x.txt
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/env.bin ${OHOS_IMAGES_DIR}/env.bin
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/u-boot.itb ${OHOS_IMAGES_DIR}/u-boot.itb
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/fw_dynamic.itb ${OHOS_IMAGES_DIR}/fw_dynamic.itb
cp ${OHOS_SOURCE_ROOT}/device/board/${DEVICE_BOARD}/${DEVICE_NAME}/kernel/boot/partition_universal.json ${OHOS_IMAGES_DIR}/partition_universal.json
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/fastboot.yaml ${OHOS_IMAGES_DIR}/fastboot.yaml
cp ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/genimage.cfg ${OHOS_IMAGES_DIR}/genimage.cfg
cp -r ${OHOS_SOURCE_ROOT}/device/soc/${DEVICE_BOARD}/k1/kernel/boot/factory ${OHOS_IMAGES_DIR}/

If the uboot of some solutions is specially customized, you need to place the uboot bin separately in the directory device/board/spacemit/xxx/kernel/boot of the solution. At the same time, you also need to modify the build_kernel.sh file and copy the uboot file in the solution directory to the packaging directory.

Custom kernel

Modify the dts kernel's dts files and place them in: kernel/linux/spacemit_kernel-6.6/arch/riscv/boot/dts/spacemit, as shown below:

|-- k1-x-camera-reserved-mm.dtsi
|-- k1-x-camera-sdk.dtsi
|-- k1-x-camera-sensor.dtsi
|-- k1-x_deb1.dts
|-- k1-x_deb2.dts
|-- k1-x.dtsi
|-- k1-x-efuse.dtsi
|-- k1-x_evb.dts
|-- k1-x-hdmi.dtsi
|-- k1-x_hs450.dts
|-- k1-x_kx312.dts
|-- k1-x-lcd.dtsi
|-- k1-x_lpi3a.dts
|-- k1-x_milkv-jupiter.dts
|-- k1-x_mingo.dts
|-- k1-x_MINI-PC.dts
|-- k1-x_MUSE-Book.dts
|-- k1-x_MUSE-Card.dts
|-- k1-x_MUSE-N1.dts
|-- k1-x_MUSE-Paper2.dts
|-- k1-x_MUSE-Paper.dts
|-- k1-x_MUSE-Paper-mini-4g.dts
|-- k1-x_MUSE-Pi.dts
|-- k1-x_opp_table.dtsi
|-- k1-x_pinctrl.dtsi
|-- k1-x_SMT001.dts
|-- k1-x_thermal_cooling.dtsi
|-- k1-x_ZT001H.dts
|-- lcd
|   |-- lcd_ft8201sinx101_mipi.dtsi
|   |-- lcd_gc9503v_mipi.dtsi
|   |-- lcd_gx09inx101_mipi.dtsi
|   |-- lcd_icnl9911c_mipi.dtsi
|   |-- lcd_icnl9951r_mipi.dtsi
|   |-- lcd_jd9365dah3_mipi.dtsi
|   |-- lcd_jd9365da_mipi_1280x800.dtsi
|   |-- lcd_lt8911_edp_1920x1080.dtsi
|   |-- lcd_lt8911_edp_1920x1200.dtsi
|   |-- lcd_lt9711_dp_1920x1080.dtsi
|   `-- lcd_orisetech_ota7290b_mipi.dtsi
|-- m1-x_milkv-jupiter.dts
`-- Makefile

You can add the corresponding dts file according to the scheme name, such as k1-x_ABC.dts. After the modification is completed, add it to the above directory and modify the Makefile file as follows:

diff --git a/arch/riscv/boot/dts/spacemit/Makefile b/arch/riscv/boot/dts/spacemit/Makefile
index ea48d28cedda..36beb0761dd7 100644
--- a/arch/riscv/boot/dts/spacemit/Makefile
+++ b/arch/riscv/boot/dts/spacemit/Makefile
@@ -3,5 +3,5 @@ dtb-$(CONFIG_SOC_SPACEMIT_K1X) += k1-x_evb.dtb k1-x_deb2.dtb k1-x_deb1.dtb k1-x_
                                  k1-x_MUSE-Pi.dtb k1-x_milkv-jupiter.dtb m1-x_milkv-jupiter.dtb \
                                  k1-x_MUSE-Book.dtb k1-x_lpi3a.dtb k1-x_MUSE-Card.dtb \
                                  k1-x_MUSE-Paper.dtb k1-x_MUSE-Paper-mini-4g.dtb \
-                                 k1-x_ZT001H.dtb k1-x_MUSE-Paper2.dtb
+                                 k1-x_ZT001H.dtb k1-x_MUSE-Paper2.dtb k1-x_ABC.dtb
 obj-$(CONFIG_BUILTIN_DTB) += $(addsuffix .o, $(dtb-y))

Recompile the kernel as follows:

./build.sh --product-name xxx --ccache -T build_kernel

Modify defconfig The kernel defconfig file is placed in: kernel/linux/spacemit_kernel-6.6/arch/riscv/configs/k1_defconfig. This defconfig is shared by all schemes. After modification, it will take effect on all schemes. If you only want to modify a specific scheme, you need to modify it in the form of patching. The process is as follows:

Generate patch: fix.patch Place fix.patch in device/board/xxx/musebook/kernel/kernel_patch and apply the patch in device/board/spacemit/xxx/kernel/build_kernel.sh as follows:

patch -p1 <${OHOS_SOURCE_ROOT}/device/board/${DEVICE_BOARD}/${DEVICE_NAME}/kernel/kernel_patch/fix.patch

Customizing the vendor directory The customization of the vendor directory is different from that in section 2.1.3. Because a new solution is added, there is no such directory under vendor/spacemit. The customization method is to copy an existing solution directory, and then uniformly modify the words about the solution, and then modify the specific content. Copy an existing solution: Select a similar solution to copy. For example, if you want to make a development board, select deb1. Take the development board smt001 as an example to create a new solution, as follows:

cd vendor/spacemit
cp -r deb1 smt001

Modify the scheme name uniformly, change all deb1 words to smt001, and change all file names with deb1 words to file names with smt001

# sed -i "s/deb1/smt001/g" `grep -rl deb1 ./`
# find . -name *deb1*
./etc/param/product_deb1.para
./etc/param/hardware_deb1.para
# mv ./etc/param/product_deb1.para ./etc/param/product_smt001.para
# mv ./etc/param/hardware_deb1.para ./etc/param/hardware_smt001.para

Modify and customize

Customizing the device directory The customization of the device directory is different from that in Section 2.1.4. Because a new solution is added, there is no such directory under device/board/spacemit. The customization method is to copy an existing solution directory, and then uniformly modify the words about the solution, and then modify the specific content.

Copy an existing solution: Select a similar solution to copy. For example, if you want to make a development board, select deb1. Create a new solution using the development board smt001 as an example, as follows:

cd device/board/spacemit
cp -r deb1 smt001

Modify the scheme name uniformly, change all deb1 words to smt001, and change all file names with deb1 words to file names with smt001

# sed -i "s/deb1/smt001/g" `grep -rl deb1 ./`
# find . -name *deb1*
./etc/param/product_deb1.para
./etc/param/hardware_deb1.para
# mv ./etc/param/product_deb1.para ./etc/param/product_smt001.para
# mv ./etc/param/hardware_deb1.para ./etc/param/hardware_smt001.para

Modify and customize the build directory. Add permissions. Add solution configuration in subsystem_compoents_whitelist.json.

diff --git a/subsystem_compoents_whitelist.json b/subsystem_compoents_whitelist.json
index ee125742..a01e2e1c 100644
--- a/subsystem_compoents_whitelist.json
+++ b/subsystem_compoents_whitelist.json
@@ -15,6 +15,7 @@
    "device_musepi" :"device_musepi",
   "device_musecard" :"device_musecard",
+  "device_smt001" :"device_smt001",
    "device_zt001h" :"device_zt001h",

Add a whitelist of modules to compile_standard_whitelist.json. The change is relatively correct. The method is to search for the name of the original solution copied by the solution, such as deb1, copy all the modules containing deb1, and change the solution name to smt001