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 <asm/atomic.h>
  27
  28 enum fw_device_state {
  29         FW_DEVICE_INITIALIZING,
  30         FW_DEVICE_RUNNING,
  31         FW_DEVICE_GONE,
  32         FW_DEVICE_SHUTDOWN,
  33 };
  34
  35 struct fw_attribute_group {
  36         struct attribute_group *groups[2];
  37         struct attribute_group group;
  38         struct attribute *attrs[11];
  39 };
  40
  41 /*
  42  * Note, fw_device.generation always has to be read before fw_device.node_id.
  43  * Use SMP memory barriers to ensure this.  Otherwise requests will be sent
  44  * to an outdated node_id if the generation was updated in the meantime due
  45  * to a bus reset.
  46  *
  47  * Likewise, fw-core will take care to update .node_id before .generation so
  48  * that whenever fw_device.generation is current WRT the actual bus generation,
  49  * fw_device.node_id is guaranteed to be current too.
  50  *
  51  * The same applies to fw_device.card->node_id vs. fw_device.generation.
  52  *
  53  * fw_device.config_rom and fw_device.config_rom_length may be accessed during
  54  * the lifetime of any fw_unit belonging to the fw_device, before device_del()
  55  * was called on the last fw_unit.  Alternatively, they may be accessed while
  56  * holding fw_device_rwsem.
  57  */
  58 struct fw_device {
  59         atomic_t state;
  60         struct fw_node *node;
  61         int node_id;
  62         int generation;
  63         unsigned max_speed;
  64         bool cmc;
  65         struct fw_card *card;
  66         struct device device;
  67         struct list_head client_list;
  68         u32 *config_rom;
  69         size_t config_rom_length;
  70         int config_rom_retries;
  71         struct delayed_work work;
  72         struct fw_attribute_group attribute_group;
  73 };
  74
  75 static inline struct fw_device *fw_device(struct device *dev)
  76 {
  77         return container_of(dev, struct fw_device, device);
  78 }
  79
  80 static inline int fw_device_is_shutdown(struct fw_device *device)
  81 {
  82         return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
  83 }
  84
  85 static inline struct fw_device *fw_device_get(struct fw_device *device)
  86 {
  87         get_device(&device->device);
  88
  89         return device;
  90 }
  91
  92 static inline void fw_device_put(struct fw_device *device)
  93 {
  94         put_device(&device->device);
  95 }
  96
  97 struct fw_device *fw_device_get_by_devt(dev_t devt);
  98 int fw_device_enable_phys_dma(struct fw_device *device);
  99
 100 void fw_device_cdev_update(struct fw_device *device);
 101 void fw_device_cdev_remove(struct fw_device *device);
 102
 103 extern struct rw_semaphore fw_device_rwsem;
 104 extern struct idr fw_device_idr;
 105 extern int fw_cdev_major;
 106
 107 /*
 108  * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
 109  */
 110 struct fw_unit {
 111         struct device device;
 112         u32 *directory;
 113         struct fw_attribute_group attribute_group;
 114 };
 115
 116 static inline struct fw_unit *fw_unit(struct device *dev)
 117 {
 118         return container_of(dev, struct fw_unit, device);
 119 }
 120
 121 static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
 122 {
 123         get_device(&unit->device);
 124
 125         return unit;
 126 }
 127
 128 static inline void fw_unit_put(struct fw_unit *unit)
 129 {
 130         put_device(&unit->device);
 131 }
 132
 133 #define CSR_OFFSET      0x40
 134 #define CSR_LEAF        0x80
 135 #define CSR_DIRECTORY   0xc0
 136
 137 #define CSR_DESCRIPTOR          0x01
 138 #define CSR_VENDOR              0x03
 139 #define CSR_HARDWARE_VERSION    0x04
 140 #define CSR_NODE_CAPABILITIES   0x0c
 141 #define CSR_UNIT                0x11
 142 #define CSR_SPECIFIER_ID        0x12
 143 #define CSR_VERSION             0x13
 144 #define CSR_DEPENDENT_INFO      0x14
 145 #define CSR_MODEL               0x17
 146 #define CSR_INSTANCE            0x18
 147 #define CSR_DIRECTORY_ID        0x20
 148
 149 struct fw_csr_iterator {
 150         u32 *p;
 151         u32 *end;
 152 };
 153
 154 void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
 155 int fw_csr_iterator_next(struct fw_csr_iterator *ci,
 156                          int *key, int *value);
 157
 158 #define FW_MATCH_VENDOR         0x0001
 159 #define FW_MATCH_MODEL          0x0002
 160 #define FW_MATCH_SPECIFIER_ID   0x0004
 161 #define FW_MATCH_VERSION        0x0008
 162
 163 struct fw_device_id {
 164         u32 match_flags;
 165         u32 vendor;
 166         u32 model;
 167         u32 specifier_id;
 168         u32 version;
 169         void *driver_data;
 170 };
 171
 172 struct fw_driver {
 173         struct device_driver driver;
 174         /* Called when the parent device sits through a bus reset. */
 175         void (*update) (struct fw_unit *unit);
 176         const struct fw_device_id *id_table;
 177 };
 178
 179 static inline struct fw_driver *
 180 fw_driver(struct device_driver *drv)
 181 {
 182         return container_of(drv, struct fw_driver, driver);
 183 }
 184
 185 extern const struct file_operations fw_device_ops;
 186
 187 #endif /* __fw_device_h */