[mirror_edk2.git] / ArmPkg / Include / Library / ArmDisassemblerLib.h

/** @file\r
\r
  Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef ARM_DISASSEMBLER_LIB_H_\r
#define ARM_DISASSEMBLER_LIB_H_\r
\r
/**\r
  Place a disassembly of **OpCodePtr into buffer, and update OpCodePtr to\r
  point to next instruction.\r
\r
  We cheat and only decode instructions that access\r
  memory. If the instruction is not found we dump the instruction in hex.\r
\r
  @param  OpCodePtrPtr  Pointer to pointer of ARM Thumb instruction to disassemble.\r
  @param  Thumb         TRUE for Thumb(2), FALSE for ARM instruction stream\r
  @param  Extended      TRUE dump hex for instruction too.\r
  @param  ItBlock       Size of IT Block\r
  @param  Buf           Buffer to sprintf disassembly into.\r
  @param  Size          Size of Buf in bytes.\r
\r
**/\r
VOID\r
DisassembleInstruction (\r
  IN  UINT8     **OpCodePtr,\r
  IN  BOOLEAN   Thumb,\r
  IN  BOOLEAN   Extended,\r
  IN OUT UINT32 *ItBlock,\r
  OUT CHAR8     *Buf,\r
  OUT UINTN     Size\r
  );\r
\r
#endif // ARM_DISASSEMBLER_LIB_H_\r
Commit	Line	Data
	1	/** @file\r
	2	\r
	3	Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
	4	\r
	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	6	\r
	7	**/\r
	8	\r
	9	#ifndef ARM_DISASSEMBLER_LIB_H_\r
	10	#define ARM_DISASSEMBLER_LIB_H_\r
	11	\r
	12	/**\r
	13	Place a disassembly of **OpCodePtr into buffer, and update OpCodePtr to\r
	14	point to next instruction.\r
	15	\r
	16	We cheat and only decode instructions that access\r
	17	memory. If the instruction is not found we dump the instruction in hex.\r
	18	\r
	19	@param OpCodePtrPtr Pointer to pointer of ARM Thumb instruction to disassemble.\r
	20	@param Thumb TRUE for Thumb(2), FALSE for ARM instruction stream\r
	21	@param Extended TRUE dump hex for instruction too.\r
	22	@param ItBlock Size of IT Block\r
	23	@param Buf Buffer to sprintf disassembly into.\r
	24	@param Size Size of Buf in bytes.\r
	25	\r
	26	**/\r
	27	VOID\r
	28	DisassembleInstruction (\r
	29	IN UINT8 **OpCodePtr,\r
	30	IN BOOLEAN Thumb,\r
	31	IN BOOLEAN Extended,\r
	32	IN OUT UINT32 *ItBlock,\r
	33	OUT CHAR8 *Buf,\r
	34	OUT UINTN Size\r
	35	);\r
	36	\r
	37	#endif // ARM_DISASSEMBLER_LIB_H_\r