README.md
1# BearPi-HM_Nano开发板OpenHarmony内核编程开发——消息队列
2本示例将演示如何在BearPi-HM_Nano开发板上使用cmsis 2.0 接口通过消息队列进行线程之间交换消息。
3
4
5## MessageQueue API分析
6### osMessageQueueNew()
7
8```c
9osMessageQueueId_t osMessageQueueNew(uint32_t msg_count,uint32_t msg_size,const osMessageQueueAttr_t *attr)
10```
11**描述：**
12
13函数osMessageQueueNew创建并初始化一个消息队列对象。该函数返回消息队列对象标识符，如果出现错误则返回NULL，可以在RTOS启动(调用 osKernelStart)之前安全地调用该函数，也可以在内核初始化 (调用 osKernelInitialize)之前调用该函数。
14> **注意** :不能在中断服务调用该函数。
15
16
17**参数：**
18
19|参数名|描述|
20|:--|:------|
21| msg_count |队列中的最大消息数。 |
22| msg_size |最大消息大小(以字节为单位)。 |
23| attr |消息队列属性;空:默认值。 |
24
25### osMessageQueuePut()
26
27```c
28osStatus_t osMessageQueuePut(osMessageQueueId_t mq_id,const void *msg_ptr,uint8_t msg_prio,uint32_t timeout)
29```
30**描述：**
31函数osMessageQueuePut将msg_ptr指向的消息放入参数mq_id指定的消息队列中。
32
33> **注意** :如果参数timeout设置为0，可以从中断服务例程调用。
34
35
36**参数：**
37
38|参数名|描述|
39|:--|:------|
40| mq_id | 由osMessageQueueNew获得的消息队列ID。 |
41| msg_ptr | 要发送的消息。 |
42| msg_prio | 指优先级。 |
43| timeout | 超时值。 |
44
45### osMessageQueueGet()
46
47```c
48osStatus_t osMessageQueueGet(osMessageQueueId_t mq_id,void *msg_ptr,uint8_t *msg_prio,uint32_t timeout)
49```
50**描述：**
51函数osMessageQueueGet从参数mq_id指定的消息队列中检索消息，并将其保存到参数msg_ptr所指向的缓冲区中。
52
53> **注意** :如果参数timeout设置为0，可以从中断服务例程调用。
54
55
56**参数：**
57
58|参数名|描述|
59|:--|:------|
60| mq_id | 由osMessageQueueNew获得的消息队列ID。 |
61| msg_ptr | 指针指向队列中获取消息的缓冲区指针。 |
62| msg_prio | 指优先级。 |
63| timeout | 超时值。 |
64
65
66## 软件设计
67
68**主要代码分析**
69
70在MessageExample函数中，通过osMessageQueueNew()函数创建了消息队列ID，MsgQueue1Thread()函数中通过osMessageQueuePut()函数向消息队列中发送消息。在MsgQueue2Thread()函数中通过osMessageQueueGet()函数读取消息队列中的消息比打印出来。
71
72```c
73
74void MsgQueue1Thread(void)
75{
76 // do some work...
77 msg.buf = "Hello BearPi-HM_Nano!";
78 msg.idx = 0U;
79 while (1) {
80 osMessageQueuePut(g_msgQueueId, &msg, 0U, 0U);
81
82 // suspend thread
83 osThreadYield();
84 osDelay(THREAD_DELAY_1S);
85 }
86}
87
88void MsgQueue2Thread(void)
89{
90 osStatus_t status;
91
92 while (1) {
93 // wait for message
94 status = osMessageQueueGet(g_msgQueueId, &msg, NULL, osWaitForever);
95 if (status == osOK) {
96 printf("Message Queue Get msg:%s\n", msg.buf);
97 }
98 }
99}
100
101/**
102 * @brief Main Entry of the Message Example
103 *
104 */
105static void MessageExample(void)
106{
107 g_msgQueueId = osMessageQueueNew(MSGQUEUE_COUNT, MSGQUEUE_SIZE, NULL);
108 if (g_msgQueueId == NULL) {
109 printf("Failed to create Message Queue!\n");
110 }
111
112 osThreadAttr_t attr;
113
114 attr.attr_bits = 0U;
115 attr.cb_mem = NULL;
116 attr.cb_size = 0U;
117 attr.stack_mem = NULL;
118 attr.stack_size = THREAD_STACK_SIZE;
119 attr.priority = THREAD_PRIO;
120
121 attr.name = "MsgQueue1Thread";
122 if (osThreadNew(MsgQueue1Thread, NULL, &attr) == NULL) {
123 printf("Failed to create MsgQueue1Thread!\n");
124 }
125
126 attr.name = "MsgQueue2Thread";
127 if (osThreadNew(MsgQueue2Thread, NULL, &attr) == NULL) {
128 printf("Failed to create MsgQueue2Thread!\n");
129 }
130}
131
132```
133
134## 编译调试
135
136### 修改 BUILD.gn 文件
137
138修改 `device\bearpi\bearpi_hm_nano\app`路径下 BUILD.gn 文件，指定 `message_example` 参与编译。
139
140```r
141#"A1_kernal_thread:thread_example",
142#"A2_kernel_timer:timer_example",
143#"A3_kernel_event:event_example",
144#"A4_kernel_mutex:mutex_example",
145#"A5_kernel_semaphore:semaphore_example",
146"A6_kernel_message:message_example",
147```
148
149
150
151### 运行结果
152
153示例代码编译烧录代码后，按下开发板的RESET按键，通过串口助手查看日志，会打印从消息队列中获取的消息。
154```c
155Message Queue Get msg:Hello BearPi-HM_Nano!
156Message Queue Get msg:Hello BearPi-HM_Nano!
157Message Queue Get msg:Hello BearPi-HM_Nano!
158Message Queue Get msg:Hello BearPi-HM_Nano!
159Message Queue Get msg:Hello BearPi-HM_Nano!
160```
161