📄 amtxhal.h
字号:
WINAPI AMTXHAL_ICE_GetNumDevices(
long *pl_numDevices); // O - pointer to number of device
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_ICE_GetDescription(
long l_deviceIndex, // I - from 0 to numDevices-1
char *pc_descriptionBuffer, // O - pointer to the Description buffer
long l_bufferSize); // I - use AMTXHAL_ICE_DESCRIPTION_BUFFER_SIZE
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_ICE_GetSerialNumber(
long l_deviceIndex, // I - from 0 to numDevices-1
char *pc_serialNumberBuffer, // O - pointer to the Serial Number buffer
long l_bufferSize); // I - use AMTXHAL_ICE_SERIAL_NUMBER_BUFFER_SIZE
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_ICE_OpenBySerialNumber(
char *pc_serialNumberBuffer, // I - pointer to the Serial Number buffer
long l_bufferSize, //I- use AMTXHAL_ICE_SERIAL_NUMBER_BUFFER_SIZE
long *pl_iceHandle); // O - will return the handle of the ice
//####################################################################################################
// IN-CIRCUIT EMULATOR (ICE) INIT
//####################################################################################################
// This function MUST be used after opening any ICE (JTAGkey ...), or could be called for a complet
// re-init of the ICE.
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_ICE_Init(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_configID); // I - for non-expert, use AMTXHAL_ICE_CONFIG_ID_DEFAULT
//####################################################################################################
// PORT CONTROLS
//####################################################################################################
// These function can be called to verify the state of a specific Port.
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_PORT_GetVref(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long *pl_vrefLevel, // O - will return AMTXHAL_PORT_IO_LEVEL_
long *pl_vrefVoltage); // O- TBD To Be Defined, DO NOT USE FOR NOW
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_PORT_GetSrst(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long *pl_srstLevel); // O - will return AMTXHAL_PORT_IO_LEVEL_
//####################################################################################################
// COMMAND QUEUE (CMDQ) : AUTO EXECUTE THE QUEUE WHEN FULL
//####################################################################################################
// This function could be used when running JTAG applications as a SVF Player. In other words, when
// TDO bits need to be checked but does not need be catched.
// Using this function, the CMDQ (CoManD Queue) will be auto-executed when the CMDQ becomes full
// enough.
// This function can help to reach very fast performances since the CMDQ will be almost full before
// sending the commands to the ICE (In Circuit Emulator as Amontec USB JTAGkey)
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_SetAutoExeWhenFullEn(
long dwHandle, // I - handle returned by AMTXHAL_ICE_Open function
long dwAutoExeWhenFullEn); // I - use AMTXHAL_CMDQ_AUTOEXEWHENFULL_
//####################################################################################################
// COMMAND QUEUE (CMDQ) : GET QUEUE STATUS (for strict coding)
//####################################################################################################
//These function should be called before adding any commands in the Command Queue.
// - If queueStatus returns AMTXHAL_CMDQ_STATUS_READY, any new AMTXHAL_CMDQ_Add_ functions can be
// added.
// - If queueStatus returns AMTXHAL_CMDQ_STATUS_FULL, the CMDQ must be executed before adding a new
// commande. First you have to call AMTXHAL_CMDQ_ExeGetScanOutData or AMTXHAL_CMDQ_Exe and then you
// can add any new AMTXHAL_CMDQ_Add_ functions
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_GetQueueStatus(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long *pl_queueStatus); // O - will return AMTXHAL_CMDQ_STATUS_
//####################################################################################################
// COMMAND QUEUE (CMDQ) : GET AUTO-EXECUTED Flag
//####################################################################################################
//These function let know if the CMDQ was auto-executed after the last AMTXHAL_CMDQ_Add_ function
//call .
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_GetAutoExecutedFlag(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long *pl_autoExecutedFlag); // O - will return AMTXHAL_CMDQ_STATUS_
//####################################################################################################
// COMMAND QUEUE (CMDQ) : GET MAX LENGTH OF COMMANDS
//####################################################################################################
// These functions should be called before adding any specific JTAG commands with a variable width.
// These functions help to have a full CMDQ before executing it.
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_GetMaxWaitMicroSecondLength(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long *pl_maxWaitMicroSecondLength); // O - will return the maximum wait
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_GetMaxJtagScanLength(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long *pl_maxJtagScanLength); // O - will return the maximum scan length for CMDQ
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_GetMaxJtagRuntckLength(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long *pl_maxJtagRuntckLength); // O - will return the maximum TCK clock for CMDQ
//####################################################################################################
// COMMAND QUEUE (CMDQ) : ADD COMMAND TO THE COMAND QUEUE
//####################################################################################################
// Common commands
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_wait(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long l_microSecondLength); // I - number of micro seconds to wait
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_srst(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long l_srstLevel); // I - use AMTXHAL_PORT_IO_LEVEL_
// JTAG commands
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_jtag_frequency(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long l_hertz); // I - frequency of JTAG in hertz (HZ)
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_jtag_trst(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long l_trstLevel); // I - use AMTXHAL_PORT_IO_LEVEL_
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_jtag_tmsreset(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID); // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_jtag_scan(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long l_targetID, // I - for non-expert, use AMTXHAL_TARGET_ID_DEFAULT
long l_scanID, // I - for non-expert, use AMTXHAL_SCAN_ID_DEFAULT
long l_scanInEn, // I - use AMTXHAL_SCAN_IN_ENABLE_
long l_scanOutEn, // I - use AMTXHAL_SCAN_OUT_ENABLE_
long l_scanCheckEn, // I - use AMTXHAL_SCAN_CHECK_ENABLE_
long l_scanState, // I - use AMTXHAL_JTAG_STATE_
long l_scanLength, // I - scan length
char *pc_scanInTdiByteBuffer, // I - pointer to TDI buffer
char *pc_scanCheckExpectedTdoByteBuffer, // I - pointer to TDO Expected buffer
char *pc_scanCheckMaskedTdoByteBuffer, // I - pointer to TDO Mask buffer
long l_endState); // I - use AMTXHAL_JTAG_STATE_
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_jtag_state(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long l_endState); // I - use AMTXHAL_JTAG_STATE_
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_jtag_runtck(
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_portID, // I - for non-expert, use AMTXHAL_PORT_ID_DEFAULT
long l_runtckState, // I - use AMTXHAL_JTAG_STATE_
long l_runtckLength, // I - number of TCK clock to generate in the runtckState
long l_endState); // I - use AMTXHAL_JTAG_STATE_
// Loop commands
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_loop_while_scancheck_error( // *** NOT YET IMPLEMENTED *** return 1
long l_iceHandle, // I - handle returned by AMTXHAL_ICE_Open function
long l_maxLoopNum); // I - set the Maximum Number of loop (kind of timeout)
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Add_loop_end( // *** NOT YET IMPLEMENTED *** return 1
long l_iceHandle); // I - handle returned by AMTXHAL_ICE_Open function
//####################################################################################################
// COMMAND QUEUE (CMDQ) : EXECUTE QUEUE
//####################################################################################################
AMTXHAL_API
long // O - exit status
WINAPI AMTXHAL_CMDQ_Exe(
long l_iceHandle); // I - handle returned by AMTXHAL_ICE_Open function
AMTXHAL_API
long // O - exit status
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -