1 /* 2 * Copyright (c) 2014 Redpine Signals Inc. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for any 5 * purpose with or without fee is hereby granted, provided that the above 6 * copyright notice and this permission notice appear in all copies. 7 * 8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 */ 16 17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 18 19 #include <linux/module.h> 20 #include <linux/firmware.h> 21 #include <net/rsi_91x.h> 22 #include "rsi_mgmt.h" 23 #include "rsi_common.h" 24 #include "rsi_coex.h" 25 #include "rsi_hal.h" 26 27 u32 rsi_zone_enabled = /* INFO_ZONE | 28 INIT_ZONE | 29 MGMT_TX_ZONE | 30 MGMT_RX_ZONE | 31 DATA_TX_ZONE | 32 DATA_RX_ZONE | 33 FSM_ZONE | 34 ISR_ZONE | */ 35 ERR_ZONE | 36 0; 37 EXPORT_SYMBOL_GPL(rsi_zone_enabled); 38 39 #ifdef CONFIG_RSI_COEX 40 static struct rsi_proto_ops g_proto_ops = { 41 .coex_send_pkt = rsi_coex_send_pkt, 42 .get_host_intf = rsi_get_host_intf, 43 .set_bt_context = rsi_set_bt_context, 44 }; 45 #endif 46 47 /** 48 * rsi_dbg() - This function outputs informational messages. 49 * @zone: Zone of interest for output message. 50 * @fmt: printf-style format for output message. 51 * 52 * Return: none 53 */ 54 void rsi_dbg(u32 zone, const char *fmt, ...) 55 { 56 struct va_format vaf; 57 va_list args; 58 59 va_start(args, fmt); 60 61 vaf.fmt = fmt; 62 vaf.va = &args; 63 64 if (zone & rsi_zone_enabled) 65 pr_info("%pV", &vaf); 66 va_end(args); 67 } 68 EXPORT_SYMBOL_GPL(rsi_dbg); 69 70 static char *opmode_str(int oper_mode) 71 { 72 switch (oper_mode) { 73 case DEV_OPMODE_WIFI_ALONE: 74 return "Wi-Fi alone"; 75 case DEV_OPMODE_BT_ALONE: 76 return "BT EDR alone"; 77 case DEV_OPMODE_BT_LE_ALONE: 78 return "BT LE alone"; 79 case DEV_OPMODE_BT_DUAL: 80 return "BT Dual"; 81 case DEV_OPMODE_STA_BT: 82 return "Wi-Fi STA + BT EDR"; 83 case DEV_OPMODE_STA_BT_LE: 84 return "Wi-Fi STA + BT LE"; 85 case DEV_OPMODE_STA_BT_DUAL: 86 return "Wi-Fi STA + BT DUAL"; 87 case DEV_OPMODE_AP_BT: 88 return "Wi-Fi AP + BT EDR"; 89 case DEV_OPMODE_AP_BT_DUAL: 90 return "Wi-Fi AP + BT DUAL"; 91 } 92 93 return "Unknown"; 94 } 95 96 void rsi_print_version(struct rsi_common *common) 97 { 98 rsi_dbg(ERR_ZONE, "================================================\n"); 99 rsi_dbg(ERR_ZONE, "================ RSI Version Info ==============\n"); 100 rsi_dbg(ERR_ZONE, "================================================\n"); 101 rsi_dbg(ERR_ZONE, "FW Version\t: %d.%d.%d\n", 102 common->lmac_ver.major, common->lmac_ver.minor, 103 common->lmac_ver.release_num); 104 rsi_dbg(ERR_ZONE, "Operating mode\t: %d [%s]", 105 common->oper_mode, opmode_str(common->oper_mode)); 106 rsi_dbg(ERR_ZONE, "Firmware file\t: %s", common->priv->fw_file_name); 107 rsi_dbg(ERR_ZONE, "================================================\n"); 108 } 109 110 /** 111 * rsi_prepare_skb() - This function prepares the skb. 112 * @common: Pointer to the driver private structure. 113 * @buffer: Pointer to the packet data. 114 * @pkt_len: Length of the packet. 115 * @extended_desc: Extended descriptor. 116 * 117 * Return: Successfully skb. 118 */ 119 static struct sk_buff *rsi_prepare_skb(struct rsi_common *common, 120 u8 *buffer, 121 u32 pkt_len, 122 u8 extended_desc) 123 { 124 struct sk_buff *skb = NULL; 125 u8 payload_offset; 126 127 if (WARN(!pkt_len, "%s: Dummy pkt received", __func__)) 128 return NULL; 129 130 if (pkt_len > (RSI_RCV_BUFFER_LEN * 4)) { 131 rsi_dbg(ERR_ZONE, "%s: Pkt size > max rx buf size %d\n", 132 __func__, pkt_len); 133 pkt_len = RSI_RCV_BUFFER_LEN * 4; 134 } 135 136 pkt_len -= extended_desc; 137 skb = dev_alloc_skb(pkt_len + FRAME_DESC_SZ); 138 if (skb == NULL) 139 return NULL; 140 141 payload_offset = (extended_desc + FRAME_DESC_SZ); 142 skb_put(skb, pkt_len); 143 memcpy((skb->data), (buffer + payload_offset), skb->len); 144 145 return skb; 146 } 147 148 /** 149 * rsi_read_pkt() - This function reads frames from the card. 150 * @common: Pointer to the driver private structure. 151 * @rx_pkt: Received pkt. 152 * @rcv_pkt_len: Received pkt length. In case of USB it is 0. 153 * 154 * Return: 0 on success, -1 on failure. 155 */ 156 int rsi_read_pkt(struct rsi_common *common, u8 *rx_pkt, s32 rcv_pkt_len) 157 { 158 u8 *frame_desc = NULL, extended_desc = 0; 159 u32 index, length = 0, queueno = 0; 160 u16 actual_length = 0, offset; 161 struct sk_buff *skb = NULL; 162 #ifdef CONFIG_RSI_COEX 163 u8 bt_pkt_type; 164 #endif 165 166 index = 0; 167 do { 168 frame_desc = &rx_pkt[index]; 169 actual_length = *(u16 *)&frame_desc[0]; 170 offset = *(u16 *)&frame_desc[2]; 171 172 queueno = rsi_get_queueno(frame_desc, offset); 173 length = rsi_get_length(frame_desc, offset); 174 175 /* Extended descriptor is valid for WLAN queues only */ 176 if (queueno == RSI_WIFI_DATA_Q || queueno == RSI_WIFI_MGMT_Q) 177 extended_desc = rsi_get_extended_desc(frame_desc, 178 offset); 179 180 switch (queueno) { 181 case RSI_COEX_Q: 182 #ifdef CONFIG_RSI_COEX 183 if (common->coex_mode > 1) 184 rsi_coex_recv_pkt(common, frame_desc + offset); 185 else 186 #endif 187 rsi_mgmt_pkt_recv(common, 188 (frame_desc + offset)); 189 break; 190 191 case RSI_WIFI_DATA_Q: 192 skb = rsi_prepare_skb(common, 193 (frame_desc + offset), 194 length, 195 extended_desc); 196 if (skb == NULL) 197 goto fail; 198 199 rsi_indicate_pkt_to_os(common, skb); 200 break; 201 202 case RSI_WIFI_MGMT_Q: 203 rsi_mgmt_pkt_recv(common, (frame_desc + offset)); 204 break; 205 206 #ifdef CONFIG_RSI_COEX 207 case RSI_BT_MGMT_Q: 208 case RSI_BT_DATA_Q: 209 #define BT_RX_PKT_TYPE_OFST 14 210 #define BT_CARD_READY_IND 0x89 211 bt_pkt_type = frame_desc[offset + BT_RX_PKT_TYPE_OFST]; 212 if (bt_pkt_type == BT_CARD_READY_IND) { 213 rsi_dbg(INFO_ZONE, "BT Card ready recvd\n"); 214 if (common->fsm_state == FSM_MAC_INIT_DONE) 215 rsi_attach_bt(common); 216 else 217 common->bt_defer_attach = true; 218 } else { 219 if (common->bt_adapter) 220 rsi_bt_ops.recv_pkt(common->bt_adapter, 221 frame_desc + offset); 222 } 223 break; 224 #endif 225 226 default: 227 rsi_dbg(ERR_ZONE, "%s: pkt from invalid queue: %d\n", 228 __func__, queueno); 229 goto fail; 230 } 231 232 index += actual_length; 233 rcv_pkt_len -= actual_length; 234 } while (rcv_pkt_len > 0); 235 236 return 0; 237 fail: 238 return -EINVAL; 239 } 240 EXPORT_SYMBOL_GPL(rsi_read_pkt); 241 242 /** 243 * rsi_tx_scheduler_thread() - This function is a kernel thread to send the 244 * packets to the device. 245 * @common: Pointer to the driver private structure. 246 * 247 * Return: None. 248 */ 249 static void rsi_tx_scheduler_thread(struct rsi_common *common) 250 { 251 struct rsi_hw *adapter = common->priv; 252 u32 timeout = EVENT_WAIT_FOREVER; 253 254 do { 255 if (adapter->determine_event_timeout) 256 timeout = adapter->determine_event_timeout(adapter); 257 rsi_wait_event(&common->tx_thread.event, timeout); 258 rsi_reset_event(&common->tx_thread.event); 259 260 if (common->init_done) 261 rsi_core_qos_processor(common); 262 } while (atomic_read(&common->tx_thread.thread_done) == 0); 263 kthread_complete_and_exit(&common->tx_thread.completion, 0); 264 } 265 266 #ifdef CONFIG_RSI_COEX 267 enum rsi_host_intf rsi_get_host_intf(void *priv) 268 { 269 struct rsi_common *common = (struct rsi_common *)priv; 270 271 return common->priv->rsi_host_intf; 272 } 273 274 void rsi_set_bt_context(void *priv, void *bt_context) 275 { 276 struct rsi_common *common = (struct rsi_common *)priv; 277 278 common->bt_adapter = bt_context; 279 } 280 #endif 281 282 void rsi_attach_bt(struct rsi_common *common) 283 { 284 #ifdef CONFIG_RSI_COEX 285 if (rsi_bt_ops.attach(common, &g_proto_ops)) 286 rsi_dbg(ERR_ZONE, 287 "Failed to attach BT module\n"); 288 #endif 289 } 290 291 /** 292 * rsi_91x_init() - This function initializes os interface operations. 293 * @oper_mode: One of DEV_OPMODE_*. 294 * 295 * Return: Pointer to the adapter structure on success, NULL on failure . 296 */ 297 struct rsi_hw *rsi_91x_init(u16 oper_mode) 298 { 299 struct rsi_hw *adapter = NULL; 300 struct rsi_common *common = NULL; 301 u8 ii = 0; 302 303 adapter = kzalloc(sizeof(*adapter), GFP_KERNEL); 304 if (!adapter) 305 return NULL; 306 307 adapter->priv = kzalloc(sizeof(*common), GFP_KERNEL); 308 if (adapter->priv == NULL) { 309 rsi_dbg(ERR_ZONE, "%s: Failed in allocation of memory\n", 310 __func__); 311 kfree(adapter); 312 return NULL; 313 } else { 314 common = adapter->priv; 315 common->priv = adapter; 316 } 317 318 for (ii = 0; ii < NUM_SOFT_QUEUES; ii++) 319 skb_queue_head_init(&common->tx_queue[ii]); 320 321 rsi_init_event(&common->tx_thread.event); 322 mutex_init(&common->mutex); 323 mutex_init(&common->tx_lock); 324 mutex_init(&common->rx_lock); 325 mutex_init(&common->tx_bus_mutex); 326 327 if (rsi_create_kthread(common, 328 &common->tx_thread, 329 rsi_tx_scheduler_thread, 330 "Tx-Thread")) { 331 rsi_dbg(ERR_ZONE, "%s: Unable to init tx thrd\n", __func__); 332 goto err; 333 } 334 335 rsi_default_ps_params(adapter); 336 init_bgscan_params(common); 337 spin_lock_init(&adapter->ps_lock); 338 timer_setup(&common->roc_timer, rsi_roc_timeout, 0); 339 init_completion(&common->wlan_init_completion); 340 adapter->device_model = RSI_DEV_9113; 341 common->oper_mode = oper_mode; 342 343 /* Determine coex mode */ 344 switch (common->oper_mode) { 345 case DEV_OPMODE_STA_BT_DUAL: 346 case DEV_OPMODE_STA_BT: 347 case DEV_OPMODE_STA_BT_LE: 348 case DEV_OPMODE_BT_ALONE: 349 case DEV_OPMODE_BT_LE_ALONE: 350 case DEV_OPMODE_BT_DUAL: 351 common->coex_mode = 2; 352 break; 353 case DEV_OPMODE_AP_BT_DUAL: 354 case DEV_OPMODE_AP_BT: 355 common->coex_mode = 4; 356 break; 357 case DEV_OPMODE_WIFI_ALONE: 358 common->coex_mode = 1; 359 break; 360 default: 361 common->oper_mode = 1; 362 common->coex_mode = 1; 363 } 364 rsi_dbg(INFO_ZONE, "%s: oper_mode = %d, coex_mode = %d\n", 365 __func__, common->oper_mode, common->coex_mode); 366 367 adapter->device_model = RSI_DEV_9113; 368 #ifdef CONFIG_RSI_COEX 369 if (common->coex_mode > 1) { 370 if (rsi_coex_attach(common)) { 371 rsi_dbg(ERR_ZONE, "Failed to init coex module\n"); 372 rsi_kill_thread(&common->tx_thread); 373 goto err; 374 } 375 } 376 #endif 377 378 common->init_done = true; 379 return adapter; 380 381 err: 382 kfree(common); 383 kfree(adapter); 384 return NULL; 385 } 386 EXPORT_SYMBOL_GPL(rsi_91x_init); 387 388 /** 389 * rsi_91x_deinit() - This function de-intializes os intf operations. 390 * @adapter: Pointer to the adapter structure. 391 * 392 * Return: None. 393 */ 394 void rsi_91x_deinit(struct rsi_hw *adapter) 395 { 396 struct rsi_common *common = adapter->priv; 397 u8 ii; 398 399 rsi_dbg(INFO_ZONE, "%s: Performing deinit os ops\n", __func__); 400 401 rsi_kill_thread(&common->tx_thread); 402 403 for (ii = 0; ii < NUM_SOFT_QUEUES; ii++) 404 skb_queue_purge(&common->tx_queue[ii]); 405 406 #ifdef CONFIG_RSI_COEX 407 if (common->coex_mode > 1) { 408 if (common->bt_adapter) { 409 rsi_bt_ops.detach(common->bt_adapter); 410 common->bt_adapter = NULL; 411 } 412 rsi_coex_detach(common); 413 } 414 #endif 415 416 common->init_done = false; 417 418 kfree(common); 419 kfree(adapter->rsi_dev); 420 kfree(adapter); 421 } 422 EXPORT_SYMBOL_GPL(rsi_91x_deinit); 423 424 /** 425 * rsi_91x_hal_module_init() - This function is invoked when the module is 426 * loaded into the kernel. 427 * It registers the client driver. 428 * @void: Void. 429 * 430 * Return: 0 on success, -1 on failure. 431 */ 432 static int rsi_91x_hal_module_init(void) 433 { 434 rsi_dbg(INIT_ZONE, "%s: Module init called\n", __func__); 435 return 0; 436 } 437 438 /** 439 * rsi_91x_hal_module_exit() - This function is called at the time of 440 * removing/unloading the module. 441 * It unregisters the client driver. 442 * @void: Void. 443 * 444 * Return: None. 445 */ 446 static void rsi_91x_hal_module_exit(void) 447 { 448 rsi_dbg(INIT_ZONE, "%s: Module exit called\n", __func__); 449 } 450 451 module_init(rsi_91x_hal_module_init); 452 module_exit(rsi_91x_hal_module_exit); 453 MODULE_AUTHOR("Redpine Signals Inc"); 454 MODULE_DESCRIPTION("Station driver for RSI 91x devices"); 455 MODULE_VERSION("0.1"); 456 MODULE_LICENSE("Dual BSD/GPL"); 457