refector project

README.md

@@ -0,0 +1,4 @@
+# R128Module
+
+
+

docs/.docsifytopdfrc.js

@@ -0,0 +1,23 @@
+var pjson = require('./package.json');
+
+module.exports = {
+  contents: [ "_sidebar.md" ], // array of "table of contents" files path
+  pathToPublic: "pdf/R128模组开发文档_" + pjson.version + ".pdf", // path where pdf will stored
+  pdfOptions: {
+    format: 'A4',
+    displayHeaderFooter: true,
+    headerTemplate: `<span></span>`,
+    footerTemplate: `<div style='text-align:center;width: 297mm;font-size: 10px;'><span class='pageNumber'>inspur</span></div>`,
+    margin: {
+      top: '50px',
+      right: '20px',
+      bottom: '40px',
+      left: '20px'
+    },
+    printBackground: true,
+    omitBackground: true,
+    landscape: false,     
+  },
+  removeTemp: true, // remove generated .md and .html or not
+  emulateMedia: "screen", // mediaType, emulating by puppeteer for rendering pdf, 'print' by default (reference: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pageemulatemediamediatype)
+}

docs/.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+pdf/
+package-lock.json
+static/

docs/README.md

@@ -0,0 +1,65 @@
+# 简介
+
+R128是一颗专为“音视频解码”而打造的全新高集成度 SoC，主要应用于智能物联和专用语音交互处理解决方案。
+
+- 单片集成 MCU+RISCV+DSP+CODEC+WIFI/BT+PMU，提供生态配套成熟、完善的用于系统、应用和网络连接开发的高效算力；
+- 集成 8MB/16MB/32MB PSRAM，为音视频解码、大容量存储、扫码以及网络连接提供充裕的高容量、高带宽的内存支持；
+- 拥有丰富的音频接口 IIS/PCM、OWA、DMIC、LINEOUT、MICIN 以及通用通讯接口 IIC、UART、SDIO、 SPI、ISO7816卡接口；同时支持 U 盘、SD卡、IR-TX/RX；
+- 内置 LDO、GPADC、LEDC，简化系统方案设计，降低 BOM成本。
+
+>  文档目前正在施工，敬请期待
+
+## 芯片应用场景
+
+![image-20220601152708483](assets/post/README/R128APP1.jpg)
+
+## 芯片实物图
+
+![R128ZB.png](assets/post/README/1680832460884-r128zb.png)
+
+## 芯片框图
+
+![image-20230319113235278](assets/post/README/image-20230319113235278-1691039559823-1.png)
+
+
+## 关于本文档
+
+本文档为 R128 开放文档，包括芯片简述，环境搭建，快速入门，SDK手册等内容，方便快速掌握 R128 开发。
+
+在线文档地址：https://yuzukihd.top/R128Module/
+
+PDF文档下载：https://github.com/YuzukiHD/R128Module/releases
+
+请注意，PDF文档并不是最新的，网页文档滚动更新可能不会及时同步PDF
+
+| 文档   | 版本  |
+| ------ | ----- |
+| 网页端 | 0.5.9 |
+| PDF    | 0.5.9 |
+
+## 文档约定
+
+### 地址与数据描述方法约定
+
+本文档在描述地址、数据时遵循如下约定：
+
+| 符号 | 例子                | 说明                                                         |
+| ---- | ------------------- | ------------------------------------------------------------ |
+| 0x   | 0x0200，0x79        | 地址或数据以16 进制表示。                                    |
+| 0b   | 0b010，0b00 000 111 | 数据采用二进制表示(寄存器描述除外)。                         |
+| X    | 00X，XX1            | 数据描述中，X 代表0 或1。<br />例如：00X 代表000 或 001；XX1 代表001，011，101 或111。 |
+
+### 数值单位约定
+
+本文档在描述数据容量（如NAND 容量）时，单位词头代表的是1024 的倍数；描述频率、数据
+速率等时则代表的是1000 的倍数。具体如下：
+
+| 类型                     | 符号 | 对应数值      |
+| ------------------------ | ---- | ------------- |
+| 数据容量（如 NAND 容量） | 1 K  | 1024          |
+|                          | 1 M  | 1 048 576     |
+|                          | 1 G  | 1 073 741 824 |
+| 频率，数据速率等         | 1 K  | 1000          |
+|                          | 1 M  | 1 000 000     |
+|                          | 1 G  | 1 000 000 000 |
+

docs/_sidebar.md

@@ -0,0 +1,111 @@
+- [主页](README.md)
+
+- 概述
+  - [芯片简介](r128/about_chip.md)
+  - [芯片参数](r128/chip_info.md)
+  - [手册与资料](r128/get_chip_ds.md)
+  - [测试固件下载](r128/test_img.md)
+
+- R128 硬件使用说明
+  - [R128 模块](devkit/r128_module.md)
+  - [R128 DevKit 开发板](devkit/r128_devkit.md)
+  - [R128 EVT 开发套件](devkit/r128_evt.md)
+
+- 获取 SDK
+  - [开发环境搭建](r128/prepare_dev_env.md)
+  - [获取SDK](r128/get_sdk.md)
+
+- SDK 入门
+  - [SDK 入门](r128/sdk_intro.md)
+  - [刷写固件](r128/flash_img.md)
+  - [RTOS 使用说明](r128/rtos_manual.md)
+  - [SDK架构](r128/sdk_tree.md)
+  - [编写HelloWorld](r128/hello_world.md)
+
+- 软件配置
+  - [配置引脚复用](sdk_base/gpio_mux.md)
+  - [RTOS 软件包配置](sdk_base/rtos_package.md)
+  - [启动与资源划分](sdk_base/boot_up.md)
+
+- 外设模块配置
+  - [USB 外设功能配置](peripheral/usb.md)
+  - [PMU 电源管理](peripheral/pmu.md)
+  - [ADC 按键配置方法](peripheral/adc_key.md)
+
+- 应用开发案例
+  - [点亮一颗 LED 灯](demo/led_and_chihui.md)
+  - [按键输入](demo/keypress.md)
+  - [按键控制蜂鸣器](demo/keypressbuzz.md)
+  - [ADC驱动烟雾传感器](demo/adc_mq2.md)
+  - [中断方式驱动旋转编码器](demo/int_encoder.md)
+  - [驱动 WS2812 流水灯](demo/ws2812.md)
+  - [获取真随机数](demo/trand.md)
+  - [驱动 OLED 屏](demo/oled.md)
+  - [SPI 驱动 TFT LCD 屏](demo/spilcd.md)
+  - [DBI 驱动 TFT LCD 屏](demo/dbilcd.md)
+  - [LVGL 与 SPI TFT GUI](demo/lvgl_spi.md)
+  - [SPI驱动ST7789V2.4寸LCD](demo/add_spilcd.md)
+  - [SPI驱动ST7789V1.47寸LCD](demo/add_spilcd_147.md)
+  - [SPI驱动ST7789V1.3寸LCD](demo/add_spilcd_13.md)
+  - [DBI驱动ST7789V1.3寸LCD](demo/add_dbilcd_13.md)
+  - [SPI 与 DBI 性能对比](demo/spi_vs_dbi.md)
+
+- 基础组件开发指南
+  - [RTOS 存储简介](sdk_base/rtos_storage.md)
+  - [RTOS 多媒体解码](sdk_base/multimedia_dec.md)
+  - [RTOS 多媒体编码](sdk_base/multimedia_enc.md)
+  - [音频框架](sdk_base/audio.md)
+  - [显示与屏幕驱动](sdk_base/disp.md)
+  - [SPI LCD 显示驱动](sdk_base/spilcd.md)
+  - [GUI 图形系统](sdk_base/graphic.md)
+  - [图像采集](sdk_base/video_capture.md)
+  - [RTOS 安全](sdk_base/sos.md)
+  - [RTOS 蓝牙](sdk_base/bluetooth.md)
+  - [Wi-Fi](sdk_base/wifi.md)
+  - [异构多核通信](sdk_base/amp.md)
+
+- SDK HAL 模块开发指南
+  - [Crypto Engine](sdk_module/ce.md)
+  - [CSI](sdk_module/csi.md)
+  - [CCU](sdk_module/ccu.md)
+  - [DMA Controller](sdk_module/dmac.md)
+  - [Flash Controller](sdk_module/flash.md)
+  - [GPADC](sdk_module/gpadc.md)
+  - [GPIO](sdk_module/gpio.md)
+  - [G2D](sdk_module/g2d.md)
+  - [HWSPINLOCK](sdk_module/spin.md)
+  - [IR](sdk_module/ir.md)
+  - [PMU](sdk_module/pmu.md)
+  - [LEDC (RGB LED)](sdk_module/ledc.md)
+  - [UART](sdk_module/uart.md)
+  - [LPUART](sdk_module/lpuart.md)
+  - [SPI](sdk_module/spi.md)
+  - [TWI](sdk_module/twi.md)
+  - [SPI DBI](sdk_module/dbi.md)
+  - [TRNG](sdk_module/trng.md)
+  - [MBUS](sdk_module/mbus.md)
+  - [MMC](sdk_module/mmc.md)
+  - [MSGBOX](sdk_module/msgbox.md)
+  - [PWM](sdk_module/pwm.md)
+  - [RTC](sdk_module/rtc.md)
+  - [SID](sdk_module/sid.md)
+  - [Smart Card](sdk_module/smartcard.md)
+  - [USB](sdk_module/usb.md)
+
+- DSP 
+  - [DSP 简介](dsp/dsp_intro.md)
+  - [DSP开发工具安装](dsp/dsp_sdk.md)
+
+- 调试指南
+  - [RTOS调试指南](debug/debug_info.md)
+  - [使用 VSCode 调试代码](debug/vsc_debug_info.md)
+  - [内存泄漏](debug/memleak.md)
+
+- 硬件设计
+  - [芯片硬件设计指南](hardware/hardware_design.md)
+  - [硬件设计参考](hardware/ref_hardware_design.md)
+  - [芯片物料支持列表](hardware/chip_support_list.md)
+
+- 其他
+  - [FAQ](others/faq.md)
+  - [术语表](others/term.md)

docs/assets/css/button-custom.css

@@ -0,0 +1,92 @@
+@import url("https://fonts.googleapis.com/css?family=Mukta:700");
+* {
+  box-sizing: border-box;
+}
+*::before, *::after {
+  box-sizing: border-box;
+}
+
+.btn-learn {
+  position: relative;
+  display: inline-block;
+  cursor: pointer;
+  outline: none;
+  border: 0;
+  vertical-align: middle;
+  text-decoration: none;
+  background: transparent;
+  padding: 0;
+  font-size: inherit;
+  font-family: inherit;
+}
+.btn-learn.learn-more {
+  width: 11rem;
+  height: auto;
+}
+.btn-learn.learn-more .circle {
+  -webkit-transition: all 0.45s cubic-bezier(0.65, 0, 0.076, 1);
+  transition: all 0.45s cubic-bezier(0.65, 0, 0.076, 1);
+  position: relative;
+  display: block;
+  margin: 0;
+  width: 3rem;
+  height: 3rem;
+  background: var(--link-color);
+  border-radius: 1.625rem;
+}
+.btn-learn.learn-more .circle .icon {
+  -webkit-transition: all 0.45s cubic-bezier(0.65, 0, 0.076, 1);
+  transition: all 0.45s cubic-bezier(0.65, 0, 0.076, 1);
+  position: absolute;
+  top: 0;
+  bottom: 0;
+  margin: auto;
+  background: #fff;
+}
+.btn-learn.learn-more .circle .icon.arrow {
+  -webkit-transition: all 0.45s cubic-bezier(0.65, 0, 0.076, 1);
+  transition: all 0.45s cubic-bezier(0.65, 0, 0.076, 1);
+  left: 0.625rem;
+  width: 1.125rem;
+  height: 0.125rem;
+  background: none;
+}
+.btn-learn.learn-more .circle .icon.arrow::before {
+  position: absolute;
+  content: '';
+  top: -0.25rem;
+  right: 0.0625rem;
+  width: 0.625rem;
+  height: 0.625rem;
+  border-top: 0.125rem solid #fff;
+  border-right: 0.125rem solid #fff;
+  -webkit-transform: rotate(45deg);
+          transform: rotate(45deg);
+}
+.btn-learn.learn-more .button-text {
+  -webkit-transition: all 0.45s cubic-bezier(0.65, 0, 0.076, 1);
+  transition: all 0.45s cubic-bezier(0.65, 0, 0.076, 1);
+  position: absolute;
+  font-family: 'Mukta', sans-serif;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  padding: 0.75rem 0;
+  margin: 0 0 0 1.85rem;
+  font-weight: 700;
+  line-height: 1.6;
+  text-align: center;
+  /* text-transform: uppercase; */
+}
+.btn-learn:hover .circle {
+  width: 100%;
+}
+.btn-learn:hover .circle .icon.arrow {
+  background: #fff;
+  -webkit-transform: translate(1rem, 0);
+          transform: translate(1rem, 0);
+}
+.btn-learn:hover .button-text {
+  color: #fff;
+}