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/device.h>
23 #include <linux/timer.h>
24 #include <linux/interrupt.h>
25 #include <linux/list.h>
27 #include <linux/dma-mapping.h>
28 #include <linux/firewire-constants.h>
30 #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
31 #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
32 #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
33 #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
34 #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
35 #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
37 #define LOCAL_BUS 0xffc0
39 #define SELFID_PORT_CHILD 0x3
40 #define SELFID_PORT_PARENT 0x2
41 #define SELFID_PORT_NCONN 0x1
42 #define SELFID_PORT_NONE 0x0
44 #define PHY_PACKET_CONFIG 0x0
45 #define PHY_PACKET_LINK_ON 0x1
46 #define PHY_PACKET_SELF_ID 0x2
48 /* Bit fields _within_ the PHY registers. */
49 #define PHY_LINK_ACTIVE 0x80
50 #define PHY_CONTENDER 0x40
51 #define PHY_BUS_RESET 0x40
52 #define PHY_BUS_SHORT_RESET 0x40
54 #define CSR_REGISTER_BASE 0xfffff0000000ULL
56 /* register offsets relative to CSR_REGISTER_BASE */
57 #define CSR_STATE_CLEAR 0x0
58 #define CSR_STATE_SET 0x4
59 #define CSR_NODE_IDS 0x8
60 #define CSR_RESET_START 0xc
61 #define CSR_SPLIT_TIMEOUT_HI 0x18
62 #define CSR_SPLIT_TIMEOUT_LO 0x1c
63 #define CSR_CYCLE_TIME 0x200
64 #define CSR_BUS_TIME 0x204
65 #define CSR_BUSY_TIMEOUT 0x210
66 #define CSR_BUS_MANAGER_ID 0x21c
67 #define CSR_BANDWIDTH_AVAILABLE 0x220
68 #define CSR_CHANNELS_AVAILABLE 0x224
69 #define CSR_CHANNELS_AVAILABLE_HI 0x224
70 #define CSR_CHANNELS_AVAILABLE_LO 0x228
71 #define CSR_BROADCAST_CHANNEL 0x234
72 #define CSR_CONFIG_ROM 0x400
73 #define CSR_CONFIG_ROM_END 0x800
74 #define CSR_FCP_COMMAND 0xB00
75 #define CSR_FCP_RESPONSE 0xD00
76 #define CSR_FCP_END 0xF00
77 #define CSR_TOPOLOGY_MAP 0x1000
78 #define CSR_TOPOLOGY_MAP_END 0x1400
79 #define CSR_SPEED_MAP 0x2000
80 #define CSR_SPEED_MAP_END 0x3000
82 #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
83 #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
86 fw_memcpy_from_be32(void *_dst
, void *_src
, size_t size
)
92 for (i
= 0; i
< size
/ 4; i
++)
93 dst
[i
] = cpu_to_be32(src
[i
]);
97 fw_memcpy_to_be32(void *_dst
, void *_src
, size_t size
)
99 fw_memcpy_from_be32(_dst
, _src
, size
);
107 struct fw_descriptor
{
108 struct list_head link
;
115 int fw_core_add_descriptor(struct fw_descriptor
*desc
);
116 void fw_core_remove_descriptor(struct fw_descriptor
*desc
);
118 typedef void (*fw_packet_callback_t
)(struct fw_packet
*packet
,
119 struct fw_card
*card
, int status
);
121 typedef void (*fw_transaction_callback_t
)(struct fw_card
*card
, int rcode
,
124 void *callback_data
);
126 typedef void (*fw_address_callback_t
)(struct fw_card
*card
,
127 struct fw_request
*request
,
128 int tcode
, int destination
, int source
,
129 int generation
, int speed
,
130 unsigned long long offset
,
131 void *data
, size_t length
,
132 void *callback_data
);
134 typedef void (*fw_bus_reset_callback_t
)(struct fw_card
*handle
,
135 int node_id
, int generation
,
138 void *callback_data
);
144 size_t header_length
;
146 size_t payload_length
;
150 * This callback is called when the packet transmission has
151 * completed; for successful transmission, the status code is
152 * the ack received from the destination, otherwise it's a
153 * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
154 * The callback can be called from tasklet context and thus
157 fw_packet_callback_t callback
;
159 struct list_head link
;
163 struct fw_transaction
{
164 int node_id
; /* The generation is implied; it is always the current. */
167 struct list_head link
;
169 struct fw_packet packet
;
172 * The data passed to the callback is valid only during the
175 fw_transaction_callback_t callback
;
179 static inline struct fw_packet
*
180 fw_packet(struct list_head
*l
)
182 return list_entry(l
, struct fw_packet
, link
);
185 struct fw_address_handler
{
188 fw_address_callback_t address_callback
;
190 struct list_head link
;
194 struct fw_address_region
{
199 extern const struct fw_address_region fw_low_memory_region
;
200 extern const struct fw_address_region fw_high_memory_region
;
201 extern const struct fw_address_region fw_private_region
;
202 extern const struct fw_address_region fw_csr_region
;
203 extern const struct fw_address_region fw_unit_space_region
;
205 int fw_core_add_address_handler(struct fw_address_handler
*handler
,
206 const struct fw_address_region
*region
);
207 void fw_core_remove_address_handler(struct fw_address_handler
*handler
);
208 void fw_fill_response(struct fw_packet
*response
, u32
*request_header
,
209 int rcode
, void *payload
, size_t length
);
210 void fw_send_response(struct fw_card
*card
,
211 struct fw_request
*request
, int rcode
);
213 extern struct bus_type fw_bus_type
;
216 const struct fw_card_driver
*driver
;
217 struct device
*device
;
222 /* This is the generation used for timestamping incoming requests. */
223 int request_generation
;
224 int current_tlabel
, tlabel_mask
;
225 struct list_head transaction_list
;
226 struct timer_list flush_timer
;
227 unsigned long reset_jiffies
;
229 unsigned long long guid
;
232 int config_rom_generation
;
235 * We need to store up to 4 self ID for a maximum of 63
236 * devices plus 3 words for the topology map header.
239 u32 topology_map
[252 + 3];
241 spinlock_t lock
; /* Take this lock when handling the lists in
243 struct fw_node
*local_node
;
244 struct fw_node
*root_node
;
245 struct fw_node
*irm_node
;
248 bool beta_repeaters_present
;
252 struct list_head link
;
254 /* Work struct for BM duties. */
255 struct delayed_work work
;
260 struct fw_card
*fw_card_get(struct fw_card
*card
);
261 void fw_card_put(struct fw_card
*card
);
264 * The iso packet format allows for an immediate header/payload part
265 * stored in 'header' immediately after the packet info plus an
266 * indirect payload part that is pointer to by the 'payload' field.
267 * Applications can use one or the other or both to implement simple
268 * low-bandwidth streaming (e.g. audio) or more advanced
269 * scatter-gather streaming (e.g. assembling video frame automatically).
272 struct fw_iso_packet
{
273 u16 payload_length
; /* Length of indirect payload. */
274 u32 interrupt
: 1; /* Generate interrupt on this packet */
275 u32 skip
: 1; /* Set to not send packet at all. */
278 u32 header_length
: 8; /* Length of immediate header. */
282 #define FW_ISO_CONTEXT_TRANSMIT 0
283 #define FW_ISO_CONTEXT_RECEIVE 1
285 #define FW_ISO_CONTEXT_MATCH_TAG0 1
286 #define FW_ISO_CONTEXT_MATCH_TAG1 2
287 #define FW_ISO_CONTEXT_MATCH_TAG2 4
288 #define FW_ISO_CONTEXT_MATCH_TAG3 8
289 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15
291 struct fw_iso_context
;
293 typedef void (*fw_iso_callback_t
)(struct fw_iso_context
*context
,
295 size_t header_length
,
300 * An iso buffer is just a set of pages mapped for DMA in the
301 * specified direction. Since the pages are to be used for DMA, they
302 * are not mapped into the kernel virtual address space. We store the
303 * DMA address in the page private. The helper function
304 * fw_iso_buffer_map() will map the pages into a given vma.
307 struct fw_iso_buffer
{
308 enum dma_data_direction direction
;
313 struct fw_iso_context
{
314 struct fw_card
*card
;
319 fw_iso_callback_t callback
;
324 fw_iso_buffer_init(struct fw_iso_buffer
*buffer
,
325 struct fw_card
*card
,
327 enum dma_data_direction direction
);
329 fw_iso_buffer_map(struct fw_iso_buffer
*buffer
, struct vm_area_struct
*vma
);
331 fw_iso_buffer_destroy(struct fw_iso_buffer
*buffer
, struct fw_card
*card
);
333 struct fw_iso_context
*
334 fw_iso_context_create(struct fw_card
*card
, int type
,
335 int channel
, int speed
, size_t header_size
,
336 fw_iso_callback_t callback
, void *callback_data
);
339 fw_iso_context_destroy(struct fw_iso_context
*ctx
);
342 fw_iso_context_queue(struct fw_iso_context
*ctx
,
343 struct fw_iso_packet
*packet
,
344 struct fw_iso_buffer
*buffer
,
345 unsigned long payload
);
348 fw_iso_context_start(struct fw_iso_context
*ctx
,
349 int cycle
, int sync
, int tags
);
352 fw_iso_context_stop(struct fw_iso_context
*ctx
);
354 struct fw_card_driver
{
358 * Enable the given card with the given initial config rom.
359 * This function is expected to activate the card, and either
360 * enable the PHY or set the link_on bit and initiate a bus
363 int (*enable
)(struct fw_card
*card
, u32
*config_rom
, size_t length
);
365 int (*update_phy_reg
)(struct fw_card
*card
, int address
,
366 int clear_bits
, int set_bits
);
369 * Update the config rom for an enabled card. This function
370 * should change the config rom that is presented on the bus
371 * an initiate a bus reset.
373 int (*set_config_rom
)(struct fw_card
*card
,
374 u32
*config_rom
, size_t length
);
376 void (*send_request
)(struct fw_card
*card
, struct fw_packet
*packet
);
377 void (*send_response
)(struct fw_card
*card
, struct fw_packet
*packet
);
378 /* Calling cancel is valid once a packet has been submitted. */
379 int (*cancel_packet
)(struct fw_card
*card
, struct fw_packet
*packet
);
382 * Allow the specified node ID to do direct DMA out and in of
383 * host memory. The card will disable this for all node when
384 * a bus reset happens, so driver need to reenable this after
385 * bus reset. Returns 0 on success, -ENODEV if the card
386 * doesn't support this, -ESTALE if the generation doesn't
389 int (*enable_phys_dma
)(struct fw_card
*card
,
390 int node_id
, int generation
);
392 u64 (*get_bus_time
)(struct fw_card
*card
);
394 struct fw_iso_context
*
395 (*allocate_iso_context
)(struct fw_card
*card
,
396 int type
, size_t header_size
);
397 void (*free_iso_context
)(struct fw_iso_context
*ctx
);
399 int (*start_iso
)(struct fw_iso_context
*ctx
,
400 s32 cycle
, u32 sync
, u32 tags
);
402 int (*queue_iso
)(struct fw_iso_context
*ctx
,
403 struct fw_iso_packet
*packet
,
404 struct fw_iso_buffer
*buffer
,
405 unsigned long payload
);
407 int (*stop_iso
)(struct fw_iso_context
*ctx
);
411 fw_core_initiate_bus_reset(struct fw_card
*card
, int short_reset
);
414 fw_send_request(struct fw_card
*card
, struct fw_transaction
*t
,
415 int tcode
, int node_id
, int generation
, int speed
,
416 unsigned long long offset
,
417 void *data
, size_t length
,
418 fw_transaction_callback_t callback
, void *callback_data
);
420 int fw_cancel_transaction(struct fw_card
*card
,
421 struct fw_transaction
*transaction
);
423 void fw_flush_transactions(struct fw_card
*card
);
425 void fw_send_phy_config(struct fw_card
*card
,
426 int node_id
, int generation
, int gap_count
);
429 * Called by the topology code to inform the device code of node
430 * activity; found, lost, or updated nodes.
433 fw_node_event(struct fw_card
*card
, struct fw_node
*node
, int event
);
435 /* API used by card level drivers */
438 fw_card_initialize(struct fw_card
*card
, const struct fw_card_driver
*driver
,
439 struct device
*device
);
441 fw_card_add(struct fw_card
*card
,
442 u32 max_receive
, u32 link_speed
, u64 guid
);
445 fw_core_remove_card(struct fw_card
*card
);
448 fw_core_handle_bus_reset(struct fw_card
*card
,
449 int node_id
, int generation
,
450 int self_id_count
, u32
*self_ids
);
452 fw_core_handle_request(struct fw_card
*card
, struct fw_packet
*request
);
455 fw_core_handle_response(struct fw_card
*card
, struct fw_packet
*packet
);
457 #endif /* __fw_transaction_h */