Pileus Git - ~andy/linux/blob - drivers/firewire/fw-device.h

   1 /*
   2  * Copyright (C) 2005-2006  Kristian Hoegsberg <krh@bitplanet.net>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 #ifndef __fw_device_h
  20 #define __fw_device_h
  21
  22 #include <linux/fs.h>
  23 #include <linux/cdev.h>
  24 #include <linux/idr.h>
  25 #include <linux/rwsem.h>
  26 #include <linux/mutex.h>
  27 #include <asm/atomic.h>
  28
  29 enum fw_device_state {
  30         FW_DEVICE_INITIALIZING,
  31         FW_DEVICE_RUNNING,
  32         FW_DEVICE_GONE,
  33         FW_DEVICE_SHUTDOWN,
  34 };
  35
  36 struct fw_attribute_group {
  37         struct attribute_group *groups[2];
  38         struct attribute_group group;
  39         struct attribute *attrs[11];
  40 };
  41
  42 /*
  43  * Note, fw_device.generation always has to be read before fw_device.node_id.
  44  * Use SMP memory barriers to ensure this.  Otherwise requests will be sent
  45  * to an outdated node_id if the generation was updated in the meantime due
  46  * to a bus reset.
  47  *
  48  * Likewise, fw-core will take care to update .node_id before .generation so
  49  * that whenever fw_device.generation is current WRT the actual bus generation,
  50  * fw_device.node_id is guaranteed to be current too.
  51  *
  52  * The same applies to fw_device.card->node_id vs. fw_device.generation.
  53  *
  54  * fw_device.config_rom and fw_device.config_rom_length may be accessed during
  55  * the lifetime of any fw_unit belonging to the fw_device, before device_del()
  56  * was called on the last fw_unit.  Alternatively, they may be accessed while
  57  * holding fw_device_rwsem.
  58  */
  59 struct fw_device {
  60         atomic_t state;
  61         struct fw_node *node;
  62         int node_id;
  63         int generation;
  64         unsigned max_speed;
  65         bool cmc;
  66         struct fw_card *card;
  67         struct device device;
  68
  69         struct mutex client_list_mutex;
  70         struct list_head client_list;
  71
  72         u32 *config_rom;
  73         size_t config_rom_length;
  74         int config_rom_retries;
  75         struct delayed_work work;
  76         struct fw_attribute_group attribute_group;
  77 };
  78
  79 static inline struct fw_device *fw_device(struct device *dev)
  80 {
  81         return container_of(dev, struct fw_device, device);
  82 }
  83
  84 static inline int fw_device_is_shutdown(struct fw_device *device)
  85 {
  86         return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
  87 }
  88
  89 static inline struct fw_device *fw_device_get(struct fw_device *device)
  90 {
  91         get_device(&device->device);
  92
  93         return device;
  94 }
  95
  96 static inline void fw_device_put(struct fw_device *device)
  97 {
  98         put_device(&device->device);
  99 }
 100
 101 struct fw_device *fw_device_get_by_devt(dev_t devt);
 102 int fw_device_enable_phys_dma(struct fw_device *device);
 103
 104 void fw_device_cdev_update(struct fw_device *device);
 105 void fw_device_cdev_remove(struct fw_device *device);
 106
 107 extern struct rw_semaphore fw_device_rwsem;
 108 extern struct idr fw_device_idr;
 109 extern int fw_cdev_major;
 110
 111 /*
 112  * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
 113  */
 114 struct fw_unit {
 115         struct device device;
 116         u32 *directory;
 117         struct fw_attribute_group attribute_group;
 118 };
 119
 120 static inline struct fw_unit *fw_unit(struct device *dev)
 121 {
 122         return container_of(dev, struct fw_unit, device);
 123 }
 124
 125 static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
 126 {
 127         get_device(&unit->device);
 128
 129         return unit;
 130 }
 131
 132 static inline void fw_unit_put(struct fw_unit *unit)
 133 {
 134         put_device(&unit->device);
 135 }
 136
 137 #define CSR_OFFSET      0x40
 138 #define CSR_LEAF        0x80
 139 #define CSR_DIRECTORY   0xc0
 140
 141 #define CSR_DESCRIPTOR          0x01
 142 #define CSR_VENDOR              0x03
 143 #define CSR_HARDWARE_VERSION    0x04
 144 #define CSR_NODE_CAPABILITIES   0x0c
 145 #define CSR_UNIT                0x11
 146 #define CSR_SPECIFIER_ID        0x12
 147 #define CSR_VERSION             0x13
 148 #define CSR_DEPENDENT_INFO      0x14
 149 #define CSR_MODEL               0x17
 150 #define CSR_INSTANCE            0x18
 151 #define CSR_DIRECTORY_ID        0x20
 152
 153 struct fw_csr_iterator {
 154         u32 *p;
 155         u32 *end;
 156 };
 157
 158 void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
 159 int fw_csr_iterator_next(struct fw_csr_iterator *ci,
 160                          int *key, int *value);
 161
 162 #define FW_MATCH_VENDOR         0x0001
 163 #define FW_MATCH_MODEL          0x0002
 164 #define FW_MATCH_SPECIFIER_ID   0x0004
 165 #define FW_MATCH_VERSION        0x0008
 166
 167 struct fw_device_id {
 168         u32 match_flags;
 169         u32 vendor;
 170         u32 model;
 171         u32 specifier_id;
 172         u32 version;
 173         void *driver_data;
 174 };
 175
 176 struct fw_driver {
 177         struct device_driver driver;
 178         /* Called when the parent device sits through a bus reset. */
 179         void (*update) (struct fw_unit *unit);
 180         const struct fw_device_id *id_table;
 181 };
 182
 183 static inline struct fw_driver *fw_driver(struct device_driver *drv)
 184 {
 185         return container_of(drv, struct fw_driver, driver);
 186 }
 187
 188 extern const struct file_operations fw_device_ops;
 189
 190 #endif /* __fw_device_h */