1b3e4c0f3SLuca Coelho // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause 2cdda18fbSLuca Coelho /* 3*b99e32cbSAlon Giladi * Copyright(c) 2020-2023 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, 34*b99e32cbSAlon Giladi size_t len, 35*b99e32cbSAlon Giladi struct iwl_pnvm_image *pnvm_data) 3669725928SLuca Coelho { 3773c289baSBjoern A. Zeeb const struct iwl_ucode_tlv *tlv; 3869725928SLuca Coelho u32 sha1 = 0; 3969725928SLuca Coelho u16 mac_type = 0, rf_id = 0; 400f673c16SJohannes Berg bool hw_match = false; 4169725928SLuca Coelho 4269725928SLuca Coelho IWL_DEBUG_FW(trans, "Handling PNVM section\n"); 4369725928SLuca Coelho 44*b99e32cbSAlon Giladi memset(pnvm_data, 0, sizeof(*pnvm_data)); 45*b99e32cbSAlon Giladi 4669725928SLuca Coelho while (len >= sizeof(*tlv)) { 4769725928SLuca Coelho u32 tlv_len, tlv_type; 4869725928SLuca Coelho 4969725928SLuca Coelho len -= sizeof(*tlv); 5073c289baSBjoern A. Zeeb tlv = (const 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); 585f408503SAlon Giladi return -EINVAL; 5969725928SLuca Coelho } 6069725928SLuca Coelho 6169725928SLuca Coelho data += sizeof(*tlv); 6269725928SLuca Coelho 6369725928SLuca Coelho switch (tlv_type) { 6469725928SLuca Coelho case IWL_UCODE_TLV_PNVM_VERSION: 6569725928SLuca Coelho if (tlv_len < sizeof(__le32)) { 6669725928SLuca Coelho IWL_DEBUG_FW(trans, 6769725928SLuca Coelho "Invalid size for IWL_UCODE_TLV_PNVM_VERSION (expected %zd, got %d)\n", 6869725928SLuca Coelho sizeof(__le32), tlv_len); 6969725928SLuca Coelho break; 7069725928SLuca Coelho } 7169725928SLuca Coelho 7273c289baSBjoern A. Zeeb sha1 = le32_to_cpup((const __le32 *)data); 7369725928SLuca Coelho 7469725928SLuca Coelho IWL_DEBUG_FW(trans, 7569725928SLuca Coelho "Got IWL_UCODE_TLV_PNVM_VERSION %0x\n", 7669725928SLuca Coelho sha1); 77*b99e32cbSAlon Giladi pnvm_data->version = 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 870f673c16SJohannes Berg if (hw_match) 880f673c16SJohannes Berg break; 890f673c16SJohannes Berg 9073c289baSBjoern A. Zeeb mac_type = le16_to_cpup((const __le16 *)data); 9173c289baSBjoern A. Zeeb rf_id = le16_to_cpup((const __le16 *)(data + sizeof(__le16))); 9269725928SLuca Coelho 9369725928SLuca Coelho IWL_DEBUG_FW(trans, 9469725928SLuca Coelho "Got IWL_UCODE_TLV_HW_TYPE mac_type 0x%0x rf_id 0x%0x\n", 9569725928SLuca Coelho mac_type, rf_id); 9669725928SLuca Coelho 970f673c16SJohannes Berg if (mac_type == CSR_HW_REV_TYPE(trans->hw_rev) && 980f673c16SJohannes Berg rf_id == CSR_HW_RFID_TYPE(trans->hw_rf_id)) 990f673c16SJohannes Berg hw_match = true; 10069725928SLuca Coelho break; 10169725928SLuca Coelho case IWL_UCODE_TLV_SEC_RT: { 10273c289baSBjoern A. Zeeb const struct iwl_pnvm_section *section = (const void *)data; 10369725928SLuca Coelho u32 data_len = tlv_len - sizeof(*section); 10469725928SLuca Coelho 10569725928SLuca Coelho IWL_DEBUG_FW(trans, 10669725928SLuca Coelho "Got IWL_UCODE_TLV_SEC_RT len %d\n", 10769725928SLuca Coelho tlv_len); 10869725928SLuca Coelho 10969725928SLuca Coelho /* TODO: remove, this is a deprecated separator */ 11073c289baSBjoern A. Zeeb if (le32_to_cpup((const __le32 *)data) == 0xddddeeee) { 11169725928SLuca Coelho IWL_DEBUG_FW(trans, "Ignoring separator.\n"); 11269725928SLuca Coelho break; 11369725928SLuca Coelho } 11469725928SLuca Coelho 115*b99e32cbSAlon Giladi if (pnvm_data->n_chunks == IPC_DRAM_MAP_ENTRY_NUM_MAX) { 1165f408503SAlon Giladi IWL_DEBUG_FW(trans, 1175f408503SAlon Giladi "too many payloads to allocate in DRAM.\n"); 1185f408503SAlon Giladi return -EINVAL; 1195f408503SAlon Giladi } 1205f408503SAlon Giladi 12169725928SLuca Coelho IWL_DEBUG_FW(trans, "Adding data (size %d)\n", 12269725928SLuca Coelho data_len); 12369725928SLuca Coelho 124*b99e32cbSAlon Giladi pnvm_data->chunks[pnvm_data->n_chunks].data = section->data; 125*b99e32cbSAlon Giladi pnvm_data->chunks[pnvm_data->n_chunks].len = data_len; 126*b99e32cbSAlon Giladi pnvm_data->n_chunks++; 12769725928SLuca Coelho 12869725928SLuca Coelho break; 12969725928SLuca Coelho } 13069725928SLuca Coelho case IWL_UCODE_TLV_PNVM_SKU: 13169725928SLuca Coelho IWL_DEBUG_FW(trans, 13269725928SLuca Coelho "New PNVM section started, stop parsing.\n"); 13369725928SLuca Coelho goto done; 13469725928SLuca Coelho default: 13569725928SLuca Coelho IWL_DEBUG_FW(trans, "Found TLV 0x%0x, len %d\n", 13669725928SLuca Coelho tlv_type, tlv_len); 13769725928SLuca Coelho break; 13869725928SLuca Coelho } 13969725928SLuca Coelho 14069725928SLuca Coelho len -= ALIGN(tlv_len, 4); 14169725928SLuca Coelho data += ALIGN(tlv_len, 4); 14269725928SLuca Coelho } 14369725928SLuca Coelho 14469725928SLuca Coelho done: 1450f673c16SJohannes Berg if (!hw_match) { 1460f673c16SJohannes Berg IWL_DEBUG_FW(trans, 1470f673c16SJohannes Berg "HW mismatch, skipping PNVM section (need mac_type 0x%x rf_id 0x%x)\n", 1480f673c16SJohannes Berg CSR_HW_REV_TYPE(trans->hw_rev), 1490f673c16SJohannes Berg CSR_HW_RFID_TYPE(trans->hw_rf_id)); 1505f408503SAlon Giladi return -ENOENT; 1510f673c16SJohannes Berg } 1520f673c16SJohannes Berg 153*b99e32cbSAlon Giladi if (!pnvm_data->n_chunks) { 15469725928SLuca Coelho IWL_DEBUG_FW(trans, "Empty PNVM, skipping.\n"); 1555f408503SAlon Giladi return -ENOENT; 15669725928SLuca Coelho } 15769725928SLuca Coelho 158194d1f84SAlon Giladi return 0; 15969725928SLuca Coelho } 16069725928SLuca Coelho 16169725928SLuca Coelho static int iwl_pnvm_parse(struct iwl_trans *trans, const u8 *data, 162*b99e32cbSAlon Giladi size_t len, 163*b99e32cbSAlon Giladi struct iwl_pnvm_image *pnvm_data) 16469725928SLuca Coelho { 16573c289baSBjoern A. Zeeb const struct iwl_ucode_tlv *tlv; 16669725928SLuca Coelho 16769725928SLuca Coelho IWL_DEBUG_FW(trans, "Parsing PNVM file\n"); 16869725928SLuca Coelho 16969725928SLuca Coelho while (len >= sizeof(*tlv)) { 17069725928SLuca Coelho u32 tlv_len, tlv_type; 17169725928SLuca Coelho 17269725928SLuca Coelho len -= sizeof(*tlv); 17386e8e657SJohannes Berg tlv = (const void *)data; 17469725928SLuca Coelho 17569725928SLuca Coelho tlv_len = le32_to_cpu(tlv->length); 17669725928SLuca Coelho tlv_type = le32_to_cpu(tlv->type); 17769725928SLuca Coelho 17869725928SLuca Coelho if (len < tlv_len) { 17969725928SLuca Coelho IWL_ERR(trans, "invalid TLV len: %zd/%u\n", 18069725928SLuca Coelho len, tlv_len); 18169725928SLuca Coelho return -EINVAL; 18269725928SLuca Coelho } 18369725928SLuca Coelho 18469725928SLuca Coelho if (tlv_type == IWL_UCODE_TLV_PNVM_SKU) { 18573c289baSBjoern A. Zeeb const struct iwl_sku_id *sku_id = 18673c289baSBjoern A. Zeeb (const void *)(data + sizeof(*tlv)); 18769725928SLuca Coelho 18869725928SLuca Coelho IWL_DEBUG_FW(trans, 18969725928SLuca Coelho "Got IWL_UCODE_TLV_PNVM_SKU len %d\n", 19069725928SLuca Coelho tlv_len); 19169725928SLuca Coelho IWL_DEBUG_FW(trans, "sku_id 0x%0x 0x%0x 0x%0x\n", 19269725928SLuca Coelho le32_to_cpu(sku_id->data[0]), 19369725928SLuca Coelho le32_to_cpu(sku_id->data[1]), 19469725928SLuca Coelho le32_to_cpu(sku_id->data[2])); 19569725928SLuca Coelho 196ff11a8eeSLuca Coelho data += sizeof(*tlv) + ALIGN(tlv_len, 4); 197ff11a8eeSLuca Coelho len -= ALIGN(tlv_len, 4); 198ff11a8eeSLuca Coelho 19969725928SLuca Coelho if (trans->sku_id[0] == le32_to_cpu(sku_id->data[0]) && 20069725928SLuca Coelho trans->sku_id[1] == le32_to_cpu(sku_id->data[1]) && 20169725928SLuca Coelho trans->sku_id[2] == le32_to_cpu(sku_id->data[2])) { 20269725928SLuca Coelho int ret; 20369725928SLuca Coelho 204*b99e32cbSAlon Giladi ret = iwl_pnvm_handle_section(trans, data, len, 205*b99e32cbSAlon Giladi pnvm_data); 20669725928SLuca Coelho if (!ret) 20769725928SLuca Coelho return 0; 20869725928SLuca Coelho } else { 20969725928SLuca Coelho IWL_DEBUG_FW(trans, "SKU ID didn't match!\n"); 21069725928SLuca Coelho } 21169725928SLuca Coelho } else { 21269725928SLuca Coelho data += sizeof(*tlv) + ALIGN(tlv_len, 4); 21369725928SLuca Coelho len -= ALIGN(tlv_len, 4); 21469725928SLuca Coelho } 21569725928SLuca Coelho } 21669725928SLuca Coelho 21769725928SLuca Coelho return -ENOENT; 21869725928SLuca Coelho } 21969725928SLuca Coelho 220cdda18fbSLuca Coelho static int iwl_pnvm_get_from_fs(struct iwl_trans *trans, u8 **data, size_t *len) 221b3e4c0f3SLuca Coelho { 2221c58bed4SJohannes Berg const struct firmware *pnvm; 223b05c1d14SDror Moshe char pnvm_name[MAX_PNVM_NAME]; 22445010c08SChristophe JAILLET size_t new_len; 225cdda18fbSLuca Coelho int ret; 22669725928SLuca Coelho 227b05c1d14SDror Moshe iwl_pnvm_get_fs_name(trans, pnvm_name, sizeof(pnvm_name)); 22869725928SLuca Coelho 22969725928SLuca Coelho ret = firmware_request_nowarn(&pnvm, pnvm_name, trans->dev); 23069725928SLuca Coelho if (ret) { 23169725928SLuca Coelho IWL_DEBUG_FW(trans, "PNVM file %s not found %d\n", 23269725928SLuca Coelho pnvm_name, ret); 233cdda18fbSLuca Coelho return ret; 234cdda18fbSLuca Coelho } 235cdda18fbSLuca Coelho 23645010c08SChristophe JAILLET new_len = pnvm->size; 237cdda18fbSLuca Coelho *data = kmemdup(pnvm->data, pnvm->size, GFP_KERNEL); 23845010c08SChristophe JAILLET release_firmware(pnvm); 23945010c08SChristophe JAILLET 240cdda18fbSLuca Coelho if (!*data) 241cdda18fbSLuca Coelho return -ENOMEM; 242cdda18fbSLuca Coelho 24345010c08SChristophe JAILLET *len = new_len; 244cdda18fbSLuca Coelho 245cdda18fbSLuca Coelho return 0; 246cdda18fbSLuca Coelho } 247cdda18fbSLuca Coelho 248*b99e32cbSAlon Giladi static u8 *iwl_get_pnvm_image(struct iwl_trans *trans_p, size_t *len) 249*b99e32cbSAlon Giladi { 250*b99e32cbSAlon Giladi struct pnvm_sku_package *package; 251*b99e32cbSAlon Giladi u8 *image = NULL; 252*b99e32cbSAlon Giladi 253*b99e32cbSAlon Giladi /* First attempt to get the PNVM from BIOS */ 254*b99e32cbSAlon Giladi package = iwl_uefi_get_pnvm(trans_p, len); 255*b99e32cbSAlon Giladi if (!IS_ERR_OR_NULL(package)) { 256*b99e32cbSAlon Giladi if (*len >= sizeof(*package)) { 257*b99e32cbSAlon Giladi /* we need only the data */ 258*b99e32cbSAlon Giladi *len -= sizeof(*package); 259*b99e32cbSAlon Giladi image = kmemdup(package->data, *len, GFP_KERNEL); 260*b99e32cbSAlon Giladi } 261*b99e32cbSAlon Giladi /* free package regardless of whether kmemdup succeeded */ 262*b99e32cbSAlon Giladi kfree(package); 263*b99e32cbSAlon Giladi if (image) 264*b99e32cbSAlon Giladi return image; 265*b99e32cbSAlon Giladi } 266*b99e32cbSAlon Giladi 267*b99e32cbSAlon Giladi /* If it's not available, try from the filesystem */ 268*b99e32cbSAlon Giladi if (iwl_pnvm_get_from_fs(trans_p, &image, len)) 269*b99e32cbSAlon Giladi return NULL; 270*b99e32cbSAlon Giladi return image; 271*b99e32cbSAlon Giladi } 272*b99e32cbSAlon Giladi 273cdda18fbSLuca Coelho int iwl_pnvm_load(struct iwl_trans *trans, 274cdda18fbSLuca Coelho struct iwl_notif_wait_data *notif_wait) 275cdda18fbSLuca Coelho { 276cdda18fbSLuca Coelho u8 *data; 277*b99e32cbSAlon Giladi size_t length; 278cdda18fbSLuca Coelho struct iwl_notification_wait pnvm_wait; 279cdda18fbSLuca Coelho static const u16 ntf_cmds[] = { WIDE_ID(REGULATORY_AND_NVM_GROUP, 280cdda18fbSLuca Coelho PNVM_INIT_COMPLETE_NTFY) }; 281*b99e32cbSAlon Giladi struct iwl_pnvm_image pnvm_data; 282cdda18fbSLuca Coelho int ret; 283cdda18fbSLuca Coelho 284cdda18fbSLuca Coelho /* if the SKU_ID is empty, there's nothing to do */ 285cdda18fbSLuca Coelho if (!trans->sku_id[0] && !trans->sku_id[1] && !trans->sku_id[2]) 286cdda18fbSLuca Coelho return 0; 287cdda18fbSLuca Coelho 288*b99e32cbSAlon Giladi /* failed to get/parse the image in the past, no use to try again */ 289*b99e32cbSAlon Giladi if (trans->fail_to_parse_pnvm_image) 290*b99e32cbSAlon Giladi goto reduce_tables; 291*b99e32cbSAlon Giladi 292*b99e32cbSAlon Giladi /* get the image, parse and load it, if not loaded yet */ 293*b99e32cbSAlon Giladi if (!trans->pnvm_loaded) { 294*b99e32cbSAlon Giladi data = iwl_get_pnvm_image(trans, &length); 295*b99e32cbSAlon Giladi if (!data) { 296*b99e32cbSAlon Giladi trans->fail_to_parse_pnvm_image = true; 297*b99e32cbSAlon Giladi goto reduce_tables; 298cdda18fbSLuca Coelho } 299*b99e32cbSAlon Giladi ret = iwl_pnvm_parse(trans, data, length, &pnvm_data); 300cdda18fbSLuca Coelho if (ret) { 301*b99e32cbSAlon Giladi trans->fail_to_parse_pnvm_image = true; 302*b99e32cbSAlon Giladi kfree(data); 303*b99e32cbSAlon Giladi goto reduce_tables; 3041c58bed4SJohannes Berg } 305b3e4c0f3SLuca Coelho 306*b99e32cbSAlon Giladi ret = iwl_trans_load_pnvm(trans, &pnvm_data); 307*b99e32cbSAlon Giladi /* can only free data after pvnm_data use, but 308*b99e32cbSAlon Giladi * pnvm_data.version used below is not a pointer 309*b99e32cbSAlon Giladi */ 310cdda18fbSLuca Coelho kfree(data); 311*b99e32cbSAlon Giladi if (ret) 312*b99e32cbSAlon Giladi goto reduce_tables; 313*b99e32cbSAlon Giladi IWL_INFO(trans, "loaded PNVM version %08x\n", 314*b99e32cbSAlon Giladi pnvm_data.version); 315*b99e32cbSAlon Giladi } 316cdda18fbSLuca Coelho 317*b99e32cbSAlon Giladi iwl_trans_set_pnvm(trans); 318*b99e32cbSAlon Giladi 319*b99e32cbSAlon Giladi reduce_tables: 3209dad325fSLuca Coelho /* now try to get the reduce power table, if not loaded yet */ 3219dad325fSLuca Coelho if (!trans->reduce_power_loaded) { 322*b99e32cbSAlon Giladi data = iwl_uefi_get_reduced_power(trans, &length); 3239dad325fSLuca Coelho if (IS_ERR_OR_NULL(data)) { 3249dad325fSLuca Coelho /* 3259dad325fSLuca Coelho * Pretend we've loaded it - at least we've tried and 3269dad325fSLuca Coelho * couldn't load it at all, so there's no point in 3279dad325fSLuca Coelho * trying again over and over. 3289dad325fSLuca Coelho */ 3299dad325fSLuca Coelho trans->reduce_power_loaded = true; 3308f55564cSJohannes Berg } else { 331*b99e32cbSAlon Giladi ret = iwl_trans_set_reduce_power(trans, data, length); 3329dad325fSLuca Coelho if (ret) 3339dad325fSLuca Coelho IWL_DEBUG_FW(trans, 3349dad325fSLuca Coelho "Failed to set reduce power table %d\n", 3359dad325fSLuca Coelho ret); 3369dad325fSLuca Coelho kfree(data); 3378f55564cSJohannes Berg } 3388f55564cSJohannes Berg } 3399dad325fSLuca Coelho 340b3e4c0f3SLuca Coelho iwl_init_notification_wait(notif_wait, &pnvm_wait, 341b3e4c0f3SLuca Coelho ntf_cmds, ARRAY_SIZE(ntf_cmds), 342b3e4c0f3SLuca Coelho iwl_pnvm_complete_fn, trans); 343b3e4c0f3SLuca Coelho 344b3e4c0f3SLuca Coelho /* kick the doorbell */ 345b3e4c0f3SLuca Coelho iwl_write_umac_prph(trans, UREG_DOORBELL_TO_ISR6, 346b3e4c0f3SLuca Coelho UREG_DOORBELL_TO_ISR6_PNVM); 347b3e4c0f3SLuca Coelho 348b3e4c0f3SLuca Coelho return iwl_wait_notification(notif_wait, &pnvm_wait, 349b3e4c0f3SLuca Coelho MVM_UCODE_PNVM_TIMEOUT); 350b3e4c0f3SLuca Coelho } 351b3e4c0f3SLuca Coelho IWL_EXPORT_SYMBOL(iwl_pnvm_load); 352