2 * Driver for OHCI 1394 controllers
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/bug.h>
22 #include <linux/compiler.h>
23 #include <linux/delay.h>
24 #include <linux/device.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/firewire.h>
27 #include <linux/firewire-constants.h>
28 #include <linux/init.h>
29 #include <linux/interrupt.h>
31 #include <linux/kernel.h>
32 #include <linux/list.h>
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/mutex.h>
37 #include <linux/pci.h>
38 #include <linux/pci_ids.h>
39 #include <linux/slab.h>
40 #include <linux/spinlock.h>
41 #include <linux/string.h>
42 #include <linux/time.h>
44 #include <asm/byteorder.h>
46 #include <asm/system.h>
48 #ifdef CONFIG_PPC_PMAC
49 #include <asm/pmac_feature.h>
55 #define DESCRIPTOR_OUTPUT_MORE 0
56 #define DESCRIPTOR_OUTPUT_LAST (1 << 12)
57 #define DESCRIPTOR_INPUT_MORE (2 << 12)
58 #define DESCRIPTOR_INPUT_LAST (3 << 12)
59 #define DESCRIPTOR_STATUS (1 << 11)
60 #define DESCRIPTOR_KEY_IMMEDIATE (2 << 8)
61 #define DESCRIPTOR_PING (1 << 7)
62 #define DESCRIPTOR_YY (1 << 6)
63 #define DESCRIPTOR_NO_IRQ (0 << 4)
64 #define DESCRIPTOR_IRQ_ERROR (1 << 4)
65 #define DESCRIPTOR_IRQ_ALWAYS (3 << 4)
66 #define DESCRIPTOR_BRANCH_ALWAYS (3 << 2)
67 #define DESCRIPTOR_WAIT (3 << 0)
73 __le32 branch_address;
75 __le16 transfer_status;
76 } __attribute__((aligned(16)));
78 #define CONTROL_SET(regs) (regs)
79 #define CONTROL_CLEAR(regs) ((regs) + 4)
80 #define COMMAND_PTR(regs) ((regs) + 12)
81 #define CONTEXT_MATCH(regs) ((regs) + 16)
84 struct descriptor descriptor;
85 struct ar_buffer *next;
91 struct ar_buffer *current_buffer;
92 struct ar_buffer *last_buffer;
95 struct tasklet_struct tasklet;
100 typedef int (*descriptor_callback_t)(struct context *ctx,
101 struct descriptor *d,
102 struct descriptor *last);
105 * A buffer that contains a block of DMA-able coherent memory used for
106 * storing a portion of a DMA descriptor program.
108 struct descriptor_buffer {
109 struct list_head list;
110 dma_addr_t buffer_bus;
113 struct descriptor buffer[0];
117 struct fw_ohci *ohci;
119 int total_allocation;
122 * List of page-sized buffers for storing DMA descriptors.
123 * Head of list contains buffers in use and tail of list contains
126 struct list_head buffer_list;
129 * Pointer to a buffer inside buffer_list that contains the tail
130 * end of the current DMA program.
132 struct descriptor_buffer *buffer_tail;
135 * The descriptor containing the branch address of the first
136 * descriptor that has not yet been filled by the device.
138 struct descriptor *last;
141 * The last descriptor in the DMA program. It contains the branch
142 * address that must be updated upon appending a new descriptor.
144 struct descriptor *prev;
146 descriptor_callback_t callback;
148 struct tasklet_struct tasklet;
151 #define IT_HEADER_SY(v) ((v) << 0)
152 #define IT_HEADER_TCODE(v) ((v) << 4)
153 #define IT_HEADER_CHANNEL(v) ((v) << 8)
154 #define IT_HEADER_TAG(v) ((v) << 14)
155 #define IT_HEADER_SPEED(v) ((v) << 16)
156 #define IT_HEADER_DATA_LENGTH(v) ((v) << 16)
159 struct fw_iso_context base;
160 struct context context;
163 size_t header_length;
166 #define CONFIG_ROM_SIZE 1024
171 __iomem char *registers;
174 int request_generation; /* for timestamping incoming requests */
176 unsigned int pri_req_max;
179 bool csr_state_setclear_abdicate;
182 * Spinlock for accessing fw_ohci data. Never call out of
183 * this driver with this lock held.
187 struct mutex phy_reg_mutex;
189 struct ar_context ar_request_ctx;
190 struct ar_context ar_response_ctx;
191 struct context at_request_ctx;
192 struct context at_response_ctx;
194 u32 it_context_mask; /* unoccupied IT contexts */
195 struct iso_context *it_context_list;
196 u64 ir_context_channels; /* unoccupied channels */
197 u32 ir_context_mask; /* unoccupied IR contexts */
198 struct iso_context *ir_context_list;
199 u64 mc_channels; /* channels in use by the multichannel IR context */
203 dma_addr_t config_rom_bus;
204 __be32 *next_config_rom;
205 dma_addr_t next_config_rom_bus;
209 dma_addr_t self_id_bus;
210 struct tasklet_struct bus_reset_tasklet;
212 u32 self_id_buffer[512];
215 static inline struct fw_ohci *fw_ohci(struct fw_card *card)
217 return container_of(card, struct fw_ohci, card);
220 #define IT_CONTEXT_CYCLE_MATCH_ENABLE 0x80000000
221 #define IR_CONTEXT_BUFFER_FILL 0x80000000
222 #define IR_CONTEXT_ISOCH_HEADER 0x40000000
223 #define IR_CONTEXT_CYCLE_MATCH_ENABLE 0x20000000
224 #define IR_CONTEXT_MULTI_CHANNEL_MODE 0x10000000
225 #define IR_CONTEXT_DUAL_BUFFER_MODE 0x08000000
227 #define CONTEXT_RUN 0x8000
228 #define CONTEXT_WAKE 0x1000
229 #define CONTEXT_DEAD 0x0800
230 #define CONTEXT_ACTIVE 0x0400
232 #define OHCI1394_MAX_AT_REQ_RETRIES 0xf
233 #define OHCI1394_MAX_AT_RESP_RETRIES 0x2
234 #define OHCI1394_MAX_PHYS_RESP_RETRIES 0x8
236 #define OHCI1394_REGISTER_SIZE 0x800
237 #define OHCI_LOOP_COUNT 500
238 #define OHCI1394_PCI_HCI_Control 0x40
239 #define SELF_ID_BUF_SIZE 0x800
240 #define OHCI_TCODE_PHY_PACKET 0x0e
241 #define OHCI_VERSION_1_1 0x010010
243 static char ohci_driver_name[] = KBUILD_MODNAME;
245 #define PCI_DEVICE_ID_JMICRON_JMB38X_FW 0x2380
246 #define PCI_DEVICE_ID_TI_TSB12LV22 0x8009
248 #define QUIRK_CYCLE_TIMER 1
249 #define QUIRK_RESET_PACKET 2
250 #define QUIRK_BE_HEADERS 4
251 #define QUIRK_NO_1394A 8
252 #define QUIRK_NO_MSI 16
254 /* In case of multiple matches in ohci_quirks[], only the first one is used. */
255 static const struct {
256 unsigned short vendor, device, flags;
258 {PCI_VENDOR_ID_TI, PCI_DEVICE_ID_TI_TSB12LV22, QUIRK_CYCLE_TIMER |
261 {PCI_VENDOR_ID_TI, PCI_ANY_ID, QUIRK_RESET_PACKET},
262 {PCI_VENDOR_ID_AL, PCI_ANY_ID, QUIRK_CYCLE_TIMER},
263 {PCI_VENDOR_ID_JMICRON, PCI_DEVICE_ID_JMICRON_JMB38X_FW, QUIRK_NO_MSI},
264 {PCI_VENDOR_ID_NEC, PCI_ANY_ID, QUIRK_CYCLE_TIMER},
265 {PCI_VENDOR_ID_VIA, PCI_ANY_ID, QUIRK_CYCLE_TIMER},
266 {PCI_VENDOR_ID_RICOH, PCI_ANY_ID, QUIRK_CYCLE_TIMER},
267 {PCI_VENDOR_ID_APPLE, PCI_DEVICE_ID_APPLE_UNI_N_FW, QUIRK_BE_HEADERS},
270 /* This overrides anything that was found in ohci_quirks[]. */
271 static int param_quirks;
272 module_param_named(quirks, param_quirks, int, 0644);
273 MODULE_PARM_DESC(quirks, "Chip quirks (default = 0"
274 ", nonatomic cycle timer = " __stringify(QUIRK_CYCLE_TIMER)
275 ", reset packet generation = " __stringify(QUIRK_RESET_PACKET)
276 ", AR/selfID endianess = " __stringify(QUIRK_BE_HEADERS)
277 ", no 1394a enhancements = " __stringify(QUIRK_NO_1394A)
278 ", disable MSI = " __stringify(QUIRK_NO_MSI)
281 #define OHCI_PARAM_DEBUG_AT_AR 1
282 #define OHCI_PARAM_DEBUG_SELFIDS 2
283 #define OHCI_PARAM_DEBUG_IRQS 4
284 #define OHCI_PARAM_DEBUG_BUSRESETS 8 /* only effective before chip init */
286 #ifdef CONFIG_FIREWIRE_OHCI_DEBUG
288 static int param_debug;
289 module_param_named(debug, param_debug, int, 0644);
290 MODULE_PARM_DESC(debug, "Verbose logging (default = 0"
291 ", AT/AR events = " __stringify(OHCI_PARAM_DEBUG_AT_AR)
292 ", self-IDs = " __stringify(OHCI_PARAM_DEBUG_SELFIDS)
293 ", IRQs = " __stringify(OHCI_PARAM_DEBUG_IRQS)
294 ", busReset events = " __stringify(OHCI_PARAM_DEBUG_BUSRESETS)
295 ", or a combination, or all = -1)");
297 static void log_irqs(u32 evt)
299 if (likely(!(param_debug &
300 (OHCI_PARAM_DEBUG_IRQS | OHCI_PARAM_DEBUG_BUSRESETS))))
303 if (!(param_debug & OHCI_PARAM_DEBUG_IRQS) &&
304 !(evt & OHCI1394_busReset))
307 fw_notify("IRQ %08x%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n", evt,
308 evt & OHCI1394_selfIDComplete ? " selfID" : "",
309 evt & OHCI1394_RQPkt ? " AR_req" : "",
310 evt & OHCI1394_RSPkt ? " AR_resp" : "",
311 evt & OHCI1394_reqTxComplete ? " AT_req" : "",
312 evt & OHCI1394_respTxComplete ? " AT_resp" : "",
313 evt & OHCI1394_isochRx ? " IR" : "",
314 evt & OHCI1394_isochTx ? " IT" : "",
315 evt & OHCI1394_postedWriteErr ? " postedWriteErr" : "",
316 evt & OHCI1394_cycleTooLong ? " cycleTooLong" : "",
317 evt & OHCI1394_cycle64Seconds ? " cycle64Seconds" : "",
318 evt & OHCI1394_cycleInconsistent ? " cycleInconsistent" : "",
319 evt & OHCI1394_regAccessFail ? " regAccessFail" : "",
320 evt & OHCI1394_busReset ? " busReset" : "",
321 evt & ~(OHCI1394_selfIDComplete | OHCI1394_RQPkt |
322 OHCI1394_RSPkt | OHCI1394_reqTxComplete |
323 OHCI1394_respTxComplete | OHCI1394_isochRx |
324 OHCI1394_isochTx | OHCI1394_postedWriteErr |
325 OHCI1394_cycleTooLong | OHCI1394_cycle64Seconds |
326 OHCI1394_cycleInconsistent |
327 OHCI1394_regAccessFail | OHCI1394_busReset)
331 static const char *speed[] = {
332 [0] = "S100", [1] = "S200", [2] = "S400", [3] = "beta",
334 static const char *power[] = {
335 [0] = "+0W", [1] = "+15W", [2] = "+30W", [3] = "+45W",
336 [4] = "-3W", [5] = " ?W", [6] = "-3..-6W", [7] = "-3..-10W",
338 static const char port[] = { '.', '-', 'p', 'c', };
340 static char _p(u32 *s, int shift)
342 return port[*s >> shift & 3];
345 static void log_selfids(int node_id, int generation, int self_id_count, u32 *s)
347 if (likely(!(param_debug & OHCI_PARAM_DEBUG_SELFIDS)))
350 fw_notify("%d selfIDs, generation %d, local node ID %04x\n",
351 self_id_count, generation, node_id);
353 for (; self_id_count--; ++s)
354 if ((*s & 1 << 23) == 0)
355 fw_notify("selfID 0: %08x, phy %d [%c%c%c] "
356 "%s gc=%d %s %s%s%s\n",
357 *s, *s >> 24 & 63, _p(s, 6), _p(s, 4), _p(s, 2),
358 speed[*s >> 14 & 3], *s >> 16 & 63,
359 power[*s >> 8 & 7], *s >> 22 & 1 ? "L" : "",
360 *s >> 11 & 1 ? "c" : "", *s & 2 ? "i" : "");
362 fw_notify("selfID n: %08x, phy %d [%c%c%c%c%c%c%c%c]\n",
364 _p(s, 16), _p(s, 14), _p(s, 12), _p(s, 10),
365 _p(s, 8), _p(s, 6), _p(s, 4), _p(s, 2));
368 static const char *evts[] = {
369 [0x00] = "evt_no_status", [0x01] = "-reserved-",
370 [0x02] = "evt_long_packet", [0x03] = "evt_missing_ack",
371 [0x04] = "evt_underrun", [0x05] = "evt_overrun",
372 [0x06] = "evt_descriptor_read", [0x07] = "evt_data_read",
373 [0x08] = "evt_data_write", [0x09] = "evt_bus_reset",
374 [0x0a] = "evt_timeout", [0x0b] = "evt_tcode_err",
375 [0x0c] = "-reserved-", [0x0d] = "-reserved-",
376 [0x0e] = "evt_unknown", [0x0f] = "evt_flushed",
377 [0x10] = "-reserved-", [0x11] = "ack_complete",
378 [0x12] = "ack_pending ", [0x13] = "-reserved-",
379 [0x14] = "ack_busy_X", [0x15] = "ack_busy_A",
380 [0x16] = "ack_busy_B", [0x17] = "-reserved-",
381 [0x18] = "-reserved-", [0x19] = "-reserved-",
382 [0x1a] = "-reserved-", [0x1b] = "ack_tardy",
383 [0x1c] = "-reserved-", [0x1d] = "ack_data_error",
384 [0x1e] = "ack_type_error", [0x1f] = "-reserved-",
385 [0x20] = "pending/cancelled",
387 static const char *tcodes[] = {
388 [0x0] = "QW req", [0x1] = "BW req",
389 [0x2] = "W resp", [0x3] = "-reserved-",
390 [0x4] = "QR req", [0x5] = "BR req",
391 [0x6] = "QR resp", [0x7] = "BR resp",
392 [0x8] = "cycle start", [0x9] = "Lk req",
393 [0xa] = "async stream packet", [0xb] = "Lk resp",
394 [0xc] = "-reserved-", [0xd] = "-reserved-",
395 [0xe] = "link internal", [0xf] = "-reserved-",
397 static const char *phys[] = {
398 [0x0] = "phy config packet", [0x1] = "link-on packet",
399 [0x2] = "self-id packet", [0x3] = "-reserved-",
402 static void log_ar_at_event(char dir, int speed, u32 *header, int evt)
404 int tcode = header[0] >> 4 & 0xf;
407 if (likely(!(param_debug & OHCI_PARAM_DEBUG_AT_AR)))
410 if (unlikely(evt >= ARRAY_SIZE(evts)))
413 if (evt == OHCI1394_evt_bus_reset) {
414 fw_notify("A%c evt_bus_reset, generation %d\n",
415 dir, (header[2] >> 16) & 0xff);
419 if (header[0] == ~header[1]) {
420 fw_notify("A%c %s, %s, %08x\n",
421 dir, evts[evt], phys[header[0] >> 30 & 0x3], header[0]);
426 case 0x0: case 0x6: case 0x8:
427 snprintf(specific, sizeof(specific), " = %08x",
428 be32_to_cpu((__force __be32)header[3]));
430 case 0x1: case 0x5: case 0x7: case 0x9: case 0xb:
431 snprintf(specific, sizeof(specific), " %x,%x",
432 header[3] >> 16, header[3] & 0xffff);
440 fw_notify("A%c %s, %s\n", dir, evts[evt], tcodes[tcode]);
442 case 0x0: case 0x1: case 0x4: case 0x5: case 0x9:
443 fw_notify("A%c spd %x tl %02x, "
446 dir, speed, header[0] >> 10 & 0x3f,
447 header[1] >> 16, header[0] >> 16, evts[evt],
448 tcodes[tcode], header[1] & 0xffff, header[2], specific);
451 fw_notify("A%c spd %x tl %02x, "
454 dir, speed, header[0] >> 10 & 0x3f,
455 header[1] >> 16, header[0] >> 16, evts[evt],
456 tcodes[tcode], specific);
462 #define param_debug 0
463 static inline void log_irqs(u32 evt) {}
464 static inline void log_selfids(int node_id, int generation, int self_id_count, u32 *s) {}
465 static inline void log_ar_at_event(char dir, int speed, u32 *header, int evt) {}
467 #endif /* CONFIG_FIREWIRE_OHCI_DEBUG */
469 static inline void reg_write(const struct fw_ohci *ohci, int offset, u32 data)
471 writel(data, ohci->registers + offset);
474 static inline u32 reg_read(const struct fw_ohci *ohci, int offset)
476 return readl(ohci->registers + offset);
479 static inline void flush_writes(const struct fw_ohci *ohci)
481 /* Do a dummy read to flush writes. */
482 reg_read(ohci, OHCI1394_Version);
485 static int read_phy_reg(struct fw_ohci *ohci, int addr)
490 reg_write(ohci, OHCI1394_PhyControl, OHCI1394_PhyControl_Read(addr));
491 for (i = 0; i < 3 + 100; i++) {
492 val = reg_read(ohci, OHCI1394_PhyControl);
493 if (val & OHCI1394_PhyControl_ReadDone)
494 return OHCI1394_PhyControl_ReadData(val);
497 * Try a few times without waiting. Sleeping is necessary
498 * only when the link/PHY interface is busy.
503 fw_error("failed to read phy reg\n");
508 static int write_phy_reg(const struct fw_ohci *ohci, int addr, u32 val)
512 reg_write(ohci, OHCI1394_PhyControl,
513 OHCI1394_PhyControl_Write(addr, val));
514 for (i = 0; i < 3 + 100; i++) {
515 val = reg_read(ohci, OHCI1394_PhyControl);
516 if (!(val & OHCI1394_PhyControl_WritePending))
522 fw_error("failed to write phy reg\n");
527 static int update_phy_reg(struct fw_ohci *ohci, int addr,
528 int clear_bits, int set_bits)
530 int ret = read_phy_reg(ohci, addr);
535 * The interrupt status bits are cleared by writing a one bit.
536 * Avoid clearing them unless explicitly requested in set_bits.
539 clear_bits |= PHY_INT_STATUS_BITS;
541 return write_phy_reg(ohci, addr, (ret & ~clear_bits) | set_bits);
544 static int read_paged_phy_reg(struct fw_ohci *ohci, int page, int addr)
548 ret = update_phy_reg(ohci, 7, PHY_PAGE_SELECT, page << 5);
552 return read_phy_reg(ohci, addr);
555 static int ohci_read_phy_reg(struct fw_card *card, int addr)
557 struct fw_ohci *ohci = fw_ohci(card);
560 mutex_lock(&ohci->phy_reg_mutex);
561 ret = read_phy_reg(ohci, addr);
562 mutex_unlock(&ohci->phy_reg_mutex);
567 static int ohci_update_phy_reg(struct fw_card *card, int addr,
568 int clear_bits, int set_bits)
570 struct fw_ohci *ohci = fw_ohci(card);
573 mutex_lock(&ohci->phy_reg_mutex);
574 ret = update_phy_reg(ohci, addr, clear_bits, set_bits);
575 mutex_unlock(&ohci->phy_reg_mutex);
580 static void ar_context_link_page(struct ar_context *ctx,
581 struct ar_buffer *ab, dma_addr_t ab_bus)
586 memset(&ab->descriptor, 0, sizeof(ab->descriptor));
587 ab->descriptor.control = cpu_to_le16(DESCRIPTOR_INPUT_MORE |
589 DESCRIPTOR_BRANCH_ALWAYS);
590 offset = offsetof(struct ar_buffer, data);
591 ab->descriptor.req_count = cpu_to_le16(PAGE_SIZE - offset);
592 ab->descriptor.data_address = cpu_to_le32(ab_bus + offset);
593 ab->descriptor.res_count = cpu_to_le16(PAGE_SIZE - offset);
594 ab->descriptor.branch_address = 0;
596 wmb(); /* finish init of new descriptors before branch_address update */
597 ctx->last_buffer->descriptor.branch_address = cpu_to_le32(ab_bus | 1);
598 ctx->last_buffer->next = ab;
599 ctx->last_buffer = ab;
601 reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_WAKE);
602 flush_writes(ctx->ohci);
605 static int ar_context_add_page(struct ar_context *ctx)
607 struct device *dev = ctx->ohci->card.device;
608 struct ar_buffer *ab;
609 dma_addr_t uninitialized_var(ab_bus);
611 ab = dma_alloc_coherent(dev, PAGE_SIZE, &ab_bus, GFP_ATOMIC);
615 ar_context_link_page(ctx, ab, ab_bus);
620 static void ar_context_release(struct ar_context *ctx)
622 struct ar_buffer *ab, *ab_next;
626 for (ab = ctx->current_buffer; ab; ab = ab_next) {
628 offset = offsetof(struct ar_buffer, data);
629 ab_bus = le32_to_cpu(ab->descriptor.data_address) - offset;
630 dma_free_coherent(ctx->ohci->card.device, PAGE_SIZE,
635 #if defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32)
636 #define cond_le32_to_cpu(v) \
637 (ohci->quirks & QUIRK_BE_HEADERS ? (__force __u32)(v) : le32_to_cpu(v))
639 #define cond_le32_to_cpu(v) le32_to_cpu(v)
642 static __le32 *handle_ar_packet(struct ar_context *ctx, __le32 *buffer)
644 struct fw_ohci *ohci = ctx->ohci;
646 u32 status, length, tcode;
649 p.header[0] = cond_le32_to_cpu(buffer[0]);
650 p.header[1] = cond_le32_to_cpu(buffer[1]);
651 p.header[2] = cond_le32_to_cpu(buffer[2]);
653 tcode = (p.header[0] >> 4) & 0x0f;
655 case TCODE_WRITE_QUADLET_REQUEST:
656 case TCODE_READ_QUADLET_RESPONSE:
657 p.header[3] = (__force __u32) buffer[3];
658 p.header_length = 16;
659 p.payload_length = 0;
662 case TCODE_READ_BLOCK_REQUEST :
663 p.header[3] = cond_le32_to_cpu(buffer[3]);
664 p.header_length = 16;
665 p.payload_length = 0;
668 case TCODE_WRITE_BLOCK_REQUEST:
669 case TCODE_READ_BLOCK_RESPONSE:
670 case TCODE_LOCK_REQUEST:
671 case TCODE_LOCK_RESPONSE:
672 p.header[3] = cond_le32_to_cpu(buffer[3]);
673 p.header_length = 16;
674 p.payload_length = p.header[3] >> 16;
677 case TCODE_WRITE_RESPONSE:
678 case TCODE_READ_QUADLET_REQUEST:
679 case OHCI_TCODE_PHY_PACKET:
680 p.header_length = 12;
681 p.payload_length = 0;
685 /* FIXME: Stop context, discard everything, and restart? */
687 p.payload_length = 0;
690 p.payload = (void *) buffer + p.header_length;
692 /* FIXME: What to do about evt_* errors? */
693 length = (p.header_length + p.payload_length + 3) / 4;
694 status = cond_le32_to_cpu(buffer[length]);
695 evt = (status >> 16) & 0x1f;
698 p.speed = (status >> 21) & 0x7;
699 p.timestamp = status & 0xffff;
700 p.generation = ohci->request_generation;
702 log_ar_at_event('R', p.speed, p.header, evt);
705 * Several controllers, notably from NEC and VIA, forget to
706 * write ack_complete status at PHY packet reception.
708 if (evt == OHCI1394_evt_no_status &&
709 (p.header[0] & 0xff) == (OHCI1394_phy_tcode << 4))
710 p.ack = ACK_COMPLETE;
713 * The OHCI bus reset handler synthesizes a PHY packet with
714 * the new generation number when a bus reset happens (see
715 * section 8.4.2.3). This helps us determine when a request
716 * was received and make sure we send the response in the same
717 * generation. We only need this for requests; for responses
718 * we use the unique tlabel for finding the matching
721 * Alas some chips sometimes emit bus reset packets with a
722 * wrong generation. We set the correct generation for these
723 * at a slightly incorrect time (in bus_reset_tasklet).
725 if (evt == OHCI1394_evt_bus_reset) {
726 if (!(ohci->quirks & QUIRK_RESET_PACKET))
727 ohci->request_generation = (p.header[2] >> 16) & 0xff;
728 } else if (ctx == &ohci->ar_request_ctx) {
729 fw_core_handle_request(&ohci->card, &p);
731 fw_core_handle_response(&ohci->card, &p);
734 return buffer + length + 1;
737 static void ar_context_tasklet(unsigned long data)
739 struct ar_context *ctx = (struct ar_context *)data;
740 struct ar_buffer *ab;
741 struct descriptor *d;
744 ab = ctx->current_buffer;
747 if (d->res_count == 0) {
748 size_t size, size2, rest, pktsize, size3, offset;
749 dma_addr_t start_bus;
753 * This descriptor is finished and we may have a
754 * packet split across this and the next buffer. We
755 * reuse the page for reassembling the split packet.
758 offset = offsetof(struct ar_buffer, data);
760 start_bus = le32_to_cpu(ab->descriptor.data_address) - offset;
765 size = start + PAGE_SIZE - ctx->pointer;
766 /* valid buffer data in the next page */
767 rest = le16_to_cpu(d->req_count) - le16_to_cpu(d->res_count);
768 /* what actually fits in this page */
769 size2 = min(rest, (size_t)PAGE_SIZE - offset - size);
770 memmove(buffer, ctx->pointer, size);
771 memcpy(buffer + size, ab->data, size2);
774 void *next = handle_ar_packet(ctx, buffer);
775 pktsize = next - buffer;
776 if (pktsize >= size) {
778 * We have handled all the data that was
779 * originally in this page, so we can now
780 * continue in the next page.
785 /* move the next packet to the start of the buffer */
786 memmove(buffer, next, size + size2 - pktsize);
788 /* fill up this page again */
789 size3 = min(rest - size2,
790 (size_t)PAGE_SIZE - offset - size - size2);
791 memcpy(buffer + size + size2,
792 (void *) ab->data + size2, size3);
797 /* handle the packets that are fully in the next page */
798 buffer = (void *) ab->data +
799 (buffer - (start + offset + size));
800 end = (void *) ab->data + rest;
803 buffer = handle_ar_packet(ctx, buffer);
805 ctx->current_buffer = ab;
808 ar_context_link_page(ctx, start, start_bus);
810 ctx->pointer = start + PAGE_SIZE;
813 buffer = ctx->pointer;
815 (void *) ab + PAGE_SIZE - le16_to_cpu(d->res_count);
818 buffer = handle_ar_packet(ctx, buffer);
822 static int ar_context_init(struct ar_context *ctx,
823 struct fw_ohci *ohci, u32 regs)
829 ctx->last_buffer = &ab;
830 tasklet_init(&ctx->tasklet, ar_context_tasklet, (unsigned long)ctx);
832 ar_context_add_page(ctx);
833 ar_context_add_page(ctx);
834 ctx->current_buffer = ab.next;
835 ctx->pointer = ctx->current_buffer->data;
840 static void ar_context_run(struct ar_context *ctx)
842 struct ar_buffer *ab = ctx->current_buffer;
846 offset = offsetof(struct ar_buffer, data);
847 ab_bus = le32_to_cpu(ab->descriptor.data_address) - offset;
849 reg_write(ctx->ohci, COMMAND_PTR(ctx->regs), ab_bus | 1);
850 reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_RUN);
851 flush_writes(ctx->ohci);
854 static struct descriptor *find_branch_descriptor(struct descriptor *d, int z)
858 b = (le16_to_cpu(d->control) & DESCRIPTOR_BRANCH_ALWAYS) >> 2;
859 key = (le16_to_cpu(d->control) & DESCRIPTOR_KEY_IMMEDIATE) >> 8;
861 /* figure out which descriptor the branch address goes in */
862 if (z == 2 && (b == 3 || key == 2))
868 static void context_tasklet(unsigned long data)
870 struct context *ctx = (struct context *) data;
871 struct descriptor *d, *last;
874 struct descriptor_buffer *desc;
876 desc = list_entry(ctx->buffer_list.next,
877 struct descriptor_buffer, list);
879 while (last->branch_address != 0) {
880 struct descriptor_buffer *old_desc = desc;
881 address = le32_to_cpu(last->branch_address);
885 /* If the branch address points to a buffer outside of the
886 * current buffer, advance to the next buffer. */
887 if (address < desc->buffer_bus ||
888 address >= desc->buffer_bus + desc->used)
889 desc = list_entry(desc->list.next,
890 struct descriptor_buffer, list);
891 d = desc->buffer + (address - desc->buffer_bus) / sizeof(*d);
892 last = find_branch_descriptor(d, z);
894 if (!ctx->callback(ctx, d, last))
897 if (old_desc != desc) {
898 /* If we've advanced to the next buffer, move the
899 * previous buffer to the free list. */
902 spin_lock_irqsave(&ctx->ohci->lock, flags);
903 list_move_tail(&old_desc->list, &ctx->buffer_list);
904 spin_unlock_irqrestore(&ctx->ohci->lock, flags);
911 * Allocate a new buffer and add it to the list of free buffers for this
912 * context. Must be called with ohci->lock held.
914 static int context_add_buffer(struct context *ctx)
916 struct descriptor_buffer *desc;
917 dma_addr_t uninitialized_var(bus_addr);
921 * 16MB of descriptors should be far more than enough for any DMA
922 * program. This will catch run-away userspace or DoS attacks.
924 if (ctx->total_allocation >= 16*1024*1024)
927 desc = dma_alloc_coherent(ctx->ohci->card.device, PAGE_SIZE,
928 &bus_addr, GFP_ATOMIC);
932 offset = (void *)&desc->buffer - (void *)desc;
933 desc->buffer_size = PAGE_SIZE - offset;
934 desc->buffer_bus = bus_addr + offset;
937 list_add_tail(&desc->list, &ctx->buffer_list);
938 ctx->total_allocation += PAGE_SIZE;
943 static int context_init(struct context *ctx, struct fw_ohci *ohci,
944 u32 regs, descriptor_callback_t callback)
948 ctx->total_allocation = 0;
950 INIT_LIST_HEAD(&ctx->buffer_list);
951 if (context_add_buffer(ctx) < 0)
954 ctx->buffer_tail = list_entry(ctx->buffer_list.next,
955 struct descriptor_buffer, list);
957 tasklet_init(&ctx->tasklet, context_tasklet, (unsigned long)ctx);
958 ctx->callback = callback;
961 * We put a dummy descriptor in the buffer that has a NULL
962 * branch address and looks like it's been sent. That way we
963 * have a descriptor to append DMA programs to.
965 memset(ctx->buffer_tail->buffer, 0, sizeof(*ctx->buffer_tail->buffer));
966 ctx->buffer_tail->buffer->control = cpu_to_le16(DESCRIPTOR_OUTPUT_LAST);
967 ctx->buffer_tail->buffer->transfer_status = cpu_to_le16(0x8011);
968 ctx->buffer_tail->used += sizeof(*ctx->buffer_tail->buffer);
969 ctx->last = ctx->buffer_tail->buffer;
970 ctx->prev = ctx->buffer_tail->buffer;
975 static void context_release(struct context *ctx)
977 struct fw_card *card = &ctx->ohci->card;
978 struct descriptor_buffer *desc, *tmp;
980 list_for_each_entry_safe(desc, tmp, &ctx->buffer_list, list)
981 dma_free_coherent(card->device, PAGE_SIZE, desc,
983 ((void *)&desc->buffer - (void *)desc));
986 /* Must be called with ohci->lock held */
987 static struct descriptor *context_get_descriptors(struct context *ctx,
988 int z, dma_addr_t *d_bus)
990 struct descriptor *d = NULL;
991 struct descriptor_buffer *desc = ctx->buffer_tail;
993 if (z * sizeof(*d) > desc->buffer_size)
996 if (z * sizeof(*d) > desc->buffer_size - desc->used) {
997 /* No room for the descriptor in this buffer, so advance to the
1000 if (desc->list.next == &ctx->buffer_list) {
1001 /* If there is no free buffer next in the list,
1003 if (context_add_buffer(ctx) < 0)
1006 desc = list_entry(desc->list.next,
1007 struct descriptor_buffer, list);
1008 ctx->buffer_tail = desc;
1011 d = desc->buffer + desc->used / sizeof(*d);
1012 memset(d, 0, z * sizeof(*d));
1013 *d_bus = desc->buffer_bus + desc->used;
1018 static void context_run(struct context *ctx, u32 extra)
1020 struct fw_ohci *ohci = ctx->ohci;
1022 reg_write(ohci, COMMAND_PTR(ctx->regs),
1023 le32_to_cpu(ctx->last->branch_address));
1024 reg_write(ohci, CONTROL_CLEAR(ctx->regs), ~0);
1025 reg_write(ohci, CONTROL_SET(ctx->regs), CONTEXT_RUN | extra);
1029 static void context_append(struct context *ctx,
1030 struct descriptor *d, int z, int extra)
1033 struct descriptor_buffer *desc = ctx->buffer_tail;
1035 d_bus = desc->buffer_bus + (d - desc->buffer) * sizeof(*d);
1037 desc->used += (z + extra) * sizeof(*d);
1039 wmb(); /* finish init of new descriptors before branch_address update */
1040 ctx->prev->branch_address = cpu_to_le32(d_bus | z);
1041 ctx->prev = find_branch_descriptor(d, z);
1043 reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_WAKE);
1044 flush_writes(ctx->ohci);
1047 static void context_stop(struct context *ctx)
1052 reg_write(ctx->ohci, CONTROL_CLEAR(ctx->regs), CONTEXT_RUN);
1053 flush_writes(ctx->ohci);
1055 for (i = 0; i < 10; i++) {
1056 reg = reg_read(ctx->ohci, CONTROL_SET(ctx->regs));
1057 if ((reg & CONTEXT_ACTIVE) == 0)
1062 fw_error("Error: DMA context still active (0x%08x)\n", reg);
1065 struct driver_data {
1066 struct fw_packet *packet;
1070 * This function apppends a packet to the DMA queue for transmission.
1071 * Must always be called with the ochi->lock held to ensure proper
1072 * generation handling and locking around packet queue manipulation.
1074 static int at_context_queue_packet(struct context *ctx,
1075 struct fw_packet *packet)
1077 struct fw_ohci *ohci = ctx->ohci;
1078 dma_addr_t d_bus, uninitialized_var(payload_bus);
1079 struct driver_data *driver_data;
1080 struct descriptor *d, *last;
1085 d = context_get_descriptors(ctx, 4, &d_bus);
1087 packet->ack = RCODE_SEND_ERROR;
1091 d[0].control = cpu_to_le16(DESCRIPTOR_KEY_IMMEDIATE);
1092 d[0].res_count = cpu_to_le16(packet->timestamp);
1095 * The DMA format for asyncronous link packets is different
1096 * from the IEEE1394 layout, so shift the fields around
1097 * accordingly. If header_length is 8, it's a PHY packet, to
1098 * which we need to prepend an extra quadlet.
1101 header = (__le32 *) &d[1];
1102 switch (packet->header_length) {
1105 header[0] = cpu_to_le32((packet->header[0] & 0xffff) |
1106 (packet->speed << 16));
1107 header[1] = cpu_to_le32((packet->header[1] & 0xffff) |
1108 (packet->header[0] & 0xffff0000));
1109 header[2] = cpu_to_le32(packet->header[2]);
1111 tcode = (packet->header[0] >> 4) & 0x0f;
1112 if (TCODE_IS_BLOCK_PACKET(tcode))
1113 header[3] = cpu_to_le32(packet->header[3]);
1115 header[3] = (__force __le32) packet->header[3];
1117 d[0].req_count = cpu_to_le16(packet->header_length);
1121 header[0] = cpu_to_le32((OHCI1394_phy_tcode << 4) |
1122 (packet->speed << 16));
1123 header[1] = cpu_to_le32(packet->header[0]);
1124 header[2] = cpu_to_le32(packet->header[1]);
1125 d[0].req_count = cpu_to_le16(12);
1127 if (is_ping_packet(packet->header))
1128 d[0].control |= cpu_to_le16(DESCRIPTOR_PING);
1132 header[0] = cpu_to_le32((packet->header[0] & 0xffff) |
1133 (packet->speed << 16));
1134 header[1] = cpu_to_le32(packet->header[0] & 0xffff0000);
1135 d[0].req_count = cpu_to_le16(8);
1140 packet->ack = RCODE_SEND_ERROR;
1144 driver_data = (struct driver_data *) &d[3];
1145 driver_data->packet = packet;
1146 packet->driver_data = driver_data;
1148 if (packet->payload_length > 0) {
1150 dma_map_single(ohci->card.device, packet->payload,
1151 packet->payload_length, DMA_TO_DEVICE);
1152 if (dma_mapping_error(ohci->card.device, payload_bus)) {
1153 packet->ack = RCODE_SEND_ERROR;
1156 packet->payload_bus = payload_bus;
1157 packet->payload_mapped = true;
1159 d[2].req_count = cpu_to_le16(packet->payload_length);
1160 d[2].data_address = cpu_to_le32(payload_bus);
1168 last->control |= cpu_to_le16(DESCRIPTOR_OUTPUT_LAST |
1169 DESCRIPTOR_IRQ_ALWAYS |
1170 DESCRIPTOR_BRANCH_ALWAYS);
1173 * If the controller and packet generations don't match, we need to
1174 * bail out and try again. If IntEvent.busReset is set, the AT context
1175 * is halted, so appending to the context and trying to run it is
1176 * futile. Most controllers do the right thing and just flush the AT
1177 * queue (per section 7.2.3.2 of the OHCI 1.1 specification), but
1178 * some controllers (like a JMicron JMB381 PCI-e) misbehave and wind
1179 * up stalling out. So we just bail out in software and try again
1180 * later, and everyone is happy.
1181 * FIXME: Document how the locking works.
1183 if (ohci->generation != packet->generation ||
1184 reg_read(ohci, OHCI1394_IntEventSet) & OHCI1394_busReset) {
1185 if (packet->payload_mapped)
1186 dma_unmap_single(ohci->card.device, payload_bus,
1187 packet->payload_length, DMA_TO_DEVICE);
1188 packet->ack = RCODE_GENERATION;
1192 context_append(ctx, d, z, 4 - z);
1194 /* If the context isn't already running, start it up. */
1195 reg = reg_read(ctx->ohci, CONTROL_SET(ctx->regs));
1196 if ((reg & CONTEXT_RUN) == 0)
1197 context_run(ctx, 0);
1202 static int handle_at_packet(struct context *context,
1203 struct descriptor *d,
1204 struct descriptor *last)
1206 struct driver_data *driver_data;
1207 struct fw_packet *packet;
1208 struct fw_ohci *ohci = context->ohci;
1211 if (last->transfer_status == 0)
1212 /* This descriptor isn't done yet, stop iteration. */
1215 driver_data = (struct driver_data *) &d[3];
1216 packet = driver_data->packet;
1218 /* This packet was cancelled, just continue. */
1221 if (packet->payload_mapped)
1222 dma_unmap_single(ohci->card.device, packet->payload_bus,
1223 packet->payload_length, DMA_TO_DEVICE);
1225 evt = le16_to_cpu(last->transfer_status) & 0x1f;
1226 packet->timestamp = le16_to_cpu(last->res_count);
1228 log_ar_at_event('T', packet->speed, packet->header, evt);
1231 case OHCI1394_evt_timeout:
1232 /* Async response transmit timed out. */
1233 packet->ack = RCODE_CANCELLED;
1236 case OHCI1394_evt_flushed:
1238 * The packet was flushed should give same error as
1239 * when we try to use a stale generation count.
1241 packet->ack = RCODE_GENERATION;
1244 case OHCI1394_evt_missing_ack:
1246 * Using a valid (current) generation count, but the
1247 * node is not on the bus or not sending acks.
1249 packet->ack = RCODE_NO_ACK;
1252 case ACK_COMPLETE + 0x10:
1253 case ACK_PENDING + 0x10:
1254 case ACK_BUSY_X + 0x10:
1255 case ACK_BUSY_A + 0x10:
1256 case ACK_BUSY_B + 0x10:
1257 case ACK_DATA_ERROR + 0x10:
1258 case ACK_TYPE_ERROR + 0x10:
1259 packet->ack = evt - 0x10;
1263 packet->ack = RCODE_SEND_ERROR;
1267 packet->callback(packet, &ohci->card, packet->ack);
1272 #define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff)
1273 #define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f)
1274 #define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff)
1275 #define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff)
1276 #define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff)
1278 static void handle_local_rom(struct fw_ohci *ohci,
1279 struct fw_packet *packet, u32 csr)
1281 struct fw_packet response;
1282 int tcode, length, i;
1284 tcode = HEADER_GET_TCODE(packet->header[0]);
1285 if (TCODE_IS_BLOCK_PACKET(tcode))
1286 length = HEADER_GET_DATA_LENGTH(packet->header[3]);
1290 i = csr - CSR_CONFIG_ROM;
1291 if (i + length > CONFIG_ROM_SIZE) {
1292 fw_fill_response(&response, packet->header,
1293 RCODE_ADDRESS_ERROR, NULL, 0);
1294 } else if (!TCODE_IS_READ_REQUEST(tcode)) {
1295 fw_fill_response(&response, packet->header,
1296 RCODE_TYPE_ERROR, NULL, 0);
1298 fw_fill_response(&response, packet->header, RCODE_COMPLETE,
1299 (void *) ohci->config_rom + i, length);
1302 fw_core_handle_response(&ohci->card, &response);
1305 static void handle_local_lock(struct fw_ohci *ohci,
1306 struct fw_packet *packet, u32 csr)
1308 struct fw_packet response;
1309 int tcode, length, ext_tcode, sel, try;
1310 __be32 *payload, lock_old;
1311 u32 lock_arg, lock_data;
1313 tcode = HEADER_GET_TCODE(packet->header[0]);
1314 length = HEADER_GET_DATA_LENGTH(packet->header[3]);
1315 payload = packet->payload;
1316 ext_tcode = HEADER_GET_EXTENDED_TCODE(packet->header[3]);
1318 if (tcode == TCODE_LOCK_REQUEST &&
1319 ext_tcode == EXTCODE_COMPARE_SWAP && length == 8) {
1320 lock_arg = be32_to_cpu(payload[0]);
1321 lock_data = be32_to_cpu(payload[1]);
1322 } else if (tcode == TCODE_READ_QUADLET_REQUEST) {
1326 fw_fill_response(&response, packet->header,
1327 RCODE_TYPE_ERROR, NULL, 0);
1331 sel = (csr - CSR_BUS_MANAGER_ID) / 4;
1332 reg_write(ohci, OHCI1394_CSRData, lock_data);
1333 reg_write(ohci, OHCI1394_CSRCompareData, lock_arg);
1334 reg_write(ohci, OHCI1394_CSRControl, sel);
1336 for (try = 0; try < 20; try++)
1337 if (reg_read(ohci, OHCI1394_CSRControl) & 0x80000000) {
1338 lock_old = cpu_to_be32(reg_read(ohci,
1340 fw_fill_response(&response, packet->header,
1342 &lock_old, sizeof(lock_old));
1346 fw_error("swap not done (CSR lock timeout)\n");
1347 fw_fill_response(&response, packet->header, RCODE_BUSY, NULL, 0);
1350 fw_core_handle_response(&ohci->card, &response);
1353 static void handle_local_request(struct context *ctx, struct fw_packet *packet)
1357 if (ctx == &ctx->ohci->at_request_ctx) {
1358 packet->ack = ACK_PENDING;
1359 packet->callback(packet, &ctx->ohci->card, packet->ack);
1363 ((unsigned long long)
1364 HEADER_GET_OFFSET_HIGH(packet->header[1]) << 32) |
1366 csr = offset - CSR_REGISTER_BASE;
1368 /* Handle config rom reads. */
1369 if (csr >= CSR_CONFIG_ROM && csr < CSR_CONFIG_ROM_END)
1370 handle_local_rom(ctx->ohci, packet, csr);
1372 case CSR_BUS_MANAGER_ID:
1373 case CSR_BANDWIDTH_AVAILABLE:
1374 case CSR_CHANNELS_AVAILABLE_HI:
1375 case CSR_CHANNELS_AVAILABLE_LO:
1376 handle_local_lock(ctx->ohci, packet, csr);
1379 if (ctx == &ctx->ohci->at_request_ctx)
1380 fw_core_handle_request(&ctx->ohci->card, packet);
1382 fw_core_handle_response(&ctx->ohci->card, packet);
1386 if (ctx == &ctx->ohci->at_response_ctx) {
1387 packet->ack = ACK_COMPLETE;
1388 packet->callback(packet, &ctx->ohci->card, packet->ack);
1392 static void at_context_transmit(struct context *ctx, struct fw_packet *packet)
1394 unsigned long flags;
1397 spin_lock_irqsave(&ctx->ohci->lock, flags);
1399 if (HEADER_GET_DESTINATION(packet->header[0]) == ctx->ohci->node_id &&
1400 ctx->ohci->generation == packet->generation) {
1401 spin_unlock_irqrestore(&ctx->ohci->lock, flags);
1402 handle_local_request(ctx, packet);
1406 ret = at_context_queue_packet(ctx, packet);
1407 spin_unlock_irqrestore(&ctx->ohci->lock, flags);
1410 packet->callback(packet, &ctx->ohci->card, packet->ack);
1414 static u32 cycle_timer_ticks(u32 cycle_timer)
1418 ticks = cycle_timer & 0xfff;
1419 ticks += 3072 * ((cycle_timer >> 12) & 0x1fff);
1420 ticks += (3072 * 8000) * (cycle_timer >> 25);
1426 * Some controllers exhibit one or more of the following bugs when updating the
1427 * iso cycle timer register:
1428 * - When the lowest six bits are wrapping around to zero, a read that happens
1429 * at the same time will return garbage in the lowest ten bits.
1430 * - When the cycleOffset field wraps around to zero, the cycleCount field is
1431 * not incremented for about 60 ns.
1432 * - Occasionally, the entire register reads zero.
1434 * To catch these, we read the register three times and ensure that the
1435 * difference between each two consecutive reads is approximately the same, i.e.
1436 * less than twice the other. Furthermore, any negative difference indicates an
1437 * error. (A PCI read should take at least 20 ticks of the 24.576 MHz timer to
1438 * execute, so we have enough precision to compute the ratio of the differences.)
1440 static u32 get_cycle_time(struct fw_ohci *ohci)
1447 c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1449 if (ohci->quirks & QUIRK_CYCLE_TIMER) {
1452 c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1456 c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1457 t0 = cycle_timer_ticks(c0);
1458 t1 = cycle_timer_ticks(c1);
1459 t2 = cycle_timer_ticks(c2);
1462 } while ((diff01 <= 0 || diff12 <= 0 ||
1463 diff01 / diff12 >= 2 || diff12 / diff01 >= 2)
1471 * This function has to be called at least every 64 seconds. The bus_time
1472 * field stores not only the upper 25 bits of the BUS_TIME register but also
1473 * the most significant bit of the cycle timer in bit 6 so that we can detect
1474 * changes in this bit.
1476 static u32 update_bus_time(struct fw_ohci *ohci)
1478 u32 cycle_time_seconds = get_cycle_time(ohci) >> 25;
1480 if ((ohci->bus_time & 0x40) != (cycle_time_seconds & 0x40))
1481 ohci->bus_time += 0x40;
1483 return ohci->bus_time | cycle_time_seconds;
1486 static void bus_reset_tasklet(unsigned long data)
1488 struct fw_ohci *ohci = (struct fw_ohci *)data;
1489 int self_id_count, i, j, reg;
1490 int generation, new_generation;
1491 unsigned long flags;
1492 void *free_rom = NULL;
1493 dma_addr_t free_rom_bus = 0;
1496 reg = reg_read(ohci, OHCI1394_NodeID);
1497 if (!(reg & OHCI1394_NodeID_idValid)) {
1498 fw_notify("node ID not valid, new bus reset in progress\n");
1501 if ((reg & OHCI1394_NodeID_nodeNumber) == 63) {
1502 fw_notify("malconfigured bus\n");
1505 ohci->node_id = reg & (OHCI1394_NodeID_busNumber |
1506 OHCI1394_NodeID_nodeNumber);
1508 is_new_root = (reg & OHCI1394_NodeID_root) != 0;
1509 if (!(ohci->is_root && is_new_root))
1510 reg_write(ohci, OHCI1394_LinkControlSet,
1511 OHCI1394_LinkControl_cycleMaster);
1512 ohci->is_root = is_new_root;
1514 reg = reg_read(ohci, OHCI1394_SelfIDCount);
1515 if (reg & OHCI1394_SelfIDCount_selfIDError) {
1516 fw_notify("inconsistent self IDs\n");
1520 * The count in the SelfIDCount register is the number of
1521 * bytes in the self ID receive buffer. Since we also receive
1522 * the inverted quadlets and a header quadlet, we shift one
1523 * bit extra to get the actual number of self IDs.
1525 self_id_count = (reg >> 3) & 0xff;
1526 if (self_id_count == 0 || self_id_count > 252) {
1527 fw_notify("inconsistent self IDs\n");
1530 generation = (cond_le32_to_cpu(ohci->self_id_cpu[0]) >> 16) & 0xff;
1533 for (i = 1, j = 0; j < self_id_count; i += 2, j++) {
1534 if (ohci->self_id_cpu[i] != ~ohci->self_id_cpu[i + 1]) {
1535 fw_notify("inconsistent self IDs\n");
1538 ohci->self_id_buffer[j] =
1539 cond_le32_to_cpu(ohci->self_id_cpu[i]);
1544 * Check the consistency of the self IDs we just read. The
1545 * problem we face is that a new bus reset can start while we
1546 * read out the self IDs from the DMA buffer. If this happens,
1547 * the DMA buffer will be overwritten with new self IDs and we
1548 * will read out inconsistent data. The OHCI specification
1549 * (section 11.2) recommends a technique similar to
1550 * linux/seqlock.h, where we remember the generation of the
1551 * self IDs in the buffer before reading them out and compare
1552 * it to the current generation after reading them out. If
1553 * the two generations match we know we have a consistent set
1557 new_generation = (reg_read(ohci, OHCI1394_SelfIDCount) >> 16) & 0xff;
1558 if (new_generation != generation) {
1559 fw_notify("recursive bus reset detected, "
1560 "discarding self ids\n");
1564 /* FIXME: Document how the locking works. */
1565 spin_lock_irqsave(&ohci->lock, flags);
1567 ohci->generation = generation;
1568 context_stop(&ohci->at_request_ctx);
1569 context_stop(&ohci->at_response_ctx);
1570 reg_write(ohci, OHCI1394_IntEventClear, OHCI1394_busReset);
1572 if (ohci->quirks & QUIRK_RESET_PACKET)
1573 ohci->request_generation = generation;
1576 * This next bit is unrelated to the AT context stuff but we
1577 * have to do it under the spinlock also. If a new config rom
1578 * was set up before this reset, the old one is now no longer
1579 * in use and we can free it. Update the config rom pointers
1580 * to point to the current config rom and clear the
1581 * next_config_rom pointer so a new update can take place.
1584 if (ohci->next_config_rom != NULL) {
1585 if (ohci->next_config_rom != ohci->config_rom) {
1586 free_rom = ohci->config_rom;
1587 free_rom_bus = ohci->config_rom_bus;
1589 ohci->config_rom = ohci->next_config_rom;
1590 ohci->config_rom_bus = ohci->next_config_rom_bus;
1591 ohci->next_config_rom = NULL;
1594 * Restore config_rom image and manually update
1595 * config_rom registers. Writing the header quadlet
1596 * will indicate that the config rom is ready, so we
1599 reg_write(ohci, OHCI1394_BusOptions,
1600 be32_to_cpu(ohci->config_rom[2]));
1601 ohci->config_rom[0] = ohci->next_header;
1602 reg_write(ohci, OHCI1394_ConfigROMhdr,
1603 be32_to_cpu(ohci->next_header));
1606 #ifdef CONFIG_FIREWIRE_OHCI_REMOTE_DMA
1607 reg_write(ohci, OHCI1394_PhyReqFilterHiSet, ~0);
1608 reg_write(ohci, OHCI1394_PhyReqFilterLoSet, ~0);
1611 spin_unlock_irqrestore(&ohci->lock, flags);
1614 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
1615 free_rom, free_rom_bus);
1617 log_selfids(ohci->node_id, generation,
1618 self_id_count, ohci->self_id_buffer);
1620 fw_core_handle_bus_reset(&ohci->card, ohci->node_id, generation,
1621 self_id_count, ohci->self_id_buffer,
1622 ohci->csr_state_setclear_abdicate);
1623 ohci->csr_state_setclear_abdicate = false;
1626 static irqreturn_t irq_handler(int irq, void *data)
1628 struct fw_ohci *ohci = data;
1629 u32 event, iso_event;
1632 event = reg_read(ohci, OHCI1394_IntEventClear);
1634 if (!event || !~event)
1637 /* busReset must not be cleared yet, see OHCI 1.1 clause 7.2.3.2 */
1638 reg_write(ohci, OHCI1394_IntEventClear, event & ~OHCI1394_busReset);
1641 if (event & OHCI1394_selfIDComplete)
1642 tasklet_schedule(&ohci->bus_reset_tasklet);
1644 if (event & OHCI1394_RQPkt)
1645 tasklet_schedule(&ohci->ar_request_ctx.tasklet);
1647 if (event & OHCI1394_RSPkt)
1648 tasklet_schedule(&ohci->ar_response_ctx.tasklet);
1650 if (event & OHCI1394_reqTxComplete)
1651 tasklet_schedule(&ohci->at_request_ctx.tasklet);
1653 if (event & OHCI1394_respTxComplete)
1654 tasklet_schedule(&ohci->at_response_ctx.tasklet);
1656 iso_event = reg_read(ohci, OHCI1394_IsoRecvIntEventClear);
1657 reg_write(ohci, OHCI1394_IsoRecvIntEventClear, iso_event);
1660 i = ffs(iso_event) - 1;
1661 tasklet_schedule(&ohci->ir_context_list[i].context.tasklet);
1662 iso_event &= ~(1 << i);
1665 iso_event = reg_read(ohci, OHCI1394_IsoXmitIntEventClear);
1666 reg_write(ohci, OHCI1394_IsoXmitIntEventClear, iso_event);
1669 i = ffs(iso_event) - 1;
1670 tasklet_schedule(&ohci->it_context_list[i].context.tasklet);
1671 iso_event &= ~(1 << i);
1674 if (unlikely(event & OHCI1394_regAccessFail))
1675 fw_error("Register access failure - "
1676 "please notify linux1394-devel@lists.sf.net\n");
1678 if (unlikely(event & OHCI1394_postedWriteErr))
1679 fw_error("PCI posted write error\n");
1681 if (unlikely(event & OHCI1394_cycleTooLong)) {
1682 if (printk_ratelimit())
1683 fw_notify("isochronous cycle too long\n");
1684 reg_write(ohci, OHCI1394_LinkControlSet,
1685 OHCI1394_LinkControl_cycleMaster);
1688 if (unlikely(event & OHCI1394_cycleInconsistent)) {
1690 * We need to clear this event bit in order to make
1691 * cycleMatch isochronous I/O work. In theory we should
1692 * stop active cycleMatch iso contexts now and restart
1693 * them at least two cycles later. (FIXME?)
1695 if (printk_ratelimit())
1696 fw_notify("isochronous cycle inconsistent\n");
1699 if (event & OHCI1394_cycle64Seconds) {
1700 spin_lock(&ohci->lock);
1701 update_bus_time(ohci);
1702 spin_unlock(&ohci->lock);
1708 static int software_reset(struct fw_ohci *ohci)
1712 reg_write(ohci, OHCI1394_HCControlSet, OHCI1394_HCControl_softReset);
1714 for (i = 0; i < OHCI_LOOP_COUNT; i++) {
1715 if ((reg_read(ohci, OHCI1394_HCControlSet) &
1716 OHCI1394_HCControl_softReset) == 0)
1724 static void copy_config_rom(__be32 *dest, const __be32 *src, size_t length)
1726 size_t size = length * 4;
1728 memcpy(dest, src, size);
1729 if (size < CONFIG_ROM_SIZE)
1730 memset(&dest[length], 0, CONFIG_ROM_SIZE - size);
1733 static int configure_1394a_enhancements(struct fw_ohci *ohci)
1736 int ret, clear, set, offset;
1738 /* Check if the driver should configure link and PHY. */
1739 if (!(reg_read(ohci, OHCI1394_HCControlSet) &
1740 OHCI1394_HCControl_programPhyEnable))
1743 /* Paranoia: check whether the PHY supports 1394a, too. */
1744 enable_1394a = false;
1745 ret = read_phy_reg(ohci, 2);
1748 if ((ret & PHY_EXTENDED_REGISTERS) == PHY_EXTENDED_REGISTERS) {
1749 ret = read_paged_phy_reg(ohci, 1, 8);
1753 enable_1394a = true;
1756 if (ohci->quirks & QUIRK_NO_1394A)
1757 enable_1394a = false;
1759 /* Configure PHY and link consistently. */
1762 set = PHY_ENABLE_ACCEL | PHY_ENABLE_MULTI;
1764 clear = PHY_ENABLE_ACCEL | PHY_ENABLE_MULTI;
1767 ret = update_phy_reg(ohci, 5, clear, set);
1772 offset = OHCI1394_HCControlSet;
1774 offset = OHCI1394_HCControlClear;
1775 reg_write(ohci, offset, OHCI1394_HCControl_aPhyEnhanceEnable);
1777 /* Clean up: configuration has been taken care of. */
1778 reg_write(ohci, OHCI1394_HCControlClear,
1779 OHCI1394_HCControl_programPhyEnable);
1784 static int ohci_enable(struct fw_card *card,
1785 const __be32 *config_rom, size_t length)
1787 struct fw_ohci *ohci = fw_ohci(card);
1788 struct pci_dev *dev = to_pci_dev(card->device);
1789 u32 lps, seconds, version, irqs;
1792 if (software_reset(ohci)) {
1793 fw_error("Failed to reset ohci card.\n");
1798 * Now enable LPS, which we need in order to start accessing
1799 * most of the registers. In fact, on some cards (ALI M5251),
1800 * accessing registers in the SClk domain without LPS enabled
1801 * will lock up the machine. Wait 50msec to make sure we have
1802 * full link enabled. However, with some cards (well, at least
1803 * a JMicron PCIe card), we have to try again sometimes.
1805 reg_write(ohci, OHCI1394_HCControlSet,
1806 OHCI1394_HCControl_LPS |
1807 OHCI1394_HCControl_postedWriteEnable);
1810 for (lps = 0, i = 0; !lps && i < 3; i++) {
1812 lps = reg_read(ohci, OHCI1394_HCControlSet) &
1813 OHCI1394_HCControl_LPS;
1817 fw_error("Failed to set Link Power Status\n");
1821 reg_write(ohci, OHCI1394_HCControlClear,
1822 OHCI1394_HCControl_noByteSwapData);
1824 reg_write(ohci, OHCI1394_SelfIDBuffer, ohci->self_id_bus);
1825 reg_write(ohci, OHCI1394_LinkControlSet,
1826 OHCI1394_LinkControl_rcvSelfID |
1827 OHCI1394_LinkControl_rcvPhyPkt |
1828 OHCI1394_LinkControl_cycleTimerEnable |
1829 OHCI1394_LinkControl_cycleMaster);
1831 reg_write(ohci, OHCI1394_ATRetries,
1832 OHCI1394_MAX_AT_REQ_RETRIES |
1833 (OHCI1394_MAX_AT_RESP_RETRIES << 4) |
1834 (OHCI1394_MAX_PHYS_RESP_RETRIES << 8) |
1837 seconds = lower_32_bits(get_seconds());
1838 reg_write(ohci, OHCI1394_IsochronousCycleTimer, seconds << 25);
1839 ohci->bus_time = seconds & ~0x3f;
1841 version = reg_read(ohci, OHCI1394_Version) & 0x00ff00ff;
1842 if (version >= OHCI_VERSION_1_1) {
1843 reg_write(ohci, OHCI1394_InitialChannelsAvailableHi,
1845 card->broadcast_channel_auto_allocated = true;
1848 /* Get implemented bits of the priority arbitration request counter. */
1849 reg_write(ohci, OHCI1394_FairnessControl, 0x3f);
1850 ohci->pri_req_max = reg_read(ohci, OHCI1394_FairnessControl) & 0x3f;
1851 reg_write(ohci, OHCI1394_FairnessControl, 0);
1852 card->priority_budget_implemented = ohci->pri_req_max != 0;
1854 ar_context_run(&ohci->ar_request_ctx);
1855 ar_context_run(&ohci->ar_response_ctx);
1857 reg_write(ohci, OHCI1394_PhyUpperBound, 0x00010000);
1858 reg_write(ohci, OHCI1394_IntEventClear, ~0);
1859 reg_write(ohci, OHCI1394_IntMaskClear, ~0);
1861 ret = configure_1394a_enhancements(ohci);
1865 /* Activate link_on bit and contender bit in our self ID packets.*/
1866 ret = ohci_update_phy_reg(card, 4, 0, PHY_LINK_ACTIVE | PHY_CONTENDER);
1871 * When the link is not yet enabled, the atomic config rom
1872 * update mechanism described below in ohci_set_config_rom()
1873 * is not active. We have to update ConfigRomHeader and
1874 * BusOptions manually, and the write to ConfigROMmap takes
1875 * effect immediately. We tie this to the enabling of the
1876 * link, so we have a valid config rom before enabling - the
1877 * OHCI requires that ConfigROMhdr and BusOptions have valid
1878 * values before enabling.
1880 * However, when the ConfigROMmap is written, some controllers
1881 * always read back quadlets 0 and 2 from the config rom to
1882 * the ConfigRomHeader and BusOptions registers on bus reset.
1883 * They shouldn't do that in this initial case where the link
1884 * isn't enabled. This means we have to use the same
1885 * workaround here, setting the bus header to 0 and then write
1886 * the right values in the bus reset tasklet.
1890 ohci->next_config_rom =
1891 dma_alloc_coherent(ohci->card.device, CONFIG_ROM_SIZE,
1892 &ohci->next_config_rom_bus,
1894 if (ohci->next_config_rom == NULL)
1897 copy_config_rom(ohci->next_config_rom, config_rom, length);
1900 * In the suspend case, config_rom is NULL, which
1901 * means that we just reuse the old config rom.
1903 ohci->next_config_rom = ohci->config_rom;
1904 ohci->next_config_rom_bus = ohci->config_rom_bus;
1907 ohci->next_header = ohci->next_config_rom[0];
1908 ohci->next_config_rom[0] = 0;
1909 reg_write(ohci, OHCI1394_ConfigROMhdr, 0);
1910 reg_write(ohci, OHCI1394_BusOptions,
1911 be32_to_cpu(ohci->next_config_rom[2]));
1912 reg_write(ohci, OHCI1394_ConfigROMmap, ohci->next_config_rom_bus);
1914 reg_write(ohci, OHCI1394_AsReqFilterHiSet, 0x80000000);
1916 if (!(ohci->quirks & QUIRK_NO_MSI))
1917 pci_enable_msi(dev);
1918 if (request_irq(dev->irq, irq_handler,
1919 pci_dev_msi_enabled(dev) ? 0 : IRQF_SHARED,
1920 ohci_driver_name, ohci)) {
1921 fw_error("Failed to allocate interrupt %d.\n", dev->irq);
1922 pci_disable_msi(dev);
1923 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
1924 ohci->config_rom, ohci->config_rom_bus);
1928 irqs = OHCI1394_reqTxComplete | OHCI1394_respTxComplete |
1929 OHCI1394_RQPkt | OHCI1394_RSPkt |
1930 OHCI1394_isochTx | OHCI1394_isochRx |
1931 OHCI1394_postedWriteErr |
1932 OHCI1394_selfIDComplete |
1933 OHCI1394_regAccessFail |
1934 OHCI1394_cycle64Seconds |
1935 OHCI1394_cycleInconsistent | OHCI1394_cycleTooLong |
1936 OHCI1394_masterIntEnable;
1937 if (param_debug & OHCI_PARAM_DEBUG_BUSRESETS)
1938 irqs |= OHCI1394_busReset;
1939 reg_write(ohci, OHCI1394_IntMaskSet, irqs);
1941 reg_write(ohci, OHCI1394_HCControlSet,
1942 OHCI1394_HCControl_linkEnable |
1943 OHCI1394_HCControl_BIBimageValid);
1946 /* We are ready to go, reset bus to finish initialization. */
1947 fw_schedule_bus_reset(&ohci->card, false, true);
1952 static int ohci_set_config_rom(struct fw_card *card,
1953 const __be32 *config_rom, size_t length)
1955 struct fw_ohci *ohci;
1956 unsigned long flags;
1958 __be32 *next_config_rom;
1959 dma_addr_t uninitialized_var(next_config_rom_bus);
1961 ohci = fw_ohci(card);
1964 * When the OHCI controller is enabled, the config rom update
1965 * mechanism is a bit tricky, but easy enough to use. See
1966 * section 5.5.6 in the OHCI specification.
1968 * The OHCI controller caches the new config rom address in a
1969 * shadow register (ConfigROMmapNext) and needs a bus reset
1970 * for the changes to take place. When the bus reset is
1971 * detected, the controller loads the new values for the
1972 * ConfigRomHeader and BusOptions registers from the specified
1973 * config rom and loads ConfigROMmap from the ConfigROMmapNext
1974 * shadow register. All automatically and atomically.
1976 * Now, there's a twist to this story. The automatic load of
1977 * ConfigRomHeader and BusOptions doesn't honor the
1978 * noByteSwapData bit, so with a be32 config rom, the
1979 * controller will load be32 values in to these registers
1980 * during the atomic update, even on litte endian
1981 * architectures. The workaround we use is to put a 0 in the
1982 * header quadlet; 0 is endian agnostic and means that the
1983 * config rom isn't ready yet. In the bus reset tasklet we
1984 * then set up the real values for the two registers.
1986 * We use ohci->lock to avoid racing with the code that sets
1987 * ohci->next_config_rom to NULL (see bus_reset_tasklet).
1991 dma_alloc_coherent(ohci->card.device, CONFIG_ROM_SIZE,
1992 &next_config_rom_bus, GFP_KERNEL);
1993 if (next_config_rom == NULL)
1996 spin_lock_irqsave(&ohci->lock, flags);
1998 if (ohci->next_config_rom == NULL) {
1999 ohci->next_config_rom = next_config_rom;
2000 ohci->next_config_rom_bus = next_config_rom_bus;
2002 copy_config_rom(ohci->next_config_rom, config_rom, length);
2004 ohci->next_header = config_rom[0];
2005 ohci->next_config_rom[0] = 0;
2007 reg_write(ohci, OHCI1394_ConfigROMmap,
2008 ohci->next_config_rom_bus);
2012 spin_unlock_irqrestore(&ohci->lock, flags);
2015 * Now initiate a bus reset to have the changes take
2016 * effect. We clean up the old config rom memory and DMA
2017 * mappings in the bus reset tasklet, since the OHCI
2018 * controller could need to access it before the bus reset
2022 fw_schedule_bus_reset(&ohci->card, true, true);
2024 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2025 next_config_rom, next_config_rom_bus);
2030 static void ohci_send_request(struct fw_card *card, struct fw_packet *packet)
2032 struct fw_ohci *ohci = fw_ohci(card);
2034 at_context_transmit(&ohci->at_request_ctx, packet);
2037 static void ohci_send_response(struct fw_card *card, struct fw_packet *packet)
2039 struct fw_ohci *ohci = fw_ohci(card);
2041 at_context_transmit(&ohci->at_response_ctx, packet);
2044 static int ohci_cancel_packet(struct fw_card *card, struct fw_packet *packet)
2046 struct fw_ohci *ohci = fw_ohci(card);
2047 struct context *ctx = &ohci->at_request_ctx;
2048 struct driver_data *driver_data = packet->driver_data;
2051 tasklet_disable(&ctx->tasklet);
2053 if (packet->ack != 0)
2056 if (packet->payload_mapped)
2057 dma_unmap_single(ohci->card.device, packet->payload_bus,
2058 packet->payload_length, DMA_TO_DEVICE);
2060 log_ar_at_event('T', packet->speed, packet->header, 0x20);
2061 driver_data->packet = NULL;
2062 packet->ack = RCODE_CANCELLED;
2063 packet->callback(packet, &ohci->card, packet->ack);
2066 tasklet_enable(&ctx->tasklet);
2071 static int ohci_enable_phys_dma(struct fw_card *card,
2072 int node_id, int generation)
2074 #ifdef CONFIG_FIREWIRE_OHCI_REMOTE_DMA
2077 struct fw_ohci *ohci = fw_ohci(card);
2078 unsigned long flags;
2082 * FIXME: Make sure this bitmask is cleared when we clear the busReset
2083 * interrupt bit. Clear physReqResourceAllBuses on bus reset.
2086 spin_lock_irqsave(&ohci->lock, flags);
2088 if (ohci->generation != generation) {
2094 * Note, if the node ID contains a non-local bus ID, physical DMA is
2095 * enabled for _all_ nodes on remote buses.
2098 n = (node_id & 0xffc0) == LOCAL_BUS ? node_id & 0x3f : 63;
2100 reg_write(ohci, OHCI1394_PhyReqFilterLoSet, 1 << n);
2102 reg_write(ohci, OHCI1394_PhyReqFilterHiSet, 1 << (n - 32));
2106 spin_unlock_irqrestore(&ohci->lock, flags);
2109 #endif /* CONFIG_FIREWIRE_OHCI_REMOTE_DMA */
2112 static u32 ohci_read_csr(struct fw_card *card, int csr_offset)
2114 struct fw_ohci *ohci = fw_ohci(card);
2115 unsigned long flags;
2118 switch (csr_offset) {
2119 case CSR_STATE_CLEAR:
2121 if (ohci->is_root &&
2122 (reg_read(ohci, OHCI1394_LinkControlSet) &
2123 OHCI1394_LinkControl_cycleMaster))
2124 value = CSR_STATE_BIT_CMSTR;
2127 if (ohci->csr_state_setclear_abdicate)
2128 value |= CSR_STATE_BIT_ABDICATE;
2133 return reg_read(ohci, OHCI1394_NodeID) << 16;
2135 case CSR_CYCLE_TIME:
2136 return get_cycle_time(ohci);
2140 * We might be called just after the cycle timer has wrapped
2141 * around but just before the cycle64Seconds handler, so we
2142 * better check here, too, if the bus time needs to be updated.
2144 spin_lock_irqsave(&ohci->lock, flags);
2145 value = update_bus_time(ohci);
2146 spin_unlock_irqrestore(&ohci->lock, flags);
2149 case CSR_BUSY_TIMEOUT:
2150 value = reg_read(ohci, OHCI1394_ATRetries);
2151 return (value >> 4) & 0x0ffff00f;
2153 case CSR_PRIORITY_BUDGET:
2154 return (reg_read(ohci, OHCI1394_FairnessControl) & 0x3f) |
2155 (ohci->pri_req_max << 8);
2163 static void ohci_write_csr(struct fw_card *card, int csr_offset, u32 value)
2165 struct fw_ohci *ohci = fw_ohci(card);
2166 unsigned long flags;
2168 switch (csr_offset) {
2169 case CSR_STATE_CLEAR:
2170 if ((value & CSR_STATE_BIT_CMSTR) && ohci->is_root) {
2171 reg_write(ohci, OHCI1394_LinkControlClear,
2172 OHCI1394_LinkControl_cycleMaster);
2175 if (value & CSR_STATE_BIT_ABDICATE)
2176 ohci->csr_state_setclear_abdicate = false;
2180 if ((value & CSR_STATE_BIT_CMSTR) && ohci->is_root) {
2181 reg_write(ohci, OHCI1394_LinkControlSet,
2182 OHCI1394_LinkControl_cycleMaster);
2185 if (value & CSR_STATE_BIT_ABDICATE)
2186 ohci->csr_state_setclear_abdicate = true;
2190 reg_write(ohci, OHCI1394_NodeID, value >> 16);
2194 case CSR_CYCLE_TIME:
2195 reg_write(ohci, OHCI1394_IsochronousCycleTimer, value);
2196 reg_write(ohci, OHCI1394_IntEventSet,
2197 OHCI1394_cycleInconsistent);
2202 spin_lock_irqsave(&ohci->lock, flags);
2203 ohci->bus_time = (ohci->bus_time & 0x7f) | (value & ~0x7f);
2204 spin_unlock_irqrestore(&ohci->lock, flags);
2207 case CSR_BUSY_TIMEOUT:
2208 value = (value & 0xf) | ((value & 0xf) << 4) |
2209 ((value & 0xf) << 8) | ((value & 0x0ffff000) << 4);
2210 reg_write(ohci, OHCI1394_ATRetries, value);
2214 case CSR_PRIORITY_BUDGET:
2215 reg_write(ohci, OHCI1394_FairnessControl, value & 0x3f);
2225 static void copy_iso_headers(struct iso_context *ctx, void *p)
2227 int i = ctx->header_length;
2229 if (i + ctx->base.header_size > PAGE_SIZE)
2233 * The iso header is byteswapped to little endian by
2234 * the controller, but the remaining header quadlets
2235 * are big endian. We want to present all the headers
2236 * as big endian, so we have to swap the first quadlet.
2238 if (ctx->base.header_size > 0)
2239 *(u32 *) (ctx->header + i) = __swab32(*(u32 *) (p + 4));
2240 if (ctx->base.header_size > 4)
2241 *(u32 *) (ctx->header + i + 4) = __swab32(*(u32 *) p);
2242 if (ctx->base.header_size > 8)
2243 memcpy(ctx->header + i + 8, p + 8, ctx->base.header_size - 8);
2244 ctx->header_length += ctx->base.header_size;
2247 static int handle_ir_packet_per_buffer(struct context *context,
2248 struct descriptor *d,
2249 struct descriptor *last)
2251 struct iso_context *ctx =
2252 container_of(context, struct iso_context, context);
2253 struct descriptor *pd;
2257 for (pd = d; pd <= last; pd++)
2258 if (pd->transfer_status)
2261 /* Descriptor(s) not done yet, stop iteration */
2265 copy_iso_headers(ctx, p);
2267 if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS) {
2268 ir_header = (__le32 *) p;
2269 ctx->base.callback.sc(&ctx->base,
2270 le32_to_cpu(ir_header[0]) & 0xffff,
2271 ctx->header_length, ctx->header,
2272 ctx->base.callback_data);
2273 ctx->header_length = 0;
2279 /* d == last because each descriptor block is only a single descriptor. */
2280 static int handle_ir_buffer_fill(struct context *context,
2281 struct descriptor *d,
2282 struct descriptor *last)
2284 struct iso_context *ctx =
2285 container_of(context, struct iso_context, context);
2287 if (!last->transfer_status)
2288 /* Descriptor(s) not done yet, stop iteration */
2291 if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS)
2292 ctx->base.callback.mc(&ctx->base,
2293 le32_to_cpu(last->data_address) +
2294 le16_to_cpu(last->req_count) -
2295 le16_to_cpu(last->res_count),
2296 ctx->base.callback_data);
2301 static int handle_it_packet(struct context *context,
2302 struct descriptor *d,
2303 struct descriptor *last)
2305 struct iso_context *ctx =
2306 container_of(context, struct iso_context, context);
2308 struct descriptor *pd;
2310 for (pd = d; pd <= last; pd++)
2311 if (pd->transfer_status)
2314 /* Descriptor(s) not done yet, stop iteration */
2317 i = ctx->header_length;
2318 if (i + 4 < PAGE_SIZE) {
2319 /* Present this value as big-endian to match the receive code */
2320 *(__be32 *)(ctx->header + i) = cpu_to_be32(
2321 ((u32)le16_to_cpu(pd->transfer_status) << 16) |
2322 le16_to_cpu(pd->res_count));
2323 ctx->header_length += 4;
2325 if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS) {
2326 ctx->base.callback.sc(&ctx->base, le16_to_cpu(last->res_count),
2327 ctx->header_length, ctx->header,
2328 ctx->base.callback_data);
2329 ctx->header_length = 0;
2334 static void set_multichannel_mask(struct fw_ohci *ohci, u64 channels)
2336 u32 hi = channels >> 32, lo = channels;
2338 reg_write(ohci, OHCI1394_IRMultiChanMaskHiClear, ~hi);
2339 reg_write(ohci, OHCI1394_IRMultiChanMaskLoClear, ~lo);
2340 reg_write(ohci, OHCI1394_IRMultiChanMaskHiSet, hi);
2341 reg_write(ohci, OHCI1394_IRMultiChanMaskLoSet, lo);
2343 ohci->mc_channels = channels;
2346 static struct fw_iso_context *ohci_allocate_iso_context(struct fw_card *card,
2347 int type, int channel, size_t header_size)
2349 struct fw_ohci *ohci = fw_ohci(card);
2350 struct iso_context *uninitialized_var(ctx);
2351 descriptor_callback_t uninitialized_var(callback);
2352 u64 *uninitialized_var(channels);
2353 u32 *uninitialized_var(mask), uninitialized_var(regs);
2354 unsigned long flags;
2355 int index, ret = -EBUSY;
2357 spin_lock_irqsave(&ohci->lock, flags);
2360 case FW_ISO_CONTEXT_TRANSMIT:
2361 mask = &ohci->it_context_mask;
2362 callback = handle_it_packet;
2363 index = ffs(*mask) - 1;
2365 *mask &= ~(1 << index);
2366 regs = OHCI1394_IsoXmitContextBase(index);
2367 ctx = &ohci->it_context_list[index];
2371 case FW_ISO_CONTEXT_RECEIVE:
2372 channels = &ohci->ir_context_channels;
2373 mask = &ohci->ir_context_mask;
2374 callback = handle_ir_packet_per_buffer;
2375 index = *channels & 1ULL << channel ? ffs(*mask) - 1 : -1;
2377 *channels &= ~(1ULL << channel);
2378 *mask &= ~(1 << index);
2379 regs = OHCI1394_IsoRcvContextBase(index);
2380 ctx = &ohci->ir_context_list[index];
2384 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2385 mask = &ohci->ir_context_mask;
2386 callback = handle_ir_buffer_fill;
2387 index = !ohci->mc_allocated ? ffs(*mask) - 1 : -1;
2389 ohci->mc_allocated = true;
2390 *mask &= ~(1 << index);
2391 regs = OHCI1394_IsoRcvContextBase(index);
2392 ctx = &ohci->ir_context_list[index];
2401 spin_unlock_irqrestore(&ohci->lock, flags);
2404 return ERR_PTR(ret);
2406 memset(ctx, 0, sizeof(*ctx));
2407 ctx->header_length = 0;
2408 ctx->header = (void *) __get_free_page(GFP_KERNEL);
2409 if (ctx->header == NULL) {
2413 ret = context_init(&ctx->context, ohci, regs, callback);
2415 goto out_with_header;
2417 if (type == FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL)
2418 set_multichannel_mask(ohci, 0);
2423 free_page((unsigned long)ctx->header);
2425 spin_lock_irqsave(&ohci->lock, flags);
2428 case FW_ISO_CONTEXT_RECEIVE:
2429 *channels |= 1ULL << channel;
2432 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2433 ohci->mc_allocated = false;
2436 *mask |= 1 << index;
2438 spin_unlock_irqrestore(&ohci->lock, flags);
2440 return ERR_PTR(ret);
2443 static int ohci_start_iso(struct fw_iso_context *base,
2444 s32 cycle, u32 sync, u32 tags)
2446 struct iso_context *ctx = container_of(base, struct iso_context, base);
2447 struct fw_ohci *ohci = ctx->context.ohci;
2448 u32 control = IR_CONTEXT_ISOCH_HEADER, match;
2451 switch (ctx->base.type) {
2452 case FW_ISO_CONTEXT_TRANSMIT:
2453 index = ctx - ohci->it_context_list;
2456 match = IT_CONTEXT_CYCLE_MATCH_ENABLE |
2457 (cycle & 0x7fff) << 16;
2459 reg_write(ohci, OHCI1394_IsoXmitIntEventClear, 1 << index);
2460 reg_write(ohci, OHCI1394_IsoXmitIntMaskSet, 1 << index);
2461 context_run(&ctx->context, match);
2464 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2465 control |= IR_CONTEXT_BUFFER_FILL|IR_CONTEXT_MULTI_CHANNEL_MODE;
2467 case FW_ISO_CONTEXT_RECEIVE:
2468 index = ctx - ohci->ir_context_list;
2469 match = (tags << 28) | (sync << 8) | ctx->base.channel;
2471 match |= (cycle & 0x07fff) << 12;
2472 control |= IR_CONTEXT_CYCLE_MATCH_ENABLE;
2475 reg_write(ohci, OHCI1394_IsoRecvIntEventClear, 1 << index);
2476 reg_write(ohci, OHCI1394_IsoRecvIntMaskSet, 1 << index);
2477 reg_write(ohci, CONTEXT_MATCH(ctx->context.regs), match);
2478 context_run(&ctx->context, control);
2485 static int ohci_stop_iso(struct fw_iso_context *base)
2487 struct fw_ohci *ohci = fw_ohci(base->card);
2488 struct iso_context *ctx = container_of(base, struct iso_context, base);
2491 switch (ctx->base.type) {
2492 case FW_ISO_CONTEXT_TRANSMIT:
2493 index = ctx - ohci->it_context_list;
2494 reg_write(ohci, OHCI1394_IsoXmitIntMaskClear, 1 << index);
2497 case FW_ISO_CONTEXT_RECEIVE:
2498 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2499 index = ctx - ohci->ir_context_list;
2500 reg_write(ohci, OHCI1394_IsoRecvIntMaskClear, 1 << index);
2504 context_stop(&ctx->context);
2509 static void ohci_free_iso_context(struct fw_iso_context *base)
2511 struct fw_ohci *ohci = fw_ohci(base->card);
2512 struct iso_context *ctx = container_of(base, struct iso_context, base);
2513 unsigned long flags;
2516 ohci_stop_iso(base);
2517 context_release(&ctx->context);
2518 free_page((unsigned long)ctx->header);
2520 spin_lock_irqsave(&ohci->lock, flags);
2522 switch (base->type) {
2523 case FW_ISO_CONTEXT_TRANSMIT:
2524 index = ctx - ohci->it_context_list;
2525 ohci->it_context_mask |= 1 << index;
2528 case FW_ISO_CONTEXT_RECEIVE:
2529 index = ctx - ohci->ir_context_list;
2530 ohci->ir_context_mask |= 1 << index;
2531 ohci->ir_context_channels |= 1ULL << base->channel;
2534 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2535 index = ctx - ohci->ir_context_list;
2536 ohci->ir_context_mask |= 1 << index;
2537 ohci->ir_context_channels |= ohci->mc_channels;
2538 ohci->mc_channels = 0;
2539 ohci->mc_allocated = false;
2543 spin_unlock_irqrestore(&ohci->lock, flags);
2546 static int ohci_set_iso_channels(struct fw_iso_context *base, u64 *channels)
2548 struct fw_ohci *ohci = fw_ohci(base->card);
2549 unsigned long flags;
2552 switch (base->type) {
2553 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2555 spin_lock_irqsave(&ohci->lock, flags);
2557 /* Don't allow multichannel to grab other contexts' channels. */
2558 if (~ohci->ir_context_channels & ~ohci->mc_channels & *channels) {
2559 *channels = ohci->ir_context_channels;
2562 set_multichannel_mask(ohci, *channels);
2566 spin_unlock_irqrestore(&ohci->lock, flags);
2576 static int queue_iso_transmit(struct iso_context *ctx,
2577 struct fw_iso_packet *packet,
2578 struct fw_iso_buffer *buffer,
2579 unsigned long payload)
2581 struct descriptor *d, *last, *pd;
2582 struct fw_iso_packet *p;
2584 dma_addr_t d_bus, page_bus;
2585 u32 z, header_z, payload_z, irq;
2586 u32 payload_index, payload_end_index, next_page_index;
2587 int page, end_page, i, length, offset;
2590 payload_index = payload;
2596 if (p->header_length > 0)
2599 /* Determine the first page the payload isn't contained in. */
2600 end_page = PAGE_ALIGN(payload_index + p->payload_length) >> PAGE_SHIFT;
2601 if (p->payload_length > 0)
2602 payload_z = end_page - (payload_index >> PAGE_SHIFT);
2608 /* Get header size in number of descriptors. */
2609 header_z = DIV_ROUND_UP(p->header_length, sizeof(*d));
2611 d = context_get_descriptors(&ctx->context, z + header_z, &d_bus);
2616 d[0].control = cpu_to_le16(DESCRIPTOR_KEY_IMMEDIATE);
2617 d[0].req_count = cpu_to_le16(8);
2619 * Link the skip address to this descriptor itself. This causes
2620 * a context to skip a cycle whenever lost cycles or FIFO
2621 * overruns occur, without dropping the data. The application
2622 * should then decide whether this is an error condition or not.
2623 * FIXME: Make the context's cycle-lost behaviour configurable?
2625 d[0].branch_address = cpu_to_le32(d_bus | z);
2627 header = (__le32 *) &d[1];
2628 header[0] = cpu_to_le32(IT_HEADER_SY(p->sy) |
2629 IT_HEADER_TAG(p->tag) |
2630 IT_HEADER_TCODE(TCODE_STREAM_DATA) |
2631 IT_HEADER_CHANNEL(ctx->base.channel) |
2632 IT_HEADER_SPEED(ctx->base.speed));
2634 cpu_to_le32(IT_HEADER_DATA_LENGTH(p->header_length +
2635 p->payload_length));
2638 if (p->header_length > 0) {
2639 d[2].req_count = cpu_to_le16(p->header_length);
2640 d[2].data_address = cpu_to_le32(d_bus + z * sizeof(*d));
2641 memcpy(&d[z], p->header, p->header_length);
2644 pd = d + z - payload_z;
2645 payload_end_index = payload_index + p->payload_length;
2646 for (i = 0; i < payload_z; i++) {
2647 page = payload_index >> PAGE_SHIFT;
2648 offset = payload_index & ~PAGE_MASK;
2649 next_page_index = (page + 1) << PAGE_SHIFT;
2651 min(next_page_index, payload_end_index) - payload_index;
2652 pd[i].req_count = cpu_to_le16(length);
2654 page_bus = page_private(buffer->pages[page]);
2655 pd[i].data_address = cpu_to_le32(page_bus + offset);
2657 payload_index += length;
2661 irq = DESCRIPTOR_IRQ_ALWAYS;
2663 irq = DESCRIPTOR_NO_IRQ;
2665 last = z == 2 ? d : d + z - 1;
2666 last->control |= cpu_to_le16(DESCRIPTOR_OUTPUT_LAST |
2668 DESCRIPTOR_BRANCH_ALWAYS |
2671 context_append(&ctx->context, d, z, header_z);
2676 static int queue_iso_packet_per_buffer(struct iso_context *ctx,
2677 struct fw_iso_packet *packet,
2678 struct fw_iso_buffer *buffer,
2679 unsigned long payload)
2681 struct descriptor *d, *pd;
2682 dma_addr_t d_bus, page_bus;
2683 u32 z, header_z, rest;
2685 int page, offset, packet_count, header_size, payload_per_buffer;
2688 * The OHCI controller puts the isochronous header and trailer in the
2689 * buffer, so we need at least 8 bytes.
2691 packet_count = packet->header_length / ctx->base.header_size;
2692 header_size = max(ctx->base.header_size, (size_t)8);
2694 /* Get header size in number of descriptors. */
2695 header_z = DIV_ROUND_UP(header_size, sizeof(*d));
2696 page = payload >> PAGE_SHIFT;
2697 offset = payload & ~PAGE_MASK;
2698 payload_per_buffer = packet->payload_length / packet_count;
2700 for (i = 0; i < packet_count; i++) {
2701 /* d points to the header descriptor */
2702 z = DIV_ROUND_UP(payload_per_buffer + offset, PAGE_SIZE) + 1;
2703 d = context_get_descriptors(&ctx->context,
2704 z + header_z, &d_bus);
2708 d->control = cpu_to_le16(DESCRIPTOR_STATUS |
2709 DESCRIPTOR_INPUT_MORE);
2710 if (packet->skip && i == 0)
2711 d->control |= cpu_to_le16(DESCRIPTOR_WAIT);
2712 d->req_count = cpu_to_le16(header_size);
2713 d->res_count = d->req_count;
2714 d->transfer_status = 0;
2715 d->data_address = cpu_to_le32(d_bus + (z * sizeof(*d)));
2717 rest = payload_per_buffer;
2719 for (j = 1; j < z; j++) {
2721 pd->control = cpu_to_le16(DESCRIPTOR_STATUS |
2722 DESCRIPTOR_INPUT_MORE);
2724 if (offset + rest < PAGE_SIZE)
2727 length = PAGE_SIZE - offset;
2728 pd->req_count = cpu_to_le16(length);
2729 pd->res_count = pd->req_count;
2730 pd->transfer_status = 0;
2732 page_bus = page_private(buffer->pages[page]);
2733 pd->data_address = cpu_to_le32(page_bus + offset);
2735 offset = (offset + length) & ~PAGE_MASK;
2740 pd->control = cpu_to_le16(DESCRIPTOR_STATUS |
2741 DESCRIPTOR_INPUT_LAST |
2742 DESCRIPTOR_BRANCH_ALWAYS);
2743 if (packet->interrupt && i == packet_count - 1)
2744 pd->control |= cpu_to_le16(DESCRIPTOR_IRQ_ALWAYS);
2746 context_append(&ctx->context, d, z, header_z);
2752 static int queue_iso_buffer_fill(struct iso_context *ctx,
2753 struct fw_iso_packet *packet,
2754 struct fw_iso_buffer *buffer,
2755 unsigned long payload)
2757 struct descriptor *d;
2758 dma_addr_t d_bus, page_bus;
2759 int page, offset, rest, z, i, length;
2761 page = payload >> PAGE_SHIFT;
2762 offset = payload & ~PAGE_MASK;
2763 rest = packet->payload_length;
2765 /* We need one descriptor for each page in the buffer. */
2766 z = DIV_ROUND_UP(offset + rest, PAGE_SIZE);
2768 if (WARN_ON(offset & 3 || rest & 3 || page + z > buffer->page_count))
2771 for (i = 0; i < z; i++) {
2772 d = context_get_descriptors(&ctx->context, 1, &d_bus);
2776 d->control = cpu_to_le16(DESCRIPTOR_INPUT_MORE |
2777 DESCRIPTOR_BRANCH_ALWAYS);
2778 if (packet->skip && i == 0)
2779 d->control |= cpu_to_le16(DESCRIPTOR_WAIT);
2780 if (packet->interrupt && i == z - 1)
2781 d->control |= cpu_to_le16(DESCRIPTOR_IRQ_ALWAYS);
2783 if (offset + rest < PAGE_SIZE)
2786 length = PAGE_SIZE - offset;
2787 d->req_count = cpu_to_le16(length);
2788 d->res_count = d->req_count;
2789 d->transfer_status = 0;
2791 page_bus = page_private(buffer->pages[page]);
2792 d->data_address = cpu_to_le32(page_bus + offset);
2798 context_append(&ctx->context, d, 1, 0);
2804 static int ohci_queue_iso(struct fw_iso_context *base,
2805 struct fw_iso_packet *packet,
2806 struct fw_iso_buffer *buffer,
2807 unsigned long payload)
2809 struct iso_context *ctx = container_of(base, struct iso_context, base);
2810 unsigned long flags;
2813 spin_lock_irqsave(&ctx->context.ohci->lock, flags);
2814 switch (base->type) {
2815 case FW_ISO_CONTEXT_TRANSMIT:
2816 ret = queue_iso_transmit(ctx, packet, buffer, payload);
2818 case FW_ISO_CONTEXT_RECEIVE:
2819 ret = queue_iso_packet_per_buffer(ctx, packet, buffer, payload);
2821 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2822 ret = queue_iso_buffer_fill(ctx, packet, buffer, payload);
2825 spin_unlock_irqrestore(&ctx->context.ohci->lock, flags);
2830 static const struct fw_card_driver ohci_driver = {
2831 .enable = ohci_enable,
2832 .read_phy_reg = ohci_read_phy_reg,
2833 .update_phy_reg = ohci_update_phy_reg,
2834 .set_config_rom = ohci_set_config_rom,
2835 .send_request = ohci_send_request,
2836 .send_response = ohci_send_response,
2837 .cancel_packet = ohci_cancel_packet,
2838 .enable_phys_dma = ohci_enable_phys_dma,
2839 .read_csr = ohci_read_csr,
2840 .write_csr = ohci_write_csr,
2842 .allocate_iso_context = ohci_allocate_iso_context,
2843 .free_iso_context = ohci_free_iso_context,
2844 .set_iso_channels = ohci_set_iso_channels,
2845 .queue_iso = ohci_queue_iso,
2846 .start_iso = ohci_start_iso,
2847 .stop_iso = ohci_stop_iso,
2850 #ifdef CONFIG_PPC_PMAC
2851 static void pmac_ohci_on(struct pci_dev *dev)
2853 if (machine_is(powermac)) {
2854 struct device_node *ofn = pci_device_to_OF_node(dev);
2857 pmac_call_feature(PMAC_FTR_1394_CABLE_POWER, ofn, 0, 1);
2858 pmac_call_feature(PMAC_FTR_1394_ENABLE, ofn, 0, 1);
2863 static void pmac_ohci_off(struct pci_dev *dev)
2865 if (machine_is(powermac)) {
2866 struct device_node *ofn = pci_device_to_OF_node(dev);
2869 pmac_call_feature(PMAC_FTR_1394_ENABLE, ofn, 0, 0);
2870 pmac_call_feature(PMAC_FTR_1394_CABLE_POWER, ofn, 0, 0);
2875 static inline void pmac_ohci_on(struct pci_dev *dev) {}
2876 static inline void pmac_ohci_off(struct pci_dev *dev) {}
2877 #endif /* CONFIG_PPC_PMAC */
2879 static int __devinit pci_probe(struct pci_dev *dev,
2880 const struct pci_device_id *ent)
2882 struct fw_ohci *ohci;
2883 u32 bus_options, max_receive, link_speed, version;
2885 int i, err, n_ir, n_it;
2888 ohci = kzalloc(sizeof(*ohci), GFP_KERNEL);
2894 fw_card_initialize(&ohci->card, &ohci_driver, &dev->dev);
2898 err = pci_enable_device(dev);
2900 fw_error("Failed to enable OHCI hardware\n");
2904 pci_set_master(dev);
2905 pci_write_config_dword(dev, OHCI1394_PCI_HCI_Control, 0);
2906 pci_set_drvdata(dev, ohci);
2908 spin_lock_init(&ohci->lock);
2909 mutex_init(&ohci->phy_reg_mutex);
2911 tasklet_init(&ohci->bus_reset_tasklet,
2912 bus_reset_tasklet, (unsigned long)ohci);
2914 err = pci_request_region(dev, 0, ohci_driver_name);
2916 fw_error("MMIO resource unavailable\n");
2920 ohci->registers = pci_iomap(dev, 0, OHCI1394_REGISTER_SIZE);
2921 if (ohci->registers == NULL) {
2922 fw_error("Failed to remap registers\n");
2927 for (i = 0; i < ARRAY_SIZE(ohci_quirks); i++)
2928 if (ohci_quirks[i].vendor == dev->vendor &&
2929 (ohci_quirks[i].device == dev->device ||
2930 ohci_quirks[i].device == (unsigned short)PCI_ANY_ID)) {
2931 ohci->quirks = ohci_quirks[i].flags;
2935 ohci->quirks = param_quirks;
2937 ar_context_init(&ohci->ar_request_ctx, ohci,
2938 OHCI1394_AsReqRcvContextControlSet);
2940 ar_context_init(&ohci->ar_response_ctx, ohci,
2941 OHCI1394_AsRspRcvContextControlSet);
2943 context_init(&ohci->at_request_ctx, ohci,
2944 OHCI1394_AsReqTrContextControlSet, handle_at_packet);
2946 context_init(&ohci->at_response_ctx, ohci,
2947 OHCI1394_AsRspTrContextControlSet, handle_at_packet);
2949 reg_write(ohci, OHCI1394_IsoRecvIntMaskSet, ~0);
2950 ohci->ir_context_channels = ~0ULL;
2951 ohci->ir_context_mask = reg_read(ohci, OHCI1394_IsoRecvIntMaskSet);
2952 reg_write(ohci, OHCI1394_IsoRecvIntMaskClear, ~0);
2953 n_ir = hweight32(ohci->ir_context_mask);
2954 size = sizeof(struct iso_context) * n_ir;
2955 ohci->ir_context_list = kzalloc(size, GFP_KERNEL);
2957 reg_write(ohci, OHCI1394_IsoXmitIntMaskSet, ~0);
2958 ohci->it_context_mask = reg_read(ohci, OHCI1394_IsoXmitIntMaskSet);
2959 reg_write(ohci, OHCI1394_IsoXmitIntMaskClear, ~0);
2960 n_it = hweight32(ohci->it_context_mask);
2961 size = sizeof(struct iso_context) * n_it;
2962 ohci->it_context_list = kzalloc(size, GFP_KERNEL);
2964 if (ohci->it_context_list == NULL || ohci->ir_context_list == NULL) {
2969 /* self-id dma buffer allocation */
2970 ohci->self_id_cpu = dma_alloc_coherent(ohci->card.device,
2974 if (ohci->self_id_cpu == NULL) {
2979 bus_options = reg_read(ohci, OHCI1394_BusOptions);
2980 max_receive = (bus_options >> 12) & 0xf;
2981 link_speed = bus_options & 0x7;
2982 guid = ((u64) reg_read(ohci, OHCI1394_GUIDHi) << 32) |
2983 reg_read(ohci, OHCI1394_GUIDLo);
2985 err = fw_card_add(&ohci->card, max_receive, link_speed, guid);
2989 version = reg_read(ohci, OHCI1394_Version) & 0x00ff00ff;
2990 fw_notify("Added fw-ohci device %s, OHCI v%x.%x, "
2991 "%d IR + %d IT contexts, quirks 0x%x\n",
2992 dev_name(&dev->dev), version >> 16, version & 0xff,
2993 n_ir, n_it, ohci->quirks);
2998 dma_free_coherent(ohci->card.device, SELF_ID_BUF_SIZE,
2999 ohci->self_id_cpu, ohci->self_id_bus);
3001 kfree(ohci->ir_context_list);
3002 kfree(ohci->it_context_list);
3003 context_release(&ohci->at_response_ctx);
3004 context_release(&ohci->at_request_ctx);
3005 ar_context_release(&ohci->ar_response_ctx);
3006 ar_context_release(&ohci->ar_request_ctx);
3007 pci_iounmap(dev, ohci->registers);
3009 pci_release_region(dev, 0);
3011 pci_disable_device(dev);
3017 fw_error("Out of memory\n");
3022 static void pci_remove(struct pci_dev *dev)
3024 struct fw_ohci *ohci;
3026 ohci = pci_get_drvdata(dev);
3027 reg_write(ohci, OHCI1394_IntMaskClear, ~0);
3029 fw_core_remove_card(&ohci->card);
3032 * FIXME: Fail all pending packets here, now that the upper
3033 * layers can't queue any more.
3036 software_reset(ohci);
3037 free_irq(dev->irq, ohci);
3039 if (ohci->next_config_rom && ohci->next_config_rom != ohci->config_rom)
3040 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
3041 ohci->next_config_rom, ohci->next_config_rom_bus);
3042 if (ohci->config_rom)
3043 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
3044 ohci->config_rom, ohci->config_rom_bus);
3045 dma_free_coherent(ohci->card.device, SELF_ID_BUF_SIZE,
3046 ohci->self_id_cpu, ohci->self_id_bus);
3047 ar_context_release(&ohci->ar_request_ctx);
3048 ar_context_release(&ohci->ar_response_ctx);
3049 context_release(&ohci->at_request_ctx);
3050 context_release(&ohci->at_response_ctx);
3051 kfree(ohci->it_context_list);
3052 kfree(ohci->ir_context_list);
3053 pci_disable_msi(dev);
3054 pci_iounmap(dev, ohci->registers);
3055 pci_release_region(dev, 0);
3056 pci_disable_device(dev);
3060 fw_notify("Removed fw-ohci device.\n");
3064 static int pci_suspend(struct pci_dev *dev, pm_message_t state)
3066 struct fw_ohci *ohci = pci_get_drvdata(dev);
3069 software_reset(ohci);
3070 free_irq(dev->irq, ohci);
3071 pci_disable_msi(dev);
3072 err = pci_save_state(dev);
3074 fw_error("pci_save_state failed\n");
3077 err = pci_set_power_state(dev, pci_choose_state(dev, state));
3079 fw_error("pci_set_power_state failed with %d\n", err);
3085 static int pci_resume(struct pci_dev *dev)
3087 struct fw_ohci *ohci = pci_get_drvdata(dev);
3091 pci_set_power_state(dev, PCI_D0);
3092 pci_restore_state(dev);
3093 err = pci_enable_device(dev);
3095 fw_error("pci_enable_device failed\n");
3099 return ohci_enable(&ohci->card, NULL, 0);
3103 static const struct pci_device_id pci_table[] = {
3104 { PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_FIREWIRE_OHCI, ~0) },
3108 MODULE_DEVICE_TABLE(pci, pci_table);
3110 static struct pci_driver fw_ohci_pci_driver = {
3111 .name = ohci_driver_name,
3112 .id_table = pci_table,
3114 .remove = pci_remove,
3116 .resume = pci_resume,
3117 .suspend = pci_suspend,
3121 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
3122 MODULE_DESCRIPTION("Driver for PCI OHCI IEEE1394 controllers");
3123 MODULE_LICENSE("GPL");
3125 /* Provide a module alias so root-on-sbp2 initrds don't break. */
3126 #ifndef CONFIG_IEEE1394_OHCI1394_MODULE
3127 MODULE_ALIAS("ohci1394");
3130 static int __init fw_ohci_init(void)
3132 return pci_register_driver(&fw_ohci_pci_driver);
3135 static void __exit fw_ohci_cleanup(void)
3137 pci_unregister_driver(&fw_ohci_pci_driver);
3140 module_init(fw_ohci_init);
3141 module_exit(fw_ohci_cleanup);