arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

pull/748/head
Jeffrey Walton 2018-11-15 16:45:56 -05:00
parent dd111a6174
commit 364017c097
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 35 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
ppc_simd.h
View File

@ -128,12 +128,13 @@ inline uint32x4_p VecLoad_ALTIVEC(int off, const byte src[16])
/// \brief Loads a vector from a byte array /// \brief Loads a vector from a byte array
/// \param src the byte array /// \param src the byte array
/// \details Loads a vector in native endian format from a byte array. /// \details VecLoad loads a vector in from a byte array.
/// \details VecLoad uses POWER7's <tt>vec_xl</tt> or /// \details VecLoad uses POWER7's <tt>vec_xl</tt> or
/// <tt>vec_vsx_ld</tt> if available. The instructions do not require /// <tt>vec_vsx_ld</tt> if available. The instructions do not require
/// an aligned memory address. /// an aligned memory address. VecLoad_ALTIVEC() is used if POWER7
/// \details VecLoad_ALTIVEC() is used if POWER7 or above /// is not available. VecLoad_ALTIVEC() is relatively expensive and
/// is not available. VecLoad_ALTIVEC() is relatively expensive. /// requires extra instructions to fix up unaligned effective memory
/// addresses.
/// \note VecLoad does not require an aligned array. /// \note VecLoad does not require an aligned array.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
inline uint32x4_p VecLoad(const byte src[16]) inline uint32x4_p VecLoad(const byte src[16])
@ -152,12 +153,13 @@ inline uint32x4_p VecLoad(const byte src[16])
/// \brief Loads a vector from a byte array /// \brief Loads a vector from a byte array
/// \param src the byte array /// \param src the byte array
/// \param off offset into the byte array /// \param off offset into the byte array
/// \details Loads a vector in native endian format from a byte array. /// \details VecLoad loads a vector in from a byte array.
/// \details VecLoad uses POWER7's <tt>vec_xl</tt> or /// \details VecLoad uses POWER7's <tt>vec_xl</tt> or
/// <tt>vec_vsx_ld</tt> if available. The instructions do not require /// <tt>vec_vsx_ld</tt> if available. The instructions do not require
/// an aligned memory address. /// an aligned memory address. VecLoad_ALTIVEC() is used if POWER7
/// \details VecLoad_ALTIVEC() is used if POWER7 or above /// is not available. VecLoad_ALTIVEC() is relatively expensive and
/// is not available. VecLoad_ALTIVEC() is relatively expensive. /// requires extra instructions to fix up unaligned effective memory
/// addresses.
/// \note VecLoad does not require an aligned array. /// \note VecLoad does not require an aligned array.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
inline uint32x4_p VecLoad(int off, const byte src[16]) inline uint32x4_p VecLoad(int off, const byte src[16])
@ -175,12 +177,13 @@ inline uint32x4_p VecLoad(int off, const byte src[16])
/// \brief Loads a vector from a byte array /// \brief Loads a vector from a byte array
/// \param src the byte array /// \param src the byte array
/// \details Loads a vector in native endian format from a byte array. /// \details VecLoad loads a vector in from a byte array.
/// \details VecLoad uses POWER7's <tt>vec_xl</tt> or /// \details VecLoad uses POWER7's <tt>vec_xl</tt> or
/// <tt>vec_vsx_ld</tt> if available. The instructions do not require /// <tt>vec_vsx_ld</tt> if available. The instructions do not require
/// an aligned memory address. /// an aligned memory address. VecLoad_ALTIVEC() is used if POWER7
/// \details VecLoad_ALTIVEC() is used if POWER7 or above /// is not available. VecLoad_ALTIVEC() is relatively expensive and
/// is not available. VecLoad_ALTIVEC() is relatively expensive. /// requires extra instructions to fix up unaligned effective memory
/// addresses.
/// \note VecLoad does not require an aligned array. /// \note VecLoad does not require an aligned array.
/// \since Crypto++ 8.0 /// \since Crypto++ 8.0
inline uint32x4_p VecLoad(const word32 src[4]) inline uint32x4_p VecLoad(const word32 src[4])
@ -191,7 +194,13 @@ inline uint32x4_p VecLoad(const word32 src[4])
/// \brief Loads a vector from a byte array /// \brief Loads a vector from a byte array
/// \param src the byte array /// \param src the byte array
/// \param off offset into the byte array /// \param off offset into the byte array
/// \details Loads a vector in native endian format from a byte array. /// \details VecLoad loads a vector in from a byte array.
/// \details VecLoad uses POWER7's <tt>vec_xl</tt> or
/// <tt>vec_vsx_ld</tt> if available. The instructions do not require
/// an aligned memory address. VecLoad_ALTIVEC() is used if POWER7
/// is not available. VecLoad_ALTIVEC() is relatively expensive and
/// requires extra instructions to fix up unaligned effective memory
/// addresses.
/// \note VecLoad does not require an aligned array. /// \note VecLoad does not require an aligned array.
/// \since Crypto++ 8.0 /// \since Crypto++ 8.0
inline uint32x4_p VecLoad(int off, const word32 src[4]) inline uint32x4_p VecLoad(int off, const word32 src[4])
@ -201,14 +210,15 @@ inline uint32x4_p VecLoad(int off, const word32 src[4])
/// \brief Loads a vector from a byte array /// \brief Loads a vector from a byte array
/// \param src the byte array /// \param src the byte array
/// \details Loads a vector in big endian format from a byte array. /// \details VecLoadBE loads a vector in from a byte array. VecLoadBE
/// VecLoadBE will swap all bytes on little endian systems. /// will reverse all bytes in the arrya on a little endian system.
/// \details VecLoadBE uses POWER7's <tt>vec_xl</tt> or /// \details VecLoadBE uses POWER7's <tt>vec_xl</tt> or
/// <tt>vec_vsx_ld</tt> if available. The instructions do not require /// <tt>vec_vsx_ld</tt> if available. The instructions do not require
/// an aligned memory address. /// an aligned memory address. VecLoad_ALTIVEC() is used if POWER7
/// \details VecLoad_ALTIVEC() is used if POWER7 or above /// is not available. VecLoad_ALTIVEC() is relatively expensive and
/// is not available. VecLoad_ALTIVEC() is relatively expensive. /// requires extra instructions to fix up unaligned effective memory
/// \note VecLoadBE() does not require an aligned array. /// addresses.
/// \note VecLoadBE does not require an aligned array.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
inline uint32x4_p VecLoadBE(const byte src[16]) inline uint32x4_p VecLoadBE(const byte src[16])
{ {
@ -234,13 +244,14 @@ inline uint32x4_p VecLoadBE(const byte src[16])
/// \brief Loads a vector from a byte array /// \brief Loads a vector from a byte array
/// \param src the byte array /// \param src the byte array
/// \param off offset into the src byte array /// \param off offset into the src byte array
/// \details Loads a vector in big endian format from a byte array. /// \details VecLoadBE loads a vector in from a byte array. VecLoadBE
/// VecLoadBE will swap all bytes on little endian systems. /// will reverse all bytes in the arrya on a little endian system.
/// \details VecLoadBE uses POWER7's <tt>vec_xl</tt> or /// \details VecLoadBE uses POWER7's <tt>vec_xl</tt> or
/// <tt>vec_vsx_ld</tt> if available. The instructions do not require /// <tt>vec_vsx_ld</tt> if available. The instructions do not require
/// an aligned memory address. /// an aligned memory address. VecLoad_ALTIVEC() is used if POWER7
/// \details VecLoad_ALTIVEC() is used if POWER7 or above /// is not available. VecLoad_ALTIVEC() is relatively expensive and
/// is not available. VecLoad_ALTIVEC() is relatively expensive. /// requires extra instructions to fix up unaligned effective memory
/// addresses.
/// \note VecLoadBE does not require an aligned array. /// \note VecLoadBE does not require an aligned array.
/// \since Crypto++ 6.0 /// \since Crypto++ 6.0
inline uint32x4_p VecLoadBE(int off, const byte src[16]) inline uint32x4_p VecLoadBE(int off, const byte src[16])