[llvm] 519cf6e - [X86][AMX] Add description of x86_amx to LangRef.

[via llvm-commits]

Author: Luo, Yuanke
Date: 2021-04-20T14:29:17+08:00
New Revision: 519cf6e80781c008c59e3f563ce6f9932f848df5

URL: https://github.com/llvm/llvm-project/commit/519cf6e80781c008c59e3f563ce6f9932f848df5
DIFF: https://github.com/llvm/llvm-project/commit/519cf6e80781c008c59e3f563ce6f9932f848df5.diff

LOG: [X86][AMX] Add description of x86_amx to LangRef.

Differential Revision: https://reviews.llvm.org/D100032

Added: 
    

Modified: 
    llvm/docs/BitCodeFormat.rst
    llvm/docs/LangRef.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/BitCodeFormat.rst b/llvm/docs/BitCodeFormat.rst
index eff9d2866a8f8..4e4a34432b459 100644
--- a/llvm/docs/BitCodeFormat.rst
+++ b/llvm/docs/BitCodeFormat.rst
@@ -1322,6 +1322,13 @@ operand fields are
 * *paramty*: Zero or more type indices representing the parameter types of the
   function
 
+TYPE_CODE_X86_AMX Record
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+``[X86_AMX]``
+
+The ``X86_AMX`` record (code 24) adds an ``x86_amx`` type to the type table.
+
 .. _CONSTANTS_BLOCK:
 
 CONSTANTS_BLOCK Contents

diff  --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index f06e95f11e731..b6c39f11f3675 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -3242,6 +3242,24 @@ The binary format of half, float, double, and fp128 correspond to the
 IEEE-754-2008 specifications for binary16, binary32, binary64, and binary128
 respectively.
 
+X86_amx Type
+""""""""""""
+
+:Overview:
+
+The x86_amx type represents a value held in an AMX tile register on an x86
+machine. The operations allowed on it are quite limited. Only few intrinsics
+are allowed: stride load and store, zero and dot product. No instruction is
+allowed for this type. There are no arguments, arrays, pointers, vectors
+or constants of this type.
+
+:Syntax:
+
+::
+
+      x86_amx
+
+
 X86_mmx Type
 """"""""""""
 
@@ -3636,7 +3654,7 @@ represented by ``0xH`` followed by 4 hexadecimal digits. The bfloat 16-bit
 format is represented by ``0xR`` followed by 4 hexadecimal digits. All
 hexadecimal formats are big-endian (sign bit at the left).
 
-There are no constants of type x86_mmx.
+There are no constants of type x86_mmx and x86_amx.
 
 .. _complexconstants: