1 /*
2 * Copyright (c) 2024, The OpenThread Authors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of the copyright holder nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /**
30 * @file
31 * This file includes definitions for endianness utility functions.
32 */
33
34 #ifndef LIB_UTILS_ENDIAN_HPP_
35 #define LIB_UTILS_ENDIAN_HPP_
36
37 #include <stdint.h>
38
39 namespace ot {
40 namespace Lib {
41 namespace Utils {
42
43 namespace LittleEndian {
44 /**
45 * Reads a `uint16_t` value from a given buffer assuming little-endian encoding.
46 *
47 * @param[in] aBuffer Pointer to buffer to read from.
48 *
49 * @returns The `uint16_t` value read from buffer.
50 *
51 */
ReadUint16(const uint8_t * aBuffer)52 inline uint16_t ReadUint16(const uint8_t *aBuffer) { return static_cast<uint16_t>(aBuffer[0] | (aBuffer[1] << 8)); }
53
54 /**
55 * Writes a `uint16_t` value to a given buffer using little-endian encoding.
56 *
57 * @param[in] aValue The value to write to buffer.
58 * @param[out] aBuffer Pointer to buffer where the value will be written.
59 *
60 */
WriteUint16(uint16_t aValue,uint8_t * aBuffer)61 inline void WriteUint16(uint16_t aValue, uint8_t *aBuffer)
62 {
63 aBuffer[0] = (aValue >> 0) & 0xff;
64 aBuffer[1] = (aValue >> 8) & 0xff;
65 }
66
67 } // namespace LittleEndian
68 } // namespace Utils
69 } // namespace Lib
70 } // namespace ot
71
72 #endif // LIB_UTILS_ENDIAN_HPP_
73
