# Phytium-Standalone-SDK
**v1.4.0** [ReleaseNote](./doc/ChangeLog.md)
## 1. 项目概要
### 1.1 仓库介绍
本项目代码仓库整体共分为两个分支：
master 分支：开发分支，用于保存最新的协作开发代码以及bug修复后的代码。其只要求保障新功能基本正确并且能够满足基本的使用需求，并没有经过系统性和复杂条件下的测试。
release 分支：发布分支，包含核心启动代码、芯片外设驱动、用户使用例程和构建的脚本工具。用于保存经过系统性测试的代码并对外发布版本，默认下载此分支的代码。
### 1.2 基本介绍
本项目发布了 Phytium 系列 CPU 的 嵌入式软件开发工具包，包括板级支持包、第三方开源中间件、交叉编译构建工具、及其 Baremetal 参考例程，在支持多平台裸机应用开发的基础上，能够为多种RTOS提供外设驱动和配置构建工具。
### 1.3 系统架构
本项目的整体设计如下所示，自下而上可以分为平台层、组件层、框架层和应用层。
- 平台层（Platform）在整个软件框架中位于最底层，提供了基本数据结构类型定义、驱动参数标定、硬件平台耦合的寄存器自检、板级启动、CPU 内存虚拟等功能
- 组件层（Component）在整个软件框架中位于中间位置，向下依赖于平台层提供的参数配置与内存方案，向上提供应用开发与模块测试的支持
- 接口构建层（Framework）为开发主机提供了开发环境，支持SDK安装，应用工程配置和二进制文件构建及烧录等工具。
- 应用层（Application）提供了应用开发模板和例程，帮助开发者迅速熟悉SDK的使用，进行不同类型的应用程序开发
### 1.4 源代码结构
```
.
├── standalone.kconfig --> 配置定义
├── LICENSE --> 版权声明
├── README.md --> 使用说明
├── arch
│ └── armv8 --> 架构相关
├── board
│ ├── e2000d_demo
│ ├── e2000q_demo
│ ├── d2000_test
│ ├── ft2004_dsk
│ ├── firefly
│ └── user --> 板级IO复用,初始化和用户定义相关
├── common
│ ├── fprintf.c
│ ├── fprintf.h
│ ├── fsleep.c
│ └── fsleep.h --> 通用方法
├── doc
│ ├── ChangeLog.md --> 修改记录
│ └── reference --> 接口说明文档
├── drivers
│ ├── can
│ ├── dma
│ ├── ...
│ └── watchdog --> 外设驱动
├── example --> 裸机例程
├── lib
│ ├── Kconfiglib
│ └── libc --> 依赖库
├── scripts
├── soc
│ ├── d2000
│ ├── e2000
│ ├── phytiumpi
│ └── ft2004 --> soc平台相关
├── third-party
│ └── letter-shell-3.1 --> 第三方库
├── tools
├── install.py --> 安装脚本
└── requirements.txt --> python环境依赖组件
```
---
## 2. 快速入门
- 目前支持在Windows和Linux上使用SDK，支持在x86_64和ARM AARCH64设备上完成交叉编译
- 参考[Windows10 WSL快速入门](./doc/reference/usr/install_windos_wsl.md),[Windows10 快速入门](./doc/reference/usr/install_windows.md),[Linux aarch64 快速入门](./doc/reference/usr/install_linux_aarch64.md), [Linux x86_64 快速入门](./doc/reference/usr/install_linux_x86_64.md), [PhyStudio用户手册快速入门](./doc/reference/ide/ide.md)
- 参考[使用说明](./doc/reference/usr/usage.md), 新建Phytium Standalone SDK的应用工程，与开发板建立连接
- 参考[例程](./example)，开始使用SDK
- 参考[板卡](./doc/reference/usr/how_to_add_board.md)，添加自定义板卡
- 参考[体系架构](./doc/reference/usr/how_to_set_architecture.md)，配置工程体系架构
- 参考[编译选项](./doc/reference/usr/how_to_build_project.md)，配置工程编译选项
- 参考[飞腾派](./doc/reference/usr/use_in_phytium_pi.md), 在飞腾派中使用SDK进行开发，参考[飞腾派镜像制作](./doc/reference/usr/partition_in_phytium_pi.md)，制作用于裸机开发的飞腾派镜像
---
## 3. 硬件参考
### 3.1 FT2000-4
FT-2000/4 是一款面向桌面应用的高性能通用 4 核处理器。每 2 个核构成 1 个处理器核簇（Cluster），并共享 L2 Cache。主要技术特征如下：
- 兼容 ARM v8 64 位指令系统，兼容 32 位指令
- 支持单精度、双精度浮点运算指令
- 支持 ASIMD 处理指令
- 集成 2 个 DDR4 通道，可对 DDR 存储数据进行实时加密
- 集成 34 Lane PCIE3.0 接口：2 个 X16（每个可拆分成 2 个 X8），2 个 X1
- 集成 2 个 GMAC，RGMII 接口，支持 10/100/1000 自适应
- 集成 1 个 SD 卡控制器，兼容 SD 2.0 规范
- 集成 加密计算单元
- 集成 4 个 UART，32 个 GPIO，4 个 I2C，1 个 QSPI，2 个通 用 SPI，2 个 WDT，16 个外部中断（和 GPIO 共用 IO）
- 集成温度传感器
### 3.2 D2000
D2000 是一款面向桌面应用的高性能通用 8 核处理器。每 2 个核构成 1 个处理器核簇（Cluster），并共享 L2 Cache。存储系统包含 Cache 子系统和 DDR，I/O 系统包含 PCIe、高速 IO 子系统、千兆位以太网 GMAC 和低速 IO 子系统，主要技术特征如下，
- 兼容 ARM v8 64 位指令系统，兼容 32 位指令
- 支持单精度、双精度浮点运算指令
- 支持 ASIMD 处理指令
- 集成 2 个 DDR 通道，支持 DDR4 和 LPDDR4，可对 DDR 存储数据进行实时加密
- 集成 34 Lane PCIE3.0 接口：2 个 X16（每个可拆分成 2 个 X8），2 个 X1
- 集成 2 个 GMAC，RGMII 接口，支持 10/100/1000 自适应
- 集成 1 个 SD 卡控制器，兼容 SD 2.0 规范
- 集成 1 个 HDAudio，支持音频输出，可同时支持最多 4 个 Codec
- 集成 SM2、SM3、SM4、SM9 模块
- 集成 4 个 UART，32 个 GPIO，4 个 I2C，1 个 QSPI，2 个通用 SPI，2 个 WDT，16 个外部中断（和 GPIO 共用 IO）
- 集成 2 个温度传感器
### 3.3 E2000Q
- E2000Q 集成2个FTC664核和2个FTC310核。主要技术特征如下：
- 兼容ARM v8 64 位指令系统，兼容32 位指令
- 集成 1 路 16 通道 General DMA 和 1 路 8 通道 Device DMA
- 支持单精度、双精度浮点运算指令
- 两个 FTC664 核各包含 1MB 私有 L2 Cache,由两个 FTC310 核组成的Cluster 内含 256KB 共享的 L2 Cache
- 集成1个DDR4 通道
- 集成6Lane PCIE3.0 接口（X4+2*X1 、X2+4*X2、6*X1）
- 集成4个1000M以太网控制器，支持2路SGMII接口和2路SGMII/RGMII接口
- 集成3路USB2.0(OTG)和2路USB3.0(兼容 2.0)
- 集成2路SATA3.0模块
- 2路 DisplayPort1.4 接口
- 集成常用低速接口：WDT、QSPI、PWM、Nand、SD/SDIO/eMMC 、SPI_M、UART、I2C、I2S、MIO、CAN-FD、GPIO、LocalBus、Timer
### 3.4 E2000D
- E2000D 集成 2 个 FTC310 核。主要技术特征如下：
- 兼容ARM v8 64 位指令系统，兼容32 位指令
- 集成 1 路 16 通道 General DMA 和 1 路 8 通道 Device DMA
- 支持单精度、双精度浮点运算指令
- L2 Cache 有256KB
- 集成1个DDR4 通道
- 集成4 Lane PCIE3.0 接口（4X1）
- 集成4个1000M以太网控制器，支持 2 路 SGMII 接口和 2 路 SGMII/RGMII 接口
- 集成3路USB2.0(OTG)和2路USB3.0(兼容 2.0)
- 集成2路SATA3.0模块
- 2路 DisplayPort1.4 接口
- 集成常用低速接口：WDT，QSPI，PWM，Nand，SD/SDIO/eMMC ，SPI_M，UART，I2C，MIO，CAN-FD，GPIO，LocalBus，Timer
### 3.5 E2000S
- E2000S 集成 1 个 FTC310 核，单核结构。主要技术特征如下：
- 兼容ARM v8 64 位指令系统，兼容32 位指令
- 集成 1 路 16 通道 General DMA 和 1 路 8 通道 Device DMA
- 支持单精度、双精度浮点运算指令
- L2 Cache 有256KB
- 集成1个DDR4 通道
- 集成2 Lane PCIE3.0 接口（2X1）
- 集成3个1000M以太网控制器，支持1路SGMII接口和2路RGMII/RMII接口
- 集成1路USB2.0(Device)和2路USB2.0(OTG)
- 2路 DisplayPort1.4 接口
- 集成常用低速接口：WDT、DMAC、PWM、QSPI、SD/SDIO/eMMC、SPI Master、UART、I2C、MIO、I3C、PMBUS、GPIO、SGPIO、One-Wire、Timer、One-Wire
### 3.6 PHYTIUMPI
- PHYTIUMPI 集成2个FTC664核和2个FTC310核。主要技术特征如下：
- FTC664 核主频可达 1.8GHz，FTC310 核主频可达 1.5GHz
- 兼容ARM v8 64 位指令系统，兼容32 位指令
- 集成 1 路 16 通道 General DMA 和 1 路 8 通道 Device DMA
- 支持单精度、双精度浮点运算指令
- 集成1个DDR4 通道
- 集成1路 Mini-PCIe，支持 AI、5G\4G 等模组
- 集成2个1000M以太网控制器，支持2路SGMII接口和2路SGMII/RGMII接口
- 集成3路USB2.0(OTG)和2路USB3.0(兼容 2.0)
- 1路 HDMI 接口
- 集成常用低速接口：WDT、QSPI、PWM、SD/SDIO/eMMC 、SPI_M、UART、I2C、I2S、MIO、CAN-FD、GPIO、LocalBus、Timer
## 4 例程支持情况
| Peripherals | Platform Supported | Platform Developing | Component |
| ------------------------------- | ----------------------------------------------------- | ------------------- | -------------------- |
| Generic Interrupt Controller v3 | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | gicv3 |
| Generic Timer | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | generic_timer |
| UART (PrimeCell PL011) | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | serial |
| ADC | E2000 | | adc |
| CAN | FT2000/4`
`E2000 `
`D2000 | | can/can |
| CANFD | E2000 | | can/canfd |
| DDMA | E2000`
`PHYTIUMPI | | seria/ddma |
| GDMA | E2000`
`PHYTIUMPI | | dma/gdma |
| IOPAD | E2000`
`PHYTIUMPI | | iopad |
| IPC | E2000`
`PHYTIUMPI | | ipc/semaphore |
| I2C | E2000`
`PHYTIUMPI | FT2004/D2000 | i2c |
| PIN | E2000`
`PHYTIUMPI | FT2004/D2000 | pin |
| QSPI (Nor Flash) | FT2000/4`
`E2000 `
`D2000 | | qspi |
| SPI | FT2000/4`
`E2000 `
`D2000 | | spi |
| TIMER & TACHO | E2000`
`PHYTIUMPI | | timer&tacho |
| MIO | E2000`
`PHYTIUMPI | | i2c & serial |
| SDMMC | FT2000/4`
`D2000 | | sd |
| SDIO | E2000`
`PHYTIUMPI | | sd |
| PCIE RC | E2000/FT2004/D2000 | | pcie rc |
| SATA | E2000 | | sata/sata_controller |
| SATA PCIE | FT2000/4`
`E2000 `
`D2000 | | sata/sata_pcie |
| PWM | E2000`
`PHYTIUMPI | | pwm |
| WDT | FT2000/4`
`D2000 `
`E2000 `
`PHYTIUMPI | | wdt |
| FJTAG | E2000 | | jtag_debugging |
| USB2(Device) | E2000 | | usb/psub2_device |
| Media | Platform Supported | Platform Developing | Component |
| ----- | ---------------------- | ------------------- | -------------- |
| DP | E2000`
`PHYTIUMPI | | media_test |
| LVGL | E2000`
`PHYTIUMPI | | lvgl_demo_test |
| Network | Platform Supported | Platform Developing | Component |
| ------- | ----------------------------------------------------- | ------------------- | ------------ |
| LWIP | FT2000/4`
`D2000 `
`E2000 `
`PHYTIUMPI | | lwip_startup |
| RAW | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | raw_api |
| Storage | Platform Supported | Platform Developing | Component |
| ----------- | ----------------------------------------------------- | ------------------- | ---------------- |
| FATFS | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | fatfs |
| MEMORY_POOL | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | memory_pool_test |
| SFUD | FT2000/4`
`E2000 `
`PHYTIUMPI | D2000 | sfud |
| System | Platform Supported | Platform Developing | Component |
| ---------------- | ----------------------------------------------------- | ------------------- | ---------------------- |
| LIBMETAL | E2000`
`D2000 `
`PHYTIUMPI `
`FT2000/4 | | amp/libmetal_test |
| AMP | E2000`
`PHYTIUMPI `
`FT2000/4 `
`D2000 | | amp/openamp |
| PSCI | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | arch/armv8/psci |
| SCMI | E2000 | | scmi_mhu |
| ATOMIC | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | atomic |
| C++ | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | cxx/cryptopp&get-start |
| SHELL | FT2000/4`
`E2000 `
`D2000 | PHYTIUMPI | letter_shell_test |
| NESTED INTERRUPT | FT2000/4`
`E2000 `
`D2000 `
`PHYTIUMPI | | nested_interrupt |
---
## 5. API指南
### 5.1 DRIVERS
#### 5.1.1 [FI2C](./doc/reference/driver/fi2c.md)
#### 5.1.2 [FPL011](./doc/reference/driver/fpl011.md)
#### 5.1.3 [FRTC](./doc/reference/driver/frtc.md)
#### 5.1.4 [FWDT](./doc/reference/driver/fwdt.md)
#### 5.1.5 [FSPIM](./doc/reference/driver/fspim.md)
#### 5.1.6 [FQSPI](./doc/reference/driver/fqspi.md)
#### 5.1.7 [FSDMMC](./doc/reference/driver/fsdmmc.md)
#### 5.1.8 [FSATA](./doc/reference/driver/fsata.md)
#### 5.1.9 [FPCIE ECAM](./doc/reference/driver/fpcie_ecam.md)
#### 5.1.10 [FUSB](./doc/reference/driver/fusb.md)
#### 5.1.11 [FGPIO](./doc/reference/driver/fgpio.md)
#### 5.1.12 [FGIC](./doc/reference/driver/fgic.md)
#### 5.1.13 [FDDMA](./doc/reference/driver/fddma.md)
#### 5.1.14 [FCAN](./doc/reference/driver/fcan.md)
#### 5.1.15 [FADC](./doc/reference/driver/fadc.md)
#### 5.1.16 [FPWM](./doc/reference/driver/fpwm.md)
#### 5.1.17 [FSDIF](./doc/reference/driver/fsdif.md)
#### 5.1.18 [FMEDIA](doc/reference/driver/fmedia.md)
### 5.2 MEMORY
#### 5.2.1 [FMEMORY_POOL](./doc/reference/sdk/fmemory_pool.md)
### 5.3 CPU
#### 5.3.1 [MMU](./doc/reference/cpu/mmu.md)
#### 5.3.2 [FPINCTRL](./doc/reference/sdk/fpinctrl.md)
#### 5.3.2 [FINTERRUPT](./doc/reference/cpu/finterrupt.md)
#### 5.3.3 [FPSCI](./doc/reference/cpu/psci.md)
---
## 6. 贡献方法
请联系飞腾嵌入式软件部
huanghe@phytium.com.cn
zhugengyu@phytium.com.cn
wangxiaodong1030@phytium.com.cn
liushengming1118@phytium.com.cn
---
## 7. 相关资源
- ARM Architecture Reference Manual
- ARM Cortex-A Series Programmer’s Guide
- Programmer Guide for ARMv8-A
- ARM System Developers Guide Designing and Optimizing System Software
- FT-2000／4 软件编程手册-V1.4
- D2000 软件编程手册-V1.0
- 飞腾腾珑E2000系列处理器软件编程手册V0.8.1
- 飞腾派软件开发手册-V1.0
- Bare-metal programming for ARM —— A hands-on guide
- Using the GNU Compiler Collection
- Using ld, The GNU Linker
- Using as, The GNU Assembler
- Armv8-A memory model guide
---
## 8. 许可协议
Phytium Public License 1.0 (PPL-1.0)