/* SPDX-License-Identifier: GPL-2.0 * * Copyright 2018-2020 HabanaLabs, Ltd. * All Rights Reserved. * */ #ifndef HL_BOOT_IF_H #define HL_BOOT_IF_H #define LKD_HARD_RESET_MAGIC 0xED7BD694 /* deprecated - do not use */ #define HL_POWER9_HOST_MAGIC 0x1DA30009 #define BOOT_FIT_SRAM_OFFSET 0x200000 #define VERSION_MAX_LEN 128 enum cpu_boot_err { CPU_BOOT_ERR_DRAM_INIT_FAIL = 0, CPU_BOOT_ERR_FIT_CORRUPTED = 1, CPU_BOOT_ERR_TS_INIT_FAIL = 2, CPU_BOOT_ERR_DRAM_SKIPPED = 3, CPU_BOOT_ERR_BMC_WAIT_SKIPPED = 4, CPU_BOOT_ERR_NIC_DATA_NOT_RDY = 5, CPU_BOOT_ERR_NIC_FW_FAIL = 6, CPU_BOOT_ERR_SECURITY_NOT_RDY = 7, CPU_BOOT_ERR_SECURITY_FAIL = 8, CPU_BOOT_ERR_EFUSE_FAIL = 9, CPU_BOOT_ERR_PRI_IMG_VER_FAIL = 10, CPU_BOOT_ERR_SEC_IMG_VER_FAIL = 11, CPU_BOOT_ERR_PLL_FAIL = 12, CPU_BOOT_ERR_DEVICE_UNUSABLE_FAIL = 13, CPU_BOOT_ERR_BOOT_FW_CRIT_ERR = 18, CPU_BOOT_ERR_BINNING_FAIL = 19, CPU_BOOT_ERR_TPM_FAIL = 20, CPU_BOOT_ERR_TMP_THRESH_INIT_FAIL = 21, CPU_BOOT_ERR_EEPROM_FAIL = 22, CPU_BOOT_ERR_ENG_ARC_MEM_SCRUB_FAIL = 23, CPU_BOOT_ERR_ENABLED = 31, CPU_BOOT_ERR_SCND_EN = 63, CPU_BOOT_ERR_LAST = 64 /* we have 2 registers of 32 bits */ }; /* * Mask for fatal failures * This mask contains all possible fatal failures, and a dynamic code * will clear the non-relevant ones. */ #define CPU_BOOT_ERR_FATAL_MASK \ ((1 << CPU_BOOT_ERR_DRAM_INIT_FAIL) | \ (1 << CPU_BOOT_ERR_PLL_FAIL) | \ (1 << CPU_BOOT_ERR_DEVICE_UNUSABLE_FAIL) | \ (1 << CPU_BOOT_ERR_BINNING_FAIL) | \ (1 << CPU_BOOT_ERR_DRAM_SKIPPED) | \ (1 << CPU_BOOT_ERR_ENG_ARC_MEM_SCRUB_FAIL) | \ (1 << CPU_BOOT_ERR_EEPROM_FAIL)) /* * CPU error bits in BOOT_ERROR registers * * CPU_BOOT_ERR0_DRAM_INIT_FAIL DRAM initialization failed. * DRAM is not reliable to use. * * CPU_BOOT_ERR0_FIT_CORRUPTED FIT data integrity verification of the * image provided by the host has failed. * * CPU_BOOT_ERR0_TS_INIT_FAIL Thermal Sensor initialization failed. * Boot continues as usual, but keep in * mind this is a warning. * * CPU_BOOT_ERR0_DRAM_SKIPPED DRAM initialization has been skipped. * Skipping DRAM initialization has been * requested (e.g. strap, command, etc.) * and FW skipped the DRAM initialization. * Host can initialize the DRAM. * * CPU_BOOT_ERR0_BMC_WAIT_SKIPPED Waiting for BMC data will be skipped. * Meaning the BMC data might not be * available until reset. * * CPU_BOOT_ERR0_NIC_DATA_NOT_RDY NIC data from BMC is not ready. * BMC has not provided the NIC data yet. * Once provided this bit will be cleared. * * CPU_BOOT_ERR0_NIC_FW_FAIL NIC FW loading failed. * The NIC FW loading and initialization * failed. This means NICs are not usable. * * CPU_BOOT_ERR0_SECURITY_NOT_RDY Chip security initialization has been * started, but is not ready yet - chip * cannot be accessed. * * CPU_BOOT_ERR0_SECURITY_FAIL Security related tasks have failed. * The tasks are security init (root of * trust), boot authentication (chain of * trust), data packets authentication. * * CPU_BOOT_ERR0_EFUSE_FAIL Reading from eFuse failed. * The PCI device ID might be wrong. * * CPU_BOOT_ERR0_PRI_IMG_VER_FAIL Verification of primary image failed. * It mean that ppboot checksum * verification for the preboot primary * image has failed to match expected * checksum. Trying to program image again * might solve this. * * CPU_BOOT_ERR0_SEC_IMG_VER_FAIL Verification of secondary image failed. * It mean that ppboot checksum * verification for the preboot secondary * image has failed to match expected * checksum. Trying to program image again * might solve this. * * CPU_BOOT_ERR0_PLL_FAIL PLL settings failed, meaning that one * of the PLLs remains in REF_CLK * * CPU_BOOT_ERR0_DEVICE_UNUSABLE_FAIL Device is unusable and customer support * should be contacted. * * CPU_BOOT_ERR0_BOOT_FW_CRIT_ERR Critical error was detected during * the execution of ppboot or preboot. * for example: stack overflow. * * CPU_BOOT_ERR0_BINNING_FAIL Binning settings failed, meaning * malfunctioning components might still be * in use. * * CPU_BOOT_ERR0_TPM_FAIL TPM verification flow failed. * * CPU_BOOT_ERR0_TMP_THRESH_INIT_FAIL Failed to set threshold for tmperature * sensor. * * CPU_BOOT_ERR_EEPROM_FAIL Failed reading EEPROM data. Defaults * are used. * * CPU_BOOT_ERR_ENG_ARC_MEM_SCRUB_FAIL Failed scrubbing the Engines/ARCFarm * memories. Boot disabled until reset. * * CPU_BOOT_ERR0_ENABLED Error registers enabled. * This is a main indication that the * running FW populates the error * registers. Meaning the error bits are * not garbage, but actual error statuses. */ #define CPU_BOOT_ERR0_DRAM_INIT_FAIL (1 << CPU_BOOT_ERR_DRAM_INIT_FAIL) #define CPU_BOOT_ERR0_FIT_CORRUPTED (1 << CPU_BOOT_ERR_FIT_CORRUPTED) #define CPU_BOOT_ERR0_TS_INIT_FAIL (1 << CPU_BOOT_ERR_TS_INIT_FAIL) #define CPU_BOOT_ERR0_DRAM_SKIPPED (1 << CPU_BOOT_ERR_DRAM_SKIPPED) #define CPU_BOOT_ERR0_BMC_WAIT_SKIPPED (1 << CPU_BOOT_ERR_BMC_WAIT_SKIPPED) #define CPU_BOOT_ERR0_NIC_DATA_NOT_RDY (1 << CPU_BOOT_ERR_NIC_DATA_NOT_RDY) #define CPU_BOOT_ERR0_NIC_FW_FAIL (1 << CPU_BOOT_ERR_NIC_FW_FAIL) #define CPU_BOOT_ERR0_SECURITY_NOT_RDY (1 << CPU_BOOT_ERR_SECURITY_NOT_RDY) #define CPU_BOOT_ERR0_SECURITY_FAIL (1 << CPU_BOOT_ERR_SECURITY_FAIL) #define CPU_BOOT_ERR0_EFUSE_FAIL (1 << CPU_BOOT_ERR_EFUSE_FAIL) #define CPU_BOOT_ERR0_PRI_IMG_VER_FAIL (1 << CPU_BOOT_ERR_PRI_IMG_VER_FAIL) #define CPU_BOOT_ERR0_SEC_IMG_VER_FAIL (1 << CPU_BOOT_ERR_SEC_IMG_VER_FAIL) #define CPU_BOOT_ERR0_PLL_FAIL (1 << CPU_BOOT_ERR_PLL_FAIL) #define CPU_BOOT_ERR0_DEVICE_UNUSABLE_FAIL (1 << CPU_BOOT_ERR_DEVICE_UNUSABLE_FAIL) #define CPU_BOOT_ERR0_BOOT_FW_CRIT_ERR (1 << CPU_BOOT_ERR_BOOT_FW_CRIT_ERR) #define CPU_BOOT_ERR0_BINNING_FAIL (1 << CPU_BOOT_ERR_BINNING_FAIL) #define CPU_BOOT_ERR0_TPM_FAIL (1 << CPU_BOOT_ERR_TPM_FAIL) #define CPU_BOOT_ERR0_TMP_THRESH_INIT_FAIL (1 << CPU_BOOT_ERR_TMP_THRESH_INIT_FAIL) #define CPU_BOOT_ERR0_EEPROM_FAIL (1 << CPU_BOOT_ERR_EEPROM_FAIL) #define CPU_BOOT_ERR0_ENG_ARC_MEM_SCRUB_FAIL (1 << CPU_BOOT_ERR_ENG_ARC_MEM_SCRUB_FAIL) #define CPU_BOOT_ERR0_ENABLED (1 << CPU_BOOT_ERR_ENABLED) #define CPU_BOOT_ERR1_ENABLED (1 << CPU_BOOT_ERR_ENABLED) enum cpu_boot_dev_sts { CPU_BOOT_DEV_STS_SECURITY_EN = 0, CPU_BOOT_DEV_STS_DEBUG_EN = 1, CPU_BOOT_DEV_STS_WATCHDOG_EN = 2, CPU_BOOT_DEV_STS_DRAM_INIT_EN = 3, CPU_BOOT_DEV_STS_BMC_WAIT_EN = 4, CPU_BOOT_DEV_STS_E2E_CRED_EN = 5, CPU_BOOT_DEV_STS_HBM_CRED_EN = 6, CPU_BOOT_DEV_STS_RL_EN = 7, CPU_BOOT_DEV_STS_SRAM_SCR_EN = 8, CPU_BOOT_DEV_STS_DRAM_SCR_EN = 9, CPU_BOOT_DEV_STS_FW_HARD_RST_EN = 10, CPU_BOOT_DEV_STS_PLL_INFO_EN = 11, CPU_BOOT_DEV_STS_SP_SRAM_EN = 12, CPU_BOOT_DEV_STS_CLK_GATE_EN = 13, CPU_BOOT_DEV_STS_HBM_ECC_EN = 14, CPU_BOOT_DEV_STS_PKT_PI_ACK_EN = 15, CPU_BOOT_DEV_STS_FW_LD_COM_EN = 16, CPU_BOOT_DEV_STS_FW_IATU_CONF_EN = 17, CPU_BOOT_DEV_STS_FW_NIC_MAC_EN = 18, CPU_BOOT_DEV_STS_DYN_PLL_EN = 19, CPU_BOOT_DEV_STS_GIC_PRIVILEGED_EN = 20, CPU_BOOT_DEV_STS_EQ_INDEX_EN = 21, CPU_BOOT_DEV_STS_MULTI_IRQ_POLL_EN = 22, CPU_BOOT_DEV_STS_FW_NIC_STAT_XPCS91_EN = 23, CPU_BOOT_DEV_STS_FW_NIC_STAT_EXT_EN = 24, CPU_BOOT_DEV_STS_IS_IDLE_CHECK_EN = 25, CPU_BOOT_DEV_STS_MAP_HWMON_EN = 26, CPU_BOOT_DEV_STS_ENABLED = 31, CPU_BOOT_DEV_STS_SCND_EN = 63, CPU_BOOT_DEV_STS_LAST = 64 /* we have 2 registers of 32 bits */ }; /* * BOOT DEVICE STATUS bits in BOOT_DEVICE_STS registers * * CPU_BOOT_DEV_STS0_SECURITY_EN Security is Enabled. * This is an indication for security * enabled in FW, which means that * all conditions for security are met: * device is indicated as security enabled, * registers are protected, and device * uses keys for image verification. * Initialized in: preboot * * CPU_BOOT_DEV_STS0_DEBUG_EN Debug is enabled. * Enabled when JTAG or DEBUG is enabled * in FW. * Initialized in: preboot * * CPU_BOOT_DEV_STS0_WATCHDOG_EN Watchdog is enabled. * Watchdog is enabled in FW. * Initialized in: preboot * * CPU_BOOT_DEV_STS0_DRAM_INIT_EN DRAM initialization is enabled. * DRAM initialization has been done in FW. * Initialized in: u-boot * * CPU_BOOT_DEV_STS0_BMC_WAIT_EN Waiting for BMC data enabled. * If set, it means that during boot, * FW waited for BMC data. * Initialized in: u-boot * * CPU_BOOT_DEV_STS0_E2E_CRED_EN E2E credits initialized. * FW initialized E2E credits. * Initialized in: u-boot * * CPU_BOOT_DEV_STS0_HBM_CRED_EN HBM credits initialized. * FW initialized HBM credits. * Initialized in: u-boot * * CPU_BOOT_DEV_STS0_RL_EN Rate limiter initialized. * FW initialized rate limiter. * Initialized in: u-boot * * CPU_BOOT_DEV_STS0_SRAM_SCR_EN SRAM scrambler enabled. * FW initialized SRAM scrambler. * Initialized in: linux * * CPU_BOOT_DEV_STS0_DRAM_SCR_EN DRAM scrambler enabled. * FW initialized DRAM scrambler. * Initialized in: u-boot * * CPU_BOOT_DEV_STS0_FW_HARD_RST_EN FW hard reset procedure is enabled. * FW has the hard reset procedure * implemented. This means that FW will * perform hard reset procedure on * receiving the halt-machine event. * Initialized in: preboot, u-boot, linux * * CPU_BOOT_DEV_STS0_PLL_INFO_EN FW retrieval of PLL info is enabled. * Initialized in: linux * * CPU_BOOT_DEV_STS0_SP_SRAM_EN SP SRAM is initialized and available * for use. * Initialized in: preboot * * CPU_BOOT_DEV_STS0_CLK_GATE_EN Clock Gating enabled. * FW initialized Clock Gating. * Initialized in: preboot * * CPU_BOOT_DEV_STS0_HBM_ECC_EN HBM ECC handling Enabled. * FW handles HBM ECC indications. * Initialized in: linux * * CPU_BOOT_DEV_STS0_PKT_PI_ACK_EN Packets ack value used in the armcpd * is set to the PI counter. * Initialized in: linux * * CPU_BOOT_DEV_STS0_FW_LD_COM_EN Flexible FW loading communication * protocol is enabled. * Initialized in: preboot * * CPU_BOOT_DEV_STS0_FW_IATU_CONF_EN FW iATU configuration is enabled. * This bit if set, means the iATU has been * configured and is ready for use. * Initialized in: ppboot * * CPU_BOOT_DEV_STS0_FW_NIC_MAC_EN NIC MAC channels init is done by FW and * any access to them is done via the FW. * Initialized in: linux * * CPU_BOOT_DEV_STS0_DYN_PLL_EN Dynamic PLL configuration is enabled. * FW sends to host a bitmap of supported * PLLs. * Initialized in: linux * * CPU_BOOT_DEV_STS0_GIC_PRIVILEGED_EN GIC access permission only from * previleged entity. FW sets this status * bit for host. If this bit is set then * GIC can not be accessed from host. * Initialized in: linux * * CPU_BOOT_DEV_STS0_EQ_INDEX_EN Event Queue (EQ) index is a running * index for each new event sent to host. * This is used as a method in host to * identify that the waiting event in * queue is actually a new event which * was not served before. * Initialized in: linux * * CPU_BOOT_DEV_STS0_MULTI_IRQ_POLL_EN Use multiple scratchpad interfaces to * prevent IRQs overriding each other. * Initialized in: linux * * CPU_BOOT_DEV_STS0_FW_NIC_STAT_XPCS91_EN * NIC STAT and XPCS91 access is restricted * and is done via FW only. * Initialized in: linux * * CPU_BOOT_DEV_STS0_FW_NIC_STAT_EXT_EN * NIC STAT get all is supported. * Initialized in: linux * * CPU_BOOT_DEV_STS0_IS_IDLE_CHECK_EN * F/W checks if the device is idle by reading defined set * of registers. It returns a bitmask of all the engines, * where a bit is set if the engine is not idle. * Initialized in: linux * * CPU_BOOT_DEV_STS0_MAP_HWMON_EN * If set, means f/w supports proprietary * HWMON enum mapping to cpucp enums. * Initialized in: linux * * CPU_BOOT_DEV_STS0_ENABLED Device status register enabled. * This is a main indication that the * running FW populates the device status * register. Meaning the device status * bits are not garbage, but actual * statuses. * Initialized in: preboot * */ #define CPU_BOOT_DEV_STS0_SECURITY_EN (1 << CPU_BOOT_DEV_STS_SECURITY_EN) #define CPU_BOOT_DEV_STS0_DEBUG_EN (1 << CPU_BOOT_DEV_STS_DEBUG_EN) #define CPU_BOOT_DEV_STS0_WATCHDOG_EN (1 << CPU_BOOT_DEV_STS_WATCHDOG_EN) #define CPU_BOOT_DEV_STS0_DRAM_INIT_EN (1 << CPU_BOOT_DEV_STS_DRAM_INIT_EN) #define CPU_BOOT_DEV_STS0_BMC_WAIT_EN (1 << CPU_BOOT_DEV_STS_BMC_WAIT_EN) #define CPU_BOOT_DEV_STS0_E2E_CRED_EN (1 << CPU_BOOT_DEV_STS_E2E_CRED_EN) #define CPU_BOOT_DEV_STS0_HBM_CRED_EN (1 << CPU_BOOT_DEV_STS_HBM_CRED_EN) #define CPU_BOOT_DEV_STS0_RL_EN (1 << CPU_BOOT_DEV_STS_RL_EN) #define CPU_BOOT_DEV_STS0_SRAM_SCR_EN (1 << CPU_BOOT_DEV_STS_SRAM_SCR_EN) #define CPU_BOOT_DEV_STS0_DRAM_SCR_EN (1 << CPU_BOOT_DEV_STS_DRAM_SCR_EN) #define CPU_BOOT_DEV_STS0_FW_HARD_RST_EN (1 << CPU_BOOT_DEV_STS_FW_HARD_RST_EN) #define CPU_BOOT_DEV_STS0_PLL_INFO_EN (1 << CPU_BOOT_DEV_STS_PLL_INFO_EN) #define CPU_BOOT_DEV_STS0_SP_SRAM_EN (1 << CPU_BOOT_DEV_STS_SP_SRAM_EN) #define CPU_BOOT_DEV_STS0_CLK_GATE_EN (1 << CPU_BOOT_DEV_STS_CLK_GATE_EN) #define CPU_BOOT_DEV_STS0_HBM_ECC_EN (1 << CPU_BOOT_DEV_STS_HBM_ECC_EN) #define CPU_BOOT_DEV_STS0_PKT_PI_ACK_EN (1 << CPU_BOOT_DEV_STS_PKT_PI_ACK_EN) #define CPU_BOOT_DEV_STS0_FW_LD_COM_EN (1 << CPU_BOOT_DEV_STS_FW_LD_COM_EN) #define CPU_BOOT_DEV_STS0_FW_IATU_CONF_EN (1 << CPU_BOOT_DEV_STS_FW_IATU_CONF_EN) #define CPU_BOOT_DEV_STS0_FW_NIC_MAC_EN (1 << CPU_BOOT_DEV_STS_FW_NIC_MAC_EN) #define CPU_BOOT_DEV_STS0_DYN_PLL_EN (1 << CPU_BOOT_DEV_STS_DYN_PLL_EN) #define CPU_BOOT_DEV_STS0_GIC_PRIVILEGED_EN (1 << CPU_BOOT_DEV_STS_GIC_PRIVILEGED_EN) #define CPU_BOOT_DEV_STS0_EQ_INDEX_EN (1 << CPU_BOOT_DEV_STS_EQ_INDEX_EN) #define CPU_BOOT_DEV_STS0_MULTI_IRQ_POLL_EN (1 << CPU_BOOT_DEV_STS_MULTI_IRQ_POLL_EN) #define CPU_BOOT_DEV_STS0_FW_NIC_STAT_XPCS91_EN (1 << CPU_BOOT_DEV_STS_FW_NIC_STAT_XPCS91_EN) #define CPU_BOOT_DEV_STS0_FW_NIC_STAT_EXT_EN (1 << CPU_BOOT_DEV_STS_FW_NIC_STAT_EXT_EN) #define CPU_BOOT_DEV_STS0_IS_IDLE_CHECK_EN (1 << CPU_BOOT_DEV_STS_IS_IDLE_CHECK_EN) #define CPU_BOOT_DEV_STS0_MAP_HWMON_EN (1 << CPU_BOOT_DEV_STS_MAP_HWMON_EN) #define CPU_BOOT_DEV_STS0_ENABLED (1 << CPU_BOOT_DEV_STS_ENABLED) #define CPU_BOOT_DEV_STS1_ENABLED (1 << CPU_BOOT_DEV_STS_ENABLED) enum cpu_boot_status { CPU_BOOT_STATUS_NA = 0, /* Default value after reset of chip */ CPU_BOOT_STATUS_IN_WFE = 1, CPU_BOOT_STATUS_DRAM_RDY = 2, CPU_BOOT_STATUS_SRAM_AVAIL = 3, CPU_BOOT_STATUS_IN_BTL = 4, /* BTL is H/W FSM */ CPU_BOOT_STATUS_IN_PREBOOT = 5, CPU_BOOT_STATUS_IN_SPL, /* deprecated - not reported */ CPU_BOOT_STATUS_IN_UBOOT = 7, CPU_BOOT_STATUS_DRAM_INIT_FAIL, /* deprecated - will be removed */ CPU_BOOT_STATUS_FIT_CORRUPTED, /* deprecated - will be removed */ /* U-Boot console prompt activated, commands are not processed */ CPU_BOOT_STATUS_UBOOT_NOT_READY = 10, /* Finished NICs init, reported after DRAM and NICs */ CPU_BOOT_STATUS_NIC_FW_RDY = 11, CPU_BOOT_STATUS_TS_INIT_FAIL, /* deprecated - will be removed */ CPU_BOOT_STATUS_DRAM_SKIPPED, /* deprecated - will be removed */ CPU_BOOT_STATUS_BMC_WAITING_SKIPPED, /* deprecated - will be removed */ /* Last boot loader progress status, ready to receive commands */ CPU_BOOT_STATUS_READY_TO_BOOT = 15, /* Internal Boot finished, ready for boot-fit */ CPU_BOOT_STATUS_WAITING_FOR_BOOT_FIT = 16, /* Internal Security has been initialized, device can be accessed */ CPU_BOOT_STATUS_SECURITY_READY = 17, }; enum kmd_msg { KMD_MSG_NA = 0, KMD_MSG_GOTO_WFE, KMD_MSG_FIT_RDY, KMD_MSG_SKIP_BMC, RESERVED, KMD_MSG_RST_DEV, KMD_MSG_LAST }; enum cpu_msg_status { CPU_MSG_CLR = 0, CPU_MSG_OK, CPU_MSG_ERR, }; /* communication registers mapping - consider ABI when changing */ struct cpu_dyn_regs { __le32 cpu_pq_base_addr_low; __le32 cpu_pq_base_addr_high; __le32 cpu_pq_length; __le32 cpu_pq_init_status; __le32 cpu_eq_base_addr_low; __le32 cpu_eq_base_addr_high; __le32 cpu_eq_length; __le32 cpu_eq_ci; __le32 cpu_cq_base_addr_low; __le32 cpu_cq_base_addr_high; __le32 cpu_cq_length; __le32 cpu_pf_pq_pi; __le32 cpu_boot_dev_sts0; __le32 cpu_boot_dev_sts1; __le32 cpu_boot_err0; __le32 cpu_boot_err1; __le32 cpu_boot_status; __le32 fw_upd_sts; __le32 fw_upd_cmd; __le32 fw_upd_pending_sts; __le32 fuse_ver_offset; __le32 preboot_ver_offset; __le32 uboot_ver_offset; __le32 hw_state; __le32 kmd_msg_to_cpu; __le32 cpu_cmd_status_to_host; __le32 gic_host_pi_upd_irq; __le32 gic_tpc_qm_irq_ctrl; __le32 gic_mme_qm_irq_ctrl; __le32 gic_dma_qm_irq_ctrl; __le32 gic_nic_qm_irq_ctrl; __le32 gic_dma_core_irq_ctrl; __le32 gic_host_halt_irq; __le32 gic_host_ints_irq; __le32 gic_host_soft_rst_irq; __le32 gic_rot_qm_irq_ctrl; __le32 cpu_rst_status; __le32 eng_arc_irq_ctrl; __le32 reserved1[20]; /* reserve for future use */ }; /* TODO: remove the desc magic after the code is updated to use message */ /* HCDM - Habana Communications Descriptor Magic */ #define HL_COMMS_DESC_MAGIC 0x4843444D #define HL_COMMS_DESC_VER 3 /* HCMv - Habana Communications Message + header version */ #define HL_COMMS_MSG_MAGIC_VALUE 0x48434D00 #define HL_COMMS_MSG_MAGIC_MASK 0xFFFFFF00 #define HL_COMMS_MSG_MAGIC_VER_MASK 0xFF #define HL_COMMS_MSG_MAGIC_VER(ver) (HL_COMMS_MSG_MAGIC_VALUE | \ ((ver) & HL_COMMS_MSG_MAGIC_VER_MASK)) #define HL_COMMS_MSG_MAGIC_V0 HL_COMMS_DESC_MAGIC #define HL_COMMS_MSG_MAGIC_V1 HL_COMMS_MSG_MAGIC_VER(1) #define HL_COMMS_MSG_MAGIC_V2 HL_COMMS_MSG_MAGIC_VER(2) #define HL_COMMS_MSG_MAGIC_V3 HL_COMMS_MSG_MAGIC_VER(3) #define HL_COMMS_MSG_MAGIC HL_COMMS_MSG_MAGIC_V3 #define HL_COMMS_MSG_MAGIC_VALIDATE_MAGIC(magic) \ (((magic) & HL_COMMS_MSG_MAGIC_MASK) == \ HL_COMMS_MSG_MAGIC_VALUE) #define HL_COMMS_MSG_MAGIC_VALIDATE_VERSION(magic, ver) \ (((magic) & HL_COMMS_MSG_MAGIC_VER_MASK) >= \ ((ver) & HL_COMMS_MSG_MAGIC_VER_MASK)) #define HL_COMMS_MSG_MAGIC_VALIDATE(magic, ver) \ (HL_COMMS_MSG_MAGIC_VALIDATE_MAGIC((magic)) && \ HL_COMMS_MSG_MAGIC_VALIDATE_VERSION((magic), (ver))) enum comms_msg_type { HL_COMMS_DESC_TYPE = 0, HL_COMMS_RESET_CAUSE_TYPE = 1, HL_COMMS_FW_CFG_SKIP_TYPE = 2, HL_COMMS_BINNING_CONF_TYPE = 3, }; /* * Binning information shared between LKD and FW * @tpc_mask_l - TPC binning information lower 64 bit * @dec_mask - Decoder binning information * @dram_mask - DRAM binning information * @edma_mask - EDMA binning information * @mme_mask_l - MME binning information lower 32 * @mme_mask_h - MME binning information upper 32 * @rot_mask - Rotator binning information * @xbar_mask - xBAR binning information * @reserved - reserved field for future binning info w/o ABI change * @tpc_mask_h - TPC binning information upper 64 bit * @nic_mask - NIC binning information */ struct lkd_fw_binning_info { __le64 tpc_mask_l; __le32 dec_mask; __le32 dram_mask; __le32 edma_mask; __le32 mme_mask_l; __le32 mme_mask_h; __le32 rot_mask; __le32 xbar_mask; __le32 reserved0; __le64 tpc_mask_h; __le64 nic_mask; __le32 reserved1[8]; }; /* TODO: remove this struct after the code is updated to use message */ /* this is the comms descriptor header - meta data */ struct comms_desc_header { __le32 magic; /* magic for validation */ __le32 crc32; /* CRC32 of the descriptor w/o header */ __le16 size; /* size of the descriptor w/o header */ __u8 version; /* descriptor version */ __u8 reserved[5]; /* pad to 64 bit */ }; /* this is the comms message header - meta data */ struct comms_msg_header { __le32 magic; /* magic for validation */ __le32 crc32; /* CRC32 of the message w/o header */ __le16 size; /* size of the message w/o header */ __u8 version; /* message payload version */ __u8 type; /* message type */ __u8 reserved[4]; /* pad to 64 bit */ }; enum lkd_fw_ascii_msg_lvls { LKD_FW_ASCII_MSG_ERR = 0, LKD_FW_ASCII_MSG_WRN = 1, LKD_FW_ASCII_MSG_INF = 2, LKD_FW_ASCII_MSG_DBG = 3, }; #define LKD_FW_ASCII_MSG_MAX_LEN 128 #define LKD_FW_ASCII_MSG_MAX 4 /* consider ABI when changing */ struct lkd_fw_ascii_msg { __u8 valid; __u8 msg_lvl; __u8 reserved[6]; char msg[LKD_FW_ASCII_MSG_MAX_LEN]; }; /* this is the main FW descriptor - consider ABI when changing */ struct lkd_fw_comms_desc { struct comms_desc_header header; struct cpu_dyn_regs cpu_dyn_regs; char fuse_ver[VERSION_MAX_LEN]; char cur_fw_ver[VERSION_MAX_LEN]; /* can be used for 1 more version w/o ABI change */ char reserved0[VERSION_MAX_LEN]; __le64 img_addr; /* address for next FW component load */ struct lkd_fw_binning_info binning_info; struct lkd_fw_ascii_msg ascii_msg[LKD_FW_ASCII_MSG_MAX]; }; enum comms_reset_cause { HL_RESET_CAUSE_UNKNOWN = 0, HL_RESET_CAUSE_HEARTBEAT = 1, HL_RESET_CAUSE_TDR = 2, }; /* TODO: remove define after struct name is aligned on all projects */ #define lkd_msg_comms lkd_fw_comms_msg /* this is the comms message descriptor */ struct lkd_fw_comms_msg { struct comms_msg_header header; /* union for future expantions of new messages */ union { struct { struct cpu_dyn_regs cpu_dyn_regs; char fuse_ver[VERSION_MAX_LEN]; char cur_fw_ver[VERSION_MAX_LEN]; /* can be used for 1 more version w/o ABI change */ char reserved0[VERSION_MAX_LEN]; /* address for next FW component load */ __le64 img_addr; struct lkd_fw_binning_info binning_info; struct lkd_fw_ascii_msg ascii_msg[LKD_FW_ASCII_MSG_MAX]; }; struct { __u8 reset_cause; }; struct { __u8 fw_cfg_skip; /* 1 - skip, 0 - don't skip */ }; struct lkd_fw_binning_info binning_conf; }; }; /* * LKD commands: * * COMMS_NOOP Used to clear the command register and no actual * command is send. * * COMMS_CLR_STS Clear status command - FW should clear the * status register. Used for synchronization * between the commands as part of the race free * protocol. * * COMMS_RST_STATE Reset the current communication state which is * kept by FW for proper responses. * Should be used in the beginning of the * communication cycle to clean any leftovers from * previous communication attempts. * * COMMS_PREP_DESC Prepare descriptor for setting up the * communication and other dynamic data: * struct lkd_fw_comms_desc. * This command has a parameter stating the next FW * component size, so the FW can actually prepare a * space for it and in the status response provide * the descriptor offset. The Offset of the next FW * data component is a part of the descriptor * structure. * * COMMS_DATA_RDY The FW data has been uploaded and is ready for * validation. * * COMMS_EXEC Execute the next FW component. * * COMMS_RST_DEV Reset the device. * * COMMS_GOTO_WFE Execute WFE command. Allowed only on non-secure * devices. * * COMMS_SKIP_BMC Perform actions required for BMC-less servers. * Do not wait for BMC response. * * COMMS_PREP_DESC_ELBI Same as COMMS_PREP_DESC only that the memory * space is allocated in a ELBI access only * address range. * */ enum comms_cmd { COMMS_NOOP = 0, COMMS_CLR_STS = 1, COMMS_RST_STATE = 2, COMMS_PREP_DESC = 3, COMMS_DATA_RDY = 4, COMMS_EXEC = 5, COMMS_RST_DEV = 6, COMMS_GOTO_WFE = 7, COMMS_SKIP_BMC = 8, COMMS_PREP_DESC_ELBI = 10, COMMS_INVLD_LAST }; #define COMMS_COMMAND_SIZE_SHIFT 0 #define COMMS_COMMAND_SIZE_MASK 0x1FFFFFF #define COMMS_COMMAND_CMD_SHIFT 27 #define COMMS_COMMAND_CMD_MASK 0xF8000000 /* * LKD command to FW register structure * @size - FW component size * @cmd - command from enum comms_cmd */ struct comms_command { union { /* bit fields are only for FW use */ struct { u32 size :25; /* 32MB max. */ u32 reserved :2; enum comms_cmd cmd :5; /* 32 commands */ }; __le32 val; }; }; /* * FW status * * COMMS_STS_NOOP Used to clear the status register and no actual * status is provided. * * COMMS_STS_ACK Command has been received and recognized. * * COMMS_STS_OK Command execution has finished successfully. * * COMMS_STS_ERR Command execution was unsuccessful and resulted * in error. * * COMMS_STS_VALID_ERR FW validation has failed. * * COMMS_STS_TIMEOUT_ERR Command execution has timed out. */ enum comms_sts { COMMS_STS_NOOP = 0, COMMS_STS_ACK = 1, COMMS_STS_OK = 2, COMMS_STS_ERR = 3, COMMS_STS_VALID_ERR = 4, COMMS_STS_TIMEOUT_ERR = 5, COMMS_STS_INVLD_LAST }; /* RAM types for FW components loading - defines the base address */ enum comms_ram_types { COMMS_SRAM = 0, COMMS_DRAM = 1, }; #define COMMS_STATUS_OFFSET_SHIFT 0 #define COMMS_STATUS_OFFSET_MASK 0x03FFFFFF #define COMMS_STATUS_OFFSET_ALIGN_SHIFT 2 #define COMMS_STATUS_RAM_TYPE_SHIFT 26 #define COMMS_STATUS_RAM_TYPE_MASK 0x0C000000 #define COMMS_STATUS_STATUS_SHIFT 28 #define COMMS_STATUS_STATUS_MASK 0xF0000000 /* * FW status to LKD register structure * @offset - an offset from the base of the ram_type shifted right by * 2 bits (always aligned to 32 bits). * Allows a maximum addressable offset of 256MB from RAM base. * Example: for real offset in RAM of 0x800000 (8MB), the value * in offset field is (0x800000 >> 2) = 0x200000. * @ram_type - the RAM type that should be used for offset from * enum comms_ram_types * @status - status from enum comms_sts */ struct comms_status { union { /* bit fields are only for FW use */ struct { u32 offset :26; enum comms_ram_types ram_type :2; enum comms_sts status :4; /* 16 statuses */ }; __le32 val; }; }; #define NAME_MAX_LEN 32 /* bytes */ struct hl_module_data { __u8 name[NAME_MAX_LEN]; __u8 version[VERSION_MAX_LEN]; }; /** * struct hl_component_versions - versions associated with hl component. * @struct_size: size of all the struct (including dynamic size of modules). * @modules_offset: offset of the modules field in this struct. * @component: version of the component itself. * @fw_os: Firmware OS Version. * @comp_name: Name of the component. * @modules_counter: number of set bits in modules_mask. * @reserved: reserved for future use. * @modules: versions of the component's modules. Elborated explanation in * struct cpucp_versions. */ struct hl_component_versions { __le16 struct_size; __le16 modules_offset; __u8 component[VERSION_MAX_LEN]; __u8 fw_os[VERSION_MAX_LEN]; __u8 comp_name[NAME_MAX_LEN]; __u8 modules_counter; __u8 reserved[3]; struct hl_module_data modules[]; }; /* Max size of fit size */ #define HL_FW_VERSIONS_FIT_SIZE 4096 #endif /* HL_BOOT_IF_H */