GitHub-Mirror/bl_mcu_sdk
2
0
Fork 0
mirror of https://github.com/Fishwaldo/bl_mcu_sdk.git synced 2025-07-19 19:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[docs] update doc

Browse source
This commit is contained in:
jzlv 2021-07-16 16:43:39 +08:00
parent ee237e8197
commit a703cb54ff
74 changed files with 74 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/development_guide/source/api_reference/api_overview.rst
View file

@ -107,26 +107,16 @@ API 概述
**device_register**
^^^^^^^^^^^^^^^^^^^^
``device_register`` 用于设备的注册，将设备信息注册到链表当中。
``device_register`` 用于设备标准驱动的注册，并将设备信息注册到链表当中。
.. code-block:: C
int device_register(struct device *dev, const char *name, uint16_t flag);
int device_register(struct device *dev, const char *name);
- dev 设备句柄。
- name 设备名称。
- flag 设备的读写属性
- return 返回错误码，0 表示注册成功，其他表示错误。
``flag`` 可以写入以下参数，表示：**只读**、**只写**、**可读可写**。
.. code-block:: C
#define DEVICE_OFLAG_RDONLY 0x1000 /* 以只读方式打开设备 */
#define DEVICE_OFLAG_WRONLY 0x2000 /* 以只写方式打开设备 */
#define DEVICE_OFLAG_RDWR 0x3000 /* 以读写方式打开设备 */
**device_unregister**
^^^^^^^^^^^^^^^^^^^^^^^

5
docs/development_guide/source/api_reference/peripheral/api_adc.rst
View file

@ -79,17 +79,16 @@ ADC 设备接口
ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
**ADC_register**
**adc_register**
^^^^^^^^^^^^^^^^^^^^^^^^
``adc_register`` 用来注册 ADC 设备标准驱动接口，在注册之前需要打开对应 ADC 设备的宏定义。例如定义宏 ``BSP_USING_ADC0`` 方可使用 ``ADC0`` 设备,注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 ``ADC0`` 设备。
.. code-block:: C
int ADC_register(enum ADC_index_type index, const char *name, uint16_t flag);
int adc_register(enum ADC_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
``index`` 用来选择 ADC 设备配置，一个 index 对应一个 ADC 设备配置，比如 ``ADC0_INDEX`` 对应 ``ADC0_CONFIG`` 配置，``index`` 有如下可选类型

3
docs/development_guide/source/api_reference/peripheral/api_dma.rst
View file

@ -217,11 +217,10 @@ DMA 设备接口全部遵循标准设备驱动管理层提供的接口。并且
.. code-block:: C
int dma_register(enum dma_index_type index, const char *name, uint16_t flag);
int dma_register(enum dma_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
``index`` 用来选择 DMA 设备某个通道的配置，一个 index 对应一个 DMA 设备的一个通道配置，比如 ``DMA_CH0_INDEX`` 对应 DMA 通道0 配置，``index`` 有如下可选类型

3
docs/development_guide/source/api_reference/peripheral/api_i2c.rst
View file

@ -75,11 +75,10 @@ I2C 设备标准接口当前仅使用 ``device_open`` , 并提供标准的数据
.. code-block:: C
int i2c_register(enum i2c_index_type index, const char *name, uint16_t flag);
int i2c_register(enum i2c_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
``index`` 用来选择 I2C 设备,一个 index 对应一个 I2C 设备配置，比如 ``I2C0_INDEX`` 对应 ``I2C0_CONFIG`` 配置，``index`` 有如下可选类型

3
docs/development_guide/source/api_reference/peripheral/api_i2s.rst
View file

@ -144,11 +144,10 @@ I2S 设备接口全部遵循标准设备驱动管理层提供的接口。
.. code-block:: C
int i2s_register(enum i2s_index_type index, const char *name, uint16_t flag);
int i2s_register(enum i2s_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
``index`` 用来选择 I2S 设备配置，一个 index 对应一个 I2S 设备配置，比如 ``I2S0_INDEX`` 对应 ``I2S0_CONFIG`` 配置。index 有如下可选类型

3
docs/development_guide/source/api_reference/peripheral/api_pwm.rst
View file

@ -94,11 +94,10 @@ PWM 设备接口全部遵循标准设备驱动管理层提供的接口。并且
.. code-block:: C
int pwm_register(enum pwm_index_type index, const char *name, uint16_t flag);
int pwm_register(enum pwm_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
``index`` 用来选择 PWM 设备某个通道的配置，一个 index 对应一个 PWM 设备的一个通道配置，比如 ``PWM_CH0_INDEX`` 对应 PWM 通道0 配置，``index`` 有如下可选类型

3
docs/development_guide/source/api_reference/peripheral/api_spi.rst
View file

@ -137,11 +137,10 @@ SPI 设备接口全部遵循标准设备驱动管理层提供的接口。
.. code-block:: C
int spi_register(enum spi_index_type index, const char *name, uint16_t flag);
int spi_register(enum spi_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
``index`` 用来选择 SPI 设备配置，一个 index 对应一个 SPI 设备配置，比如 ``SPI0_INDEX`` 对应 ``SPI0_CONFIG`` 配置，``index`` 有如下可选类型

3
docs/development_guide/source/api_reference/peripheral/api_timer.rst
View file

@ -124,11 +124,10 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
.. code-block:: C
int timer_register(enum timer_index_type index, const char *name, uint16_t flag);
int timer_register(enum timer_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
``index`` 用来选择 TIMER 设备配置，一个 index 对应一个 TIMER 设备配置，比如 ``TIMER_CH0_INDEX`` 对应 ``TIMER_CH0_CONFIG`` 配置，``index`` 有如下可选类型

3
docs/development_guide/source/api_reference/peripheral/api_uart.rst
View file

@ -125,11 +125,10 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
.. code-block:: C
int uart_register(enum uart_index_type index, const char *name, uint16_t flag);
int uart_register(enum uart_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
``index`` 用来选择 UART 设备配置，一个 index 对应一个 UART 设备配置，比如 ``UART0_INDEX`` 对应 ``UART0_CONFIG`` 配置，``index`` 有如下可选类型

3
docs/development_guide/source/api_reference/peripheral/api_usb.rst
View file

@ -81,11 +81,10 @@ USB 设备接口遵循标准设备驱动管理层提供的接口。
.. code-block:: C
int usb_dc_register(enum usb_index_type index, const char *name, uint16_t flag);
int usb_dc_register(enum usb_index_type index, const char *name);
- index 要注册的设备索引
- name 为注册的设备命名
- flag 默认可读可写属性
- return 错误码，0表示成功，其他表示失败
**device_open**

2
docs/development_guide/source/api_reference/usb stack/api_usb_stack.rst
View file

@ -42,7 +42,7 @@ USB DEVICE 控制器接口
struct device *usb_dc_init(void)
{
usb_dc_register(USB_INDEX, "usb", DEVICE_OFLAG_RDWR);
usb_dc_register(USB_INDEX, "usb");
usb = device_find("usb");
device_set_callback(usb, usb_dc_event_callback);
device_open(usb, 0);

2
docs/development_guide/source/samples/advance samples/shell_demo.rst
View file

@ -77,7 +77,7 @@ shell 移植到串口
.. code-block:: C
:linenos:
uart_register(board_get_debug_uart_index(), "debug_log", DEVICE_OFLAG_RDWR);
uart_register(board_get_debug_uart_index(), "debug_log");
struct device *uart = device_find("debug_log");
if (uart)

2
docs/development_guide/source/samples/basic samples/dma/dma_m2m_demo.rst
View file

@ -38,7 +38,7 @@ DMA - RAM间数据搬运
.. code-block:: C
:linenos:
dma_register(DMA0_CH0_INDEX, "DMA", DEVICE_OFLAG_RDWR);
dma_register(DMA0_CH0_INDEX, "DMA");
struct device *dma = device_find("DMA");

4
docs/development_guide/source/samples/basic samples/i2c/i2c_eeprom_demo.rst
View file

@ -33,7 +33,7 @@ I2C - AT24CXX 读写
#define CONFIG_GPIO11_FUNC GPIO_FUN_I2C
#define CONFIG_GPIO16_FUNC GPIO_FUN_I2C
- 配置 ``I2C`` 设备复用引脚，见 ``bsp/board/bl706_iot/peripheral_config.h``
- 配置 ``I2C`` 设备复用引脚，见 ``bsp/board/bl706_iot/pinmux_config.h``
.. code-block:: C
:linenos:
@ -56,7 +56,7 @@ I2C - AT24CXX 读写
.. code-block:: C
:linenos:
i2c_register(I2C0_INDEX, "i2c", DEVICE_OFLAG_RDWR);
i2c_register(I2C0_INDEX, "i2c");
struct device *i2c0 = device_find("i2c");
if (i2c0)

2
docs/development_guide/source/samples/basic samples/pwm/pwm_breath_demo.rst
View file

@ -59,7 +59,7 @@ PWM - 呼吸灯
.. code-block:: C
:linenos:
pwm_register(PWM_CH2_INDEX, "led_breath", DEVICE_OFLAG_RDWR);
pwm_register(PWM_CH2_INDEX, "led_breath");
struct device *led_breath = device_find("led_breath");

8
docs/development_guide/source/samples/basic samples/pwm/pwm_step_motor.rst
View file

@ -151,10 +151,10 @@ PWM - 驱动步进电机
.. code-block:: C
:linenos:
pwm_register(PWM_CH0_INDEX, "motor_ch0", DEVICE_OFLAG_RDWR);
pwm_register(PWM_CH1_INDEX, "motor_ch1", DEVICE_OFLAG_RDWR);
pwm_register(PWM_CH2_INDEX, "motor_ch2", DEVICE_OFLAG_RDWR);
pwm_register(PWM_CH3_INDEX, "motor_ch3", DEVICE_OFLAG_RDWR);
pwm_register(PWM_CH0_INDEX, "motor_ch0");
pwm_register(PWM_CH1_INDEX, "motor_ch1");
pwm_register(PWM_CH2_INDEX, "motor_ch2");
pwm_register(PWM_CH3_INDEX, "motor_ch3");
motor_ch0 = device_find("motor_ch0");
motor_ch1 = device_find("motor_ch1");

2
docs/development_guide/source/samples/basic samples/spi/spi_lcd_demo.rst
View file

@ -80,7 +80,7 @@ SPI - TFT LCD 显示
device_close(spi0);
}
else{
spi_register(SPI0_INDEX,"spi0",DEVICE_OFLAG_RDWR);
spi_register(SPI0_INDEX,"spi0");
spi0 = device_find("spi0");
}
if(spi0)

2
docs/development_guide/source/samples/basic samples/uart/uart_loopback_demo.rst
View file

@ -67,7 +67,7 @@ UART - 数据自收发
.. code-block:: C
:linenos:
uart_register(board_get_debug_uart_index(), "debug_log", DEVICE_OFLAG_RDWR);
uart_register(board_get_debug_uart_index(), "debug_log");
struct device *uart = device_find("debug_log");
if (uart)