1b3e4c0f3SLuca Coelho // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause 2b3e4c0f3SLuca Coelho /****************************************************************************** 3b3e4c0f3SLuca Coelho * 4b3e4c0f3SLuca Coelho * Copyright(c) 2020 Intel Corporation 5b3e4c0f3SLuca Coelho * 6b3e4c0f3SLuca Coelho *****************************************************************************/ 7b3e4c0f3SLuca Coelho 8b3e4c0f3SLuca Coelho #include "iwl-drv.h" 9b3e4c0f3SLuca Coelho #include "pnvm.h" 10b3e4c0f3SLuca Coelho #include "iwl-prph.h" 11b3e4c0f3SLuca Coelho #include "iwl-io.h" 12b3e4c0f3SLuca Coelho #include "fw/api/commands.h" 13b3e4c0f3SLuca Coelho #include "fw/api/nvm-reg.h" 1469725928SLuca Coelho #include "fw/api/alive.h" 1569725928SLuca Coelho 1669725928SLuca Coelho struct iwl_pnvm_section { 1769725928SLuca Coelho __le32 offset; 1869725928SLuca Coelho const u8 data[]; 1969725928SLuca Coelho } __packed; 20b3e4c0f3SLuca Coelho 21b3e4c0f3SLuca Coelho static bool iwl_pnvm_complete_fn(struct iwl_notif_wait_data *notif_wait, 22b3e4c0f3SLuca Coelho struct iwl_rx_packet *pkt, void *data) 23b3e4c0f3SLuca Coelho { 24b3e4c0f3SLuca Coelho struct iwl_trans *trans = (struct iwl_trans *)data; 25b3e4c0f3SLuca Coelho struct iwl_pnvm_init_complete_ntfy *pnvm_ntf = (void *)pkt->data; 26b3e4c0f3SLuca Coelho 27b3e4c0f3SLuca Coelho IWL_DEBUG_FW(trans, 28b3e4c0f3SLuca Coelho "PNVM complete notification received with status %d\n", 29b3e4c0f3SLuca Coelho le32_to_cpu(pnvm_ntf->status)); 30b3e4c0f3SLuca Coelho 31b3e4c0f3SLuca Coelho return true; 32b3e4c0f3SLuca Coelho } 33b3e4c0f3SLuca Coelho 3469725928SLuca Coelho static int iwl_pnvm_handle_section(struct iwl_trans *trans, const u8 *data, 3569725928SLuca Coelho size_t len) 3669725928SLuca Coelho { 3769725928SLuca Coelho struct iwl_ucode_tlv *tlv; 3869725928SLuca Coelho u32 sha1 = 0; 3969725928SLuca Coelho u16 mac_type = 0, rf_id = 0; 4069725928SLuca Coelho u8 *pnvm_data = NULL, *tmp; 4169725928SLuca Coelho u32 size = 0; 4269725928SLuca Coelho int ret; 4369725928SLuca Coelho 4469725928SLuca Coelho IWL_DEBUG_FW(trans, "Handling PNVM section\n"); 4569725928SLuca Coelho 4669725928SLuca Coelho while (len >= sizeof(*tlv)) { 4769725928SLuca Coelho u32 tlv_len, tlv_type; 4869725928SLuca Coelho 4969725928SLuca Coelho len -= sizeof(*tlv); 5069725928SLuca Coelho tlv = (void *)data; 5169725928SLuca Coelho 5269725928SLuca Coelho tlv_len = le32_to_cpu(tlv->length); 5369725928SLuca Coelho tlv_type = le32_to_cpu(tlv->type); 5469725928SLuca Coelho 5569725928SLuca Coelho if (len < tlv_len) { 5669725928SLuca Coelho IWL_ERR(trans, "invalid TLV len: %zd/%u\n", 5769725928SLuca Coelho len, tlv_len); 5869725928SLuca Coelho ret = -EINVAL; 5969725928SLuca Coelho goto out; 6069725928SLuca Coelho } 6169725928SLuca Coelho 6269725928SLuca Coelho data += sizeof(*tlv); 6369725928SLuca Coelho 6469725928SLuca Coelho switch (tlv_type) { 6569725928SLuca Coelho case IWL_UCODE_TLV_PNVM_VERSION: 6669725928SLuca Coelho if (tlv_len < sizeof(__le32)) { 6769725928SLuca Coelho IWL_DEBUG_FW(trans, 6869725928SLuca Coelho "Invalid size for IWL_UCODE_TLV_PNVM_VERSION (expected %zd, got %d)\n", 6969725928SLuca Coelho sizeof(__le32), tlv_len); 7069725928SLuca Coelho break; 7169725928SLuca Coelho } 7269725928SLuca Coelho 7369725928SLuca Coelho sha1 = le32_to_cpup((__le32 *)data); 7469725928SLuca Coelho 7569725928SLuca Coelho IWL_DEBUG_FW(trans, 7669725928SLuca Coelho "Got IWL_UCODE_TLV_PNVM_VERSION %0x\n", 7769725928SLuca Coelho sha1); 7869725928SLuca Coelho break; 7969725928SLuca Coelho case IWL_UCODE_TLV_HW_TYPE: 8069725928SLuca Coelho if (tlv_len < 2 * sizeof(__le16)) { 8169725928SLuca Coelho IWL_DEBUG_FW(trans, 8269725928SLuca Coelho "Invalid size for IWL_UCODE_TLV_HW_TYPE (expected %zd, got %d)\n", 8369725928SLuca Coelho 2 * sizeof(__le16), tlv_len); 8469725928SLuca Coelho break; 8569725928SLuca Coelho } 8669725928SLuca Coelho 8769725928SLuca Coelho mac_type = le16_to_cpup((__le16 *)data); 8869725928SLuca Coelho rf_id = le16_to_cpup((__le16 *)(data + sizeof(__le16))); 8969725928SLuca Coelho 9069725928SLuca Coelho IWL_DEBUG_FW(trans, 9169725928SLuca Coelho "Got IWL_UCODE_TLV_HW_TYPE mac_type 0x%0x rf_id 0x%0x\n", 9269725928SLuca Coelho mac_type, rf_id); 9369725928SLuca Coelho 9469725928SLuca Coelho if (mac_type != CSR_HW_REV_TYPE(trans->hw_rev) || 9569725928SLuca Coelho rf_id != CSR_HW_RFID_TYPE(trans->hw_rf_id)) { 9669725928SLuca Coelho IWL_DEBUG_FW(trans, 9769725928SLuca Coelho "HW mismatch, skipping PNVM section, mac_type 0x%0x, rf_id 0x%0x.\n", 9869725928SLuca Coelho CSR_HW_REV_TYPE(trans->hw_rev), trans->hw_rf_id); 9969725928SLuca Coelho ret = -ENOENT; 10069725928SLuca Coelho goto out; 10169725928SLuca Coelho } 10269725928SLuca Coelho 10369725928SLuca Coelho break; 10469725928SLuca Coelho case IWL_UCODE_TLV_SEC_RT: { 10569725928SLuca Coelho struct iwl_pnvm_section *section = (void *)data; 10669725928SLuca Coelho u32 data_len = tlv_len - sizeof(*section); 10769725928SLuca Coelho 10869725928SLuca Coelho IWL_DEBUG_FW(trans, 10969725928SLuca Coelho "Got IWL_UCODE_TLV_SEC_RT len %d\n", 11069725928SLuca Coelho tlv_len); 11169725928SLuca Coelho 11269725928SLuca Coelho /* TODO: remove, this is a deprecated separator */ 11369725928SLuca Coelho if (le32_to_cpup((__le32 *)data) == 0xddddeeee) { 11469725928SLuca Coelho IWL_DEBUG_FW(trans, "Ignoring separator.\n"); 11569725928SLuca Coelho break; 11669725928SLuca Coelho } 11769725928SLuca Coelho 11869725928SLuca Coelho IWL_DEBUG_FW(trans, "Adding data (size %d)\n", 11969725928SLuca Coelho data_len); 12069725928SLuca Coelho 12169725928SLuca Coelho tmp = krealloc(pnvm_data, size + data_len, GFP_KERNEL); 12269725928SLuca Coelho if (!tmp) { 12369725928SLuca Coelho IWL_DEBUG_FW(trans, 12469725928SLuca Coelho "Couldn't allocate (more) pnvm_data\n"); 12569725928SLuca Coelho 12669725928SLuca Coelho ret = -ENOMEM; 12769725928SLuca Coelho goto out; 12869725928SLuca Coelho } 12969725928SLuca Coelho 13069725928SLuca Coelho pnvm_data = tmp; 13169725928SLuca Coelho 13269725928SLuca Coelho memcpy(pnvm_data + size, section->data, data_len); 13369725928SLuca Coelho 13469725928SLuca Coelho size += data_len; 13569725928SLuca Coelho 13669725928SLuca Coelho break; 13769725928SLuca Coelho } 13869725928SLuca Coelho case IWL_UCODE_TLV_PNVM_SKU: 13969725928SLuca Coelho IWL_DEBUG_FW(trans, 14069725928SLuca Coelho "New PNVM section started, stop parsing.\n"); 14169725928SLuca Coelho goto done; 14269725928SLuca Coelho default: 14369725928SLuca Coelho IWL_DEBUG_FW(trans, "Found TLV 0x%0x, len %d\n", 14469725928SLuca Coelho tlv_type, tlv_len); 14569725928SLuca Coelho break; 14669725928SLuca Coelho } 14769725928SLuca Coelho 14869725928SLuca Coelho len -= ALIGN(tlv_len, 4); 14969725928SLuca Coelho data += ALIGN(tlv_len, 4); 15069725928SLuca Coelho } 15169725928SLuca Coelho 15269725928SLuca Coelho done: 15369725928SLuca Coelho if (!size) { 15469725928SLuca Coelho IWL_DEBUG_FW(trans, "Empty PNVM, skipping.\n"); 15569725928SLuca Coelho ret = -ENOENT; 15669725928SLuca Coelho goto out; 15769725928SLuca Coelho } 15869725928SLuca Coelho 15969725928SLuca Coelho IWL_INFO(trans, "loaded PNVM version 0x%0x\n", sha1); 16069725928SLuca Coelho 16169725928SLuca Coelho ret = iwl_trans_set_pnvm(trans, pnvm_data, size); 16269725928SLuca Coelho out: 16369725928SLuca Coelho kfree(pnvm_data); 16469725928SLuca Coelho return ret; 16569725928SLuca Coelho } 16669725928SLuca Coelho 16769725928SLuca Coelho static int iwl_pnvm_parse(struct iwl_trans *trans, const u8 *data, 16869725928SLuca Coelho size_t len) 16969725928SLuca Coelho { 17069725928SLuca Coelho struct iwl_ucode_tlv *tlv; 17169725928SLuca Coelho 17269725928SLuca Coelho IWL_DEBUG_FW(trans, "Parsing PNVM file\n"); 17369725928SLuca Coelho 17469725928SLuca Coelho while (len >= sizeof(*tlv)) { 17569725928SLuca Coelho u32 tlv_len, tlv_type; 17669725928SLuca Coelho 17769725928SLuca Coelho len -= sizeof(*tlv); 17869725928SLuca Coelho tlv = (void *)data; 17969725928SLuca Coelho 18069725928SLuca Coelho tlv_len = le32_to_cpu(tlv->length); 18169725928SLuca Coelho tlv_type = le32_to_cpu(tlv->type); 18269725928SLuca Coelho 18369725928SLuca Coelho if (len < tlv_len) { 18469725928SLuca Coelho IWL_ERR(trans, "invalid TLV len: %zd/%u\n", 18569725928SLuca Coelho len, tlv_len); 18669725928SLuca Coelho return -EINVAL; 18769725928SLuca Coelho } 18869725928SLuca Coelho 18969725928SLuca Coelho if (tlv_type == IWL_UCODE_TLV_PNVM_SKU) { 19069725928SLuca Coelho struct iwl_sku_id *sku_id = 19169725928SLuca Coelho (void *)(data + sizeof(*tlv)); 19269725928SLuca Coelho 19369725928SLuca Coelho IWL_DEBUG_FW(trans, 19469725928SLuca Coelho "Got IWL_UCODE_TLV_PNVM_SKU len %d\n", 19569725928SLuca Coelho tlv_len); 19669725928SLuca Coelho IWL_DEBUG_FW(trans, "sku_id 0x%0x 0x%0x 0x%0x\n", 19769725928SLuca Coelho le32_to_cpu(sku_id->data[0]), 19869725928SLuca Coelho le32_to_cpu(sku_id->data[1]), 19969725928SLuca Coelho le32_to_cpu(sku_id->data[2])); 20069725928SLuca Coelho 201*ff11a8eeSLuca Coelho data += sizeof(*tlv) + ALIGN(tlv_len, 4); 202*ff11a8eeSLuca Coelho len -= ALIGN(tlv_len, 4); 203*ff11a8eeSLuca Coelho 20469725928SLuca Coelho if (trans->sku_id[0] == le32_to_cpu(sku_id->data[0]) && 20569725928SLuca Coelho trans->sku_id[1] == le32_to_cpu(sku_id->data[1]) && 20669725928SLuca Coelho trans->sku_id[2] == le32_to_cpu(sku_id->data[2])) { 20769725928SLuca Coelho int ret; 20869725928SLuca Coelho 20969725928SLuca Coelho ret = iwl_pnvm_handle_section(trans, data, len); 21069725928SLuca Coelho if (!ret) 21169725928SLuca Coelho return 0; 21269725928SLuca Coelho } else { 21369725928SLuca Coelho IWL_DEBUG_FW(trans, "SKU ID didn't match!\n"); 21469725928SLuca Coelho } 21569725928SLuca Coelho } else { 21669725928SLuca Coelho data += sizeof(*tlv) + ALIGN(tlv_len, 4); 21769725928SLuca Coelho len -= ALIGN(tlv_len, 4); 21869725928SLuca Coelho } 21969725928SLuca Coelho } 22069725928SLuca Coelho 22169725928SLuca Coelho return -ENOENT; 22269725928SLuca Coelho } 22369725928SLuca Coelho 224b3e4c0f3SLuca Coelho int iwl_pnvm_load(struct iwl_trans *trans, 225b3e4c0f3SLuca Coelho struct iwl_notif_wait_data *notif_wait) 226b3e4c0f3SLuca Coelho { 227b3e4c0f3SLuca Coelho struct iwl_notification_wait pnvm_wait; 228b3e4c0f3SLuca Coelho static const u16 ntf_cmds[] = { WIDE_ID(REGULATORY_AND_NVM_GROUP, 229b3e4c0f3SLuca Coelho PNVM_INIT_COMPLETE_NTFY) }; 2304a81598fSLuca Coelho int ret; 231b3e4c0f3SLuca Coelho 232b3e4c0f3SLuca Coelho /* if the SKU_ID is empty, there's nothing to do */ 233b3e4c0f3SLuca Coelho if (!trans->sku_id[0] && !trans->sku_id[1] && !trans->sku_id[2]) 234b3e4c0f3SLuca Coelho return 0; 235b3e4c0f3SLuca Coelho 23682a08d0cSJohannes Berg /* load from disk only if we haven't done it (or tried) before */ 2371c58bed4SJohannes Berg if (!trans->pnvm_loaded) { 2381c58bed4SJohannes Berg const struct firmware *pnvm; 2391c58bed4SJohannes Berg char pnvm_name[64]; 24069725928SLuca Coelho 241b3e4c0f3SLuca Coelho /* 24269725928SLuca Coelho * The prefix unfortunately includes a hyphen at the end, so 24369725928SLuca Coelho * don't add the dot here... 244b3e4c0f3SLuca Coelho */ 24569725928SLuca Coelho snprintf(pnvm_name, sizeof(pnvm_name), "%spnvm", 24669725928SLuca Coelho trans->cfg->fw_name_pre); 24769725928SLuca Coelho 24869725928SLuca Coelho /* ...but replace the hyphen with the dot here. */ 24969725928SLuca Coelho if (strlen(trans->cfg->fw_name_pre) < sizeof(pnvm_name)) 25069725928SLuca Coelho pnvm_name[strlen(trans->cfg->fw_name_pre) - 1] = '.'; 25169725928SLuca Coelho 25269725928SLuca Coelho ret = firmware_request_nowarn(&pnvm, pnvm_name, trans->dev); 25369725928SLuca Coelho if (ret) { 25469725928SLuca Coelho IWL_DEBUG_FW(trans, "PNVM file %s not found %d\n", 25569725928SLuca Coelho pnvm_name, ret); 25682a08d0cSJohannes Berg /* 25782a08d0cSJohannes Berg * Pretend we've loaded it - at least we've tried and 25882a08d0cSJohannes Berg * couldn't load it at all, so there's no point in 25982a08d0cSJohannes Berg * trying again over and over. 26082a08d0cSJohannes Berg */ 26182a08d0cSJohannes Berg trans->pnvm_loaded = true; 26269725928SLuca Coelho } else { 26369725928SLuca Coelho iwl_pnvm_parse(trans, pnvm->data, pnvm->size); 26469725928SLuca Coelho 26569725928SLuca Coelho release_firmware(pnvm); 26669725928SLuca Coelho } 2674a81598fSLuca Coelho } else { 2684a81598fSLuca Coelho /* if we already loaded, we need to set it again */ 2694a81598fSLuca Coelho ret = iwl_trans_set_pnvm(trans, NULL, 0); 2704a81598fSLuca Coelho if (ret) 2714a81598fSLuca Coelho return ret; 2721c58bed4SJohannes Berg } 273b3e4c0f3SLuca Coelho 274b3e4c0f3SLuca Coelho iwl_init_notification_wait(notif_wait, &pnvm_wait, 275b3e4c0f3SLuca Coelho ntf_cmds, ARRAY_SIZE(ntf_cmds), 276b3e4c0f3SLuca Coelho iwl_pnvm_complete_fn, trans); 277b3e4c0f3SLuca Coelho 278b3e4c0f3SLuca Coelho /* kick the doorbell */ 279b3e4c0f3SLuca Coelho iwl_write_umac_prph(trans, UREG_DOORBELL_TO_ISR6, 280b3e4c0f3SLuca Coelho UREG_DOORBELL_TO_ISR6_PNVM); 281b3e4c0f3SLuca Coelho 282b3e4c0f3SLuca Coelho return iwl_wait_notification(notif_wait, &pnvm_wait, 283b3e4c0f3SLuca Coelho MVM_UCODE_PNVM_TIMEOUT); 284b3e4c0f3SLuca Coelho } 285b3e4c0f3SLuca Coelho IWL_EXPORT_SYMBOL(iwl_pnvm_load); 286