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