freebsd-dev/sys/dev/bhnd/bcma/bcma_dmp.h
Michael Zhilin ba3eb10d85 [BHND] correct spelling error in macro name
This commit is part of D6920 review. One of macro had wrong prefix:
 BMCA => BCMA

Reviewed by:	landonf, adrian (mentor)
Approved by:	adrian (mentor)
Differential Revision:	https://reviews.freebsd.org/D6920
2016-11-15 20:05:22 +00:00

266 lines
9.7 KiB
C

/*-
* Copyright (c) 2015 Landon Fuller <landon@landonf.org>
* Copyright (c) 2010 Broadcom Corporation
*
* Portions of this file were derived from the aidmp.h header
* distributed with Broadcom's initial brcm80211 Linux driver release, as
* contributed to the Linux staging repository.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* $FreeBSD$
*/
#ifndef _BCMA_BCMA_DMP_H_
#define _BCMA_BCMA_DMP_H_
/*
* PL-368 Device Management Plugin (DMP) Registers & Constants
*
* The "DMP" core used in Broadcom HND devices has been described
* by Broadcom engineers (and in published header files) as being
* ARM's PL-368 "Device Management Plugin" system IP, included with
* the CoreLink AMBA Designer tooling.
*
* Documentation for the PL-368 is not publicly available, however,
* and the only public reference by ARM to its existence appears to be
* in the proprietary "NIC-301 Interconnect Device Management (PL368)"
* errata publication, available to licensees as part of ARM's
* CoreLink Controllers and Peripherals Engineering Errata.
*
* As such, the exact interpretation of these register definitions is
* unconfirmed, and may be incorrect.
*/
#define BCMA_DMP_GET_FLAG(_value, _flag) \
(((_value) & _flag) != 0)
#define BCMA_DMP_GET_BITS(_value, _field) \
((_value & _field ## _MASK) >> _field ## _SHIFT)
#define BHND_DMP_SET_BITS(_value, _field) \
(((_value) << _field ## _SHIFT) & _field ## _MASK)
/* Out-of-band Router registers */
#define BCMA_OOB_BUSCONFIG 0x020
#define BCMA_OOB_STATUSA 0x100
#define BCMA_OOB_STATUSB 0x104
#define BCMA_OOB_STATUSC 0x108
#define BCMA_OOB_STATUSD 0x10c
#define BCMA_OOB_ENABLEA0 0x200
#define BCMA_OOB_ENABLEA1 0x204
#define BCMA_OOB_ENABLEA2 0x208
#define BCMA_OOB_ENABLEA3 0x20c
#define BCMA_OOB_ENABLEB0 0x280
#define BCMA_OOB_ENABLEB1 0x284
#define BCMA_OOB_ENABLEB2 0x288
#define BCMA_OOB_ENABLEB3 0x28c
#define BCMA_OOB_ENABLEC0 0x300
#define BCMA_OOB_ENABLEC1 0x304
#define BCMA_OOB_ENABLEC2 0x308
#define BCMA_OOB_ENABLEC3 0x30c
#define BCMA_OOB_ENABLED0 0x380
#define BCMA_OOB_ENABLED1 0x384
#define BCMA_OOB_ENABLED2 0x388
#define BCMA_OOB_ENABLED3 0x38c
#define BCMA_OOB_ITCR 0xf00
#define BCMA_OOB_ITIPOOBA 0xf10
#define BCMA_OOB_ITIPOOBB 0xf14
#define BCMA_OOB_ITIPOOBC 0xf18
#define BCMA_OOB_ITIPOOBD 0xf1c
#define BCMA_OOB_ITOPOOBA 0xf30
#define BCMA_OOB_ITOPOOBB 0xf34
#define BCMA_OOB_ITOPOOBC 0xf38
#define BCMA_OOB_ITOPOOBD 0xf3c
/* Common definitions */
#define BCMA_OOB_NUM_BANKS 4 /**< number of OOB banks (A, B, C, D) */
#define BCMA_OOB_NUM_SEL 8 /**< number of OOB selectors per bank */
#define BCMA_OOB_NUM_BUSLINES 32 /**< number of bus lines managed by OOB core */
#define BCMA_OOB_BANKA 0 /**< bank A index */
#define BCMA_OOB_BANKB 1 /**< bank B index */
#define BCMA_OOB_BANKC 2 /**< bank C index */
#define BCMA_OOB_BANKD 3 /**< bank D index */
/** OOB bank used for interrupt lines */
#define BCMA_OOB_BANK_INTR BCMA_OOB_BANKA
/* DMP agent registers */
#define BCMA_DMP_OOBSELINA30 0x000 /**< A0-A3 input selectors */
#define BCMA_DMP_OOBSELINA74 0x004 /**< A4-A7 input selectors */
#define BCMA_DMP_OOBSELINB30 0x020 /**< B0-B3 input selectors */
#define BCMA_DMP_OOBSELINB74 0x024 /**< B4-B7 input selectors */
#define BCMA_DMP_OOBSELINC30 0x040 /**< C0-C3 input selectors */
#define BCMA_DMP_OOBSELINC74 0x044 /**< C4-C7 input selectors */
#define BCMA_DMP_OOBSELIND30 0x060 /**< D0-D3 input selectors */
#define BCMA_DMP_OOBSELIND74 0x064 /**< D4-D7 input selectors */
#define BCMA_DMP_OOBSELOUTA30 0x100 /**< A0-A3 output selectors */
#define BCMA_DMP_OOBSELOUTA74 0x104 /**< A4-A7 output selectors */
#define BCMA_DMP_OOBSELOUTB30 0x120 /**< B0-B3 output selectors */
#define BCMA_DMP_OOBSELOUTB74 0x124 /**< B4-B7 output selectors */
#define BCMA_DMP_OOBSELOUTC30 0x140 /**< C0-C3 output selectors */
#define BCMA_DMP_OOBSELOUTC74 0x144 /**< C4-C7 output selectors */
#define BCMA_DMP_OOBSELOUTD30 0x160 /**< D0-D3 output selectors */
#define BCMA_DMP_OOBSELOUTD74 0x164 /**< D4-D7 output selectors */
#define BCMA_DMP_OOBSYNCA 0x200
#define BCMA_DMP_OOBSELOUTAEN 0x204
#define BCMA_DMP_OOBSYNCB 0x220
#define BCMA_DMP_OOBSELOUTBEN 0x224
#define BCMA_DMP_OOBSYNCC 0x240
#define BCMA_DMP_OOBSELOUTCEN 0x244
#define BCMA_DMP_OOBSYNCD 0x260
#define BCMA_DMP_OOBSELOUTDEN 0x264
#define BCMA_DMP_OOBAEXTWIDTH 0x300
#define BCMA_DMP_OOBAINWIDTH 0x304
#define BCMA_DMP_OOBAOUTWIDTH 0x308
#define BCMA_DMP_OOBBEXTWIDTH 0x320
#define BCMA_DMP_OOBBINWIDTH 0x324
#define BCMA_DMP_OOBBOUTWIDTH 0x328
#define BCMA_DMP_OOBCEXTWIDTH 0x340
#define BCMA_DMP_OOBCINWIDTH 0x344
#define BCMA_DMP_OOBCOUTWIDTH 0x348
#define BCMA_DMP_OOBDEXTWIDTH 0x360
#define BCMA_DMP_OOBDINWIDTH 0x364
#define BCMA_DMP_OOBDOUTWIDTH 0x368
#define BCMA_DMP_OOBSEL(_base, _bank, _sel) \
(_base + (_bank * 8) + (_sel >= 4 ? 4 : 0))
#define BCMA_DMP_OOBSELIN(_bank, _sel) \
BCMA_DMP_OOBSEL(BCMA_DMP_OOBSELINA30, _bank, _sel)
#define BCMA_DMP_OOBSELOUT(_bank, _sel) \
BCMA_DMP_OOBSEL(BCMA_DMP_OOBSELOUTA30, _bank, _sel)
#define BCMA_DMP_OOBSYNC(_bank) (BCMA_DMP_OOBSYNCA + (_bank * 8))
#define BCMA_DMP_OOBSELOUT_EN(_bank) (BCMA_DMP_OOBSELOUTAEN + (_bank * 8))
#define BCMA_DMP_OOB_EXTWIDTH(_bank) (BCMA_DMP_OOBAEXTWIDTH + (_bank * 12))
#define BCMA_DMP_OOB_INWIDTH(_bank) (BCMA_DMP_OOBAINWIDTH + (_bank * 12))
#define BCMA_DMP_OOB_OUTWIDTH(_bank) (BCMA_DMP_OOBAOUTWIDTH + (_bank * 12))
// This was inherited from Broadcom's aidmp.h header
// Is it required for any of our use-cases?
#if 0 /* defined(IL_BIGENDIAN) && defined(BCMHND74K) */
/* Selective swapped defines for those registers we need in
* big-endian code.
*/
#define BCMA_DMP_IOCTRLSET 0x404
#define BCMA_DMP_IOCTRLCLEAR 0x400
#define BCMA_DMP_IOCTRL 0x40c
#define BCMA_DMP_IOSTATUS 0x504
#define BCMA_DMP_RESETCTRL 0x804
#define BCMA_DMP_RESETSTATUS 0x800
#else /* !IL_BIGENDIAN || !BCMHND74K */
#define BCMA_DMP_IOCTRLSET 0x400
#define BCMA_DMP_IOCTRLCLEAR 0x404
#define BCMA_DMP_IOCTRL 0x408
#define BCMA_DMP_IOSTATUS 0x500
#define BCMA_DMP_RESETCTRL 0x800
#define BCMA_DMP_RESETSTATUS 0x804
#endif /* IL_BIGENDIAN && BCMHND74K */
#define BCMA_DMP_IOCTRLWIDTH 0x700
#define BCMA_DMP_IOSTATUSWIDTH 0x704
#define BCMA_DMP_RESETREADID 0x808
#define BCMA_DMP_RESETWRITEID 0x80c
#define BCMA_DMP_ERRLOGCTRL 0xa00
#define BCMA_DMP_ERRLOGDONE 0xa04
#define BCMA_DMP_ERRLOGSTATUS 0xa08
#define BCMA_DMP_ERRLOGADDRLO 0xa0c
#define BCMA_DMP_ERRLOGADDRHI 0xa10
#define BCMA_DMP_ERRLOGID 0xa14
#define BCMA_DMP_ERRLOGUSER 0xa18
#define BCMA_DMP_ERRLOGFLAGS 0xa1c
#define BCMA_DMP_INTSTATUS 0xa00
#define BCMA_DMP_CONFIG 0xe00
#define BCMA_DMP_ITCR 0xf00
#define BCMA_DMP_ITIPOOBA 0xf10
#define BCMA_DMP_ITIPOOBB 0xf14
#define BCMA_DMP_ITIPOOBC 0xf18
#define BCMA_DMP_ITIPOOBD 0xf1c
#define BCMA_DMP_ITIPOOBAOUT 0xf30
#define BCMA_DMP_ITIPOOBBOUT 0xf34
#define BCMA_DMP_ITIPOOBCOUT 0xf38
#define BCMA_DMP_ITIPOOBDOUT 0xf3c
#define BCMA_DMP_ITOPOOBA 0xf50
#define BCMA_DMP_ITOPOOBB 0xf54
#define BCMA_DMP_ITOPOOBC 0xf58
#define BCMA_DMP_ITOPOOBD 0xf5c
#define BCMA_DMP_ITOPOOBAIN 0xf70
#define BCMA_DMP_ITOPOOBBIN 0xf74
#define BCMA_DMP_ITOPOOBCIN 0xf78
#define BCMA_DMP_ITOPOOBDIN 0xf7c
#define BCMA_DMP_ITOPRESET 0xf90
#define BCMA_DMP_PERIPHERIALID4 0xfd0
#define BCMA_DMP_PERIPHERIALID5 0xfd4
#define BCMA_DMP_PERIPHERIALID6 0xfd8
#define BCMA_DMP_PERIPHERIALID7 0xfdc
#define BCMA_DMP_PERIPHERIALID0 0xfe0
#define BCMA_DMP_PERIPHERIALID1 0xfe4
#define BCMA_DMP_PERIPHERIALID2 0xfe8
#define BCMA_DMP_PERIPHERIALID3 0xfec
#define BCMA_DMP_COMPONENTID0 0xff0
#define BCMA_DMP_COMPONENTID1 0xff4
#define BCMA_DMP_COMPONENTID2 0xff8
#define BCMA_DMP_COMPONENTID3 0xffc
/* OOBSEL(IN|OUT) */
#define BCMA_DMP_OOBSEL_MASK 0xFF /**< OOB selector mask */
#define BCMA_DMP_OOBSEL_EN (1<<7) /**< OOB selector enable bit */
#define BCMA_DMP_OOBSEL_SHIFT(_sel) ((_sel % BCMA_OOB_NUM_SEL) * 8)
#define BCMA_DMP_OOBSEL_BUSLINE_MASK 0x7F /**< OOB selector bus line mask */
#define BCMA_DMP_OOBSEL_BUSLINE_SHIFT 0
#define BCMA_DMP_OOBSEL_0_MASK BCMA_DMP_OOBSEL_MASK
#define BCMA_DMP_OOBSEL_1_MASK BCMA_DMP_OOBSEL_MASK
#define BCMA_DMP_OOBSEL_2_MASK BCMA_DMP_OOBSEL_MASK
#define BCMA_DMP_OOBSEL_3_MASK BCMA_DMP_OOBSEL_MASK
#define BCMA_DMP_OOBSEL_4_MASK BCMA_DMP_OOBSEL_MASK
#define BCMA_DMP_OOBSEL_5_MASK BCMA_DMP_OOBSEL_MASK
#define BCMA_DMP_OOBSEL_6_MASK BCMA_DMP_OOBSEL_MASK
#define BCMA_DMP_OOBSEL_7_MASK BCMA_DMP_OOBSEL_MASK
#define BCMA_DMP_OOBSEL_0_SHIFT BCMA_DMP_OOBSEL_SHIFT(0)
#define BCMA_DMP_OOBSEL_1_SHIFT BCMA_DMP_OOBSEL_SHIFT(1)
#define BCMA_DMP_OOBSEL_2_SHIFT BCMA_DMP_OOBSEL_SHIFT(2)
#define BCMA_DMP_OOBSEL_3_SHIFT BCMA_DMP_OOBSEL_SHIFT(3)
#define BCMA_DMP_OOBSEL_4_SHIFT BCMA_DMP_OOBSEL_0_SHIFT
#define BCMA_DMP_OOBSEL_5_SHIFT BCMA_DMP_OOBSEL_1_SHIFT
#define BCMA_DMP_OOBSEL_6_SHIFT BCMA_DMP_OOBSEL_2_SHIFT
#define BCMA_DMP_OOBSEL_7_SHIFT BCMA_DMP_OOBSEL_3_SHIFT
/* ioctrl */
#define BCMA_DMP_IOCTRL_MASK 0x0000FFFF
/* iostatus */
#define BCMA_DMP_IOST_MASK 0x0000FFFF
/* resetctrl */
#define BCMA_DMP_RC_RESET 0x00000001
/* config */
#define BCMA_DMP_CFG_OOB 0x00000020
#define BCMA_DMP_CFG_IOS 0x00000010
#define BCMA_DMP_CFGIOC 0x00000008
#define BCMA_DMP_CFGTO 0x00000004
#define BCMA_DMP_CFGERRL 0x00000002
#define BCMA_DMP_CFGRST 0x00000001
#endif /* _BCMA_BCMA_DMP_H_ */