1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     ir_Result.h
4 
5   Copyright (C)2009-2012 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: 47249 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_IR_CTR_IR_RESULT_H_
17 #define NN_IR_CTR_IR_RESULT_H_
18 
19 #include <nn/Result.h>
20 
21 /* Please see man pages for details
22 
23 */
24 
25 
26 namespace nn {
27 namespace ir {
28 namespace CTR {
29 
30     /*
31 
32     */
33     enum Description
34     {
35         DESCRIPTION_MACHINE_SLEEP = 1,      //
36         DESCRIPTION_FATAL_ERROR,            //
37 
38         // Protocol
39         DESCRIPTION_SIGNATURE_NOT_FOUND,    //
40         DESCRIPTION_DIFFERENT_SESSIONID,    //
41         DESCRIPTION_INVALID_CRC,            //
42         DESCRIPTION_FOLLOWING_DATA_NOT_EXIST,   //
43 
44         // Ir module error
45         DESCRIPTION_FRAMING_ERROR,          //
46         DESCRIPTION_OVERRUN_ERROR,          //
47         DESCRIPTION_PERFORMANCE_ERROR,      //
48         DESCRIPTION_MODULE_OTHER_ERROR,     //
49 
50         // Ir library state error
51         DESCRIPTION_ALREADY_CONNECTED,          //
52         DESCRIPTION_ALREADY_TRYING_TO_CONNECT,  //
53         DESCRIPTION_NOT_CONNECTED,              //
54 
55         // Send/Receive buffer error
56         DESCRIPTION_BUFFER_FULL,            //
57         DESCRIPTION_BUFFER_INSUFFICIENT,    //
58         DESCRIPTION_PACKET_FULL,            //
59 
60         // Error used by other libraries
61         DESCRIPTION_TIMEOUT,                //
62         DESCRIPTION_PERIPHERAL,             //
63         DESCRIPTION_PERIPHERAL_DATA_NOT_EXIST,   //
64         DESCRIPTION_CANNOT_CONFIRM_ID,      //
65         DESCRIPTION_INVALID_DATA,           //
66 
67 
68         DESCRIPTION_END
69     };
70 
71 /* Please see man pages for details
72 
73 
74 */
75 
76     /* Basic error */
77 
78 /* Please see man pages for details
79 
80 
81 */
82     NN_DEFINE_RESULT_CONST(
83         ResultNotInitialized,
84         Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_IR, Result::DESCRIPTION_NOT_INITIALIZED
85     );
86 
87 /* Please see man pages for details
88 
89 
90 */
91     NN_DEFINE_RESULT_CONST(
92         ResultAlreadyInitialized,
93         Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_IR, Result::DESCRIPTION_ALREADY_INITIALIZED
94     );
95 
96 /* Please see man pages for details
97 
98 
99 */
100     NN_DEFINE_RESULT_CONST(
101         ResultInvalidSize,
102         Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_IR, Result::DESCRIPTION_INVALID_SIZE
103     );
104 
105 /* Please see man pages for details
106 
107 
108 */
109     NN_DEFINE_RESULT_CONST(
110         ResultInvalidEnumValue,
111         Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_IR, Result::DESCRIPTION_INVALID_ENUM_VALUE
112     );
113 
114 /* Please see man pages for details
115 
116 
117 */
118     NN_DEFINE_RESULT_CONST(
119         ResultOutOfRange,
120         Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_IR, Result::DESCRIPTION_OUT_OF_RANGE
121     );
122 
123 /* Please see man pages for details
124 
125 
126 */
127     NN_DEFINE_RESULT_CONST(
128         ResultNoData,
129         Result::LEVEL_STATUS, Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_IR, Result::DESCRIPTION_NO_DATA
130     );
131 
132 /* Please see man pages for details
133 
134 
135 */
136     NN_DEFINE_RESULT_CONST(
137         ResultOutOfResource,
138         Result::LEVEL_STATUS, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_IR, Result::DESCRIPTION_OUT_OF_MEMORY
139     );
140 
141 /* Please see man pages for details
142 
143 
144 */
145     NN_DEFINE_RESULT_CONST(
146         ResultFatalError,
147         Result::LEVEL_FATAL, Result::SUMMARY_INTERNAL, Result::MODULE_NN_IR, DESCRIPTION_FATAL_ERROR
148     );
149 
150 /* Please see man pages for details
151 
152 
153 */
154     NN_DEFINE_RESULT_CONST(
155         ResultPerformanceError,
156         Result::LEVEL_STATUS, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_IR, DESCRIPTION_PERFORMANCE_ERROR
157     );
158 
159 /* Please see man pages for details
160 
161 
162 */
163     NN_DEFINE_RESULT_CONST(
164         ResultFramingError,
165         Result::LEVEL_STATUS, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_IR, DESCRIPTION_FRAMING_ERROR
166     );
167 
168 /* Please see man pages for details
169 
170 
171 */
172     NN_DEFINE_RESULT_CONST(
173         ResultOverrunError,
174         Result::LEVEL_STATUS, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_IR, DESCRIPTION_OVERRUN_ERROR
175     );
176 
177 /* Please see man pages for details
178 
179 
180 */
181     NN_DEFINE_RESULT_CONST(
182         ResultModuleOtherError,
183         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_IR, DESCRIPTION_MODULE_OTHER_ERROR
184     );
185 
186 
187 /* Please see man pages for details
188 
189 
190 */
191     NN_DEFINE_RESULT_CONST(
192         ResultMachineSleep,
193         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_IR, DESCRIPTION_MACHINE_SLEEP
194     );
195 
196     /* IRNOP-releated errors */
197 
198 /* Please see man pages for details
199 
200 
201 */
202     NN_DEFINE_RESULT_CONST(
203         ResultSignatureNotFound,
204         Result::LEVEL_STATUS, Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_IR, DESCRIPTION_SIGNATURE_NOT_FOUND
205     );
206 
207 /* Please see man pages for details
208 
209 
210 */
211     NN_DEFINE_RESULT_CONST(
212         ResultdifferentSessionId,
213         Result::LEVEL_STATUS, Result::SUMMARY_WRONG_ARGUMENT, Result::MODULE_NN_IR, DESCRIPTION_DIFFERENT_SESSIONID
214     );
215 
216 /* Please see man pages for details
217 
218 
219 */
220     NN_DEFINE_RESULT_CONST(
221         ResultInvalidCrc,
222         Result::LEVEL_STATUS, Result::SUMMARY_WRONG_ARGUMENT, Result::MODULE_NN_IR, DESCRIPTION_INVALID_CRC
223     );
224 
225 /* Please see man pages for details
226 
227 
228 */
229     NN_DEFINE_RESULT_CONST(
230         ResultFollowingDataNotExist,
231         Result::LEVEL_STATUS, Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_IR, DESCRIPTION_FOLLOWING_DATA_NOT_EXIST
232     );
233 
234 /* Please see man pages for details
235 
236 
237 */
238     NN_DEFINE_RESULT_CONST(
239         ResultAlreadyConnected,
240         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_IR, DESCRIPTION_ALREADY_CONNECTED
241     );
242 
243 /* Please see man pages for details
244 
245 
246 */
247     NN_DEFINE_RESULT_CONST(
248         ResultAlreadyTryingToConnect,
249         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_IR, DESCRIPTION_ALREADY_TRYING_TO_CONNECT
250     );
251 
252 /* Please see man pages for details
253 
254 
255 */
256     NN_DEFINE_RESULT_CONST(
257         ResultNotConnected,
258         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_IR, DESCRIPTION_NOT_CONNECTED
259     );
260 
261 /* Please see man pages for details
262 
263 
264 */
265     NN_DEFINE_RESULT_CONST(
266         ResultBufferFull,
267         Result::LEVEL_STATUS, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_IR, DESCRIPTION_BUFFER_FULL
268     );
269 
270 /* Please see man pages for details
271 
272 
273 */
274     NN_DEFINE_RESULT_CONST(
275         ResultPacketFull,
276         Result::LEVEL_STATUS, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_IR, DESCRIPTION_PACKET_FULL
277     );
278 
279 /* Please see man pages for details
280 
281 
282 */
283     NN_DEFINE_RESULT_CONST(
284         ResultBufferInsufficient,
285         Result::LEVEL_STATUS, Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_IR, DESCRIPTION_BUFFER_INSUFFICIENT
286     );
287 
288     /* Please see man pages for details
289 
290 
291     */
292     NN_DEFINE_RESULT_CONST(
293         ResultTimeout,
294         Result::LEVEL_STATUS, Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_IR, DESCRIPTION_TIMEOUT
295     );
296 
297     /* Please see man pages for details
298 
299 
300      */
301     NN_DEFINE_RESULT_CONST(
302         ResultPeripheral,
303         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_IR, DESCRIPTION_PERIPHERAL
304     );
305 
306     /* Please see man pages for details
307 
308 
309      */
310     NN_DEFINE_RESULT_CONST(
311         ResultCannotConfirmId,
312         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_IR, DESCRIPTION_CANNOT_CONFIRM_ID
313     );
314 
315     /* Please see man pages for details
316 
317 
318      */
319     NN_DEFINE_RESULT_CONST(
320         ResultInvalidData,
321         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_IR, DESCRIPTION_CANNOT_CONFIRM_ID
322     );
323 
324 }
325 }
326 }
327 
328 #endif /* NN_IR_CTR_IR_RESULT_H_ */
329