Pull d-states into release branch
[linux-2.6] / 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 struct fw_device {
39         atomic_t state;
40         struct fw_node *node;
41         int node_id;
42         int generation;
43         unsigned max_speed;
44         struct fw_card *card;
45         struct device device;
46         struct list_head link;
47         struct list_head client_list;
48         u32 *config_rom;
49         size_t config_rom_length;
50         int config_rom_retries;
51         struct delayed_work work;
52         struct fw_attribute_group attribute_group;
53 };
54
55 static inline struct fw_device *
56 fw_device(struct device *dev)
57 {
58         return container_of(dev, struct fw_device, device);
59 }
60
61 static inline int
62 fw_device_is_shutdown(struct fw_device *device)
63 {
64         return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
65 }
66
67 struct fw_device *fw_device_get(struct fw_device *device);
68 void fw_device_put(struct fw_device *device);
69 int fw_device_enable_phys_dma(struct fw_device *device);
70
71 void fw_device_cdev_update(struct fw_device *device);
72 void fw_device_cdev_remove(struct fw_device *device);
73
74 struct fw_device *fw_device_from_devt(dev_t devt);
75 extern int fw_cdev_major;
76
77 struct fw_unit {
78         struct device device;
79         u32 *directory;
80         struct fw_attribute_group attribute_group;
81 };
82
83 static inline struct fw_unit *
84 fw_unit(struct device *dev)
85 {
86         return container_of(dev, struct fw_unit, device);
87 }
88
89 #define CSR_OFFSET      0x40
90 #define CSR_LEAF        0x80
91 #define CSR_DIRECTORY   0xc0
92
93 #define CSR_DESCRIPTOR          0x01
94 #define CSR_VENDOR              0x03
95 #define CSR_HARDWARE_VERSION    0x04
96 #define CSR_NODE_CAPABILITIES   0x0c
97 #define CSR_UNIT                0x11
98 #define CSR_SPECIFIER_ID        0x12
99 #define CSR_VERSION             0x13
100 #define CSR_DEPENDENT_INFO      0x14
101 #define CSR_MODEL               0x17
102 #define CSR_INSTANCE            0x18
103 #define CSR_DIRECTORY_ID        0x20
104
105 #define SBP2_COMMAND_SET_SPECIFIER      0x38
106 #define SBP2_COMMAND_SET                0x39
107 #define SBP2_COMMAND_SET_REVISION       0x3b
108 #define SBP2_FIRMWARE_REVISION          0x3c
109
110 struct fw_csr_iterator {
111         u32 *p;
112         u32 *end;
113 };
114
115 void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
116 int fw_csr_iterator_next(struct fw_csr_iterator *ci,
117                          int *key, int *value);
118
119 #define FW_MATCH_VENDOR         0x0001
120 #define FW_MATCH_MODEL          0x0002
121 #define FW_MATCH_SPECIFIER_ID   0x0004
122 #define FW_MATCH_VERSION        0x0008
123
124 struct fw_device_id {
125         u32 match_flags;
126         u32 vendor;
127         u32 model;
128         u32 specifier_id;
129         u32 version;
130         void *driver_data;
131 };
132
133 struct fw_driver {
134         struct device_driver driver;
135         /* Called when the parent device sits through a bus reset. */
136         void (*update) (struct fw_unit *unit);
137         const struct fw_device_id *id_table;
138 };
139
140 static inline struct fw_driver *
141 fw_driver(struct device_driver *drv)
142 {
143         return container_of(drv, struct fw_driver, driver);
144 }
145
146 extern const struct file_operations fw_device_ops;
147
148 #endif /* __fw_device_h */