From e968366e2195c3741f904275f2802a4069c52e03 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Wed, 26 May 1999 18:10:59 +0000 Subject: Prototypes are now based on how the TRON specification states them. The style in the output is not right but it is a good starting point. --- doc/itron3.0/config.t | 15 ++++++++++----- doc/itron3.0/eventflags.t | 24 ++++++++++++++++-------- doc/itron3.0/fixedblock.t | 21 ++++++++++++++------- doc/itron3.0/interrupt.t | 27 ++++++++++++++++++--------- doc/itron3.0/mailbox.t | 21 ++++++++++++++------- doc/itron3.0/memorypool.t | 21 ++++++++++++++------- doc/itron3.0/msgbuffer.t | 27 ++++++++++++++++++--------- doc/itron3.0/network.t | 12 ++++++++---- doc/itron3.0/rendezvous.t | 33 ++++++++++++++++++++++----------- doc/itron3.0/tasksync.t | 21 ++++++++++++++------- doc/itron3.0/time.t | 27 ++++++++++++++++++--------- 11 files changed, 166 insertions(+), 83 deletions(-) (limited to 'doc') diff --git a/doc/itron3.0/config.t b/doc/itron3.0/config.t index 773c44b339..93bde06bf6 100644 --- a/doc/itron3.0/config.t +++ b/doc/itron3.0/config.t @@ -46,7 +46,8 @@ and status codes. @ifset is-C @example -int get_ver( +ER get_ver ( + T_VER *pk_ver ER nget_ver ); @end example @end ifset @@ -74,7 +75,8 @@ int get_ver( @ifset is-C @example -int ref_sys( +ER ref_sys ( + T_RSYS *pk_rsys ); @end example @end ifset @@ -102,7 +104,8 @@ int ref_sys( @ifset is-C @example -int ref_cfg( +ER ref_cfg ( + T_RCFG *pk_rcfg ); @end example @end ifset @@ -130,7 +133,8 @@ int ref_cfg( @ifset is-C @example -int def_svc( +ER def_svc ( + FN s_fncd, T_DSVC *pk_dsvc ); @end example @end ifset @@ -158,7 +162,8 @@ int def_svc( @ifset is-C @example -int def_exc( +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 475394595c..b7a044805d 100644 --- a/doc/itron3.0/eventflags.t +++ b/doc/itron3.0/eventflags.t @@ -49,7 +49,8 @@ and status codes. @ifset is-C @example -int cre_flg( +ER cre_flg ( + ID flgid, T_CFLG *pk_cflg ); @end example @end ifset @@ -77,7 +78,8 @@ int cre_flg( @ifset is-C @example -int del_flg( +ER del_flg ( + ID flgid ); @end example @end ifset @@ -105,7 +107,8 @@ int del_flg( @ifset is-C @example -int set_flg( +ER set_flg ( + ID flgid, UINT setptn ); @end example @end ifset @@ -133,7 +136,8 @@ int set_flg( @ifset is-C @example -int clr_flg( +ER clr_flg ( + ID flgid, UINT clrptn ); @end example @end ifset @@ -161,7 +165,8 @@ int clr_flg( @ifset is-C @example -int wai_flg( +ER wai_flg ( + UINT *p_flgptn, ID flgid, UINT waiptn, UINT wfmode ER ercd =twai_flg ); @end example @end ifset @@ -189,7 +194,8 @@ int wai_flg( @ifset is-C @example -int pol_flg( +ER pol_flg ( + UINT *p_flgptn, ID flgid, UINT waiptn, UINT wfmode ); @end example @end ifset @@ -217,7 +223,8 @@ int pol_flg( @ifset is-C @example -int twai_flg( +ER ercd =twai_flg ( + UINT *p_flgptn, ID flgid, UINT waiptn, UINT wfmode, ); @end example @end ifset @@ -245,7 +252,8 @@ int twai_flg( @ifset is-C @example -int ref_flg( +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 cf727a5d8d..22efa4fe63 100644 --- a/doc/itron3.0/fixedblock.t +++ b/doc/itron3.0/fixedblock.t @@ -48,7 +48,8 @@ and status codes. @ifset is-C @example -int cre_mpf( +ER cre_mpf ( + ID mpfid, T_CMPF *pk_cmpf ); @end example @end ifset @@ -76,7 +77,8 @@ int cre_mpf( @ifset is-C @example -int del_mpf( +ER del_mpf ( + ID mpfid ); @end example @end ifset @@ -104,7 +106,8 @@ int del_mpf( @ifset is-C @example -int get_blf( +ER get_blf ( + VP *p_blf, ID mpfid ER ercd =pget_blf ); @end example @end ifset @@ -132,7 +135,8 @@ int get_blf( @ifset is-C @example -int pget_blf( +ER ercd =pget_blf ( + VP *p_blf, ID mpfid ); @end example @end ifset @@ -160,7 +164,8 @@ int pget_blf( @ifset is-C @example -int tget_blf( +ER ercd =tget_blf ( + VP *p_blf, ID mpfid, TMO tmout ); @end example @end ifset @@ -188,7 +193,8 @@ int tget_blf( @ifset is-C @example -int rel_blf( +ER rel_blf ( + ID mpfid, VP blf ); @end example @end ifset @@ -216,7 +222,8 @@ int rel_blf( @ifset is-C @example -int ref_mpf( +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 4f6eb330a3..11b6d9adf0 100644 --- a/doc/itron3.0/interrupt.t +++ b/doc/itron3.0/interrupt.t @@ -50,7 +50,8 @@ and status codes. @ifset is-C @example -int def_int( +ER def_int ( + UINT dintno, T_DINT *pk_dint ); @end example @end ifset @@ -78,7 +79,8 @@ int def_int( @ifset is-C @example -int ret_int( +void ret_int ( + ); @end example @end ifset @@ -106,7 +108,8 @@ int ret_int( @ifset is-C @example -int ret_wup( +void ret_wup ( + ID tskid ); @end example @end ifset @@ -134,7 +137,8 @@ int ret_wup( @ifset is-C @example -int loc_cpu( +ER loc_cpu ( + ); @end example @end ifset @@ -162,7 +166,8 @@ int loc_cpu( @ifset is-C @example -int unl_cpu( +ER unl_cpu ( + ); @end example @end ifset @@ -190,7 +195,8 @@ int unl_cpu( @ifset is-C @example -int dis_int( +ER dis_int ( + UINT eintno ); @end example @end ifset @@ -218,7 +224,8 @@ int dis_int( @ifset is-C @example -int ena_int( +ER ena_int ( + UINT eintno ); @end example @end ifset @@ -246,7 +253,8 @@ int ena_int( @ifset is-C @example -int chg_iXX( +ER chg_iXX ( + UINT iXXXX ); @end example @end ifset @@ -274,7 +282,8 @@ int chg_iXX( @ifset is-C @example -int ref_iXX( +ER ref_iXX ( + UINT *p_iXXXX ); @end example @end ifset diff --git a/doc/itron3.0/mailbox.t b/doc/itron3.0/mailbox.t index b2a123ece9..e37d46a20b 100644 --- a/doc/itron3.0/mailbox.t +++ b/doc/itron3.0/mailbox.t @@ -48,7 +48,8 @@ and status codes. @ifset is-C @example -int cre_mbx( +ER cre_mbx ( + ID mbxid, T_CMBX* pk_cmbx ); @end example @end ifset @@ -76,7 +77,8 @@ int cre_mbx( @ifset is-C @example -int del_mbx( +ER del_mbx ( + ID mbxid ); @end example @end ifset @@ -104,7 +106,8 @@ int del_mbx( @ifset is-C @example -int snd_msg( +ER snd_msg ( + ID mbxid, T_MSG *pk_msg ); @end example @end ifset @@ -132,7 +135,8 @@ int snd_msg( @ifset is-C @example -int rcv_msg( +ER rcv_msg ( + T_MSG **ppk_msg, ID mbxid ER ercd =prcv_msg ); @end example @end ifset @@ -160,7 +164,8 @@ int rcv_msg( @ifset is-C @example -int prcv_msg( +ER ercd =prcv_msg ( + T_MSG **ppk_msg, ID mbxid ); @end example @end ifset @@ -188,7 +193,8 @@ int prcv_msg( @ifset is-C @example -int trcv_msg( +ER ercd =trcv_msg ( + T_MSG **ppk_msg, ID mbxid, TMO tmout ); @end example @end ifset @@ -216,7 +222,8 @@ int trcv_msg( @ifset is-C @example -int ref_mbx( +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 271bc85029..3aa9c407a4 100644 --- a/doc/itron3.0/memorypool.t +++ b/doc/itron3.0/memorypool.t @@ -48,7 +48,8 @@ and status codes. @ifset is-C @example -int cre_mpl( +ER cre_mpl ( + ID mplid, T_CMPL *pk_cmpl ); @end example @end ifset @@ -76,7 +77,8 @@ int cre_mpl( @ifset is-C @example -int del_mpl( +ER del_mpl ( + ID mplid ); @end example @end ifset @@ -104,7 +106,8 @@ int del_mpl( @ifset is-C @example -int get_blk( +ER get_blk ( + VP *p_blk, ID mplid, INT blksz ER ercd =pget_blk ); @end example @end ifset @@ -132,7 +135,8 @@ int get_blk( @ifset is-C @example -int pget_blk( +ER ercd =pget_blk ( + VP *p_blk, ID mplid, INT blksz ); @end example @end ifset @@ -160,7 +164,8 @@ int pget_blk( @ifset is-C @example -int tget_blk( +ER ercd =tget_blk ( + VP *p_blk, ID mplid, INT blksz, TMO tmout ); @end example @end ifset @@ -188,7 +193,8 @@ int tget_blk( @ifset is-C @example -int rel_blk( +ER rel_blk ( + ID mplid, VP blk ); @end example @end ifset @@ -216,7 +222,8 @@ int rel_blk( @ifset is-C @example -int ref_mpl( +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 e8253e26f1..59c66a8be0 100644 --- a/doc/itron3.0/msgbuffer.t +++ b/doc/itron3.0/msgbuffer.t @@ -50,7 +50,8 @@ and status codes. @ifset is-C @example -int cre_mbf( +ER cre_mbf ( + ID mbfid, T_CMBF *pk_cmbf ); @end example @end ifset @@ -78,7 +79,8 @@ int cre_mbf( @ifset is-C @example -int del_mbf( +ER del_mbf ( + ID mbfid ); @end example @end ifset @@ -106,7 +108,8 @@ int del_mbf( @ifset is-C @example -int snd_mbf( +ER snd_mbf ( + ID mbfid, VP msg, INT msgsz ER ercd =psnd_mbf ); @end example @end ifset @@ -134,7 +137,8 @@ int snd_mbf( @ifset is-C @example -int psnd_mbf( +ER ercd =psnd_mbf ( + ID mbfid, VP msg, INT msgsz ); @end example @end ifset @@ -162,7 +166,8 @@ int psnd_mbf( @ifset is-C @example -int tsnd_mbf( +ER ercd =tsnd_mbf ( + ID mbfid, VP msg, INT msgsz, TMO tmout ); @end example @end ifset @@ -190,7 +195,8 @@ int tsnd_mbf( @ifset is-C @example -int rcv_mbf( +ER rcv_mbf ( + VP msg, INT *p_msgsz, ID mbfid ER ercd =prcv_mbf ); @end example @end ifset @@ -218,7 +224,8 @@ int rcv_mbf( @ifset is-C @example -int prcv_mbf( +ER ercd =prcv_mbf ( + VP msg, INT *p_msgsz, ID mbfid ); @end example @end ifset @@ -246,7 +253,8 @@ int prcv_mbf( @ifset is-C @example -int trcv_mbf( +ER ercd =trcv_mbf ( + VP msg, INT *p_msgsz, ID mbfid, TMO tmout ); @end example @end ifset @@ -274,7 +282,8 @@ int trcv_mbf( @ifset is-C @example -int ref_mbf( +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 7941a953e7..7240349d18 100644 --- a/doc/itron3.0/network.t +++ b/doc/itron3.0/network.t @@ -45,7 +45,8 @@ and status codes. @ifset is-C @example -int nrea_dat( +ER nrea_dat ( + INT *p_reasz, VP dstadr, NODE srcnode, VP srcadr, ); @end example @end ifset @@ -73,7 +74,8 @@ int nrea_dat( @ifset is-C @example -int nwri_dat( +ER nwri_dat ( + INT *p_wrisz, NODE dstnode, VP dstadr, VP srcadr, ); @end example @end ifset @@ -101,7 +103,8 @@ int nwri_dat( @ifset is-C @example -int nget_nod( +ER nget_nod ( + NODE *p_node ); @end example @end ifset @@ -129,7 +132,8 @@ int nget_nod( @ifset is-C @example -int nget_ver( +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 beca84d39f..54b2d59883 100644 --- a/doc/itron3.0/rendezvous.t +++ b/doc/itron3.0/rendezvous.t @@ -52,7 +52,8 @@ and status codes. @ifset is-C @example -int cre_por( +ER cre_por ( + ID porid, T_CPOR *pk_cpor ); @end example @end ifset @@ -80,7 +81,8 @@ int cre_por( @ifset is-C @example -int del_por( +ER del_por ( + ID porid ); @end example @end ifset @@ -108,7 +110,8 @@ int del_por( @ifset is-C @example -int cal_por( +ER cal_por ( + VP msg, INT *p_rmsgsz, ID porid, UINT calptn, INT ER ercd =pcal_por ); @end example @end ifset @@ -136,7 +139,8 @@ int cal_por( @ifset is-C @example -int pcal_por( +ER ercd =pcal_por ( + VP msg, INT *p_rmsgsz, ID porid, UINT calptn, INT ); @end example @end ifset @@ -164,7 +168,8 @@ int pcal_por( @ifset is-C @example -int tcal_por( +ER ercd =tcal_por ( + VP msg, INT *p_rmsgsz, ID porid, UINT calptn, INT ); @end example @end ifset @@ -192,7 +197,8 @@ int tcal_por( @ifset is-C @example -int acp_por( +ER acp_por ( + RNO *p_rdvno, VP msg, INT *p_cmsgsz, ID porid, UINT ER ercd =pacp_por ); @end example @end ifset @@ -220,7 +226,8 @@ int acp_por( @ifset is-C @example -int pacp_por( +ER ercd =pacp_por ( + RNO *p_rdvno, VP msg, INT *p_cmsgsz, ID porid, UINT ); @end example @end ifset @@ -248,7 +255,8 @@ int pacp_por( @ifset is-C @example -int tacp_por( +ER ercd =tacp_por ( + RNO *p_rdvno, VP msg, INT *p_cmsgsz, ID porid, UINT ); @end example @end ifset @@ -276,7 +284,8 @@ int tacp_por( @ifset is-C @example -int fwd_por( +ER fwd_por ( + ID porid, UINT calptn, RNO rdvno, VP msg, INT cmsgsz ); @end example @end ifset @@ -304,7 +313,8 @@ int fwd_por( @ifset is-C @example -int rpl_rdv( +ER rpl_rdv ( + RNO rdvno, VP msg, INT rmsgsz ); @end example @end ifset @@ -332,7 +342,8 @@ int rpl_rdv( @ifset is-C @example -int ref_por( +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 f349fb5f70..f015869bf9 100644 --- a/doc/itron3.0/tasksync.t +++ b/doc/itron3.0/tasksync.t @@ -48,7 +48,8 @@ and status codes. @ifset is-C @example -int sus_tsk( +ER sus_tsk ( + ID tskid ); @end example @end ifset @@ -76,7 +77,8 @@ int sus_tsk( @ifset is-C @example -int rsm_tsk( +ER rsm_tsk ( + ID tskid ER ercd =frsm_tsk ); @end example @end ifset @@ -104,7 +106,8 @@ int rsm_tsk( @ifset is-C @example -int frsm_tsk( +ER ercd =frsm_tsk ( + ID tskid ); @end example @end ifset @@ -132,7 +135,8 @@ int frsm_tsk( @ifset is-C @example -int slp_tsk( +ER slp_tsk ( + ER ercd =tslp_tsk ); @end example @end ifset @@ -160,7 +164,8 @@ No polling function for slp_tsk is provided. A similar function can be implemen @subheading CALLING SEQUENCE: @ifset is-C -int tslp_tsk( +ER ercd =tslp_tsk ( + TMO tmout TMO tmout ); @end example @@ -188,7 +193,8 @@ If you simply wish to delay a task (make it wait for a while), use dly_tsk rathe @subheading CALLING SEQUENCE: @ifset is-C -int wup_tsk( +ER wup_tsk ( + ID tskid ID tskid ); @end example @@ -216,7 +222,8 @@ An E_QOVR error will result if wup_tsk is issued more than the maximum value all @subheading CALLING SEQUENCE: @ifset is-C -int can_wup( +ER can_wup ( + INT *p_wupcnt, ID tskid ID tskid ); @end example diff --git a/doc/itron3.0/time.t b/doc/itron3.0/time.t index ff61605cad..bc60c0c5ea 100644 --- a/doc/itron3.0/time.t +++ b/doc/itron3.0/time.t @@ -50,7 +50,8 @@ and status codes. @ifset is-C @example -int get_tim( +ER get_tim ( + SYSTIME *pk_tim ); @end example @end ifset @@ -78,7 +79,8 @@ int get_tim( @ifset is-C @example -int set_tim( +ER set_tim ( + SYSTIME *pk_tim ); @end example @end ifset @@ -106,7 +108,8 @@ int set_tim( @ifset is-C @example -int dly_tsk( +ER dly_tsk ( + DLYTIME dlytim ); @end example @end ifset @@ -134,7 +137,8 @@ int dly_tsk( @ifset is-C @example -int def_cyc( +ER def_cyc ( + HNO cycno, T_DCYC *pk_dcyc ); @end example @end ifset @@ -162,7 +166,8 @@ int def_cyc( @ifset is-C @example -int act_cyc( +ER act_cyc ( + HNO cycno, UINT cycact ); @end example @end ifset @@ -190,7 +195,8 @@ int act_cyc( @ifset is-C @example -int ref_cyc( +ER ref_cyc ( + T_RCYC *pk_rcyc, HNO cycno ); @end example @end ifset @@ -218,7 +224,8 @@ int ref_cyc( @ifset is-C @example -int def_alm( +ER def_alm ( + HNO almno, T_DALM *pk_dalm ); @end example @end ifset @@ -246,7 +253,8 @@ int def_alm( @ifset is-C @example -int ref_alm( +ER ref_alm ( + T_RALM *pk_ralm, HNO almno ); @end example @end ifset @@ -274,7 +282,8 @@ int ref_alm( @ifset is-C @example -int ret_tmr( +void ret_tmr ( + ); @end example @end ifset -- cgit v1.2.3