• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Broadcom HND chip & on-chip-interconnect-related definitions.
4  *
5  * Copyright (C) 1999-2019, Broadcom.
6  *
7  *      Unless you and Broadcom execute a separate written software license
8  * agreement governing use of this software, this software is licensed to you
9  * under the terms of the GNU General Public License version 2 (the "GPL"),
10  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
11  * following added to such license:
12  *
13  *      As a special exception, the copyright holders of this software give you
14  * permission to link this software with independent modules, and to copy and
15  * distribute the resulting executable under terms of your choice, provided that
16  * you also meet, for each linked independent module, the terms and conditions of
17  * the license of that module.  An independent module is a module which is not
18  * derived from this software.  The special exception does not apply to any
19  * modifications of the software.
20  *
21  *      Notwithstanding the above, under no circumstances may you combine this
22  * software in any way with any other Broadcom software provided under a license
23  * other than the GPL, without Broadcom's express prior written consent.
24  *
25  *
26  * <<Broadcom-WL-IPTag/Open:>>
27  *
28  * $Id: hndsoc.h 795345 2018-12-18 16:52:03Z $
29  */
30 
31 #ifndef	_HNDSOC_H
32 #define	_HNDSOC_H
33 
34 /* Include the soci specific files */
35 #include <sbconfig.h>
36 #include <aidmp.h>
37 
38 /*
39  * SOC Interconnect Address Map.
40  * All regions may not exist on all chips.
41  */
42 #define SI_SDRAM_BASE		0x00000000	/* Physical SDRAM */
43 #define SI_PCI_MEM		0x08000000	/* Host Mode sb2pcitranslation0 (64 MB) */
44 #define SI_PCI_MEM_SZ		(64 * 1024 * 1024)
45 #define SI_PCI_CFG		0x0c000000	/* Host Mode sb2pcitranslation1 (64 MB) */
46 #define	SI_SDRAM_SWAPPED	0x10000000	/* Byteswapped Physical SDRAM */
47 #define SI_SDRAM_R2		0x80000000	/* Region 2 for sdram (512 MB) */
48 
49 #ifdef STB_SOC_WIFI
50 #define SI_REG_BASE_SIZE	0xB000		/* size from 0xf1800000 to 0xf180AFFF (44KB) */
51 #define SI_ENUM_BASE_DEFAULT		0xF1800000	/* Enumeration space base */
52 #define SI_WRAP_BASE_DEFAULT		0xF1900000	/* Wrapper space base */
53 #endif /* STB_SOC_WIFI */
54 
55 #ifndef SI_ENUM_BASE_DEFAULT
56 #define SI_ENUM_BASE_DEFAULT		0x18000000	/* Enumeration space base */
57 #endif // endif
58 
59 #ifndef SI_WRAP_BASE_DEFAULT
60 #define SI_WRAP_BASE_DEFAULT		0x18100000	/* Wrapper space base */
61 #endif // endif
62 
63 /** new(er) chips started locating their chipc core at a different BP address than 0x1800_0000 */
64 // NIC and DHD driver binaries should support both old(er) and new(er) chips at the same time
65 #define SI_ENUM_BASE(sih)	((sih)->enum_base)
66 #define SI_WRAP_BASE(sih)	(SI_ENUM_BASE(sih) + 0x00100000)
67 
68 #define SI_CORE_SIZE		0x1000		/* each core gets 4Kbytes for registers */
69 
70 #define SI_NIC400_GPV_BASE	0x18200000	/* NIC-400 Global Programmers View (GPV) */
71 #define SI_GPV_WR_CAP_ADDR	0x4008	/* WR-CAP offset */
72 #define SI_GPV_RD_CAP_EN	0x1	/* issue read */
73 #define SI_GPV_WR_CAP_EN	0x2	/* issue write */
74 
75 #ifndef SI_MAXCORES
76 #define	SI_MAXCORES		32		/* NorthStar has more cores */
77 #endif /* SI_MAXCORES */
78 
79 #define	SI_MAXBR		4		/* Max bridges (this is arbitrary, for software
80 					 * convenience and could be changed if we
81 					 * make any larger chips
82 					 */
83 
84 #define	SI_FASTRAM		0x19000000	/* On-chip RAM on chips that also have DDR */
85 #define	SI_FASTRAM_SWAPPED	0x19800000
86 
87 #define	SI_FLASH2		0x1c000000	/* Flash Region 2 (region 1 shadowed here) */
88 #define	SI_FLASH2_SZ		0x02000000	/* Size of Flash Region 2 */
89 #define	SI_ARMCM3_ROM		0x1e000000	/* ARM Cortex-M3 ROM */
90 #define	SI_FLASH1		0x1fc00000	/* MIPS Flash Region 1 */
91 #define	SI_FLASH1_SZ		0x00400000	/* MIPS Size of Flash Region 1 */
92 #define	SI_FLASH_WINDOW		0x01000000	/* Flash XIP Window */
93 
94 #define SI_NS_NANDFLASH		0x1c000000	/* NorthStar NAND flash base */
95 #define SI_NS_NORFLASH		0x1e000000	/* NorthStar NOR flash base */
96 #define SI_NS_ROM		0xfffd0000	/* NorthStar ROM */
97 #define	SI_NS_FLASH_WINDOW	0x02000000	/* Flash XIP Window */
98 
99 #define	SI_ARM7S_ROM		0x20000000	/* ARM7TDMI-S ROM */
100 #define	SI_ARMCR4_ROM		0x000f0000	/* ARM Cortex-R4 ROM */
101 #define	SI_ARMCM3_SRAM2		0x60000000	/* ARM Cortex-M3 SRAM Region 2 */
102 #define	SI_ARM7S_SRAM2		0x80000000	/* ARM7TDMI-S SRAM Region 2 */
103 #define	SI_ARMCA7_ROM		0x00000000	/* ARM Cortex-A7 ROM */
104 #ifndef SI_ARMCA7_RAM
105 #define	SI_ARMCA7_RAM		0x00200000	/* ARM Cortex-A7 RAM */
106 #endif // endif
107 #define	SI_ARM_FLASH1		0xffff0000	/* ARM Flash Region 1 */
108 #define	SI_ARM_FLASH1_SZ	0x00010000	/* ARM Size of Flash Region 1 */
109 
110 #define SI_SFLASH		0x14000000
111 #define SI_PCI_DMA		0x40000000	/* Client Mode sb2pcitranslation2 (1 GB) */
112 #define SI_PCI_DMA2		0x80000000	/* Client Mode sb2pcitranslation2 (1 GB) */
113 #define SI_PCI_DMA_SZ		0x40000000	/* Client Mode sb2pcitranslation2 size in bytes */
114 #define SI_PCIE_DMA_L32		0x00000000	/* PCIE Client Mode sb2pcitranslation2
115 						 * (2 ZettaBytes), low 32 bits
116 						 */
117 #define SI_PCIE_DMA_H32		0x80000000	/* PCIE Client Mode sb2pcitranslation2
118 						 * (2 ZettaBytes), high 32 bits
119 						 */
120 
121 #define SI_BCM53573_NANDFLASH	0x30000000	/* 53573 NAND flash base */
122 #define SI_BCM53573_NORFLASH	0x1c000000	/* 53573 NOR flash base */
123 #define SI_BCM53573_FLASH2_SZ	0x04000000	/* 53573 NOR flash2 size */
124 
125 #define	SI_BCM53573_NORFLASH_WINDOW	0x01000000	/* only support 16M direct access for
126 							 * 3-byte address modes in spi flash
127 							 */
128 #define	SI_BCM53573_BOOTDEV_MASK	0x3
129 #define	SI_BCM53573_BOOTDEV_NOR		0x0
130 
131 #define SI_BCM53573_NAND_PRE_MASK	0x100	/* 53573 NAND present mask */
132 
133 #define	SI_BCM53573_DDRTYPE_MASK	0x10
134 #define	SI_BCM53573_DDRTYPE_DDR3	0x10
135 
136 #define	SI_BCM47189_RGMII_VDD_MASK	0x3
137 #define	SI_BCM47189_RGMII_VDD_SHIFT	21
138 #define	SI_BCM47189_RGMII_VDD_3_3V	0
139 #define	SI_BCM47189_RGMII_VDD_2_5V	1
140 #define	SI_BCM47189_RGMII_VDD_1_5V	1
141 
142 #define	SI_BCM53573_LOCKED_CPUPLL	0x1
143 
144 /* APB bridge code */
145 #define	APB_BRIDGE_ID		0x135		/* APB Bridge 0, 1, etc. */
146 
147 /* core codes */
148 #define	NODEV_CORE_ID		0x700		/* Invalid coreid */
149 #define	CC_CORE_ID		0x800		/* chipcommon core */
150 #define	ILINE20_CORE_ID		0x801		/* iline20 core */
151 #define	SRAM_CORE_ID		0x802		/* sram core */
152 #define	SDRAM_CORE_ID		0x803		/* sdram core */
153 #define	PCI_CORE_ID		0x804		/* pci core */
154 #define	MIPS_CORE_ID		0x805		/* mips core */
155 #define	ENET_CORE_ID		0x806		/* enet mac core */
156 #define	CODEC_CORE_ID		0x807		/* v90 codec core */
157 #define	USB_CORE_ID		0x808		/* usb 1.1 host/device core */
158 #define	ADSL_CORE_ID		0x809		/* ADSL core */
159 #define	ILINE100_CORE_ID	0x80a		/* iline100 core */
160 #define	IPSEC_CORE_ID		0x80b		/* ipsec core */
161 #define	UTOPIA_CORE_ID		0x80c		/* utopia core */
162 #define	PCMCIA_CORE_ID		0x80d		/* pcmcia core */
163 #define	SOCRAM_CORE_ID		0x80e		/* internal memory core */
164 #define	MEMC_CORE_ID		0x80f		/* memc sdram core */
165 #define	OFDM_CORE_ID		0x810		/* OFDM phy core */
166 #define	EXTIF_CORE_ID		0x811		/* external interface core */
167 #define	D11_CORE_ID		0x812		/* 802.11 MAC core */
168 #define	APHY_CORE_ID		0x813		/* 802.11a phy core */
169 #define	BPHY_CORE_ID		0x814		/* 802.11b phy core */
170 #define	GPHY_CORE_ID		0x815		/* 802.11g phy core */
171 #define	MIPS33_CORE_ID		0x816		/* mips3302 core */
172 #define	USB11H_CORE_ID		0x817		/* usb 1.1 host core */
173 #define	USB11D_CORE_ID		0x818		/* usb 1.1 device core */
174 #define	USB20H_CORE_ID		0x819		/* usb 2.0 host core */
175 #define	USB20D_CORE_ID		0x81a		/* usb 2.0 device core */
176 #define	SDIOH_CORE_ID		0x81b		/* sdio host core */
177 #define	ROBO_CORE_ID		0x81c		/* roboswitch core */
178 #define	ATA100_CORE_ID		0x81d		/* parallel ATA core */
179 #define	SATAXOR_CORE_ID		0x81e		/* serial ATA & XOR DMA core */
180 #define	GIGETH_CORE_ID		0x81f		/* gigabit ethernet core */
181 #define	PCIE_CORE_ID		0x820		/* pci express core */
182 #define	NPHY_CORE_ID		0x821		/* 802.11n 2x2 phy core */
183 #define	SRAMC_CORE_ID		0x822		/* SRAM controller core */
184 #define	MINIMAC_CORE_ID		0x823		/* MINI MAC/phy core */
185 #define	ARM11_CORE_ID		0x824		/* ARM 1176 core */
186 #define	ARM7S_CORE_ID		0x825		/* ARM7tdmi-s core */
187 #define	LPPHY_CORE_ID		0x826		/* 802.11a/b/g phy core */
188 #define	PMU_CORE_ID		0x827		/* PMU core */
189 #define	SSNPHY_CORE_ID		0x828		/* 802.11n single-stream phy core */
190 #define	SDIOD_CORE_ID		0x829		/* SDIO device core */
191 #define	ARMCM3_CORE_ID		0x82a		/* ARM Cortex M3 core */
192 #define	HTPHY_CORE_ID		0x82b		/* 802.11n 4x4 phy core */
193 #define	MIPS74K_CORE_ID		0x82c		/* mips 74k core */
194 #define	GMAC_CORE_ID		0x82d		/* Gigabit MAC core */
195 #define	DMEMC_CORE_ID		0x82e		/* DDR1/2 memory controller core */
196 #define	PCIERC_CORE_ID		0x82f		/* PCIE Root Complex core */
197 #define	OCP_CORE_ID		0x830		/* OCP2OCP bridge core */
198 #define	SC_CORE_ID		0x831		/* shared common core */
199 #define	AHB_CORE_ID		0x832		/* OCP2AHB bridge core */
200 #define	SPIH_CORE_ID		0x833		/* SPI host core */
201 #define	I2S_CORE_ID		0x834		/* I2S core */
202 #define	DMEMS_CORE_ID		0x835		/* SDR/DDR1 memory controller core */
203 #define	DEF_SHIM_COMP		0x837		/* SHIM component in ubus/6362 */
204 
205 #define ACPHY_CORE_ID		0x83b		/* Dot11 ACPHY */
206 #define PCIE2_CORE_ID		0x83c		/* pci express Gen2 core */
207 #define USB30D_CORE_ID		0x83d		/* usb 3.0 device core */
208 #define ARMCR4_CORE_ID		0x83e		/* ARM CR4 CPU */
209 #define GCI_CORE_ID		0x840		/* GCI Core */
210 #define SR_CORE_ID		0x841		/* SR_CORE ID */
211 #define M2MDMA_CORE_ID          0x844           /* memory to memory dma */
212 #define CMEM_CORE_ID		0x846		/* CNDS DDR2/3 memory controller */
213 #define ARMCA7_CORE_ID		0x847		/* ARM CA7 CPU */
214 #define SYSMEM_CORE_ID		0x849		/* System memory core */
215 #define HUB_CORE_ID		0x84b           /* Hub core ID */
216 #define HND_OOBR_CORE_ID        0x85c           /* Hnd oob router core ID */
217 #define APB_BRIDGE_CORE_ID	0x135		/* APB bridge core ID */
218 #define AXI_CORE_ID		0x301		/* AXI/GPV core ID */
219 #define EROM_CORE_ID		0x366		/* EROM core ID */
220 #define OOB_ROUTER_CORE_ID	0x367		/* OOB router core ID */
221 #define DEF_AI_COMP		0xfff		/* Default component, in ai chips it maps all
222 						 * unused address ranges
223 						 */
224 
225 #define NS_PCIEG2_CORE_ID	0x501		/* PCIE Gen 2 core */
226 #define NS_DMA_CORE_ID		0x502		/* DMA core */
227 #define NS_SDIO3_CORE_ID	0x503		/* SDIO3 core */
228 #define NS_USB20_CORE_ID	0x504		/* USB2.0 core */
229 #define NS_USB30_CORE_ID	0x505		/* USB3.0 core */
230 #define NS_A9JTAG_CORE_ID	0x506		/* ARM Cortex A9 JTAG core */
231 #define NS_DDR23_CORE_ID	0x507		/* Denali DDR2/DDR3 memory controller */
232 #define NS_ROM_CORE_ID		0x508		/* ROM core */
233 #define NS_NAND_CORE_ID		0x509		/* NAND flash controller core */
234 #define NS_QSPI_CORE_ID		0x50a		/* SPI flash controller core */
235 #define NS_CCB_CORE_ID		0x50b		/* ChipcommonB core */
236 #define NS_SOCRAM_CORE_ID	0x50e		/* internal memory core */
237 #define	ARMCA9_CORE_ID		0x510		/* ARM Cortex A9 core (ihost) */
238 #define	NS_IHOST_CORE_ID	ARMCA9_CORE_ID	/* ARM Cortex A9 core (ihost) */
239 #define AMEMC_CORE_ID		0x52e		/* DDR1/2 memory controller core */
240 #define ALTA_CORE_ID		0x534		/* I2S core */
241 #define DDR23_PHY_CORE_ID	0x5dd
242 
243 #define SI_PCI1_MEM     0x40000000  /* Host Mode sb2pcitranslation0 (64 MB) */
244 #define SI_PCI1_CFG     0x44000000  /* Host Mode sb2pcitranslation1 (64 MB) */
245 #define SI_PCIE1_DMA_H32		0xc0000000	/* PCIE Client Mode sb2pcitranslation2
246 						 * (2 ZettaBytes), high 32 bits
247 						 */
248 #define NS_PCIEG2_CORE_REV_B0	0x7		/* NS-B0 PCIE Gen 2 core rev */
249 
250 /* There are TWO constants on all HND chips: SI_ENUM_BASE_DEFAULT above,
251  * and chipcommon being the first core:
252  */
253 #define	SI_CC_IDX		0
254 /* SOC Interconnect types (aka chip types) */
255 #define	SOCI_SB			0
256 #define	SOCI_AI			1
257 #define	SOCI_UBUS		2
258 #define	SOCI_NAI		3
259 #define SOCI_DVTBUS		4 /* BCM7XXX Digital Video Tech bus */
260 
261 /* Common core control flags */
262 #define	SICF_BIST_EN		0x8000
263 #define	SICF_PME_EN		0x4000
264 #define	SICF_CORE_BITS		0x3ffc
265 #define	SICF_FGC		0x0002
266 #define	SICF_CLOCK_EN		0x0001
267 
268 /* Common core status flags */
269 #define	SISF_BIST_DONE		0x8000
270 #define	SISF_BIST_ERROR		0x4000
271 #define	SISF_GATED_CLK		0x2000
272 #define	SISF_DMA64		0x1000
273 #define	SISF_CORE_BITS		0x0fff
274 
275 /* Norstar core status flags */
276 #define SISF_NS_BOOTDEV_MASK	0x0003	/* ROM core */
277 #define SISF_NS_BOOTDEV_NOR	0x0000	/* ROM core */
278 #define SISF_NS_BOOTDEV_NAND	0x0001	/* ROM core */
279 #define SISF_NS_BOOTDEV_ROM	0x0002	/* ROM core */
280 #define SISF_NS_BOOTDEV_OFFLOAD	0x0003	/* ROM core */
281 #define SISF_NS_SKUVEC_MASK	0x000c	/* ROM core */
282 
283 /* dot11 core-specific status flags */
284 #define	SISF_MINORREV_D11_SHIFT	16
285 #define	SISF_MINORREV_D11_MASK	0xF		/**< minor corerev (corerev == 61) */
286 
287 /* A register that is common to all cores to
288  * communicate w/PMU regarding clock control.
289  */
290 #define SI_CLK_CTL_ST		0x1e0		/* clock control and status */
291 #define SI_PWR_CTL_ST		0x1e8		/* For memory clock gating */
292 
293 /* clk_ctl_st register */
294 #define	CCS_FORCEALP		0x00000001	/* force ALP request */
295 #define	CCS_FORCEHT		0x00000002	/* force HT request */
296 #define	CCS_FORCEILP		0x00000004	/* force ILP request */
297 #define	CCS_ALPAREQ		0x00000008	/* ALP Avail Request */
298 #define	CCS_HTAREQ		0x00000010	/* HT Avail Request */
299 #define	CCS_FORCEHWREQOFF	0x00000020	/* Force HW Clock Request Off */
300 #define CCS_HQCLKREQ		0x00000040	/* HQ Clock Required */
301 #define CCS_USBCLKREQ		0x00000100	/* USB Clock Req */
302 #define CCS_SECICLKREQ		0x00000100	/* SECI Clock Req */
303 #define CCS_ARMFASTCLOCKREQ	0x00000100	/* ARM CR4/CA7 fast clock request */
304 #define CCS_SFLASH_CLKREQ	0x00000200	/* Sflash clk request */
305 #define CCS_AVBCLKREQ		0x00000400	/* AVB Clock enable request */
306 #define CCS_ERSRC_REQ_MASK	0x00000700	/* external resource requests */
307 #define CCS_ERSRC_REQ_SHIFT	8
308 #define	CCS_ALPAVAIL		0x00010000	/* ALP is available */
309 #define	CCS_HTAVAIL		0x00020000	/* HT is available */
310 #define CCS_BP_ON_APL		0x00040000	/* RO: Backplane is running on ALP clock */
311 #define CCS_BP_ON_HT		0x00080000	/* RO: Backplane is running on HT clock */
312 #define CCS_ARMFASTCLOCKSTATUS	0x01000000	/* Fast CPU clock is running */
313 #define CCS_ERSRC_STS_MASK	0x07000000	/* external resource status */
314 #define CCS_ERSRC_STS_SHIFT	24
315 #define CCS_SECI_AVAIL		0x01000000	/* RO: SECI is available  */
316 
317 /* Not really related to SOC Interconnect, but a couple of software
318  * conventions for the use the flash space:
319  */
320 
321 /* Minumum amount of flash we support */
322 #define FLASH_MIN		0x00020000	/* Minimum flash size */
323 
324 /* A boot/binary may have an embedded block that describes its size  */
325 #define	BISZ_OFFSET		0x3e0		/* At this offset into the binary */
326 #define	BISZ_MAGIC		0x4249535a	/* Marked with this value: 'BISZ' */
327 #define	BISZ_MAGIC_IDX		0		/* Word 0: magic */
328 #define	BISZ_TXTST_IDX		1		/*	1: text start */
329 #define	BISZ_TXTEND_IDX		2		/*	2: text end */
330 #define	BISZ_DATAST_IDX		3		/*	3: data start */
331 #define	BISZ_DATAEND_IDX	4		/*	4: data end */
332 #define	BISZ_BSSST_IDX		5		/*	5: bss start */
333 #define	BISZ_BSSEND_IDX		6		/*	6: bss end */
334 #define BISZ_SIZE		7		/* descriptor size in 32-bit integers */
335 
336 /* Boot/Kernel related defintion and functions */
337 #define	SOC_BOOTDEV_ROM		0x00000001
338 #define	SOC_BOOTDEV_PFLASH	0x00000002
339 #define	SOC_BOOTDEV_SFLASH	0x00000004
340 #define	SOC_BOOTDEV_NANDFLASH	0x00000008
341 
342 #define	SOC_KNLDEV_NORFLASH	0x00000002
343 #define	SOC_KNLDEV_NANDFLASH	0x00000004
344 
345 #if !defined(_LANGUAGE_ASSEMBLY) && !defined(__ASSEMBLY__)
346 int soc_boot_dev(void *sih);
347 int soc_knl_dev(void *sih);
348 #endif	/* !defined(_LANGUAGE_ASSEMBLY) && !defined(__ASSEMBLY__) */
349 
350 #define PMU_BASE_OFFSET	0x00012000	/* PMU offset is changed for ccrev >= 56 */
351 #endif /* _HNDSOC_H */
352