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