# Shinobi Library

English

### Ver 0.90

1998/09/28

## 目次

今回のSDKでサポートされる関数一覧

### ■システム関数

関数 | 機能
--- | ---
sbInitSystem | Shinobiライブラリの初期化
sbExitSystem | Shinobiシステムの終了
sbHwInit | Ninjaの初期化をする前に行うべき初期化処理
sbHwInit2 | Ninjaの初期化後に行わなければならない初期化処理
sbHwFinish | ハードウェアの終了処理をする

### ■ファイルシステム関数

関数 | 機能
--- | ---
gdFsInit | ライブラリの初期化
gdFsReinit | ライブラリの再初期化
gdFsFinish | ライブラリの終了
gdFsGetWorkSize | ライブラリワークサイズ取得 (macro)
gdFsGetDirrecSize | ディレクトリレコードバッファサイズ取得 (macro)
gdFsCreateDirhn | ディレクトリハンドルの生成
gdFsLoadDir | ディレクトリの読み取り
gdFsSetDir | カレントディレクトリを設定
gdFsChangeDir | カレントディレクトリの変更
gdFsGetDirInfo | ファイルの情報を取得
gdFsOpen | ファイルのオープン
gdFsOpenRange | ファイルのセクタ指定オープン
gdFsClose | ファイルのクローズ
gdFsSeek | ファイルの読み出し位置変更
gdFsTell | ファイルの次の読み出し位置を取得
gdFsCheckEof | ファイルがEOFに到達したかを調べる
gdFsGetFileSize | ファイルサイズの取得
gdFsGetFileSctSize | ファイルのセクタサイズ取得
gdFsGetFad | ファイルのFADを取得
gdFsCalcSctSize | バイト数からセクタ数を算出 (macro)
gdFsRead | ファイルの読み込み
gdFsReqRd32 | ファイルの読み込み
gdFsGetStat | ファイルの状態取得
gdFsGetErrStat | ファイルのエラー状態取得
gdFsGetNumRd | ファイルの読み込み済みサイズの取得
gdFsStopRd | ファイルの読み込み中断
gdFsMovePickup | ピックアップ (読取装置) の移動
gdFsReqGdRd | GDバッファへの先読みのリクエスト発行
gdFsTrans32 | GDバッファからの転送指定
gdFsGetWorkHn | 現在実行中のハンドルの取得
gdFsGetSysHn＜新規＞ | システムハンドルの取得
gdFsGetTransStat | 転送状態を取得
gdFsGetToc | TOCの取得
gdFsGetDrvStat | ドライブの状態の取得
gdFsReqDrvStat＜新規＞ | ドライブ状態の更新
gdFsEntryRdEndFunc | 読み込み終了時のコールバック関数を登録
gdFsEntryTrEndFunc | 転送終了時のコールバック関数を登録
gdFsEntryErrFunc | エラー発生時のコールバック関数を登録
gdFsDaPlay | DAのトラック再生
gdFsDaPlaySct | DAのセクタ指定再生
gdFsDaStop | DAの再生停止
gdFsDaPause | DAの再生の一時停止
gdFsDaRelease | DAの再生の一時停止解除

### ■メモリマネジメント関数

関数 | 機能
--- | ---
syMallocInit | Malloc用のヒープ領域の確保と宣言
syMalloc | メモリの確保
syFree | メモリの開放
syMallocStat | 取得可能な最大連続メモリサイズ及び空き領域サイズの取得
syMallocFinish | Mallocシステムの終了

### ■キャッシュ関数

関数 | 機能
--- | ---
syCacheInit＜新規＞ | 関数の初期化
syCacheICI＜新規＞ | すべてのキャッシュの無効化
syCacheOCl＜新規＞ | オペランドキャッシュのすべてのエントリを無効化
syCacheOCBI＜新規＞ | オペランドキャッシュブロックの無効化
syCacheOCBP＜新規＞ | オペランドキャッシュブロックのパージ
syCacheOCWB＜新規＞ | オペランドキャッシュブロックの書き戻し
syCachePREF＜新規＞ | オペランドキャッシュのプリフェッチ
syCacheMOVCAL＜新規＞ | MOVCA.L命令の実行

### ■ペリフェラルデータ取得関数

関数 | 機能
--- | ---
pdGetPeripheral | ペリフェラルデータの取得
pdGetPeripheralError | ペリフェラルステータスの取得
pdExecPeripheralServer | ペリフェラルデータ取得のためのサーバ関数
pdGetPeripheralInfo＜新規＞ | ペリフェラル情報の取得
pdTmrAlarm＜新規＞ | ペリフェラル情報の取得

### ■LCD関数

関数 | 機能
--- | ---
pdVmsLcdWrite | VMSの液晶にデータを表示する
pdLcdGetDirection | 液晶の向きを取得する
pdVmsLcdIsReady | VMSが接続されているかどうか調べる

### ■時間情報取得関数

関数 | 機能
--- | ---
syTmrGetCount | フリーランニングタイマの値を取得する
syTmrDiffCount | 二つのタイマカウント値の差を取る
syTmrCountToMicro | カウント値をμ秒に変換する
syTmrMicroToCount | μ秒値をカウンタ値に変換する
syTmrGenStart | 汎用タイマを起動する
syTmrGenStop | 汎用タイマを停止する
syTmrGenSetClock | 汎用タイマの基準クロックを設定
syTmrGenSetInt | 汎用タイマによるタイマ割り込みを許可する
syTmrGenCancelInt | 汎用タイマによるタイマ割り込みを禁止する
syTmrGenSetCount | 汎用タイマ割り込みカウンタの設定
syTmrGenGetCount | 汎用タイマ割り込みカウンタを取得
syTmrGenDiffCount | 汎用割り込みカウントの差分を計算する
syTmrGenCountToMicro | 汎用カウンタ値をμ秒値に変換
syTmrGenMicroToCount | μ秒値を汎用カウンタ値に変換する

### ■リアルタイムクロック関数

関数 | 機能
--- | ---
syRtcInit＜新規＞ | ライブラリの初期化
syRtcFinish＜新規＞ | ライブラリの終了
syRtcExecServer＜新規＞ | サーバ関数
syRtcGetDate＜新規＞ | 現日付時刻の取得
syRtcSetDate＜新規＞ | 日付時刻の設定
syRtcSetServerMode＜新規＞ | サーバ関数の動作の設定
syRtcGetStat＜新規＞ | サーバ関数の状態の取得
syRtcCompareDate＜新規＞ | 日付時刻の比較
syRtcDateToCount＜新規＞ | 日付時刻からカウント数への変換
syRtcCountToDate＜新規＞ | カウント数から日付時刻への変換

### ■バックアップ関数

関数 | 機能
--- | ---
buInit | ライブラリを初期化する
buExit | ライブラリを終了する
buMountDisk＜新規＞ | ドライブのマウント
buUnmount＜新規＞ | ドライブのアンマウント
buSetCompleteCallback | 処理完了時のコールバック関数を登録する
buSetProgressCallback | 一定処理経過時のコールバック関数を登録する
buIsReady | バックアップRAMが接続されているかどうかを調べる
buIsFormat | バックアップRAMがフォーマット済みかどうかを調べる
buGetDiskFree | 空き容量を調べる
buGetDiskInfo | バックアップRAMの各種情報を取得する
buIsExistFile | 指定ファイルが存在するかどうか調べる
buGetFileSize | 指定ファイルのサイズを調べる
buGetFileInfo | 指定ファイルの各種情報を取得する
buStat | 処理が完了しているかどうか調べる
buGetLastError | 最後に発生したエラーを取得する
buSaveFile | ファイルをセーブする
buLoadFile | ファイルをロードする
buDeleteFile | ファイルを削除する
buSetFileAttr | ファイル属性を変更する
buFindFirstFile | 第１ファイルのファイル名を取得する
buFindNextFile | 次のファイルのファイル名を取得する
buLoadFileEx | 読み込み開始ブロックとブロック数を指定してファイルをロードする
buFormatDisk | バックアップRAMをフォーマットする
buFindExecFile | 実行ファイルのファイル名を取得する
buSaveExecFile | 実行ファイルをセーブする
buDefragDisk | 連続空きブロックを確保する
buMakeBackupFileImage＜新規＞ | バックアップファイル形式メモリイメージを作成する
buCalcBackupFileSize＜新規＞ | バックアップファイルイメージのブロックサイズを計算する
buAnalyzeBackupFileImage＜新規＞ | メモリ上のファイルイメージを解析する

### ■ビデオケーブル種別取得関数

関数 | 機能
--- | ---
syCblCheckCable | ビデオケーブル種別の取得

### ■BootROMフォント関数

関数 | 機能
--- | ---
| syBtFntGet | ブートロム上のフォントデータの先頭アドレスの取得 | syBtFntChkSmph | フォントセマフォのチェック
syBtFntClrSmph | フォントセマフォのクリア
syBtFntGetAddr＜新規＞ | Shift JISコードから対象フォントデータへのオフセット値を取得
syBtFntGetInfo＜新規＞ | Shift JISコードから対象フォントデータのサイズ情報を取得
syBtFntSjis2Jis＜新規＞ | Shift JISコードからJISコードへ変換

### ■コンフィギュレーション関数

関数 | 機能
--- | ---
syCfgInit＜新規＞ | コンフィギュレーション関数の初期化
syCfgExit＜新規＞ | コンフィギュレーション関数の終了
syCfgSetSoundMode＜新規＞ | 音声設定の更新
syCfgGetSoundMode＜新規＞ | 音声設定の取得

### ■サウンド関数

### ■BootROMサービス関数

関数 | 機能
--- | ---
syBtExit＜新規＞ | BOOT ROMのGUI画面への復帰
syBtCheckDisk＜新規＞ | ディスク交換の調査
syBtGetBootSystemID＜新規＞ | 起動ディスクの情報取得
syBtGetCurrentSystemID＜新規＞ | 現在のディスクの情報取得

## 注意事項

上記関数の中で、gdFsInitと、syMallocInit及びnjInitSystemはライブラリ初期化関数sbInitの中で実行されます。
SET2環境からSET4環境への以降に関する手順については、「set2to4.doc」を必ずご覧頂くようお願いいたします。
本ライブラリでは、デフォルトでBSG32セクション以降をライブラリのメモリアロケート用の空間(メモリアロケート関数「syMalloc」が確保するメモリ空間)として確保するため、BSG32セクション以降にユーザセクションが存在していた場合、データが破壊される可能性があります。
独自にユーザセクションを配置する場合、syMallocInitでの設定値を変更するか、ユーザセクションを必ずBSG32セクションよりも前に来るようにしてください。

オーバービューに戻る