Home | History | Annotate | Download | only in include
      1 /*===---- __wmmintrin_pclmul.h - PCMUL intrinsics ---------------------------===
      2  *
      3  * Permission is hereby granted, free of charge, to any person obtaining a copy
      4  * of this software and associated documentation files (the "Software"), to deal
      5  * in the Software without restriction, including without limitation the rights
      6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      7  * copies of the Software, and to permit persons to whom the Software is
      8  * furnished to do so, subject to the following conditions:
      9  *
     10  * The above copyright notice and this permission notice shall be included in
     11  * all copies or substantial portions of the Software.
     12  *
     13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
     19  * THE SOFTWARE.
     20  *
     21  *===-----------------------------------------------------------------------===
     22  */
     23 #ifndef _WMMINTRIN_PCLMUL_H
     24 #define _WMMINTRIN_PCLMUL_H
     25 
     26 /// \brief Multiplies two 64-bit integer values, which are selected from source
     27 ///    operands using the immediate-value operand. The multiplication is a
     28 ///    carry-less multiplication, and the 128-bit integer product is stored in
     29 ///    the destination.
     30 ///
     31 /// \headerfile <x86intrin.h>
     32 ///
     33 /// \code
     34 /// __m128i _mm_clmulepi64_si128(__m128i __X, __m128i __Y, const int __I);
     35 /// \endcode
     36 ///
     37 /// This intrinsic corresponds to the \c VPCLMULQDQ instruction.
     38 ///
     39 /// \param __X
     40 ///    A 128-bit vector of [2 x i64] containing one of the source operands.
     41 /// \param __Y
     42 ///    A 128-bit vector of [2 x i64] containing one of the source operands.
     43 /// \param __I
     44 ///    An immediate value specifying which 64-bit values to select from the
     45 ///    operands.
     46 ///    Bit 0 is used to select a value from operand __X,
     47 ///    and bit 4 is used to select a value from operand __Y:
     48 ///    Bit[0]=0 indicates that bits[63:0] of operand __X are used.
     49 ///    Bit[0]=1 indicates that bits[127:64] of operand __X are used.
     50 ///    Bit[4]=0 indicates that bits[63:0] of operand __Y are used.
     51 ///    Bit[4]=1 indicates that bits[127:64] of operand __Y are used.
     52 /// \returns The 128-bit integer vector containing the result of the carry-less
     53 ///    multiplication of the selected 64-bit values.
     54 #define _mm_clmulepi64_si128(__X, __Y, __I) \
     55   ((__m128i)__builtin_ia32_pclmulqdq128((__v2di)(__m128i)(__X), \
     56                                         (__v2di)(__m128i)(__Y), (char)(__I)))
     57 
     58 #endif /* _WMMINTRIN_PCLMUL_H */
     59