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#include <kunit/visibility.h>
10
11/* for all modules */
12#define DRV_NAME        "iwlwifi"
13
14/* radio config bits (actual values from NVM definition) */
15#define NVM_RF_CFG_DASH_MSK(x)   (x & 0x3)         /* bits 0-1   */
16#define NVM_RF_CFG_STEP_MSK(x)   ((x >> 2)  & 0x3) /* bits 2-3   */
17#define NVM_RF_CFG_TYPE_MSK(x)   ((x >> 4)  & 0x3) /* bits 4-5   */
18#define NVM_RF_CFG_PNUM_MSK(x)   ((x >> 6)  & 0x3) /* bits 6-7   */
19#define NVM_RF_CFG_TX_ANT_MSK(x) ((x >> 8)  & 0xF) /* bits 8-11  */
20#define NVM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */
21
22#define EXT_NVM_RF_CFG_FLAVOR_MSK(x)   ((x) & 0xF)
23#define EXT_NVM_RF_CFG_DASH_MSK(x)   (((x) >> 4) & 0xF)
24#define EXT_NVM_RF_CFG_STEP_MSK(x)   (((x) >> 8) & 0xF)
25#define EXT_NVM_RF_CFG_TYPE_MSK(x)   (((x) >> 12) & 0xFFF)
26#define EXT_NVM_RF_CFG_TX_ANT_MSK(x) (((x) >> 24) & 0xF)
27#define EXT_NVM_RF_CFG_RX_ANT_MSK(x) (((x) >> 28) & 0xF)
28
29/**
30 * DOC: Driver system flows - drv component
31 *
32 * This component implements the system flows such as bus enumeration, bus
33 * removal. Bus dependent parts of system flows (such as iwl_pci_probe) are in
34 * bus specific files (transport files). This is the code that is common among
35 * different buses.
36 *
37 * This component is also in charge of managing the several implementations of
38 * the wifi flows: it will allow to have several fw API implementation. These
39 * different implementations will differ in the way they implement mac80211's
40 * handlers too.
41
42 * The init flow wrt to the drv component looks like this:
43 * 1) The bus specific component is called from module_init
44 * 2) The bus specific component registers the bus driver
45 * 3) The bus driver calls the probe function
46 * 4) The bus specific component configures the bus
47 * 5) The bus specific component calls to the drv bus agnostic part
48 *    (iwl_drv_start)
49 * 6) iwl_drv_start fetches the fw ASYNC, iwl_req_fw_callback
50 * 7) iwl_req_fw_callback parses the fw file
51 * 8) iwl_req_fw_callback starts the wifi implementation to matches the fw
52 */
53
54struct iwl_drv;
55struct iwl_trans;
56struct iwl_cfg;
57/**
58 * iwl_drv_start - start the drv
59 *
60 * @trans: the transport
61 *
62 * starts the driver: fetches the firmware. This should be called by bus
63 * specific system flows implementations. For example, the bus specific probe
64 * function should do bus related operations only, and then call to this
65 * function. It returns the driver object or %NULL if an error occurred.
66 */
67struct iwl_drv *iwl_drv_start(struct iwl_trans *trans);
68
69/**
70 * iwl_drv_stop - stop the drv
71 *
72 * @drv:
73 *
74 * Stop the driver. This should be called by bus specific system flows
75 * implementations. For example, the bus specific remove function should first
76 * call this function and then do the bus related operations only.
77 */
78void iwl_drv_stop(struct iwl_drv *drv);
79
80/*
81 * exported symbol management
82 *
83 * The driver can be split into multiple modules, in which case some symbols
84 * must be exported for the sub-modules. However, if it's not split and
85 * everything is built-in, then we can avoid that.
86 */
87#ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
88#define IWL_EXPORT_SYMBOL(sym)	EXPORT_SYMBOL_NS_GPL(sym, IWLWIFI)
89#else
90#define IWL_EXPORT_SYMBOL(sym)
91#endif
92
93#if IS_ENABLED(CONFIG_IWLWIFI_KUNIT_TESTS)
94#define EXPORT_SYMBOL_IF_IWLWIFI_KUNIT(sym)	EXPORT_SYMBOL_IF_KUNIT(sym)
95#define VISIBLE_IF_IWLWIFI_KUNIT
96#else
97#define EXPORT_SYMBOL_IF_IWLWIFI_KUNIT(sym)
98#define VISIBLE_IF_IWLWIFI_KUNIT static
99#endif
100
101#define FW_NAME_PRE_BUFSIZE	64
102struct iwl_trans;
103const char *iwl_drv_get_fwname_pre(struct iwl_trans *trans, char *buf);
104
105#endif /* __iwl_drv_h__ */
106