Loading...
1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2/*
3 * Copyright (C) 2005-2015, 2018-2023 Intel Corporation
4 * Copyright (C) 2016-2017 Intel Deutschland GmbH
5 */
6#ifndef __iwl_nvm_parse_h__
7#define __iwl_nvm_parse_h__
8
9#include <net/cfg80211.h>
10#include "iwl-eeprom-parse.h"
11#include "mei/iwl-mei.h"
12
13/**
14 * enum iwl_nvm_sbands_flags - modification flags for the channel profiles
15 *
16 * @IWL_NVM_SBANDS_FLAGS_LAR: LAR is enabled
17 * @IWL_NVM_SBANDS_FLAGS_NO_WIDE_IN_5GHZ: disallow 40, 80 and 160MHz on 5GHz
18 */
19enum iwl_nvm_sbands_flags {
20 IWL_NVM_SBANDS_FLAGS_LAR = BIT(0),
21 IWL_NVM_SBANDS_FLAGS_NO_WIDE_IN_5GHZ = BIT(1),
22};
23
24/*
25 * iwl_parse_nvm_data - parse NVM data and return values
26 *
27 * This function parses all NVM values we need and then
28 * returns a (newly allocated) struct containing all the
29 * relevant values for driver use. The struct must be freed
30 * later with iwl_free_nvm_data().
31 */
32struct iwl_nvm_data *
33iwl_parse_nvm_data(struct iwl_trans *trans, const struct iwl_cfg *cfg,
34 const struct iwl_fw *fw,
35 const __be16 *nvm_hw, const __le16 *nvm_sw,
36 const __le16 *nvm_calib, const __le16 *regulatory,
37 const __le16 *mac_override, const __le16 *phy_sku,
38 u8 tx_chains, u8 rx_chains);
39
40/**
41 * iwl_parse_mcc_info - parse MCC (mobile country code) info coming from FW
42 *
43 * This function parses the regulatory channel data received as a
44 * MCC_UPDATE_CMD command. It returns a newly allocation regulatory domain,
45 * to be fed into the regulatory core. In case the geo_info is set handle
46 * accordingly. An ERR_PTR is returned on error.
47 * If not given to the regulatory core, the user is responsible for freeing
48 * the regdomain returned here with kfree.
49 */
50struct ieee80211_regdomain *
51iwl_parse_nvm_mcc_info(struct device *dev, const struct iwl_cfg *cfg,
52 int num_of_ch, __le32 *channels, u16 fw_mcc,
53 u16 geo_info, u32 cap, u8 resp_ver);
54
55/**
56 * struct iwl_nvm_section - describes an NVM section in memory.
57 *
58 * This struct holds an NVM section read from the NIC using NVM_ACCESS_CMD,
59 * and saved for later use by the driver. Not all NVM sections are saved
60 * this way, only the needed ones.
61 */
62struct iwl_nvm_section {
63 u16 length;
64 const u8 *data;
65};
66
67/**
68 * iwl_read_external_nvm - Reads external NVM from a file into nvm_sections
69 */
70int iwl_read_external_nvm(struct iwl_trans *trans,
71 const char *nvm_file_name,
72 struct iwl_nvm_section *nvm_sections);
73void iwl_nvm_fixups(u32 hw_id, unsigned int section, u8 *data,
74 unsigned int len);
75
76/*
77 * iwl_get_nvm - retrieve NVM data from firmware
78 *
79 * Allocates a new iwl_nvm_data structure, fills it with
80 * NVM data, and returns it to caller.
81 */
82struct iwl_nvm_data *iwl_get_nvm(struct iwl_trans *trans,
83 const struct iwl_fw *fw,
84 u8 set_tx_ant, u8 set_rx_ant);
85
86/*
87 * iwl_parse_mei_nvm_data - parse the mei_nvm_data and get an iwl_nvm_data
88 */
89struct iwl_nvm_data *
90iwl_parse_mei_nvm_data(struct iwl_trans *trans, const struct iwl_cfg *cfg,
91 const struct iwl_mei_nvm *mei_nvm,
92 const struct iwl_fw *fw, u8 set_tx_ant, u8 set_rx_ant);
93
94/*
95 * iwl_reinit_cab - to be called when the tx_chains or rx_chains are modified
96 */
97void iwl_reinit_cab(struct iwl_trans *trans, struct iwl_nvm_data *data,
98 u8 tx_chains, u8 rx_chains, const struct iwl_fw *fw);
99
100#endif /* __iwl_nvm_parse_h__ */
1/******************************************************************************
2 *
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * GPL LICENSE SUMMARY
7 *
8 * Copyright(c) 2008 - 2015 Intel Corporation. All rights reserved.
9 * Copyright(c) 2016 Intel Deutschland GmbH
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
23 * USA
24 *
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
27 *
28 * Contact Information:
29 * Intel Linux Wireless <linuxwifi@intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
31 *
32 * BSD LICENSE
33 *
34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
35 * All rights reserved.
36 *
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
39 * are met:
40 *
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in
45 * the documentation and/or other materials provided with the
46 * distribution.
47 * * Neither the name Intel Corporation nor the names of its
48 * contributors may be used to endorse or promote products derived
49 * from this software without specific prior written permission.
50 *
51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 *****************************************************************************/
63#ifndef __iwl_nvm_parse_h__
64#define __iwl_nvm_parse_h__
65
66#include <net/cfg80211.h>
67#include "iwl-eeprom-parse.h"
68
69/**
70 * iwl_parse_nvm_data - parse NVM data and return values
71 *
72 * This function parses all NVM values we need and then
73 * returns a (newly allocated) struct containing all the
74 * relevant values for driver use. The struct must be freed
75 * later with iwl_free_nvm_data().
76 */
77struct iwl_nvm_data *
78iwl_parse_nvm_data(struct iwl_trans *trans, const struct iwl_cfg *cfg,
79 const __le16 *nvm_hw, const __le16 *nvm_sw,
80 const __le16 *nvm_calib, const __le16 *regulatory,
81 const __le16 *mac_override, const __le16 *phy_sku,
82 u8 tx_chains, u8 rx_chains, bool lar_fw_supported);
83
84/**
85 * iwl_parse_mcc_info - parse MCC (mobile country code) info coming from FW
86 *
87 * This function parses the regulatory channel data received as a
88 * MCC_UPDATE_CMD command. It returns a newly allocation regulatory domain,
89 * to be fed into the regulatory core. An ERR_PTR is returned on error.
90 * If not given to the regulatory core, the user is responsible for freeing
91 * the regdomain returned here with kfree.
92 */
93struct ieee80211_regdomain *
94iwl_parse_nvm_mcc_info(struct device *dev, const struct iwl_cfg *cfg,
95 int num_of_ch, __le32 *channels, u16 fw_mcc);
96
97#ifdef CONFIG_ACPI
98/**
99 * iwl_get_bios_mcc - read MCC from BIOS, if available
100 *
101 * @dev: the struct device
102 * @mcc: output buffer (3 bytes) that will get the MCC
103 *
104 * This function tries to read the current MCC from ACPI if available.
105 */
106int iwl_get_bios_mcc(struct device *dev, char *mcc);
107#else
108static inline int iwl_get_bios_mcc(struct device *dev, char *mcc)
109{
110 return -ENOENT;
111}
112#endif
113
114#endif /* __iwl_nvm_parse_h__ */