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