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