diff --git a/docs/development_guide/build/doctrees/Linux_quick_start_ubuntu.doctree b/docs/development_guide/build/doctrees/Linux_quick_start_ubuntu.doctree index d86d49e1..41825734 100644 Binary files a/docs/development_guide/build/doctrees/Linux_quick_start_ubuntu.doctree and b/docs/development_guide/build/doctrees/Linux_quick_start_ubuntu.doctree differ diff --git a/docs/development_guide/build/doctrees/Windows_quick_start_cdk.doctree b/docs/development_guide/build/doctrees/Windows_quick_start_cdk.doctree index d9dfcf5e..75fa287f 100644 Binary files a/docs/development_guide/build/doctrees/Windows_quick_start_cdk.doctree and b/docs/development_guide/build/doctrees/Windows_quick_start_cdk.doctree differ diff --git a/docs/development_guide/build/doctrees/Windows_quick_start_eclipse.doctree b/docs/development_guide/build/doctrees/Windows_quick_start_eclipse.doctree index e1ea90fc..9f9e9aef 100644 Binary files a/docs/development_guide/build/doctrees/Windows_quick_start_eclipse.doctree and b/docs/development_guide/build/doctrees/Windows_quick_start_eclipse.doctree differ diff --git a/docs/development_guide/build/doctrees/api_guide.doctree b/docs/development_guide/build/doctrees/api_guide.doctree index 5e19e84c..ec7afbae 100644 Binary files a/docs/development_guide/build/doctrees/api_guide.doctree and b/docs/development_guide/build/doctrees/api_guide.doctree differ diff --git a/docs/development_guide/build/doctrees/blink_demo_introduce.doctree b/docs/development_guide/build/doctrees/blink_demo_introduce.doctree index 77e84bd9..a106140a 100644 Binary files a/docs/development_guide/build/doctrees/blink_demo_introduce.doctree and b/docs/development_guide/build/doctrees/blink_demo_introduce.doctree differ diff --git a/docs/development_guide/build/doctrees/breath_pwm_demo_introduce.doctree b/docs/development_guide/build/doctrees/breath_pwm_demo_introduce.doctree index affc5288..c38711ee 100644 Binary files a/docs/development_guide/build/doctrees/breath_pwm_demo_introduce.doctree and b/docs/development_guide/build/doctrees/breath_pwm_demo_introduce.doctree differ diff --git a/docs/development_guide/build/doctrees/connecting_hardware.doctree b/docs/development_guide/build/doctrees/connecting_hardware.doctree index 2a759b95..73ffc705 100644 Binary files a/docs/development_guide/build/doctrees/connecting_hardware.doctree and b/docs/development_guide/build/doctrees/connecting_hardware.doctree differ diff --git a/docs/development_guide/build/doctrees/environment.pickle b/docs/development_guide/build/doctrees/environment.pickle index e696055c..2e5745f7 100644 Binary files a/docs/development_guide/build/doctrees/environment.pickle and b/docs/development_guide/build/doctrees/environment.pickle differ diff --git a/docs/development_guide/build/doctrees/get_started.doctree b/docs/development_guide/build/doctrees/get_started.doctree index 44cda4cd..f5316f52 100644 Binary files a/docs/development_guide/build/doctrees/get_started.doctree and b/docs/development_guide/build/doctrees/get_started.doctree differ diff --git a/docs/development_guide/build/doctrees/index.doctree b/docs/development_guide/build/doctrees/index.doctree index ad154ebe..508bd62b 100644 Binary files a/docs/development_guide/build/doctrees/index.doctree and b/docs/development_guide/build/doctrees/index.doctree differ diff --git a/docs/development_guide/build/doctrees/uart_loopback_demo_introduce.doctree b/docs/development_guide/build/doctrees/uart_loopback_demo_introduce.doctree index 8080a80f..a1927ac7 100644 Binary files a/docs/development_guide/build/doctrees/uart_loopback_demo_introduce.doctree and b/docs/development_guide/build/doctrees/uart_loopback_demo_introduce.doctree differ diff --git a/docs/development_guide/build/html/Linux_quick_start_ubuntu.html b/docs/development_guide/build/html/Linux_quick_start_ubuntu.html index 5e98c5a0..f885d5f4 100644 --- a/docs/development_guide/build/html/Linux_quick_start_ubuntu.html +++ b/docs/development_guide/build/html/Linux_quick_start_ubuntu.html @@ -215,7 +215,7 @@ $ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz $ mkdir -p riscv64-elf-20210120 $ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120 -$ sudo cp ~/riscv64-elf-20210120 /usr/bin +$ sudo cp -rf ~/riscv64-elf-20210120 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\"" >> ~/.bashrc $ source ~/.bashrc @@ -235,7 +235,7 @@ $ sudo apt install make $ cd ~ $ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz $ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz -$ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin +$ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\"" >> ~/.bashrc $ source ~/.bashrc diff --git a/docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt b/docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt index 8f7f344e..b10e8a9d 100644 --- a/docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt +++ b/docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt @@ -23,7 +23,7 @@ Linux 环境开发指南 $ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz $ mkdir -p riscv64-elf-20210120 $ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120 - $ sudo cp ~/riscv64-elf-20210120 /usr/bin + $ sudo cp -rf ~/riscv64-elf-20210120 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\"" >> ~/.bashrc $ source ~/.bashrc @@ -39,7 +39,7 @@ Linux 环境开发指南 $ cd ~ $ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz $ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz - $ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin + $ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64 /usr/bin $ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\"" >> ~/.bashrc $ source ~/.bashrc diff --git a/docs/development_guide/build/html/_sources/api_guide.rst.txt b/docs/development_guide/build/html/_sources/api_guide.rst.txt index 8fbae716..6e78c854 100644 --- a/docs/development_guide/build/html/_sources/api_guide.rst.txt +++ b/docs/development_guide/build/html/_sources/api_guide.rst.txt @@ -207,13 +207,21 @@ API 分层模型 .. code-block:: C - #define DEVICE_CTRL_SET_INT 0x01 /* 设置中断 */ - #define DEVICE_CTRL_CLR_INT 0x02 /* 清中断 */ - #define DEVICE_CTRL_GET_INT 0x03 /* 获取中断状态 */ - #define DEVICE_CTRL_RESUME 0x04 /* 恢复设备 */ - #define DEVICE_CTRL_SUSPEND 0x05 /* 挂起设备 */ - #define DEVICE_CTRL_CONFIG 0x06 /* 配置设备 */ - #define DEVICE_CTRL_GET_CONFIG 0x07 /* 获取设备配置 */ + #define DEVICE_CTRL_SET_INT 0x01 /* set interrupt */ + #define DEVICE_CTRL_CLR_INT 0x02 /* clear interrupt */ + #define DEVICE_CTRL_GET_INT 0x03 /* get interrupt status*/ + #define DEVICE_CTRL_RESUME 0x04 /* resume device */ + #define DEVICE_CTRL_SUSPEND 0x05 /* suspend device */ + #define DEVICE_CTRL_CONFIG 0x06 /* config device */ + #define DEVICE_CTRL_GET_CONFIG 0x07 /* get device configuration */ + #define DEVICE_CTRL_ATTACH_TX_DMA 0x08 + #define DEVICE_CTRL_ATTACH_RX_DMA 0x09 + #define DEVICE_CTRL_TX_DMA_SUSPEND 0x0a + #define DEVICE_CTRL_RX_DMA_SUSPEND 0x0b + #define DEVICE_CTRL_TX_DMA_RESUME 0x0c + #define DEVICE_CTRL_RX_DMA_RESUME 0x0d + #define DEVICE_CTRL_RESVD1 0x0E + #define DEVICE_CTRL_RESVD2 0x0F **device_write** ^^^^^^^^^^^^^^^^ @@ -371,7 +379,7 @@ GPIO 全称 General Purpose Input Output（通用输入 / 输出），博流系 bl mcu sdk 的引脚配置方式分为两种。 -- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚和工功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。 +- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚的功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。 - 通过标准的 GPIO 设备接口配置引脚，缺点是只能配置普通的输入输出和中断功能，复用功能建议还是使用 table 进行配置。 GPIO 设备接口 @@ -514,7 +522,7 @@ UART 设备结构体定义 - parity 校验位 - fifo_threshold fifo 阈值,不同 mcu 最大值不同 - tx_dma 附加的发送 dma 句柄 -- rx_dma 附加的发送 dma 句柄 +- rx_dma 附加的接收 dma 句柄 databits 提供以下类型 @@ -679,8 +687,6 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。 #define DEVICE_CTRL_UART_GET_TX_FIFO 0x10 #define DEVICE_CTRL_UART_GET_RX_FIFO 0x11 - #define DEVICE_CTRL_UART_ATTACH_TX_DMA 0x12 - #define DEVICE_CTRL_UART_ATTACH_RX_DMA 0x13 ``args`` 根据不同的 ``cmd`` 传入不同，具体如下： @@ -693,9 +699,9 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。 +---------------------------------------+--------------------------------------+ | DEVICE_CTRL_CONFIG | uart_param_cfg_t | +---------------------------------------+--------------------------------------+ -| DEVICE_CTRL_UART_ATTACH_TX_DMA | dma句柄 | +| DEVICE_CTRL_ATTACH_TX_DMA | dma句柄 | +---------------------------------------+--------------------------------------+ -| DEVICE_CTRL_UART_ATTACH_RX_DMA | dma句柄 | +| DEVICE_CTRL_ATTACH_RX_DMA | dma句柄 | +---------------------------------------+--------------------------------------+ | DEVICE_CTRL_UART_GET_TX_FIFO | 缓存变量 | +---------------------------------------+--------------------------------------+ diff --git a/docs/development_guide/build/html/api_guide.html b/docs/development_guide/build/html/api_guide.html index 3f0a7e3b..e156e856 100644 --- a/docs/development_guide/build/html/api_guide.html +++ b/docs/development_guide/build/html/api_guide.html @@ -406,13 +406,21 @@

  • return 不同的控制命令返回的意义不同。

    • cmd 提供了以下标准命令，除此之外，不同外设还具有自己的命令

    -
    #define DEVICE_CTRL_SET_INT     0x01    /* 设置中断 */
-#define DEVICE_CTRL_CLR_INT     0x02    /* 清中断 */
-#define DEVICE_CTRL_GET_INT     0x03    /* 获取中断状态 */
-#define DEVICE_CTRL_RESUME      0x04    /* 恢复设备 */
-#define DEVICE_CTRL_SUSPEND     0x05    /* 挂起设备 */
-#define DEVICE_CTRL_CONFIG      0x06    /* 配置设备 */
-#define DEVICE_CTRL_GET_CONFIG  0x07    /* 获取设备配置 */
+
    #define DEVICE_CTRL_SET_INT             0x01    /* set interrupt */
+#define DEVICE_CTRL_CLR_INT             0x02    /* clear interrupt */
+#define DEVICE_CTRL_GET_INT             0x03    /* get interrupt status*/
+#define DEVICE_CTRL_RESUME              0x04    /* resume device */
+#define DEVICE_CTRL_SUSPEND             0x05    /* suspend device */
+#define DEVICE_CTRL_CONFIG              0x06    /* config device */
+#define DEVICE_CTRL_GET_CONFIG          0x07    /* get device configuration */
+#define DEVICE_CTRL_ATTACH_TX_DMA       0x08
+#define DEVICE_CTRL_ATTACH_RX_DMA       0x09
+#define DEVICE_CTRL_TX_DMA_SUSPEND      0x0a
+#define DEVICE_CTRL_RX_DMA_SUSPEND      0x0b
+#define DEVICE_CTRL_TX_DMA_RESUME       0x0c
+#define DEVICE_CTRL_RX_DMA_RESUME       0x0d
+#define DEVICE_CTRL_RESVD1              0x0E
+#define DEVICE_CTRL_RESVD2              0x0F
    @@ -554,7 +562,7 @@

    bl mcu sdk 的引脚配置方式分为两种。

    @@ -683,7 +691,7 @@

  • parity 校验位

  • fifo_threshold fifo 阈值,不同 mcu 最大值不同

  • tx_dma 附加的发送 dma 句柄

    • -

  • rx_dma 附加的发送 dma 句柄

    • +

  • rx_dma 附加的接收 dma 句柄

    • databits 提供以下类型

    typedef enum
@@ -827,8 +835,6 @@
 
    串口设备除了标准的控制命令，还具有自己特殊的控制命令。
    
 
    #define DEVICE_CTRL_UART_GET_TX_FIFO        0x10
 #define DEVICE_CTRL_UART_GET_RX_FIFO        0x11
-#define DEVICE_CTRL_UART_ATTACH_TX_DMA      0x12
-#define DEVICE_CTRL_UART_ATTACH_RX_DMA      0x13
 
    
 
    
 
    args 根据不同的 cmd 传入不同，具体如下：
    
@@ -852,10 +858,10 @@
 
    DEVICE_CTRL_CONFIG
    
 
    uart_param_cfg_t
    
 
-
    DEVICE_CTRL_UART_ATTACH_TX_DMA
    
+
    DEVICE_CTRL_ATTACH_TX_DMA
    
 
    dma句柄
    
 
-
    DEVICE_CTRL_UART_ATTACH_RX_DMA
    
+
    DEVICE_CTRL_ATTACH_RX_DMA
    
 
    dma句柄
    
 
 
    DEVICE_CTRL_UART_GET_TX_FIFO
    
diff --git a/docs/development_guide/build/html/searchindex.js b/docs/development_guide/build/html/searchindex.js
index 175ae822..f5f7dae3 100644
--- a/docs/development_guide/build/html/searchindex.js
+++ b/docs/development_guide/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["Linux_quick_start_ubuntu","Windows_quick_start_cdk","Windows_quick_start_eclipse","api_guide","blink_demo_introduce","breath_pwm_demo_introduce","connecting_hardware","get_started","index","uart_loopback_demo_introduce"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["Linux_quick_start_ubuntu.rst","Windows_quick_start_cdk.rst","Windows_quick_start_eclipse.rst","api_guide.rst","blink_demo_introduce.rst","breath_pwm_demo_introduce.rst","connecting_hardware.rst","get_started.rst","index.rst","uart_loopback_demo_introduce.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x001":3,"0x002":3,"0x004":3,"0x008":3,"0x01":3,"0x010":3,"0x02":3,"0x020":3,"0x03":3,"0x04":3,"0x05":3,"0x06":3,"0x07":3,"0x10":3,"0x1000":3,"0x11":3,"0x12":3,"0x13":3,"0x2000":3,"0x3000":3,"10":3,"11":3,"12":3,"13":3,"18":7,"19":0,"2000000":[0,3],"20210120":0,"3v3":6,"case":2,"char":3,"const":3,"do":6,"enum":3,"export":0,"if":[3,5,9],"import":2,"int":3,"null":3,"return":3,"void":[3,9],adc:3,add:1,api:8,app:[0,2],appli:2,applic:2,apt:0,arg:[3,9],asynchron:3,bashrc:0,baudrat:3,bflb_mcu_prefer:2,bflb_platform_init:9,bin:[0,1,2],bit:3,bl702:[0,1,2,7,8],bl702_iot:6,bl706:[2,6],bl706_avb:7,bl706_iot:[0,2,4,5,7,9],bl70x:[6,8],bl70x_flash:1,bl70x_flasher:1,bl:3,bl_clean:2,bl_make:2,bl_mcu_sdk:[3,5],ble:8,board:[0,2,3,5,6,9],boot:[0,6],boot_rom:0,borad:2,bouffalo:[2,6,7],bouffalolab:[0,1,2],bsp:[3,5,9],bsp_using_uart0:3,bsp_using_uart1:3,bsp_using_uart2:3,bsp_using_uart3:3,bsp_using_uart4:3,buffer:3,build:[0,1,2],callback:3,cancel:2,cbfun:3,cd:0,cdk:[7,8],cdk_flashload:1,cdkproj:1,ck:[1,7],ck_link:6,clean:1,clone:[0,1,2],close:3,cmd:3,code:3,com:[0,1,2,6],command:2,config_gpio14_func:9,config_gpio15_func:9,config_gpio22_func:5,connect:6,consol:2,control:3,core:8,cp:0,cpu:1,csky:1,ctrl:3,cube:6,data:3,databit:3,debug:[1,2],debug_log:9,debugg:[1,7],defin:[3,5,9],demo:2,dev:[0,2,3,6,9],devic:[3,5,9],device_class_adc:3,device_class_camera:3,device_class_dma:3,device_class_gpio:3,device_class_i2:3,device_class_i2c:3,device_class_non:3,device_class_pwm:3,device_class_sdio:3,device_class_sec_hash:3,device_class_spi:3,device_class_tim:3,device_class_typ:3,device_class_uart:3,device_class_usb:3,device_contorl:5,device_control:[5,9],device_ctrl_clr_int:3,device_ctrl_config:[3,5],device_ctrl_get_config:3,device_ctrl_get_int:3,device_ctrl_resum:3,device_ctrl_set_int:[3,9],device_ctrl_suspend:3,device_ctrl_uart_attach_rx_dma:3,device_ctrl_uart_attach_tx_dma:3,device_ctrl_uart_get_rx_fifo:3,device_ctrl_uart_get_tx_fifo:3,device_find:[5,9],device_oflag_dma_rx:3,device_oflag_dma_tx:3,device_oflag_int_rx:3,device_oflag_int_tx:3,device_oflag_rdonli:3,device_oflag_rdwr:[3,5],device_oflag_stream_rx:3,device_oflag_stream_tx:3,device_oflag_wronli:3,device_open:5,device_set_callback:9,device_status_typ:3,device_writ:9,dlist_t:3,dma:3,download:[0,1,2],e24:8,echo:0,eclips:[7,8],edit:2,elf:[0,1,2],els:9,enabl:3,endif:3,epf:2,even:3,event:3,exampl:[0,1,2,4,5,9],exe:[1,2],exist:2,fifo:3,fifo_threshold:3,file:[0,2],find:[5,9],finish:2,finsh:2,flag:3,flash:1,flashdownload:1,gdb:2,gener:[2,3],git:[0,1,2],gite:[0,1,2],gnd:[2,6],gpio22:[4,5],gpio29:[4,5],gpio30:[4,5],gpio31:[4,5],gpio:[2,4,8],gpio_async_falling_triger_int_mod:3,gpio_async_high_level_int_mod:3,gpio_async_low_level_int_mod:3,gpio_async_rising_triger_int_mod:3,gpio_blink:[2,4],gpio_fun_uart0_rx:9,gpio_fun_uart0_tx:9,gpio_fun_unus:5,gpio_input_mod:3,gpio_input_pd_mod:3,gpio_input_pp_mod:3,gpio_output_mod:3,gpio_output_pd_mod:3,gpio_output_pp_mod:[3,4],gpio_pin_14:9,gpio_pin_15:9,gpio_pin_22:4,gpio_pin_29:4,gpio_pin_30:4,gpio_pin_31:4,gpio_set_mod:4,gpio_sync_falling_triger_int_mod:3,gpio_sync_high_level_int_mod:3,gpio_sync_low_level_int_mod:3,gpio_sync_rising_triger_int_mod:3,gpio_writ:4,gz:0,hal:3,handl:3,hd1:[6,9],hd3:6,hellowd:[0,1,2],helloworld:[0,1,2],help:1,http:[0,1,2],id:3,ifdef:3,ifndef:3,index:3,input:3,instal:0,interfac:0,into:2,iot:[2,6,8],is:3,jlink:[6,7],jlink_bl_mcu_sdk:2,jtag:[6,7,8],jtag_tck:6,jtag_tdi:6,jtag_tdo:6,jtag_tm:6,keil:8,lab:[2,6,7],launch:2,led:[4,5],led_breath:5,length:3,link:[1,2,7],linux:[7,8],list:3,loader:1,log:2,lts:7,main:[0,2],make:2,mcu:[0,1,2,3,6,7],mdk:8,media:0,mini:[0,6],mkdir:0,mode:3,name:3,name_max:3,next:2,no:3,node:3,occ:1,odd:3,of:3,oflag:3,ok:1,one:3,open:3,or:[6,7],org:0,ostrac:1,out:2,output:3,over:2,pane:1,parent:3,pariti:3,path:0,pc:[2,6,7],peripher:1,peripheral_clock_adc:3,peripheral_clock_dac:3,peripheral_clock_i2:3,peripheral_clock_i2c:3,peripheral_clock_spi:3,peripheral_clock_typ:3,peripheral_clock_uart:3,peripheral_config:3,picocom:0,pin:3,pinmux:3,pinmux_config:[3,5,9],pos:3,prefer:2,printf:9,profil:1,project:[1,2],purpos:3,pwm0_index:5,pwm:[5,8,9],pwm_breath_l:5,pwm_cfg:5,pwm_regist:5,read:3,receiv:3,recurs:[0,1,2],refresh:6,regist:1,risc:[2,8],riscv64:0,rom:6,rst:[0,1,2,6],rto:3,rx0:6,rx:9,rx_dma:3,rxd0:2,rxd:6,sdk:[0,1,2,3],segger:2,serial:1,set:1,set_callback:9,setup:1,sifiv:8,sipe:7,size:[3,9],sky:1,sourc:0,spi:3,start:1,state:9,statu:3,std:3,step:2,stop:[1,3],stopbit:3,struct:[3,5,9],structur:3,success:1,sudo:0,system:1,system_clock_bclk:3,system_clock_fclk:3,system_clock_root_clock:3,system_clock_typ:3,system_clock_xclk:3,tabl:3,tar:0,target:2,tck:6,tdi:6,tdo:6,tms:6,to:6,tool:1,transmitt:3,ttl:[0,1,2,6,7],ttyusb0:0,two:3,tx0:6,tx:9,tx_dma:3,txd0:2,txd:6,type:[1,2,3,6],typedef:3,uart0:[3,6],uart0_config:3,uart0_index:3,uart1_config:3,uart1_index:3,uart2_index:3,uart3_index:3,uart4_index:3,uart:[0,8,9],uart_data_len_5:3,uart_data_len_6:3,uart_data_len_7:3,uart_data_len_8:3,uart_databits_t:3,uart_devic:3,uart_device_t:3,uart_echo:9,uart_event_rto:[3,9],uart_event_rx_end:3,uart_event_rx_fifo:[3,9],uart_event_tx_end:3,uart_event_tx_fifo:3,uart_event_typ:3,uart_event_unknown:3,uart_index_typ:3,uart_irq_callback:9,uart_it_typ:3,uart_max_index:3,uart_par_even:3,uart_par_non:3,uart_par_odd:3,uart_param_cfg_t:3,uart_parity_t:3,uart_rto_it:9,uart_rx_fifo_it:9,uart_stop_on:3,uart_stop_one_d_f:3,uart_stop_two:3,uart_stopbits_t:3,uartx_devic:3,ubuntu:7,uint16_t:3,uint32_t:[3,9],uint8_t:[3,9],univers:3,updat:0,upload:0,usb:[0,1,2,6,7],usr:0,v11:7,v3:0,valu:3,vdd33:6,vdd:6,vi:0,view:1,viewer:1,vref:6,vtref:6,welcom:2,wget:0,window:[7,8],workspac:2,write:3,x86_64:0,xxx:2,xxx_board:3,xxx_clock_config:3,xxx_close:3,xxx_control:3,xxx_devic:3,xxx_device_t:3,xxx_open:3,xxx_read:3,xxx_regist:3,xxx_write:3,zigbe:8,zxvf:0},titles:["4. Linux \u73af\u5883\u5f00\u53d1\u6307\u5357","2. Windows \u4e0b\u4f7f\u7528 CDK (\u7c7b MDK Keil)\u5f00\u53d1\u6307\u5357","3. Windows \u4e0b\u4f7f\u7528 Eclipse \u5f00\u53d1\u6307\u5357","1. API \u5206\u5c42\u6a21\u578b","1. \u6d41\u6c34\u706f\u793a\u4f8b","2. \u547c\u5438\u706f\u793a\u4f8b","5. \u786c\u4ef6\u8fde\u63a5","1. \u5f00\u53d1\u524d\u7684\u51c6\u5907","BL MCU SDK \u5f00\u53d1\u6307\u5357","3. \u4e32\u53e3\u81ea\u6536\u53d1\u793a\u4f8b"],titleterms:{api:3,bl702_avb:6,bl706_iot:6,bl:8,bl_mcu_sdk:[0,1,2],cdk:1,ck:6,cmake:0,device_clos:3,device_control:3,device_find:3,device_open:3,device_read:3,device_regist:3,device_set_callback:3,device_unregist:3,device_writ:3,eclips:2,gpio:3,gpio_attach_irq:3,gpio_irq_en:3,gpio_read:3,gpio_set_mod:3,gpio_toggl:3,gpio_writ:3,hello:[0,1,2],keil:1,link:6,linux:0,make:0,mcu:8,mdk:1,peripheral_clock_get:3,pwm:3,risc:0,sdk:8,system_clock_get:3,uart:3,uart_regist:3,window:[1,2],world:[0,1,2]}})
\ No newline at end of file
+Search.setIndex({docnames:["Linux_quick_start_ubuntu","Windows_quick_start_cdk","Windows_quick_start_eclipse","api_guide","blink_demo_introduce","breath_pwm_demo_introduce","connecting_hardware","get_started","index","uart_loopback_demo_introduce"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["Linux_quick_start_ubuntu.rst","Windows_quick_start_cdk.rst","Windows_quick_start_eclipse.rst","api_guide.rst","blink_demo_introduce.rst","breath_pwm_demo_introduce.rst","connecting_hardware.rst","get_started.rst","index.rst","uart_loopback_demo_introduce.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x001":3,"0x002":3,"0x004":3,"0x008":3,"0x01":3,"0x010":3,"0x02":3,"0x020":3,"0x03":3,"0x04":3,"0x05":3,"0x06":3,"0x07":3,"0x08":3,"0x09":3,"0x0a":3,"0x0b":3,"0x0c":3,"0x0d":3,"0x0e":3,"0x0f":3,"0x10":3,"0x1000":3,"0x11":3,"0x2000":3,"0x3000":3,"10":3,"11":3,"12":3,"13":3,"18":7,"19":0,"2000000":[0,3],"20210120":0,"3v3":6,"case":2,"char":3,"const":3,"do":6,"enum":3,"export":0,"if":[3,5,9],"import":2,"int":3,"null":3,"return":3,"void":[3,9],adc:3,add:1,api:8,app:[0,2],appli:2,applic:2,apt:0,arg:[3,9],asynchron:3,bashrc:0,baudrat:3,bflb_mcu_prefer:2,bflb_platform_init:9,bin:[0,1,2],bit:3,bl702:[0,1,2,7,8],bl702_iot:6,bl706:[2,6],bl706_avb:7,bl706_iot:[0,2,4,5,7,9],bl70x:[6,8],bl70x_flash:1,bl70x_flasher:1,bl:3,bl_clean:2,bl_make:2,bl_mcu_sdk:[3,5],ble:8,board:[0,2,3,5,6,9],boot:[0,6],boot_rom:0,borad:2,bouffalo:[2,6,7],bouffalolab:[0,1,2],bsp:[3,5,9],bsp_using_uart0:3,bsp_using_uart1:3,bsp_using_uart2:3,bsp_using_uart3:3,bsp_using_uart4:3,buffer:3,build:[0,1,2],callback:3,cancel:2,cbfun:3,cd:0,cdk:[7,8],cdk_flashload:1,cdkproj:1,ck:[1,7],ck_link:6,clean:1,clear:3,clone:[0,1,2],close:3,cmd:3,code:3,com:[0,1,2,6],command:2,config:3,config_gpio14_func:9,config_gpio15_func:9,config_gpio22_func:5,configur:3,connect:6,consol:2,control:3,core:8,cp:0,cpu:1,csky:1,ctrl:3,cube:6,data:3,databit:3,debug:[1,2],debug_log:9,debugg:[1,7],defin:[3,5,9],demo:2,dev:[0,2,3,6,9],devic:[3,5,9],device_class_adc:3,device_class_camera:3,device_class_dma:3,device_class_gpio:3,device_class_i2:3,device_class_i2c:3,device_class_non:3,device_class_pwm:3,device_class_sdio:3,device_class_sec_hash:3,device_class_spi:3,device_class_tim:3,device_class_typ:3,device_class_uart:3,device_class_usb:3,device_contorl:5,device_control:[5,9],device_ctrl_attach_rx_dma:3,device_ctrl_attach_tx_dma:3,device_ctrl_clr_int:3,device_ctrl_config:[3,5],device_ctrl_get_config:3,device_ctrl_get_int:3,device_ctrl_resum:3,device_ctrl_resvd1:3,device_ctrl_resvd2:3,device_ctrl_rx_dma_resum:3,device_ctrl_rx_dma_suspend:3,device_ctrl_set_int:[3,9],device_ctrl_suspend:3,device_ctrl_tx_dma_resum:3,device_ctrl_tx_dma_suspend:3,device_ctrl_uart_get_rx_fifo:3,device_ctrl_uart_get_tx_fifo:3,device_find:[5,9],device_oflag_dma_rx:3,device_oflag_dma_tx:3,device_oflag_int_rx:3,device_oflag_int_tx:3,device_oflag_rdonli:3,device_oflag_rdwr:[3,5],device_oflag_stream_rx:3,device_oflag_stream_tx:3,device_oflag_wronli:3,device_open:5,device_set_callback:9,device_status_typ:3,device_writ:9,dlist_t:3,dma:3,download:[0,1,2],e24:8,echo:0,eclips:[7,8],edit:2,elf:[0,1,2],els:9,enabl:3,endif:3,epf:2,even:3,event:3,exampl:[0,1,2,4,5,9],exe:[1,2],exist:2,fifo:3,fifo_threshold:3,file:[0,2],find:[5,9],finish:2,finsh:2,flag:3,flash:1,flashdownload:1,gdb:2,gener:[2,3],get:3,git:[0,1,2],gite:[0,1,2],gnd:[2,6],gpio22:[4,5],gpio29:[4,5],gpio30:[4,5],gpio31:[4,5],gpio:[2,4,8],gpio_async_falling_triger_int_mod:3,gpio_async_high_level_int_mod:3,gpio_async_low_level_int_mod:3,gpio_async_rising_triger_int_mod:3,gpio_blink:[2,4],gpio_fun_uart0_rx:9,gpio_fun_uart0_tx:9,gpio_fun_unus:5,gpio_input_mod:3,gpio_input_pd_mod:3,gpio_input_pp_mod:3,gpio_output_mod:3,gpio_output_pd_mod:3,gpio_output_pp_mod:[3,4],gpio_pin_14:9,gpio_pin_15:9,gpio_pin_22:4,gpio_pin_29:4,gpio_pin_30:4,gpio_pin_31:4,gpio_set_mod:4,gpio_sync_falling_triger_int_mod:3,gpio_sync_high_level_int_mod:3,gpio_sync_low_level_int_mod:3,gpio_sync_rising_triger_int_mod:3,gpio_writ:4,gz:0,hal:3,handl:3,hd1:[6,9],hd3:6,hellowd:[0,1,2],helloworld:[0,1,2],help:1,http:[0,1,2],id:3,ifdef:3,ifndef:3,index:3,input:3,instal:0,interfac:0,interrupt:3,into:2,iot:[2,6,8],is:3,jlink:[6,7],jlink_bl_mcu_sdk:2,jtag:[6,7,8],jtag_tck:6,jtag_tdi:6,jtag_tdo:6,jtag_tm:6,keil:8,lab:[2,6,7],launch:2,led:[4,5],led_breath:5,length:3,link:[1,2,7],linux:[7,8],list:3,loader:1,log:2,lts:7,main:[0,2],make:2,mcu:[0,1,2,3,6,7],mdk:8,media:0,mini:[0,6],mkdir:0,mode:3,name:3,name_max:3,next:2,no:3,node:3,occ:1,odd:3,of:3,oflag:3,ok:1,one:3,open:3,or:[6,7],org:0,ostrac:1,out:2,output:3,over:2,pane:1,parent:3,pariti:3,path:0,pc:[2,6,7],peripher:1,peripheral_clock_adc:3,peripheral_clock_dac:3,peripheral_clock_i2:3,peripheral_clock_i2c:3,peripheral_clock_spi:3,peripheral_clock_typ:3,peripheral_clock_uart:3,peripheral_config:3,picocom:0,pin:3,pinmux:3,pinmux_config:[3,5,9],pos:3,prefer:2,printf:9,profil:1,project:[1,2],purpos:3,pwm0_index:5,pwm:[5,8,9],pwm_breath_l:5,pwm_cfg:5,pwm_regist:5,read:3,receiv:3,recurs:[0,1,2],refresh:6,regist:1,resum:3,rf:0,risc:[2,8],riscv64:0,rom:6,rst:[0,1,2,6],rto:3,rx0:6,rx:9,rx_dma:3,rxd0:2,rxd:6,sdk:[0,1,2,3],segger:2,serial:1,set:[1,3],set_callback:9,setup:1,sifiv:8,sipe:7,size:[3,9],sky:1,sourc:0,spi:3,start:1,state:9,statu:3,std:3,step:2,stop:[1,3],stopbit:3,struct:[3,5,9],structur:3,success:1,sudo:0,suspend:3,system:1,system_clock_bclk:3,system_clock_fclk:3,system_clock_root_clock:3,system_clock_typ:3,system_clock_xclk:3,tabl:3,tar:0,target:2,tck:6,tdi:6,tdo:6,tms:6,to:6,tool:1,transmitt:3,ttl:[0,1,2,6,7],ttyusb0:0,two:3,tx0:6,tx:9,tx_dma:3,txd0:2,txd:6,type:[1,2,3,6],typedef:3,uart0:[3,6],uart0_config:3,uart0_index:3,uart1_config:3,uart1_index:3,uart2_index:3,uart3_index:3,uart4_index:3,uart:[0,8,9],uart_data_len_5:3,uart_data_len_6:3,uart_data_len_7:3,uart_data_len_8:3,uart_databits_t:3,uart_devic:3,uart_device_t:3,uart_echo:9,uart_event_rto:[3,9],uart_event_rx_end:3,uart_event_rx_fifo:[3,9],uart_event_tx_end:3,uart_event_tx_fifo:3,uart_event_typ:3,uart_event_unknown:3,uart_index_typ:3,uart_irq_callback:9,uart_it_typ:3,uart_max_index:3,uart_par_even:3,uart_par_non:3,uart_par_odd:3,uart_param_cfg_t:3,uart_parity_t:3,uart_rto_it:9,uart_rx_fifo_it:9,uart_stop_on:3,uart_stop_one_d_f:3,uart_stop_two:3,uart_stopbits_t:3,uartx_devic:3,ubuntu:7,uint16_t:3,uint32_t:[3,9],uint8_t:[3,9],univers:3,updat:0,upload:0,usb:[0,1,2,6,7],usr:0,v11:7,v3:0,valu:3,vdd33:6,vdd:6,vi:0,view:1,viewer:1,vref:6,vtref:6,welcom:2,wget:0,window:[7,8],workspac:2,write:3,x86_64:0,xxx:2,xxx_board:3,xxx_clock_config:3,xxx_close:3,xxx_control:3,xxx_devic:3,xxx_device_t:3,xxx_open:3,xxx_read:3,xxx_regist:3,xxx_write:3,zigbe:8,zxvf:0},titles:["4. Linux \u73af\u5883\u5f00\u53d1\u6307\u5357","2. Windows \u4e0b\u4f7f\u7528 CDK (\u7c7b MDK Keil)\u5f00\u53d1\u6307\u5357","3. Windows \u4e0b\u4f7f\u7528 Eclipse \u5f00\u53d1\u6307\u5357","1. API \u5206\u5c42\u6a21\u578b","1. \u6d41\u6c34\u706f\u793a\u4f8b","2. \u547c\u5438\u706f\u793a\u4f8b","5. \u786c\u4ef6\u8fde\u63a5","1. \u5f00\u53d1\u524d\u7684\u51c6\u5907","BL MCU SDK \u5f00\u53d1\u6307\u5357","3. \u4e32\u53e3\u81ea\u6536\u53d1\u793a\u4f8b"],titleterms:{api:3,bl702_avb:6,bl706_iot:6,bl:8,bl_mcu_sdk:[0,1,2],cdk:1,ck:6,cmake:0,device_clos:3,device_control:3,device_find:3,device_open:3,device_read:3,device_regist:3,device_set_callback:3,device_unregist:3,device_writ:3,eclips:2,gpio:3,gpio_attach_irq:3,gpio_irq_en:3,gpio_read:3,gpio_set_mod:3,gpio_toggl:3,gpio_writ:3,hello:[0,1,2],keil:1,link:6,linux:0,make:0,mcu:8,mdk:1,peripheral_clock_get:3,pwm:3,risc:0,sdk:8,system_clock_get:3,uart:3,uart_regist:3,window:[1,2],world:[0,1,2]}})
\ No newline at end of file
diff --git a/docs/development_guide/source/Linux_quick_start_ubuntu.rst b/docs/development_guide/source/Linux_quick_start_ubuntu.rst
index 8f7f344e..b10e8a9d 100644
--- a/docs/development_guide/source/Linux_quick_start_ubuntu.rst
+++ b/docs/development_guide/source/Linux_quick_start_ubuntu.rst
@@ -23,7 +23,7 @@ Linux 环境开发指南
    $ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz
    $ mkdir -p riscv64-elf-20210120
    $ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120
-   $ sudo cp ~/riscv64-elf-20210120  /usr/bin
+   $ sudo cp -rf ~/riscv64-elf-20210120  /usr/bin
    $ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\""  >> ~/.bashrc
    $ source ~/.bashrc
 
@@ -39,7 +39,7 @@ Linux 环境开发指南
    $ cd ~
    $ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz 
    $ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz
-   $ sudo cp ~/cmake-3.19.3-Linux-x86_64  /usr/bin
+   $ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64  /usr/bin
    $ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\""  >> ~/.bashrc
    $ source ~/.bashrc
 
diff --git a/docs/development_guide/source/api_guide.rst b/docs/development_guide/source/api_guide.rst
index 8fbae716..6e78c854 100644
--- a/docs/development_guide/source/api_guide.rst
+++ b/docs/development_guide/source/api_guide.rst
@@ -207,13 +207,21 @@ API 分层模型
 
 .. code-block:: C
 
-    #define DEVICE_CTRL_SET_INT     0x01    /* 设置中断 */
-    #define DEVICE_CTRL_CLR_INT     0x02    /* 清中断 */
-    #define DEVICE_CTRL_GET_INT     0x03    /* 获取中断状态 */
-    #define DEVICE_CTRL_RESUME      0x04    /* 恢复设备 */
-    #define DEVICE_CTRL_SUSPEND     0x05    /* 挂起设备 */
-    #define DEVICE_CTRL_CONFIG      0x06    /* 配置设备 */
-    #define DEVICE_CTRL_GET_CONFIG  0x07    /* 获取设备配置 */
+    #define DEVICE_CTRL_SET_INT             0x01    /* set interrupt */
+    #define DEVICE_CTRL_CLR_INT             0x02    /* clear interrupt */
+    #define DEVICE_CTRL_GET_INT             0x03    /* get interrupt status*/
+    #define DEVICE_CTRL_RESUME              0x04    /* resume device */
+    #define DEVICE_CTRL_SUSPEND             0x05    /* suspend device */
+    #define DEVICE_CTRL_CONFIG              0x06    /* config device */
+    #define DEVICE_CTRL_GET_CONFIG          0x07    /* get device configuration */
+    #define DEVICE_CTRL_ATTACH_TX_DMA       0x08
+    #define DEVICE_CTRL_ATTACH_RX_DMA       0x09
+    #define DEVICE_CTRL_TX_DMA_SUSPEND      0x0a
+    #define DEVICE_CTRL_RX_DMA_SUSPEND      0x0b
+    #define DEVICE_CTRL_TX_DMA_RESUME       0x0c
+    #define DEVICE_CTRL_RX_DMA_RESUME       0x0d
+    #define DEVICE_CTRL_RESVD1              0x0E
+    #define DEVICE_CTRL_RESVD2              0x0F
 
 **device_write**
 ^^^^^^^^^^^^^^^^
@@ -371,7 +379,7 @@ GPIO 全称 General Purpose Input Output（通用输入 / 输出），博流系
 
 bl mcu sdk 的引脚配置方式分为两种。
 
-- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚和工功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。
+- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚的功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。
 - 通过标准的 GPIO 设备接口配置引脚，缺点是只能配置普通的输入输出和中断功能，复用功能建议还是使用 table 进行配置。
 
 GPIO 设备接口
@@ -514,7 +522,7 @@ UART 设备结构体定义
 - parity 校验位
 - fifo_threshold fifo 阈值,不同 mcu 最大值不同
 - tx_dma 附加的发送 dma 句柄
-- rx_dma 附加的发送 dma 句柄
+- rx_dma 附加的接收 dma 句柄
 
 databits 提供以下类型
 
@@ -679,8 +687,6 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
 
     #define DEVICE_CTRL_UART_GET_TX_FIFO        0x10
     #define DEVICE_CTRL_UART_GET_RX_FIFO        0x11
-    #define DEVICE_CTRL_UART_ATTACH_TX_DMA      0x12
-    #define DEVICE_CTRL_UART_ATTACH_RX_DMA      0x13
 
 ``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
 
@@ -693,9 +699,9 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
 +---------------------------------------+--------------------------------------+
 |     DEVICE_CTRL_CONFIG                |         uart_param_cfg_t             |
 +---------------------------------------+--------------------------------------+
-|     DEVICE_CTRL_UART_ATTACH_TX_DMA    |         dma句柄                      |
+|     DEVICE_CTRL_ATTACH_TX_DMA         |         dma句柄                      |
 +---------------------------------------+--------------------------------------+
-|     DEVICE_CTRL_UART_ATTACH_RX_DMA    |         dma句柄                      |
+|     DEVICE_CTRL_ATTACH_RX_DMA         |         dma句柄                      |
 +---------------------------------------+--------------------------------------+
 |     DEVICE_CTRL_UART_GET_TX_FIFO      |         缓存变量                     |
 +---------------------------------------+--------------------------------------+