1 /* -*- c-basic-offset: 8 -*-
3 * fw-transaction.h - Header for IEEE1394 transaction logic
5 * Copyright (C) 2003-2006 Kristian Hoegsberg <krh@bitplanet.net>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software Foundation,
19 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 #ifndef __fw_transaction_h
23 #define __fw_transaction_h
25 #include <linux/device.h>
26 #include <linux/timer.h>
27 #include <linux/interrupt.h>
28 #include <linux/list.h>
30 #include <linux/dma-mapping.h>
32 #define TCODE_WRITE_QUADLET_REQUEST 0
33 #define TCODE_WRITE_BLOCK_REQUEST 1
34 #define TCODE_WRITE_RESPONSE 2
35 #define TCODE_READ_QUADLET_REQUEST 4
36 #define TCODE_READ_BLOCK_REQUEST 5
37 #define TCODE_READ_QUADLET_RESPONSE 6
38 #define TCODE_READ_BLOCK_RESPONSE 7
39 #define TCODE_CYCLE_START 8
40 #define TCODE_LOCK_REQUEST 9
41 #define TCODE_STREAM_DATA 10
42 #define TCODE_LOCK_RESPONSE 11
44 #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
45 #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
46 #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
47 #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
48 #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
49 #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
51 /* Juju specific tcodes */
52 #define TCODE_DEALLOCATE 0x10
53 #define TCODE_LOCK_MASK_SWAP 0x11
54 #define TCODE_LOCK_COMPARE_SWAP 0x12
55 #define TCODE_LOCK_FETCH_ADD 0x13
56 #define TCODE_LOCK_LITTLE_ADD 0x14
57 #define TCODE_LOCK_BOUNDED_ADD 0x15
58 #define TCODE_LOCK_WRAP_ADD 0x16
59 #define TCODE_LOCK_VENDOR_SPECIFIC 0x17
64 #define SCODE_BETA 0x3
66 #define EXTCODE_MASK_SWAP 0x1
67 #define EXTCODE_COMPARE_SWAP 0x2
68 #define EXTCODE_FETCH_ADD 0x3
69 #define EXTCODE_LITTLE_ADD 0x4
70 #define EXTCODE_BOUNDED_ADD 0x5
71 #define EXTCODE_WRAP_ADD 0x6
73 #define ACK_COMPLETE 0x1
74 #define ACK_PENDING 0x2
75 #define ACK_BUSY_X 0x4
76 #define ACK_BUSY_A 0x5
77 #define ACK_BUSY_B 0x6
78 #define ACK_DATA_ERROR 0xd
79 #define ACK_TYPE_ERROR 0xe
81 #define RCODE_COMPLETE 0x0
82 #define RCODE_CONFLICT_ERROR 0x4
83 #define RCODE_DATA_ERROR 0x5
84 #define RCODE_TYPE_ERROR 0x6
85 #define RCODE_ADDRESS_ERROR 0x7
87 /* Juju specific rcodes */
88 #define RCODE_SEND_ERROR 0x10
89 #define RCODE_CANCELLED 0x11
90 #define RCODE_BUSY 0x12
91 #define RCODE_GENERATION 0x13
92 #define RCODE_NO_ACK 0x14
99 #define LOCAL_BUS 0xffc0
101 #define SELFID_PORT_CHILD 0x3
102 #define SELFID_PORT_PARENT 0x2
103 #define SELFID_PORT_NCONN 0x1
104 #define SELFID_PORT_NONE 0x0
106 #define PHY_PACKET_CONFIG 0x0
107 #define PHY_PACKET_LINK_ON 0x1
108 #define PHY_PACKET_SELF_ID 0x2
110 #define CSR_REGISTER_BASE 0xfffff0000000ULL
112 /* register offsets relative to CSR_REGISTER_BASE */
113 #define CSR_STATE_CLEAR 0x0
114 #define CSR_STATE_SET 0x4
115 #define CSR_NODE_IDS 0x8
116 #define CSR_RESET_START 0xc
117 #define CSR_SPLIT_TIMEOUT_HI 0x18
118 #define CSR_SPLIT_TIMEOUT_LO 0x1c
119 #define CSR_CYCLE_TIME 0x200
120 #define CSR_BUS_TIME 0x204
121 #define CSR_BUSY_TIMEOUT 0x210
122 #define CSR_BUS_MANAGER_ID 0x21c
123 #define CSR_BANDWIDTH_AVAILABLE 0x220
124 #define CSR_CHANNELS_AVAILABLE 0x224
125 #define CSR_CHANNELS_AVAILABLE_HI 0x224
126 #define CSR_CHANNELS_AVAILABLE_LO 0x228
127 #define CSR_BROADCAST_CHANNEL 0x234
128 #define CSR_CONFIG_ROM 0x400
129 #define CSR_CONFIG_ROM_END 0x800
130 #define CSR_FCP_COMMAND 0xB00
131 #define CSR_FCP_RESPONSE 0xD00
132 #define CSR_FCP_END 0xF00
133 #define CSR_TOPOLOGY_MAP 0x1000
134 #define CSR_TOPOLOGY_MAP_END 0x1400
135 #define CSR_SPEED_MAP 0x2000
136 #define CSR_SPEED_MAP_END 0x3000
138 #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
139 #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
140 #define fw_debug(s, args...) printk(KERN_DEBUG KBUILD_MODNAME ": " s, ## args)
143 fw_memcpy_from_be32(void *_dst
, void *_src
, size_t size
)
149 for (i
= 0; i
< size
/ 4; i
++)
150 dst
[i
] = cpu_to_be32(src
[i
]);
154 fw_memcpy_to_be32(void *_dst
, void *_src
, size_t size
)
156 fw_memcpy_from_be32(_dst
, _src
, size
);
164 struct fw_descriptor
{
165 struct list_head link
;
171 int fw_core_add_descriptor (struct fw_descriptor
*desc
);
172 void fw_core_remove_descriptor (struct fw_descriptor
*desc
);
174 typedef void (*fw_packet_callback_t
) (struct fw_packet
*packet
,
175 struct fw_card
*card
, int status
);
177 typedef void (*fw_transaction_callback_t
)(struct fw_card
*card
, int rcode
,
180 void *callback_data
);
182 typedef void (*fw_address_callback_t
)(struct fw_card
*card
,
183 struct fw_request
*request
,
184 int tcode
, int destination
, int source
,
185 int generation
, int speed
,
186 unsigned long long offset
,
187 void *data
, size_t length
,
188 void *callback_data
);
190 typedef void (*fw_bus_reset_callback_t
)(struct fw_card
*handle
,
191 int node_id
, int generation
,
194 void *callback_data
);
200 size_t header_length
;
202 size_t payload_length
;
205 dma_addr_t payload_bus
;
207 /* This callback is called when the packet transmission has
208 * completed; for successful transmission, the status code is
209 * the ack received from the destination, otherwise it's a
210 * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
211 * The callback can be called from tasklet context and thus
214 fw_packet_callback_t callback
;
216 struct list_head link
;
219 struct fw_transaction
{
220 int node_id
; /* The generation is implied; it is always the current. */
223 struct list_head link
;
225 struct fw_packet packet
;
227 /* The data passed to the callback is valid only during the
229 fw_transaction_callback_t callback
;
233 static inline struct fw_packet
*
234 fw_packet(struct list_head
*l
)
236 return list_entry (l
, struct fw_packet
, link
);
239 struct fw_address_handler
{
242 fw_address_callback_t address_callback
;
244 struct list_head link
;
248 struct fw_address_region
{
253 extern const struct fw_address_region fw_low_memory_region
;
254 extern const struct fw_address_region fw_high_memory_region
;
255 extern const struct fw_address_region fw_private_region
;
256 extern const struct fw_address_region fw_csr_region
;
257 extern const struct fw_address_region fw_unit_space_region
;
259 int fw_core_add_address_handler(struct fw_address_handler
*handler
,
260 const struct fw_address_region
*region
);
261 void fw_core_remove_address_handler(struct fw_address_handler
*handler
);
262 void fw_fill_response(struct fw_packet
*response
, u32
*request_header
,
263 int rcode
, void *payload
, size_t length
);
264 void fw_send_response(struct fw_card
*card
,
265 struct fw_request
*request
, int rcode
);
267 extern struct bus_type fw_bus_type
;
270 const struct fw_card_driver
*driver
;
271 struct device
*device
;
275 /* This is the generation used for timestamping incoming requests. */
276 int request_generation
;
277 int current_tlabel
, tlabel_mask
;
278 struct list_head transaction_list
;
279 struct timer_list flush_timer
;
280 unsigned long reset_jiffies
;
282 unsigned long long guid
;
285 int config_rom_generation
;
287 /* We need to store up to 4 self ID for a maximum of 63 devices. */
291 spinlock_t lock
; /* Take this lock when handling the lists in
293 struct fw_node
*local_node
;
294 struct fw_node
*root_node
;
295 struct fw_node
*irm_node
;
302 struct device card_device
;
304 struct list_head link
;
306 /* Work struct for BM duties. */
307 struct delayed_work work
;
312 struct fw_card
*fw_card_get(struct fw_card
*card
);
313 void fw_card_put(struct fw_card
*card
);
315 /* The iso packet format allows for an immediate header/payload part
316 * stored in 'header' immediately after the packet info plus an
317 * indirect payload part that is pointer to by the 'payload' field.
318 * Applications can use one or the other or both to implement simple
319 * low-bandwidth streaming (e.g. audio) or more advanced
320 * scatter-gather streaming (e.g. assembling video frame automatically). */
322 struct fw_iso_packet
{
323 u16 payload_length
; /* Length of indirect payload. */
324 u32 interrupt
: 1; /* Generate interrupt on this packet */
325 u32 skip
: 1; /* Set to not send packet at all. */
328 u32 header_length
: 8; /* Length of immediate header. */
332 #define FW_ISO_CONTEXT_TRANSMIT 0
333 #define FW_ISO_CONTEXT_RECEIVE 1
335 struct fw_iso_context
;
337 typedef void (*fw_iso_callback_t
) (struct fw_iso_context
*context
,
338 int status
, u32 cycle
, void *data
);
340 /* An iso buffer is just a set of pages mapped for DMA in the
341 * specified direction. Since the pages are to be used for DMA, they
342 * are not mapped into the kernel virtual address space. We store the
343 * DMA address in the page private. The helper function
344 * fw_iso_buffer_map() will map the pages into a given vma. */
346 struct fw_iso_buffer
{
347 enum dma_data_direction direction
;
352 struct fw_iso_context
{
353 struct fw_card
*card
;
358 fw_iso_callback_t callback
;
363 fw_iso_buffer_init(struct fw_iso_buffer
*buffer
,
364 struct fw_card
*card
,
366 enum dma_data_direction direction
);
368 fw_iso_buffer_map(struct fw_iso_buffer
*buffer
, struct vm_area_struct
*vma
);
370 fw_iso_buffer_destroy(struct fw_iso_buffer
*buffer
, struct fw_card
*card
);
372 struct fw_iso_context
*
373 fw_iso_context_create(struct fw_card
*card
, int type
, size_t header_size
,
374 fw_iso_callback_t callback
, void *callback_data
);
377 fw_iso_context_destroy(struct fw_iso_context
*ctx
);
380 fw_iso_context_queue(struct fw_iso_context
*ctx
,
381 struct fw_iso_packet
*packet
,
382 struct fw_iso_buffer
*buffer
,
383 unsigned long payload
);
386 fw_iso_context_start(struct fw_iso_context
*ctx
,
387 int channel
, int speed
, int cycle
);
389 struct fw_card_driver
{
392 /* Enable the given card with the given initial config rom.
393 * This function is expected to activate the card, and either
394 * enable the PHY or set the link_on bit and initiate a bus
396 int (*enable
) (struct fw_card
*card
, u32
*config_rom
, size_t length
);
398 int (*update_phy_reg
) (struct fw_card
*card
, int address
,
399 int clear_bits
, int set_bits
);
401 /* Update the config rom for an enabled card. This function
402 * should change the config rom that is presented on the bus
403 * an initiate a bus reset. */
404 int (*set_config_rom
) (struct fw_card
*card
,
405 u32
*config_rom
, size_t length
);
407 void (*send_request
) (struct fw_card
*card
, struct fw_packet
*packet
);
408 void (*send_response
) (struct fw_card
*card
, struct fw_packet
*packet
);
409 /* Calling cancel is valid once a packet has been submitted. */
410 int (*cancel_packet
) (struct fw_card
*card
, struct fw_packet
*packet
);
412 /* Allow the specified node ID to do direct DMA out and in of
413 * host memory. The card will disable this for all node when
414 * a bus reset happens, so driver need to reenable this after
415 * bus reset. Returns 0 on success, -ENODEV if the card
416 * doesn't support this, -ESTALE if the generation doesn't
418 int (*enable_phys_dma
) (struct fw_card
*card
,
419 int node_id
, int generation
);
421 struct fw_iso_context
*
422 (*allocate_iso_context
)(struct fw_card
*card
, int type
);
423 void (*free_iso_context
)(struct fw_iso_context
*ctx
);
425 int (*start_iso
)(struct fw_iso_context
*ctx
, s32 cycle
);
427 int (*queue_iso
)(struct fw_iso_context
*ctx
,
428 struct fw_iso_packet
*packet
,
429 struct fw_iso_buffer
*buffer
,
430 unsigned long payload
);
434 fw_core_initiate_bus_reset(struct fw_card
*card
, int short_reset
);
437 fw_send_request(struct fw_card
*card
, struct fw_transaction
*t
,
438 int tcode
, int node_id
, int generation
, int speed
,
439 unsigned long long offset
,
440 void *data
, size_t length
,
441 fw_transaction_callback_t callback
, void *callback_data
);
443 int fw_cancel_transaction(struct fw_card
*card
,
444 struct fw_transaction
*transaction
);
446 void fw_flush_transactions(struct fw_card
*card
);
448 void fw_send_phy_config(struct fw_card
*card
,
449 int node_id
, int generation
, int gap_count
);
451 /* Called by the topology code to inform the device code of node
452 * activity; found, lost, or updated nodes */
454 fw_node_event(struct fw_card
*card
, struct fw_node
*node
, int event
);
456 /* API used by card level drivers */
458 /* Do we need phy speed here also? If we add more args, maybe we
459 should go back to struct fw_card_info. */
461 fw_card_initialize(struct fw_card
*card
, const struct fw_card_driver
*driver
,
462 struct device
*device
);
464 fw_card_add(struct fw_card
*card
,
465 u32 max_receive
, u32 link_speed
, u64 guid
);
468 fw_core_remove_card(struct fw_card
*card
);
471 fw_core_handle_bus_reset(struct fw_card
*card
,
472 int node_id
, int generation
,
473 int self_id_count
, u32
*self_ids
);
475 fw_core_handle_request(struct fw_card
*card
, struct fw_packet
*request
);
478 fw_core_handle_response(struct fw_card
*card
, struct fw_packet
*packet
);
480 #endif /* __fw_transaction_h */