drivers/firewire/fw-device.h

   1 /*                                              -*- c-basic-offset: 8 -*-
   2  *
   3  * fw-device.h - Device probing and sysfs code.
   4  *
   5  * Copyright (C) 2005-2006  Kristian Hoegsberg <krh@bitplanet.net>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software Foundation,
  19  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __fw_device_h
  23 #define __fw_device_h
  24
  25 #include <linux/fs.h>
  26 #include <linux/cdev.h>
  27 #include <asm/atomic.h>
  28
  29 enum fw_device_state {
  30         FW_DEVICE_INITIALIZING,
  31         FW_DEVICE_RUNNING,
  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 struct fw_device {
  42         atomic_t state;
  43         struct fw_node *node;
  44         int node_id;
  45         int generation;
  46         struct fw_card *card;
  47         struct device device;
  48         struct list_head link;
  49         struct list_head client_list;
  50         u32 *config_rom;
  51         size_t config_rom_length;
  52         int config_rom_retries;
  53         struct delayed_work work;
  54         struct fw_attribute_group attribute_group;
  55 };
  56
  57 static inline struct fw_device *
  58 fw_device(struct device *dev)
  59 {
  60         return container_of(dev, struct fw_device, device);
  61 }
  62
  63 static inline int
  64 fw_device_is_shutdown(struct fw_device *device)
  65 {
  66         return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
  67 }
  68
  69 struct fw_device *fw_device_get(struct fw_device *device);
  70 void fw_device_put(struct fw_device *device);
  71 int fw_device_enable_phys_dma(struct fw_device *device);
  72
  73 void fw_device_cdev_update(struct fw_device *device);
  74 void fw_device_cdev_remove(struct fw_device *device);
  75
  76 struct fw_device *fw_device_from_devt(dev_t devt);
  77 extern int fw_cdev_major;
  78
  79 struct fw_unit {
  80         struct device device;
  81         u32 *directory;
  82         struct fw_attribute_group attribute_group;
  83 };
  84
  85 static inline struct fw_unit *
  86 fw_unit(struct device *dev)
  87 {
  88         return container_of(dev, struct fw_unit, device);
  89 }
  90
  91 #define CSR_OFFSET      0x40
  92 #define CSR_LEAF        0x80
  93 #define CSR_DIRECTORY   0xc0
  94
  95 #define CSR_DESCRIPTOR          0x01
  96 #define CSR_VENDOR              0x03
  97 #define CSR_HARDWARE_VERSION    0x04
  98 #define CSR_NODE_CAPABILITIES   0x0c
  99 #define CSR_UNIT                0x11
 100 #define CSR_SPECIFIER_ID        0x12
 101 #define CSR_VERSION             0x13
 102 #define CSR_DEPENDENT_INFO      0x14
 103 #define CSR_MODEL               0x17
 104 #define CSR_INSTANCE            0x18
 105
 106 #define SBP2_COMMAND_SET_SPECIFIER      0x38
 107 #define SBP2_COMMAND_SET                0x39
 108 #define SBP2_COMMAND_SET_REVISION       0x3b
 109 #define SBP2_FIRMWARE_REVISION          0x3c
 110
 111 struct fw_csr_iterator {
 112         u32 *p;
 113         u32 *end;
 114 };
 115
 116 void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
 117 int fw_csr_iterator_next(struct fw_csr_iterator *ci,
 118                          int *key, int *value);
 119
 120 #define FW_MATCH_VENDOR         0x0001
 121 #define FW_MATCH_MODEL          0x0002
 122 #define FW_MATCH_SPECIFIER_ID   0x0004
 123 #define FW_MATCH_VERSION        0x0008
 124
 125 struct fw_device_id {
 126         u32 match_flags;
 127         u32 vendor;
 128         u32 model;
 129         u32 specifier_id;
 130         u32 version;
 131         void *driver_data;
 132 };
 133
 134 struct fw_driver {
 135         struct device_driver driver;
 136         /* Called when the parent device sits through a bus reset. */
 137         void (*update) (struct fw_unit *unit);
 138         const struct fw_device_id *id_table;
 139 };
 140
 141 static inline struct fw_driver *
 142 fw_driver(struct device_driver *drv)
 143 {
 144         return container_of(drv, struct fw_driver, driver);
 145 }
 146
 147 extern const struct file_operations fw_device_ops;
 148
 149 #endif /* __fw_device_h */