/* art_if.h -  contains the ART wrapper function declarations */
 
/* Copyright (c) 2000 Atheros Communications, Inc., All Rights Reserved */

#ifndef __INCartifh
#define __INCartifh


extern A_INT32 art_mdkErrNo;
extern A_CHAR art_mdkErrStr[SIZE_ERROR_BUFFER];

A_INT32  art_setupDevice
(
	A_UINT32 whichDevice
);

#ifndef __ATH_DJGPPDOS__
A_UINT32 art_createEvent
(
	A_UINT32 devNum,
    A_UINT32 type,
    A_UINT32 persistent,
    A_UINT32 param1,
    A_UINT32 param2,
    A_UINT32 param3
);
A_UINT32 art_getISREvent(A_UINT32 devNum, EVENT_STRUCT *ppEvent);
#endif

A_UINT32 art_cfgRead
(
	A_UINT32 devNum,
    A_UINT32 regOffset
);

A_UINT32 art_regRead
(
	A_UINT32 devNum,
    A_UINT32 regOffset
);

A_UINT32 art_regWrite
(
	A_UINT32 devNum,
    A_UINT32 regOffset,
    A_UINT32 regValue
);

A_UINT32 art_memRead 
(
	A_UINT32 devNum,
    A_UINT32 physAddr, 
	A_UCHAR  *bytesRead,
    A_UINT32 length
);

A_UINT32 art_memWrite
(
	A_UINT32 devNum,
    A_UINT32 physAddr, 
	A_UCHAR  *bytesWrite,
    A_UINT32 length
);

A_UINT32 art_cfgWrite
(
	A_UINT32 devNum,
    A_UINT32 regOffset,
    A_UINT32 regValue
);

void art_setResetParams
(
 A_UINT32   devNum,
 A_CHAR     *pFilename,
 A_BOOL		eePromLoad,
 A_BOOL		eePromHeaderLoad,
 A_UCHAR    mode,
 A_UINT16     initCodeFlag
);

A_UINT32 art_resetDevice
(
	A_UINT32 devNum,
	A_UCHAR *mac, 
	A_UCHAR *bss, 
	A_UINT32 freq,
	A_UINT32 turbo
);

void art_getDeviceInfo
(
 A_UINT32 devNum,
 SUB_DEV_INFO *devStruct
);

A_UINT32 art_eepromRead
(
	A_UINT32  devNum,
	A_UINT32 eepromOffset
);

void art_eepromWrite
(
	A_UINT32 devNum,
	A_UINT32 eepromOffset,
	A_UINT32 eepromValue
);

void art_eepromReadBlock
(
	A_UINT32 devNum,
	A_UINT32 startOffset,
	A_UINT32 length,
	A_UINT32 *buf
);

void art_eepromReadLocs
(
	A_UINT32 devNum,
	A_UINT32 startOffset,
	A_UINT32 length,
	A_UINT8 *buf
);

void art_eepromWriteBlock
(
	A_UINT32 devNum,
	A_UINT32 startOffset,
	A_UINT32 length,
	A_UINT32 *buf
);



A_UINT32 art_checkRegs
(
	A_UINT32 devNum
);

A_UINT32 art_checkProm
(
	A_UINT32 devNum,
	A_UINT32 enablePrint
);

void art_rereadProm
(
	A_UINT32 devNum
);

void art_changeChannel
(
	A_UINT32 devNum,
	A_UINT32 freq
);

void art_txDataSetup
(
	A_UINT32 devNum,
	A_UINT32 rateMask,
	A_UCHAR *dest, 
	A_UINT32 numDescPerRate,
	A_UINT32 dataBodyLength,
	A_UCHAR *dataPattern, 
	A_UINT32 dataPatternLength, 
	A_UINT32 retries,
	A_UINT32 antenna,
	A_UINT32 broadcast
);

void art_txDataBegin
(
	A_UINT32 devNum,
	A_UINT32 timeout,
	A_UINT32 remoteStats
);

void art_rxDataSetup
(
	A_UINT32 devNum,
	A_UINT32 numDesc,
	A_UINT32 dataBodyLength,
	A_UINT32 enablePPM
);

void art_cleanupTxRxMemory
(
 A_UINT32 devNum,
 A_UINT32 flags
);

void art_rxDataBegin
(
	A_UINT32 devNum,
	A_UINT32 waitTime,
	A_UINT32 timeout,
	A_UINT32 remoteStats,
	A_UINT32 enableCompare,
	A_UCHAR *dataPattern, 
	A_UINT32 dataPatternLength
);

// works with Signal Generators
void art_rxDataBeginSG
(
	A_UINT32 devNum,
	A_UINT32 waitTime,
	A_UINT32 timeout,
	A_UINT32 remoteStats,
	A_UINT32 enableCompare,
	A_UCHAR *dataPattern, 
	A_UINT32 dataPatternLength,
	A_UINT32 sgpacketnumber
);



void art_rxGetData
(
 A_UINT32 devNum, 
 A_UINT32 bufferNum, 
 A_UCHAR *pReturnBuffer, 
 A_UINT32 sizeBuffer
);

void art_rxDataComplete
(
	A_UINT32 devNum,
	A_UINT32 waitTime,
	A_UINT32 timeout,
	A_UINT32 remoteStats,
	A_UINT32 enableCompare,
	A_UCHAR *dataPattern, 
	A_UINT32 dataPatternLength
);


void art_txrxDataBegin
(
	A_UINT32 devNum,
	A_UINT32 waitTime,
	A_UINT32 timeout,
	A_UINT32 remoteStats,
	A_UINT32 enableCompare,
	A_UCHAR *dataPattern, 
	A_UINT32 dataPatternLength
);

A_BOOL art_rxLastDescStatsSnapshot
(
 A_UINT32 devNum, 
 RX_STATS_SNAPSHOT *pRxStats
);

void art_setAntenna
(
	A_UINT32 devNum,
	A_UINT32 antenna
);

A_UINT16 art_getMaxPowerForRate
(
 A_UINT32 devNum,
 A_UINT16 freq,
 A_UINT16 rate
);

A_UINT16 art_getPcdacForPower
(
 A_UINT32 devNum,
 A_UINT16 freq,
 A_INT16 power
);

void art_txContBegin
(
	A_UINT32 devNum,
	A_UINT32 type,
	A_UINT32 typeOption1,
	A_UINT32 typeOption2,
	A_UINT32 antenna
);

void art_txContFrameBegin
(
	A_UINT32 devNum,
	A_UINT32 length,
	A_UINT32 ifswait,
	A_UINT32 typeOption1,
	A_UINT32 typeOption2,
	A_UINT32 antenna,
	A_BOOL   performStabilizePower,
	A_UINT32 numDescriptors,
	A_UCHAR *dest
);


void art_txContEnd
(
	A_UINT32 devNum
);

void art_txGetStats
(
 A_UINT32 devNum, 
 A_UINT32 rateInMb,
 A_UINT32 remote,
 TX_STATS_STRUCT *pReturnStats 
);

void art_rxGetStats
(
	A_UINT32 devNum,
	A_UINT32 rateInMb,
	A_UINT32 remote,
	RX_STATS_STRUCT *pReturnStats 
);

void art_rxDataStart
(
 A_UINT32 devNum
);

void art_setSingleTransmitPower
(
 A_UINT32 devNum,
 A_UCHAR pcdac
);


void art_getField
(
	A_UINT32 devNum,
	A_CHAR   *fieldName,
	A_UINT32 *baseValue,
	A_UINT32 *turboValue
);

void art_changeField
(
	A_UINT32 devNum,
	A_CHAR *fieldName, 
	A_UINT32 newValue
);

void art_writeField
(
	A_UINT32 devNum,
	A_CHAR *fieldName, 
	A_UINT32 newValue
);

void art_teardownDevice
(
	A_UINT32 devNum
);

A_BOOL art_testLib
(
 A_UINT32 devNum,
 A_UINT32 timeout
);

void art_ForceSinglePCDACTable
(
	A_UINT32 devNum, 
	A_UINT16 pcdac
);

void art_ForceSinglePCDACTableGriffin
(
	A_UINT32 devNum, 
	A_UINT16 pcdac,
	A_UINT16 offset
);

void art_ForcePCDACTable
(
	A_UINT32 devNum, 
	A_UINT16 *pcdac
);

void art_specifySubSystemID
(
 A_UINT32 devNum,
 A_INT16  subsystemID
);
void art_forcePowerTxMax 
(
	A_UINT32		devNum,
	A_UINT16		*pRatesPower
);

void art_forceSinglePowerTxMax 
(
	A_UINT32		devNum,
	A_UINT16		powerValue
);

A_UINT16 art_GetEepromStruct
(
 A_UINT32 devNum,
 A_UINT16 eepStructFlag,	//which eeprom strcut
 void **ppReturnStruct		//return ptr to struct asked for
);

void art_writeNewProdData
(
 A_UINT32 devNum,
 A_INT32  *argList,
 A_UINT32 numArgs
);

void art_writeProdData
(
 A_UINT32 devNum,
 A_UCHAR wlan0Mac[6],
 A_UCHAR wlan1Mac[6],
 A_UCHAR enet0Mac[6],
 A_UCHAR enet1Mac[6]
);

A_BOOL art_ftpDownloadFile
(
 A_UINT32 devNum,
 A_CHAR *hostname,
 A_CHAR *user,
 A_CHAR *password,
 A_CHAR *remoteFile,
 A_CHAR *localFile
);


A_BOOL checkLibError
(
	 A_UINT32 devNum,
     A_BOOL	printError 
);

void art_getLastErrorStr
(
 A_CHAR *pStrBuffer
);

A_INT32 art_getFieldForMode
(
 A_UINT32 devNum,
 A_CHAR   *fieldName,
 A_UINT32  mode,			//desired mode 
 A_UINT32  turbo		//Flag for base or turbo value
);

A_INT32 art_getFieldForModeChecked
(
 A_UINT32 devNum,
 A_CHAR   *fieldName,
 A_UINT32  mode,			//desired mode 
 A_UINT32  turbo		//Flag for base or turbo value
);

void art_changeMultipleFieldsAllModes
(
 A_UINT32		  devNum,
 PARSE_MODE_INFO *pFieldsToChange,
 A_UINT32		  numFields
);

void art_changeMultipleFields
(
 A_UINT32		  devNum,
 PARSE_FIELD_INFO *pFieldsToChange,
 A_UINT32		  numFields
);

A_INT16 art_GetMacAddr
(
	A_UINT32 devNum,
	A_UINT16 wmac,
	A_UINT16 instNo,
	A_UINT8	*macAddr
);

A_BOOL selectPrimary
(
 void
);

A_BOOL selectSecondary
(
 void
);

A_BOOL activateCommsInitHandshake
(
 A_CHAR *machName
);

A_BOOL art_waitForGenericCmd
(
 void *pSock,
 A_UCHAR   *pStringVar,
 A_UINT32  *pIntVar1,
 A_UINT32  *pIntVar2,
 A_UINT32  *pIntVar3
);

A_BOOL art_sendGenericCmd
(
 A_UINT32 devNum,
 A_CHAR *stringVar,
 A_INT32 intVar1,
 A_INT32 intVar2,
 A_INT32 intVar3
);

A_BOOL waitCommsInitHandshake
(
 void
);

void closeComms
(
 void
);


void art_enableHwCal
(
	 A_UINT32 devNum,
     A_UINT32 calFlag
);

void art_supplyFalseDetectbackoff
(
	A_UINT32 devNum,
	A_UINT32 *pBackoffValues
);

A_INT16 art_configureLibParams
(
	A_UINT32 devNum
);

A_UINT16 art_getXpdgainForPower
(
	A_UINT32 devNum,
	A_INT16  power
);

A_UINT16 art_getPowerIndex
(
	A_UINT32 devNum,
	A_INT32  power   // 2 x power in dB
);

A_UINT32 art_getArtAniLevel
(
	A_UINT32 devNum,
	A_UINT32 artAniType   // NI/BI/SI
);
void art_setArtAniLevel
(
	A_UINT32 devNum,
	A_UINT32 artAniType,   // NI/BI/SI
	A_UINT32 artAniLevel
);

A_BOOL	 art_getCtlPowerInfo
(
 A_UINT32 devNum,
 CTL_POWER_INFO *pReturnStruct //pointer to structure to fill
);

double art_getMaxLinPower
(
	A_UINT32 devNum
);

A_UINT16 art_getEARCalAtChannel
(
 A_UINT32 devNum, 
 A_BOOL   atCal, 
 A_UINT16 channel, 
 A_UINT32 *word, 
 A_UINT16 xpd_mask,
 A_UINT32 version_mask
 );

A_UINT32 get_eeprom_size(A_UINT32 devNum,A_UINT32 *eepromSize, A_UINT32 *checkSumLength);
A_BOOL eeprom_verify_checksum (A_UINT32 devNum);
A_UINT32 eeprom_get_checksum(A_UINT32 devNum, A_UINT16 startAddr, A_UINT32 numWords ) ;

A_UINT32 art_hwReset(A_UINT32 devNum, A_UINT32 rMask);
void art_pllProgram(A_UINT32 devNum, A_UINT32 turbo, A_UINT32 mode);
A_UINT32 art_calCheck (A_UINT32 devNum, A_UINT32 enableCal, A_UINT32 timeout );
void art_pciWrite(A_UINT32 devNum, PCI_VALUES *pPciValues, A_UINT32 length);
A_UINT32 art_ap_reg_read ( A_UINT32 devNum, A_UINT32 regAddr);
A_UINT32 art_ap_reg_write ( A_UINT32 devNum, A_UINT32 regAddr, A_UINT32 regValue);
A_UINT32 load_and_run_code( A_UINT32 devNum, A_UINT32 loadAddress, A_UINT32 totalBytes, A_UCHAR *loadBytes);
void art_fillTxStats ( A_UINT32 devNum, A_UINT32 descAddress, A_UINT32 numDesc, A_UINT32 dataBodyLen, A_UINT32 txTime, TX_STATS_STRUCT *txStats);
void art_createDescriptors(A_UINT32 devNumIndex, A_UINT32 descBaseAddress,  A_UINT32 descInfo, A_UINT32 bufAddrIncrement, A_UINT32 descOp, A_UINT32 descWords[MAX_DESC_WORDS]);
A_UINT32 art_memAlloc (   A_UINT32 allocSize, A_UINT32 physAddr, A_UINT32 devNum  );
void art_memFree (   A_UINT32 fAddr, A_UINT32 devNum  );
void art_memFreeAll (   A_UINT32 devNum  );
void art_load_and_program_code( A_UINT32 devNum, A_UINT32 loadAddress, A_UINT32 totalBytes, A_UCHAR *loadBytes, A_BOOL calData);
A_INT32 art_getRefClkSpeed(A_UINT32 devNum) ;
void art_sleepCmd ( A_UINT32 devNum, A_UINT32 sleep_enable);

#ifndef CUSTOMER_REL		  
A_UINT32 art_send_frame_and_recv(
   A_UINT32 devIndex, 
   A_UINT8 *pBuffer, 
   A_UINT32 tx_desc_ptr, 
   A_UINT32 tx_buf_ptr, 
   A_UINT32 rx_desc_ptr, 
   A_UINT32 rx_buf_ptr,
   A_UINT32 rate_code
);

A_UINT32 art_recv_frame_and_xmit(
   A_UINT32 devIndex, 
   A_UINT32 tx_desc_ptr, 
   A_UINT32 tx_buf_ptr, 
   A_UINT32 rx_desc_ptr, 
   A_UINT32 rx_buf_ptr,
   A_UINT32 rate_code
);
#endif

#endif