xref: /freebsd/sys/dev/bhnd/bcma/bcma_dmp.h (revision 6b7b2d80ed4d728d3ffd12c422e57798c1b63a84)
1 /*-
2  * Copyright (c) 2015 Landon Fuller <landon@landonf.org>
3  * Copyright (c) 2010 Broadcom Corporation
4  *
5  * Portions of this file were derived from the aidmp.h header
6  * distributed with Broadcom's initial brcm80211 Linux driver release, as
7  * contributed to the Linux staging repository.
8  *
9  * Permission to use, copy, modify, and/or distribute this software for any
10  * purpose with or without fee is hereby granted, provided that the above
11  * copyright notice and this permission notice appear in all copies.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
14  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
16  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
18  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
19  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20  *
21  * $FreeBSD$
22  */
23 
24 #ifndef	_BCMA_BCMA_DMP_H_
25 #define	_BCMA_BCMA_DMP_H_
26 
27 /*
28  * PL-368 Device Management Plugin (DMP) Registers & Constants
29  *
30  * The "DMP" core used in Broadcom HND devices has been described
31  * by Broadcom engineers (and in published header files) as being
32  * ARM's PL-368 "Device Management Plugin" system IP, included with
33  * the CoreLink AMBA Designer tooling.
34  *
35  * Documentation for the PL-368 is not publicly available, however,
36  * and the only public reference by ARM to its existence appears to be
37  * in the proprietary "NIC-301 Interconnect Device Management (PL368)"
38  * errata publication, available to licensees as part of ARM's
39  * CoreLink Controllers and Peripherals Engineering Errata.
40  */
41 
42 /* Out-of-band Router registers */
43 #define	BCMA_OOB_BUSCONFIG	0x020
44 #define	BCMA_OOB_STATUSA	0x100
45 #define	BCMA_OOB_STATUSB	0x104
46 #define	BCMA_OOB_STATUSC	0x108
47 #define	BCMA_OOB_STATUSD	0x10c
48 #define	BCMA_OOB_ENABLEA0	0x200
49 #define	BCMA_OOB_ENABLEA1	0x204
50 #define	BCMA_OOB_ENABLEA2	0x208
51 #define	BCMA_OOB_ENABLEA3	0x20c
52 #define	BCMA_OOB_ENABLEB0	0x280
53 #define	BCMA_OOB_ENABLEB1	0x284
54 #define	BCMA_OOB_ENABLEB2	0x288
55 #define	BCMA_OOB_ENABLEB3	0x28c
56 #define	BCMA_OOB_ENABLEC0	0x300
57 #define	BCMA_OOB_ENABLEC1	0x304
58 #define	BCMA_OOB_ENABLEC2	0x308
59 #define	BCMA_OOB_ENABLEC3	0x30c
60 #define	BCMA_OOB_ENABLED0	0x380
61 #define	BCMA_OOB_ENABLED1	0x384
62 #define	BCMA_OOB_ENABLED2	0x388
63 #define	BCMA_OOB_ENABLED3	0x38c
64 #define	BCMA_OOB_ITCR		0xf00
65 #define	BCMA_OOB_ITIPOOBA	0xf10
66 #define	BCMA_OOB_ITIPOOBB	0xf14
67 #define	BCMA_OOB_ITIPOOBC	0xf18
68 #define	BCMA_OOB_ITIPOOBD	0xf1c
69 #define	BCMA_OOB_ITOPOOBA	0xf30
70 #define	BCMA_OOB_ITOPOOBB	0xf34
71 #define	BCMA_OOB_ITOPOOBC	0xf38
72 #define	BCMA_OOB_ITOPOOBD	0xf3c
73 
74 /* DMP wrapper registers */
75 #define	BCMA_DMP_OOBSELINA30	0x000
76 #define	BCMA_DMP_OOBSELINA74	0x004
77 #define	BCMA_DMP_OOBSELINB30	0x020
78 #define	BCMA_DMP_OOBSELINB74	0x024
79 #define	BCMA_DMP_OOBSELINC30	0x040
80 #define	BCMA_DMP_OOBSELINC74	0x044
81 #define	BCMA_DMP_OOBSELIND30	0x060
82 #define	BCMA_DMP_OOBSELIND74	0x064
83 #define	BCMA_DMP_OOBSELOUTA30	0x100
84 #define	BCMA_DMP_OOBSELOUTA74	0x104
85 #define	BCMA_DMP_OOBSELOUTB30	0x120
86 #define	BCMA_DMP_OOBSELOUTB74	0x124
87 #define	BCMA_DMP_OOBSELOUTC30	0x140
88 #define	BCMA_DMP_OOBSELOUTC74	0x144
89 #define	BCMA_DMP_OOBSELOUTD30	0x160
90 #define	BCMA_DMP_OOBSELOUTD74	0x164
91 #define	BCMA_DMP_OOBSYNCA	0x200
92 #define	BCMA_DMP_OOBSELOUTAEN	0x204
93 #define	BCMA_DMP_OOBSYNCB	0x220
94 #define	BCMA_DMP_OOBSELOUTBEN	0x224
95 #define	BCMA_DMP_OOBSYNCC	0x240
96 #define	BCMA_DMP_OOBSELOUTCEN	0x244
97 #define	BCMA_DMP_OOBSYNCD	0x260
98 #define	BCMA_DMP_OOBSELOUTDEN	0x264
99 #define	BCMA_DMP_OOBAEXTWIDTH	0x300
100 #define	BCMA_DMP_OOBAINWIDTH	0x304
101 #define	BCMA_DMP_OOBAOUTWIDTH	0x308
102 #define	BCMA_DMP_OOBBEXTWIDTH	0x320
103 #define	BCMA_DMP_OOBBINWIDTH	0x324
104 #define	BCMA_DMP_OOBBOUTWIDTH	0x328
105 #define	BCMA_DMP_OOBCEXTWIDTH	0x340
106 #define	BCMA_DMP_OOBCINWIDTH	0x344
107 #define	BCMA_DMP_OOBCOUTWIDTH	0x348
108 #define	BCMA_DMP_OOBDEXTWIDTH	0x360
109 #define	BCMA_DMP_OOBDINWIDTH	0x364
110 #define	BCMA_DMP_OOBDOUTWIDTH	0x368
111 
112 // This was inherited from Broadcom's aidmp.h header
113 // Is it required for any of our use-cases?
114 #if 0 /* defined(IL_BIGENDIAN) && defined(BCMHND74K) */
115 /* Selective swapped defines for those registers we need in
116  * big-endian code.
117  */
118 #define	BCMA_DMP_IOCTRLSET	0x404
119 #define	BCMA_DMP_IOCTRLCLEAR	0x400
120 #define	BCMA_DMP_IOCTRL		0x40c
121 #define	BCMA_DMP_IOSTATUS	0x504
122 #define	BCMA_DMP_RESETCTRL	0x804
123 #define	BCMA_DMP_RESETSTATUS	0x800
124 
125 #else				/* !IL_BIGENDIAN || !BCMHND74K */
126 
127 #define	BCMA_DMP_IOCTRLSET	0x400
128 #define	BCMA_DMP_IOCTRLCLEAR	0x404
129 #define	BCMA_DMP_IOCTRL		0x408
130 #define	BCMA_DMP_IOSTATUS	0x500
131 #define	BCMA_DMP_RESETCTRL	0x800
132 #define	BCMA_DMP_RESETSTATUS	0x804
133 
134 #endif				/* IL_BIGENDIAN && BCMHND74K */
135 
136 #define	BCMA_DMP_IOCTRLWIDTH	0x700
137 #define	BCMA_DMP_IOSTATUSWIDTH	0x704
138 
139 #define	BCMA_DMP_RESETREADID	0x808
140 #define	BCMA_DMP_RESETWRITEID	0x80c
141 #define	BCMA_DMP_ERRLOGCTRL	0xa00
142 #define	BCMA_DMP_ERRLOGDONE	0xa04
143 #define	BCMA_DMP_ERRLOGSTATUS	0xa08
144 #define	BCMA_DMP_ERRLOGADDRLO	0xa0c
145 #define	BCMA_DMP_ERRLOGADDRHI	0xa10
146 #define	BCMA_DMP_ERRLOGID	0xa14
147 #define	BCMA_DMP_ERRLOGUSER	0xa18
148 #define	BCMA_DMP_ERRLOGFLAGS	0xa1c
149 #define	BCMA_DMP_INTSTATUS	0xa00
150 #define	BCMA_DMP_CONFIG		0xe00
151 #define	BCMA_DMP_ITCR		0xf00
152 #define	BCMA_DMP_ITIPOOBA	0xf10
153 #define	BCMA_DMP_ITIPOOBB	0xf14
154 #define	BCMA_DMP_ITIPOOBC	0xf18
155 #define	BCMA_DMP_ITIPOOBD	0xf1c
156 #define	BCMA_DMP_ITIPOOBAOUT	0xf30
157 #define	BCMA_DMP_ITIPOOBBOUT	0xf34
158 #define	BCMA_DMP_ITIPOOBCOUT	0xf38
159 #define	BCMA_DMP_ITIPOOBDOUT	0xf3c
160 #define	BCMA_DMP_ITOPOOBA	0xf50
161 #define	BCMA_DMP_ITOPOOBB	0xf54
162 #define	BCMA_DMP_ITOPOOBC	0xf58
163 #define	BCMA_DMP_ITOPOOBD	0xf5c
164 #define	BCMA_DMP_ITOPOOBAIN	0xf70
165 #define	BCMA_DMP_ITOPOOBBIN	0xf74
166 #define	BCMA_DMP_ITOPOOBCIN	0xf78
167 #define	BCMA_DMP_ITOPOOBDIN	0xf7c
168 #define	BCMA_DMP_ITOPRESET	0xf90
169 #define	BCMA_DMP_PERIPHERIALID4	0xfd0
170 #define	BCMA_DMP_PERIPHERIALID5	0xfd4
171 #define	BCMA_DMP_PERIPHERIALID6	0xfd8
172 #define	BCMA_DMP_PERIPHERIALID7	0xfdc
173 #define	BCMA_DMP_PERIPHERIALID0	0xfe0
174 #define	BCMA_DMP_PERIPHERIALID1	0xfe4
175 #define	BCMA_DMP_PERIPHERIALID2	0xfe8
176 #define	BCMA_DMP_PERIPHERIALID3	0xfec
177 #define	BCMA_DMP_COMPONENTID0	0xff0
178 #define	BCMA_DMP_COMPONENTID1	0xff4
179 #define	BCMA_DMP_COMPONENTID2	0xff8
180 #define	BCMA_DMP_COMPONENTID3	0xffc
181 
182 /* resetctrl */
183 #define	BMCA_DMP_RC_RESET	1
184 
185 /* config */
186 #define	BCMA_DMP_CFG_OOB	0x00000020
187 #define	BCMA_DMP_CFG_IOS	0x00000010
188 #define	BCMA_DMP_CFGIOC		0x00000008
189 #define	BCMA_DMP_CFGTO		0x00000004
190 #define	BCMA_DMP_CFGERRL	0x00000002
191 #define	BCMA_DMP_CFGRST		0x00000001
192 
193 #endif /* _BCMA_BCMA_DMP_H_ */
194