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 - 2012 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 LICENSE.GPL.
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 - 2012 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
66#include "iwl-shared.h"
67
68/**
69 * DOC: Driver system flows - drv component
70 *
71 * This component implements the system flows such as bus enumeration, bus
72 * removal. Bus dependent parts of system flows (such as iwl_pci_probe) are in
73 * bus specific files (transport files). This is the code that is common among
74 * different buses.
75 *
76 * This component is also in charge of managing the several implementations of
77 * the wifi flows: it will allow to have several fw API implementation. These
78 * different implementations will differ in the way they implement mac80211's
79 * handlers too.
80
81 * The init flow wrt to the drv component looks like this:
82 * 1) The bus specific component is called from module_init
83 * 2) The bus specific component registers the bus driver
84 * 3) The bus driver calls the probe function
85 * 4) The bus specific component configures the bus
86 * 5) The bus specific component calls to the drv bus agnostic part
87 *    (iwl_drv_start)
88 * 6) iwl_drv_start fetches the fw ASYNC, iwl_ucode_callback
89 * 7) iwl_ucode_callback parses the fw file
90 * 8) iwl_ucode_callback starts the wifi implementation to matches the fw
91 */
92
93/**
94 * iwl_drv_start - start the drv
95 *
96 * @shrd: the shrd area
97 * @trans_ops: the ops of the transport
98 * @cfg: device specific constants / virtual functions
99 *
100 * TODO: review the parameters given to this function
101 *
102 * starts the driver: fetches the firmware. This should be called by bus
103 * specific system flows implementations. For example, the bus specific probe
104 * function should do bus related operations only, and then call to this
105 * function.
106 */
107int iwl_drv_start(struct iwl_shared *shrd,
108		  struct iwl_trans *trans, const struct iwl_cfg *cfg);
109
110/**
111 * iwl_drv_stop - stop the drv
112 *
113 * @shrd: the shrd area
114 *
115 * TODO: review the parameters given to this function
116 *
117 * Stop the driver. This should be called by bus specific system flows
118 * implementations. For example, the bus specific remove function should first
119 * call this function and then do the bus related operations only.
120 */
121void iwl_drv_stop(struct iwl_shared *shrd);
122
123#endif /* __iwl_drv_h__ */
124