1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     fs_Parameters.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: 32660 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_FS_FS_PARAMETERS_H_
17 #define NN_FS_FS_PARAMETERS_H_
18 
19 #include <nn/types.h>
20 #include <nn/config.h>
21 #include <nn/dbg/dbg_Logger.h>
22 #include <nn/assert.h>
23 #include <nn/util.h>
24 #include <nn/util/util_Int64.h>
25 
26 namespace nn {
27 namespace fs {
28 
29 static const size_t MAX_ARCHIVE_NAME_LENGTH = 7;
30 static const size_t MAX_FILE_PATH_LENGTH = MAX_ARCHIVE_NAME_LENGTH + 1 + 253;
31 
32 /*!
33     @brief ファイルのオープンモードを示す列挙定数です。
34 
35     ファイルのオープンモードをこれらの論理和で指定します。
36 */
37 enum OpenMode
38 {
39     OPEN_MODE_READ    = (1u << 0),  //!< 読み込みモードで開きます。
40     OPEN_MODE_WRITE   = (1u << 1),  //!< 書き込みモードで開きます。
41     OPEN_MODE_CREATE  = (1u << 2)   //!< ファイルが無ければファイルを作成します。OPEN_MODE_WRITE を同時に指定する必要があります。
42 };
43 
44 /*!
45     @brief ファイルの読み書きの位置を指定することを示す列挙定数です。
46 */
47 enum PositionBase
48 {
49     POSITION_BASE_BEGIN,    //!< ファイルの先頭を基準としてファイルのカレント位置を設定することを示す定数です。
50     POSITION_BASE_CURRENT,  //!< ファイルのカレント位置を基準としてファイルのカレント位置を設定することを示す定数です。
51     POSITION_BASE_END       //!< ファイルの末尾を基準としてファイルのカレント位置を設定することを示す定数です。
52 };
53 
54 struct Transaction
55 {
56     bit32   dummy;
57 };
58 
59 /*!
60     @brief ディレクトリエントリの属性情報を示す構造体です。
61 
62     isDirectory メンバ以外は、sdmc アーカイブでのみ有効です。それ以外のアーカイブでは不定値になりますので、ご注意ください。
63 */
64 struct Attributes
65 {
66     bool isDirectory;   //!< true のときはディレクトリであることを、false のときはファイルであること示します。
67     bool isHidden;      //!< true のときは、隠し属性であることを示します。
68     bool isArchive;     //!< true のときは、アーカイブであることを示します。
69     bool isReadOnly;    //!< true のときは、読み取り専用であることを示します。
70 };
71 
72 struct ShortName
73 {
74     char body[10];      //!< 8.3 形式の拡張子以外の部分を示す文字列が格納されます。
75     char ext[4];        //!< 8.3 形式の拡張子部分を表す文字列が格納されます。
76     bool valid;         //!< true のときは、このショートファイルネームが有効であることを示します。
77     bit8 pad;
78 };
79 
80 /*!
81     @brief ディレクトリエントリを示す構造体です。
82 
83     entrySize メンバは、sdmc アーカイブでのみ有効です。それ以外のアーカイブでは不定値になりますので、ご注意ください。
84 */
85 struct DirectoryEntry
86 {
87     wchar_t            entryName[MAX_FILE_PATH_LENGTH + 1]; //!< エントリのロングファイルネームを示します。
88     ShortName          shortName;   //!< エントリのショートファイルネームを示します。
89     nn::fs::Attributes attributes;  //!< エントリの属性を示します。
90     s64                entrySize;   //!< エントリがファイルであればファイルサイズを示します。ディレクトリのときは 0 が入ります。
91 };
92 
93 struct PathMark
94 {
95     bit32 rawPathMark;
96 };
97 
98 enum MediaType
99 {
100     MEDIA_TYPE_NAND     = 0,
101     MEDIA_TYPE_SDMC     = 1,
102     MEDIA_TYPE_CTRCARD  = 2
103 };
104 
105 namespace detail { struct ArchiveHandleTag {}; }
106 typedef nn::util::Int64<bit64, detail::ArchiveHandleTag> ArchiveHandle;
107 
108 typedef bit64 ExtSaveDataId;
109 typedef bit64 TitleId;
110 
111 } // end of namespace tcb
112 } // end of namespace nn
113 
114 namespace nn { namespace CTR {
115 
116 typedef struct DUMMY1
117 {
118     bit8 data[948];
119 } Dummy1;
120 
121 typedef struct DUMMY2
122 {
123     bit8 data[9152];
124 } Dummy2;
125 
126 }}
127 
128 #endif  // ifndef NN_FS_FS_ENUMS_H_
129