2 * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
\r
3 * All rights reserved.
\r
5 * Redistribution and use in source and binary forms, with or without modification,
\r
6 * are permitted provided that the following conditions are met:
\r
8 * 1. Redistributions of source code must retain the above copyright notice,
\r
9 * this list of conditions and the following disclaimer.
\r
10 * 2. Redistributions in binary form must reproduce the above copyright notice,
\r
11 * this list of conditions and the following disclaimer in the documentation
\r
12 * and/or other materials provided with the distribution.
\r
13 * 3. The name of the author may not be used to endorse or promote products
\r
14 * derived from this software without specific prior written permission.
\r
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
\r
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
\r
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
\r
19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
\r
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
\r
21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
\r
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
\r
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
\r
24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
\r
27 * This file is part of the lwIP TCP/IP stack.
\r
29 * Author: Adam Dunkels <adam@sics.se>
\r
33 //*****************************************************************************
\r
35 // Include OS functionality.
\r
37 //*****************************************************************************
\r
39 /* ------------------------ System architecture includes ----------------------------- */
\r
40 #include "arch/sys_arch.h"
\r
42 /* ------------------------ lwIP includes --------------------------------- */
\r
43 #include "lwip/opt.h"
\r
45 #include "lwip/debug.h"
\r
46 #include "lwip/def.h"
\r
47 #include "lwip/sys.h"
\r
48 #include "lwip/mem.h"
\r
49 #include "lwip/stats.h"
\r
51 /* Very crude mechanism used to determine if the critical section handling
\r
52 functions are being called from an interrupt context or not. This relies on
\r
53 the interrupt handler setting this variable manually. */
\r
54 BaseType_t xInsideISR = pdFALSE;
\r
56 /*---------------------------------------------------------------------------*
\r
57 * Routine: sys_mbox_new
\r
58 *---------------------------------------------------------------------------*
\r
60 * Creates a new mailbox
\r
62 * int size -- Size of elements in the mailbox
\r
64 * sys_mbox_t -- Handle to new mailbox
\r
65 *---------------------------------------------------------------------------*/
\r
66 err_t sys_mbox_new( sys_mbox_t *pxMailBox, int iSize )
\r
68 err_t xReturn = ERR_MEM;
\r
70 *pxMailBox = xQueueCreate( iSize, sizeof( void * ) );
\r
72 if( *pxMailBox != NULL )
\r
75 SYS_STATS_INC_USED( mbox );
\r
82 /*---------------------------------------------------------------------------*
\r
83 * Routine: sys_mbox_free
\r
84 *---------------------------------------------------------------------------*
\r
86 * Deallocates a mailbox. If there are messages still present in the
\r
87 * mailbox when the mailbox is deallocated, it is an indication of a
\r
88 * programming error in lwIP and the developer should be notified.
\r
90 * sys_mbox_t mbox -- Handle of mailbox
\r
92 * sys_mbox_t -- Handle to new mailbox
\r
93 *---------------------------------------------------------------------------*/
\r
94 void sys_mbox_free( sys_mbox_t *pxMailBox )
\r
96 unsigned long ulMessagesWaiting;
\r
98 ulMessagesWaiting = uxQueueMessagesWaiting( *pxMailBox );
\r
99 configASSERT( ( ulMessagesWaiting == 0 ) );
\r
103 if( ulMessagesWaiting != 0UL )
\r
105 SYS_STATS_INC( mbox.err );
\r
108 SYS_STATS_DEC( mbox.used );
\r
110 #endif /* SYS_STATS */
\r
112 vQueueDelete( *pxMailBox );
\r
115 /*---------------------------------------------------------------------------*
\r
116 * Routine: sys_mbox_post
\r
117 *---------------------------------------------------------------------------*
\r
119 * Post the "msg" to the mailbox.
\r
121 * sys_mbox_t mbox -- Handle of mailbox
\r
122 * void *data -- Pointer to data to post
\r
123 *---------------------------------------------------------------------------*/
\r
124 void sys_mbox_post( sys_mbox_t *pxMailBox, void *pxMessageToPost )
\r
126 while( xQueueSendToBack( *pxMailBox, &pxMessageToPost, portMAX_DELAY ) != pdTRUE );
\r
129 /*---------------------------------------------------------------------------*
\r
130 * Routine: sys_mbox_trypost
\r
131 *---------------------------------------------------------------------------*
\r
133 * Try to post the "msg" to the mailbox. Returns immediately with
\r
136 * sys_mbox_t mbox -- Handle of mailbox
\r
137 * void *msg -- Pointer to data to post
\r
139 * err_t -- ERR_OK if message posted, else ERR_MEM
\r
141 *---------------------------------------------------------------------------*/
\r
142 err_t sys_mbox_trypost( sys_mbox_t *pxMailBox, void *pxMessageToPost )
\r
145 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
147 if( xInsideISR != pdFALSE )
\r
149 xReturn = xQueueSendFromISR( *pxMailBox, &pxMessageToPost, &xHigherPriorityTaskWoken );
\r
150 portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
\r
154 xReturn = xQueueSend( *pxMailBox, &pxMessageToPost, ( TickType_t ) 0 );
\r
157 if( xReturn == pdPASS )
\r
163 /* The queue was already full. */
\r
165 SYS_STATS_INC( mbox.err );
\r
171 /*---------------------------------------------------------------------------*
\r
172 * Routine: sys_arch_mbox_fetch
\r
173 *---------------------------------------------------------------------------*
\r
175 * Blocks the thread until a message arrives in the mailbox, but does
\r
176 * not block the thread longer than "timeout" milliseconds (similar to
\r
177 * the sys_arch_sem_wait() function). The "msg" argument is a result
\r
178 * parameter that is set by the function (i.e., by doing "*msg =
\r
179 * ptr"). The "msg" parameter maybe NULL to indicate that the message
\r
180 * should be dropped.
\r
182 * The return values are the same as for the sys_arch_sem_wait() function:
\r
183 * Number of milliseconds spent waiting or SYS_ARCH_TIMEOUT if there was a
\r
186 * Note that a function with a similar name, sys_mbox_fetch(), is
\r
187 * implemented by lwIP.
\r
189 * sys_mbox_t mbox -- Handle of mailbox
\r
190 * void **msg -- Pointer to pointer to msg received
\r
191 * u32_t timeout -- Number of milliseconds until timeout
\r
193 * u32_t -- SYS_ARCH_TIMEOUT if timeout, else number
\r
194 * of milliseconds until received.
\r
195 *---------------------------------------------------------------------------*/
\r
196 u32_t sys_arch_mbox_fetch( sys_mbox_t *pxMailBox, void **ppvBuffer, u32_t ulTimeOut )
\r
199 TickType_t xStartTime, xEndTime, xElapsed;
\r
200 unsigned long ulReturn;
\r
202 xStartTime = xTaskGetTickCount();
\r
204 if( NULL == ppvBuffer )
\r
206 ppvBuffer = &pvDummy;
\r
209 if( ulTimeOut != 0UL )
\r
211 configASSERT( xInsideISR == ( portBASE_TYPE ) 0 );
\r
213 if( pdTRUE == xQueueReceive( *pxMailBox, &( *ppvBuffer ), ulTimeOut/ portTICK_PERIOD_MS ) )
\r
215 xEndTime = xTaskGetTickCount();
\r
216 xElapsed = ( xEndTime - xStartTime ) * portTICK_PERIOD_MS;
\r
218 ulReturn = xElapsed;
\r
224 ulReturn = SYS_ARCH_TIMEOUT;
\r
229 while( pdTRUE != xQueueReceive( *pxMailBox, &( *ppvBuffer ), portMAX_DELAY ) );
\r
230 xEndTime = xTaskGetTickCount();
\r
231 xElapsed = ( xEndTime - xStartTime ) * portTICK_PERIOD_MS;
\r
233 if( xElapsed == 0UL )
\r
238 ulReturn = xElapsed;
\r
244 /*---------------------------------------------------------------------------*
\r
245 * Routine: sys_arch_mbox_tryfetch
\r
246 *---------------------------------------------------------------------------*
\r
248 * Similar to sys_arch_mbox_fetch, but if message is not ready
\r
249 * immediately, we'll return with SYS_MBOX_EMPTY. On success, 0 is
\r
252 * sys_mbox_t mbox -- Handle of mailbox
\r
253 * void **msg -- Pointer to pointer to msg received
\r
255 * u32_t -- SYS_MBOX_EMPTY if no messages. Otherwise,
\r
257 *---------------------------------------------------------------------------*/
\r
258 u32_t sys_arch_mbox_tryfetch( sys_mbox_t *pxMailBox, void **ppvBuffer )
\r
261 unsigned long ulReturn;
\r
263 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
265 if( ppvBuffer== NULL )
\r
267 ppvBuffer = &pvDummy;
\r
270 if( xInsideISR != pdFALSE )
\r
272 lResult = xQueueReceiveFromISR( *pxMailBox, &( *ppvBuffer ), &xHigherPriorityTaskWoken );
\r
273 portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
\r
277 lResult = xQueueReceive( *pxMailBox, &( *ppvBuffer ), 0UL );
\r
280 if( lResult == pdPASS )
\r
286 ulReturn = SYS_MBOX_EMPTY;
\r
292 /*---------------------------------------------------------------------------*
\r
293 * Routine: sys_sem_new
\r
294 *---------------------------------------------------------------------------*
\r
296 * Creates and returns a new semaphore. The "ucCount" argument specifies
\r
297 * the initial state of the semaphore.
\r
298 * NOTE: Currently this routine only creates counts of 1 or 0
\r
300 * sys_mbox_t mbox -- Handle of mailbox
\r
301 * u8_t ucCount -- Initial ucCount of semaphore (1 or 0)
\r
303 * sys_sem_t -- Created semaphore or 0 if could not create.
\r
304 *---------------------------------------------------------------------------*/
\r
305 err_t sys_sem_new( sys_sem_t *pxSemaphore, u8_t ucCount )
\r
307 err_t xReturn = ERR_MEM;
\r
309 //vSemaphoreCreateBinary( ( *pxSemaphore ) );
\r
310 *pxSemaphore = xSemaphoreCreateCounting( 0xffff, ( unsigned long ) ucCount );
\r
312 if( *pxSemaphore != NULL )
\r
314 if( ucCount == 0U )
\r
316 // xSemaphoreTake( *pxSemaphore, 1UL );
\r
320 SYS_STATS_INC_USED( sem );
\r
324 SYS_STATS_INC( sem.err );
\r
330 /*---------------------------------------------------------------------------*
\r
331 * Routine: sys_arch_sem_wait
\r
332 *---------------------------------------------------------------------------*
\r
334 * Blocks the thread while waiting for the semaphore to be
\r
335 * signaled. If the "timeout" argument is non-zero, the thread should
\r
336 * only be blocked for the specified time (measured in
\r
339 * If the timeout argument is non-zero, the return value is the number of
\r
340 * milliseconds spent waiting for the semaphore to be signaled. If the
\r
341 * semaphore wasn't signaled within the specified time, the return value is
\r
342 * SYS_ARCH_TIMEOUT. If the thread didn't have to wait for the semaphore
\r
343 * (i.e., it was already signaled), the function may return zero.
\r
345 * Notice that lwIP implements a function with a similar name,
\r
346 * sys_sem_wait(), that uses the sys_arch_sem_wait() function.
\r
348 * sys_sem_t sem -- Semaphore to wait on
\r
349 * u32_t timeout -- Number of milliseconds until timeout
\r
351 * u32_t -- Time elapsed or SYS_ARCH_TIMEOUT.
\r
352 *---------------------------------------------------------------------------*/
\r
353 u32_t sys_arch_sem_wait( sys_sem_t *pxSemaphore, u32_t ulTimeout )
\r
355 TickType_t xStartTime, xEndTime, xElapsed;
\r
356 unsigned long ulReturn;
\r
358 xStartTime = xTaskGetTickCount();
\r
360 if( ulTimeout != 0UL )
\r
362 if( xSemaphoreTake( *pxSemaphore, ulTimeout / portTICK_PERIOD_MS ) == pdTRUE )
\r
364 xEndTime = xTaskGetTickCount();
\r
365 xElapsed = (xEndTime - xStartTime) * portTICK_PERIOD_MS;
\r
366 ulReturn = xElapsed;
\r
370 ulReturn = SYS_ARCH_TIMEOUT;
\r
375 while( xSemaphoreTake( *pxSemaphore, portMAX_DELAY ) != pdTRUE );
\r
376 xEndTime = xTaskGetTickCount();
\r
377 xElapsed = ( xEndTime - xStartTime ) * portTICK_PERIOD_MS;
\r
379 if( xElapsed == 0UL )
\r
384 ulReturn = xElapsed;
\r
390 /** Create a new mutex
\r
391 * @param mutex pointer to the mutex to create
\r
392 * @return a new mutex */
\r
393 err_t sys_mutex_new( sys_mutex_t *pxMutex )
\r
395 err_t xReturn = ERR_MEM;
\r
397 *pxMutex = xSemaphoreCreateMutex();
\r
399 if( *pxMutex != NULL )
\r
402 SYS_STATS_INC_USED( mutex );
\r
406 SYS_STATS_INC( mutex.err );
\r
413 * @param mutex the mutex to lock */
\r
414 void sys_mutex_lock( sys_mutex_t *pxMutex )
\r
416 BaseType_t xGotSemaphore;
\r
417 BaseType_t xHigherPriorityTaskWoken = pdFALSE;
\r
419 if( xInsideISR == 0 )
\r
421 while( xSemaphoreTake( *pxMutex, portMAX_DELAY ) != pdPASS );
\r
425 xGotSemaphore = xSemaphoreTakeFromISR( *pxMutex, &xHigherPriorityTaskWoken );
\r
426 configASSERT( xGotSemaphore );
\r
427 portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
\r
429 /* Prevent compiler warnings if configASSERT() is not defined. */
\r
430 ( void ) xGotSemaphore;
\r
435 * @param mutex the mutex to unlock */
\r
436 void sys_mutex_unlock(sys_mutex_t *pxMutex )
\r
438 xSemaphoreGive( *pxMutex );
\r
442 /** Delete a semaphore
\r
443 * @param mutex the mutex to delete */
\r
444 void sys_mutex_free( sys_mutex_t *pxMutex )
\r
446 SYS_STATS_DEC( mutex.used );
\r
447 vQueueDelete( *pxMutex );
\r
451 /*---------------------------------------------------------------------------*
\r
452 * Routine: sys_sem_signal
\r
453 *---------------------------------------------------------------------------*
\r
455 * Signals (releases) a semaphore
\r
457 * sys_sem_t sem -- Semaphore to signal
\r
458 *---------------------------------------------------------------------------*/
\r
459 void sys_sem_signal( sys_sem_t *pxSemaphore )
\r
461 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
463 if( xInsideISR != pdFALSE )
\r
465 xSemaphoreGiveFromISR( *pxSemaphore, &xHigherPriorityTaskWoken );
\r
466 portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
\r
470 xSemaphoreGive( *pxSemaphore );
\r
474 /*---------------------------------------------------------------------------*
\r
475 * Routine: sys_sem_free
\r
476 *---------------------------------------------------------------------------*
\r
478 * Deallocates a semaphore
\r
480 * sys_sem_t sem -- Semaphore to free
\r
481 *---------------------------------------------------------------------------*/
\r
482 void sys_sem_free( sys_sem_t *pxSemaphore )
\r
484 SYS_STATS_DEC(sem.used);
\r
485 vQueueDelete( *pxSemaphore );
\r
488 /*---------------------------------------------------------------------------*
\r
489 * Routine: sys_init
\r
490 *---------------------------------------------------------------------------*
\r
492 * Initialize sys arch
\r
493 *---------------------------------------------------------------------------*/
\r
494 void sys_init(void)
\r
498 u32_t sys_now(void)
\r
500 return xTaskGetTickCount();
\r
503 /*---------------------------------------------------------------------------*
\r
504 * Routine: sys_thread_new
\r
505 *---------------------------------------------------------------------------*
\r
507 * Starts a new thread with priority "prio" that will begin its
\r
508 * execution in the function "thread()". The "arg" argument will be
\r
509 * passed as an argument to the thread() function. The id of the new
\r
510 * thread is returned. Both the id and the priority are system
\r
513 * char *name -- Name of thread
\r
514 * void (* thread)(void *arg) -- Pointer to function to run.
\r
515 * void *arg -- Argument passed into function
\r
516 * int stacksize -- Required stack amount in bytes
\r
517 * int prio -- Thread priority
\r
519 * sys_thread_t -- Pointer to per-thread timeouts.
\r
520 *---------------------------------------------------------------------------*/
\r
521 sys_thread_t sys_thread_new( const char *pcName, void( *pxThread )( void *pvParameters ), void *pvArg, int iStackSize, int iPriority )
\r
523 TaskHandle_t xCreatedTask;
\r
524 portBASE_TYPE xResult;
\r
525 sys_thread_t xReturn;
\r
527 xResult = xTaskCreate( pxThread, pcName, iStackSize, pvArg, iPriority, &xCreatedTask );
\r
529 if( xResult == pdPASS )
\r
531 xReturn = xCreatedTask;
\r
541 /*---------------------------------------------------------------------------*
\r
542 * Routine: sys_arch_protect
\r
543 *---------------------------------------------------------------------------*
\r
545 * This optional function does a "fast" critical region protection and
\r
546 * returns the previous protection level. This function is only called
\r
547 * during very short critical regions. An embedded system which supports
\r
548 * ISR-based drivers might want to implement this function by disabling
\r
549 * interrupts. Task-based systems might want to implement this by using
\r
550 * a mutex or disabling tasking. This function should support recursive
\r
551 * calls from the same task or interrupt. In other words,
\r
552 * sys_arch_protect() could be called while already protected. In
\r
553 * that case the return value indicates that it is already protected.
\r
555 * sys_arch_protect() is only required if your port is supporting an
\r
556 * operating system.
\r
558 * sys_prot_t -- Previous protection level (not used here)
\r
559 *---------------------------------------------------------------------------*/
\r
560 sys_prot_t sys_arch_protect( void )
\r
562 if( xInsideISR == pdFALSE )
\r
564 taskENTER_CRITICAL();
\r
566 return ( sys_prot_t ) 1;
\r
569 /*---------------------------------------------------------------------------*
\r
570 * Routine: sys_arch_unprotect
\r
571 *---------------------------------------------------------------------------*
\r
573 * This optional function does a "fast" set of critical region
\r
574 * protection to the value specified by pval. See the documentation for
\r
575 * sys_arch_protect() for more information. This function is only
\r
576 * required if your port is supporting an operating system.
\r
578 * sys_prot_t -- Previous protection level (not used here)
\r
579 *---------------------------------------------------------------------------*/
\r
580 void sys_arch_unprotect( sys_prot_t xValue )
\r
583 if( xInsideISR == pdFALSE )
\r
585 taskEXIT_CRITICAL();
\r
590 * Prints an assertion messages and aborts execution.
\r
592 void sys_assert( const char *pcMessage )
\r
600 /*-------------------------------------------------------------------------*
\r
601 * End of File: sys_arch.c
\r
602 *-------------------------------------------------------------------------*/
\r