1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     cec_Message.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: 31024 $
14  *---------------------------------------------------------------------------*/
15 #ifndef NN_CEC_CTR_CEC_TYPES_H_
16 #define NN_CEC_CTR_CEC_TYPES_H_
17 
18 #include <nn/types.h>
19 #include <nn/cec/CTR/cec_Const.h>
20 #include <nn/cec/CTR/cec_MessageId.h>
21 
22 namespace nn {
23 namespace cec {
24 namespace CTR {
25     /*!
26         @brief   すれちがい通信IDの形式です。@ref MakeCecTitleId で、この 32ビットの値を生成することができます。
27     */
28     typedef u32 TitleId;
29     typedef u32 GroupId;
30     typedef bit64 SenderId;
31 
32     //! @name SendMode
33     //@{
34     /*!
35      * @brief Messageの送信方式です。Messageに指定します。
36 
37               SENDMODE_RECV : 受信のみ<br>
38               SENDMODE_SEND : 送信のみ<br>
39               SENDMODE_SENDRECV : 送受信<br>
40               SENDMODE_EXCHANGE : 交換<br>
41               <br>
42               「受信のみ」に設定されたMessageは送信されず、相手の送信を待つのみになります。<br>
43               「交換」に設定されたMessageは、送信が成功しなかった場合、
44               そのとき受信したMessageは保存されません。<br>
45               また、受信したMessageには、交換で送信されたMessageのMessageIdが記録され、どのMessageと交換されたかを追跡することができます。このMessageIdは、Message::GetMessageId_Pair で取得できます。
46 
47 
48      */
49     typedef u8 SendMode;
50 
51         static const u8 SENDMODE_RECV           = 0x1;                  //!< 受信のみ
52         static const u8 SENDMODE_SEND           = 0x2;                  //!< 送信のみ
53         static const u8 SENDMODE_SENDRECV       = 0x3;                  //!< 送受信
54         static const u8 SENDMODE_EXCHANGE       = 0x0;                  //!< 交換
55 
56         static const u8 CEC_SENDMODE_RECV       = SENDMODE_RECV;
57         static const u8 CEC_SENDMODE_SEND       = SENDMODE_SEND;
58         static const u8 CEC_SENDMODE_SENDRECV   = SENDMODE_SENDRECV;
59         static const u8 CEC_SENDMODE_EXCHANGE   = SENDMODE_EXCHANGE;
60     //@}
61 
62 
63     //! @name MessageTypeFlag
64     //@{
65     /*!
66      * @brief 送信相手によって Message を切り替える為のフラグです。Messageに指定します。
67 
68               MESSAGE_TYPEFLAG_NON_FRIEND : 非Friendが受信可<br>
69               MESSAGE_TYPEFLAG_FRIEND     : Friendが受信可<br>
70 Friend/Friend問わず送信するデータには、 (MESSAGE_TYPEFLAG_NON_FRIEND | MESSAGE_TYPEFLAG_FRIEND) を指定します。<br>
71               groupId と組み合わせることで、送信相手がFriendか非FriendかでMessageを切り替えて送信することができます。
72 
73      */
74     typedef u8 MessageTypeFlag;
75 
76         static const u8 MESSAGE_TYPEFLAG_NON_FRIEND     = 0x1;          //!< 非Friendが受信可
77         static const u8 MESSAGE_TYPEFLAG_FRIEND         = 0x2;          //!< Friendが受信可
78 
79     typedef MessageTypeFlag CecMessageTypeFlag;
80     //@}
81 
82 
83     //! @name MessageExHeaderType
84     //@{
85 
86     /*!
87      * @brief Message の拡張Headerのデータ種別です。
88      */
89     typedef u32 MessageExHeaderType;
90 
91         static const u32 MESSAGE_EXHEADER_TYPE_MFILTER  = 0x00000001;    // ModuleFilter
92         static const u32 MESSAGE_EXHEADER_TYPE_ICON     = 0x00000002;   //!< 個々の Message のアイコン
93         static const u32 MESSAGE_EXHEADER_TYPE_NAME     = 0x00000003;    // アプリ名
94         static const u32 MESSAGE_EXHEADER_TYPE_INFO     = 0x00000004;   //!< 個々の Message のデータの説明
95         static const u32 MESSAGE_EXHEADER_TYPE_REGION   = 0x00000005;    // REGION
96 
97     typedef MessageExHeaderType CecMessageExHeaderType;
98     //@}
99 
100     #define MESSAGE_MAGIC       (0x6060)
101     #define MESSAGE_VERSION     (0x00000000)
102     struct CecMessageHeader
103     {
104         u16 magic16;                //!< マジックコード。固定値。
105         NN_PADDING2;
106 
107         u32 messSize;               //!< メッセージ全体のサイズ  (messSize = headerSize + bodySize + hashSize)
108         u32 headerSize;             //!< ヘッダのサイズ(ExHeaderを含む)
109         u32 bodySize;                //!< Message 本文のサイズ
110 
111         u32 cecTitleId;                 //!< Title固有ID
112         u32 cecTitleId_reserve;         //!< Title固有ID(予備)
113         u32 groupId;                //!< Title固有サブID
114         u32 sessionId;              //!< 送信時に付与されるID(同時に送信されたMessageは同じIDになる)
115         u8  messageId[CEC_SIZEOF_MESSAGEID];          //!< メッセージ固有ID
116         u32 messVersion;            //!< Messageバージョン
117         u8  messageId_pair[CEC_SIZEOF_MESSAGEID];     //!< メッセージ交換をした場合、対になるメッセージのID
118         u8  messageTypeFlag;        //!< Friend/Anybody
119         u8  sendMode;               //!< 送信/受信
120         bit8    flagUnread;                 //!< フラグ1
121         bit8    flagNew;                    //!< フラグ2
122         u64  senderId;              //!< 送信者のID
123         u64  senderId2;             //!< 送信者のID(予備)
124         nn::fnd::DateTimeParameters     sendDate;               //!< 送信日時(ms)
125         nn::fnd::DateTimeParameters     recvDate;               //!< 受信日時(ms)
126         nn::fnd::DateTimeParameters     createDate;             //!< 作成日時(ms)
127         u8  sendCount;              //!< 送信回数
128         u8  propagationCount;       //!< 伝播回数
129         bit16   tag;                //!< タグ
130         //u32   PAD[4]; // 16 bytes
131     };
132 
133 
134 } // namespace CTR
135 } // namespace cec
136 } // namespace nn
137 
138 #endif  //NN_CEC_CTR_CEC_TYPES_H_
139