firewire: ohci: log dead DMA contexts
[pandora-kernel.git] / drivers / firewire / ohci.c
1 /*
2  * Driver for OHCI 1394 controllers
3  *
4  * Copyright (C) 2003-2006 Kristian Hoegsberg <krh@bitplanet.net>
5  *
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.
10  *
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.
15  *
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.
19  */
20
21 #include <linux/bitops.h>
22 #include <linux/bug.h>
23 #include <linux/compiler.h>
24 #include <linux/delay.h>
25 #include <linux/device.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/firewire.h>
28 #include <linux/firewire-constants.h>
29 #include <linux/init.h>
30 #include <linux/interrupt.h>
31 #include <linux/io.h>
32 #include <linux/kernel.h>
33 #include <linux/list.h>
34 #include <linux/mm.h>
35 #include <linux/module.h>
36 #include <linux/moduleparam.h>
37 #include <linux/mutex.h>
38 #include <linux/pci.h>
39 #include <linux/pci_ids.h>
40 #include <linux/slab.h>
41 #include <linux/spinlock.h>
42 #include <linux/string.h>
43 #include <linux/time.h>
44 #include <linux/vmalloc.h>
45
46 #include <asm/byteorder.h>
47 #include <asm/page.h>
48 #include <asm/system.h>
49
50 #ifdef CONFIG_PPC_PMAC
51 #include <asm/pmac_feature.h>
52 #endif
53
54 #include "core.h"
55 #include "ohci.h"
56
57 #define DESCRIPTOR_OUTPUT_MORE          0
58 #define DESCRIPTOR_OUTPUT_LAST          (1 << 12)
59 #define DESCRIPTOR_INPUT_MORE           (2 << 12)
60 #define DESCRIPTOR_INPUT_LAST           (3 << 12)
61 #define DESCRIPTOR_STATUS               (1 << 11)
62 #define DESCRIPTOR_KEY_IMMEDIATE        (2 << 8)
63 #define DESCRIPTOR_PING                 (1 << 7)
64 #define DESCRIPTOR_YY                   (1 << 6)
65 #define DESCRIPTOR_NO_IRQ               (0 << 4)
66 #define DESCRIPTOR_IRQ_ERROR            (1 << 4)
67 #define DESCRIPTOR_IRQ_ALWAYS           (3 << 4)
68 #define DESCRIPTOR_BRANCH_ALWAYS        (3 << 2)
69 #define DESCRIPTOR_WAIT                 (3 << 0)
70
71 struct descriptor {
72         __le16 req_count;
73         __le16 control;
74         __le32 data_address;
75         __le32 branch_address;
76         __le16 res_count;
77         __le16 transfer_status;
78 } __attribute__((aligned(16)));
79
80 #define CONTROL_SET(regs)       (regs)
81 #define CONTROL_CLEAR(regs)     ((regs) + 4)
82 #define COMMAND_PTR(regs)       ((regs) + 12)
83 #define CONTEXT_MATCH(regs)     ((regs) + 16)
84
85 #define AR_BUFFER_SIZE  (32*1024)
86 #define AR_BUFFERS_MIN  DIV_ROUND_UP(AR_BUFFER_SIZE, PAGE_SIZE)
87 /* we need at least two pages for proper list management */
88 #define AR_BUFFERS      (AR_BUFFERS_MIN >= 2 ? AR_BUFFERS_MIN : 2)
89
90 #define MAX_ASYNC_PAYLOAD       4096
91 #define MAX_AR_PACKET_SIZE      (16 + MAX_ASYNC_PAYLOAD + 4)
92 #define AR_WRAPAROUND_PAGES     DIV_ROUND_UP(MAX_AR_PACKET_SIZE, PAGE_SIZE)
93
94 struct ar_context {
95         struct fw_ohci *ohci;
96         struct page *pages[AR_BUFFERS];
97         void *buffer;
98         struct descriptor *descriptors;
99         dma_addr_t descriptors_bus;
100         void *pointer;
101         unsigned int last_buffer_index;
102         u32 regs;
103         struct tasklet_struct tasklet;
104 };
105
106 struct context;
107
108 typedef int (*descriptor_callback_t)(struct context *ctx,
109                                      struct descriptor *d,
110                                      struct descriptor *last);
111
112 /*
113  * A buffer that contains a block of DMA-able coherent memory used for
114  * storing a portion of a DMA descriptor program.
115  */
116 struct descriptor_buffer {
117         struct list_head list;
118         dma_addr_t buffer_bus;
119         size_t buffer_size;
120         size_t used;
121         struct descriptor buffer[0];
122 };
123
124 struct context {
125         struct fw_ohci *ohci;
126         u32 regs;
127         int total_allocation;
128         bool running;
129         bool flushing;
130
131         /*
132          * List of page-sized buffers for storing DMA descriptors.
133          * Head of list contains buffers in use and tail of list contains
134          * free buffers.
135          */
136         struct list_head buffer_list;
137
138         /*
139          * Pointer to a buffer inside buffer_list that contains the tail
140          * end of the current DMA program.
141          */
142         struct descriptor_buffer *buffer_tail;
143
144         /*
145          * The descriptor containing the branch address of the first
146          * descriptor that has not yet been filled by the device.
147          */
148         struct descriptor *last;
149
150         /*
151          * The last descriptor in the DMA program.  It contains the branch
152          * address that must be updated upon appending a new descriptor.
153          */
154         struct descriptor *prev;
155
156         descriptor_callback_t callback;
157
158         struct tasklet_struct tasklet;
159 };
160
161 #define IT_HEADER_SY(v)          ((v) <<  0)
162 #define IT_HEADER_TCODE(v)       ((v) <<  4)
163 #define IT_HEADER_CHANNEL(v)     ((v) <<  8)
164 #define IT_HEADER_TAG(v)         ((v) << 14)
165 #define IT_HEADER_SPEED(v)       ((v) << 16)
166 #define IT_HEADER_DATA_LENGTH(v) ((v) << 16)
167
168 struct iso_context {
169         struct fw_iso_context base;
170         struct context context;
171         int excess_bytes;
172         void *header;
173         size_t header_length;
174
175         u8 sync;
176         u8 tags;
177 };
178
179 #define CONFIG_ROM_SIZE 1024
180
181 struct fw_ohci {
182         struct fw_card card;
183
184         __iomem char *registers;
185         int node_id;
186         int generation;
187         int request_generation; /* for timestamping incoming requests */
188         unsigned quirks;
189         unsigned int pri_req_max;
190         u32 bus_time;
191         bool is_root;
192         bool csr_state_setclear_abdicate;
193         int n_ir;
194         int n_it;
195         /*
196          * Spinlock for accessing fw_ohci data.  Never call out of
197          * this driver with this lock held.
198          */
199         spinlock_t lock;
200
201         struct mutex phy_reg_mutex;
202
203         void *misc_buffer;
204         dma_addr_t misc_buffer_bus;
205
206         struct ar_context ar_request_ctx;
207         struct ar_context ar_response_ctx;
208         struct context at_request_ctx;
209         struct context at_response_ctx;
210
211         u32 it_context_support;
212         u32 it_context_mask;     /* unoccupied IT contexts */
213         struct iso_context *it_context_list;
214         u64 ir_context_channels; /* unoccupied channels */
215         u32 ir_context_support;
216         u32 ir_context_mask;     /* unoccupied IR contexts */
217         struct iso_context *ir_context_list;
218         u64 mc_channels; /* channels in use by the multichannel IR context */
219         bool mc_allocated;
220
221         __be32    *config_rom;
222         dma_addr_t config_rom_bus;
223         __be32    *next_config_rom;
224         dma_addr_t next_config_rom_bus;
225         __be32     next_header;
226
227         __le32    *self_id_cpu;
228         dma_addr_t self_id_bus;
229         struct tasklet_struct bus_reset_tasklet;
230
231         u32 self_id_buffer[512];
232 };
233
234 static inline struct fw_ohci *fw_ohci(struct fw_card *card)
235 {
236         return container_of(card, struct fw_ohci, card);
237 }
238
239 #define IT_CONTEXT_CYCLE_MATCH_ENABLE   0x80000000
240 #define IR_CONTEXT_BUFFER_FILL          0x80000000
241 #define IR_CONTEXT_ISOCH_HEADER         0x40000000
242 #define IR_CONTEXT_CYCLE_MATCH_ENABLE   0x20000000
243 #define IR_CONTEXT_MULTI_CHANNEL_MODE   0x10000000
244 #define IR_CONTEXT_DUAL_BUFFER_MODE     0x08000000
245
246 #define CONTEXT_RUN     0x8000
247 #define CONTEXT_WAKE    0x1000
248 #define CONTEXT_DEAD    0x0800
249 #define CONTEXT_ACTIVE  0x0400
250
251 #define OHCI1394_MAX_AT_REQ_RETRIES     0xf
252 #define OHCI1394_MAX_AT_RESP_RETRIES    0x2
253 #define OHCI1394_MAX_PHYS_RESP_RETRIES  0x8
254
255 #define OHCI1394_REGISTER_SIZE          0x800
256 #define OHCI_LOOP_COUNT                 500
257 #define OHCI1394_PCI_HCI_Control        0x40
258 #define SELF_ID_BUF_SIZE                0x800
259 #define OHCI_TCODE_PHY_PACKET           0x0e
260 #define OHCI_VERSION_1_1                0x010010
261
262 static char ohci_driver_name[] = KBUILD_MODNAME;
263
264 #define PCI_DEVICE_ID_AGERE_FW643       0x5901
265 #define PCI_DEVICE_ID_JMICRON_JMB38X_FW 0x2380
266 #define PCI_DEVICE_ID_TI_TSB12LV22      0x8009
267
268 #define QUIRK_CYCLE_TIMER               1
269 #define QUIRK_RESET_PACKET              2
270 #define QUIRK_BE_HEADERS                4
271 #define QUIRK_NO_1394A                  8
272 #define QUIRK_NO_MSI                    16
273
274 /* In case of multiple matches in ohci_quirks[], only the first one is used. */
275 static const struct {
276         unsigned short vendor, device, revision, flags;
277 } ohci_quirks[] = {
278         {PCI_VENDOR_ID_AL, PCI_ANY_ID, PCI_ANY_ID,
279                 QUIRK_CYCLE_TIMER},
280
281         {PCI_VENDOR_ID_APPLE, PCI_DEVICE_ID_APPLE_UNI_N_FW, PCI_ANY_ID,
282                 QUIRK_BE_HEADERS},
283
284         {PCI_VENDOR_ID_ATT, PCI_DEVICE_ID_AGERE_FW643, 6,
285                 QUIRK_NO_MSI},
286
287         {PCI_VENDOR_ID_JMICRON, PCI_DEVICE_ID_JMICRON_JMB38X_FW, PCI_ANY_ID,
288                 QUIRK_NO_MSI},
289
290         {PCI_VENDOR_ID_NEC, PCI_ANY_ID, PCI_ANY_ID,
291                 QUIRK_CYCLE_TIMER},
292
293         {PCI_VENDOR_ID_RICOH, PCI_ANY_ID, PCI_ANY_ID,
294                 QUIRK_CYCLE_TIMER},
295
296         {PCI_VENDOR_ID_TI, PCI_DEVICE_ID_TI_TSB12LV22, PCI_ANY_ID,
297                 QUIRK_CYCLE_TIMER | QUIRK_RESET_PACKET | QUIRK_NO_1394A},
298
299         {PCI_VENDOR_ID_TI, PCI_ANY_ID, PCI_ANY_ID,
300                 QUIRK_RESET_PACKET},
301
302         {PCI_VENDOR_ID_VIA, PCI_ANY_ID, PCI_ANY_ID,
303                 QUIRK_CYCLE_TIMER | QUIRK_NO_MSI},
304 };
305
306 /* This overrides anything that was found in ohci_quirks[]. */
307 static int param_quirks;
308 module_param_named(quirks, param_quirks, int, 0644);
309 MODULE_PARM_DESC(quirks, "Chip quirks (default = 0"
310         ", nonatomic cycle timer = "    __stringify(QUIRK_CYCLE_TIMER)
311         ", reset packet generation = "  __stringify(QUIRK_RESET_PACKET)
312         ", AR/selfID endianess = "      __stringify(QUIRK_BE_HEADERS)
313         ", no 1394a enhancements = "    __stringify(QUIRK_NO_1394A)
314         ", disable MSI = "              __stringify(QUIRK_NO_MSI)
315         ")");
316
317 #define OHCI_PARAM_DEBUG_AT_AR          1
318 #define OHCI_PARAM_DEBUG_SELFIDS        2
319 #define OHCI_PARAM_DEBUG_IRQS           4
320 #define OHCI_PARAM_DEBUG_BUSRESETS      8 /* only effective before chip init */
321
322 #ifdef CONFIG_FIREWIRE_OHCI_DEBUG
323
324 static int param_debug;
325 module_param_named(debug, param_debug, int, 0644);
326 MODULE_PARM_DESC(debug, "Verbose logging (default = 0"
327         ", AT/AR events = "     __stringify(OHCI_PARAM_DEBUG_AT_AR)
328         ", self-IDs = "         __stringify(OHCI_PARAM_DEBUG_SELFIDS)
329         ", IRQs = "             __stringify(OHCI_PARAM_DEBUG_IRQS)
330         ", busReset events = "  __stringify(OHCI_PARAM_DEBUG_BUSRESETS)
331         ", or a combination, or all = -1)");
332
333 static void log_irqs(u32 evt)
334 {
335         if (likely(!(param_debug &
336                         (OHCI_PARAM_DEBUG_IRQS | OHCI_PARAM_DEBUG_BUSRESETS))))
337                 return;
338
339         if (!(param_debug & OHCI_PARAM_DEBUG_IRQS) &&
340             !(evt & OHCI1394_busReset))
341                 return;
342
343         fw_notify("IRQ %08x%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n", evt,
344             evt & OHCI1394_selfIDComplete       ? " selfID"             : "",
345             evt & OHCI1394_RQPkt                ? " AR_req"             : "",
346             evt & OHCI1394_RSPkt                ? " AR_resp"            : "",
347             evt & OHCI1394_reqTxComplete        ? " AT_req"             : "",
348             evt & OHCI1394_respTxComplete       ? " AT_resp"            : "",
349             evt & OHCI1394_isochRx              ? " IR"                 : "",
350             evt & OHCI1394_isochTx              ? " IT"                 : "",
351             evt & OHCI1394_postedWriteErr       ? " postedWriteErr"     : "",
352             evt & OHCI1394_cycleTooLong         ? " cycleTooLong"       : "",
353             evt & OHCI1394_cycle64Seconds       ? " cycle64Seconds"     : "",
354             evt & OHCI1394_cycleInconsistent    ? " cycleInconsistent"  : "",
355             evt & OHCI1394_regAccessFail        ? " regAccessFail"      : "",
356             evt & OHCI1394_unrecoverableError   ? " unrecoverableError" : "",
357             evt & OHCI1394_busReset             ? " busReset"           : "",
358             evt & ~(OHCI1394_selfIDComplete | OHCI1394_RQPkt |
359                     OHCI1394_RSPkt | OHCI1394_reqTxComplete |
360                     OHCI1394_respTxComplete | OHCI1394_isochRx |
361                     OHCI1394_isochTx | OHCI1394_postedWriteErr |
362                     OHCI1394_cycleTooLong | OHCI1394_cycle64Seconds |
363                     OHCI1394_cycleInconsistent |
364                     OHCI1394_regAccessFail | OHCI1394_busReset)
365                                                 ? " ?"                  : "");
366 }
367
368 static const char *speed[] = {
369         [0] = "S100", [1] = "S200", [2] = "S400",    [3] = "beta",
370 };
371 static const char *power[] = {
372         [0] = "+0W",  [1] = "+15W", [2] = "+30W",    [3] = "+45W",
373         [4] = "-3W",  [5] = " ?W",  [6] = "-3..-6W", [7] = "-3..-10W",
374 };
375 static const char port[] = { '.', '-', 'p', 'c', };
376
377 static char _p(u32 *s, int shift)
378 {
379         return port[*s >> shift & 3];
380 }
381
382 static void log_selfids(int node_id, int generation, int self_id_count, u32 *s)
383 {
384         if (likely(!(param_debug & OHCI_PARAM_DEBUG_SELFIDS)))
385                 return;
386
387         fw_notify("%d selfIDs, generation %d, local node ID %04x\n",
388                   self_id_count, generation, node_id);
389
390         for (; self_id_count--; ++s)
391                 if ((*s & 1 << 23) == 0)
392                         fw_notify("selfID 0: %08x, phy %d [%c%c%c] "
393                             "%s gc=%d %s %s%s%s\n",
394                             *s, *s >> 24 & 63, _p(s, 6), _p(s, 4), _p(s, 2),
395                             speed[*s >> 14 & 3], *s >> 16 & 63,
396                             power[*s >> 8 & 7], *s >> 22 & 1 ? "L" : "",
397                             *s >> 11 & 1 ? "c" : "", *s & 2 ? "i" : "");
398                 else
399                         fw_notify("selfID n: %08x, phy %d [%c%c%c%c%c%c%c%c]\n",
400                             *s, *s >> 24 & 63,
401                             _p(s, 16), _p(s, 14), _p(s, 12), _p(s, 10),
402                             _p(s,  8), _p(s,  6), _p(s,  4), _p(s,  2));
403 }
404
405 static const char *evts[] = {
406         [0x00] = "evt_no_status",       [0x01] = "-reserved-",
407         [0x02] = "evt_long_packet",     [0x03] = "evt_missing_ack",
408         [0x04] = "evt_underrun",        [0x05] = "evt_overrun",
409         [0x06] = "evt_descriptor_read", [0x07] = "evt_data_read",
410         [0x08] = "evt_data_write",      [0x09] = "evt_bus_reset",
411         [0x0a] = "evt_timeout",         [0x0b] = "evt_tcode_err",
412         [0x0c] = "-reserved-",          [0x0d] = "-reserved-",
413         [0x0e] = "evt_unknown",         [0x0f] = "evt_flushed",
414         [0x10] = "-reserved-",          [0x11] = "ack_complete",
415         [0x12] = "ack_pending ",        [0x13] = "-reserved-",
416         [0x14] = "ack_busy_X",          [0x15] = "ack_busy_A",
417         [0x16] = "ack_busy_B",          [0x17] = "-reserved-",
418         [0x18] = "-reserved-",          [0x19] = "-reserved-",
419         [0x1a] = "-reserved-",          [0x1b] = "ack_tardy",
420         [0x1c] = "-reserved-",          [0x1d] = "ack_data_error",
421         [0x1e] = "ack_type_error",      [0x1f] = "-reserved-",
422         [0x20] = "pending/cancelled",
423 };
424 static const char *tcodes[] = {
425         [0x0] = "QW req",               [0x1] = "BW req",
426         [0x2] = "W resp",               [0x3] = "-reserved-",
427         [0x4] = "QR req",               [0x5] = "BR req",
428         [0x6] = "QR resp",              [0x7] = "BR resp",
429         [0x8] = "cycle start",          [0x9] = "Lk req",
430         [0xa] = "async stream packet",  [0xb] = "Lk resp",
431         [0xc] = "-reserved-",           [0xd] = "-reserved-",
432         [0xe] = "link internal",        [0xf] = "-reserved-",
433 };
434
435 static void log_ar_at_event(char dir, int speed, u32 *header, int evt)
436 {
437         int tcode = header[0] >> 4 & 0xf;
438         char specific[12];
439
440         if (likely(!(param_debug & OHCI_PARAM_DEBUG_AT_AR)))
441                 return;
442
443         if (unlikely(evt >= ARRAY_SIZE(evts)))
444                         evt = 0x1f;
445
446         if (evt == OHCI1394_evt_bus_reset) {
447                 fw_notify("A%c evt_bus_reset, generation %d\n",
448                     dir, (header[2] >> 16) & 0xff);
449                 return;
450         }
451
452         switch (tcode) {
453         case 0x0: case 0x6: case 0x8:
454                 snprintf(specific, sizeof(specific), " = %08x",
455                          be32_to_cpu((__force __be32)header[3]));
456                 break;
457         case 0x1: case 0x5: case 0x7: case 0x9: case 0xb:
458                 snprintf(specific, sizeof(specific), " %x,%x",
459                          header[3] >> 16, header[3] & 0xffff);
460                 break;
461         default:
462                 specific[0] = '\0';
463         }
464
465         switch (tcode) {
466         case 0xa:
467                 fw_notify("A%c %s, %s\n", dir, evts[evt], tcodes[tcode]);
468                 break;
469         case 0xe:
470                 fw_notify("A%c %s, PHY %08x %08x\n",
471                           dir, evts[evt], header[1], header[2]);
472                 break;
473         case 0x0: case 0x1: case 0x4: case 0x5: case 0x9:
474                 fw_notify("A%c spd %x tl %02x, "
475                     "%04x -> %04x, %s, "
476                     "%s, %04x%08x%s\n",
477                     dir, speed, header[0] >> 10 & 0x3f,
478                     header[1] >> 16, header[0] >> 16, evts[evt],
479                     tcodes[tcode], header[1] & 0xffff, header[2], specific);
480                 break;
481         default:
482                 fw_notify("A%c spd %x tl %02x, "
483                     "%04x -> %04x, %s, "
484                     "%s%s\n",
485                     dir, speed, header[0] >> 10 & 0x3f,
486                     header[1] >> 16, header[0] >> 16, evts[evt],
487                     tcodes[tcode], specific);
488         }
489 }
490
491 #else
492
493 #define param_debug 0
494 static inline void log_irqs(u32 evt) {}
495 static inline void log_selfids(int node_id, int generation, int self_id_count, u32 *s) {}
496 static inline void log_ar_at_event(char dir, int speed, u32 *header, int evt) {}
497
498 #endif /* CONFIG_FIREWIRE_OHCI_DEBUG */
499
500 static inline void reg_write(const struct fw_ohci *ohci, int offset, u32 data)
501 {
502         writel(data, ohci->registers + offset);
503 }
504
505 static inline u32 reg_read(const struct fw_ohci *ohci, int offset)
506 {
507         return readl(ohci->registers + offset);
508 }
509
510 static inline void flush_writes(const struct fw_ohci *ohci)
511 {
512         /* Do a dummy read to flush writes. */
513         reg_read(ohci, OHCI1394_Version);
514 }
515
516 static int read_phy_reg(struct fw_ohci *ohci, int addr)
517 {
518         u32 val;
519         int i;
520
521         reg_write(ohci, OHCI1394_PhyControl, OHCI1394_PhyControl_Read(addr));
522         for (i = 0; i < 3 + 100; i++) {
523                 val = reg_read(ohci, OHCI1394_PhyControl);
524                 if (val & OHCI1394_PhyControl_ReadDone)
525                         return OHCI1394_PhyControl_ReadData(val);
526
527                 /*
528                  * Try a few times without waiting.  Sleeping is necessary
529                  * only when the link/PHY interface is busy.
530                  */
531                 if (i >= 3)
532                         msleep(1);
533         }
534         fw_error("failed to read phy reg\n");
535
536         return -EBUSY;
537 }
538
539 static int write_phy_reg(const struct fw_ohci *ohci, int addr, u32 val)
540 {
541         int i;
542
543         reg_write(ohci, OHCI1394_PhyControl,
544                   OHCI1394_PhyControl_Write(addr, val));
545         for (i = 0; i < 3 + 100; i++) {
546                 val = reg_read(ohci, OHCI1394_PhyControl);
547                 if (!(val & OHCI1394_PhyControl_WritePending))
548                         return 0;
549
550                 if (i >= 3)
551                         msleep(1);
552         }
553         fw_error("failed to write phy reg\n");
554
555         return -EBUSY;
556 }
557
558 static int update_phy_reg(struct fw_ohci *ohci, int addr,
559                           int clear_bits, int set_bits)
560 {
561         int ret = read_phy_reg(ohci, addr);
562         if (ret < 0)
563                 return ret;
564
565         /*
566          * The interrupt status bits are cleared by writing a one bit.
567          * Avoid clearing them unless explicitly requested in set_bits.
568          */
569         if (addr == 5)
570                 clear_bits |= PHY_INT_STATUS_BITS;
571
572         return write_phy_reg(ohci, addr, (ret & ~clear_bits) | set_bits);
573 }
574
575 static int read_paged_phy_reg(struct fw_ohci *ohci, int page, int addr)
576 {
577         int ret;
578
579         ret = update_phy_reg(ohci, 7, PHY_PAGE_SELECT, page << 5);
580         if (ret < 0)
581                 return ret;
582
583         return read_phy_reg(ohci, addr);
584 }
585
586 static int ohci_read_phy_reg(struct fw_card *card, int addr)
587 {
588         struct fw_ohci *ohci = fw_ohci(card);
589         int ret;
590
591         mutex_lock(&ohci->phy_reg_mutex);
592         ret = read_phy_reg(ohci, addr);
593         mutex_unlock(&ohci->phy_reg_mutex);
594
595         return ret;
596 }
597
598 static int ohci_update_phy_reg(struct fw_card *card, int addr,
599                                int clear_bits, int set_bits)
600 {
601         struct fw_ohci *ohci = fw_ohci(card);
602         int ret;
603
604         mutex_lock(&ohci->phy_reg_mutex);
605         ret = update_phy_reg(ohci, addr, clear_bits, set_bits);
606         mutex_unlock(&ohci->phy_reg_mutex);
607
608         return ret;
609 }
610
611 static inline dma_addr_t ar_buffer_bus(struct ar_context *ctx, unsigned int i)
612 {
613         return page_private(ctx->pages[i]);
614 }
615
616 static void ar_context_link_page(struct ar_context *ctx, unsigned int index)
617 {
618         struct descriptor *d;
619
620         d = &ctx->descriptors[index];
621         d->branch_address  &= cpu_to_le32(~0xf);
622         d->res_count       =  cpu_to_le16(PAGE_SIZE);
623         d->transfer_status =  0;
624
625         wmb(); /* finish init of new descriptors before branch_address update */
626         d = &ctx->descriptors[ctx->last_buffer_index];
627         d->branch_address  |= cpu_to_le32(1);
628
629         ctx->last_buffer_index = index;
630
631         reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_WAKE);
632         flush_writes(ctx->ohci);
633 }
634
635 static void ar_context_release(struct ar_context *ctx)
636 {
637         unsigned int i;
638
639         if (ctx->buffer)
640                 vm_unmap_ram(ctx->buffer, AR_BUFFERS + AR_WRAPAROUND_PAGES);
641
642         for (i = 0; i < AR_BUFFERS; i++)
643                 if (ctx->pages[i]) {
644                         dma_unmap_page(ctx->ohci->card.device,
645                                        ar_buffer_bus(ctx, i),
646                                        PAGE_SIZE, DMA_FROM_DEVICE);
647                         __free_page(ctx->pages[i]);
648                 }
649 }
650
651 static void ar_context_abort(struct ar_context *ctx, const char *error_msg)
652 {
653         if (reg_read(ctx->ohci, CONTROL_CLEAR(ctx->regs)) & CONTEXT_RUN) {
654                 reg_write(ctx->ohci, CONTROL_CLEAR(ctx->regs), CONTEXT_RUN);
655                 flush_writes(ctx->ohci);
656
657                 fw_error("AR error: %s; DMA stopped\n", error_msg);
658         }
659         /* FIXME: restart? */
660 }
661
662 static inline unsigned int ar_next_buffer_index(unsigned int index)
663 {
664         return (index + 1) % AR_BUFFERS;
665 }
666
667 static inline unsigned int ar_prev_buffer_index(unsigned int index)
668 {
669         return (index - 1 + AR_BUFFERS) % AR_BUFFERS;
670 }
671
672 static inline unsigned int ar_first_buffer_index(struct ar_context *ctx)
673 {
674         return ar_next_buffer_index(ctx->last_buffer_index);
675 }
676
677 /*
678  * We search for the buffer that contains the last AR packet DMA data written
679  * by the controller.
680  */
681 static unsigned int ar_search_last_active_buffer(struct ar_context *ctx,
682                                                  unsigned int *buffer_offset)
683 {
684         unsigned int i, next_i, last = ctx->last_buffer_index;
685         __le16 res_count, next_res_count;
686
687         i = ar_first_buffer_index(ctx);
688         res_count = ACCESS_ONCE(ctx->descriptors[i].res_count);
689
690         /* A buffer that is not yet completely filled must be the last one. */
691         while (i != last && res_count == 0) {
692
693                 /* Peek at the next descriptor. */
694                 next_i = ar_next_buffer_index(i);
695                 rmb(); /* read descriptors in order */
696                 next_res_count = ACCESS_ONCE(
697                                 ctx->descriptors[next_i].res_count);
698                 /*
699                  * If the next descriptor is still empty, we must stop at this
700                  * descriptor.
701                  */
702                 if (next_res_count == cpu_to_le16(PAGE_SIZE)) {
703                         /*
704                          * The exception is when the DMA data for one packet is
705                          * split over three buffers; in this case, the middle
706                          * buffer's descriptor might be never updated by the
707                          * controller and look still empty, and we have to peek
708                          * at the third one.
709                          */
710                         if (MAX_AR_PACKET_SIZE > PAGE_SIZE && i != last) {
711                                 next_i = ar_next_buffer_index(next_i);
712                                 rmb();
713                                 next_res_count = ACCESS_ONCE(
714                                         ctx->descriptors[next_i].res_count);
715                                 if (next_res_count != cpu_to_le16(PAGE_SIZE))
716                                         goto next_buffer_is_active;
717                         }
718
719                         break;
720                 }
721
722 next_buffer_is_active:
723                 i = next_i;
724                 res_count = next_res_count;
725         }
726
727         rmb(); /* read res_count before the DMA data */
728
729         *buffer_offset = PAGE_SIZE - le16_to_cpu(res_count);
730         if (*buffer_offset > PAGE_SIZE) {
731                 *buffer_offset = 0;
732                 ar_context_abort(ctx, "corrupted descriptor");
733         }
734
735         return i;
736 }
737
738 static void ar_sync_buffers_for_cpu(struct ar_context *ctx,
739                                     unsigned int end_buffer_index,
740                                     unsigned int end_buffer_offset)
741 {
742         unsigned int i;
743
744         i = ar_first_buffer_index(ctx);
745         while (i != end_buffer_index) {
746                 dma_sync_single_for_cpu(ctx->ohci->card.device,
747                                         ar_buffer_bus(ctx, i),
748                                         PAGE_SIZE, DMA_FROM_DEVICE);
749                 i = ar_next_buffer_index(i);
750         }
751         if (end_buffer_offset > 0)
752                 dma_sync_single_for_cpu(ctx->ohci->card.device,
753                                         ar_buffer_bus(ctx, i),
754                                         end_buffer_offset, DMA_FROM_DEVICE);
755 }
756
757 #if defined(CONFIG_PPC_PMAC) && defined(CONFIG_PPC32)
758 #define cond_le32_to_cpu(v) \
759         (ohci->quirks & QUIRK_BE_HEADERS ? (__force __u32)(v) : le32_to_cpu(v))
760 #else
761 #define cond_le32_to_cpu(v) le32_to_cpu(v)
762 #endif
763
764 static __le32 *handle_ar_packet(struct ar_context *ctx, __le32 *buffer)
765 {
766         struct fw_ohci *ohci = ctx->ohci;
767         struct fw_packet p;
768         u32 status, length, tcode;
769         int evt;
770
771         p.header[0] = cond_le32_to_cpu(buffer[0]);
772         p.header[1] = cond_le32_to_cpu(buffer[1]);
773         p.header[2] = cond_le32_to_cpu(buffer[2]);
774
775         tcode = (p.header[0] >> 4) & 0x0f;
776         switch (tcode) {
777         case TCODE_WRITE_QUADLET_REQUEST:
778         case TCODE_READ_QUADLET_RESPONSE:
779                 p.header[3] = (__force __u32) buffer[3];
780                 p.header_length = 16;
781                 p.payload_length = 0;
782                 break;
783
784         case TCODE_READ_BLOCK_REQUEST :
785                 p.header[3] = cond_le32_to_cpu(buffer[3]);
786                 p.header_length = 16;
787                 p.payload_length = 0;
788                 break;
789
790         case TCODE_WRITE_BLOCK_REQUEST:
791         case TCODE_READ_BLOCK_RESPONSE:
792         case TCODE_LOCK_REQUEST:
793         case TCODE_LOCK_RESPONSE:
794                 p.header[3] = cond_le32_to_cpu(buffer[3]);
795                 p.header_length = 16;
796                 p.payload_length = p.header[3] >> 16;
797                 if (p.payload_length > MAX_ASYNC_PAYLOAD) {
798                         ar_context_abort(ctx, "invalid packet length");
799                         return NULL;
800                 }
801                 break;
802
803         case TCODE_WRITE_RESPONSE:
804         case TCODE_READ_QUADLET_REQUEST:
805         case OHCI_TCODE_PHY_PACKET:
806                 p.header_length = 12;
807                 p.payload_length = 0;
808                 break;
809
810         default:
811                 ar_context_abort(ctx, "invalid tcode");
812                 return NULL;
813         }
814
815         p.payload = (void *) buffer + p.header_length;
816
817         /* FIXME: What to do about evt_* errors? */
818         length = (p.header_length + p.payload_length + 3) / 4;
819         status = cond_le32_to_cpu(buffer[length]);
820         evt    = (status >> 16) & 0x1f;
821
822         p.ack        = evt - 16;
823         p.speed      = (status >> 21) & 0x7;
824         p.timestamp  = status & 0xffff;
825         p.generation = ohci->request_generation;
826
827         log_ar_at_event('R', p.speed, p.header, evt);
828
829         /*
830          * Several controllers, notably from NEC and VIA, forget to
831          * write ack_complete status at PHY packet reception.
832          */
833         if (evt == OHCI1394_evt_no_status &&
834             (p.header[0] & 0xff) == (OHCI1394_phy_tcode << 4))
835                 p.ack = ACK_COMPLETE;
836
837         /*
838          * The OHCI bus reset handler synthesizes a PHY packet with
839          * the new generation number when a bus reset happens (see
840          * section 8.4.2.3).  This helps us determine when a request
841          * was received and make sure we send the response in the same
842          * generation.  We only need this for requests; for responses
843          * we use the unique tlabel for finding the matching
844          * request.
845          *
846          * Alas some chips sometimes emit bus reset packets with a
847          * wrong generation.  We set the correct generation for these
848          * at a slightly incorrect time (in bus_reset_tasklet).
849          */
850         if (evt == OHCI1394_evt_bus_reset) {
851                 if (!(ohci->quirks & QUIRK_RESET_PACKET))
852                         ohci->request_generation = (p.header[2] >> 16) & 0xff;
853         } else if (ctx == &ohci->ar_request_ctx) {
854                 fw_core_handle_request(&ohci->card, &p);
855         } else {
856                 fw_core_handle_response(&ohci->card, &p);
857         }
858
859         return buffer + length + 1;
860 }
861
862 static void *handle_ar_packets(struct ar_context *ctx, void *p, void *end)
863 {
864         void *next;
865
866         while (p < end) {
867                 next = handle_ar_packet(ctx, p);
868                 if (!next)
869                         return p;
870                 p = next;
871         }
872
873         return p;
874 }
875
876 static void ar_recycle_buffers(struct ar_context *ctx, unsigned int end_buffer)
877 {
878         unsigned int i;
879
880         i = ar_first_buffer_index(ctx);
881         while (i != end_buffer) {
882                 dma_sync_single_for_device(ctx->ohci->card.device,
883                                            ar_buffer_bus(ctx, i),
884                                            PAGE_SIZE, DMA_FROM_DEVICE);
885                 ar_context_link_page(ctx, i);
886                 i = ar_next_buffer_index(i);
887         }
888 }
889
890 static void ar_context_tasklet(unsigned long data)
891 {
892         struct ar_context *ctx = (struct ar_context *)data;
893         unsigned int end_buffer_index, end_buffer_offset;
894         void *p, *end;
895
896         p = ctx->pointer;
897         if (!p)
898                 return;
899
900         end_buffer_index = ar_search_last_active_buffer(ctx,
901                                                         &end_buffer_offset);
902         ar_sync_buffers_for_cpu(ctx, end_buffer_index, end_buffer_offset);
903         end = ctx->buffer + end_buffer_index * PAGE_SIZE + end_buffer_offset;
904
905         if (end_buffer_index < ar_first_buffer_index(ctx)) {
906                 /*
907                  * The filled part of the overall buffer wraps around; handle
908                  * all packets up to the buffer end here.  If the last packet
909                  * wraps around, its tail will be visible after the buffer end
910                  * because the buffer start pages are mapped there again.
911                  */
912                 void *buffer_end = ctx->buffer + AR_BUFFERS * PAGE_SIZE;
913                 p = handle_ar_packets(ctx, p, buffer_end);
914                 if (p < buffer_end)
915                         goto error;
916                 /* adjust p to point back into the actual buffer */
917                 p -= AR_BUFFERS * PAGE_SIZE;
918         }
919
920         p = handle_ar_packets(ctx, p, end);
921         if (p != end) {
922                 if (p > end)
923                         ar_context_abort(ctx, "inconsistent descriptor");
924                 goto error;
925         }
926
927         ctx->pointer = p;
928         ar_recycle_buffers(ctx, end_buffer_index);
929
930         return;
931
932 error:
933         ctx->pointer = NULL;
934 }
935
936 static int ar_context_init(struct ar_context *ctx, struct fw_ohci *ohci,
937                            unsigned int descriptors_offset, u32 regs)
938 {
939         unsigned int i;
940         dma_addr_t dma_addr;
941         struct page *pages[AR_BUFFERS + AR_WRAPAROUND_PAGES];
942         struct descriptor *d;
943
944         ctx->regs        = regs;
945         ctx->ohci        = ohci;
946         tasklet_init(&ctx->tasklet, ar_context_tasklet, (unsigned long)ctx);
947
948         for (i = 0; i < AR_BUFFERS; i++) {
949                 ctx->pages[i] = alloc_page(GFP_KERNEL | GFP_DMA32);
950                 if (!ctx->pages[i])
951                         goto out_of_memory;
952                 dma_addr = dma_map_page(ohci->card.device, ctx->pages[i],
953                                         0, PAGE_SIZE, DMA_FROM_DEVICE);
954                 if (dma_mapping_error(ohci->card.device, dma_addr)) {
955                         __free_page(ctx->pages[i]);
956                         ctx->pages[i] = NULL;
957                         goto out_of_memory;
958                 }
959                 set_page_private(ctx->pages[i], dma_addr);
960         }
961
962         for (i = 0; i < AR_BUFFERS; i++)
963                 pages[i]              = ctx->pages[i];
964         for (i = 0; i < AR_WRAPAROUND_PAGES; i++)
965                 pages[AR_BUFFERS + i] = ctx->pages[i];
966         ctx->buffer = vm_map_ram(pages, AR_BUFFERS + AR_WRAPAROUND_PAGES,
967                                  -1, PAGE_KERNEL);
968         if (!ctx->buffer)
969                 goto out_of_memory;
970
971         ctx->descriptors     = ohci->misc_buffer     + descriptors_offset;
972         ctx->descriptors_bus = ohci->misc_buffer_bus + descriptors_offset;
973
974         for (i = 0; i < AR_BUFFERS; i++) {
975                 d = &ctx->descriptors[i];
976                 d->req_count      = cpu_to_le16(PAGE_SIZE);
977                 d->control        = cpu_to_le16(DESCRIPTOR_INPUT_MORE |
978                                                 DESCRIPTOR_STATUS |
979                                                 DESCRIPTOR_BRANCH_ALWAYS);
980                 d->data_address   = cpu_to_le32(ar_buffer_bus(ctx, i));
981                 d->branch_address = cpu_to_le32(ctx->descriptors_bus +
982                         ar_next_buffer_index(i) * sizeof(struct descriptor));
983         }
984
985         return 0;
986
987 out_of_memory:
988         ar_context_release(ctx);
989
990         return -ENOMEM;
991 }
992
993 static void ar_context_run(struct ar_context *ctx)
994 {
995         unsigned int i;
996
997         for (i = 0; i < AR_BUFFERS; i++)
998                 ar_context_link_page(ctx, i);
999
1000         ctx->pointer = ctx->buffer;
1001
1002         reg_write(ctx->ohci, COMMAND_PTR(ctx->regs), ctx->descriptors_bus | 1);
1003         reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_RUN);
1004         flush_writes(ctx->ohci);
1005 }
1006
1007 static struct descriptor *find_branch_descriptor(struct descriptor *d, int z)
1008 {
1009         int b, key;
1010
1011         b   = (le16_to_cpu(d->control) & DESCRIPTOR_BRANCH_ALWAYS) >> 2;
1012         key = (le16_to_cpu(d->control) & DESCRIPTOR_KEY_IMMEDIATE) >> 8;
1013
1014         /* figure out which descriptor the branch address goes in */
1015         if (z == 2 && (b == 3 || key == 2))
1016                 return d;
1017         else
1018                 return d + z - 1;
1019 }
1020
1021 static void context_tasklet(unsigned long data)
1022 {
1023         struct context *ctx = (struct context *) data;
1024         struct descriptor *d, *last;
1025         u32 address;
1026         int z;
1027         struct descriptor_buffer *desc;
1028
1029         desc = list_entry(ctx->buffer_list.next,
1030                         struct descriptor_buffer, list);
1031         last = ctx->last;
1032         while (last->branch_address != 0) {
1033                 struct descriptor_buffer *old_desc = desc;
1034                 address = le32_to_cpu(last->branch_address);
1035                 z = address & 0xf;
1036                 address &= ~0xf;
1037
1038                 /* If the branch address points to a buffer outside of the
1039                  * current buffer, advance to the next buffer. */
1040                 if (address < desc->buffer_bus ||
1041                                 address >= desc->buffer_bus + desc->used)
1042                         desc = list_entry(desc->list.next,
1043                                         struct descriptor_buffer, list);
1044                 d = desc->buffer + (address - desc->buffer_bus) / sizeof(*d);
1045                 last = find_branch_descriptor(d, z);
1046
1047                 if (!ctx->callback(ctx, d, last))
1048                         break;
1049
1050                 if (old_desc != desc) {
1051                         /* If we've advanced to the next buffer, move the
1052                          * previous buffer to the free list. */
1053                         unsigned long flags;
1054                         old_desc->used = 0;
1055                         spin_lock_irqsave(&ctx->ohci->lock, flags);
1056                         list_move_tail(&old_desc->list, &ctx->buffer_list);
1057                         spin_unlock_irqrestore(&ctx->ohci->lock, flags);
1058                 }
1059                 ctx->last = last;
1060         }
1061 }
1062
1063 /*
1064  * Allocate a new buffer and add it to the list of free buffers for this
1065  * context.  Must be called with ohci->lock held.
1066  */
1067 static int context_add_buffer(struct context *ctx)
1068 {
1069         struct descriptor_buffer *desc;
1070         dma_addr_t uninitialized_var(bus_addr);
1071         int offset;
1072
1073         /*
1074          * 16MB of descriptors should be far more than enough for any DMA
1075          * program.  This will catch run-away userspace or DoS attacks.
1076          */
1077         if (ctx->total_allocation >= 16*1024*1024)
1078                 return -ENOMEM;
1079
1080         desc = dma_alloc_coherent(ctx->ohci->card.device, PAGE_SIZE,
1081                         &bus_addr, GFP_ATOMIC);
1082         if (!desc)
1083                 return -ENOMEM;
1084
1085         offset = (void *)&desc->buffer - (void *)desc;
1086         desc->buffer_size = PAGE_SIZE - offset;
1087         desc->buffer_bus = bus_addr + offset;
1088         desc->used = 0;
1089
1090         list_add_tail(&desc->list, &ctx->buffer_list);
1091         ctx->total_allocation += PAGE_SIZE;
1092
1093         return 0;
1094 }
1095
1096 static int context_init(struct context *ctx, struct fw_ohci *ohci,
1097                         u32 regs, descriptor_callback_t callback)
1098 {
1099         ctx->ohci = ohci;
1100         ctx->regs = regs;
1101         ctx->total_allocation = 0;
1102
1103         INIT_LIST_HEAD(&ctx->buffer_list);
1104         if (context_add_buffer(ctx) < 0)
1105                 return -ENOMEM;
1106
1107         ctx->buffer_tail = list_entry(ctx->buffer_list.next,
1108                         struct descriptor_buffer, list);
1109
1110         tasklet_init(&ctx->tasklet, context_tasklet, (unsigned long)ctx);
1111         ctx->callback = callback;
1112
1113         /*
1114          * We put a dummy descriptor in the buffer that has a NULL
1115          * branch address and looks like it's been sent.  That way we
1116          * have a descriptor to append DMA programs to.
1117          */
1118         memset(ctx->buffer_tail->buffer, 0, sizeof(*ctx->buffer_tail->buffer));
1119         ctx->buffer_tail->buffer->control = cpu_to_le16(DESCRIPTOR_OUTPUT_LAST);
1120         ctx->buffer_tail->buffer->transfer_status = cpu_to_le16(0x8011);
1121         ctx->buffer_tail->used += sizeof(*ctx->buffer_tail->buffer);
1122         ctx->last = ctx->buffer_tail->buffer;
1123         ctx->prev = ctx->buffer_tail->buffer;
1124
1125         return 0;
1126 }
1127
1128 static void context_release(struct context *ctx)
1129 {
1130         struct fw_card *card = &ctx->ohci->card;
1131         struct descriptor_buffer *desc, *tmp;
1132
1133         list_for_each_entry_safe(desc, tmp, &ctx->buffer_list, list)
1134                 dma_free_coherent(card->device, PAGE_SIZE, desc,
1135                         desc->buffer_bus -
1136                         ((void *)&desc->buffer - (void *)desc));
1137 }
1138
1139 /* Must be called with ohci->lock held */
1140 static struct descriptor *context_get_descriptors(struct context *ctx,
1141                                                   int z, dma_addr_t *d_bus)
1142 {
1143         struct descriptor *d = NULL;
1144         struct descriptor_buffer *desc = ctx->buffer_tail;
1145
1146         if (z * sizeof(*d) > desc->buffer_size)
1147                 return NULL;
1148
1149         if (z * sizeof(*d) > desc->buffer_size - desc->used) {
1150                 /* No room for the descriptor in this buffer, so advance to the
1151                  * next one. */
1152
1153                 if (desc->list.next == &ctx->buffer_list) {
1154                         /* If there is no free buffer next in the list,
1155                          * allocate one. */
1156                         if (context_add_buffer(ctx) < 0)
1157                                 return NULL;
1158                 }
1159                 desc = list_entry(desc->list.next,
1160                                 struct descriptor_buffer, list);
1161                 ctx->buffer_tail = desc;
1162         }
1163
1164         d = desc->buffer + desc->used / sizeof(*d);
1165         memset(d, 0, z * sizeof(*d));
1166         *d_bus = desc->buffer_bus + desc->used;
1167
1168         return d;
1169 }
1170
1171 static void context_run(struct context *ctx, u32 extra)
1172 {
1173         struct fw_ohci *ohci = ctx->ohci;
1174
1175         reg_write(ohci, COMMAND_PTR(ctx->regs),
1176                   le32_to_cpu(ctx->last->branch_address));
1177         reg_write(ohci, CONTROL_CLEAR(ctx->regs), ~0);
1178         reg_write(ohci, CONTROL_SET(ctx->regs), CONTEXT_RUN | extra);
1179         ctx->running = true;
1180         flush_writes(ohci);
1181 }
1182
1183 static void context_append(struct context *ctx,
1184                            struct descriptor *d, int z, int extra)
1185 {
1186         dma_addr_t d_bus;
1187         struct descriptor_buffer *desc = ctx->buffer_tail;
1188
1189         d_bus = desc->buffer_bus + (d - desc->buffer) * sizeof(*d);
1190
1191         desc->used += (z + extra) * sizeof(*d);
1192
1193         wmb(); /* finish init of new descriptors before branch_address update */
1194         ctx->prev->branch_address = cpu_to_le32(d_bus | z);
1195         ctx->prev = find_branch_descriptor(d, z);
1196
1197         reg_write(ctx->ohci, CONTROL_SET(ctx->regs), CONTEXT_WAKE);
1198         flush_writes(ctx->ohci);
1199 }
1200
1201 static void context_stop(struct context *ctx)
1202 {
1203         u32 reg;
1204         int i;
1205
1206         reg_write(ctx->ohci, CONTROL_CLEAR(ctx->regs), CONTEXT_RUN);
1207         ctx->running = false;
1208         flush_writes(ctx->ohci);
1209
1210         for (i = 0; i < 10; i++) {
1211                 reg = reg_read(ctx->ohci, CONTROL_SET(ctx->regs));
1212                 if ((reg & CONTEXT_ACTIVE) == 0)
1213                         return;
1214
1215                 mdelay(1);
1216         }
1217         fw_error("Error: DMA context still active (0x%08x)\n", reg);
1218 }
1219
1220 struct driver_data {
1221         struct fw_packet *packet;
1222 };
1223
1224 /*
1225  * This function apppends a packet to the DMA queue for transmission.
1226  * Must always be called with the ochi->lock held to ensure proper
1227  * generation handling and locking around packet queue manipulation.
1228  */
1229 static int at_context_queue_packet(struct context *ctx,
1230                                    struct fw_packet *packet)
1231 {
1232         struct fw_ohci *ohci = ctx->ohci;
1233         dma_addr_t d_bus, uninitialized_var(payload_bus);
1234         struct driver_data *driver_data;
1235         struct descriptor *d, *last;
1236         __le32 *header;
1237         int z, tcode;
1238
1239         d = context_get_descriptors(ctx, 4, &d_bus);
1240         if (d == NULL) {
1241                 packet->ack = RCODE_SEND_ERROR;
1242                 return -1;
1243         }
1244
1245         d[0].control   = cpu_to_le16(DESCRIPTOR_KEY_IMMEDIATE);
1246         d[0].res_count = cpu_to_le16(packet->timestamp);
1247
1248         /*
1249          * The DMA format for asyncronous link packets is different
1250          * from the IEEE1394 layout, so shift the fields around
1251          * accordingly.
1252          */
1253
1254         tcode = (packet->header[0] >> 4) & 0x0f;
1255         header = (__le32 *) &d[1];
1256         switch (tcode) {
1257         case TCODE_WRITE_QUADLET_REQUEST:
1258         case TCODE_WRITE_BLOCK_REQUEST:
1259         case TCODE_WRITE_RESPONSE:
1260         case TCODE_READ_QUADLET_REQUEST:
1261         case TCODE_READ_BLOCK_REQUEST:
1262         case TCODE_READ_QUADLET_RESPONSE:
1263         case TCODE_READ_BLOCK_RESPONSE:
1264         case TCODE_LOCK_REQUEST:
1265         case TCODE_LOCK_RESPONSE:
1266                 header[0] = cpu_to_le32((packet->header[0] & 0xffff) |
1267                                         (packet->speed << 16));
1268                 header[1] = cpu_to_le32((packet->header[1] & 0xffff) |
1269                                         (packet->header[0] & 0xffff0000));
1270                 header[2] = cpu_to_le32(packet->header[2]);
1271
1272                 if (TCODE_IS_BLOCK_PACKET(tcode))
1273                         header[3] = cpu_to_le32(packet->header[3]);
1274                 else
1275                         header[3] = (__force __le32) packet->header[3];
1276
1277                 d[0].req_count = cpu_to_le16(packet->header_length);
1278                 break;
1279
1280         case TCODE_LINK_INTERNAL:
1281                 header[0] = cpu_to_le32((OHCI1394_phy_tcode << 4) |
1282                                         (packet->speed << 16));
1283                 header[1] = cpu_to_le32(packet->header[1]);
1284                 header[2] = cpu_to_le32(packet->header[2]);
1285                 d[0].req_count = cpu_to_le16(12);
1286
1287                 if (is_ping_packet(&packet->header[1]))
1288                         d[0].control |= cpu_to_le16(DESCRIPTOR_PING);
1289                 break;
1290
1291         case TCODE_STREAM_DATA:
1292                 header[0] = cpu_to_le32((packet->header[0] & 0xffff) |
1293                                         (packet->speed << 16));
1294                 header[1] = cpu_to_le32(packet->header[0] & 0xffff0000);
1295                 d[0].req_count = cpu_to_le16(8);
1296                 break;
1297
1298         default:
1299                 /* BUG(); */
1300                 packet->ack = RCODE_SEND_ERROR;
1301                 return -1;
1302         }
1303
1304         driver_data = (struct driver_data *) &d[3];
1305         driver_data->packet = packet;
1306         packet->driver_data = driver_data;
1307
1308         if (packet->payload_length > 0) {
1309                 payload_bus =
1310                         dma_map_single(ohci->card.device, packet->payload,
1311                                        packet->payload_length, DMA_TO_DEVICE);
1312                 if (dma_mapping_error(ohci->card.device, payload_bus)) {
1313                         packet->ack = RCODE_SEND_ERROR;
1314                         return -1;
1315                 }
1316                 packet->payload_bus     = payload_bus;
1317                 packet->payload_mapped  = true;
1318
1319                 d[2].req_count    = cpu_to_le16(packet->payload_length);
1320                 d[2].data_address = cpu_to_le32(payload_bus);
1321                 last = &d[2];
1322                 z = 3;
1323         } else {
1324                 last = &d[0];
1325                 z = 2;
1326         }
1327
1328         last->control |= cpu_to_le16(DESCRIPTOR_OUTPUT_LAST |
1329                                      DESCRIPTOR_IRQ_ALWAYS |
1330                                      DESCRIPTOR_BRANCH_ALWAYS);
1331
1332         /*
1333          * If the controller and packet generations don't match, we need to
1334          * bail out and try again.  If IntEvent.busReset is set, the AT context
1335          * is halted, so appending to the context and trying to run it is
1336          * futile.  Most controllers do the right thing and just flush the AT
1337          * queue (per section 7.2.3.2 of the OHCI 1.1 specification), but
1338          * some controllers (like a JMicron JMB381 PCI-e) misbehave and wind
1339          * up stalling out.  So we just bail out in software and try again
1340          * later, and everyone is happy.
1341          * FIXME: Test of IntEvent.busReset may no longer be necessary since we
1342          *        flush AT queues in bus_reset_tasklet.
1343          * FIXME: Document how the locking works.
1344          */
1345         if (ohci->generation != packet->generation ||
1346             reg_read(ohci, OHCI1394_IntEventSet) & OHCI1394_busReset) {
1347                 if (packet->payload_mapped)
1348                         dma_unmap_single(ohci->card.device, payload_bus,
1349                                          packet->payload_length, DMA_TO_DEVICE);
1350                 packet->ack = RCODE_GENERATION;
1351                 return -1;
1352         }
1353
1354         context_append(ctx, d, z, 4 - z);
1355
1356         if (!ctx->running)
1357                 context_run(ctx, 0);
1358
1359         return 0;
1360 }
1361
1362 static void at_context_flush(struct context *ctx)
1363 {
1364         tasklet_disable(&ctx->tasklet);
1365
1366         ctx->flushing = true;
1367         context_tasklet((unsigned long)ctx);
1368         ctx->flushing = false;
1369
1370         tasklet_enable(&ctx->tasklet);
1371 }
1372
1373 static int handle_at_packet(struct context *context,
1374                             struct descriptor *d,
1375                             struct descriptor *last)
1376 {
1377         struct driver_data *driver_data;
1378         struct fw_packet *packet;
1379         struct fw_ohci *ohci = context->ohci;
1380         int evt;
1381
1382         if (last->transfer_status == 0 && !context->flushing)
1383                 /* This descriptor isn't done yet, stop iteration. */
1384                 return 0;
1385
1386         driver_data = (struct driver_data *) &d[3];
1387         packet = driver_data->packet;
1388         if (packet == NULL)
1389                 /* This packet was cancelled, just continue. */
1390                 return 1;
1391
1392         if (packet->payload_mapped)
1393                 dma_unmap_single(ohci->card.device, packet->payload_bus,
1394                                  packet->payload_length, DMA_TO_DEVICE);
1395
1396         evt = le16_to_cpu(last->transfer_status) & 0x1f;
1397         packet->timestamp = le16_to_cpu(last->res_count);
1398
1399         log_ar_at_event('T', packet->speed, packet->header, evt);
1400
1401         switch (evt) {
1402         case OHCI1394_evt_timeout:
1403                 /* Async response transmit timed out. */
1404                 packet->ack = RCODE_CANCELLED;
1405                 break;
1406
1407         case OHCI1394_evt_flushed:
1408                 /*
1409                  * The packet was flushed should give same error as
1410                  * when we try to use a stale generation count.
1411                  */
1412                 packet->ack = RCODE_GENERATION;
1413                 break;
1414
1415         case OHCI1394_evt_missing_ack:
1416                 if (context->flushing)
1417                         packet->ack = RCODE_GENERATION;
1418                 else {
1419                         /*
1420                          * Using a valid (current) generation count, but the
1421                          * node is not on the bus or not sending acks.
1422                          */
1423                         packet->ack = RCODE_NO_ACK;
1424                 }
1425                 break;
1426
1427         case ACK_COMPLETE + 0x10:
1428         case ACK_PENDING + 0x10:
1429         case ACK_BUSY_X + 0x10:
1430         case ACK_BUSY_A + 0x10:
1431         case ACK_BUSY_B + 0x10:
1432         case ACK_DATA_ERROR + 0x10:
1433         case ACK_TYPE_ERROR + 0x10:
1434                 packet->ack = evt - 0x10;
1435                 break;
1436
1437         case OHCI1394_evt_no_status:
1438                 if (context->flushing) {
1439                         packet->ack = RCODE_GENERATION;
1440                         break;
1441                 }
1442                 /* fall through */
1443
1444         default:
1445                 packet->ack = RCODE_SEND_ERROR;
1446                 break;
1447         }
1448
1449         packet->callback(packet, &ohci->card, packet->ack);
1450
1451         return 1;
1452 }
1453
1454 #define HEADER_GET_DESTINATION(q)       (((q) >> 16) & 0xffff)
1455 #define HEADER_GET_TCODE(q)             (((q) >> 4) & 0x0f)
1456 #define HEADER_GET_OFFSET_HIGH(q)       (((q) >> 0) & 0xffff)
1457 #define HEADER_GET_DATA_LENGTH(q)       (((q) >> 16) & 0xffff)
1458 #define HEADER_GET_EXTENDED_TCODE(q)    (((q) >> 0) & 0xffff)
1459
1460 static void handle_local_rom(struct fw_ohci *ohci,
1461                              struct fw_packet *packet, u32 csr)
1462 {
1463         struct fw_packet response;
1464         int tcode, length, i;
1465
1466         tcode = HEADER_GET_TCODE(packet->header[0]);
1467         if (TCODE_IS_BLOCK_PACKET(tcode))
1468                 length = HEADER_GET_DATA_LENGTH(packet->header[3]);
1469         else
1470                 length = 4;
1471
1472         i = csr - CSR_CONFIG_ROM;
1473         if (i + length > CONFIG_ROM_SIZE) {
1474                 fw_fill_response(&response, packet->header,
1475                                  RCODE_ADDRESS_ERROR, NULL, 0);
1476         } else if (!TCODE_IS_READ_REQUEST(tcode)) {
1477                 fw_fill_response(&response, packet->header,
1478                                  RCODE_TYPE_ERROR, NULL, 0);
1479         } else {
1480                 fw_fill_response(&response, packet->header, RCODE_COMPLETE,
1481                                  (void *) ohci->config_rom + i, length);
1482         }
1483
1484         fw_core_handle_response(&ohci->card, &response);
1485 }
1486
1487 static void handle_local_lock(struct fw_ohci *ohci,
1488                               struct fw_packet *packet, u32 csr)
1489 {
1490         struct fw_packet response;
1491         int tcode, length, ext_tcode, sel, try;
1492         __be32 *payload, lock_old;
1493         u32 lock_arg, lock_data;
1494
1495         tcode = HEADER_GET_TCODE(packet->header[0]);
1496         length = HEADER_GET_DATA_LENGTH(packet->header[3]);
1497         payload = packet->payload;
1498         ext_tcode = HEADER_GET_EXTENDED_TCODE(packet->header[3]);
1499
1500         if (tcode == TCODE_LOCK_REQUEST &&
1501             ext_tcode == EXTCODE_COMPARE_SWAP && length == 8) {
1502                 lock_arg = be32_to_cpu(payload[0]);
1503                 lock_data = be32_to_cpu(payload[1]);
1504         } else if (tcode == TCODE_READ_QUADLET_REQUEST) {
1505                 lock_arg = 0;
1506                 lock_data = 0;
1507         } else {
1508                 fw_fill_response(&response, packet->header,
1509                                  RCODE_TYPE_ERROR, NULL, 0);
1510                 goto out;
1511         }
1512
1513         sel = (csr - CSR_BUS_MANAGER_ID) / 4;
1514         reg_write(ohci, OHCI1394_CSRData, lock_data);
1515         reg_write(ohci, OHCI1394_CSRCompareData, lock_arg);
1516         reg_write(ohci, OHCI1394_CSRControl, sel);
1517
1518         for (try = 0; try < 20; try++)
1519                 if (reg_read(ohci, OHCI1394_CSRControl) & 0x80000000) {
1520                         lock_old = cpu_to_be32(reg_read(ohci,
1521                                                         OHCI1394_CSRData));
1522                         fw_fill_response(&response, packet->header,
1523                                          RCODE_COMPLETE,
1524                                          &lock_old, sizeof(lock_old));
1525                         goto out;
1526                 }
1527
1528         fw_error("swap not done (CSR lock timeout)\n");
1529         fw_fill_response(&response, packet->header, RCODE_BUSY, NULL, 0);
1530
1531  out:
1532         fw_core_handle_response(&ohci->card, &response);
1533 }
1534
1535 static void handle_local_request(struct context *ctx, struct fw_packet *packet)
1536 {
1537         u64 offset, csr;
1538
1539         if (ctx == &ctx->ohci->at_request_ctx) {
1540                 packet->ack = ACK_PENDING;
1541                 packet->callback(packet, &ctx->ohci->card, packet->ack);
1542         }
1543
1544         offset =
1545                 ((unsigned long long)
1546                  HEADER_GET_OFFSET_HIGH(packet->header[1]) << 32) |
1547                 packet->header[2];
1548         csr = offset - CSR_REGISTER_BASE;
1549
1550         /* Handle config rom reads. */
1551         if (csr >= CSR_CONFIG_ROM && csr < CSR_CONFIG_ROM_END)
1552                 handle_local_rom(ctx->ohci, packet, csr);
1553         else switch (csr) {
1554         case CSR_BUS_MANAGER_ID:
1555         case CSR_BANDWIDTH_AVAILABLE:
1556         case CSR_CHANNELS_AVAILABLE_HI:
1557         case CSR_CHANNELS_AVAILABLE_LO:
1558                 handle_local_lock(ctx->ohci, packet, csr);
1559                 break;
1560         default:
1561                 if (ctx == &ctx->ohci->at_request_ctx)
1562                         fw_core_handle_request(&ctx->ohci->card, packet);
1563                 else
1564                         fw_core_handle_response(&ctx->ohci->card, packet);
1565                 break;
1566         }
1567
1568         if (ctx == &ctx->ohci->at_response_ctx) {
1569                 packet->ack = ACK_COMPLETE;
1570                 packet->callback(packet, &ctx->ohci->card, packet->ack);
1571         }
1572 }
1573
1574 static void at_context_transmit(struct context *ctx, struct fw_packet *packet)
1575 {
1576         unsigned long flags;
1577         int ret;
1578
1579         spin_lock_irqsave(&ctx->ohci->lock, flags);
1580
1581         if (HEADER_GET_DESTINATION(packet->header[0]) == ctx->ohci->node_id &&
1582             ctx->ohci->generation == packet->generation) {
1583                 spin_unlock_irqrestore(&ctx->ohci->lock, flags);
1584                 handle_local_request(ctx, packet);
1585                 return;
1586         }
1587
1588         ret = at_context_queue_packet(ctx, packet);
1589         spin_unlock_irqrestore(&ctx->ohci->lock, flags);
1590
1591         if (ret < 0)
1592                 packet->callback(packet, &ctx->ohci->card, packet->ack);
1593
1594 }
1595
1596 static void detect_dead_context(struct fw_ohci *ohci,
1597                                 const char *name, unsigned int regs)
1598 {
1599         u32 ctl;
1600
1601         ctl = reg_read(ohci, CONTROL_SET(regs));
1602         if (ctl & CONTEXT_DEAD) {
1603 #ifdef CONFIG_FIREWIRE_OHCI_DEBUG
1604                 fw_error("DMA context %s has stopped, error code: %s\n",
1605                          name, evts[ctl & 0x1f]);
1606 #else
1607                 fw_error("DMA context %s has stopped, error code: %#x\n",
1608                          name, ctl & 0x1f);
1609 #endif
1610         }
1611 }
1612
1613 static void handle_dead_contexts(struct fw_ohci *ohci)
1614 {
1615         unsigned int i;
1616         char name[8];
1617
1618         detect_dead_context(ohci, "ATReq", OHCI1394_AsReqTrContextBase);
1619         detect_dead_context(ohci, "ATRsp", OHCI1394_AsRspTrContextBase);
1620         detect_dead_context(ohci, "ARReq", OHCI1394_AsReqRcvContextBase);
1621         detect_dead_context(ohci, "ARRsp", OHCI1394_AsRspRcvContextBase);
1622         for (i = 0; i < 32; ++i) {
1623                 if (!(ohci->it_context_support & (1 << i)))
1624                         continue;
1625                 sprintf(name, "IT%u", i);
1626                 detect_dead_context(ohci, name, OHCI1394_IsoXmitContextBase(i));
1627         }
1628         for (i = 0; i < 32; ++i) {
1629                 if (!(ohci->ir_context_support & (1 << i)))
1630                         continue;
1631                 sprintf(name, "IR%u", i);
1632                 detect_dead_context(ohci, name, OHCI1394_IsoRcvContextBase(i));
1633         }
1634         /* TODO: maybe try to flush and restart the dead contexts */
1635 }
1636
1637 static u32 cycle_timer_ticks(u32 cycle_timer)
1638 {
1639         u32 ticks;
1640
1641         ticks = cycle_timer & 0xfff;
1642         ticks += 3072 * ((cycle_timer >> 12) & 0x1fff);
1643         ticks += (3072 * 8000) * (cycle_timer >> 25);
1644
1645         return ticks;
1646 }
1647
1648 /*
1649  * Some controllers exhibit one or more of the following bugs when updating the
1650  * iso cycle timer register:
1651  *  - When the lowest six bits are wrapping around to zero, a read that happens
1652  *    at the same time will return garbage in the lowest ten bits.
1653  *  - When the cycleOffset field wraps around to zero, the cycleCount field is
1654  *    not incremented for about 60 ns.
1655  *  - Occasionally, the entire register reads zero.
1656  *
1657  * To catch these, we read the register three times and ensure that the
1658  * difference between each two consecutive reads is approximately the same, i.e.
1659  * less than twice the other.  Furthermore, any negative difference indicates an
1660  * error.  (A PCI read should take at least 20 ticks of the 24.576 MHz timer to
1661  * execute, so we have enough precision to compute the ratio of the differences.)
1662  */
1663 static u32 get_cycle_time(struct fw_ohci *ohci)
1664 {
1665         u32 c0, c1, c2;
1666         u32 t0, t1, t2;
1667         s32 diff01, diff12;
1668         int i;
1669
1670         c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1671
1672         if (ohci->quirks & QUIRK_CYCLE_TIMER) {
1673                 i = 0;
1674                 c1 = c2;
1675                 c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1676                 do {
1677                         c0 = c1;
1678                         c1 = c2;
1679                         c2 = reg_read(ohci, OHCI1394_IsochronousCycleTimer);
1680                         t0 = cycle_timer_ticks(c0);
1681                         t1 = cycle_timer_ticks(c1);
1682                         t2 = cycle_timer_ticks(c2);
1683                         diff01 = t1 - t0;
1684                         diff12 = t2 - t1;
1685                 } while ((diff01 <= 0 || diff12 <= 0 ||
1686                           diff01 / diff12 >= 2 || diff12 / diff01 >= 2)
1687                          && i++ < 20);
1688         }
1689
1690         return c2;
1691 }
1692
1693 /*
1694  * This function has to be called at least every 64 seconds.  The bus_time
1695  * field stores not only the upper 25 bits of the BUS_TIME register but also
1696  * the most significant bit of the cycle timer in bit 6 so that we can detect
1697  * changes in this bit.
1698  */
1699 static u32 update_bus_time(struct fw_ohci *ohci)
1700 {
1701         u32 cycle_time_seconds = get_cycle_time(ohci) >> 25;
1702
1703         if ((ohci->bus_time & 0x40) != (cycle_time_seconds & 0x40))
1704                 ohci->bus_time += 0x40;
1705
1706         return ohci->bus_time | cycle_time_seconds;
1707 }
1708
1709 static void bus_reset_tasklet(unsigned long data)
1710 {
1711         struct fw_ohci *ohci = (struct fw_ohci *)data;
1712         int self_id_count, i, j, reg;
1713         int generation, new_generation;
1714         unsigned long flags;
1715         void *free_rom = NULL;
1716         dma_addr_t free_rom_bus = 0;
1717         bool is_new_root;
1718
1719         reg = reg_read(ohci, OHCI1394_NodeID);
1720         if (!(reg & OHCI1394_NodeID_idValid)) {
1721                 fw_notify("node ID not valid, new bus reset in progress\n");
1722                 return;
1723         }
1724         if ((reg & OHCI1394_NodeID_nodeNumber) == 63) {
1725                 fw_notify("malconfigured bus\n");
1726                 return;
1727         }
1728         ohci->node_id = reg & (OHCI1394_NodeID_busNumber |
1729                                OHCI1394_NodeID_nodeNumber);
1730
1731         is_new_root = (reg & OHCI1394_NodeID_root) != 0;
1732         if (!(ohci->is_root && is_new_root))
1733                 reg_write(ohci, OHCI1394_LinkControlSet,
1734                           OHCI1394_LinkControl_cycleMaster);
1735         ohci->is_root = is_new_root;
1736
1737         reg = reg_read(ohci, OHCI1394_SelfIDCount);
1738         if (reg & OHCI1394_SelfIDCount_selfIDError) {
1739                 fw_notify("inconsistent self IDs\n");
1740                 return;
1741         }
1742         /*
1743          * The count in the SelfIDCount register is the number of
1744          * bytes in the self ID receive buffer.  Since we also receive
1745          * the inverted quadlets and a header quadlet, we shift one
1746          * bit extra to get the actual number of self IDs.
1747          */
1748         self_id_count = (reg >> 3) & 0xff;
1749         if (self_id_count == 0 || self_id_count > 252) {
1750                 fw_notify("inconsistent self IDs\n");
1751                 return;
1752         }
1753         generation = (cond_le32_to_cpu(ohci->self_id_cpu[0]) >> 16) & 0xff;
1754         rmb();
1755
1756         for (i = 1, j = 0; j < self_id_count; i += 2, j++) {
1757                 if (ohci->self_id_cpu[i] != ~ohci->self_id_cpu[i + 1]) {
1758                         fw_notify("inconsistent self IDs\n");
1759                         return;
1760                 }
1761                 ohci->self_id_buffer[j] =
1762                                 cond_le32_to_cpu(ohci->self_id_cpu[i]);
1763         }
1764         rmb();
1765
1766         /*
1767          * Check the consistency of the self IDs we just read.  The
1768          * problem we face is that a new bus reset can start while we
1769          * read out the self IDs from the DMA buffer. If this happens,
1770          * the DMA buffer will be overwritten with new self IDs and we
1771          * will read out inconsistent data.  The OHCI specification
1772          * (section 11.2) recommends a technique similar to
1773          * linux/seqlock.h, where we remember the generation of the
1774          * self IDs in the buffer before reading them out and compare
1775          * it to the current generation after reading them out.  If
1776          * the two generations match we know we have a consistent set
1777          * of self IDs.
1778          */
1779
1780         new_generation = (reg_read(ohci, OHCI1394_SelfIDCount) >> 16) & 0xff;
1781         if (new_generation != generation) {
1782                 fw_notify("recursive bus reset detected, "
1783                           "discarding self ids\n");
1784                 return;
1785         }
1786
1787         /* FIXME: Document how the locking works. */
1788         spin_lock_irqsave(&ohci->lock, flags);
1789
1790         ohci->generation = -1; /* prevent AT packet queueing */
1791         context_stop(&ohci->at_request_ctx);
1792         context_stop(&ohci->at_response_ctx);
1793
1794         spin_unlock_irqrestore(&ohci->lock, flags);
1795
1796         /*
1797          * Per OHCI 1.2 draft, clause 7.2.3.3, hardware may leave unsent
1798          * packets in the AT queues and software needs to drain them.
1799          * Some OHCI 1.1 controllers (JMicron) apparently require this too.
1800          */
1801         at_context_flush(&ohci->at_request_ctx);
1802         at_context_flush(&ohci->at_response_ctx);
1803
1804         spin_lock_irqsave(&ohci->lock, flags);
1805
1806         ohci->generation = generation;
1807         reg_write(ohci, OHCI1394_IntEventClear, OHCI1394_busReset);
1808
1809         if (ohci->quirks & QUIRK_RESET_PACKET)
1810                 ohci->request_generation = generation;
1811
1812         /*
1813          * This next bit is unrelated to the AT context stuff but we
1814          * have to do it under the spinlock also.  If a new config rom
1815          * was set up before this reset, the old one is now no longer
1816          * in use and we can free it. Update the config rom pointers
1817          * to point to the current config rom and clear the
1818          * next_config_rom pointer so a new update can take place.
1819          */
1820
1821         if (ohci->next_config_rom != NULL) {
1822                 if (ohci->next_config_rom != ohci->config_rom) {
1823                         free_rom      = ohci->config_rom;
1824                         free_rom_bus  = ohci->config_rom_bus;
1825                 }
1826                 ohci->config_rom      = ohci->next_config_rom;
1827                 ohci->config_rom_bus  = ohci->next_config_rom_bus;
1828                 ohci->next_config_rom = NULL;
1829
1830                 /*
1831                  * Restore config_rom image and manually update
1832                  * config_rom registers.  Writing the header quadlet
1833                  * will indicate that the config rom is ready, so we
1834                  * do that last.
1835                  */
1836                 reg_write(ohci, OHCI1394_BusOptions,
1837                           be32_to_cpu(ohci->config_rom[2]));
1838                 ohci->config_rom[0] = ohci->next_header;
1839                 reg_write(ohci, OHCI1394_ConfigROMhdr,
1840                           be32_to_cpu(ohci->next_header));
1841         }
1842
1843 #ifdef CONFIG_FIREWIRE_OHCI_REMOTE_DMA
1844         reg_write(ohci, OHCI1394_PhyReqFilterHiSet, ~0);
1845         reg_write(ohci, OHCI1394_PhyReqFilterLoSet, ~0);
1846 #endif
1847
1848         spin_unlock_irqrestore(&ohci->lock, flags);
1849
1850         if (free_rom)
1851                 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
1852                                   free_rom, free_rom_bus);
1853
1854         log_selfids(ohci->node_id, generation,
1855                     self_id_count, ohci->self_id_buffer);
1856
1857         fw_core_handle_bus_reset(&ohci->card, ohci->node_id, generation,
1858                                  self_id_count, ohci->self_id_buffer,
1859                                  ohci->csr_state_setclear_abdicate);
1860         ohci->csr_state_setclear_abdicate = false;
1861 }
1862
1863 static irqreturn_t irq_handler(int irq, void *data)
1864 {
1865         struct fw_ohci *ohci = data;
1866         u32 event, iso_event;
1867         int i;
1868
1869         event = reg_read(ohci, OHCI1394_IntEventClear);
1870
1871         if (!event || !~event)
1872                 return IRQ_NONE;
1873
1874         /*
1875          * busReset and postedWriteErr must not be cleared yet
1876          * (OHCI 1.1 clauses 7.2.3.2 and 13.2.8.1)
1877          */
1878         reg_write(ohci, OHCI1394_IntEventClear,
1879                   event & ~(OHCI1394_busReset | OHCI1394_postedWriteErr));
1880         log_irqs(event);
1881
1882         if (event & OHCI1394_selfIDComplete)
1883                 tasklet_schedule(&ohci->bus_reset_tasklet);
1884
1885         if (event & OHCI1394_RQPkt)
1886                 tasklet_schedule(&ohci->ar_request_ctx.tasklet);
1887
1888         if (event & OHCI1394_RSPkt)
1889                 tasklet_schedule(&ohci->ar_response_ctx.tasklet);
1890
1891         if (event & OHCI1394_reqTxComplete)
1892                 tasklet_schedule(&ohci->at_request_ctx.tasklet);
1893
1894         if (event & OHCI1394_respTxComplete)
1895                 tasklet_schedule(&ohci->at_response_ctx.tasklet);
1896
1897         if (event & OHCI1394_isochRx) {
1898                 iso_event = reg_read(ohci, OHCI1394_IsoRecvIntEventClear);
1899                 reg_write(ohci, OHCI1394_IsoRecvIntEventClear, iso_event);
1900
1901                 while (iso_event) {
1902                         i = ffs(iso_event) - 1;
1903                         tasklet_schedule(
1904                                 &ohci->ir_context_list[i].context.tasklet);
1905                         iso_event &= ~(1 << i);
1906                 }
1907         }
1908
1909         if (event & OHCI1394_isochTx) {
1910                 iso_event = reg_read(ohci, OHCI1394_IsoXmitIntEventClear);
1911                 reg_write(ohci, OHCI1394_IsoXmitIntEventClear, iso_event);
1912
1913                 while (iso_event) {
1914                         i = ffs(iso_event) - 1;
1915                         tasklet_schedule(
1916                                 &ohci->it_context_list[i].context.tasklet);
1917                         iso_event &= ~(1 << i);
1918                 }
1919         }
1920
1921         if (unlikely(event & OHCI1394_regAccessFail))
1922                 fw_error("Register access failure - "
1923                          "please notify linux1394-devel@lists.sf.net\n");
1924
1925         if (unlikely(event & OHCI1394_postedWriteErr)) {
1926                 reg_read(ohci, OHCI1394_PostedWriteAddressHi);
1927                 reg_read(ohci, OHCI1394_PostedWriteAddressLo);
1928                 reg_write(ohci, OHCI1394_IntEventClear,
1929                           OHCI1394_postedWriteErr);
1930                 fw_error("PCI posted write error\n");
1931         }
1932
1933         if (unlikely(event & OHCI1394_cycleTooLong)) {
1934                 if (printk_ratelimit())
1935                         fw_notify("isochronous cycle too long\n");
1936                 reg_write(ohci, OHCI1394_LinkControlSet,
1937                           OHCI1394_LinkControl_cycleMaster);
1938         }
1939
1940         if (unlikely(event & OHCI1394_cycleInconsistent)) {
1941                 /*
1942                  * We need to clear this event bit in order to make
1943                  * cycleMatch isochronous I/O work.  In theory we should
1944                  * stop active cycleMatch iso contexts now and restart
1945                  * them at least two cycles later.  (FIXME?)
1946                  */
1947                 if (printk_ratelimit())
1948                         fw_notify("isochronous cycle inconsistent\n");
1949         }
1950
1951         if (unlikely(event & OHCI1394_unrecoverableError))
1952                 handle_dead_contexts(ohci);
1953
1954         if (event & OHCI1394_cycle64Seconds) {
1955                 spin_lock(&ohci->lock);
1956                 update_bus_time(ohci);
1957                 spin_unlock(&ohci->lock);
1958         } else
1959                 flush_writes(ohci);
1960
1961         return IRQ_HANDLED;
1962 }
1963
1964 static int software_reset(struct fw_ohci *ohci)
1965 {
1966         int i;
1967
1968         reg_write(ohci, OHCI1394_HCControlSet, OHCI1394_HCControl_softReset);
1969
1970         for (i = 0; i < OHCI_LOOP_COUNT; i++) {
1971                 if ((reg_read(ohci, OHCI1394_HCControlSet) &
1972                      OHCI1394_HCControl_softReset) == 0)
1973                         return 0;
1974                 msleep(1);
1975         }
1976
1977         return -EBUSY;
1978 }
1979
1980 static void copy_config_rom(__be32 *dest, const __be32 *src, size_t length)
1981 {
1982         size_t size = length * 4;
1983
1984         memcpy(dest, src, size);
1985         if (size < CONFIG_ROM_SIZE)
1986                 memset(&dest[length], 0, CONFIG_ROM_SIZE - size);
1987 }
1988
1989 static int configure_1394a_enhancements(struct fw_ohci *ohci)
1990 {
1991         bool enable_1394a;
1992         int ret, clear, set, offset;
1993
1994         /* Check if the driver should configure link and PHY. */
1995         if (!(reg_read(ohci, OHCI1394_HCControlSet) &
1996               OHCI1394_HCControl_programPhyEnable))
1997                 return 0;
1998
1999         /* Paranoia: check whether the PHY supports 1394a, too. */
2000         enable_1394a = false;
2001         ret = read_phy_reg(ohci, 2);
2002         if (ret < 0)
2003                 return ret;
2004         if ((ret & PHY_EXTENDED_REGISTERS) == PHY_EXTENDED_REGISTERS) {
2005                 ret = read_paged_phy_reg(ohci, 1, 8);
2006                 if (ret < 0)
2007                         return ret;
2008                 if (ret >= 1)
2009                         enable_1394a = true;
2010         }
2011
2012         if (ohci->quirks & QUIRK_NO_1394A)
2013                 enable_1394a = false;
2014
2015         /* Configure PHY and link consistently. */
2016         if (enable_1394a) {
2017                 clear = 0;
2018                 set = PHY_ENABLE_ACCEL | PHY_ENABLE_MULTI;
2019         } else {
2020                 clear = PHY_ENABLE_ACCEL | PHY_ENABLE_MULTI;
2021                 set = 0;
2022         }
2023         ret = update_phy_reg(ohci, 5, clear, set);
2024         if (ret < 0)
2025                 return ret;
2026
2027         if (enable_1394a)
2028                 offset = OHCI1394_HCControlSet;
2029         else
2030                 offset = OHCI1394_HCControlClear;
2031         reg_write(ohci, offset, OHCI1394_HCControl_aPhyEnhanceEnable);
2032
2033         /* Clean up: configuration has been taken care of. */
2034         reg_write(ohci, OHCI1394_HCControlClear,
2035                   OHCI1394_HCControl_programPhyEnable);
2036
2037         return 0;
2038 }
2039
2040 static int ohci_enable(struct fw_card *card,
2041                        const __be32 *config_rom, size_t length)
2042 {
2043         struct fw_ohci *ohci = fw_ohci(card);
2044         struct pci_dev *dev = to_pci_dev(card->device);
2045         u32 lps, seconds, version, irqs;
2046         int i, ret;
2047
2048         if (software_reset(ohci)) {
2049                 fw_error("Failed to reset ohci card.\n");
2050                 return -EBUSY;
2051         }
2052
2053         /*
2054          * Now enable LPS, which we need in order to start accessing
2055          * most of the registers.  In fact, on some cards (ALI M5251),
2056          * accessing registers in the SClk domain without LPS enabled
2057          * will lock up the machine.  Wait 50msec to make sure we have
2058          * full link enabled.  However, with some cards (well, at least
2059          * a JMicron PCIe card), we have to try again sometimes.
2060          */
2061         reg_write(ohci, OHCI1394_HCControlSet,
2062                   OHCI1394_HCControl_LPS |
2063                   OHCI1394_HCControl_postedWriteEnable);
2064         flush_writes(ohci);
2065
2066         for (lps = 0, i = 0; !lps && i < 3; i++) {
2067                 msleep(50);
2068                 lps = reg_read(ohci, OHCI1394_HCControlSet) &
2069                       OHCI1394_HCControl_LPS;
2070         }
2071
2072         if (!lps) {
2073                 fw_error("Failed to set Link Power Status\n");
2074                 return -EIO;
2075         }
2076
2077         reg_write(ohci, OHCI1394_HCControlClear,
2078                   OHCI1394_HCControl_noByteSwapData);
2079
2080         reg_write(ohci, OHCI1394_SelfIDBuffer, ohci->self_id_bus);
2081         reg_write(ohci, OHCI1394_LinkControlSet,
2082                   OHCI1394_LinkControl_rcvSelfID |
2083                   OHCI1394_LinkControl_rcvPhyPkt |
2084                   OHCI1394_LinkControl_cycleTimerEnable |
2085                   OHCI1394_LinkControl_cycleMaster);
2086
2087         reg_write(ohci, OHCI1394_ATRetries,
2088                   OHCI1394_MAX_AT_REQ_RETRIES |
2089                   (OHCI1394_MAX_AT_RESP_RETRIES << 4) |
2090                   (OHCI1394_MAX_PHYS_RESP_RETRIES << 8) |
2091                   (200 << 16));
2092
2093         seconds = lower_32_bits(get_seconds());
2094         reg_write(ohci, OHCI1394_IsochronousCycleTimer, seconds << 25);
2095         ohci->bus_time = seconds & ~0x3f;
2096
2097         version = reg_read(ohci, OHCI1394_Version) & 0x00ff00ff;
2098         if (version >= OHCI_VERSION_1_1) {
2099                 reg_write(ohci, OHCI1394_InitialChannelsAvailableHi,
2100                           0xfffffffe);
2101                 card->broadcast_channel_auto_allocated = true;
2102         }
2103
2104         /* Get implemented bits of the priority arbitration request counter. */
2105         reg_write(ohci, OHCI1394_FairnessControl, 0x3f);
2106         ohci->pri_req_max = reg_read(ohci, OHCI1394_FairnessControl) & 0x3f;
2107         reg_write(ohci, OHCI1394_FairnessControl, 0);
2108         card->priority_budget_implemented = ohci->pri_req_max != 0;
2109
2110         ar_context_run(&ohci->ar_request_ctx);
2111         ar_context_run(&ohci->ar_response_ctx);
2112
2113         reg_write(ohci, OHCI1394_PhyUpperBound, 0x00010000);
2114         reg_write(ohci, OHCI1394_IntEventClear, ~0);
2115         reg_write(ohci, OHCI1394_IntMaskClear, ~0);
2116
2117         ret = configure_1394a_enhancements(ohci);
2118         if (ret < 0)
2119                 return ret;
2120
2121         /* Activate link_on bit and contender bit in our self ID packets.*/
2122         ret = ohci_update_phy_reg(card, 4, 0, PHY_LINK_ACTIVE | PHY_CONTENDER);
2123         if (ret < 0)
2124                 return ret;
2125
2126         /*
2127          * When the link is not yet enabled, the atomic config rom
2128          * update mechanism described below in ohci_set_config_rom()
2129          * is not active.  We have to update ConfigRomHeader and
2130          * BusOptions manually, and the write to ConfigROMmap takes
2131          * effect immediately.  We tie this to the enabling of the
2132          * link, so we have a valid config rom before enabling - the
2133          * OHCI requires that ConfigROMhdr and BusOptions have valid
2134          * values before enabling.
2135          *
2136          * However, when the ConfigROMmap is written, some controllers
2137          * always read back quadlets 0 and 2 from the config rom to
2138          * the ConfigRomHeader and BusOptions registers on bus reset.
2139          * They shouldn't do that in this initial case where the link
2140          * isn't enabled.  This means we have to use the same
2141          * workaround here, setting the bus header to 0 and then write
2142          * the right values in the bus reset tasklet.
2143          */
2144
2145         if (config_rom) {
2146                 ohci->next_config_rom =
2147                         dma_alloc_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2148                                            &ohci->next_config_rom_bus,
2149                                            GFP_KERNEL);
2150                 if (ohci->next_config_rom == NULL)
2151                         return -ENOMEM;
2152
2153                 copy_config_rom(ohci->next_config_rom, config_rom, length);
2154         } else {
2155                 /*
2156                  * In the suspend case, config_rom is NULL, which
2157                  * means that we just reuse the old config rom.
2158                  */
2159                 ohci->next_config_rom = ohci->config_rom;
2160                 ohci->next_config_rom_bus = ohci->config_rom_bus;
2161         }
2162
2163         ohci->next_header = ohci->next_config_rom[0];
2164         ohci->next_config_rom[0] = 0;
2165         reg_write(ohci, OHCI1394_ConfigROMhdr, 0);
2166         reg_write(ohci, OHCI1394_BusOptions,
2167                   be32_to_cpu(ohci->next_config_rom[2]));
2168         reg_write(ohci, OHCI1394_ConfigROMmap, ohci->next_config_rom_bus);
2169
2170         reg_write(ohci, OHCI1394_AsReqFilterHiSet, 0x80000000);
2171
2172         if (!(ohci->quirks & QUIRK_NO_MSI))
2173                 pci_enable_msi(dev);
2174         if (request_irq(dev->irq, irq_handler,
2175                         pci_dev_msi_enabled(dev) ? 0 : IRQF_SHARED,
2176                         ohci_driver_name, ohci)) {
2177                 fw_error("Failed to allocate interrupt %d.\n", dev->irq);
2178                 pci_disable_msi(dev);
2179                 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2180                                   ohci->config_rom, ohci->config_rom_bus);
2181                 return -EIO;
2182         }
2183
2184         irqs =  OHCI1394_reqTxComplete | OHCI1394_respTxComplete |
2185                 OHCI1394_RQPkt | OHCI1394_RSPkt |
2186                 OHCI1394_isochTx | OHCI1394_isochRx |
2187                 OHCI1394_postedWriteErr |
2188                 OHCI1394_selfIDComplete |
2189                 OHCI1394_regAccessFail |
2190                 OHCI1394_cycle64Seconds |
2191                 OHCI1394_cycleInconsistent |
2192                 OHCI1394_unrecoverableError |
2193                 OHCI1394_cycleTooLong |
2194                 OHCI1394_masterIntEnable;
2195         if (param_debug & OHCI_PARAM_DEBUG_BUSRESETS)
2196                 irqs |= OHCI1394_busReset;
2197         reg_write(ohci, OHCI1394_IntMaskSet, irqs);
2198
2199         reg_write(ohci, OHCI1394_HCControlSet,
2200                   OHCI1394_HCControl_linkEnable |
2201                   OHCI1394_HCControl_BIBimageValid);
2202         flush_writes(ohci);
2203
2204         /* We are ready to go, reset bus to finish initialization. */
2205         fw_schedule_bus_reset(&ohci->card, false, true);
2206
2207         return 0;
2208 }
2209
2210 static int ohci_set_config_rom(struct fw_card *card,
2211                                const __be32 *config_rom, size_t length)
2212 {
2213         struct fw_ohci *ohci;
2214         unsigned long flags;
2215         int ret = -EBUSY;
2216         __be32 *next_config_rom;
2217         dma_addr_t uninitialized_var(next_config_rom_bus);
2218
2219         ohci = fw_ohci(card);
2220
2221         /*
2222          * When the OHCI controller is enabled, the config rom update
2223          * mechanism is a bit tricky, but easy enough to use.  See
2224          * section 5.5.6 in the OHCI specification.
2225          *
2226          * The OHCI controller caches the new config rom address in a
2227          * shadow register (ConfigROMmapNext) and needs a bus reset
2228          * for the changes to take place.  When the bus reset is
2229          * detected, the controller loads the new values for the
2230          * ConfigRomHeader and BusOptions registers from the specified
2231          * config rom and loads ConfigROMmap from the ConfigROMmapNext
2232          * shadow register. All automatically and atomically.
2233          *
2234          * Now, there's a twist to this story.  The automatic load of
2235          * ConfigRomHeader and BusOptions doesn't honor the
2236          * noByteSwapData bit, so with a be32 config rom, the
2237          * controller will load be32 values in to these registers
2238          * during the atomic update, even on litte endian
2239          * architectures.  The workaround we use is to put a 0 in the
2240          * header quadlet; 0 is endian agnostic and means that the
2241          * config rom isn't ready yet.  In the bus reset tasklet we
2242          * then set up the real values for the two registers.
2243          *
2244          * We use ohci->lock to avoid racing with the code that sets
2245          * ohci->next_config_rom to NULL (see bus_reset_tasklet).
2246          */
2247
2248         next_config_rom =
2249                 dma_alloc_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2250                                    &next_config_rom_bus, GFP_KERNEL);
2251         if (next_config_rom == NULL)
2252                 return -ENOMEM;
2253
2254         spin_lock_irqsave(&ohci->lock, flags);
2255
2256         if (ohci->next_config_rom == NULL) {
2257                 ohci->next_config_rom = next_config_rom;
2258                 ohci->next_config_rom_bus = next_config_rom_bus;
2259
2260                 copy_config_rom(ohci->next_config_rom, config_rom, length);
2261
2262                 ohci->next_header = config_rom[0];
2263                 ohci->next_config_rom[0] = 0;
2264
2265                 reg_write(ohci, OHCI1394_ConfigROMmap,
2266                           ohci->next_config_rom_bus);
2267                 ret = 0;
2268         }
2269
2270         spin_unlock_irqrestore(&ohci->lock, flags);
2271
2272         /*
2273          * Now initiate a bus reset to have the changes take
2274          * effect. We clean up the old config rom memory and DMA
2275          * mappings in the bus reset tasklet, since the OHCI
2276          * controller could need to access it before the bus reset
2277          * takes effect.
2278          */
2279         if (ret == 0)
2280                 fw_schedule_bus_reset(&ohci->card, true, true);
2281         else
2282                 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
2283                                   next_config_rom, next_config_rom_bus);
2284
2285         return ret;
2286 }
2287
2288 static void ohci_send_request(struct fw_card *card, struct fw_packet *packet)
2289 {
2290         struct fw_ohci *ohci = fw_ohci(card);
2291
2292         at_context_transmit(&ohci->at_request_ctx, packet);
2293 }
2294
2295 static void ohci_send_response(struct fw_card *card, struct fw_packet *packet)
2296 {
2297         struct fw_ohci *ohci = fw_ohci(card);
2298
2299         at_context_transmit(&ohci->at_response_ctx, packet);
2300 }
2301
2302 static int ohci_cancel_packet(struct fw_card *card, struct fw_packet *packet)
2303 {
2304         struct fw_ohci *ohci = fw_ohci(card);
2305         struct context *ctx = &ohci->at_request_ctx;
2306         struct driver_data *driver_data = packet->driver_data;
2307         int ret = -ENOENT;
2308
2309         tasklet_disable(&ctx->tasklet);
2310
2311         if (packet->ack != 0)
2312                 goto out;
2313
2314         if (packet->payload_mapped)
2315                 dma_unmap_single(ohci->card.device, packet->payload_bus,
2316                                  packet->payload_length, DMA_TO_DEVICE);
2317
2318         log_ar_at_event('T', packet->speed, packet->header, 0x20);
2319         driver_data->packet = NULL;
2320         packet->ack = RCODE_CANCELLED;
2321         packet->callback(packet, &ohci->card, packet->ack);
2322         ret = 0;
2323  out:
2324         tasklet_enable(&ctx->tasklet);
2325
2326         return ret;
2327 }
2328
2329 static int ohci_enable_phys_dma(struct fw_card *card,
2330                                 int node_id, int generation)
2331 {
2332 #ifdef CONFIG_FIREWIRE_OHCI_REMOTE_DMA
2333         return 0;
2334 #else
2335         struct fw_ohci *ohci = fw_ohci(card);
2336         unsigned long flags;
2337         int n, ret = 0;
2338
2339         /*
2340          * FIXME:  Make sure this bitmask is cleared when we clear the busReset
2341          * interrupt bit.  Clear physReqResourceAllBuses on bus reset.
2342          */
2343
2344         spin_lock_irqsave(&ohci->lock, flags);
2345
2346         if (ohci->generation != generation) {
2347                 ret = -ESTALE;
2348                 goto out;
2349         }
2350
2351         /*
2352          * Note, if the node ID contains a non-local bus ID, physical DMA is
2353          * enabled for _all_ nodes on remote buses.
2354          */
2355
2356         n = (node_id & 0xffc0) == LOCAL_BUS ? node_id & 0x3f : 63;
2357         if (n < 32)
2358                 reg_write(ohci, OHCI1394_PhyReqFilterLoSet, 1 << n);
2359         else
2360                 reg_write(ohci, OHCI1394_PhyReqFilterHiSet, 1 << (n - 32));
2361
2362         flush_writes(ohci);
2363  out:
2364         spin_unlock_irqrestore(&ohci->lock, flags);
2365
2366         return ret;
2367 #endif /* CONFIG_FIREWIRE_OHCI_REMOTE_DMA */
2368 }
2369
2370 static u32 ohci_read_csr(struct fw_card *card, int csr_offset)
2371 {
2372         struct fw_ohci *ohci = fw_ohci(card);
2373         unsigned long flags;
2374         u32 value;
2375
2376         switch (csr_offset) {
2377         case CSR_STATE_CLEAR:
2378         case CSR_STATE_SET:
2379                 if (ohci->is_root &&
2380                     (reg_read(ohci, OHCI1394_LinkControlSet) &
2381                      OHCI1394_LinkControl_cycleMaster))
2382                         value = CSR_STATE_BIT_CMSTR;
2383                 else
2384                         value = 0;
2385                 if (ohci->csr_state_setclear_abdicate)
2386                         value |= CSR_STATE_BIT_ABDICATE;
2387
2388                 return value;
2389
2390         case CSR_NODE_IDS:
2391                 return reg_read(ohci, OHCI1394_NodeID) << 16;
2392
2393         case CSR_CYCLE_TIME:
2394                 return get_cycle_time(ohci);
2395
2396         case CSR_BUS_TIME:
2397                 /*
2398                  * We might be called just after the cycle timer has wrapped
2399                  * around but just before the cycle64Seconds handler, so we
2400                  * better check here, too, if the bus time needs to be updated.
2401                  */
2402                 spin_lock_irqsave(&ohci->lock, flags);
2403                 value = update_bus_time(ohci);
2404                 spin_unlock_irqrestore(&ohci->lock, flags);
2405                 return value;
2406
2407         case CSR_BUSY_TIMEOUT:
2408                 value = reg_read(ohci, OHCI1394_ATRetries);
2409                 return (value >> 4) & 0x0ffff00f;
2410
2411         case CSR_PRIORITY_BUDGET:
2412                 return (reg_read(ohci, OHCI1394_FairnessControl) & 0x3f) |
2413                         (ohci->pri_req_max << 8);
2414
2415         default:
2416                 WARN_ON(1);
2417                 return 0;
2418         }
2419 }
2420
2421 static void ohci_write_csr(struct fw_card *card, int csr_offset, u32 value)
2422 {
2423         struct fw_ohci *ohci = fw_ohci(card);
2424         unsigned long flags;
2425
2426         switch (csr_offset) {
2427         case CSR_STATE_CLEAR:
2428                 if ((value & CSR_STATE_BIT_CMSTR) && ohci->is_root) {
2429                         reg_write(ohci, OHCI1394_LinkControlClear,
2430                                   OHCI1394_LinkControl_cycleMaster);
2431                         flush_writes(ohci);
2432                 }
2433                 if (value & CSR_STATE_BIT_ABDICATE)
2434                         ohci->csr_state_setclear_abdicate = false;
2435                 break;
2436
2437         case CSR_STATE_SET:
2438                 if ((value & CSR_STATE_BIT_CMSTR) && ohci->is_root) {
2439                         reg_write(ohci, OHCI1394_LinkControlSet,
2440                                   OHCI1394_LinkControl_cycleMaster);
2441                         flush_writes(ohci);
2442                 }
2443                 if (value & CSR_STATE_BIT_ABDICATE)
2444                         ohci->csr_state_setclear_abdicate = true;
2445                 break;
2446
2447         case CSR_NODE_IDS:
2448                 reg_write(ohci, OHCI1394_NodeID, value >> 16);
2449                 flush_writes(ohci);
2450                 break;
2451
2452         case CSR_CYCLE_TIME:
2453                 reg_write(ohci, OHCI1394_IsochronousCycleTimer, value);
2454                 reg_write(ohci, OHCI1394_IntEventSet,
2455                           OHCI1394_cycleInconsistent);
2456                 flush_writes(ohci);
2457                 break;
2458
2459         case CSR_BUS_TIME:
2460                 spin_lock_irqsave(&ohci->lock, flags);
2461                 ohci->bus_time = (ohci->bus_time & 0x7f) | (value & ~0x7f);
2462                 spin_unlock_irqrestore(&ohci->lock, flags);
2463                 break;
2464
2465         case CSR_BUSY_TIMEOUT:
2466                 value = (value & 0xf) | ((value & 0xf) << 4) |
2467                         ((value & 0xf) << 8) | ((value & 0x0ffff000) << 4);
2468                 reg_write(ohci, OHCI1394_ATRetries, value);
2469                 flush_writes(ohci);
2470                 break;
2471
2472         case CSR_PRIORITY_BUDGET:
2473                 reg_write(ohci, OHCI1394_FairnessControl, value & 0x3f);
2474                 flush_writes(ohci);
2475                 break;
2476
2477         default:
2478                 WARN_ON(1);
2479                 break;
2480         }
2481 }
2482
2483 static void copy_iso_headers(struct iso_context *ctx, void *p)
2484 {
2485         int i = ctx->header_length;
2486
2487         if (i + ctx->base.header_size > PAGE_SIZE)
2488                 return;
2489
2490         /*
2491          * The iso header is byteswapped to little endian by
2492          * the controller, but the remaining header quadlets
2493          * are big endian.  We want to present all the headers
2494          * as big endian, so we have to swap the first quadlet.
2495          */
2496         if (ctx->base.header_size > 0)
2497                 *(u32 *) (ctx->header + i) = __swab32(*(u32 *) (p + 4));
2498         if (ctx->base.header_size > 4)
2499                 *(u32 *) (ctx->header + i + 4) = __swab32(*(u32 *) p);
2500         if (ctx->base.header_size > 8)
2501                 memcpy(ctx->header + i + 8, p + 8, ctx->base.header_size - 8);
2502         ctx->header_length += ctx->base.header_size;
2503 }
2504
2505 static int handle_ir_packet_per_buffer(struct context *context,
2506                                        struct descriptor *d,
2507                                        struct descriptor *last)
2508 {
2509         struct iso_context *ctx =
2510                 container_of(context, struct iso_context, context);
2511         struct descriptor *pd;
2512         __le32 *ir_header;
2513         void *p;
2514
2515         for (pd = d; pd <= last; pd++)
2516                 if (pd->transfer_status)
2517                         break;
2518         if (pd > last)
2519                 /* Descriptor(s) not done yet, stop iteration */
2520                 return 0;
2521
2522         p = last + 1;
2523         copy_iso_headers(ctx, p);
2524
2525         if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS) {
2526                 ir_header = (__le32 *) p;
2527                 ctx->base.callback.sc(&ctx->base,
2528                                       le32_to_cpu(ir_header[0]) & 0xffff,
2529                                       ctx->header_length, ctx->header,
2530                                       ctx->base.callback_data);
2531                 ctx->header_length = 0;
2532         }
2533
2534         return 1;
2535 }
2536
2537 /* d == last because each descriptor block is only a single descriptor. */
2538 static int handle_ir_buffer_fill(struct context *context,
2539                                  struct descriptor *d,
2540                                  struct descriptor *last)
2541 {
2542         struct iso_context *ctx =
2543                 container_of(context, struct iso_context, context);
2544
2545         if (!last->transfer_status)
2546                 /* Descriptor(s) not done yet, stop iteration */
2547                 return 0;
2548
2549         if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS)
2550                 ctx->base.callback.mc(&ctx->base,
2551                                       le32_to_cpu(last->data_address) +
2552                                       le16_to_cpu(last->req_count) -
2553                                       le16_to_cpu(last->res_count),
2554                                       ctx->base.callback_data);
2555
2556         return 1;
2557 }
2558
2559 static int handle_it_packet(struct context *context,
2560                             struct descriptor *d,
2561                             struct descriptor *last)
2562 {
2563         struct iso_context *ctx =
2564                 container_of(context, struct iso_context, context);
2565         int i;
2566         struct descriptor *pd;
2567
2568         for (pd = d; pd <= last; pd++)
2569                 if (pd->transfer_status)
2570                         break;
2571         if (pd > last)
2572                 /* Descriptor(s) not done yet, stop iteration */
2573                 return 0;
2574
2575         i = ctx->header_length;
2576         if (i + 4 < PAGE_SIZE) {
2577                 /* Present this value as big-endian to match the receive code */
2578                 *(__be32 *)(ctx->header + i) = cpu_to_be32(
2579                                 ((u32)le16_to_cpu(pd->transfer_status) << 16) |
2580                                 le16_to_cpu(pd->res_count));
2581                 ctx->header_length += 4;
2582         }
2583         if (le16_to_cpu(last->control) & DESCRIPTOR_IRQ_ALWAYS) {
2584                 ctx->base.callback.sc(&ctx->base, le16_to_cpu(last->res_count),
2585                                       ctx->header_length, ctx->header,
2586                                       ctx->base.callback_data);
2587                 ctx->header_length = 0;
2588         }
2589         return 1;
2590 }
2591
2592 static void set_multichannel_mask(struct fw_ohci *ohci, u64 channels)
2593 {
2594         u32 hi = channels >> 32, lo = channels;
2595
2596         reg_write(ohci, OHCI1394_IRMultiChanMaskHiClear, ~hi);
2597         reg_write(ohci, OHCI1394_IRMultiChanMaskLoClear, ~lo);
2598         reg_write(ohci, OHCI1394_IRMultiChanMaskHiSet, hi);
2599         reg_write(ohci, OHCI1394_IRMultiChanMaskLoSet, lo);
2600         mmiowb();
2601         ohci->mc_channels = channels;
2602 }
2603
2604 static struct fw_iso_context *ohci_allocate_iso_context(struct fw_card *card,
2605                                 int type, int channel, size_t header_size)
2606 {
2607         struct fw_ohci *ohci = fw_ohci(card);
2608         struct iso_context *uninitialized_var(ctx);
2609         descriptor_callback_t uninitialized_var(callback);
2610         u64 *uninitialized_var(channels);
2611         u32 *uninitialized_var(mask), uninitialized_var(regs);
2612         unsigned long flags;
2613         int index, ret = -EBUSY;
2614
2615         spin_lock_irqsave(&ohci->lock, flags);
2616
2617         switch (type) {
2618         case FW_ISO_CONTEXT_TRANSMIT:
2619                 mask     = &ohci->it_context_mask;
2620                 callback = handle_it_packet;
2621                 index    = ffs(*mask) - 1;
2622                 if (index >= 0) {
2623                         *mask &= ~(1 << index);
2624                         regs = OHCI1394_IsoXmitContextBase(index);
2625                         ctx  = &ohci->it_context_list[index];
2626                 }
2627                 break;
2628
2629         case FW_ISO_CONTEXT_RECEIVE:
2630                 channels = &ohci->ir_context_channels;
2631                 mask     = &ohci->ir_context_mask;
2632                 callback = handle_ir_packet_per_buffer;
2633                 index    = *channels & 1ULL << channel ? ffs(*mask) - 1 : -1;
2634                 if (index >= 0) {
2635                         *channels &= ~(1ULL << channel);
2636                         *mask     &= ~(1 << index);
2637                         regs = OHCI1394_IsoRcvContextBase(index);
2638                         ctx  = &ohci->ir_context_list[index];
2639                 }
2640                 break;
2641
2642         case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2643                 mask     = &ohci->ir_context_mask;
2644                 callback = handle_ir_buffer_fill;
2645                 index    = !ohci->mc_allocated ? ffs(*mask) - 1 : -1;
2646                 if (index >= 0) {
2647                         ohci->mc_allocated = true;
2648                         *mask &= ~(1 << index);
2649                         regs = OHCI1394_IsoRcvContextBase(index);
2650                         ctx  = &ohci->ir_context_list[index];
2651                 }
2652                 break;
2653
2654         default:
2655                 index = -1;
2656                 ret = -ENOSYS;
2657         }
2658
2659         spin_unlock_irqrestore(&ohci->lock, flags);
2660
2661         if (index < 0)
2662                 return ERR_PTR(ret);
2663
2664         memset(ctx, 0, sizeof(*ctx));
2665         ctx->header_length = 0;
2666         ctx->header = (void *) __get_free_page(GFP_KERNEL);
2667         if (ctx->header == NULL) {
2668                 ret = -ENOMEM;
2669                 goto out;
2670         }
2671         ret = context_init(&ctx->context, ohci, regs, callback);
2672         if (ret < 0)
2673                 goto out_with_header;
2674
2675         if (type == FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL)
2676                 set_multichannel_mask(ohci, 0);
2677
2678         return &ctx->base;
2679
2680  out_with_header:
2681         free_page((unsigned long)ctx->header);
2682  out:
2683         spin_lock_irqsave(&ohci->lock, flags);
2684
2685         switch (type) {
2686         case FW_ISO_CONTEXT_RECEIVE:
2687                 *channels |= 1ULL << channel;
2688                 break;
2689
2690         case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2691                 ohci->mc_allocated = false;
2692                 break;
2693         }
2694         *mask |= 1 << index;
2695
2696         spin_unlock_irqrestore(&ohci->lock, flags);
2697
2698         return ERR_PTR(ret);
2699 }
2700
2701 static int ohci_start_iso(struct fw_iso_context *base,
2702                           s32 cycle, u32 sync, u32 tags)
2703 {
2704         struct iso_context *ctx = container_of(base, struct iso_context, base);
2705         struct fw_ohci *ohci = ctx->context.ohci;
2706         u32 control = IR_CONTEXT_ISOCH_HEADER, match;
2707         int index;
2708
2709         switch (ctx->base.type) {
2710         case FW_ISO_CONTEXT_TRANSMIT:
2711                 index = ctx - ohci->it_context_list;
2712                 match = 0;
2713                 if (cycle >= 0)
2714                         match = IT_CONTEXT_CYCLE_MATCH_ENABLE |
2715                                 (cycle & 0x7fff) << 16;
2716
2717                 reg_write(ohci, OHCI1394_IsoXmitIntEventClear, 1 << index);
2718                 reg_write(ohci, OHCI1394_IsoXmitIntMaskSet, 1 << index);
2719                 context_run(&ctx->context, match);
2720                 break;
2721
2722         case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2723                 control |= IR_CONTEXT_BUFFER_FILL|IR_CONTEXT_MULTI_CHANNEL_MODE;
2724                 /* fall through */
2725         case FW_ISO_CONTEXT_RECEIVE:
2726                 index = ctx - ohci->ir_context_list;
2727                 match = (tags << 28) | (sync << 8) | ctx->base.channel;
2728                 if (cycle >= 0) {
2729                         match |= (cycle & 0x07fff) << 12;
2730                         control |= IR_CONTEXT_CYCLE_MATCH_ENABLE;
2731                 }
2732
2733                 reg_write(ohci, OHCI1394_IsoRecvIntEventClear, 1 << index);
2734                 reg_write(ohci, OHCI1394_IsoRecvIntMaskSet, 1 << index);
2735                 reg_write(ohci, CONTEXT_MATCH(ctx->context.regs), match);
2736                 context_run(&ctx->context, control);
2737
2738                 ctx->sync = sync;
2739                 ctx->tags = tags;
2740
2741                 break;
2742         }
2743
2744         return 0;
2745 }
2746
2747 static int ohci_stop_iso(struct fw_iso_context *base)
2748 {
2749         struct fw_ohci *ohci = fw_ohci(base->card);
2750         struct iso_context *ctx = container_of(base, struct iso_context, base);
2751         int index;
2752
2753         switch (ctx->base.type) {
2754         case FW_ISO_CONTEXT_TRANSMIT:
2755                 index = ctx - ohci->it_context_list;
2756                 reg_write(ohci, OHCI1394_IsoXmitIntMaskClear, 1 << index);
2757                 break;
2758
2759         case FW_ISO_CONTEXT_RECEIVE:
2760         case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2761                 index = ctx - ohci->ir_context_list;
2762                 reg_write(ohci, OHCI1394_IsoRecvIntMaskClear, 1 << index);
2763                 break;
2764         }
2765         flush_writes(ohci);
2766         context_stop(&ctx->context);
2767
2768         return 0;
2769 }
2770
2771 static void ohci_free_iso_context(struct fw_iso_context *base)
2772 {
2773         struct fw_ohci *ohci = fw_ohci(base->card);
2774         struct iso_context *ctx = container_of(base, struct iso_context, base);
2775         unsigned long flags;
2776         int index;
2777
2778         ohci_stop_iso(base);
2779         context_release(&ctx->context);
2780         free_page((unsigned long)ctx->header);
2781
2782         spin_lock_irqsave(&ohci->lock, flags);
2783
2784         switch (base->type) {
2785         case FW_ISO_CONTEXT_TRANSMIT:
2786                 index = ctx - ohci->it_context_list;
2787                 ohci->it_context_mask |= 1 << index;
2788                 break;
2789
2790         case FW_ISO_CONTEXT_RECEIVE:
2791                 index = ctx - ohci->ir_context_list;
2792                 ohci->ir_context_mask |= 1 << index;
2793                 ohci->ir_context_channels |= 1ULL << base->channel;
2794                 break;
2795
2796         case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2797                 index = ctx - ohci->ir_context_list;
2798                 ohci->ir_context_mask |= 1 << index;
2799                 ohci->ir_context_channels |= ohci->mc_channels;
2800                 ohci->mc_channels = 0;
2801                 ohci->mc_allocated = false;
2802                 break;
2803         }
2804
2805         spin_unlock_irqrestore(&ohci->lock, flags);
2806 }
2807
2808 static int ohci_set_iso_channels(struct fw_iso_context *base, u64 *channels)
2809 {
2810         struct fw_ohci *ohci = fw_ohci(base->card);
2811         unsigned long flags;
2812         int ret;
2813
2814         switch (base->type) {
2815         case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
2816
2817                 spin_lock_irqsave(&ohci->lock, flags);
2818
2819                 /* Don't allow multichannel to grab other contexts' channels. */
2820                 if (~ohci->ir_context_channels & ~ohci->mc_channels & *channels) {
2821                         *channels = ohci->ir_context_channels;
2822                         ret = -EBUSY;
2823                 } else {
2824                         set_multichannel_mask(ohci, *channels);
2825                         ret = 0;
2826                 }
2827
2828                 spin_unlock_irqrestore(&ohci->lock, flags);
2829
2830                 break;
2831         default:
2832                 ret = -EINVAL;
2833         }
2834
2835         return ret;
2836 }
2837
2838 #ifdef CONFIG_PM
2839 static void ohci_resume_iso_dma(struct fw_ohci *ohci)
2840 {
2841         int i;
2842         struct iso_context *ctx;
2843
2844         for (i = 0 ; i < ohci->n_ir ; i++) {
2845                 ctx = &ohci->ir_context_list[i];
2846                 if (ctx->context.running)
2847                         ohci_start_iso(&ctx->base, 0, ctx->sync, ctx->tags);
2848         }
2849
2850         for (i = 0 ; i < ohci->n_it ; i++) {
2851                 ctx = &ohci->it_context_list[i];
2852                 if (ctx->context.running)
2853                         ohci_start_iso(&ctx->base, 0, ctx->sync, ctx->tags);
2854         }
2855 }
2856 #endif
2857
2858 static int queue_iso_transmit(struct iso_context *ctx,
2859                               struct fw_iso_packet *packet,
2860                               struct fw_iso_buffer *buffer,
2861                               unsigned long payload)
2862 {
2863         struct descriptor *d, *last, *pd;
2864         struct fw_iso_packet *p;
2865         __le32 *header;
2866         dma_addr_t d_bus, page_bus;
2867         u32 z, header_z, payload_z, irq;
2868         u32 payload_index, payload_end_index, next_page_index;
2869         int page, end_page, i, length, offset;
2870
2871         p = packet;
2872         payload_index = payload;
2873
2874         if (p->skip)
2875                 z = 1;
2876         else
2877                 z = 2;
2878         if (p->header_length > 0)
2879                 z++;
2880
2881         /* Determine the first page the payload isn't contained in. */
2882         end_page = PAGE_ALIGN(payload_index + p->payload_length) >> PAGE_SHIFT;
2883         if (p->payload_length > 0)
2884                 payload_z = end_page - (payload_index >> PAGE_SHIFT);
2885         else
2886                 payload_z = 0;
2887
2888         z += payload_z;
2889
2890         /* Get header size in number of descriptors. */
2891         header_z = DIV_ROUND_UP(p->header_length, sizeof(*d));
2892
2893         d = context_get_descriptors(&ctx->context, z + header_z, &d_bus);
2894         if (d == NULL)
2895                 return -ENOMEM;
2896
2897         if (!p->skip) {
2898                 d[0].control   = cpu_to_le16(DESCRIPTOR_KEY_IMMEDIATE);
2899                 d[0].req_count = cpu_to_le16(8);
2900                 /*
2901                  * Link the skip address to this descriptor itself.  This causes
2902                  * a context to skip a cycle whenever lost cycles or FIFO
2903                  * overruns occur, without dropping the data.  The application
2904                  * should then decide whether this is an error condition or not.
2905                  * FIXME:  Make the context's cycle-lost behaviour configurable?
2906                  */
2907                 d[0].branch_address = cpu_to_le32(d_bus | z);
2908
2909                 header = (__le32 *) &d[1];
2910                 header[0] = cpu_to_le32(IT_HEADER_SY(p->sy) |
2911                                         IT_HEADER_TAG(p->tag) |
2912                                         IT_HEADER_TCODE(TCODE_STREAM_DATA) |
2913                                         IT_HEADER_CHANNEL(ctx->base.channel) |
2914                                         IT_HEADER_SPEED(ctx->base.speed));
2915                 header[1] =
2916                         cpu_to_le32(IT_HEADER_DATA_LENGTH(p->header_length +
2917                                                           p->payload_length));
2918         }
2919
2920         if (p->header_length > 0) {
2921                 d[2].req_count    = cpu_to_le16(p->header_length);
2922                 d[2].data_address = cpu_to_le32(d_bus + z * sizeof(*d));
2923                 memcpy(&d[z], p->header, p->header_length);
2924         }
2925
2926         pd = d + z - payload_z;
2927         payload_end_index = payload_index + p->payload_length;
2928         for (i = 0; i < payload_z; i++) {
2929                 page               = payload_index >> PAGE_SHIFT;
2930                 offset             = payload_index & ~PAGE_MASK;
2931                 next_page_index    = (page + 1) << PAGE_SHIFT;
2932                 length             =
2933                         min(next_page_index, payload_end_index) - payload_index;
2934                 pd[i].req_count    = cpu_to_le16(length);
2935
2936                 page_bus = page_private(buffer->pages[page]);
2937                 pd[i].data_address = cpu_to_le32(page_bus + offset);
2938
2939                 payload_index += length;
2940         }
2941
2942         if (p->interrupt)
2943                 irq = DESCRIPTOR_IRQ_ALWAYS;
2944         else
2945                 irq = DESCRIPTOR_NO_IRQ;
2946
2947         last = z == 2 ? d : d + z - 1;
2948         last->control |= cpu_to_le16(DESCRIPTOR_OUTPUT_LAST |
2949                                      DESCRIPTOR_STATUS |
2950                                      DESCRIPTOR_BRANCH_ALWAYS |
2951                                      irq);
2952
2953         context_append(&ctx->context, d, z, header_z);
2954
2955         return 0;
2956 }
2957
2958 static int queue_iso_packet_per_buffer(struct iso_context *ctx,
2959                                        struct fw_iso_packet *packet,
2960                                        struct fw_iso_buffer *buffer,
2961                                        unsigned long payload)
2962 {
2963         struct descriptor *d, *pd;
2964         dma_addr_t d_bus, page_bus;
2965         u32 z, header_z, rest;
2966         int i, j, length;
2967         int page, offset, packet_count, header_size, payload_per_buffer;
2968
2969         /*
2970          * The OHCI controller puts the isochronous header and trailer in the
2971          * buffer, so we need at least 8 bytes.
2972          */
2973         packet_count = packet->header_length / ctx->base.header_size;
2974         header_size  = max(ctx->base.header_size, (size_t)8);
2975
2976         /* Get header size in number of descriptors. */
2977         header_z = DIV_ROUND_UP(header_size, sizeof(*d));
2978         page     = payload >> PAGE_SHIFT;
2979         offset   = payload & ~PAGE_MASK;
2980         payload_per_buffer = packet->payload_length / packet_count;
2981
2982         for (i = 0; i < packet_count; i++) {
2983                 /* d points to the header descriptor */
2984                 z = DIV_ROUND_UP(payload_per_buffer + offset, PAGE_SIZE) + 1;
2985                 d = context_get_descriptors(&ctx->context,
2986                                 z + header_z, &d_bus);
2987                 if (d == NULL)
2988                         return -ENOMEM;
2989
2990                 d->control      = cpu_to_le16(DESCRIPTOR_STATUS |
2991                                               DESCRIPTOR_INPUT_MORE);
2992                 if (packet->skip && i == 0)
2993                         d->control |= cpu_to_le16(DESCRIPTOR_WAIT);
2994                 d->req_count    = cpu_to_le16(header_size);
2995                 d->res_count    = d->req_count;
2996                 d->transfer_status = 0;
2997                 d->data_address = cpu_to_le32(d_bus + (z * sizeof(*d)));
2998
2999                 rest = payload_per_buffer;
3000                 pd = d;
3001                 for (j = 1; j < z; j++) {
3002                         pd++;
3003                         pd->control = cpu_to_le16(DESCRIPTOR_STATUS |
3004                                                   DESCRIPTOR_INPUT_MORE);
3005
3006                         if (offset + rest < PAGE_SIZE)
3007                                 length = rest;
3008                         else
3009                                 length = PAGE_SIZE - offset;
3010                         pd->req_count = cpu_to_le16(length);
3011                         pd->res_count = pd->req_count;
3012                         pd->transfer_status = 0;
3013
3014                         page_bus = page_private(buffer->pages[page]);
3015                         pd->data_address = cpu_to_le32(page_bus + offset);
3016
3017                         offset = (offset + length) & ~PAGE_MASK;
3018                         rest -= length;
3019                         if (offset == 0)
3020                                 page++;
3021                 }
3022                 pd->control = cpu_to_le16(DESCRIPTOR_STATUS |
3023                                           DESCRIPTOR_INPUT_LAST |
3024                                           DESCRIPTOR_BRANCH_ALWAYS);
3025                 if (packet->interrupt && i == packet_count - 1)
3026                         pd->control |= cpu_to_le16(DESCRIPTOR_IRQ_ALWAYS);
3027
3028                 context_append(&ctx->context, d, z, header_z);
3029         }
3030
3031         return 0;
3032 }
3033
3034 static int queue_iso_buffer_fill(struct iso_context *ctx,
3035                                  struct fw_iso_packet *packet,
3036                                  struct fw_iso_buffer *buffer,
3037                                  unsigned long payload)
3038 {
3039         struct descriptor *d;
3040         dma_addr_t d_bus, page_bus;
3041         int page, offset, rest, z, i, length;
3042
3043         page   = payload >> PAGE_SHIFT;
3044         offset = payload & ~PAGE_MASK;
3045         rest   = packet->payload_length;
3046
3047         /* We need one descriptor for each page in the buffer. */
3048         z = DIV_ROUND_UP(offset + rest, PAGE_SIZE);
3049
3050         if (WARN_ON(offset & 3 || rest & 3 || page + z > buffer->page_count))
3051                 return -EFAULT;
3052
3053         for (i = 0; i < z; i++) {
3054                 d = context_get_descriptors(&ctx->context, 1, &d_bus);
3055                 if (d == NULL)
3056                         return -ENOMEM;
3057
3058                 d->control = cpu_to_le16(DESCRIPTOR_INPUT_MORE |
3059                                          DESCRIPTOR_BRANCH_ALWAYS);
3060                 if (packet->skip && i == 0)
3061                         d->control |= cpu_to_le16(DESCRIPTOR_WAIT);
3062                 if (packet->interrupt && i == z - 1)
3063                         d->control |= cpu_to_le16(DESCRIPTOR_IRQ_ALWAYS);
3064
3065                 if (offset + rest < PAGE_SIZE)
3066                         length = rest;
3067                 else
3068                         length = PAGE_SIZE - offset;
3069                 d->req_count = cpu_to_le16(length);
3070                 d->res_count = d->req_count;
3071                 d->transfer_status = 0;
3072
3073                 page_bus = page_private(buffer->pages[page]);
3074                 d->data_address = cpu_to_le32(page_bus + offset);
3075
3076                 rest -= length;
3077                 offset = 0;
3078                 page++;
3079
3080                 context_append(&ctx->context, d, 1, 0);
3081         }
3082
3083         return 0;
3084 }
3085
3086 static int ohci_queue_iso(struct fw_iso_context *base,
3087                           struct fw_iso_packet *packet,
3088                           struct fw_iso_buffer *buffer,
3089                           unsigned long payload)
3090 {
3091         struct iso_context *ctx = container_of(base, struct iso_context, base);
3092         unsigned long flags;
3093         int ret = -ENOSYS;
3094
3095         spin_lock_irqsave(&ctx->context.ohci->lock, flags);
3096         switch (base->type) {
3097         case FW_ISO_CONTEXT_TRANSMIT:
3098                 ret = queue_iso_transmit(ctx, packet, buffer, payload);
3099                 break;
3100         case FW_ISO_CONTEXT_RECEIVE:
3101                 ret = queue_iso_packet_per_buffer(ctx, packet, buffer, payload);
3102                 break;
3103         case FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL:
3104                 ret = queue_iso_buffer_fill(ctx, packet, buffer, payload);
3105                 break;
3106         }
3107         spin_unlock_irqrestore(&ctx->context.ohci->lock, flags);
3108
3109         return ret;
3110 }
3111
3112 static const struct fw_card_driver ohci_driver = {
3113         .enable                 = ohci_enable,
3114         .read_phy_reg           = ohci_read_phy_reg,
3115         .update_phy_reg         = ohci_update_phy_reg,
3116         .set_config_rom         = ohci_set_config_rom,
3117         .send_request           = ohci_send_request,
3118         .send_response          = ohci_send_response,
3119         .cancel_packet          = ohci_cancel_packet,
3120         .enable_phys_dma        = ohci_enable_phys_dma,
3121         .read_csr               = ohci_read_csr,
3122         .write_csr              = ohci_write_csr,
3123
3124         .allocate_iso_context   = ohci_allocate_iso_context,
3125         .free_iso_context       = ohci_free_iso_context,
3126         .set_iso_channels       = ohci_set_iso_channels,
3127         .queue_iso              = ohci_queue_iso,
3128         .start_iso              = ohci_start_iso,
3129         .stop_iso               = ohci_stop_iso,
3130 };
3131
3132 #ifdef CONFIG_PPC_PMAC
3133 static void pmac_ohci_on(struct pci_dev *dev)
3134 {
3135         if (machine_is(powermac)) {
3136                 struct device_node *ofn = pci_device_to_OF_node(dev);
3137
3138                 if (ofn) {
3139                         pmac_call_feature(PMAC_FTR_1394_CABLE_POWER, ofn, 0, 1);
3140                         pmac_call_feature(PMAC_FTR_1394_ENABLE, ofn, 0, 1);
3141                 }
3142         }
3143 }
3144
3145 static void pmac_ohci_off(struct pci_dev *dev)
3146 {
3147         if (machine_is(powermac)) {
3148                 struct device_node *ofn = pci_device_to_OF_node(dev);
3149
3150                 if (ofn) {
3151                         pmac_call_feature(PMAC_FTR_1394_ENABLE, ofn, 0, 0);
3152                         pmac_call_feature(PMAC_FTR_1394_CABLE_POWER, ofn, 0, 0);
3153                 }
3154         }
3155 }
3156 #else
3157 static inline void pmac_ohci_on(struct pci_dev *dev) {}
3158 static inline void pmac_ohci_off(struct pci_dev *dev) {}
3159 #endif /* CONFIG_PPC_PMAC */
3160
3161 static int __devinit pci_probe(struct pci_dev *dev,
3162                                const struct pci_device_id *ent)
3163 {
3164         struct fw_ohci *ohci;
3165         u32 bus_options, max_receive, link_speed, version;
3166         u64 guid;
3167         int i, err;
3168         size_t size;
3169
3170         ohci = kzalloc(sizeof(*ohci), GFP_KERNEL);
3171         if (ohci == NULL) {
3172                 err = -ENOMEM;
3173                 goto fail;
3174         }
3175
3176         fw_card_initialize(&ohci->card, &ohci_driver, &dev->dev);
3177
3178         pmac_ohci_on(dev);
3179
3180         err = pci_enable_device(dev);
3181         if (err) {
3182                 fw_error("Failed to enable OHCI hardware\n");
3183                 goto fail_free;
3184         }
3185
3186         pci_set_master(dev);
3187         pci_write_config_dword(dev, OHCI1394_PCI_HCI_Control, 0);
3188         pci_set_drvdata(dev, ohci);
3189
3190         spin_lock_init(&ohci->lock);
3191         mutex_init(&ohci->phy_reg_mutex);
3192
3193         tasklet_init(&ohci->bus_reset_tasklet,
3194                      bus_reset_tasklet, (unsigned long)ohci);
3195
3196         err = pci_request_region(dev, 0, ohci_driver_name);
3197         if (err) {
3198                 fw_error("MMIO resource unavailable\n");
3199                 goto fail_disable;
3200         }
3201
3202         ohci->registers = pci_iomap(dev, 0, OHCI1394_REGISTER_SIZE);
3203         if (ohci->registers == NULL) {
3204                 fw_error("Failed to remap registers\n");
3205                 err = -ENXIO;
3206                 goto fail_iomem;
3207         }
3208
3209         for (i = 0; i < ARRAY_SIZE(ohci_quirks); i++)
3210                 if ((ohci_quirks[i].vendor == dev->vendor) &&
3211                     (ohci_quirks[i].device == (unsigned short)PCI_ANY_ID ||
3212                      ohci_quirks[i].device == dev->device) &&
3213                     (ohci_quirks[i].revision == (unsigned short)PCI_ANY_ID ||
3214                      ohci_quirks[i].revision >= dev->revision)) {
3215                         ohci->quirks = ohci_quirks[i].flags;
3216                         break;
3217                 }
3218         if (param_quirks)
3219                 ohci->quirks = param_quirks;
3220
3221         /*
3222          * Because dma_alloc_coherent() allocates at least one page,
3223          * we save space by using a common buffer for the AR request/
3224          * response descriptors and the self IDs buffer.
3225          */
3226         BUILD_BUG_ON(AR_BUFFERS * sizeof(struct descriptor) > PAGE_SIZE/4);
3227         BUILD_BUG_ON(SELF_ID_BUF_SIZE > PAGE_SIZE/2);
3228         ohci->misc_buffer = dma_alloc_coherent(ohci->card.device,
3229                                                PAGE_SIZE,
3230                                                &ohci->misc_buffer_bus,
3231                                                GFP_KERNEL);
3232         if (!ohci->misc_buffer) {
3233                 err = -ENOMEM;
3234                 goto fail_iounmap;
3235         }
3236
3237         err = ar_context_init(&ohci->ar_request_ctx, ohci, 0,
3238                               OHCI1394_AsReqRcvContextControlSet);
3239         if (err < 0)
3240                 goto fail_misc_buf;
3241
3242         err = ar_context_init(&ohci->ar_response_ctx, ohci, PAGE_SIZE/4,
3243                               OHCI1394_AsRspRcvContextControlSet);
3244         if (err < 0)
3245                 goto fail_arreq_ctx;
3246
3247         err = context_init(&ohci->at_request_ctx, ohci,
3248                            OHCI1394_AsReqTrContextControlSet, handle_at_packet);
3249         if (err < 0)
3250                 goto fail_arrsp_ctx;
3251
3252         err = context_init(&ohci->at_response_ctx, ohci,
3253                            OHCI1394_AsRspTrContextControlSet, handle_at_packet);
3254         if (err < 0)
3255                 goto fail_atreq_ctx;
3256
3257         reg_write(ohci, OHCI1394_IsoRecvIntMaskSet, ~0);
3258         ohci->ir_context_channels = ~0ULL;
3259         ohci->ir_context_support = reg_read(ohci, OHCI1394_IsoRecvIntMaskSet);
3260         reg_write(ohci, OHCI1394_IsoRecvIntMaskClear, ~0);
3261         ohci->ir_context_mask = ohci->ir_context_support;
3262         ohci->n_ir = hweight32(ohci->ir_context_mask);
3263         size = sizeof(struct iso_context) * ohci->n_ir;
3264         ohci->ir_context_list = kzalloc(size, GFP_KERNEL);
3265
3266         reg_write(ohci, OHCI1394_IsoXmitIntMaskSet, ~0);
3267         ohci->it_context_support = reg_read(ohci, OHCI1394_IsoXmitIntMaskSet);
3268         reg_write(ohci, OHCI1394_IsoXmitIntMaskClear, ~0);
3269         ohci->it_context_mask = ohci->it_context_support;
3270         ohci->n_it = hweight32(ohci->it_context_mask);
3271         size = sizeof(struct iso_context) * ohci->n_it;
3272         ohci->it_context_list = kzalloc(size, GFP_KERNEL);
3273
3274         if (ohci->it_context_list == NULL || ohci->ir_context_list == NULL) {
3275                 err = -ENOMEM;
3276                 goto fail_contexts;
3277         }
3278
3279         ohci->self_id_cpu = ohci->misc_buffer     + PAGE_SIZE/2;
3280         ohci->self_id_bus = ohci->misc_buffer_bus + PAGE_SIZE/2;
3281
3282         bus_options = reg_read(ohci, OHCI1394_BusOptions);
3283         max_receive = (bus_options >> 12) & 0xf;
3284         link_speed = bus_options & 0x7;
3285         guid = ((u64) reg_read(ohci, OHCI1394_GUIDHi) << 32) |
3286                 reg_read(ohci, OHCI1394_GUIDLo);
3287
3288         err = fw_card_add(&ohci->card, max_receive, link_speed, guid);
3289         if (err)
3290                 goto fail_contexts;
3291
3292         version = reg_read(ohci, OHCI1394_Version) & 0x00ff00ff;
3293         fw_notify("Added fw-ohci device %s, OHCI v%x.%x, "
3294                   "%d IR + %d IT contexts, quirks 0x%x\n",
3295                   dev_name(&dev->dev), version >> 16, version & 0xff,
3296                   ohci->n_ir, ohci->n_it, ohci->quirks);
3297
3298         return 0;
3299
3300  fail_contexts:
3301         kfree(ohci->ir_context_list);
3302         kfree(ohci->it_context_list);
3303         context_release(&ohci->at_response_ctx);
3304  fail_atreq_ctx:
3305         context_release(&ohci->at_request_ctx);
3306  fail_arrsp_ctx:
3307         ar_context_release(&ohci->ar_response_ctx);
3308  fail_arreq_ctx:
3309         ar_context_release(&ohci->ar_request_ctx);
3310  fail_misc_buf:
3311         dma_free_coherent(ohci->card.device, PAGE_SIZE,
3312                           ohci->misc_buffer, ohci->misc_buffer_bus);
3313  fail_iounmap:
3314         pci_iounmap(dev, ohci->registers);
3315  fail_iomem:
3316         pci_release_region(dev, 0);
3317  fail_disable:
3318         pci_disable_device(dev);
3319  fail_free:
3320         kfree(&ohci->card);
3321         pmac_ohci_off(dev);
3322  fail:
3323         if (err == -ENOMEM)
3324                 fw_error("Out of memory\n");
3325
3326         return err;
3327 }
3328
3329 static void pci_remove(struct pci_dev *dev)
3330 {
3331         struct fw_ohci *ohci;
3332
3333         ohci = pci_get_drvdata(dev);
3334         reg_write(ohci, OHCI1394_IntMaskClear, ~0);
3335         flush_writes(ohci);
3336         fw_core_remove_card(&ohci->card);
3337
3338         /*
3339          * FIXME: Fail all pending packets here, now that the upper
3340          * layers can't queue any more.
3341          */
3342
3343         software_reset(ohci);
3344         free_irq(dev->irq, ohci);
3345
3346         if (ohci->next_config_rom && ohci->next_config_rom != ohci->config_rom)
3347                 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
3348                                   ohci->next_config_rom, ohci->next_config_rom_bus);
3349         if (ohci->config_rom)
3350                 dma_free_coherent(ohci->card.device, CONFIG_ROM_SIZE,
3351                                   ohci->config_rom, ohci->config_rom_bus);
3352         ar_context_release(&ohci->ar_request_ctx);
3353         ar_context_release(&ohci->ar_response_ctx);
3354         dma_free_coherent(ohci->card.device, PAGE_SIZE,
3355                           ohci->misc_buffer, ohci->misc_buffer_bus);
3356         context_release(&ohci->at_request_ctx);
3357         context_release(&ohci->at_response_ctx);
3358         kfree(ohci->it_context_list);
3359         kfree(ohci->ir_context_list);
3360         pci_disable_msi(dev);
3361         pci_iounmap(dev, ohci->registers);
3362         pci_release_region(dev, 0);
3363         pci_disable_device(dev);
3364         kfree(&ohci->card);
3365         pmac_ohci_off(dev);
3366
3367         fw_notify("Removed fw-ohci device.\n");
3368 }
3369
3370 #ifdef CONFIG_PM
3371 static int pci_suspend(struct pci_dev *dev, pm_message_t state)
3372 {
3373         struct fw_ohci *ohci = pci_get_drvdata(dev);
3374         int err;
3375
3376         software_reset(ohci);
3377         free_irq(dev->irq, ohci);
3378         pci_disable_msi(dev);
3379         err = pci_save_state(dev);
3380         if (err) {
3381                 fw_error("pci_save_state failed\n");
3382                 return err;
3383         }
3384         err = pci_set_power_state(dev, pci_choose_state(dev, state));
3385         if (err)
3386                 fw_error("pci_set_power_state failed with %d\n", err);
3387         pmac_ohci_off(dev);
3388
3389         return 0;
3390 }
3391
3392 static int pci_resume(struct pci_dev *dev)
3393 {
3394         struct fw_ohci *ohci = pci_get_drvdata(dev);
3395         int err;
3396
3397         pmac_ohci_on(dev);
3398         pci_set_power_state(dev, PCI_D0);
3399         pci_restore_state(dev);
3400         err = pci_enable_device(dev);
3401         if (err) {
3402                 fw_error("pci_enable_device failed\n");
3403                 return err;
3404         }
3405
3406         /* Some systems don't setup GUID register on resume from ram  */
3407         if (!reg_read(ohci, OHCI1394_GUIDLo) &&
3408                                         !reg_read(ohci, OHCI1394_GUIDHi)) {
3409                 reg_write(ohci, OHCI1394_GUIDLo, (u32)ohci->card.guid);
3410                 reg_write(ohci, OHCI1394_GUIDHi, (u32)(ohci->card.guid >> 32));
3411         }
3412
3413         err = ohci_enable(&ohci->card, NULL, 0);
3414         if (err)
3415                 return err;
3416
3417         ohci_resume_iso_dma(ohci);
3418
3419         return 0;
3420 }
3421 #endif
3422
3423 static const struct pci_device_id pci_table[] = {
3424         { PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_FIREWIRE_OHCI, ~0) },
3425         { }
3426 };
3427
3428 MODULE_DEVICE_TABLE(pci, pci_table);
3429
3430 static struct pci_driver fw_ohci_pci_driver = {
3431         .name           = ohci_driver_name,
3432         .id_table       = pci_table,
3433         .probe          = pci_probe,
3434         .remove         = pci_remove,
3435 #ifdef CONFIG_PM
3436         .resume         = pci_resume,
3437         .suspend        = pci_suspend,
3438 #endif
3439 };
3440
3441 MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
3442 MODULE_DESCRIPTION("Driver for PCI OHCI IEEE1394 controllers");
3443 MODULE_LICENSE("GPL");
3444
3445 /* Provide a module alias so root-on-sbp2 initrds don't break. */
3446 #ifndef CONFIG_IEEE1394_OHCI1394_MODULE
3447 MODULE_ALIAS("ohci1394");
3448 #endif
3449
3450 static int __init fw_ohci_init(void)
3451 {
3452         return pci_register_driver(&fw_ohci_pci_driver);
3453 }
3454
3455 static void __exit fw_ohci_cleanup(void)
3456 {
3457         pci_unregister_driver(&fw_ohci_pci_driver);
3458 }
3459
3460 module_init(fw_ohci_init);
3461 module_exit(fw_ohci_cleanup);