iwl-drv.h

  1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
  2/*
  3 * Copyright (C) 2005-2014, 2020-2021, 2023, 2025 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_rf_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.
 66 * Return: the driver object or %NULL if an error occurred.
 67 */
 68struct iwl_drv *iwl_drv_start(struct iwl_trans *trans);
 69
 70/**
 71 * iwl_drv_stop - stop the drv
 72 *
 73 * @drv:
 74 *
 75 * Stop the driver. This should be called by bus specific system flows
 76 * implementations. For example, the bus specific remove function should first
 77 * call this function and then do the bus related operations only.
 78 */
 79void iwl_drv_stop(struct iwl_drv *drv);
 80
 81/*
 82 * iwl_drv_is_wifi7_supported - returns if wifi7 is supported
 83 * If yes, iwlmld needs to be used to drive the device.
 84 */
 85bool iwl_drv_is_wifi7_supported(struct iwl_trans *trans);
 86
 87/*
 88 * exported symbol management
 89 *
 90 * The driver can be split into multiple modules, in which case some symbols
 91 * must be exported for the sub-modules. However, if it's not split and
 92 * everything is built-in, then we can avoid that.
 93 */
 94#ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
 95#define IWL_EXPORT_SYMBOL(sym)	EXPORT_SYMBOL_NS_GPL(sym, "IWLWIFI")
 96#else
 97#define IWL_EXPORT_SYMBOL(sym)
 98#endif
 99
100#if IS_ENABLED(CONFIG_IWLWIFI_KUNIT_TESTS)
101#define EXPORT_SYMBOL_IF_IWLWIFI_KUNIT(sym)	EXPORT_SYMBOL_IF_KUNIT(sym)
102#define VISIBLE_IF_IWLWIFI_KUNIT
103#else
104#define EXPORT_SYMBOL_IF_IWLWIFI_KUNIT(sym)
105#define VISIBLE_IF_IWLWIFI_KUNIT static
106#endif
107
108/* max retry for init flow */
109#define IWL_MAX_INIT_RETRY 2
110
111#define FW_NAME_PRE_BUFSIZE	64
112struct iwl_trans;
113const char *iwl_drv_get_fwname_pre(struct iwl_trans *trans, char *buf);
114
115#endif /* __iwl_drv_h__ */