Commit | Line | Data |
---|---|---|
77c9a5da SR |
1 | #ifndef _FIREWIRE_CORE_H |
2 | #define _FIREWIRE_CORE_H | |
3 | ||
21076226 | 4 | #include <linux/device.h> |
77c9a5da SR |
5 | #include <linux/fs.h> |
6 | #include <linux/list.h> | |
7 | #include <linux/idr.h> | |
8 | #include <linux/mm_types.h> | |
9 | #include <linux/rwsem.h> | |
10 | #include <linux/slab.h> | |
11 | #include <linux/types.h> | |
12 | ||
60063497 | 13 | #include <linux/atomic.h> |
77c9a5da SR |
14 | |
15 | struct device; | |
16 | struct fw_card; | |
17 | struct fw_device; | |
18 | struct fw_iso_buffer; | |
19 | struct fw_iso_context; | |
20 | struct fw_iso_packet; | |
21 | struct fw_node; | |
22 | struct fw_packet; | |
23 | ||
24 | ||
25 | /* -card */ | |
26 | ||
27 | /* bitfields within the PHY registers */ | |
28 | #define PHY_LINK_ACTIVE 0x80 | |
29 | #define PHY_CONTENDER 0x40 | |
30 | #define PHY_BUS_RESET 0x40 | |
925e7a65 | 31 | #define PHY_EXTENDED_REGISTERS 0xe0 |
77c9a5da | 32 | #define PHY_BUS_SHORT_RESET 0x40 |
e7014dad | 33 | #define PHY_INT_STATUS_BITS 0x3c |
925e7a65 CL |
34 | #define PHY_ENABLE_ACCEL 0x02 |
35 | #define PHY_ENABLE_MULTI 0x01 | |
36 | #define PHY_PAGE_SELECT 0xe0 | |
77c9a5da SR |
37 | |
38 | #define BANDWIDTH_AVAILABLE_INITIAL 4915 | |
39 | #define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31) | |
40 | #define BROADCAST_CHANNEL_VALID (1 << 30) | |
41 | ||
4ffb7a6a | 42 | #define CSR_STATE_BIT_CMSTR (1 << 8) |
7e0e314f | 43 | #define CSR_STATE_BIT_ABDICATE (1 << 10) |
4ffb7a6a | 44 | |
77c9a5da SR |
45 | struct fw_card_driver { |
46 | /* | |
47 | * Enable the given card with the given initial config rom. | |
48 | * This function is expected to activate the card, and either | |
49 | * enable the PHY or set the link_on bit and initiate a bus | |
50 | * reset. | |
51 | */ | |
8e85973e SR |
52 | int (*enable)(struct fw_card *card, |
53 | const __be32 *config_rom, size_t length); | |
77c9a5da | 54 | |
02d37bed | 55 | int (*read_phy_reg)(struct fw_card *card, int address); |
77c9a5da SR |
56 | int (*update_phy_reg)(struct fw_card *card, int address, |
57 | int clear_bits, int set_bits); | |
58 | ||
59 | /* | |
60 | * Update the config rom for an enabled card. This function | |
61 | * should change the config rom that is presented on the bus | |
8e85973e | 62 | * and initiate a bus reset. |
77c9a5da SR |
63 | */ |
64 | int (*set_config_rom)(struct fw_card *card, | |
8e85973e | 65 | const __be32 *config_rom, size_t length); |
77c9a5da SR |
66 | |
67 | void (*send_request)(struct fw_card *card, struct fw_packet *packet); | |
68 | void (*send_response)(struct fw_card *card, struct fw_packet *packet); | |
69 | /* Calling cancel is valid once a packet has been submitted. */ | |
70 | int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet); | |
71 | ||
72 | /* | |
73 | * Allow the specified node ID to do direct DMA out and in of | |
74 | * host memory. The card will disable this for all node when | |
75 | * a bus reset happens, so driver need to reenable this after | |
76 | * bus reset. Returns 0 on success, -ENODEV if the card | |
77 | * doesn't support this, -ESTALE if the generation doesn't | |
78 | * match. | |
79 | */ | |
80 | int (*enable_phys_dma)(struct fw_card *card, | |
81 | int node_id, int generation); | |
82 | ||
0fcff4e3 SR |
83 | u32 (*read_csr)(struct fw_card *card, int csr_offset); |
84 | void (*write_csr)(struct fw_card *card, int csr_offset, u32 value); | |
77c9a5da SR |
85 | |
86 | struct fw_iso_context * | |
87 | (*allocate_iso_context)(struct fw_card *card, | |
88 | int type, int channel, size_t header_size); | |
89 | void (*free_iso_context)(struct fw_iso_context *ctx); | |
90 | ||
91 | int (*start_iso)(struct fw_iso_context *ctx, | |
92 | s32 cycle, u32 sync, u32 tags); | |
93 | ||
872e330e SR |
94 | int (*set_iso_channels)(struct fw_iso_context *ctx, u64 *channels); |
95 | ||
77c9a5da SR |
96 | int (*queue_iso)(struct fw_iso_context *ctx, |
97 | struct fw_iso_packet *packet, | |
98 | struct fw_iso_buffer *buffer, | |
99 | unsigned long payload); | |
100 | ||
13882a82 CL |
101 | void (*flush_queue_iso)(struct fw_iso_context *ctx); |
102 | ||
77c9a5da SR |
103 | int (*stop_iso)(struct fw_iso_context *ctx); |
104 | }; | |
105 | ||
106 | void fw_card_initialize(struct fw_card *card, | |
107 | const struct fw_card_driver *driver, struct device *device); | |
108 | int fw_card_add(struct fw_card *card, | |
109 | u32 max_receive, u32 link_speed, u64 guid); | |
110 | void fw_core_remove_card(struct fw_card *card); | |
cb7c96da | 111 | int fw_compute_block_crc(__be32 *block); |
02d37bed | 112 | void fw_schedule_bus_reset(struct fw_card *card, bool delayed, bool short_reset); |
77c9a5da SR |
113 | void fw_schedule_bm_work(struct fw_card *card, unsigned long delay); |
114 | ||
18668ff9 SR |
115 | static inline struct fw_card *fw_card_get(struct fw_card *card) |
116 | { | |
117 | kref_get(&card->kref); | |
118 | ||
119 | return card; | |
120 | } | |
121 | ||
122 | void fw_card_release(struct kref *kref); | |
123 | ||
124 | static inline void fw_card_put(struct fw_card *card) | |
125 | { | |
126 | kref_put(&card->kref, fw_card_release); | |
127 | } | |
128 | ||
77c9a5da SR |
129 | |
130 | /* -cdev */ | |
131 | ||
132 | extern const struct file_operations fw_device_ops; | |
133 | ||
134 | void fw_device_cdev_update(struct fw_device *device); | |
135 | void fw_device_cdev_remove(struct fw_device *device); | |
bf54e146 | 136 | void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p); |
77c9a5da SR |
137 | |
138 | ||
139 | /* -device */ | |
140 | ||
141 | extern struct rw_semaphore fw_device_rwsem; | |
142 | extern struct idr fw_device_idr; | |
143 | extern int fw_cdev_major; | |
144 | ||
21076226 SR |
145 | static inline struct fw_device *fw_device_get(struct fw_device *device) |
146 | { | |
147 | get_device(&device->device); | |
148 | ||
149 | return device; | |
150 | } | |
151 | ||
152 | static inline void fw_device_put(struct fw_device *device) | |
153 | { | |
154 | put_device(&device->device); | |
155 | } | |
156 | ||
77c9a5da | 157 | struct fw_device *fw_device_get_by_devt(dev_t devt); |
099d5414 | 158 | int fw_device_set_broadcast_channel(struct device *dev, void *gen); |
77c9a5da SR |
159 | void fw_node_event(struct fw_card *card, struct fw_node *node, int event); |
160 | ||
161 | ||
162 | /* -iso */ | |
163 | ||
77c9a5da | 164 | int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma); |
77c9a5da SR |
165 | |
166 | ||
167 | /* -topology */ | |
168 | ||
169 | enum { | |
170 | FW_NODE_CREATED, | |
171 | FW_NODE_UPDATED, | |
172 | FW_NODE_DESTROYED, | |
173 | FW_NODE_LINK_ON, | |
174 | FW_NODE_LINK_OFF, | |
175 | FW_NODE_INITIATED_RESET, | |
176 | }; | |
177 | ||
178 | struct fw_node { | |
179 | u16 node_id; | |
180 | u8 color; | |
181 | u8 port_count; | |
182 | u8 link_on:1; | |
183 | u8 initiated_reset:1; | |
184 | u8 b_path:1; | |
185 | u8 phy_speed:2; /* As in the self ID packet. */ | |
186 | u8 max_speed:2; /* Minimum of all phy-speeds on the path from the | |
187 | * local node to this node. */ | |
188 | u8 max_depth:4; /* Maximum depth to any leaf node */ | |
189 | u8 max_hops:4; /* Max hops in this sub tree */ | |
190 | atomic_t ref_count; | |
191 | ||
192 | /* For serializing node topology into a list. */ | |
193 | struct list_head link; | |
194 | ||
195 | /* Upper layer specific data. */ | |
196 | void *data; | |
197 | ||
198 | struct fw_node *ports[0]; | |
199 | }; | |
200 | ||
201 | static inline struct fw_node *fw_node_get(struct fw_node *node) | |
202 | { | |
203 | atomic_inc(&node->ref_count); | |
204 | ||
205 | return node; | |
206 | } | |
207 | ||
208 | static inline void fw_node_put(struct fw_node *node) | |
209 | { | |
210 | if (atomic_dec_and_test(&node->ref_count)) | |
211 | kfree(node); | |
212 | } | |
213 | ||
214 | void fw_core_handle_bus_reset(struct fw_card *card, int node_id, | |
c8a94ded | 215 | int generation, int self_id_count, u32 *self_ids, bool bm_abdicate); |
77c9a5da SR |
216 | void fw_destroy_nodes(struct fw_card *card); |
217 | ||
218 | /* | |
219 | * Check whether new_generation is the immediate successor of old_generation. | |
220 | * Take counter roll-over at 255 (as per OHCI) into account. | |
221 | */ | |
222 | static inline bool is_next_generation(int new_generation, int old_generation) | |
223 | { | |
224 | return (new_generation & 0xff) == ((old_generation + 1) & 0xff); | |
225 | } | |
226 | ||
227 | ||
228 | /* -transaction */ | |
229 | ||
5b06db16 CL |
230 | #define TCODE_LINK_INTERNAL 0xe |
231 | ||
77c9a5da SR |
232 | #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4) |
233 | #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0) | |
5b06db16 | 234 | #define TCODE_IS_LINK_INTERNAL(tcode) ((tcode) == TCODE_LINK_INTERNAL) |
77c9a5da SR |
235 | #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0) |
236 | #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0) | |
237 | #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4) | |
238 | #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0) | |
239 | ||
240 | #define LOCAL_BUS 0xffc0 | |
241 | ||
242 | void fw_core_handle_request(struct fw_card *card, struct fw_packet *request); | |
243 | void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet); | |
a10c0ce7 | 244 | int fw_get_response_length(struct fw_request *request); |
77c9a5da SR |
245 | void fw_fill_response(struct fw_packet *response, u32 *request_header, |
246 | int rcode, void *payload, size_t length); | |
02d37bed SR |
247 | |
248 | #define FW_PHY_CONFIG_NO_NODE_ID -1 | |
249 | #define FW_PHY_CONFIG_CURRENT_GAP_COUNT -1 | |
77c9a5da SR |
250 | void fw_send_phy_config(struct fw_card *card, |
251 | int node_id, int generation, int gap_count); | |
252 | ||
cc550216 SR |
253 | static inline bool is_ping_packet(u32 *data) |
254 | { | |
255 | return (data[0] & 0xc0ffffff) == 0 && ~data[0] == data[1]; | |
256 | } | |
257 | ||
77c9a5da | 258 | #endif /* _FIREWIRE_CORE_H */ |