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

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

#ifndef NN_BOSS_BOSS_TYPES_H_
#define NN_BOSS_BOSS_TYPES_H_

#include <nn/types.h>
#include <nn/os/os_Event.h>
#include <nn/Handle.h>
#include <nn/http/http_Types.h>
#include <nn/fs/fs_Parameters.h>
#include <nn/boss/boss_Const.h>
#include <nn/boss/boss_Result.h>

/*=======================================================================*
    Type Definitions
 *=======================================================================*/

#ifdef __cplusplus

namespace nn {
namespace boss {

typedef nn::fs::TitleId         AppIdType;
typedef nn::fs::ExtSaveDataId   BossStorageId;

/* Please see man pages for details 
    
*/
typedef struct TaskPolicyConfig {
    u8                  priority;               //
    SchedulingPolicy    schedulingPolicy;       //
    TaskPermission      taskPermission;         //
    NN_PADDING1;
    u32                 targetDuration;         //
    u32                 execInterval;           //
    u32                 execCount;              //
} TaskPolicyConfig;


/* Please see man pages for details 
    
*/
typedef struct TaskOptionConfig {
    ExecOption      option;               //
    u8              step;                 //
    u8              targetStep;           //
    NN_PADDING1;
    u32             param1;               //
    u32             param2;               //
} TaskOptionConfig;

//------------------------------------------------------------
//  TASK ACTION   Cautions for 1st BOSS version
//      (1) ACTION supports Download and NsaDownload, parameters are provisionally defined although Upload and Signal are not implemented
//                    
//
//      (2) Regarding "nn::os::Event* event;" used with SIGNAL ACTION, must consider whether to develop after 2nd BOSS.
//          
//          Event* is held in a structure, and using it by registering it in the BOSS database is a problem.
//
//
/* Please see man pages for details 
    
*/
typedef struct TaskActionConfig {
    Action              action;                                 //
    u8                  privateRootCA;                          //
    u8                  privateClientCert;                      //
    ApInfoType          infoAP;                                 //
    FileDescriptor      fDsec;                                  //
    NN_PADDING3;
    u32                 execSerialID;                           //
    u32                 offset;                                 //
    nn::os::Event*      event;                                  //
    nn::Handle          fileHandle;                             //
    union File {
        char            filePath[MAX_FILEPATH_LENGTH];          //
        wchar_t         filePathW[MAX_FILEPATH_LENGTH];         //
    } file;
    char                url[MAX_URL_LENGTH];                    //
    
    struct HhttpRequestHeader{                                  
        char            label[MAX_HTTP_HEADER_LABEL];           //
        char            value[MAX_HTTP_HEADER_VALUE];           //
    } httpRequestHeader[MAX_HTTP_HEADER];                       //

    nn::http::InternalCaCertId      rootCA[MAX_ROOT_CA];        //
    nn::http::InternalClientCertId  clientCert[MAX_CLIENT_CERT];//
    u32                             rootCANum;                  //
    u32                             clientCertNum;              //

    NN_PADDING4;
    char lastModified[MAX_LASTMODIFIED_LENGTH];                 //

} TaskActionConfig;

/* Please see man pages for details 
    
*/
typedef TaskActionConfig TaskActionUploadConfig;

/* Please see man pages for details 
    
*/
typedef TaskActionConfig TaskActionDownloadConfig;

/* Please see man pages for details 
    
*/
typedef TaskActionConfig TaskActionSignalConfig;

/* Please see man pages for details 
    
*/
typedef TaskActionConfig TaskActionNsaDownloadConfig;


/* Please see man pages for details 
    
*/
typedef struct TaskConfig {
    u32                 execInterval;           //
    u32                 execCount;              //
    u8                  taskId[TASK_ID_LENGTH]; //
} TaskConfig;


/* Please see man pages for details 
    
*/
typedef struct TaskStatusInfo {
    s64                 taskStartTime;        //
    s64                 stepStartTime;        //
    TaskStateCode       state;                //
    TaskStateCode       taskState;            //
    TaskStateCode       stateResume;          //
    TaskServiceStatus   serviceStatus;        //
    bool                serviceTerminated;    //
    TaskResultCode      resultCode;           //
    NN_PADDING2;

    u32                 commErrorCode;        //
    u32                 execCount;            //
    u32                 pendingTime;          //
    u32                 remainTime;           //
    u32                 progress;             //
    u32                 dataSize;             //
    u16                 activeRate;           //
    u16                 requestRate;          //
    u8                  activeStep;           //
    u8                  priority;             //
    NN_PADDING2;
    char lastModified[MAX_LASTMODIFIED_LENGTH];  //
} TaskStatusInfo;


/* Please see man pages for details 
    
*/
typedef TaskStatusInfo TaskStepStatusInfo ;

/* Please see man pages for details 
    
*/
typedef struct TaskErrorInfo {
    TaskResultCode  errorResultCode;            //
    NN_PADDING3;
    u32        errorCode;                       //
    char       message[MAX_ERROR_MESSAGE];      //
} TaskErrorInfo;

/* Please see man pages for details 
    
*/
typedef struct ApplicationIdInfoList {
    u16       size;                             //
    NN_PADDING2;
    NN_PADDING4;
    AppIdType appId[MAX_APPLICATION_ID];        //
} ApplicationIdInfoList;

/* Please see man pages for details 
    
*/
typedef struct TaskIdInfoList {
    u16     size;                               //
    NN_PADDING2;
    NN_PADDING4;
    u8      taskId[MAX_TASK_ID][TASK_ID_LENGTH];//
} TaskIdInfoList;

/* Please see man pages for details 
    
*/
typedef struct StepIdInfoList {
    u16       size;                     //
    NN_PADDING2;
    u8        StepID[MAX_TASK_ID];      //
} StepIdInfoList;

/* Please see man pages for details 
    
*/
typedef struct NsDataIdInfoList {
    u16       size;                     //
    u16       lastIndex;                //
    u32       lastSerial;               //
    u32*      pSerial;                  //
    size_t    serialSize;               //
} NsDataIdInfoList;

/* Please see man pages for details 
    
*/
typedef struct NsDataHeaderInfo {
    s64       titleId;                  //
    bit32     flags;                    //
    bit32     dataType;                 //
    s32       length;                   //
    u32       serialId;                 //
    u32       version;                  //
    NN_PADDING4;  
} NsDataHeaderInfo;

} // end of namespace boss
} // end of namespace nn


#endif /*__cplusplus*/

#endif /* NN_BOSS_BOSS_TYPES_H_ */