justmarvinn/luckfox-pico-sdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update:readme update

Browse Source
This commit is contained in:
eng33 2023-12-18 18:12:38 +08:00 committed by luckfox-eng33
parent 43b945a541
commit 39229dd102
4 changed files with 237 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
README.md
View File

@ -4,28 +4,13 @@
* This SDK is modified based on the SDK provided by Rockchip * This SDK is modified based on the SDK provided by Rockchip
* It provides a customized SDK specifically for Luckfox Pico series development boards  * It provides a customized SDK specifically for Luckfox Pico series development boards 
* Aimed at providing developers with a better programming experience * Aimed at providing developers with a better programming experience
## SDK Introduction ## SDK Updatelog
* The current main branch uses buildroot to build the rootfs, which makes it easier to add or remove applications. * Current version V1.2
* The original rootfs built directly with busybox has been moved to the busybox branch. 1. Added compatibility for Ubuntu system
### Default Applications 2. Restored support for busybox, allowing users to choose between busybox, buildroot, and Ubuntu according to their needs
The default SDK includes or installs the following applications (but not limited to): 3. Added Ubuntu root file submodule and support for switching between GitHub and Gitee sources
1. python3 4. Added support for exFAT file system
* The following libraries are enabled by default: 5. Partial bug fixes
1. PERIPHERY
2. PILLOW (font loading is temporarily unavailable)
3. SERIAL
4. SMBUS
5. SPIDEV
2. ssh
1. Automatically starts at boot
2. Username: root
3. Password: luckfox
3. samba
1. Automatically starts at boot
2. Username: root
3. Password: luckfox
4. adb
1. Automatically starts at boot
## SDK Usage Instructions ## SDK Usage Instructions
* recommended operating system : Ubuntu 22.04 * recommended operating system : Ubuntu 22.04
### Installing Dependencies ### Installing Dependencies
@ -42,6 +27,20 @@ git clone https://github.com/LuckfoxTECH/luckfox-pico.git
cd {SDK_PATH}/tools/linux/toolchain/arm-rockchip830-linux-uclibcgnueabihf/ cd {SDK_PATH}/tools/linux/toolchain/arm-rockchip830-linux-uclibcgnueabihf/
source env_install_toolchain.sh source env_install_toolchain.sh
``` ```
### Get the SDK
* GitHub
```
git clone <https://github.com/LuckfoxTECH/luckfox-pico.git>
```
* Gitee
```
git clone <https://gitee.com/LuckfoxTECH/luckfox-pico.git>
```
* If you need to compile the Ubuntu system and use the Gitee source
* Please modify the corresponding board mk file LF_SUBMODULES_BY to gitee, for example
```
LF_SUBMODULES_BY=gitee
```
### Instructions for build.sh ### Instructions for build.sh
* The build.sh script is used to automate the compilation process. * The build.sh script is used to automate the compilation process.
* Most of the compilation operations can be completed automatically through build.sh. * Most of the compilation operations can be completed automatically through build.sh.
@ -93,47 +92,79 @@ You're building on Linux
Lunch menu...pick a combo: Lunch menu...pick a combo:
BoardConfig-*.mk naming rules: BoardConfig-*.mk naming rules:
BoardConfig-"启动介质"-"电源方案"-"硬件版本"-"应用场景".mk BoardConfig-"启动介质"-"系统版本"-"硬件版本"-"应用场景".mk
BoardConfig-"boot medium"-"power solution"-"hardware version"-"applicaton".mk BoardConfig-"boot medium"-"system version"-"hardware version"-"applicaton".mk
---------------------------------------------------------------- ----------------------------------------------------------------
1. BoardConfig_IPC/BoardConfig-EMMC-NONE-RV1103_Luckfox_Pico-IPC.mk 0. BoardConfig_IPC/BoardConfig-EMMC-Buildroot-RV1103_Luckfox_Pico-IPC.mk
boot medium(启动介质): EMMC boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Buildroot
hardware version(硬件版本): RV1103_Luckfox_Pico hardware version(硬件版本): RV1103_Luckfox_Pico
applicaton(应用场景): IPC applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
---------------------------------------------------------------- ----------------------------------------------------------------
2. BoardConfig_IPC/BoardConfig-EMMC-NONE-RV1103_Luckfox_Pico_Mini_A-IPC.mk 1. BoardConfig_IPC/BoardConfig-EMMC-Buildroot-RV1103_Luckfox_Pico_Mini_A-IPC.mk
boot medium(启动介质): EMMC boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Buildroot
hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_A hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_A
applicaton(应用场景): IPC applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
---------------------------------------------------------------- ----------------------------------------------------------------
3. BoardConfig_IPC/BoardConfig-SPI_NAND-NONE-RV1103_Luckfox_Pico_Mini_B-IPC.mk 2. BoardConfig_IPC/BoardConfig-EMMC-Ubuntu-RV1103_Luckfox_Pico-IPC.mk
boot medium(启动介质): SPI_NAND boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Ubuntu
hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_B hardware version(硬件版本): RV1103_Luckfox_Pico
applicaton(应用场景): IPC applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
---------------------------------------------------------------- ----------------------------------------------------------------
4. BoardConfig_IPC/BoardConfig-SPI_NAND-NONE-RV1103_Luckfox_Pico_Plus-IPC.mk 3. BoardConfig_IPC/BoardConfig-EMMC-Ubuntu-RV1103_Luckfox_Pico_Mini_A-IPC.mk
boot medium(启动介质): SPI_NAND boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Ubuntu
hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_A
applicaton(应用场景): IPC
----------------------------------------------------------------
----------------------------------------------------------------
4. BoardConfig_IPC/BoardConfig-EMMC-Ubuntu-RV1103_Luckfox_Pico_Plus-IPC.mk
boot medium(启动介质): EMMC
system version(系统版本): Ubuntu
hardware version(硬件版本): RV1103_Luckfox_Pico_Plus hardware version(硬件版本): RV1103_Luckfox_Pico_Plus
applicaton(应用场景): IPC applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
---------------------------------------------------------------- ----------------------------------------------------------------
5. BoardConfig_IPC/BoardConfig-SPI_NAND-NONE-RV1106_Luckfox_Pico_Pro_Max-IPC.mk 5. BoardConfig_IPC/BoardConfig-EMMC-Ubuntu-RV1106_Luckfox_Pico_Pro_Max-IPC.mk
boot medium(启动介质): SPI_NAND boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Ubuntu
hardware version(硬件版本): RV1106_Luckfox_Pico_Pro_Max hardware version(硬件版本): RV1106_Luckfox_Pico_Pro_Max
applicaton(应用场景): IPC applicaton(应用场景): IPC
----------------------------------------------------------------
----------------------------------------------------------------
6. BoardConfig_IPC/BoardConfig-SPI_NAND-Buildroot-RV1103_Luckfox_Pico_Mini_B-IPC.mk
boot medium(启动介质): SPI_NAND
system version(系统版本): Buildroot
hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_B
applicaton(应用场景): IPC
----------------------------------------------------------------
----------------------------------------------------------------
7. BoardConfig_IPC/BoardConfig-SPI_NAND-Buildroot-RV1103_Luckfox_Pico_Plus-IPC.mk
boot medium(启动介质): SPI_NAND
system version(系统版本): Buildroot
hardware version(硬件版本): RV1103_Luckfox_Pico_Plus
applicaton(应用场景): IPC
----------------------------------------------------------------
----------------------------------------------------------------
8. BoardConfig_IPC/BoardConfig-SPI_NAND-Buildroot-RV1106_Luckfox_Pico_Pro_Max-IPC.mk
boot medium(启动介质): SPI_NAND
system version(系统版本): Buildroot
hardware version(硬件版本): RV1106_Luckfox_Pico_Pro_Max
applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
Which would you like? [0]: Which would you like? [0]:
@ -145,6 +176,18 @@ Which would you like? [0]:
./build.sh lunch # Select the reference board configuration ./build.sh lunch # Select the reference board configuration
./build.sh # One-click automatic compilation ./build.sh # One-click automatic compilation
``` ```
* Compile busybox/buildroot
```
./build.sh lunch # Select the reference board
./build.sh # One-click automatic compilation
```
* Compile Ubuntu
```
sudo ./build.sh lunch # Select the reference board
sudo ./build.sh # One-click automatic compilation
```
* Note that when compiling Ubuntu, make sure to use sudo, otherwise it may cause file system errors
* The following text will not distinguish between the two sets of instructions, please choose accordingly based on the situation
#### Build U-Boot #### Build U-Boot
```shell ```shell
./build.sh clean uboot ./build.sh clean uboot

152
README_CN.md
View File

@ -4,46 +4,39 @@
* 本SDK基于RK官方提供的SDK修改而来 * 本SDK基于RK官方提供的SDK修改而来
* 专为Luckfox Pico系列开发板提供客制化的SDK * 专为Luckfox Pico系列开发板提供客制化的SDK
* 旨在为开发者提供更好的编程体验 * 旨在为开发者提供更好的编程体验
## SDK 介绍 ## SDK 更新日志
* 当前main分支，rootfs使用buildroot构建，可以更加轻松的添加或者删除应用程序 * 当前版本 V1.2
* 原先使用busybox直接构建rootfs，被移动到busybox分支 1. 添加ubuntu系统兼容
### 默认应用 2. 恢复对busybox的支持，使用户可以根据自身需求busybox、buildroot和ubuntu
默认SDK中开启或者装有应用（包括但不限于） 3. 添加ubuntu根文件子库，并且支持github与gitee源切换
1. python3 4. 添加exfat文件系统的支持
* 默认开启以下库 5. 部分bug修复
1. PERIPHERY
2. PILLOW（暂时无法加载字体）
3. SERIAL
4. SMBUS
5. SPIDEV
2. ssh
1. 默认开机自启
2. 账号为root
3. 密码为luckfox
3. samba
1. 默认开机自启
2. 账号为root
3. 密码为luckfox
4. adb
1. 默认开机自启
## SDK 使用说明 ## SDK 使用说明
* 推荐使用系统为Ubuntu 22.04 * 推荐使用系统为Ubuntu 22.04
### 安装依赖 ### 安装依赖
```shell ```shell
sudo apt-get install repo git ssh make gcc gcc-multilib g++-multilib module-assistant expect g++ gawk texinfo libssl-dev bison flex fakeroot cmake unzip gperf autoconf device-tree-compiler libncurses5-dev pkg-config sudo apt-get install repo git ssh make gcc gcc-multilib g++-multilib module-assistant expect g++ gawk texinfo libssl-dev bison flex fakeroot cmake unzip gperf autoconf device-tree-compiler libncurses5-dev pkg-config
``` ```
### 获取SDK ### 获取SDK
``` * github
git clone https://github.com/LuckfoxTECH/luckfox-pico.git ```
``` git clone https://github.com/LuckfoxTECH/luckfox-pico.git
```
* gitee
```
git clone https://gitee.com/LuckfoxTECH/luckfox-pico.git
```
* 如果你需要需要编译ubuntu系统，并且使用gitee源
* 请修改对应的板型mk文件中LF_SUBMODULES_BY改为gitee，如
```
LF_SUBMODULES_BY=gitee
```
### 环境变量 ### 环境变量
* 需要将交叉编译工具链设置 * 需要将交叉编译工具链设置
``` ```
cd {SDK_PATH}/tools/linux/toolchain/arm-rockchip830-linux-uclibcgnueabihf/ cd {SDK_PATH}/tools/linux/toolchain/arm-rockchip830-linux-uclibcgnueabihf/
source env_install_toolchain.sh source env_install_toolchain.sh
``` ```
### build.sh使用说明 ### build.sh使用说明
* SDK使用build.sh脚本实现自动编译，大部分编译操作均可以通过build.sh自动完成. * SDK使用build.sh脚本实现自动编译，大部分编译操作均可以通过build.sh自动完成.
#### build.sh全部可用选项 #### build.sh全部可用选项
@ -94,47 +87,79 @@ You're building on Linux
Lunch menu...pick a combo: Lunch menu...pick a combo:
BoardConfig-*.mk naming rules: BoardConfig-*.mk naming rules:
BoardConfig-"启动介质"-"电源方案"-"硬件版本"-"应用场景".mk BoardConfig-"启动介质"-"系统版本"-"硬件版本"-"应用场景".mk
BoardConfig-"boot medium"-"power solution"-"hardware version"-"applicaton".mk BoardConfig-"boot medium"-"system version"-"hardware version"-"applicaton".mk
---------------------------------------------------------------- ----------------------------------------------------------------
1. BoardConfig_IPC/BoardConfig-EMMC-NONE-RV1103_Luckfox_Pico-IPC.mk 0. BoardConfig_IPC/BoardConfig-EMMC-Buildroot-RV1103_Luckfox_Pico-IPC.mk
boot medium(启动介质): EMMC boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Buildroot
hardware version(硬件版本): RV1103_Luckfox_Pico hardware version(硬件版本): RV1103_Luckfox_Pico
applicaton(应用场景): IPC applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
---------------------------------------------------------------- ----------------------------------------------------------------
2. BoardConfig_IPC/BoardConfig-EMMC-NONE-RV1103_Luckfox_Pico_Mini_A-IPC.mk 1. BoardConfig_IPC/BoardConfig-EMMC-Buildroot-RV1103_Luckfox_Pico_Mini_A-IPC.mk
boot medium(启动介质): EMMC boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Buildroot
hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_A hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_A
applicaton(应用场景): IPC applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
---------------------------------------------------------------- ----------------------------------------------------------------
3. BoardConfig_IPC/BoardConfig-SPI_NAND-NONE-RV1103_Luckfox_Pico_Mini_B-IPC.mk 2. BoardConfig_IPC/BoardConfig-EMMC-Ubuntu-RV1103_Luckfox_Pico-IPC.mk
boot medium(启动介质): SPI_NAND boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Ubuntu
hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_B hardware version(硬件版本): RV1103_Luckfox_Pico
applicaton(应用场景): IPC applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
---------------------------------------------------------------- ----------------------------------------------------------------
4. BoardConfig_IPC/BoardConfig-SPI_NAND-NONE-RV1103_Luckfox_Pico_Plus-IPC.mk 3. BoardConfig_IPC/BoardConfig-EMMC-Ubuntu-RV1103_Luckfox_Pico_Mini_A-IPC.mk
boot medium(启动介质): SPI_NAND boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Ubuntu
hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_A
applicaton(应用场景): IPC
----------------------------------------------------------------
----------------------------------------------------------------
4. BoardConfig_IPC/BoardConfig-EMMC-Ubuntu-RV1103_Luckfox_Pico_Plus-IPC.mk
boot medium(启动介质): EMMC
system version(系统版本): Ubuntu
hardware version(硬件版本): RV1103_Luckfox_Pico_Plus hardware version(硬件版本): RV1103_Luckfox_Pico_Plus
applicaton(应用场景): IPC applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
---------------------------------------------------------------- ----------------------------------------------------------------
5. BoardConfig_IPC/BoardConfig-SPI_NAND-NONE-RV1106_Luckfox_Pico_Pro_Max-IPC.mk 5. BoardConfig_IPC/BoardConfig-EMMC-Ubuntu-RV1106_Luckfox_Pico_Pro_Max-IPC.mk
boot medium(启动介质): SPI_NAND boot medium(启动介质): EMMC
power solution(电源方案): NONE system version(系统版本): Ubuntu
hardware version(硬件版本): RV1106_Luckfox_Pico_Pro_Max hardware version(硬件版本): RV1106_Luckfox_Pico_Pro_Max
applicaton(应用场景): IPC applicaton(应用场景): IPC
----------------------------------------------------------------
----------------------------------------------------------------
6. BoardConfig_IPC/BoardConfig-SPI_NAND-Buildroot-RV1103_Luckfox_Pico_Mini_B-IPC.mk
boot medium(启动介质): SPI_NAND
system version(系统版本): Buildroot
hardware version(硬件版本): RV1103_Luckfox_Pico_Mini_B
applicaton(应用场景): IPC
----------------------------------------------------------------
----------------------------------------------------------------
7. BoardConfig_IPC/BoardConfig-SPI_NAND-Buildroot-RV1103_Luckfox_Pico_Plus-IPC.mk
boot medium(启动介质): SPI_NAND
system version(系统版本): Buildroot
hardware version(硬件版本): RV1103_Luckfox_Pico_Plus
applicaton(应用场景): IPC
----------------------------------------------------------------
----------------------------------------------------------------
8. BoardConfig_IPC/BoardConfig-SPI_NAND-Buildroot-RV1106_Luckfox_Pico_Pro_Max-IPC.mk
boot medium(启动介质): SPI_NAND
system version(系统版本): Buildroot
hardware version(硬件版本): RV1106_Luckfox_Pico_Pro_Max
applicaton(应用场景): IPC
---------------------------------------------------------------- ----------------------------------------------------------------
Which would you like? [0]: Which would you like? [0]:
@ -144,16 +169,17 @@ Which would you like? [0]:
#### 一键自动编译 #### 一键自动编译
* 编译busybox/buildroot * 编译busybox/buildroot
```shell ```shell
./build.sh lunch # 选择参考板级 ./build.sh lunch # 选择参考板级
./build.sh # 一键自动编译 ./build.sh # 一键自动编译
``` ```
* 编译ubuntu * 编译ubuntu
```shell ```shell
sudo ./build.sh lunch # 选择参考板级 sudo ./build.sh lunch # 选择参考板级
sudo ./build.sh # 一键自动编译 sudo ./build.sh # 一键自动编译
``` ```
* 编译ubuntu时需要注意使用sudo，否则会报错 * 注意编译ubuntu时需要注意使用sudo，否则会导致文件系统错误
* 下文就不一一区分两者指令区别，请自行根据情况选择
#### 单独编译U-Boot #### 单独编译U-Boot
```shell ```shell
./build.sh clean uboot ./build.sh clean uboot

30
UPDATE_LOG.md Executable file
View File

@ -0,0 +1,30 @@
# Updatelog
## V1.2 Updatelog
1. Added compatibility for Ubuntu system
2. Restored support for busybox, allowing users to choose between busybox, buildroot, and Ubuntu according to their needs
3. Added Ubuntu root file submodule and support for switching between GitHub and Gitee sources
4. Added support for exFAT file system
5. Partial bug fixes
## V1.1 Updatelog
1. Rootfs built using buildroot, making it easier to add or remove applications
2. Previously, the rootfs was directly built using busybox, which has been moved to the busybox branch
3. Buildroot now defaults to enabling the following libraries:
1. Python3
* Default libraries enabled:
1. PERIPHERY
2. PILLOW (font loading temporarily unavailable)
3. SERIAL
4. SMBUS
5. SPIDEV
2. SSH
1. Automatically starts on boot
2. Account: root
3. Password: luckfox
3. Samba
1. Automatically starts on boot
2. Account: root
3. Password: luckfox
4. ADB
1. Automatically starts on boot
## V1.0 Updatelog
* Initial upload, default system is busybox

30
UPDATE_LOG_CN.md Normal file
View File

@ -0,0 +1,30 @@
# 更新日志
## V1.2 更新日志
1. 添加ubuntu系统兼容
2. 恢复对busybox的支持，使用户可以根据自身需求busybox、buildroot和ubuntu
3. 添加ubuntu根文件子库，并且支持github与gitee源切换
4. 添加exfat文件系统的支持
5. 部分bug修复
## V1.1 更新日志
1. rootfs使用buildroot构建，可以更加轻松的添加或者删除应用程序
2. 原先使用busybox直接构建rootfs，被移动到busybox分支
3. buildroot默认开启以下库
1. python3
* 默认开启以下库
1. PERIPHERY
2. PILLOW（暂时无法加载字体）
3. SERIAL
4. SMBUS
5. SPIDEV
2. ssh
1. 默认开机自启
2. 账号为root
3. 密码为luckfox
3. samba
1. 默认开机自启
2. 账号为root
3. 密码为luckfox
4. adb
1. 默认开机自启
## V1.0 更新日志
* 初次上传，默认系统为busybox