1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     nsoc_entry.h
4 
5   Copyright (C)2010 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: 21767 $
14  *---------------------------------------------------------------------------*/
15 
16 /**
17  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()で使用する情報構造体
18  */
19 
20 #ifndef __NSOC_ENTRY_H__
21 #define __NSOC_ENTRY_H__
22 
23 #include <nn/net/compatible/nsoc/nsoc_user.h>	/* for NSOC_IP_ALEN, NSOC_ETH_ALEN */
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 enum NSOCARPState {
30 	NSOC_ARP_STATE_INCOMPLETE              = 1, /**< ARP解決実行中状態 */
31 	NSOC_ARP_STATE_REACHABLE               = 2, /**< 到達可能状態 */
32 	NSOC_ARP_STATE_PROBE                   = 3  /**< 確認中状態 */
33 };
34 
35 /**
36  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()でNSOC_CONFIG_ARP_TABLE使用時の構造体
37  */
38 typedef struct NSOCARPEntry
39 {
40     int             state;                      /**< NSOC_ARP_STATE_*のいずれか */
41     u8              prAddr[NSOC_IP_ALEN];       /**< IPアドレス */
42     u8              hwAddr[NSOC_ETH_ALEN];      /**< MACアドレス */
43 } NSOCARPEntry;
44 
45 
46 /**
47  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()でNSOC_CONFIG_IP_ADDR_TABLE 使用時の構造体
48  */
49 typedef struct NSOCIPAddrEntry
50 {
51     u8              addr[NSOC_IP_ALEN];         /**< IPアドレス */
52     u8              netMask[NSOC_IP_ALEN];      /**< サブネットマスク */
53     u8              bcastAddr[NSOC_IP_ALEN];    /**< ブロードキャストアドレス */
54 } NSOCIPAddrEntry;
55 
56 enum NSOCIPRouteFlag {
57 	NSOC_IP_ROUTE_FLAG_G                   = 0x01,    /**< ルータからの情報により作成 */
58 	NSOC_IP_ROUTE_FLAG_D                   = 0x02,    /**< ICMPにより作成 */
59 	NSOC_IP_ROUTE_FLAG_M                   = 0x04     /**< ICMPにより変更 */
60 };
61 
62 /**
63  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()でNSOC_CONFIG_IP_ROUTING_TABLE 使用時の構造体
64  */
65 typedef struct NSOCIPRouteEntry
66 {
67     u8           dst[NSOC_IP_ALEN];          /**< 宛先IPアドレス */
68     u8           netmask[NSOC_IP_ALEN];      /**< サブネットマスク */
69     u8           gateway[NSOC_IP_ALEN];      /**< next-hopゲートウエイ */
70     u32          flag;                       /**< NSOC_IP_ROUTE_FLAG_XXX、NSOC_SetInstanceOpt()では0を指定してください。 */
71     NOSTick      time;                       /**< 最後にアクセスされた時刻(tick)、NSOC_SetInstanceOpt()では0を指定してください。 */
72 } NSOCIPRouteEntry;
73 
74 #ifdef NSOC_IP6_ENABLE
75 /**
76  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()でNSOC_CONFIG_IP6_ADD_ROUTE 使用時の構造体
77  */
78 typedef struct NSOCIP6RouteEntry
79 {
80     u8              prefix[NSOC_IP6_ALEN];      /**< プレフィックス */
81     u32             prefixLen;                  /**< プレフィックス長 */
82     u32             flag;                       /**< NSOC_IP_ROUTE_FLAG_XXX、NSOC_SetInstanceOpt()では0を指定してください。 */
83     u32             expireTime;                 /**< 期限切れとなる時刻(秒)、NSOC_SetInstanceOpt()時は0を指定してください。 */
84 } NSOCIP6RouteEntry;
85 
86 /**
87  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()でNSOC_CONFIG_IP6_ADD_ADDRESS、
88  * NSOC_CONFIG_IP6_ADDR_TABLE 使用時の構造体
89  */
90 typedef struct NSOCIP6MyAddrEntry
91 {
92     u8              addr[NSOC_IP6_ALEN];    /**< アドレス */
93     u32             preferredTime;          /**< Preferred Lifetime(秒) */
94     u32             validTime;              /**< Valid Lifetime(秒) */
95     u32             state;                  /**< 自アドレスの状態 NSOC_IP6_MYADR_ST_XXXX、NSOC_SetInstanceOpt()時は0を指定してください。 */
96     BOOL            anycast;                /**< エニーキャストアドレスか否か */
97 } NSOCIP6MyAddrEntry;
98 
99 /**
100  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()でNSOC_CONFIG_IP6_ADD_PREFIX、
101  * NSOC_CONFIG_IP6_PREFIX_TABLE 使用時の構造体
102  */
103 typedef struct NSOCIP6PrefixEntry
104 {
105     u8              prefix[NSOC_IP6_ALEN];  /**< プレフィックス */
106     u32             prefixLen;              /**< プレフィックス長。NSOC_GetInstanceOpt()時は1-64のビット長で指定してください。 */
107     u32             preferredTime;          /**< Preferred Lifetime(秒) */
108     u32             validTime;              /**< Valid Lifetime(秒) */
109     u8              flags;                  /**< NSOC_NDP_OPT_PI_FLAG_XXXXのいずれか */
110 } NSOCIP6PrefixEntry;
111 
112 /**
113  * NSOC_GetInstanceOpt()
114  * NSOC_CONFIG_IP6_NEIGHBOR_CACHE_TABLE 使用時の構造体
115  */
116 typedef struct NSOCIP6NeighborCacheEntry
117 {
118     u8              addr[NSOC_IP6_ALEN];    /**< 近隣アドレス */
119     u32             state;                  /**< キャッシュの状態 NSOC_NDP_NCST_XXXX */
120     BOOL            isRouter;               /**< ルータか否か */
121 } NSOCIP6NeighborCacheEntry;
122 
123 /**
124  * NSOC_GetInstanceOpt()で
125  * NSOC_CONFIG_IP6_DESTINATION_CACHE_TABLE 使用時の構造体
126  */
127 typedef struct NSOCIP6DestinationCacheEntry
128 {
129     u8              dst[NSOC_IP6_ALEN];     /**< 宛先アドレス */
130     u8              nextHop[NSOC_IP6_ALEN]; /**< 次ホップアドレス */
131     u32             pmtu;                   /**< パスMTU値 */
132 } NSOCIP6DestinationCacheEntry;
133 
134 /**
135  * NSOC_GetInstanceOpt()で
136  * NSOC_CONFIG_IP6_DEFAULT_ROUTER_TABLE 使用時の構造体
137  */
138 typedef struct NSOCIP6DefaultRouterEntry
139 {
140     u8              addr[NSOC_IP6_ALEN];     /**< デフォルトルータアドレス */
141 } NSOCIP6DefaultRouterEntry;
142 
143 #endif /* NSOC_IP6_ENABLE */
144 
145 /**
146  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()でNSOC_CONFIG_UDP_TABLE 使用時の構造体
147  */
148 typedef struct NSOCUDPEntry
149 {
150     NSOCSockAddrStorage    local;         /**< 自ソケットアドレス情報 */
151     NSOCSockAddrStorage    remote;        /**< 相手先ソケットアドレス情報 */
152 } NSOCUDPEntry;
153 
154 
155 #define NSOC_TCP_STATE_CLOSED        1    /**< CLOSEDステート */
156 #define NSOC_TCP_STATE_LISTEN        2    /**< LISTENステート */
157 #define NSOC_TCP_STATE_SYN_SENT      3    /**< SYN_SENTステート */
158 #define NSOC_TCP_STATE_SYN_RECEIVED  4    /**< SYN_RECEIVED ステート */
159 #define NSOC_TCP_STATE_ESTABLISHED   5    /**< ESTABLISHEDステート */
160 #define NSOC_TCP_STATE_FINWAIT1      6    /**< FINWAIT_1ステート */
161 #define NSOC_TCP_STATE_FINWAIT2      7    /**< FINWAIT_2ステート */
162 #define NSOC_TCP_STATE_CLOSE_WAIT    8    /**< CLOSE_WAITステート */
163 #define NSOC_TCP_STATE_LAST_ACK      9    /**< LAST_ACKステート */
164 #define NSOC_TCP_STATE_CLOSING       10   /**< CLOSINGステート */
165 #define NSOC_TCP_STATE_TIME_WAIT     11   /**< TIME_WAITステート */
166 
167 /**
168  * NSOC_GetInstanceOpt(), NSOC_SetInstanceOpt()でNSOC_CONFIG_TCP_TABLE 使用時の構造体
169  */
170 typedef struct NSOCTCPEntry
171 {
172     s32                    state;         /**< NSOC_TCP_STATE_*のいずれか */
173     NSOCSockAddrStorage    local;         /**< 自ソケットアドレス情報 */
174     NSOCSockAddrStorage    remote;        /**< 相手先ソケットアドレス情報 */
175 } NSOCTCPEntry;
176 
177 #ifdef __cplusplus
178 }
179 #endif
180 
181 #endif  /* __NSOC_ENTRY_H__ */
182