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