Commit | Line | Data |
---|---|---|
c781c06d | 1 | /* |
19a15b93 KH |
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 | ||
41f321c2 | 22 | #include <linux/device.h> |
19a15b93 | 23 | #include <linux/fs.h> |
d6053e08 | 24 | #include <linux/idr.h> |
41f321c2 SR |
25 | #include <linux/kernel.h> |
26 | #include <linux/list.h> | |
d67cfb96 | 27 | #include <linux/mutex.h> |
41f321c2 SR |
28 | #include <linux/rwsem.h> |
29 | #include <linux/sysfs.h> | |
30 | #include <linux/types.h> | |
31 | #include <linux/workqueue.h> | |
32 | ||
641f8791 | 33 | #include <asm/atomic.h> |
19a15b93 KH |
34 | |
35 | enum fw_device_state { | |
36 | FW_DEVICE_INITIALIZING, | |
37 | FW_DEVICE_RUNNING, | |
3d36a0df | 38 | FW_DEVICE_GONE, |
5af4e5ea | 39 | FW_DEVICE_SHUTDOWN, |
19a15b93 KH |
40 | }; |
41 | ||
6f2e53d5 KH |
42 | struct fw_attribute_group { |
43 | struct attribute_group *groups[2]; | |
44 | struct attribute_group group; | |
45 | struct attribute *attrs[11]; | |
46 | }; | |
47 | ||
41f321c2 SR |
48 | struct fw_node; |
49 | struct fw_card; | |
50 | ||
b5d2a5e0 SR |
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. | |
c9755e14 SR |
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. | |
b5d2a5e0 | 67 | */ |
19a15b93 | 68 | struct fw_device { |
641f8791 | 69 | atomic_t state; |
19a15b93 KH |
70 | struct fw_node *node; |
71 | int node_id; | |
72 | int generation; | |
f1397490 | 73 | unsigned max_speed; |
19a15b93 KH |
74 | struct fw_card *card; |
75 | struct device device; | |
d67cfb96 SR |
76 | |
77 | struct mutex client_list_mutex; | |
97bd9efa | 78 | struct list_head client_list; |
d67cfb96 | 79 | |
945ac222 | 80 | u32 *config_rom; |
19a15b93 KH |
81 | size_t config_rom_length; |
82 | int config_rom_retries; | |
7889b60e SR |
83 | unsigned cmc:1; |
84 | unsigned bc_implemented:2; | |
85 | ||
19a15b93 | 86 | struct delayed_work work; |
6f2e53d5 | 87 | struct fw_attribute_group attribute_group; |
19a15b93 KH |
88 | }; |
89 | ||
1dc3bea7 | 90 | static inline struct fw_device *fw_device(struct device *dev) |
19a15b93 | 91 | { |
5e20c282 | 92 | return container_of(dev, struct fw_device, device); |
19a15b93 KH |
93 | } |
94 | ||
1dc3bea7 | 95 | static inline int fw_device_is_shutdown(struct fw_device *device) |
2603bf21 KH |
96 | { |
97 | return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN; | |
98 | } | |
99 | ||
1dc3bea7 | 100 | static inline struct fw_device *fw_device_get(struct fw_device *device) |
855c603d SR |
101 | { |
102 | get_device(&device->device); | |
103 | ||
104 | return device; | |
105 | } | |
106 | ||
1dc3bea7 | 107 | static inline void fw_device_put(struct fw_device *device) |
855c603d SR |
108 | { |
109 | put_device(&device->device); | |
110 | } | |
111 | ||
96b19062 | 112 | struct fw_device *fw_device_get_by_devt(dev_t devt); |
19a15b93 | 113 | int fw_device_enable_phys_dma(struct fw_device *device); |
7889b60e | 114 | void fw_device_set_broadcast_channel(struct fw_device *device, int generation); |
19a15b93 | 115 | |
97bd9efa | 116 | void fw_device_cdev_update(struct fw_device *device); |
2603bf21 | 117 | void fw_device_cdev_remove(struct fw_device *device); |
97bd9efa | 118 | |
c9755e14 | 119 | extern struct rw_semaphore fw_device_rwsem; |
d6053e08 | 120 | extern struct idr fw_device_idr; |
a3aca3da KH |
121 | extern int fw_cdev_major; |
122 | ||
c9755e14 SR |
123 | /* |
124 | * fw_unit.directory must not be accessed after device_del(&fw_unit.device). | |
125 | */ | |
19a15b93 KH |
126 | struct fw_unit { |
127 | struct device device; | |
128 | u32 *directory; | |
6f2e53d5 | 129 | struct fw_attribute_group attribute_group; |
19a15b93 KH |
130 | }; |
131 | ||
1dc3bea7 | 132 | static inline struct fw_unit *fw_unit(struct device *dev) |
19a15b93 | 133 | { |
5e20c282 | 134 | return container_of(dev, struct fw_unit, device); |
19a15b93 KH |
135 | } |
136 | ||
1dc3bea7 SR |
137 | static inline struct fw_unit *fw_unit_get(struct fw_unit *unit) |
138 | { | |
139 | get_device(&unit->device); | |
140 | ||
141 | return unit; | |
142 | } | |
143 | ||
144 | static inline void fw_unit_put(struct fw_unit *unit) | |
145 | { | |
146 | put_device(&unit->device); | |
147 | } | |
148 | ||
19a15b93 KH |
149 | #define CSR_OFFSET 0x40 |
150 | #define CSR_LEAF 0x80 | |
151 | #define CSR_DIRECTORY 0xc0 | |
152 | ||
153 | #define CSR_DESCRIPTOR 0x01 | |
154 | #define CSR_VENDOR 0x03 | |
155 | #define CSR_HARDWARE_VERSION 0x04 | |
156 | #define CSR_NODE_CAPABILITIES 0x0c | |
157 | #define CSR_UNIT 0x11 | |
158 | #define CSR_SPECIFIER_ID 0x12 | |
159 | #define CSR_VERSION 0x13 | |
160 | #define CSR_DEPENDENT_INFO 0x14 | |
161 | #define CSR_MODEL 0x17 | |
162 | #define CSR_INSTANCE 0x18 | |
14e21986 | 163 | #define CSR_DIRECTORY_ID 0x20 |
19a15b93 | 164 | |
19a15b93 KH |
165 | struct fw_csr_iterator { |
166 | u32 *p; | |
167 | u32 *end; | |
168 | }; | |
169 | ||
170 | void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p); | |
171 | int fw_csr_iterator_next(struct fw_csr_iterator *ci, | |
172 | int *key, int *value); | |
173 | ||
174 | #define FW_MATCH_VENDOR 0x0001 | |
175 | #define FW_MATCH_MODEL 0x0002 | |
176 | #define FW_MATCH_SPECIFIER_ID 0x0004 | |
177 | #define FW_MATCH_VERSION 0x0008 | |
178 | ||
179 | struct fw_device_id { | |
180 | u32 match_flags; | |
181 | u32 vendor; | |
182 | u32 model; | |
183 | u32 specifier_id; | |
184 | u32 version; | |
185 | void *driver_data; | |
186 | }; | |
187 | ||
188 | struct fw_driver { | |
189 | struct device_driver driver; | |
190 | /* Called when the parent device sits through a bus reset. */ | |
191 | void (*update) (struct fw_unit *unit); | |
21ebcd12 | 192 | const struct fw_device_id *id_table; |
19a15b93 KH |
193 | }; |
194 | ||
53dca511 | 195 | static inline struct fw_driver *fw_driver(struct device_driver *drv) |
19a15b93 | 196 | { |
5e20c282 | 197 | return container_of(drv, struct fw_driver, driver); |
19a15b93 KH |
198 | } |
199 | ||
21ebcd12 | 200 | extern const struct file_operations fw_device_ops; |
19a15b93 | 201 | |
687198bb | 202 | #endif /* __fw_device_h */ |