1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     ptm_Api.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: 38834 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_PTM_CTR_PTM_API_H_
17 #define NN_PTM_CTR_PTM_API_H_
18 
19 #include <nn/Handle.h>
20 #include <nn/Result.h>
21 #include <nn/types.h>
22 #include <nn/fnd.h>
23 
24 namespace nn {
25 namespace ptm {
26 namespace CTR {
27 
28     /* Please see man pages for details
29 
30 
31 
32     */
33     Result Initialize();
34 
35     /* Please see man pages for details
36 
37 
38 
39     */
40     Result Finalize();
41 
42     /* Please see man pages for details
43 
44 
45     */
46 
47     /* Please see man pages for details
48 
49 
50 
51 
52     */
53     Result RegisterAlarmEvent(nn::os::Event &event);
54 
55     /* Please see man pages for details
56 
57 
58 
59 
60 
61 
62 
63 
64 
65     */
66     Result SetRtcAlarm(nn::fnd::DateTime datetime);
67 
68     /* Please see man pages for details
69 
70 
71 
72 
73 
74 
75 
76 
77 
78 
79     */
80     Result GetRtcAlarm(nn::fnd::DateTime *pDatetime);
81 
82     /* Please see man pages for details
83 
84 
85 
86 
87 
88 
89     */
90     Result CancelRtcAlarm();
91 
92     /*
93 
94 */
95 
96     /* Please see man pages for details
97 
98 
99     */
100 
101     /* Please see man pages for details
102 
103     */
104     enum AdapterState
105     {
106         ADAPTERSTATE_NOCONNECTED,       //
107         ADAPTERSTATE_CONNECTED          //
108     };
109 
110     /* Please see man pages for details
111 
112     */
113     enum BatteryChargeState
114     {
115         BATTERYCHARGESTATE_NOCHARGING,   //
116         BATTERYCHARGESTATE_CHARGING      //
117     };
118 
119     /* Please see man pages for details
120 
121     */
122     enum BatteryLevel
123     {
124         BATTERYLEVEL_0,                 //
125         BATTERYLEVEL_1,                 //
126         BATTERYLEVEL_2,                 //
127         BATTERYLEVEL_3,                 //
128         BATTERYLEVEL_4,                 //
129         BATTERYLEVEL_5,                 //
130 
131         BATTERYLEVEL_MIN = BATTERYLEVEL_0,  //
132         BATTERYLEVEL_MAX = BATTERYLEVEL_5   //
133     };
134 
135     /* Please see man pages for details
136 
137 
138 
139     */
140     enum HardwareType
141     {
142         HARDWARE_TYPE_DEVICE,           //
143         HARDWARE_TYPE_BOARD,            //
144         HARDWARE_TYPE_DEBUGGER          //
145     };
146 
147     /* Please see man pages for details
148 
149 
150 
151     */
152     AdapterState    GetAdapterState();
153 
154     /* Please see man pages for details
155 
156 
157 
158     */
159     BatteryLevel    GetBatteryLevel();
160 
161     /* Please see man pages for details
162 
163 
164 
165     */
166     BatteryChargeState GetBatteryChargeState();
167 
168     /*
169 
170 */
171 } // end of namespace CTR
172 } // end of namespace ptm
173 } // end of namespace nn
174 
175 
176 #endif  // ifndef NN_PTM_CTR_PTM_API_H_
177