APIの記述形式

本仕様書のAPI説明の部分では、API(Application Programming Interface)ごとに、以下のような形式で仕様の説明を行っている。なお、APIには、カーネルの機能を直接的に呼び出すシステムコールのほかに、拡張SVC(拡張システムコール)やマクロ、ライブラリとして実現されるものも含まれる。

API名称 - 説明

APIの名称および説明を示す。

C言語インタフェース

APIのC言語インタフェースおよびインクルードするヘッダファイルを示す。

パラメータ

APIのパラメータ、すなわちAPIを発行するときにμT-Kernelに渡す情報に関する説明を行う。

リターンパラメータ

APIのリターンパラメータ、すなわちAPIの実行が終ったときにμT-Kernelから返される情報に関する説明を行う。

なお、リターンパラメータのうち、APIの関数値として戻されるものを「戻値」と呼ぶことがある。リターンパラメータには、戻値のほかに、パラメータとして渡されたポインタの参照先に情報を返すものがある。

エラーコード

APIで発生する可能性のあるエラーに関して説明を行う。

以下のエラーコードについては、各APIのエラーコードの説明の項には含めていないが、各APIにおいて共通に発生する可能性がある。

E_SYS, E_NOSPT, E_RSFN, E_MACV, E_OACV

以下のエラーコードの検出は実装依存であり、エラーとして検出されない場合がある。

E_PAR, E_MACV, E_CTX

エラーコード E_CTX については、待ち状態に入るAPIのタスク独立部からの呼出など、APIの呼出コンテキストに意味的な誤りがある場合についてのみ、各APIのエラーコードの説明に含めている。呼出コンテキストに関する制約が実装依存であり、必ずしもエラーとする必要がない条件については、各APIのエラーコードの説明の項には含めていない。

また、実装上の制限事項により、エラーコードの説明に含まれない条件でエラーが発生する可能性もある。

利用可能なコンテキスト

APIを発行することができるコンテキスト(タスク部、準タスク部、タスク独立部)を示す。なお、「×」を記した項目については該当するコンテキストにおいて明確に利用可能でないAPIのほか、利用可能であるかどうかが実装依存となっている項目を含んでおり、実装によっては利用可能である可能性がある。

関連するサービスプロファイル

APIに関連するサービスプロファイルとの関係を示す。

解説

APIの機能の解説を行う。

いくつかの値を選択して設定するようなパラメータの場合には、以下のような記述方法によって仕様説明を行っている。

( x || y || z )

x, y, z のいずれか一つを選択して指定する。

x | y

x と y を同時に指定可能である。 (同時に指定する場合は x と y の論理和をとる)

[ x ]

x は指定しても指定しなくても良い。

例 1. パラメータの記述例


wfmode := (TWF_ANDW || TWF_ORW) | [TWF_CLR]

の場合、wfmode の指定は次の4種のいずれかになる。

TWF_ANDW
TWF_ORW
(TWF_ANDW | TWF_CLR)
(TWF_ORW | TWF_CLR)

補足事項

特記事項や注意すべき点など、解説に対する補足事項を述べる。

仕様決定の理由

仕様決定の理由を述べる。