/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     ptm_Api.h

  Copyright (C)2010 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 26531 $
 *---------------------------------------------------------------------------*/

#ifndef NN_PTM_CTR_PTM_API_H_
#define NN_PTM_CTR_PTM_API_H_

#include <nn/Handle.h>
#include <nn/Result.h>
#include <nn/types.h>
#include <nn/fnd.h>

namespace nn {
namespace ptm {
namespace CTR {

    Result Initialize();
    Result Finalize();

    /*!
        @name アラーム関連
        @{
    */

    /*!
        @brief アラームの通知取得用のイベントを登録します。

        @param[in]  event       アラーム通知用のイベントを指定します。
        @return                 結果を返します。
    */
    Result RegisterAlarmEvent(nn::os::Event &event);

    /*!
        @brief  アラームをセットします

        @param[in]  datetime    アラームの時刻を指定します
        @return                 アラーム設定の結果を返します。

        アラームを通知して欲しい時刻を指定し、指定時刻を過ぎると @ref RegisterAlarmEvent で登録したイベントがシグナルされます。

        指定できる年月日は 2000年1月1日から 2099年12月31日までになります。
        
        指定時刻を過ぎてから最大で1分程度遅れる場合があります。この仕様は今後変更される可能性があります。

        過去の時刻を指定するとすぐに通知されます。

        アラームが既に設定されているときは @ref nn::ptm::ResultAlarmOverWrite が帰ります。
        この場合でも、アラームの設定は成功します。
    */
    Result SetRtcAlarm(nn::fnd::DateTime datetime);

    /*!
        @brief 設定したアラームの時刻を取得します。
        @param[out] pDatetime   取得した時刻を入れるアドレスを指定します。
        @return                 取得の成否を返します。

        @ref SetRtcAlarm で設定した時刻を取得します。

        既に時刻が通知されている場合、アラームが設定されていない場合には @ref nn::ptm::ResultNoAlarm が返ります。
        このとき pDatetime には値は入りません。
    */
    Result GetRtcAlarm(nn::fnd::DateTime *pDatetime);

    /*!
        @brief      設定したアラームをキャンセルします。
        @return     キャンセルの成否を返します。

        既に時刻が通知されている場合、アラームが設定されていない場合には @ref nn::ptm::ResultNoAlarm が返ります。
    */
    Result CancelRtcAlarm();

    /*!
        @}
    */

    /*!
        @name 本体状態
        @{
    */

    /*!
        @brief  電源アダプタの状態を表します。
    */
    enum AdapterState
    {
        ADAPTERSTATE_NOCONNECTED,       //!< アダプタは接続されていません。
        ADAPTERSTATE_CONNECTED          //!< アダプタは接続されています。
    };

    /*!
        :private
    
        @brief  ふたの状態を表します。
    */
    enum ShellState
    {
        SHELLSTATE_CLOSED,              //!< ふたは閉じています。
        SHELLSTATE_OPENED               //!< ふたは開いています。
    };

    /*!
        @brief  バッテリの充電状態を表します
    */
    enum BatteryChargeState
    {
        BATTERYCHARGESTATE_NOCHARGING,   //!< 充電中ではありません。
        BATTERYCHARGESTATE_CHARGING      //!< 充電中です。
    };

    /*!
        @brief  バッテリの残量をレベルで表します。
    */
    enum BatteryLevel
    {
        BATTERYLEVEL_0,                 //!<  0%
        BATTERYLEVEL_1,                 //!<  1% ～   5%
        BATTERYLEVEL_2,                 //!<  6% ～  10%
        BATTERYLEVEL_3,                 //!< 11% ～  30%
        BATTERYLEVEL_4,                 //!< 31% ～  60%
        BATTERYLEVEL_5,                 //!< 61% ～ 100%

        BATTERYLEVEL_MIN = BATTERYLEVEL_0,  //!< バッテリレベルの最小値です。
        BATTERYLEVEL_MAX = BATTERYLEVEL_5   //!< バッテリレベルの最大値です。
    };

    /*!
        :private
    
        @brief  本体識別情報を表します。
    */
    enum HardwareType
    {
        HARDWARE_TYPE_DEVICE,           //!< 実機
        HARDWARE_TYPE_BOARD,            //!< TSボード
        HARDWARE_TYPE_DEBUGGER          //!< デバッガ
    };

    /*!
        @brief  電源アダプタの状態を取得します。

        @return 電源アダプタの状態を返します。
    */
    AdapterState    GetAdapterState();

    /*!
        :private
    
        @brief  ふたの状態を取得します。

        @return ふたの状態を返します。
    */
    ShellState      GetShellState();

    /*!
        @brief  バッテリの残量をレベルで取得します。

        @return バッテリ残量のレベルを返します。
    */
    BatteryLevel    GetBatteryLevel();

    /*!
        @brief  バッテリの充電状態を取得します。

        @return バッテリの充電状態を返します。
    */
    BatteryChargeState GetBatteryChargeState();

    /*!
        @}
    */
} // end of namespace CTR
} // end of namespace ptm
} // end of namespace nn


#endif  // ifndef NN_PTM_CTR_PTM_API_H_