/*---------------------------------------------------------------------------*
  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: 34180 $
 *---------------------------------------------------------------------------*/

#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 {

    /*!
    @brief      PTM ライブラリの初期化を行います。

    @return     通常失敗することはあり得ません。ResultSuccess が返ります。
    */
    Result Initialize();

    /*!
    @brief      PTM ライブラリを終了します。

    @return     通常失敗することはあり得ません。ResultSuccess が返ります。
    */
    Result Finalize();

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

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

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

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

        @param[in]  datetime    アラームの時刻を指定します

        @return     関数の実行結果を返します。以下に挙げる Result を返します。
        @retval     ResultSuccess               処理に成功しました。
        @retval     ResultNotRegistered         @ref nn::ptm::CTR::RegisterAlarmEvent が実行されていません。
        @retval     ResultInvalidAlarm          指定している年月日が範囲外です。
        @retval     ResultOverWriteAlarm        既に設定されていました。
    */
    Result SetRtcAlarm(nn::fnd::DateTime datetime);

    /*!
        @brief 設定したアラームの時刻を取得します。
        @param[out] pDatetime   取得した時刻を入れるアドレスを指定します。
        @return     関数の実行結果を返します。以下に挙げる Result を返します。
        @retval     ResultSuccess               処理に成功しました。
        @retval     ResultNoAlarm               アラームが設定されていません。

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

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

    /*!
        @brief      設定したアラームをキャンセルします。
        @return     関数の実行結果を返します。以下に挙げる Result を返します。
        @retval     ResultSuccess               処理に成功しました。
        @retval     ResultNoAlarm               アラームが設定されていません。

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

    /*!
        @}
    */

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

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

    /*!
        @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();

    /*!
        @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_