1/* NFP ELF support for BFD. 2 Copyright (C) 2017-2020 Free Software Foundation, Inc. 3 Contributed by Francois H. Theron <francois.theron@netronome.com> 4 5 This file is part of BFD, the Binary File Descriptor library. 6 7 This program is free software; you can redistribute it and/or modify 8 it under the terms of the GNU General Public License as published by 9 the Free Software Foundation; either version 3 of the License, or 10 (at your option) any later version. 11 12 This program is distributed in the hope that it will be useful, 13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 GNU General Public License for more details. 16 17 You should have received a copy of the GNU General Public License 18 along with this program; if not, write to the Free Software Foundation, 19 Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */ 20 21#ifndef _ELF_NFP_H 22#define _ELF_NFP_H 23 24#include "bfd.h" 25#include "elf/common.h" 26#include "elf/reloc-macros.h" 27#include "bfd_stdint.h" 28 29#ifdef __cplusplus 30extern "C" 31{ 32#endif 33 34#define ET_NFP_PARTIAL_REL (ET_LOPROC + ET_REL) 35#define ET_NFP_PARTIAL_EXEC (ET_LOPROC + ET_EXEC) 36 37/* NFP e_flags - chip family 38 Valid values for FAMILY are: 39 0x3200 - NFP-32xx 40 0x6000 - NFP-6xxx/NFP-4xxx. */ 41#define EF_NFP_MACH(ef_nfp) (((ef_nfp) >> 8) & 0xFFFF) 42#define EF_NFP_SET_MACH(nfp_fam) (((nfp_fam) & 0xFFFF) << 8) 43 44#define E_NFP_MACH_3200 0x3200 45#define E_NFP_MACH_6000 0x6000 46 47#define NFP_3200_CPPTGT_MSF0 1 48#define NFP_3200_CPPTGT_QDR 2 49#define NFP_3200_CPPTGT_MSF1 3 50#define NFP_3200_CPPTGT_HASH 4 51#define NFP_3200_CPPTGT_MU 7 52#define NFP_3200_CPPTGT_GS 8 53#define NFP_3200_CPPTGT_PCIE 9 54#define NFP_3200_CPPTGT_ARM 10 55#define NFP_3200_CPPTGT_CRYPTO 12 56#define NFP_3200_CPPTGT_CAP 13 57#define NFP_3200_CPPTGT_CT 14 58#define NFP_3200_CPPTGT_CLS 15 59 60#define NFP_6000_CPPTGT_NBI 1 61#define NFP_6000_CPPTGT_VQDR 2 62#define NFP_6000_CPPTGT_ILA 6 63#define NFP_6000_CPPTGT_MU 7 64#define NFP_6000_CPPTGT_PCIE 9 65#define NFP_6000_CPPTGT_ARM 10 66#define NFP_6000_CPPTGT_CRYPTO 12 67#define NFP_6000_CPPTGT_CTXPB 14 68#define NFP_6000_CPPTGT_CLS 15 69 70/* NFP Section types 71 MECONFIG - NFP-32xx only, ME CSR configurations 72 INITREG - A generic register initialisation section (chip or ME CSRs/GPRs) 73 UDEBUG - Legacy-style debug data section. */ 74#define SHT_NFP_MECONFIG (SHT_LOPROC + 1) 75#define SHT_NFP_INITREG (SHT_LOPROC + 2) 76#define SHT_NFP_UDEBUG SHT_LOUSER 77 78/* NFP SECTION flags 79 ELF-64 sh_flags is 64-bit, but there is no info on what the upper 32 bits 80 are expected to be used for, it is not marked reserved either. 81 We'll use them for NFP-specific flags since we don't use ELF-32. 82 83 INIT - Sections that are loaded and executed before the final text 84 microcode. Non-code INIT sections are loaded first, then other 85 memory secions, then INIT2 sections, then INIT-code sections. 86 INIT2 - Sections that are loaded before INIT-code sections, used for 87 transient configuration before executing INIT-code section 88 microcode. 89 SCS - The number of additional ME codestores being shared with the group's 90 base ME of the section, e.g. 0 for no SCS, 1 for dual and 3 for 91 quad. If this is 0 it is possible that stagger-style SCS codestore 92 sections are being used. For stagger-style each section is simply 93 loaded directly to the ME it is assigned to. If these flags are 94 used, virtual address space loading will be used - one large section 95 loaded to the group's base ME will be packed across shared MEs by 96 hardware. This is not available on all ME versions. 97 98 NFP_ELF_SHF_GET_SCS (val) returns the number of additional codestores 99 being shared with the group's base ME, e.g. 0 for no SCS, 100 1 for dual SCS, 3 for quad SCS. */ 101 102#define SHF_NFP_INIT 0x80000000 103#define SHF_NFP_INIT2 0x40000000 104#define SHF_NFP_SCS(shf) (((shf) >> 32) & 0xFF) 105#define SHF_NFP_SET_SCS(v) (((BFD_HOST_U_64_BIT)((v) & 0xFF)) << 32) 106 107/* NFP Section Info 108 For PROGBITS and NOBITS sections: 109 MEMTYPE - the memory type 110 DOMAIN - The island ID and ME number where the data will be loaded. 111 For NFP-32xx, this is an island number or linear ME number. 112 For NFP-6xxx, DOMAIN<15:8> == island ID, DOMAIN<7:0> is 0 based 113 ME number (if applicable). 114 For INITREG sections: 115 ISLAND - island ID (if it's a ME target, ME numbers are in the 116 section data) 117 CPPTGT - CPP Target ID 118 CPPACTRD - CPP Read Action 119 CPPTOKRD - CPP Read Token 120 CPPACTWR - CPP Write Action 121 CPPTOKWR - CPP Write Token 122 ORDER - Controls the order in which the loader processes sections with 123 the same info fields. */ 124 125#define SHI_NFP_DOMAIN(shi) (((shi) >> 16) & 0xFFFF) 126#define SHI_NFP_MEMTYPE(shi) ( (shi) & 0xFFFF) 127#define SHI_NFP_SET_DOMAIN(v) (((v) & 0xFFFF) << 16) 128#define SHI_NFP_SET_MEMTYPE(v) ( (v) & 0xFFFF) 129 130#define SHI_NFP_IREG_ISLAND(shi) (((shi) >> 26) & 0x3F) 131#define SHI_NFP_IREG_CPPTGT(shi) (((shi) >> 22) & 0xF) 132#define SHI_NFP_IREG_CPPACTRD(shi) (((shi) >> 17) & 0x1F) 133#define SHI_NFP_IREG_CPPTOKRD(shi) (((shi) >> 15) & 0x3) 134#define SHI_NFP_IREG_CPPACTWR(shi) (((shi) >> 10) & 0x1F) 135#define SHI_NFP_IREG_CPPTOKWR(shi) (((shi) >> 8) & 0x3) 136#define SHI_NFP_IREG_ORDER(shi) ( (shi) & 0xFF) 137#define SHI_NFP_SET_IREG_ISLAND(v) (((v) & 0x3F) << 26) 138#define SHI_NFP_SET_IREG_CPPTGT(v) (((v) & 0xF) << 22) 139#define SHI_NFP_SET_IREG_CPPACTRD(v) (((v) & 0x1F) << 17) 140#define SHI_NFP_SET_IREG_CPPTOKRD(v) (((v) & 0x3) << 15) 141#define SHI_NFP_SET_IREG_CPPACTWR(v) (((v) & 0x1F) << 10) 142#define SHI_NFP_SET_IREG_CPPTOKWR(v) (((v) & 0x3) << 8) 143#define SHI_NFP_SET_IREG_ORDER(v) ( (v) & 0xFF) 144 145/* CtXpb/reflect_read_sig_init/reflect_write_sig_init 146 identifies Init-CSR sections for ME CSRs. */ 147#define SHI_NFP_6000_IS_IREG_MECSR(shi) ( \ 148 SHI_NFP_IREG_CPPTGT (shi) == NFP_6000_CPPTGT_CTXPB \ 149 && SHI_NFP_IREG_CPPACTRD (shi) == 2 \ 150 && SHI_NFP_IREG_CPPTOKRD (shi) == 1 \ 151 && SHI_NFP_IREG_CPPACTWR (shi) == 3 \ 152 && SHI_NFP_IREG_CPPTOKWR (shi) == 1 \ 153) 154 155/* Transient INITREG sections will be validated against the target 156 but will not be kept - validate, write or read and discard. 157 They will still be handled last (in order). */ 158#define SHI_NFP_IREG_ORDER_TRANSIENT 0xFF 159 160/* Below are some extra macros to translate SHI fields in more specific 161 contexts. 162 163 For NFP-32xx, DOMAIN is set to a global linear ME number (0 to 39). 164 An NFP-32xx has 8 MEs per island and up to 5 islands. */ 165 166#define SHI_NFP_3200_ISLAND(shi) ((SHI_NFP_DOMAIN (shi) >> 3) & 0x7) 167#define SHI_NFP_3200_MENUM(shi) ( SHI_NFP_DOMAIN (shi) & 0x7) 168#define SHI_NFP_SET_3200_ISLAND(v) SHI_NFP_SET_DOMAIN (((v) & 0x7) << 3) 169#define SHI_NFP_SET_3200_MENUM(v) SHI_NFP_SET_DOMAIN ( (v) & 0x7) 170 171#define SHI_NFP_ISLAND(shi) ((SHI_NFP_DOMAIN (shi) >> 8) & 0xFF) 172#define SHI_NFP_MENUM(shi) ( SHI_NFP_DOMAIN (shi) & 0xFF) 173#define SHI_NFP_SET_ISLAND(shi) SHI_NFP_SET_DOMAIN (((shi) & 0xFF) << 8) 174#define SHI_NFP_SET_MENUM(shi) SHI_NFP_SET_DOMAIN ( (shi) & 0xFF) 175 176#define SHI_NFP_MEMTYPE_NONE 0 177#define SHI_NFP_MEMTYPE_USTORE 1 178#define SHI_NFP_MEMTYPE_LMEM 2 179#define SHI_NFP_MEMTYPE_CLS 3 180#define SHI_NFP_MEMTYPE_DRAM 4 181#define SHI_NFP_MEMTYPE_MU 4 182#define SHI_NFP_MEMTYPE_SRAM 5 183#define SHI_NFP_MEMTYPE_GS 6 184#define SHI_NFP_MEMTYPE_PPC_LMEM 7 185#define SHI_NFP_MEMTYPE_PPC_SMEM 8 186#define SHI_NFP_MEMTYPE_EMU_CACHE 9 187 188/* VTP_FORCE is for use by the NFP Linker+Loader only. */ 189#define NFP_IREG_VTP_FORCE 0 190#define NFP_IREG_VTP_CONST 1 191#define NFP_IREG_VTP_REQUIRED 2 192#define NFP_IREG_VTP_VOLATILE_INIT 3 193#define NFP_IREG_VTP_VOLATILE_NOINIT 4 194#define NFP_IREG_VTP_INVALID 5 195 196/* Init-CSR entry w0 fields: 197 NLW - Not Last Word 198 CTX - ME context number (if applicable) 199 VTP - Value type 200 COH - CPP Offset High 8 bits. */ 201#define NFP_IREG_ENTRY_WO_NLW(w0) (((w0) >> 31) & 0x1) 202#define NFP_IREG_ENTRY_WO_CTX(w0) (((w0) >> 28) & 0x7) 203#define NFP_IREG_ENTRY_WO_VTP(w0) (((w0) >> 25) & 0x7) 204#define NFP_IREG_ENTRY_WO_COH(w0) (((w0) >> 0) & 0xFF) 205 206typedef struct 207{ 208 uint32_t w0; 209 uint32_t cpp_offset_lo; 210 uint32_t val; 211 uint32_t mask; 212} Elf_Nfp_InitRegEntry; 213 214typedef struct 215{ 216 uint32_t ctx_enables; 217 uint32_t entry; 218 uint32_t misc_control; 219 uint32_t reserved; 220} Elf_Nfp_MeConfig; 221 222/* Relocations. */ 223START_RELOC_NUMBERS (elf_nfp3200_reloc_type) 224 RELOC_NUMBER (R_NFP3200_NOTYPE, 0) 225 RELOC_NUMBER (R_NFP3200_W32LE, 1) 226 RELOC_NUMBER (R_NFP3200_SRC8_A, 2) 227 RELOC_NUMBER (R_NFP3200_SRC8_B, 3) 228 RELOC_NUMBER (R_NFP3200_IMMED8_I, 4) 229 RELOC_NUMBER (R_NFP3200_SC, 5) 230 RELOC_NUMBER (R_NFP3200_IMMED_LO16_I_A, 6) 231 RELOC_NUMBER (R_NFP3200_IMMED_LO16_I_B, 7) 232 RELOC_NUMBER (R_NFP3200_SRC7_B, 8) 233 RELOC_NUMBER (R_NFP3200_SRC7_A, 9) 234 RELOC_NUMBER (R_NFP3200_SRC8_I_B, 10) 235 RELOC_NUMBER (R_NFP3200_SRC8_I_A, 11) 236 RELOC_NUMBER (R_NFP3200_IMMED_HI16_I_A, 12) 237 RELOC_NUMBER (R_NFP3200_IMMED_HI16_I_B, 13) 238 RELOC_NUMBER (R_NFP3200_RSVD_0, 14) 239 RELOC_NUMBER (R_NFP3200_RSVD_1, 15) 240 RELOC_NUMBER (R_NFP3200_RSVD_2, 16) 241 RELOC_NUMBER (R_NFP3200_RSVD_3, 17) 242 RELOC_NUMBER (R_NFP3200_RSVD_4, 18) 243 RELOC_NUMBER (R_NFP3200_RSVD_5, 19) 244 RELOC_NUMBER (R_NFP3200_RSVD_6, 20) 245 RELOC_NUMBER (R_NFP3200_W64LE, 21) 246 RELOC_NUMBER (R_NFP3200_W32BE, 22) 247 RELOC_NUMBER (R_NFP3200_W64BE, 23) 248 RELOC_NUMBER (R_NFP3200_W32LE_AND, 24) 249 RELOC_NUMBER (R_NFP3200_W32BE_AND, 25) 250 RELOC_NUMBER (R_NFP3200_W32LE_OR, 26) 251 RELOC_NUMBER (R_NFP3200_W32BE_OR, 27) 252 RELOC_NUMBER (R_NFP3200_W64LE_AND, 28) 253 RELOC_NUMBER (R_NFP3200_W64BE_AND, 29) 254 RELOC_NUMBER (R_NFP3200_W64LE_OR, 30) 255 RELOC_NUMBER (R_NFP3200_W64BE_OR, 31) 256END_RELOC_NUMBERS (R_NFP3200_MAX) 257 258START_RELOC_NUMBERS (elf_nfp_reloc_type) 259 RELOC_NUMBER (R_NFP_NOTYPE, 0) 260 RELOC_NUMBER (R_NFP_W32LE, 1) 261 RELOC_NUMBER (R_NFP_SRC8_A, 2) 262 RELOC_NUMBER (R_NFP_SRC8_B, 3) 263 RELOC_NUMBER (R_NFP_IMMED8_I, 4) 264 RELOC_NUMBER (R_NFP_SC, 5) 265 RELOC_NUMBER (R_NFP_IMMED_LO16_I_A, 6) 266 RELOC_NUMBER (R_NFP_IMMED_LO16_I_B, 7) 267 RELOC_NUMBER (R_NFP_SRC7_B, 8) 268 RELOC_NUMBER (R_NFP_SRC7_A, 9) 269 RELOC_NUMBER (R_NFP_SRC8_I_B, 10) 270 RELOC_NUMBER (R_NFP_SRC8_I_A, 11) 271 RELOC_NUMBER (R_NFP_IMMED_HI16_I_A, 12) 272 RELOC_NUMBER (R_NFP_IMMED_HI16_I_B, 13) 273 RELOC_NUMBER (R_NFP_W64LE, 14) 274 RELOC_NUMBER (R_NFP_SH_INFO, 15) 275 RELOC_NUMBER (R_NFP_W32BE, 16) 276 RELOC_NUMBER (R_NFP_W64BE, 17) 277 RELOC_NUMBER (R_NFP_W32_29_24, 18) 278 RELOC_NUMBER (R_NFP_W32LE_AND, 19) 279 RELOC_NUMBER (R_NFP_W32BE_AND, 20) 280 RELOC_NUMBER (R_NFP_W32LE_OR, 21) 281 RELOC_NUMBER (R_NFP_W32BE_OR, 22) 282 RELOC_NUMBER (R_NFP_W64LE_AND, 23) 283 RELOC_NUMBER (R_NFP_W64BE_AND, 24) 284 RELOC_NUMBER (R_NFP_W64LE_OR, 25) 285 RELOC_NUMBER (R_NFP_W64BE_OR, 26) 286END_RELOC_NUMBERS (R_NFP_MAX) 287 288#ifdef __cplusplus 289} 290#endif 291 292#endif /* _ELF_NFP_H */ 293