-/*++\r
+/** @file\r
\r
-Copyright (c) 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007, Intel Corporation All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-Module Name:\r
\r
- EdbDisasmSupport.c\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
\r
#include "Edb.h"\r
\r
UINTN mInstructionNameOffset;\r
UINTN mInstructionContentOffset;\r
\r
+/**\r
+\r
+ Set offset for Instruction name and content.\r
+\r
+ @param InstructionNameOffset - Instruction name offset\r
+ @param InstructionContentOffset - Instruction content offset\r
+\r
+**/\r
VOID\r
EdbSetOffset (\r
IN UINTN InstructionNameOffset,\r
IN UINTN InstructionContentOffset\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Set offset for Instruction name and content\r
-\r
-Arguments:\r
-\r
- InstructionNameOffset - Instruction name offset\r
- InstructionContentOffset - Instruction content offset\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
mInstructionNameOffset = InstructionNameOffset;\r
mInstructionContentOffset = InstructionContentOffset;\r
return ;\r
}\r
\r
+/**\r
+\r
+ Pre instruction string construction.\r
+\r
+ @return Instruction string\r
+\r
+**/\r
CHAR16 *\r
EdbPreInstructionString (\r
VOID\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Pre instruction string construction\r
-\r
-Arguments:\r
-\r
- None\r
-\r
-Returns:\r
-\r
- Instruction string\r
-\r
---*/\r
{\r
ZeroMem (&mInstructionString, sizeof(mInstructionString));\r
mInstructionNameOffset = 0;\r
return (CHAR16 *)&mInstructionString;\r
}\r
\r
+/**\r
+\r
+ Post instruction string construction.\r
+\r
+ @return Instruction string\r
+\r
+**/\r
CHAR16 *\r
EdbPostInstructionString (\r
VOID\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Post instruction string construction\r
-\r
-Arguments:\r
-\r
- None\r
-\r
-Returns:\r
-\r
- Instruction string\r
-\r
---*/\r
{\r
CHAR16 *Char;\r
\r
return (CHAR16 *)&mInstructionString;\r
}\r
\r
+/**\r
+\r
+ Get Sign, NaturalUnits, and ConstantUnits of the WORD data.\r
+\r
+ @param Data16 - WORD data\r
+ @param NaturalUnits - Natural Units of the WORD\r
+ @param ConstantUnits - Constant Units of the WORD\r
+\r
+ @return Sign value of WORD\r
+\r
+**/\r
BOOLEAN\r
EdbGetNaturalIndex16 (\r
IN UINT16 Data16,\r
OUT UINTN *NaturalUnits,\r
OUT UINTN *ConstantUnits\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Get Sign, NaturalUnits, and ConstantUnits of the WORD data\r
-\r
-Arguments:\r
-\r
- Data16 - WORD data\r
- NaturalUnits - Natural Units of the WORD\r
- ConstantUnits - Constant Units of the WORD\r
-\r
-Returns:\r
-\r
- Sign value of WORD\r
-\r
---*/\r
{\r
BOOLEAN Sign;\r
UINTN NaturalUnitBit;\r
return Sign;\r
}\r
\r
+/**\r
+\r
+ Get Sign, NaturalUnits, and ConstantUnits of the DWORD data.\r
+\r
+ @param Data32 - DWORD data\r
+ @param NaturalUnits - Natural Units of the DWORD\r
+ @param ConstantUnits - Constant Units of the DWORD\r
+\r
+ @return Sign value of DWORD\r
+\r
+**/\r
BOOLEAN\r
EdbGetNaturalIndex32 (\r
IN UINT32 Data32,\r
OUT UINTN *NaturalUnits,\r
OUT UINTN *ConstantUnits\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Get Sign, NaturalUnits, and ConstantUnits of the DWORD data\r
-\r
-Arguments:\r
-\r
- Data32 - DWORD data\r
- NaturalUnits - Natural Units of the DWORD\r
- ConstantUnits - Constant Units of the DWORD\r
-\r
-Returns:\r
-\r
- Sign value of DWORD\r
-\r
---*/\r
{\r
BOOLEAN Sign;\r
UINTN NaturalUnitBit;\r
return Sign;\r
}\r
\r
+/**\r
+\r
+ Get Sign, NaturalUnits, and ConstantUnits of the QWORD data.\r
+\r
+ @param Data64 - QWORD data\r
+ @param NaturalUnits - Natural Units of the QWORD\r
+ @param ConstantUnits - Constant Units of the QWORD\r
+\r
+ @return Sign value of QWORD\r
+\r
+**/\r
BOOLEAN\r
EdbGetNaturalIndex64 (\r
IN UINT64 Data64,\r
OUT UINT64 *NaturalUnits,\r
OUT UINT64 *ConstantUnits\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Get Sign, NaturalUnits, and ConstantUnits of the QWORD data\r
-\r
-Arguments:\r
-\r
- Data64 - QWORD data\r
- NaturalUnits - Natural Units of the QWORD\r
- ConstantUnits - Constant Units of the QWORD\r
-\r
-Returns:\r
-\r
- Sign value of QWORD\r
-\r
---*/\r
{\r
BOOLEAN Sign;\r
UINTN NaturalUnitBit;\r
return Sign;\r
}\r
\r
-UINT8\r
-EdbGetBitWidth (\r
- IN UINT64 Value\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Get Bit Width of the value\r
+/**\r
\r
-Arguments:\r
+ Get Bit Width of the value.\r
\r
- Value - data\r
+ @param Value - data\r
\r
-Returns:\r
+ @return Bit width\r
\r
- Bit width\r
-\r
---*/\r
+**/\r
+UINT8\r
+EdbGetBitWidth (\r
+ IN UINT64 Value\r
+ )\r
{\r
if (Value >= 10000000000000) {\r
return 14;\r
}\r
}\r
\r
-UINTN\r
-EdbPrintInstructionName (\r
- IN CHAR16 *Name\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
- Print the instruction name\r
+ Print the instruction name.\r
\r
-Arguments:\r
+ @param Name - instruction name\r
\r
- Name - instruction name\r
+ @return Instruction name offset\r
\r
-Returns:\r
-\r
- Instruction name offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintInstructionName (\r
+ IN CHAR16 *Name\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Name,\r
return mInstructionNameOffset;\r
}\r
\r
-UINTN\r
-EdbPrintRegister1 (\r
- IN UINT8 Operands\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print register 1 in operands\r
-\r
-Arguments:\r
+/**\r
\r
- Operands - instruction operands\r
+ Print register 1 in operands.\r
\r
-Returns:\r
+ @param Operands - instruction operands\r
\r
- Instruction content offset\r
+ @return Instruction content offset\r
\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintRegister1 (\r
+ IN UINT8 Operands\r
+ )\r
{\r
if (Operands & OPERAND_M_INDIRECT1) {\r
EDBSPrintWithOffset (\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintRegister2 (\r
- IN UINT8 Operands\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
- Print register 2 in operands\r
+ Print register 2 in operands.\r
\r
-Arguments:\r
+ @param Operands - instruction operands\r
\r
- Operands - instruction operands\r
+ @return Instruction content offset\r
\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintRegister2 (\r
+ IN UINT8 Operands\r
+ )\r
{\r
if (Operands & OPERAND_M_INDIRECT2) {\r
EDBSPrintWithOffset (\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintDedicatedRegister1 (\r
- IN UINT8 Operands\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print dedicated register 1 in operands\r
-\r
-Arguments:\r
+/**\r
\r
- Operands - instruction operands\r
+ Print dedicated register 1 in operands.\r
\r
-Returns:\r
+ @param Operands - instruction operands\r
\r
- Instruction content offset\r
+ @return Instruction content offset\r
\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintDedicatedRegister1 (\r
+ IN UINT8 Operands\r
+ )\r
{\r
switch (Operands & OPERAND_M_OP1) {\r
case 0:\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintDedicatedRegister2 (\r
- IN UINT8 Operands\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print dedicated register 2 in operands\r
+/**\r
\r
-Arguments:\r
+ Print dedicated register 2 in operands.\r
\r
- Operands - instruction operands\r
+ @param Operands - instruction operands\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintDedicatedRegister2 (\r
+ IN UINT8 Operands\r
+ )\r
{\r
switch ((Operands & OPERAND_M_OP2) >> 4) {\r
case 0:\r
return mInstructionContentOffset;\r
}\r
\r
+/**\r
+\r
+ Print the hexical UINTN index data to instruction content.\r
+\r
+ @param Sign - Signed bit of UINTN data\r
+ @param NaturalUnits - natural units of UINTN data\r
+ @param ConstantUnits - natural units of UINTN data\r
+\r
+ @return Instruction content offset\r
+\r
+**/\r
UINTN\r
EdbPrintIndexData (\r
IN BOOLEAN Sign,\r
IN UINTN NaturalUnits,\r
IN UINTN ConstantUnits\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical UINTN index data to instruction content\r
-\r
-Arguments:\r
-\r
- Sign - Signed bit of UINTN data\r
- NaturalUnits - natural units of UINTN data\r
- ConstantUnits - natural units of UINTN data\r
-\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
+/**\r
+\r
+ Print the hexical QWORD index data to instruction content.\r
+\r
+ @param Sign - Signed bit of QWORD data\r
+ @param NaturalUnits - natural units of QWORD data\r
+ @param ConstantUnits - natural units of QWORD data\r
+\r
+ @return Instruction content offset\r
+\r
+**/\r
UINTN\r
EdbPrintIndexData64 (\r
IN BOOLEAN Sign,\r
IN UINT64 NaturalUnits,\r
IN UINT64 ConstantUnits\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical QWORD index data to instruction content\r
-\r
-Arguments:\r
-\r
- Sign - Signed bit of QWORD data\r
- NaturalUnits - natural units of QWORD data\r
- ConstantUnits - natural units of QWORD data\r
-\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintRawIndexData16 (\r
- IN UINT16 Data16\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical WORD raw index data to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the hexical WORD raw index data to instruction content.\r
\r
- Data16 - WORD data\r
+ @param Data16 - WORD data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintRawIndexData16 (\r
+ IN UINT16 Data16\r
+ )\r
{\r
BOOLEAN Sign;\r
UINTN NaturalUnits;\r
return Offset;\r
}\r
\r
-UINTN\r
-EdbPrintRawIndexData32 (\r
- IN UINT32 Data32\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical DWORD raw index data to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the hexical DWORD raw index data to instruction content.\r
\r
- Data32 - DWORD data\r
+ @param Data32 - DWORD data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintRawIndexData32 (\r
+ IN UINT32 Data32\r
+ )\r
{\r
BOOLEAN Sign;\r
UINTN NaturalUnits;\r
return Offset;\r
}\r
\r
-UINTN\r
-EdbPrintRawIndexData64 (\r
- IN UINT64 Data64\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical QWORD raw index data to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the hexical QWORD raw index data to instruction content.\r
\r
- Data64 - QWORD data\r
+ @param Data64 - QWORD data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintRawIndexData64 (\r
+ IN UINT64 Data64\r
+ )\r
{\r
BOOLEAN Sign;\r
UINT64 NaturalUnits;\r
return Offset;\r
}\r
\r
-UINTN\r
-EdbPrintImmData8 (\r
- IN UINT8 Data\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
- Print the hexical BYTE immediate data to instruction content\r
+ Print the hexical BYTE immediate data to instruction content.\r
\r
-Arguments:\r
+ @param Data - BYTE data\r
\r
- Data - BYTE data\r
+ @return Instruction content offset\r
\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintImmData8 (\r
+ IN UINT8 Data\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintImmData16 (\r
- IN UINT16 Data\r
- )\r
-/*++\r
+/**\r
\r
-Routine Description:\r
+ Print the hexical WORD immediate data to instruction content.\r
\r
- Print the hexical WORD immediate data to instruction content\r
+ @param Data - WORD data\r
\r
-Arguments:\r
+ @return Instruction content offset\r
\r
- Data - WORD data\r
-\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintImmData16 (\r
+ IN UINT16 Data\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintImmData32 (\r
- IN UINT32 Data\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical DWORD immediate data to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the hexical DWORD immediate data to instruction content.\r
\r
- Data - DWORD data\r
+ @param Data - DWORD data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintImmData32 (\r
+ IN UINT32 Data\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintImmData64 (\r
- IN UINT64 Data\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
- Print the hexical QWORD immediate data to instruction content\r
+ Print the hexical QWORD immediate data to instruction content.\r
\r
-Arguments:\r
+ @param Data - QWORD data\r
\r
- Data - QWORD data\r
+ @return Instruction content offset\r
\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintImmData64 (\r
+ IN UINT64 Data\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintImmDatan (\r
- IN UINTN Data\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the decimal UINTN immediate data to instruction content\r
-\r
-Arguments:\r
+/**\r
\r
- Data - UINTN data\r
+ Print the decimal UINTN immediate data to instruction content.\r
\r
-Returns:\r
+ @param Data - UINTN data\r
\r
- Instruction content offset\r
+ @return Instruction content offset\r
\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintImmDatan (\r
+ IN UINTN Data\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintImmData64n (\r
- IN UINT64 Data64\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
- Print the decimal QWORD immediate data to instruction content\r
+ Print the decimal QWORD immediate data to instruction content.\r
\r
-Arguments:\r
+ @param Data64 - QWORD data\r
\r
- Data64 - QWORD data\r
+ @return Instruction content offset\r
\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintImmData64n (\r
+ IN UINT64 Data64\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData8 (\r
- IN UINT8 Data8\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical BYTE to instruction content\r
-\r
-Arguments:\r
+/**\r
\r
- Data8 - BYTE data\r
+ Print the hexical BYTE to instruction content.\r
\r
-Returns:\r
+ @param Data8 - BYTE data\r
\r
- Instruction content offset\r
+ @return Instruction content offset\r
\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData8 (\r
+ IN UINT8 Data8\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData16 (\r
- IN UINT16 Data16\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical WORD to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the hexical WORD to instruction content.\r
\r
- Data16 - WORD data\r
+ @param Data16 - WORD data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData16 (\r
+ IN UINT16 Data16\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData32 (\r
- IN UINT32 Data32\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
- Print the hexical DWORD to instruction content\r
+ Print the hexical DWORD to instruction content.\r
\r
-Arguments:\r
+ @param Data32 - DWORD data\r
\r
- Data32 - DWORD data\r
+ @return Instruction content offset\r
\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData32 (\r
+ IN UINT32 Data32\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData64 (\r
- IN UINT64 Data64\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the hexical QWORD to instruction content\r
-\r
-Arguments:\r
+/**\r
\r
- Data64 - QWORD data\r
+ Print the hexical QWORD to instruction content.\r
\r
-Returns:\r
+ @param Data64 - QWORD data\r
\r
- Instruction content offset\r
+ @return Instruction content offset\r
\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData64 (\r
+ IN UINT64 Data64\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintDatan (\r
- IN UINTN Data\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the decimal unsigned UINTN to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the decimal unsigned UINTN to instruction content.\r
\r
- Data - unsigned UINTN data\r
+ @param Data - unsigned UINTN data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintDatan (\r
+ IN UINTN Data\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData64n (\r
- IN UINT64 Data64\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the decimal unsigned QWORD to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the decimal unsigned QWORD to instruction content.\r
\r
- Data64 - unsigned QWORD data\r
+ @param Data64 - unsigned QWORD data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData64n (\r
+ IN UINT64 Data64\r
+ )\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData8s (\r
- IN UINT8 Data8\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the decimal signed BYTE to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the decimal signed BYTE to instruction content.\r
\r
- Data8 - signed BYTE data\r
+ @param Data8 - signed BYTE data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData8s (\r
+ IN UINT8 Data8\r
+ )\r
{\r
BOOLEAN Sign;\r
\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData16s (\r
- IN UINT16 Data16\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
\r
- Print the decimal signed WORD to instruction content\r
+ Print the decimal signed WORD to instruction content.\r
\r
-Arguments:\r
+ @param Data16 - signed WORD data\r
\r
- Data16 - signed WORD data\r
+ @return Instruction content offset\r
\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData16s (\r
+ IN UINT16 Data16\r
+ )\r
{\r
BOOLEAN Sign;\r
\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData32s (\r
- IN UINT32 Data32\r
- )\r
-/*++\r
+/**\r
\r
-Routine Description:\r
+ Print the decimal signed DWORD to instruction content.\r
\r
- Print the decimal signed DWORD to instruction content\r
+ @param Data32 - signed DWORD data\r
\r
-Arguments:\r
+ @return Instruction content offset\r
\r
- Data32 - signed DWORD data\r
-\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData32s (\r
+ IN UINT32 Data32\r
+ )\r
{\r
BOOLEAN Sign;\r
\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbPrintData64s (\r
- IN UINT64 Data64\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the decimal signed QWORD to instruction content\r
+/**\r
\r
-Arguments:\r
+ Print the decimal signed QWORD to instruction content.\r
\r
- Data64 - signed QWORD data\r
+ @param Data64 - signed QWORD data\r
\r
-Returns:\r
+ @return Instruction content offset\r
\r
- Instruction content offset\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbPrintData64s (\r
+ IN UINT64 Data64\r
+ )\r
{\r
BOOLEAN Sign;\r
INT64 Data64s;\r
return mInstructionContentOffset;\r
}\r
\r
+/**\r
+\r
+ Print the comma to instruction content.\r
+\r
+ @return Instruction content offset\r
+\r
+**/\r
UINTN\r
EdbPrintComma (\r
VOID\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the comma to instruction content\r
-\r
-Arguments:\r
-\r
- None\r
-\r
-Returns:\r
-\r
- Instruction content offset\r
-\r
---*/\r
{\r
EDBSPrintWithOffset (\r
mInstructionString.Content,\r
return mInstructionContentOffset;\r
}\r
\r
-UINTN\r
-EdbFindAndPrintSymbol (\r
- IN UINTN Address\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Find the symbol string according to address, then print it\r
+/**\r
\r
-Arguments:\r
+ Find the symbol string according to address, then print it.\r
\r
- Address - instruction address\r
+ @param Address - instruction address\r
\r
-Returns:\r
+ @retval 1 - symbol string is found and printed\r
+ @retval 0 - symbol string not found\r
\r
- 1 - symbol string is found and printed\r
- 0 - symbol string not found\r
-\r
---*/\r
+**/\r
+UINTN\r
+EdbFindAndPrintSymbol (\r
+ IN UINTN Address\r
+ )\r
{\r
CHAR8 *SymbolStr;\r
\r
return 0;\r
}\r
\r
+/**\r
+\r
+ Print the EBC byte code.\r
+\r
+ @param InstructionAddress - instruction address\r
+ @param InstructionNumber - instruction number\r
+\r
+**/\r
VOID\r
EdbPrintRaw (\r
IN EFI_PHYSICAL_ADDRESS InstructionAddress,\r
IN UINTN InstructionNumber\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the EBC byte code\r
-\r
-Arguments:\r
-\r
- InstructionAddress - instruction address\r
- InstructionNumber - instruction number\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
UINTN LineNumber;\r
UINTN ByteNumber;\r
return ;\r
}\r
\r
+/**\r
+\r
+ Print the EBC asm code.\r
+\r
+ @param DebuggerPrivate - EBC Debugger private data structure\r
+ @param SystemContext - EBC system context.\r
+\r
+ @retval EFI_SUCCESS - show disasm successfully\r
+\r
+**/\r
EFI_STATUS\r
EdbShowDisasm (\r
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,\r
IN EFI_SYSTEM_CONTEXT SystemContext\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Print the EBC asm code\r
-\r
-Arguments:\r
-\r
- DebuggerPrivate - EBC Debugger private data structure\r
- SystemContext - EBC system context.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - show disasm successfully\r
-\r
---*/\r
{\r
EFI_PHYSICAL_ADDRESS InstructionAddress;\r
UINTN InstructionNumber;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Get register value accroding to the system context, and register index.\r
+\r
+ @param SystemContext - EBC system context.\r
+ @param Index - EBC register index\r
+\r
+ @return register value\r
+\r
+**/\r
UINT64\r
GetRegisterValue (\r
IN EFI_SYSTEM_CONTEXT SystemContext,\r
IN UINT8 Index\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Get register value accroding to the system context, and register index\r
-\r
-Arguments:\r
-\r
- SystemContext - EBC system context.\r
- Index - EBC register index\r
-\r
-Returns:\r
-\r
- register value\r
-\r
---*/\r
{\r
switch (Index) {\r
case 0:\r
projects / mirror_edk2.git / blobdiff