intel/iwlwifi/iwl-drv.h

0001 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
0002 /*
0003  * Copyright (C) 2005-2014, 2020-2021 Intel Corporation
0004  * Copyright (C) 2013-2014 Intel Mobile Communications GmbH
0005  */
0006 #ifndef __iwl_drv_h__
0007 #define __iwl_drv_h__
0008 #include <linux/export.h>
0009
0010 /* for all modules */
0011 #define DRV_NAME        "iwlwifi"
0012
0013 /* radio config bits (actual values from NVM definition) */
0014 #define NVM_RF_CFG_DASH_MSK(x)   (x & 0x3)         /* bits 0-1   */
0015 #define NVM_RF_CFG_STEP_MSK(x)   ((x >> 2)  & 0x3) /* bits 2-3   */
0016 #define NVM_RF_CFG_TYPE_MSK(x)   ((x >> 4)  & 0x3) /* bits 4-5   */
0017 #define NVM_RF_CFG_PNUM_MSK(x)   ((x >> 6)  & 0x3) /* bits 6-7   */
0018 #define NVM_RF_CFG_TX_ANT_MSK(x) ((x >> 8)  & 0xF) /* bits 8-11  */
0019 #define NVM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */
0020
0021 #define EXT_NVM_RF_CFG_FLAVOR_MSK(x)   ((x) & 0xF)
0022 #define EXT_NVM_RF_CFG_DASH_MSK(x)   (((x) >> 4) & 0xF)
0023 #define EXT_NVM_RF_CFG_STEP_MSK(x)   (((x) >> 8) & 0xF)
0024 #define EXT_NVM_RF_CFG_TYPE_MSK(x)   (((x) >> 12) & 0xFFF)
0025 #define EXT_NVM_RF_CFG_TX_ANT_MSK(x) (((x) >> 24) & 0xF)
0026 #define EXT_NVM_RF_CFG_RX_ANT_MSK(x) (((x) >> 28) & 0xF)
0027
0028 /**
0029  * DOC: Driver system flows - drv component
0030  *
0031  * This component implements the system flows such as bus enumeration, bus
0032  * removal. Bus dependent parts of system flows (such as iwl_pci_probe) are in
0033  * bus specific files (transport files). This is the code that is common among
0034  * different buses.
0035  *
0036  * This component is also in charge of managing the several implementations of
0037  * the wifi flows: it will allow to have several fw API implementation. These
0038  * different implementations will differ in the way they implement mac80211's
0039  * handlers too.
0040
0041  * The init flow wrt to the drv component looks like this:
0042  * 1) The bus specific component is called from module_init
0043  * 2) The bus specific component registers the bus driver
0044  * 3) The bus driver calls the probe function
0045  * 4) The bus specific component configures the bus
0046  * 5) The bus specific component calls to the drv bus agnostic part
0047  *    (iwl_drv_start)
0048  * 6) iwl_drv_start fetches the fw ASYNC, iwl_req_fw_callback
0049  * 7) iwl_req_fw_callback parses the fw file
0050  * 8) iwl_req_fw_callback starts the wifi implementation to matches the fw
0051  */
0052
0053 struct iwl_drv;
0054 struct iwl_trans;
0055 struct iwl_cfg;
0056 /**
0057  * iwl_drv_start - start the drv
0058  *
0059  * @trans_ops: the ops of the transport
0060  *
0061  * starts the driver: fetches the firmware. This should be called by bus
0062  * specific system flows implementations. For example, the bus specific probe
0063  * function should do bus related operations only, and then call to this
0064  * function. It returns the driver object or %NULL if an error occurred.
0065  */
0066 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans);
0067
0068 /**
0069  * iwl_drv_stop - stop the drv
0070  *
0071  * @drv:
0072  *
0073  * Stop the driver. This should be called by bus specific system flows
0074  * implementations. For example, the bus specific remove function should first
0075  * call this function and then do the bus related operations only.
0076  */
0077 void iwl_drv_stop(struct iwl_drv *drv);
0078
0079 /*
0080  * exported symbol management
0081  *
0082  * The driver can be split into multiple modules, in which case some symbols
0083  * must be exported for the sub-modules. However, if it's not split and
0084  * everything is built-in, then we can avoid that.
0085  */
0086 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
0087 #define IWL_EXPORT_SYMBOL(sym)  EXPORT_SYMBOL_NS_GPL(sym, IWLWIFI)
0088 #else
0089 #define IWL_EXPORT_SYMBOL(sym)
0090 #endif
0091
0092 /* max retry for init flow */
0093 #define IWL_MAX_INIT_RETRY 2
0094
0095 #endif /* __iwl_drv_h__ */