arch/mips/mach-octeon/include/mach/cvmx-bootinfo.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (C) 2020 Marvell International Ltd.
   4  */
   5
   6 /*
   7  * Header file containing the ABI with the bootloader.
   8  */
   9
  10 #ifndef __CVMX_BOOTINFO_H__
  11 #define __CVMX_BOOTINFO_H__
  12
  13 #include "cvmx-coremask.h"
  14
  15 /*
  16  * Current major and minor versions of the CVMX bootinfo block that is
  17  * passed from the bootloader to the application.  This is versioned
  18  * so that applications can properly handle multiple bootloader
  19  * versions.
  20  */
  21 #define CVMX_BOOTINFO_MAJ_VER 1
  22 #define CVMX_BOOTINFO_MIN_VER 4
  23
  24 #if (CVMX_BOOTINFO_MAJ_VER == 1)
  25 #define CVMX_BOOTINFO_OCTEON_SERIAL_LEN 20
  26 /*
  27  * This structure is populated by the bootloader.  For binary
  28  * compatibility the only changes that should be made are
  29  * adding members to the end of the structure, and the minor
  30  * version should be incremented at that time.
  31  * If an incompatible change is made, the major version
  32  * must be incremented, and the minor version should be reset
  33  * to 0.
  34  */
  35 struct cvmx_bootinfo {
  36         u32 major_version;
  37         u32 minor_version;
  38
  39         u64 stack_top;
  40         u64 heap_base;
  41         u64 heap_end;
  42         u64 desc_vaddr;
  43
  44         u32 exception_base_addr;
  45         u32 stack_size;
  46         u32 flags;
  47         u32 core_mask;
  48         /* DRAM size in megabytes */
  49         u32 dram_size;
  50         /* physical address of free memory descriptor block*/
  51         u32 phy_mem_desc_addr;
  52         /* used to pass flags from app to debugger */
  53         u32 debugger_flags_base_addr;
  54
  55         /* CPU clock speed, in hz */
  56         u32 eclock_hz;
  57
  58         /* DRAM clock speed, in hz */
  59         u32 dclock_hz;
  60
  61         u32 reserved0;
  62         u16 board_type;
  63         u8 board_rev_major;
  64         u8 board_rev_minor;
  65         u16 reserved1;
  66         u8 reserved2;
  67         u8 reserved3;
  68         char board_serial_number[CVMX_BOOTINFO_OCTEON_SERIAL_LEN];
  69         u8 mac_addr_base[6];
  70         u8 mac_addr_count;
  71 #if (CVMX_BOOTINFO_MIN_VER >= 1)
  72         /*
  73          * Several boards support compact flash on the Octeon boot
  74          * bus.  The CF memory spaces may be mapped to different
  75          * addresses on different boards.  These are the physical
  76          * addresses, so care must be taken to use the correct
  77          * XKPHYS/KSEG0 addressing depending on the application's
  78          * ABI.  These values will be 0 if CF is not present.
  79          */
  80         u64 compact_flash_common_base_addr;
  81         u64 compact_flash_attribute_base_addr;
  82         /*
  83          * Base address of the LED display (as on EBT3000 board)
  84          * This will be 0 if LED display not present.
  85          */
  86         u64 led_display_base_addr;
  87 #endif
  88 #if (CVMX_BOOTINFO_MIN_VER >= 2)
  89         /* DFA reference clock in hz (if applicable)*/
  90         u32 dfa_ref_clock_hz;
  91
  92         /*
  93          * flags indicating various configuration options.  These
  94          * flags supercede the 'flags' variable and should be used
  95          * instead if available.
  96          */
  97         u32 config_flags;
  98 #endif
  99 #if (CVMX_BOOTINFO_MIN_VER >= 3)
 100         /*
 101          * Address of the OF Flattened Device Tree structure
 102          * describing the board.
 103          */
 104         u64 fdt_addr;
 105 #endif
 106 #if (CVMX_BOOTINFO_MIN_VER >= 4)
 107         /*
 108          * Coremask used for processors with more than 32 cores
 109          * or with OCI.  This replaces core_mask.
 110          */
 111         struct cvmx_coremask ext_core_mask;
 112 #endif
 113 };
 114
 115 #define CVMX_BOOTINFO_CFG_FLAG_PCI_HOST                 (1ull << 0)
 116 #define CVMX_BOOTINFO_CFG_FLAG_PCI_TARGET               (1ull << 1)
 117 #define CVMX_BOOTINFO_CFG_FLAG_DEBUG                    (1ull << 2)
 118 #define CVMX_BOOTINFO_CFG_FLAG_NO_MAGIC                 (1ull << 3)
 119 /*
 120  * This flag is set if the TLB mappings are not contained in the
 121  * 0x10000000 - 0x20000000 boot bus region.
 122  */
 123 #define CVMX_BOOTINFO_CFG_FLAG_OVERSIZE_TLB_MAPPING     (1ull << 4)
 124 #define CVMX_BOOTINFO_CFG_FLAG_BREAK                    (1ull << 5)
 125
 126 #endif /*   (CVMX_BOOTINFO_MAJ_VER == 1) */
 127
 128 /* Type defines for board and chip types */
 129 enum cvmx_board_types_enum {
 130         CVMX_BOARD_TYPE_NULL = 0,
 131         CVMX_BOARD_TYPE_SIM = 1,
 132         CVMX_BOARD_TYPE_EBT3000 = 2,
 133         CVMX_BOARD_TYPE_KODAMA = 3,
 134         CVMX_BOARD_TYPE_NIAGARA = 4,
 135         CVMX_BOARD_TYPE_NAC38 = 5,      /* formerly NAO38 */
 136         CVMX_BOARD_TYPE_THUNDER = 6,
 137         CVMX_BOARD_TYPE_TRANTOR = 7,
 138         CVMX_BOARD_TYPE_EBH3000 = 8,
 139         CVMX_BOARD_TYPE_EBH3100 = 9,
 140         CVMX_BOARD_TYPE_HIKARI = 10,
 141         CVMX_BOARD_TYPE_CN3010_EVB_HS5 = 11,
 142         CVMX_BOARD_TYPE_CN3005_EVB_HS5 = 12,
 143         CVMX_BOARD_TYPE_KBP = 13,
 144         /* Deprecated, CVMX_BOARD_TYPE_CN3010_EVB_HS5 supports the CN3020 */
 145         CVMX_BOARD_TYPE_CN3020_EVB_HS5 = 14,
 146         CVMX_BOARD_TYPE_EBT5800 = 15,
 147         CVMX_BOARD_TYPE_NICPRO2 = 16,
 148         CVMX_BOARD_TYPE_EBH5600 = 17,
 149         CVMX_BOARD_TYPE_EBH5601 = 18,
 150         CVMX_BOARD_TYPE_EBH5200 = 19,
 151         CVMX_BOARD_TYPE_BBGW_REF = 20,
 152         CVMX_BOARD_TYPE_NIC_XLE_4G = 21,
 153         CVMX_BOARD_TYPE_EBT5600 = 22,
 154         CVMX_BOARD_TYPE_EBH5201 = 23,
 155         CVMX_BOARD_TYPE_EBT5200 = 24,
 156         CVMX_BOARD_TYPE_CB5600  = 25,
 157         CVMX_BOARD_TYPE_CB5601  = 26,
 158         CVMX_BOARD_TYPE_CB5200  = 27,
 159         /* Special 'generic' board type, supports many boards */
 160         CVMX_BOARD_TYPE_GENERIC = 28,
 161         CVMX_BOARD_TYPE_EBH5610 = 29,
 162         CVMX_BOARD_TYPE_LANAI2_A = 30,
 163         CVMX_BOARD_TYPE_LANAI2_U = 31,
 164         CVMX_BOARD_TYPE_EBB5600 = 32,
 165         CVMX_BOARD_TYPE_EBB6300 = 33,
 166         CVMX_BOARD_TYPE_NIC_XLE_10G = 34,
 167         CVMX_BOARD_TYPE_LANAI2_G = 35,
 168         CVMX_BOARD_TYPE_EBT5810 = 36,
 169         CVMX_BOARD_TYPE_NIC10E = 37,
 170         CVMX_BOARD_TYPE_EP6300C = 38,
 171         CVMX_BOARD_TYPE_EBB6800 = 39,
 172         CVMX_BOARD_TYPE_NIC4E = 40,
 173         CVMX_BOARD_TYPE_NIC2E = 41,
 174         CVMX_BOARD_TYPE_EBB6600 = 42,
 175         CVMX_BOARD_TYPE_REDWING = 43,
 176         CVMX_BOARD_TYPE_NIC68_4 = 44,
 177         CVMX_BOARD_TYPE_NIC10E_66 = 45,
 178         CVMX_BOARD_TYPE_MAX,
 179
 180         /*
 181          * The range from CVMX_BOARD_TYPE_MAX to
 182          * CVMX_BOARD_TYPE_CUST_DEFINED_MIN is reserved for future
 183          * SDK use.
 184          */
 185
 186         /*
 187          * Set aside a range for customer boards.  These numbers are managed
 188          * by Cavium.
 189          */
 190         CVMX_BOARD_TYPE_CUST_DEFINED_MIN = 10000,
 191         CVMX_BOARD_TYPE_CUST_WSX16 = 10001,
 192         CVMX_BOARD_TYPE_CUST_NS0216 = 10002,
 193         CVMX_BOARD_TYPE_CUST_NB5 = 10003,
 194         CVMX_BOARD_TYPE_CUST_WMR500 = 10004,
 195         CVMX_BOARD_TYPE_CUST_ITB101 = 10005,
 196         CVMX_BOARD_TYPE_CUST_NTE102 = 10006,
 197         CVMX_BOARD_TYPE_CUST_AGS103 = 10007,
 198         CVMX_BOARD_TYPE_CUST_GST104 = 10008,
 199         CVMX_BOARD_TYPE_CUST_GCT105 = 10009,
 200         CVMX_BOARD_TYPE_CUST_AGS106 = 10010,
 201         CVMX_BOARD_TYPE_CUST_SGM107 = 10011,
 202         CVMX_BOARD_TYPE_CUST_GCT108 = 10012,
 203         CVMX_BOARD_TYPE_CUST_AGS109 = 10013,
 204         CVMX_BOARD_TYPE_CUST_GCT110 = 10014,
 205         CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER = 10015,
 206         CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER = 10016,
 207         CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX = 10017,
 208         CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX = 10018,
 209         CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX = 10019,
 210         CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX = 10020,
 211         CVMX_BOARD_TYPE_CUST_L2_ZINWELL = 10021,
 212         CVMX_BOARD_TYPE_CUST_DEFINED_MAX = 20000,
 213
 214         /*
 215          * Set aside a range for customer private use.  The SDK won't
 216          * use any numbers in this range.
 217          */
 218         CVMX_BOARD_TYPE_CUST_PRIVATE_MIN = 20001,
 219         CVMX_BOARD_TYPE_UBNT_E100 = 20002,
 220         CVMX_BOARD_TYPE_CUST_DSR1000N = 20006,
 221         CVMX_BOARD_TYPE_KONTRON_S1901 = 21901,
 222         CVMX_BOARD_TYPE_CUST_PRIVATE_MAX = 30000,
 223
 224         /* The remaining range is reserved for future use. */
 225 };
 226
 227 enum cvmx_chip_types_enum {
 228         CVMX_CHIP_TYPE_NULL = 0,
 229         CVMX_CHIP_SIM_TYPE_DEPRECATED = 1,
 230         CVMX_CHIP_TYPE_OCTEON_SAMPLE = 2,
 231         CVMX_CHIP_TYPE_MAX,
 232 };
 233
 234 /*
 235  * Compatibility alias for NAC38 name change, planned to be removed
 236  * from SDK 1.7
 237  */
 238 #define CVMX_BOARD_TYPE_NAO38   CVMX_BOARD_TYPE_NAC38
 239
 240 /* Functions to return string based on type */
 241 #define ENUM_BRD_TYPE_CASE(x)                                           \
 242         case x:                                                         \
 243                 return(#x + 16)         /* Skip CVMX_BOARD_TYPE_ */
 244
 245 static inline const char *cvmx_board_type_to_string(enum
 246                                                     cvmx_board_types_enum type)
 247 {
 248         switch (type) {
 249                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NULL);
 250                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_SIM);
 251                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT3000);
 252                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KODAMA);
 253                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIAGARA);
 254                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NAC38);
 255                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_THUNDER);
 256                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_TRANTOR);
 257                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3000);
 258                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3100);
 259                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_HIKARI);
 260                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3010_EVB_HS5);
 261                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3005_EVB_HS5);
 262                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KBP);
 263                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3020_EVB_HS5);
 264                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5800);
 265                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NICPRO2);
 266                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5600);
 267                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5601);
 268                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5200);
 269                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_BBGW_REF);
 270                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_4G);
 271                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5600);
 272                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5201);
 273                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5200);
 274                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5600);
 275                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5601);
 276                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5200);
 277                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_GENERIC);
 278                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5610);
 279                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_A);
 280                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_U);
 281                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB5600);
 282                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6300);
 283                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_10G);
 284                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_G);
 285                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5810);
 286                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E);
 287                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EP6300C);
 288                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6800);
 289                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC4E);
 290                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC2E);
 291                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6600);
 292                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_REDWING);
 293                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC68_4);
 294                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E_66);
 295                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MAX);
 296
 297                 /* Customer boards listed here */
 298                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MIN);
 299                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WSX16);
 300                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NS0216);
 301                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NB5);
 302                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WMR500);
 303                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_ITB101);
 304                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NTE102);
 305                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS103);
 306                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GST104);
 307                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT105);
 308                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS106);
 309                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_SGM107);
 310                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT108);
 311                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS109);
 312                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT110);
 313                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER);
 314                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER);
 315                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX);
 316                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX);
 317                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX);
 318                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX);
 319                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ZINWELL);
 320                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MAX);
 321
 322                 /* Customer private range */
 323                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MIN);
 324                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_UBNT_E100);
 325                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DSR1000N);
 326                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KONTRON_S1901);
 327                 ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MAX);
 328         }
 329
 330         return NULL;
 331 }
 332
 333 #define ENUM_CHIP_TYPE_CASE(x)                                          \
 334         case x:                                                         \
 335                 return(#x + 15)         /* Skip CVMX_CHIP_TYPE */
 336
 337 static inline const char *cvmx_chip_type_to_string(enum
 338                                                    cvmx_chip_types_enum type)
 339 {
 340         switch (type) {
 341                 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_NULL);
 342                 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_SIM_TYPE_DEPRECATED);
 343                 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_OCTEON_SAMPLE);
 344                 ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_MAX);
 345         }
 346
 347         return "Unsupported Chip";
 348 }
 349
 350 #endif /* __CVMX_BOOTINFO_H__ */