1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * This file contains definitions and data structures specific
4  * to Marvell 802.11 NIC. It contains the Device Information
5  * structure struct lbs_private..
6  */
7 #ifndef _LBS_DEV_H_
8 #define _LBS_DEV_H_
9 
10 #include "defs.h"
11 #include "decl.h"
12 #include "host.h"
13 
14 #include <linux/kfifo.h>
15 
16 /* sleep_params */
17 struct sleep_params {
18 	uint16_t sp_error;
19 	uint16_t sp_offset;
20 	uint16_t sp_stabletime;
21 	uint8_t  sp_calcontrol;
22 	uint8_t  sp_extsleepclk;
23 	uint16_t sp_reserved;
24 };
25 
26 /* Mesh statistics */
27 struct lbs_mesh_stats {
28 	u32	fwd_bcast_cnt;		/* Fwd: Broadcast counter */
29 	u32	fwd_unicast_cnt;	/* Fwd: Unicast counter */
30 	u32	fwd_drop_ttl;		/* Fwd: TTL zero */
31 	u32	fwd_drop_rbt;		/* Fwd: Recently Broadcasted */
32 	u32	fwd_drop_noroute; 	/* Fwd: No route to Destination */
33 	u32	fwd_drop_nobuf;		/* Fwd: Run out of internal buffers */
34 	u32	drop_blind;		/* Rx:  Dropped by blinding table */
35 	u32	tx_failed_cnt;		/* Tx:  Failed transmissions */
36 };
37 
38 /* Private structure for the MV device */
39 struct lbs_private {
40 
41 	/* Basic networking */
42 	struct net_device *dev;
43 	u32 connect_status;
44 	struct work_struct mcast_work;
45 	u32 nr_of_multicastmacaddr;
46 	u8 multicastlist[MRVDRV_MAX_MULTICAST_LIST_SIZE][ETH_ALEN];
47 
48 	/* CFG80211 */
49 	struct wireless_dev *wdev;
50 	bool wiphy_registered;
51 	struct cfg80211_scan_request *scan_req;
52 	u8 assoc_bss[ETH_ALEN];
53 	u8 country_code[IEEE80211_COUNTRY_STRING_LEN];
54 	u8 disassoc_reason;
55 
56 	/* Mesh */
57 	struct net_device *mesh_dev; /* Virtual device */
58 #ifdef CONFIG_LIBERTAS_MESH
59 	struct lbs_mesh_stats mstats;
60 	uint16_t mesh_tlv;
61 	u8 mesh_ssid[IEEE80211_MAX_SSID_LEN + 1];
62 	u8 mesh_ssid_len;
63 	u8 mesh_channel;
64 #endif
65 
66 	/* Debugfs */
67 	struct dentry *debugfs_dir;
68 	struct dentry *debugfs_debug;
69 	struct dentry *debugfs_files[6];
70 	struct dentry *events_dir;
71 	struct dentry *debugfs_events_files[6];
72 	struct dentry *regs_dir;
73 	struct dentry *debugfs_regs_files[6];
74 
75 	/* Hardware debugging */
76 	u32 mac_offset;
77 	u32 bbp_offset;
78 	u32 rf_offset;
79 
80 	/* Power management */
81 	u16 psmode;
82 	u32 psstate;
83 	u8 needtowakeup;
84 
85 	/* Deep sleep */
86 	int is_deep_sleep;
87 	int deep_sleep_required;
88 	int is_auto_deep_sleep_enabled;
89 	int wakeup_dev_required;
90 	int is_activity_detected;
91 	int auto_deep_sleep_timeout; /* in ms */
92 	wait_queue_head_t ds_awake_q;
93 	struct timer_list auto_deepsleep_timer;
94 
95 	/* Host sleep*/
96 	int is_host_sleep_configured;
97 	int is_host_sleep_activated;
98 	wait_queue_head_t host_sleep_q;
99 
100 	/* Hardware access */
101 	void *card;
102 	bool iface_running;
103 	u8 is_polling; /* host has to poll the card irq */
104 	u8 fw_ready;
105 	u8 surpriseremoved;
106 	u8 setup_fw_on_resume;
107 	u8 power_up_on_resume;
108 	int (*hw_host_to_card) (struct lbs_private *priv, u8 type, u8 *payload, u16 nb);
109 	void (*reset_card) (struct lbs_private *priv);
110 	int (*power_save) (struct lbs_private *priv);
111 	int (*power_restore) (struct lbs_private *priv);
112 	int (*enter_deep_sleep) (struct lbs_private *priv);
113 	int (*exit_deep_sleep) (struct lbs_private *priv);
114 	int (*reset_deep_sleep_wakeup) (struct lbs_private *priv);
115 
116 	/* Adapter info (from EEPROM) */
117 	u32 fwrelease;
118 	u32 fwcapinfo;
119 	u16 regioncode;
120 	u8 current_addr[ETH_ALEN];
121 	u8 copied_hwaddr;
122 
123 	/* Command download */
124 	u8 dnld_sent;
125 	/* bit0 1/0=data_sent/data_tx_done,
126 	   bit1 1/0=cmd_sent/cmd_tx_done,
127 	   all other bits reserved 0 */
128 	u16 seqnum;
129 	struct cmd_ctrl_node *cmd_array;
130 	struct cmd_ctrl_node *cur_cmd;
131 	struct list_head cmdfreeq;    /* free command buffers */
132 	struct list_head cmdpendingq; /* pending command buffers */
133 	struct timer_list command_timer;
134 	int cmd_timed_out;
135 
136 	/* Command responses sent from the hardware to the driver */
137 	u8 resp_idx;
138 	u8 resp_buf[2][LBS_UPLD_SIZE];
139 	u32 resp_len[2];
140 
141 	/* Events sent from hardware to driver */
142 	struct kfifo event_fifo;
143 
144 	/* thread to service interrupts */
145 	struct task_struct *main_thread;
146 	wait_queue_head_t waitq;
147 	struct workqueue_struct *work_thread;
148 
149 	/* Encryption stuff */
150 	u8 authtype_auto;
151 	u8 wep_tx_key;
152 	u8 wep_key[4][WLAN_KEY_LEN_WEP104];
153 	u8 wep_key_len[4];
154 
155 	/* Wake On LAN */
156 	uint32_t wol_criteria;
157 	uint8_t wol_gpio;
158 	uint8_t wol_gap;
159 	bool ehs_remove_supported;
160 
161 	/* Transmitting */
162 	int tx_pending_len;		/* -1 while building packet */
163 	u8 tx_pending_buf[LBS_UPLD_SIZE];
164 	/* protected by hard_start_xmit serialization */
165 	u8 txretrycount;
166 	struct sk_buff *currenttxskb;
167 	struct timer_list tx_lockup_timer;
168 
169 	/* Locks */
170 	struct mutex lock;
171 	spinlock_t driver_lock;
172 
173 	/* NIC/link operation characteristics */
174 	u16 mac_control;
175 	u8 radio_on;
176 	u8 cur_rate;
177 	u8 channel;
178 	s16 txpower_cur;
179 	s16 txpower_min;
180 	s16 txpower_max;
181 
182 	/* Scanning */
183 	struct delayed_work scan_work;
184 	int scan_channel;
185 	/* Queue of things waiting for scan completion */
186 	wait_queue_head_t scan_q;
187 	/* Whether the scan was initiated internally and not by cfg80211 */
188 	bool internal_scan;
189 
190 	/* Firmware load */
191 	u32 fw_model;
192 	wait_queue_head_t fw_waitq;
193 	struct device *fw_device;
194 	const struct firmware *helper_fw;
195 	const struct lbs_fw_table *fw_table;
196 	const struct lbs_fw_table *fw_iter;
197 	lbs_fw_cb fw_callback;
198 };
199 
200 extern struct cmd_confirm_sleep confirm_sleep;
201 
202 /* Check if there is an interface active. */
203 static inline int lbs_iface_active(struct lbs_private *priv)
204 {
205 	int r;
206 
207 	r = netif_running(priv->dev);
208 	if (priv->mesh_dev)
209 		r |= netif_running(priv->mesh_dev);
210 
211 	return r;
212 }
213 
214 #endif
215