T-Kernel Specification (1.B0.02)

4.7. TIME MANAGEMENT FUNCTIONS 177
tk cre alm
Create Alarm Handler
[C Language Interface]
ID almid = tk_cre_alm ( T_CALM *pk_calm ) ;
[Parameters]
T CALM* pk calm Address of alarm handler definition packet
pk calm detail:
VP exinf Extended information
ATR almatr Alarm handler attributes
FP almhdr Alarm handler address
[Return Parameters]
ID almid Alarm handler ID
or Error Code
[Error Codes]
E OK
E NOMEM
E LIMIT
E RSATR
E PAR
Normal completion
Insufficient memory (memory for control block cannot be allocated)
Number of alarm handlers exceeds the system limit
Reserved attribute (almatr is invalid or cannot be used)
Parameter error (almno, pk calm, or almhdr is invalid or cannot be used)
[Description]
Creates an alarm handler, assigning to it an alarm handler ID. An alarm handler is a handler running
at the designated time as a task-independent portion.
exinf can be used freely by the user to set miscellaneous information about the created alarm handler.
The information set in this parameter can be referenced by tk ref alm. If a larger area is needed for
indicating user information, or if the information may need to be changed after the alarm handler is
created, this can be done by allocating separate memory for this purpose and putting the memory packet
address in exinf. The OS pays no attention to the contents of exinf.
almatr indicates system attributes in its low bits and implementation-dependent information in the
high bits. Designation in the system attributes part of almatr is as follows.
almatr := (TA_ASM || TA_HLNG)
TA ASM
TA HLNG
The handler is written in assembly language
The handler is written in high-level language
Copyright c○ 2002, 2003 by T-Engine Forum
T-Kernel 1.B0.02