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

  Copyright (C)2009 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: 26754 $
 *---------------------------------------------------------------------------*/

#ifndef NN_CEC_CTR_CEC_CONTROL_H_
#define NN_CEC_CTR_CEC_CONTROL_H_

#include <nn/fnd.h>
#include <nn/cec/CTR/cec_Api.h>

namespace nn {
namespace cec {
namespace CTR {

struct CecAllocFunc
{
    void* (*allocFunc)(size_t);  //!< メモリアロケート関数へのポインタです。
    void  (*freeFunc)(void*);    //!< メモリ解放関数へのポインタです。
};

//------------------------------------------------------------
// 通知用

/*!
    @struct     CecNotificationParam
    @brief      受信情報のBOX個々の情報
*/
struct CecNotificationParam
{
    nn::fnd::DateTimeParameters     recvDate;       //!<    受信日時
    u32                             cecTitleId;     //!<    BOXの cecTitleId
    u8                              messageId[CEC_SIZEOF_MESSAGEID];    //!< 受信MessageのMessageID(先頭のMessageのみ)
};

/*!
    @struct     CecNotificationData
    @brief      受信情報
*/
struct CecNotificationData
{
    size_t  num;                //!< 項目数
    s32     count;              //!< 受信回数(本体起動から)
    CecNotificationParam param[MESSAGE_BOX_NUM_MAX];    //!< 個々のBOXの情報
};


/*! 
    @class CecControl
    @brief Cecの状態を変更します。

           (Cecの状態はシステムに管理され、自動的に動作します。通常は、手動で状態を変更する必要はありません。)
*/

class CecControl {

public:

    enum ChangeDaemonState{
        DAEMON_CHANGE_STATE_READY ,
        DAEMON_CHANGE_STATE_STARTSCAN ,
        DAEMON_CHANGE_STATE_STOP,
        DAEMON_CHANGE_STATE_STOP_DAEMON,
        DAEMON_CHANGE_STATE_START_DAEMON,
        DAEMON_CHANGE_STATE_RESET_FILTER,

        DAEMON_CHANGE_STATE_NDM_RESUME,
        DAEMON_CHANGE_STATE_NDM_SUSPEND
        
    };

    /*! 
        @brief @ref GetCecState で取得される、Cecの状態を示す値です。DAEMON_STATE_IDLE のときしか BOXにアクセスすることはできません。
    */
    enum DaemonState
    {
        DAEMON_STATE_STOP,          //!< 動作していません
        DAEMON_STATE_IDLE,          //!< 停止中
        DAEMON_STATE_BUSY           //!< 動作中
    };


    CecControl(size_t bufSize);
    CecControl();
    ~CecControl();

    /*!
    :private
     * @brief       cec に接続します。cec にアクセスするために最初に呼ぶ必要があります。
     * @return      nn::Result
     */
    static nn::Result  Initialize();
    //static nn::Result  Initialize(CecAllocFunc& cecAllocFunc);
    static nn::Result  Initialize(nn::fnd::IAllocator& cecAllocFunc);
    #if 0
    static nn::Result  InitializeSys();
    #endif
    
    /*!
    :private
     * @brief       cec へのアクセスを終了します。
     * @return      nn::Result
     */
    static nn::Result  Finalize();

    #if 0
    static nn::Result  FinalizeSys();
    #endif


    static bool IsInitialized();
    #if 0
    static bool IsInitializedSys();
    #endif

    /*!
     :private
     * @brief       cec を Ready 状態に移行させます。nn::cec::Initialize() ～ Finalize() の間は呼ぶことはできません。 
                   （暫定的に用意されたAPIです。今後のバージョンでは、cecの状態を直接変更するAPIは削除されます。）
     * @return      nn::Result
     */
    static nn::Result  ReadyDaemon();

    /*!
     * @brief       cec の動作を開始させます。

     * @param[in]   reset         true をセットすると、BOXの内容を読み直して Scan を開始します。<br>
                                  また、記憶していた通信相手のリストも消去され、同じ相手と再接続することが可能になります。このとき、設定中のボックスだけでなく、全てのボックス（アプリ）のデータが、再度交換される可能性があります。<br>
                                  デバッグ時等、同じ相手と再接続する必要があるとき以外は使用しないでください。<br>
                                  リストの消去は、nn::cec::CTR::MessageBox::DeleteMessageBox() で BOXを削除したときも行われます。

     * @return      nn::Result
     */
    static nn::Result  StartScanning(bool reset = false);

    /*!
     * @brief       cec の動作を停止します。MessageBox にアクセスするには、停止状態である必要があります。

     * @param[in]   b_Immediate   true をセットすると、通信を中断して停止ステータスに移行します。
     * @return      nn::Result
     */
    static nn::Result  StopScanning(bool b_Immediate = false);

    /*!
     :private
     * @brief       CecDaemon を 停止させます。
                   （暫定的に用意されたAPIです。今後のバージョンでは、cecの状態を直接変更するAPIは削除されます。）

                   停止後は StartScanning を呼んでも動作開始しません。
     * @return      nn::Result
     */
    static nn::Result  StopDaemon();

    /*!
     :private
     * @brief       CecDaemon を 動作開始させます。
                   （暫定的に用意されたAPIです。今後のバージョンでは、cecの状態を直接変更するAPIは削除されます。）
     * @return      nn::Result
     */
    static nn::Result  StartDaemon();

    /*!
     :private
     * @brief       受信したMessageの情報を取得します。
     * @param[in]   cecTitleId              CecTitleId を指定します。
     * @param[out]  pCecInfoBuffer          CecNotificationData を受け取るバッファを指定します。
     * @param[in]   size                    バッファのサイズを指定します。
     * @return      nn::Result
     */
    static nn::Result GetCecInfoBuffer(  u32 cecTitleId, u8 pCecInfoBuffer[], size_t size );
    static nn::Result GetCecInfoBuffer(  u8 pCecInfoBuffer[], size_t size )
    {
        return GetCecInfoBuffer(  0, pCecInfoBuffer, size );
    };

    /*!
     * @brief       CECの状態を取得します。
     * @param[out]  state          状態を示す @ref DaemonState が格納されます。 DAEMON_STATE_IDLE のときのみ、BOXにアクセス可能です。
     * @return      nn::Result
     */
    static nn::Result GetCecState( u32* state );

    /*!
     :private
     * @brief       受信の通知を受ける Event をセットします。
     * @param[out]  event          受信があったときに Signal される Event です。
     * @return      nn::Result
     */
    static nn::Result GetCecRecvEventHandle( nn::os::Event& event );

    static nn::Result GetChangeStateEventHandle( nn::os::Event& event );

    /* @brief       NAND上の CECのBOX保存領域をフォーマットします。デバッグ用です。 */
    static nn::Result FormatSaveData();
};

/*!
 * @brief       CEC Daemon に接続します。CEC MessageBox にアクセスするために最初に呼ぶ必要があります。

 * @param[in]   cecAllocFunc        CEC ライブラリが使用するアロケータを指定します。
 
                                    CEC ライブラリのMessageデータ処理に必要なメモリを確保するために
                                    使用されます。最大で扱うMessageデータサイズ × 2 程度のメモリが使用されます。
 * @return      nn::Result
 */
nn::Result  Initialize(nn::fnd::IAllocator& cecAllocFunc);

/*!
 * @brief       CEC Daemon に接続します。CEC MessageBox にアクセスするために最初に呼ぶ必要があります。

 * @return      nn::Result
 */
nn::Result  Initialize();

inline nn::Result  Initialize()
{
    return CecControl::Initialize();
}

nn::Result  Initialize(nn::cec::CTR::CecAllocFunc& cecAllocFunc);

inline nn::Result  Initialize(nn::fnd::IAllocator& cecAllocFunc)
{
    return CecControl::Initialize(cecAllocFunc);
}

/*!
 * @brief       CEC Daemon へのアクセスを終了します。
 * @return      nn::Result
 */
nn::Result  Finalize();

inline nn::Result  Finalize()
{
    return CecControl::Finalize();
}

/*!
 * @brief       受信の通知を受ける Event を指定します。
 * @param[out]  event          受信があったときに Signal される Event です。
 * @return      nn::Result
 */
nn::Result GetCecRecvEventHandle( nn::os::Event& event );
inline nn::Result GetCecRecvEventHandle( nn::os::Event& event )
{
    return CecControl::GetCecRecvEventHandle( event );
}


/*!
 * @brief       受信したMessageの情報を取得します。

                グルーピングして複数のMessageを受け取ったときでも、取得できる情報は1つ分だけです。
 
 * @param[in]   cecTitleId              CecTitleId を指定します。
 * @param[out]  pCecInfoBuffer          CecNotificationData を受け取るバッファを指定します。
 * @param[in]   size                    バッファのサイズを指定します。
 * @return      nn::Result
 */
nn::Result GetCecInfoBuffer( u32 cecTitleId, u8 pCecInfoBuffer[], size_t size );
nn::Result GetCecInfoBuffer( u8 pCecInfoBuffer[], size_t size );

inline nn::Result GetCecInfoBuffer( u32 cecTitleId, u8 pCecInfoBuffer[], size_t size )
{
    return CecControl::GetCecInfoBuffer(cecTitleId, pCecInfoBuffer, size );
}

inline nn::Result GetCecInfoBuffer( u8 pCecInfoBuffer[], size_t size )
{
    return CecControl::GetCecInfoBuffer(0, pCecInfoBuffer, size );
}



} // end of namespace CTR
} // end of namespace cec
} // end of namespace nn



#endif  // ifndef NN_CEC_CTR_CEC_CONTROL_H_