1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     fs_Api.h
4 
5   Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.
6 
7   These coded instructions, statements, and computer programs contain
8   proprietary information of Nintendo of America Inc. and/or Nintendo
9   Company Ltd., and are protected by Federal copyright law.  They may
10   not be disclosed to third parties or copied or duplicated in any form,
11   in whole or in part, without the prior written consent of Nintendo.
12 
13   $Rev: 32795 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_FS_FS_API_H_
17 #define NN_FS_FS_API_H_
18 
19 #include <nn/Result.h>
20 #include <nn/os.h>
21 
22 namespace nn {
23 namespace fs {
24 
25 //----------------------------------------
26 //! @name 初期化
27 //@{
28 
29 /*!
30     @brief fsライブラリを初期化します。
31 
32            fs ライブラリにあるクラスや関数を使うためには、先にこの関数を呼ぶ必要があります。
33 */
34 void  Initialize();
35 void  Finalize();
36 bool  IsInitialized();
37 
38 //@}
39 
40 //----------------------------------------
41 //! @name SD カード
42 //@{
43 
44 /*!
45     @brief  SD カード挿入時にシグナルされる @ref nn::os::LightEvent を登録します。
46 
47     @param[in] p    SD カード挿入時にシグナルされる @ref nn::os::LightEvent を指定します。
48 */
49 void RegisterSdmcInsertedEvent(nn::os::LightEvent* p);
50 
51 /*!
52     @brief  @ref nn::fs::RegisterSdmcInsertedEvent の登録を解除します。
53 */
54 void UnregisterSdmcInsertedEvent();
55 
56 /*!
57     @brief  SD カード取り出し時にシグナルされる @ref nn::os::LightEvent を登録します。
58 
59     @param[in] p    SD カード取り出し時にシグナルされる @ref nn::os::LightEvent を指定します。
60 */
61 void RegisterSdmcEjectedEvent(nn::os::LightEvent* p);
62 
63 /*!
64     @brief  @ref nn::fs::RegisterSdmcEjectedEvent の登録を解除します。
65 */
66 void UnregisterSdmcEjectedEvent();
67 
68 /*!
69     @brief  SD カードが挿入されているかを返します。
70 
71             本関数は高負荷のため、SD カード挿入イベントや取り出しイベントを待つ場合は、@ref nn::fs::RegisterSdmcInsertedEvent,
72             @ref nn::fs::RegisterSdmcEjectedEvent 関数で登録した@ref nn::os::LightEvent を使用してください。
73 
74     @return         挿入されていれば true を、挿入されていなければ false を返します。
75 */
76 bool IsSdmcInserted();
77 
78 /*!
79     @brief  SD カードが書き込み可能かを返します。
80 
81             SD カードが書き込み可能である状態とは、SD カードが挿入されており、かつ SD カードが LOCK スイッチにより書き込み禁止
82             されていない状態です。
83 
84     @return         書き込み可能であれば true を、書き込み不可能であれば false を返します。
85 */
86 bool IsSdmcWritable();
87 
88 /*!
89     @brief  SD カードの総容量と空き容量を取得します。
90 
91     @param[out] pTotal      SD カードの総容量を返します。
92     @param[out] pFree       SD カードの空き容量を返します。
93 
94     @return 処理の結果を返します。
95     @retval 成功                    処理に成功しました。戻り値の IsSuccess 関数が true を返す状態です。
96     @retval ResultMediaNotFound     SD カードが見つからないか、もしくは認識できません。
97     @retval ResultMediaAccessError  挿さっているのが SD カードではないか、もしくは SD カードが壊れています。
98     @retval ResultBadFormat         SD カードのフォーマットが不正です。SD カードをフォーマットする必要があります。
99     @retval 上記以外                アプリケーション側の不具合、もしくは想定外のエラーです。
100 */
101 
102 Result GetSdmcSize( s64* pTotal, s64* pFree );
103 
104 //@}
105 
106 }
107 }
108 
109 #endif /* NN_FS_FS_API_H_ */
110