1 /****************************************************************************** 2 * 3 * This file is provided under a dual BSD/GPLv2 license. When using or 4 * redistributing this file, you may do so under either license. 5 * 6 * GPL LICENSE SUMMARY 7 * 8 * Copyright(c) 2008 - 2014 Intel Corporation. All rights reserved. 9 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * The full GNU General Public License is included in this distribution 21 * in the file called COPYING. 22 * 23 * Contact Information: 24 * Intel Linux Wireless <linuxwifi@intel.com> 25 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 26 * 27 * BSD LICENSE 28 * 29 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved. 30 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH 31 * All rights reserved. 32 * 33 * Redistribution and use in source and binary forms, with or without 34 * modification, are permitted provided that the following conditions 35 * are met: 36 * 37 * * Redistributions of source code must retain the above copyright 38 * notice, this list of conditions and the following disclaimer. 39 * * Redistributions in binary form must reproduce the above copyright 40 * notice, this list of conditions and the following disclaimer in 41 * the documentation and/or other materials provided with the 42 * distribution. 43 * * Neither the name Intel Corporation nor the names of its 44 * contributors may be used to endorse or promote products derived 45 * from this software without specific prior written permission. 46 * 47 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 48 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 49 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 50 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 51 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 52 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 53 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 54 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 55 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 56 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 57 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 58 *****************************************************************************/ 59 60 #ifndef __iwl_drv_h__ 61 #define __iwl_drv_h__ 62 #include <linux/export.h> 63 64 /* for all modules */ 65 #define DRV_NAME "iwlwifi" 66 #define DRV_COPYRIGHT "Copyright(c) 2003- 2015 Intel Corporation" 67 #define DRV_AUTHOR "<linuxwifi@intel.com>" 68 69 /* radio config bits (actual values from NVM definition) */ 70 #define NVM_RF_CFG_DASH_MSK(x) (x & 0x3) /* bits 0-1 */ 71 #define NVM_RF_CFG_STEP_MSK(x) ((x >> 2) & 0x3) /* bits 2-3 */ 72 #define NVM_RF_CFG_TYPE_MSK(x) ((x >> 4) & 0x3) /* bits 4-5 */ 73 #define NVM_RF_CFG_PNUM_MSK(x) ((x >> 6) & 0x3) /* bits 6-7 */ 74 #define NVM_RF_CFG_TX_ANT_MSK(x) ((x >> 8) & 0xF) /* bits 8-11 */ 75 #define NVM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF) /* bits 12-15 */ 76 77 #define EXT_NVM_RF_CFG_FLAVOR_MSK(x) ((x) & 0xF) 78 #define EXT_NVM_RF_CFG_DASH_MSK(x) (((x) >> 4) & 0xF) 79 #define EXT_NVM_RF_CFG_STEP_MSK(x) (((x) >> 8) & 0xF) 80 #define EXT_NVM_RF_CFG_TYPE_MSK(x) (((x) >> 12) & 0xFFF) 81 #define EXT_NVM_RF_CFG_TX_ANT_MSK(x) (((x) >> 24) & 0xF) 82 #define EXT_NVM_RF_CFG_RX_ANT_MSK(x) (((x) >> 28) & 0xF) 83 84 /** 85 * DOC: Driver system flows - drv component 86 * 87 * This component implements the system flows such as bus enumeration, bus 88 * removal. Bus dependent parts of system flows (such as iwl_pci_probe) are in 89 * bus specific files (transport files). This is the code that is common among 90 * different buses. 91 * 92 * This component is also in charge of managing the several implementations of 93 * the wifi flows: it will allow to have several fw API implementation. These 94 * different implementations will differ in the way they implement mac80211's 95 * handlers too. 96 97 * The init flow wrt to the drv component looks like this: 98 * 1) The bus specific component is called from module_init 99 * 2) The bus specific component registers the bus driver 100 * 3) The bus driver calls the probe function 101 * 4) The bus specific component configures the bus 102 * 5) The bus specific component calls to the drv bus agnostic part 103 * (iwl_drv_start) 104 * 6) iwl_drv_start fetches the fw ASYNC, iwl_req_fw_callback 105 * 7) iwl_req_fw_callback parses the fw file 106 * 8) iwl_req_fw_callback starts the wifi implementation to matches the fw 107 */ 108 109 struct iwl_drv; 110 struct iwl_trans; 111 struct iwl_cfg; 112 /** 113 * iwl_drv_start - start the drv 114 * 115 * @trans_ops: the ops of the transport 116 * 117 * starts the driver: fetches the firmware. This should be called by bus 118 * specific system flows implementations. For example, the bus specific probe 119 * function should do bus related operations only, and then call to this 120 * function. It returns the driver object or %NULL if an error occurred. 121 */ 122 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans); 123 124 /** 125 * iwl_drv_stop - stop the drv 126 * 127 * @drv: 128 * 129 * Stop the driver. This should be called by bus specific system flows 130 * implementations. For example, the bus specific remove function should first 131 * call this function and then do the bus related operations only. 132 */ 133 void iwl_drv_stop(struct iwl_drv *drv); 134 135 /* 136 * exported symbol management 137 * 138 * The driver can be split into multiple modules, in which case some symbols 139 * must be exported for the sub-modules. However, if it's not split and 140 * everything is built-in, then we can avoid that. 141 */ 142 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR 143 #define IWL_EXPORT_SYMBOL(sym) EXPORT_SYMBOL_GPL(sym) 144 #else 145 #define IWL_EXPORT_SYMBOL(sym) 146 #endif 147 148 #endif /* __iwl_drv_h__ */