2 * Copyright (C) 2003-2006 Kristian Hoegsberg <krh@bitplanet.net>
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.
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.
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.
19 #ifndef __fw_transaction_h
20 #define __fw_transaction_h
22 #include <linux/completion.h>
23 #include <linux/device.h>
24 #include <linux/dma-mapping.h>
25 #include <linux/firewire-constants.h>
26 #include <linux/kref.h>
27 #include <linux/list.h>
28 #include <linux/spinlock_types.h>
29 #include <linux/timer.h>
30 #include <linux/types.h>
31 #include <linux/workqueue.h>
33 #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
34 #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
35 #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
36 #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
37 #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
38 #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
40 #define LOCAL_BUS 0xffc0
42 #define SELFID_PORT_CHILD 0x3
43 #define SELFID_PORT_PARENT 0x2
44 #define SELFID_PORT_NCONN 0x1
45 #define SELFID_PORT_NONE 0x0
47 #define PHY_PACKET_CONFIG 0x0
48 #define PHY_PACKET_LINK_ON 0x1
49 #define PHY_PACKET_SELF_ID 0x2
51 /* Bit fields _within_ the PHY registers. */
52 #define PHY_LINK_ACTIVE 0x80
53 #define PHY_CONTENDER 0x40
54 #define PHY_BUS_RESET 0x40
55 #define PHY_BUS_SHORT_RESET 0x40
57 #define CSR_REGISTER_BASE 0xfffff0000000ULL
59 /* register offsets relative to CSR_REGISTER_BASE */
60 #define CSR_STATE_CLEAR 0x0
61 #define CSR_STATE_SET 0x4
62 #define CSR_NODE_IDS 0x8
63 #define CSR_RESET_START 0xc
64 #define CSR_SPLIT_TIMEOUT_HI 0x18
65 #define CSR_SPLIT_TIMEOUT_LO 0x1c
66 #define CSR_CYCLE_TIME 0x200
67 #define CSR_BUS_TIME 0x204
68 #define CSR_BUSY_TIMEOUT 0x210
69 #define CSR_BUS_MANAGER_ID 0x21c
70 #define CSR_BANDWIDTH_AVAILABLE 0x220
71 #define CSR_CHANNELS_AVAILABLE 0x224
72 #define CSR_CHANNELS_AVAILABLE_HI 0x224
73 #define CSR_CHANNELS_AVAILABLE_LO 0x228
74 #define CSR_BROADCAST_CHANNEL 0x234
75 #define CSR_CONFIG_ROM 0x400
76 #define CSR_CONFIG_ROM_END 0x800
77 #define CSR_FCP_COMMAND 0xB00
78 #define CSR_FCP_RESPONSE 0xD00
79 #define CSR_FCP_END 0xF00
80 #define CSR_TOPOLOGY_MAP 0x1000
81 #define CSR_TOPOLOGY_MAP_END 0x1400
82 #define CSR_SPEED_MAP 0x2000
83 #define CSR_SPEED_MAP_END 0x3000
85 #define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31)
86 #define BROADCAST_CHANNEL_VALID (1 << 30)
88 #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
89 #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
91 static inline void fw_memcpy_from_be32(void *_dst, void *_src, size_t size)
97 for (i = 0; i < size / 4; i++)
98 dst[i] = be32_to_cpu(src[i]);
101 static inline void fw_memcpy_to_be32(void *_dst, void *_src, size_t size)
103 fw_memcpy_from_be32(_dst, _src, size);
111 struct fw_descriptor {
112 struct list_head link;
119 int fw_core_add_descriptor(struct fw_descriptor *desc);
120 void fw_core_remove_descriptor(struct fw_descriptor *desc);
122 typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
123 struct fw_card *card, int status);
125 typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
126 void *data, size_t length,
127 void *callback_data);
130 * Important note: The callback must guarantee that either fw_send_response()
131 * or kfree() is called on the @request.
133 typedef void (*fw_address_callback_t)(struct fw_card *card,
134 struct fw_request *request,
135 int tcode, int destination, int source,
136 int generation, int speed,
137 unsigned long long offset,
138 void *data, size_t length,
139 void *callback_data);
145 size_t header_length;
147 size_t payload_length;
148 dma_addr_t payload_bus;
152 * This callback is called when the packet transmission has
153 * completed; for successful transmission, the status code is
154 * the ack received from the destination, otherwise it's a
155 * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
156 * The callback can be called from tasklet context and thus
159 fw_packet_callback_t callback;
161 struct list_head link;
165 struct fw_transaction {
166 int node_id; /* The generation is implied; it is always the current. */
169 struct list_head link;
171 struct fw_packet packet;
174 * The data passed to the callback is valid only during the
177 fw_transaction_callback_t callback;
181 struct fw_address_handler {
184 fw_address_callback_t address_callback;
186 struct list_head link;
189 struct fw_address_region {
194 extern const struct fw_address_region fw_high_memory_region;
196 int fw_core_add_address_handler(struct fw_address_handler *handler,
197 const struct fw_address_region *region);
198 void fw_core_remove_address_handler(struct fw_address_handler *handler);
199 void fw_fill_response(struct fw_packet *response, u32 *request_header,
200 int rcode, void *payload, size_t length);
201 void fw_send_response(struct fw_card *card,
202 struct fw_request *request, int rcode);
204 extern struct bus_type fw_bus_type;
207 const struct fw_card_driver *driver;
208 struct device *device;
210 struct completion done;
214 int current_tlabel, tlabel_mask;
215 struct list_head transaction_list;
216 struct timer_list flush_timer;
217 unsigned long reset_jiffies;
219 unsigned long long guid;
220 unsigned max_receive;
222 int config_rom_generation;
224 spinlock_t lock; /* Take this lock when handling the lists in
226 struct fw_node *local_node;
227 struct fw_node *root_node;
228 struct fw_node *irm_node;
229 u8 color; /* must be u8 to match the definition in struct fw_node */
231 bool beta_repeaters_present;
235 struct list_head link;
237 /* Work struct for BM duties. */
238 struct delayed_work work;
242 u32 broadcast_channel;
243 u32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
246 static inline struct fw_card *fw_card_get(struct fw_card *card)
248 kref_get(&card->kref);
253 void fw_card_release(struct kref *kref);
255 static inline void fw_card_put(struct fw_card *card)
257 kref_put(&card->kref, fw_card_release);
260 extern void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
263 * Check whether new_generation is the immediate successor of old_generation.
264 * Take counter roll-over at 255 (as per to OHCI) into account.
266 static inline bool is_next_generation(int new_generation, int old_generation)
268 return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
272 * The iso packet format allows for an immediate header/payload part
273 * stored in 'header' immediately after the packet info plus an
274 * indirect payload part that is pointer to by the 'payload' field.
275 * Applications can use one or the other or both to implement simple
276 * low-bandwidth streaming (e.g. audio) or more advanced
277 * scatter-gather streaming (e.g. assembling video frame automatically).
280 struct fw_iso_packet {
281 u16 payload_length; /* Length of indirect payload. */
282 u32 interrupt : 1; /* Generate interrupt on this packet */
283 u32 skip : 1; /* Set to not send packet at all. */
286 u32 header_length : 8; /* Length of immediate header. */
290 #define FW_ISO_CONTEXT_TRANSMIT 0
291 #define FW_ISO_CONTEXT_RECEIVE 1
293 #define FW_ISO_CONTEXT_MATCH_TAG0 1
294 #define FW_ISO_CONTEXT_MATCH_TAG1 2
295 #define FW_ISO_CONTEXT_MATCH_TAG2 4
296 #define FW_ISO_CONTEXT_MATCH_TAG3 8
297 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15
299 struct fw_iso_context;
301 typedef void (*fw_iso_callback_t)(struct fw_iso_context *context,
302 u32 cycle, size_t header_length,
303 void *header, void *data);
306 * An iso buffer is just a set of pages mapped for DMA in the
307 * specified direction. Since the pages are to be used for DMA, they
308 * are not mapped into the kernel virtual address space. We store the
309 * DMA address in the page private. The helper function
310 * fw_iso_buffer_map() will map the pages into a given vma.
313 struct fw_iso_buffer {
314 enum dma_data_direction direction;
319 struct fw_iso_context {
320 struct fw_card *card;
325 fw_iso_callback_t callback;
329 int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
330 int page_count, enum dma_data_direction direction);
331 int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
332 void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
334 struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
335 int type, int channel, int speed, size_t header_size,
336 fw_iso_callback_t callback, void *callback_data);
337 int fw_iso_context_queue(struct fw_iso_context *ctx,
338 struct fw_iso_packet *packet,
339 struct fw_iso_buffer *buffer,
340 unsigned long payload);
341 int fw_iso_context_start(struct fw_iso_context *ctx,
342 int cycle, int sync, int tags);
343 int fw_iso_context_stop(struct fw_iso_context *ctx);
344 void fw_iso_context_destroy(struct fw_iso_context *ctx);
346 struct fw_card_driver {
348 * Enable the given card with the given initial config rom.
349 * This function is expected to activate the card, and either
350 * enable the PHY or set the link_on bit and initiate a bus
353 int (*enable)(struct fw_card *card, u32 *config_rom, size_t length);
355 int (*update_phy_reg)(struct fw_card *card, int address,
356 int clear_bits, int set_bits);
359 * Update the config rom for an enabled card. This function
360 * should change the config rom that is presented on the bus
361 * an initiate a bus reset.
363 int (*set_config_rom)(struct fw_card *card,
364 u32 *config_rom, size_t length);
366 void (*send_request)(struct fw_card *card, struct fw_packet *packet);
367 void (*send_response)(struct fw_card *card, struct fw_packet *packet);
368 /* Calling cancel is valid once a packet has been submitted. */
369 int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet);
372 * Allow the specified node ID to do direct DMA out and in of
373 * host memory. The card will disable this for all node when
374 * a bus reset happens, so driver need to reenable this after
375 * bus reset. Returns 0 on success, -ENODEV if the card
376 * doesn't support this, -ESTALE if the generation doesn't
379 int (*enable_phys_dma)(struct fw_card *card,
380 int node_id, int generation);
382 u64 (*get_bus_time)(struct fw_card *card);
384 struct fw_iso_context *
385 (*allocate_iso_context)(struct fw_card *card,
386 int type, int channel, size_t header_size);
387 void (*free_iso_context)(struct fw_iso_context *ctx);
389 int (*start_iso)(struct fw_iso_context *ctx,
390 s32 cycle, u32 sync, u32 tags);
392 int (*queue_iso)(struct fw_iso_context *ctx,
393 struct fw_iso_packet *packet,
394 struct fw_iso_buffer *buffer,
395 unsigned long payload);
397 int (*stop_iso)(struct fw_iso_context *ctx);
400 int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
402 void fw_send_request(struct fw_card *card, struct fw_transaction *t,
403 int tcode, int destination_id, int generation, int speed,
404 unsigned long long offset, void *data, size_t length,
405 fw_transaction_callback_t callback, void *callback_data);
406 int fw_cancel_transaction(struct fw_card *card,
407 struct fw_transaction *transaction);
408 void fw_flush_transactions(struct fw_card *card);
409 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
410 int generation, int speed, unsigned long long offset,
411 void *data, size_t length);
412 void fw_send_phy_config(struct fw_card *card,
413 int node_id, int generation, int gap_count);
416 * Called by the topology code to inform the device code of node
417 * activity; found, lost, or updated nodes.
419 void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
421 /* API used by card level drivers */
423 void fw_card_initialize(struct fw_card *card,
424 const struct fw_card_driver *driver, struct device *device);
425 int fw_card_add(struct fw_card *card,
426 u32 max_receive, u32 link_speed, u64 guid);
427 void fw_core_remove_card(struct fw_card *card);
428 void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
429 int generation, int self_id_count, u32 *self_ids);
430 void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
431 void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
433 #endif /* __fw_transaction_h */