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__
35 #include "cvmx-coremask.h"
38 * Current major and minor versions of the CVMX bootinfo block that is
39 * passed from the bootloader to the application. This is versioned
40 * so that applications can properly handle multiple bootloader
43 #define CVMX_BOOTINFO_MAJ_VER 1
44 #define CVMX_BOOTINFO_MIN_VER 4
46 #if (CVMX_BOOTINFO_MAJ_VER == 1)
47 #define CVMX_BOOTINFO_OCTEON_SERIAL_LEN 20
49 * This structure is populated by the bootloader. For binary
50 * compatibility the only changes that should be made are
51 * adding members to the end of the structure, and the minor
52 * version should be incremented at that time.
53 * If an incompatible change is made, the major version
54 * must be incremented, and the minor version should be reset
57 struct cvmx_bootinfo
{
58 #ifdef __BIG_ENDIAN_BITFIELD
59 uint32_t major_version
;
60 uint32_t minor_version
;
67 uint32_t exception_base_addr
;
71 /* DRAM size in megabytes */
73 /* physical address of free memory descriptor block*/
74 uint32_t phy_mem_desc_addr
;
75 /* used to pass flags from app to debugger */
76 uint32_t debugger_flags_base_addr
;
78 /* CPU clock speed, in hz */
81 /* DRAM clock speed, in hz */
86 uint8_t board_rev_major
;
87 uint8_t board_rev_minor
;
91 char board_serial_number
[CVMX_BOOTINFO_OCTEON_SERIAL_LEN
];
92 uint8_t mac_addr_base
[6];
93 uint8_t mac_addr_count
;
94 #if (CVMX_BOOTINFO_MIN_VER >= 1)
96 * Several boards support compact flash on the Octeon boot
97 * bus. The CF memory spaces may be mapped to different
98 * addresses on different boards. These are the physical
99 * addresses, so care must be taken to use the correct
100 * XKPHYS/KSEG0 addressing depending on the application's
101 * ABI. These values will be 0 if CF is not present.
103 uint64_t compact_flash_common_base_addr
;
104 uint64_t compact_flash_attribute_base_addr
;
106 * Base address of the LED display (as on EBT3000 board)
107 * This will be 0 if LED display not present.
109 uint64_t led_display_base_addr
;
111 #if (CVMX_BOOTINFO_MIN_VER >= 2)
112 /* DFA reference clock in hz (if applicable)*/
113 uint32_t dfa_ref_clock_hz
;
116 * flags indicating various configuration options. These
117 * flags supersede the 'flags' variable and should be used
118 * instead if available.
120 uint32_t config_flags
;
122 #if (CVMX_BOOTINFO_MIN_VER >= 3)
124 * Address of the OF Flattened Device Tree structure
125 * describing the board.
129 #if (CVMX_BOOTINFO_MIN_VER >= 4)
131 * Coremask used for processors with more than 32 cores
132 * or with OCI. This replaces core_mask.
134 struct cvmx_coremask ext_core_mask
;
136 #else /* __BIG_ENDIAN */
138 * Little-Endian: When the CPU mode is switched to
139 * little-endian, the view of the structure has some of the
142 uint32_t minor_version
;
143 uint32_t major_version
;
151 uint32_t exception_base_addr
;
156 uint32_t phy_mem_desc_addr
;
160 uint32_t debugger_flags_base_addr
;
168 uint8_t board_rev_minor
;
169 uint8_t board_rev_major
;
172 char board_serial_number
[CVMX_BOOTINFO_OCTEON_SERIAL_LEN
];
173 uint8_t mac_addr_base
[6];
174 uint8_t mac_addr_count
;
177 #if (CVMX_BOOTINFO_MIN_VER >= 1)
178 uint64_t compact_flash_common_base_addr
;
179 uint64_t compact_flash_attribute_base_addr
;
180 uint64_t led_display_base_addr
;
182 #if (CVMX_BOOTINFO_MIN_VER >= 2)
183 uint32_t config_flags
;
184 uint32_t dfa_ref_clock_hz
;
186 #if (CVMX_BOOTINFO_MIN_VER >= 3)
189 #if (CVMX_BOOTINFO_MIN_VER >= 4)
190 struct cvmx_coremask ext_core_mask
;
195 #define CVMX_BOOTINFO_CFG_FLAG_PCI_HOST (1ull << 0)
196 #define CVMX_BOOTINFO_CFG_FLAG_PCI_TARGET (1ull << 1)
197 #define CVMX_BOOTINFO_CFG_FLAG_DEBUG (1ull << 2)
198 #define CVMX_BOOTINFO_CFG_FLAG_NO_MAGIC (1ull << 3)
199 /* This flag is set if the TLB mappings are not contained in the
200 * 0x10000000 - 0x20000000 boot bus region. */
201 #define CVMX_BOOTINFO_CFG_FLAG_OVERSIZE_TLB_MAPPING (1ull << 4)
202 #define CVMX_BOOTINFO_CFG_FLAG_BREAK (1ull << 5)
204 #endif /* (CVMX_BOOTINFO_MAJ_VER == 1) */
206 /* Type defines for board and chip types */
207 enum cvmx_board_types_enum
{
208 CVMX_BOARD_TYPE_NULL
= 0,
209 CVMX_BOARD_TYPE_SIM
= 1,
210 CVMX_BOARD_TYPE_EBT3000
= 2,
211 CVMX_BOARD_TYPE_KODAMA
= 3,
212 CVMX_BOARD_TYPE_NIAGARA
= 4,
213 CVMX_BOARD_TYPE_NAC38
= 5, /* formerly NAO38 */
214 CVMX_BOARD_TYPE_THUNDER
= 6,
215 CVMX_BOARD_TYPE_TRANTOR
= 7,
216 CVMX_BOARD_TYPE_EBH3000
= 8,
217 CVMX_BOARD_TYPE_EBH3100
= 9,
218 CVMX_BOARD_TYPE_HIKARI
= 10,
219 CVMX_BOARD_TYPE_CN3010_EVB_HS5
= 11,
220 CVMX_BOARD_TYPE_CN3005_EVB_HS5
= 12,
221 CVMX_BOARD_TYPE_KBP
= 13,
222 /* Deprecated, CVMX_BOARD_TYPE_CN3010_EVB_HS5 supports the CN3020 */
223 CVMX_BOARD_TYPE_CN3020_EVB_HS5
= 14,
224 CVMX_BOARD_TYPE_EBT5800
= 15,
225 CVMX_BOARD_TYPE_NICPRO2
= 16,
226 CVMX_BOARD_TYPE_EBH5600
= 17,
227 CVMX_BOARD_TYPE_EBH5601
= 18,
228 CVMX_BOARD_TYPE_EBH5200
= 19,
229 CVMX_BOARD_TYPE_BBGW_REF
= 20,
230 CVMX_BOARD_TYPE_NIC_XLE_4G
= 21,
231 CVMX_BOARD_TYPE_EBT5600
= 22,
232 CVMX_BOARD_TYPE_EBH5201
= 23,
233 CVMX_BOARD_TYPE_EBT5200
= 24,
234 CVMX_BOARD_TYPE_CB5600
= 25,
235 CVMX_BOARD_TYPE_CB5601
= 26,
236 CVMX_BOARD_TYPE_CB5200
= 27,
237 /* Special 'generic' board type, supports many boards */
238 CVMX_BOARD_TYPE_GENERIC
= 28,
239 CVMX_BOARD_TYPE_EBH5610
= 29,
240 CVMX_BOARD_TYPE_LANAI2_A
= 30,
241 CVMX_BOARD_TYPE_LANAI2_U
= 31,
242 CVMX_BOARD_TYPE_EBB5600
= 32,
243 CVMX_BOARD_TYPE_EBB6300
= 33,
244 CVMX_BOARD_TYPE_NIC_XLE_10G
= 34,
245 CVMX_BOARD_TYPE_LANAI2_G
= 35,
246 CVMX_BOARD_TYPE_EBT5810
= 36,
247 CVMX_BOARD_TYPE_NIC10E
= 37,
248 CVMX_BOARD_TYPE_EP6300C
= 38,
249 CVMX_BOARD_TYPE_EBB6800
= 39,
250 CVMX_BOARD_TYPE_NIC4E
= 40,
251 CVMX_BOARD_TYPE_NIC2E
= 41,
252 CVMX_BOARD_TYPE_EBB6600
= 42,
253 CVMX_BOARD_TYPE_REDWING
= 43,
254 CVMX_BOARD_TYPE_NIC68_4
= 44,
255 CVMX_BOARD_TYPE_NIC10E_66
= 45,
256 CVMX_BOARD_TYPE_SNIC10E
= 50,
260 * The range from CVMX_BOARD_TYPE_MAX to
261 * CVMX_BOARD_TYPE_CUST_DEFINED_MIN is reserved for future
266 * Set aside a range for customer boards. These numbers are managed
269 CVMX_BOARD_TYPE_CUST_DEFINED_MIN
= 10000,
270 CVMX_BOARD_TYPE_CUST_WSX16
= 10001,
271 CVMX_BOARD_TYPE_CUST_NS0216
= 10002,
272 CVMX_BOARD_TYPE_CUST_NB5
= 10003,
273 CVMX_BOARD_TYPE_CUST_WMR500
= 10004,
274 CVMX_BOARD_TYPE_CUST_ITB101
= 10005,
275 CVMX_BOARD_TYPE_CUST_NTE102
= 10006,
276 CVMX_BOARD_TYPE_CUST_AGS103
= 10007,
277 CVMX_BOARD_TYPE_CUST_GST104
= 10008,
278 CVMX_BOARD_TYPE_CUST_GCT105
= 10009,
279 CVMX_BOARD_TYPE_CUST_AGS106
= 10010,
280 CVMX_BOARD_TYPE_CUST_SGM107
= 10011,
281 CVMX_BOARD_TYPE_CUST_GCT108
= 10012,
282 CVMX_BOARD_TYPE_CUST_AGS109
= 10013,
283 CVMX_BOARD_TYPE_CUST_GCT110
= 10014,
284 CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER
= 10015,
285 CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER
= 10016,
286 CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX
= 10017,
287 CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX
= 10018,
288 CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX
= 10019,
289 CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX
= 10020,
290 CVMX_BOARD_TYPE_CUST_L2_ZINWELL
= 10021,
291 CVMX_BOARD_TYPE_CUST_DEFINED_MAX
= 20000,
294 * Set aside a range for customer private use. The SDK won't
295 * use any numbers in this range.
297 CVMX_BOARD_TYPE_CUST_PRIVATE_MIN
= 20001,
298 CVMX_BOARD_TYPE_UBNT_E100
= 20002,
299 CVMX_BOARD_TYPE_UBNT_E200
= 20003,
300 CVMX_BOARD_TYPE_UBNT_E220
= 20005,
301 CVMX_BOARD_TYPE_CUST_DSR1000N
= 20006,
302 CVMX_BOARD_TYPE_UBNT_E300
= 20300,
303 CVMX_BOARD_TYPE_KONTRON_S1901
= 21901,
304 CVMX_BOARD_TYPE_CUST_PRIVATE_MAX
= 30000,
306 /* The remaining range is reserved for future use. */
309 enum cvmx_chip_types_enum
{
310 CVMX_CHIP_TYPE_NULL
= 0,
311 CVMX_CHIP_SIM_TYPE_DEPRECATED
= 1,
312 CVMX_CHIP_TYPE_OCTEON_SAMPLE
= 2,
316 /* Compatibility alias for NAC38 name change, planned to be removed
318 #define CVMX_BOARD_TYPE_NAO38 CVMX_BOARD_TYPE_NAC38
320 /* Functions to return string based on type */
321 #define ENUM_BRD_TYPE_CASE(x) \
322 case x: return (&#x[16]); /* Skip CVMX_BOARD_TYPE_ */
323 static inline const char *cvmx_board_type_to_string(enum
324 cvmx_board_types_enum type
)
327 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NULL
)
328 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_SIM
)
329 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT3000
)
330 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KODAMA
)
331 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIAGARA
)
332 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NAC38
)
333 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_THUNDER
)
334 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_TRANTOR
)
335 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3000
)
336 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3100
)
337 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_HIKARI
)
338 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3010_EVB_HS5
)
339 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3005_EVB_HS5
)
340 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KBP
)
341 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3020_EVB_HS5
)
342 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5800
)
343 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NICPRO2
)
344 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5600
)
345 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5601
)
346 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5200
)
347 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_BBGW_REF
)
348 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_4G
)
349 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5600
)
350 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5201
)
351 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5200
)
352 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5600
)
353 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5601
)
354 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5200
)
355 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_GENERIC
)
356 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5610
)
357 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_A
)
358 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_U
)
359 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB5600
)
360 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6300
)
361 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_10G
)
362 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_G
)
363 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5810
)
364 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E
)
365 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EP6300C
)
366 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6800
)
367 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC4E
)
368 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC2E
)
369 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6600
)
370 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_REDWING
)
371 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC68_4
)
372 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E_66
)
373 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_SNIC10E
)
374 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MAX
)
376 /* Customer boards listed here */
377 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MIN
)
378 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WSX16
)
379 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NS0216
)
380 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NB5
)
381 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WMR500
)
382 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_ITB101
)
383 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NTE102
)
384 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS103
)
385 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GST104
)
386 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT105
)
387 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS106
)
388 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_SGM107
)
389 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT108
)
390 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS109
)
391 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT110
)
392 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER
)
393 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER
)
394 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX
)
395 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX
)
396 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX
)
397 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX
)
398 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ZINWELL
)
399 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MAX
)
401 /* Customer private range */
402 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MIN
)
403 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_UBNT_E100
)
404 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_UBNT_E200
)
405 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_UBNT_E220
)
406 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DSR1000N
)
407 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_UBNT_E300
)
408 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KONTRON_S1901
)
409 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MAX
)
414 #define ENUM_CHIP_TYPE_CASE(x) \
415 case x: return (&#x[15]); /* Skip CVMX_CHIP_TYPE */
416 static inline const char *cvmx_chip_type_to_string(enum
417 cvmx_chip_types_enum type
)
420 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_NULL
)
421 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_SIM_TYPE_DEPRECATED
)
422 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_OCTEON_SAMPLE
)
423 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_MAX
)
425 return "Unsupported Chip";
428 #endif /* __CVMX_BOOTINFO_H__ */