Commit | Line | Data |
---|---|---|
48d1a211 EG |
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) 2007 - 2011 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 - 2011 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 | *****************************************************************************/ | |
6fbfae8e EG |
63 | #ifndef __iwl_bus_h__ |
64 | #define __iwl_bus_h__ | |
65 | ||
66 | /*This file includes the declaration that are exported from the bus layer */ | |
48d1a211 | 67 | |
a72b8b08 | 68 | #include <linux/types.h> |
83ed9015 | 69 | #include <linux/spinlock.h> |
a72b8b08 | 70 | |
cac988a6 | 71 | struct iwl_shared; |
d5934110 EG |
72 | struct iwl_bus; |
73 | ||
74 | /** | |
75 | * struct iwl_bus_ops - bus specific operations | |
d5934110 EG |
76 | * @get_pm_support: must returns true if the bus can go to sleep |
77 | * @apm_config: will be called during the config of the APM configuration | |
cac988a6 | 78 | * @set_drv_data: set the shared data pointer to the bus layer |
d5934110 EG |
79 | * @get_hw_id: prints the hw_id in the provided buffer |
80 | * @write8: write a byte to register at offset ofs | |
81 | * @write32: write a dword to register at offset ofs | |
82 | * @wread32: read a dword at register at offset ofs | |
83 | */ | |
84 | struct iwl_bus_ops { | |
85 | bool (*get_pm_support)(struct iwl_bus *bus); | |
86 | void (*apm_config)(struct iwl_bus *bus); | |
cac988a6 | 87 | void (*set_drv_data)(struct iwl_bus *bus, struct iwl_shared *shrd); |
d5934110 EG |
88 | void (*get_hw_id)(struct iwl_bus *bus, char buf[], int buf_len); |
89 | void (*write8)(struct iwl_bus *bus, u32 ofs, u8 val); | |
90 | void (*write32)(struct iwl_bus *bus, u32 ofs, u32 val); | |
91 | u32 (*read32)(struct iwl_bus *bus, u32 ofs); | |
92 | }; | |
93 | ||
6fbfae8e EG |
94 | /** |
95 | * struct iwl_bus - bus common data | |
96 | * @dev - pointer to struct device * that represent the device | |
97 | * @ops - pointer to iwl_bus_ops | |
98 | * @shrd - pointer to iwl_shared which holds shared data from the upper layer | |
99 | * @irq - the irq number for the device | |
83ed9015 | 100 | * @reg_lock - protect hw register access |
6fbfae8e | 101 | */ |
d5934110 EG |
102 | struct iwl_bus { |
103 | /* Common data to all buses */ | |
d5934110 | 104 | struct device *dev; |
e6bb4c9c | 105 | const struct iwl_bus_ops *ops; |
cac988a6 | 106 | struct iwl_shared *shrd; |
d5934110 EG |
107 | |
108 | unsigned int irq; | |
83ed9015 | 109 | spinlock_t reg_lock; |
d5934110 EG |
110 | |
111 | /* pointer to bus specific struct */ | |
112 | /*Ensure that this pointer will always be aligned to sizeof pointer */ | |
113 | char bus_specific[0] __attribute__((__aligned__(sizeof(void *)))); | |
114 | }; | |
115 | ||
116 | static inline bool bus_get_pm_support(struct iwl_bus *bus) | |
117 | { | |
118 | return bus->ops->get_pm_support(bus); | |
119 | } | |
120 | ||
121 | static inline void bus_apm_config(struct iwl_bus *bus) | |
122 | { | |
123 | bus->ops->apm_config(bus); | |
124 | } | |
125 | ||
cac988a6 EG |
126 | static inline void bus_set_drv_data(struct iwl_bus *bus, |
127 | struct iwl_shared *shrd) | |
d5934110 | 128 | { |
cac988a6 | 129 | bus->ops->set_drv_data(bus, shrd); |
d5934110 EG |
130 | } |
131 | ||
132 | static inline void bus_get_hw_id(struct iwl_bus *bus, char buf[], int buf_len) | |
133 | { | |
134 | bus->ops->get_hw_id(bus, buf, buf_len); | |
135 | } | |
136 | ||
137 | static inline void bus_write8(struct iwl_bus *bus, u32 ofs, u8 val) | |
138 | { | |
139 | bus->ops->write8(bus, ofs, val); | |
140 | } | |
141 | ||
142 | static inline void bus_write32(struct iwl_bus *bus, u32 ofs, u32 val) | |
143 | { | |
144 | bus->ops->write32(bus, ofs, val); | |
145 | } | |
146 | ||
147 | static inline u32 bus_read32(struct iwl_bus *bus, u32 ofs) | |
148 | { | |
149 | return bus->ops->read32(bus, ofs); | |
150 | } | |
151 | ||
48d1a211 EG |
152 | int __must_check iwl_pci_register_driver(void); |
153 | void iwl_pci_unregister_driver(void); | |
154 | ||
6fbfae8e | 155 | #endif /* __iwl_bus_h__ */ |