diff options
| author | Ekaterina Romanova <katya_romanova@playstation.sony.com> | 2016-01-29 20:37:14 +0000 |
|---|---|---|
| committer | Ekaterina Romanova <katya_romanova@playstation.sony.com> | 2016-01-29 20:37:14 +0000 |
| commit | deec50a3d2339af731b42b5c9f7308f861acae5f (patch) | |
| tree | 991d32f6441105dd3f3e2e275d59417e3e5f73cd /clang/lib/Headers | |
| parent | 65d98ea473b70b26835b621aca5871992ac882fe (diff) | |
| download | bcm5719-llvm-deec50a3d2339af731b42b5c9f7308f861acae5f.tar.gz bcm5719-llvm-deec50a3d2339af731b42b5c9f7308f861acae5f.zip | |
This patch adds doxygen comments for the intrinsincs in the header file __wmmintrin_pclmul.h. The doxygen comments are automatically generated based on Sony's intrinsics document.
Differential Revision: http://reviews.llvm.org/D15999
llvm-svn: 259239
Diffstat (limited to 'clang/lib/Headers')
| -rw-r--r-- | clang/lib/Headers/__wmmintrin_pclmul.h | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/clang/lib/Headers/__wmmintrin_pclmul.h b/clang/lib/Headers/__wmmintrin_pclmul.h index 68e944e9219..9eac0288069 100644 --- a/clang/lib/Headers/__wmmintrin_pclmul.h +++ b/clang/lib/Headers/__wmmintrin_pclmul.h @@ -23,6 +23,34 @@ #ifndef _WMMINTRIN_PCLMUL_H #define _WMMINTRIN_PCLMUL_H +/// \brief Multiplies two 64-bit integer values, which are selected from source +/// operands using the immediate-value operand. The multiplication is a +/// carry-less multiplication, and the 128-bit integer product is stored in +/// the destination. +/// +/// \headerfile <x86intrin.h> +/// +/// \code +/// __m128i _mm_clmulepi64_si128(__m128i __X, __m128i __Y, const int __I); +/// \endcode +/// +/// This intrinsic corresponds to the \c VPCLMULQDQ instruction. +/// +/// \param __X +/// A 128-bit vector of [2 x i64] containing one of the source operands. +/// \param __Y +/// A 128-bit vector of [2 x i64] containing one of the source operands. +/// \param __I +/// An immediate value specifying which 64-bit values to select from the +/// operands. +/// Bit 0 is used to select a value from operand __X, +/// and bit 4 is used to select a value from operand __Y: +/// Bit[0]=0 indicates that bits[63:0] of operand __X are used. +/// Bit[0]=1 indicates that bits[127:64] of operand __X are used. +/// Bit[4]=0 indicates that bits[63:0] of operand __Y are used. +/// Bit[4]=1 indicates that bits[127:64] of operand __Y are used. +/// \returns The 128-bit integer vector containing the result of the carry-less +/// multiplication of the selected 64-bit values. #define _mm_clmulepi64_si128(__X, __Y, __I) \ ((__m128i)__builtin_ia32_pclmulqdq128((__v2di)(__m128i)(__X), \ (__v2di)(__m128i)(__Y), (char)(__I))) |
