1 /***********************license start***************
2 * Copyright (c) 2003-2010 Cavium Networks (support@cavium.com). All rights
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
18 * * Neither the name of Cavium Networks nor the names of
19 * its contributors may be used to endorse or promote products
20 * derived from this software without specific prior written
23 * This Software, including technical data, may be subject to U.S. export control
24 * laws, including the U.S. Export Administration Act and its associated
25 * regulations, and may be subject to export or import regulations in other
28 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
29 * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS OR
30 * WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
31 * THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY REPRESENTATION OR
32 * DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, AND CAVIUM
33 * SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES OF TITLE,
34 * MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF
35 * VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR
36 * CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT OF USE OR
37 * PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
38 ***********************license end**************************************/
47 * Header file for simple executive application initialization. This defines
48 * part of the ABI between the bootloader and the application.
49 * <hr>$Revision: 52004 $<hr>
53 #ifndef __CVMX_APP_INIT_H__
54 #define __CVMX_APP_INIT_H__
61 /* Current major and minor versions of the CVMX bootinfo block that is passed
62 ** from the bootloader to the application. This is versioned so that applications
63 ** can properly handle multiple bootloader versions. */
64 #define CVMX_BOOTINFO_MAJ_VER 1
65 #define CVMX_BOOTINFO_MIN_VER 2
68 #if (CVMX_BOOTINFO_MAJ_VER == 1)
69 #define CVMX_BOOTINFO_OCTEON_SERIAL_LEN 20
70 /* This structure is populated by the bootloader. For binary
71 ** compatibility the only changes that should be made are
72 ** adding members to the end of the structure, and the minor
73 ** version should be incremented at that time.
74 ** If an incompatible change is made, the major version
75 ** must be incremented, and the minor version should be reset
78 struct cvmx_bootinfo {
79 uint32_t major_version;
80 uint32_t minor_version;
87 uint32_t exception_base_addr;
91 uint32_t dram_size; /**< DRAM size in megabytes */
92 uint32_t phy_mem_desc_addr; /**< physical address of free memory descriptor block*/
93 uint32_t debugger_flags_base_addr; /**< used to pass flags from app to debugger */
94 uint32_t eclock_hz; /**< CPU clock speed, in hz */
95 uint32_t dclock_hz; /**< DRAM clock speed, in hz */
98 uint8_t board_rev_major;
99 uint8_t board_rev_minor;
103 char board_serial_number[CVMX_BOOTINFO_OCTEON_SERIAL_LEN];
104 uint8_t mac_addr_base[6];
105 uint8_t mac_addr_count;
106 #if (CVMX_BOOTINFO_MIN_VER >= 1)
107 /* Several boards support compact flash on the Octeon boot bus. The CF
108 ** memory spaces may be mapped to different addresses on different boards.
109 ** These are the physical addresses, so care must be taken to use the correct
110 ** XKPHYS/KSEG0 addressing depending on the application's ABI.
111 ** These values will be 0 if CF is not present */
112 uint64_t compact_flash_common_base_addr;
113 uint64_t compact_flash_attribute_base_addr;
114 /* Base address of the LED display (as on EBT3000 board)
115 ** This will be 0 if LED display not present. */
116 uint64_t led_display_base_addr;
118 #if (CVMX_BOOTINFO_MIN_VER >= 2)
119 uint32_t dfa_ref_clock_hz; /**< DFA reference clock in hz (if applicable)*/
120 uint32_t config_flags; /**< flags indicating various configuration options. These flags supercede
121 ** the 'flags' variable and should be used instead if available */
127 typedef struct cvmx_bootinfo cvmx_bootinfo_t;
129 #define CVMX_BOOTINFO_CFG_FLAG_PCI_HOST (1ull << 0)
130 #define CVMX_BOOTINFO_CFG_FLAG_PCI_TARGET (1ull << 1)
131 #define CVMX_BOOTINFO_CFG_FLAG_DEBUG (1ull << 2)
132 #define CVMX_BOOTINFO_CFG_FLAG_NO_MAGIC (1ull << 3)
133 /* This flag is set if the TLB mappings are not contained in the
134 ** 0x10000000 - 0x20000000 boot bus region. */
135 #define CVMX_BOOTINFO_CFG_FLAG_OVERSIZE_TLB_MAPPING (1ull << 4)
136 #define CVMX_BOOTINFO_CFG_FLAG_BREAK (1ull << 5)
138 #endif /* (CVMX_BOOTINFO_MAJ_VER == 1) */
141 /* Type defines for board and chip types */
142 enum cvmx_board_types_enum {
143 CVMX_BOARD_TYPE_NULL = 0,
144 CVMX_BOARD_TYPE_SIM = 1,
145 CVMX_BOARD_TYPE_EBT3000 = 2,
146 CVMX_BOARD_TYPE_KODAMA = 3,
147 CVMX_BOARD_TYPE_NIAGARA = 4, /* Obsolete, no longer supported */
148 CVMX_BOARD_TYPE_NAC38 = 5, /* formerly NAO38 */
149 CVMX_BOARD_TYPE_THUNDER = 6,
150 CVMX_BOARD_TYPE_TRANTOR = 7, /* Obsolete, no longer supported */
151 CVMX_BOARD_TYPE_EBH3000 = 8,
152 CVMX_BOARD_TYPE_EBH3100 = 9,
153 CVMX_BOARD_TYPE_HIKARI = 10,
154 CVMX_BOARD_TYPE_CN3010_EVB_HS5 = 11,
155 CVMX_BOARD_TYPE_CN3005_EVB_HS5 = 12,
156 CVMX_BOARD_TYPE_KBP = 13,
157 CVMX_BOARD_TYPE_CN3020_EVB_HS5 = 14, /* Deprecated, CVMX_BOARD_TYPE_CN3010_EVB_HS5 supports the CN3020 */
158 CVMX_BOARD_TYPE_EBT5800 = 15,
159 CVMX_BOARD_TYPE_NICPRO2 = 16,
160 CVMX_BOARD_TYPE_EBH5600 = 17,
161 CVMX_BOARD_TYPE_EBH5601 = 18,
162 CVMX_BOARD_TYPE_EBH5200 = 19,
163 CVMX_BOARD_TYPE_BBGW_REF = 20,
164 CVMX_BOARD_TYPE_NIC_XLE_4G = 21,
165 CVMX_BOARD_TYPE_EBT5600 = 22,
166 CVMX_BOARD_TYPE_EBH5201 = 23,
167 CVMX_BOARD_TYPE_EBT5200 = 24,
168 CVMX_BOARD_TYPE_CB5600 = 25,
169 CVMX_BOARD_TYPE_CB5601 = 26,
170 CVMX_BOARD_TYPE_CB5200 = 27,
171 CVMX_BOARD_TYPE_GENERIC = 28, /* Special 'generic' board type, supports many boards */
172 CVMX_BOARD_TYPE_EBH5610 = 29,
173 CVMX_BOARD_TYPE_LANAI2_A = 30,
174 CVMX_BOARD_TYPE_LANAI2_U = 31,
175 CVMX_BOARD_TYPE_EBB5600 = 32,
176 CVMX_BOARD_TYPE_EBB6300 = 33,
177 CVMX_BOARD_TYPE_NIC_XLE_10G = 34,
178 CVMX_BOARD_TYPE_LANAI2_G = 35,
179 CVMX_BOARD_TYPE_EBT5810 = 36,
180 CVMX_BOARD_TYPE_NIC10E = 37,
183 /* The range from CVMX_BOARD_TYPE_MAX to CVMX_BOARD_TYPE_CUST_DEFINED_MIN is reserved
184 ** for future SDK use. */
186 /* Set aside a range for customer boards. These numbers are managed
189 CVMX_BOARD_TYPE_CUST_DEFINED_MIN = 10000,
190 CVMX_BOARD_TYPE_CUST_WSX16 = 10001,
191 CVMX_BOARD_TYPE_CUST_NS0216 = 10002,
192 CVMX_BOARD_TYPE_CUST_NB5 = 10003,
193 CVMX_BOARD_TYPE_CUST_WMR500 = 10004,
194 CVMX_BOARD_TYPE_CUST_ITB101 = 10005,
195 CVMX_BOARD_TYPE_CUST_NTE102 = 10006,
196 CVMX_BOARD_TYPE_CUST_AGS103 = 10007,
197 #if !defined(OCTEON_VENDOR_LANNER)
198 CVMX_BOARD_TYPE_CUST_GST104 = 10008,
200 CVMX_BOARD_TYPE_CUST_LANNER_MR955= 10008,
202 CVMX_BOARD_TYPE_CUST_GCT105 = 10009,
203 CVMX_BOARD_TYPE_CUST_AGS106 = 10010,
204 CVMX_BOARD_TYPE_CUST_SGM107 = 10011,
205 CVMX_BOARD_TYPE_CUST_GCT108 = 10012,
206 CVMX_BOARD_TYPE_CUST_AGS109 = 10013,
207 CVMX_BOARD_TYPE_CUST_GCT110 = 10014,
208 CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER = 10015,
209 CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER= 10016,
210 CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX = 10017,
211 CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX = 10018,
212 CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX= 10019,
213 CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX= 10020,
214 #if defined(OCTEON_VENDOR_LANNER)
215 CVMX_BOARD_TYPE_CUST_LANNER_MR730 = 10021,
217 CVMX_BOARD_TYPE_CUST_L2_ZINWELL = 10021,
219 CVMX_BOARD_TYPE_CUST_DEFINED_MAX = 20000,
221 /* Set aside a range for customer private use. The SDK won't
222 ** use any numbers in this range. */
223 CVMX_BOARD_TYPE_CUST_PRIVATE_MIN = 20001,
224 #if defined(OCTEON_VENDOR_LANNER)
225 CVMX_BOARD_TYPE_CUST_LANNER_MR320= 20002,
226 CVMX_BOARD_TYPE_CUST_LANNER_MR321X=20007,
228 CVMX_BOARD_TYPE_CUST_PRIVATE_MAX = 30000,
231 /* Range for IO modules */
232 CVMX_BOARD_TYPE_MODULE_MIN = 30001,
233 CVMX_BOARD_TYPE_MODULE_PCIE_RC_4X = 30002,
234 CVMX_BOARD_TYPE_MODULE_PCIE_EP_4X = 30003,
235 CVMX_BOARD_TYPE_MODULE_SGMII_MARVEL = 30004,
236 CVMX_BOARD_TYPE_MODULE_SFPPLUS_BCM = 30005,
237 CVMX_BOARD_TYPE_MODULE_SRIO = 30006,
238 CVMX_BOARD_TYPE_MODULE_EBB5600_QLM0 = 30007,
239 CVMX_BOARD_TYPE_MODULE_EBB5600_QLM1 = 30008,
240 CVMX_BOARD_TYPE_MODULE_EBB5600_QLM2 = 30009,
241 CVMX_BOARD_TYPE_MODULE_EBB5600_QLM3 = 30010,
242 CVMX_BOARD_TYPE_MODULE_MAX = 31000,
244 /* The remaining range is reserved for future use. */
246 enum cvmx_chip_types_enum {
247 CVMX_CHIP_TYPE_NULL = 0,
248 CVMX_CHIP_SIM_TYPE_DEPRECATED = 1,
249 CVMX_CHIP_TYPE_OCTEON_SAMPLE = 2,
253 /* Compatability alias for NAC38 name change, planned to be removed from SDK 1.7 */
254 #define CVMX_BOARD_TYPE_NAO38 CVMX_BOARD_TYPE_NAC38
256 /* Functions to return string based on type */
257 #define ENUM_BRD_TYPE_CASE(x) case x: return(#x + 16); /* Skip CVMX_BOARD_TYPE_ */
258 static inline const char *cvmx_board_type_to_string(enum cvmx_board_types_enum type)
262 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NULL)
263 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_SIM)
264 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT3000)
265 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KODAMA)
266 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIAGARA)
267 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NAC38)
268 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_THUNDER)
269 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_TRANTOR)
270 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3000)
271 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3100)
272 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_HIKARI)
273 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3010_EVB_HS5)
274 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3005_EVB_HS5)
275 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KBP)
276 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3020_EVB_HS5)
277 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5800)
278 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NICPRO2)
279 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5600)
280 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5601)
281 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5200)
282 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_BBGW_REF)
283 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_4G)
284 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5600)
285 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5201)
286 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5200)
287 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5600)
288 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5601)
289 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5200)
290 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_GENERIC)
291 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5610)
292 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_A)
293 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_U)
294 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB5600)
295 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6300)
296 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_10G)
297 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_G)
298 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5810)
299 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E)
300 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MAX)
302 /* Customer boards listed here */
303 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MIN)
304 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WSX16)
305 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NS0216)
306 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NB5)
307 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WMR500)
308 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_ITB101)
309 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NTE102)
310 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS103)
311 #if !defined(OCTEON_VENDOR_LANNER)
312 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GST104)
314 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_LANNER_MR955)
316 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT105)
317 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS106)
318 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_SGM107)
319 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT108)
320 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS109)
321 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT110)
322 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER)
323 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER)
324 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX)
325 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX)
326 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX)
327 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX)
328 #if defined(OCTEON_VENDOR_LANNER)
329 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_LANNER_MR730)
331 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ZINWELL)
334 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MAX)
336 /* Customer private range */
337 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MIN)
338 #if defined(OCTEON_VENDOR_LANNER)
339 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_LANNER_MR320)
340 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_LANNER_MR321X)
342 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MAX)
345 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_MIN)
346 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_PCIE_RC_4X)
347 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_PCIE_EP_4X)
348 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_SGMII_MARVEL)
349 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_SFPPLUS_BCM)
350 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_SRIO)
351 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_EBB5600_QLM0)
352 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_EBB5600_QLM1)
353 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_EBB5600_QLM2)
354 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_EBB5600_QLM3)
355 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MODULE_MAX)
357 return "Unsupported Board";
360 #define ENUM_CHIP_TYPE_CASE(x) case x: return(#x + 15); /* Skip CVMX_CHIP_TYPE */
361 static inline const char *cvmx_chip_type_to_string(enum cvmx_chip_types_enum type)
365 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_NULL)
366 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_SIM_TYPE_DEPRECATED)
367 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_OCTEON_SAMPLE)
368 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_MAX)
370 return "Unsupported Chip";
374 extern int cvmx_debug_uart;
382 #endif /* __CVMX_APP_INIT_H__ */