Alan Ffrench / Mbed 2 deprecated Experiment_2_5

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

mbed-rtos/rtx/rt_Mailbox.c@0:52468b19aa21, 2020-07-29 (annotated)

Committer:
alanffrench
Date:
Wed Jul 29 18:51:38 2020 +0000
Revision:
0:52468b19aa21
Threads

Who changed what in which revision?

UserRevisionLine numberNew contents of line
alanffrench 0:52468b19aa21 1 /*----------------------------------------------------------------------------
alanffrench 0:52468b19aa21 2 * RL-ARM - RTX
alanffrench 0:52468b19aa21 3 *----------------------------------------------------------------------------
alanffrench 0:52468b19aa21 4 * Name: RT_MAILBOX.C
alanffrench 0:52468b19aa21 5 * Purpose: Implements waits and wake-ups for mailbox messages
alanffrench 0:52468b19aa21 6 * Rev.: V4.60
alanffrench 0:52468b19aa21 7 *----------------------------------------------------------------------------
alanffrench 0:52468b19aa21 8 *
alanffrench 0:52468b19aa21 9 * Copyright (c) 1999-2009 KEIL, 2009-2012 ARM Germany GmbH
alanffrench 0:52468b19aa21 10 * All rights reserved.
alanffrench 0:52468b19aa21 11 * Redistribution and use in source and binary forms, with or without
alanffrench 0:52468b19aa21 12 * modification, are permitted provided that the following conditions are met:
alanffrench 0:52468b19aa21 13 * - Redistributions of source code must retain the above copyright
alanffrench 0:52468b19aa21 14 * notice, this list of conditions and the following disclaimer.
alanffrench 0:52468b19aa21 15 * - Redistributions in binary form must reproduce the above copyright
alanffrench 0:52468b19aa21 16 * notice, this list of conditions and the following disclaimer in the
alanffrench 0:52468b19aa21 17 * documentation and/or other materials provided with the distribution.
alanffrench 0:52468b19aa21 18 * - Neither the name of ARM nor the names of its contributors may be used
alanffrench 0:52468b19aa21 19 * to endorse or promote products derived from this software without
alanffrench 0:52468b19aa21 20 * specific prior written permission.
alanffrench 0:52468b19aa21 21 *
alanffrench 0:52468b19aa21 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
alanffrench 0:52468b19aa21 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
alanffrench 0:52468b19aa21 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
alanffrench 0:52468b19aa21 25 * ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
alanffrench 0:52468b19aa21 26 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
alanffrench 0:52468b19aa21 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
alanffrench 0:52468b19aa21 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
alanffrench 0:52468b19aa21 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
alanffrench 0:52468b19aa21 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
alanffrench 0:52468b19aa21 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
alanffrench 0:52468b19aa21 32 * POSSIBILITY OF SUCH DAMAGE.
alanffrench 0:52468b19aa21 33 *---------------------------------------------------------------------------*/
alanffrench 0:52468b19aa21 34
alanffrench 0:52468b19aa21 35 #include "rt_TypeDef.h"
alanffrench 0:52468b19aa21 36 #include "RTX_Config.h"
alanffrench 0:52468b19aa21 37 #include "rt_System.h"
alanffrench 0:52468b19aa21 38 #include "rt_List.h"
alanffrench 0:52468b19aa21 39 #include "rt_Mailbox.h"
alanffrench 0:52468b19aa21 40 #include "rt_MemBox.h"
alanffrench 0:52468b19aa21 41 #include "rt_Task.h"
alanffrench 0:52468b19aa21 42 #include "rt_HAL_CM.h"
alanffrench 0:52468b19aa21 43
alanffrench 0:52468b19aa21 44
alanffrench 0:52468b19aa21 45 /*----------------------------------------------------------------------------
alanffrench 0:52468b19aa21 46 * Functions
alanffrench 0:52468b19aa21 47 *---------------------------------------------------------------------------*/
alanffrench 0:52468b19aa21 48
alanffrench 0:52468b19aa21 49
alanffrench 0:52468b19aa21 50 /*--------------------------- rt_mbx_init -----------------------------------*/
alanffrench 0:52468b19aa21 51
alanffrench 0:52468b19aa21 52 void rt_mbx_init (OS_ID mailbox, U16 mbx_size) {
alanffrench 0:52468b19aa21 53 /* Initialize a mailbox */
alanffrench 0:52468b19aa21 54 P_MCB p_MCB = mailbox;
alanffrench 0:52468b19aa21 55
alanffrench 0:52468b19aa21 56 p_MCB->cb_type = MCB;
alanffrench 0:52468b19aa21 57 p_MCB->state = 0;
alanffrench 0:52468b19aa21 58 p_MCB->isr_st = 0;
alanffrench 0:52468b19aa21 59 p_MCB->p_lnk = NULL;
alanffrench 0:52468b19aa21 60 p_MCB->first = 0;
alanffrench 0:52468b19aa21 61 p_MCB->last = 0;
alanffrench 0:52468b19aa21 62 p_MCB->count = 0;
alanffrench 0:52468b19aa21 63 p_MCB->size = (mbx_size + sizeof(void *) - sizeof(struct OS_MCB)) /
alanffrench 0:52468b19aa21 64 (U32)sizeof (void *);
alanffrench 0:52468b19aa21 65 }
alanffrench 0:52468b19aa21 66
alanffrench 0:52468b19aa21 67
alanffrench 0:52468b19aa21 68 /*--------------------------- rt_mbx_send -----------------------------------*/
alanffrench 0:52468b19aa21 69
alanffrench 0:52468b19aa21 70 OS_RESULT rt_mbx_send (OS_ID mailbox, void *p_msg, U16 timeout) {
alanffrench 0:52468b19aa21 71 /* Send message to a mailbox */
alanffrench 0:52468b19aa21 72 P_MCB p_MCB = mailbox;
alanffrench 0:52468b19aa21 73 P_TCB p_TCB;
alanffrench 0:52468b19aa21 74
alanffrench 0:52468b19aa21 75 if ((p_MCB->p_lnk != NULL) && (p_MCB->state == 1)) {
alanffrench 0:52468b19aa21 76 /* A task is waiting for message */
alanffrench 0:52468b19aa21 77 p_TCB = rt_get_first ((P_XCB)p_MCB);
alanffrench 0:52468b19aa21 78 #ifdef __CMSIS_RTOS
alanffrench 0:52468b19aa21 79 rt_ret_val2(p_TCB, 0x10/*osEventMessage*/, (U32)p_msg);
alanffrench 0:52468b19aa21 80 #else
alanffrench 0:52468b19aa21 81 *p_TCB->msg = p_msg;
alanffrench 0:52468b19aa21 82 rt_ret_val (p_TCB, OS_R_MBX);
alanffrench 0:52468b19aa21 83 #endif
alanffrench 0:52468b19aa21 84 rt_rmv_dly (p_TCB);
alanffrench 0:52468b19aa21 85 rt_dispatch (p_TCB);
alanffrench 0:52468b19aa21 86 }
alanffrench 0:52468b19aa21 87 else {
alanffrench 0:52468b19aa21 88 /* Store message in mailbox queue */
alanffrench 0:52468b19aa21 89 if (p_MCB->count == p_MCB->size) {
alanffrench 0:52468b19aa21 90 /* No free message entry, wait for one. If message queue is full, */
alanffrench 0:52468b19aa21 91 /* then no task is waiting for message. The 'p_MCB->p_lnk' list */
alanffrench 0:52468b19aa21 92 /* pointer can now be reused for send message waits task list. */
alanffrench 0:52468b19aa21 93 if (timeout == 0) {
alanffrench 0:52468b19aa21 94 return (OS_R_TMO);
alanffrench 0:52468b19aa21 95 }
alanffrench 0:52468b19aa21 96 if (p_MCB->p_lnk != NULL) {
alanffrench 0:52468b19aa21 97 rt_put_prio ((P_XCB)p_MCB, os_tsk.run);
alanffrench 0:52468b19aa21 98 }
alanffrench 0:52468b19aa21 99 else {
alanffrench 0:52468b19aa21 100 p_MCB->p_lnk = os_tsk.run;
alanffrench 0:52468b19aa21 101 os_tsk.run->p_lnk = NULL;
alanffrench 0:52468b19aa21 102 os_tsk.run->p_rlnk = (P_TCB)p_MCB;
alanffrench 0:52468b19aa21 103 /* Task is waiting to send a message */
alanffrench 0:52468b19aa21 104 p_MCB->state = 2;
alanffrench 0:52468b19aa21 105 }
alanffrench 0:52468b19aa21 106 os_tsk.run->msg = p_msg;
alanffrench 0:52468b19aa21 107 rt_block (timeout, WAIT_MBX);
alanffrench 0:52468b19aa21 108 return (OS_R_TMO);
alanffrench 0:52468b19aa21 109 }
alanffrench 0:52468b19aa21 110 /* Yes, there is a free entry in a mailbox. */
alanffrench 0:52468b19aa21 111 p_MCB->msg[p_MCB->first] = p_msg;
alanffrench 0:52468b19aa21 112 rt_inc (&p_MCB->count);
alanffrench 0:52468b19aa21 113 if (++p_MCB->first == p_MCB->size) {
alanffrench 0:52468b19aa21 114 p_MCB->first = 0;
alanffrench 0:52468b19aa21 115 }
alanffrench 0:52468b19aa21 116 }
alanffrench 0:52468b19aa21 117 return (OS_R_OK);
alanffrench 0:52468b19aa21 118 }
alanffrench 0:52468b19aa21 119
alanffrench 0:52468b19aa21 120
alanffrench 0:52468b19aa21 121 /*--------------------------- rt_mbx_wait -----------------------------------*/
alanffrench 0:52468b19aa21 122
alanffrench 0:52468b19aa21 123 OS_RESULT rt_mbx_wait (OS_ID mailbox, void **message, U16 timeout) {
alanffrench 0:52468b19aa21 124 /* Receive a message; possibly wait for it */
alanffrench 0:52468b19aa21 125 P_MCB p_MCB = mailbox;
alanffrench 0:52468b19aa21 126 P_TCB p_TCB;
alanffrench 0:52468b19aa21 127
alanffrench 0:52468b19aa21 128 /* If a message is available in the fifo buffer */
alanffrench 0:52468b19aa21 129 /* remove it from the fifo buffer and return. */
alanffrench 0:52468b19aa21 130 if (p_MCB->count) {
alanffrench 0:52468b19aa21 131 *message = p_MCB->msg[p_MCB->last];
alanffrench 0:52468b19aa21 132 if (++p_MCB->last == p_MCB->size) {
alanffrench 0:52468b19aa21 133 p_MCB->last = 0;
alanffrench 0:52468b19aa21 134 }
alanffrench 0:52468b19aa21 135 if ((p_MCB->p_lnk != NULL) && (p_MCB->state == 2)) {
alanffrench 0:52468b19aa21 136 /* A task is waiting to send message */
alanffrench 0:52468b19aa21 137 p_TCB = rt_get_first ((P_XCB)p_MCB);
alanffrench 0:52468b19aa21 138 #ifdef __CMSIS_RTOS
alanffrench 0:52468b19aa21 139 rt_ret_val(p_TCB, 0/*osOK*/);
alanffrench 0:52468b19aa21 140 #else
alanffrench 0:52468b19aa21 141 rt_ret_val(p_TCB, OS_R_OK);
alanffrench 0:52468b19aa21 142 #endif
alanffrench 0:52468b19aa21 143 p_MCB->msg[p_MCB->first] = p_TCB->msg;
alanffrench 0:52468b19aa21 144 if (++p_MCB->first == p_MCB->size) {
alanffrench 0:52468b19aa21 145 p_MCB->first = 0;
alanffrench 0:52468b19aa21 146 }
alanffrench 0:52468b19aa21 147 rt_rmv_dly (p_TCB);
alanffrench 0:52468b19aa21 148 rt_dispatch (p_TCB);
alanffrench 0:52468b19aa21 149 }
alanffrench 0:52468b19aa21 150 else {
alanffrench 0:52468b19aa21 151 rt_dec (&p_MCB->count);
alanffrench 0:52468b19aa21 152 }
alanffrench 0:52468b19aa21 153 return (OS_R_OK);
alanffrench 0:52468b19aa21 154 }
alanffrench 0:52468b19aa21 155 /* No message available: wait for one */
alanffrench 0:52468b19aa21 156 if (timeout == 0) {
alanffrench 0:52468b19aa21 157 return (OS_R_TMO);
alanffrench 0:52468b19aa21 158 }
alanffrench 0:52468b19aa21 159 if (p_MCB->p_lnk != NULL) {
alanffrench 0:52468b19aa21 160 rt_put_prio ((P_XCB)p_MCB, os_tsk.run);
alanffrench 0:52468b19aa21 161 }
alanffrench 0:52468b19aa21 162 else {
alanffrench 0:52468b19aa21 163 p_MCB->p_lnk = os_tsk.run;
alanffrench 0:52468b19aa21 164 os_tsk.run->p_lnk = NULL;
alanffrench 0:52468b19aa21 165 os_tsk.run->p_rlnk = (P_TCB)p_MCB;
alanffrench 0:52468b19aa21 166 /* Task is waiting to receive a message */
alanffrench 0:52468b19aa21 167 p_MCB->state = 1;
alanffrench 0:52468b19aa21 168 }
alanffrench 0:52468b19aa21 169 rt_block(timeout, WAIT_MBX);
alanffrench 0:52468b19aa21 170 #ifndef __CMSIS_RTOS
alanffrench 0:52468b19aa21 171 os_tsk.run->msg = message;
alanffrench 0:52468b19aa21 172 #endif
alanffrench 0:52468b19aa21 173 return (OS_R_TMO);
alanffrench 0:52468b19aa21 174 }
alanffrench 0:52468b19aa21 175
alanffrench 0:52468b19aa21 176
alanffrench 0:52468b19aa21 177 /*--------------------------- rt_mbx_check ----------------------------------*/
alanffrench 0:52468b19aa21 178
alanffrench 0:52468b19aa21 179 OS_RESULT rt_mbx_check (OS_ID mailbox) {
alanffrench 0:52468b19aa21 180 /* Check for free space in a mailbox. Returns the number of messages */
alanffrench 0:52468b19aa21 181 /* that can be stored to a mailbox. It returns 0 when mailbox is full. */
alanffrench 0:52468b19aa21 182 P_MCB p_MCB = mailbox;
alanffrench 0:52468b19aa21 183
alanffrench 0:52468b19aa21 184 return (p_MCB->size - p_MCB->count);
alanffrench 0:52468b19aa21 185 }
alanffrench 0:52468b19aa21 186
alanffrench 0:52468b19aa21 187
alanffrench 0:52468b19aa21 188 /*--------------------------- isr_mbx_send ----------------------------------*/
alanffrench 0:52468b19aa21 189
alanffrench 0:52468b19aa21 190 void isr_mbx_send (OS_ID mailbox, void *p_msg) {
alanffrench 0:52468b19aa21 191 /* Same function as "os_mbx_send", but to be called by ISRs. */
alanffrench 0:52468b19aa21 192 P_MCB p_MCB = mailbox;
alanffrench 0:52468b19aa21 193
alanffrench 0:52468b19aa21 194 rt_psq_enq (p_MCB, (U32)p_msg);
alanffrench 0:52468b19aa21 195 rt_psh_req ();
alanffrench 0:52468b19aa21 196 }
alanffrench 0:52468b19aa21 197
alanffrench 0:52468b19aa21 198
alanffrench 0:52468b19aa21 199 /*--------------------------- isr_mbx_receive -------------------------------*/
alanffrench 0:52468b19aa21 200
alanffrench 0:52468b19aa21 201 OS_RESULT isr_mbx_receive (OS_ID mailbox, void **message) {
alanffrench 0:52468b19aa21 202 /* Receive a message in the interrupt function. The interrupt function */
alanffrench 0:52468b19aa21 203 /* should not wait for a message since this would block the rtx os. */
alanffrench 0:52468b19aa21 204 P_MCB p_MCB = mailbox;
alanffrench 0:52468b19aa21 205
alanffrench 0:52468b19aa21 206 if (p_MCB->count) {
alanffrench 0:52468b19aa21 207 /* A message is available in the fifo buffer. */
alanffrench 0:52468b19aa21 208 *message = p_MCB->msg[p_MCB->last];
alanffrench 0:52468b19aa21 209 if (p_MCB->state == 2) {
alanffrench 0:52468b19aa21 210 /* A task is locked waiting to send message */
alanffrench 0:52468b19aa21 211 rt_psq_enq (p_MCB, 0);
alanffrench 0:52468b19aa21 212 rt_psh_req ();
alanffrench 0:52468b19aa21 213 }
alanffrench 0:52468b19aa21 214 rt_dec (&p_MCB->count);
alanffrench 0:52468b19aa21 215 if (++p_MCB->last == p_MCB->size) {
alanffrench 0:52468b19aa21 216 p_MCB->last = 0;
alanffrench 0:52468b19aa21 217 }
alanffrench 0:52468b19aa21 218 return (OS_R_MBX);
alanffrench 0:52468b19aa21 219 }
alanffrench 0:52468b19aa21 220 return (OS_R_OK);
alanffrench 0:52468b19aa21 221 }
alanffrench 0:52468b19aa21 222
alanffrench 0:52468b19aa21 223
alanffrench 0:52468b19aa21 224 /*--------------------------- rt_mbx_psh ------------------------------------*/
alanffrench 0:52468b19aa21 225
alanffrench 0:52468b19aa21 226 void rt_mbx_psh (P_MCB p_CB, void *p_msg) {
alanffrench 0:52468b19aa21 227 /* Store the message to the mailbox queue or pass it to task directly. */
alanffrench 0:52468b19aa21 228 P_TCB p_TCB;
alanffrench 0:52468b19aa21 229 void *mem;
alanffrench 0:52468b19aa21 230
alanffrench 0:52468b19aa21 231 if (p_CB->p_lnk != NULL) switch (p_CB->state) {
alanffrench 0:52468b19aa21 232 #ifdef __CMSIS_RTOS
alanffrench 0:52468b19aa21 233 case 3:
alanffrench 0:52468b19aa21 234 /* Task is waiting to allocate memory, remove it from the waiting list */
alanffrench 0:52468b19aa21 235 mem = rt_alloc_box(p_msg);
alanffrench 0:52468b19aa21 236 if (mem == NULL) break;
alanffrench 0:52468b19aa21 237 p_TCB = rt_get_first ((P_XCB)p_CB);
alanffrench 0:52468b19aa21 238 rt_ret_val(p_TCB, (U32)mem);
alanffrench 0:52468b19aa21 239 p_TCB->state = READY;
alanffrench 0:52468b19aa21 240 rt_rmv_dly (p_TCB);
alanffrench 0:52468b19aa21 241 rt_put_prio (&os_rdy, p_TCB);
alanffrench 0:52468b19aa21 242 break;
alanffrench 0:52468b19aa21 243 #endif
alanffrench 0:52468b19aa21 244 case 2:
alanffrench 0:52468b19aa21 245 /* Task is waiting to send a message, remove it from the waiting list */
alanffrench 0:52468b19aa21 246 p_TCB = rt_get_first ((P_XCB)p_CB);
alanffrench 0:52468b19aa21 247 #ifdef __CMSIS_RTOS
alanffrench 0:52468b19aa21 248 rt_ret_val(p_TCB, 0/*osOK*/);
alanffrench 0:52468b19aa21 249 #else
alanffrench 0:52468b19aa21 250 rt_ret_val(p_TCB, OS_R_OK);
alanffrench 0:52468b19aa21 251 #endif
alanffrench 0:52468b19aa21 252 p_CB->msg[p_CB->first] = p_TCB->msg;
alanffrench 0:52468b19aa21 253 rt_inc (&p_CB->count);
alanffrench 0:52468b19aa21 254 if (++p_CB->first == p_CB->size) {
alanffrench 0:52468b19aa21 255 p_CB->first = 0;
alanffrench 0:52468b19aa21 256 }
alanffrench 0:52468b19aa21 257 p_TCB->state = READY;
alanffrench 0:52468b19aa21 258 rt_rmv_dly (p_TCB);
alanffrench 0:52468b19aa21 259 rt_put_prio (&os_rdy, p_TCB);
alanffrench 0:52468b19aa21 260 break;
alanffrench 0:52468b19aa21 261 case 1:
alanffrench 0:52468b19aa21 262 /* Task is waiting for a message, pass the message to the task directly */
alanffrench 0:52468b19aa21 263 p_TCB = rt_get_first ((P_XCB)p_CB);
alanffrench 0:52468b19aa21 264 #ifdef __CMSIS_RTOS
alanffrench 0:52468b19aa21 265 rt_ret_val2(p_TCB, 0x10/*osEventMessage*/, (U32)p_msg);
alanffrench 0:52468b19aa21 266 #else
alanffrench 0:52468b19aa21 267 *p_TCB->msg = p_msg;
alanffrench 0:52468b19aa21 268 rt_ret_val (p_TCB, OS_R_MBX);
alanffrench 0:52468b19aa21 269 #endif
alanffrench 0:52468b19aa21 270 p_TCB->state = READY;
alanffrench 0:52468b19aa21 271 rt_rmv_dly (p_TCB);
alanffrench 0:52468b19aa21 272 rt_put_prio (&os_rdy, p_TCB);
alanffrench 0:52468b19aa21 273 break;
alanffrench 0:52468b19aa21 274 } else {
alanffrench 0:52468b19aa21 275 /* No task is waiting for a message, store it to the mailbox queue */
alanffrench 0:52468b19aa21 276 if (p_CB->count < p_CB->size) {
alanffrench 0:52468b19aa21 277 p_CB->msg[p_CB->first] = p_msg;
alanffrench 0:52468b19aa21 278 rt_inc (&p_CB->count);
alanffrench 0:52468b19aa21 279 if (++p_CB->first == p_CB->size) {
alanffrench 0:52468b19aa21 280 p_CB->first = 0;
alanffrench 0:52468b19aa21 281 }
alanffrench 0:52468b19aa21 282 }
alanffrench 0:52468b19aa21 283 else {
alanffrench 0:52468b19aa21 284 os_error (OS_ERR_MBX_OVF);
alanffrench 0:52468b19aa21 285 }
alanffrench 0:52468b19aa21 286 }
alanffrench 0:52468b19aa21 287 }
alanffrench 0:52468b19aa21 288
alanffrench 0:52468b19aa21 289 /*----------------------------------------------------------------------------
alanffrench 0:52468b19aa21 290 * end of file
alanffrench 0:52468b19aa21 291 *---------------------------------------------------------------------------*/
alanffrench 0:52468b19aa21 292