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

/** @file

  Copyright (c) 2008-2010 Apple Inc. All rights reserved.<BR>

  All rights reserved. This program and the accompanying materials
  are licensed and made available under the terms and conditions of the BSD License
  which accompanies this distribution.  The full text of the license may be found at
  http://opensource.org/licenses/bsd-license.php

  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

**/

#ifndef __ARM_DISASSEBLER_LIB_H__
#define __ARM_DISASSEBLER_LIB_H__

/**
  Place a dissasembly of of **OpCodePtr into buffer, and update OpCodePtr to 
  point to next instructin. 
  
  We cheat and only decode instructions that access 
  memory. If the instruction is not found we dump the instruction in hex.
   
  @param  OpCodePtrPtr  Pointer to pointer of ARM Thumb instruction to disassemble.  
  @param  Thumb         TRUE for Thumb(2), FALSE for ARM instruction stream
  @param  Extended      TRUE dump hex for instruction too.
  @param  Buf           Buffer to sprintf disassembly into.
  @param  Size          Size of Buf in bytes. 
  
**/
VOID
DisassembleInstruction (
  IN  UINT8     **OpCodePtr,
  IN  BOOLEAN   Thumb,
  IN  BOOLEAN   Extended,
  OUT CHAR8     *Buf,
  OUT UINTN     Size
  );
  
#endif
Commit	Line	Data
097bd461	1	/** @file
	2
	3	Copyright (c) 2008-2010 Apple Inc. All rights reserved.<BR>
	4
	5	All rights reserved. This program and the accompanying materials
	6	are licensed and made available under the terms and conditions of the BSD License
	7	which accompanies this distribution. The full text of the license may be found at
	8	http://opensource.org/licenses/bsd-license.php
	9
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
	12
	13	**/
	14
	15	#ifndef __ARM_DISASSEBLER_LIB_H__
	16	#define __ARM_DISASSEBLER_LIB_H__
	17
	18	/**
	19	Place a dissasembly of of **OpCodePtr into buffer, and update OpCodePtr to
	20	point to next instructin.
	21
	22	We cheat and only decode instructions that access
	23	memory. If the instruction is not found we dump the instruction in hex.
	24
	25	@param OpCodePtrPtr Pointer to pointer of ARM Thumb instruction to disassemble.
	26	@param Thumb TRUE for Thumb(2), FALSE for ARM instruction stream
f9f937d2	27	@param Extended TRUE dump hex for instruction too.
097bd461	28	@param Buf Buffer to sprintf disassembly into.
	29	@param Size Size of Buf in bytes.
	30
	31	**/
	32	VOID
	33	DisassembleInstruction (
	34	IN UINT8 **OpCodePtr,
	35	IN BOOLEAN Thumb,
f9f937d2	36	IN BOOLEAN Extended,
097bd461	37	OUT CHAR8 *Buf,
	38	OUT UINTN Size
	39	);
	40
	41	#endif