drivers/net/wireless/iwlwifi/iwl-bus.h

   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  *****************************************************************************/
  63 #ifndef __iwl_bus_h__
  64 #define __iwl_bus_h__
  65
  66 #include <linux/types.h>
  67 #include <linux/spinlock.h>
  68
  69 /**
  70  * DOC: Bus layer - role and goal
  71  *
  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
  82  */
  83
  84 /**
  85  * DOC: encapsulation and type safety
  86  *
  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.
  93  *
  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 *).
  97  */
  98
  99 /**
 100  * DOC: probe flow
 101  *
 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.
 110  *
 111  * Note: The bus specific code must set the following data in iwl_bus before it
 112  *       calls iwl_probe:
 113  *      * bus->dev
 114  *      * bus->irq
 115  *      * bus->ops
 116  */
 117
 118 struct iwl_shared;
 119 struct iwl_bus;
 120
 121 /**
 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
 127  * @write8: write a byte to register at offset ofs
 128  * @write32: write a dword to register at offset ofs
 129  * @wread32: read a dword at register at offset ofs
 130  */
 131 struct iwl_bus_ops {
 132         bool (*get_pm_support)(struct iwl_bus *bus);
 133         void (*apm_config)(struct iwl_bus *bus);
 134         void (*get_hw_id_string)(struct iwl_bus *bus, char buf[], int buf_len);
 135         u32 (*get_hw_id)(struct iwl_bus *bus);
 136         void (*write8)(struct iwl_bus *bus, u32 ofs, u8 val);
 137         void (*write32)(struct iwl_bus *bus, u32 ofs, u32 val);
 138         u32 (*read32)(struct iwl_bus *bus, u32 ofs);
 139 };
 140
 141 /**
 142  * struct iwl_bus - bus common data
 143  *
 144  * This data is common to all bus layer implementations.
 145  *
 146  * @dev - pointer to struct device * that represents the device
 147  * @ops - pointer to iwl_bus_ops
 148  * @shrd - pointer to iwl_shared which holds shared data from the upper layer
 149  *      NB: for the time being this needs to be set by the upper layer since
 150  *      it allocates the shared data
 151  * @irq - the irq number for the device
 152  * @reg_lock - protect hw register access
 153  */
 154 struct iwl_bus {
 155         struct device *dev;
 156         const struct iwl_bus_ops *ops;
 157         struct iwl_shared *shrd;
 158
 159         unsigned int irq;
 160         spinlock_t reg_lock;
 161
 162         /* pointer to bus specific struct */
 163         /*Ensure that this pointer will always be aligned to sizeof pointer */
 164         char bus_specific[0] __attribute__((__aligned__(sizeof(void *))));
 165 };
 166
 167 static inline bool bus_get_pm_support(struct iwl_bus *bus)
 168 {
 169         return bus->ops->get_pm_support(bus);
 170 }
 171
 172 static inline void bus_apm_config(struct iwl_bus *bus)
 173 {
 174         bus->ops->apm_config(bus);
 175 }
 176
 177 static inline void bus_get_hw_id_string(struct iwl_bus *bus, char buf[],
 178                 int buf_len)
 179 {
 180         bus->ops->get_hw_id_string(bus, buf, buf_len);
 181 }
 182
 183 static inline u32 bus_get_hw_id(struct iwl_bus *bus)
 184 {
 185         return bus->ops->get_hw_id(bus);
 186 }
 187
 188 static inline void bus_write8(struct iwl_bus *bus, u32 ofs, u8 val)
 189 {
 190         bus->ops->write8(bus, ofs, val);
 191 }
 192
 193 static inline void bus_write32(struct iwl_bus *bus, u32 ofs, u32 val)
 194 {
 195         bus->ops->write32(bus, ofs, val);
 196 }
 197
 198 static inline u32 bus_read32(struct iwl_bus *bus, u32 ofs)
 199 {
 200         return bus->ops->read32(bus, ofs);
 201 }
 202
 203 /*****************************************************
 204 * Bus layer registration functions
 205 ******************************************************/
 206 int __must_check iwl_pci_register_driver(void);
 207 void iwl_pci_unregister_driver(void);
 208
 209 #endif /* __iwl_bus_h__ */