/*
|
* Misc system wide definitions
|
*
|
* Copyright (C) 2020, 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.
|
*
|
*
|
* <<Broadcom-WL-IPTag/Dual:>>
|
*/
|
|
#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
|
|
/* 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)) || \
|
defined(__clang__))
|
#define GCC_DIAGNOSTIC_PUSH_SUPPRESS_CAST() \
|
_Pragma("GCC diagnostic push") \
|
_Pragma("GCC diagnostic ignored \"-Wcast-qual\"")
|
#define GCC_DIAGNOSTIC_PUSH_SUPPRESS_NULL_DEREF() \
|
_Pragma("GCC diagnostic push") \
|
_Pragma("GCC diagnostic ignored \"-Wnull-dereference\"")
|
#define GCC_DIAGNOSTIC_POP() \
|
_Pragma("GCC diagnostic pop")
|
#elif defined(_MSC_VER)
|
#define GCC_DIAGNOSTIC_PUSH_SUPPRESS_CAST() \
|
__pragma(warning(push)) \
|
__pragma(warning(disable:4090))
|
#define GCC_DIAGNOSTIC_PUSH_SUPPRESS_NULL_DEREF() \
|
__pragma(warning(push))
|
#define GCC_DIAGNOSTIC_POP() \
|
__pragma(warning(pop))
|
#else
|
#define GCC_DIAGNOSTIC_PUSH_SUPPRESS_CAST()
|
#define GCC_DIAGNOSTIC_PUSH_SUPPRESS_NULL_DEREF()
|
#define GCC_DIAGNOSTIC_POP()
|
#endif /* Diagnostic macros not defined */
|
|
/* Macros to allow Coverity modeling contructs in source code */
|
#if defined(__COVERITY__)
|
|
/* Coverity Doc:
|
* Indicates to the TAINTED_SCALAR checker and the INTEGER_OVERFLOW checker
|
* that a function taints its argument
|
*/
|
#define COV_TAINTED_DATA_ARG(arg) __coverity_tainted_data_argument__(arg)
|
|
/* Coverity Doc:
|
* Indicates to the TAINTED_SCALAR checker and the INTEGER_OVERFLOW checker
|
* that a function is a tainted data sink for an argument.
|
*/
|
#define COV_TAINTED_DATA_SINK(arg) __coverity_tainted_data_sink__(arg)
|
|
/* Coverity Doc:
|
* Models a function that cannot take a negative number as an argument. Used in
|
* conjunction with other models to indicate that negative arguments are invalid.
|
*/
|
#define COV_NEG_SINK(arg) __coverity_negative_sink__(arg)
|
|
#else
|
|
#define COV_TAINTED_DATA_ARG(arg) do { } while (0)
|
#define COV_TAINTED_DATA_SINK(arg) do { } while (0)
|
#define COV_NEG_SINK(arg) do { } while (0)
|
|
#endif /* __COVERITY__ */
|
|
/* 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)
|
|
/* Place _fn/_data symbols in various reclaimed output sections */
|
#define BCMATTACHDATA(_data) __attribute__ ((__section__ (".dataini2." #_data))) _data
|
#define BCMATTACHFN(_fn) __attribute__ ((__section__ (".textini2." #_fn), noinline)) _fn
|
#define BCMPREATTACHDATA(_data) __attribute__ ((__section__ (".dataini3." #_data))) _data
|
#define BCMPREATTACHFN(_fn) __attribute__ ((__section__ (".textini3." #_fn), noinline)) _fn
|
#define BCMPOSTATTACHDATA(_data) __attribute__ ((__section__ (".dataini5." #_data))) _data
|
#define BCMPOSTATTACHFN(_fn) __attribute__ ((__section__ (".textini5." #_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
|
|
/* Explicitly place data in .rodata section so it can be write-protected after attach */
|
#define BCMRODATA(_data) __attribute__ ((__section__ (".shrodata." #_data))) _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) BCMATTACHDATA(_data)
|
#define BCMATTACHFNSR(_fn) BCMATTACHFN(_fn)
|
#endif
|
|
#define BCMINITDATA(_data) _data
|
#define BCMINITFN(_fn) _fn
|
#ifndef CONST
|
#define CONST const
|
#endif
|
|
/* Non-manufacture or internal attach function/dat */
|
#if !(defined(WLTEST) || defined(ATE_BUILD))
|
#define BCMNMIATTACHFN(_fn) BCMATTACHFN(_fn)
|
#define BCMNMIATTACHDATA(_data) BCMATTACHDATA(_data)
|
#else
|
#define BCMNMIATTACHFN(_fn) _fn
|
#define BCMNMIATTACHDATA(_data) _data
|
#endif /* WLTEST || ATE_BUILD */
|
|
#if !defined(ATE_BUILD) && 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 /* !ATE_BUILD && BCM_CISDUMP_NO_RECLAIM */
|
|
/* 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 */
|
|
#define BCMUNINITFN(_fn) _fn
|
|
#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 BCMATTACHDATA(_data) _data
|
#define BCMATTACHFN(_fn) _fn
|
#define BCM_SRM_ATTACH_DATA(_data) _data
|
#define BCM_SRM_ATTACH_FN(_fn) _fn
|
/* BCMRODATA data is written into at attach time so it cannot be in .rodata */
|
#define BCMRODATA(_data) __attribute__ ((__section__ (".data." #_data))) _data
|
#define BCMPREATTACHDATA(_data) _data
|
#define BCMPREATTACHFN(_fn) _fn
|
#define BCMPOSTATTACHDATA(_data) _data
|
#define BCMPOSTATTACHFN(_fn) _fn
|
#define BCMINITDATA(_data) _data
|
#define BCMINITFN(_fn) _fn
|
#define BCMUNINITFN(_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) BCMINITDATA(_data)
|
|
#if defined(BCM_AQM_DMA_DESC) && !defined(BCM_AQM_DMA_DESC_DISABLED) && !defined(DONGLEBUILD)
|
#define BCMUCODEFN(_fn) BCMINITFN(_fn)
|
#else
|
#define BCMUCODEFN(_fn) BCMATTACHFN(_fn)
|
#endif /* BCM_AQM_DMA_DESC */
|
|
/* This feature is for dongle builds only.
|
* In Rom build use BCMFASTPATH() to mark functions that will excluded from ROM bits if
|
* BCMFASTPATH_EXCLUDE_FROM_ROM flag is defined (defined by default).
|
* In romoffload or ram builds all functions that marked by BCMFASTPATH() will be placed
|
* in "text_fastpath" section and will be used by trap handler.
|
*/
|
#ifndef BCMFASTPATH
|
#if defined(DONGLEBUILD)
|
#if defined(BCMROMBUILD)
|
#if defined(BCMFASTPATH_EXCLUDE_FROM_ROM)
|
#define BCMFASTPATH(_fn) __attribute__ ((__section__ (".text_ram." #_fn))) _fn
|
#else /* BCMFASTPATH_EXCLUDE_FROM_ROM */
|
#define BCMFASTPATH(_fn) _fn
|
#endif /* BCMFASTPATH_EXCLUDE_FROM_ROM */
|
#else /* BCMROMBUILD */
|
#ifdef BCMFASTPATH_O3OPT
|
#ifdef ROM_ENAB_RUNTIME_CHECK
|
#define BCMFASTPATH(_fn) __attribute__ ((__section__ (".text_fastpath." #_fn))) _fn
|
#else
|
#define BCMFASTPATH(_fn) __attribute__ ((__section__ (".text_fastpath." #_fn))) \
|
__attribute__ ((optimize(3))) _fn
|
#endif /* ROM_ENAB_RUNTIME_CHECK */
|
#else
|
#define BCMFASTPATH(_fn) __attribute__ ((__section__ (".text_fastpath." #_fn))) _fn
|
#endif /* BCMFASTPATH_O3OPT */
|
#endif /* BCMROMBUILD */
|
#else /* DONGLEBUILD */
|
#define BCMFASTPATH(_fn) _fn
|
#endif /* DONGLEBUILD */
|
#endif /* BCMFASTPATH */
|
|
/* Use the BCMRAMFN/BCMRAMDATA() macros to tag functions/data in source that must be included in RAM
|
* (excluded from ROM). This should eliminate the need to manually specify these functions/data 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.
|
*/
|
#if defined(BCMROMBUILD)
|
#define BCMRAMFN(_fn) __attribute__ ((__section__ (".text_ram." #_fn), noinline)) _fn
|
#define BCMRAMDATA(_data) __attribute__ ((__section__ (".rodata_ram." #_data))) _data
|
#else
|
#define BCMRAMFN(_fn) _fn
|
#define BCMRAMDATA(_data) _data
|
#endif /* ROMBUILD */
|
|
/* 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
|
|
/* functions that do not examine any values except their arguments, and have no effects except
|
* the return value should use this keyword. Note that a function that has pointer arguments
|
* and examines the data pointed to must not be declared as BCMCONSTFN.
|
*/
|
#ifdef __GNUC__
|
#define BCMCONSTFN __attribute__ ((const))
|
#else
|
#define BCMCONSTFN
|
#endif /* __GNUC__ */
|
|
/* 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
|
|
#ifdef BCMBUSCORETYPE
|
#define BUSCORETYPE(ct) (BCMBUSCORETYPE)
|
#else
|
#define BUSCORETYPE(ct) (ct)
|
#endif
|
|
/* Allows size optimization for single-backplane image */
|
#ifdef BCMCHIPTYPE
|
#define CHIPTYPE(bus) (BCMCHIPTYPE)
|
#else
|
#define CHIPTYPE(bus) (bus)
|
#endif
|
|
/* Allows size optimization for SPROM support */
|
#if defined(BCMSPROMBUS)
|
#define SPROMBUS (BCMSPROMBUS)
|
#else
|
#define SPROMBUS (PCI_BUS)
|
#endif
|
|
/* Allows size optimization for single-chip image */
|
/* These macros are NOT meant to encourage writing chip-specific code.
|
* Use them only when it is appropriate for example in PMU PLL/CHIP/SWREG
|
* controls and in chip-specific workarounds.
|
*/
|
#ifdef BCMCHIPID
|
#define CHIPID(chip) (BCMCHIPID)
|
#else
|
#define CHIPID(chip) (chip)
|
#endif
|
|
#ifdef BCMCHIPREV
|
#define CHIPREV(rev) (BCMCHIPREV)
|
#else
|
#define CHIPREV(rev) (rev)
|
#endif
|
|
#ifdef BCMPCIEREV
|
#define PCIECOREREV(rev) (BCMPCIEREV)
|
#else
|
#define PCIECOREREV(rev) (rev)
|
#endif
|
|
#ifdef BCMPMUREV
|
#define PMUREV(rev) (BCMPMUREV)
|
#else
|
#define PMUREV(rev) (rev)
|
#endif
|
|
#ifdef BCMCCREV
|
#define CCREV(rev) (BCMCCREV)
|
#else
|
#define CCREV(rev) (rev)
|
#endif
|
|
#ifdef BCMGCIREV
|
#define GCIREV(rev) (BCMGCIREV)
|
#else
|
#define GCIREV(rev) (rev)
|
#endif
|
|
#ifdef BCMCR4REV
|
#define CR4REV(rev) (BCMCR4REV)
|
#define CR4REV_GE(rev, val) ((BCMCR4REV) >= (val))
|
#else
|
#define CR4REV(rev) (rev)
|
#define CR4REV_GE(rev, val) ((rev) >= (val))
|
#endif
|
|
#ifdef BCMLHLREV
|
#define LHLREV(rev) (BCMLHLREV)
|
#else
|
#define LHLREV(rev) (rev)
|
#endif
|
|
#ifdef BCMSPMISREV
|
#define SPMISREV(rev) (BCMSPMISREV)
|
#else
|
#define SPMISREV(rev) (rev)
|
#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 uint32 dmaaddr_t;
|
#define PHYSADDRHI(_pa) (0u)
|
#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;
|
|
#if defined(__linux__)
|
#define MAX_DMA_SEGS 8
|
#else
|
#define MAX_DMA_SEGS 4
|
#endif
|
|
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).
|
*/
|
|
#ifndef BCMEXTRAHDROOM
|
#define BCMEXTRAHDROOM 204
|
#endif
|
|
/* Packet alignment for most efficient SDIO (can change based on platform) */
|
#ifndef SDALIGN
|
#define SDALIGN 32
|
#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.).
|
*/
|
/*
|
* set the numbers to be MAX of all the devices, to avoid problems with ROM builds
|
* USB BCMDONGLEHDRSZ and BCMDONGLEPADSZ is 0
|
* SDIO BCMDONGLEHDRSZ 12 and BCMDONGLEPADSZ 16
|
*/
|
#define BCMDONGLEHDRSZ 12
|
#define BCMDONGLEPADSZ 16
|
|
#define BCMDONGLEOVERHEAD (BCMDONGLEHDRSZ + BCMDONGLEPADSZ)
|
|
#ifdef BCMDBG
|
|
#ifndef BCMDBG_ERR
|
#define BCMDBG_ERR
|
#endif /* BCMDBG_ERR */
|
|
#ifndef BCMDBG_ASSERT
|
#define BCMDBG_ASSERT
|
#endif /* BCMDBG_ASSERT */
|
|
#endif /* BCMDBG */
|
|
#if defined(NO_BCMDBG_ASSERT)
|
#undef BCMDBG_ASSERT
|
#undef BCMASSERT_LOG
|
#endif
|
|
#if defined(BCMDBG_ASSERT) || defined(BCMASSERT_LOG)
|
#define BCMASSERT_SUPPORT
|
#endif /* BCMDBG_ASSERT || BCMASSERT_LOG */
|
|
/* 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, ®s->regfoo);
|
* field = GFIELD(regval, <NAME>);
|
* regval = SFIELD(regval, <NAME>, 1);
|
* W_REG(osh, ®s->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
|
|
/* 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).
|
*/
|
#if defined(BCMROMBUILD)
|
#ifndef ROM_ENAB_RUNTIME_CHECK
|
#define ROM_ENAB_RUNTIME_CHECK
|
#endif
|
#endif /* BCMROMBUILD */
|
|
#ifdef BCM_SH_SFLASH
|
extern bool _bcm_sh_sflash;
|
#if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
|
#define BCM_SH_SFLASH_ENAB() (_bcm_sh_sflash)
|
#elif defined(BCM_SH_SFLASH_DISABLED)
|
#define BCM_SH_SFLASH_ENAB() (0)
|
#else
|
#define BCM_SH_SFLASH_ENAB() (1)
|
#endif
|
#else
|
#define BCM_SH_SFLASH_ENAB() (0)
|
#endif /* BCM_SH_SFLASH */
|
|
#ifdef BCM_SFLASH
|
extern bool _bcm_sflash;
|
#if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
|
#define BCM_SFLASH_ENAB() (_bcm_sflash)
|
#elif defined(BCM_SFLASH_DISABLED)
|
#define BCM_SFLASH_ENAB() (0)
|
#else
|
#define BCM_SFLASH_ENAB() (1)
|
#endif
|
#else
|
#define BCM_SFLASH_ENAB() (0)
|
#endif /* BCM_SFLASH */
|
|
#ifdef BCM_DELAY_ON_LTR
|
extern bool _bcm_delay_on_ltr;
|
#if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
|
#define BCM_DELAY_ON_LTR_ENAB() (_bcm_delay_on_ltr)
|
#elif defined(BCM_DELAY_ON_LTR_DISABLED)
|
#define BCM_DELAY_ON_LTR_ENAB() (0)
|
#else
|
#define BCM_DELAY_ON_LTR_ENAB() (1)
|
#endif
|
#else
|
#define BCM_DELAY_ON_LTR_ENAB() (0)
|
#endif /* BCM_DELAY_ON_LTR */
|
|
/* Max. nvram variable table size */
|
#ifndef MAXSZ_NVRAM_VARS
|
#ifdef LARGE_NVRAM_MAXSZ
|
#define MAXSZ_NVRAM_VARS (LARGE_NVRAM_MAXSZ * 2)
|
#else
|
#if defined(BCMROMBUILD) || defined(DONGLEBUILD)
|
/* SROM12 changes */
|
#define MAXSZ_NVRAM_VARS 6144 /* should be reduced */
|
#else
|
#define LARGE_NVRAM_MAXSZ 8192
|
#define MAXSZ_NVRAM_VARS (LARGE_NVRAM_MAXSZ * 2)
|
#endif /* BCMROMBUILD || DONGLEBUILD */
|
#endif /* LARGE_NVRAM_MAXSZ */
|
#endif /* !MAXSZ_NVRAM_VARS */
|
|
#ifdef ATE_BUILD
|
#ifndef ATE_NVRAM_MAXSIZE
|
#define ATE_NVRAM_MAXSIZE 32000
|
#endif /* ATE_NVRAM_MAXSIZE */
|
#endif /* ATE_BUILD */
|
|
#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_DISABLED)
|
#define BCMRESVFRAGPOOL_ENAB() (0)
|
#else
|
#define BCMRESVFRAGPOOL_ENAB() (1)
|
#endif
|
#else
|
#define BCMRESVFRAGPOOL_ENAB() 0
|
#endif /* BCMPCIEDEV */
|
|
#ifdef BCMSDIODEV /* BCMSDIODEV support enab macros */
|
extern bool _sdiodevenab;
|
#if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
|
#define BCMSDIODEV_ENAB() (_sdiodevenab)
|
#elif defined(BCMSDIODEV_ENABLED)
|
#define BCMSDIODEV_ENAB() 1
|
#else
|
#define BCMSDIODEV_ENAB() 0
|
#endif
|
#else
|
#define BCMSDIODEV_ENAB() 0
|
#endif /* BCMSDIODEV */
|
|
#ifdef BCMSPMIS
|
extern bool _bcmspmi_enab;
|
#if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
|
#define BCMSPMIS_ENAB() (_bcmspmi_enab)
|
#elif defined(BCMSPMIS_DISABLED)
|
#define BCMSPMIS_ENAB() 0
|
#else
|
#define BCMSPMIS_ENAB() 1
|
#endif
|
#else
|
#define BCMSPMIS_ENAB() 0
|
#endif /* BCMSPMIS */
|
|
#ifdef BCMDVFS /* BCMDVFS support enab macros */
|
extern bool _dvfsenab;
|
#if defined(ROM_ENAB_RUNTIME_CHECK)
|
#define BCMDVFS_ENAB() (_dvfsenab)
|
#elif !defined(BCMDVFS_DISABLED)
|
#define BCMDVFS_ENAB() (1)
|
#else
|
#define BCMDVFS_ENAB() (0)
|
#endif
|
#else
|
#define BCMDVFS_ENAB() (0)
|
#endif /* BCMDVFS */
|
|
/* Max size for reclaimable NVRAM array */
|
#ifndef ATE_BUILD
|
#ifdef DL_NVRAM
|
#define NVRAM_ARRAY_MAXSIZE DL_NVRAM
|
#else
|
#define NVRAM_ARRAY_MAXSIZE MAXSZ_NVRAM_VARS
|
#endif /* DL_NVRAM */
|
#else
|
#define NVRAM_ARRAY_MAXSIZE ATE_NVRAM_MAXSIZE
|
#endif /* ATE_BUILD */
|
|
extern uint32 gFWID;
|
|
#ifdef BCMFRWDPKT /* BCMFRWDPKT support enab macros */
|
extern bool _bcmfrwdpkt;
|
#if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
|
#define BCMFRWDPKT_ENAB() (_bcmfrwdpkt)
|
#elif defined(BCMFRWDPKT_DISABLED)
|
#define BCMFRWDPKT_ENAB() (0)
|
#else
|
#define BCMFRWDPKT_ENAB() (1)
|
#endif
|
#else
|
#define BCMFRWDPKT_ENAB() (0)
|
#endif /* BCMFRWDPKT */
|
|
#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
|
|
#if defined(DONGLEBUILD) && ! defined(__COVERITY__)
|
#define MODULE_DETACH(var, detach_func)\
|
do { \
|
BCM_REFERENCE(detach_func); \
|
OSL_SYS_HALT(); \
|
} while (0);
|
#define MODULE_DETACH_2(var1, var2, detach_func) MODULE_DETACH(var1, detach_func)
|
#define MODULE_DETACH_TYPECASTED(var, detach_func)
|
#else
|
#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)
|
#endif /* DONGLEBUILD */
|
|
/* 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.
|
*/
|
#if !defined(BCMROMBUILD) || defined(BCMROMSYMGEN_BUILD)
|
#define BCM_ATTACH_REF_DECL()
|
#define BCM_ATTACH_REF() (1)
|
#else
|
#define BCM_ATTACH_REF_DECL() static bool bcm_non_roml_build = 0;
|
#define BCM_ATTACH_REF() (bcm_non_roml_build)
|
#endif
|
|
/* For ROM builds, keep it in const section so that it gets ROMmed. If abandoned, move it to
|
* RO section but before ro region start so that FATAL log buf doesn't use this.
|
*/
|
// Temporary - leave old definition in place until all references are removed elsewhere
|
#if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
|
#define BCMRODATA_ONTRAP(_data) _data
|
#else
|
#define BCMRODATA_ONTRAP(_data) __attribute__ ((__section__ (".ro_ontrap." #_data))) _data
|
#endif
|
// Renamed for consistency with post trap function definition
|
#if defined(ROM_ENAB_RUNTIME_CHECK) || !defined(DONGLEBUILD)
|
#define BCMPOST_TRAP_RODATA(_data) _data
|
#else
|
#define BCMPOST_TRAP_RODATA(_data) __attribute__ ((__section__ (".ro_ontrap." #_data))) _data
|
#endif
|
|
/* Similar to RO data on trap, we want code that's used after a trap to be placed in a special area
|
* as this means we can use all of the rest of the .text for post trap dumps. Functions with
|
* the BCMPOSTTRAPFN macro applied will either be in ROM or this protected area.
|
* For RAMFNs, the ROM build only needs to nkow that they won't be in ROM, but the -roml
|
* builds need to know to protect them.
|
*/
|
#if defined(BCMROMBUILD)
|
#define BCMPOSTTRAPFN(_fn) _fn
|
#define BCMPOSTTRAPRAMFN(_fn) __attribute__ ((__section__ (".text_ram." #_fn))) _fn
|
#if defined(BCMFASTPATH_EXCLUDE_FROM_ROM)
|
#define BCMPOSTTRAPFASTPATH(_fn) __attribute__ ((__section__ (".text_ram." #_fn))) _fn
|
#else /* BCMFASTPATH_EXCLUDE_FROM_ROM */
|
#define BCMPOSTTRAPFASTPATH(fn) BCMPOSTTRAPFN(fn)
|
#endif /* BCMFASTPATH_EXCLUDE_FROM_ROM */
|
#else
|
#if defined(DONGLEBUILD)
|
#define BCMPOSTTRAPFN(_fn) __attribute__ ((__section__ (".text_posttrap." #_fn))) _fn
|
#else
|
#define BCMPOSTTRAPFN(_fn) _fn
|
#endif /* DONGLEBUILD */
|
#define BCMPOSTTRAPRAMFN(fn) BCMPOSTTRAPFN(fn)
|
#define BCMPOSTTRAPFASTPATH(fn) BCMPOSTTRAPFN(fn)
|
#endif /* ROMBUILD */
|
|
typedef struct bcm_rng * bcm_rng_handle_t;
|
|
/* Use BCM_FUNC_PTR() to tag function pointers for ASLR code implementation. It will perform
|
* run-time relocation of a function pointer by translating it from a physical to virtual address.
|
*
|
* BCM_FUNC_PTR() should only be used where the function name is referenced (corresponding to the
|
* relocation entry for that symbol). It should not be used when the function pointer is invoked.
|
*/
|
void* BCM_ASLR_CODE_FNPTR_RELOCATOR(void *func_ptr);
|
#if defined(BCM_ASLR_CODE_FNPTR_RELOC)
|
/* 'func_ptr_err_chk' performs a compile time error check to ensure that only a constant
|
* function name is passed as an argument to BCM_FUNC_PTR(). This ensures that the macro is
|
* only used for function pointer references, and not for function pointer invocations.
|
*/
|
#define BCM_FUNC_PTR(func) \
|
({ static void *func_ptr_err_chk __attribute__ ((unused)) = (func); \
|
BCM_ASLR_CODE_FNPTR_RELOCATOR(func); })
|
#else
|
#define BCM_FUNC_PTR(func) (func)
|
#endif /* BCM_ASLR_CODE_FNPTR_RELOC */
|
|
/*
|
* Timestamps have this tag appended following a null byte which
|
* helps comparison/hashing scripts find and ignore them.
|
*/
|
#define TIMESTAMP_SUFFIX "<TIMESTAMP>"
|
|
#ifdef ASLR_STACK
|
/* MMU main thread stack data */
|
#define BCM_MMU_MTH_STK_DATA(_data) __attribute__ ((__section__ (".mmu_mth_stack." #_data))) _data
|
#endif /* ASLR_STACK */
|
|
/* Special section for MMU page-tables. */
|
#define BCM_MMU_PAGE_TABLE_DATA(_data) \
|
__attribute__ ((__section__ (".mmu_pagetable." #_data))) _data
|
|
/* Some phy initialization code/data can't be reclaimed in dualband mode */
|
#if defined(DBAND)
|
#define WLBANDINITDATA(_data) _data
|
#define WLBANDINITFN(_fn) _fn
|
#else
|
#define WLBANDINITDATA(_data) BCMINITDATA(_data)
|
#define WLBANDINITFN(_fn) BCMINITFN(_fn)
|
#endif
|
|
/* Tag struct members to make it explicitly clear that they are physical addresses. These are
|
* typically used in data structs shared by the firmware and host code (or off-line utilities). The
|
* use of the macro avoids customer visible API/name changes.
|
*/
|
#if defined(BCM_PHYS_ADDR_NAME_CONVERSION)
|
#define PHYS_ADDR_N(name) name ## _phys
|
#else
|
#define PHYS_ADDR_N(name) name
|
#endif
|
|
/*
|
* A compact form for a list of valid register address offsets.
|
* Used for when dumping the contents of the register set for the user.
|
*
|
* bmp_cnt has either bitmap or count. If the MSB (bit 31) is set, then
|
* bmp_cnt[30:0] has count, i.e, number of valid registers whose values are
|
* contigous from the start address. If MSB is zero, then the value
|
* should be considered as a bitmap of 31 discreet addresses from the base addr.
|
* Note: the data type for bmp_cnt is chosen as an array of uint8 to avoid padding.
|
*/
|
typedef struct _regs_bmp_list {
|
uint16 addr; /* start address offset */
|
uint8 bmp_cnt[4]; /* bit[31]=1, bit[30:0] is count else it is a bitmap */
|
} regs_list_t;
|
|
#endif /* _bcmdefs_h_ */
|
