hc
2023-11-06 15ade055295d13f95d49e3d99b09f3bbfb4a43e7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Misc system wide definitions
 *
 * Copyright (C) 1999-2019, Broadcom.
 *
 *      Unless you and Broadcom execute a separate written software license
 * agreement governing use of this software, this software is licensed to you
 * under the terms of the GNU General Public License version 2 (the "GPL"),
 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
 * following added to such license:
 *
 *      As a special exception, the copyright holders of this software give you
 * permission to link this software with independent modules, and to copy and
 * distribute the resulting executable under terms of your choice, provided that
 * you also meet, for each linked independent module, the terms and conditions of
 * the license of that module.  An independent module is a module which is not
 * derived from this software.  The special exception does not apply to any
 * modifications of the software.
 *
 *      Notwithstanding the above, under no circumstances may you combine this
 * software in any way with any other Broadcom software provided under a license
 * other than the GPL, without Broadcom's express prior written consent.
 *
 *
 * <<Broadcom-WL-IPTag/Open:>>
 *
 * $Id: bcmdefs.h 788740 2018-11-13 21:45:01Z $
 */
 
#ifndef    _bcmdefs_h_
#define    _bcmdefs_h_
 
/*
 * One doesn't need to include this file explicitly, gets included automatically if
 * typedefs.h is included.
 */
 
/* Use BCM_REFERENCE to suppress warnings about intentionally-unused function
 * arguments or local variables.
 */
#define BCM_REFERENCE(data)    ((void)(data))
 
/* Allow for suppressing unused variable warnings. */
#ifdef __GNUC__
#define UNUSED_VAR     __attribute__ ((unused))
#else
#define UNUSED_VAR
#endif // endif
 
/* GNU GCC 4.6+ supports selectively turning off a warning.
 * Define these diagnostic macros to help suppress cast-qual warning
 * until all the work can be done to fix the casting issues.
 */
#if (defined(__GNUC__) && defined(STRICT_GCC_WARNINGS) && (__GNUC__ > 4 || (__GNUC__ == \
   4 && __GNUC_MINOR__ >= 6)))
#define GCC_DIAGNOSTIC_PUSH_SUPPRESS_CAST()              \
   _Pragma("GCC diagnostic push")             \
   _Pragma("GCC diagnostic ignored \"-Wcast-qual\"")
#define GCC_DIAGNOSTIC_POP()                             \
   _Pragma("GCC diagnostic pop")
#else
#define GCC_DIAGNOSTIC_PUSH_SUPPRESS_CAST()
#define GCC_DIAGNOSTIC_POP()
#endif   /* Diagnostic macros not defined */
 
/* Support clang for MACOSX compiler */
#ifdef __clang__
#define CLANG_DIAGNOSTIC_PUSH_SUPPRESS_CAST()              \
   _Pragma("clang diagnostic push")             \
   _Pragma("clang diagnostic ignored \"-Wcast-qual\"")
#define CLANG_DIAGNOSTIC_PUSH_SUPPRESS_FORMAT()              \
   _Pragma("clang diagnostic push")             \
   _Pragma("clang diagnostic ignored \"-Wformat-nonliteral\"")
#define CLANG_DIAGNOSTIC_POP()              \
   _Pragma("clang diagnostic pop")
#else
#define CLANG_DIAGNOSTIC_PUSH_SUPPRESS_CAST()
#define CLANG_DIAGNOSTIC_PUSH_SUPPRESS_FORMAT()
#define CLANG_DIAGNOSTIC_POP()
#endif // endif
/* Compile-time assert can be used in place of ASSERT if the expression evaluates
 * to a constant at compile time.
 */
#define STATIC_ASSERT(expr) { \
   /* Make sure the expression is constant. */ \
   typedef enum { _STATIC_ASSERT_NOT_CONSTANT = (expr) } _static_assert_e UNUSED_VAR; \
   /* Make sure the expression is true. */ \
   typedef char STATIC_ASSERT_FAIL[(expr) ? 1 : -1] UNUSED_VAR; \
}
 
/* Reclaiming text and data :
 * The following macros specify special linker sections that can be reclaimed
 * after a system is considered 'up'.
 * BCMATTACHFN is also used for detach functions (it's not worth having a BCMDETACHFN,
 * as in most cases, the attach function calls the detach function to clean up on error).
 */
#if defined(BCM_RECLAIM)
 
extern bool bcm_reclaimed;
extern bool bcm_attach_part_reclaimed;
extern bool bcm_preattach_part_reclaimed;
extern bool bcm_postattach_part_reclaimed;
 
#define RECLAIMED()            (bcm_reclaimed)
#define ATTACH_PART_RECLAIMED()        (bcm_attach_part_reclaimed)
#define PREATTACH_PART_RECLAIMED()    (bcm_preattach_part_reclaimed)
#define POSTATTACH_PART_RECLAIMED()    (bcm_postattach_part_reclaimed)
 
#if defined(BCM_RECLAIM_ATTACH_FN_DATA)
#define _data    __attribute__ ((__section__ (".dataini2." #_data))) _data
#define _fn    __attribute__ ((__section__ (".textini2." #_fn), noinline)) _fn
 
/* Relocate attach symbols to save-restore region to increase pre-reclaim heap size. */
#define BCM_SRM_ATTACH_DATA(_data)    __attribute__ ((__section__ (".datasrm." #_data))) _data
#define BCM_SRM_ATTACH_FN(_fn)        __attribute__ ((__section__ (".textsrm." #_fn), noinline)) _fn
 
#ifndef PREATTACH_NORECLAIM
#define BCMPREATTACHDATA(_data)    __attribute__ ((__section__ (".dataini3." #_data))) _data
#define BCMPREATTACHFN(_fn)    __attribute__ ((__section__ (".textini3." #_fn), noinline)) _fn
#else
#define BCMPREATTACHDATA(_data)    __attribute__ ((__section__ (".dataini2." #_data))) _data
#define BCMPREATTACHFN(_fn)    __attribute__ ((__section__ (".textini2." #_fn), noinline)) _fn
#endif /* PREATTACH_NORECLAIM  */
#define BCMPOSTATTACHDATA(_data)    __attribute__ ((__section__ (".dataini5." #_data))) _data
#define BCMPOSTATTACHFN(_fn)    __attribute__ ((__section__ (".textini5." #_fn), noinline)) _fn
#else  /* BCM_RECLAIM_ATTACH_FN_DATA  */
#define _data    _data
#define _fn    _fn
#define BCMPREATTACHDATA(_data)    _data
#define BCMPREATTACHFN(_fn)    _fn
#define BCMPOSTATTACHDATA(_data)    _data
#define BCMPOSTATTACHFN(_fn)    _fn
#endif /* BCM_RECLAIM_ATTACH_FN_DATA  */
 
#ifdef BCMDBG_SR
/*
 * Don't reclaim so we can compare SR ASM
 */
#define BCMPREATTACHDATASR(_data)    _data
#define BCMPREATTACHFNSR(_fn)        _fn
#define BCMATTACHDATASR(_data)        _data
#define BCMATTACHFNSR(_fn)        _fn
#else
#define BCMPREATTACHDATASR(_data)    BCMPREATTACHDATA(_data)
#define BCMPREATTACHFNSR(_fn)        BCMPREATTACHFN(_fn)
#define BCMATTACHDATASR(_data)        _data
#define BCMATTACHFNSR(_fn)        _fn
#endif // endif
 
#if defined(BCM_RECLAIM_INIT_FN_DATA)
#define _data    __attribute__ ((__section__ (".dataini1." #_data))) _data
#define _fn        __attribute__ ((__section__ (".textini1." #_fn), noinline)) _fn
#define CONST
#else /* BCM_RECLAIM_INIT_FN_DATA  */
#define _data    _data
#define _fn        _fn
#ifndef CONST
#define CONST    const
#endif // endif
#endif /* BCM_RECLAIM_INIT_FN_DATA  */
 
/* Non-manufacture or internal attach function/dat */
#define    BCMNMIATTACHFN(_fn)    _fn
#define    BCMNMIATTACHDATA(_data)    _data
 
#if defined(BCM_CISDUMP_NO_RECLAIM)
#define    BCMCISDUMPATTACHFN(_fn)        _fn
#define    BCMCISDUMPATTACHDATA(_data)    _data
#else
#define    BCMCISDUMPATTACHFN(_fn)        BCMNMIATTACHFN(_fn)
#define    BCMCISDUMPATTACHDATA(_data)    BCMNMIATTACHDATA(_data)
#endif // endif
 
/* SROM with OTP support */
#if defined(BCMOTPSROM)
#define    BCMSROMATTACHFN(_fn)        _fn
#define    BCMSROMATTACHDATA(_data)    _data
#else
#define    BCMSROMATTACHFN(_fn)        BCMNMIATTACHFN(_fn)
#define    BCMSROMATTACHDATA(_data)    BCMNMIATTACHFN(_data)
#endif    /* BCMOTPSROM */
 
#if defined(BCM_CISDUMP_NO_RECLAIM)
#define    BCMSROMCISDUMPATTACHFN(_fn)    _fn
#define    BCMSROMCISDUMPATTACHDATA(_data)    _data
#else
#define    BCMSROMCISDUMPATTACHFN(_fn)    BCMSROMATTACHFN(_fn)
#define    BCMSROMCISDUMPATTACHDATA(_data)    BCMSROMATTACHDATA(_data)
#endif /* BCM_CISDUMP_NO_RECLAIM */
 
#ifdef BCMNODOWN
#define _fn    _fn
#else
#define _fn    _fn
#endif // endif
 
#else /* BCM_RECLAIM */
 
#define bcm_reclaimed            (1)
#define bcm_attach_part_reclaimed    (1)
#define bcm_preattach_part_reclaimed    (1)
#define bcm_postattach_part_reclaimed    (1)
#define _data        _data
#define _fn        _fn
#define BCM_SRM_ATTACH_DATA(_data)    _data
#define BCM_SRM_ATTACH_FN(_fn)        _fn
#define BCMPREATTACHDATA(_data)        _data
#define BCMPREATTACHFN(_fn)        _fn
#define BCMPOSTATTACHDATA(_data)    _data
#define BCMPOSTATTACHFN(_fn)        _fn
#define _data        _data
#define _fn            _fn
#define _fn        _fn
#define    BCMNMIATTACHFN(_fn)        _fn
#define    BCMNMIATTACHDATA(_data)        _data
#define    BCMSROMATTACHFN(_fn)        _fn
#define    BCMSROMATTACHDATA(_data)    _data
#define BCMPREATTACHFNSR(_fn)        _fn
#define BCMPREATTACHDATASR(_data)    _data
#define BCMATTACHFNSR(_fn)        _fn
#define BCMATTACHDATASR(_data)        _data
#define    BCMSROMATTACHFN(_fn)        _fn
#define    BCMSROMATTACHDATA(_data)    _data
#define    BCMCISDUMPATTACHFN(_fn)        _fn
#define    BCMCISDUMPATTACHDATA(_data)    _data
#define    BCMSROMCISDUMPATTACHFN(_fn)    _fn
#define    BCMSROMCISDUMPATTACHDATA(_data)    _data
#define CONST                const
 
#define RECLAIMED()            (bcm_reclaimed)
#define ATTACH_PART_RECLAIMED()        (bcm_attach_part_reclaimed)
#define PREATTACH_PART_RECLAIMED()    (bcm_preattach_part_reclaimed)
#define POSTATTACH_PART_RECLAIMED()    (bcm_postattach_part_reclaimed)
 
#endif /* BCM_RECLAIM */
 
#define BCMUCODEDATA(_data)        _data
 
#if defined(BCM_DMA_CT) && !defined(BCM_DMA_CT_DISABLED)
#define BCMUCODEFN(_fn)            _fn
#else
#define BCMUCODEFN(_fn)            _fn
#endif /* BCM_DMA_CT */
 
#if !defined STB
#undef BCM47XX_CA9
#endif /* STB */
 
/* BCMFASTPATH Related Macro defines
*/
#ifndef BCMFASTPATH
#if defined(STB)
#define BCMFASTPATH        __attribute__ ((__section__ (".text.fastpath")))
#define BCMFASTPATH_HOST    __attribute__ ((__section__ (".text.fastpath_host")))
#else /* mips || BCM47XX_CA9 || STB */
#define BCMFASTPATH
#define BCMFASTPATH_HOST
#endif // endif
#endif /* BCMFASTPATH */
 
/* Use the BCMRAMFN() macro to tag functions in source that must be included in RAM (excluded from
 * ROM). This should eliminate the need to manually specify these functions in the ROM config file.
 * It should only be used in special cases where the function must be in RAM for *all* ROM-based
 * chips.
 */
   #define BCMRAMFN(_fn)    _fn
 
/* Use BCMSPECSYM() macro to tag symbols going to a special output section in the binary. */
#define BCMSPECSYM(_sym)    __attribute__ ((__section__ (".special." #_sym))) _sym
 
#define STATIC    static
 
/* Bus types */
#define    SI_BUS            0    /* SOC Interconnect */
#define    PCI_BUS            1    /* PCI target */
#define    PCMCIA_BUS        2    /* PCMCIA target */
#define SDIO_BUS        3    /* SDIO target */
#define JTAG_BUS        4    /* JTAG */
#define USB_BUS            5    /* USB (does not support R/W REG) */
#define SPI_BUS            6    /* gSPI target */
#define RPC_BUS            7    /* RPC target */
 
/* Allows size optimization for single-bus image */
#ifdef BCMBUSTYPE
#define BUSTYPE(bus)    (BCMBUSTYPE)
#else
#define BUSTYPE(bus)    (bus)
#endif // endif
 
#ifdef BCMBUSCORETYPE
#define BUSCORETYPE(ct)        (BCMBUSCORETYPE)
#else
#define BUSCORETYPE(ct)        (ct)
#endif // endif
 
/* Allows size optimization for single-backplane image */
#ifdef BCMCHIPTYPE
#define CHIPTYPE(bus)    (BCMCHIPTYPE)
#else
#define CHIPTYPE(bus)    (bus)
#endif // endif
 
/* Allows size optimization for SPROM support */
#if defined(BCMSPROMBUS)
#define SPROMBUS    (BCMSPROMBUS)
#elif defined(SI_PCMCIA_SROM)
#define SPROMBUS    (PCMCIA_BUS)
#else
#define SPROMBUS    (PCI_BUS)
#endif // endif
 
/* Allows size optimization for single-chip image */
#ifdef BCMCHIPID
#define CHIPID(chip)    (BCMCHIPID)
#else
#define CHIPID(chip)    (chip)
#endif // endif
 
#ifdef BCMCHIPREV
#define CHIPREV(rev)    (BCMCHIPREV)
#else
#define CHIPREV(rev)    (rev)
#endif // endif
 
#ifdef BCMPCIEREV
#define PCIECOREREV(rev)    (BCMPCIEREV)
#else
#define PCIECOREREV(rev)    (rev)
#endif // endif
 
#ifdef BCMPMUREV
#define PMUREV(rev)    (BCMPMUREV)
#else
#define PMUREV(rev)    (rev)
#endif // endif
 
#ifdef BCMCCREV
#define CCREV(rev)    (BCMCCREV)
#else
#define CCREV(rev)    (rev)
#endif // endif
 
#ifdef BCMGCIREV
#define GCIREV(rev)    (BCMGCIREV)
#else
#define GCIREV(rev)    (rev)
#endif // endif
 
#ifdef BCMCR4REV
#define CR4REV        (BCMCR4REV)
#endif // endif
 
/* Defines for DMA Address Width - Shared between OSL and HNDDMA */
#define DMADDR_MASK_32 0x0        /* Address mask for 32-bits */
#define DMADDR_MASK_30 0xc0000000    /* Address mask for 30-bits */
#define DMADDR_MASK_26 0xFC000000    /* Address maks for 26-bits */
#define DMADDR_MASK_0  0xffffffff    /* Address mask for 0-bits (hi-part) */
 
#define    DMADDRWIDTH_26  26 /* 26-bit addressing capability */
#define    DMADDRWIDTH_30  30 /* 30-bit addressing capability */
#define    DMADDRWIDTH_32  32 /* 32-bit addressing capability */
#define    DMADDRWIDTH_63  63 /* 64-bit addressing capability */
#define    DMADDRWIDTH_64  64 /* 64-bit addressing capability */
 
typedef struct {
   uint32 loaddr;
   uint32 hiaddr;
} dma64addr_t;
 
#define PHYSADDR64HI(_pa) ((_pa).hiaddr)
#define PHYSADDR64HISET(_pa, _val) \
   do { \
       (_pa).hiaddr = (_val);        \
   } while (0)
#define PHYSADDR64LO(_pa) ((_pa).loaddr)
#define PHYSADDR64LOSET(_pa, _val) \
   do { \
       (_pa).loaddr = (_val);        \
   } while (0)
 
#ifdef BCMDMA64OSL
typedef dma64addr_t dmaaddr_t;
#define PHYSADDRHI(_pa) PHYSADDR64HI(_pa)
#define PHYSADDRHISET(_pa, _val) PHYSADDR64HISET(_pa, _val)
#define PHYSADDRLO(_pa)  PHYSADDR64LO(_pa)
#define PHYSADDRLOSET(_pa, _val) PHYSADDR64LOSET(_pa, _val)
#define PHYSADDRTOULONG(_pa, _ulong) \
   do { \
       _ulong = ((unsigned long long)(_pa).hiaddr << 32) | ((_pa).loaddr); \
   } while (0)
 
#else
typedef unsigned long dmaaddr_t;
#define PHYSADDRHI(_pa) (0)
#define PHYSADDRHISET(_pa, _val)
#define PHYSADDRLO(_pa) ((_pa))
#define PHYSADDRLOSET(_pa, _val) \
   do { \
       (_pa) = (_val);            \
   } while (0)
#endif /* BCMDMA64OSL */
#define PHYSADDRISZERO(_pa) (PHYSADDRLO(_pa) == 0 && PHYSADDRHI(_pa) == 0)
 
/* One physical DMA segment */
typedef struct  {
   dmaaddr_t addr;
   uint32      length;
} hnddma_seg_t;
 
#define MAX_DMA_SEGS 8
 
typedef struct {
   void *oshdmah; /* Opaque handle for OSL to store its information */
   uint origsize; /* Size of the virtual packet */
   uint nsegs;
   hnddma_seg_t segs[MAX_DMA_SEGS];
} hnddma_seg_map_t;
 
/* packet headroom necessary to accommodate the largest header in the system, (i.e TXOFF).
 * By doing, we avoid the need  to allocate an extra buffer for the header when bridging to WL.
 * There is a compile time check in wlc.c which ensure that this value is at least as big
 * as TXOFF. This value is used in dma_rxfill (hnddma.c).
 */
 
#if defined(BCM_RPC_NOCOPY) || defined(BCM_RCP_TXNOCOPY)
/* add 40 bytes to allow for extra RPC header and info  */
#define BCMEXTRAHDROOM 260
#else /* BCM_RPC_NOCOPY || BCM_RPC_TXNOCOPY */
#if defined(STB)
#define BCMEXTRAHDROOM 224
#else
#define BCMEXTRAHDROOM 204
#endif // endif
#endif /* BCM_RPC_NOCOPY || BCM_RPC_TXNOCOPY */
 
/* Packet alignment for most efficient SDIO (can change based on platform) */
#ifndef SDALIGN
#define SDALIGN    32
#endif // endif
 
/* Headroom required for dongle-to-host communication.  Packets allocated
 * locally in the dongle (e.g. for CDC ioctls or RNDIS messages) should
 * leave this much room in front for low-level message headers which may
 * be needed to get across the dongle bus to the host.  (These messages
 * don't go over the network, so room for the full WL header above would
 * be a waste.).
*/
#define BCMDONGLEHDRSZ 12
#define BCMDONGLEPADSZ 16
 
#define BCMDONGLEOVERHEAD    (BCMDONGLEHDRSZ + BCMDONGLEPADSZ)
 
#if defined(NO_BCMDBG_ASSERT)
# undef BCMDBG_ASSERT
# undef BCMASSERT_LOG
#endif // endif
 
#if defined(BCMASSERT_LOG)
#define BCMASSERT_SUPPORT
#endif // endif
 
/* Macros for doing definition and get/set of bitfields
 * Usage example, e.g. a three-bit field (bits 4-6):
 *    #define <NAME>_M    BITFIELD_MASK(3)
 *    #define <NAME>_S    4
 * ...
 *    regval = R_REG(osh, &regs->regfoo);
 *    field = GFIELD(regval, <NAME>);
 *    regval = SFIELD(regval, <NAME>, 1);
 *    W_REG(osh, &regs->regfoo, regval);
 */
#define BITFIELD_MASK(width) \
       (((unsigned)1 << (width)) - 1)
#define GFIELD(val, field) \
       (((val) >> field ## _S) & field ## _M)
#define SFIELD(val, field, bits) \
       (((val) & (~(field ## _M << field ## _S))) | \
        ((unsigned)(bits) << field ## _S))
 
/* define BCMSMALL to remove misc features for memory-constrained environments */
#ifdef BCMSMALL
#undef    BCMSPACE
#define bcmspace    FALSE    /* if (bcmspace) code is discarded */
#else
#define    BCMSPACE
#define bcmspace    TRUE    /* if (bcmspace) code is retained */
#endif // endif
 
/* Max. nvram variable table size */
#ifndef MAXSZ_NVRAM_VARS
#ifdef LARGE_NVRAM_MAXSZ
#define MAXSZ_NVRAM_VARS    (LARGE_NVRAM_MAXSZ * 2)
#else
#define LARGE_NVRAM_MAXSZ    8192
#define MAXSZ_NVRAM_VARS    (LARGE_NVRAM_MAXSZ * 2)
#endif /* LARGE_NVRAM_MAXSZ */
#endif /* !MAXSZ_NVRAM_VARS */
 
/* ROM_ENAB_RUNTIME_CHECK may be set based upon the #define below (for ROM builds). It may also
 * be defined via makefiles (e.g. ROM auto abandon unoptimized compiles).
 */
 
#ifdef BCMLFRAG /* BCMLFRAG support enab macros  */
   extern bool _bcmlfrag;
   #if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
       #define BCMLFRAG_ENAB() (_bcmlfrag)
   #elif defined(BCMLFRAG_DISABLED)
       #define BCMLFRAG_ENAB()    (0)
   #else
       #define BCMLFRAG_ENAB()    (1)
   #endif
#else
   #define BCMLFRAG_ENAB()        (0)
#endif /* BCMLFRAG_ENAB */
 
#ifdef BCMPCIEDEV /* BCMPCIEDEV support enab macros */
extern bool _pciedevenab;
   #if defined(ROM_ENAB_RUNTIME_CHECK)
       #define BCMPCIEDEV_ENAB() (_pciedevenab)
   #elif defined(BCMPCIEDEV_ENABLED)
       #define BCMPCIEDEV_ENAB()    1
   #else
       #define BCMPCIEDEV_ENAB()    0
   #endif
#else
   #define BCMPCIEDEV_ENAB()    0
#endif /* BCMPCIEDEV */
 
#ifdef BCMRESVFRAGPOOL /* BCMRESVFRAGPOOL support enab macros */
extern bool _resvfragpool_enab;
   #if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
       #define  BCMRESVFRAGPOOL_ENAB() (_resvfragpool_enab)
   #elif defined(BCMRESVFRAGPOOL_ENABLED)
       #define BCMRESVFRAGPOOL_ENAB()    1
   #else
       #define BCMRESVFRAGPOOL_ENAB()    0
   #endif
#else
   #define BCMRESVFRAGPOOL_ENAB()    0
#endif /* BCMPCIEDEV */
 
   #define BCMSDIODEV_ENAB()    0
 
/* Max size for reclaimable NVRAM array */
#ifdef DL_NVRAM
#define NVRAM_ARRAY_MAXSIZE    DL_NVRAM
#else
#define NVRAM_ARRAY_MAXSIZE    MAXSZ_NVRAM_VARS
#endif /* DL_NVRAM */
 
extern uint32 gFWID;
 
#ifdef BCMFRWDPOOLREORG /* BCMFRWDPOOLREORG support enab macros  */
   extern bool _bcmfrwdpoolreorg;
   #if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
       #define BCMFRWDPOOLREORG_ENAB() (_bcmfrwdpoolreorg)
   #elif defined(BCMFRWDPOOLREORG_DISABLED)
       #define BCMFRWDPOOLREORG_ENAB()    (0)
   #else
       #define BCMFRWDPOOLREORG_ENAB()    (1)
   #endif
#else
   #define BCMFRWDPOOLREORG_ENAB()        (0)
#endif /* BCMFRWDPOOLREORG */
 
#ifdef BCMPOOLRECLAIM /* BCMPOOLRECLAIM support enab macros  */
   extern bool _bcmpoolreclaim;
   #if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
       #define BCMPOOLRECLAIM_ENAB() (_bcmpoolreclaim)
   #elif defined(BCMPOOLRECLAIM_DISABLED)
       #define BCMPOOLRECLAIM_ENAB()    (0)
   #else
       #define BCMPOOLRECLAIM_ENAB()    (1)
   #endif
#else
   #define BCMPOOLRECLAIM_ENAB()        (0)
#endif /* BCMPOOLRECLAIM */
 
/* Chip related low power flags (lpflags) */
 
#ifndef PAD
#define _PADLINE(line)  pad ## line
#define _XSTR(line)     _PADLINE(line)
#define PAD             _XSTR(__LINE__)
#endif // endif
 
#ifndef FRAG_HEADROOM
#define FRAG_HEADROOM    224    /* In absence of SFD, use default headroom of 224 */
#endif // endif
 
#define MODULE_DETACH(var, detach_func)\
   if (var) { \
       detach_func(var); \
       (var) = NULL; \
   }
#define MODULE_DETACH_2(var1, var2, detach_func) detach_func(var1, var2)
#define MODULE_DETACH_TYPECASTED(var, detach_func) detach_func(var)
 
/* When building ROML image use runtime conditional to cause the compiler
 * to compile everything but not to complain "defined but not used"
 * as #ifdef would cause at the callsites.
 * In the end functions called under if (0) {} will not be linked
 * into the final binary if they're not called from other places either.
 */
#define BCM_ATTACH_REF_DECL()
#define BCM_ATTACH_REF()    (1)
 
/* Const in ROM else normal data in RAM */
#if defined(ROM_ENAB_RUNTIME_CHECK)
   #define ROMCONST    CONST
#else
   #define ROMCONST
#endif // endif
 
#endif /* _bcmdefs_h_ */