# OS_LockCartridge

## 構文

      #include <nitro/os.h>

      s32 OS_LockCartridge( u16 lockID );

## 引数

lockID | カートリッジのロックに用いるID

## 返り値

OS_LOCK_SUCCESS ならば成功です。( 0に定義されています )
成功するまで試行しつづけるので、返り値は必ずこの値になります。

## 説明

プロセッサ間やモジュール間で共有リソース(この関数ではカートリッジ)を排他制御するためにスピンロックを行ないます。

この関数はロックが成功するまで試行しつづけます。ロックに成功した場合にはEXMEMCNTレジスタへアクセスし、カートリッジバスへのアクセス権を取得します。プロセッサ間の共有リソースは必ずロック後に使用して下さい。プロセッサ専有のリソースはタイミング的に調整できるのであればロックしなくても構いません。

lockID はロックのためのIDで、プロセッサ間やモジュール間で重らないように `OS_GetLockID()` を用いてIDを取得するとよいでしょう。

## 内部動作

IOレジスタの、EXMEMCNT(0x4000204)にアクセスしています。

## 参照

`OS_UnlockCartridge, OS_TryLockCartridge, OS_LockCard, OS_GetLockID
`

## 履歴

2004/11/04 内部動作を追加
2004/07/22 引数の型を u32 → u16 に変更
2004/06/21 初版