/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     fs_Api.h

  Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 33378 $
 *---------------------------------------------------------------------------*/

#ifndef NN_FS_FS_API_H_
#define NN_FS_FS_API_H_

#include <nn/Result.h>
#include <nn/os.h>

namespace nn {
namespace fs {

//----------------------------------------
//! @name 初期化
//@{

/*!
    @brief  fsライブラリを初期化します。

            fs ライブラリにあるクラスや関数を使うためには、先にこの関数を呼ぶ必要があります。
*/
void  Initialize();
void  Finalize();
bool  IsInitialized();

//@}

//----------------------------------------
//! @name SD カード
//@{

/*!
    @brief  SD カード挿入時にシグナルされる @ref nn::os::LightEvent を登録します。

            このイベントは、壊れた SD カードが挿されたり、SD カードでないもの (空の SD カードアダプタ等) が挿された場合にもシグ
            ナルされます。

    @param[in] p    SD カード挿入時にシグナルされる @ref nn::os::LightEvent を指定します。
*/
void RegisterSdmcInsertedEvent(nn::os::LightEvent* p);

/*!
    @brief  @ref nn::fs::RegisterSdmcInsertedEvent の登録を解除します。
*/
void UnregisterSdmcInsertedEvent();

/*!
    @brief  SD カード取り出し時にシグナルされる @ref nn::os::LightEvent を登録します。

    @param[in] p    SD カード取り出し時にシグナルされる @ref nn::os::LightEvent を指定します。
*/
void RegisterSdmcEjectedEvent(nn::os::LightEvent* p);

/*!
    @brief  @ref nn::fs::RegisterSdmcEjectedEvent の登録を解除します。
*/
void UnregisterSdmcEjectedEvent();

/*!
    @brief  SD カードが挿入されているかを返します。

            本関数は高負荷のため、SD カード挿入イベントや取り出しイベントを待つ場合は、@ref nn::fs::RegisterSdmcInsertedEvent, 
            @ref nn::fs::RegisterSdmcEjectedEvent 関数で登録した@ref nn::os::LightEvent を使用してください。

            壊れた SD カードが挿されたり、SD カードでないもの (空の SD カードアダプタ等) が挿された場合にも、この関数は true を
            返します。

    @return     挿入されていれば true を、挿入されていなければ false を返します。
*/
bool IsSdmcInserted();

/*!
    @brief  SD カードが書き込み可能かを返します。

            SD カードが書き込み可能である状態とは、SD カードが挿入されており、かつ SD カードが LOCK スイッチにより書き込み禁止
            されていない状態です。

    @return     書き込み可能であれば true を、書き込み不可能であれば false を返します。
*/
bool IsSdmcWritable();

/*!
    @brief  SD カードの総容量と空き容量を取得します。

    @param[out] pTotal      SD カードの総容量を返します。
    @param[out] pFree       SD カードの空き容量を返します。

    @return 処理の結果を返します。
    @retval 成功            処理に成功しました。戻り値の IsSuccess 関数が true を返す状態です。
    @retval ResultNotFound  SD カードが見つからないか、もしくは認識できません。
                            また、SD カードが挿さっていても、SD カード上のファイルシステムにアクセスできないときは、このエラー
                            が返ります。
    @retval 上記以外        アプリケーション側の不具合、もしくは想定外のエラーです。
*/

Result GetSdmcSize( s64* pTotal, s64* pFree );

//@}

}
}

#endif /* NN_FS_FS_API_H_ */