intel/iwlwifi/iwl-op-mode.h

0001 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
0002 /*
0003  * Copyright (C) 2005-2014, 2018-2021 Intel Corporation
0004  * Copyright (C) 2013-2014 Intel Mobile Communications GmbH
0005  * Copyright (C) 2015 Intel Deutschland GmbH
0006  */
0007 #ifndef __iwl_op_mode_h__
0008 #define __iwl_op_mode_h__
0009
0010 #include <linux/netdevice.h>
0011 #include <linux/debugfs.h>
0012 #include "iwl-dbg-tlv.h"
0013
0014 struct iwl_op_mode;
0015 struct iwl_trans;
0016 struct sk_buff;
0017 struct iwl_device_cmd;
0018 struct iwl_rx_cmd_buffer;
0019 struct iwl_fw;
0020 struct iwl_cfg;
0021
0022 /**
0023  * DOC: Operational mode - what is it ?
0024  *
0025  * The operational mode (a.k.a. op_mode) is the layer that implements
0026  * mac80211's handlers. It knows two APIs: mac80211's and the fw's. It uses
0027  * the transport API to access the HW. The op_mode doesn't need to know how the
0028  * underlying HW works, since the transport layer takes care of that.
0029  *
0030  * There can be several op_mode: i.e. different fw APIs will require two
0031  * different op_modes. This is why the op_mode is virtualized.
0032  */
0033
0034 /**
0035  * DOC: Life cycle of the Operational mode
0036  *
0037  * The operational mode has a very simple life cycle.
0038  *
0039  *  1) The driver layer (iwl-drv.c) chooses the op_mode based on the
0040  *     capabilities advertised by the fw file (in TLV format).
0041  *  2) The driver layer starts the op_mode (ops->start)
0042  *  3) The op_mode registers mac80211
0043  *  4) The op_mode is governed by mac80211
0044  *  5) The driver layer stops the op_mode
0045  */
0046
0047 /**
0048  * struct iwl_op_mode_ops - op_mode specific operations
0049  *
0050  * The op_mode exports its ops so that external components can start it and
0051  * interact with it. The driver layer typically calls the start and stop
0052  * handlers, the transport layer calls the others.
0053  *
0054  * All the handlers MUST be implemented, except @rx_rss which can be left
0055  * out *iff* the opmode will never run on hardware with multi-queue capability.
0056  *
0057  * @start: start the op_mode. The transport layer is already allocated.
0058  *  May sleep
0059  * @stop: stop the op_mode. Must free all the memory allocated.
0060  *  May sleep
0061  * @rx: Rx notification to the op_mode. rxb is the Rx buffer itself. Cmd is the
0062  *  HCMD this Rx responds to. Can't sleep.
0063  * @rx_rss: data queue RX notification to the op_mode, for (data) notifications
0064  *  received on the RSS queue(s). The queue parameter indicates which of the
0065  *  RSS queues received this frame; it will always be non-zero.
0066  *  This method must not sleep.
0067  * @async_cb: called when an ASYNC command with CMD_WANT_ASYNC_CALLBACK set
0068  *  completes. Must be atomic.
0069  * @queue_full: notifies that a HW queue is full.
0070  *  Must be atomic and called with BH disabled.
0071  * @queue_not_full: notifies that a HW queue is not full any more.
0072  *  Must be atomic and called with BH disabled.
0073  * @hw_rf_kill:notifies of a change in the HW rf kill switch. True means that
0074  *  the radio is killed. Return %true if the device should be stopped by
0075  *  the transport immediately after the call. May sleep.
0076  * @free_skb: allows the transport layer to free skbs that haven't been
0077  *  reclaimed by the op_mode. This can happen when the driver is freed and
0078  *  there are Tx packets pending in the transport layer.
0079  *  Must be atomic
0080  * @nic_error: error notification. Must be atomic and must be called with BH
0081  *  disabled, unless the sync parameter is true.
0082  * @cmd_queue_full: Called when the command queue gets full. Must be atomic and
0083  *  called with BH disabled.
0084  * @nic_config: configure NIC, called before firmware is started.
0085  *  May sleep
0086  * @wimax_active: invoked when WiMax becomes active. May sleep
0087  * @time_point: called when transport layer wants to collect debug data
0088  */
0089 struct iwl_op_mode_ops {
0090     struct iwl_op_mode *(*start)(struct iwl_trans *trans,
0091                      const struct iwl_cfg *cfg,
0092                      const struct iwl_fw *fw,
0093                      struct dentry *dbgfs_dir);
0094     void (*stop)(struct iwl_op_mode *op_mode);
0095     void (*rx)(struct iwl_op_mode *op_mode, struct napi_struct *napi,
0096            struct iwl_rx_cmd_buffer *rxb);
0097     void (*rx_rss)(struct iwl_op_mode *op_mode, struct napi_struct *napi,
0098                struct iwl_rx_cmd_buffer *rxb, unsigned int queue);
0099     void (*async_cb)(struct iwl_op_mode *op_mode,
0100              const struct iwl_device_cmd *cmd);
0101     void (*queue_full)(struct iwl_op_mode *op_mode, int queue);
0102     void (*queue_not_full)(struct iwl_op_mode *op_mode, int queue);
0103     bool (*hw_rf_kill)(struct iwl_op_mode *op_mode, bool state);
0104     void (*free_skb)(struct iwl_op_mode *op_mode, struct sk_buff *skb);
0105     void (*nic_error)(struct iwl_op_mode *op_mode, bool sync);
0106     void (*cmd_queue_full)(struct iwl_op_mode *op_mode);
0107     void (*nic_config)(struct iwl_op_mode *op_mode);
0108     void (*wimax_active)(struct iwl_op_mode *op_mode);
0109     void (*time_point)(struct iwl_op_mode *op_mode,
0110                enum iwl_fw_ini_time_point tp_id,
0111                union iwl_dbg_tlv_tp_data *tp_data);
0112 };
0113
0114 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops);
0115 void iwl_opmode_deregister(const char *name);
0116
0117 /**
0118  * struct iwl_op_mode - operational mode
0119  * @ops: pointer to its own ops
0120  *
0121  * This holds an implementation of the mac80211 / fw API.
0122  */
0123 struct iwl_op_mode {
0124     const struct iwl_op_mode_ops *ops;
0125
0126     char op_mode_specific[] __aligned(sizeof(void *));
0127 };
0128
0129 static inline void iwl_op_mode_stop(struct iwl_op_mode *op_mode)
0130 {
0131     might_sleep();
0132     op_mode->ops->stop(op_mode);
0133 }
0134
0135 static inline void iwl_op_mode_rx(struct iwl_op_mode *op_mode,
0136                   struct napi_struct *napi,
0137                   struct iwl_rx_cmd_buffer *rxb)
0138 {
0139     return op_mode->ops->rx(op_mode, napi, rxb);
0140 }
0141
0142 static inline void iwl_op_mode_rx_rss(struct iwl_op_mode *op_mode,
0143                       struct napi_struct *napi,
0144                       struct iwl_rx_cmd_buffer *rxb,
0145                       unsigned int queue)
0146 {
0147     op_mode->ops->rx_rss(op_mode, napi, rxb, queue);
0148 }
0149
0150 static inline void iwl_op_mode_async_cb(struct iwl_op_mode *op_mode,
0151                     const struct iwl_device_cmd *cmd)
0152 {
0153     if (op_mode->ops->async_cb)
0154         op_mode->ops->async_cb(op_mode, cmd);
0155 }
0156
0157 static inline void iwl_op_mode_queue_full(struct iwl_op_mode *op_mode,
0158                       int queue)
0159 {
0160     op_mode->ops->queue_full(op_mode, queue);
0161 }
0162
0163 static inline void iwl_op_mode_queue_not_full(struct iwl_op_mode *op_mode,
0164                           int queue)
0165 {
0166     op_mode->ops->queue_not_full(op_mode, queue);
0167 }
0168
0169 static inline bool __must_check
0170 iwl_op_mode_hw_rf_kill(struct iwl_op_mode *op_mode, bool state)
0171 {
0172     might_sleep();
0173     return op_mode->ops->hw_rf_kill(op_mode, state);
0174 }
0175
0176 static inline void iwl_op_mode_free_skb(struct iwl_op_mode *op_mode,
0177                     struct sk_buff *skb)
0178 {
0179     if (WARN_ON_ONCE(!op_mode))
0180         return;
0181     op_mode->ops->free_skb(op_mode, skb);
0182 }
0183
0184 static inline void iwl_op_mode_nic_error(struct iwl_op_mode *op_mode, bool sync)
0185 {
0186     op_mode->ops->nic_error(op_mode, sync);
0187 }
0188
0189 static inline void iwl_op_mode_cmd_queue_full(struct iwl_op_mode *op_mode)
0190 {
0191     op_mode->ops->cmd_queue_full(op_mode);
0192 }
0193
0194 static inline void iwl_op_mode_nic_config(struct iwl_op_mode *op_mode)
0195 {
0196     might_sleep();
0197     op_mode->ops->nic_config(op_mode);
0198 }
0199
0200 static inline void iwl_op_mode_wimax_active(struct iwl_op_mode *op_mode)
0201 {
0202     might_sleep();
0203     op_mode->ops->wimax_active(op_mode);
0204 }
0205
0206 static inline void iwl_op_mode_time_point(struct iwl_op_mode *op_mode,
0207                       enum iwl_fw_ini_time_point tp_id,
0208                       union iwl_dbg_tlv_tp_data *tp_data)
0209 {
0210     if (!op_mode || !op_mode->ops || !op_mode->ops->time_point)
0211         return;
0212     op_mode->ops->time_point(op_mode, tp_id, tp_data);
0213 }
0214
0215 #endif /* __iwl_op_mode_h__ */