1 /******************************************************************************
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.
8 * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
66 #include <linux/types.h>
67 #include <linux/spinlock.h>
70 * DOC: Bus layer - role and goal
72 * iwl-bus.h defines the API to the bus layer of the iwlwifi driver.
73 * The bus layer is responsible for doing very basic bus operations that are
74 * listed in the iwl_bus_ops structure.
75 * The bus layer registers to the bus driver, advertises the supported HW and
76 * gets notifications about enumeration, suspend, resume.
77 * For the moment, the bus layer is not a linux kernel module as itself, and
78 * the module_init function of the driver must call the bus specific
79 * registration functions. These functions are listed at the end of this file.
80 * For the moment, there is only one implementation of this interface: PCI-e.
81 * This implementation is iwl-pci.c
85 * DOC: encapsulation and type safety
87 * The iwl_bus describes the data that is shared amongst all the bus layer
88 * implementations. This data is visible to other layers. Data in the bus
89 * specific area is not visible outside the bus specific implementation.
90 * iwl_bus holds a pointer to iwl_shared which holds pointer to all the other
91 * layers of the driver (iwl_priv, iwl_trans). In fact, this is the way to go
92 * when the transport layer needs to call a function of another layer.
94 * In order to achieve encapsulation, iwl_priv cannot be dereferenced from the
95 * bus layer. Type safety is still kept since functions that gets iwl_priv gets
96 * a typed pointer (as opposed to void *).
102 * The module_init calls the bus specific registration function. The
103 * registration to the bus layer will trigger an enumeration of the bus which
104 * will call the bus specific probe function.
105 * The first thing this function must do is to allocate the memory needed by
106 * iwl_bus + the bus_specific data.
107 * Once the bus specific probe function has configured the hardware, it
108 * chooses the appropriate transport layer and calls iwl_probe that will run
109 * the bus independent probe flow.
111 * Note: The bus specific code must set the following data in iwl_bus before it
122 * struct iwl_bus_ops - bus specific operations
123 * @get_pm_support: must returns true if the bus can go to sleep
124 * @apm_config: will be called during the config of the APM
125 * @get_hw_id_string: prints the hw_id in the provided buffer
126 * @get_hw_id: get hw_id in u32
129 bool (*get_pm_support)(struct iwl_bus *bus);
130 void (*apm_config)(struct iwl_bus *bus);
131 void (*get_hw_id_string)(struct iwl_bus *bus, char buf[], int buf_len);
132 u32 (*get_hw_id)(struct iwl_bus *bus);
136 * struct iwl_bus - bus common data
138 * This data is common to all bus layer implementations.
140 * @ops - pointer to iwl_bus_ops
141 * @shrd - pointer to iwl_shared which holds shared data from the upper layer
142 * NB: for the time being this needs to be set by the upper layer since
143 * it allocates the shared data
146 const struct iwl_bus_ops *ops;
147 struct iwl_shared *shrd;
149 /* pointer to bus specific struct */
150 /*Ensure that this pointer will always be aligned to sizeof pointer */
151 char bus_specific[0] __attribute__((__aligned__(sizeof(void *))));
154 static inline bool bus_get_pm_support(struct iwl_bus *bus)
156 return bus->ops->get_pm_support(bus);
159 static inline void bus_apm_config(struct iwl_bus *bus)
161 bus->ops->apm_config(bus);
164 static inline void bus_get_hw_id_string(struct iwl_bus *bus, char buf[],
167 bus->ops->get_hw_id_string(bus, buf, buf_len);
170 static inline u32 bus_get_hw_id(struct iwl_bus *bus)
172 return bus->ops->get_hw_id(bus);
175 /*****************************************************
176 * Bus layer registration functions
177 ******************************************************/
178 int __must_check iwl_pci_register_driver(void);
179 void iwl_pci_unregister_driver(void);
181 #endif /* __iwl_bus_h__ */