blob: 1f8ea6f411ee2c96bee91ee55b7aabc873316d4c [file] [log] [blame]
/*
* OS Abstraction Layer
*
* Copyright (C) 1999-2016, 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.
*
*
* <<Broadcom-WL-IPTag/Open:>>
*
* $Id: osl.h 585315 2015-09-10 06:02:11Z $
*/
#ifndef _osl_h_
#define _osl_h_
#include <osl_decl.h>
#define OSL_PKTTAG_SZ 32 /* Size of PktTag */
/* Drivers use PKTFREESETCB to register a callback function when a packet is freed by OSL */
typedef void (*pktfree_cb_fn_t)(void *ctx, void *pkt, unsigned int status);
/* Drivers use REGOPSSET() to register register read/write funcitons */
typedef unsigned int (*osl_rreg_fn_t)(void *ctx, volatile void *reg, unsigned int size);
typedef void (*osl_wreg_fn_t)(void *ctx, volatile void *reg, unsigned int val, unsigned int size);
#ifdef __mips__
#define PREF_LOAD 0
#define PREF_STORE 1
#define PREF_LOAD_STREAMED 4
#define PREF_STORE_STREAMED 5
#define PREF_LOAD_RETAINED 6
#define PREF_STORE_RETAINED 7
#define PREF_WBACK_INV 25
#define PREF_PREPARE4STORE 30
#define MAKE_PREFETCH_FN(hint) \
static inline void prefetch_##hint(const void *addr) \
{ \
__asm__ __volatile__(\
" .set mips4 \n" \
" pref %0, (%1) \n" \
" .set mips0 \n" \
: \
: "i" (hint), "r" (addr)); \
}
#define MAKE_PREFETCH_RANGE_FN(hint) \
static inline void prefetch_range_##hint(const void *addr, int len) \
{ \
int size = len; \
while (size > 0) { \
prefetch_##hint(addr); \
size -= 32; \
} \
}
MAKE_PREFETCH_FN(PREF_LOAD)
MAKE_PREFETCH_RANGE_FN(PREF_LOAD)
MAKE_PREFETCH_FN(PREF_STORE)
MAKE_PREFETCH_RANGE_FN(PREF_STORE)
MAKE_PREFETCH_FN(PREF_LOAD_STREAMED)
MAKE_PREFETCH_RANGE_FN(PREF_LOAD_STREAMED)
MAKE_PREFETCH_FN(PREF_STORE_STREAMED)
MAKE_PREFETCH_RANGE_FN(PREF_STORE_STREAMED)
MAKE_PREFETCH_FN(PREF_LOAD_RETAINED)
MAKE_PREFETCH_RANGE_FN(PREF_LOAD_RETAINED)
MAKE_PREFETCH_FN(PREF_STORE_RETAINED)
MAKE_PREFETCH_RANGE_FN(PREF_STORE_RETAINED)
#endif /* __mips__ */
#if defined(WL_UNITTEST)
#include <utest_osl.h>
#else
#include <linux_osl.h>
#endif
#ifndef PKTDBG_TRACE
#define PKTDBG_TRACE(osh, pkt, bit) BCM_REFERENCE(osh)
#endif
#define PKTCTFMAP(osh, p) BCM_REFERENCE(osh)
/* --------------------------------------------------------------------------
** Register manipulation macros.
*/
#define SET_REG(osh, r, mask, val) W_REG((osh), (r), ((R_REG((osh), r) & ~(mask)) | (val)))
#ifndef AND_REG
#define AND_REG(osh, r, v) W_REG(osh, (r), R_REG(osh, r) & (v))
#endif /* !AND_REG */
#ifndef OR_REG
#define OR_REG(osh, r, v) W_REG(osh, (r), R_REG(osh, r) | (v))
#endif /* !OR_REG */
#ifdef CONFIG_DHD_USE_STATIC_BUF
void* dhd_wlan_mem_prealloc(int section, unsigned long size);
#endif
#if !defined(OSL_SYSUPTIME)
#define OSL_SYSUPTIME() (0)
#define OSL_SYSUPTIME_SUPPORT FALSE
#else
#define OSL_SYSUPTIME_SUPPORT TRUE
#endif /* OSL_SYSUPTIME */
#ifndef OSL_SYS_HALT
#define OSL_SYS_HALT() do {} while (0)
#endif
#ifndef OSL_MEM_AVAIL
#define OSL_MEM_AVAIL() (0xffffffff)
#endif
#if !defined(PKTC) && !defined(PKTC_DONGLE)
#define PKTCGETATTR(skb) (0)
#define PKTCSETATTR(skb, f, p, b) BCM_REFERENCE(skb)
#define PKTCCLRATTR(skb) BCM_REFERENCE(skb)
#define PKTCCNT(skb) (1)
#define PKTCLEN(skb) PKTLEN(NULL, skb)
#define PKTCGETFLAGS(skb) (0)
#define PKTCSETFLAGS(skb, f) BCM_REFERENCE(skb)
#define PKTCCLRFLAGS(skb) BCM_REFERENCE(skb)
#define PKTCFLAGS(skb) (0)
#define PKTCSETCNT(skb, c) BCM_REFERENCE(skb)
#define PKTCINCRCNT(skb) BCM_REFERENCE(skb)
#define PKTCADDCNT(skb, c) BCM_REFERENCE(skb)
#define PKTCSETLEN(skb, l) BCM_REFERENCE(skb)
#define PKTCADDLEN(skb, l) BCM_REFERENCE(skb)
#define PKTCSETFLAG(skb, fb) BCM_REFERENCE(skb)
#define PKTCCLRFLAG(skb, fb) BCM_REFERENCE(skb)
#define PKTCLINK(skb) NULL
#define PKTSETCLINK(skb, x) BCM_REFERENCE(skb)
#define FOREACH_CHAINED_PKT(skb, nskb) \
for ((nskb) = NULL; (skb) != NULL; (skb) = (nskb))
#define PKTCFREE PKTFREE
#define PKTCENQTAIL(h, t, p) \
do { \
if ((t) == NULL) { \
(h) = (t) = (p); \
} \
} while (0)
#endif /* !linux || !PKTC */
#if !defined(HNDCTF) && !defined(PKTC_TX_DONGLE)
#define PKTSETCHAINED(osh, skb) BCM_REFERENCE(osh)
#define PKTCLRCHAINED(osh, skb) BCM_REFERENCE(osh)
#define PKTISCHAINED(skb) FALSE
#endif
/* Lbuf with fraglist */
#define PKTFRAGPKTID(osh, lb) (0)
#define PKTSETFRAGPKTID(osh, lb, id) BCM_REFERENCE(osh)
#define PKTFRAGTOTNUM(osh, lb) (0)
#define PKTSETFRAGTOTNUM(osh, lb, tot) BCM_REFERENCE(osh)
#define PKTFRAGTOTLEN(osh, lb) (0)
#define PKTSETFRAGTOTLEN(osh, lb, len) BCM_REFERENCE(osh)
#define PKTIFINDEX(osh, lb) (0)
#define PKTSETIFINDEX(osh, lb, idx) BCM_REFERENCE(osh)
#define PKTGETLF(osh, len, send, lbuf_type) (0)
/* in rx path, reuse totlen as used len */
#define PKTFRAGUSEDLEN(osh, lb) (0)
#define PKTSETFRAGUSEDLEN(osh, lb, len) BCM_REFERENCE(osh)
#define PKTFRAGLEN(osh, lb, ix) (0)
#define PKTSETFRAGLEN(osh, lb, ix, len) BCM_REFERENCE(osh)
#define PKTFRAGDATA_LO(osh, lb, ix) (0)
#define PKTSETFRAGDATA_LO(osh, lb, ix, addr) BCM_REFERENCE(osh)
#define PKTFRAGDATA_HI(osh, lb, ix) (0)
#define PKTSETFRAGDATA_HI(osh, lb, ix, addr) BCM_REFERENCE(osh)
/* RX FRAG */
#define PKTISRXFRAG(osh, lb) (0)
#define PKTSETRXFRAG(osh, lb) BCM_REFERENCE(osh)
#define PKTRESETRXFRAG(osh, lb) BCM_REFERENCE(osh)
/* TX FRAG */
#define PKTISTXFRAG(osh, lb) (0)
#define PKTSETTXFRAG(osh, lb) BCM_REFERENCE(osh)
/* Need Rx completion used for AMPDU reordering */
#define PKTNEEDRXCPL(osh, lb) (TRUE)
#define PKTSETNORXCPL(osh, lb) BCM_REFERENCE(osh)
#define PKTRESETNORXCPL(osh, lb) BCM_REFERENCE(osh)
#define PKTISFRAG(osh, lb) (0)
#define PKTFRAGISCHAINED(osh, i) (0)
/* TRIM Tail bytes from lfrag */
#define PKTFRAG_TRIM_TAILBYTES(osh, p, len, type) PKTSETLEN(osh, p, PKTLEN(osh, p) - len)
#ifdef BCM_SECURE_DMA
#define SECURE_DMA_ENAB(osh) (1)
#else
#define SECURE_DMA_ENAB(osh) (0)
#define SECURE_DMA_MAP(osh, va, size, direction, p, dmah, pcma, offset) ((dmaaddr_t) {(0)})
#define SECURE_DMA_DD_MAP(osh, va, size, direction, p, dmah) 0
#define SECURE_DMA_MAP_TXMETA(osh, va, size, direction, p, dmah, pcma) ((dmaaddr_t) {(0)})
#define SECURE_DMA_UNMAP(osh, pa, size, direction, p, dmah, pcma, offset)
#define SECURE_DMA_UNMAP_ALL(osh, pcma)
#endif
#endif /* _osl_h_ */