// defines.h :
//

#if !defined(AGD_DEFINES_H__C7EAD575_99C7_4047_8E24_F5887CACEC73__INCLUDED_)
#define AGD_DEFINES_H__C7EAD575_99C7_4047_8E24_F5887CACEC73__INCLUDED_

#include "gfaspi.h"

#ifdef __cplusplus
extern "C" {
#endif	//	__cplusplus

/////////////////////////////////////////////////////////////////////////////
// defines.h - Declarations:

#define _SITARA_EGGELSBERG										0
#define _EXTENDED_ERROR_CHECK									1
#define _SUPPORT_LEGACY_UPTIME									0
#define _SCALE_DISPLAY_DUTY_CYCLE								0

/////////////////////////////////////////////////////////////////////////////

#define KFW_MAX_IMG_MATERIAL_NUM_LENGTH							16	// including the zero terminator
#define KFW_MAX_IMG_SERIAL_NUM_LENGTH							16	// including the zero terminator
#define KFW_MAX_IMG_NAME_BUILD_LENGTH							24	// including the zero terminator

#define KFW_IMG_HEADER_PREFIX_0									((unsigned int)0xFF01FF02)
#define KFW_IMG_HEADER_PREFIX_1									((unsigned int)0xFF03FF04)

/////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////

typedef union _TIVA_DCAP
{
	struct
	{
		unsigned int did0;
		unsigned int did1;
		unsigned int dc0;
	};
	struct
	{
		unsigned int min	: 8;	// Minor Die Revision
		unsigned int maj	: 8;	// Major Die Revision
		unsigned int cls	: 8;	// Device Class
		unsigned int res2	: 4;
		unsigned int ver0	: 3;	// DID0 Version
		unsigned int res1	: 1;

		unsigned int qual	: 2;	// Qualification Status
		unsigned int rohs	: 1;	// RoHS-Compliance
		unsigned int pkg	: 2;	// Package Type
		unsigned int temp	: 3;	// Temperature Range
		unsigned int res3	: 5;
		unsigned int pincnt	: 3;	// Package Pin Count
		unsigned int partno	: 8;	// Part Number
		unsigned int fam	: 4;	// Family
		unsigned int ver1	: 4;	// DID1 Version
		
		unsigned short fsize;		// Flash Size
		unsigned short ssize;		// SRAM Size
	};
}TIVA_DCAP, *LPTIVA_DCAP;
typedef const TIVA_DCAP *LPCTIVA_DCAP;

/////////////////////////////////////////////////////////////////////////////

typedef struct _TIVA_MEMORY_MAP
{
	unsigned int baseAddr;
	unsigned int size;
	bool bIsRO;
}TIVA_MEMORY_MAP, *LPTIVA_MEMORY_MAP;
typedef const TIVA_MEMORY_MAP *LPCTIVA_MEMORY_MAP;

/////////////////////////////////////////////////////////////////////////////

typedef struct _TIVA_MAT_SER
{
	char szImgMaterialNum[KFW_MAX_IMG_MATERIAL_NUM_LENGTH];
	char szImgNameBuild[KFW_MAX_IMG_NAME_BUILD_LENGTH];
}TIVA_MAT_SER, *LPTIVA_MAT_SER;
typedef const TIVA_MAT_SER *LPCTIVA_MAT_SER;

/////////////////////////////////////////////////////////////////////////////

typedef struct _KFW_IMG_HEADER
{
	const unsigned int	nPrefix0;
	const unsigned int	nPrefix1;
	const unsigned int	nImgLength;
	const unsigned int	nImgCRC32;
	const unsigned int	nReserved[4];
	union
	{
		struct
		{
			const char * const	pszImgMaterialNum;
			const char * const	pszImgNameBuild;
		}app;
		struct
		{
			const char szImgMaterialNum[KFW_MAX_IMG_MATERIAL_NUM_LENGTH];
			const char szImgNameBuild[KFW_MAX_IMG_NAME_BUILD_LENGTH];
		}bl;
	};
}KFW_IMG_HEADER, *LPKFW_IMG_HEADER;
typedef const KFW_IMG_HEADER *LPCKFW_IMG_HEADER;

/////////////////////////////////////////////////////////////////////////////

typedef struct _TIVA_UPLOAD_INFO
{
	const void *pData;
	size_t nCbData;
	LPCKFW_IMG_HEADER  pkih;
	const char *pszMat;
	const char *pszBld;
	atomic_t flgUIReady;
}TIVA_UPLOAD_INFO, *LPTIVA_UPLOAD_INFO;
typedef const TIVA_UPLOAD_INFO *LPCTIVA_UPLOAD_INFO;


/////////////////////////////////////////////////////////////////////////////


#define _min(a, b)						(((a) < (b)) ? (a) : (b))
#define _countof(a)						(sizeof(a) / sizeof(*a))
#define _JIFFY_DIFF(a, b)				((long)((unsigned long)(a) - (unsigned long)(b)))
#define KALERT(...)						printk(KERN_ALERT __VA_ARGS__)

/////////////////////////////////////////////////////////////////////////////


#if _SITARA_EGGELSBERG
#define _SPI_SPEED_HZ					100000
#else	//	_SITARA_EGGELSBERG
#define _SPI_SPEED_HZ					1000000
#endif	//	_SITARA_EGGELSBERG
#define _SPI_BITS_PER_WORD				8
#define _SPI_DEVICE						"/dev/spidev1.0"
#define _TIMER_INTERVAL					(jiffies + HZ) // 1 sec
#define _FIRMWARE_PAGES_COUNT			6
#define _FIRMWARE_BUFFER_SIZE			(64 * PAGE_SIZE) // = 2 ^ 6 * PAGE_SIZE

#define _BACKLIGHT_PERIOD_MIN			5000
#define _BACKLIGHT_PERIOD_MAX			1000000
#define _BACKLIGHT_PERIOD_DEFAULT		50000

#define _BACKLIGHT_DUTY_CYCLE_PERC_MIN	0
#define _BACKLIGHT_DUTY_CYCLE_PERC_MAX	100
#define _BACKLIGHT_DUTY_CYCLE_PERC_DEF	100

#define KFW_DEFAULT_PAGE_ERASE_TIME		20
#define KFW_FLASH_PAGE_SIZE				1024

#define KFW_DEFAULT_BASE_ADDRESS		0
//#define KFW_DEFAULT_BASE_ADDRESS		0x2000

#define KFW_MIN_UPLOAD_BLOCKSIZE		4
#define KFW_MAX_UPLOAD_BLOCKSIZE		76
#define KFW_DEFAULT_UPLOAD_BLOCKSIZE	76

#define KFW_MIN_HAS_MATERIAL_NR_VERSION	0x0202


/////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus
}
#endif	//	__cplusplus
#endif	//	!defined(AGD_DEFINES_H__C7EAD575_99C7_4047_8E24_F5887CACEC73__INCLUDED_)