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>
43 #include <linux/vmalloc.h>
45 #include <asm/byteorder.h>
47 #include <asm/system.h>
49 #ifdef CONFIG_PPC_PMAC
50 #include <asm/pmac_feature.h>
56 #define DESCRIPTOR_OUTPUT_MORE 0
57 #define DESCRIPTOR_OUTPUT_LAST (1 << 12)
58 #define DESCRIPTOR_INPUT_MORE (2 << 12)
59 #define DESCRIPTOR_INPUT_LAST (3 << 12)
60 #define DESCRIPTOR_STATUS (1 << 11)
61 #define DESCRIPTOR_KEY_IMMEDIATE (2 << 8)
62 #define DESCRIPTOR_PING (1 << 7)
63 #define DESCRIPTOR_YY (1 << 6)
64 #define DESCRIPTOR_NO_IRQ (0 << 4)
65 #define DESCRIPTOR_IRQ_ERROR (1 << 4)
66 #define DESCRIPTOR_IRQ_ALWAYS (3 << 4)
67 #define DESCRIPTOR_BRANCH_ALWAYS (3 << 2)
68 #define DESCRIPTOR_WAIT (3 << 0)
74 __le32 branch_address;
76 __le16 transfer_status;
77 } __attribute__((aligned(16)));
79 #define CONTROL_SET(regs) (regs)
80 #define CONTROL_CLEAR(regs) ((regs) + 4)
81 #define COMMAND_PTR(regs) ((regs) + 12)
82 #define CONTEXT_MATCH(regs) ((regs) + 16)
84 #define AR_BUFFER_SIZE (32*1024)
85 #define AR_BUFFERS_MIN DIV_ROUND_UP(AR_BUFFER_SIZE, PAGE_SIZE)
86 /* we need at least two pages for proper list management */
87 #define AR_BUFFERS (AR_BUFFERS_MIN >= 2 ? AR_BUFFERS_MIN : 2)
89 #define MAX_ASYNC_PAYLOAD 4096
90 #define MAX_AR_PACKET_SIZE (16 + MAX_ASYNC_PAYLOAD + 4)
91 #define AR_WRAPAROUND_PAGES DIV_ROUND_UP(MAX_AR_PACKET_SIZE, PAGE_SIZE)
95 struct page *pages[AR_BUFFERS];
97 struct descriptor *descriptors;
98 dma_addr_t descriptors_bus;
100 unsigned int last_buffer_index;
102 struct tasklet_struct tasklet;
107 typedef int (*descriptor_callback_t)(struct context *ctx,
108 struct descriptor *d,
109 struct descriptor *last);
112 * A buffer that contains a block of DMA-able coherent memory used for
113 * storing a portion of a DMA descriptor program.
115 struct descriptor_buffer {
116 struct list_head list;
117 dma_addr_t buffer_bus;
120 struct descriptor buffer[0];
124 struct fw_ohci *ohci;
126 int total_allocation;
129 * List of page-sized buffers for storing DMA descriptors.
130 * Head of list contains buffers in use and tail of list contains
133 struct list_head buffer_list;
136 * Pointer to a buffer inside buffer_list that contains the tail
137 * end of the current DMA program.
139 struct descriptor_buffer *buffer_tail;
142 * The descriptor containing the branch address of the first
143 * descriptor that has not yet been filled by the device.
145 struct descriptor *last;
148 * The last descriptor in the DMA program. It contains the branch
149 * address that must be updated upon appending a new descriptor.
151 struct descriptor *prev;
153 descriptor_callback_t callback;
155 struct tasklet_struct tasklet;
158 #define IT_HEADER_SY(v) ((v) << 0)
159 #define IT_HEADER_TCODE(v) ((v) << 4)
160 #define IT_HEADER_CHANNEL(v) ((v) << 8)
161 #define IT_HEADER_TAG(v) ((v) << 14)
162 #define IT_HEADER_SPEED(v) ((v) << 16)
163 #define IT_HEADER_DATA_LENGTH(v) ((v) << 16)
166 struct fw_iso_context base;
167 struct context context;
170 size_t header_length;
173 #define CONFIG_ROM_SIZE 1024
178 __iomem char *registers;
181 int request_generation; /* for timestamping incoming requests */
183 unsigned int pri_req_max;
186 bool csr_state_setclear_abdicate;
189 * Spinlock for accessing fw_ohci data. Never call out of
190 * this driver with this lock held.
194 struct mutex phy_reg_mutex;
196 struct ar_context ar_request_ctx;
197 struct ar_context ar_response_ctx;
198 struct context at_request_ctx;
199 struct context at_response_ctx;
201 u32 it_context_mask; /* unoccupied IT contexts */
202 struct iso_context *it_context_list;
203 u64 ir_context_channels; /* unoccupied channels */
204 u32 ir_context_mask; /* unoccupied IR contexts */
205 struct iso_context *ir_context_list;
206 u64 mc_channels; /* channels in use by the multichannel IR context */
210 dma_addr_t config_rom_bus;
211 __be32 *next_config_rom;
212 dma_addr_t next_config_rom_bus;
216 dma_addr_t self_id_bus;
217 struct tasklet_struct bus_reset_tasklet;
219 u32 self_id_buffer[512];
222 static inline struct fw_ohci *fw_ohci(struct fw_card *card)
224 return container_of(card, struct fw_ohci, card);
227 #define IT_CONTEXT_CYCLE_MATCH_ENABLE 0x80000000
228 #define IR_CONTEXT_BUFFER_FILL 0x80000000
229 #define IR_CONTEXT_ISOCH_HEADER 0x40000000
230 #define IR_CONTEXT_CYCLE_MATCH_ENABLE 0x20000000
231 #define IR_CONTEXT_MULTI_CHANNEL_MODE 0x10000000
232 #define IR_CONTEXT_DUAL_BUFFER_MODE 0x08000000
234 #define CONTEXT_RUN 0x8000
235 #define CONTEXT_WAKE 0x1000
236 #define CONTEXT_DEAD 0x0800
237 #define CONTEXT_ACTIVE 0x0400
239 #define OHCI1394_MAX_AT_REQ_RETRIES 0xf
240 #define OHCI1394_MAX_AT_RESP_RETRIES 0x2
241 #define OHCI1394_MAX_PHYS_RESP_RETRIES 0x8
243 #define OHCI1394_REGISTER_SIZE 0x800
244 #define OHCI_LOOP_COUNT 500
245 #define OHCI1394_PCI_HCI_Control 0x40
246 #define SELF_ID_BUF_SIZE 0x800
247 #define OHCI_TCODE_PHY_PACKET 0x0e
248 #define OHCI_VERSION_1_1 0x010010
250 static char ohci_driver_name[] = KBUILD_MODNAME;
252 #define PCI_DEVICE_ID_AGERE_FW643 0x5901
253 #define PCI_DEVICE_ID_JMICRON_JMB38X_FW 0x2380
254 #define PCI_DEVICE_ID_TI_TSB12LV22 0x8009
256 #define QUIRK_CYCLE_TIMER 1
257 #define QUIRK_RESET_PACKET 2
258 #define QUIRK_BE_HEADERS 4
259 #define QUIRK_NO_1394A 8
260 #define QUIRK_NO_MSI 16
262 /* In case of multiple matches in ohci_quirks[], only the first one is used. */
263 static const struct {
264 unsigned short vendor, device, revision, flags;
266 {PCI_VENDOR_ID_AL, PCI_ANY_ID, PCI_ANY_ID,
269 {PCI_VENDOR_ID_APPLE, PCI_DEVICE_ID_APPLE_UNI_N_FW, PCI_ANY_ID,
272 {PCI_VENDOR_ID_ATT, PCI_DEVICE_ID_AGERE_FW643, 6,
275 {PCI_VENDOR_ID_JMICRON, PCI_DEVICE_ID_JMICRON_JMB38X_FW, PCI_ANY_ID,
278 {PCI_VENDOR_ID_NEC, PCI_ANY_ID, PCI_ANY_ID,
281 {PCI_VENDOR_ID_RICOH, PCI_ANY_ID, PCI_ANY_ID,
284 {PCI_VENDOR_ID_TI, PCI_DEVICE_ID_TI_TSB12LV22, PCI_ANY_ID,
285 QUIRK_CYCLE_TIMER | QUIRK_RESET_PACKET | QUIRK_NO_1394A},
287 {PCI_VENDOR_ID_TI, PCI_ANY_ID, PCI_ANY_ID,
290 {PCI_VENDOR_ID_VIA, PCI_ANY_ID, PCI_ANY_ID,
291 QUIRK_CYCLE_TIMER | QUIRK_NO_MSI},
294 /* This overrides anything that was found in ohci_quirks[]. */
295 static int param_quirks;
296 module_param_named(quirks, param_quirks, int, 0644);
297 MODULE_PARM_DESC(quirks, "Chip quirks (default = 0"
298 ", nonatomic cycle timer = " __stringify(QUIRK_CYCLE_TIMER)
299 ", reset packet generation = " __stringify(QUIRK_RESET_PACKET)
300 ", AR/selfID endianess = " __stringify(QUIRK_BE_HEADERS)
301 ", no 1394a enhancements = " __stringify(QUIRK_NO_1394A)
302 ", disable MSI = " __stringify(QUIRK_NO_MSI)
305 #define OHCI_PARAM_DEBUG_AT_AR 1
306 #define OHCI_PARAM_DEBUG_SELFIDS 2
307 #define OHCI_PARAM_DEBUG_IRQS 4
308 #define OHCI_PARAM_DEBUG_BUSRESETS 8 /* only effective before chip init */
310 #ifdef CONFIG_FIREWIRE_OHCI_DEBUG
312 static int param_debug;
313 module_param_named(debug, param_debug, int, 0644);
314 MODULE_PARM_DESC(debug, "Verbose logging (default = 0"
315 ", AT/AR events = " __stringify(OHCI_PARAM_DEBUG_AT_AR)
316 ", self-IDs = " __stringify(OHCI_PARAM_DEBUG_SELFIDS)
317 ", IRQs = " __stringify(OHCI_PARAM_DEBUG_IRQS)
318 ", busReset events = " __stringify(OHCI_PARAM_DEBUG_BUSRESETS)
319 ", or a combination, or all = -1)");
321 static void log_irqs(u32 evt)
323 if (likely(!(param_debug &
324 (OHCI_PARAM_DEBUG_IRQS | OHCI_PARAM_DEBUG_BUSRESETS))))
327 if (!(param_debug & OHCI_PARAM_DEBUG_IRQS) &&
328 !(evt & OHCI1394_busReset))
331 fw_notify("IRQ %08x%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n", evt,
332 evt & OHCI1394_selfIDComplete ? " selfID" : "",
333 evt & OHCI1394_RQPkt ? " AR_req" : "",
334 evt & OHCI1394_RSPkt ? " AR_resp" : "",
335 evt & OHCI1394_reqTxComplete ? " AT_req" : "",
336 evt & OHCI1394_respTxComplete ? " AT_resp" : "",
337 evt & OHCI1394_isochRx ? " IR" : "",
338 evt & OHCI1394_isochTx ? " IT" : "",
339 evt & OHCI1394_postedWriteErr ? " postedWriteErr" : "",
340 evt & OHCI1394_cycleTooLong ? " cycleTooLong" : "",
341 evt & OHCI1394_cycle64Seconds ? " cycle64Seconds" : "",
342 evt & OHCI1394_cycleInconsistent ? " cycleInconsistent" : "",
343 evt & OHCI1394_regAccessFail ? " regAccessFail" : "",
344 evt & OHCI1394_busReset ? " busReset" : "",
345 evt & ~(OHCI1394_selfIDComplete | OHCI1394_RQPkt |
346 OHCI1394_RSPkt | OHCI1394_reqTxComplete |
347 OHCI1394_respTxComplete | OHCI1394_isochRx |
348 OHCI1394_isochTx | OHCI1394_postedWriteErr |
349 OHCI1394_cycleTooLong | OHCI1394_cycle64Seconds |
350 OHCI1394_cycleInconsistent |
351 OHCI1394_regAccessFail | OHCI1394_busReset)
355 static const char *speed[] = {
356 [0] = "S100", [1] = "S200", [2] = "S400", [3] = "beta",
358 static const char *power[] = {
359 [0] = "+0W", [1] = "+15W", [2] = "+30W", [3] = "+45W",
360 [4] = "-3W", [5] = " ?W", [6] = "-3..-6W", [7] = "-3..-10W",
362 static const char port[] = { '.', '-', 'p', 'c', };
364 static char _p(u32 *s, int shift)
366 return port[*s >> shift & 3];
369 static void log_selfids(int node_id, int generation, int self_id_count, u32 *s)
371 if (likely(!(param_debug & OHCI_PARAM_DEBUG_SELFIDS)))
374 fw_notify("%d selfIDs, generation %d, local node ID %04x\n",
375 self_id_count, generation, node_id);
377 for (; self_id_count--; ++s)
378 if ((*s & 1 << 23) == 0)
379 fw_notify("selfID 0: %08x, phy %d [%c%c%c] "
380 "%s gc=%d %s %s%s%s\n",
381 *s, *s >> 24 & 63, _p(s, 6), _p(s, 4), _p(s, 2),
382 speed[*s >> 14 & 3], *s >> 16 & 63,
383 power[*s >> 8 & 7], *s >> 22 & 1 ? "L" : "",
384 *s >> 11 & 1 ? "c" : "", *s & 2 ? "i" : "");
386 fw_notify("selfID n: %08x, phy %d [%c%c%c%c%c%c%c%c]\n",
388 _p(s, 16), _p(s, 14), _p(s, 12), _p(s, 10),
389 _p(s, 8), _p(s, 6), _p(s, 4), _p(s, 2));
392 static const char *evts[] = {
393 [0x00] = "evt_no_status", [0x01] = "-reserved-",
394 [0x02] = "evt_long_packet", [0x03] = "evt_missing_ack",
395 [0x04] = "evt_underrun", [0x05] = "evt_overrun",
396 [0x06] = "evt_descriptor_read", [0x07] = "evt_data_read",
397 [0x08] = "evt_data_write", [0x09] = "evt_bus_reset",
398 [0x0a] = "evt_timeout", [0x0b] = "evt_tcode_err",
399 [0x0c] = "-reserved-", [0x0d] = "-reserved-",
400 [0x0e] = "evt_unknown", [0x0f] = "evt_flushed",
401 [0x10] = "-reserved-", [0x11] = "ack_complete",
402 [0x12] = "ack_pending ", [0x13] = "-reserved-",
403 [0x14] = "ack_busy_X", [0x15] = "ack_busy_A",
404 [0x16] = "ack_busy_B", [0x17] = "-reserved-",
405 [0x18] = "-reserved-", [0x19] = "-reserved-",
406 [0x1a] = "-reserved-", [0x1b] = "ack_tardy",
407 [0x1c] = "-reserved-", [0x1d] = "ack_data_error",
408 [0x1e] = "ack_type_error", [0x1f] = "-reserved-",
409 [0x20] = "pending/cancelled",
411 static const char *tcodes[] = {
412 [0x0] = "QW req", [0x1] = "BW req",
413 [0x2] = "W resp", [0x3] = "-reserved-",
414 [0x4] = "QR req", [0x5] = "BR req",
415 [0x6] = "QR resp", [0x7] = "BR resp",
416 [0x8] = "cycle start", [0x9] = "Lk req",
417 [0xa] = "async stream packet", [0xb] = "Lk resp",
418 [0xc] = "-reserved-", [0xd] = "-reserved-",
419 [0xe] = "link internal", [0xf] = "-reserved-",
422 static void log_ar_at_event(char dir, int speed, u32 *header, int evt)
424 int tcode = header[0] >> 4 & 0xf;
427 if (likely(!(param_debug & OHCI_PARAM_DEBUG_AT_AR)))
430 if (unlikely(evt >= ARRAY_SIZE(evts)))
433 if (evt == OHCI1394_evt_bus_reset) {
434 fw_notify("A%c evt_bus_reset, generation %d\n",
435 dir, (header[2] >> 16) & 0xff);
440 case 0x0: case 0x6: case 0x8:
441 snprintf(specific, sizeof(specific), " = %08x",
442 be32_to_cpu((__force __be32)header[3]));
444 case 0x1: case 0x5: case 0x7: case 0x9: case 0xb:
445 snprintf(specific, sizeof(specific), " %x,%x",
446 header[3] >> 16, header[3] & 0xffff);
454 fw_notify("A%c %s, %s\n", dir, evts[evt], tcodes[tcode]);
457 fw_notify("A%c %s, PHY %08x %08x\n",
458 dir, evts[evt], header[1], header[2]);
460 case 0x0: case 0x1: case 0x4: case 0x5: case 0x9:
461 fw_notify("A%c spd %x tl %02x, "
464 dir, speed, header[0] >> 10 & 0x3f,
465 header[1] >> 16, header[0] >> 16, evts[evt],
466 tcodes[tcode], header[1] & 0xffff, header[2], specific);
469 fw_notify("A%c spd %x tl %02x, "
472 dir, speed, header[0] >> 10 & 0x3f,
473 header[1] >> 16, header[0] >> 16, evts[evt],
474 tcodes[tcode], specific);
480 #define param_debug 0
481 static inline void log_irqs(u32 evt) {}
482 static inline void log_selfids(int node_id, int generation, int self_id_count, u32 *s) {}
483 static inline void log_ar_at_event(char dir, int speed, u32 *header, int evt) {}
485 #endif /* CONFIG_FIREWIRE_OHCI_DEBUG */
487 static inline void reg_write(const struct fw_ohci *ohci, int offset, u32 data)
489 writel(data, ohci->registers + offset);
492 static inline u32 reg_read(const struct fw_ohci *ohci, int offset)
494 return readl(ohci->registers + offset);
497 static inline void flush_writes(const struct fw_ohci *ohci)
499 /* Do a dummy read to flush writes. */
500 reg_read(ohci, OHCI1394_Version);
503 static int read_phy_reg(struct fw_ohci *ohci, int addr)
508 reg_write(ohci, OHCI1394_PhyControl, OHCI1394_PhyControl_Read(addr));
509 for (i = 0; i < 3 + 100; i++) {
510 val = reg_read(ohci, OHCI1394_PhyControl);
511 if (val & OHCI1394_PhyControl_ReadDone)
512 return OHCI1394_PhyControl_ReadData(val);
515 * Try a few times without waiting. Sleeping is necessary
516 * only when the link/PHY interface is busy.
521 fw_error("failed to read phy reg\n");
526 static int write_phy_reg(const struct fw_ohci *ohci, int addr, u32 val)
530 reg_write(ohci, OHCI1394_PhyControl,
531 OHCI1394_PhyControl_Write(addr, val));
532 for (i = 0; i < 3 + 100; i++) {
533 val = reg_read(ohci, OHCI1394_PhyControl);
534 if (!(val & OHCI1394_PhyControl_WritePending))
540 fw_error("failed to write phy reg\n");
545 static int update_phy_reg(struct fw_ohci *ohci, int addr,
546 int clear_bits, int set_bits)
548 int ret = read_phy_reg(ohci, addr);
553 * The interrupt status bits are cleared by writing a one bit.
554 * Avoid clearing them unless explicitly requested in set_bits.
557 clear_bits |= PHY_INT_STATUS_BITS;
559 return write_phy_reg(ohci, addr, (ret & ~clear_bits) | set_bits);
562 static int read_paged_phy_reg(struct fw_ohci *ohci, int page, int addr)
566 ret = update_phy_reg(ohci, 7, PHY_PAGE_SELECT, page << 5);
570 return read_phy_reg(ohci, addr);
573 static int ohci_read_phy_reg(struct fw_card *card, int addr)
575 struct fw_ohci *ohci = fw_ohci(card);
578 mutex_lock(&ohci->phy_reg_mutex);
579 ret = read_phy_reg(ohci, addr);
580 mutex_unlock(&ohci->phy_reg_mutex);
585 static int ohci_update_phy_reg(struct fw_card *card, int addr,
586 int clear_bits, int set_bits)
588 struct fw_ohci *ohci = fw_ohci(card);
591 mutex_lock(&ohci->phy_reg_mutex);
592 ret = update_phy_reg(ohci, addr, clear_bits, set_bits);
593 mutex_unlock(&ohci->phy_reg_mutex);
598 static inline dma_addr_t ar_buffer_bus(struct ar_context *ctx, unsigned int i)
600 return page_private(ctx->pages[i]);
603 static void ar_context_link_page(struct ar_context *ctx, unsigned int index)
605 struct descriptor *d;
607 d = &ctx->descriptors[index];
608 d->branch_address &= cpu_to_le32(~0xf);
609 d->res_count = cpu_to_le16(PAGE_SIZE);
610 d->transfer_status = 0;
612 wmb(); /* finish init of new descriptors before branch_address update */
613 d = &ctx->descriptors[ctx->last_buffer_index];
614 d->branch_address |= cpu_to_le32(1);
616 ctx->last_buffer_index = index;
618 reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_WAKE);
619 flush_writes(ctx->ohci);
622 static void ar_context_release(struct ar_context *ctx)
626 if (ctx->descriptors)
627 dma_free_coherent(ctx->ohci->card.device,
628 AR_BUFFERS * sizeof(struct descriptor),
629 ctx->descriptors, ctx->descriptors_bus);
632 vm_unmap_ram(ctx->buffer, AR_BUFFERS + AR_WRAPAROUND_PAGES);
634 for (i = 0; i < AR_BUFFERS; i++)
636 dma_unmap_page(ctx->ohci->card.device,
637 ar_buffer_bus(ctx, i),
638 PAGE_SIZE, DMA_FROM_DEVICE);
639 __free_page(ctx->pages[i]);
643 static void ar_context_abort(struct ar_context *ctx, const char *error_msg)
645 if (reg_read(ctx->ohci, CONTROL_CLEAR(ctx->regs)) & CONTEXT_RUN) {
646 reg_write(ctx->ohci, CONTROL_CLEAR(ctx->regs), CONTEXT_RUN);
647 flush_writes(ctx->ohci);
649 fw_error("AR error: %s; DMA stopped\n", error_msg);
651 /* FIXME: restart? */
654 static inline unsigned int ar_next_buffer_index(unsigned int index)
656 return (index + 1) % AR_BUFFERS;
659 static inline unsigned int ar_prev_buffer_index(unsigned int index)
661 return (index - 1 + AR_BUFFERS) % AR_BUFFERS;
664 static inline unsigned int ar_first_buffer_index(struct ar_context *ctx)
666 return ar_next_buffer_index(ctx->last_buffer_index);
670 * We search for the buffer that contains the last AR packet DMA data written
673 static unsigned int ar_search_last_active_buffer(struct ar_context *ctx,
674 unsigned int *buffer_offset)
676 unsigned int i, next_i, last = ctx->last_buffer_index;
677 __le16 res_count, next_res_count;
679 i = ar_first_buffer_index(ctx);
680 res_count = ACCESS_ONCE(ctx->descriptors[i].res_count);
682 /* A buffer that is not yet completely filled must be the last one. */
683 while (i != last && res_count == 0) {
685 /* Peek at the next descriptor. */
686 next_i = ar_next_buffer_index(i);
687 rmb(); /* read descriptors in order */
688 next_res_count = ACCESS_ONCE(
689 ctx->descriptors[next_i].res_count);
691 * If the next descriptor is still empty, we must stop at this
694 if (next_res_count == cpu_to_le16(PAGE_SIZE)) {
696 * The exception is when the DMA data for one packet is
697 * split over three buffers; in this case, the middle
698 * buffer's descriptor might be never updated by the
699 * controller and look still empty, and we have to peek
702 if (MAX_AR_PACKET_SIZE > PAGE_SIZE && i != last) {
703 next_i = ar_next_buffer_index(next_i);
705 next_res_count = ACCESS_ONCE(
706 ctx->descriptors[next_i].res_count);
707 if (next_res_count != cpu_to_le16(PAGE_SIZE))
708 goto next_buffer_is_active;
714 next_buffer_is_active:
716 res_count = next_res_count;
719 rmb(); /* read res_count before the DMA data */
721 *buffer_offset = PAGE_SIZE - le16_to_cpu(res_count);
722 if (*buffer_offset > PAGE_SIZE) {
724 ar_context_abort(ctx, "corrupted descriptor");
730 static void ar_sync_buffers_for_cpu(struct ar_context *ctx,
731 unsigned int end_buffer_index,
732 unsigned int end_buffer_offset)
736 i = ar_first_buffer_index(ctx);
737 while (i != end_buffer_index) {
738 dma_sync_single_for_cpu(ctx->ohci->card.device,
739 ar_buffer_bus(ctx, i),
740 PAGE_SIZE, DMA_FROM_DEVICE);
741 i = ar_next_buffer_index(i);
743 if (end_buffer_offset > 0)
744 dma_sync_single_for_cpu(ctx->ohci->card.device,
745 ar_buffer_bus(ctx, i),
746 end_buffer_offset, DMA_FROM_DEVICE);
749 #if defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32)
750 #define cond_le32_to_cpu(v) \
751 (ohci->quirks & QUIRK_BE_HEADERS ? (__force __u32)(v) : le32_to_cpu(v))
753 #define cond_le32_to_cpu(v) le32_to_cpu(v)
756 static __le32 *handle_ar_packet(struct ar_context *ctx, __le32 *buffer)
758 struct fw_ohci *ohci = ctx->ohci;
760 u32 status, length, tcode;
763 p.header[0] = cond_le32_to_cpu(buffer[0]);
764 p.header[1] = cond_le32_to_cpu(buffer[1]);
765 p.header[2] = cond_le32_to_cpu(buffer[2]);
767 tcode = (p.header[0] >> 4) & 0x0f;
769 case TCODE_WRITE_QUADLET_REQUEST:
770 case TCODE_READ_QUADLET_RESPONSE:
771 p.header[3] = (__force __u32) buffer[3];
772 p.header_length = 16;
773 p.payload_length = 0;
776 case TCODE_READ_BLOCK_REQUEST :
777 p.header[3] = cond_le32_to_cpu(buffer[3]);
778 p.header_length = 16;
779 p.payload_length = 0;
782 case TCODE_WRITE_BLOCK_REQUEST:
783 case TCODE_READ_BLOCK_RESPONSE:
784 case TCODE_LOCK_REQUEST:
785 case TCODE_LOCK_RESPONSE:
786 p.header[3] = cond_le32_to_cpu(buffer[3]);
787 p.header_length = 16;
788 p.payload_length = p.header[3] >> 16;
789 if (p.payload_length > MAX_ASYNC_PAYLOAD) {
790 ar_context_abort(ctx, "invalid packet length");
795 case TCODE_WRITE_RESPONSE:
796 case TCODE_READ_QUADLET_REQUEST:
797 case OHCI_TCODE_PHY_PACKET:
798 p.header_length = 12;
799 p.payload_length = 0;
803 ar_context_abort(ctx, "invalid tcode");
807 p.payload = (void *) buffer + p.header_length;
809 /* FIXME: What to do about evt_* errors? */
810 length = (p.header_length + p.payload_length + 3) / 4;
811 status = cond_le32_to_cpu(buffer[length]);
812 evt = (status >> 16) & 0x1f;
815 p.speed = (status >> 21) & 0x7;
816 p.timestamp = status & 0xffff;
817 p.generation = ohci->request_generation;
819 log_ar_at_event('R', p.speed, p.header, evt);
822 * Several controllers, notably from NEC and VIA, forget to
823 * write ack_complete status at PHY packet reception.
825 if (evt == OHCI1394_evt_no_status &&
826 (p.header[0] & 0xff) == (OHCI1394_phy_tcode << 4))
827 p.ack = ACK_COMPLETE;
830 * The OHCI bus reset handler synthesizes a PHY packet with
831 * the new generation number when a bus reset happens (see
832 * section 8.4.2.3). This helps us determine when a request
833 * was received and make sure we send the response in the same
834 * generation. We only need this for requests; for responses
835 * we use the unique tlabel for finding the matching
838 * Alas some chips sometimes emit bus reset packets with a
839 * wrong generation. We set the correct generation for these
840 * at a slightly incorrect time (in bus_reset_tasklet).
842 if (evt == OHCI1394_evt_bus_reset) {
843 if (!(ohci->quirks & QUIRK_RESET_PACKET))
844 ohci->request_generation = (p.header[2] >> 16) & 0xff;
845 } else if (ctx == &ohci->ar_request_ctx) {
846 fw_core_handle_request(&ohci->card, &p);
848 fw_core_handle_response(&ohci->card, &p);
851 return buffer + length + 1;
854 static void *handle_ar_packets(struct ar_context *ctx, void *p, void *end)
859 next = handle_ar_packet(ctx, p);
868 static void ar_recycle_buffers(struct ar_context *ctx, unsigned int end_buffer)
872 i = ar_first_buffer_index(ctx);
873 while (i != end_buffer) {
874 dma_sync_single_for_device(ctx->ohci->card.device,
875 ar_buffer_bus(ctx, i),
876 PAGE_SIZE, DMA_FROM_DEVICE);
877 ar_context_link_page(ctx, i);
878 i = ar_next_buffer_index(i);
882 static void ar_context_tasklet(unsigned long data)
884 struct ar_context *ctx = (struct ar_context *)data;
885 unsigned int end_buffer_index, end_buffer_offset;
892 end_buffer_index = ar_search_last_active_buffer(ctx,
894 ar_sync_buffers_for_cpu(ctx, end_buffer_index, end_buffer_offset);
895 end = ctx->buffer + end_buffer_index * PAGE_SIZE + end_buffer_offset;
897 if (end_buffer_index < ar_first_buffer_index(ctx)) {
899 * The filled part of the overall buffer wraps around; handle
900 * all packets up to the buffer end here. If the last packet
901 * wraps around, its tail will be visible after the buffer end
902 * because the buffer start pages are mapped there again.
904 void *buffer_end = ctx->buffer + AR_BUFFERS * PAGE_SIZE;
905 p = handle_ar_packets(ctx, p, buffer_end);
908 /* adjust p to point back into the actual buffer */
909 p -= AR_BUFFERS * PAGE_SIZE;
912 p = handle_ar_packets(ctx, p, end);
915 ar_context_abort(ctx, "inconsistent descriptor");
920 ar_recycle_buffers(ctx, end_buffer_index);
928 static int ar_context_init(struct ar_context *ctx,
929 struct fw_ohci *ohci, u32 regs)
933 struct page *pages[AR_BUFFERS + AR_WRAPAROUND_PAGES];
934 struct descriptor *d;
938 tasklet_init(&ctx->tasklet, ar_context_tasklet, (unsigned long)ctx);
940 for (i = 0; i < AR_BUFFERS; i++) {
941 ctx->pages[i] = alloc_page(GFP_KERNEL | GFP_DMA32);
944 dma_addr = dma_map_page(ohci->card.device, ctx->pages[i],
945 0, PAGE_SIZE, DMA_FROM_DEVICE);
946 if (dma_mapping_error(ohci->card.device, dma_addr)) {
947 __free_page(ctx->pages[i]);
948 ctx->pages[i] = NULL;
951 set_page_private(ctx->pages[i], dma_addr);
954 for (i = 0; i < AR_BUFFERS; i++)
955 pages[i] = ctx->pages[i];
956 for (i = 0; i < AR_WRAPAROUND_PAGES; i++)
957 pages[AR_BUFFERS + i] = ctx->pages[i];
958 ctx->buffer = vm_map_ram(pages, AR_BUFFERS + AR_WRAPAROUND_PAGES,
964 dma_alloc_coherent(ohci->card.device,
965 AR_BUFFERS * sizeof(struct descriptor),
966 &ctx->descriptors_bus,
968 if (!ctx->descriptors)
971 for (i = 0; i < AR_BUFFERS; i++) {
972 d = &ctx->descriptors[i];
973 d->req_count = cpu_to_le16(PAGE_SIZE);
974 d->control = cpu_to_le16(DESCRIPTOR_INPUT_MORE |
976 DESCRIPTOR_BRANCH_ALWAYS);
977 d->data_address = cpu_to_le32(ar_buffer_bus(ctx, i));
978 d->branch_address = cpu_to_le32(ctx->descriptors_bus +
979 ar_next_buffer_index(i) * sizeof(struct descriptor));
985 ar_context_release(ctx);
990 static void ar_context_run(struct ar_context *ctx)
994 for (i = 0; i < AR_BUFFERS; i++)
995 ar_context_link_page(ctx, i);
997 ctx->pointer = ctx->buffer;
999 reg_write(ctx->ohci, COMMAND_PTR(ctx->regs), ctx->descriptors_bus | 1);
1000 reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_RUN);
1001 flush_writes(ctx->ohci);
1004 static struct descriptor *find_branch_descriptor(struct descriptor *d, int z)
1008 b = (le16_to_cpu(d->control) & DESCRIPTOR_BRANCH_ALWAYS) >> 2;
1009 key = (le16_to_cpu(d->control) & DESCRIPTOR_KEY_IMMEDIATE) >> 8;
1011 /* figure out which descriptor the branch address goes in */
1012 if (z == 2 && (b == 3 || key == 2))
1018 static void context_tasklet(unsigned long data)
1020 struct context *ctx = (struct context *) data;
1021 struct descriptor *d, *last;
1024 struct descriptor_buffer *desc;
1026 desc = list_entry(ctx->buffer_list.next,
1027 struct descriptor_buffer, list);
1029 while (last->branch_address != 0) {
1030 struct descriptor_buffer *old_desc = desc;
1031 address = le32_to_cpu(last->branch_address);
1035 /* If the branch address points to a buffer outside of the
1036 * current buffer, advance to the next buffer. */
1037 if (address < desc->buffer_bus ||
1038 address >= desc->buffer_bus + desc->used)
1039 desc = list_entry(desc->list.next,
1040 struct descriptor_buffer, list);
1041 d = desc->buffer + (address - desc->buffer_bus) / sizeof(*d);
1042 last = find_branch_descriptor(d, z);
1044 if (!ctx->callback(ctx, d, last))
1047 if (old_desc != desc) {
1048 /* If we've advanced to the next buffer, move the
1049 * previous buffer to the free list. */
1050 unsigned long flags;
1052 spin_lock_irqsave(&ctx->ohci->lock, flags);
1053 list_move_tail(&old_desc->list, &ctx->buffer_list);
1054 spin_unlock_irqrestore(&ctx->ohci->lock, flags);
1061 * Allocate a new buffer and add it to the list of free buffers for this
1062 * context. Must be called with ohci->lock held.
1064 static int context_add_buffer(struct context *ctx)
1066 struct descriptor_buffer *desc;
1067 dma_addr_t uninitialized_var(bus_addr);
1071 * 16MB of descriptors should be far more than enough for any DMA
1072 * program. This will catch run-away userspace or DoS attacks.
1074 if (ctx->total_allocation >= 16*1024*1024)
1077 desc = dma_alloc_coherent(ctx->ohci->card.device, PAGE_SIZE,
1078 &bus_addr, GFP_ATOMIC);
1082 offset = (void *)&desc->buffer - (void *)desc;
1083 desc->buffer_size = PAGE_SIZE - offset;
1084 desc->buffer_bus = bus_addr + offset;
1087 list_add_tail(&desc->list, &ctx->buffer_list);
1088 ctx->total_allocation += PAGE_SIZE;
1093 static int context_init(struct context *ctx, struct fw_ohci *ohci,
1094 u32 regs, descriptor_callback_t callback)
1098 ctx->total_allocation = 0;
1100 INIT_LIST_HEAD(&ctx->buffer_list);
1101 if (context_add_buffer(ctx) < 0)
1104 ctx->buffer_tail = list_entry(ctx->buffer_list.next,
1105 struct descriptor_buffer, list);
1107 tasklet_init(&ctx->tasklet, context_tasklet, (unsigned long)ctx);
1108 ctx->callback = callback;
1111 * We put a dummy descriptor in the buffer that has a NULL
1112 * branch address and looks like it's been sent. That way we
1113 * have a descriptor to append DMA programs to.
1115 memset(ctx->buffer_tail->buffer, 0, sizeof(*ctx->buffer_tail->buffer));
1116 ctx->buffer_tail->buffer->control = cpu_to_le16(DESCRIPTOR_OUTPUT_LAST);
1117 ctx->buffer_tail->buffer->transfer_status = cpu_to_le16(0x8011);
1118 ctx->buffer_tail->used += sizeof(*ctx->buffer_tail->buffer);
1119 ctx->last = ctx->buffer_tail->buffer;
1120 ctx->prev = ctx->buffer_tail->buffer;
1125 static void context_release(struct context *ctx)
1127 struct fw_card *card = &ctx->ohci->card;
1128 struct descriptor_buffer *desc, *tmp;
1130 list_for_each_entry_safe(desc, tmp, &ctx->buffer_list, list)
1131 dma_free_coherent(card->device, PAGE_SIZE, desc,
1133 ((void *)&desc->buffer - (void *)desc));
1136 /* Must be called with ohci->lock held */
1137 static struct descriptor *context_get_descriptors(struct context *ctx,
1138 int z, dma_addr_t *d_bus)
1140 struct descriptor *d = NULL;
1141 struct descriptor_buffer *desc = ctx->buffer_tail;
1143 if (z * sizeof(*d) > desc->buffer_size)
1146 if (z * sizeof(*d) > desc->buffer_size - desc->used) {
1147 /* No room for the descriptor in this buffer, so advance to the
1150 if (desc->list.next == &ctx->buffer_list) {
1151 /* If there is no free buffer next in the list,
1153 if (context_add_buffer(ctx) < 0)
1156 desc = list_entry(desc->list.next,
1157 struct descriptor_buffer, list);
1158 ctx->buffer_tail = desc;
1161 d = desc->buffer + desc->used / sizeof(*d);
1162 memset(d, 0, z * sizeof(*d));
1163 *d_bus = desc->buffer_bus + desc->used;
1168 static void context_run(struct context *ctx, u32 extra)
1170 struct fw_ohci *ohci = ctx->ohci;
1172 reg_write(ohci, COMMAND_PTR(ctx->regs),
1173 le32_to_cpu(ctx->last->branch_address));
1174 reg_write(ohci, CONTROL_CLEAR(ctx->regs), ~0);
1175 reg_write(ohci, CONTROL_SET(ctx->regs), CONTEXT_RUN | extra);
1179 static void context_append(struct context *ctx,
1180 struct descriptor *d, int z, int extra)
1183 struct descriptor_buffer *desc = ctx->buffer_tail;
1185 d_bus = desc->buffer_bus + (d - desc->buffer) * sizeof(*d);
1187 desc->used += (z + extra) * sizeof(*d);
1189 wmb(); /* finish init of new descriptors before branch_address update */
1190 ctx->prev->branch_address = cpu_to_le32(d_bus | z);
1191 ctx->prev = find_branch_descriptor(d, z);
1193 reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_WAKE);
1194 flush_writes(ctx->ohci);
1197 static void context_stop(struct context *ctx)
1202 reg_write(ctx->ohci, CONTROL_CLEAR(ctx->regs), CONTEXT_RUN);
1203 flush_writes(ctx->ohci);
1205 for (i = 0; i < 10; i++) {
1206 reg = reg_read(ctx->ohci, CONTROL_SET(ctx->regs));
1207 if ((reg & CONTEXT_ACTIVE) == 0)
1212 fw_error("Error: DMA context still active (0x%08x)\n", reg);
1215 struct driver_data {
1216 struct fw_packet *packet;
1220 * This function apppends a packet to the DMA queue for transmission.
1221 * Must always be called with the ochi->lock held to ensure proper
1222 * generation handling and locking around packet queue manipulation.
1224 static int at_context_queue_packet(struct context *ctx,
1225 struct fw_packet *packet)
1227 struct fw_ohci *ohci = ctx->ohci;
1228 dma_addr_t d_bus, uninitialized_var(payload_bus);
1229 struct driver_data *driver_data;
1230 struct descriptor *d, *last;
1235 d = context_get_descriptors(ctx, 4, &d_bus);
1237 packet->ack = RCODE_SEND_ERROR;
1241 d[0].control = cpu_to_le16(DESCRIPTOR_KEY_IMMEDIATE);
1242 d[0].res_count = cpu_to_le16(packet->timestamp);
1245 * The DMA format for asyncronous link packets is different
1246 * from the IEEE1394 layout, so shift the fields around
1250 tcode = (packet->header[0] >> 4) & 0x0f;
1251 header = (__le32 *) &d[1];
1253 case TCODE_WRITE_QUADLET_REQUEST:
1254 case TCODE_WRITE_BLOCK_REQUEST:
1255 case TCODE_WRITE_RESPONSE:
1256 case TCODE_READ_QUADLET_REQUEST:
1257 case TCODE_READ_BLOCK_REQUEST:
1258 case TCODE_READ_QUADLET_RESPONSE:
1259 case TCODE_READ_BLOCK_RESPONSE:
1260 case TCODE_LOCK_REQUEST:
1261 case TCODE_LOCK_RESPONSE:
1262 header[0] = cpu_to_le32((packet->header[0] & 0xffff) |
1263 (packet->speed << 16));
1264 header[1] = cpu_to_le32((packet->header[1] & 0xffff) |
1265 (packet->header[0] & 0xffff0000));
1266 header[2] = cpu_to_le32(packet->header[2]);
1268 if (TCODE_IS_BLOCK_PACKET(tcode))
1269 header[3] = cpu_to_le32(packet->header[3]);
1271 header[3] = (__force __le32) packet->header[3];
1273 d[0].req_count = cpu_to_le16(packet->header_length);
1276 case TCODE_LINK_INTERNAL:
1277 header[0] = cpu_to_le32((OHCI1394_phy_tcode << 4) |
1278 (packet->speed << 16));
1279 header[1] = cpu_to_le32(packet->header[1]);
1280 header[2] = cpu_to_le32(packet->header[2]);
1281 d[0].req_count = cpu_to_le16(12);
1283 if (is_ping_packet(&packet->header[1]))
1284 d[0].control |= cpu_to_le16(DESCRIPTOR_PING);
1287 case TCODE_STREAM_DATA:
1288 header[0] = cpu_to_le32((packet->header[0] & 0xffff) |
1289 (packet->speed << 16));
1290 header[1] = cpu_to_le32(packet->header[0] & 0xffff0000);
1291 d[0].req_count = cpu_to_le16(8);
1296 packet->ack = RCODE_SEND_ERROR;
1300 driver_data = (struct driver_data *) &d[3];
1301 driver_data->packet = packet;
1302 packet->driver_data = driver_data;
1304 if (packet->payload_length > 0) {
1306 dma_map_single(ohci->card.device, packet->payload,
1307 packet->payload_length, DMA_TO_DEVICE);
1308 if (dma_mapping_error(ohci->card.device, payload_bus)) {
1309 packet->ack = RCODE_SEND_ERROR;
1312 packet->payload_bus = payload_bus;
1313 packet->payload_mapped = true;
1315 d[2].req_count = cpu_to_le16(packet->payload_length);
1316 d[2].data_address = cpu_to_le32(payload_bus);
1324 last->control |= cpu_to_le16(DESCRIPTOR_OUTPUT_LAST |
1325 DESCRIPTOR_IRQ_ALWAYS |
1326 DESCRIPTOR_BRANCH_ALWAYS);
1329 * If the controller and packet generations don't match, we need to
1330 * bail out and try again. If IntEvent.busReset is set, the AT context
1331 * is halted, so appending to the context and trying to run it is
1332 * futile. Most controllers do the right thing and just flush the AT
1333 * queue (per section 7.2.3.2 of the OHCI 1.1 specification), but
1334 * some controllers (like a JMicron JMB381 PCI-e) misbehave and wind
1335 * up stalling out. So we just bail out in software and try again
1336 * later, and everyone is happy.
1337 * FIXME: Document how the locking works.
1339 if (ohci->generation != packet->generation ||
1340 reg_read(ohci, OHCI1394_IntEventSet) & OHCI1394_busReset) {
1341 if (packet->payload_mapped)
1342 dma_unmap_single(ohci->card.device, payload_bus,
1343 packet->payload_length, DMA_TO_DEVICE);
1344 packet->ack = RCODE_GENERATION;
1348 context_append(ctx, d, z, 4 - z);
1350 /* If the context isn't already running, start it up. */
1351 reg = reg_read(ctx->ohci, CONTROL_SET(ctx->regs));
1352 if ((reg & CONTEXT_RUN) == 0)
1353 context_run(ctx, 0);
1358 static int handle_at_packet(struct context *context,
1359 struct descriptor *d,
1360 struct descriptor *last)
1362 struct driver_data *driver_data;
1363 struct fw_packet *packet;
1364 struct fw_ohci *ohci = context->ohci;
1367 if (last->transfer_status == 0)
1368 /* This descriptor isn't done yet, stop iteration. */
1371 driver_data = (struct driver_data *) &d[3];
1372 packet = driver_data->packet;
1374 /* This packet was cancelled, just continue. */
1377 if (packet->payload_mapped)
1378 dma_unmap_single(ohci->card.device, packet->payload_bus,
1379 packet->payload_length, DMA_TO_DEVICE);
1381 evt = le16_to_cpu(last->transfer_status) & 0x1f;
1382 packet->timestamp = le16_to_cpu(last->res_count);
1384 log_ar_at_event('T', packet->speed, packet->header, evt);
1387 case OHCI1394_evt_timeout:
1388 /* Async response transmit timed out. */
1389 packet->ack = RCODE_CANCELLED;
1392 case OHCI1394_evt_flushed:
1394 * The packet was flushed should give same error as
1395 * when we try to use a stale generation count.
1397 packet->ack = RCODE_GENERATION;
1400 case OHCI1394_evt_missing_ack:
1402 * Using a valid (current) generation count, but the
1403 * node is not on the bus or not sending acks.
1405 packet->ack = RCODE_NO_ACK;
1408 case ACK_COMPLETE + 0x10:
1409 case ACK_PENDING + 0x10:
1410 case ACK_BUSY_X + 0x10:
1411 case ACK_BUSY_A + 0x10:
1412 case ACK_BUSY_B + 0x10:
1413 case ACK_DATA_ERROR + 0x10:
1414 case ACK_TYPE_ERROR + 0x10:
1415 packet->ack = evt - 0x10;
1419 packet->ack = RCODE_SEND_ERROR;
1423 packet->callback(packet, &ohci->card, packet->ack);
1428 #define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff)
1429 #define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f)
1430 #define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff)
1431 #define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff)
1432 #define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff)
1434 static void handle_local_rom(struct fw_ohci *ohci,
1435 struct fw_packet *packet, u32 csr)
1437 struct fw_packet response;
1438 int tcode, length, i;
1440 tcode = HEADER_GET_TCODE(packet->header[0]);
1441 if (TCODE_IS_BLOCK_PACKET(tcode))
1442 length = HEADER_GET_DATA_LENGTH(packet->header[3]);
1446 i = csr - CSR_CONFIG_ROM;
1447 if (i + length > CONFIG_ROM_SIZE) {
1448 fw_fill_response(&response, packet->header,
1449 RCODE_ADDRESS_ERROR, NULL, 0);
1450 } else if (!TCODE_IS_READ_REQUEST(tcode)) {
1451 fw_fill_response(&response, packet->header,
1452 RCODE_TYPE_ERROR, NULL, 0);
1454 fw_fill_response(&response, packet->header, RCODE_COMPLETE,
1455 (void *) ohci->config_rom + i, length);
1458 fw_core_handle_response(&ohci->card, &response);
1461 static void handle_local_lock(struct fw_ohci *ohci,
1462 struct fw_packet *packet, u32 csr)
1464 struct fw_packet response;
1465 int tcode, length, ext_tcode, sel, try;
1466 __be32 *payload, lock_old;
1467 u32 lock_arg, lock_data;
1469 tcode = HEADER_GET_TCODE(packet->header[0]);
1470 length = HEADER_GET_DATA_LENGTH(packet->header[3]);
1471 payload = packet->payload;
1472 ext_tcode = HEADER_GET_EXTENDED_TCODE(packet->header[3]);
1474 if (tcode == TCODE_LOCK_REQUEST &&
1475 ext_tcode == EXTCODE_COMPARE_SWAP && length == 8) {
1476 lock_arg = be32_to_cpu(payload[0]);
1477 lock_data = be32_to_cpu(payload[1]);
1478 } else if (tcode == TCODE_READ_QUADLET_REQUEST) {
1482 fw_fill_response(&response, packet->header,
1483 RCODE_TYPE_ERROR, NULL, 0);
1487 sel = (csr - CSR_BUS_MANAGER_ID) / 4;
1488 reg_write(ohci, OHCI1394_CSRData, lock_data);
1489 reg_write(ohci, OHCI1394_CSRCompareData, lock_arg);
1490 reg_write(ohci, OHCI1394_CSRControl, sel);
1492 for (try = 0; try < 20; try++)
1493 if (reg_read(ohci, OHCI1394_CSRControl) & 0x80000000) {
1494 lock_old = cpu_to_be32(reg_read(ohci,
1496 fw_fill_response(&response, packet->header,
1498 &lock_old, sizeof(lock_old));
1502 fw_error("swap not done (CSR lock timeout)\n");
1503 fw_fill_response(&response, packet->header, RCODE_BUSY, NULL, 0);
1506 fw_core_handle_response(&ohci->card, &response);
1509 static void handle_local_request(struct context *ctx, struct fw_packet *packet)
1513 if (ctx == &ctx->ohci->at_request_ctx) {
1514 packet->ack = ACK_PENDING;
1515 packet->callback(packet, &ctx->ohci->card, packet->ack);
1519 ((unsigned long long)
1520 HEADER_GET_OFFSET_HIGH(packet->header[1]) << 32) |
1522 csr = offset - CSR_REGISTER_BASE;
1524 /* Handle config rom reads. */
1525 if (csr >= CSR_CONFIG_ROM && csr < CSR_CONFIG_ROM_END)
1526 handle_local_rom(ctx->ohci, packet, csr);
1528 case CSR_BUS_MANAGER_ID:
1529 case CSR_BANDWIDTH_AVAILABLE:
1530 case CSR_CHANNELS_AVAILABLE_HI:
1531 case CSR_CHANNELS_AVAILABLE_LO:
1532 handle_local_lock(ctx->ohci, packet, csr);
1535 if (ctx == &ctx->ohci->at_request_ctx)
1536 fw_core_handle_request(&ctx->ohci->card, packet);
1538 fw_core_handle_response(&ctx->ohci->card, packet);
1542 if (ctx == &ctx->ohci->at_response_ctx) {
1543 packet->ack = ACK_COMPLETE;
1544 packet->callback(packet, &ctx->ohci->card, packet->ack);
1548 static void at_context_transmit(struct context *ctx, struct fw_packet *packet)
1550 unsigned long flags;
1553 spin_lock_irqsave(&ctx->ohci->lock, flags);
1555 if (HEADER_GET_DESTINATION(packet->header[0]) == ctx->ohci->node_id &&
1556 ctx->ohci->generation == packet->generation) {
1557 spin_unlock_irqrestore(&ctx->ohci->lock, flags);
1558 handle_local_request(ctx, packet);
1562 ret = at_context_queue_packet(ctx, packet);
1563 spin_unlock_irqrestore(&ctx->ohci->lock, flags);
1566 packet->callback(packet, &ctx->ohci->card, packet->ack);
1570 static u32 cycle_timer_ticks(u32 cycle_timer)
1574 ticks = cycle_timer & 0xfff;
1575 ticks += 3072 * ((cycle_timer >> 12) & 0x1fff);
1576 ticks += (3072 * 8000) * (cycle_timer >> 25);
1582 * Some controllers exhibit one or more of the following bugs when updating the
1583 * iso cycle timer register:
1584 * - When the lowest six bits are wrapping around to zero, a read that happens
1585 * at the same time will return garbage in the lowest ten bits.
1586 * - When the cycleOffset field wraps around to zero, the cycleCount field is
1587 * not incremented for about 60 ns.
1588 * - Occasionally, the entire register reads zero.
1590 * To catch these, we read the register three times and ensure that the
1591 * difference between each two consecutive reads is approximately the same, i.e.
1592 * less than twice the other. Furthermore, any negative difference indicates an
1593 * error. (A PCI read should take at least 20 ticks of the 24.576 MHz timer to
1594 * execute, so we have enough precision to compute the ratio of the differences.)
1596 static u32 get_cycle_time(struct fw_ohci *ohci)
1603 c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1605 if (ohci->quirks & QUIRK_CYCLE_TIMER) {
1608 c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1612 c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1613 t0 = cycle_timer_ticks(c0);
1614 t1 = cycle_timer_ticks(c1);
1615 t2 = cycle_timer_ticks(c2);
1618 } while ((diff01 <= 0 || diff12 <= 0 ||
1619 diff01 / diff12 >= 2 || diff12 / diff01 >= 2)
1627 * This function has to be called at least every 64 seconds. The bus_time
1628 * field stores not only the upper 25 bits of the BUS_TIME register but also
1629 * the most significant bit of the cycle timer in bit 6 so that we can detect
1630 * changes in this bit.
1632 static u32 update_bus_time(struct fw_ohci *ohci)
1634 u32 cycle_time_seconds = get_cycle_time(ohci) >> 25;
1636 if ((ohci->bus_time & 0x40) != (cycle_time_seconds & 0x40))
1637 ohci->bus_time += 0x40;
1639 return ohci->bus_time | cycle_time_seconds;
1642 static void bus_reset_tasklet(unsigned long data)
1644 struct fw_ohci *ohci = (struct fw_ohci *)data;
1645 int self_id_count, i, j, reg;
1646 int generation, new_generation;
1647 unsigned long flags;
1648 void *free_rom = NULL;
1649 dma_addr_t free_rom_bus = 0;
1652 reg = reg_read(ohci, OHCI1394_NodeID);
1653 if (!(reg & OHCI1394_NodeID_idValid)) {
1654 fw_notify("node ID not valid, new bus reset in progress\n");
1657 if ((reg & OHCI1394_NodeID_nodeNumber) == 63) {
1658 fw_notify("malconfigured bus\n");
1661 ohci->node_id = reg & (OHCI1394_NodeID_busNumber |
1662 OHCI1394_NodeID_nodeNumber);
1664 is_new_root = (reg & OHCI1394_NodeID_root) != 0;
1665 if (!(ohci->is_root && is_new_root))
1666 reg_write(ohci, OHCI1394_LinkControlSet,
1667 OHCI1394_LinkControl_cycleMaster);
1668 ohci->is_root = is_new_root;
1670 reg = reg_read(ohci, OHCI1394_SelfIDCount);
1671 if (reg & OHCI1394_SelfIDCount_selfIDError) {
1672 fw_notify("inconsistent self IDs\n");
1676 * The count in the SelfIDCount register is the number of
1677 * bytes in the self ID receive buffer. Since we also receive
1678 * the inverted quadlets and a header quadlet, we shift one
1679 * bit extra to get the actual number of self IDs.
1681 self_id_count = (reg >> 3) & 0xff;
1682 if (self_id_count == 0 || self_id_count > 252) {
1683 fw_notify("inconsistent self IDs\n");
1686 generation = (cond_le32_to_cpu(ohci->self_id_cpu[0]) >> 16) & 0xff;
1689 for (i = 1, j = 0; j < self_id_count; i += 2, j++) {
1690 if (ohci->self_id_cpu[i] != ~ohci->self_id_cpu[i + 1]) {
1691 fw_notify("inconsistent self IDs\n");
1694 ohci->self_id_buffer[j] =
1695 cond_le32_to_cpu(ohci->self_id_cpu[i]);
1700 * Check the consistency of the self IDs we just read. The
1701 * problem we face is that a new bus reset can start while we
1702 * read out the self IDs from the DMA buffer. If this happens,
1703 * the DMA buffer will be overwritten with new self IDs and we
1704 * will read out inconsistent data. The OHCI specification
1705 * (section 11.2) recommends a technique similar to
1706 * linux/seqlock.h, where we remember the generation of the
1707 * self IDs in the buffer before reading them out and compare
1708 * it to the current generation after reading them out. If
1709 * the two generations match we know we have a consistent set
1713 new_generation = (reg_read(ohci, OHCI1394_SelfIDCount) >> 16) & 0xff;
1714 if (new_generation != generation) {
1715 fw_notify("recursive bus reset detected, "
1716 "discarding self ids\n");
1720 /* FIXME: Document how the locking works. */
1721 spin_lock_irqsave(&ohci->lock, flags);
1723 ohci->generation = generation;
1724 context_stop(&ohci->at_request_ctx);
1725 context_stop(&ohci->at_response_ctx);
1726 reg_write(ohci, OHCI1394_IntEventClear, OHCI1394_busReset);
1728 if (ohci->quirks & QUIRK_RESET_PACKET)
1729 ohci->request_generation = generation;
1732 * This next bit is unrelated to the AT context stuff but we
1733 * have to do it under the spinlock also. If a new config rom
1734 * was set up before this reset, the old one is now no longer
1735 * in use and we can free it. Update the config rom pointers
1736 * to point to the current config rom and clear the
1737 * next_config_rom pointer so a new update can take place.
1740 if (ohci->next_config_rom != NULL) {
1741 if (ohci->next_config_rom != ohci->config_rom) {
1742 free_rom = ohci->config_rom;
1743 free_rom_bus = ohci->config_rom_bus;
1745 ohci->config_rom = ohci->next_config_rom;
1746 ohci->config_rom_bus = ohci->next_config_rom_bus;
1747 ohci->next_config_rom = NULL;
1750 * Restore config_rom image and manually update
1751 * config_rom registers. Writing the header quadlet
1752 * will indicate that the config rom is ready, so we
1755 reg_write(ohci, OHCI1394_BusOptions,
1756 be32_to_cpu(ohci->config_rom[2]));
1757 ohci->config_rom[0] = ohci->next_header;
1758 reg_write(ohci, OHCI1394_ConfigROMhdr,
1759 be32_to_cpu(ohci->next_header));
1762 #ifdef CONFIG_FIREWIRE_OHCI_REMOTE_DMA
1763 reg_write(ohci, OHCI1394_PhyReqFilterHiSet, ~0);
1764 reg_write(ohci, OHCI1394_PhyReqFilterLoSet, ~0);
1767 spin_unlock_irqrestore(&ohci->lock, flags);
1770 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
1771 free_rom, free_rom_bus);
1773 log_selfids(ohci->node_id, generation,
1774 self_id_count, ohci->self_id_buffer);
1776 fw_core_handle_bus_reset(&ohci->card, ohci->node_id, generation,
1777 self_id_count, ohci->self_id_buffer,
1778 ohci->csr_state_setclear_abdicate);
1779 ohci->csr_state_setclear_abdicate = false;
1782 static irqreturn_t irq_handler(int irq, void *data)
1784 struct fw_ohci *ohci = data;
1785 u32 event, iso_event;
1788 event = reg_read(ohci, OHCI1394_IntEventClear);
1790 if (!event || !~event)
1794 * busReset and postedWriteErr must not be cleared yet
1795 * (OHCI 1.1 clauses 7.2.3.2 and 13.2.8.1)
1797 reg_write(ohci, OHCI1394_IntEventClear,
1798 event & ~(OHCI1394_busReset | OHCI1394_postedWriteErr));
1801 if (event & OHCI1394_selfIDComplete)
1802 tasklet_schedule(&ohci->bus_reset_tasklet);
1804 if (event & OHCI1394_RQPkt)
1805 tasklet_schedule(&ohci->ar_request_ctx.tasklet);
1807 if (event & OHCI1394_RSPkt)
1808 tasklet_schedule(&ohci->ar_response_ctx.tasklet);
1810 if (event & OHCI1394_reqTxComplete)
1811 tasklet_schedule(&ohci->at_request_ctx.tasklet);
1813 if (event & OHCI1394_respTxComplete)
1814 tasklet_schedule(&ohci->at_response_ctx.tasklet);
1816 iso_event = reg_read(ohci, OHCI1394_IsoRecvIntEventClear);
1817 reg_write(ohci, OHCI1394_IsoRecvIntEventClear, iso_event);
1820 i = ffs(iso_event) - 1;
1821 tasklet_schedule(&ohci->ir_context_list[i].context.tasklet);
1822 iso_event &= ~(1 << i);
1825 iso_event = reg_read(ohci, OHCI1394_IsoXmitIntEventClear);
1826 reg_write(ohci, OHCI1394_IsoXmitIntEventClear, iso_event);
1829 i = ffs(iso_event) - 1;
1830 tasklet_schedule(&ohci->it_context_list[i].context.tasklet);
1831 iso_event &= ~(1 << i);
1834 if (unlikely(event & OHCI1394_regAccessFail))
1835 fw_error("Register access failure - "
1836 "please notify linux1394-devel@lists.sf.net\n");
1838 if (unlikely(event & OHCI1394_postedWriteErr)) {
1839 reg_read(ohci, OHCI1394_PostedWriteAddressHi);
1840 reg_read(ohci, OHCI1394_PostedWriteAddressLo);
1841 reg_write(ohci, OHCI1394_IntEventClear,
1842 OHCI1394_postedWriteErr);
1843 fw_error("PCI posted write error\n");
1846 if (unlikely(event & OHCI1394_cycleTooLong)) {
1847 if (printk_ratelimit())
1848 fw_notify("isochronous cycle too long\n");
1849 reg_write(ohci, OHCI1394_LinkControlSet,
1850 OHCI1394_LinkControl_cycleMaster);
1853 if (unlikely(event & OHCI1394_cycleInconsistent)) {
1855 * We need to clear this event bit in order to make
1856 * cycleMatch isochronous I/O work. In theory we should
1857 * stop active cycleMatch iso contexts now and restart
1858 * them at least two cycles later. (FIXME?)
1860 if (printk_ratelimit())
1861 fw_notify("isochronous cycle inconsistent\n");
1864 if (event & OHCI1394_cycle64Seconds) {
1865 spin_lock(&ohci->lock);
1866 update_bus_time(ohci);
1867 spin_unlock(&ohci->lock);
1874 static int software_reset(struct fw_ohci *ohci)
1878 reg_write(ohci, OHCI1394_HCControlSet, OHCI1394_HCControl_softReset);
1880 for (i = 0; i < OHCI_LOOP_COUNT; i++) {
1881 if ((reg_read(ohci, OHCI1394_HCControlSet) &
1882 OHCI1394_HCControl_softReset) == 0)
1890 static void copy_config_rom(__be32 *dest, const __be32 *src, size_t length)
1892 size_t size = length * 4;
1894 memcpy(dest, src, size);
1895 if (size < CONFIG_ROM_SIZE)
1896 memset(&dest[length], 0, CONFIG_ROM_SIZE - size);
1899 static int configure_1394a_enhancements(struct fw_ohci *ohci)
1902 int ret, clear, set, offset;
1904 /* Check if the driver should configure link and PHY. */
1905 if (!(reg_read(ohci, OHCI1394_HCControlSet) &
1906 OHCI1394_HCControl_programPhyEnable))
1909 /* Paranoia: check whether the PHY supports 1394a, too. */
1910 enable_1394a = false;
1911 ret = read_phy_reg(ohci, 2);
1914 if ((ret & PHY_EXTENDED_REGISTERS) == PHY_EXTENDED_REGISTERS) {
1915 ret = read_paged_phy_reg(ohci, 1, 8);
1919 enable_1394a = true;
1922 if (ohci->quirks & QUIRK_NO_1394A)
1923 enable_1394a = false;
1925 /* Configure PHY and link consistently. */
1928 set = PHY_ENABLE_ACCEL | PHY_ENABLE_MULTI;
1930 clear = PHY_ENABLE_ACCEL | PHY_ENABLE_MULTI;
1933 ret = update_phy_reg(ohci, 5, clear, set);
1938 offset = OHCI1394_HCControlSet;
1940 offset = OHCI1394_HCControlClear;
1941 reg_write(ohci, offset, OHCI1394_HCControl_aPhyEnhanceEnable);
1943 /* Clean up: configuration has been taken care of. */
1944 reg_write(ohci, OHCI1394_HCControlClear,
1945 OHCI1394_HCControl_programPhyEnable);
1950 static int ohci_enable(struct fw_card *card,
1951 const __be32 *config_rom, size_t length)
1953 struct fw_ohci *ohci = fw_ohci(card);
1954 struct pci_dev *dev = to_pci_dev(card->device);
1955 u32 lps, seconds, version, irqs;
1958 if (software_reset(ohci)) {
1959 fw_error("Failed to reset ohci card.\n");
1964 * Now enable LPS, which we need in order to start accessing
1965 * most of the registers. In fact, on some cards (ALI M5251),
1966 * accessing registers in the SClk domain without LPS enabled
1967 * will lock up the machine. Wait 50msec to make sure we have
1968 * full link enabled. However, with some cards (well, at least
1969 * a JMicron PCIe card), we have to try again sometimes.
1971 reg_write(ohci, OHCI1394_HCControlSet,
1972 OHCI1394_HCControl_LPS |
1973 OHCI1394_HCControl_postedWriteEnable);
1976 for (lps = 0, i = 0; !lps && i < 3; i++) {
1978 lps = reg_read(ohci, OHCI1394_HCControlSet) &
1979 OHCI1394_HCControl_LPS;
1983 fw_error("Failed to set Link Power Status\n");
1987 reg_write(ohci, OHCI1394_HCControlClear,
1988 OHCI1394_HCControl_noByteSwapData);
1990 reg_write(ohci, OHCI1394_SelfIDBuffer, ohci->self_id_bus);
1991 reg_write(ohci, OHCI1394_LinkControlSet,
1992 OHCI1394_LinkControl_rcvSelfID |
1993 OHCI1394_LinkControl_rcvPhyPkt |
1994 OHCI1394_LinkControl_cycleTimerEnable |
1995 OHCI1394_LinkControl_cycleMaster);
1997 reg_write(ohci, OHCI1394_ATRetries,
1998 OHCI1394_MAX_AT_REQ_RETRIES |
1999 (OHCI1394_MAX_AT_RESP_RETRIES << 4) |
2000 (OHCI1394_MAX_PHYS_RESP_RETRIES << 8) |
2003 seconds = lower_32_bits(get_seconds());
2004 reg_write(ohci, OHCI1394_IsochronousCycleTimer, seconds << 25);
2005 ohci->bus_time = seconds & ~0x3f;
2007 version = reg_read(ohci, OHCI1394_Version) & 0x00ff00ff;
2008 if (version >= OHCI_VERSION_1_1) {
2009 reg_write(ohci, OHCI1394_InitialChannelsAvailableHi,
2011 card->broadcast_channel_auto_allocated = true;
2014 /* Get implemented bits of the priority arbitration request counter. */
2015 reg_write(ohci, OHCI1394_FairnessControl, 0x3f);
2016 ohci->pri_req_max = reg_read(ohci, OHCI1394_FairnessControl) & 0x3f;
2017 reg_write(ohci, OHCI1394_FairnessControl, 0);
2018 card->priority_budget_implemented = ohci->pri_req_max != 0;
2020 ar_context_run(&ohci->ar_request_ctx);
2021 ar_context_run(&ohci->ar_response_ctx);
2023 reg_write(ohci, OHCI1394_PhyUpperBound, 0x00010000);
2024 reg_write(ohci, OHCI1394_IntEventClear, ~0);
2025 reg_write(ohci, OHCI1394_IntMaskClear, ~0);
2027 ret = configure_1394a_enhancements(ohci);
2031 /* Activate link_on bit and contender bit in our self ID packets.*/
2032 ret = ohci_update_phy_reg(card, 4, 0, PHY_LINK_ACTIVE | PHY_CONTENDER);
2037 * When the link is not yet enabled, the atomic config rom
2038 * update mechanism described below in ohci_set_config_rom()
2039 * is not active. We have to update ConfigRomHeader and
2040 * BusOptions manually, and the write to ConfigROMmap takes
2041 * effect immediately. We tie this to the enabling of the
2042 * link, so we have a valid config rom before enabling - the
2043 * OHCI requires that ConfigROMhdr and BusOptions have valid
2044 * values before enabling.
2046 * However, when the ConfigROMmap is written, some controllers
2047 * always read back quadlets 0 and 2 from the config rom to
2048 * the ConfigRomHeader and BusOptions registers on bus reset.
2049 * They shouldn't do that in this initial case where the link
2050 * isn't enabled. This means we have to use the same
2051 * workaround here, setting the bus header to 0 and then write
2052 * the right values in the bus reset tasklet.
2056 ohci->next_config_rom =
2057 dma_alloc_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2058 &ohci->next_config_rom_bus,
2060 if (ohci->next_config_rom == NULL)
2063 copy_config_rom(ohci->next_config_rom, config_rom, length);
2066 * In the suspend case, config_rom is NULL, which
2067 * means that we just reuse the old config rom.
2069 ohci->next_config_rom = ohci->config_rom;
2070 ohci->next_config_rom_bus = ohci->config_rom_bus;
2073 ohci->next_header = ohci->next_config_rom[0];
2074 ohci->next_config_rom[0] = 0;
2075 reg_write(ohci, OHCI1394_ConfigROMhdr, 0);
2076 reg_write(ohci, OHCI1394_BusOptions,
2077 be32_to_cpu(ohci->next_config_rom[2]));
2078 reg_write(ohci, OHCI1394_ConfigROMmap, ohci->next_config_rom_bus);
2080 reg_write(ohci, OHCI1394_AsReqFilterHiSet, 0x80000000);
2082 if (!(ohci->quirks & QUIRK_NO_MSI))
2083 pci_enable_msi(dev);
2084 if (request_irq(dev->irq, irq_handler,
2085 pci_dev_msi_enabled(dev) ? 0 : IRQF_SHARED,
2086 ohci_driver_name, ohci)) {
2087 fw_error("Failed to allocate interrupt %d.\n", dev->irq);
2088 pci_disable_msi(dev);
2089 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2090 ohci->config_rom, ohci->config_rom_bus);
2094 irqs = OHCI1394_reqTxComplete | OHCI1394_respTxComplete |
2095 OHCI1394_RQPkt | OHCI1394_RSPkt |
2096 OHCI1394_isochTx | OHCI1394_isochRx |
2097 OHCI1394_postedWriteErr |
2098 OHCI1394_selfIDComplete |
2099 OHCI1394_regAccessFail |
2100 OHCI1394_cycle64Seconds |
2101 OHCI1394_cycleInconsistent | OHCI1394_cycleTooLong |
2102 OHCI1394_masterIntEnable;
2103 if (param_debug & OHCI_PARAM_DEBUG_BUSRESETS)
2104 irqs |= OHCI1394_busReset;
2105 reg_write(ohci, OHCI1394_IntMaskSet, irqs);
2107 reg_write(ohci, OHCI1394_HCControlSet,
2108 OHCI1394_HCControl_linkEnable |
2109 OHCI1394_HCControl_BIBimageValid);
2112 /* We are ready to go, reset bus to finish initialization. */
2113 fw_schedule_bus_reset(&ohci->card, false, true);
2118 static int ohci_set_config_rom(struct fw_card *card,
2119 const __be32 *config_rom, size_t length)
2121 struct fw_ohci *ohci;
2122 unsigned long flags;
2124 __be32 *next_config_rom;
2125 dma_addr_t uninitialized_var(next_config_rom_bus);
2127 ohci = fw_ohci(card);
2130 * When the OHCI controller is enabled, the config rom update
2131 * mechanism is a bit tricky, but easy enough to use. See
2132 * section 5.5.6 in the OHCI specification.
2134 * The OHCI controller caches the new config rom address in a
2135 * shadow register (ConfigROMmapNext) and needs a bus reset
2136 * for the changes to take place. When the bus reset is
2137 * detected, the controller loads the new values for the
2138 * ConfigRomHeader and BusOptions registers from the specified
2139 * config rom and loads ConfigROMmap from the ConfigROMmapNext
2140 * shadow register. All automatically and atomically.
2142 * Now, there's a twist to this story. The automatic load of
2143 * ConfigRomHeader and BusOptions doesn't honor the
2144 * noByteSwapData bit, so with a be32 config rom, the
2145 * controller will load be32 values in to these registers
2146 * during the atomic update, even on litte endian
2147 * architectures. The workaround we use is to put a 0 in the
2148 * header quadlet; 0 is endian agnostic and means that the
2149 * config rom isn't ready yet. In the bus reset tasklet we
2150 * then set up the real values for the two registers.
2152 * We use ohci->lock to avoid racing with the code that sets
2153 * ohci->next_config_rom to NULL (see bus_reset_tasklet).
2157 dma_alloc_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2158 &next_config_rom_bus, GFP_KERNEL);
2159 if (next_config_rom == NULL)
2162 spin_lock_irqsave(&ohci->lock, flags);
2164 if (ohci->next_config_rom == NULL) {
2165 ohci->next_config_rom = next_config_rom;
2166 ohci->next_config_rom_bus = next_config_rom_bus;
2168 copy_config_rom(ohci->next_config_rom, config_rom, length);
2170 ohci->next_header = config_rom[0];
2171 ohci->next_config_rom[0] = 0;
2173 reg_write(ohci, OHCI1394_ConfigROMmap,
2174 ohci->next_config_rom_bus);
2178 spin_unlock_irqrestore(&ohci->lock, flags);
2181 * Now initiate a bus reset to have the changes take
2182 * effect. We clean up the old config rom memory and DMA
2183 * mappings in the bus reset tasklet, since the OHCI
2184 * controller could need to access it before the bus reset
2188 fw_schedule_bus_reset(&ohci->card, true, true);
2190 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2191 next_config_rom, next_config_rom_bus);
2196 static void ohci_send_request(struct fw_card *card, struct fw_packet *packet)
2198 struct fw_ohci *ohci = fw_ohci(card);
2200 at_context_transmit(&ohci->at_request_ctx, packet);
2203 static void ohci_send_response(struct fw_card *card, struct fw_packet *packet)
2205 struct fw_ohci *ohci = fw_ohci(card);
2207 at_context_transmit(&ohci->at_response_ctx, packet);
2210 static int ohci_cancel_packet(struct fw_card *card, struct fw_packet *packet)
2212 struct fw_ohci *ohci = fw_ohci(card);
2213 struct context *ctx = &ohci->at_request_ctx;
2214 struct driver_data *driver_data = packet->driver_data;
2217 tasklet_disable(&ctx->tasklet);
2219 if (packet->ack != 0)
2222 if (packet->payload_mapped)
2223 dma_unmap_single(ohci->card.device, packet->payload_bus,
2224 packet->payload_length, DMA_TO_DEVICE);
2226 log_ar_at_event('T', packet->speed, packet->header, 0x20);
2227 driver_data->packet = NULL;
2228 packet->ack = RCODE_CANCELLED;
2229 packet->callback(packet, &ohci->card, packet->ack);
2232 tasklet_enable(&ctx->tasklet);
2237 static int ohci_enable_phys_dma(struct fw_card *card,
2238 int node_id, int generation)
2240 #ifdef CONFIG_FIREWIRE_OHCI_REMOTE_DMA
2243 struct fw_ohci *ohci = fw_ohci(card);
2244 unsigned long flags;
2248 * FIXME: Make sure this bitmask is cleared when we clear the busReset
2249 * interrupt bit. Clear physReqResourceAllBuses on bus reset.
2252 spin_lock_irqsave(&ohci->lock, flags);
2254 if (ohci->generation != generation) {
2260 * Note, if the node ID contains a non-local bus ID, physical DMA is
2261 * enabled for _all_ nodes on remote buses.
2264 n = (node_id & 0xffc0) == LOCAL_BUS ? node_id & 0x3f : 63;
2266 reg_write(ohci, OHCI1394_PhyReqFilterLoSet, 1 << n);
2268 reg_write(ohci, OHCI1394_PhyReqFilterHiSet, 1 << (n - 32));
2272 spin_unlock_irqrestore(&ohci->lock, flags);
2275 #endif /* CONFIG_FIREWIRE_OHCI_REMOTE_DMA */
2278 static u32 ohci_read_csr(struct fw_card *card, int csr_offset)
2280 struct fw_ohci *ohci = fw_ohci(card);
2281 unsigned long flags;
2284 switch (csr_offset) {
2285 case CSR_STATE_CLEAR:
2287 if (ohci->is_root &&
2288 (reg_read(ohci, OHCI1394_LinkControlSet) &
2289 OHCI1394_LinkControl_cycleMaster))
2290 value = CSR_STATE_BIT_CMSTR;
2293 if (ohci->csr_state_setclear_abdicate)
2294 value |= CSR_STATE_BIT_ABDICATE;
2299 return reg_read(ohci, OHCI1394_NodeID) << 16;
2301 case CSR_CYCLE_TIME:
2302 return get_cycle_time(ohci);
2306 * We might be called just after the cycle timer has wrapped
2307 * around but just before the cycle64Seconds handler, so we
2308 * better check here, too, if the bus time needs to be updated.
2310 spin_lock_irqsave(&ohci->lock, flags);
2311 value = update_bus_time(ohci);
2312 spin_unlock_irqrestore(&ohci->lock, flags);
2315 case CSR_BUSY_TIMEOUT:
2316 value = reg_read(ohci, OHCI1394_ATRetries);
2317 return (value >> 4) & 0x0ffff00f;
2319 case CSR_PRIORITY_BUDGET:
2320 return (reg_read(ohci, OHCI1394_FairnessControl) & 0x3f) |
2321 (ohci->pri_req_max << 8);
2329 static void ohci_write_csr(struct fw_card *card, int csr_offset, u32 value)
2331 struct fw_ohci *ohci = fw_ohci(card);
2332 unsigned long flags;
2334 switch (csr_offset) {
2335 case CSR_STATE_CLEAR:
2336 if ((value & CSR_STATE_BIT_CMSTR) && ohci->is_root) {
2337 reg_write(ohci, OHCI1394_LinkControlClear,
2338 OHCI1394_LinkControl_cycleMaster);
2341 if (value & CSR_STATE_BIT_ABDICATE)
2342 ohci->csr_state_setclear_abdicate = false;
2346 if ((value & CSR_STATE_BIT_CMSTR) && ohci->is_root) {
2347 reg_write(ohci, OHCI1394_LinkControlSet,
2348 OHCI1394_LinkControl_cycleMaster);
2351 if (value & CSR_STATE_BIT_ABDICATE)
2352 ohci->csr_state_setclear_abdicate = true;
2356 reg_write(ohci, OHCI1394_NodeID, value >> 16);
2360 case CSR_CYCLE_TIME:
2361 reg_write(ohci, OHCI1394_IsochronousCycleTimer, value);
2362 reg_write(ohci, OHCI1394_IntEventSet,
2363 OHCI1394_cycleInconsistent);
2368 spin_lock_irqsave(&ohci->lock, flags);
2369 ohci->bus_time = (ohci->bus_time & 0x7f) | (value & ~0x7f);
2370 spin_unlock_irqrestore(&ohci->lock, flags);
2373 case CSR_BUSY_TIMEOUT:
2374 value = (value & 0xf) | ((value & 0xf) << 4) |
2375 ((value & 0xf) << 8) | ((value & 0x0ffff000) << 4);
2376 reg_write(ohci, OHCI1394_ATRetries, value);
2380 case CSR_PRIORITY_BUDGET:
2381 reg_write(ohci, OHCI1394_FairnessControl, value & 0x3f);
2391 static void copy_iso_headers(struct iso_context *ctx, void *p)
2393 int i = ctx->header_length;
2395 if (i + ctx->base.header_size > PAGE_SIZE)
2399 * The iso header is byteswapped to little endian by
2400 * the controller, but the remaining header quadlets
2401 * are big endian. We want to present all the headers
2402 * as big endian, so we have to swap the first quadlet.
2404 if (ctx->base.header_size > 0)
2405 *(u32 *) (ctx->header + i) = __swab32(*(u32 *) (p + 4));
2406 if (ctx->base.header_size > 4)
2407 *(u32 *) (ctx->header + i + 4) = __swab32(*(u32 *) p);
2408 if (ctx->base.header_size > 8)
2409 memcpy(ctx->header + i + 8, p + 8, ctx->base.header_size - 8);
2410 ctx->header_length += ctx->base.header_size;
2413 static int handle_ir_packet_per_buffer(struct context *context,
2414 struct descriptor *d,
2415 struct descriptor *last)
2417 struct iso_context *ctx =
2418 container_of(context, struct iso_context, context);
2419 struct descriptor *pd;
2423 for (pd = d; pd <= last; pd++)
2424 if (pd->transfer_status)
2427 /* Descriptor(s) not done yet, stop iteration */
2431 copy_iso_headers(ctx, p);
2433 if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS) {
2434 ir_header = (__le32 *) p;
2435 ctx->base.callback.sc(&ctx->base,
2436 le32_to_cpu(ir_header[0]) & 0xffff,
2437 ctx->header_length, ctx->header,
2438 ctx->base.callback_data);
2439 ctx->header_length = 0;
2445 /* d == last because each descriptor block is only a single descriptor. */
2446 static int handle_ir_buffer_fill(struct context *context,
2447 struct descriptor *d,
2448 struct descriptor *last)
2450 struct iso_context *ctx =
2451 container_of(context, struct iso_context, context);
2453 if (!last->transfer_status)
2454 /* Descriptor(s) not done yet, stop iteration */
2457 if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS)
2458 ctx->base.callback.mc(&ctx->base,
2459 le32_to_cpu(last->data_address) +
2460 le16_to_cpu(last->req_count) -
2461 le16_to_cpu(last->res_count),
2462 ctx->base.callback_data);
2467 static int handle_it_packet(struct context *context,
2468 struct descriptor *d,
2469 struct descriptor *last)
2471 struct iso_context *ctx =
2472 container_of(context, struct iso_context, context);
2474 struct descriptor *pd;
2476 for (pd = d; pd <= last; pd++)
2477 if (pd->transfer_status)
2480 /* Descriptor(s) not done yet, stop iteration */
2483 i = ctx->header_length;
2484 if (i + 4 < PAGE_SIZE) {
2485 /* Present this value as big-endian to match the receive code */
2486 *(__be32 *)(ctx->header + i) = cpu_to_be32(
2487 ((u32)le16_to_cpu(pd->transfer_status) << 16) |
2488 le16_to_cpu(pd->res_count));
2489 ctx->header_length += 4;
2491 if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS) {
2492 ctx->base.callback.sc(&ctx->base, le16_to_cpu(last->res_count),
2493 ctx->header_length, ctx->header,
2494 ctx->base.callback_data);
2495 ctx->header_length = 0;
2500 static void set_multichannel_mask(struct fw_ohci *ohci, u64 channels)
2502 u32 hi = channels >> 32, lo = channels;
2504 reg_write(ohci, OHCI1394_IRMultiChanMaskHiClear, ~hi);
2505 reg_write(ohci, OHCI1394_IRMultiChanMaskLoClear, ~lo);
2506 reg_write(ohci, OHCI1394_IRMultiChanMaskHiSet, hi);
2507 reg_write(ohci, OHCI1394_IRMultiChanMaskLoSet, lo);
2509 ohci->mc_channels = channels;
2512 static struct fw_iso_context *ohci_allocate_iso_context(struct fw_card *card,
2513 int type, int channel, size_t header_size)
2515 struct fw_ohci *ohci = fw_ohci(card);
2516 struct iso_context *uninitialized_var(ctx);
2517 descriptor_callback_t uninitialized_var(callback);
2518 u64 *uninitialized_var(channels);
2519 u32 *uninitialized_var(mask), uninitialized_var(regs);
2520 unsigned long flags;
2521 int index, ret = -EBUSY;
2523 spin_lock_irqsave(&ohci->lock, flags);
2526 case FW_ISO_CONTEXT_TRANSMIT:
2527 mask = &ohci->it_context_mask;
2528 callback = handle_it_packet;
2529 index = ffs(*mask) - 1;
2531 *mask &= ~(1 << index);
2532 regs = OHCI1394_IsoXmitContextBase(index);
2533 ctx = &ohci->it_context_list[index];
2537 case FW_ISO_CONTEXT_RECEIVE:
2538 channels = &ohci->ir_context_channels;
2539 mask = &ohci->ir_context_mask;
2540 callback = handle_ir_packet_per_buffer;
2541 index = *channels & 1ULL << channel ? ffs(*mask) - 1 : -1;
2543 *channels &= ~(1ULL << channel);
2544 *mask &= ~(1 << index);
2545 regs = OHCI1394_IsoRcvContextBase(index);
2546 ctx = &ohci->ir_context_list[index];
2550 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2551 mask = &ohci->ir_context_mask;
2552 callback = handle_ir_buffer_fill;
2553 index = !ohci->mc_allocated ? ffs(*mask) - 1 : -1;
2555 ohci->mc_allocated = true;
2556 *mask &= ~(1 << index);
2557 regs = OHCI1394_IsoRcvContextBase(index);
2558 ctx = &ohci->ir_context_list[index];
2567 spin_unlock_irqrestore(&ohci->lock, flags);
2570 return ERR_PTR(ret);
2572 memset(ctx, 0, sizeof(*ctx));
2573 ctx->header_length = 0;
2574 ctx->header = (void *) __get_free_page(GFP_KERNEL);
2575 if (ctx->header == NULL) {
2579 ret = context_init(&ctx->context, ohci, regs, callback);
2581 goto out_with_header;
2583 if (type == FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL)
2584 set_multichannel_mask(ohci, 0);
2589 free_page((unsigned long)ctx->header);
2591 spin_lock_irqsave(&ohci->lock, flags);
2594 case FW_ISO_CONTEXT_RECEIVE:
2595 *channels |= 1ULL << channel;
2598 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2599 ohci->mc_allocated = false;
2602 *mask |= 1 << index;
2604 spin_unlock_irqrestore(&ohci->lock, flags);
2606 return ERR_PTR(ret);
2609 static int ohci_start_iso(struct fw_iso_context *base,
2610 s32 cycle, u32 sync, u32 tags)
2612 struct iso_context *ctx = container_of(base, struct iso_context, base);
2613 struct fw_ohci *ohci = ctx->context.ohci;
2614 u32 control = IR_CONTEXT_ISOCH_HEADER, match;
2617 switch (ctx->base.type) {
2618 case FW_ISO_CONTEXT_TRANSMIT:
2619 index = ctx - ohci->it_context_list;
2622 match = IT_CONTEXT_CYCLE_MATCH_ENABLE |
2623 (cycle & 0x7fff) << 16;
2625 reg_write(ohci, OHCI1394_IsoXmitIntEventClear, 1 << index);
2626 reg_write(ohci, OHCI1394_IsoXmitIntMaskSet, 1 << index);
2627 context_run(&ctx->context, match);
2630 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2631 control |= IR_CONTEXT_BUFFER_FILL|IR_CONTEXT_MULTI_CHANNEL_MODE;
2633 case FW_ISO_CONTEXT_RECEIVE:
2634 index = ctx - ohci->ir_context_list;
2635 match = (tags << 28) | (sync << 8) | ctx->base.channel;
2637 match |= (cycle & 0x07fff) << 12;
2638 control |= IR_CONTEXT_CYCLE_MATCH_ENABLE;
2641 reg_write(ohci, OHCI1394_IsoRecvIntEventClear, 1 << index);
2642 reg_write(ohci, OHCI1394_IsoRecvIntMaskSet, 1 << index);
2643 reg_write(ohci, CONTEXT_MATCH(ctx->context.regs), match);
2644 context_run(&ctx->context, control);
2651 static int ohci_stop_iso(struct fw_iso_context *base)
2653 struct fw_ohci *ohci = fw_ohci(base->card);
2654 struct iso_context *ctx = container_of(base, struct iso_context, base);
2657 switch (ctx->base.type) {
2658 case FW_ISO_CONTEXT_TRANSMIT:
2659 index = ctx - ohci->it_context_list;
2660 reg_write(ohci, OHCI1394_IsoXmitIntMaskClear, 1 << index);
2663 case FW_ISO_CONTEXT_RECEIVE:
2664 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2665 index = ctx - ohci->ir_context_list;
2666 reg_write(ohci, OHCI1394_IsoRecvIntMaskClear, 1 << index);
2670 context_stop(&ctx->context);
2675 static void ohci_free_iso_context(struct fw_iso_context *base)
2677 struct fw_ohci *ohci = fw_ohci(base->card);
2678 struct iso_context *ctx = container_of(base, struct iso_context, base);
2679 unsigned long flags;
2682 ohci_stop_iso(base);
2683 context_release(&ctx->context);
2684 free_page((unsigned long)ctx->header);
2686 spin_lock_irqsave(&ohci->lock, flags);
2688 switch (base->type) {
2689 case FW_ISO_CONTEXT_TRANSMIT:
2690 index = ctx - ohci->it_context_list;
2691 ohci->it_context_mask |= 1 << index;
2694 case FW_ISO_CONTEXT_RECEIVE:
2695 index = ctx - ohci->ir_context_list;
2696 ohci->ir_context_mask |= 1 << index;
2697 ohci->ir_context_channels |= 1ULL << base->channel;
2700 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2701 index = ctx - ohci->ir_context_list;
2702 ohci->ir_context_mask |= 1 << index;
2703 ohci->ir_context_channels |= ohci->mc_channels;
2704 ohci->mc_channels = 0;
2705 ohci->mc_allocated = false;
2709 spin_unlock_irqrestore(&ohci->lock, flags);
2712 static int ohci_set_iso_channels(struct fw_iso_context *base, u64 *channels)
2714 struct fw_ohci *ohci = fw_ohci(base->card);
2715 unsigned long flags;
2718 switch (base->type) {
2719 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2721 spin_lock_irqsave(&ohci->lock, flags);
2723 /* Don't allow multichannel to grab other contexts' channels. */
2724 if (~ohci->ir_context_channels & ~ohci->mc_channels & *channels) {
2725 *channels = ohci->ir_context_channels;
2728 set_multichannel_mask(ohci, *channels);
2732 spin_unlock_irqrestore(&ohci->lock, flags);
2742 static int queue_iso_transmit(struct iso_context *ctx,
2743 struct fw_iso_packet *packet,
2744 struct fw_iso_buffer *buffer,
2745 unsigned long payload)
2747 struct descriptor *d, *last, *pd;
2748 struct fw_iso_packet *p;
2750 dma_addr_t d_bus, page_bus;
2751 u32 z, header_z, payload_z, irq;
2752 u32 payload_index, payload_end_index, next_page_index;
2753 int page, end_page, i, length, offset;
2756 payload_index = payload;
2762 if (p->header_length > 0)
2765 /* Determine the first page the payload isn't contained in. */
2766 end_page = PAGE_ALIGN(payload_index + p->payload_length) >> PAGE_SHIFT;
2767 if (p->payload_length > 0)
2768 payload_z = end_page - (payload_index >> PAGE_SHIFT);
2774 /* Get header size in number of descriptors. */
2775 header_z = DIV_ROUND_UP(p->header_length, sizeof(*d));
2777 d = context_get_descriptors(&ctx->context, z + header_z, &d_bus);
2782 d[0].control = cpu_to_le16(DESCRIPTOR_KEY_IMMEDIATE);
2783 d[0].req_count = cpu_to_le16(8);
2785 * Link the skip address to this descriptor itself. This causes
2786 * a context to skip a cycle whenever lost cycles or FIFO
2787 * overruns occur, without dropping the data. The application
2788 * should then decide whether this is an error condition or not.
2789 * FIXME: Make the context's cycle-lost behaviour configurable?
2791 d[0].branch_address = cpu_to_le32(d_bus | z);
2793 header = (__le32 *) &d[1];
2794 header[0] = cpu_to_le32(IT_HEADER_SY(p->sy) |
2795 IT_HEADER_TAG(p->tag) |
2796 IT_HEADER_TCODE(TCODE_STREAM_DATA) |
2797 IT_HEADER_CHANNEL(ctx->base.channel) |
2798 IT_HEADER_SPEED(ctx->base.speed));
2800 cpu_to_le32(IT_HEADER_DATA_LENGTH(p->header_length +
2801 p->payload_length));
2804 if (p->header_length > 0) {
2805 d[2].req_count = cpu_to_le16(p->header_length);
2806 d[2].data_address = cpu_to_le32(d_bus + z * sizeof(*d));
2807 memcpy(&d[z], p->header, p->header_length);
2810 pd = d + z - payload_z;
2811 payload_end_index = payload_index + p->payload_length;
2812 for (i = 0; i < payload_z; i++) {
2813 page = payload_index >> PAGE_SHIFT;
2814 offset = payload_index & ~PAGE_MASK;
2815 next_page_index = (page + 1) << PAGE_SHIFT;
2817 min(next_page_index, payload_end_index) - payload_index;
2818 pd[i].req_count = cpu_to_le16(length);
2820 page_bus = page_private(buffer->pages[page]);
2821 pd[i].data_address = cpu_to_le32(page_bus + offset);
2823 payload_index += length;
2827 irq = DESCRIPTOR_IRQ_ALWAYS;
2829 irq = DESCRIPTOR_NO_IRQ;
2831 last = z == 2 ? d : d + z - 1;
2832 last->control |= cpu_to_le16(DESCRIPTOR_OUTPUT_LAST |
2834 DESCRIPTOR_BRANCH_ALWAYS |
2837 context_append(&ctx->context, d, z, header_z);
2842 static int queue_iso_packet_per_buffer(struct iso_context *ctx,
2843 struct fw_iso_packet *packet,
2844 struct fw_iso_buffer *buffer,
2845 unsigned long payload)
2847 struct descriptor *d, *pd;
2848 dma_addr_t d_bus, page_bus;
2849 u32 z, header_z, rest;
2851 int page, offset, packet_count, header_size, payload_per_buffer;
2854 * The OHCI controller puts the isochronous header and trailer in the
2855 * buffer, so we need at least 8 bytes.
2857 packet_count = packet->header_length / ctx->base.header_size;
2858 header_size = max(ctx->base.header_size, (size_t)8);
2860 /* Get header size in number of descriptors. */
2861 header_z = DIV_ROUND_UP(header_size, sizeof(*d));
2862 page = payload >> PAGE_SHIFT;
2863 offset = payload & ~PAGE_MASK;
2864 payload_per_buffer = packet->payload_length / packet_count;
2866 for (i = 0; i < packet_count; i++) {
2867 /* d points to the header descriptor */
2868 z = DIV_ROUND_UP(payload_per_buffer + offset, PAGE_SIZE) + 1;
2869 d = context_get_descriptors(&ctx->context,
2870 z + header_z, &d_bus);
2874 d->control = cpu_to_le16(DESCRIPTOR_STATUS |
2875 DESCRIPTOR_INPUT_MORE);
2876 if (packet->skip && i == 0)
2877 d->control |= cpu_to_le16(DESCRIPTOR_WAIT);
2878 d->req_count = cpu_to_le16(header_size);
2879 d->res_count = d->req_count;
2880 d->transfer_status = 0;
2881 d->data_address = cpu_to_le32(d_bus + (z * sizeof(*d)));
2883 rest = payload_per_buffer;
2885 for (j = 1; j < z; j++) {
2887 pd->control = cpu_to_le16(DESCRIPTOR_STATUS |
2888 DESCRIPTOR_INPUT_MORE);
2890 if (offset + rest < PAGE_SIZE)
2893 length = PAGE_SIZE - offset;
2894 pd->req_count = cpu_to_le16(length);
2895 pd->res_count = pd->req_count;
2896 pd->transfer_status = 0;
2898 page_bus = page_private(buffer->pages[page]);
2899 pd->data_address = cpu_to_le32(page_bus + offset);
2901 offset = (offset + length) & ~PAGE_MASK;
2906 pd->control = cpu_to_le16(DESCRIPTOR_STATUS |
2907 DESCRIPTOR_INPUT_LAST |
2908 DESCRIPTOR_BRANCH_ALWAYS);
2909 if (packet->interrupt && i == packet_count - 1)
2910 pd->control |= cpu_to_le16(DESCRIPTOR_IRQ_ALWAYS);
2912 context_append(&ctx->context, d, z, header_z);
2918 static int queue_iso_buffer_fill(struct iso_context *ctx,
2919 struct fw_iso_packet *packet,
2920 struct fw_iso_buffer *buffer,
2921 unsigned long payload)
2923 struct descriptor *d;
2924 dma_addr_t d_bus, page_bus;
2925 int page, offset, rest, z, i, length;
2927 page = payload >> PAGE_SHIFT;
2928 offset = payload & ~PAGE_MASK;
2929 rest = packet->payload_length;
2931 /* We need one descriptor for each page in the buffer. */
2932 z = DIV_ROUND_UP(offset + rest, PAGE_SIZE);
2934 if (WARN_ON(offset & 3 || rest & 3 || page + z > buffer->page_count))
2937 for (i = 0; i < z; i++) {
2938 d = context_get_descriptors(&ctx->context, 1, &d_bus);
2942 d->control = cpu_to_le16(DESCRIPTOR_INPUT_MORE |
2943 DESCRIPTOR_BRANCH_ALWAYS);
2944 if (packet->skip && i == 0)
2945 d->control |= cpu_to_le16(DESCRIPTOR_WAIT);
2946 if (packet->interrupt && i == z - 1)
2947 d->control |= cpu_to_le16(DESCRIPTOR_IRQ_ALWAYS);
2949 if (offset + rest < PAGE_SIZE)
2952 length = PAGE_SIZE - offset;
2953 d->req_count = cpu_to_le16(length);
2954 d->res_count = d->req_count;
2955 d->transfer_status = 0;
2957 page_bus = page_private(buffer->pages[page]);
2958 d->data_address = cpu_to_le32(page_bus + offset);
2964 context_append(&ctx->context, d, 1, 0);
2970 static int ohci_queue_iso(struct fw_iso_context *base,
2971 struct fw_iso_packet *packet,
2972 struct fw_iso_buffer *buffer,
2973 unsigned long payload)
2975 struct iso_context *ctx = container_of(base, struct iso_context, base);
2976 unsigned long flags;
2979 spin_lock_irqsave(&ctx->context.ohci->lock, flags);
2980 switch (base->type) {
2981 case FW_ISO_CONTEXT_TRANSMIT:
2982 ret = queue_iso_transmit(ctx, packet, buffer, payload);
2984 case FW_ISO_CONTEXT_RECEIVE:
2985 ret = queue_iso_packet_per_buffer(ctx, packet, buffer, payload);
2987 case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2988 ret = queue_iso_buffer_fill(ctx, packet, buffer, payload);
2991 spin_unlock_irqrestore(&ctx->context.ohci->lock, flags);
2996 static const struct fw_card_driver ohci_driver = {
2997 .enable = ohci_enable,
2998 .read_phy_reg = ohci_read_phy_reg,
2999 .update_phy_reg = ohci_update_phy_reg,
3000 .set_config_rom = ohci_set_config_rom,
3001 .send_request = ohci_send_request,
3002 .send_response = ohci_send_response,
3003 .cancel_packet = ohci_cancel_packet,
3004 .enable_phys_dma = ohci_enable_phys_dma,
3005 .read_csr = ohci_read_csr,
3006 .write_csr = ohci_write_csr,
3008 .allocate_iso_context = ohci_allocate_iso_context,
3009 .free_iso_context = ohci_free_iso_context,
3010 .set_iso_channels = ohci_set_iso_channels,
3011 .queue_iso = ohci_queue_iso,
3012 .start_iso = ohci_start_iso,
3013 .stop_iso = ohci_stop_iso,
3016 #ifdef CONFIG_PPC_PMAC
3017 static void pmac_ohci_on(struct pci_dev *dev)
3019 if (machine_is(powermac)) {
3020 struct device_node *ofn = pci_device_to_OF_node(dev);
3023 pmac_call_feature(PMAC_FTR_1394_CABLE_POWER, ofn, 0, 1);
3024 pmac_call_feature(PMAC_FTR_1394_ENABLE, ofn, 0, 1);
3029 static void pmac_ohci_off(struct pci_dev *dev)
3031 if (machine_is(powermac)) {
3032 struct device_node *ofn = pci_device_to_OF_node(dev);
3035 pmac_call_feature(PMAC_FTR_1394_ENABLE, ofn, 0, 0);
3036 pmac_call_feature(PMAC_FTR_1394_CABLE_POWER, ofn, 0, 0);
3041 static inline void pmac_ohci_on(struct pci_dev *dev) {}
3042 static inline void pmac_ohci_off(struct pci_dev *dev) {}
3043 #endif /* CONFIG_PPC_PMAC */
3045 static int __devinit pci_probe(struct pci_dev *dev,
3046 const struct pci_device_id *ent)
3048 struct fw_ohci *ohci;
3049 u32 bus_options, max_receive, link_speed, version;
3051 int i, err, n_ir, n_it;
3054 ohci = kzalloc(sizeof(*ohci), GFP_KERNEL);
3060 fw_card_initialize(&ohci->card, &ohci_driver, &dev->dev);
3064 err = pci_enable_device(dev);
3066 fw_error("Failed to enable OHCI hardware\n");
3070 pci_set_master(dev);
3071 pci_write_config_dword(dev, OHCI1394_PCI_HCI_Control, 0);
3072 pci_set_drvdata(dev, ohci);
3074 spin_lock_init(&ohci->lock);
3075 mutex_init(&ohci->phy_reg_mutex);
3077 tasklet_init(&ohci->bus_reset_tasklet,
3078 bus_reset_tasklet, (unsigned long)ohci);
3080 err = pci_request_region(dev, 0, ohci_driver_name);
3082 fw_error("MMIO resource unavailable\n");
3086 ohci->registers = pci_iomap(dev, 0, OHCI1394_REGISTER_SIZE);
3087 if (ohci->registers == NULL) {
3088 fw_error("Failed to remap registers\n");
3093 for (i = 0; i < ARRAY_SIZE(ohci_quirks); i++)
3094 if ((ohci_quirks[i].vendor == dev->vendor) &&
3095 (ohci_quirks[i].device == (unsigned short)PCI_ANY_ID ||
3096 ohci_quirks[i].device == dev->device) &&
3097 (ohci_quirks[i].revision == (unsigned short)PCI_ANY_ID ||
3098 ohci_quirks[i].revision >= dev->revision)) {
3099 ohci->quirks = ohci_quirks[i].flags;
3103 ohci->quirks = param_quirks;
3105 err = ar_context_init(&ohci->ar_request_ctx, ohci,
3106 OHCI1394_AsReqRcvContextControlSet);
3110 err = ar_context_init(&ohci->ar_response_ctx, ohci,
3111 OHCI1394_AsRspRcvContextControlSet);
3113 goto fail_arreq_ctx;
3115 err = context_init(&ohci->at_request_ctx, ohci,
3116 OHCI1394_AsReqTrContextControlSet, handle_at_packet);
3118 goto fail_arrsp_ctx;
3120 err = context_init(&ohci->at_response_ctx, ohci,
3121 OHCI1394_AsRspTrContextControlSet, handle_at_packet);
3123 goto fail_atreq_ctx;
3125 reg_write(ohci, OHCI1394_IsoRecvIntMaskSet, ~0);
3126 ohci->ir_context_channels = ~0ULL;
3127 ohci->ir_context_mask = reg_read(ohci, OHCI1394_IsoRecvIntMaskSet);
3128 reg_write(ohci, OHCI1394_IsoRecvIntMaskClear, ~0);
3129 n_ir = hweight32(ohci->ir_context_mask);
3130 size = sizeof(struct iso_context) * n_ir;
3131 ohci->ir_context_list = kzalloc(size, GFP_KERNEL);
3133 reg_write(ohci, OHCI1394_IsoXmitIntMaskSet, ~0);
3134 ohci->it_context_mask = reg_read(ohci, OHCI1394_IsoXmitIntMaskSet);
3135 reg_write(ohci, OHCI1394_IsoXmitIntMaskClear, ~0);
3136 n_it = hweight32(ohci->it_context_mask);
3137 size = sizeof(struct iso_context) * n_it;
3138 ohci->it_context_list = kzalloc(size, GFP_KERNEL);
3140 if (ohci->it_context_list == NULL || ohci->ir_context_list == NULL) {
3145 /* self-id dma buffer allocation */
3146 ohci->self_id_cpu = dma_alloc_coherent(ohci->card.device,
3150 if (ohci->self_id_cpu == NULL) {
3155 bus_options = reg_read(ohci, OHCI1394_BusOptions);
3156 max_receive = (bus_options >> 12) & 0xf;
3157 link_speed = bus_options & 0x7;
3158 guid = ((u64) reg_read(ohci, OHCI1394_GUIDHi) << 32) |
3159 reg_read(ohci, OHCI1394_GUIDLo);
3161 err = fw_card_add(&ohci->card, max_receive, link_speed, guid);
3165 version = reg_read(ohci, OHCI1394_Version) & 0x00ff00ff;
3166 fw_notify("Added fw-ohci device %s, OHCI v%x.%x, "
3167 "%d IR + %d IT contexts, quirks 0x%x\n",
3168 dev_name(&dev->dev), version >> 16, version & 0xff,
3169 n_ir, n_it, ohci->quirks);
3174 dma_free_coherent(ohci->card.device, SELF_ID_BUF_SIZE,
3175 ohci->self_id_cpu, ohci->self_id_bus);
3177 kfree(ohci->ir_context_list);
3178 kfree(ohci->it_context_list);
3179 context_release(&ohci->at_response_ctx);
3181 context_release(&ohci->at_request_ctx);
3183 ar_context_release(&ohci->ar_response_ctx);
3185 ar_context_release(&ohci->ar_request_ctx);
3187 pci_iounmap(dev, ohci->registers);
3189 pci_release_region(dev, 0);
3191 pci_disable_device(dev);
3197 fw_error("Out of memory\n");
3202 static void pci_remove(struct pci_dev *dev)
3204 struct fw_ohci *ohci;
3206 ohci = pci_get_drvdata(dev);
3207 reg_write(ohci, OHCI1394_IntMaskClear, ~0);
3209 fw_core_remove_card(&ohci->card);
3212 * FIXME: Fail all pending packets here, now that the upper
3213 * layers can't queue any more.
3216 software_reset(ohci);
3217 free_irq(dev->irq, ohci);
3219 if (ohci->next_config_rom && ohci->next_config_rom != ohci->config_rom)
3220 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
3221 ohci->next_config_rom, ohci->next_config_rom_bus);
3222 if (ohci->config_rom)
3223 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
3224 ohci->config_rom, ohci->config_rom_bus);
3225 dma_free_coherent(ohci->card.device, SELF_ID_BUF_SIZE,
3226 ohci->self_id_cpu, ohci->self_id_bus);
3227 ar_context_release(&ohci->ar_request_ctx);
3228 ar_context_release(&ohci->ar_response_ctx);
3229 context_release(&ohci->at_request_ctx);
3230 context_release(&ohci->at_response_ctx);
3231 kfree(ohci->it_context_list);
3232 kfree(ohci->ir_context_list);
3233 pci_disable_msi(dev);
3234 pci_iounmap(dev, ohci->registers);
3235 pci_release_region(dev, 0);
3236 pci_disable_device(dev);
3240 fw_notify("Removed fw-ohci device.\n");
3244 static int pci_suspend(struct pci_dev *dev, pm_message_t state)
3246 struct fw_ohci *ohci = pci_get_drvdata(dev);
3249 software_reset(ohci);
3250 free_irq(dev->irq, ohci);
3251 pci_disable_msi(dev);
3252 err = pci_save_state(dev);
3254 fw_error("pci_save_state failed\n");
3257 err = pci_set_power_state(dev, pci_choose_state(dev, state));
3259 fw_error("pci_set_power_state failed with %d\n", err);
3265 static int pci_resume(struct pci_dev *dev)
3267 struct fw_ohci *ohci = pci_get_drvdata(dev);
3271 pci_set_power_state(dev, PCI_D0);
3272 pci_restore_state(dev);
3273 err = pci_enable_device(dev);
3275 fw_error("pci_enable_device failed\n");
3279 return ohci_enable(&ohci->card, NULL, 0);
3283 static const struct pci_device_id pci_table[] = {
3284 { PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_FIREWIRE_OHCI, ~0) },
3288 MODULE_DEVICE_TABLE(pci, pci_table);
3290 static struct pci_driver fw_ohci_pci_driver = {
3291 .name = ohci_driver_name,
3292 .id_table = pci_table,
3294 .remove = pci_remove,
3296 .resume = pci_resume,
3297 .suspend = pci_suspend,
3301 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
3302 MODULE_DESCRIPTION("Driver for PCI OHCI IEEE1394 controllers");
3303 MODULE_LICENSE("GPL");
3305 /* Provide a module alias so root-on-sbp2 initrds don't break. */
3306 #ifndef CONFIG_IEEE1394_OHCI1394_MODULE
3307 MODULE_ALIAS("ohci1394");
3310 static int __init fw_ohci_init(void)
3312 return pci_register_driver(&fw_ohci_pci_driver);
3315 static void __exit fw_ohci_cleanup(void)
3317 pci_unregister_driver(&fw_ohci_pci_driver);
3320 module_init(fw_ohci_init);
3321 module_exit(fw_ohci_cleanup);