T-Kernel Specification (1.B0.02)

156 CHAPTER 4. T-KERNEL/OS FUNCTIONS
tk cre mpl
Create Variable-size Memory Pool
[C Language Interface]
ID mplid = tk_cre_mpl ( T_CMPL *pk_cmpl ) ;
[Parameters]
T CMPL* pk cmpl Information about the variable-size memory pool to be created
pk cmpf detail:
VP exinf Extended information
ATR mplatr Memory pool attributes
INT mplsz Memory pool size (in bytes)
(Other implementation-dependent parameters may be added beyond this point.)
[Return Parameters]
ID mplid Variable-size memory pool ID
or Error Code
[Error Codes]
E OK
E NOMEM
E LIMIT
E RSATR
E PAR
Normal completion
Insufficient memory (memory for control block or memory pool area cannot be allocated)
Number of variable-size memory pools exceeds the system limit
Reserved attribute (mplatr is invalid or cannot be used)
Parameter error (pk cmpl is invalid, or mplsz is negative or invalid)
[Description]
Creates a variable-size memory pool, assigning to it a variable-size memory pool ID.
This system call allocates a memory space for use as a memory pool, based on the information in
parameter mplsz, and allocates a control block to the created memory pool.
exinf can be used freely by the user to set miscellaneous information about the created memory pool.
The information set in this parameter can be referenced by tk ref mpl. If a larger area is needed
for indicating user information, or if the information may need to be changed after the memory pool
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.
mplatr indicates system attributes in its low bits and implementation-dependent information in the
high bits. Designation in the system attributes part of mplatr is as follows.
mplatr:= (TA_TFIFO || TA_TPRI) | [TA_NODISWAI]
| (TA_RNG0 || TA_RNG1 || TA_RNG2 || TA_RNG3)
Copyright c○ 2002, 2003 by T-Engine Forum
T-Kernel 1.B0.02