/*
<:copyright-BRCM:2013:DUAL/GPL:standard 

   Copyright (c) 2013 Broadcom 
   All Rights Reserved

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2, as published by
the Free Software Foundation (the "GPL").

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.


A copy of the GPL is available at http://www.broadcom.com/licenses/GPLv2.php, or by
writing to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.

:> 
*/

#ifndef PMCCOMMAND_H
#define PMCCOMMAND_H

#include "bcmtypes.h"

typedef union {
	struct {
#ifdef PMC_LITTLE_ENDIAN
		uint32 cmdID	: 8;
		uint32 error	: 8;
		uint32 msgID	: 8;
		uint32 srcPort	: 8;
#else
		uint32 srcPort	: 8;
		uint32 msgID	: 8;
		uint32 error	: 8;
		uint32 cmdID	: 8;
#endif
	} Bits;
	uint32 Reg32; 
} TCommandWord0;

#if defined(_BCM96836_) || defined(CONFIG_BCM96836)
typedef union {
    struct {
        uint32 devAddr  : 16;   // [15:00] bus in upper nibble (only values of 0-7 are allowed), device address in lower 12 bits (4096 devices = 0..4095)
        uint32 zoneIdx  : 10;   // [25:16] maximum 1023 registers/zone (0..1022)
        uint32 island   : 4;    // [27:26] maximum 15 power islands (0..15) (island 15 = ALL islands!
        uint32 reserved : 2;    // [31:28]
    } Bits;
    uint32  Reg32;
} TCommandWord1;
#else
typedef union {
	struct {
#ifdef PMC_LITTLE_ENDIAN
		uint32 zoneIdx  : 10;
		uint32 devAddr	: 10;
		uint32 island	: 4;
		uint32 logNum	: 8;
#else
		uint32 logNum	: 8;
		uint32 island	: 4;
		uint32 devAddr	: 10;
		uint32 zoneIdx  : 10;
#endif
	} Bits;
	uint32	Reg32;
} TCommandWord1;
#endif

// Ping, GetNextLogEntry, GetRMON and Sigma
typedef struct {
	uint32			unused[2];
} TCommandNoParams;

typedef struct {
	uint32			params[2];
} TCommandGenericParams;

// PowerZoneOnOff, SetRunState, SetPowerState
typedef struct {
#if (PMC_LITTLE_ENDIAN==1) && (PMC_CPU_BIG_ENDIAN==1)
	uint8			reserved[3];
	uint8			state;
#else
	uint8			state;
	uint8			reserved[3];
#endif
	uint32			unused;
} TCommandStateOnly;

// PowerDevOnOff
typedef struct {
#if (PMC_LITTLE_ENDIAN==1) && (PMC_CPU_BIG_ENDIAN==1)
	uint8			reserved[2];
	uint8			restore;
	uint8			state;
#else
	uint8			state;
	uint8			restore;
	uint8			reserved[2];
#endif
	uint32			unused;
} TCommandPowerDevice;

// PowerOffIsland
typedef struct {
#if (PMC_LITTLE_ENDIAN==1) && (PMC_CPU_BIG_ENDIAN==1)
	uint8			reserved[3];
	uint8			restore;
#else
	uint8			restore;
	uint8			reserved[3];
#endif
	uint32			unused;
} TCommandPowerIsland;

// SetClockLowGear, SetClockHighGear
typedef struct {
#if (PMC_LITTLE_ENDIAN==1) && (PMC_CPU_BIG_ENDIAN==1)
	uint8			reserved[3];
	uint8			clkN;
#else
	uint8			clkN;
	uint8			reserved[3];
#endif
	uint32			unused;
} TCommandSetClockN;

// SetClockGear
typedef struct {
#if (PMC_LITTLE_ENDIAN==1) && (PMC_CPU_BIG_ENDIAN==1)
	uint8			reserved[3];
	uint8			gear;
#else
	uint8			gear;
	uint8			reserved[3];
#endif
	uint32			unused;
} TCommandSetClockGear;

typedef struct {
#if (PMC_LITTLE_ENDIAN==1) && (PMC_CPU_BIG_ENDIAN==1)
	uint8			unused1;
	uint8			numTokens;
	uint8			tokenSize;
	uint8			queueNumber;
	uint16			unused2;
	uint8			high_watermark;
	uint8			low_watermark;
#else
	uint8			queueNumber;
	uint8			tokenSize;
	uint8			numTokens;
	uint8			unused1;
	uint8			low_watermark;
	uint8			high_watermark;
	uint16			unused2;
#endif
} TCommandAllocDQM;

typedef struct {
	uint32			phy_src_addr;
	uint32			dest_addr;		// lower 8 bits **may** be log2 window size
} TCommandJumpApp;

typedef struct {
	uint32			margin_mv_slow;
	uint32			margin_mv_fast;
} TCommandCloseAVS;

typedef struct {
	uint32			word2;
	uint32			word3;
} TCommandResponse;

typedef struct {
	TCommandWord0		word0;
	TCommandWord1		word1;
	union {
		TCommandNoParams	cmdNoParams;
		TCommandGenericParams	cmdGenericParams;
		TCommandStateOnly	cmdStateOnlyParam;
		TCommandPowerDevice	cmdPowerDevice;
		TCommandPowerIsland	cmdPowerIsland;
		TCommandSetClockN	cmdSetClockN;
		TCommandSetClockGear	cmdSetClockGear;
		TCommandAllocDQM	cmdAllocDqm;
		TCommandJumpApp		cmdJumpApp;
		TCommandCloseAVS	cmdCloseAVS;
		TCommandResponse	cmdResponse;
	} u;
} TCommand;

// special values to select all devices/zones
#define ALL_DEVICES	0x3ff
#define ALL_ZONES	0x3ff

// used in validate caller to prevent/allow restrictions on island, device and/or zone
#define ANY_ISLAND	998
#define ANY_DEVICE	1024
#define ANY_ZONE	1024
#define NO_ISLAND	999
#define NO_DEVICE	1025
#define NO_ZONE		1025

// error codes
enum {
	NO_ERROR = 0,
	INVALID_ISLAND,
	INVALID_DEVICE,
	INVALID_ZONE,
	INVALID_STATE,
	INVALID_COMMAND,
	LOG_EMPTY,
	INVALID_PARAM,
	BPCM_READ_TIMEOUT,
	INVALID_BUS,
	INVALID_QUEUE_NUMBER,
	QUEUE_NOT_AVAILABLE,
	INVALID_TOKEN_SIZE,
	INVALID_WATERMARKS,
	INSUFFIENT_QSM_MEMORY_AVAILABLE,
	INVALID_BOOT_COMMAND,
	BPCM_WRITE_TIMEOUT,
	CMD_TABLE_FULL,
	CMD_TABLE_LOCKED,
};

// command codes
enum {
	// low-level commands
	cmdReserved = 0,
	cmdGetDevPresence,
	cmdGetSWStrap,
	cmdGetHWRev,
	cmdGetNumZones,
	cmdPing,
	cmdGetNextLogEntry,
	cmdGetRMONandSigma,
	cmdSetClockHighGear,
	cmdSetClockLowGear,
	cmdSetClockGear,
	cmdReadBpcmReg,
	cmdReadZoneReg,
	cmdWriteBpcmReg,
	cmdWriteZoneReg,
#if defined _BCM96838_ || defined CONFIG_BCM96838
	// reserved 15..63
	// general-purpose high-level commands
	cmdSetRunState = 64,
	cmdSetPowerState,
	cmdShutdownAllowed,
	cmdGetSelect0,
	cmdGetSelect3,
	cmdGetAvsDisableState,
	cmdGetPVT,
	// reserved 69..127
	// specific-purpose high-level commands
	cmdPowerOffIsland = 128,
	cmdPowerDevOnOff,
	cmdPowerZoneOnOff,
	cmdResetDevice,
	cmdResetZone,
#ifndef BCM_6838
	cmdAllocateG2UDQM,
	cmdQSMAvailable,
#endif //#ifndef BCM_6838
	cmdRevision = 135,
	// reserved 136..255
#else
	// general-purpose high-level commands
	cmdSetRunState,
	cmdSetPowerState,
	cmdShutdownAllowed,
	cmdGetSelect0,
	cmdGetSelect3,
	cmdGetAvsDisableState,
	cmdGetPVT,
	// specific-purpose high-level commands
	cmdPowerDevOnOff,
	cmdPowerZoneOnOff,
	cmdResetDevice,
	cmdResetZone,
	cmdAllocateG2UDQM,
	cmdQSMAvailable,
	cmdRevision,
	cmdRegisterCmdHandler,
	cmdFindUnusedCommand,
	cmdLockCmdTable,
	cmdJumpApp,
	cmdStall,
	cmdCloseAVS,
#if defined(_BCM96836_) || defined(CONFIG_BCM96836)
    cmdReadROs,
    cmdBMUCommand,     // not used
    cmdGetIslandStatus,
    cmdGetTMON,
    cmdSetTemperatureThreholds,
    cmdResetTemperatureWarning,
#endif
#endif
};

extern void ProcessCommand(TCommand *cmd, TCommand *response);

#endif // PMCCOMMAND_H