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/spinlock.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         /* to prevent deadlocks, never take this lock with card->lock held */
  69         spinlock_t client_list_lock;
  70         struct list_head client_list;
  71         u32 *config_rom;
  72         size_t config_rom_length;
  73         int config_rom_retries;
  74         struct delayed_work work;
  75         struct fw_attribute_group attribute_group;
  76 };
  77
  78 static inline struct fw_device *fw_device(struct device *dev)
  79 {
  80         return container_of(dev, struct fw_device, device);
  81 }
  82
  83 static inline int fw_device_is_shutdown(struct fw_device *device)
  84 {
  85         return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
  86 }
  87
  88 static inline struct fw_device *fw_device_get(struct fw_device *device)
  89 {
  90         get_device(&device->device);
  91
  92         return device;
  93 }
  94
  95 static inline void fw_device_put(struct fw_device *device)
  96 {
  97         put_device(&device->device);
  98 }
  99
 100 struct fw_device *fw_device_get_by_devt(dev_t devt);
 101 int fw_device_enable_phys_dma(struct fw_device *device);
 102
 103 void fw_device_cdev_update(struct fw_device *device);
 104 void fw_device_cdev_remove(struct fw_device *device);
 105
 106 extern struct rw_semaphore fw_device_rwsem;
 107 extern struct idr fw_device_idr;
 108 extern int fw_cdev_major;
 109
 110 /*
 111  * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
 112  */
 113 struct fw_unit {
 114         struct device device;
 115         u32 *directory;
 116         struct fw_attribute_group attribute_group;
 117 };
 118
 119 static inline struct fw_unit *fw_unit(struct device *dev)
 120 {
 121         return container_of(dev, struct fw_unit, device);
 122 }
 123
 124 static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
 125 {
 126         get_device(&unit->device);
 127
 128         return unit;
 129 }
 130
 131 static inline void fw_unit_put(struct fw_unit *unit)
 132 {
 133         put_device(&unit->device);
 134 }
 135
 136 #define CSR_OFFSET      0x40
 137 #define CSR_LEAF        0x80
 138 #define CSR_DIRECTORY   0xc0
 139
 140 #define CSR_DESCRIPTOR          0x01
 141 #define CSR_VENDOR              0x03
 142 #define CSR_HARDWARE_VERSION    0x04
 143 #define CSR_NODE_CAPABILITIES   0x0c
 144 #define CSR_UNIT                0x11
 145 #define CSR_SPECIFIER_ID        0x12
 146 #define CSR_VERSION             0x13
 147 #define CSR_DEPENDENT_INFO      0x14
 148 #define CSR_MODEL               0x17
 149 #define CSR_INSTANCE            0x18
 150 #define CSR_DIRECTORY_ID        0x20
 151
 152 struct fw_csr_iterator {
 153         u32 *p;
 154         u32 *end;
 155 };
 156
 157 void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
 158 int fw_csr_iterator_next(struct fw_csr_iterator *ci,
 159                          int *key, int *value);
 160
 161 #define FW_MATCH_VENDOR         0x0001
 162 #define FW_MATCH_MODEL          0x0002
 163 #define FW_MATCH_SPECIFIER_ID   0x0004
 164 #define FW_MATCH_VERSION        0x0008
 165
 166 struct fw_device_id {
 167         u32 match_flags;
 168         u32 vendor;
 169         u32 model;
 170         u32 specifier_id;
 171         u32 version;
 172         void *driver_data;
 173 };
 174
 175 struct fw_driver {
 176         struct device_driver driver;
 177         /* Called when the parent device sits through a bus reset. */
 178         void (*update) (struct fw_unit *unit);
 179         const struct fw_device_id *id_table;
 180 };
 181
 182 static inline struct fw_driver *
 183 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 */