/drivers/net/wireless/bcmdhd/include/bcmdefs.h
C Header | 287 lines | 167 code | 41 blank | 79 comment | 4 complexity | 0cfff4b8a949aa9a0b6d7eff4469f7c0 MD5 | raw file
- /*
- * Misc system wide definitions
- *
- * Copyright (C) 1999-2013, Broadcom Corporation
- *
- * 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.
- *
- * $Id: bcmdefs.h 416231 2013-08-02 07:38:34Z $
- */
- #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))
- /* 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; \
- /* Make sure the expression is true. */ \
- typedef char STATIC_ASSERT_FAIL[(expr) ? 1 : -1]; \
- }
- /* 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).
- */
- #define bcmreclaimed 0
- #define _data _data
- #define _fn _fn
- #define BCMPREATTACHDATA(_data) _data
- #define BCMPREATTACHFN(_fn) _fn
- #define _data _data
- #define _fn _fn
- #define _fn _fn
- #define BCMNMIATTACHFN(_fn) _fn
- #define BCMNMIATTACHDATA(_data) _data
- #define CONST const
- /* Do not put BCM47XX and __ARM_ARCH_7A__ to the same line.
- * DHD build has problem because the BCM47XX will be excluded in DHD release.
- */
- #undef BCM47XX_CA9
- #ifdef __ARM_ARCH_7A__
- #define BCM47XX_CA9
- #endif /* __ARM_ARCH_7A__ */
- #ifndef BCMFASTPATH
- #if defined(BCM47XX_CA9)
- #define BCMFASTPATH __attribute__ ((__section__ (".text.fastpath")))
- #define BCMFASTPATH_HOST __attribute__ ((__section__ (".text.fastpath_host")))
- #else
- #define BCMFASTPATH
- #define BCMFASTPATH_HOST
- #endif
- #endif /* BCMFASTPATH */
- /* Put some library data/code into ROM to reduce RAM requirements */
- #define _data _data
- #define BCMROMDAT_NAME(_data) _data
- #define _fn _fn
- #define _fn _fn
- #define STATIC static
- #define BCMROMDAT_ARYSIZ(data) ARRAYSIZE(data)
- #define BCMROMDAT_SIZEOF(data) sizeof(data)
- #define BCMROMDAT_APATCH(data)
- #define BCMROMDAT_SPATCH(data)
- /* 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
- /* 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)
- #elif defined(SI_PCMCIA_SROM)
- #define SPROMBUS (PCMCIA_BUS)
- #else
- #define SPROMBUS (PCI_BUS)
- #endif
- /* Allows size optimization for single-chip image */
- #ifdef BCMCHIPID
- #define CHIPID(chip) (BCMCHIPID)
- #else
- #define CHIPID(chip) (chip)
- #endif
- #ifdef BCMCHIPREV
- #define CHIPREV(rev) (BCMCHIPREV)
- #else
- #define CHIPREV(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_0 0xffffffff /* Address mask for 0-bits (hi-part) */
- #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 */
- #ifdef BCMDMA64OSL
- typedef struct {
- uint32 loaddr;
- uint32 hiaddr;
- } dma64addr_t;
- typedef dma64addr_t dmaaddr_t;
- #define PHYSADDRHI(_pa) ((_pa).hiaddr)
- #define PHYSADDRHISET(_pa, _val) \
- do { \
- (_pa).hiaddr = (_val); \
- } while (0)
- #define PHYSADDRLO(_pa) ((_pa).loaddr)
- #define PHYSADDRLOSET(_pa, _val) \
- do { \
- (_pa).loaddr = (_val); \
- } 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 */
- /* One physical DMA segment */
- typedef struct {
- dmaaddr_t addr;
- uint32 length;
- } hnddma_seg_t;
- #define MAX_DMA_SEGS 4
- 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(BCM47XX_CA9)
- #define BCMEXTRAHDROOM 224
- #else
- #define BCMEXTRAHDROOM 204
- #endif /* linux && BCM47XX_CA9 */
- #endif /* BCM_RPC_NOCOPY || BCM_RPC_TXNOCOPY */
- /* 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.).
- */
- #define BCMDONGLEHDRSZ 12
- #define BCMDONGLEPADSZ 16
- #define BCMDONGLEOVERHEAD (BCMDONGLEHDRSZ + BCMDONGLEPADSZ)
- #if defined(NO_BCMDBG_ASSERT)
- # undef BCMDBG_ASSERT
- # undef BCMASSERT_LOG
- #endif
- #if defined(BCMASSERT_LOG)
- #define BCMASSERT_SUPPORT
- #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, ®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
- /* Max. nvram variable table size */
- #define MAXSZ_NVRAM_VARS 4096
- /* 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 */
- #ifdef BCMUSBDEV_ENABLED
- extern uint32 gFWID;
- #endif
- #endif /* _bcmdefs_h_ */