summaryrefslogtreecommitdiffstats
path: root/doc/itron3.0
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1999-06-04 13:37:43 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1999-06-04 13:37:43 +0000
commiteb91a4bb49d492ab11ff979110b451d992a365e1 (patch)
tree695dfb3334c6553a532a256ea00705780cf1d55b /doc/itron3.0
parentAdded much of the text required to turn this into a real chapter. (diff)
downloadrtems-eb91a4bb49d492ab11ff979110b451d992a365e1.tar.bz2
Significantly cleaned up to make a much better starting point for the
class.
Diffstat (limited to 'doc/itron3.0')
-rw-r--r--doc/itron3.0/Makefile15
-rw-r--r--doc/itron3.0/config.t28
-rw-r--r--doc/itron3.0/eventflags.t63
-rw-r--r--doc/itron3.0/fixedblock.t49
-rw-r--r--doc/itron3.0/interrupt.t53
-rw-r--r--doc/itron3.0/itron.texi4
-rw-r--r--doc/itron3.0/mailbox.t49
-rw-r--r--doc/itron3.0/memorypool.t52
-rw-r--r--doc/itron3.0/msgbuffer.t70
-rw-r--r--doc/itron3.0/network.t31
-rw-r--r--doc/itron3.0/rendezvous.t96
-rw-r--r--doc/itron3.0/tasksync.t43
-rw-r--r--doc/itron3.0/time.t57
13 files changed, 361 insertions, 249 deletions
diff --git a/doc/itron3.0/Makefile b/doc/itron3.0/Makefile
index 4486319dd1..0fd4566893 100644
--- a/doc/itron3.0/Makefile
+++ b/doc/itron3.0/Makefile
@@ -11,7 +11,7 @@ TEXI2DVI=../tools/texi2dvi
MAKEINFO=makeinfo
TEXI2WWW=../tools/texi2www
BMENU=../tools/bmenu
-TEXI2WWW_ARGS=-dirfile index.html \
+TEXI2WWW_ARGS=-dirfile ../../../index.html \
-header ../tools/rtems_header.html \
-footer ../tools/rtems_footer.html \
-icons .
@@ -24,7 +24,8 @@ COMMON_FILES=
GENERATED_FILES= \
task.texi tasksync.texi semaphore.texi eventflags.texi mailbox.texi \
msgbuffer.texi rendezvous.texi interrupt.texi memorypool.texi \
- fixedblock.texi time.texi config.texi network.texi
+ fixedblock.texi time.texi config.texi network.texi \
+ psxmsg.texi psxsem.texi
FILES= $(PROJECT).texi \
$(COMMON_FILES) $(GENERATED_FILES)
@@ -121,3 +122,13 @@ network.texi: network.t Makefile
-u "Top" \
-n "" ${*}.t
+psxmsg.texi: psxmsg.t Makefile
+ $(BMENU) -p "" \
+ -u "Top" \
+ -n "" ${*}.t
+
+psxsem.texi: psxsem.t Makefile
+ $(BMENU) -p "" \
+ -u "Top" \
+ -n "" ${*}.t
+
diff --git a/doc/itron3.0/config.t b/doc/itron3.0/config.t
index 6538a8c399..b34e5bbf0f 100644
--- a/doc/itron3.0/config.t
+++ b/doc/itron3.0/config.t
@@ -40,14 +40,14 @@ and status codes.
@c
@page
-@subsection get_ver - Get Version Information Get Version Information of another Node
+@subsection get_ver - Get Version Information
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER get_ver (
- T_VER *pk_ver ER nget_ver
+ER get_ver(
+ T_VER *pk_ver
);
@end example
@end ifset
@@ -69,13 +69,13 @@ ER get_ver (
@c
@page
-@subsection ref_sys - Reference Semaphore Status
+@subsection ref_sys - Reference Semaphore Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_sys (
+ER ref_sys(
T_RSYS *pk_rsys
);
@end example
@@ -98,13 +98,13 @@ ER ref_sys (
@c
@page
-@subsection ref_cfg - Reference Configuration Information
+@subsection ref_cfg - Reference Configuration Information
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_cfg (
+ER ref_cfg(
T_RCFG *pk_rcfg
);
@end example
@@ -127,14 +127,15 @@ ER ref_cfg (
@c
@page
-@subsection def_svc - Define Extended SVC Handler
+@subsection def_svc - Define Extended SVC Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER def_svc (
- FN s_fncd, T_DSVC *pk_dsvc
+ER def_svc(
+ FN s_fncd,
+ T_DSVC *pk_dsvc
);
@end example
@end ifset
@@ -156,14 +157,15 @@ ER def_svc (
@c
@page
-@subsection def_exc - Define Exception Handler
+@subsection def_exc - Define Exception Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER def_exc (
- UINT exckind, T_DEXC *pk_dexc
+ER def_exc(
+ UINT exckind,
+ T_DEXC *pk_dexc
);
@end example
@end ifset
diff --git a/doc/itron3.0/eventflags.t b/doc/itron3.0/eventflags.t
index 118cfc545e..9b4049200a 100644
--- a/doc/itron3.0/eventflags.t
+++ b/doc/itron3.0/eventflags.t
@@ -21,7 +21,7 @@ The services provided by the eventflags manager are:
@item @code{set_flg} - Set Eventflag
@item @code{clr_flg} - Clear Eventflag
@item @code{wai_flg} - Wait on Eventflag
-@item @code{pol_flg} - Wait for Eventflag (Polling)
+@item @code{pol_flg} - Wait for Eventflag(Polling)
@item @code{twai_flg} - Wait on Eventflag with Timeout
@item @code{ref_flg} - Reference Eventflag Status
@end itemize
@@ -43,14 +43,15 @@ and status codes.
@c
@page
-@subsection cre_flg - Create Eventflag
+@subsection cre_flg - Create Eventflag
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER cre_flg (
- ID flgid, T_CFLG *pk_cflg
+ER cre_flg(
+ ID flgid,
+ T_CFLG *pk_cflg
);
@end example
@end ifset
@@ -72,14 +73,14 @@ ER cre_flg (
@c
@page
-@subsection del_flg - Delete Eventflag
+@subsection del_flg - Delete Eventflag
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER del_flg (
- ID flgid
+ER del_flg(
+ ID flgid
);
@end example
@end ifset
@@ -101,14 +102,15 @@ ER del_flg (
@c
@page
-@subsection set_flg - Set Eventflag
+@subsection set_flg - Set Eventflag
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER set_flg (
- ID flgid, UINT setptn
+ER set_flg(
+ ID flgid,
+ UINT setptn
);
@end example
@end ifset
@@ -130,14 +132,15 @@ ER set_flg (
@c
@page
-@subsection clr_flg - Clear Eventflag
+@subsection clr_flg - Clear Eventflag
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER clr_flg (
- ID flgid, UINT clrptn
+ER clr_flg(
+ ID flgid,
+ UINT clrptn
);
@end example
@end ifset
@@ -159,14 +162,17 @@ ER clr_flg (
@c
@page
-@subsection wai_flg - Wait on Eventflag with Timeout Wait on Eventflag
+@subsection wai_flg - Wait on Eventflag
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER wai_flg (
- UINT *p_flgptn, ID flgid, UINT waiptn, UINT wfmode ER ercd =twai_flg
+ER wai_flg(
+ UINT *p_flgptn,
+ ID flgid,
+ UINT waiptn,
+ UINT wfmode
);
@end example
@end ifset
@@ -188,14 +194,17 @@ ER wai_flg (
@c
@page
-@subsection pol_flg - Wait for Eventflag (Polling)
+@subsection pol_flg - Wait for Eventflag(Polling)
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER pol_flg (
- UINT *p_flgptn, ID flgid, UINT waiptn, UINT wfmode
+ER pol_flg(
+ UINT *p_flgptn,
+ ID flgid,
+ UINT waiptn,
+ UINT wfmode
);
@end example
@end ifset
@@ -217,14 +226,17 @@ ER pol_flg (
@c
@page
-@subsection twai_flg - Wait on Eventflag with Timeout
+@subsection twai_flg - Wait on Eventflag with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =twai_flg (
- UINT *p_flgptn, ID flgid, UINT waiptn, UINT wfmode,
+ER ercd =twai_flg(
+ UINT *p_flgptn,
+ ID flgid,
+ UINT waiptn,
+ UINT wfmode,
);
@end example
@end ifset
@@ -246,14 +258,15 @@ ER ercd =twai_flg (
@c
@page
-@subsection ref_flg - Reference Eventflag Status
+@subsection ref_flg - Reference Eventflag Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_flg (
- T_RFLG *pk_rflg, ID flgid
+ER ref_flg(
+ T_RFLG *pk_rflg,
+ ID flgid
);
@end example
@end ifset
diff --git a/doc/itron3.0/fixedblock.t b/doc/itron3.0/fixedblock.t
index 3ae3de6ede..0e7f9ddb18 100644
--- a/doc/itron3.0/fixedblock.t
+++ b/doc/itron3.0/fixedblock.t
@@ -42,14 +42,15 @@ and status codes.
@c
@page
-@subsection cre_mpf - Create Fixed-Size Memorypool
+@subsection cre_mpf - Create Fixed-Size Memorypool
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER cre_mpf (
- ID mpfid, T_CMPF *pk_cmpf
+ER cre_mpf(
+ ID mpfid,
+ T_CMPF *pk_cmpf
);
@end example
@end ifset
@@ -71,14 +72,14 @@ ER cre_mpf (
@c
@page
-@subsection del_mpf - Delete Fixed-Size Memorypool
+@subsection del_mpf - Delete Fixed-Size Memorypool
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER del_mpf (
- ID mpfid
+ER del_mpf(
+ ID mpfid
);
@end example
@end ifset
@@ -100,14 +101,15 @@ ER del_mpf (
@c
@page
-@subsection get_blf - Get Fixed-Size Memory Block Poll and Get Fixed-Size Memory Block Get Fixed-Size Memory Block with Timeout
+@subsection get_blf - Get Fixed-Size Memory Block
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER get_blf (
- VP *p_blf, ID mpfid ER ercd =pget_blf
+ER get_blf(
+ VP *p_blf,
+ ID mpfid
);
@end example
@end ifset
@@ -129,14 +131,15 @@ ER get_blf (
@c
@page
-@subsection pget_blf - Poll and Get Fixed-Size Memory Block
+@subsection pget_blf - Poll and Get Fixed-Size Memory Block
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =pget_blf (
- VP *p_blf, ID mpfid
+ER ercd =pget_blf(
+ VP *p_blf,
+ ID mpfid
);
@end example
@end ifset
@@ -158,14 +161,16 @@ ER ercd =pget_blf (
@c
@page
-@subsection tget_blf - Get Fixed-Size Memory Block with Timeout
+@subsection tget_blf - Get Fixed-Size Memory Block with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =tget_blf (
- VP *p_blf, ID mpfid, TMO tmout
+ER ercd =tget_blf(
+ VP *p_blf,
+ ID mpfid,
+ TMO tmout
);
@end example
@end ifset
@@ -187,14 +192,15 @@ ER ercd =tget_blf (
@c
@page
-@subsection rel_blf - Release Fixed-Size Memory Block
+@subsection rel_blf - Release Fixed-Size Memory Block
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER rel_blf (
- ID mpfid, VP blf
+ER rel_blf(
+ ID mpfid,
+ VP blf
);
@end example
@end ifset
@@ -216,14 +222,15 @@ ER rel_blf (
@c
@page
-@subsection ref_mpf - Reference Fixed-Size Memorypool Status
+@subsection ref_mpf - Reference Fixed-Size Memorypool Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_mpf (
- T_RMPF *pk_rmpf, ID mpfid
+ER ref_mpf(
+ T_RMPF *pk_rmpf,
+ ID mpfid
);
@end example
@end ifset
diff --git a/doc/itron3.0/interrupt.t b/doc/itron3.0/interrupt.t
index d7589e393a..eb8a26a379 100644
--- a/doc/itron3.0/interrupt.t
+++ b/doc/itron3.0/interrupt.t
@@ -23,8 +23,8 @@ The services provided by the interrupt manager are:
@item @code{unl_cpu} - Unlock CPU
@item @code{dis_int} - Disable Interrupt
@item @code{ena_int} - Enable Interrupt
-@item @code{chg_iXX} - Change Interrupt Mask (Level or Priority)
-@item @code{ref_iXX} - Reference Interrupt Mask (Level or Priority)
+@item @code{chg_iXX} - Change Interrupt Mask(Level or Priority)
+@item @code{ref_iXX} - Reference Interrupt Mask(Level or Priority)
@end itemize
@section Background
@@ -44,14 +44,15 @@ and status codes.
@c
@page
-@subsection def_int - Define Interrupt Handler
+@subsection def_int - Define Interrupt Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER def_int (
- UINT dintno, T_DINT *pk_dint
+ER def_int(
+ UINT dintno,
+ T_DINT *pk_dint
);
@end example
@end ifset
@@ -73,13 +74,13 @@ ER def_int (
@c
@page
-@subsection ret_int - Return from Interrupt Handler
+@subsection ret_int - Return from Interrupt Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-void ret_int (
+void ret_int(
);
@end example
@@ -102,14 +103,14 @@ void ret_int (
@c
@page
-@subsection ret_wup - Return and Wakeup Task
+@subsection ret_wup - Return and Wakeup Task
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-void ret_wup (
- ID tskid
+void ret_wup(
+ ID tskid
);
@end example
@end ifset
@@ -131,13 +132,13 @@ void ret_wup (
@c
@page
-@subsection loc_cpu - Lock CPU
+@subsection loc_cpu - Lock CPU
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER loc_cpu (
+ER loc_cpu(
);
@end example
@@ -160,13 +161,13 @@ ER loc_cpu (
@c
@page
-@subsection unl_cpu - Unlock CPU
+@subsection unl_cpu - Unlock CPU
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER unl_cpu (
+ER unl_cpu(
);
@end example
@@ -189,14 +190,14 @@ ER unl_cpu (
@c
@page
-@subsection dis_int - Disable Interrupt
+@subsection dis_int - Disable Interrupt
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER dis_int (
- UINT eintno
+ER dis_int(
+ UINT eintno
);
@end example
@end ifset
@@ -218,14 +219,14 @@ ER dis_int (
@c
@page
-@subsection ena_int - Enable Interrupt
+@subsection ena_int - Enable Interrupt
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ena_int (
- UINT eintno
+ER ena_int(
+ UINT eintno
);
@end example
@end ifset
@@ -247,14 +248,14 @@ ER ena_int (
@c
@page
-@subsection chg_iXX - Change Interrupt Mask (Level or Priority)
+@subsection chg_iXX - Change Interrupt Mask(Level or Priority)
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER chg_iXX (
- UINT iXXXX
+ER chg_iXX(
+ UINT iXXXX
);
@end example
@end ifset
@@ -276,14 +277,14 @@ ER chg_iXX (
@c
@page
-@subsection ref_iXX - Reference Interrupt Mask (Level or Priority)
+@subsection ref_iXX - Reference Interrupt Mask(Level or Priority)
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_iXX (
- UINT *p_iXXXX
+ER ref_iXX(
+ UINT *p_iXXXX
);
@end example
@end ifset
diff --git a/doc/itron3.0/itron.texi b/doc/itron3.0/itron.texi
index d815523aa8..34278919cb 100644
--- a/doc/itron3.0/itron.texi
+++ b/doc/itron3.0/itron.texi
@@ -97,6 +97,8 @@ END-INFO-DIR-ENTRY
@include time.texi
@include config.texi
@include network.texi
+@include psxmsg.texi
+@include psxsem.texi
@ifinfo
@node Top, , (dir), (dir)
@top itron
@@ -117,6 +119,8 @@ This is the online version of the RTEMS ITRON API User's Guide
* Time Manager::
* System Manager::
* Network Support Manager::
+* POSIX Message Passing Manager::
+* POSIX Semaphores Manager::
* Command and Variable Index::
* Concept Index::
@end menu
diff --git a/doc/itron3.0/mailbox.t b/doc/itron3.0/mailbox.t
index 9b838a4a6f..99957a7daa 100644
--- a/doc/itron3.0/mailbox.t
+++ b/doc/itron3.0/mailbox.t
@@ -42,14 +42,15 @@ and status codes.
@c
@page
-@subsection cre_mbx - Create Mailbox
+@subsection cre_mbx - Create Mailbox
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER cre_mbx (
- ID mbxid, T_CMBX* pk_cmbx
+ER cre_mbx(
+ ID mbxid,
+ T_CMBX* pk_cmbx
);
@end example
@end ifset
@@ -71,14 +72,14 @@ ER cre_mbx (
@c
@page
-@subsection del_mbx - Delete Mailbox
+@subsection del_mbx - Delete Mailbox
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER del_mbx (
- ID mbxid
+ER del_mbx(
+ ID mbxid
);
@end example
@end ifset
@@ -100,14 +101,15 @@ ER del_mbx (
@c
@page
-@subsection snd_msg - Send Message to Mailbox
+@subsection snd_msg - Send Message to Mailbox
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER snd_msg (
- ID mbxid, T_MSG *pk_msg
+ER snd_msg(
+ ID mbxid,
+ T_MSG *pk_msg
);
@end example
@end ifset
@@ -129,14 +131,15 @@ ER snd_msg (
@c
@page
-@subsection rcv_msg - Poll and Receive Message from Mailbox Receive Message from Mailbox Receive Message from Mailbox with Timeout
+@subsection rcv_msg - Receive Message from Mailbox
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER rcv_msg (
- T_MSG **ppk_msg, ID mbxid ER ercd =prcv_msg
+ER rcv_msg(
+ T_MSG **ppk_msg,
+ ID mbxid
);
@end example
@end ifset
@@ -158,14 +161,15 @@ ER rcv_msg (
@c
@page
-@subsection prcv_msg - Poll and Receive Message from Mailbox
+@subsection prcv_msg - Poll and Receive Message from Mailbox
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =prcv_msg (
- T_MSG **ppk_msg, ID mbxid
+ER ercd =prcv_msg(
+ T_MSG **ppk_msg,
+ ID mbxid
);
@end example
@end ifset
@@ -187,14 +191,16 @@ ER ercd =prcv_msg (
@c
@page
-@subsection trcv_msg - Receive Message from Mailbox with Timeout
+@subsection trcv_msg - Receive Message from Mailbox with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =trcv_msg (
- T_MSG **ppk_msg, ID mbxid, TMO tmout
+ER ercd =trcv_msg(
+ T_MSG **ppk_msg,
+ ID mbxid,
+ TMO tmout
);
@end example
@end ifset
@@ -216,14 +222,15 @@ ER ercd =trcv_msg (
@c
@page
-@subsection ref_mbx - Reference Mailbox Status
+@subsection ref_mbx - Reference Mailbox Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_mbx (
- T_RMBX *pk_rmbx, ID mbxid
+ER ref_mbx(
+ T_RMBX *pk_rmbx,
+ ID mbxid
);
@end example
@end ifset
diff --git a/doc/itron3.0/memorypool.t b/doc/itron3.0/memorypool.t
index 3e6fe64480..db2b0542a4 100644
--- a/doc/itron3.0/memorypool.t
+++ b/doc/itron3.0/memorypool.t
@@ -42,14 +42,15 @@ and status codes.
@c
@page
-@subsection cre_mpl - Create Variable-Size Memorypool
+@subsection cre_mpl - Create Variable-Size Memorypool
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER cre_mpl (
- ID mplid, T_CMPL *pk_cmpl
+ER cre_mpl(
+ ID mplid,
+ T_CMPL *pk_cmpl
);
@end example
@end ifset
@@ -71,14 +72,14 @@ ER cre_mpl (
@c
@page
-@subsection del_mpl - Delete Variable-Size Memorypool
+@subsection del_mpl - Delete Variable-Size Memorypool
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER del_mpl (
- ID mplid
+ER del_mpl(
+ ID mplid
);
@end example
@end ifset
@@ -100,14 +101,16 @@ ER del_mpl (
@c
@page
-@subsection get_blk - Get Variable-Size Memory Block Poll and Get Variable-Size Memory Block Get Variable-Size Memory Block with Timeout
+@subsection get_blk - Get Variable-Size Memory Block
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER get_blk (
- VP *p_blk, ID mplid, INT blksz ER ercd =pget_blk
+ER get_blk(
+ VP *p_blk,
+ ID mplid,
+ INT blksz
);
@end example
@end ifset
@@ -129,14 +132,16 @@ ER get_blk (
@c
@page
-@subsection pget_blk - Poll and Get Variable-Size Memory Block
+@subsection pget_blk - Poll and Get Variable-Size Memory Block
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =pget_blk (
- VP *p_blk, ID mplid, INT blksz
+ER ercd =pget_blk(
+ VP *p_blk,
+ ID mplid,
+ INT blksz
);
@end example
@end ifset
@@ -158,14 +163,17 @@ ER ercd =pget_blk (
@c
@page
-@subsection tget_blk - Get Variable-Size Memory Block with Timeout
+@subsection tget_blk - Get Variable-Size Memory Block with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =tget_blk (
- VP *p_blk, ID mplid, INT blksz, TMO tmout
+ER ercd =tget_blk(
+ VP *p_blk,
+ ID mplid,
+ INT blksz,
+ TMO tmout
);
@end example
@end ifset
@@ -187,14 +195,15 @@ ER ercd =tget_blk (
@c
@page
-@subsection rel_blk - Release Variable-Size Memory Block
+@subsection rel_blk - Release Variable-Size Memory Block
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER rel_blk (
- ID mplid, VP blk
+ER rel_blk(
+ ID mplid,
+ VP blk
);
@end example
@end ifset
@@ -216,14 +225,15 @@ ER rel_blk (
@c
@page
-@subsection ref_mpl - Reference Variable-Size Memorypool Status
+@subsection ref_mpl - Reference Variable-Size Memorypool Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_mpl (
- T_RMPL *pk_rmpl, ID mplid
+ER ref_mpl(
+ T_RMPL *pk_rmpl,
+ ID mplid
);
@end example
@end ifset
diff --git a/doc/itron3.0/msgbuffer.t b/doc/itron3.0/msgbuffer.t
index d312aa7da7..a6fc84fd37 100644
--- a/doc/itron3.0/msgbuffer.t
+++ b/doc/itron3.0/msgbuffer.t
@@ -44,14 +44,15 @@ and status codes.
@c
@page
-@subsection cre_mbf - Create MessageBuffer
+@subsection cre_mbf - Create MessageBuffer
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER cre_mbf (
- ID mbfid, T_CMBF *pk_cmbf
+ER cre_mbf(
+ ID mbfid,
+ T_CMBF *pk_cmbf
);
@end example
@end ifset
@@ -73,14 +74,14 @@ ER cre_mbf (
@c
@page
-@subsection del_mbf - Delete MessageBuffer
+@subsection del_mbf - Delete MessageBuffer
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER del_mbf (
- ID mbfid
+ER del_mbf(
+ ID mbfid
);
@end example
@end ifset
@@ -102,14 +103,16 @@ ER del_mbf (
@c
@page
-@subsection snd_mbf - Poll and Send Message to MessageBuffer Send Message to MessageBuffer Send Message to MessageBuffer with Timeout
+@subsection snd_mbf - Send Message to MessageBuffer
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER snd_mbf (
- ID mbfid, VP msg, INT msgsz ER ercd =psnd_mbf
+ER snd_mbf(
+ ID mbfid,
+ VP msg,
+ INT msgsz
);
@end example
@end ifset
@@ -131,14 +134,16 @@ ER snd_mbf (
@c
@page
-@subsection psnd_mbf - Poll and Send Message to MessageBuffer
+@subsection psnd_mbf - Poll and Send Message to MessageBuffer
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =psnd_mbf (
- ID mbfid, VP msg, INT msgsz
+ER ercd =psnd_mbf(
+ ID mbfid,
+ VP msg,
+ INT msgsz
);
@end example
@end ifset
@@ -160,14 +165,17 @@ ER ercd =psnd_mbf (
@c
@page
-@subsection tsnd_mbf - Send Message to MessageBuffer with Timeout
+@subsection tsnd_mbf - Send Message to MessageBuffer with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =tsnd_mbf (
- ID mbfid, VP msg, INT msgsz, TMO tmout
+ER ercd =tsnd_mbf(
+ ID mbfid,
+ VP msg,
+ INT msgsz,
+ TMO tmout
);
@end example
@end ifset
@@ -189,14 +197,16 @@ ER ercd =tsnd_mbf (
@c
@page
-@subsection rcv_mbf - Poll and Receive Message from MessageBuffer Receive Message from MessageBuffer Receive Message from MessageBuffer with Timeout
+@subsection rcv_mbf - Receive Message from MessageBuffer
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER rcv_mbf (
- VP msg, INT *p_msgsz, ID mbfid ER ercd =prcv_mbf
+ER rcv_mbf(
+ VP msg,
+ INT *p_msgsz,
+ ID mbfid
);
@end example
@end ifset
@@ -218,14 +228,16 @@ ER rcv_mbf (
@c
@page
-@subsection prcv_mbf - Poll and Receive Message from MessageBuffer
+@subsection prcv_mbf - Poll and Receive Message from MessageBuffer
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =prcv_mbf (
- VP msg, INT *p_msgsz, ID mbfid
+ER ercd =prcv_mbf(
+ VP msg,
+ INT *p_msgsz,
+ ID mbfid
);
@end example
@end ifset
@@ -247,14 +259,17 @@ ER ercd =prcv_mbf (
@c
@page
-@subsection trcv_mbf - Receive Message from MessageBuffer with Timeout
+@subsection trcv_mbf - Receive Message from MessageBuffer with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =trcv_mbf (
- VP msg, INT *p_msgsz, ID mbfid, TMO tmout
+ER ercd =trcv_mbf(
+ VP msg,
+ INT *p_msgsz,
+ ID mbfid,
+ TMO tmout
);
@end example
@end ifset
@@ -276,14 +291,15 @@ ER ercd =trcv_mbf (
@c
@page
-@subsection ref_mbf - Reference MessageBuffer Status
+@subsection ref_mbf - Reference MessageBuffer Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_mbf (
- T_RMBF *pk_rmbf, ID mbfid
+ER ref_mbf(
+ T_RMBF *pk_rmbf,
+ ID mbfid
);
@end example
@end ifset
diff --git a/doc/itron3.0/network.t b/doc/itron3.0/network.t
index fae6f933f0..6a05e8ea42 100644
--- a/doc/itron3.0/network.t
+++ b/doc/itron3.0/network.t
@@ -39,14 +39,17 @@ and status codes.
@c
@page
-@subsection nrea_dat - Read Data from another Node
+@subsection nrea_dat - Read Data from another Node
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER nrea_dat (
- INT *p_reasz, VP dstadr, NODE srcnode, VP srcadr,
+ER nrea_dat(
+ INT *p_reasz,
+ VP dstadr,
+ NODE srcnode,
+ VP srcadr,
);
@end example
@end ifset
@@ -68,14 +71,17 @@ ER nrea_dat (
@c
@page
-@subsection nwri_dat - Write Data to another Node
+@subsection nwri_dat - Write Data to another Node
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER nwri_dat (
- INT *p_wrisz, NODE dstnode, VP dstadr, VP srcadr,
+ER nwri_dat(
+ INT *p_wrisz,
+ NODE dstnode,
+ VP dstadr,
+ VP srcadr,
);
@end example
@end ifset
@@ -97,14 +103,14 @@ ER nwri_dat (
@c
@page
-@subsection nget_nod - Get Local Node Number
+@subsection nget_nod - Get Local Node Number
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER nget_nod (
- NODE *p_node
+ER nget_nod(
+ NODE *p_node
);
@end example
@end ifset
@@ -126,14 +132,15 @@ ER nget_nod (
@c
@page
-@subsection nget_ver - Get Version Information of another Node
+@subsection nget_ver - Get Version Information of another Node
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER nget_ver (
- T_VER *pk_ver, NODE node
+ER nget_ver(
+ T_VER *pk_ver,
+ NODE node
);
@end example
@end ifset
diff --git a/doc/itron3.0/rendezvous.t b/doc/itron3.0/rendezvous.t
index 3651a696d5..f6cb1b4590 100644
--- a/doc/itron3.0/rendezvous.t
+++ b/doc/itron3.0/rendezvous.t
@@ -46,14 +46,15 @@ and status codes.
@c
@page
-@subsection cre_por - Create Port for Rendezvous
+@subsection cre_por - Create Port for Rendezvous
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER cre_por (
- ID porid, T_CPOR *pk_cpor
+ER cre_por(
+ ID porid,
+ T_CPOR *pk_cpor
);
@end example
@end ifset
@@ -75,14 +76,14 @@ ER cre_por (
@c
@page
-@subsection del_por - Delete Port for Rendezvous
+@subsection del_por - Delete Port for Rendezvous
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER del_por (
- ID porid
+ER del_por(
+ ID porid
);
@end example
@end ifset
@@ -104,14 +105,17 @@ ER del_por (
@c
@page
-@subsection cal_por - Call Port for Rendezvous Poll and Call Port for Rendezvous Call Port for Rendezvous with Timeout
+@subsection cal_por - Call Port for Rendezvous Poll
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER cal_por (
- VP msg, INT *p_rmsgsz, ID porid, UINT calptn, INT ER ercd =pcal_por
+ER cal_por(
+ VP msg,
+ INT *p_rmsgsz,
+ ID porid,
+ UINT calptn
);
@end example
@end ifset
@@ -133,14 +137,18 @@ ER cal_por (
@c
@page
-@subsection pcal_por - Poll and Call Port for Rendezvous
+@subsection pcal_por - Poll and Call Port for Rendezvous
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =pcal_por (
- VP msg, INT *p_rmsgsz, ID porid, UINT calptn, INT
+ER ercd =pcal_por(
+ VP msg,
+ INT *p_rmsgsz,
+ ID porid,
+ UINT calptn,
+ INT
);
@end example
@end ifset
@@ -162,14 +170,18 @@ ER ercd =pcal_por (
@c
@page
-@subsection tcal_por - Call Port for Rendezvous with Timeout
+@subsection tcal_por - Call Port for Rendezvous with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =tcal_por (
- VP msg, INT *p_rmsgsz, ID porid, UINT calptn, INT
+ER ercd =tcal_por(
+ VP msg,
+ INT *p_rmsgsz,
+ ID porid,
+ UINT calptn,
+ INT
);
@end example
@end ifset
@@ -191,14 +203,17 @@ ER ercd =tcal_por (
@c
@page
-@subsection acp_por - Accept Port for Rendezvous Poll and Accept Port for Rendezvous Accept Port for Rendezvous with Timeout
+@subsection acp_por - Accept Port for Rendezvous Poll
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER acp_por (
- RNO *p_rdvno, VP msg, INT *p_cmsgsz, ID porid, UINT ER ercd =pacp_por
+ER acp_por(
+ RNO *p_rdvno,
+ VP msg,
+ INT *p_cmsgsz,
+ ID porid
);
@end example
@end ifset
@@ -220,14 +235,18 @@ ER acp_por (
@c
@page
-@subsection pacp_por - Poll and Accept Port for Rendezvous
+@subsection pacp_por - Poll and Accept Port for Rendezvous
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =pacp_por (
- RNO *p_rdvno, VP msg, INT *p_cmsgsz, ID porid, UINT
+ER ercd =pacp_por(
+ RNO *p_rdvno,
+ VP msg,
+ INT *p_cmsgsz,
+ ID porid,
+ UINT
);
@end example
@end ifset
@@ -249,14 +268,18 @@ ER ercd =pacp_por (
@c
@page
-@subsection tacp_por - Accept Port for Rendezvous with Timeout
+@subsection tacp_por - Accept Port for Rendezvous with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =tacp_por (
- RNO *p_rdvno, VP msg, INT *p_cmsgsz, ID porid, UINT
+ER ercd =tacp_por(
+ RNO *p_rdvno,
+ VP msg,
+ INT *p_cmsgsz,
+ ID porid,
+ UINT
);
@end example
@end ifset
@@ -278,14 +301,18 @@ ER ercd =tacp_por (
@c
@page
-@subsection fwd_por - Forward Rendezvous to Other Port
+@subsection fwd_por - Forward Rendezvous to Other Port
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER fwd_por (
- ID porid, UINT calptn, RNO rdvno, VP msg, INT cmsgsz
+ER fwd_por(
+ ID porid,
+ UINT calptn,
+ RNO rdvno,
+ VP msg,
+ INT cmsgsz
);
@end example
@end ifset
@@ -307,14 +334,16 @@ ER fwd_por (
@c
@page
-@subsection rpl_rdv - Reply Rendezvous
+@subsection rpl_rdv - Reply Rendezvous
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER rpl_rdv (
- RNO rdvno, VP msg, INT rmsgsz
+ER rpl_rdv(
+ RNO rdvno,
+ VP msg,
+ INT rmsgsz
);
@end example
@end ifset
@@ -336,14 +365,15 @@ ER rpl_rdv (
@c
@page
-@subsection ref_por - Reference Port Status
+@subsection ref_por - Reference Port Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_por (
- T_RPOR *pk_rpor, ID porid
+ER ref_por(
+ T_RPOR *pk_rpor,
+ ID porid
);
@end example
@end ifset
diff --git a/doc/itron3.0/tasksync.t b/doc/itron3.0/tasksync.t
index c20abc1119..51cca765e9 100644
--- a/doc/itron3.0/tasksync.t
+++ b/doc/itron3.0/tasksync.t
@@ -42,14 +42,14 @@ and status codes.
@c
@page
-@subsection sus_tsk - Suspend Other Task
+@subsection sus_tsk - Suspend Other Task
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER sus_tsk (
- ID tskid
+ER sus_tsk(
+ ID tskid
);
@end example
@end ifset
@@ -71,14 +71,14 @@ ER sus_tsk (
@c
@page
-@subsection rsm_tsk - Forcibly Resume Suspended Task Resume Suspended Task
+@subsection rsm_tsk - Resume Suspended Task
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER rsm_tsk (
- ID tskid ER ercd =frsm_tsk
+ER rsm_tsk(
+ ID tskid
);
@end example
@end ifset
@@ -100,14 +100,14 @@ ER rsm_tsk (
@c
@page
-@subsection frsm_tsk - Forcibly Resume Suspended Task
+@subsection frsm_tsk - Forcibly Resume Suspended Task
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ercd =frsm_tsk (
- ID tskid
+ER ercd =frsm_tsk(
+ ID tskid
);
@end example
@end ifset
@@ -129,15 +129,13 @@ ER ercd =frsm_tsk (
@c
@page
-@subsection slp_tsk - Sleep Task Sleep Task with Timeout
+@subsection slp_tsk - Sleep Task Sleep Task with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER slp_tsk (
- ER ercd =tslp_tsk
-);
+ER slp_tsk( void );
@end example
@end ifset
@@ -158,14 +156,14 @@ No polling function for slp_tsk is provided. A similar function can be implemen
@c tslp_tsk
@c
-@subsection tslp_tsk - Sleep Task with Timeout
+@page
@subsection tslp_tsk - Sleep Task with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
-ER ercd =tslp_tsk (
- TMO tmout
+@example
+ER ercd =tslp_tsk(
TMO tmout
);
@end example
@@ -187,14 +185,14 @@ If you simply wish to delay a task (make it wait for a while), use dly_tsk rathe
@c wup_tsk
@c
-@subsection wup_tsk - Wakeup Other Task
+@page
@subsection wup_tsk - Wakeup Other Task
@subheading CALLING SEQUENCE:
@ifset is-C
-ER wup_tsk (
- ID tskid
+@example
+ER wup_tsk(
ID tskid
);
@end example
@@ -216,14 +214,15 @@ An E_QOVR error will result if wup_tsk is issued more than the maximum value all
@c can_wup
@c
-@subsection can_wup - Cancel Wakeup Request
+@page
@subsection can_wup - Cancel Wakeup Request
@subheading CALLING SEQUENCE:
@ifset is-C
-ER can_wup (
- INT *p_wupcnt, ID tskid
+@example
+ER can_wup(
+ INT *p_wupcnt,
ID tskid
);
@end example
diff --git a/doc/itron3.0/time.t b/doc/itron3.0/time.t
index e3a670ed3d..cf171fb5dc 100644
--- a/doc/itron3.0/time.t
+++ b/doc/itron3.0/time.t
@@ -44,14 +44,14 @@ and status codes.
@c
@page
-@subsection get_tim - Get System Clock
+@subsection get_tim - Get System Clock
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER get_tim (
- SYSTIME *pk_tim
+ER get_tim(
+ SYSTIME *pk_tim
);
@end example
@end ifset
@@ -73,14 +73,14 @@ ER get_tim (
@c
@page
-@subsection set_tim - Set System Clock
+@subsection set_tim - Set System Clock
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER set_tim (
- SYSTIME *pk_tim
+ER set_tim(
+ SYSTIME *pk_tim
);
@end example
@end ifset
@@ -102,14 +102,14 @@ ER set_tim (
@c
@page
-@subsection dly_tsk - Delay Task
+@subsection dly_tsk - Delay Task
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER dly_tsk (
- DLYTIME dlytim
+ER dly_tsk(
+ DLYTIME dlytim
);
@end example
@end ifset
@@ -131,14 +131,15 @@ ER dly_tsk (
@c
@page
-@subsection def_cyc - Define Cyclic Handler
+@subsection def_cyc - Define Cyclic Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER def_cyc (
- HNO cycno, T_DCYC *pk_dcyc
+ER def_cyc(
+ HNO cycno,
+ T_DCYC *pk_dcyc
);
@end example
@end ifset
@@ -160,14 +161,15 @@ ER def_cyc (
@c
@page
-@subsection act_cyc - Activate Cyclic Handler
+@subsection act_cyc - Activate Cyclic Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER act_cyc (
- HNO cycno, UINT cycact
+ER act_cyc(
+ HNO cycno,
+ UINT cycact
);
@end example
@end ifset
@@ -189,14 +191,15 @@ ER act_cyc (
@c
@page
-@subsection ref_cyc - Reference Cyclic Handler Status
+@subsection ref_cyc - Reference Cyclic Handler Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_cyc (
- T_RCYC *pk_rcyc, HNO cycno
+ER ref_cyc(
+ T_RCYC *pk_rcyc,
+ HNO cycno
);
@end example
@end ifset
@@ -218,14 +221,15 @@ ER ref_cyc (
@c
@page
-@subsection def_alm - Define Alarm Handler
+@subsection def_alm - Define Alarm Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER def_alm (
- HNO almno, T_DALM *pk_dalm
+ER def_alm(
+ HNO almno,
+ T_DALM *pk_dalm
);
@end example
@end ifset
@@ -247,14 +251,15 @@ ER def_alm (
@c
@page
-@subsection ref_alm - Reference Alarm Handler Status
+@subsection ref_alm - Reference Alarm Handler Status
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-ER ref_alm (
- T_RALM *pk_ralm, HNO almno
+ER ref_alm(
+ T_RALM *pk_ralm,
+ HNO almno
);
@end example
@end ifset
@@ -276,13 +281,13 @@ ER ref_alm (
@c
@page
-@subsection ret_tmr - Return from Timer Handler
+@subsection ret_tmr - Return from Timer Handler
@subheading CALLING SEQUENCE:
@ifset is-C
@example
-void ret_tmr (
+void ret_tmr(
);
@end example