iot_uart.h 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. #ifndef __IOT_UART_H__
  2. #define __IOT_UART_H__
  3. #include "iot_os.h"
  4. /**
  5. * @ingroup iot_sdk_device 外设接口
  6. * @{
  7. */
  8. /**
  9. * @defgroup iot_sdk_uart 串口接口
  10. * @{
  11. */
  12. /**@example uart/demo_uart.c
  13. * uart接口示例
  14. */
  15. /**打开uart
  16. *@param port: UART 编号
  17. *@param cfg: 配置信息
  18. *@return TRUE: 成功
  19. * FALSE: 失败
  20. **/
  21. BOOL iot_uart_open(
  22. E_AMOPENAT_UART_PORT port,
  23. T_AMOPENAT_UART_PARAM *cfg
  24. );
  25. /**关闭uart
  26. *@param port: UART 编号
  27. *@return TRUE: 成功
  28. * FALSE: 失败
  29. **/
  30. BOOL iot_uart_close(
  31. E_AMOPENAT_UART_PORT port
  32. );
  33. /**读uart
  34. *@param port: UART 编号
  35. *@param buf: 存储数据地址
  36. *@param bufLen: 存储空间长度
  37. *@param timeoutMs: 读取超时 ms
  38. *@return UINT32: 实际读取长度
  39. **/
  40. UINT32 iot_uart_read(
  41. E_AMOPENAT_UART_PORT port,
  42. UINT8* buf,
  43. UINT32 bufLen,
  44. UINT32 timeoutMs
  45. );
  46. /**写uart
  47. *@param port: UART 编号
  48. *@param buf: 写入数据地址
  49. *@param bufLen: 写入数据长度
  50. *@return UINT32: 实际读取长度
  51. **/
  52. UINT32 iot_uart_write(
  53. E_AMOPENAT_UART_PORT port,
  54. UINT8* buf,
  55. UINT32 bufLen
  56. );
  57. /** @}*/
  58. /** @}*/
  59. #endif