linux/include/linux/uwb/umc.h
<<
>>
Prefs 
   1/*
   2 * UWB Multi-interface Controller support.
   3 *
   4 * Copyright (C) 2007 Cambridge Silicon Radio Ltd.
   5 *
   6 * This file is released under the GPLv2
   7 *
   8 * UMC (UWB Multi-interface Controller) capabilities (e.g., radio
   9 * controller, host controller) are presented as devices on the "umc"
  10 * bus.
  11 *
  12 * The radio controller is not strictly a UMC capability but it's
  13 * useful to present it as such.
  14 *
  15 * References:
  16 *
  17 *   [WHCI] Wireless Host Controller Interface Specification for
  18 *          Certified Wireless Universal Serial Bus, revision 0.95.
  19 *
  20 * How this works is kind of convoluted but simple. The whci.ko driver
  21 * loads when WHCI devices are detected. These WHCI devices expose
  22 * many devices in the same PCI function (they couldn't have reused
  23 * functions, no), so for each PCI function that exposes these many
  24 * devices, whci ceates a umc_dev [whci_probe() -> whci_add_cap()]
  25 * with umc_device_create() and adds it to the bus with
  26 * umc_device_register().
  27 *
  28 * umc_device_register() calls device_register() which will push the
  29 * bus management code to load your UMC driver's somehting_probe()
  30 * that you have registered for that capability code.
  31 *
  32 * Now when the WHCI device is removed, whci_remove() will go over
  33 * each umc_dev assigned to each of the PCI function's capabilities
  34 * and through whci_del_cap() call umc_device_unregister() each
  35 * created umc_dev. Of course, if you are bound to the device, your
  36 * driver's something_remove() will be called.
  37 */
  38
  39#ifndef _LINUX_UWB_UMC_H_
  40#define _LINUX_UWB_UMC_H_
  41
  42#include <linux/device.h>
  43#include <linux/pci.h>
  44
  45/*
  46 * UMC capability IDs.
  47 *
  48 * 0x00 is reserved so use it for the radio controller device.
  49 *
  50 * [WHCI] table 2-8
  51 */
  52#define UMC_CAP_ID_WHCI_RC      0x00 /* radio controller */
  53#define UMC_CAP_ID_WHCI_WUSB_HC 0x01 /* WUSB host controller */
  54
  55/**
  56 * struct umc_dev - UMC capability device
  57 *
  58 * @version:  version of the specification this capability conforms to.
  59 * @cap_id:   capability ID.
  60 * @bar:      PCI Bar (64 bit) where the resource lies
  61 * @resource: register space resource.
  62 * @irq:      interrupt line.
  63 */
  64struct umc_dev {
  65        u16             version;
  66        u8              cap_id;
  67        u8              bar;
  68        struct resource resource;
  69        unsigned        irq;
  70        struct device   dev;
  71};
  72
  73#define to_umc_dev(d) container_of(d, struct umc_dev, dev)
  74
  75/**
  76 * struct umc_driver - UMC capability driver
  77 * @cap_id: supported capability ID.
  78 * @match: driver specific capability matching function.
  79 * @match_data: driver specific data for match() (e.g., a
  80 * table of pci_device_id's if umc_match_pci_id() is used).
  81 */
  82struct umc_driver {
  83        char *name;
  84        u8 cap_id;
  85        int (*match)(struct umc_driver *, struct umc_dev *);
  86        const void *match_data;
  87
  88        int  (*probe)(struct umc_dev *);
  89        void (*remove)(struct umc_dev *);
  90        int  (*suspend)(struct umc_dev *, pm_message_t state);
  91        int  (*resume)(struct umc_dev *);
  92        int  (*pre_reset)(struct umc_dev *);
  93        int  (*post_reset)(struct umc_dev *);
  94
  95        struct device_driver driver;
  96};
  97
  98#define to_umc_driver(d) container_of(d, struct umc_driver, driver)
  99
 100extern struct bus_type umc_bus_type;
 101
 102struct umc_dev *umc_device_create(struct device *parent, int n);
 103int __must_check umc_device_register(struct umc_dev *umc);
 104void umc_device_unregister(struct umc_dev *umc);
 105
 106int __must_check __umc_driver_register(struct umc_driver *umc_drv,
 107                                       struct module *mod,
 108                                       const char *mod_name);
 109
 110/**
 111 * umc_driver_register - register a UMC capabiltity driver.
 112 * @umc_drv:  pointer to the driver.
 113 */
 114static inline int __must_check umc_driver_register(struct umc_driver *umc_drv)
 115{
 116        return __umc_driver_register(umc_drv, THIS_MODULE, KBUILD_MODNAME);
 117}
 118void umc_driver_unregister(struct umc_driver *umc_drv);
 119
 120/*
 121 * Utility function you can use to match (umc_driver->match) against a
 122 * null-terminated array of 'struct pci_device_id' in
 123 * umc_driver->match_data.
 124 */
 125int umc_match_pci_id(struct umc_driver *umc_drv, struct umc_dev *umc);
 126
 127/**
 128 * umc_parent_pci_dev - return the UMC's parent PCI device or NULL if none
 129 * @umc_dev: UMC device whose parent PCI device we are looking for
 130 *
 131 * DIRTY!!! DON'T RELY ON THIS
 132 *
 133 * FIXME: This is as dirty as it gets, but we need some way to check
 134 * the correct type of umc_dev->parent (so that for example, we can
 135 * cast to pci_dev). Casting to pci_dev is necesary because at some
 136 * point we need to request resources from the device. Mapping is
 137 * easily over come (ioremap and stuff are bus agnostic), but hooking
 138 * up to some error handlers (such as pci error handlers) might need
 139 * this.
 140 *
 141 * THIS might (probably will) be removed in the future, so don't count
 142 * on it.
 143 */
 144static inline struct pci_dev *umc_parent_pci_dev(struct umc_dev *umc_dev)
 145{
 146        struct pci_dev *pci_dev = NULL;
 147        if (umc_dev->dev.parent->bus == &pci_bus_type)
 148                pci_dev = to_pci_dev(umc_dev->dev.parent);
 149        return pci_dev;
 150}
 151
 152/**
 153 * umc_dev_get() - reference a UMC device.
 154 * @umc_dev: Pointer to UMC device.
 155 *
 156 * NOTE: we are assuming in this whole scheme that the parent device
 157 *       is referenced at _probe() time and unreferenced at _remove()
 158 *       time by the parent's subsystem.
 159 */
 160static inline struct umc_dev *umc_dev_get(struct umc_dev *umc_dev)
 161{
 162        get_device(&umc_dev->dev);
 163        return umc_dev;
 164}
 165
 166/**
 167 * umc_dev_put() - unreference a UMC device.
 168 * @umc_dev: Pointer to UMC device.
 169 */
 170static inline void umc_dev_put(struct umc_dev *umc_dev)
 171{
 172        put_device(&umc_dev->dev);
 173}
 174
 175/**
 176 * umc_set_drvdata - set UMC device's driver data.
 177 * @umc_dev: Pointer to UMC device.
 178 * @data:    Data to set.
 179 */
 180static inline void umc_set_drvdata(struct umc_dev *umc_dev, void *data)
 181{
 182        dev_set_drvdata(&umc_dev->dev, data);
 183}
 184
 185/**
 186 * umc_get_drvdata - recover UMC device's driver data.
 187 * @umc_dev: Pointer to UMC device.
 188 */
 189static inline void *umc_get_drvdata(struct umc_dev *umc_dev)
 190{
 191        return dev_get_drvdata(&umc_dev->dev);
 192}
 193
 194int umc_controller_reset(struct umc_dev *umc);
 195
 196#endif /* #ifndef _LINUX_UWB_UMC_H_ */
 197
Hosted by Missing Link Electronics. The original LXR software by the LXR community, this experimental version by lxr@linux.no.