1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * Declare directives for structure packing. No padding will be provided
3*4882a593Smuzhiyun * between the members of packed structures, and therefore, there is no
4*4882a593Smuzhiyun * guarantee that structure members will be aligned.
5*4882a593Smuzhiyun *
6*4882a593Smuzhiyun * Declaring packed structures is compiler specific. In order to handle all
7*4882a593Smuzhiyun * cases, packed structures should be delared as:
8*4882a593Smuzhiyun *
9*4882a593Smuzhiyun * #include <packed_section_start.h>
10*4882a593Smuzhiyun *
11*4882a593Smuzhiyun * typedef BWL_PRE_PACKED_STRUCT struct foobar_t {
12*4882a593Smuzhiyun * some_struct_members;
13*4882a593Smuzhiyun * } BWL_POST_PACKED_STRUCT foobar_t;
14*4882a593Smuzhiyun *
15*4882a593Smuzhiyun * #include <packed_section_end.h>
16*4882a593Smuzhiyun *
17*4882a593Smuzhiyun *
18*4882a593Smuzhiyun * Portions of this code are copyright (c) 2021 Cypress Semiconductor Corporation
19*4882a593Smuzhiyun *
20*4882a593Smuzhiyun * Copyright (C) 1999-2017, Broadcom Corporation
21*4882a593Smuzhiyun *
22*4882a593Smuzhiyun * Unless you and Broadcom execute a separate written software license
23*4882a593Smuzhiyun * agreement governing use of this software, this software is licensed to you
24*4882a593Smuzhiyun * under the terms of the GNU General Public License version 2 (the "GPL"),
25*4882a593Smuzhiyun * available at http://www.broadcom.com/licenses/GPLv2.php, with the
26*4882a593Smuzhiyun * following added to such license:
27*4882a593Smuzhiyun *
28*4882a593Smuzhiyun * As a special exception, the copyright holders of this software give you
29*4882a593Smuzhiyun * permission to link this software with independent modules, and to copy and
30*4882a593Smuzhiyun * distribute the resulting executable under terms of your choice, provided that
31*4882a593Smuzhiyun * you also meet, for each linked independent module, the terms and conditions of
32*4882a593Smuzhiyun * the license of that module. An independent module is a module which is not
33*4882a593Smuzhiyun * derived from this software. The special exception does not apply to any
34*4882a593Smuzhiyun * modifications of the software.
35*4882a593Smuzhiyun *
36*4882a593Smuzhiyun * Notwithstanding the above, under no circumstances may you combine this
37*4882a593Smuzhiyun * software in any way with any other Broadcom software provided under a license
38*4882a593Smuzhiyun * other than the GPL, without Broadcom's express prior written consent.
39*4882a593Smuzhiyun *
40*4882a593Smuzhiyun *
41*4882a593Smuzhiyun * <<Broadcom-WL-IPTag/Open:>>
42*4882a593Smuzhiyun *
43*4882a593Smuzhiyun * $Id: packed_section_start.h 666738 2016-10-24 12:16:37Z $
44*4882a593Smuzhiyun */
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun #ifndef _alignment_test_
47*4882a593Smuzhiyun #define _alignment_test_
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun /* ASSERT default packing */
50*4882a593Smuzhiyun typedef struct T4 {
51*4882a593Smuzhiyun uint8 a;
52*4882a593Smuzhiyun uint32 b;
53*4882a593Smuzhiyun uint16 c;
54*4882a593Smuzhiyun uint8 d;
55*4882a593Smuzhiyun } T4_t;
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun /* 4 byte alignment support */
58*4882a593Smuzhiyun /*
59*4882a593Smuzhiyun * a . . .
60*4882a593Smuzhiyun * b b b b
61*4882a593Smuzhiyun * c c d .
62*4882a593Smuzhiyun */
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun /*
65*4882a593Smuzhiyun * Below function is meant to verify that this file is compiled with the default alignment of 4.
66*4882a593Smuzhiyun * Function will fail to compile if the condition is not met.
67*4882a593Smuzhiyun */
68*4882a593Smuzhiyun #ifdef __GNUC__
69*4882a593Smuzhiyun #define VARIABLE_IS_NOT_USED __attribute__ ((unused))
70*4882a593Smuzhiyun #else
71*4882a593Smuzhiyun #define VARIABLE_IS_NOT_USED
72*4882a593Smuzhiyun #endif // endif
73*4882a593Smuzhiyun static void alignment_test(void);
74*4882a593Smuzhiyun static void
alignment_test(void)75*4882a593Smuzhiyun VARIABLE_IS_NOT_USED alignment_test(void)
76*4882a593Smuzhiyun {
77*4882a593Smuzhiyun /* verify 4 byte alignment support */
78*4882a593Smuzhiyun STATIC_ASSERT(sizeof(T4_t) == 12);
79*4882a593Smuzhiyun }
80*4882a593Smuzhiyun #endif /* _alignment_test_ */
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun /* Error check - BWL_PACKED_SECTION is defined in packed_section_start.h
83*4882a593Smuzhiyun * and undefined in packed_section_end.h. If it is already defined at this
84*4882a593Smuzhiyun * point, then there is a missing include of packed_section_end.h.
85*4882a593Smuzhiyun */
86*4882a593Smuzhiyun #ifdef BWL_PACKED_SECTION
87*4882a593Smuzhiyun #error "BWL_PACKED_SECTION is already defined!"
88*4882a593Smuzhiyun #else
89*4882a593Smuzhiyun #define BWL_PACKED_SECTION
90*4882a593Smuzhiyun #endif // endif
91*4882a593Smuzhiyun
92*4882a593Smuzhiyun #if defined(BWL_DEFAULT_PACKING)
93*4882a593Smuzhiyun /* generate an error if BWL_DEFAULT_PACKING is defined */
94*4882a593Smuzhiyun #error "BWL_DEFAULT_PACKING not supported any more."
95*4882a593Smuzhiyun #endif /* BWL_PACKED_SECTION */
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun /* Declare compiler-specific directives for structure packing. */
98*4882a593Smuzhiyun #if defined(__GNUC__) || defined(__lint)
99*4882a593Smuzhiyun #define BWL_PRE_PACKED_STRUCT
100*4882a593Smuzhiyun #define BWL_POST_PACKED_STRUCT __attribute__ ((packed))
101*4882a593Smuzhiyun #elif defined(__CC_ARM)
102*4882a593Smuzhiyun #define BWL_PRE_PACKED_STRUCT __packed
103*4882a593Smuzhiyun #define BWL_POST_PACKED_STRUCT
104*4882a593Smuzhiyun #else
105*4882a593Smuzhiyun #error "Unknown compiler!"
106*4882a593Smuzhiyun #endif // endif
107