Doubea Pierre / Mbed 2 deprecated HW3

Lab Checkoff

Dependencies:   SDFileSystem TextLCD mbed-rtos mbed wave_player FATFileSystem

mbed-rtos/rtx/rt_Mailbox.c@0:67dbd54e60d4, 2013-11-13 (annotated)

Committer:
doubster
Date:
Wed Nov 13 20:00:28 2013 +0000
Revision:
0:67dbd54e60d4
Lab Checkoff

Who changed what in which revision?

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