1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     ptm_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: 47251 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_PTM_CTR_PTM_RESULT_H_
17 #define NN_PTM_CTR_PTM_RESULT_H_
18 
19 #ifdef __cplusplus
20 
21 #include <nn/Result.h>
22 
23 namespace nn {
24 namespace ptm {
25 
26 /*
27 
28 */
29 enum Description
30 {
31     DESCRIPTION_INVALID_SYSTEMTIME = 1,
32     DESCRIPTION_NOALARM,
33     DESCRIPTION_OVERWRITEALARM,
34     DESCRIPTION_FILEERROR,
35     DESCRIPTION_NOT_SLEEPING,
36     DESCRIPTION_INVALID_TRIGGER,
37     DESCRIPTION_MCU_FATAL_ERROR
38 };
39 
40 /* Please see man pages for details
41 
42 
43 */
44 
45 NN_DEFINE_RESULT_CONST(
46     ResultNotImplemented,
47     Result::LEVEL_FATAL, Result::SUMMARY_NOT_SUPPORTED, Result::MODULE_NN_PTM, nn::Result::DESCRIPTION_NOT_IMPLEMENTED
48 );
49 
50 NN_DEFINE_RESULT_CONST(
51     ResultInvalidSystemTime,
52     Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_PTM, DESCRIPTION_INVALID_SYSTEMTIME
53 );
54 
55 /* Please see man pages for details
56 
57 
58 */
59 NN_DEFINE_RESULT_CONST(
60     ResultOverWriteAlarm,
61     Result::LEVEL_SUCCESS, Result::SUMMARY_SUCCESS, Result::MODULE_NN_PTM, DESCRIPTION_OVERWRITEALARM
62 );
63 
64 /* Please see man pages for details
65 
66 
67 */
68 NN_DEFINE_RESULT_CONST(
69     ResultNoAlarm,
70     Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_PTM, DESCRIPTION_NOALARM
71 );
72 
73 /* Please see man pages for details
74 
75 
76 */
77 NN_DEFINE_RESULT_CONST(
78     ResultNotRegistered,
79     Result::LEVEL_PERMANENT, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_PTM, Result::DESCRIPTION_NOT_INITIALIZED
80 );
81 
82 NN_DEFINE_RESULT_CONST(
83     ResultFileError,
84     Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_PTM, DESCRIPTION_FILEERROR
85 );
86 
87 /* Please see man pages for details
88 
89 
90 */
91 NN_DEFINE_RESULT_CONST(
92     ResultWrongArgument,
93     Result::LEVEL_USAGE, Result::SUMMARY_WRONG_ARGUMENT, Result::MODULE_NN_PTM, Result::DESCRIPTION_NO_DATA
94 );
95 
96 NN_DEFINE_RESULT_CONST(
97     ResultNotSleeping,
98     Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_PTM, DESCRIPTION_NOT_SLEEPING
99 );
100 
101 NN_DEFINE_RESULT_CONST(
102     ResultInvalidTrigger,
103     Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_PTM, DESCRIPTION_INVALID_TRIGGER
104 );
105 
106 /* Please see man pages for details
107 
108 
109 */
110 NN_DEFINE_RESULT_CONST(
111     ResultInvalidAlarm,
112     Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_PTM, Result::DESCRIPTION_OUT_OF_RANGE
113 );
114 
115 NN_DEFINE_RESULT_CONST(
116     ResultOutOfRange,
117     Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_PTM, Result::DESCRIPTION_OUT_OF_RANGE
118 );
119 
120 NN_DEFINE_RESULT_CONST(
121     ResultInvalidSize,
122     Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_PTM, Result::DESCRIPTION_INVALID_SIZE
123 );
124 
125 // For internal use
126 NN_DEFINE_RESULT_CONST(
127     ResultMcuFatalError,
128     Result::LEVEL_FATAL, Result::SUMMARY_INTERNAL, Result::MODULE_NN_PTM, DESCRIPTION_MCU_FATAL_ERROR
129 );
130 
131 // For internal use
132 NN_DEFINE_RESULT_CONST(
133     ResultNotWrite,
134     Result::LEVEL_SUCCESS, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_PTM, Result::DESCRIPTION_SUCCESS
135 );
136 
137 // For internal use
138 NN_DEFINE_RESULT_CONST(
139     ResultNotFound,
140     Result::LEVEL_PERMANENT, Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_PTM, Result::DESCRIPTION_NOT_FOUND
141 );
142 
143 } // end of namespace ptm
144 } // end of namespace nn
145 
146 #endif // #ifdef __cplusplus
147 #endif // #ifndef NN_PTM_CTR_PTM_RESULT_H_
148