TABLE OF CONTENTS

1. Component Library/Byte Swapping
2. Component Library: Byte Swapping/CL_HTON16
3. Component Library: Byte Swapping/CL_HTON32
4. Component Library: Byte Swapping/CL_HTON64
5. Component Library: Byte Swapping/CL_NTOH16
6. Component Library: Byte Swapping/CL_NTOH32
7. Component Library: Byte Swapping/CL_NTOH64
8. Component Library: Byte Swapping/cl_hton16
9. Component Library: Byte Swapping/cl_hton32
10. Component Library: Byte Swapping/cl_hton64
11. Component Library: Byte Swapping/cl_ntoh
12. Component Library: Byte Swapping/cl_ntoh16
13. Component Library: Byte Swapping/cl_ntoh32
14. Component Library: Byte Swapping/cl_ntoh64

Component Library/Byte Swapping

    Byte Swapping

    The byte swapping functions and macros allow swapping bytes from network
    byte order to host byte order.

    All data transmitted between systems should be in network byte order.
    In order to utilize such data, it must be converted to host byte order
    before use.

    Functions:
        cl_ntoh16, cl_hton16, cl_ntoh32, cl_hton32, cl_ntoh64, cl_hton64,
        cl_ntoh

    Macros:
        CL_NTOH16, CL_HTON16, CL_NTOH32, CL_HTON32, CL_NTOH64, CL_HTON64

Component Library: Byte Swapping/CL_HTON16

    CL_HTON16

    The CL_HTON16 macro converts a 16-bit value from host byte order to
    network byte order.  The CL_HTON16 macro will cause constant values to be
    swapped by the pre-processor.  For variables, CL_HTON16 is less efficient
    than the cl_hton16 function.

    CL_HTON16( val );

    val
        [in] 16-bit value to swap from host byte order to network byte order.

    Value of val converted to network byte order.

    This macro is analogous to CL_NTOH16.

    Byte Swapping, CL_NTOH16, CL_HTON32, CL_HTON64,
    cl_hton16, cl_hton32, cl_hton64, cl_ntoh

Component Library: Byte Swapping/CL_HTON32

    CL_HTON32

    The CL_HTON32 macro converts a 32-bit value from host byte order to
    network byte order.  The CL_HTON32 macro will cause constant values to be
    swapped by the pre-processor.  For variables, CL_HTON32 is less efficient
    than the cl_hton32 function.

    CL_HTON32( val );

    val
        [in] 32-bit value to swap from host byte order to network byte order.

    Value of val converted to network byte order.

    This macro is analogous to CL_NTOH32.

    Byte Swapping, CL_NTOH32, CL_HTON16, CL_HTON64,
    cl_hton16, cl_hton32, cl_hton64, cl_ntoh

Component Library: Byte Swapping/CL_HTON64

    CL_HTON64

    The CL_HTON64 macro converts a 64-bit value from host byte order to
    network byte order.  The CL_HTON64 macro will cause constant values to be
    swapped by the pre-processor.  For variables, CL_HTON64 is less efficient
    than the cl_hton64 function.

    CL_HTON64( val );

    val
        [in] 64-bit value to swap from host byte order to network byte order.

    Value of val converted to network byte order.

    This macro is analogous to CL_NTOH64.

    Byte Swapping, CL_NTOH64, CL_HTON16, CL_HTON32,
    cl_hton16, cl_hton32, cl_hton64, cl_ntoh

Component Library: Byte Swapping/CL_NTOH16

    CL_NTOH16

    The CL_NTOH16 macro converts a 16-bit value from network byte order to
    host byte order.  The CL_NTOH16 macro will cause constant values to be
    swapped by the pre-processor.  For variables, CL_NTOH16 is less efficient
    than the cl_ntoh16 function.

    CL_NTOH16( val );

    val
        [in] 16-bit value to swap from network byte order to host byte order.

    Value of val converted to host byte order.

    This macro is analogous to CL_HTON16.

    Byte Swapping, CL_HTON16, CL_NTOH32, CL_NTOH64,
    cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh

Component Library: Byte Swapping/CL_NTOH32

    CL_NTOH32

    The CL_NTOH32 macro converts a 32-bit value from network byte order to
    host byte order.  The CL_NTOH32 macro will cause constant values to be
    swapped by the pre-processor.  For variables, CL_NTOH32 is less efficient
    than the cl_ntoh32 function.

    CL_NTOH32( val );

    val
        [in] 32-bit value to swap from network byte order to host byte order.

    Value of val converted to host byte order.

    This macro is analogous to CL_HTON32.

    Byte Swapping, CL_HTON32, CL_NTOH16, CL_NTOH64,
    cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh

Component Library: Byte Swapping/CL_NTOH64

    CL_NTOH64

    The CL_NTOH64 macro converts a 64-bit value from network byte order to
    host byte order.  The CL_NTOH64 macro will cause constant values to be
    swapped by the pre-processor.  For variables, CL_NTOH64 is less efficient
    than the cl_ntoh64 function.

    CL_NTOH64( val );

    val
        [in] 64-bit value to swap from network byte order to host byte order.

    Value of val converted to host byte order.

    This macro is analogous to CL_HTON64.

    Byte Swapping, CL_HTON64, CL_NTOH16, CL_NTOH32,
    cl_ntoh16, cl_ntoh32, cl_ntoh64, cl_ntoh

Component Library: Byte Swapping/cl_hton16

    cl_hton16

    The cl_hton16 function converts a 16-bit value from host byte order to
    network byte order.

    uint16_t
    cl_hton16(
        IN  const uint16_t  val );

    val
        [in] Value to swap from host byte order to network byte order .

    Value of val converted to network byte order.

    This function is analogous to cl_ntoh16.

    Byte Swapping, cl_ntoh16, cl_hton32, cl_hton64, cl_ntoh

Component Library: Byte Swapping/cl_hton32

    cl_hton32

    The cl_hton32 function converts a 32-bit value from host byte order to
    network byte order.

    uint32_t
    cl_hton32(
        IN  const uint32_t  val );

    val
        [in] Value to swap from host byte order to network byte order .

    Value of val converted to network byte order.

    This function is analogous to cl_ntoh32.

    Byte Swapping, cl_ntoh32, cl_hton16, cl_hton64, cl_ntoh

Component Library: Byte Swapping/cl_hton64

    cl_hton64

    The cl_hton64 function converts a 64-bit value from host byte order to
    network byte order.

    uint64_t
    cl_hton64(
        IN  const uint64_t  val );

    val
        [in] Value to swap from host byte order to network byte order .

    Value of val converted to network byte order.

    This function is analogous to cl_ntoh64.

    Byte Swapping, cl_ntoh64, cl_hton16, cl_hton32, cl_ntoh

Component Library: Byte Swapping/cl_ntoh

    cl_ntoh

    The cl_ntoh function converts a value from network byte order to
    host byte order.

 void
cl_ntoh(
    OUT char* const         p_dest,
    IN  const char* const   p_src,
    IN  const uint8_t       size ;

    p_dest
        [in] Pointer to a byte array to contain the converted value of p_src.

    p_src
        [in] Pointer to a byte array to be converted from network byte
        ordering.

    size
        [in] Number of bytes to swap.p_dest

    This function does not return a value.

    cl_ntoh can perform in place swapping if both p_src and p_dest point to
    the same buffer.

    Byte Swapping, cl_ntoh16, cl_ntoh32, cl_ntoh64

Component Library: Byte Swapping/cl_ntoh16

    cl_ntoh16

    The cl_ntoh16 function converts a 16-bit value from network byte order to
    host byte order.

    uint16_t
    cl_ntoh16(
        IN  const uint16_t  val );

    val
        [in] Value to swap from network byte order to host byte order.

    Value of val converted to host byte order.

    This function is analogous to cl_hton16.

    Byte Swapping, cl_hton16, cl_ntoh32, cl_ntoh64, cl_ntoh

Component Library: Byte Swapping/cl_ntoh32

    cl_ntoh32

    The cl_ntoh32 function converts a 32-bit value from network byte order to
    host byte order.

    uint32_t
    cl_ntoh32(
        IN  const uint32_t  val );

    val
        [in] Value to swap from network byte order to host byte order.

    Value of val converted in host byte order.

    This function is analogous to cl_hton32.

    Byte Swapping, cl_hton32, cl_ntoh16, cl_ntoh64, cl_ntoh

Component Library: Byte Swapping/cl_ntoh64

    cl_ntoh64

    The cl_ntoh64 function converts a 64-bit value from network byte order to
    host byte order.

    uint64_t
    cl_ntoh64(
        IN  const uint64_t  val );

    val
        [in] Value to swap from network byte order to host byte order.

    Value of val converted in host byte order.

    This function is analogous to cl_hton64.

    Byte Swapping, cl_hton64, cl_ntoh16, cl_ntoh32, cl_ntoh