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