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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
/*
****************************************************************************
PROJECT : Drw2D driver
FILE : $Id: r_drw2d_os.h 14751 2017-09-25 04:27:33Z shinya.tomari $
============================================================================
DESCRIPTION
Driver for DRW2D
============================================================================
C O P Y R I G H T
============================================================================
Copyright (c) 2016
by
Renesas Electronics (Europe) GmbH.
Arcadiastrasse 10
D-40472 Duesseldorf
Germany
All rights reserved.
============================================================================
Purpose: only for testing, not for mass production
DISCLAIMER
LICENSEE has read, understood and accepted the terms and conditions defined in
the license agreement, especially the usage rights. In any case, it is
LICENSEE's responsibility to make sure that any user of the software complies
with the terms and conditions of the signed license agreement.
SAMPLE CODE is not part of the licensed software, as such it must not be used in
mass-production applications. It can only be used for evaluation and
demonstration purposes at customer's premises listed in the signed license
agreement.
****************************************************************************
*/
#ifndef R_DRW2D_OS_H_
#define R_DRW2D_OS_H_
#ifdef __cplusplus
extern "C" {
#endif
/* (note) Since the API must not use dynamic memory allocation we need to include the OS header
file(s) to reserve memory for OS objects (e.g. CRITICAL_SECTION).
*/
#if defined(R_DRW2D_OS_WIN32)
#include <windows.h>
#elif defined(R_DRW2D_OS_RENESAS)
#include <r_os_api.h>
#elif defined(R_DRW2D_OS_INTEGRITY)
/* Disable MISRA checks for GHS Integrity - it's already perfect by default ;) */
#if defined (__ghs__)
#pragma ghs startnomisra
#endif /* __ghs__ */
#include <INTEGRITY.h>
#include "r_typedefs.h"
#if defined (__ghs__)
#pragma ghs endnomisra
#endif
#elif defined(R_DRW2D_OS_NO_OS)
#else
#define R_DRW2D_OS_NO_OS
#endif
/***********************************************************
Title: DRW2D OS abstraction
DRW2D OS functions.
Declaration of DRW2D OS functions.
The generic DRW2D driver uses these functions. They have to be implemented
within the driver library for a concrete device. (e.g. D1L, D1M)
Support functions are functions that are not part of the driver itself
but they must be provided to integrate the driver on a particular board.
*/
/*******************************************************************************
Section: Global Defines
*/
/***********************************************************
Enum: r_drw2d_OS_Error_t
DRW2D OS abstraction layer error code.
Values:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_NOT_SUPPORTED - (Currently) unsupported feature
R_DRW2D_OS_ERR_PARAM_NOT_SUPPORTED - unsupported parameter
R_DRW2D_OS_ERR_THREAD_CREATE - Failed to create OS-specific thread
R_DRW2D_OS_ERR_THREAD_INFO - Invalid thread info
R_DRW2D_OS_ERR_THREAD_HANDLE - Invalid thread handle
R_DRW2D_OS_ERR_THREAD_TIMEOUT - Timeout while waiting for thread.
R_DRW2D_OS_ERR_THREAD_WAIT - Failed to wait for OS thread
R_DRW2D_OS_ERR_THREAD_DESTROY - Failed to destroy OS thread
R_DRW2D_OS_ERR_MUTEX_HANDLE - Invalid mutex handle
R_DRW2D_OS_ERR_MUTEX_CREATE - Failed to create mutex
R_DRW2D_OS_ERR_MUTEX_DESTROY - Failed to destroy mutex
R_DRW2D_OS_ERR_MUTEX_LOCK - Failed to lock mutex
R_DRW2D_OS_ERR_MUTEX_UNLOCK - Failed to unlock mutex
R_DRW2D_OS_ERR_SEM_HANDLE - Invalid semaphore handle
R_DRW2D_OS_ERR_SEM_CREATE - Failed to create semaphore
R_DRW2D_OS_ERR_SEM_DESTROY - Failed to destroy semaphore
R_DRW2D_OS_ERR_SEM_WAIT - Failed to wait for semaphore
R_DRW2D_OS_ERR_SEM_POST - Failed to post semaphore
*/
typedef enum
{
R_DRW2D_OS_ERR_OK,
R_DRW2D_OS_ERR_NOT_SUPPORTED,
R_DRW2D_OS_ERR_PARAM_NOT_SUPPORTED,
R_DRW2D_OS_ERR_THREAD_CREATE,
R_DRW2D_OS_ERR_THREAD_INFO,
R_DRW2D_OS_ERR_THREAD_HANDLE,
R_DRW2D_OS_ERR_THREAD_TIMEOUT,
R_DRW2D_OS_ERR_THREAD_WAIT,
R_DRW2D_OS_ERR_THREAD_DESTROY,
R_DRW2D_OS_ERR_MUTEX_HANDLE,
R_DRW2D_OS_ERR_MUTEX_CREATE,
R_DRW2D_OS_ERR_MUTEX_DESTROY,
R_DRW2D_OS_ERR_MUTEX_LOCK,
R_DRW2D_OS_ERR_MUTEX_UNLOCK,
R_DRW2D_OS_ERR_SEM_HANDLE,
R_DRW2D_OS_ERR_SEM_CREATE,
R_DRW2D_OS_ERR_SEM_DESTROY,
R_DRW2D_OS_ERR_SEM_WAIT,
R_DRW2D_OS_ERR_SEM_POST,
NUM_R_DRW2D_OS_ERR_CODES
} r_drw2d_OS_Error_t;
/***********************************************************
Enum: r_drw2d_OS_Mem_t
DRW2D framework OS abstraction layer memory allocation type.
Values:
R_DRW2D_OS_MEM_CPU - Memory to be used by the CPU only
R_DRW2D_OS_MEM_VIDEO - Memory to be used as video memory
*/
typedef enum
{
R_DRW2D_OS_MEM_CPU = 0,
R_DRW2D_OS_MEM_VIDEO = 1
} r_drw2d_OS_Mem_t;
/***********************************************************
Type: r_drw2d_OS_Thread_t
OS-specific thread handle type.
On R_OS, this will internally be cast to R_OS_Thread_t (uint32_t).
On Win32, this will internally be cast to HANDLE (void*).
On Linux, this will internally be cast to pthread_t.
*/
#if defined(R_DRW2D_OS_WIN32)
typedef HANDLE r_drw2d_OS_Thread_t;
#elif defined(R_DRW2D_OS_RENESAS)
typedef R_OS_Thread_t r_drw2d_OS_Thread_t;
#elif defined(R_DRW2D_OS_INTEGRITY)
typedef Task r_drw2d_OS_Thread_t;
#elif defined(R_DRW2D_OS_NO_OS)
#else
#error Unable to determine r_drw2d_OS_Thread_t
#endif
/***********************************************************
Type: r_drw2d_OS_ThreadId_t
Unique thread identifier.
May not necessarily be the same as the thread handle (<r_drw2d_OS_Thread_t>).
For example, when using pthreads, the pthread_t may be a structure (implementation dependent)
that cannot be casted to a void pointer.
See also:
<R_DRW2D_OS_Thread_GetId>
*/
typedef void *r_drw2d_OS_ThreadId_t;
/*******************************************************************************
Type: r_drw2d_OS_ThreadInfo_t
Structure that manages thread information.
*/
typedef struct r_drw2d_OS_ThreadInfo_s r_drw2d_OS_ThreadInfo_t;
/***********************************************************
Type: r_drw2d_OS_ThreadFxn_t
Thread function type.
*/
typedef void (*r_drw2d_OS_ThreadFxn_t) (r_drw2d_OS_ThreadInfo_t *ThreadInfo);
/***********************************************************
Type: r_drw2d_OS_Mutex_t
Abstract type representing an OS mutex .
*/
#if defined(R_DRW2D_OS_WIN32)
typedef CRITICAL_SECTION r_drw2d_OS_Mutex_t;
#elif defined(R_DRW2D_OS_RENESAS)
typedef R_OS_ThreadMutex_t r_drw2d_OS_Mutex_t;
#elif defined(R_DRW2D_OS_INTEGRITY)
typedef LocalMutex r_drw2d_OS_Mutex_t;
#elif defined(R_DRW2D_OS_NO_OS)
typedef void* r_drw2d_OS_Mutex_t;
#else
#error Unable to determine r_drw2d_OS_Mutex_t
#endif
/***********************************************************
Constant: R_DRW2D_OS_THREAD_WAIT_INFINITE
'Magic' timeout value for <R_DRW2D_OS_Thread_Wait>.
*/
#define R_DRW2D_OS_THREAD_WAIT_INFINITE 0
#ifndef R_DRW2D_OS_NO_OS
/*******************************************************************************
Type: r_drw2d_OS_ThreadInfo_s
Thread Information.
Will be passed to the thread entry function.
Members:
Function - Thread function
UserData - Pointer to User Data
Prio - Priority
StackAddr - Stack address
StackSize - Stack size
Thread - OS-specific thread handle or structure
Result - Result value of the thread function.
(The argument "RetVal" when calling the R_DRW2D_OS_Thread_Exit function is stored.)
*/
typedef struct r_drw2d_OS_ThreadInfo_s
{
r_drw2d_OS_ThreadFxn_t Function;
void * UserData;
uint32_t Prio;
void * StackAddr;
uint32_t StackSize;
r_drw2d_OS_Thread_t Thread;
void * Result;
} r_drw2d_OS_ThreadInfo_s_t;
#endif /* R_DRW2D_OS_NO_OS */
/*******************************************************************************
Type: r_drw2d_OS_Semaphore_t
*/
typedef struct
{
#if defined(R_DRW2D_OS_WIN32)
HANDLE Handle;
#elif defined(R_DRW2D_OS_RENESAS)
R_OS_Sem_t Sem;
#elif defined(R_DRW2D_OS_INTEGRITY)
Semaphore Sem;
#elif defined(R_DRW2D_OS_NO_OS)
int8_t unused;
#else
#error Unable to determine r_drw2d_OS_Semaphore_t
#endif
} r_drw2d_OS_Semaphore_t;
/***********************************************************
Section: Global Functions
*/
/***********************************************************
Group: Thread functions
*/
/***********************************************************
Function: R_DRW2D_OS_Thread_Create
Creates and starts a new thread.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function to create a thread.
Parameter:
ThreadInfo - Pointer to thread info.
The entry *Function* and *UserData* fields must be set.
Please set *Prio*, *StackAddr* and *StackSize* as necessary.
If there are NOT set, the default value is set from OS.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_THREAD_CREATE - Failed to create OS-specific thread
R_DRW2D_OS_ERR_THREAD_INFO - Invalid thread info
See also:
<R_DRW2D_OS_Thread_Wait>, <R_DRW2D_OS_Thread_Destroy>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Thread_Create (r_drw2d_OS_ThreadInfo_t *ThreadInfo);
/***********************************************************
Function: R_DRW2D_OS_Thread_Wait
Waits until the thread terminates or a time-out interval elapses.
Unless the function timed out, the return value of the thread function
will be stored in the *Result* field of the *ThreadInfo* structure.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that waits until the terminates or
a time-out interval elapses.
Parameter:
ThreadInfo - Pointer to thread info.
Timeout - Time-out in Milliseconds. 0 to wait indefinitely
(see <R_DRW2D_OS_THREAD_WAIT_INFINITE>).
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_THREAD_TIMEOUT - Timeout while waiting for thread.
See also:
<R_DRW2D_OS_Thread_Create>, <R_DRW2D_OS_Thread_Destroy>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Thread_Wait (r_drw2d_OS_ThreadInfo_t *ThreadInfo,
uint32_t Timeout
);
/***********************************************************
Function: R_DRW2D_OS_Thread_GetId
Get the unique identifier for the current thread.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that gets id of thread.
Parameter:
None
Return Value:
Unique identifier for the current thread
*/
r_drw2d_OS_ThreadId_t R_DRW2D_OS_Thread_GetId (void);
/***********************************************************
Function: R_DRW2D_OS_Thread_Sleep
Sleep for the given number of milliseconds.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that sleeps the thread.
Parameter:
MilliSeconds - Number of milliseconds to sleep
Return Value:
None
*/
void R_DRW2D_OS_Thread_Sleep (uint32_t MilliSeconds);
/***********************************************************
Function: R_DRW2D_OS_Thread_Exit
Terminate thread. Must be called from thread when terminate the thread.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that exits the thread.
Parameter:
ThreadInfo - Pointer to thread info.
RetVal - Return value. Stored in ThreadInfo->Result.
Return Value:
None
*/
void R_DRW2D_OS_Thread_Exit (r_drw2d_OS_ThreadInfo_t *ThreadInfo,
void *RetVal
);
/***********************************************************
Function: R_DRW2D_OS_Thread_Destroy
De-initializes a thread and destroys the OS specific thread handle.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that waits until the terminates.
Parameter:
ThreadInfo - Pointer to thread info.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_THREAD_WAIT - Failed to wait for OS thread.
R_DRW2D_OS_ERR_THREAD_HANDLE - Invalid thread handle.
R_DRW2D_OS_ERR_PARAM_NOT_SUPPORTED - unsupported parameter.
R_DRW2D_OS_ERR_THREAD_INFO - Invalid thread info.
See also:
<R_DRW2D_OS_Thread_Create>, <R_DRW2D_OS_Thread_Wait>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Thread_Destroy (r_drw2d_OS_ThreadInfo_t *ThreadInfo);
/***********************************************************
Group: Mutex functions
*/
/***********************************************************
Function: R_DRW2D_OS_Mutex_Create
Creates and initializes an OS mutex.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that creates the mutex.
Parameter:
Mutex - Reference to OS-specific mutex handle or structure, see <r_drw2d_OS_Mutex_t>.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
See also:
<R_DRW2D_OS_Mutex_Destroy>, <R_DRW2D_OS_Mutex_Lock>, <R_DRW2D_OS_Mutex_Unlock>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Mutex_Create (r_drw2d_OS_Mutex_t *Mutex);
/***********************************************************
Function: R_DRW2D_OS_Mutex_Destroy
Destroys a mutex.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that destroys the mutex.
Parameter:
Mutex - The mutex to be destroyed.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_MUTEX_DESTROY - Failed to destroy mutex.
See also:
<R_DRW2D_OS_Mutex_Create>, <R_DRW2D_OS_Mutex_Lock>, <R_DRW2D_OS_Mutex_Unlock>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Mutex_Destroy (r_drw2d_OS_Mutex_t *Mutex);
/***********************************************************
Function: R_DRW2D_OS_Mutex_Lock
Locks a mutex.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that locks the mutex.
Parameter:
Mutex - The mutex to be locked.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_MUTEX_LOCK - Failed to lock mutex.
R_DRW2D_OS_ERR_MUTEX_HANDLE - Invalid mutex handle.
See also:
<R_DRW2D_OS_Mutex_Create>, <R_DRW2D_OS_Mutex_Destroy>, <R_DRW2D_OS_Mutex_Unlock>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Mutex_Lock (r_drw2d_OS_Mutex_t *Mutex);
/***********************************************************
Function: R_DRW2D_OS_Mutex_Unlock
Unlocks a mutex.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that unlocks the mutex.
Parameter:
Mutex - The mutex to be unlocked.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_MUTEX_UNLOCK - Failed to unlock mutex.
R_DRW2D_OS_ERR_MUTEX_HANDLE - Invalid mutex handle.
See also:
<R_DRW2D_OS_Mutex_Create>, <R_DRW2D_OS_Mutex_Destroy>, <R_DRW2D_OS_Mutex_Lock>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Mutex_Unlock (r_drw2d_OS_Mutex_t *Mutex);
/***********************************************************
Group: Semaphore functions
*/
/***********************************************************
Function: R_DRW2D_OS_Semaphore_Create
Creates a semaphore.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that create the semaphore.
Parameter:
Sem - Location of the unnamed semaphore.
InitialValue - Initial value of the semaphore.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_SEM_CREATE - Failed to create semaphore.
R_DRW2D_OS_ERR_SEM_HANDLE - Invalid semaphore handle.
See also:
<R_DRW2D_OS_Semaphore_Destroy>, <R_DRW2D_OS_Semaphore_Wait>, <R_DRW2D_OS_Semaphore_Post>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Semaphore_Create (r_drw2d_OS_Semaphore_t *Sem,
uint32_t InitialValue
);
/***********************************************************
Function: R_DRW2D_OS_Semaphore_Destroy
Destroys a semaphore.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that destroys the semaphore.
Parameter:
Sem - Location of the unnamed semaphore.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_SEM_DESTROY - Failed to destroy semaphore.
R_DRW2D_OS_ERR_SEM_HANDLE - Invalid semaphore handle.
See also:
<R_DRW2D_OS_Semaphore_Create>, <R_DRW2D_OS_Semaphore_Wait>, <R_DRW2D_OS_Semaphore_Post>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Semaphore_Destroy (r_drw2d_OS_Semaphore_t *Sem);
/***********************************************************
Function: R_DRW2D_OS_Semaphore_Wait
Wait until semaphore can be decremented.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that waits until semaphore
can be decremented.
Parameter:
Sem - Location of the unnamed semaphore.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_SEM_WAIT - Failed to wait for semaphore.
R_DRW2D_OS_ERR_SEM_HANDLE - Invalid semaphore handle.
See also:
<R_DRW2D_OS_Semaphore_Create>, <R_DRW2D_OS_Semaphore_Destroy>, <R_DRW2D_OS_Semaphore_Post>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Semaphore_Wait (r_drw2d_OS_Semaphore_t *Sem);
/***********************************************************
Function: R_DRW2D_OS_Semaphore_Post
Increment semaphore.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that increments the semaphore.
Parameter:
Sem - Location of the unnamed semaphore.
Return Value:
R_DRW2D_OS_ERR_OK - No error occurred.
R_DRW2D_OS_ERR_SEM_POST - Failed to post semaphore.
R_DRW2D_OS_ERR_SEM_HANDLE - Invalid semaphore handle.
See also:
<R_DRW2D_OS_Semaphore_Create>, <R_DRW2D_OS_Semaphore_Destroy>, <R_DRW2D_OS_Semaphore_Wait>
*/
r_drw2d_OS_Error_t R_DRW2D_OS_Semaphore_Post (r_drw2d_OS_Semaphore_t *Sem);
/***********************************************************
Group: Memory utility functions
*/
/***********************************************************
Function: R_DRW2D_OS_Mem_Alloc
Allocate memory.
This function is return 0 as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that allocates the memory.
Parameter:
NumBytes - Number of bytes to allocate
Alignment - Address alignment (power of two) (0/1=any, 2=align to 16bit word boundary,
4=align to 32bit dword boundary, ..)
Type - R_DRW2D_OS_MEM_CPU (CPU usage only) or R_DRW2D_OS_MEM_VIDEO (CPU+GPU usage)
Return Value:
Start address of allocated memory or R_NULL if the allocation failed.
*/
void *R_DRW2D_OS_Mem_Alloc (uint32_t NumBytes, uint32_t Alignment, r_drw2d_OS_Mem_t Type);
/***********************************************************
Function: R_DRW2D_OS_Mem_Free
Free memory previously allocated with <R_DRW2D_OS_Mem_Alloc>.
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that frees the memory.
Parameter:
Addr - Start address of allocated memory
Return Value:
None
*/
void R_DRW2D_OS_Mem_Free (void *Addr);
/***********************************************************
Function: R_DRW2D_OS_Mem_Clear
Clear memory area (fill with 0)
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that clears the memory.
Parameter:
Addr - Start address of allocated memory
NumBytes - Number of bytes to clear
Return Value:
None
*/
void R_DRW2D_OS_Mem_Clear (void *Addr, uint32_t NumBytes);
/***********************************************************
Function: R_DRW2D_OS_Mem_Copy
Copy memory area
This function is empty as default.
Customizing Points:
It is NOT necessary to modify this function in general use-case.
If you want to customize depending on the OS environment,
please implement a function that copies the memory.
Parameter:
DestAddr - Buffer to copy to
SrcAddr - Buffer to copy from
NumBytes - Number of bytes to copy
Return Value:
None
*/
void R_DRW2D_OS_Mem_Copy (void *DestAddr, const void *SrcAddr, uint32_t NumBytes);
#ifdef __cplusplus
}
#endif
#endif /* R_DRW2D_OS_H_ */