Renesas / GraphicsFramework

Graphics framework for GR-PEACH. When you use this program, we judge you have agreed to the following contents. https://developer.mbed.org/teams/Renesas/wiki/About-LICENSE

Dependents:   ImageZoomInout_Sample ImageRotaion_Sample ImageScroll_Sample GR-PEACH_LCD_4_3inch_Save_to_USB ... more

Embed: (wiki syntax)

« Back to documentation index

r_ospl_os_less.h File Reference
Functions

r_ospl_os_less.h File Reference

OS Porting Layer API for OS less Compatibility. More...

Go to the source code of this file.

Functions

INLINE errnum_t R_OSPL_THREAD_SetOnWait (r_ospl_wait_t const OnWait)
 Set waiting behavior of current thread.
INLINE r_ospl_wait_t R_OSPL_THREAD_GetOnWait (void)
 Get waiting behavior of current thread.
INLINE bool_t R_OSPL_THREAD_GetIsWaiting (void)
 Get whether the current thread is waiting or not.
INLINE void R_OSPL_THREAD_ExitWaiting (void)
 Exit waiting state, if current thread was waiting state.

Detailed Description

OS Porting Layer API for OS less Compatibility.

Module:
OSPL
PublicVersion:
0.90

(=R_OSPL_VERSION)

Rev:
35
Date:
2014-04-15 21:38:18 +0900#

Definition in file r_ospl_os_less.h.

Function Documentation

INLINE void R_OSPL_THREAD_ExitWaiting ( void   )

Exit waiting state, if current thread was waiting state.

Parameters
None
Returns:
None
Description
- Case of = 0

The thread returned true from R_OSPL_THREAD_GetIsWaiting function after a waiting function must call the waiting function again. After exiting waiting state, other operation and other waiting can be done. If time out was set to 0, exiting does not have to do.

If it was detected in OSPL API that necessary exiting was not done, E_STATE error is raised. However sometimes the state can not be detected. In this case, time out will be not correct.

This function does not do anything called from the interrupt context. "ASSERT_D" in this function notifies in debug configuration.

- Case of = 1

This function is for compatibility only. This function does not do anything.

Definition at line 184 of file r_ospl_os_less.h.

INLINE bool_t R_OSPL_THREAD_GetIsWaiting ( void   )

Get whether the current thread is waiting or not.

Parameters
None
Returns:
Whether the current thread is waiting or not
Description
- Case of = 0

If R_OSPL_WAIT_PM_THREAD was set by R_OSPL_THREAD_SetOnWait function, some waiting functions return soon even if the state is waiting and R_OSPL_THREAD_GetIsWaiting function returns true.

If time out was set to 0, R_OSPL_THREAD_GetIsWaiting function returns true at time out, even if any value was passed to R_OSPL_THREAD_SetOnWait function,

If this function was called from the interrupt context, this function returns false and ASSERT_D in this function notifies in debug configuration.

- Case of = 1

This function is for compatibility only. This function returns false.

Example
    e= R_OSPL_Delay( 100 ); IF(e){goto fin;}
    if ( R_OSPL_THREAD_GetIsWaiting() ) { e=0; goto fin; }

Definition at line 151 of file r_ospl_os_less.h.

INLINE r_ospl_wait_t R_OSPL_THREAD_GetOnWait ( void   )

Get waiting behavior of current thread.

Parameters
None
Returns:
Behavior on waiting
Description
- Case of = 0

Initial value is R_OSPL_WAIT_POLLING. If this function was called from the interrupt context, this function returns R_OSPL_WAIT_POLLING.

- Case of = 1

This function is for compatibility only. This function returns R_OSPL_WAIT_POLLING. But it does not polling on waiting

Refer to: R_OSPL_THREAD_SetOnWait

Definition at line 113 of file r_ospl_os_less.h.

INLINE errnum_t R_OSPL_THREAD_SetOnWait ( r_ospl_wait_t const   OnWait )

Set waiting behavior of current thread.

Parameters:
OnWaitBehavior on waiting
Returns:
Error code. If there is no error, the return value is 0.
Description
- Case of = 0

Initial value is R_OSPL_WAIT_POLLING. If this function was called from the interrupt context, E_STATE error is raised.

- Case of = 1

This function is for compatibility only. Arguments are ignored. This function returns 0.

Refer to: R_OSPL_THREAD_GetIsWaiting

Definition at line 85 of file r_ospl_os_less.h.

Generated on Tue Jul 12 2022 11:15:07 by  doxygen 1.7.2