cc2640r2f:uart
差别
这里会显示出您选择的修订版和当前版本之间的差别。
| 两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 | ||
|
cc2640r2f:uart [2017/09/09 12:57] wuyl |
cc2640r2f:uart [2021/06/22 23:14] (当前版本) |
||
|---|---|---|---|
| 行 7: | 行 7: | ||
| ## 概述 ## | ## 概述 ## | ||
| - | UART 用于芯片和串行端口之间的数据传输。UART 驱动程序经过多层的封装简化了应用程序对 UART 外设的读写操作，应用程序开发者只需要调用封装好的驱动接口就可以操作串口进行读写了。当然 UART 也有多种操作模式，例如：阻塞、非阻塞、轮询以及文本/ | + | UART 用于芯片和串行端口之间的数据传输。UART 驱动程序经过多层的封装简化了应用程序对 UART 外设的读写操作，应用程序开发者只需要调用封装好的驱动接口就可以操作串口进行读写了。 |
| + | |||
| + | 当然 UART 也有多种操作模式，例如：阻塞、非阻塞、轮询以及文本/ | ||
| ## UART 驱动的分层实现 ## | ## UART 驱动的分层实现 ## | ||
| 行 13: | 行 15: | ||
| 虽然在应用层直接调用几个驱动接口就可操作 UART 进行读写，但是在驱动程序内部从接口函数到底层硬件操作是通过了多层封装的。如图 1 所示是 UART 驱动程序的分层实现图。 | 虽然在应用层直接调用几个驱动接口就可操作 UART 进行读写，但是在驱动程序内部从接口函数到底层硬件操作是通过了多层封装的。如图 1 所示是 UART 驱动程序的分层实现图。 | ||
| - | 图1 UART 驱动程序的分层实现 | + | 图1. UART 驱动程序的分层实现 |
| ` | 1. `void UART_init(void)` | ||
| + | |||
| * 函数功能：根据配置信息对UART模块进行初始化 | * 函数功能：根据配置信息对UART模块进行初始化 | ||
| * 形参：无 | * 形参：无 | ||
| * 返回值：无 | * 返回值：无 | ||
| - | * 注意事项：在调用此函数之前，UART_config参数必须配置完成，在调用该函数之后才能调用其他UART接口函数 | + | * 注意事项：在调用此函数之前，UART_config 参数必须配置完成，在调用该函数之后才能调用其他 UART 接口函数 |
| 2. `void UART_Params_init(UART_Params *params)` | 2. `void UART_Params_init(UART_Params *params)` | ||
| - | * 函数功能：将UART_Params结构体中的参数初始化为默认值 | + | |
| - | * 形参：`params`,UART_Params类型的结构体指针，存放UART的相关参数 | + | * 函数功能：将 UART_Params 结构体中的参数初始化为默认值 |
| + | * 形参： `params` | ||
| * 返回值：无 | * 返回值：无 | ||
| - | * 注意事项：该函数将UART_Params结构体中的参数全部初始化为默认值，在接下来的程序中你可以根据具体应用的需要修改这些参数值 | + | * 注意事项：该函数将 UART_Params 结构体中的参数全部初始化为默认值，在接下来的程序中你可以根据具体应用的需要修改这些参数值 |
| 3. `UART_Handle UART_open(uint_least8_t index, UART_Params *params)` | 3. `UART_Handle UART_open(uint_least8_t index, UART_Params *params)` | ||
| - | * 函数功能：初始化并打开指定的UART外设接口 | + | |
| - | * 形参：`index`UART外设接口的索引；`params`UART_Params类型的结构体指针，存放UART的相关参数 | + | * 函数功能：初始化并打开指定的 UART 外设接口 |
| - | * 返回值：`UART_Handle`如果成功打开UART外设接口就返回该接口配置数组（UART_config）的句柄,如果发生错误或者需要打开的UART外设接口已经被打开，则会返回NULL指针 | + | * 形参：`index` UART 外设接口的索引；`params` UART_Params 类型的结构体指针，存放 UART 的相关参数 |
| + | * 返回值：`UART_Handle` 如果成功打开UART 外设接口就返回该接口配置数组（UART_config）的句柄，如果发生错误或需要打开的 UART 外设接口已经被打开，则会返回 NULL 指针 | ||
| 4. `int_fast16_t UART_control(UART_Handle handle, uint_fast16_t cmd, void *arg)` | 4. `int_fast16_t UART_control(UART_Handle handle, uint_fast16_t cmd, void *arg)` | ||
| - | * 函数功能：通过给定的UART_Handle来处理相应的命令事务 | + | |
| - | * 形参：`handle`UART_open中返回的句柄；`cmd`需要处理的命令事务；`arg`不用命令事务可能需要的不同类型的参数指针 | + | * 函数功能：通过给定的 UART_Handle 来处理相应的命令事务 |
| - | * 返回值：处理特定命令返回的值，如果操作失败，会返回一个负值 | + | * 形参：`handle` UART_open 中返回的句柄；`cmd` 需要处理的命令事务；`arg` 不用命令事务可能需要的不同类型的参数指针 |
| - | * 注意事项：必须在UART_open调用之后才能调用此函数 | + | * 返回值：处理特定命令返回的值。如果操作失败，会返回一个负值 |
| + | * 注意事项：必须在 UART_open 调用之后才能调用此函数 | ||
| 5. `void UART_close(UART_Handle handle)` | 5. `void UART_close(UART_Handle handle)` | ||
| - | * 函数功能：关闭UART_Handle指定的UART外设接口 | + | |
| - | * 形参：`handle`从UART_open()中返回的UART外设接口配置数组的句柄，以此来关闭外设接口 | + | * 函数功能：关闭 UART_Handle 指定的 UART 外设接口 |
| + | * 形参：`handle` 从 UART_open() 中返回的 UART 外设接口配置数组的句柄，以此来关闭外设接口 | ||
| * 返回值：无 | * 返回值：无 | ||
| - | * 注意事项：必须在UART_open()调用之后才能调用此函数，在调用该函数之前必须先调用UART_readCancel()或UART_writeCancel()分别取消正在进行的异步读取或写入 | + | * 注意事项：必须在 UART_open() 调用之后才能调用此函数，在调用该函数之前必须先调用 UART_readCancel() 或 UART_writeCancel() |
| 6. `int_fast32_t UART_write(UART_Handle handle, const void *buffer, size_t size)` | 6. `int_fast32_t UART_write(UART_Handle handle, const void *buffer, size_t size)` | ||
| + | |||
| * 函数功能：通过使能中断来向串口写入数据 | * 函数功能：通过使能中断来向串口写入数据 | ||
| - | * 形参：`handle`UART_open中返回的句柄；`buffer`一个只读指针，其中包含了将要写入的数据；`size`需要写入数据的字节数 | + | * 形参：`handle`UART_open 中返回的句柄；`buffer` 一个只读指针，其中包含了将要写入的数据；`size` 需要写入数据的字节数 |
| - | * 返回值：返回已经写入串口的字节数，如果发生错误，则返回UART_ERROR. | + | * 返回值：返回已经写入串口的字节数，如果发生错误，则返回 UART_ERROR |
| - | * 注意事项：在UART_MODE_CALLBACK下返回值始终为0 | + | * 注意事项：在 UART_MODE_CALLBACK 下返回值始终为 0 |
| 7. `int_fast32_t UART_writePolling(UART_Handle handle, const void *buffer, size_t size)` | 7. `int_fast32_t UART_writePolling(UART_Handle handle, const void *buffer, size_t size)` | ||
| - | * 函数功能：利用轮询的方式写入数据，不使能中断，与UART_write()的使用是互斥的。 | + | |
| - | * 形参：`handle`从UART_open()中返回的UART外设接口配置数组的句柄; | + | * 函数功能：利用轮询的方式写入数据，不使能中断。与 UART_write() 的使用是互斥的 |
| - | * 返回值：返回已经写入UART外设接口的字节数，如果发生错误，则返回UART_ERROR. | + | * 形参：`handle` 从 UART_open() 中返回的 UART 外设接口配置数组的句柄; |
| - | * 注意事项：在所有的数据都被写入UART外设接口之前，该函数不会返回值 | + | * 返回值：返回已经写入 UART 外设接口的字节数。如果发生错误，则返回 UART_ERROR |
| + | * 注意事项：在所有的数据都被写入 UART 外设接口之前，该函数不会返回值 | ||
| 8. `void UART_writeCancel(UART_Handle handle)` | 8. `void UART_writeCancel(UART_Handle handle)` | ||
| - | * 函数功能：取消UART_write()函数调用的功能 | + | |
| - | * 形参：`handle`从UART_open()中返回的UART外设接口配置数组的句柄 | + | * 函数功能：取消 UART_write() 函数调用的功能 |
| + | * 形参：`handle` 从 UART_open() 中返回的 UART 外设接口配置数组的句柄 | ||
| * 返回值：无 | * 返回值：无 | ||
| - | * 注意事项：在函数只适用于在UART_MODE_CALLBACK模式下取消异步UART_write()操作。 | + | * 注意事项：函数只适用于在 UART_MODE_CALLBACK 模式下取消异步 UART_write() 操作。 |
| 9. `int_fast32_t UART_read(UART_Handle handle, void *buffer, size_t size)` | 9. `int_fast32_t UART_read(UART_Handle handle, void *buffer, size_t size)` | ||
| - | * 函数功能：通过使能中断来读取UART外设接口的数据 | + | |
| - | * 形参：`handle`从UART_open()中返回的UART外设接口配置数组的句柄; | + | * 函数功能：通过使能中断来读取 UART 外设接口的数据 |
| - | * 返回值：返回从UART外设接口读取的字节数，如果发生错误则返回UART_ERROR | + | * 形参：`handle` 从 UART_open() 中返回的UART外设接口配置数组的句柄; |
| - | * 注意事项：在**UART_MODE_BLOCKING**模式下，UART_read()会阻止任务的执行，直到缓冲区的数据被读完。在 | + | * 返回值：返回从 UART 外设接口读取的字节数。如果发生错误则返回 UART_ERROR |
| + | * 注意事项：在** UART_MODE_BLOCKING **模式下，UART_read() 会阻止任务的执行，直到缓冲区的数据被读完。在 | ||
| 10. `int_fast32_t UART_readPolling(UART_Handle handle, void *buffer, size_t size)` | 10. `int_fast32_t UART_readPolling(UART_Handle handle, void *buffer, size_t size)` | ||
| - | * 函数功能：使用轮询的方式读取数据，不使能中断，与UART_write()的使用是互斥的 | + | |
| - | * 形参：`handle`从UART_open()中返回的UART外设接口配置数组的句柄; | + | * 函数功能：使用轮询的方式读取数据，不使能中断，与 UART_write() 的使用是互斥的 |
| - | * 返回值：返回从UART外设接口读取的字节数，如果发生错误则返回UART_ERROR | + | * 形参：`handle` 从 UART_open() 中返回的 UART 外设接口配置数组的句柄; |
| - | * 注意事项：在指定的数据被读取完之前，UART_readPolling不会返回 | + | * 返回值：返回从 UART 外设接口读取的字节数。如果发生错误则返回 UART_ERROR |
| + | * 注意事项：在指定的数据被读取完之前，UART_readPolling 不会返回。 | ||
| 11. `void UART_readCancel(UART_Handle handle)` | 11. `void UART_readCancel(UART_Handle handle)` | ||
| - | * 函数功能：取消UART_read()函数的功能 | + | |
| - | * 形参：`handle`从UART_open()中返回的UART外设接口配置数组的句柄 | + | * 函数功能：取消 UART_read() 函数的功能 |
| + | * 形参：`handle` 从 UART_open() 中返回的 UART 外设接口配置数组的句柄 | ||
| * 返回值：无 | * 返回值：无 | ||
| - | * 注意事项：仅适用于在UART_MODE_CALLBACK模式下取消异步UART_read()函数的功能 | + | * 注意事项：仅适用于在 UART_MODE_CALLBACK 模式下取消异步 UART_read() 函数的功能。 |
| + | |||
| + | ## 利用 UART 串口实现数据的打印 ## | ||
| + | |||
| + | 接下来调用中间件层提供的 UART 接口建立一个独立的线程，实现 “hello world!” 的串口打印。这里直接给出主线程的接口调用例程，如清单4所示： | ||
| + | |||
| + | 清单4：UART 外设接口打印主线程代码实现 | ||
| - | ## 利用UART串口实现数据的打印 ## | ||
| - | 下面我们调用中间件层提供的UART接口来建立一个独立的线程，实现“hello world!”的串口打印。这里我们直接给出主线程的接口调用例程，如List4所示： | ||
| - | List4：UART外设接口打印主线程代码实现 | ||
| ```C | ```C | ||
| /* | /* | ||
| 行 222: | 行 243: | ||
| } | } | ||
| ``` | ``` | ||
| - | 1. 我们可以看到在**mainThread**中首先调用`UART_init()`来初始化UART外设接口配置，这里的配置信息是在配置文件CC2640R2_LAUNCHXL.c中设置的，上文**UART的驱动配置**中有讲到，所以在我们调用`UART_init()`之前，必须要在CC2640R2_LAUNCHXL.c中完成所有的配置。 | ||
| - | 2. 调用`UART_Params_init()`将uartParams结构体中的参数全部初始化为默认值。 | ||
| - | 3. 初始化UART_Params参数后，根据需要我们可以对一些参数进行重新赋值。 | ||
| - | 4. 在UART外设接口参数设置完成之后，我们就可以调用UART_open()来开启我们指定的UART外设接口了，这里我们需要指定某个定义的UART外设接口，在我们的例程中是打开的**Board_UART0**，如果指定UART外设接口打开成功，则会返回一个句柄，以后我们就通过这个句柄来执行UART外设接口的相关操作了。如果UART外设接口打开失败或者指定的UART外设接口已经被打开使用则会返回一个空指针。 | ||
| - | 5. 成功打开UART外设接口之后我们就可以操作UART外设接口读写数据了，这里我们首先调用`UART_write()`将字符串`hello world!`打印出来。然后进入无限循环一直执行接收串口数据，又将串口数据打印出来的操作。 | ||
| - | 下面我们看一下如何编译，利用串口工具调试串口功能: | + | 1. 可以看到，在** mainThread **中首先调用 `UART_init()` 来初始化 UART 外设接口配置，配置信息是在配置文件 CC2640R2_LAUNCHXL.c 中设置的。上文** UART 的驱动配置**中有讲到，在调用 `UART_init()` 之前，必须要在 CC2640R2_LAUNCHXL.c 中完成所有的配置。 |
| - | 1. 新建一个`.c`文件，将该段代码拷贝到`.c`文件中，这里我们给该`.c`文件命名为`uartdebug.c`。 | + | 2. 调用 `UART_Params_init()` 将 uartParams 结构体中的参数全部初始化为默认值。 |
| - | 2. 将`uartdebug.c`文件保存在`C: | + | 3. 初始化 UART_Params 参数后，根据需要对一些参数进行重新赋值。 |
| - | 3. 在`C: | + | 4. 在 UART 外设接口参数设置完成之后，就可以调用 UART_open() 开启指定的 UART 外设接口。这里需要指定某个定义的 UART 外设接口，在例程中打开的是** Board_UART0 **。如果指定 UART 外设接口打开成功，则会返回一个句柄，以后通过这个句柄就可以执行 UART 外设接口的相关操作。如果 UART 外设接口打开失败或者指定的 UART 外设接口已经被打开使用则会返回一个空指针。 |
| + | 5. 成功打开 UART 外设接口之后就能用 UART 外设接口读写数据了。首先调用 `UART_write()` 将字符串 `hello world!` 打印出来，然后进入无限循环一直执行接收串口数据，再将串口数据打印出来的操作。 | ||
| + | |||
| + | 下面看一下如何编译，先利用串口工具调试串口功能: | ||
| + | |||
| + | 1. 新建一个 `.c` 文件，将该段代码拷贝到 `.c` 文件中，假设给该 `.c` 文件命名为 `uartdebug.c` 。 | ||
| + | 2. 将 `uartdebug.c` 文件保存在 `C: | ||
| + | 3. 在 `C: | ||
| + | |||
| + | 图2. IAR 工程目录 | ||
| 
除额外注明的地方外，本维基上的内容按下列许可协议发布： CC Attribution-Share Alike 4.0 International
