Select one of the symbols to view example projects that use it.
 
Outline
#include "lwip/debug.h"
#include "lwip/def.h"
#include "lwip/sys.h"
#include "lwip/mem.h"
#include "lwip/stats.h"
#include "cmsis_os.h"
errno
sys_mbox_new(sys_mbox_t *, int)
sys_mbox_free(sys_mbox_t *)
sys_mbox_post(sys_mbox_t *, void *)
sys_mbox_trypost(sys_mbox_t *, void *)
sys_mbox_trypost_fromisr(sys_mbox_t *, void *)
sys_arch_mbox_fetch(sys_mbox_t *, void **, u32_t)
sys_arch_mbox_tryfetch(sys_mbox_t *, void **)
sys_mbox_valid(sys_mbox_t *)
sys_mbox_set_invalid(sys_mbox_t *)
sys_sem_new(sys_sem_t *, u8_t)
sys_arch_sem_wait(sys_sem_t *, u32_t)
sys_sem_signal(sys_sem_t *)
sys_sem_free(sys_sem_t *)
sys_sem_valid(sys_sem_t *)
sys_sem_set_invalid(sys_sem_t *)
lwip_sys_mutex
os_mutex_def_lwip_sys_mutex
sys_init()
sys_mutex_new(sys_mutex_t *)
sys_mutex_free(sys_mutex_t *)
sys_mutex_lock(sys_mutex_t *)
sys_mutex_unlock(sys_mutex_t *)
sys_thread_new(const char *, lwip_thread_fn, void *, int, int)
sys_arch_protect()
sys_arch_unprotect(sys_prot_t)
Files
loading...
SourceVuSTM32 Libraries and SamplesLwIPsystem/OS/sys_arch.c
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * Copyright (c) 2001-2003 Swedish Institute of Computer Science. * All rights reserved. * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. The name of the author may not be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY * OF SUCH DAMAGE. * * This file is part of the lwIP TCP/IP stack. * * Author: Adam Dunkels <adam@sics.se> * *//* ... */ /* lwIP includes. */ #include "lwip/debug.h" #include "lwip/def.h" #include "lwip/sys.h" #include "lwip/mem.h" #include "lwip/stats.h" 5 includes #if !NO_SYS #include "cmsis_os.h" #if defined(LWIP_PROVIDE_ERRNO) int errno; #endif /*-----------------------------------------------------------------------------------*/ // Creates an empty mailbox. err_t sys_mbox_new(sys_mbox_t *mbox, int size) { #if (osCMSIS < 0x20000U) osMessageQDef(QUEUE, size, void *); *mbox = osMessageCreate(osMessageQ(QUEUE), NULL);/* ... */ #else *mbox = osMessageQueueNew(size, sizeof(void *), NULL); #endif #if SYS_STATS ++lwip_stats.sys.mbox.used; if(lwip_stats.sys.mbox.max < lwip_stats.sys.mbox.used) { lwip_stats.sys.mbox.max = lwip_stats.sys.mbox.used; }if (lwip_stats.sys.mbox.max < lwip_stats.sys.mbox.used) { ... } /* ... */#endif /* SYS_STATS */ if(*mbox == NULL) return ERR_MEM; return ERR_OK; }{ ... } /*-----------------------------------------------------------------------------------*/ /* Deallocates a mailbox. If there are messages still present in the mailbox when the mailbox is deallocated, it is an indication of a programming error in lwIP and the developer should be notified. *//* ... */ void sys_mbox_free(sys_mbox_t *mbox) { #if (osCMSIS < 0x20000U) if(osMessageWaiting(*mbox)) #else if(osMessageQueueGetCount(*mbox)) #endif { /* Line for breakpoint. Should never break here! */ portNOP(); #if SYS_STATS lwip_stats.sys.mbox.err++; #endif /* SYS_STATS */ ...} #if (osCMSIS < 0x20000U) osMessageDelete(*mbox); #else osMessageQueueDelete(*mbox); #endif #if SYS_STATS --lwip_stats.sys.mbox.used; #endif /* SYS_STATS */ }{ ... } /*-----------------------------------------------------------------------------------*/ // Posts the "msg" to the mailbox. void sys_mbox_post(sys_mbox_t *mbox, void *data) { #if (osCMSIS < 0x20000U) while(osMessagePut(*mbox, (uint32_t)data, osWaitForever) != osOK); #else while(osMessageQueuePut(*mbox, &data, 0, osWaitForever) != osOK); #endif }{ ... } /*-----------------------------------------------------------------------------------*/ // Try to post the "msg" to the mailbox. err_t sys_mbox_trypost(sys_mbox_t *mbox, void *msg) { err_t result; #if (osCMSIS < 0x20000U) if(osMessagePut(*mbox, (uint32_t)msg, 0) == osOK) #else if(osMessageQueuePut(*mbox, &msg, 0, 0) == osOK) #endif { result = ERR_OK; ...} else { // could not post, queue must be full result = ERR_MEM; #if SYS_STATS lwip_stats.sys.mbox.err++; #endif /* SYS_STATS */ }else { ... } return result; }{ ... } /*-----------------------------------------------------------------------------------*/ // Try to post the "msg" to the mailbox. err_t sys_mbox_trypost_fromisr(sys_mbox_t *mbox, void *msg) { return sys_mbox_trypost(mbox, msg); }{ ... } /*-----------------------------------------------------------------------------------*/ /* Blocks the thread until a message arrives in the mailbox, but does not block the thread longer than "timeout" milliseconds (similar to the sys_arch_sem_wait() function). The "msg" argument is a result parameter that is set by the function (i.e., by doing "*msg = ptr"). The "msg" parameter maybe NULL to indicate that the message should be dropped. The return values are the same as for the sys_arch_sem_wait() function: Number of milliseconds spent waiting or SYS_ARCH_TIMEOUT if there was a timeout. Note that a function with a similar name, sys_mbox_fetch(), is implemented by lwIP. *//* ... */ u32_t sys_arch_mbox_fetch(sys_mbox_t *mbox, void **msg, u32_t timeout) { #if (osCMSIS < 0x20000U) osEvent event; uint32_t starttime = osKernelSysTick();/* ... */ #else osStatus_t status; uint32_t starttime = osKernelGetTickCount();/* ... */ #endif if(timeout != 0) { #if (osCMSIS < 0x20000U) event = osMessageGet (*mbox, timeout); if(event.status == osEventMessage) { *msg = (void *)event.value.v; return (osKernelSysTick() - starttime); }if (event.status == osEventMessage) { ... } /* ... */#else status = osMessageQueueGet(*mbox, msg, 0, timeout); if (status == osOK) { return (osKernelGetTickCount() - starttime); }if (status == osOK) { ... } /* ... */#endif else { return SYS_ARCH_TIMEOUT; }else { ... } }if (timeout != 0) { ... } else { #if (osCMSIS < 0x20000U) event = osMessageGet (*mbox, osWaitForever); *msg = (void *)event.value.v; return (osKernelSysTick() - starttime);/* ... */ #else osMessageQueueGet(*mbox, msg, 0, osWaitForever ); return (osKernelGetTickCount() - starttime);/* ... */ #endif }else { ... } }{ ... } /*-----------------------------------------------------------------------------------*/ /* Similar to sys_arch_mbox_fetch, but if message is not ready immediately, we'll return with SYS_MBOX_EMPTY. On success, 0 is returned. *//* ... */ u32_t sys_arch_mbox_tryfetch(sys_mbox_t *mbox, void **msg) { #if (osCMSIS < 0x20000U) osEvent event; event = osMessageGet (*mbox, 0); if(event.status == osEventMessage) { *msg = (void *)event.value.v; #else if (osMessageQueueGet(*mbox, msg, 0, 0) == osOK) { #endif return ERR_OK; }if (osMessageQueueGet(*mbox, msg, 0, 0) == osOK) { ... } else { return SYS_MBOX_EMPTY; }else { ... } }{ ... } /*----------------------------------------------------------------------------------*/ int sys_mbox_valid(sys_mbox_t *mbox) { if (*mbox == SYS_MBOX_NULL) return 0; else return 1; }{ ... } /*-----------------------------------------------------------------------------------*/ void sys_mbox_set_invalid(sys_mbox_t *mbox) { *mbox = SYS_MBOX_NULL; }{ ... } /*-----------------------------------------------------------------------------------*/ // Creates a new semaphore. The "count" argument specifies // the initial state of the semaphore. err_t sys_sem_new(sys_sem_t *sem, u8_t count) { #if (osCMSIS < 0x20000U) osSemaphoreDef(SEM); *sem = osSemaphoreCreate (osSemaphore(SEM), 1);/* ... */ #else *sem = osSemaphoreNew(UINT16_MAX, count, NULL); #endif if(*sem == NULL) { #if SYS_STATS ++lwip_stats.sys.sem.err; #endif /* SYS_STATS */ return ERR_MEM; }if (*sem == NULL) { ... } if(count == 0) // Means it can't be taken { #if (osCMSIS < 0x20000U) osSemaphoreWait(*sem, 0); #else osSemaphoreAcquire(*sem, 0); #endif ...} #if SYS_STATS ++lwip_stats.sys.sem.used; if (lwip_stats.sys.sem.max < lwip_stats.sys.sem.used) { lwip_stats.sys.sem.max = lwip_stats.sys.sem.used; }if (lwip_stats.sys.sem.max < lwip_stats.sys.sem.used) { ... } /* ... */#endif /* SYS_STATS */ return ERR_OK; }{ ... } /*-----------------------------------------------------------------------------------*/ /* Blocks the thread while waiting for the semaphore to be signaled. If the "timeout" argument is non-zero, the thread should only be blocked for the specified time (measured in milliseconds). If the timeout argument is non-zero, the return value is the number of milliseconds spent waiting for the semaphore to be signaled. If the semaphore wasn't signaled within the specified time, the return value is SYS_ARCH_TIMEOUT. If the thread didn't have to wait for the semaphore (i.e., it was already signaled), the function may return zero. Notice that lwIP implements a function with a similar name, sys_sem_wait(), that uses the sys_arch_sem_wait() function. *//* ... */ u32_t sys_arch_sem_wait(sys_sem_t *sem, u32_t timeout) { #if (osCMSIS < 0x20000U) uint32_t starttime = osKernelSysTick(); #else uint32_t starttime = osKernelGetTickCount(); #endif if(timeout != 0) { #if (osCMSIS < 0x20000U) if(osSemaphoreWait (*sem, timeout) == osOK) { return (osKernelSysTick() - starttime); #else if(osSemaphoreAcquire(*sem, timeout) == osOK) { return (osKernelGetTickCount() - starttime); #endif }if (osSemaphoreAcquire(*sem, timeout) == osOK) { ... } else { return SYS_ARCH_TIMEOUT; }else { ... } }if (osSemaphoreWait (*sem, timeout) == osOK) { ... } else { #if (osCMSIS < 0x20000U) while(osSemaphoreWait (*sem, osWaitForever) != osOK); return (osKernelSysTick() - starttime);/* ... */ #else while(osSemaphoreAcquire(*sem, osWaitForever) != osOK); return (osKernelGetTickCount() - starttime);/* ... */ #endif }else { ... } }{ ... } /*-----------------------------------------------------------------------------------*/ // Signals a semaphore void sys_sem_signal(sys_sem_t *sem) { osSemaphoreRelease(*sem); }{ ... } /*-----------------------------------------------------------------------------------*/ // Deallocates a semaphore void sys_sem_free(sys_sem_t *sem) { #if SYS_STATS --lwip_stats.sys.sem.used; #endif /* SYS_STATS */ osSemaphoreDelete(*sem); }{ ... } /*-----------------------------------------------------------------------------------*/ int sys_sem_valid(sys_sem_t *sem) { if (*sem == SYS_SEM_NULL) return 0; else return 1; }{ ... } /*-----------------------------------------------------------------------------------*/ void sys_sem_set_invalid(sys_sem_t *sem) { *sem = SYS_SEM_NULL; }{ ... } /*-----------------------------------------------------------------------------------*/ #if (osCMSIS < 0x20000U) osMutexId lwip_sys_mutex; osMutexDef(lwip_sys_mutex);/* ... */ #else osMutexId_t lwip_sys_mutex; #endif // Initialize sys arch void sys_init(void) { #if (osCMSIS < 0x20000U) lwip_sys_mutex = osMutexCreate(osMutex(lwip_sys_mutex)); #else lwip_sys_mutex = osMutexNew(NULL); #endif }{ ... } /*-----------------------------------------------------------------------------------*/ /* Mutexes*/ /*-----------------------------------------------------------------------------------*/ /*-----------------------------------------------------------------------------------*/ #if LWIP_COMPAT_MUTEX == 0 /* Create a new mutex*/ err_t sys_mutex_new(sys_mutex_t *mutex) { #if (osCMSIS < 0x20000U) osMutexDef(MUTEX); *mutex = osMutexCreate(osMutex(MUTEX));/* ... */ #else *mutex = osMutexNew(NULL); #endif if(*mutex == NULL) { #if SYS_STATS ++lwip_stats.sys.mutex.err; #endif /* SYS_STATS */ return ERR_MEM; }if (*mutex == NULL) { ... } #if SYS_STATS ++lwip_stats.sys.mutex.used; if (lwip_stats.sys.mutex.max < lwip_stats.sys.mutex.used) { lwip_stats.sys.mutex.max = lwip_stats.sys.mutex.used; }if (lwip_stats.sys.mutex.max < lwip_stats.sys.mutex.used) { ... } /* ... */#endif /* SYS_STATS */ return ERR_OK; }{ ... } /*-----------------------------------------------------------------------------------*/ /* Deallocate a mutex*/ void sys_mutex_free(sys_mutex_t *mutex) { #if SYS_STATS --lwip_stats.sys.mutex.used; #endif /* SYS_STATS */ osMutexDelete(*mutex); }{ ... } /*-----------------------------------------------------------------------------------*/ /* Lock a mutex*/ void sys_mutex_lock(sys_mutex_t *mutex) { #if (osCMSIS < 0x20000U) osMutexWait(*mutex, osWaitForever); #else osMutexAcquire(*mutex, osWaitForever); #endif }{ ... } /*-----------------------------------------------------------------------------------*/ /* Unlock a mutex*/ void sys_mutex_unlock(sys_mutex_t *mutex) { osMutexRelease(*mutex); }{ ... } #endif/* ... */ /*LWIP_COMPAT_MUTEX*/ /*-----------------------------------------------------------------------------------*/ // TODO /*-----------------------------------------------------------------------------------*/ /* Starts a new thread with priority "prio" that will begin its execution in the function "thread()". The "arg" argument will be passed as an argument to the thread() function. The id of the new thread is returned. Both the id and the priority are system dependent. *//* ... */ sys_thread_t sys_thread_new(const char *name, lwip_thread_fn thread , void *arg, int stacksize, int prio) { #if (osCMSIS < 0x20000U) const osThreadDef_t os_thread_def = { (char *)name, (os_pthread)thread, (osPriority)prio, 0, stacksize}; return osThreadCreate(&os_thread_def, arg);/* ... */ #else const osThreadAttr_t attributes = { .name = name, .stack_size = stacksize, .priority = (osPriority_t)prio, ...}; return osThreadNew(thread, arg, &attributes);/* ... */ #endif }{ ... } /* This optional function does a "fast" critical region protection and returns the previous protection level. This function is only called during very short critical regions. An embedded system which supports ISR-based drivers might want to implement this function by disabling interrupts. Task-based systems might want to implement this by using a mutex or disabling tasking. This function should support recursive calls from the same task or interrupt. In other words, sys_arch_protect() could be called while already protected. In that case the return value indicates that it is already protected. sys_arch_protect() is only required if your port is supporting an operating system. Note: This function is based on FreeRTOS API, because no equivalent CMSIS-RTOS API is available *//* ... */ sys_prot_t sys_arch_protect(void) { #if (osCMSIS < 0x20000U) osMutexWait(lwip_sys_mutex, osWaitForever); #else osMutexAcquire(lwip_sys_mutex, osWaitForever); #endif return (sys_prot_t)1; }{ ... } /* This optional function does a "fast" set of critical region protection to the value specified by pval. See the documentation for sys_arch_protect() for more information. This function is only required if your port is supporting an operating system. Note: This function is based on FreeRTOS API, because no equivalent CMSIS-RTOS API is available *//* ... */ void sys_arch_unprotect(sys_prot_t pval) { ( void ) pval; osMutexRelease(lwip_sys_mutex); }{ ... } /* ... */#endif /* !NO_SYS */
Details
Show:
from
Types: Columns:
This file uses the notable symbols shown below. Click anywhere in the file to view more details.