μT-Kernel/DS Functions

μT-Kernel 2.0 Specification
Prev		Next

	Overall Note and Supplement
	Except where otherwise noted, μT-Kernel/DS system calls (td_...) can be called from a task independent portion and while dispatching and interrupts are disabled. There may be some limitations, however, imposed by particular implementations. When μT-Kernel/DS system calls (td_...) are invoked in interrupts disabled state, they are processed without enabling interrupts. Other kernel states likewise remain unchanged during this processing. Changes in kernel states may occur if a service call is invoked while interrupts or dispatching are enabled, since the kernel continues operating. μT-Kernel/DS system calls (td_...) cannot be invoked from a lower protection level than that at which μT-Kernel/OS system calls can be invoked (lower than `TSVCLimit`)(E_OACV). Error codes such as E_PAR, E_MACV, and E_CTX that can be returned in many situations are not described here always unless there is some special reason for doing so. Detection of error codes E_PAR, E_MACV, and E_CTX is implementation-dependent; these may not always be detected as error. For this reason, the service calls must not be invoked in such a way that these errors might occur.

td_lst_tsk - Reference Task ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_tsk (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of task ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used tasks
or		Error Code	Error code

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Gets the list of the IDs of the currently used tasks, and puts in list up to nent IDs. The number of the used tasks is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_sem - Reference Semaphore ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_sem (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of semaphore ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used semaphores
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used semaphores, and puts in list up to nent IDs. The number of the used semaphores is passed in the return code. If return code > nent, this means not all semaphore IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_flg - Reference Event Flag ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_flg (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of event flag ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used event flags
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used event flags, and puts in list up to nent IDs. The number of the used event flags is passed in the return code. If return code > nent, this means not all event flag IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_mbx - Reference Mailbox ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_mbx (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of mailbox ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used mailboxes
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used mailboxes, and puts in list up to nent IDs. The number of the used mailboxes is passed in the return code. If return code > nent, this means not all mailbox IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_mtx - Reference Mutex ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_mtx (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of mutex ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used mutexes
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used mutexes, and puts in list up to nent IDs. The number of the used mutexes is passed in the return code. If return code > nent, this means not all mutex IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_mbf - Reference Message Buffer ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_mbf (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of message buffer ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used message buffers
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used message buffers, and puts in list up to nent IDs. The number of the used message buffers is passed in the return code. If return code > nent, this means not all message buffer IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_por - Reference Rendezvous Port ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_por (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of rendezvous port ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used rendezvous ports
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used rendezvous ports, and puts in list up to nent IDs. The number of the used rendezvous ports is passed in the return code. If return code > nent, this means not all rendezvous port IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_mpf - Reference Fixed-size Memory Pool ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_mpf (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of fixed-size memory pool ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used fixed-size memory pools
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used fixed-size memory pools, and puts in list up to nent IDs. The number of the used fixed-size memory pools is passed in the return code. If return code > nent, this means not all fixed-size memory pool IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_mpl - Reference Variable-size Memory Pool ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_mpl (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of variable-size memory pool ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used variable-size memory pools
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used variable-size memory pools, and puts in list up to nent IDs. The number of the used variable-size memory pools is passed in the return code. If return code > nent, this means not all variable-size memory pool IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_cyc - Reference Cyclic Handler ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_cyc (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of cyclic handler ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used cyclic handlers
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used cyclic handlers, and puts in list up to nent IDs. The number of the used cyclic handlers is passed in the return code. If return code > nent, this means not all cyclic handler IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_alm - Reference Alarm Handler ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_alm (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of alarm handler ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used alarm handlers
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used alarm handlers, and puts in list up to nent IDs. The number of the used alarm handlers is passed in the return code. If return code > nent, this means not all alarm handler IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_lst_ssy - Reference Subsystem ID List

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_lst_ssy (ID list[], INT nent );

Parameter

ID	`list[]`	List	Location of subsystem ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of used subsystems
or		Error Code	Error code

Error Code

None.

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the currently used subsystems, and puts in list up to nent IDs. The number of the used subsystems is passed in the return code. If return code > nent, this means not all subsystem IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_rdy_que - Reference Task Precedence

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_rdy_que (PRI pri , ID list[], INT nent );

Parameter

PRI	`pri`	Task Priority	Task priority
ID	`list[]`	Task ID List	Location of task ID list
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of tasks with priority `pri` in a run state
or		Error Code	Error code

Error Code

E_PAR Parameter error (pri is invalid or cannot be used)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets a list of IDs of the tasks in a run state (READY state or RUNNING state) whose task priority is pri, arranged in the order from the highest to the lowest precedence.

This function stores in list up to nent task IDs, arranged in the order of precedence starting from the highest-precedence task ID at the head of the list.

The number of tasks in a run state with priority pri is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_sem_que - Reference Semaphore Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_sem_que (ID semid , ID list[], INT nent );

Parameter

ID	`semid`	Semaphore ID	Target semaphore ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`semid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the semaphore specified in `semid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for a semaphore specified in semid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the semaphore queue. The number of the tasks in the semaphore queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_flg_que - Reference Event Flag Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_flg_que (ID flgid , ID list[], INT nent );

Parameter

ID	`flgid`	EventFlag ID	Target event flag ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`flgid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the event flag specified in `flgid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for an event flag specified in flgid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the event flag queue. The number of the tasks in the event flag queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_mbx_que - Reference Mailbox Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_mbx_que (ID mbxid , ID list[], INT nent );

Parameter

ID	`mbxid`	Mailbox ID	Target mailbox ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`mbxid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the mailbox specified in `mbxid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for a mailbox specified in mbxid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the mailbox queue. The number of the tasks in the mailbox queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_mtx_que - Reference Mutex Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_mtx_que (ID mtxid , ID list[], INT nent );

Parameter

ID	`mtxid`	Mutex ID	Target mutex ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`mtxid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the mutex specified in `mtxid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for a mutex specified in mtxid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the mutex queue. The number of the tasks in the mutex queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_smbf_que - Reference Message Buffer Send Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_smbf_que (ID mbfid , ID list[], INT nent );

Parameter

ID	`mbfid`	Message Buffer ID	Target message buffer ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`mbfid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the message buffer specified in `mbfid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for sending a message to a message buffer specified in mbfid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the message buffer send queue. The number of the tasks in the message buffer send queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_rmbf_que - Reference Message Buffer Receive Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_rmbf_que (ID mbfid , ID list[], INT nent );

Parameter

ID	`mbfid`	Message Buffer ID	Target message buffer ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`mbfid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the message buffer specified in `mbfid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for receiving a message from a message buffer specified in mbfid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the message buffer receive queue. The number of the tasks in the message buffer receive queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_cal_que - Reference Call Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_cal_que (ID porid , ID list[], INT nent );

Parameter

ID	`porid`	Port ID	Target rendezvous port ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`porid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the rendezvous port specified in `porid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for rendezvous call at a port specified in porid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the rendezvous call queue. The number of the tasks in the rendezvous call queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_acp_que - Reference Accept Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_acp_que (ID porid , ID list[], INT nent );

Parameter

ID	`porid`	Port ID	Target rendezvous port ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`porid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the rendezvous port specified in `porid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for rendezvous acceptance at a port specified in porid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the rendezvous acceptance queue. The number of the tasks in the rendezvous acceptance queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_mpf_que - Reference Fixed-size Memory Pool Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_mpf_que (ID mpfid , ID list[], INT nent );

Parameter

ID	`mpfid`	Memory Pool ID	Target fixed-size memory pool ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`mpfid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the fixed-size memory pool specified in `mpfid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for allocation in a fixed-size memory pool specified in mpfid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the fixed-size memory pool queue. The number of the tasks in the fixed-size memory pool queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_mpl_que - Reference Variable-size Memory Pool Queue

C Language Interface

#include <tk/dbgspt.h>

INT ct = td_mpl_que (ID mplid , ID list[], INT nent );

Parameter

ID	`mplid`	Memory Pool ID	Target variable-size memory pool ID
ID	`list[]`	Task ID List	Location of waiting task IDs
INT	`nent`	Number of List Entries	Maximum number of entries in `list`

Return Parameter

INT	`ct`	Count	Number of waiting tasks
or		Error Code	Error code

Error Code

E_ID	Invalid ID number (`mplid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the variable-size memory pool specified in `mplid` does not exist)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the list of the IDs of the queued tasks waiting for allocation in a variable-size memory pool specified in mplid. This function stores in list up to nent task IDs, arranged in the order in which tasks are queued, starting from the first task in the variable-size memory pool queue. The number of the tasks in the variable-size memory pool queue is passed in the return code. If return code > nent, this means not all task IDs could be retrieved.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_tsk - Reference Task Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_tsk (ID tskid , TD_RTSK *rtsk );

Parameter

ID	`tskid`	Task ID	Target task ID (`TSK_SELF` can be specified)
TD_RTSK*	`rtsk`	Packet to Return Task Status	Pointer to the area to return the task status

Return Parameter

ER ercd Error Code Error code

rtsk Detail:

void*	`exinf`	Extended Information	Extended information
PRI	`tskpri`	Task Priority	Current priority
PRI	`tskbpri`	Task Base Priority	Base priority
UINT	`tskstat`	Task State	Task States
UW	`tskwait`	Task Wait Factor	Wait factor
ID	`wid`	Waiting Object ID	Waiting object ID
INT	`wupcnt`	Wakeup Count	Wakeup request queuing count
INT	`suscnt`	Suspend Count	Suspend request nesting count
RELTIM	`slicetime`	Slice Time	Maximum continuous run time (in ms)
UW	`waitmask`	Wait Mask	Disabled wait factors
UINT	`texmask`	Task Exception Mask	Allowed task exceptions
UINT	`tskevent`	Task Event	Raised task event
FP	`task`	Task Start Address	Task start address
SZ	`stksz`	User Stack Size	User stack size (in bytes)
SZ	`sstksz`	System Stack Size	System stack size (in bytes)
void*	`istack`	Initial User Stack Pointer	User stack pointer initial value
void*	`isstack`	Initial System Stack Pointer	System stack pointer initial value

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

`TK_SUPPORT_SLICETIME`	Support for obtaining (`slicetime`)
`TK_SUPPORT_DISWAI`	Information about disabled wait factors (`waitmask`) is obtainable
`TK_SUPPORT_TASKEXCEPTION`	Task exception information (`texmask`) can be acquired.
`TK_SUPPORT_TASKEVENT`	Generated task event(`tskevent`)can be acquired
`TK_HAS_SYSSTACK`	Task can have a system stack independent of user-stack, and information can be acquired of the system stack as well as user stack(`sstksz` and `isstack`)

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the state of the task designated in tskid. This function is similar to tk_ref_tsk(), with the task start address and stack information added to the state information obtained.

The stack area extends from the stack pointer initial value toward the low addresses for the number of bytes designated as the stack size.

istack - stksz ≦ user stack area < istack
isstack - sstksz ≦ system stack area < isstack

Note that the stack pointer initial value (istack, isstack) is not the same as its current position. The stack area may be used even before a task is started. Calling td_get_reg() gets the stack pointer current position.

slicetime in the task status information (TD_RTSK) returns a value rounded to milliseconds. To know the value in microseconds, call td_ref_tsk_u.

Difference from T-Kernel 2.0

The data type of members, tskwait and waitmask, of TD_RTSK has been changed from UINT to UW.

The data type of members, stksz and sstksz, of TD_RTSK has been changed from INT to SZ.

Difference from μT-Kernel 1.0

Introduction of service profile has made it possible to use the following features, which had been removed from μT-Kernel before, within the restrictions described by the profile: acquiring of the following information about slice time(slicetime), disabled wait factors (waitmask), task exception (texmask), task event (tskevent), system stack size (sstksz), and system stack pointer initial value (isstack).

Per the description above, tskstat can return TTS_NODISWAI (reject request to disable wait) and tskwait can return a value (TTW_EVn) which is related to task event.

The data type of members, stksz and sstksz, of TD_RTSK has been changed from INT to SZ.

td_ref_tsk_u - Reference Task Status (Microseconds)

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_tsk_u (ID tskid , TD_RTSK_U *rtsk_u );

Parameter

ID	`tskid`	Task ID	Target task ID (`TSK_SELF` can be specified)
TD_RTSK_U*	`rtsk_u`	Packet to Return Task Status	Pointer to the area to return the task status

Return Parameter

ER ercd Error Code Error code

rtsk_u Detail:

void*	`exinf`	Extended Information	Extended information
PRI	`tskpri`	Task Priority	Current priority
PRI	`tskbpri`	Task Base Priority	Base priority
UINT	`tskstat`	Task State	Task States
UW	`tskwait`	Task Wait Factor	Wait factor
ID	`wid`	Waiting Object ID	Waiting object ID
INT	`wupcnt`	Wakeup Count	Wakeup request queuing count
INT	`suscnt`	Suspend Count	Suspend request nesting count
RELTIM_U	`slicetime_u`	Slice Time	Maximum continuous run time (in microseconds)
UW	`waitmask`	Wait Mask	Disabled wait factors
UINT	`texmask`	Task Exception Mask	Allowed task exceptions
UINT	`tskevent`	Task Event	Raised task event
FP	`task`	Task Start Address	Task start address
SZ	`stksz`	User Stack Size	User stack size (in bytes)
SZ	`sstksz`	System Stack Size	System stack size (in bytes)
void*	`istack`	Initial User Stack Pointer	User stack pointer initial value
void*	`isstack`	Initial System Stack Pointer	System stack pointer initial value

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_USEC`	Support instructions that can handle time in microsecond resolutions

Other service profile items related to td_ref_tsk are also related to this system call.

Description

This system call takes slicetime_u in 64-bit microseconds instead of the return parameter slicetime of td_ref_tsk.

The specification of this system call is same as that of td_ref_tsk, except that a field in the return parameter is replaced with slicetime_u. For more details, see the description of td_ref_tsk.

Difference from T-Kernel 2.0

The data type of members, tskwait and waitmask, of TD_RTSK_U has been changed from UINT to UW.

The data type of members, stksz and sstksz, of TD_RTSK_U has been changed from INT to SZ.

Difference from μT-Kernel 1.0

New API introduced based on T-Kernel 2.0 specification

td_ref_tex - Reference Task Exception Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_tex (ID tskid , TD_RTEX *pk_rtex );

Parameter

ID	`tskid`	Task ID	Target task ID (`TSK_SELF` can be specified)
TD_RTEX*	`pk_rtex`	Packet to Return Task Exception Status	Pointer to the area to return the task exception status

Return Parameter

ER ercd Error Code Error code

pk_rtex Detail:

UINT	`pendtex`	Pending Task Exception	Pending task exceptions
UINT	`texmask`	Task Exception Mask	Allowed task exceptions

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_TASKEXCEPTION`	Support task exception function

Description

Gets the task exception status. This is similar to tk_ref_tex().

Difference from μT-Kernel 1.0

This API was not in the older μT-Kernel specification, but, with the introduction of service profile mechanism, this API can now be used when the profile permits it.

td_ref_sem - Reference Semaphore Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_sem (ID semid , TD_RSEM *rsem );

Parameter

ID	`semid`	Semaphore ID	Target semaphore ID
TD_RSEM*	`rsem`	Packet to Return Semaphore Status	Pointer to the area to return the semaphore status

Return Parameter

ER ercd Error Code Error code

rsem Detail:

void*	`exinf`	Extended Information	Extended information
ID	`wtsk`	Wait Task Information	Waiting task ID
INT	`semcnt`	Semaphore Count	current semaphore count value

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the semaphore status. This is similar to tk_ref_sem().

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_flg - Reference Event Flag Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_flg (ID flgid , TD_RFLG *rflg );

Parameter

ID	`flgid`	EventFlag ID	Target event flag ID
TD_RFLG*	`rflg`	Packet to Return EventFlag Status	Pointer to the area to return the event flag status

Return Parameter

ER ercd Error Code Error code

rflg Detail:

void*	`exinf`	Extended Information	Extended information
ID	`wtsk`	Wait Task Information	Waiting task ID
UINT	`flgptn`	EventFlag Bit Pattern	The current event flag bit pattern

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the event flag status. This is similar to tk_ref_flg().

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_mbx - Reference Mailbox Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_mbx (ID mbxid , TD_RMBX *rmbx );

Parameter

ID	`mbxid`	Mailbox ID	Target mailbox ID
TD_RMBX*	`rmbx`	Packet to Return Mailbox Status	Pointer to the area to return the mailbox status

Return Parameter

ER ercd Error Code Error code

rmbx Detail:

void*	`exinf`	Extended Information	Extended information
ID	`wtsk`	Wait Task Information	Waiting task ID
T_MSG*	`pk_msg`	Packet of Message	Next message to be received

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the mailbox status. This is similar to tk_ref_mbx().

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_mtx - Refer Mutex Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_mtx (ID mtxid , TD_RMTX *rmtx );

Parameter

ID	`mtxid`	Mutex ID	Target mutex ID
TD_RMTX*	`rmtx`	Packet to Return Mutex Status	Pointer to the area to return the mutex status

Return Parameter

ER ercd Error Code Error code

rmtx Detail:

void*	`exinf`	Extended Information	Extended information
ID	`htsk`	Locking Task ID	ID of task locking the mutex
ID	`wtsk`	Lock Waiting Task ID	ID of tasks waiting to lock the mutex

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the mutex status. This is similar to tk_ref_mtx().

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_mbf - Reference Message Buffer Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_mbf (ID mbfid , TD_RMBF *rmbf );

Parameter

ID	`mbfid`	Message Buffer ID	Target message buffer ID
TD_RMBF*	`rmbf`	Packet to Return Message Buffer Status	Pointer to the area to return the message buffer status

Return Parameter

ER ercd Error Code Error code

rmbf Detail:

void*	`exinf`	Extended Information	Extended information
ID	`wtsk`	Wait Task Information	Receive wait task ID
ID	`stsk`	Send Task Information	Send wait task ID
INT	`msgsz`	Message Size	Size of the next message to be received (in bytes)
SZ	`frbufsz`	Free Buffer Size	Free buffer size (in bytes)
INT	`maxmsz`	Maximum Message Size	Maximum message size (in bytes)

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the message buffer status. This is similar to tk_ref_mbf().

Difference from T-Kernel 2.0

The data type of member, frbufsz, of TD_RMBF has been changed from INT to SZ.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

The data type of member, frbufsz, of TD_RMBF has been changed from INT to SZ.

td_ref_por - Reference Port Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_por (ID porid , TD_RPOR *rpor );

Parameter

ID	`porid`	Port ID	Target rendezvous port ID
TD_RPOR*	`rpor`	Packet to Return Port Status	Pointer to the area to return the rendezvous port status

Return Parameter

ER ercd Error Code Error code

rpor Detail:

void*	`exinf`	Extended Information	Extended information
ID	`wtsk`	Wait Task Information	Call waiting task ID
ID	`atsk`	Accept Task Information	Accept waiting task ID
INT	`maxcmsz`	Maximum Call Message Size	Maximum call message size (in bytes)
INT	`maxrmsz`	Maximum Reply Message Size	Maximum reply message size (in bytes)

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the rendezvous port status. This is similar to tk_ref_por().

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_mpf - Reference Fixed-size Memory Pool Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_mpf (ID mpfid , TD_RMPF *rmpf );

Parameter

ID	`mpfid`	Memory Pool ID	Target fixed-size memory pool ID
TD_RMPF*	`rmpf`	Packet to Return Memory Pool Status	Pointer to the area to return the memory pool status

Return Parameter

ER ercd Error Code Error code

rmpf Detail:

void*	`exinf`	Extended Information	Extended information
ID	`wtsk`	Wait Task Information	Waiting task ID
SZ	`frbcnt`	Free Block Count	Free block count

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the fixed-size memory pool status. This is similar to tk_ref_mpf().

Difference from T-Kernel 2.0

The data type of member, frbcnt, of TD_RMPF has been changed from INT to SZ.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

The data type of member, frbcnt, of TD_RMPF has been changed from W to SZ.

td_ref_mpl - Reference Variable-size Memory Pool Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_mpl (ID mplid , TD_RMPL *rmpl );

Parameter

ID	`mplid`	Memory Pool ID	Target variable-size memory pool ID
TD_RMPL*	`rmpl`	Packet to Return Memory Pool Status	Pointer to the area to return the memory pool status

Return Parameter

ER ercd Error Code Error code

rmpl Detail:

void*	`exinf`	Extended Information	Extended information
ID	`wtsk`	Wait Task Information	Waiting task ID
SZ	`frsz`	Free Memory Size	Free memory size (in bytes)
SZ	`maxsz`	Max Memory Size	Maximum memory space size (in bytes)

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the variable-size memory pool status. This is similar to tk_ref_mpl().

Difference from T-Kernel 2.0

The data type of members, frsz and maxsz, of TD_RMPL has been changed from INT to SZ.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

The data type of members, frsz and maxsz, of TD_RMPL has been changed from W to SZ.

td_ref_cyc - Reference Cyclic Handler Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_cyc (ID cycid , TD_RCYC *rcyc );

Parameter

ID	`cycid`	Cyclic Handler ID	Target cyclic handler ID
TD_RCYC*	`rcyc`	Packet to Return Cyclic Handler Status	Pointer to the area to return the cyclic handler status

Return Parameter

ER ercd Error Code Error code

rcyc Detail:

void*	`exinf`	Extended Information	Extended information
RELTIM	`lfttim`	Left Time	Time remaining until the next handler starts (ms)
UINT	`cycstat`	Cyclic Handler Status	Cyclic handler activation state

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the cyclic handler status. This is similar to tk_ref_cyc().

The time remaining lfttim returned in the cyclic handler status information (TD_RCYC) obtained by td_ref_cyc is a value rounded to milliseconds. To know the value in microseconds, call td_ref_cyc_u.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_cyc_u - Reference Cyclic Handler Status (Microseconds)

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_cyc_u (ID cycid , TD_RCYC_U *rcyc_u );

Parameter

ID	`cycid`	Cyclic Handler ID	Target cyclic handler ID
TD_RCYC_U*	`rcyc_u`	Packet to Return Cyclic Handler Status	Pointer to the area to return the cyclic handler status

Return Parameter

ER ercd Error Code Error code

rcyc_u Detail:

void*	`exinf`	Extended Information	Extended information
RELTIM_U	`lfttim_u`	Left Time	Time remaining until the next handler starts (microseconds)
UINT	`cycstat`	Cyclic Handler Status	Cyclic handler activation state

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_USEC`	Support instructions that can handle time in microsecond resolutions

Description

This system call takes 64-bit lfttim_u in microseconds instead of the return parameter lfttim of td_ref_cyc.

The specification of this system call is same as that of td_ref_cyc, except that the return parameter is replaced with lfttim_u. For more details, see the description of td_ref_cyc.

Difference from μT-Kernel 1.0

New API introduced based on T-Kernel 2.0 specification

td_ref_alm - Reference Alarm Handler Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_alm (ID almid , TD_RALM *ralm );

Parameter

ID	`almid`	Alarm Handler ID	Target alarm handler ID
TD_RALM*	`ralm`	Packet to Return Alarm Handler Status	Pointer to the area to return the alarm handler status

Return Parameter

ER ercd Error Code Error code

ralm Detail:

void*	`exinf`	Extended Information	Extended information
RELTIM	`lfttim`	Left Time	Time remaining until the handler starts (ms)
UINT	`almstat`	Alarm Handler Status	Alarm handler activation state

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the alarm handler status. This is similar to tk_ref_alm().

The time remaining lfttim returned in the alarm handler status information (TD_RALM) obtained by td_ref_alm is a value rounded to milliseconds. To know the value in microseconds, call td_ref_alm_u.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_alm_u - Reference Alarm Handler Status (Microseconds)

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_alm_u (ID almid , TD_RALM_U *ralm_u );

Parameter

ID	`almid`	Alarm Handler ID	Target alarm handler ID
TD_RALM_U*	`ralm_u`	Packet to Return Alarm Handler Status	Pointer to the area to return the alarm handler status

Return Parameter

ER ercd Error Code Error code

ralm_u Detail:

void*	`exinf`	Extended Information	Extended information
RELTIM_U	`lfttim_u`	Left Time	Time remaining until the handler starts (microseconds)
UINT	`almstat`	Alarm Handler Status	Alarm handler activation state

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_USEC`	Support instructions that can handle time in microsecond resolutions

Description

This system call takes 64-bit lfttim_u in microseconds instead of the return parameter lfttim of td_ref_alm.

The specification of this system call is same as that of td_ref_alm, except that the return parameter is replaced with lfttim_u. For more details, see the description of td_ref_alm.

Difference from μT-Kernel 1.0

New API introduced based on T-Kernel 2.0 specification

td_ref_sys - Reference System Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_sys (TD_RSYS *pk_rsys );

Parameter

TD_RSYS* pk_rsys Packet to Return System Status Pointer to the area to return the system status

Return Parameter

ER ercd Error Code Error code

pk_rsys Detail:

UINT	`sysstat`	System State	System States
ID	`runtskid`	Running Task ID	ID of the task currently in RUNNING state
ID	`schedtskid`	Scheduled Task ID	ID of the task scheduled to run next

Error Code

E_OK	Normal completion

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the system status. This is similar to tk_ref_sys().

Difference from T-Kernel 2.0

The data type of member, sysstat, of TD_RSYS has been changed from INT to UINT.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_ref_ssy - Reference Subsystem Status

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_ssy (ID ssid , TD_RSSY *rssy );

Parameter

ID	`ssid`	Subsystem ID	Target subsystem ID
TD_RSSY*	`rssy`	Packet to Return Subsystem Status	Pointer to the area to return the subsystem definition information

Return Parameter

ER ercd Error Code Error code

rssy Detail:

PRI	`ssypri`	Subsystem Priority	Subsystem priority
SZ	`resblksz`	Resource Control Block Size	Resource control block size (in bytes)

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

References the subsystem status. This is similar to tk_ref_ssy().

Difference from T-Kernel 2.0

The data type of member, resblksz, of TD_RSSY has been changed from INT to SZ.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

The data type of member, resblksz, of TD_RSSY has been changed from W to SZ.

td_inf_tsk - Reference Task Statistics

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_inf_tsk (ID tskid , TD_ITSK *pk_itsk , BOOL clr );

Parameter

ID	`tskid`	Task ID	Target task ID (`TSK_SELF` can be specified)
TD_ITSK*	`pk_itsk`	Packet to Return Task Statistics	Pointer to the area to return the task statistics
BOOL	`clr`	Clear	Task statistics clear flag

Return Parameter

ER ercd Error Code Error code

pk_itsk Detail:

RELTIM	`stime`	System Time	Cumulative system-level run time (ms)
RELTIM	`utime`	User Time	Cumulative user-level run time (ms)

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_TASKINF`	Support for acquiring task-related statistics

Description

Gets task statistics. This is similar to tk_inf_tsk(). If clr = TRUE (≠ 0), the cumulative information is reset (cleared to 0) after the information is obtained.

stime and utime in the task statistics (TD_ITSK) return values rounded to milliseconds. To know the value in microseconds, call td_inf_tsk_u.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_inf_tsk_u - Reference Task Statistics (Microseconds)

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_inf_tsk_u (ID tskid , TD_ITSK_U *itsk_u , BOOL clr );

Parameter

ID	`tskid`	Task ID	Target task ID (`TSK_SELF` can be specified)
TD_ITSK_U*	`itsk_u`	Packet to Return Task Statistics	Pointer to the area to return the task statistics
BOOL	`clr`	Clear	Task statistics clear flag

Return Parameter

ER ercd Error Code Error code

itsk_u Detail:

RELTIM_U	`stime_u`	System Time	Cumulative system-level run time (in microseconds)
RELTIM_U	`utime_u`	User Time	Cumulative user-level run time (in microseconds)

Error Code

E_OK	Normal completion
E_ID	Bad identifier
E_NOEXS	Object does not exist

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_TASKINF`	Support for acquiring task-related statistics
`TK_SUPPORT_USEC`	Support instructions that can handle time in microsecond resolutions

Description

This system call takes 64-bit stime_u and utime_u in microseconds instead of the return parameters stime and utime of td_inf_tsk.

The specification of this system call is same as that of td_inf_tsk, except that the return parameters are replaced with stime_u and utime_u. For more details, see the description of td_inf_tsk.

Difference from μT-Kernel 1.0

New API introduced based on T-Kernel 2.0 specification

td_get_reg - Get Task Register

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_get_reg (ID tskid , T_REGS *pk_regs , T_EIT *pk_eit , T_CREGS *pk_cregs );

Parameter

ID	`tskid`	Task ID	Target task ID (`TSK_SELF` cannot be specified)
T_REGS*	`pk_regs`	Packet of Registers	Pointer to the area to return the general register values
T_EIT*	`pk_eit`	Packet of EIT Registers	Pointer to the area to return the values of registers saved when an exception occurs
T_CREGS*	`pk_cregs`	Packet of Control Registers	Pointer to the area to return the control register values

Return Parameter

ER ercd Error Code Error code

The contents of T_REGS, T_EIT, and T_CREGS are defined for each CPU and implementation.

Error Code

E_OK	Normal completion
E_ID	Invalid ID number (`tskid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the task specified in `tskid` does not exist)
E_OBJ	Invalid object state (issued for a RUNNING state task)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_REGOPS`	Support for task-register manipulation functions

Description

Gets the register values of the task designated in tskid. This is similar to tk_get_reg.

Registers cannot be referenced for the task currently in RUNNING state. Except when a task-independent portion is executing, the current RUNNING state task is the invoking task.

If NULL is set in pk_regs, pk_eit, or pk_cregs, the corresponding registers are not referenced.

The contents of T_REGS, T_EIT, and T_CREGS are implementation-dependent.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_set_reg - Set Task Registers

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_set_reg (ID tskid , CONST T_REGS *pk_regs , CONST T_EIT *pk_eit , CONST T_CREGS *pk_cregs );

Parameter

ID	`tskid`	Task ID	Target task ID (`TSK_SELF` cannot be specified)
CONST T_REGS*	`pk_regs`	Packet of Registers	General registers
CONST T_EIT*	`pk_eit`	Packet of EIT Registers	Registers saved when EIT occurs
CONST T_CREGS*	`pk_cregs`	Packet of Control Registers	Control registers

The contents of T_REGS, T_EIT, and T_CREGS are defined for each CPU and implementation.

Return Parameter

ER ercd Error Code Error code

Error Code

E_OK	Normal completion
E_ID	Invalid ID number (`tskid` is invalid or cannot be used)
E_NOEXS	Object does not exist (the task specified in `tskid` does not exist)
E_OBJ	Invalid object state (issued for a RUNNING state task)

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_REGOPS`	Support for task-register manipulation functions

Description

Sets registers of the task designated in tskid. This is similar to tk_set_reg.

Registers cannot be set for the task currently in RUNNING state. Except when a task-independent portion is executing, the current RUNNING state task is the invoking task.

If NULL is set in pk_regs, pk_eit, or pk_cregs, the corresponding registers are not set.

The contents of T_REGS, T_EIT, and T_CREGS are implementation-dependent.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_get_tim - Get System Time

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_get_tim (SYSTIM *tim , UW *ofs );

Parameter

SYSTIM*	`tim`	Time	Pointer to the area to return the current time (ms)
UW*	`ofs`	Offset	Pointer to the area to return the return parameter `ofs`

Return Parameter

ER	`ercd`	Error Code	Error code
SYSTIM	`tim`	Time	Current time (in milliseconds)
UW	`ofs`	Offset	Elapsed time from `tim` (nanoseconds)

tim Detail:

W	`hi`	High 32 bits	Higher 32 bits of current time of the system time
UW	`lo`	Low 32 bits	Lower 32 bits of current time of the system time

Error Code

E_OK	Normal completion

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the current time as total elapsed milliseconds since 0:00:00 (GMT), January 1, 1985. The value returned in tim is the same as that obtained by tk_get_tim(). tim is the resolution of timer interrupt intervals (cycles), but even more precise time information is obtained in ofs as the elapsed time from tim in nanoseconds. The resolution of ofs is implementation-dependent, but generally is the resolution of hardware timer.

Since tim is a cumulative time counted based on timer interrupts, in some cases time is not refreshed, when a timer interrupt cycle arrives while interrupts are disabled and the timer interrupt handler is not started (is delayed). In such cases, the time as updated by the previous timer interrupt is returned in tim, and the elapsed time from the previous timer interrupt is returned in ofs. Accordingly, in some cases ofs will be longer than the timer interrupt cycle. The length of elapsed time that can be measured by ofs depends on the hardware, but preferably it should be possible to measure at least up to twice the timer interrupt cycle (0 ≦ ofs < twice the timer interrupt cycle).

Note that the time returned in tim and ofs is the time at some point between the calling of and return from td_get_tim(). It is neither the time at which td_get_tim() was called nor the time of return from td_get_tim(). In order to obtain more accurate information, this function should be called in interrupts disabled state.

Difference from T-Kernel 2.0

The data type of ofs has been changed from a pointer to UINT to a pointer to UW.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_get_tim_u - Get System Time (Microseconds)

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_get_tim_u (SYSTIM_U *tim_u , UW *ofs );

Parameter

SYSTIM_U*	`tim_u`	Time	Pointer to the area to return the current time (microseconds)
UW*	`ofs`	Offset	Pointer to the area to return the return parameter `ofs`

Return Parameter

ER	`ercd`	Error Code	Error code
SYSTIM_U	`tim_u`	Time	Current time (in microseconds)
UW	`ofs`	Offset	Elapsed time from `tim_u` (nanoseconds)

Error Code

E_OK	Normal completion

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_USEC`	Support instructions that can handle time in microsecond resolutions

Description

This system call takes 64-bit tim_u in microseconds instead of the return parameter tim of td_get_tim.

The specification of this system call is same as that of td_get_tim, except that the return parameter is replaced with tim_u. For more details, see the description of td_get_tim.

Difference from T-Kernel 2.0

The data type of ofs has been changed from a pointer to UINT to a pointer to UW.

Difference from μT-Kernel 1.0

New API introduced based on T-Kernel 2.0 specification

td_get_otm - Get Operating Time

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_get_otm (SYSTIM *tim , UW *ofs );

Parameter

SYSTIM*	`tim`	Time	Pointer to the area to return the operating time (ms)
UW*	`ofs`	Offset	Pointer to the area to return the return parameter `ofs`

Return Parameter

ER	`ercd`	Error Code	Error code
SYSTIM	`tim`	Time	Operating time (ms)
UW	`ofs`	Offset	Elapsed time from `tim` (nanoseconds)

tim Detail:

W	`hi`	High 32 bits	Higher 32 bits of the system operating time
UW	`lo`	Low 32 bits	Lower 32 bits of the system operating time

Error Code

E_OK	Normal completion

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DBGSPT Support μT-Kernel/DS

Description

Gets the system operating time (uptime, as elapsed milliseconds since the system was booted). The value returned in tim is the same as that obtained by tk_get_otm. tim is the resolution of timer interrupt intervals (cycles), but even more precise time information is obtained in ofs as the elapsed time from tim in nanoseconds. The resolution of ofs is implementation-dependent, but generally is the resolution of hardware timer.

Since tim is a cumulative time counted based on timer interrupts, in some cases time is not refreshed, when a timer interrupt cycle arrives while interrupts are disabled and the timer interrupt handler is not started (is delayed). In such cases, the time as updated by the previous timer interrupt is returned in tim, and the elapsed time from the previous timer interrupt is returned in ofs. Accordingly, in some cases ofs will be longer than the timer interrupt cycle. The length of elapsed time that can be measured by ofs depends on the hardware, but preferably it should be possible to measure at least up to twice the timer interrupt cycle (0 ≦ ofs < twice the timer interrupt cycle).

Note that the time returned in tim and ofs is the time at some point between the calling of and return from td_get_otm(). It is neither the time at which td_get_otm() was called nor the time of return from td_get_otm(). In order to obtain more accurate information, this function should be called in interrupts disabled state.

Difference from T-Kernel 2.0

The data type of ofs has been changed from a pointer to UINT to a pointer to UW.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_get_otm_u - Get Operating Time (Microseconds)

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_get_otm_u (SYSTIM_U *tim_u , UW *ofs );

Parameter

SYSTIM_U*	`tim_u`	Time	Pointer to the area to return the operating time (microseconds)
UW*	`ofs`	Offset	Pointer to the area to return the return parameter `ofs`

Return Parameter

ER	`ercd`	Error Code	Error code
SYSTIM_U	`tim_u`	Time	Operating time (microseconds)
UW	`ofs`	Offset	Elapsed time from `tim_u` (nanoseconds)

Error Code

E_OK	Normal completion

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

`TK_SUPPORT_DBGSPT`	Support μT-Kernel/DS
`TK_SUPPORT_USEC`	Support instructions that can handle time in microsecond resolutions

Description

This system call takes 64-bit tim_u in microseconds instead of the return parameter tim of td_get_otm.

The specification of this system call is same as that of td_get_otm, except that the return parameter is replaced with tim_u. For more details, see the description of td_get_otm.

Difference from T-Kernel 2.0

The data type of ofs has been changed from a pointer to UINT to a pointer to UW.

Difference from μT-Kernel 1.0

New API introduced based on T-Kernel 2.0 specification

td_ref_dsname - Refer to DS Object Name

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_ref_dsname (UINT type , ID id , UB *dsname );

Parameter

UINT	`type`	Object Type	Target object type
ID	`id`	Object ID	Object ID
UB*	`dsname`	DS Object Name	Pointer to the area to return the DS object name

Return Parameter

ER ercd Error Code Error code

dsname Detail:: DS object name, set at object creation or by td_set_dsname()

Error Code

E_OK	Normal completion
E_PAR	Invalid object type
E_NOEXS	Object does not exist
E_OBJ	DS object name is not used

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DSNAME Support for DS object name

Description

References the DS object name (dsname), which is set at object creation. The object is specified by object type (type) and object ID (id).

Object types (type) are as follows:

`TN_TSK`	0x01	Task
`TN_SEM`	0x02	Semaphore
`TN_FLG`	0x03	Event Flag
`TN_MBX`	0x04	Mailbox
`TN_MBF`	0x05	Message Buffer
`TN_POR`	0x06	Rendezvous Port
`TN_MTX`	0x07	Mutex
`TN_MPL`	0x08	Variable-size Memory Pool
`TN_MPF`	0x09	Fixed-size Memory Pool
`TN_CYC`	0x0a	Cyclic Handler
`TN_ALM`	0x0b	Alarm Handler

DS object name is valid if TA_DSNAME is set as object attribute. If DS object name is changed by td_set_dsname(), then td_ref_dsname() references the new name.

DS object name needs to satisfy the following conditions:

Available characters (UB): a to z, A to Z, 0 to 9
Name length: 8-byte (filled with NULL for shorter name)

However, character code range is not checked by μT-Kernel.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

td_set_dsname - Set DS Object Name

C Language Interface

#include <tk/dbgspt.h>

ER ercd = td_set_dsname (UINT type , ID id , CONST UB *dsname );

Parameter

UINT	`type`	Object Type	Target object type
ID	`id`	Object ID	Object ID
CONST UB*	`dsname`	DS Object Name	DS object name to be set

Return Parameter

ER ercd Error Code Error code

Error Code

E_OK	Normal completion
E_PAR	Invalid object type
E_NOEXS	Object does not exist
E_OBJ	DS object name is not used

Valid Context

Task portion	Quasi-task portion	Task-independent portion
YES	YES	YES

Related Service Profile Items

Only when all the service profile items below are set to be effective, this system call can be used.

TK_SUPPORT_DSNAME Support for DS object name

Description

Re-sets DS object name (dsname), which is set at object creation. The object is specified by object type (type) and object ID (id).

Object types (type) are as same as that of td_ref_dsname() .

DS object name needs to satisfy the following conditions:

Available characters (UB): a to z, A to Z, 0 to 9
Name length: 8-byte (filled with NULL for shorter name)

However, character code range is not checked by μT-Kernel.

DS object name is valid if TA_DSNAME is set as object attribute. td_set_dsname() returns E_OBJ error if TA_DSNAME attribute is not specified.

Difference from μT-Kernel 1.0

With the introduction of service profile, this API can be used when the profile permits it.

Prev	Home	Next
Subsystem and Device Driver Starting		Trace Functions