/**
	@file
		DMW_PsiSdds.h

	@brief


	Copyright 2010 Digital STREAM Technology, Inc.
	All Rights Reserved
*/


#ifndef __DMW_PSI_SDDS_H__
#define __DMW_PSI_SDDS_H__


#include "DHL_Types.h"
#include "DLIB_SDDS.h" // 헤더 파일 안에서 DLIB 구조체를 직접 사용함.


#ifdef __cplusplus
extern "C" {
#endif



#if COMMENT
____Overview____(){}
#endif

/**
	@file DHL_MMM.h
	
	이곳에 이 모듈에 대해 설명이 필요한 각종 내용 기술..
	
	module overview
		- 
		-

	APIs
	
	implementations
	
	dependencies		
	

*/


#if COMMENT
____Config____(){}
#endif

/*
	이 부분은 별도의 DHL_XXX_Config configuration file 을 
	활용하는 것이 좋을 것 같음.
*/



/*
	플랫폼에 따라 달라짐.
	EMMA의 경우 NOR flash가 4MB 밖에 안된다. image 크기가 4M를 넘지 않는다.
*/
#define SDDS_MAX_MODULE_SIZE (0x400000)



#if COMMENT
____Types____(){}
#endif


/*
	client should fill this values, and pass back to MW.
*/
typedef struct
{
	UINT32 oui;     // IEEE OUI data
	
	UINT16 model;   // product model. oui specific. 0xFFFF means any model.
	UINT16 version; // product version. oui specific. 0xFFFF means any version.

} S_SDDS_CBPARAM_GET_OUI;


typedef struct
{
	sddsCompatDesc_t *desc; // [in] 체크하고자 하는 compat. 디스크립터.
	BOOL isOk; // [out] 이 descriptor가 맞으면 TRUE로 설정.
	
} S_SDDS_CBPARAM_CHECK_DESC;



typedef struct
{
	//int index; // module index. from 0..
	
	UINT16 id; // module id.
	UINT32 size; 
		// 모듈 전체의 크기. 이 크기에 해당되는 버퍼를 할당해 두어야 한다.

	UINT8 *name;
	UINT8 *version;
	
	UINT8   type; // ModuleType_BootLoader or ModuleType_Application

	// 이 펌웨어가 동작 가능한 하드웨어 버전 (리비전) 리스트.
	UINT8   numSupportedHwVersions;
	UINT8   *supportedHwVersions;

	UINT32  crc32;
	// 이 펌웨어 파일의 crc32.
	// 단순히 이름/버전 만으로 difference 여부를 신뢰하기 힘들다면 
	// flash에 기록된 firmware 전체에 대한 crc32를 비교하는 방법을 사용할 수도 있다.
	
	// 위 모든 사항이 조건에 맞는다면 아래 isOk를 True로 설정해줘야 한다.
	
	BOOL  isOk;  // [out]
	
} S_SDDS_CBPARAM_CHECK_FILE;



typedef struct
{
	UINT32 total_blocks;
	
} S_SDDS_CBPARAM_DOWNLOAD_START;



typedef struct
{
	sddsDdbPtr_t ddb;
	
	UINT32 idxblk;
	UINT32 offset;

	UINT32 received_blocks;
	UINT32 total_blocks;

} S_SDDS_CBPARAM_BLOCK_RECEIVED;



typedef enum
{
	eSDDS_CB_TYPE_GetOUI,
		// 아주 간단하게 compat descriptor를 선택할 수 있는 방법.
		// 제조사의 OUI 데이터만 리턴해 주면 MW가 알아서 선택한다.
		// param: S_SDDS_CBPARAM_GET_OUI *

	eSDDS_CB_TYPE_CheckCompatDesc,
		// 좀 더 세밀하게 compat desc. 선택하는 방법.
		// compat desc 포인터 자체를 받아서 내용을 확인 해 본후 yes/no 답해준다.
		// param: S_SDDS_CBPARAM_CHECK_DESC *

	// MW에서의 우선 순위:
	// 	eSDDS_CB_TYPE_GetOUI -> eSDDS_CB_TYPE_CheckCompatDesc
	//
	// 먼저 GetOUI를 얻어보고, OUI를 얻으면 이 값을 사용한다.
	// 따라서 CheckCompatDesc 콜백을 사용하려면 GetOUI는 구현하지 말아야 한다.

	eSDDS_CB_TYPE_NotifySchedules,
		// 
		// param: sddsScheduleDesc_t *


	eSDDS_CB_TYPE_CheckModuleInfo,
		//
		// param: S_SDDS_CBPARAM_CHECK_FILE *

	eSDDS_CB_TYPE_DownloadNotRequired,
		// 모듈 체크 결과, 다운로드가 필요하지 않게 된 경우에 호출된다.
		// 이게 호출 되면 dsi/dii가 변경되기 전까지는 
		// 더 이상의 sdds 진행은 이루어지지 않는다.
		//
		// param: none

	eSDDS_CB_TYPE_DownloadStarted,
		// 모든 점검 과정이 끝난 후에 다운로드 할 모듈이 있는 경우 호출된다.
		// 다운로드 할 모듈이 하나도 없는 경우에는 호출되지 않는다.
		// 
		// param: S_SDDS_CBPARAM_DOWNLOAD_START

	eSDDS_CB_TYPE_BlockReceived,
		// ddb block이 받아질 때 마다 호출된다.
		// application에서는 ddb block 내의 버퍼 내용을 다른 곳으로 memcpy 해 두어야 한다.
		// 특정 block 에 대해서 단 1회만 callback 된다. 즉 중복 호출되지는 않는다.
		//
		// param: S_SDDS_CBPARAM_BLOCK_RECEIVED *

	eSDDS_CB_TYPE_DownloadCompleted,
		// 각 모듈의 다운로드가 완료 되면 호출된다.
		// 모든 모듈이 다 다운로드가 완료 된 후에도 호출된다. (module id: -1)
		//
		// param: module id or (UINT32)-1 if all completed.

	eSDDS_CB_TYPE_DownloadStopped,
		// 다운로드가 일시 중지된 경우에 호출된다.
		// eSDDS_CB_TYPE_DownloadStarted 가 아직 불리기 전에도 이 콜백은 호출될 수 있다.
		//
		// param: none

	eSDDS_CB_TYPE_ResetDownload,
		//
		// param: none

	eSDDS_CB_TYPE_UserAction,
		//
		// param: userparam
	
	
} E_SDDS_CB_TYPE;

typedef void (*F_SDDS_CALLBACK)(E_SDDS_CB_TYPE cbtype, void *param);



#if COMMENT
____Defines____(){}
#endif






#if COMMENT
____API____(){}
#endif


/*
	SDDS 모듈을 초기화 한다.

	DMW 모듈 초기화 할 때 불려지면 된다.

	dependency:
		태스크 등을 DHL_TIMER 모듈을 사용하므로 해당 부분이 먼저 초기화 되어 있어야 함.
*/
void DMW_SDDS_Init(void);

/*
	SDDS 모듈에 사용될 user callback을 등록한다.
	아무 때나 불려도 됨.
	보통은 Init 후에 Start 전에 불러주면 좋다.
*/
void DMW_SDDS_RegisterCallback(F_SDDS_CALLBACK cb);


/*
	SDDS 다운로더 동작을 개시한다.

	만약 이전에 동작 했다가 Stop 된 상태라면, 다시 Resume 한다.

*/
void DMW_SDDS_Start(int pid);

/*
	SDDS 다운로더 동작을 일시 중지한다.
	모든 psi monitor는 중단된다.

	하지만 현재 수신되어 있는 데이터 및 자료는 보존된다.
	나중에 다시 Start API를 호출하여 resume 가능하다.
*/
void DMW_SDDS_Stop(void);


/*

*/
void DMW_SDDS_Reset(void);


/*

*/
void DMW_SDDS_PrintStatus(int level);


/*

*/
void DMW_SDDS_UserAction(UINT32 userparam);



#ifdef __cplusplus
} /* extern "C" */
#endif



#endif	/* __DMW_PSI_SDDS_H__ */