GNU Radio's GSM Package
bit32gen.h
Go to the documentation of this file.
1 /*
2  * bit32gen.h
3  *
4  * Copyright (C) 2014 Max <max.suraev@fairwaves.co>
5  *
6  * All Rights Reserved
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with this program; if not, write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22 
23 #pragma once
24 
25 /*! \brief load unaligned n-byte integer (little-endian encoding) into uint32_t
26  * \param[in] p Buffer where integer is stored
27  * \param[in] n Number of bytes stored in p
28  * \returns 32 bit unsigned integer
29  */
30 static inline uint32_t osmo_load32le_ext(const void *p, uint8_t n)
31 {
32  uint8_t i;
33  uint32_t r = 0;
34  const uint8_t *q = (uint8_t *)p;
35  for(i = 0; i < n; r |= ((uint32_t)q[i] << (8 * i)), i++);
36  return r;
37 }
38 
39 /*! \brief load unaligned n-byte integer (big-endian encoding) into uint32_t
40  * \param[in] p Buffer where integer is stored
41  * \param[in] n Number of bytes stored in p
42  * \returns 32 bit unsigned integer
43  */
44 static inline uint32_t osmo_load32be_ext(const void *p, uint8_t n)
45 {
46  uint8_t i;
47  uint32_t r = 0;
48  const uint8_t *q = (uint8_t *)p;
49  for(i = 0; i < n; r |= ((uint32_t)q[i] << (32 - 8* (1 + i))), i++);
50  return r;
51 }
52 
53 
54 /*! \brief store unaligned n-byte integer (little-endian encoding) from uint32_t
55  * \param[in] x unsigned 32 bit integer
56  * \param[out] p Buffer to store integer
57  * \param[in] n Number of bytes to store
58  */
59 static inline void osmo_store32le_ext(uint32_t x, void *p, uint8_t n)
60 {
61  uint8_t i;
62  uint8_t *q = (uint8_t *)p;
63  for(i = 0; i < n; q[i] = (x >> i * 8) & 0xFF, i++);
64 }
65 
66 /*! \brief store unaligned n-byte integer (big-endian encoding) from uint32_t
67  * \param[in] x unsigned 32 bit integer
68  * \param[out] p Buffer to store integer
69  * \param[in] n Number of bytes to store
70  */
71 static inline void osmo_store32be_ext(uint32_t x, void *p, uint8_t n)
72 {
73  uint8_t i;
74  uint8_t *q = (uint8_t *)p;
75  for(i = 0; i < n; q[i] = (x >> ((n - 1 - i) * 8)) & 0xFF, i++);
76 }
77 
78 
79 /* Convenience function for most-used cases */
80 
81 
82 /*! \brief load unaligned 32-bit integer (little-endian encoding) */
83 static inline uint32_t osmo_load32le(const void *p)
84 {
85  return osmo_load32le_ext(p, 32 / 8);
86 }
87 
88 /*! \brief load unaligned 32-bit integer (big-endian encoding) */
89 static inline uint32_t osmo_load32be(const void *p)
90 {
91  return osmo_load32be_ext(p, 32 / 8);
92 }
93 
94 
95 /*! \brief store unaligned 32-bit integer (little-endian encoding) */
96 static inline void osmo_store32le(uint32_t x, void *p)
97 {
98  osmo_store32le_ext(x, p, 32 / 8);
99 }
100 
101 /*! \brief store unaligned 32-bit integer (big-endian encoding) */
102 static inline void osmo_store32be(uint32_t x, void *p)
103 {
104  osmo_store32be_ext(x, p, 32 / 8);
105 }
osmo_store32le
static void osmo_store32le(uint32_t x, void *p)
store unaligned 32-bit integer (little-endian encoding)
Definition: bit32gen.h:96
osmo_store32le_ext
static void osmo_store32le_ext(uint32_t x, void *p, uint8_t n)
store unaligned n-byte integer (little-endian encoding) from uint32_t
Definition: bit32gen.h:59
osmo_load32le_ext
static uint32_t osmo_load32le_ext(const void *p, uint8_t n)
load unaligned n-byte integer (little-endian encoding) into uint32_t
Definition: bit32gen.h:30
osmo_load32be_ext
static uint32_t osmo_load32be_ext(const void *p, uint8_t n)
load unaligned n-byte integer (big-endian encoding) into uint32_t
Definition: bit32gen.h:44
osmo_load32be
static uint32_t osmo_load32be(const void *p)
load unaligned 32-bit integer (big-endian encoding)
Definition: bit32gen.h:89
osmo_store32be_ext
static void osmo_store32be_ext(uint32_t x, void *p, uint8_t n)
store unaligned n-byte integer (big-endian encoding) from uint32_t
Definition: bit32gen.h:71
osmo_load32le
static uint32_t osmo_load32le(const void *p)
load unaligned 32-bit integer (little-endian encoding)
Definition: bit32gen.h:83
osmo_store32be
static void osmo_store32be(uint32_t x, void *p)
store unaligned 32-bit integer (big-endian encoding)
Definition: bit32gen.h:102