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