1b3e4c0f3SLuca Coelho // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause 2cdda18fbSLuca Coelho /* 38f55564cSJohannes Berg * Copyright(c) 2020-2022 Intel Corporation 4cdda18fbSLuca Coelho */ 5b3e4c0f3SLuca Coelho 6b3e4c0f3SLuca Coelho #include "iwl-drv.h" 7b3e4c0f3SLuca Coelho #include "pnvm.h" 8b3e4c0f3SLuca Coelho #include "iwl-prph.h" 9b3e4c0f3SLuca Coelho #include "iwl-io.h" 10b3e4c0f3SLuca Coelho #include "fw/api/commands.h" 11b3e4c0f3SLuca Coelho #include "fw/api/nvm-reg.h" 1269725928SLuca Coelho #include "fw/api/alive.h" 1384c3c995SLuca Coelho #include "fw/uefi.h" 1469725928SLuca Coelho 1569725928SLuca Coelho struct iwl_pnvm_section { 1669725928SLuca Coelho __le32 offset; 1769725928SLuca Coelho const u8 data[]; 1869725928SLuca Coelho } __packed; 19b3e4c0f3SLuca Coelho 20b3e4c0f3SLuca Coelho static bool iwl_pnvm_complete_fn(struct iwl_notif_wait_data *notif_wait, 21b3e4c0f3SLuca Coelho struct iwl_rx_packet *pkt, void *data) 22b3e4c0f3SLuca Coelho { 23b3e4c0f3SLuca Coelho struct iwl_trans *trans = (struct iwl_trans *)data; 24b3e4c0f3SLuca Coelho struct iwl_pnvm_init_complete_ntfy *pnvm_ntf = (void *)pkt->data; 25b3e4c0f3SLuca Coelho 26b3e4c0f3SLuca Coelho IWL_DEBUG_FW(trans, 272a1d2fcfSLuca Coelho "PNVM complete notification received with status 0x%0x\n", 28b3e4c0f3SLuca Coelho le32_to_cpu(pnvm_ntf->status)); 29b3e4c0f3SLuca Coelho 30b3e4c0f3SLuca Coelho return true; 31b3e4c0f3SLuca Coelho } 32b3e4c0f3SLuca Coelho 3369725928SLuca Coelho static int iwl_pnvm_handle_section(struct iwl_trans *trans, const u8 *data, 3469725928SLuca Coelho size_t len) 3569725928SLuca Coelho { 3673c289baSBjoern A. Zeeb const struct iwl_ucode_tlv *tlv; 3769725928SLuca Coelho u32 sha1 = 0; 3869725928SLuca Coelho u16 mac_type = 0, rf_id = 0; 395f408503SAlon Giladi struct iwl_pnvm_image pnvm_data = {}; 400f673c16SJohannes Berg bool hw_match = false; 41*194d1f84SAlon Giladi int ret; 4269725928SLuca Coelho 4369725928SLuca Coelho IWL_DEBUG_FW(trans, "Handling PNVM section\n"); 4469725928SLuca Coelho 4569725928SLuca Coelho while (len >= sizeof(*tlv)) { 4669725928SLuca Coelho u32 tlv_len, tlv_type; 4769725928SLuca Coelho 4869725928SLuca Coelho len -= sizeof(*tlv); 4973c289baSBjoern A. Zeeb tlv = (const void *)data; 5069725928SLuca Coelho 5169725928SLuca Coelho tlv_len = le32_to_cpu(tlv->length); 5269725928SLuca Coelho tlv_type = le32_to_cpu(tlv->type); 5369725928SLuca Coelho 5469725928SLuca Coelho if (len < tlv_len) { 5569725928SLuca Coelho IWL_ERR(trans, "invalid TLV len: %zd/%u\n", 5669725928SLuca Coelho len, tlv_len); 575f408503SAlon Giladi return -EINVAL; 5869725928SLuca Coelho } 5969725928SLuca Coelho 6069725928SLuca Coelho data += sizeof(*tlv); 6169725928SLuca Coelho 6269725928SLuca Coelho switch (tlv_type) { 6369725928SLuca Coelho case IWL_UCODE_TLV_PNVM_VERSION: 6469725928SLuca Coelho if (tlv_len < sizeof(__le32)) { 6569725928SLuca Coelho IWL_DEBUG_FW(trans, 6669725928SLuca Coelho "Invalid size for IWL_UCODE_TLV_PNVM_VERSION (expected %zd, got %d)\n", 6769725928SLuca Coelho sizeof(__le32), tlv_len); 6869725928SLuca Coelho break; 6969725928SLuca Coelho } 7069725928SLuca Coelho 7173c289baSBjoern A. Zeeb sha1 = le32_to_cpup((const __le32 *)data); 7269725928SLuca Coelho 7369725928SLuca Coelho IWL_DEBUG_FW(trans, 7469725928SLuca Coelho "Got IWL_UCODE_TLV_PNVM_VERSION %0x\n", 7569725928SLuca Coelho sha1); 7669725928SLuca Coelho break; 7769725928SLuca Coelho case IWL_UCODE_TLV_HW_TYPE: 7869725928SLuca Coelho if (tlv_len < 2 * sizeof(__le16)) { 7969725928SLuca Coelho IWL_DEBUG_FW(trans, 8069725928SLuca Coelho "Invalid size for IWL_UCODE_TLV_HW_TYPE (expected %zd, got %d)\n", 8169725928SLuca Coelho 2 * sizeof(__le16), tlv_len); 8269725928SLuca Coelho break; 8369725928SLuca Coelho } 8469725928SLuca Coelho 850f673c16SJohannes Berg if (hw_match) 860f673c16SJohannes Berg break; 870f673c16SJohannes Berg 8873c289baSBjoern A. Zeeb mac_type = le16_to_cpup((const __le16 *)data); 8973c289baSBjoern A. Zeeb rf_id = le16_to_cpup((const __le16 *)(data + sizeof(__le16))); 9069725928SLuca Coelho 9169725928SLuca Coelho IWL_DEBUG_FW(trans, 9269725928SLuca Coelho "Got IWL_UCODE_TLV_HW_TYPE mac_type 0x%0x rf_id 0x%0x\n", 9369725928SLuca Coelho mac_type, rf_id); 9469725928SLuca Coelho 950f673c16SJohannes Berg if (mac_type == CSR_HW_REV_TYPE(trans->hw_rev) && 960f673c16SJohannes Berg rf_id == CSR_HW_RFID_TYPE(trans->hw_rf_id)) 970f673c16SJohannes Berg hw_match = true; 9869725928SLuca Coelho break; 9969725928SLuca Coelho case IWL_UCODE_TLV_SEC_RT: { 10073c289baSBjoern A. Zeeb const struct iwl_pnvm_section *section = (const void *)data; 10169725928SLuca Coelho u32 data_len = tlv_len - sizeof(*section); 10269725928SLuca Coelho 10369725928SLuca Coelho IWL_DEBUG_FW(trans, 10469725928SLuca Coelho "Got IWL_UCODE_TLV_SEC_RT len %d\n", 10569725928SLuca Coelho tlv_len); 10669725928SLuca Coelho 10769725928SLuca Coelho /* TODO: remove, this is a deprecated separator */ 10873c289baSBjoern A. Zeeb if (le32_to_cpup((const __le32 *)data) == 0xddddeeee) { 10969725928SLuca Coelho IWL_DEBUG_FW(trans, "Ignoring separator.\n"); 11069725928SLuca Coelho break; 11169725928SLuca Coelho } 11269725928SLuca Coelho 1135f408503SAlon Giladi if (pnvm_data.n_chunks == IPC_DRAM_MAP_ENTRY_NUM_MAX) { 1145f408503SAlon Giladi IWL_DEBUG_FW(trans, 1155f408503SAlon Giladi "too many payloads to allocate in DRAM.\n"); 1165f408503SAlon Giladi return -EINVAL; 1175f408503SAlon Giladi } 1185f408503SAlon Giladi 11969725928SLuca Coelho IWL_DEBUG_FW(trans, "Adding data (size %d)\n", 12069725928SLuca Coelho data_len); 12169725928SLuca Coelho 1225f408503SAlon Giladi pnvm_data.chunks[pnvm_data.n_chunks].data = section->data; 1235f408503SAlon Giladi pnvm_data.chunks[pnvm_data.n_chunks].len = data_len; 1245f408503SAlon Giladi pnvm_data.n_chunks++; 12569725928SLuca Coelho 12669725928SLuca Coelho break; 12769725928SLuca Coelho } 12869725928SLuca Coelho case IWL_UCODE_TLV_PNVM_SKU: 12969725928SLuca Coelho IWL_DEBUG_FW(trans, 13069725928SLuca Coelho "New PNVM section started, stop parsing.\n"); 13169725928SLuca Coelho goto done; 13269725928SLuca Coelho default: 13369725928SLuca Coelho IWL_DEBUG_FW(trans, "Found TLV 0x%0x, len %d\n", 13469725928SLuca Coelho tlv_type, tlv_len); 13569725928SLuca Coelho break; 13669725928SLuca Coelho } 13769725928SLuca Coelho 13869725928SLuca Coelho len -= ALIGN(tlv_len, 4); 13969725928SLuca Coelho data += ALIGN(tlv_len, 4); 14069725928SLuca Coelho } 14169725928SLuca Coelho 14269725928SLuca Coelho done: 1430f673c16SJohannes Berg if (!hw_match) { 1440f673c16SJohannes Berg IWL_DEBUG_FW(trans, 1450f673c16SJohannes Berg "HW mismatch, skipping PNVM section (need mac_type 0x%x rf_id 0x%x)\n", 1460f673c16SJohannes Berg CSR_HW_REV_TYPE(trans->hw_rev), 1470f673c16SJohannes Berg CSR_HW_RFID_TYPE(trans->hw_rf_id)); 1485f408503SAlon Giladi return -ENOENT; 1490f673c16SJohannes Berg } 1500f673c16SJohannes Berg 1515f408503SAlon Giladi if (!pnvm_data.n_chunks) { 15269725928SLuca Coelho IWL_DEBUG_FW(trans, "Empty PNVM, skipping.\n"); 1535f408503SAlon Giladi return -ENOENT; 15469725928SLuca Coelho } 15569725928SLuca Coelho 156*194d1f84SAlon Giladi ret = iwl_trans_load_pnvm(trans, &pnvm_data); 157*194d1f84SAlon Giladi if (ret) 158*194d1f84SAlon Giladi return ret; 159*194d1f84SAlon Giladi 1602c5769e3SJohannes Berg IWL_INFO(trans, "loaded PNVM version %08x\n", sha1); 16169725928SLuca Coelho 162*194d1f84SAlon Giladi iwl_trans_set_pnvm(trans); 163*194d1f84SAlon Giladi return 0; 16469725928SLuca Coelho } 16569725928SLuca Coelho 16669725928SLuca Coelho static int iwl_pnvm_parse(struct iwl_trans *trans, const u8 *data, 16769725928SLuca Coelho size_t len) 16869725928SLuca Coelho { 16973c289baSBjoern A. Zeeb const struct iwl_ucode_tlv *tlv; 17069725928SLuca Coelho 17169725928SLuca Coelho IWL_DEBUG_FW(trans, "Parsing PNVM file\n"); 17269725928SLuca Coelho 17369725928SLuca Coelho while (len >= sizeof(*tlv)) { 17469725928SLuca Coelho u32 tlv_len, tlv_type; 17569725928SLuca Coelho 17669725928SLuca Coelho len -= sizeof(*tlv); 17786e8e657SJohannes Berg tlv = (const void *)data; 17869725928SLuca Coelho 17969725928SLuca Coelho tlv_len = le32_to_cpu(tlv->length); 18069725928SLuca Coelho tlv_type = le32_to_cpu(tlv->type); 18169725928SLuca Coelho 18269725928SLuca Coelho if (len < tlv_len) { 18369725928SLuca Coelho IWL_ERR(trans, "invalid TLV len: %zd/%u\n", 18469725928SLuca Coelho len, tlv_len); 18569725928SLuca Coelho return -EINVAL; 18669725928SLuca Coelho } 18769725928SLuca Coelho 18869725928SLuca Coelho if (tlv_type == IWL_UCODE_TLV_PNVM_SKU) { 18973c289baSBjoern A. Zeeb const struct iwl_sku_id *sku_id = 19073c289baSBjoern A. Zeeb (const void *)(data + sizeof(*tlv)); 19169725928SLuca Coelho 19269725928SLuca Coelho IWL_DEBUG_FW(trans, 19369725928SLuca Coelho "Got IWL_UCODE_TLV_PNVM_SKU len %d\n", 19469725928SLuca Coelho tlv_len); 19569725928SLuca Coelho IWL_DEBUG_FW(trans, "sku_id 0x%0x 0x%0x 0x%0x\n", 19669725928SLuca Coelho le32_to_cpu(sku_id->data[0]), 19769725928SLuca Coelho le32_to_cpu(sku_id->data[1]), 19869725928SLuca Coelho le32_to_cpu(sku_id->data[2])); 19969725928SLuca Coelho 200ff11a8eeSLuca Coelho data += sizeof(*tlv) + ALIGN(tlv_len, 4); 201ff11a8eeSLuca Coelho len -= ALIGN(tlv_len, 4); 202ff11a8eeSLuca Coelho 20369725928SLuca Coelho if (trans->sku_id[0] == le32_to_cpu(sku_id->data[0]) && 20469725928SLuca Coelho trans->sku_id[1] == le32_to_cpu(sku_id->data[1]) && 20569725928SLuca Coelho trans->sku_id[2] == le32_to_cpu(sku_id->data[2])) { 20669725928SLuca Coelho int ret; 20769725928SLuca Coelho 20869725928SLuca Coelho ret = iwl_pnvm_handle_section(trans, data, len); 20969725928SLuca Coelho if (!ret) 21069725928SLuca Coelho return 0; 21169725928SLuca Coelho } else { 21269725928SLuca Coelho IWL_DEBUG_FW(trans, "SKU ID didn't match!\n"); 21369725928SLuca Coelho } 21469725928SLuca Coelho } else { 21569725928SLuca Coelho data += sizeof(*tlv) + ALIGN(tlv_len, 4); 21669725928SLuca Coelho len -= ALIGN(tlv_len, 4); 21769725928SLuca Coelho } 21869725928SLuca Coelho } 21969725928SLuca Coelho 22069725928SLuca Coelho return -ENOENT; 22169725928SLuca Coelho } 22269725928SLuca Coelho 223cdda18fbSLuca Coelho static int iwl_pnvm_get_from_fs(struct iwl_trans *trans, u8 **data, size_t *len) 224b3e4c0f3SLuca Coelho { 2251c58bed4SJohannes Berg const struct firmware *pnvm; 226b05c1d14SDror Moshe char pnvm_name[MAX_PNVM_NAME]; 22745010c08SChristophe JAILLET size_t new_len; 228cdda18fbSLuca Coelho int ret; 22969725928SLuca Coelho 230b05c1d14SDror Moshe iwl_pnvm_get_fs_name(trans, pnvm_name, sizeof(pnvm_name)); 23169725928SLuca Coelho 23269725928SLuca Coelho ret = firmware_request_nowarn(&pnvm, pnvm_name, trans->dev); 23369725928SLuca Coelho if (ret) { 23469725928SLuca Coelho IWL_DEBUG_FW(trans, "PNVM file %s not found %d\n", 23569725928SLuca Coelho pnvm_name, ret); 236cdda18fbSLuca Coelho return ret; 237cdda18fbSLuca Coelho } 238cdda18fbSLuca Coelho 23945010c08SChristophe JAILLET new_len = pnvm->size; 240cdda18fbSLuca Coelho *data = kmemdup(pnvm->data, pnvm->size, GFP_KERNEL); 24145010c08SChristophe JAILLET release_firmware(pnvm); 24245010c08SChristophe JAILLET 243cdda18fbSLuca Coelho if (!*data) 244cdda18fbSLuca Coelho return -ENOMEM; 245cdda18fbSLuca Coelho 24645010c08SChristophe JAILLET *len = new_len; 247cdda18fbSLuca Coelho 248cdda18fbSLuca Coelho return 0; 249cdda18fbSLuca Coelho } 250cdda18fbSLuca Coelho 251cdda18fbSLuca Coelho int iwl_pnvm_load(struct iwl_trans *trans, 252cdda18fbSLuca Coelho struct iwl_notif_wait_data *notif_wait) 253cdda18fbSLuca Coelho { 254cdda18fbSLuca Coelho u8 *data; 255cdda18fbSLuca Coelho size_t len; 25684c3c995SLuca Coelho struct pnvm_sku_package *package; 257cdda18fbSLuca Coelho struct iwl_notification_wait pnvm_wait; 258cdda18fbSLuca Coelho static const u16 ntf_cmds[] = { WIDE_ID(REGULATORY_AND_NVM_GROUP, 259cdda18fbSLuca Coelho PNVM_INIT_COMPLETE_NTFY) }; 260cdda18fbSLuca Coelho int ret; 261cdda18fbSLuca Coelho 262cdda18fbSLuca Coelho /* if the SKU_ID is empty, there's nothing to do */ 263cdda18fbSLuca Coelho if (!trans->sku_id[0] && !trans->sku_id[1] && !trans->sku_id[2]) 264cdda18fbSLuca Coelho return 0; 265cdda18fbSLuca Coelho 266cdda18fbSLuca Coelho /* 267cdda18fbSLuca Coelho * If we already loaded (or tried to load) it before, we just 268cdda18fbSLuca Coelho * need to set it again. 269cdda18fbSLuca Coelho */ 270cdda18fbSLuca Coelho if (trans->pnvm_loaded) { 271*194d1f84SAlon Giladi iwl_trans_set_pnvm(trans); 272cdda18fbSLuca Coelho goto skip_parse; 273cdda18fbSLuca Coelho } 274cdda18fbSLuca Coelho 275a1a6a4cfSLuca Coelho /* First attempt to get the PNVM from BIOS */ 27684c3c995SLuca Coelho package = iwl_uefi_get_pnvm(trans, &len); 27784c3c995SLuca Coelho if (!IS_ERR_OR_NULL(package)) { 278e864a77fSJohannes Berg if (len >= sizeof(*package)) { 2790f892441SJohannes Berg /* we need only the data */ 2800f892441SJohannes Berg len -= sizeof(*package); 28184c3c995SLuca Coelho data = kmemdup(package->data, len, GFP_KERNEL); 282e864a77fSJohannes Berg } else { 283e864a77fSJohannes Berg data = NULL; 284e864a77fSJohannes Berg } 28584c3c995SLuca Coelho 28684c3c995SLuca Coelho /* free package regardless of whether kmemdup succeeded */ 28784c3c995SLuca Coelho kfree(package); 28884c3c995SLuca Coelho 2890f892441SJohannes Berg if (data) 290a1a6a4cfSLuca Coelho goto parse; 29184c3c995SLuca Coelho } 292a1a6a4cfSLuca Coelho 293a1a6a4cfSLuca Coelho /* If it's not available, try from the filesystem */ 294cdda18fbSLuca Coelho ret = iwl_pnvm_get_from_fs(trans, &data, &len); 295cdda18fbSLuca Coelho if (ret) { 29682a08d0cSJohannes Berg /* 29782a08d0cSJohannes Berg * Pretend we've loaded it - at least we've tried and 29882a08d0cSJohannes Berg * couldn't load it at all, so there's no point in 29982a08d0cSJohannes Berg * trying again over and over. 30082a08d0cSJohannes Berg */ 30182a08d0cSJohannes Berg trans->pnvm_loaded = true; 30269725928SLuca Coelho 303cdda18fbSLuca Coelho goto skip_parse; 3041c58bed4SJohannes Berg } 305b3e4c0f3SLuca Coelho 306a1a6a4cfSLuca Coelho parse: 307cdda18fbSLuca Coelho iwl_pnvm_parse(trans, data, len); 308cdda18fbSLuca Coelho 309cdda18fbSLuca Coelho kfree(data); 310cdda18fbSLuca Coelho 311cdda18fbSLuca Coelho skip_parse: 3129dad325fSLuca Coelho /* now try to get the reduce power table, if not loaded yet */ 3139dad325fSLuca Coelho if (!trans->reduce_power_loaded) { 3149dad325fSLuca Coelho data = iwl_uefi_get_reduced_power(trans, &len); 3159dad325fSLuca Coelho if (IS_ERR_OR_NULL(data)) { 3169dad325fSLuca Coelho /* 3179dad325fSLuca Coelho * Pretend we've loaded it - at least we've tried and 3189dad325fSLuca Coelho * couldn't load it at all, so there's no point in 3199dad325fSLuca Coelho * trying again over and over. 3209dad325fSLuca Coelho */ 3219dad325fSLuca Coelho trans->reduce_power_loaded = true; 3228f55564cSJohannes Berg } else { 3239dad325fSLuca Coelho ret = iwl_trans_set_reduce_power(trans, data, len); 3249dad325fSLuca Coelho if (ret) 3259dad325fSLuca Coelho IWL_DEBUG_FW(trans, 3269dad325fSLuca Coelho "Failed to set reduce power table %d\n", 3279dad325fSLuca Coelho ret); 3289dad325fSLuca Coelho kfree(data); 3298f55564cSJohannes Berg } 3308f55564cSJohannes Berg } 3319dad325fSLuca Coelho 332b3e4c0f3SLuca Coelho iwl_init_notification_wait(notif_wait, &pnvm_wait, 333b3e4c0f3SLuca Coelho ntf_cmds, ARRAY_SIZE(ntf_cmds), 334b3e4c0f3SLuca Coelho iwl_pnvm_complete_fn, trans); 335b3e4c0f3SLuca Coelho 336b3e4c0f3SLuca Coelho /* kick the doorbell */ 337b3e4c0f3SLuca Coelho iwl_write_umac_prph(trans, UREG_DOORBELL_TO_ISR6, 338b3e4c0f3SLuca Coelho UREG_DOORBELL_TO_ISR6_PNVM); 339b3e4c0f3SLuca Coelho 340b3e4c0f3SLuca Coelho return iwl_wait_notification(notif_wait, &pnvm_wait, 341b3e4c0f3SLuca Coelho MVM_UCODE_PNVM_TIMEOUT); 342b3e4c0f3SLuca Coelho } 343b3e4c0f3SLuca Coelho IWL_EXPORT_SYMBOL(iwl_pnvm_load); 344