/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     uds_packet.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: 27700 $
 *---------------------------------------------------------------------------*/

/*! @file
    @brief    UDS 用 Vendor Specific IE の定義
*/

#ifndef LIBRARIES_UDS_CTR_UDS_IE_H_
#define LIBRARIES_UDS_CTR_UDS_IE_H_

#include <nn.h>

#include <nn/uds.h>

namespace nn {
namespace uds {
namespace CTR {
namespace detail {

const bit8 VSIE_OUI[3]       = {0x00, 0x1f, 0x32};  //!<  CTR 用 Vendor Specific IE で使用される OUI
const size_t VSIE_SIZE_MAX   = 250;

//NetworkDescription に含める接続情報
const bit16 EJECT_SPECTAOTR_FLAG     = 0x0001; //!<接続中の Spectator を退去させるフラグ、新規接続も禁止
const bit16 DISALLOW_CONNECT_FLAG    = 0x0002; //!<Client の新規接続を禁止する
const bit16 DISALLOW_RECONNECT_FLAG  = 0x0004; //!<Client の再接続を禁止する。 @ref DISALLOW_CONNECT_FLAG が有効の場合にのみ参照される
const bit16 DIRECT_BROADCAST_FLAG    = 0x8000; //!<DirectBroadcast の使用可否フラグ、かならずこのフラグは立っている


/*!--------------------------------------------------------------------------*
  @brief        UDS が使用する Vendor Specific IE の SubType
 *---------------------------------------------------------------------------*/
enum SubType
{
    NETWORK_DESCRIPTION_IE  = 21,   //!< NetworkDescription IE … 接続情報一式を格納 (Beacon)
    SPECTATOR_PACKET_IE      = 22,   //!< Spectator から Master へのデータ送信用 (Probe Request)
    SPECTATOR_ACK_IE         = 23,   //!< Master から Spectator への Acknowledge (Probe Response)
    NODE_INFORMATION_IE_1   = 24,   //!< ノード情報 IE(1) … 8台分の ユーザー名とフレンドコードを格納
    NODE_INFORMATION_IE_2   = 25    //!< ノード情報 IE(2) … 8台分の ユーザー名とフレンドコードを格納
};

/*!--------------------------------------------------------------------------*
  @brief        NetworkDescription IE の IE Body
 *---------------------------------------------------------------------------*/
struct NetworkDescriptionElement
{   
    //共通ヘッダ
    bit8  oui[3];           //!< OUI,      00:1f:32 固定
    u8    subType;          //!< SubType,  21 固定
    u32   gameId;           //!< プラットホームを越えて一意な、ゲームタイトル毎に割り振られるID
    u8    subId;            //!< サブID, 1タイトル内で複数の通信方式を利用する場合に利用する
    u8    sequenceNumber;   //!< シーケンス番号。ビーコン情報が更新される度にインクリメントされる
    bit16 attribute;        //!< 接続属性, 観戦機能の可否、新規接続の可否をビットフィールドで表現
    u32   temporaryId;      //!< MP 通信における TGID
    u8    nowEntry;         //!< 現在の接続数
    u8    maxEntry;         //!< 最大接続数
    u8    tmpEntry;         //!< 一時的に接続しているノードの数 [TODO] 現状未使用で、使い方が定まっていない
    bit8  platform;         //!< プラットホーム
    u8    securityType;     //!< セキュリティタイプ, NWM の定義に従う
    u8    reserved[10];     //!< 予約領域
    u8    digest[20];         //!< ダイジェスト値
    u8    appDataLength;    //!< 後に続くアプリデータのサイズ, 最大 @ref NET_DESC_APPDATA_SIZE_MAX (Byte) です。
    bit8  appData[NET_DESC_APPDATA_SIZE_MAX];   //!< アプリが自由に格納できるデータ, 最大 @ref NET_DESC_APPDATA_SIZE_MAX Byte です。
};

/*!--------------------------------------------------------------------------*
  @brief        NodeInformation IE の IE Body
 *---------------------------------------------------------------------------*/
struct NodeInformationElement
{   
    //共通ヘッダ
    bit8  oui[3];           //!< OUI,      00:1f:32 固定
    u8    subType;          //!< SubType,  前半8台分が 22, 後半8台分が 23
    bit8  payload[VSIE_SIZE_MAX];
};

} // end of namespace detail
} // end of namespace CTR
} // end of namespace uds
} // end of namespace nn

#endif /* LIBRARIES_UDS_CTR_UDS_IE_H_ */