mirror of
https://github.com/Fishwaldo/bl_mcu_sdk.git
synced 2025-07-18 18:58:38 +00:00
[docs] update doc
This commit is contained in:
parent
ee237e8197
commit
a703cb54ff
74 changed files with 74 additions and 128 deletions
|
@ -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**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
|
@ -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`` 有如下可选类型
|
||||
|
|
|
@ -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`` 有如下可选类型
|
||||
|
||||
|
|
|
@ -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`` 有如下可选类型
|
||||
|
||||
|
|
|
@ -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 有如下可选类型
|
||||
|
||||
|
|
|
@ -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`` 有如下可选类型
|
||||
|
||||
|
|
|
@ -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`` 有如下可选类型
|
||||
|
||||
|
|
|
@ -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`` 有如下可选类型
|
||||
|
||||
|
|
|
@ -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`` 有如下可选类型
|
||||
|
||||
|
|
|
@ -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**
|
||||
|
|
|
@ -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);
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue