pol_flg/ipol_flg | CS+ V5.00.00

pol_flg

ipol_flg

Outline

Wait for eventflag (polling).

C format
 ER      pol_flg (ID flgid, FLGPTN waiptn, MODE wfmode, FLGPTN *p_flgptn);
 ER      ipol_flg (ID flgid, FLGPTN waiptn, MODE wfmode, FLGPTN *p_flgptn);
Parameter(s)
I/O

Parameter

Description
I
 ID      flgid;
ID number of the eventflag.
I
 FLGPTN  waiptn;
Wait bit pattern.
I
 MODE    wfmode;
Wait mode.

TWF_ANDW: AND waiting condition.

TWF_ORW: OR waiting condition.
O
 FLGPTN  *p_flgptn;
Bit pattern causing a task to be released from waiting.
Explanation

This service call checks whether the bit pattern specified by parameter waiptn and the bit pattern that satisfies the required condition specified by parameter wfmode are set to the eventflag specified by parameter flgid.

If the bit pattern that satisfies the required condition has been set to the target eventflag, the bit pattern of the target eventflag is stored in the area specified by parameter p_flgptn.

If the bit pattern of the target eventflag does not satisfy the required condition when this service call is issued, "E_TMOUT" is returned.

The following shows the specification format of required condition wfmode.

- wfmode == TWF_ANDW
Checks whether all of the bits to which 1 is set by parameter waiptn are set as the target eventflag.

- wfmode == TWF_ORW
Checks which bit, among bits to which 1 is set by parameter waiptn, is set as the target eventflag.

Note 1 With the RI600V4, whether to enable queuing of multiple tasks to the event flag wait queue is defined during configuration. If this service call is issued for the event flag (TA_WSGL attribute) to which a wait task is queued, therefore, "E_ILUSE" is returned regardless of whether the required condition is immediately satisfied.

TA_WSGL: Only one task is allowed to be in the WAITING state for the eventflag.

TA_WMUL: Multiple tasks are allowed to be in the WAITING state for the eventflag.

Note 2 The RI600V4 performs bit pattern clear processing (0 setting) when the required condition of the target eventflag (TA_CLR attribute) is satisfied.

Return value

Macro

Value

Description

E_OK

0

Normal completion.

E_PAR

-17

Parameter error.

- waiptn == 0

- wfmode is invalid.

E_ID

-18

Invalid ID number.

- flgid < 0

- flgid > VTMAX_FLG

E_CTX

-25

Context error.

- This service call was issued in the CPU locked state.

- This service call was issued in the status "PSW.IPL > kernel interrupt mask level".

Note When the ipol_flg is issued from task or the pol_flg is issued from non-task, the context error is not detected and normal operation of the system is not guaranteed.

E_ILUSE

-28

Illegal use of service call.

- There is already a task waiting for an eventflag with the TA_WSGL attribute.

E_TMOUT

-50

Polling failure

I/O	Parameter	Description
I	ID flgid;	ID number of the eventflag.
I	FLGPTN waiptn;	Wait bit pattern.
I	MODE wfmode;	Wait mode. TWF_ANDW: AND waiting condition. TWF_ORW: OR waiting condition.
O	FLGPTN *p_flgptn;	Bit pattern causing a task to be released from waiting.

Macro	Value	Description
E_OK	0	Normal completion.
E_PAR	-17	Parameter error. - waiptn == 0 - wfmode is invalid.
E_ID	-18	Invalid ID number. - flgid < 0 - flgid > VTMAX_FLG
E_CTX	-25	Context error. - This service call was issued in the CPU locked state. - This service call was issued in the status "PSW.IPL > kernel interrupt mask level". Note When the ipol_flg is issued from task or the pol_flg is issued from non-task, the context error is not detected and normal operation of the system is not guaranteed.
E_ILUSE	-28	Illegal use of service call. - There is already a task waiting for an eventflag with the TA_WSGL attribute.
E_TMOUT	-50	Polling failure