1 /***********************license start***************
2 * Author: Cavium Networks
4 * Contact: support@caviumnetworks.com
5 * This file is part of the OCTEON SDK
7 * Copyright (c) 2003-2008 Cavium Networks
9 * This file is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License, Version 2, as
11 * published by the Free Software Foundation.
13 * This file is distributed in the hope that it will be useful, but
14 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty
15 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
16 * NONINFRINGEMENT. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this file; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * or visit http://www.gnu.org/licenses/.
24 * This file may also be available under a different license from Cavium.
25 * Contact Cavium Networks for more information
26 ***********************license end**************************************/
29 * Header file containing the ABI with the bootloader.
32 #ifndef __CVMX_BOOTINFO_H__
33 #define __CVMX_BOOTINFO_H__
36 * Current major and minor versions of the CVMX bootinfo block that is
37 * passed from the bootloader to the application. This is versioned
38 * so that applications can properly handle multiple bootloader
41 #define CVMX_BOOTINFO_MAJ_VER 1
42 #define CVMX_BOOTINFO_MIN_VER 3
44 #if (CVMX_BOOTINFO_MAJ_VER == 1)
45 #define CVMX_BOOTINFO_OCTEON_SERIAL_LEN 20
47 * This structure is populated by the bootloader. For binary
48 * compatibility the only changes that should be made are
49 * adding members to the end of the structure, and the minor
50 * version should be incremented at that time.
51 * If an incompatible change is made, the major version
52 * must be incremented, and the minor version should be reset
55 struct cvmx_bootinfo
{
56 #ifdef __BIG_ENDIAN_BITFIELD
57 uint32_t major_version
;
58 uint32_t minor_version
;
65 uint32_t exception_base_addr
;
69 /* DRAM size in megabytes */
71 /* physical address of free memory descriptor block*/
72 uint32_t phy_mem_desc_addr
;
73 /* used to pass flags from app to debugger */
74 uint32_t debugger_flags_base_addr
;
76 /* CPU clock speed, in hz */
79 /* DRAM clock speed, in hz */
84 uint8_t board_rev_major
;
85 uint8_t board_rev_minor
;
89 char board_serial_number
[CVMX_BOOTINFO_OCTEON_SERIAL_LEN
];
90 uint8_t mac_addr_base
[6];
91 uint8_t mac_addr_count
;
92 #if (CVMX_BOOTINFO_MIN_VER >= 1)
94 * Several boards support compact flash on the Octeon boot
95 * bus. The CF memory spaces may be mapped to different
96 * addresses on different boards. These are the physical
97 * addresses, so care must be taken to use the correct
98 * XKPHYS/KSEG0 addressing depending on the application's
99 * ABI. These values will be 0 if CF is not present.
101 uint64_t compact_flash_common_base_addr
;
102 uint64_t compact_flash_attribute_base_addr
;
104 * Base address of the LED display (as on EBT3000 board)
105 * This will be 0 if LED display not present.
107 uint64_t led_display_base_addr
;
109 #if (CVMX_BOOTINFO_MIN_VER >= 2)
110 /* DFA reference clock in hz (if applicable)*/
111 uint32_t dfa_ref_clock_hz
;
114 * flags indicating various configuration options. These
115 * flags supercede the 'flags' variable and should be used
116 * instead if available.
118 uint32_t config_flags
;
120 #if (CVMX_BOOTINFO_MIN_VER >= 3)
122 * Address of the OF Flattened Device Tree structure
123 * describing the board.
127 #else /* __BIG_ENDIAN */
129 * Little-Endian: When the CPU mode is switched to
130 * little-endian, the view of the structure has some of the
133 uint32_t minor_version
;
134 uint32_t major_version
;
142 uint32_t exception_base_addr
;
147 uint32_t phy_mem_desc_addr
;
151 uint32_t debugger_flags_base_addr
;
159 uint8_t board_rev_minor
;
160 uint8_t board_rev_major
;
163 char board_serial_number
[CVMX_BOOTINFO_OCTEON_SERIAL_LEN
];
164 uint8_t mac_addr_base
[6];
165 uint8_t mac_addr_count
;
168 #if (CVMX_BOOTINFO_MIN_VER >= 1)
169 uint64_t compact_flash_common_base_addr
;
170 uint64_t compact_flash_attribute_base_addr
;
171 uint64_t led_display_base_addr
;
173 #if (CVMX_BOOTINFO_MIN_VER >= 2)
174 uint32_t config_flags
;
175 uint32_t dfa_ref_clock_hz
;
177 #if (CVMX_BOOTINFO_MIN_VER >= 3)
183 #define CVMX_BOOTINFO_CFG_FLAG_PCI_HOST (1ull << 0)
184 #define CVMX_BOOTINFO_CFG_FLAG_PCI_TARGET (1ull << 1)
185 #define CVMX_BOOTINFO_CFG_FLAG_DEBUG (1ull << 2)
186 #define CVMX_BOOTINFO_CFG_FLAG_NO_MAGIC (1ull << 3)
187 /* This flag is set if the TLB mappings are not contained in the
188 * 0x10000000 - 0x20000000 boot bus region. */
189 #define CVMX_BOOTINFO_CFG_FLAG_OVERSIZE_TLB_MAPPING (1ull << 4)
190 #define CVMX_BOOTINFO_CFG_FLAG_BREAK (1ull << 5)
192 #endif /* (CVMX_BOOTINFO_MAJ_VER == 1) */
194 /* Type defines for board and chip types */
195 enum cvmx_board_types_enum
{
196 CVMX_BOARD_TYPE_NULL
= 0,
197 CVMX_BOARD_TYPE_SIM
= 1,
198 CVMX_BOARD_TYPE_EBT3000
= 2,
199 CVMX_BOARD_TYPE_KODAMA
= 3,
200 CVMX_BOARD_TYPE_NIAGARA
= 4,
201 CVMX_BOARD_TYPE_NAC38
= 5, /* formerly NAO38 */
202 CVMX_BOARD_TYPE_THUNDER
= 6,
203 CVMX_BOARD_TYPE_TRANTOR
= 7,
204 CVMX_BOARD_TYPE_EBH3000
= 8,
205 CVMX_BOARD_TYPE_EBH3100
= 9,
206 CVMX_BOARD_TYPE_HIKARI
= 10,
207 CVMX_BOARD_TYPE_CN3010_EVB_HS5
= 11,
208 CVMX_BOARD_TYPE_CN3005_EVB_HS5
= 12,
209 CVMX_BOARD_TYPE_KBP
= 13,
210 /* Deprecated, CVMX_BOARD_TYPE_CN3010_EVB_HS5 supports the CN3020 */
211 CVMX_BOARD_TYPE_CN3020_EVB_HS5
= 14,
212 CVMX_BOARD_TYPE_EBT5800
= 15,
213 CVMX_BOARD_TYPE_NICPRO2
= 16,
214 CVMX_BOARD_TYPE_EBH5600
= 17,
215 CVMX_BOARD_TYPE_EBH5601
= 18,
216 CVMX_BOARD_TYPE_EBH5200
= 19,
217 CVMX_BOARD_TYPE_BBGW_REF
= 20,
218 CVMX_BOARD_TYPE_NIC_XLE_4G
= 21,
219 CVMX_BOARD_TYPE_EBT5600
= 22,
220 CVMX_BOARD_TYPE_EBH5201
= 23,
221 CVMX_BOARD_TYPE_EBT5200
= 24,
222 CVMX_BOARD_TYPE_CB5600
= 25,
223 CVMX_BOARD_TYPE_CB5601
= 26,
224 CVMX_BOARD_TYPE_CB5200
= 27,
225 /* Special 'generic' board type, supports many boards */
226 CVMX_BOARD_TYPE_GENERIC
= 28,
227 CVMX_BOARD_TYPE_EBH5610
= 29,
228 CVMX_BOARD_TYPE_LANAI2_A
= 30,
229 CVMX_BOARD_TYPE_LANAI2_U
= 31,
230 CVMX_BOARD_TYPE_EBB5600
= 32,
231 CVMX_BOARD_TYPE_EBB6300
= 33,
232 CVMX_BOARD_TYPE_NIC_XLE_10G
= 34,
233 CVMX_BOARD_TYPE_LANAI2_G
= 35,
234 CVMX_BOARD_TYPE_EBT5810
= 36,
235 CVMX_BOARD_TYPE_NIC10E
= 37,
236 CVMX_BOARD_TYPE_EP6300C
= 38,
237 CVMX_BOARD_TYPE_EBB6800
= 39,
238 CVMX_BOARD_TYPE_NIC4E
= 40,
239 CVMX_BOARD_TYPE_NIC2E
= 41,
240 CVMX_BOARD_TYPE_EBB6600
= 42,
241 CVMX_BOARD_TYPE_REDWING
= 43,
242 CVMX_BOARD_TYPE_NIC68_4
= 44,
243 CVMX_BOARD_TYPE_NIC10E_66
= 45,
247 * The range from CVMX_BOARD_TYPE_MAX to
248 * CVMX_BOARD_TYPE_CUST_DEFINED_MIN is reserved for future
253 * Set aside a range for customer boards. These numbers are managed
256 CVMX_BOARD_TYPE_CUST_DEFINED_MIN
= 10000,
257 CVMX_BOARD_TYPE_CUST_WSX16
= 10001,
258 CVMX_BOARD_TYPE_CUST_NS0216
= 10002,
259 CVMX_BOARD_TYPE_CUST_NB5
= 10003,
260 CVMX_BOARD_TYPE_CUST_WMR500
= 10004,
261 CVMX_BOARD_TYPE_CUST_ITB101
= 10005,
262 CVMX_BOARD_TYPE_CUST_NTE102
= 10006,
263 CVMX_BOARD_TYPE_CUST_AGS103
= 10007,
264 CVMX_BOARD_TYPE_CUST_GST104
= 10008,
265 CVMX_BOARD_TYPE_CUST_GCT105
= 10009,
266 CVMX_BOARD_TYPE_CUST_AGS106
= 10010,
267 CVMX_BOARD_TYPE_CUST_SGM107
= 10011,
268 CVMX_BOARD_TYPE_CUST_GCT108
= 10012,
269 CVMX_BOARD_TYPE_CUST_AGS109
= 10013,
270 CVMX_BOARD_TYPE_CUST_GCT110
= 10014,
271 CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER
= 10015,
272 CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER
= 10016,
273 CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX
= 10017,
274 CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX
= 10018,
275 CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX
= 10019,
276 CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX
= 10020,
277 CVMX_BOARD_TYPE_CUST_L2_ZINWELL
= 10021,
278 CVMX_BOARD_TYPE_CUST_DEFINED_MAX
= 20000,
281 * Set aside a range for customer private use. The SDK won't
282 * use any numbers in this range.
284 CVMX_BOARD_TYPE_CUST_PRIVATE_MIN
= 20001,
285 CVMX_BOARD_TYPE_UBNT_E100
= 20002,
286 CVMX_BOARD_TYPE_CUST_DSR1000N
= 20006,
287 CVMX_BOARD_TYPE_KONTRON_S1901
= 21901,
288 CVMX_BOARD_TYPE_CUST_PRIVATE_MAX
= 30000,
290 /* The remaining range is reserved for future use. */
293 enum cvmx_chip_types_enum
{
294 CVMX_CHIP_TYPE_NULL
= 0,
295 CVMX_CHIP_SIM_TYPE_DEPRECATED
= 1,
296 CVMX_CHIP_TYPE_OCTEON_SAMPLE
= 2,
300 /* Compatibility alias for NAC38 name change, planned to be removed
302 #define CVMX_BOARD_TYPE_NAO38 CVMX_BOARD_TYPE_NAC38
304 /* Functions to return string based on type */
305 #define ENUM_BRD_TYPE_CASE(x) \
306 case x: return(#x + 16); /* Skip CVMX_BOARD_TYPE_ */
307 static inline const char *cvmx_board_type_to_string(enum
308 cvmx_board_types_enum type
)
311 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NULL
)
312 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_SIM
)
313 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT3000
)
314 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KODAMA
)
315 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIAGARA
)
316 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NAC38
)
317 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_THUNDER
)
318 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_TRANTOR
)
319 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3000
)
320 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3100
)
321 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_HIKARI
)
322 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3010_EVB_HS5
)
323 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3005_EVB_HS5
)
324 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KBP
)
325 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3020_EVB_HS5
)
326 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5800
)
327 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NICPRO2
)
328 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5600
)
329 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5601
)
330 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5200
)
331 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_BBGW_REF
)
332 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_4G
)
333 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5600
)
334 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5201
)
335 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5200
)
336 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5600
)
337 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5601
)
338 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5200
)
339 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_GENERIC
)
340 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5610
)
341 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_A
)
342 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_U
)
343 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB5600
)
344 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6300
)
345 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_10G
)
346 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_G
)
347 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5810
)
348 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E
)
349 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EP6300C
)
350 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6800
)
351 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC4E
)
352 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC2E
)
353 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6600
)
354 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_REDWING
)
355 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC68_4
)
356 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E_66
)
357 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MAX
)
359 /* Customer boards listed here */
360 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MIN
)
361 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WSX16
)
362 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NS0216
)
363 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NB5
)
364 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WMR500
)
365 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_ITB101
)
366 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NTE102
)
367 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS103
)
368 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GST104
)
369 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT105
)
370 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS106
)
371 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_SGM107
)
372 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT108
)
373 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS109
)
374 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT110
)
375 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER
)
376 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER
)
377 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX
)
378 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX
)
379 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX
)
380 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX
)
381 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ZINWELL
)
382 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MAX
)
384 /* Customer private range */
385 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MIN
)
386 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_UBNT_E100
)
387 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DSR1000N
)
388 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KONTRON_S1901
)
389 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MAX
)
391 return "Unsupported Board";
394 #define ENUM_CHIP_TYPE_CASE(x) \
395 case x: return(#x + 15); /* Skip CVMX_CHIP_TYPE */
396 static inline const char *cvmx_chip_type_to_string(enum
397 cvmx_chip_types_enum type
)
400 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_NULL
)
401 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_SIM_TYPE_DEPRECATED
)
402 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_OCTEON_SAMPLE
)
403 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_MAX
)
405 return "Unsupported Chip";
408 #endif /* __CVMX_BOOTINFO_H__ */