summaryrefslogtreecommitdiffstats
path: root/doc/itron3.0/semaphore.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1999-05-26 17:51:04 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1999-05-26 17:51:04 +0000
commit315b929d287967a434cf3e09df1d9849cf549841 (patch)
tree1f8848be1e55a90da8908983bb17c132eb2b25b9 /doc/itron3.0/semaphore.t
parentb1b4fd26d0f10a9415a2bc1fc062bad7bda4bcd2 (diff)
downloadrtems-315b929d287967a434cf3e09df1d9849cf549841.tar.bz2
Added error codes to all service calls
Diffstat (limited to 'doc/itron3.0/semaphore.t')
-rw-r--r--doc/itron3.0/semaphore.t204
1 files changed, 190 insertions, 14 deletions
diff --git a/doc/itron3.0/semaphore.t b/doc/itron3.0/semaphore.t
index 250d7b48af..794abdaefa 100644
--- a/doc/itron3.0/semaphore.t
+++ b/doc/itron3.0/semaphore.t
@@ -74,8 +74,8 @@ is the extended information XXX
@item sematr
is the attributes for this semaphore. The only attributed
-which can be specified is whether tasks wait in FIFO (default)
-or priority order.
+which can be specified is whether tasks wait in FIFO (@code{TA_TFIFO})
+or priority (@code{TA_TPRI}) order.
@item isemcnt
is the initial count of the semaphore.
@@ -161,33 +161,42 @@ ER cre_sem(
@code{E_OK} - Normal Completion
-@code{E_NOMEM} - Insufficient memory (Memory for control block cannot be allocated)
+@code{E_NOMEM} - Insufficient memory (Memory for control block cannot be
+allocated)
@code{E_ID} - Invalid ID number (semid was invalid or could not be used)
-@code{E_RSATR} - Reserved attribute (sematr was invalid or could not be used)
+@code{E_RSATR} - Reserved attribute (sematr was invalid or could not be
+used)
-@code{E_OBJ} - Invalid object state (a semaphore of the same ID already exists)
+@code{E_OBJ} - Invalid object state (a semaphore of the same ID already
+exists)
-@code{E_OACV} - Object access violation (A semid less than -4 was specified from a user task. This is implementation dependent.)
+@code{E_OACV} - Object access violation (A semid less than -4 was
+specified from a user task. This is implementation dependent.)
-@code{E_PAR} - Parameter error (pk_csem is invalid and/or isemcnt or maxsem is negative or invalid)
+@code{E_PAR} - Parameter error (pk_csem is invalid and/or isemcnt or
+maxsem is negative or invalid)
-@code{EN_OBJNO} - An object number which could not be accessed on the target node is specified.
+@code{EN_OBJNO} - An object number which could not be accessed on the
+target node is specified.
-@code{EN_CTXID} - Specified an object on another node when the system call was
-issued from a task in dispatch disabled state or from a task-
+@code{EN_CTXID} - Specified an object on another node when the system call
+was issued from a task in dispatch disabled state or from a task-
independent portion
-@code{EN_PAR} - A value outside the range supported by the target node and/or
-transmission packet format was specified as a parameter (a value
-outside supported range was specified for exinf, sematr, isemcnt
-and/or maxsem)
+@code{EN_PAR} - A value outside the range supported by the target node
+and/or transmission packet format was specified as a parameter (a value
+outside supported range was specified for exinf, sematr, isemcnt and/or
+maxsem)
@subheading DESCRIPTION:
+
+
@subheading NOTES:
+NONE
@c
@@ -214,8 +223,28 @@ ER del_sem(
@subheading DESCRIPTION:
+@code{E_OK} - Normal Completion
+
+@code{E_ID} - Invalid ID number (semid was invalid or could not be used)
+
+@code{E_NOEXS} - Object does not exist (the semaphore specified by semid
+does not exist)
+
+@code{E_OACV} - Object access violation (A semid less than -4 was
+specified from a user task. This is implementation dependent.)
+
+@code{EN_OBJNO} - An object number which could not be accessed on the
+target node is specified.
+
+@code{EN_CTXID} - Specified an object on another node when the system call
+was issued from a task in dispatch disabled state or from a
+task-independent portion
+
+
@subheading NOTES:
+NONE
+
@c
@c sig_sem
@@ -239,10 +268,32 @@ ER sig_sem(
@subheading STATUS CODES:
+@code{E_OK} - Normal Completion
+
+@code{E_ID} - Invalid ID number (semid was invalid or could not be used)
+
+@code{E_NOEXS} - Object does not exist (the semaphore specified by semid
+does not exist)
+
+@code{E_OACV} - Object access violation (A semid less than -4 was
+specified from a user task. This is implementation dependent.)
+
+@code{E_QOVR} - Queuing or nesting overflow (the queuing count given by
+semcnt went over the maximum allowed)
+
+@code{EN_OBJNO} - An object number which could not be accessed on the
+target node is specified.
+
+@code{EN_CTXID} - Specified an object on another node when the system call
+was issued from a task in dispatch disabled state or from a
+task-independent portion
+
@subheading DESCRIPTION:
@subheading NOTES:
+NONE
+
@c
@c wai_sem
@@ -266,10 +317,43 @@ ER wai_sem(
@subheading STATUS CODES:
+@code{E_OK} - Normal Completion
+
+@code{E_ID} - Invalid ID number (semid was invalid or could not be used)
+
+@code{E_NOEXS} - Object does not exist (the semaphore specified by semid
+does not exist)
+
+@code{E_OACV} - Object access violation (A semid less than -4 was
+specified from a user task. This is implementation dependent.)
+
+@code{E_PAR} - Parameter error (tmout is -2 or less)
+
+@code{E_DLT} - The object being waited for was deleted (the specified
+semaphore was deleted while waiting)
+
+@code{E_RLWAI} - Wait state was forcibly released (rel_wai was received
+while waiting)
+
+@code{E_TMOUT} - Polling failure or timeout exceeded
+
+@code{E_CTX} - Context error (issued from task-independent portions or a
+task in dispatch disabled state)
+
+@code{EN_OBJNO} - An object number which could not be accessed on the
+target node is specified.
+
+@code{EN_PAR} - A value outside the range supported by the target node
+and/or transmission packet format was specified as a parameter (a value
+outside supported range was specified for tmout)
+
+
@subheading DESCRIPTION:
@subheading NOTES:
+NONE
+
@c
@c preq_sem
@@ -293,10 +377,43 @@ ER preq_sem(
@subheading STATUS CODES:
+@code{E_OK} - Normal Completion
+
+@code{E_ID} - Invalid ID number (semid was invalid or could not be used)
+
+@code{E_NOEXS} - Object does not exist (the semaphore specified by semid
+does not exist)
+
+@code{E_OACV} - Object access violation (A semid less than -4 was
+specified from a user task. This is implementation dependent.)
+
+@code{E_PAR} - Parameter error (tmout is -2 or less)
+
+@code{E_DLT} - The object being waited for was deleted (the specified
+semaphore was deleted while waiting)
+
+@code{E_RLWAI} - Wait state was forcibly released (rel_wai was received
+while waiting)
+
+@code{E_TMOUT} - Polling failure or timeout exceeded
+
+@code{E_CTX} - Context error (issued from task-independent portions or a
+task in dispatch disabled state)
+
+@code{EN_OBJNO} - An object number which could not be accessed on the
+target node is specified.
+
+@code{EN_PAR} - A value outside the range supported by the target node
+and/or transmission packet format was specified as a parameter (a value
+outside supported range was specified for tmout)
+
+
@subheading DESCRIPTION:
@subheading NOTES:
+NONE
+
@c
@c twai_sem
@@ -321,10 +438,43 @@ ER twai_sem(
@subheading STATUS CODES:
+@code{E_OK} - Normal Completion
+
+@code{E_ID} - Invalid ID number (semid was invalid or could not be used)
+
+@code{E_NOEXS} - Object does not exist (the semaphore specified by semid
+does not exist)
+
+@code{E_OACV} - Object access violation (A semid less than -4 was
+specified from a user task. This is implementation dependent.)
+
+@code{E_PAR} - Parameter error (tmout is -2 or less)
+
+@code{E_DLT} - The object being waited for was deleted (the specified
+semaphore was deleted while waiting)
+
+@code{E_RLWAI} - Wait state was forcibly released (rel_wai was received
+while waiting)
+
+@code{E_TMOUT} - Polling failure or timeout exceeded
+
+@code{E_CTX} - Context error (issued from task-independent portions or a
+task in dispatch disabled state)
+
+@code{EN_OBJNO} - An object number which could not be accessed on the
+target node is specified.
+
+@code{EN_PAR} - A value outside the range supported by the target node
+and/or transmission packet format was specified as a parameter (a value
+outside supported range was specified for tmout)
+
+
@subheading DESCRIPTION:
@subheading NOTES:
+NONE
+
@c
@c ref_sem
@@ -349,7 +499,33 @@ ER ref_sem(
@subheading STATUS CODES:
+@code{E_OK} - Normal Completion
+
+@code{E_ID} - Invalid ID number (semid was invalid or could not be used)
+
+@code{E_NOEXS} - Object does not exist (the semaphore specified by semid
+does not exist)
+
+@code{E_OACV} - Object access violation (A semid less than -4 was
+specified from a user task. This is implementation dependent.)
+
+@code{E_PAR} - Parameter error (the packet address for the return
+parameters could not be used)
+
+@code{EN_OBJNO} - An object number which could not be accessed on the
+target node is specified.
+
+@code{EN_CTXID} - Specified an object on another node when the system call
+was issued from a task in dispatch disabled state or from a
+task-independent portion
+
+@code{EN_RPAR} - A value outside the range supported by the requesting
+node and/or transmission packet format was returned as a parameter (a
+value outside supported range was specified for exinf, wtsk or semcnt)
+
@subheading DESCRIPTION:
@subheading NOTES:
+NONE
+