1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: dlp_Type.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 14 *---------------------------------------------------------------------------*/ 15 #ifndef NN_DLP_CTR_DLP_TYPE_H_ 16 #define NN_DLP_CTR_DLP_TYPE_H_ 17 18 #include <nn/Handle.h> 19 #include <nn/Result.h> 20 #include <nn/types.h> 21 #include <nn/cfg.h> 22 #include <nn/uds.h> 23 24 namespace nn { 25 namespace dlp { 26 namespace CTR { 27 /*!--------------------------------------------------------------------------* 28 @name サイズ、数の定義 29 @{ 30 *--------------------------------------------------------------------------*/ 31 const size_t MAX_CHILD_IMPORT_SIZE = 32 * 1024 * 1024; //!< 子機プログラムの最大サイズ 32 const s32 SHORT_TITLE_NAME_LENGTH = 64; //!< 1 行子機プログラム名の文字長 33 const s32 LONG_TITLE_NAME_LENGTH = 128; //!< 2 行子機プログラム名の文字長 34 const s32 ICON_HEIGHT_PIXEL = 48; //!< アイコンのピクセル高 35 const s32 ICON_WIDTH_PIXEL = 48; //!< アイコンのピクセル幅 36 const s32 ICON_PIXEL_COUNT = ICON_WIDTH_PIXEL * ICON_HEIGHT_PIXEL; //!< アイコンのピクセル数 37 const s32 RATING_INFO_SIZE = 16; //!< ペアレンタルコントロールの情報サイズ 38 const u16 MAX_NODE_NUM = nn::uds::NODE_MAX; //!< サーバを含むネットワークに存在する最大のノード数 39 const u16 MAX_CLIENT_NUM = MAX_NODE_NUM - 1; //!< サーバに接続可能なクライアントの最大台数 40 const u8 MAX_SCAN_NUM = 16; //!< クライアントにおいて一度にスキャンできる子機プログラムの最大数 41 const size_t MIN_NETWORK_BLOCK_BUFFER_NUM = 2; //!< ネットワークブロックバッファの最低数 42 const size_t MAX_NETWORK_BLOCK_BUFFER_NUM = 4; //!< ネットワークブロックバッファの最大数 43 const size_t MIN_NETWORK_BLOCK_BUFFER_SIZE = 128*1024; //!< ネットワークブロックバッファの最低サイズ 44 const size_t MAX_NETWORK_BLOCK_BUFFER_SIZE = 512*1024; //!< ネットワークブロックバッファの最大サイズ 45 const size_t MAX_CHILD_UDS_PASSPHRASE_LENGTH = 9; //!< 子機の再接続時の UDS パスフレーズの最大長(NULL終端を含む) 46 47 /*! 48 @} 49 */ 50 51 52 /*!--------------------------------------------------------------------------* 53 @brief ダウンロードセッションの種類 54 *--------------------------------------------------------------------------*/ 55 enum SessionType 56 { 57 SESSION_TYPE_INVALID = 0, 58 SESSION_TYPE_TITLE = 1, //!< 子機プログラムのダウンロードセッション 59 SESSION_TYPE_SYSTEM = 2 //!< タイトルを起動するのに必要なシステムのダウンロードセッション 60 }; 61 62 63 /*!--------------------------------------------------------------------------* 64 @brief クライアントの状態 65 *---------------------------------------------------------------------------*/ 66 enum ClientState 67 { 68 CLIENT_STATE_INVALID = 0x00, //!< サーバでこの状態を認識できません。クライアントは未初期化の状態です。 69 CLIENT_STATE_DISCONNECTED_NETWORK = 0x01, //!< サーバでこの状態を認識できません。ネットワークに接続していない 状態です。 70 CLIENT_STATE_SCANNING = 0x02, //!< サーバでこの状態を認識できません。スキャン中の状態です。 71 CLIENT_STATE_WAITING_CONNECT = 0x03, //!< サーバでこの状態を認識できません。ネットワークへの接続を待っています。 72 CLIENT_STATE_WAITING_INVITE = 0x04, //!< ネットワークに接続しました。サーバからのINVITEコマンドを待っています。 73 CLIENT_STATE_JOINED_SESSION = 0x05, //!< セッションへ 参加しています。 74 CLIENT_STATE_DOWNLOADING = 0x06, //!< ダウンロード中です。ただし、サーバからデータが出ていない場合も含みます。 75 CLIENT_STATE_DOWNLOAD_COMPLETE = 0x07, //!< ダウンロードが完了した状態です。 76 CLIENT_STATE_RECONNECTING_NETWORK = 0x08, //!< システムのダウンロード後に、アプリケーションの再接続処理を待っている状態です。 77 CLIENT_STATE_REBOOTING = 0x09, //!< サーバでこの状態を認識できません。ダウンロード後に、アプリケーションのリブート処理を待っている状態です。 78 CLIENT_STATE_ERROR = 0x80, //!< サーバでこの状態を認識できません。エラーが発生し再初期化しないといけない状態です。遷移条件は、Initialize() から Finalize() の間に SLEEP か WIFI ボタンが OFF になるか、ダウンロードセッション開始後(CLIENT_STATE_WAITING_INVITE から CLIENT_STATE_REBOOTING) にサーバから切断されるか他のクライアントが切断することです。 79 CLIENT_STATE_WAITING_ACCEPT = 0x40, //!< クライアントでこの状態を認識できません。ネットワークに接続していますが、サーバの ACCEPT を待っています。 80 CLIENT_STATE_CONFIRMING_DOWNLOAD_PROGRESS = 0x41 //!< クライアントでこの状態を認識できません。ダウンロードの進捗を確認しています。 81 }; 82 83 84 /*!--------------------------------------------------------------------------* 85 @brief サーバの状態 86 87 StartDistribute() を呼び出した後は配信処理が進むに従い、SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION から SERVER_STATE_COMPLETE_DISTRIBUTION まで<BR> 88 SDK 内で自動で状態遷移します。しかし、この間にいくつかの要因 (通信エラー、スリープ、Wifi ボタンの OFF)により SERVER_STATE_ERROR に遷移することがあります。<BR> 89 GetState() か GetEventDesc() で状態を監視してください。 <BR> 90 また、SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION から SERVER_STATE_DISTRIBUTING_TITLE までの状態は、ひととくくりに配信中とみなして処理してください。<BR> 91 これらの状態にあるときは、「配信中」などと UI に表示してしまって構いません。ただし、常にユーザで配信をキャンセルできるようにしてください。<BR> 92 これは、DLP サーバがシステム更新後にリブートしたクライアントが接続してくるのを待ち続けるためです。クライアントは必ず接続してくると限りません。 93 94 95 *---------------------------------------------------------------------------*/ 96 enum ServerState 97 { 98 SERVER_STATE_INVALID = 0, //!< サーバは未初期化の状態です。 99 SERVER_STATE_INITIALIZED, //!< 初期化が完了した状態です。 100 SERVER_STATE_OPENED_SESSIONS, //!< セッションへの参加を受け付けている状態です。 101 SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION, //!< システム配信を行う前の状態です。 102 SERVER_STATE_DISTRIBUTING_SYSTEM, //!< システムを配信している状態です。 103 SERVER_STATE_WAITING_RECONNECT, //!< システム配信後に、システムをリブートしたクライアントが再接続してくるのを待っている状態です。クライアントは再接続してくるとは限りません。 104 SERVER_STATE_PREPARING_FOR_TITLE_DISTRIBUTION, //!< サーバが子機プログラム配信を行う前の状態です。 105 SERVER_STATE_DISTRIBUTING_TITLE, //!< サーバが子機プログラムを配信している状態です。 106 SERVER_STATE_COMPLETE_DISTRIBUTION, //!< サーバが子機プログラムの配信を完了した状態です。 107 SERVER_STATE_REBOOTING_CLIENTS, //!< サーバがクライアントのリブートを行っている状態です。全てのクライアントの切断を確認したら、ダウンロードプレイを終了してください。 その後、 ローカル通信を行う場合は、UDS でクライアントの接続を待ってください。ただし、クライアントは必ず再接続するとは限らないので注意してください。 108 SERVER_STATE_ERROR //!< エラーが発生し再初期化しないといけない状態です。遷移条件は、Initialize() から Finalize() の間に SLEEP か WIFI ボタンが OFF になるか、ダウンロードセッション開始後(SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION から SERVER_STATE_COMPLETE_DISTRIBUTION) に CLIENT_STATE_RECONNECTING_NETWORK 以外のクライアントが切断するかカードが抜けることです。 109 }; 110 111 112 /*!--------------------------------------------------------------------------* 113 @brief 通知されるイベントの種類 114 *---------------------------------------------------------------------------*/ 115 enum EventType 116 { 117 EVENT_TYPE_INVALID = 0, 118 // SERVER 119 EVENT_TYPE_SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION, //!< サーバにおいて SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION 状態に遷移したときのイベント 120 EVENT_TYPE_SERVER_STATE_DISTRIBUTING_SYSTEM, //!< サーバにおいて SERVER_STATE_DISTRIBUTING_SYSTEM 状態に遷移したときのイベント 121 EVENT_TYPE_SERVER_STATE_WAITING_RECONNECT, //!< サーバにおいて SERVER_STATE_WAITING_RECONNECT 状態に遷移したときのイベント 122 EVENT_TYPE_SERVER_STATE_PREPARING_FOR_TITLE_DISTRIBUTION, //!< サーバにおいて SERVER_STATE_PREPARING_FOR_TITLE_DISTRIBUTION 状態に遷移したときのイベント 123 EVENT_TYPE_SERVER_STATE_DISTRIBUTING_TITLE, //!< サーバにおいて SERVER_STATE_DISTRIBUTING_TITLE 状態に遷移したときのイベント 124 EVENT_TYPE_SERVER_STATE_COMPLETE_DISTRIBUTION, //!< サーバにおいて SERVER_STATE_COMPLETE_DISTRIBUTION 状態に遷移したときのイベント 125 EVENT_TYPE_SERVER_STATE_ERROR, //!< サーバにおいて SERVER_STATE_ERROR 状態に遷移したときのイベント 126 127 // CLIENT 128 EVENT_TYPE_CLIENT_DISCOVERED_SERVER, //!< クライアントにおいて サーバーが発見されましたときのイベント 129 EVENT_TYPE_CLIENT_SCAN_BUFFER_FULL, //!< クライアントにおいて スキャンバッファがいっぱいになったときのイベント(サーバーの情報の更新は続けられます。) 130 EVENT_TYPE_CLIENT_DISCOVERED_TITLE, //!< クライアントにおいて 子機プログラムが発見されたときのイベント 131 EVENT_TYPE_CLIENT_STATE_WAITING_INVITE, //!< クライアントにおいて CLIENT_STATE_WAITING_INVITE 状態に遷移したときのイベント 132 EVENT_TYPE_CLIENT_STATE_JOINED_SESSION, //!< クライアントにおいて CLIENT_STATE_JOINED_SESSION 状態に遷移したときのイベント 133 EVENT_TYPE_CLIENT_STATE_DOWNLOADING, //!< クライアントにおいて CLIENT_STATE_DOWNLOADING 状態に遷移したときのイベント 134 EVENT_TYPE_CLIENT_STATE_DOWNLOAD_COMPLETE, //!< クライアントにおいて CLIENT_STATE_DOWNLOAD_COMPLETE 状態に遷移したときのイベント 135 EVENT_TYPE_CLIENT_STATE_RECONNECTING_NETWORK, //!< クライアントにおいて CLIENT_STATE_RECONNECTING_NETWORK 状態に遷移したときのイベント 136 EVENT_TYPE_CLIENT_STATE_REBOOTING, //!< クライアントにおいて CLIENT_STATE_REBOOTING 状態に遷移したときのイベント 137 EVENT_TYPE_CLIENT_STATE_DISCONNECTED_NETWORK, //!< クライアントにおいて CLIENT_STATE_DISCONNECTED_NETWORK 状態に遷移したときのイベント 138 EVENT_TYPE_CLIENT_STATE_ERROR //!< クライアントにおいて CLIENT_STATE_ERROR 状態に遷移したときのイベント 139 }; 140 141 142 /*!--------------------------------------------------------------------------* 143 @brief EventDesc の type が EVENT_TYPE_CLIENT_DISCOVERED_SERVER のときのイベント情報です。 144 *---------------------------------------------------------------------------*/ 145 typedef struct 146 { 147 u8 mac[6]; //!< スキャンによって発見されたサーバの MAC アドレスです。 148 NN_PADDING2; 149 } ClientDiscoveredServer; 150 151 152 /*!--------------------------------------------------------------------------* 153 @brief EventDesc の type が EVENT_TYPE_CLIENT_DISCOVERED_TITLE のときのイベント情報です。 154 *---------------------------------------------------------------------------*/ 155 typedef struct 156 { 157 u32 uniqueId; //!< スキャンによって発見された子機プログラムの Unique ID です。 158 u8 childIndex; //!< スキャンによって発見された子機プログラムの Child index です。 159 NN_PADDING3; 160 u8 mac[6]; //!< スキャンによって発見された子機プログラムを持つサーバの MAC アドレスです。 161 u16 programVersion; //!< スキャンによって発見された子機プログラムのプログラムバージョンです。 162 } ClientDiscoveredTitle; 163 164 165 /*!--------------------------------------------------------------------------* 166 @brief EventDesc の type が EVENT_TYPE_CLIENT_STATE_WAITING_INVITE のときのイベント情報です。 167 *---------------------------------------------------------------------------*/ 168 typedef struct 169 { 170 u16 nodeId; //!< 自分の ノード ID です。 171 NN_PADDING2; 172 } ClientStateWaitingInvite; 173 174 175 /*!--------------------------------------------------------------------------* 176 @brief DLP 内で発生したイベントを通知します。 type メンバによって情報が変わります。 177 *---------------------------------------------------------------------------*/ 178 typedef struct 179 { 180 EventType type; 181 NN_PADDING3; 182 NN_PADDING4; 183 union{ 184 // Client 185 ClientDiscoveredServer clientDiscoveredServer; 186 ClientDiscoveredTitle clientDiscoveredTitle; 187 ClientStateWaitingInvite clientStateWaitingInvite; 188 189 u8 placeHolder[16]; // IPC 用 190 } ; 191 } EventDesc; 192 193 194 /*!--------------------------------------------------------------------------* 195 @brief ノードの情報 196 *---------------------------------------------------------------------------*/ 197 typedef nn::uds::NodeInformation NodeInfo; 198 199 200 /*!--------------------------------------------------------------------------* 201 @brief クライアントの状態、ダウンロードの進捗 202 *---------------------------------------------------------------------------*/ 203 typedef struct 204 { 205 u16 nodeId; //!< ノードID 206 SessionType sessionType; //!< 参加しているダウンロードセッションの種類 207 ClientState state; //!< クライアントの状態 208 size_t totalNum; //!< ダウンロードしなくてはならない総数 (パケット数) 209 size_t downloadedNum; //!< ダウンロード済みの数(パケット数) 210 } ClientStatus; 211 212 /*!--------------------------------------------------------------------------* 213 @brief アイコンの情報 214 *---------------------------------------------------------------------------*/ 215 typedef struct 216 { 217 bit16 image[ICON_PIXEL_COUNT]; //!< アイコンの画像データ 218 } IconInfo; 219 220 221 /*!--------------------------------------------------------------------------* 222 @brief 子機プログラムの情報 223 *---------------------------------------------------------------------------*/ 224 typedef struct 225 { 226 u32 uniqueId; //!< Unique ID 227 u8 childIndex; //!< Child index 228 NN_PADDING3; 229 u8 mac[6]; //!< サーバのMACアドレス 230 u16 programVersion; //!< プログラムのバージョン 231 bit8 ratingInfo[RATING_INFO_SIZE]; //!< レーティング情報 232 wchar_t shortTitleName[SHORT_TITLE_NAME_LENGTH]; //!< 1 行の子機プログラム名 233 wchar_t longTitleName[LONG_TITLE_NAME_LENGTH]; //!< 2 行の子機プログラム名 234 IconInfo icon; //!< アイコン情報 235 u32 importSize; //!< インポートに必要な NAND のバイトサイズ 236 nn::cfg::CfgRegionCode region; //!< リージョン 237 bool ulcd; //!< ULCD表示をするか 238 NN_PADDING2; 239 } TitleInfo; 240 241 242 /*!--------------------------------------------------------------------------* 243 @brief サーバの情報 244 *---------------------------------------------------------------------------*/ 245 typedef struct 246 { 247 u8 mac[6]; //!< サーバのMACアドレス 248 u8 channel; //!< サーバの存在するチャンネル 249 nn::uds::LinkLevel linkLevel; //!< リンクレベル、スキャンしている間(CLIENT_STATE_SCANNING状態)だけ更新されます。 250 u8 maxNodeNum; //!< サーバを含む接続可能な最大ノード数 251 u8 nodeNum; //!< サーバを含む現在の接続しているノード数、スキャンしている間(CLIENT_STATE_SCANNING状態)だけ更新されます。 252 bit16 dlpVersion; //!< ダウンロードプレイのバージョン 253 NN_PADDING4; 254 NodeInfo nodeInfo[MAX_NODE_NUM]; //!< サーバに接続しているノードの情報、スキャンしている間(CLIENT_STATE_SCANNING状態)だけ更新されます。 255 nn::os::Tick lastUpdateTick; //!< 最後に更新された Tick です。 256 } ServerInfo; 257 258 259 /*!--------------------------------------------------------------------------* 260 @brief リブート後に親機に再接続するための情報を格納するための構造体 261 *---------------------------------------------------------------------------*/ 262 typedef struct 263 { 264 u8 bssid[6]; //!< サーバの BSSID (MAC アドレス) が格納されます 265 char passphrase[MAX_CHILD_UDS_PASSPHRASE_LENGTH]; //!< UDS パスフレーズが格納されます。長さは NULL 終端含み MAX_CHILD_UDS_PASSPHRASE_LENGTH バイトまでです。 266 NN_PADDING1; 267 } RebootInfo; 268 269 } // end of namespace CTR 270 } // end of namespace dlp 271 } // end of namespace nn 272 273 #endif // ifndef NN_DLP_CTR_DLP_TYPE_H_ 274