From 06e646e04714e0e0f7537841107ab0528ef33a52 Mon Sep 17 00:00:00 2001 From: Michael Jeanson Date: Mon, 15 Mar 2021 13:50:50 -0400 Subject: [PATCH] cleanup: add comments to lttng/ust-endian.h Signed-off-by: Michael Jeanson Signed-off-by: Mathieu Desnoyers Change-Id: I60967d2791434dc513d36dbb8d7b671f13c0be7e --- include/lttng/ust-endian.h | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/include/lttng/ust-endian.h b/include/lttng/ust-endian.h index a0a6db3b..06f82364 100644 --- a/include/lttng/ust-endian.h +++ b/include/lttng/ust-endian.h @@ -2,8 +2,28 @@ * SPDX-License-Identifier: MIT * * Copyright (C) 2012 Mathieu Desnoyers + */ + +/* + * This header defines the following endian macros based on the current + * platform endian headers: + * + * BYTE_ORDER this macro shall have a value equal to one + * of the *_ENDIAN macros in this header. + * FLOAT_WORD_ORDER this macro shall have a value equal to one + * of the *_ENDIAN macros in this header. + * LITTLE_ENDIAN if BYTE_ORDER == LITTLE_ENDIAN, the host + * byte order is from least significant to + * most significant. + * BIG_ENDIAN if BYTE_ORDER == BIG_ENDIAN, the host byte + * order is from most significant to least + * significant. + * + * Direct byte swapping interfaces: * - * endian.h compatibility layer. + * uint16_t bswap_16(uint16_t x); (* swap bytes 16-bit word *) + * uint32_t bswap_32(uint32_t x); (* swap bytes 32-bit word *) + * uint64_t bswap_64(uint32_t x); (* swap bytes 64-bit word *) */ #ifndef _LTTNG_UST_ENDIAN_H -- 2.34.1