1b3e4c0f3SLuca Coelho // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause 2cdda18fbSLuca Coelho /* 3cdda18fbSLuca Coelho * Copyright(c) 2020-2021 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" 13*84c3c995SLuca 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 20*84c3c995SLuca Coelho struct pnvm_sku_package { 21*84c3c995SLuca Coelho u8 rev; 22*84c3c995SLuca Coelho u8 reserved1[3]; 23*84c3c995SLuca Coelho u32 total_size; 24*84c3c995SLuca Coelho u8 n_skus; 25*84c3c995SLuca Coelho u8 reserved2[11]; 26*84c3c995SLuca Coelho u8 data[]; 27*84c3c995SLuca Coelho }; 28*84c3c995SLuca Coelho 29b3e4c0f3SLuca Coelho static bool iwl_pnvm_complete_fn(struct iwl_notif_wait_data *notif_wait, 30b3e4c0f3SLuca Coelho struct iwl_rx_packet *pkt, void *data) 31b3e4c0f3SLuca Coelho { 32b3e4c0f3SLuca Coelho struct iwl_trans *trans = (struct iwl_trans *)data; 33b3e4c0f3SLuca Coelho struct iwl_pnvm_init_complete_ntfy *pnvm_ntf = (void *)pkt->data; 34b3e4c0f3SLuca Coelho 35b3e4c0f3SLuca Coelho IWL_DEBUG_FW(trans, 36b3e4c0f3SLuca Coelho "PNVM complete notification received with status %d\n", 37b3e4c0f3SLuca Coelho le32_to_cpu(pnvm_ntf->status)); 38b3e4c0f3SLuca Coelho 39b3e4c0f3SLuca Coelho return true; 40b3e4c0f3SLuca Coelho } 41b3e4c0f3SLuca Coelho 4269725928SLuca Coelho static int iwl_pnvm_handle_section(struct iwl_trans *trans, const u8 *data, 4369725928SLuca Coelho size_t len) 4469725928SLuca Coelho { 4569725928SLuca Coelho struct iwl_ucode_tlv *tlv; 4669725928SLuca Coelho u32 sha1 = 0; 4769725928SLuca Coelho u16 mac_type = 0, rf_id = 0; 4869725928SLuca Coelho u8 *pnvm_data = NULL, *tmp; 4969725928SLuca Coelho u32 size = 0; 5069725928SLuca Coelho int ret; 5169725928SLuca Coelho 5269725928SLuca Coelho IWL_DEBUG_FW(trans, "Handling PNVM section\n"); 5369725928SLuca Coelho 5469725928SLuca Coelho while (len >= sizeof(*tlv)) { 5569725928SLuca Coelho u32 tlv_len, tlv_type; 5669725928SLuca Coelho 5769725928SLuca Coelho len -= sizeof(*tlv); 5869725928SLuca Coelho tlv = (void *)data; 5969725928SLuca Coelho 6069725928SLuca Coelho tlv_len = le32_to_cpu(tlv->length); 6169725928SLuca Coelho tlv_type = le32_to_cpu(tlv->type); 6269725928SLuca Coelho 6369725928SLuca Coelho if (len < tlv_len) { 6469725928SLuca Coelho IWL_ERR(trans, "invalid TLV len: %zd/%u\n", 6569725928SLuca Coelho len, tlv_len); 6669725928SLuca Coelho ret = -EINVAL; 6769725928SLuca Coelho goto out; 6869725928SLuca Coelho } 6969725928SLuca Coelho 7069725928SLuca Coelho data += sizeof(*tlv); 7169725928SLuca Coelho 7269725928SLuca Coelho switch (tlv_type) { 7369725928SLuca Coelho case IWL_UCODE_TLV_PNVM_VERSION: 7469725928SLuca Coelho if (tlv_len < sizeof(__le32)) { 7569725928SLuca Coelho IWL_DEBUG_FW(trans, 7669725928SLuca Coelho "Invalid size for IWL_UCODE_TLV_PNVM_VERSION (expected %zd, got %d)\n", 7769725928SLuca Coelho sizeof(__le32), tlv_len); 7869725928SLuca Coelho break; 7969725928SLuca Coelho } 8069725928SLuca Coelho 8169725928SLuca Coelho sha1 = le32_to_cpup((__le32 *)data); 8269725928SLuca Coelho 8369725928SLuca Coelho IWL_DEBUG_FW(trans, 8469725928SLuca Coelho "Got IWL_UCODE_TLV_PNVM_VERSION %0x\n", 8569725928SLuca Coelho sha1); 8669725928SLuca Coelho break; 8769725928SLuca Coelho case IWL_UCODE_TLV_HW_TYPE: 8869725928SLuca Coelho if (tlv_len < 2 * sizeof(__le16)) { 8969725928SLuca Coelho IWL_DEBUG_FW(trans, 9069725928SLuca Coelho "Invalid size for IWL_UCODE_TLV_HW_TYPE (expected %zd, got %d)\n", 9169725928SLuca Coelho 2 * sizeof(__le16), tlv_len); 9269725928SLuca Coelho break; 9369725928SLuca Coelho } 9469725928SLuca Coelho 9569725928SLuca Coelho mac_type = le16_to_cpup((__le16 *)data); 9669725928SLuca Coelho rf_id = le16_to_cpup((__le16 *)(data + sizeof(__le16))); 9769725928SLuca Coelho 9869725928SLuca Coelho IWL_DEBUG_FW(trans, 9969725928SLuca Coelho "Got IWL_UCODE_TLV_HW_TYPE mac_type 0x%0x rf_id 0x%0x\n", 10069725928SLuca Coelho mac_type, rf_id); 10169725928SLuca Coelho 10269725928SLuca Coelho if (mac_type != CSR_HW_REV_TYPE(trans->hw_rev) || 10369725928SLuca Coelho rf_id != CSR_HW_RFID_TYPE(trans->hw_rf_id)) { 10469725928SLuca Coelho IWL_DEBUG_FW(trans, 10569725928SLuca Coelho "HW mismatch, skipping PNVM section, mac_type 0x%0x, rf_id 0x%0x.\n", 10669725928SLuca Coelho CSR_HW_REV_TYPE(trans->hw_rev), trans->hw_rf_id); 10769725928SLuca Coelho ret = -ENOENT; 10869725928SLuca Coelho goto out; 10969725928SLuca Coelho } 11069725928SLuca Coelho 11169725928SLuca Coelho break; 11269725928SLuca Coelho case IWL_UCODE_TLV_SEC_RT: { 11369725928SLuca Coelho struct iwl_pnvm_section *section = (void *)data; 11469725928SLuca Coelho u32 data_len = tlv_len - sizeof(*section); 11569725928SLuca Coelho 11669725928SLuca Coelho IWL_DEBUG_FW(trans, 11769725928SLuca Coelho "Got IWL_UCODE_TLV_SEC_RT len %d\n", 11869725928SLuca Coelho tlv_len); 11969725928SLuca Coelho 12069725928SLuca Coelho /* TODO: remove, this is a deprecated separator */ 12169725928SLuca Coelho if (le32_to_cpup((__le32 *)data) == 0xddddeeee) { 12269725928SLuca Coelho IWL_DEBUG_FW(trans, "Ignoring separator.\n"); 12369725928SLuca Coelho break; 12469725928SLuca Coelho } 12569725928SLuca Coelho 12669725928SLuca Coelho IWL_DEBUG_FW(trans, "Adding data (size %d)\n", 12769725928SLuca Coelho data_len); 12869725928SLuca Coelho 12969725928SLuca Coelho tmp = krealloc(pnvm_data, size + data_len, GFP_KERNEL); 13069725928SLuca Coelho if (!tmp) { 13169725928SLuca Coelho IWL_DEBUG_FW(trans, 13269725928SLuca Coelho "Couldn't allocate (more) pnvm_data\n"); 13369725928SLuca Coelho 13469725928SLuca Coelho ret = -ENOMEM; 13569725928SLuca Coelho goto out; 13669725928SLuca Coelho } 13769725928SLuca Coelho 13869725928SLuca Coelho pnvm_data = tmp; 13969725928SLuca Coelho 14069725928SLuca Coelho memcpy(pnvm_data + size, section->data, data_len); 14169725928SLuca Coelho 14269725928SLuca Coelho size += data_len; 14369725928SLuca Coelho 14469725928SLuca Coelho break; 14569725928SLuca Coelho } 14669725928SLuca Coelho case IWL_UCODE_TLV_PNVM_SKU: 14769725928SLuca Coelho IWL_DEBUG_FW(trans, 14869725928SLuca Coelho "New PNVM section started, stop parsing.\n"); 14969725928SLuca Coelho goto done; 15069725928SLuca Coelho default: 15169725928SLuca Coelho IWL_DEBUG_FW(trans, "Found TLV 0x%0x, len %d\n", 15269725928SLuca Coelho tlv_type, tlv_len); 15369725928SLuca Coelho break; 15469725928SLuca Coelho } 15569725928SLuca Coelho 15669725928SLuca Coelho len -= ALIGN(tlv_len, 4); 15769725928SLuca Coelho data += ALIGN(tlv_len, 4); 15869725928SLuca Coelho } 15969725928SLuca Coelho 16069725928SLuca Coelho done: 16169725928SLuca Coelho if (!size) { 16269725928SLuca Coelho IWL_DEBUG_FW(trans, "Empty PNVM, skipping.\n"); 16369725928SLuca Coelho ret = -ENOENT; 16469725928SLuca Coelho goto out; 16569725928SLuca Coelho } 16669725928SLuca Coelho 16769725928SLuca Coelho IWL_INFO(trans, "loaded PNVM version 0x%0x\n", sha1); 16869725928SLuca Coelho 16969725928SLuca Coelho ret = iwl_trans_set_pnvm(trans, pnvm_data, size); 17069725928SLuca Coelho out: 17169725928SLuca Coelho kfree(pnvm_data); 17269725928SLuca Coelho return ret; 17369725928SLuca Coelho } 17469725928SLuca Coelho 17569725928SLuca Coelho static int iwl_pnvm_parse(struct iwl_trans *trans, const u8 *data, 17669725928SLuca Coelho size_t len) 17769725928SLuca Coelho { 17869725928SLuca Coelho struct iwl_ucode_tlv *tlv; 17969725928SLuca Coelho 18069725928SLuca Coelho IWL_DEBUG_FW(trans, "Parsing PNVM file\n"); 18169725928SLuca Coelho 18269725928SLuca Coelho while (len >= sizeof(*tlv)) { 18369725928SLuca Coelho u32 tlv_len, tlv_type; 18469725928SLuca Coelho 18569725928SLuca Coelho len -= sizeof(*tlv); 18669725928SLuca Coelho tlv = (void *)data; 18769725928SLuca Coelho 18869725928SLuca Coelho tlv_len = le32_to_cpu(tlv->length); 18969725928SLuca Coelho tlv_type = le32_to_cpu(tlv->type); 19069725928SLuca Coelho 19169725928SLuca Coelho if (len < tlv_len) { 19269725928SLuca Coelho IWL_ERR(trans, "invalid TLV len: %zd/%u\n", 19369725928SLuca Coelho len, tlv_len); 19469725928SLuca Coelho return -EINVAL; 19569725928SLuca Coelho } 19669725928SLuca Coelho 19769725928SLuca Coelho if (tlv_type == IWL_UCODE_TLV_PNVM_SKU) { 19869725928SLuca Coelho struct iwl_sku_id *sku_id = 19969725928SLuca Coelho (void *)(data + sizeof(*tlv)); 20069725928SLuca Coelho 20169725928SLuca Coelho IWL_DEBUG_FW(trans, 20269725928SLuca Coelho "Got IWL_UCODE_TLV_PNVM_SKU len %d\n", 20369725928SLuca Coelho tlv_len); 20469725928SLuca Coelho IWL_DEBUG_FW(trans, "sku_id 0x%0x 0x%0x 0x%0x\n", 20569725928SLuca Coelho le32_to_cpu(sku_id->data[0]), 20669725928SLuca Coelho le32_to_cpu(sku_id->data[1]), 20769725928SLuca Coelho le32_to_cpu(sku_id->data[2])); 20869725928SLuca Coelho 209ff11a8eeSLuca Coelho data += sizeof(*tlv) + ALIGN(tlv_len, 4); 210ff11a8eeSLuca Coelho len -= ALIGN(tlv_len, 4); 211ff11a8eeSLuca Coelho 21269725928SLuca Coelho if (trans->sku_id[0] == le32_to_cpu(sku_id->data[0]) && 21369725928SLuca Coelho trans->sku_id[1] == le32_to_cpu(sku_id->data[1]) && 21469725928SLuca Coelho trans->sku_id[2] == le32_to_cpu(sku_id->data[2])) { 21569725928SLuca Coelho int ret; 21669725928SLuca Coelho 21769725928SLuca Coelho ret = iwl_pnvm_handle_section(trans, data, len); 21869725928SLuca Coelho if (!ret) 21969725928SLuca Coelho return 0; 22069725928SLuca Coelho } else { 22169725928SLuca Coelho IWL_DEBUG_FW(trans, "SKU ID didn't match!\n"); 22269725928SLuca Coelho } 22369725928SLuca Coelho } else { 22469725928SLuca Coelho data += sizeof(*tlv) + ALIGN(tlv_len, 4); 22569725928SLuca Coelho len -= ALIGN(tlv_len, 4); 22669725928SLuca Coelho } 22769725928SLuca Coelho } 22869725928SLuca Coelho 22969725928SLuca Coelho return -ENOENT; 23069725928SLuca Coelho } 23169725928SLuca Coelho 232cdda18fbSLuca Coelho static int iwl_pnvm_get_from_fs(struct iwl_trans *trans, u8 **data, size_t *len) 233b3e4c0f3SLuca Coelho { 2341c58bed4SJohannes Berg const struct firmware *pnvm; 2351c58bed4SJohannes Berg char pnvm_name[64]; 236cdda18fbSLuca Coelho int ret; 23769725928SLuca Coelho 238b3e4c0f3SLuca Coelho /* 23969725928SLuca Coelho * The prefix unfortunately includes a hyphen at the end, so 24069725928SLuca Coelho * don't add the dot here... 241b3e4c0f3SLuca Coelho */ 24269725928SLuca Coelho snprintf(pnvm_name, sizeof(pnvm_name), "%spnvm", 24369725928SLuca Coelho trans->cfg->fw_name_pre); 24469725928SLuca Coelho 24569725928SLuca Coelho /* ...but replace the hyphen with the dot here. */ 24669725928SLuca Coelho if (strlen(trans->cfg->fw_name_pre) < sizeof(pnvm_name)) 24769725928SLuca Coelho pnvm_name[strlen(trans->cfg->fw_name_pre) - 1] = '.'; 24869725928SLuca Coelho 24969725928SLuca Coelho ret = firmware_request_nowarn(&pnvm, pnvm_name, trans->dev); 25069725928SLuca Coelho if (ret) { 25169725928SLuca Coelho IWL_DEBUG_FW(trans, "PNVM file %s not found %d\n", 25269725928SLuca Coelho pnvm_name, ret); 253cdda18fbSLuca Coelho return ret; 254cdda18fbSLuca Coelho } 255cdda18fbSLuca Coelho 256cdda18fbSLuca Coelho *data = kmemdup(pnvm->data, pnvm->size, GFP_KERNEL); 257cdda18fbSLuca Coelho if (!*data) 258cdda18fbSLuca Coelho return -ENOMEM; 259cdda18fbSLuca Coelho 260cdda18fbSLuca Coelho *len = pnvm->size; 261cdda18fbSLuca Coelho 262cdda18fbSLuca Coelho return 0; 263cdda18fbSLuca Coelho } 264cdda18fbSLuca Coelho 265cdda18fbSLuca Coelho int iwl_pnvm_load(struct iwl_trans *trans, 266cdda18fbSLuca Coelho struct iwl_notif_wait_data *notif_wait) 267cdda18fbSLuca Coelho { 268cdda18fbSLuca Coelho u8 *data; 269cdda18fbSLuca Coelho size_t len; 270*84c3c995SLuca Coelho struct pnvm_sku_package *package; 271cdda18fbSLuca Coelho struct iwl_notification_wait pnvm_wait; 272cdda18fbSLuca Coelho static const u16 ntf_cmds[] = { WIDE_ID(REGULATORY_AND_NVM_GROUP, 273cdda18fbSLuca Coelho PNVM_INIT_COMPLETE_NTFY) }; 274cdda18fbSLuca Coelho int ret; 275cdda18fbSLuca Coelho 276cdda18fbSLuca Coelho /* if the SKU_ID is empty, there's nothing to do */ 277cdda18fbSLuca Coelho if (!trans->sku_id[0] && !trans->sku_id[1] && !trans->sku_id[2]) 278cdda18fbSLuca Coelho return 0; 279cdda18fbSLuca Coelho 280cdda18fbSLuca Coelho /* 281cdda18fbSLuca Coelho * If we already loaded (or tried to load) it before, we just 282cdda18fbSLuca Coelho * need to set it again. 283cdda18fbSLuca Coelho */ 284cdda18fbSLuca Coelho if (trans->pnvm_loaded) { 285cdda18fbSLuca Coelho ret = iwl_trans_set_pnvm(trans, NULL, 0); 286cdda18fbSLuca Coelho if (ret) 287cdda18fbSLuca Coelho return ret; 288cdda18fbSLuca Coelho goto skip_parse; 289cdda18fbSLuca Coelho } 290cdda18fbSLuca Coelho 291a1a6a4cfSLuca Coelho /* First attempt to get the PNVM from BIOS */ 292*84c3c995SLuca Coelho package = iwl_uefi_get_pnvm(trans, &len); 293*84c3c995SLuca Coelho if (!IS_ERR_OR_NULL(package)) { 294*84c3c995SLuca Coelho data = kmemdup(package->data, len, GFP_KERNEL); 295*84c3c995SLuca Coelho 296*84c3c995SLuca Coelho /* free package regardless of whether kmemdup succeeded */ 297*84c3c995SLuca Coelho kfree(package); 298*84c3c995SLuca Coelho 299*84c3c995SLuca Coelho if (data) { 300*84c3c995SLuca Coelho /* we need only the data size */ 301*84c3c995SLuca Coelho len -= sizeof(*package); 302a1a6a4cfSLuca Coelho goto parse; 303*84c3c995SLuca Coelho } 304*84c3c995SLuca Coelho } 305a1a6a4cfSLuca Coelho 306a1a6a4cfSLuca Coelho /* If it's not available, try from the filesystem */ 307cdda18fbSLuca Coelho ret = iwl_pnvm_get_from_fs(trans, &data, &len); 308cdda18fbSLuca Coelho if (ret) { 30982a08d0cSJohannes Berg /* 31082a08d0cSJohannes Berg * Pretend we've loaded it - at least we've tried and 31182a08d0cSJohannes Berg * couldn't load it at all, so there's no point in 31282a08d0cSJohannes Berg * trying again over and over. 31382a08d0cSJohannes Berg */ 31482a08d0cSJohannes Berg trans->pnvm_loaded = true; 31569725928SLuca Coelho 316cdda18fbSLuca Coelho goto skip_parse; 3171c58bed4SJohannes Berg } 318b3e4c0f3SLuca Coelho 319a1a6a4cfSLuca Coelho parse: 320cdda18fbSLuca Coelho iwl_pnvm_parse(trans, data, len); 321cdda18fbSLuca Coelho 322cdda18fbSLuca Coelho kfree(data); 323cdda18fbSLuca Coelho 324cdda18fbSLuca Coelho skip_parse: 325b3e4c0f3SLuca Coelho iwl_init_notification_wait(notif_wait, &pnvm_wait, 326b3e4c0f3SLuca Coelho ntf_cmds, ARRAY_SIZE(ntf_cmds), 327b3e4c0f3SLuca Coelho iwl_pnvm_complete_fn, trans); 328b3e4c0f3SLuca Coelho 329b3e4c0f3SLuca Coelho /* kick the doorbell */ 330b3e4c0f3SLuca Coelho iwl_write_umac_prph(trans, UREG_DOORBELL_TO_ISR6, 331b3e4c0f3SLuca Coelho UREG_DOORBELL_TO_ISR6_PNVM); 332b3e4c0f3SLuca Coelho 333b3e4c0f3SLuca Coelho return iwl_wait_notification(notif_wait, &pnvm_wait, 334b3e4c0f3SLuca Coelho MVM_UCODE_PNVM_TIMEOUT); 335b3e4c0f3SLuca Coelho } 336b3e4c0f3SLuca Coelho IWL_EXPORT_SYMBOL(iwl_pnvm_load); 337