GNU Linux-libre 4.14.266-gnu1
[releases.git] / drivers / net / wireless / intel / iwlwifi / 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 - 2017 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  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
36  * All rights reserved.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions
40  * are met:
41  *
42  *  * Redistributions of source code must retain the above copyright
43  *    notice, this list of conditions and the following disclaimer.
44  *  * Redistributions in binary form must reproduce the above copyright
45  *    notice, this list of conditions and the following disclaimer in
46  *    the documentation and/or other materials provided with the
47  *    distribution.
48  *  * Neither the name Intel Corporation nor the names of its
49  *    contributors may be used to endorse or promote products derived
50  *    from this software without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63  *****************************************************************************/
64 #ifndef __iwl_nvm_parse_h__
65 #define __iwl_nvm_parse_h__
66
67 #include <net/cfg80211.h>
68 #include "iwl-eeprom-parse.h"
69
70 /**
71  * iwl_parse_nvm_data - parse NVM data and return values
72  *
73  * This function parses all NVM values we need and then
74  * returns a (newly allocated) struct containing all the
75  * relevant values for driver use. The struct must be freed
76  * later with iwl_free_nvm_data().
77  */
78 struct iwl_nvm_data *
79 iwl_parse_nvm_data(struct iwl_trans *trans, const struct iwl_cfg *cfg,
80                    const __be16 *nvm_hw, const __le16 *nvm_sw,
81                    const __le16 *nvm_calib, const __le16 *regulatory,
82                    const __le16 *mac_override, const __le16 *phy_sku,
83                    u8 tx_chains, u8 rx_chains, bool lar_fw_supported);
84
85 /**
86  * iwl_set_hw_address_from_csr - sets HW address for 9000 devices and on
87  */
88 void iwl_set_hw_address_from_csr(struct iwl_trans *trans,
89                                  struct iwl_nvm_data *data);
90
91 /**
92  * iwl_init_sbands - parse and set all channel profiles
93  */
94 void iwl_init_sbands(struct device *dev, const struct iwl_cfg *cfg,
95                      struct iwl_nvm_data *data, const __le16 *nvm_ch_flags,
96                      u8 tx_chains, u8 rx_chains, bool lar_supported,
97                      bool no_wide_in_5ghz);
98
99 /**
100  * iwl_parse_mcc_info - parse MCC (mobile country code) info coming from FW
101  *
102  * This function parses the regulatory channel data received as a
103  * MCC_UPDATE_CMD command. It returns a newly allocation regulatory domain,
104  * to be fed into the regulatory core. An ERR_PTR is returned on error.
105  * If not given to the regulatory core, the user is responsible for freeing
106  * the regdomain returned here with kfree.
107  */
108 struct ieee80211_regdomain *
109 iwl_parse_nvm_mcc_info(struct device *dev, const struct iwl_cfg *cfg,
110                        int num_of_ch, __le32 *channels, u16 fw_mcc);
111
112 #ifdef CONFIG_ACPI
113 /**
114  * iwl_get_bios_mcc - read MCC from BIOS, if available
115  *
116  * @dev: the struct device
117  * @mcc: output buffer (3 bytes) that will get the MCC
118  *
119  * This function tries to read the current MCC from ACPI if available.
120  */
121 int iwl_get_bios_mcc(struct device *dev, char *mcc);
122 #else
123 static inline int iwl_get_bios_mcc(struct device *dev, char *mcc)
124 {
125         return -ENOENT;
126 }
127 #endif
128
129 #endif /* __iwl_nvm_parse_h__ */