Loading...
1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2/*
3 * Copyright (C) 2005-2014, 2020-2021, 2023 Intel Corporation
4 * Copyright (C) 2013-2014 Intel Mobile Communications GmbH
5 */
6#ifndef __iwl_drv_h__
7#define __iwl_drv_h__
8#include <linux/export.h>
9
10/* for all modules */
11#define DRV_NAME "iwlwifi"
12
13/* radio config bits (actual values from NVM definition) */
14#define NVM_RF_CFG_DASH_MSK(x) (x & 0x3) /* bits 0-1 */
15#define NVM_RF_CFG_STEP_MSK(x) ((x >> 2) & 0x3) /* bits 2-3 */
16#define NVM_RF_CFG_TYPE_MSK(x) ((x >> 4) & 0x3) /* bits 4-5 */
17#define NVM_RF_CFG_PNUM_MSK(x) ((x >> 6) & 0x3) /* bits 6-7 */
18#define NVM_RF_CFG_TX_ANT_MSK(x) ((x >> 8) & 0xF) /* bits 8-11 */
19#define NVM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */
20
21#define EXT_NVM_RF_CFG_FLAVOR_MSK(x) ((x) & 0xF)
22#define EXT_NVM_RF_CFG_DASH_MSK(x) (((x) >> 4) & 0xF)
23#define EXT_NVM_RF_CFG_STEP_MSK(x) (((x) >> 8) & 0xF)
24#define EXT_NVM_RF_CFG_TYPE_MSK(x) (((x) >> 12) & 0xFFF)
25#define EXT_NVM_RF_CFG_TX_ANT_MSK(x) (((x) >> 24) & 0xF)
26#define EXT_NVM_RF_CFG_RX_ANT_MSK(x) (((x) >> 28) & 0xF)
27
28/**
29 * DOC: Driver system flows - drv component
30 *
31 * This component implements the system flows such as bus enumeration, bus
32 * removal. Bus dependent parts of system flows (such as iwl_pci_probe) are in
33 * bus specific files (transport files). This is the code that is common among
34 * different buses.
35 *
36 * This component is also in charge of managing the several implementations of
37 * the wifi flows: it will allow to have several fw API implementation. These
38 * different implementations will differ in the way they implement mac80211's
39 * handlers too.
40
41 * The init flow wrt to the drv component looks like this:
42 * 1) The bus specific component is called from module_init
43 * 2) The bus specific component registers the bus driver
44 * 3) The bus driver calls the probe function
45 * 4) The bus specific component configures the bus
46 * 5) The bus specific component calls to the drv bus agnostic part
47 * (iwl_drv_start)
48 * 6) iwl_drv_start fetches the fw ASYNC, iwl_req_fw_callback
49 * 7) iwl_req_fw_callback parses the fw file
50 * 8) iwl_req_fw_callback starts the wifi implementation to matches the fw
51 */
52
53struct iwl_drv;
54struct iwl_trans;
55struct iwl_cfg;
56/**
57 * iwl_drv_start - start the drv
58 *
59 * @trans: the transport
60 *
61 * starts the driver: fetches the firmware. This should be called by bus
62 * specific system flows implementations. For example, the bus specific probe
63 * function should do bus related operations only, and then call to this
64 * function. It returns the driver object or %NULL if an error occurred.
65 */
66struct iwl_drv *iwl_drv_start(struct iwl_trans *trans);
67
68/**
69 * iwl_drv_stop - stop the drv
70 *
71 * @drv:
72 *
73 * Stop the driver. This should be called by bus specific system flows
74 * implementations. For example, the bus specific remove function should first
75 * call this function and then do the bus related operations only.
76 */
77void iwl_drv_stop(struct iwl_drv *drv);
78
79/*
80 * exported symbol management
81 *
82 * The driver can be split into multiple modules, in which case some symbols
83 * must be exported for the sub-modules. However, if it's not split and
84 * everything is built-in, then we can avoid that.
85 */
86#ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
87#define IWL_EXPORT_SYMBOL(sym) EXPORT_SYMBOL_NS_GPL(sym, IWLWIFI)
88#else
89#define IWL_EXPORT_SYMBOL(sym)
90#endif
91
92/* max retry for init flow */
93#define IWL_MAX_INIT_RETRY 2
94
95#define FW_NAME_PRE_BUFSIZE 64
96struct iwl_trans;
97const char *iwl_drv_get_fwname_pre(struct iwl_trans *trans, char *buf);
98
99#endif /* __iwl_drv_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 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2014 Intel Mobile Communications 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) 2013 - 2014 Intel Mobile Communications 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
65#ifndef __iwl_drv_h__
66#define __iwl_drv_h__
67#include <linux/export.h>
68
69/* for all modules */
70#define DRV_NAME "iwlwifi"
71#define DRV_COPYRIGHT "Copyright(c) 2003- 2015 Intel Corporation"
72#define DRV_AUTHOR "<linuxwifi@intel.com>"
73
74/* radio config bits (actual values from NVM definition) */
75#define NVM_RF_CFG_DASH_MSK(x) (x & 0x3) /* bits 0-1 */
76#define NVM_RF_CFG_STEP_MSK(x) ((x >> 2) & 0x3) /* bits 2-3 */
77#define NVM_RF_CFG_TYPE_MSK(x) ((x >> 4) & 0x3) /* bits 4-5 */
78#define NVM_RF_CFG_PNUM_MSK(x) ((x >> 6) & 0x3) /* bits 6-7 */
79#define NVM_RF_CFG_TX_ANT_MSK(x) ((x >> 8) & 0xF) /* bits 8-11 */
80#define NVM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */
81
82#define EXT_NVM_RF_CFG_FLAVOR_MSK(x) ((x) & 0xF)
83#define EXT_NVM_RF_CFG_DASH_MSK(x) (((x) >> 4) & 0xF)
84#define EXT_NVM_RF_CFG_STEP_MSK(x) (((x) >> 8) & 0xF)
85#define EXT_NVM_RF_CFG_TYPE_MSK(x) (((x) >> 12) & 0xFFF)
86#define EXT_NVM_RF_CFG_TX_ANT_MSK(x) (((x) >> 24) & 0xF)
87#define EXT_NVM_RF_CFG_RX_ANT_MSK(x) (((x) >> 28) & 0xF)
88
89/**
90 * DOC: Driver system flows - drv component
91 *
92 * This component implements the system flows such as bus enumeration, bus
93 * removal. Bus dependent parts of system flows (such as iwl_pci_probe) are in
94 * bus specific files (transport files). This is the code that is common among
95 * different buses.
96 *
97 * This component is also in charge of managing the several implementations of
98 * the wifi flows: it will allow to have several fw API implementation. These
99 * different implementations will differ in the way they implement mac80211's
100 * handlers too.
101
102 * The init flow wrt to the drv component looks like this:
103 * 1) The bus specific component is called from module_init
104 * 2) The bus specific component registers the bus driver
105 * 3) The bus driver calls the probe function
106 * 4) The bus specific component configures the bus
107 * 5) The bus specific component calls to the drv bus agnostic part
108 * (iwl_drv_start)
109 * 6) iwl_drv_start fetches the fw ASYNC, iwl_req_fw_callback
110 * 7) iwl_req_fw_callback parses the fw file
111 * 8) iwl_req_fw_callback starts the wifi implementation to matches the fw
112 */
113
114struct iwl_drv;
115struct iwl_trans;
116struct iwl_cfg;
117/**
118 * iwl_drv_start - start the drv
119 *
120 * @trans_ops: the ops of the transport
121 *
122 * starts the driver: fetches the firmware. This should be called by bus
123 * specific system flows implementations. For example, the bus specific probe
124 * function should do bus related operations only, and then call to this
125 * function. It returns the driver object or %NULL if an error occurred.
126 */
127struct iwl_drv *iwl_drv_start(struct iwl_trans *trans);
128
129/**
130 * iwl_drv_stop - stop the drv
131 *
132 * @drv:
133 *
134 * Stop the driver. This should be called by bus specific system flows
135 * implementations. For example, the bus specific remove function should first
136 * call this function and then do the bus related operations only.
137 */
138void iwl_drv_stop(struct iwl_drv *drv);
139
140/*
141 * exported symbol management
142 *
143 * The driver can be split into multiple modules, in which case some symbols
144 * must be exported for the sub-modules. However, if it's not split and
145 * everything is built-in, then we can avoid that.
146 */
147#ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
148#define IWL_EXPORT_SYMBOL(sym) EXPORT_SYMBOL_GPL(sym)
149#else
150#define IWL_EXPORT_SYMBOL(sym)
151#endif
152
153#endif /* __iwl_drv_h__ */