ArmPkg: Replace BSD License with BSD+Patent License

[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_DISASSEBLER_LIB_H__\r
#define __ARM_DISASSEBLER_LIB_H__\r
\r
/**\r
  Place a dissasembly of of **OpCodePtr into buffer, and update OpCodePtr to\r
  point to next instructin.\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\r