<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
<!-- This material may be distributed only subject to the terms -->
|
<!-- This material may be distributed only subject to the terms -->
|
<!-- and conditions set forth in the Open Publication License, v1.0 -->
|
<!-- and conditions set forth in the Open Publication License, v1.0 -->
|
<!-- or later (the latest version is presently available at -->
|
<!-- or later (the latest version is presently available at -->
|
<!-- http://www.opencontent.org/openpub/). -->
|
<!-- http://www.opencontent.org/openpub/). -->
|
<!-- Distribution of the work or derivative of the work in any -->
|
<!-- Distribution of the work or derivative of the work in any -->
|
<!-- standard (paper) book form is prohibited unless prior -->
|
<!-- standard (paper) book form is prohibited unless prior -->
|
<!-- permission is obtained from the copyright holder. -->
|
<!-- permission is obtained from the copyright holder. -->
|
<HTML
|
<HTML
|
><HEAD
|
><HEAD
|
><TITLE
|
><TITLE
|
>Task-Dependent Synchronization Functions</TITLE
|
>Task-Dependent Synchronization Functions</TITLE
|
><meta name="MSSmartTagsPreventParsing" content="TRUE">
|
><meta name="MSSmartTagsPreventParsing" content="TRUE">
|
<META
|
<META
|
NAME="GENERATOR"
|
NAME="GENERATOR"
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
"><LINK
|
"><LINK
|
REL="HOME"
|
REL="HOME"
|
TITLE="eCos Reference Manual"
|
TITLE="eCos Reference Manual"
|
HREF="ecos-ref.html"><LINK
|
HREF="ecos-ref.html"><LINK
|
REL="UP"
|
REL="UP"
|
TITLE="µITRON API"
|
TITLE="µITRON API"
|
HREF="compat-uitron-microitron-api.html"><LINK
|
HREF="compat-uitron-microitron-api.html"><LINK
|
REL="PREVIOUS"
|
REL="PREVIOUS"
|
TITLE="Task Management Functions"
|
TITLE="Task Management Functions"
|
HREF="compat-uitron-task-management-functions.html"><LINK
|
HREF="compat-uitron-task-management-functions.html"><LINK
|
REL="NEXT"
|
REL="NEXT"
|
TITLE=" Synchronization and Communication Functions"
|
TITLE=" Synchronization and Communication Functions"
|
HREF="compat-uitron-sync-and-comm-functions.html"></HEAD
|
HREF="compat-uitron-sync-and-comm-functions.html"></HEAD
|
><BODY
|
><BODY
|
CLASS="SECT1"
|
CLASS="SECT1"
|
BGCOLOR="#FFFFFF"
|
BGCOLOR="#FFFFFF"
|
TEXT="#000000"
|
TEXT="#000000"
|
LINK="#0000FF"
|
LINK="#0000FF"
|
VLINK="#840084"
|
VLINK="#840084"
|
ALINK="#0000FF"
|
ALINK="#0000FF"
|
><DIV
|
><DIV
|
CLASS="NAVHEADER"
|
CLASS="NAVHEADER"
|
><TABLE
|
><TABLE
|
SUMMARY="Header navigation table"
|
SUMMARY="Header navigation table"
|
WIDTH="100%"
|
WIDTH="100%"
|
BORDER="0"
|
BORDER="0"
|
CELLPADDING="0"
|
CELLPADDING="0"
|
CELLSPACING="0"
|
CELLSPACING="0"
|
><TR
|
><TR
|
><TH
|
><TH
|
COLSPAN="3"
|
COLSPAN="3"
|
ALIGN="center"
|
ALIGN="center"
|
>eCos Reference Manual</TH
|
>eCos Reference Manual</TH
|
></TR
|
></TR
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="10%"
|
WIDTH="10%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
><A
|
><A
|
HREF="compat-uitron-task-management-functions.html"
|
HREF="compat-uitron-task-management-functions.html"
|
ACCESSKEY="P"
|
ACCESSKEY="P"
|
>Prev</A
|
>Prev</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="80%"
|
WIDTH="80%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
>Chapter 32. µITRON API</TD
|
>Chapter 32. µITRON API</TD
|
><TD
|
><TD
|
WIDTH="10%"
|
WIDTH="10%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
><A
|
><A
|
HREF="compat-uitron-sync-and-comm-functions.html"
|
HREF="compat-uitron-sync-and-comm-functions.html"
|
ACCESSKEY="N"
|
ACCESSKEY="N"
|
>Next</A
|
>Next</A
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><HR
|
><HR
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
WIDTH="100%"></DIV
|
WIDTH="100%"></DIV
|
><DIV
|
><DIV
|
CLASS="SECT1"
|
CLASS="SECT1"
|
><H1
|
><H1
|
CLASS="SECT1"
|
CLASS="SECT1"
|
><A
|
><A
|
NAME="COMPAT-UITRON-TASK-DEPENDENT-SYNCH-FUNCTIONS">Task-Dependent Synchronization Functions</H1
|
NAME="COMPAT-UITRON-TASK-DEPENDENT-SYNCH-FUNCTIONS">Task-Dependent Synchronization Functions</H1
|
><P
|
><P
|
>These functions are fully supported in this release: </P
|
>These functions are fully supported in this release: </P
|
><TABLE
|
><TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="PROGRAMLISTING"
|
CLASS="PROGRAMLISTING"
|
>ER <TT
|
>ER <TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>sus_tsk</TT
|
>sus_tsk</TT
|
>(
|
>(
|
ID <SPAN
|
ID <SPAN
|
CLASS="emphasis"
|
CLASS="emphasis"
|
><I
|
><I
|
CLASS="EMPHASIS"
|
CLASS="EMPHASIS"
|
>tskid</I
|
>tskid</I
|
></SPAN
|
></SPAN
|
> )</PRE
|
> )</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><TABLE
|
><TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="PROGRAMLISTING"
|
CLASS="PROGRAMLISTING"
|
>ER <TT
|
>ER <TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>rsm_tsk</TT
|
>rsm_tsk</TT
|
>(
|
>(
|
ID <SPAN
|
ID <SPAN
|
CLASS="emphasis"
|
CLASS="emphasis"
|
><I
|
><I
|
CLASS="EMPHASIS"
|
CLASS="EMPHASIS"
|
>tskid</I
|
>tskid</I
|
></SPAN
|
></SPAN
|
> )</PRE
|
> )</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><TABLE
|
><TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="PROGRAMLISTING"
|
CLASS="PROGRAMLISTING"
|
>ER <TT
|
>ER <TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>frsm_tsk</TT
|
>frsm_tsk</TT
|
>(
|
>(
|
ID <SPAN
|
ID <SPAN
|
CLASS="emphasis"
|
CLASS="emphasis"
|
><I
|
><I
|
CLASS="EMPHASIS"
|
CLASS="EMPHASIS"
|
>tskid</I
|
>tskid</I
|
></SPAN
|
></SPAN
|
> )</PRE
|
> )</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><TABLE
|
><TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="PROGRAMLISTING"
|
CLASS="PROGRAMLISTING"
|
>ER <TT
|
>ER <TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>slp_tsk</TT
|
>slp_tsk</TT
|
>( void )</PRE
|
>( void )</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><TABLE
|
><TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="PROGRAMLISTING"
|
CLASS="PROGRAMLISTING"
|
>ER <TT
|
>ER <TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>tslp_tsk</TT
|
>tslp_tsk</TT
|
>(
|
>(
|
TMO <SPAN
|
TMO <SPAN
|
CLASS="emphasis"
|
CLASS="emphasis"
|
><I
|
><I
|
CLASS="EMPHASIS"
|
CLASS="EMPHASIS"
|
>tmout</I
|
>tmout</I
|
></SPAN
|
></SPAN
|
> )</PRE
|
> )</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><TABLE
|
><TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="PROGRAMLISTING"
|
CLASS="PROGRAMLISTING"
|
>ER <TT
|
>ER <TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>wup_tsk</TT
|
>wup_tsk</TT
|
>(
|
>(
|
ID <SPAN
|
ID <SPAN
|
CLASS="emphasis"
|
CLASS="emphasis"
|
><I
|
><I
|
CLASS="EMPHASIS"
|
CLASS="EMPHASIS"
|
>tskid</I
|
>tskid</I
|
></SPAN
|
></SPAN
|
> )</PRE
|
> )</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><TABLE
|
><TABLE
|
BORDER="5"
|
BORDER="5"
|
BGCOLOR="#E0E0F0"
|
BGCOLOR="#E0E0F0"
|
WIDTH="70%"
|
WIDTH="70%"
|
><TR
|
><TR
|
><TD
|
><TD
|
><PRE
|
><PRE
|
CLASS="PROGRAMLISTING"
|
CLASS="PROGRAMLISTING"
|
>ER <TT
|
>ER <TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>can_wup</TT
|
>can_wup</TT
|
>(
|
>(
|
INT *<SPAN
|
INT *<SPAN
|
CLASS="emphasis"
|
CLASS="emphasis"
|
><I
|
><I
|
CLASS="EMPHASIS"
|
CLASS="EMPHASIS"
|
>p_wupcnt,</I
|
>p_wupcnt,</I
|
></SPAN
|
></SPAN
|
> ID <SPAN
|
> ID <SPAN
|
CLASS="emphasis"
|
CLASS="emphasis"
|
><I
|
><I
|
CLASS="EMPHASIS"
|
CLASS="EMPHASIS"
|
>tskid</I
|
>tskid</I
|
></SPAN
|
></SPAN
|
> )</PRE
|
> )</PRE
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><DIV
|
><DIV
|
CLASS="SECT2"
|
CLASS="SECT2"
|
><H2
|
><H2
|
CLASS="SECT2"
|
CLASS="SECT2"
|
><A
|
><A
|
NAME="AEN13571">Error checking</H2
|
NAME="AEN13571">Error checking</H2
|
><P
|
><P
|
>The following conditions are only checked for, and only return
|
>The following conditions are only checked for, and only return
|
errors if
|
errors if
|
<TT
|
<TT
|
CLASS="LITERAL"
|
CLASS="LITERAL"
|
>CYGSEM_UITRON_BAD_PARAMS_RETURN_ERRORS</TT
|
>CYGSEM_UITRON_BAD_PARAMS_RETURN_ERRORS</TT
|
>
|
>
|
is enabled (see the configuration option “Return Error Codes for Bad
|
is enabled (see the configuration option “Return Error Codes for Bad
|
Params”):</P
|
Params”):</P
|
><P
|
><P
|
></P
|
></P
|
><UL
|
><UL
|
><LI
|
><LI
|
><P
|
><P
|
>invalid tskid; less than 1 or greater than
|
>invalid tskid; less than 1 or greater than
|
<TT
|
<TT
|
CLASS="LITERAL"
|
CLASS="LITERAL"
|
>CYGNUM_UITRON_TASKS</TT
|
>CYGNUM_UITRON_TASKS</TT
|
>
|
>
|
returns E_ID</P
|
returns E_ID</P
|
></LI
|
></LI
|
><LI
|
><LI
|
><P
|
><P
|
><TT
|
><TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>wup_tsk()</TT
|
>wup_tsk()</TT
|
>
|
>
|
,
|
,
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>sus_tsk()</TT
|
>sus_tsk()</TT
|
>
|
>
|
,
|
,
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>rsm_tsk()</TT
|
>rsm_tsk()</TT
|
>
|
>
|
,
|
,
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>frsm_tsk()</TT
|
>frsm_tsk()</TT
|
>
|
>
|
on the calling task returns E_OBJ</P
|
on the calling task returns E_OBJ</P
|
></LI
|
></LI
|
><LI
|
><LI
|
><P
|
><P
|
>dispatching is enabled in
|
>dispatching is enabled in
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>tslp_tsk()</TT
|
>tslp_tsk()</TT
|
>
|
>
|
and
|
and
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>slp_tsk()</TT
|
>slp_tsk()</TT
|
>
|
>
|
, or E_CTX</P
|
, or E_CTX</P
|
></LI
|
></LI
|
><LI
|
><LI
|
><P
|
><P
|
>tmout must be positive, otherwise E_PAR</P
|
>tmout must be positive, otherwise E_PAR</P
|
></LI
|
></LI
|
><LI
|
><LI
|
><P
|
><P
|
>return value pointer in
|
>return value pointer in
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>can_wup()</TT
|
>can_wup()</TT
|
>
|
>
|
is a valid pointer, or E_PAR</P
|
is a valid pointer, or E_PAR</P
|
></LI
|
></LI
|
></UL
|
></UL
|
><P
|
><P
|
>The following conditions are checked for, and can
|
>The following conditions are checked for, and can
|
return error codes, regardless of the setting of
|
return error codes, regardless of the setting of
|
<TT
|
<TT
|
CLASS="LITERAL"
|
CLASS="LITERAL"
|
>CYGSEM_UITRON_BAD_PARAMS_RETURN_ERRORS</TT
|
>CYGSEM_UITRON_BAD_PARAMS_RETURN_ERRORS</TT
|
>:</P
|
>:</P
|
><P
|
><P
|
></P
|
></P
|
><UL
|
><UL
|
><LI
|
><LI
|
><P
|
><P
|
>When create and delete functions
|
>When create and delete functions
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>cre_tsk()</TT
|
>cre_tsk()</TT
|
>
|
>
|
and
|
and
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>del_tsk()</TT
|
>del_tsk()</TT
|
>
|
>
|
are supported, all calls which use a valid task ID number check
|
are supported, all calls which use a valid task ID number check
|
that the task exists; if not, E_NOEXS is returned</P
|
that the task exists; if not, E_NOEXS is returned</P
|
></LI
|
></LI
|
><LI
|
><LI
|
><P
|
><P
|
><TT
|
><TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>sus_tsk()</TT
|
>sus_tsk()</TT
|
>
|
>
|
: the task must not be dormant, else E_OBJ</P
|
: the task must not be dormant, else E_OBJ</P
|
></LI
|
></LI
|
><LI
|
><LI
|
><P
|
><P
|
><TT
|
><TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>frsm/rsm_tsk()</TT
|
>frsm/rsm_tsk()</TT
|
>
|
>
|
: the task must be suspended, else E_OBJ</P
|
: the task must be suspended, else E_OBJ</P
|
></LI
|
></LI
|
><LI
|
><LI
|
><P
|
><P
|
><TT
|
><TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>tslp/slp_tsk()</TT
|
>tslp/slp_tsk()</TT
|
>
|
>
|
: return codes E_TMOUT, E_RLWAI and E_DLT
|
: return codes E_TMOUT, E_RLWAI and E_DLT
|
are returned depending on the reason for terminating the sleep</P
|
are returned depending on the reason for terminating the sleep</P
|
></LI
|
></LI
|
><LI
|
><LI
|
><P
|
><P
|
><TT
|
><TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>wup_tsk()</TT
|
>wup_tsk()</TT
|
>
|
>
|
and
|
and
|
<TT
|
<TT
|
CLASS="FUNCTION"
|
CLASS="FUNCTION"
|
>can_wup()</TT
|
>can_wup()</TT
|
>
|
>
|
: the task must not be dormant, or E_OBJ is returned</P
|
: the task must not be dormant, or E_OBJ is returned</P
|
></LI
|
></LI
|
></UL
|
></UL
|
></DIV
|
></DIV
|
></DIV
|
></DIV
|
><DIV
|
><DIV
|
CLASS="NAVFOOTER"
|
CLASS="NAVFOOTER"
|
><HR
|
><HR
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
WIDTH="100%"><TABLE
|
WIDTH="100%"><TABLE
|
SUMMARY="Footer navigation table"
|
SUMMARY="Footer navigation table"
|
WIDTH="100%"
|
WIDTH="100%"
|
BORDER="0"
|
BORDER="0"
|
CELLPADDING="0"
|
CELLPADDING="0"
|
CELLSPACING="0"
|
CELLSPACING="0"
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="compat-uitron-task-management-functions.html"
|
HREF="compat-uitron-task-management-functions.html"
|
ACCESSKEY="P"
|
ACCESSKEY="P"
|
>Prev</A
|
>Prev</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="34%"
|
WIDTH="34%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="ecos-ref.html"
|
HREF="ecos-ref.html"
|
ACCESSKEY="H"
|
ACCESSKEY="H"
|
>Home</A
|
>Home</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="compat-uitron-sync-and-comm-functions.html"
|
HREF="compat-uitron-sync-and-comm-functions.html"
|
ACCESSKEY="N"
|
ACCESSKEY="N"
|
>Next</A
|
>Next</A
|
></TD
|
></TD
|
></TR
|
></TR
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="top"
|
VALIGN="top"
|
>Task Management Functions</TD
|
>Task Management Functions</TD
|
><TD
|
><TD
|
WIDTH="34%"
|
WIDTH="34%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="compat-uitron-microitron-api.html"
|
HREF="compat-uitron-microitron-api.html"
|
ACCESSKEY="U"
|
ACCESSKEY="U"
|
>Up</A
|
>Up</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="top"
|
VALIGN="top"
|
>Synchronization and Communication Functions</TD
|
>Synchronization and Communication Functions</TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
></DIV
|
></DIV
|
></BODY
|
></BODY
|
></HTML
|
></HTML
|
|
|