1 /* -*- c-basic-offset: 8 -*-
3 * fw-ohci.c - Driver for OHCI 1394 boards
4 * Copyright (C) 2003-2006 Kristian Hoegsberg <krh@bitplanet.net>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/init.h>
24 #include <linux/interrupt.h>
25 #include <linux/pci.h>
26 #include <linux/delay.h>
27 #include <linux/poll.h>
28 #include <linux/dma-mapping.h>
30 #include <asm/uaccess.h>
31 #include <asm/semaphore.h>
33 #include "fw-transaction.h"
36 #define descriptor_output_more 0
37 #define descriptor_output_last (1 << 12)
38 #define descriptor_input_more (2 << 12)
39 #define descriptor_input_last (3 << 12)
40 #define descriptor_status (1 << 11)
41 #define descriptor_key_immediate (2 << 8)
42 #define descriptor_ping (1 << 7)
43 #define descriptor_yy (1 << 6)
44 #define descriptor_no_irq (0 << 4)
45 #define descriptor_irq_error (1 << 4)
46 #define descriptor_irq_always (3 << 4)
47 #define descriptor_branch_always (3 << 2)
48 #define descriptor_wait (3 << 0)
54 __le32 branch_address
;
56 __le16 transfer_status
;
57 } __attribute__((aligned(16)));
59 struct db_descriptor
{
62 __le16 second_req_count
;
63 __le16 first_req_count
;
64 __le32 branch_address
;
65 __le16 second_res_count
;
66 __le16 first_res_count
;
71 } __attribute__((aligned(16)));
73 #define control_set(regs) (regs)
74 #define control_clear(regs) ((regs) + 4)
75 #define command_ptr(regs) ((regs) + 12)
76 #define context_match(regs) ((regs) + 16)
79 struct descriptor descriptor
;
80 struct ar_buffer
*next
;
86 struct ar_buffer
*current_buffer
;
87 struct ar_buffer
*last_buffer
;
90 struct tasklet_struct tasklet
;
95 typedef int (*descriptor_callback_t
)(struct context
*ctx
,
97 struct descriptor
*last
);
102 struct descriptor
*buffer
;
103 dma_addr_t buffer_bus
;
105 struct descriptor
*head_descriptor
;
106 struct descriptor
*tail_descriptor
;
107 struct descriptor
*tail_descriptor_last
;
108 struct descriptor
*prev_descriptor
;
110 descriptor_callback_t callback
;
112 struct tasklet_struct tasklet
;
115 #define it_header_sy(v) ((v) << 0)
116 #define it_header_tcode(v) ((v) << 4)
117 #define it_header_channel(v) ((v) << 8)
118 #define it_header_tag(v) ((v) << 14)
119 #define it_header_speed(v) ((v) << 16)
120 #define it_header_data_length(v) ((v) << 16)
123 struct fw_iso_context base
;
124 struct context context
;
126 size_t header_length
;
129 #define CONFIG_ROM_SIZE 1024
135 __iomem
char *registers
;
136 dma_addr_t self_id_bus
;
138 struct tasklet_struct bus_reset_tasklet
;
141 int request_generation
;
144 /* Spinlock for accessing fw_ohci data. Never call out of
145 * this driver with this lock held. */
147 u32 self_id_buffer
[512];
149 /* Config rom buffers */
151 dma_addr_t config_rom_bus
;
152 __be32
*next_config_rom
;
153 dma_addr_t next_config_rom_bus
;
156 struct ar_context ar_request_ctx
;
157 struct ar_context ar_response_ctx
;
158 struct context at_request_ctx
;
159 struct context at_response_ctx
;
162 struct iso_context
*it_context_list
;
164 struct iso_context
*ir_context_list
;
167 static inline struct fw_ohci
*fw_ohci(struct fw_card
*card
)
169 return container_of(card
, struct fw_ohci
, card
);
172 #define IT_CONTEXT_CYCLE_MATCH_ENABLE 0x80000000
173 #define IR_CONTEXT_BUFFER_FILL 0x80000000
174 #define IR_CONTEXT_ISOCH_HEADER 0x40000000
175 #define IR_CONTEXT_CYCLE_MATCH_ENABLE 0x20000000
176 #define IR_CONTEXT_MULTI_CHANNEL_MODE 0x10000000
177 #define IR_CONTEXT_DUAL_BUFFER_MODE 0x08000000
179 #define CONTEXT_RUN 0x8000
180 #define CONTEXT_WAKE 0x1000
181 #define CONTEXT_DEAD 0x0800
182 #define CONTEXT_ACTIVE 0x0400
184 #define OHCI1394_MAX_AT_REQ_RETRIES 0x2
185 #define OHCI1394_MAX_AT_RESP_RETRIES 0x2
186 #define OHCI1394_MAX_PHYS_RESP_RETRIES 0x8
188 #define FW_OHCI_MAJOR 240
189 #define OHCI1394_REGISTER_SIZE 0x800
190 #define OHCI_LOOP_COUNT 500
191 #define OHCI1394_PCI_HCI_Control 0x40
192 #define SELF_ID_BUF_SIZE 0x800
193 #define OHCI_TCODE_PHY_PACKET 0x0e
194 #define OHCI_VERSION_1_1 0x010010
195 #define ISO_BUFFER_SIZE (64 * 1024)
196 #define AT_BUFFER_SIZE 4096
198 static char ohci_driver_name
[] = KBUILD_MODNAME
;
200 static inline void reg_write(const struct fw_ohci
*ohci
, int offset
, u32 data
)
202 writel(data
, ohci
->registers
+ offset
);
205 static inline u32
reg_read(const struct fw_ohci
*ohci
, int offset
)
207 return readl(ohci
->registers
+ offset
);
210 static inline void flush_writes(const struct fw_ohci
*ohci
)
212 /* Do a dummy read to flush writes. */
213 reg_read(ohci
, OHCI1394_Version
);
217 ohci_update_phy_reg(struct fw_card
*card
, int addr
,
218 int clear_bits
, int set_bits
)
220 struct fw_ohci
*ohci
= fw_ohci(card
);
223 reg_write(ohci
, OHCI1394_PhyControl
, OHCI1394_PhyControl_Read(addr
));
225 val
= reg_read(ohci
, OHCI1394_PhyControl
);
226 if ((val
& OHCI1394_PhyControl_ReadDone
) == 0) {
227 fw_error("failed to set phy reg bits.\n");
231 old
= OHCI1394_PhyControl_ReadData(val
);
232 old
= (old
& ~clear_bits
) | set_bits
;
233 reg_write(ohci
, OHCI1394_PhyControl
,
234 OHCI1394_PhyControl_Write(addr
, old
));
239 static int ar_context_add_page(struct ar_context
*ctx
)
241 struct device
*dev
= ctx
->ohci
->card
.device
;
242 struct ar_buffer
*ab
;
246 ab
= (struct ar_buffer
*) __get_free_page(GFP_ATOMIC
);
250 ab_bus
= dma_map_single(dev
, ab
, PAGE_SIZE
, DMA_BIDIRECTIONAL
);
251 if (dma_mapping_error(ab_bus
)) {
252 free_page((unsigned long) ab
);
256 memset(&ab
->descriptor
, 0, sizeof ab
->descriptor
);
257 ab
->descriptor
.control
= cpu_to_le16(descriptor_input_more
|
259 descriptor_branch_always
);
260 offset
= offsetof(struct ar_buffer
, data
);
261 ab
->descriptor
.req_count
= cpu_to_le16(PAGE_SIZE
- offset
);
262 ab
->descriptor
.data_address
= cpu_to_le32(ab_bus
+ offset
);
263 ab
->descriptor
.res_count
= cpu_to_le16(PAGE_SIZE
- offset
);
264 ab
->descriptor
.branch_address
= 0;
266 dma_sync_single_for_device(dev
, ab_bus
, PAGE_SIZE
, DMA_BIDIRECTIONAL
);
268 ctx
->last_buffer
->descriptor
.branch_address
= ab_bus
| 1;
269 ctx
->last_buffer
->next
= ab
;
270 ctx
->last_buffer
= ab
;
272 reg_write(ctx
->ohci
, control_set(ctx
->regs
), CONTEXT_WAKE
);
273 flush_writes(ctx
->ohci
);
278 static __le32
*handle_ar_packet(struct ar_context
*ctx
, __le32
*buffer
)
280 struct fw_ohci
*ohci
= ctx
->ohci
;
282 u32 status
, length
, tcode
;
284 p
.header
[0] = le32_to_cpu(buffer
[0]);
285 p
.header
[1] = le32_to_cpu(buffer
[1]);
286 p
.header
[2] = le32_to_cpu(buffer
[2]);
288 tcode
= (p
.header
[0] >> 4) & 0x0f;
290 case TCODE_WRITE_QUADLET_REQUEST
:
291 case TCODE_READ_QUADLET_RESPONSE
:
292 p
.header
[3] = (__force __u32
) buffer
[3];
293 p
.header_length
= 16;
294 p
.payload_length
= 0;
297 case TCODE_READ_BLOCK_REQUEST
:
298 p
.header
[3] = le32_to_cpu(buffer
[3]);
299 p
.header_length
= 16;
300 p
.payload_length
= 0;
303 case TCODE_WRITE_BLOCK_REQUEST
:
304 case TCODE_READ_BLOCK_RESPONSE
:
305 case TCODE_LOCK_REQUEST
:
306 case TCODE_LOCK_RESPONSE
:
307 p
.header
[3] = le32_to_cpu(buffer
[3]);
308 p
.header_length
= 16;
309 p
.payload_length
= p
.header
[3] >> 16;
312 case TCODE_WRITE_RESPONSE
:
313 case TCODE_READ_QUADLET_REQUEST
:
314 case OHCI_TCODE_PHY_PACKET
:
315 p
.header_length
= 12;
316 p
.payload_length
= 0;
320 p
.payload
= (void *) buffer
+ p
.header_length
;
322 /* FIXME: What to do about evt_* errors? */
323 length
= (p
.header_length
+ p
.payload_length
+ 3) / 4;
324 status
= le32_to_cpu(buffer
[length
]);
326 p
.ack
= ((status
>> 16) & 0x1f) - 16;
327 p
.speed
= (status
>> 21) & 0x7;
328 p
.timestamp
= status
& 0xffff;
329 p
.generation
= ohci
->request_generation
;
331 /* The OHCI bus reset handler synthesizes a phy packet with
332 * the new generation number when a bus reset happens (see
333 * section 8.4.2.3). This helps us determine when a request
334 * was received and make sure we send the response in the same
335 * generation. We only need this for requests; for responses
336 * we use the unique tlabel for finding the matching
339 if (p
.ack
+ 16 == 0x09)
340 ohci
->request_generation
= (buffer
[2] >> 16) & 0xff;
341 else if (ctx
== &ohci
->ar_request_ctx
)
342 fw_core_handle_request(&ohci
->card
, &p
);
344 fw_core_handle_response(&ohci
->card
, &p
);
346 return buffer
+ length
+ 1;
349 static void ar_context_tasklet(unsigned long data
)
351 struct ar_context
*ctx
= (struct ar_context
*)data
;
352 struct fw_ohci
*ohci
= ctx
->ohci
;
353 struct ar_buffer
*ab
;
354 struct descriptor
*d
;
357 ab
= ctx
->current_buffer
;
360 if (d
->res_count
== 0) {
361 size_t size
, rest
, offset
;
363 /* This descriptor is finished and we may have a
364 * packet split across this and the next buffer. We
365 * reuse the page for reassembling the split packet. */
367 offset
= offsetof(struct ar_buffer
, data
);
368 dma_unmap_single(ohci
->card
.device
,
369 ab
->descriptor
.data_address
- offset
,
370 PAGE_SIZE
, DMA_BIDIRECTIONAL
);
375 size
= buffer
+ PAGE_SIZE
- ctx
->pointer
;
376 rest
= le16_to_cpu(d
->req_count
) - le16_to_cpu(d
->res_count
);
377 memmove(buffer
, ctx
->pointer
, size
);
378 memcpy(buffer
+ size
, ab
->data
, rest
);
379 ctx
->current_buffer
= ab
;
380 ctx
->pointer
= (void *) ab
->data
+ rest
;
381 end
= buffer
+ size
+ rest
;
384 buffer
= handle_ar_packet(ctx
, buffer
);
386 free_page((unsigned long)buffer
);
387 ar_context_add_page(ctx
);
389 buffer
= ctx
->pointer
;
391 (void *) ab
+ PAGE_SIZE
- le16_to_cpu(d
->res_count
);
394 buffer
= handle_ar_packet(ctx
, buffer
);
399 ar_context_init(struct ar_context
*ctx
, struct fw_ohci
*ohci
, u32 regs
)
405 ctx
->last_buffer
= &ab
;
406 tasklet_init(&ctx
->tasklet
, ar_context_tasklet
, (unsigned long)ctx
);
408 ar_context_add_page(ctx
);
409 ar_context_add_page(ctx
);
410 ctx
->current_buffer
= ab
.next
;
411 ctx
->pointer
= ctx
->current_buffer
->data
;
413 reg_write(ctx
->ohci
, command_ptr(ctx
->regs
), ab
.descriptor
.branch_address
);
414 reg_write(ctx
->ohci
, control_set(ctx
->regs
), CONTEXT_RUN
);
415 flush_writes(ctx
->ohci
);
420 static void context_tasklet(unsigned long data
)
422 struct context
*ctx
= (struct context
*) data
;
423 struct fw_ohci
*ohci
= ctx
->ohci
;
424 struct descriptor
*d
, *last
;
428 dma_sync_single_for_cpu(ohci
->card
.device
, ctx
->buffer_bus
,
429 ctx
->buffer_size
, DMA_TO_DEVICE
);
431 d
= ctx
->tail_descriptor
;
432 last
= ctx
->tail_descriptor_last
;
434 while (last
->branch_address
!= 0) {
435 address
= le32_to_cpu(last
->branch_address
);
437 d
= ctx
->buffer
+ (address
- ctx
->buffer_bus
) / sizeof *d
;
438 last
= (z
== 2) ? d
: d
+ z
- 1;
440 if (!ctx
->callback(ctx
, d
, last
))
443 ctx
->tail_descriptor
= d
;
444 ctx
->tail_descriptor_last
= last
;
449 context_init(struct context
*ctx
, struct fw_ohci
*ohci
,
450 size_t buffer_size
, u32 regs
,
451 descriptor_callback_t callback
)
455 ctx
->buffer_size
= buffer_size
;
456 ctx
->buffer
= kmalloc(buffer_size
, GFP_KERNEL
);
457 if (ctx
->buffer
== NULL
)
460 tasklet_init(&ctx
->tasklet
, context_tasklet
, (unsigned long)ctx
);
461 ctx
->callback
= callback
;
464 dma_map_single(ohci
->card
.device
, ctx
->buffer
,
465 buffer_size
, DMA_TO_DEVICE
);
466 if (dma_mapping_error(ctx
->buffer_bus
)) {
471 ctx
->head_descriptor
= ctx
->buffer
;
472 ctx
->prev_descriptor
= ctx
->buffer
;
473 ctx
->tail_descriptor
= ctx
->buffer
;
474 ctx
->tail_descriptor_last
= ctx
->buffer
;
476 /* We put a dummy descriptor in the buffer that has a NULL
477 * branch address and looks like it's been sent. That way we
478 * have a descriptor to append DMA programs to. Also, the
479 * ring buffer invariant is that it always has at least one
480 * element so that head == tail means buffer full. */
482 memset(ctx
->head_descriptor
, 0, sizeof *ctx
->head_descriptor
);
483 ctx
->head_descriptor
->control
= cpu_to_le16(descriptor_output_last
);
484 ctx
->head_descriptor
->transfer_status
= cpu_to_le16(0x8011);
485 ctx
->head_descriptor
++;
491 context_release(struct context
*ctx
)
493 struct fw_card
*card
= &ctx
->ohci
->card
;
495 dma_unmap_single(card
->device
, ctx
->buffer_bus
,
496 ctx
->buffer_size
, DMA_TO_DEVICE
);
500 static struct descriptor
*
501 context_get_descriptors(struct context
*ctx
, int z
, dma_addr_t
*d_bus
)
503 struct descriptor
*d
, *tail
, *end
;
505 d
= ctx
->head_descriptor
;
506 tail
= ctx
->tail_descriptor
;
507 end
= ctx
->buffer
+ ctx
->buffer_size
/ sizeof(struct descriptor
);
511 } else if (d
> tail
&& d
+ z
<= end
) {
513 } else if (d
> tail
&& ctx
->buffer
+ z
<= tail
) {
521 memset(d
, 0, z
* sizeof *d
);
522 *d_bus
= ctx
->buffer_bus
+ (d
- ctx
->buffer
) * sizeof *d
;
527 static void context_run(struct context
*ctx
, u32 extra
)
529 struct fw_ohci
*ohci
= ctx
->ohci
;
531 reg_write(ohci
, command_ptr(ctx
->regs
),
532 le32_to_cpu(ctx
->tail_descriptor_last
->branch_address
));
533 reg_write(ohci
, control_clear(ctx
->regs
), ~0);
534 reg_write(ohci
, control_set(ctx
->regs
), CONTEXT_RUN
| extra
);
538 static void context_append(struct context
*ctx
,
539 struct descriptor
*d
, int z
, int extra
)
543 d_bus
= ctx
->buffer_bus
+ (d
- ctx
->buffer
) * sizeof *d
;
545 ctx
->head_descriptor
= d
+ z
+ extra
;
546 ctx
->prev_descriptor
->branch_address
= cpu_to_le32(d_bus
| z
);
547 ctx
->prev_descriptor
= z
== 2 ? d
: d
+ z
- 1;
549 dma_sync_single_for_device(ctx
->ohci
->card
.device
, ctx
->buffer_bus
,
550 ctx
->buffer_size
, DMA_TO_DEVICE
);
552 reg_write(ctx
->ohci
, control_set(ctx
->regs
), CONTEXT_WAKE
);
553 flush_writes(ctx
->ohci
);
556 static void context_stop(struct context
*ctx
)
561 reg_write(ctx
->ohci
, control_clear(ctx
->regs
), CONTEXT_RUN
);
562 flush_writes(ctx
->ohci
);
564 for (i
= 0; i
< 10; i
++) {
565 reg
= reg_read(ctx
->ohci
, control_set(ctx
->regs
));
566 if ((reg
& CONTEXT_ACTIVE
) == 0)
569 fw_notify("context_stop: still active (0x%08x)\n", reg
);
575 struct fw_packet
*packet
;
578 /* This function apppends a packet to the DMA queue for transmission.
579 * Must always be called with the ochi->lock held to ensure proper
580 * generation handling and locking around packet queue manipulation. */
582 at_context_queue_packet(struct context
*ctx
, struct fw_packet
*packet
)
584 struct fw_ohci
*ohci
= ctx
->ohci
;
585 dma_addr_t d_bus
, payload_bus
;
586 struct driver_data
*driver_data
;
587 struct descriptor
*d
, *last
;
592 d
= context_get_descriptors(ctx
, 4, &d_bus
);
594 packet
->ack
= RCODE_SEND_ERROR
;
598 d
[0].control
= cpu_to_le16(descriptor_key_immediate
);
599 d
[0].res_count
= cpu_to_le16(packet
->timestamp
);
601 /* The DMA format for asyncronous link packets is different
602 * from the IEEE1394 layout, so shift the fields around
603 * accordingly. If header_length is 8, it's a PHY packet, to
604 * which we need to prepend an extra quadlet. */
606 header
= (__le32
*) &d
[1];
607 if (packet
->header_length
> 8) {
608 header
[0] = cpu_to_le32((packet
->header
[0] & 0xffff) |
609 (packet
->speed
<< 16));
610 header
[1] = cpu_to_le32((packet
->header
[1] & 0xffff) |
611 (packet
->header
[0] & 0xffff0000));
612 header
[2] = cpu_to_le32(packet
->header
[2]);
614 tcode
= (packet
->header
[0] >> 4) & 0x0f;
615 if (TCODE_IS_BLOCK_PACKET(tcode
))
616 header
[3] = cpu_to_le32(packet
->header
[3]);
618 header
[3] = (__force __le32
) packet
->header
[3];
620 d
[0].req_count
= cpu_to_le16(packet
->header_length
);
622 header
[0] = cpu_to_le32((OHCI1394_phy_tcode
<< 4) |
623 (packet
->speed
<< 16));
624 header
[1] = cpu_to_le32(packet
->header
[0]);
625 header
[2] = cpu_to_le32(packet
->header
[1]);
626 d
[0].req_count
= cpu_to_le16(12);
629 driver_data
= (struct driver_data
*) &d
[3];
630 driver_data
->packet
= packet
;
632 if (packet
->payload_length
> 0) {
634 dma_map_single(ohci
->card
.device
, packet
->payload
,
635 packet
->payload_length
, DMA_TO_DEVICE
);
636 if (dma_mapping_error(payload_bus
)) {
637 packet
->ack
= RCODE_SEND_ERROR
;
641 d
[2].req_count
= cpu_to_le16(packet
->payload_length
);
642 d
[2].data_address
= cpu_to_le32(payload_bus
);
650 last
->control
|= cpu_to_le16(descriptor_output_last
|
651 descriptor_irq_always
|
652 descriptor_branch_always
);
654 /* FIXME: Document how the locking works. */
655 if (ohci
->generation
!= packet
->generation
) {
656 packet
->ack
= RCODE_GENERATION
;
660 context_append(ctx
, d
, z
, 4 - z
);
662 /* If the context isn't already running, start it up. */
663 reg
= reg_read(ctx
->ohci
, control_set(ctx
->regs
));
664 if ((reg
& CONTEXT_ACTIVE
) == 0)
670 static int handle_at_packet(struct context
*context
,
671 struct descriptor
*d
,
672 struct descriptor
*last
)
674 struct driver_data
*driver_data
;
675 struct fw_packet
*packet
;
676 struct fw_ohci
*ohci
= context
->ohci
;
677 dma_addr_t payload_bus
;
680 if (last
->transfer_status
== 0)
681 /* This descriptor isn't done yet, stop iteration. */
684 driver_data
= (struct driver_data
*) &d
[3];
685 packet
= driver_data
->packet
;
687 /* This packet was cancelled, just continue. */
690 payload_bus
= le32_to_cpu(last
->data_address
);
691 if (payload_bus
!= 0)
692 dma_unmap_single(ohci
->card
.device
, payload_bus
,
693 packet
->payload_length
, DMA_TO_DEVICE
);
695 evt
= le16_to_cpu(last
->transfer_status
) & 0x1f;
696 packet
->timestamp
= le16_to_cpu(last
->res_count
);
699 case OHCI1394_evt_timeout
:
700 /* Async response transmit timed out. */
701 packet
->ack
= RCODE_CANCELLED
;
704 case OHCI1394_evt_flushed
:
705 /* The packet was flushed should give same error as
706 * when we try to use a stale generation count. */
707 packet
->ack
= RCODE_GENERATION
;
710 case OHCI1394_evt_missing_ack
:
711 /* Using a valid (current) generation count, but the
712 * node is not on the bus or not sending acks. */
713 packet
->ack
= RCODE_NO_ACK
;
716 case ACK_COMPLETE
+ 0x10:
717 case ACK_PENDING
+ 0x10:
718 case ACK_BUSY_X
+ 0x10:
719 case ACK_BUSY_A
+ 0x10:
720 case ACK_BUSY_B
+ 0x10:
721 case ACK_DATA_ERROR
+ 0x10:
722 case ACK_TYPE_ERROR
+ 0x10:
723 packet
->ack
= evt
- 0x10;
727 packet
->ack
= RCODE_SEND_ERROR
;
731 packet
->callback(packet
, &ohci
->card
, packet
->ack
);
736 #define header_get_destination(q) (((q) >> 16) & 0xffff)
737 #define header_get_tcode(q) (((q) >> 4) & 0x0f)
738 #define header_get_offset_high(q) (((q) >> 0) & 0xffff)
739 #define header_get_data_length(q) (((q) >> 16) & 0xffff)
740 #define header_get_extended_tcode(q) (((q) >> 0) & 0xffff)
743 handle_local_rom(struct fw_ohci
*ohci
, struct fw_packet
*packet
, u32 csr
)
745 struct fw_packet response
;
746 int tcode
, length
, i
;
748 tcode
= header_get_tcode(packet
->header
[0]);
749 if (TCODE_IS_BLOCK_PACKET(tcode
))
750 length
= header_get_data_length(packet
->header
[3]);
754 i
= csr
- CSR_CONFIG_ROM
;
755 if (i
+ length
> CONFIG_ROM_SIZE
) {
756 fw_fill_response(&response
, packet
->header
,
757 RCODE_ADDRESS_ERROR
, NULL
, 0);
758 } else if (!TCODE_IS_READ_REQUEST(tcode
)) {
759 fw_fill_response(&response
, packet
->header
,
760 RCODE_TYPE_ERROR
, NULL
, 0);
762 fw_fill_response(&response
, packet
->header
, RCODE_COMPLETE
,
763 (void *) ohci
->config_rom
+ i
, length
);
766 fw_core_handle_response(&ohci
->card
, &response
);
770 handle_local_lock(struct fw_ohci
*ohci
, struct fw_packet
*packet
, u32 csr
)
772 struct fw_packet response
;
773 int tcode
, length
, ext_tcode
, sel
;
774 __be32
*payload
, lock_old
;
775 u32 lock_arg
, lock_data
;
777 tcode
= header_get_tcode(packet
->header
[0]);
778 length
= header_get_data_length(packet
->header
[3]);
779 payload
= packet
->payload
;
780 ext_tcode
= header_get_extended_tcode(packet
->header
[3]);
782 if (tcode
== TCODE_LOCK_REQUEST
&&
783 ext_tcode
== EXTCODE_COMPARE_SWAP
&& length
== 8) {
784 lock_arg
= be32_to_cpu(payload
[0]);
785 lock_data
= be32_to_cpu(payload
[1]);
786 } else if (tcode
== TCODE_READ_QUADLET_REQUEST
) {
790 fw_fill_response(&response
, packet
->header
,
791 RCODE_TYPE_ERROR
, NULL
, 0);
795 sel
= (csr
- CSR_BUS_MANAGER_ID
) / 4;
796 reg_write(ohci
, OHCI1394_CSRData
, lock_data
);
797 reg_write(ohci
, OHCI1394_CSRCompareData
, lock_arg
);
798 reg_write(ohci
, OHCI1394_CSRControl
, sel
);
800 if (reg_read(ohci
, OHCI1394_CSRControl
) & 0x80000000)
801 lock_old
= cpu_to_be32(reg_read(ohci
, OHCI1394_CSRData
));
803 fw_notify("swap not done yet\n");
805 fw_fill_response(&response
, packet
->header
,
806 RCODE_COMPLETE
, &lock_old
, sizeof lock_old
);
808 fw_core_handle_response(&ohci
->card
, &response
);
812 handle_local_request(struct context
*ctx
, struct fw_packet
*packet
)
817 if (ctx
== &ctx
->ohci
->at_request_ctx
) {
818 packet
->ack
= ACK_PENDING
;
819 packet
->callback(packet
, &ctx
->ohci
->card
, packet
->ack
);
823 ((unsigned long long)
824 header_get_offset_high(packet
->header
[1]) << 32) |
826 csr
= offset
- CSR_REGISTER_BASE
;
828 /* Handle config rom reads. */
829 if (csr
>= CSR_CONFIG_ROM
&& csr
< CSR_CONFIG_ROM_END
)
830 handle_local_rom(ctx
->ohci
, packet
, csr
);
832 case CSR_BUS_MANAGER_ID
:
833 case CSR_BANDWIDTH_AVAILABLE
:
834 case CSR_CHANNELS_AVAILABLE_HI
:
835 case CSR_CHANNELS_AVAILABLE_LO
:
836 handle_local_lock(ctx
->ohci
, packet
, csr
);
839 if (ctx
== &ctx
->ohci
->at_request_ctx
)
840 fw_core_handle_request(&ctx
->ohci
->card
, packet
);
842 fw_core_handle_response(&ctx
->ohci
->card
, packet
);
846 if (ctx
== &ctx
->ohci
->at_response_ctx
) {
847 packet
->ack
= ACK_COMPLETE
;
848 packet
->callback(packet
, &ctx
->ohci
->card
, packet
->ack
);
853 at_context_transmit(struct context
*ctx
, struct fw_packet
*packet
)
858 spin_lock_irqsave(&ctx
->ohci
->lock
, flags
);
860 if (header_get_destination(packet
->header
[0]) == ctx
->ohci
->node_id
&&
861 ctx
->ohci
->generation
== packet
->generation
) {
862 spin_unlock_irqrestore(&ctx
->ohci
->lock
, flags
);
863 handle_local_request(ctx
, packet
);
867 retval
= at_context_queue_packet(ctx
, packet
);
868 spin_unlock_irqrestore(&ctx
->ohci
->lock
, flags
);
871 packet
->callback(packet
, &ctx
->ohci
->card
, packet
->ack
);
875 static void bus_reset_tasklet(unsigned long data
)
877 struct fw_ohci
*ohci
= (struct fw_ohci
*)data
;
878 int self_id_count
, i
, j
, reg
;
879 int generation
, new_generation
;
882 reg
= reg_read(ohci
, OHCI1394_NodeID
);
883 if (!(reg
& OHCI1394_NodeID_idValid
)) {
884 fw_error("node ID not valid, new bus reset in progress\n");
887 ohci
->node_id
= reg
& 0xffff;
889 /* The count in the SelfIDCount register is the number of
890 * bytes in the self ID receive buffer. Since we also receive
891 * the inverted quadlets and a header quadlet, we shift one
892 * bit extra to get the actual number of self IDs. */
894 self_id_count
= (reg_read(ohci
, OHCI1394_SelfIDCount
) >> 3) & 0x3ff;
895 generation
= (le32_to_cpu(ohci
->self_id_cpu
[0]) >> 16) & 0xff;
897 for (i
= 1, j
= 0; j
< self_id_count
; i
+= 2, j
++) {
898 if (ohci
->self_id_cpu
[i
] != ~ohci
->self_id_cpu
[i
+ 1])
899 fw_error("inconsistent self IDs\n");
900 ohci
->self_id_buffer
[j
] = le32_to_cpu(ohci
->self_id_cpu
[i
]);
903 /* Check the consistency of the self IDs we just read. The
904 * problem we face is that a new bus reset can start while we
905 * read out the self IDs from the DMA buffer. If this happens,
906 * the DMA buffer will be overwritten with new self IDs and we
907 * will read out inconsistent data. The OHCI specification
908 * (section 11.2) recommends a technique similar to
909 * linux/seqlock.h, where we remember the generation of the
910 * self IDs in the buffer before reading them out and compare
911 * it to the current generation after reading them out. If
912 * the two generations match we know we have a consistent set
915 new_generation
= (reg_read(ohci
, OHCI1394_SelfIDCount
) >> 16) & 0xff;
916 if (new_generation
!= generation
) {
917 fw_notify("recursive bus reset detected, "
918 "discarding self ids\n");
922 /* FIXME: Document how the locking works. */
923 spin_lock_irqsave(&ohci
->lock
, flags
);
925 ohci
->generation
= generation
;
926 context_stop(&ohci
->at_request_ctx
);
927 context_stop(&ohci
->at_response_ctx
);
928 reg_write(ohci
, OHCI1394_IntEventClear
, OHCI1394_busReset
);
930 /* This next bit is unrelated to the AT context stuff but we
931 * have to do it under the spinlock also. If a new config rom
932 * was set up before this reset, the old one is now no longer
933 * in use and we can free it. Update the config rom pointers
934 * to point to the current config rom and clear the
935 * next_config_rom pointer so a new udpate can take place. */
937 if (ohci
->next_config_rom
!= NULL
) {
938 dma_free_coherent(ohci
->card
.device
, CONFIG_ROM_SIZE
,
939 ohci
->config_rom
, ohci
->config_rom_bus
);
940 ohci
->config_rom
= ohci
->next_config_rom
;
941 ohci
->config_rom_bus
= ohci
->next_config_rom_bus
;
942 ohci
->next_config_rom
= NULL
;
944 /* Restore config_rom image and manually update
945 * config_rom registers. Writing the header quadlet
946 * will indicate that the config rom is ready, so we
948 reg_write(ohci
, OHCI1394_BusOptions
,
949 be32_to_cpu(ohci
->config_rom
[2]));
950 ohci
->config_rom
[0] = cpu_to_be32(ohci
->next_header
);
951 reg_write(ohci
, OHCI1394_ConfigROMhdr
, ohci
->next_header
);
954 spin_unlock_irqrestore(&ohci
->lock
, flags
);
956 fw_core_handle_bus_reset(&ohci
->card
, ohci
->node_id
, generation
,
957 self_id_count
, ohci
->self_id_buffer
);
960 static irqreturn_t
irq_handler(int irq
, void *data
)
962 struct fw_ohci
*ohci
= data
;
963 u32 event
, iso_event
, cycle_time
;
966 event
= reg_read(ohci
, OHCI1394_IntEventClear
);
971 reg_write(ohci
, OHCI1394_IntEventClear
, event
);
973 if (event
& OHCI1394_selfIDComplete
)
974 tasklet_schedule(&ohci
->bus_reset_tasklet
);
976 if (event
& OHCI1394_RQPkt
)
977 tasklet_schedule(&ohci
->ar_request_ctx
.tasklet
);
979 if (event
& OHCI1394_RSPkt
)
980 tasklet_schedule(&ohci
->ar_response_ctx
.tasklet
);
982 if (event
& OHCI1394_reqTxComplete
)
983 tasklet_schedule(&ohci
->at_request_ctx
.tasklet
);
985 if (event
& OHCI1394_respTxComplete
)
986 tasklet_schedule(&ohci
->at_response_ctx
.tasklet
);
988 iso_event
= reg_read(ohci
, OHCI1394_IsoRecvIntEventClear
);
989 reg_write(ohci
, OHCI1394_IsoRecvIntEventClear
, iso_event
);
992 i
= ffs(iso_event
) - 1;
993 tasklet_schedule(&ohci
->ir_context_list
[i
].context
.tasklet
);
994 iso_event
&= ~(1 << i
);
997 iso_event
= reg_read(ohci
, OHCI1394_IsoXmitIntEventClear
);
998 reg_write(ohci
, OHCI1394_IsoXmitIntEventClear
, iso_event
);
1001 i
= ffs(iso_event
) - 1;
1002 tasklet_schedule(&ohci
->it_context_list
[i
].context
.tasklet
);
1003 iso_event
&= ~(1 << i
);
1006 if (event
& OHCI1394_cycle64Seconds
) {
1007 cycle_time
= reg_read(ohci
, OHCI1394_IsochronousCycleTimer
);
1008 if ((cycle_time
& 0x80000000) == 0)
1009 ohci
->bus_seconds
++;
1015 static int ohci_enable(struct fw_card
*card
, u32
*config_rom
, size_t length
)
1017 struct fw_ohci
*ohci
= fw_ohci(card
);
1018 struct pci_dev
*dev
= to_pci_dev(card
->device
);
1020 /* When the link is not yet enabled, the atomic config rom
1021 * update mechanism described below in ohci_set_config_rom()
1022 * is not active. We have to update ConfigRomHeader and
1023 * BusOptions manually, and the write to ConfigROMmap takes
1024 * effect immediately. We tie this to the enabling of the
1025 * link, so we have a valid config rom before enabling - the
1026 * OHCI requires that ConfigROMhdr and BusOptions have valid
1027 * values before enabling.
1029 * However, when the ConfigROMmap is written, some controllers
1030 * always read back quadlets 0 and 2 from the config rom to
1031 * the ConfigRomHeader and BusOptions registers on bus reset.
1032 * They shouldn't do that in this initial case where the link
1033 * isn't enabled. This means we have to use the same
1034 * workaround here, setting the bus header to 0 and then write
1035 * the right values in the bus reset tasklet.
1038 ohci
->next_config_rom
=
1039 dma_alloc_coherent(ohci
->card
.device
, CONFIG_ROM_SIZE
,
1040 &ohci
->next_config_rom_bus
, GFP_KERNEL
);
1041 if (ohci
->next_config_rom
== NULL
)
1044 memset(ohci
->next_config_rom
, 0, CONFIG_ROM_SIZE
);
1045 fw_memcpy_to_be32(ohci
->next_config_rom
, config_rom
, length
* 4);
1047 ohci
->next_header
= config_rom
[0];
1048 ohci
->next_config_rom
[0] = 0;
1049 reg_write(ohci
, OHCI1394_ConfigROMhdr
, 0);
1050 reg_write(ohci
, OHCI1394_BusOptions
, config_rom
[2]);
1051 reg_write(ohci
, OHCI1394_ConfigROMmap
, ohci
->next_config_rom_bus
);
1053 reg_write(ohci
, OHCI1394_AsReqFilterHiSet
, 0x80000000);
1055 if (request_irq(dev
->irq
, irq_handler
,
1056 IRQF_SHARED
, ohci_driver_name
, ohci
)) {
1057 fw_error("Failed to allocate shared interrupt %d.\n",
1059 dma_free_coherent(ohci
->card
.device
, CONFIG_ROM_SIZE
,
1060 ohci
->config_rom
, ohci
->config_rom_bus
);
1064 reg_write(ohci
, OHCI1394_HCControlSet
,
1065 OHCI1394_HCControl_linkEnable
|
1066 OHCI1394_HCControl_BIBimageValid
);
1069 /* We are ready to go, initiate bus reset to finish the
1070 * initialization. */
1072 fw_core_initiate_bus_reset(&ohci
->card
, 1);
1078 ohci_set_config_rom(struct fw_card
*card
, u32
*config_rom
, size_t length
)
1080 struct fw_ohci
*ohci
;
1081 unsigned long flags
;
1083 __be32
*next_config_rom
;
1084 dma_addr_t next_config_rom_bus
;
1086 ohci
= fw_ohci(card
);
1088 /* When the OHCI controller is enabled, the config rom update
1089 * mechanism is a bit tricky, but easy enough to use. See
1090 * section 5.5.6 in the OHCI specification.
1092 * The OHCI controller caches the new config rom address in a
1093 * shadow register (ConfigROMmapNext) and needs a bus reset
1094 * for the changes to take place. When the bus reset is
1095 * detected, the controller loads the new values for the
1096 * ConfigRomHeader and BusOptions registers from the specified
1097 * config rom and loads ConfigROMmap from the ConfigROMmapNext
1098 * shadow register. All automatically and atomically.
1100 * Now, there's a twist to this story. The automatic load of
1101 * ConfigRomHeader and BusOptions doesn't honor the
1102 * noByteSwapData bit, so with a be32 config rom, the
1103 * controller will load be32 values in to these registers
1104 * during the atomic update, even on litte endian
1105 * architectures. The workaround we use is to put a 0 in the
1106 * header quadlet; 0 is endian agnostic and means that the
1107 * config rom isn't ready yet. In the bus reset tasklet we
1108 * then set up the real values for the two registers.
1110 * We use ohci->lock to avoid racing with the code that sets
1111 * ohci->next_config_rom to NULL (see bus_reset_tasklet).
1115 dma_alloc_coherent(ohci
->card
.device
, CONFIG_ROM_SIZE
,
1116 &next_config_rom_bus
, GFP_KERNEL
);
1117 if (next_config_rom
== NULL
)
1120 spin_lock_irqsave(&ohci
->lock
, flags
);
1122 if (ohci
->next_config_rom
== NULL
) {
1123 ohci
->next_config_rom
= next_config_rom
;
1124 ohci
->next_config_rom_bus
= next_config_rom_bus
;
1126 memset(ohci
->next_config_rom
, 0, CONFIG_ROM_SIZE
);
1127 fw_memcpy_to_be32(ohci
->next_config_rom
, config_rom
,
1130 ohci
->next_header
= config_rom
[0];
1131 ohci
->next_config_rom
[0] = 0;
1133 reg_write(ohci
, OHCI1394_ConfigROMmap
,
1134 ohci
->next_config_rom_bus
);
1136 dma_free_coherent(ohci
->card
.device
, CONFIG_ROM_SIZE
,
1137 next_config_rom
, next_config_rom_bus
);
1141 spin_unlock_irqrestore(&ohci
->lock
, flags
);
1143 /* Now initiate a bus reset to have the changes take
1144 * effect. We clean up the old config rom memory and DMA
1145 * mappings in the bus reset tasklet, since the OHCI
1146 * controller could need to access it before the bus reset
1149 fw_core_initiate_bus_reset(&ohci
->card
, 1);
1154 static void ohci_send_request(struct fw_card
*card
, struct fw_packet
*packet
)
1156 struct fw_ohci
*ohci
= fw_ohci(card
);
1158 at_context_transmit(&ohci
->at_request_ctx
, packet
);
1161 static void ohci_send_response(struct fw_card
*card
, struct fw_packet
*packet
)
1163 struct fw_ohci
*ohci
= fw_ohci(card
);
1165 at_context_transmit(&ohci
->at_response_ctx
, packet
);
1168 static int ohci_cancel_packet(struct fw_card
*card
, struct fw_packet
*packet
)
1170 struct fw_ohci
*ohci
= fw_ohci(card
);
1171 struct context
*ctx
= &ohci
->at_request_ctx
;
1172 struct driver_data
*driver_data
= packet
->driver_data
;
1173 int retval
= -ENOENT
;
1175 tasklet_disable(&ctx
->tasklet
);
1177 if (packet
->ack
!= 0)
1180 driver_data
->packet
= NULL
;
1181 packet
->ack
= RCODE_CANCELLED
;
1182 packet
->callback(packet
, &ohci
->card
, packet
->ack
);
1186 tasklet_enable(&ctx
->tasklet
);
1192 ohci_enable_phys_dma(struct fw_card
*card
, int node_id
, int generation
)
1194 struct fw_ohci
*ohci
= fw_ohci(card
);
1195 unsigned long flags
;
1198 /* FIXME: Make sure this bitmask is cleared when we clear the busReset
1199 * interrupt bit. Clear physReqResourceAllBuses on bus reset. */
1201 spin_lock_irqsave(&ohci
->lock
, flags
);
1203 if (ohci
->generation
!= generation
) {
1208 /* NOTE, if the node ID contains a non-local bus ID, physical DMA is
1209 * enabled for _all_ nodes on remote buses. */
1211 n
= (node_id
& 0xffc0) == LOCAL_BUS
? node_id
& 0x3f : 63;
1213 reg_write(ohci
, OHCI1394_PhyReqFilterLoSet
, 1 << n
);
1215 reg_write(ohci
, OHCI1394_PhyReqFilterHiSet
, 1 << (n
- 32));
1219 spin_unlock_irqrestore(&ohci
->lock
, flags
);
1224 ohci_get_bus_time(struct fw_card
*card
)
1226 struct fw_ohci
*ohci
= fw_ohci(card
);
1230 cycle_time
= reg_read(ohci
, OHCI1394_IsochronousCycleTimer
);
1231 bus_time
= ((u64
) ohci
->bus_seconds
<< 32) | cycle_time
;
1236 static int handle_ir_bufferfill_packet(struct context
*context
,
1237 struct descriptor
*d
,
1238 struct descriptor
*last
)
1240 struct iso_context
*ctx
=
1241 container_of(context
, struct iso_context
, context
);
1243 if (d
->res_count
> 0)
1246 if (le16_to_cpu(last
->control
) & descriptor_irq_always
)
1247 ctx
->base
.callback(&ctx
->base
,
1248 le16_to_cpu(last
->res_count
),
1249 0, NULL
, ctx
->base
.callback_data
);
1254 static int handle_ir_dualbuffer_packet(struct context
*context
,
1255 struct descriptor
*d
,
1256 struct descriptor
*last
)
1258 struct iso_context
*ctx
=
1259 container_of(context
, struct iso_context
, context
);
1260 struct db_descriptor
*db
= (struct db_descriptor
*) d
;
1261 size_t header_length
;
1263 if (db
->first_res_count
> 0 && db
->second_res_count
> 0)
1264 /* This descriptor isn't done yet, stop iteration. */
1267 header_length
= db
->first_req_count
- db
->first_res_count
;
1268 if (ctx
->header_length
+ header_length
<= PAGE_SIZE
)
1269 memcpy(ctx
->header
+ ctx
->header_length
, db
+ 1, header_length
);
1270 ctx
->header_length
+= header_length
;
1272 if (le16_to_cpu(db
->control
) & descriptor_irq_always
) {
1273 ctx
->base
.callback(&ctx
->base
, 0,
1274 ctx
->header_length
, ctx
->header
,
1275 ctx
->base
.callback_data
);
1276 ctx
->header_length
= 0;
1282 static int handle_it_packet(struct context
*context
,
1283 struct descriptor
*d
,
1284 struct descriptor
*last
)
1286 struct iso_context
*ctx
=
1287 container_of(context
, struct iso_context
, context
);
1289 if (last
->transfer_status
== 0)
1290 /* This descriptor isn't done yet, stop iteration. */
1293 if (le16_to_cpu(last
->control
) & descriptor_irq_always
)
1294 ctx
->base
.callback(&ctx
->base
, le16_to_cpu(last
->res_count
),
1295 0, NULL
, ctx
->base
.callback_data
);
1300 static struct fw_iso_context
*
1301 ohci_allocate_iso_context(struct fw_card
*card
, int type
,
1302 int sync
, int tags
, size_t header_size
)
1304 struct fw_ohci
*ohci
= fw_ohci(card
);
1305 struct iso_context
*ctx
, *list
;
1306 descriptor_callback_t callback
;
1308 unsigned long flags
;
1309 int index
, retval
= -ENOMEM
;
1311 if (type
== FW_ISO_CONTEXT_TRANSMIT
) {
1312 mask
= &ohci
->it_context_mask
;
1313 list
= ohci
->it_context_list
;
1314 callback
= handle_it_packet
;
1316 mask
= &ohci
->ir_context_mask
;
1317 list
= ohci
->ir_context_list
;
1318 if (header_size
> 0)
1319 callback
= handle_ir_dualbuffer_packet
;
1321 callback
= handle_ir_bufferfill_packet
;
1324 if (callback
== handle_ir_dualbuffer_packet
&&
1325 ohci
->version
< OHCI_VERSION_1_1
)
1326 return ERR_PTR(-EINVAL
);
1328 spin_lock_irqsave(&ohci
->lock
, flags
);
1329 index
= ffs(*mask
) - 1;
1331 *mask
&= ~(1 << index
);
1332 spin_unlock_irqrestore(&ohci
->lock
, flags
);
1335 return ERR_PTR(-EBUSY
);
1337 if (type
== FW_ISO_CONTEXT_TRANSMIT
)
1338 regs
= OHCI1394_IsoXmitContextBase(index
);
1340 regs
= OHCI1394_IsoRcvContextBase(index
);
1343 memset(ctx
, 0, sizeof *ctx
);
1344 ctx
->header_length
= 0;
1345 ctx
->header
= (void *) __get_free_page(GFP_KERNEL
);
1346 if (ctx
->header
== NULL
)
1349 retval
= context_init(&ctx
->context
, ohci
, ISO_BUFFER_SIZE
,
1352 goto out_with_header
;
1357 free_page((unsigned long)ctx
->header
);
1359 spin_lock_irqsave(&ohci
->lock
, flags
);
1360 *mask
|= 1 << index
;
1361 spin_unlock_irqrestore(&ohci
->lock
, flags
);
1363 return ERR_PTR(retval
);
1366 static int ohci_start_iso(struct fw_iso_context
*base
, s32 cycle
)
1368 struct iso_context
*ctx
= container_of(base
, struct iso_context
, base
);
1369 struct fw_ohci
*ohci
= ctx
->context
.ohci
;
1370 u32 cycle_match
= 0, mode
;
1373 if (ctx
->base
.type
== FW_ISO_CONTEXT_TRANSMIT
) {
1374 index
= ctx
- ohci
->it_context_list
;
1376 cycle_match
= IT_CONTEXT_CYCLE_MATCH_ENABLE
|
1377 (cycle
& 0x7fff) << 16;
1379 reg_write(ohci
, OHCI1394_IsoXmitIntEventClear
, 1 << index
);
1380 reg_write(ohci
, OHCI1394_IsoXmitIntMaskSet
, 1 << index
);
1381 context_run(&ctx
->context
, cycle_match
);
1383 index
= ctx
- ohci
->ir_context_list
;
1385 if (ctx
->base
.header_size
> 0)
1386 mode
= IR_CONTEXT_DUAL_BUFFER_MODE
;
1388 mode
= IR_CONTEXT_BUFFER_FILL
;
1389 reg_write(ohci
, OHCI1394_IsoRecvIntEventClear
, 1 << index
);
1390 reg_write(ohci
, OHCI1394_IsoRecvIntMaskSet
, 1 << index
);
1391 reg_write(ohci
, context_match(ctx
->context
.regs
),
1392 (ctx
->base
.tags
<< 28) |
1393 (ctx
->base
.sync
<< 8) | ctx
->base
.channel
);
1394 context_run(&ctx
->context
, mode
);
1400 static int ohci_stop_iso(struct fw_iso_context
*base
)
1402 struct fw_ohci
*ohci
= fw_ohci(base
->card
);
1403 struct iso_context
*ctx
= container_of(base
, struct iso_context
, base
);
1406 if (ctx
->base
.type
== FW_ISO_CONTEXT_TRANSMIT
) {
1407 index
= ctx
- ohci
->it_context_list
;
1408 reg_write(ohci
, OHCI1394_IsoXmitIntMaskClear
, 1 << index
);
1410 index
= ctx
- ohci
->ir_context_list
;
1411 reg_write(ohci
, OHCI1394_IsoRecvIntMaskClear
, 1 << index
);
1414 context_stop(&ctx
->context
);
1419 static void ohci_free_iso_context(struct fw_iso_context
*base
)
1421 struct fw_ohci
*ohci
= fw_ohci(base
->card
);
1422 struct iso_context
*ctx
= container_of(base
, struct iso_context
, base
);
1423 unsigned long flags
;
1426 ohci_stop_iso(base
);
1427 context_release(&ctx
->context
);
1428 free_page((unsigned long)ctx
->header
);
1430 spin_lock_irqsave(&ohci
->lock
, flags
);
1432 if (ctx
->base
.type
== FW_ISO_CONTEXT_TRANSMIT
) {
1433 index
= ctx
- ohci
->it_context_list
;
1434 ohci
->it_context_mask
|= 1 << index
;
1436 index
= ctx
- ohci
->ir_context_list
;
1437 ohci
->ir_context_mask
|= 1 << index
;
1440 spin_unlock_irqrestore(&ohci
->lock
, flags
);
1444 ohci_queue_iso_transmit(struct fw_iso_context
*base
,
1445 struct fw_iso_packet
*packet
,
1446 struct fw_iso_buffer
*buffer
,
1447 unsigned long payload
)
1449 struct iso_context
*ctx
= container_of(base
, struct iso_context
, base
);
1450 struct descriptor
*d
, *last
, *pd
;
1451 struct fw_iso_packet
*p
;
1453 dma_addr_t d_bus
, page_bus
;
1454 u32 z
, header_z
, payload_z
, irq
;
1455 u32 payload_index
, payload_end_index
, next_page_index
;
1456 int page
, end_page
, i
, length
, offset
;
1458 /* FIXME: Cycle lost behavior should be configurable: lose
1459 * packet, retransmit or terminate.. */
1462 payload_index
= payload
;
1468 if (p
->header_length
> 0)
1471 /* Determine the first page the payload isn't contained in. */
1472 end_page
= PAGE_ALIGN(payload_index
+ p
->payload_length
) >> PAGE_SHIFT
;
1473 if (p
->payload_length
> 0)
1474 payload_z
= end_page
- (payload_index
>> PAGE_SHIFT
);
1480 /* Get header size in number of descriptors. */
1481 header_z
= DIV_ROUND_UP(p
->header_length
, sizeof *d
);
1483 d
= context_get_descriptors(&ctx
->context
, z
+ header_z
, &d_bus
);
1488 d
[0].control
= cpu_to_le16(descriptor_key_immediate
);
1489 d
[0].req_count
= cpu_to_le16(8);
1491 header
= (__le32
*) &d
[1];
1492 header
[0] = cpu_to_le32(it_header_sy(p
->sy
) |
1493 it_header_tag(p
->tag
) |
1494 it_header_tcode(TCODE_STREAM_DATA
) |
1495 it_header_channel(ctx
->base
.channel
) |
1496 it_header_speed(ctx
->base
.speed
));
1498 cpu_to_le32(it_header_data_length(p
->header_length
+
1499 p
->payload_length
));
1502 if (p
->header_length
> 0) {
1503 d
[2].req_count
= cpu_to_le16(p
->header_length
);
1504 d
[2].data_address
= cpu_to_le32(d_bus
+ z
* sizeof *d
);
1505 memcpy(&d
[z
], p
->header
, p
->header_length
);
1508 pd
= d
+ z
- payload_z
;
1509 payload_end_index
= payload_index
+ p
->payload_length
;
1510 for (i
= 0; i
< payload_z
; i
++) {
1511 page
= payload_index
>> PAGE_SHIFT
;
1512 offset
= payload_index
& ~PAGE_MASK
;
1513 next_page_index
= (page
+ 1) << PAGE_SHIFT
;
1515 min(next_page_index
, payload_end_index
) - payload_index
;
1516 pd
[i
].req_count
= cpu_to_le16(length
);
1518 page_bus
= page_private(buffer
->pages
[page
]);
1519 pd
[i
].data_address
= cpu_to_le32(page_bus
+ offset
);
1521 payload_index
+= length
;
1525 irq
= descriptor_irq_always
;
1527 irq
= descriptor_no_irq
;
1529 last
= z
== 2 ? d
: d
+ z
- 1;
1530 last
->control
|= cpu_to_le16(descriptor_output_last
|
1532 descriptor_branch_always
|
1535 context_append(&ctx
->context
, d
, z
, header_z
);
1541 setup_wait_descriptor(struct context
*ctx
)
1543 struct descriptor
*d
;
1546 d
= context_get_descriptors(ctx
, 1, &d_bus
);
1550 d
->control
= cpu_to_le16(descriptor_input_more
|
1552 descriptor_branch_always
|
1555 context_append(ctx
, d
, 1, 0);
1561 ohci_queue_iso_receive_dualbuffer(struct fw_iso_context
*base
,
1562 struct fw_iso_packet
*packet
,
1563 struct fw_iso_buffer
*buffer
,
1564 unsigned long payload
)
1566 struct iso_context
*ctx
= container_of(base
, struct iso_context
, base
);
1567 struct db_descriptor
*db
= NULL
;
1568 struct descriptor
*d
;
1569 struct fw_iso_packet
*p
;
1570 dma_addr_t d_bus
, page_bus
;
1571 u32 z
, header_z
, length
, rest
;
1574 /* FIXME: Cycle lost behavior should be configurable: lose
1575 * packet, retransmit or terminate.. */
1577 if (packet
->skip
&& setup_wait_descriptor(&ctx
->context
) < 0)
1583 /* Get header size in number of descriptors. */
1584 header_z
= DIV_ROUND_UP(p
->header_length
, sizeof *d
);
1585 page
= payload
>> PAGE_SHIFT
;
1586 offset
= payload
& ~PAGE_MASK
;
1587 rest
= p
->payload_length
;
1589 /* FIXME: OHCI 1.0 doesn't support dual buffer receive */
1590 /* FIXME: handle descriptor_wait */
1591 /* FIXME: make packet-per-buffer/dual-buffer a context option */
1593 d
= context_get_descriptors(&ctx
->context
,
1594 z
+ header_z
, &d_bus
);
1598 db
= (struct db_descriptor
*) d
;
1599 db
->control
= cpu_to_le16(descriptor_status
|
1600 descriptor_branch_always
);
1601 db
->first_size
= cpu_to_le16(ctx
->base
.header_size
);
1602 db
->first_req_count
= cpu_to_le16(p
->header_length
);
1603 db
->first_res_count
= db
->first_req_count
;
1604 db
->first_buffer
= cpu_to_le32(d_bus
+ sizeof *db
);
1606 if (offset
+ rest
< PAGE_SIZE
)
1609 length
= PAGE_SIZE
- offset
;
1611 db
->second_req_count
= cpu_to_le16(length
);
1612 db
->second_res_count
= db
->second_req_count
;
1613 page_bus
= page_private(buffer
->pages
[page
]);
1614 db
->second_buffer
= cpu_to_le32(page_bus
+ offset
);
1616 if (p
->interrupt
&& length
== rest
)
1617 db
->control
|= cpu_to_le16(descriptor_irq_always
);
1619 context_append(&ctx
->context
, d
, z
, header_z
);
1620 offset
= (offset
+ length
) & ~PAGE_MASK
;
1629 ohci_queue_iso_receive_bufferfill(struct fw_iso_context
*base
,
1630 struct fw_iso_packet
*packet
,
1631 struct fw_iso_buffer
*buffer
,
1632 unsigned long payload
)
1634 struct iso_context
*ctx
= container_of(base
, struct iso_context
, base
);
1635 struct descriptor
*d
= NULL
;
1636 dma_addr_t d_bus
, page_bus
;
1640 page
= payload
>> PAGE_SHIFT
;
1641 offset
= payload
& ~PAGE_MASK
;
1642 rest
= packet
->payload_length
;
1644 if (packet
->skip
&& setup_wait_descriptor(&ctx
->context
) < 0)
1648 d
= context_get_descriptors(&ctx
->context
, 1, &d_bus
);
1652 d
->control
= cpu_to_le16(descriptor_input_more
|
1654 descriptor_branch_always
);
1656 if (offset
+ rest
< PAGE_SIZE
)
1659 length
= PAGE_SIZE
- offset
;
1661 page_bus
= page_private(buffer
->pages
[page
]);
1662 d
->data_address
= cpu_to_le32(page_bus
+ offset
);
1663 d
->req_count
= cpu_to_le16(length
);
1664 d
->res_count
= cpu_to_le16(length
);
1666 if (packet
->interrupt
&& length
== rest
)
1667 d
->control
|= cpu_to_le16(descriptor_irq_always
);
1669 context_append(&ctx
->context
, d
, 1, 0);
1671 offset
= (offset
+ length
) & ~PAGE_MASK
;
1680 ohci_queue_iso(struct fw_iso_context
*base
,
1681 struct fw_iso_packet
*packet
,
1682 struct fw_iso_buffer
*buffer
,
1683 unsigned long payload
)
1685 struct iso_context
*ctx
= container_of(base
, struct iso_context
, base
);
1687 if (base
->type
== FW_ISO_CONTEXT_TRANSMIT
)
1688 return ohci_queue_iso_transmit(base
, packet
, buffer
, payload
);
1689 else if (base
->header_size
== 0)
1690 return ohci_queue_iso_receive_bufferfill(base
, packet
,
1692 else if (ctx
->context
.ohci
->version
>= OHCI_VERSION_1_1
)
1693 return ohci_queue_iso_receive_dualbuffer(base
, packet
,
1696 /* FIXME: Implement fallback for OHCI 1.0 controllers. */
1700 static const struct fw_card_driver ohci_driver
= {
1701 .name
= ohci_driver_name
,
1702 .enable
= ohci_enable
,
1703 .update_phy_reg
= ohci_update_phy_reg
,
1704 .set_config_rom
= ohci_set_config_rom
,
1705 .send_request
= ohci_send_request
,
1706 .send_response
= ohci_send_response
,
1707 .cancel_packet
= ohci_cancel_packet
,
1708 .enable_phys_dma
= ohci_enable_phys_dma
,
1709 .get_bus_time
= ohci_get_bus_time
,
1711 .allocate_iso_context
= ohci_allocate_iso_context
,
1712 .free_iso_context
= ohci_free_iso_context
,
1713 .queue_iso
= ohci_queue_iso
,
1714 .start_iso
= ohci_start_iso
,
1715 .stop_iso
= ohci_stop_iso
,
1718 static int software_reset(struct fw_ohci
*ohci
)
1722 reg_write(ohci
, OHCI1394_HCControlSet
, OHCI1394_HCControl_softReset
);
1724 for (i
= 0; i
< OHCI_LOOP_COUNT
; i
++) {
1725 if ((reg_read(ohci
, OHCI1394_HCControlSet
) &
1726 OHCI1394_HCControl_softReset
) == 0)
1734 /* ---------- pci subsystem interface ---------- */
1744 static int cleanup(struct fw_ohci
*ohci
, int stage
, int code
)
1746 struct pci_dev
*dev
= to_pci_dev(ohci
->card
.device
);
1749 case CLEANUP_SELF_ID
:
1750 dma_free_coherent(ohci
->card
.device
, SELF_ID_BUF_SIZE
,
1751 ohci
->self_id_cpu
, ohci
->self_id_bus
);
1752 case CLEANUP_REGISTERS
:
1753 kfree(ohci
->it_context_list
);
1754 kfree(ohci
->ir_context_list
);
1755 pci_iounmap(dev
, ohci
->registers
);
1757 pci_release_region(dev
, 0);
1758 case CLEANUP_DISABLE
:
1759 pci_disable_device(dev
);
1760 case CLEANUP_PUT_CARD
:
1761 fw_card_put(&ohci
->card
);
1767 static int __devinit
1768 pci_probe(struct pci_dev
*dev
, const struct pci_device_id
*ent
)
1770 struct fw_ohci
*ohci
;
1771 u32 bus_options
, max_receive
, link_speed
;
1776 ohci
= kzalloc(sizeof *ohci
, GFP_KERNEL
);
1778 fw_error("Could not malloc fw_ohci data.\n");
1782 fw_card_initialize(&ohci
->card
, &ohci_driver
, &dev
->dev
);
1784 if (pci_enable_device(dev
)) {
1785 fw_error("Failed to enable OHCI hardware.\n");
1786 return cleanup(ohci
, CLEANUP_PUT_CARD
, -ENODEV
);
1789 pci_set_master(dev
);
1790 pci_write_config_dword(dev
, OHCI1394_PCI_HCI_Control
, 0);
1791 pci_set_drvdata(dev
, ohci
);
1793 spin_lock_init(&ohci
->lock
);
1795 tasklet_init(&ohci
->bus_reset_tasklet
,
1796 bus_reset_tasklet
, (unsigned long)ohci
);
1798 if (pci_request_region(dev
, 0, ohci_driver_name
)) {
1799 fw_error("MMIO resource unavailable\n");
1800 return cleanup(ohci
, CLEANUP_DISABLE
, -EBUSY
);
1803 ohci
->registers
= pci_iomap(dev
, 0, OHCI1394_REGISTER_SIZE
);
1804 if (ohci
->registers
== NULL
) {
1805 fw_error("Failed to remap registers\n");
1806 return cleanup(ohci
, CLEANUP_IOMEM
, -ENXIO
);
1809 if (software_reset(ohci
)) {
1810 fw_error("Failed to reset ohci card.\n");
1811 return cleanup(ohci
, CLEANUP_REGISTERS
, -EBUSY
);
1814 /* Now enable LPS, which we need in order to start accessing
1815 * most of the registers. In fact, on some cards (ALI M5251),
1816 * accessing registers in the SClk domain without LPS enabled
1817 * will lock up the machine. Wait 50msec to make sure we have
1818 * full link enabled. */
1819 reg_write(ohci
, OHCI1394_HCControlSet
,
1820 OHCI1394_HCControl_LPS
|
1821 OHCI1394_HCControl_postedWriteEnable
);
1825 reg_write(ohci
, OHCI1394_HCControlClear
,
1826 OHCI1394_HCControl_noByteSwapData
);
1828 reg_write(ohci
, OHCI1394_LinkControlSet
,
1829 OHCI1394_LinkControl_rcvSelfID
|
1830 OHCI1394_LinkControl_cycleTimerEnable
|
1831 OHCI1394_LinkControl_cycleMaster
);
1833 ar_context_init(&ohci
->ar_request_ctx
, ohci
,
1834 OHCI1394_AsReqRcvContextControlSet
);
1836 ar_context_init(&ohci
->ar_response_ctx
, ohci
,
1837 OHCI1394_AsRspRcvContextControlSet
);
1839 context_init(&ohci
->at_request_ctx
, ohci
, AT_BUFFER_SIZE
,
1840 OHCI1394_AsReqTrContextControlSet
, handle_at_packet
);
1842 context_init(&ohci
->at_response_ctx
, ohci
, AT_BUFFER_SIZE
,
1843 OHCI1394_AsRspTrContextControlSet
, handle_at_packet
);
1845 reg_write(ohci
, OHCI1394_ATRetries
,
1846 OHCI1394_MAX_AT_REQ_RETRIES
|
1847 (OHCI1394_MAX_AT_RESP_RETRIES
<< 4) |
1848 (OHCI1394_MAX_PHYS_RESP_RETRIES
<< 8));
1850 reg_write(ohci
, OHCI1394_IsoRecvIntMaskSet
, ~0);
1851 ohci
->it_context_mask
= reg_read(ohci
, OHCI1394_IsoRecvIntMaskSet
);
1852 reg_write(ohci
, OHCI1394_IsoRecvIntMaskClear
, ~0);
1853 size
= sizeof(struct iso_context
) * hweight32(ohci
->it_context_mask
);
1854 ohci
->it_context_list
= kzalloc(size
, GFP_KERNEL
);
1856 reg_write(ohci
, OHCI1394_IsoXmitIntMaskSet
, ~0);
1857 ohci
->ir_context_mask
= reg_read(ohci
, OHCI1394_IsoXmitIntMaskSet
);
1858 reg_write(ohci
, OHCI1394_IsoXmitIntMaskClear
, ~0);
1859 size
= sizeof(struct iso_context
) * hweight32(ohci
->ir_context_mask
);
1860 ohci
->ir_context_list
= kzalloc(size
, GFP_KERNEL
);
1862 if (ohci
->it_context_list
== NULL
|| ohci
->ir_context_list
== NULL
) {
1863 fw_error("Out of memory for it/ir contexts.\n");
1864 return cleanup(ohci
, CLEANUP_REGISTERS
, -ENOMEM
);
1867 /* self-id dma buffer allocation */
1868 ohci
->self_id_cpu
= dma_alloc_coherent(ohci
->card
.device
,
1872 if (ohci
->self_id_cpu
== NULL
) {
1873 fw_error("Out of memory for self ID buffer.\n");
1874 return cleanup(ohci
, CLEANUP_REGISTERS
, -ENOMEM
);
1877 reg_write(ohci
, OHCI1394_SelfIDBuffer
, ohci
->self_id_bus
);
1878 reg_write(ohci
, OHCI1394_PhyUpperBound
, 0x00010000);
1879 reg_write(ohci
, OHCI1394_IntEventClear
, ~0);
1880 reg_write(ohci
, OHCI1394_IntMaskClear
, ~0);
1881 reg_write(ohci
, OHCI1394_IntMaskSet
,
1882 OHCI1394_selfIDComplete
|
1883 OHCI1394_RQPkt
| OHCI1394_RSPkt
|
1884 OHCI1394_reqTxComplete
| OHCI1394_respTxComplete
|
1885 OHCI1394_isochRx
| OHCI1394_isochTx
|
1886 OHCI1394_masterIntEnable
|
1887 OHCI1394_cycle64Seconds
);
1889 bus_options
= reg_read(ohci
, OHCI1394_BusOptions
);
1890 max_receive
= (bus_options
>> 12) & 0xf;
1891 link_speed
= bus_options
& 0x7;
1892 guid
= ((u64
) reg_read(ohci
, OHCI1394_GUIDHi
) << 32) |
1893 reg_read(ohci
, OHCI1394_GUIDLo
);
1895 error_code
= fw_card_add(&ohci
->card
, max_receive
, link_speed
, guid
);
1897 return cleanup(ohci
, CLEANUP_SELF_ID
, error_code
);
1899 ohci
->version
= reg_read(ohci
, OHCI1394_Version
) & 0x00ff00ff;
1900 fw_notify("Added fw-ohci device %s, OHCI version %x.%x\n",
1901 dev
->dev
.bus_id
, ohci
->version
>> 16, ohci
->version
& 0xff);
1906 static void pci_remove(struct pci_dev
*dev
)
1908 struct fw_ohci
*ohci
;
1910 ohci
= pci_get_drvdata(dev
);
1911 reg_write(ohci
, OHCI1394_IntMaskClear
, ~0);
1913 fw_core_remove_card(&ohci
->card
);
1915 /* FIXME: Fail all pending packets here, now that the upper
1916 * layers can't queue any more. */
1918 software_reset(ohci
);
1919 free_irq(dev
->irq
, ohci
);
1920 cleanup(ohci
, CLEANUP_SELF_ID
, 0);
1922 fw_notify("Removed fw-ohci device.\n");
1925 static struct pci_device_id pci_table
[] = {
1926 { PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_FIREWIRE_OHCI
, ~0) },
1930 MODULE_DEVICE_TABLE(pci
, pci_table
);
1932 static struct pci_driver fw_ohci_pci_driver
= {
1933 .name
= ohci_driver_name
,
1934 .id_table
= pci_table
,
1936 .remove
= pci_remove
,
1939 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1940 MODULE_DESCRIPTION("Driver for PCI OHCI IEEE1394 controllers");
1941 MODULE_LICENSE("GPL");
1943 static int __init
fw_ohci_init(void)
1945 return pci_register_driver(&fw_ohci_pci_driver
);
1948 static void __exit
fw_ohci_cleanup(void)
1950 pci_unregister_driver(&fw_ohci_pci_driver
);
1953 module_init(fw_ohci_init
);
1954 module_exit(fw_ohci_cleanup
);