mirror of
https://github.com/Fishwaldo/bl_mcu_sdk.git
synced 2025-07-12 07:48:42 +00:00
[doc] update rst
This commit is contained in:
parent
3c3e85b504
commit
926235b949
15 changed files with 663 additions and 104 deletions
|
@ -4,18 +4,18 @@ DAC
|
|||
Macros
|
||||
------------
|
||||
|
||||
dac sampling frequence
|
||||
dac clock div
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
dac 采样频率可以选择 32K、16K、8K,512K 只有 dma 模式下才可以使用。
|
||||
dac 分频,只有 DMA 模式下可以使用 1 分频。
|
||||
|
||||
.. code-block:: c
|
||||
:linenos:
|
||||
|
||||
#define DAC_SAMPLING_FREQ_32K 0
|
||||
#define DAC_SAMPLING_FREQ_16K 1
|
||||
#define DAC_SAMPLING_FREQ_8K 3
|
||||
#define DAC_SAMPLING_FREQ_512K 4
|
||||
#define DAC_CLK_DIV_16 0
|
||||
#define DAC_CLK_DIV_32 1
|
||||
#define DAC_CLK_DIV_64 3
|
||||
#define DAC_CLK_DIV_1 4
|
||||
|
||||
dac channel
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
@ -44,7 +44,7 @@ bflb_dac_init
|
|||
.. code-block:: c
|
||||
:linenos:
|
||||
|
||||
void bflb_dac_init(struct bflb_device_s *dev, uint8_t frequence);
|
||||
void bflb_dac_init(struct bflb_device_s *dev, uint8_t clk_div);
|
||||
|
||||
.. list-table::
|
||||
:widths: 10 10
|
||||
|
@ -54,8 +54,8 @@ bflb_dac_init
|
|||
- description
|
||||
* - dev
|
||||
- 设备句柄
|
||||
* - frequence
|
||||
- 采样率
|
||||
* - clk_div
|
||||
- 分频值
|
||||
|
||||
bflb_dac_deinit
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
BIN
docs/source/api_reference/peripherals/doxygen.png
Normal file
BIN
docs/source/api_reference/peripherals/doxygen.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
|
@ -5,7 +5,7 @@ Peripherals
|
|||
简介
|
||||
---------
|
||||
|
||||
BL MCU SDK 中外设驱动分为两类: **LHAL** 和 **SOC** ,前者对通用外设进行了统一的封装,不同芯片使用同一套接口,方便用户使用和移植到其他平台。后者则是每个芯片独有且特殊的部分,比如 GLB、HBN、PDS、AON 等等。
|
||||
BouffaloSDK 中外设驱动分为两类: **LHAL** 和 **SOC** ,前者对通用外设进行了统一的封装,不同芯片使用同一套接口,方便用户使用和移植到其他平台。后者则是每个芯片独有且特殊的部分,比如 GLB、HBN、PDS、AON 等等。
|
||||
|
||||
下面主要列出 **LHAL** 相关 API 的使用。
|
||||
|
||||
|
@ -22,7 +22,6 @@ BL MCU SDK 中外设驱动分为两类: **LHAL** 和 **SOC** ,前者对通
|
|||
uint8_t sub_idx;
|
||||
uint8_t dev_type;
|
||||
void *user_data;
|
||||
bflb_dlist_t list;
|
||||
};
|
||||
|
||||
.. list-table::
|
||||
|
@ -202,6 +201,13 @@ API 支持情况
|
|||
API 列表
|
||||
---------------
|
||||
|
||||
除了使用网页版查看 API 以外, 还提供了 **LHAL Doxygen** 版本,离线生成文档。 Doxyfile 文件在 ``drivers/lhal`` 目录下。
|
||||
|
||||
使用 Doxywizard 导入并运行即可。
|
||||
|
||||
.. figure:: doxygen.png
|
||||
:alt:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue