firewire: core: no need to track irq flags in bm_work
[linux-2.6.git] / drivers / firewire / core-card.c
1 /*
2  * Copyright (C) 2005-2007  Kristian Hoegsberg <krh@bitplanet.net>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17  */
18
19 #include <linux/bug.h>
20 #include <linux/completion.h>
21 #include <linux/crc-itu-t.h>
22 #include <linux/device.h>
23 #include <linux/errno.h>
24 #include <linux/firewire.h>
25 #include <linux/firewire-constants.h>
26 #include <linux/jiffies.h>
27 #include <linux/kernel.h>
28 #include <linux/kref.h>
29 #include <linux/list.h>
30 #include <linux/module.h>
31 #include <linux/mutex.h>
32 #include <linux/spinlock.h>
33 #include <linux/workqueue.h>
34
35 #include <asm/atomic.h>
36 #include <asm/byteorder.h>
37
38 #include "core.h"
39
40 int fw_compute_block_crc(__be32 *block)
41 {
42         int length;
43         u16 crc;
44
45         length = (be32_to_cpu(block[0]) >> 16) & 0xff;
46         crc = crc_itu_t(0, (u8 *)&block[1], length * 4);
47         *block |= cpu_to_be32(crc);
48
49         return length;
50 }
51
52 static DEFINE_MUTEX(card_mutex);
53 static LIST_HEAD(card_list);
54
55 static LIST_HEAD(descriptor_list);
56 static int descriptor_count;
57
58 static __be32 tmp_config_rom[256];
59 /* ROM header, bus info block, root dir header, capabilities = 7 quadlets */
60 static size_t config_rom_length = 1 + 4 + 1 + 1;
61
62 #define BIB_CRC(v)              ((v) <<  0)
63 #define BIB_CRC_LENGTH(v)       ((v) << 16)
64 #define BIB_INFO_LENGTH(v)      ((v) << 24)
65 #define BIB_BUS_NAME            0x31333934 /* "1394" */
66 #define BIB_LINK_SPEED(v)       ((v) <<  0)
67 #define BIB_GENERATION(v)       ((v) <<  4)
68 #define BIB_MAX_ROM(v)          ((v) <<  8)
69 #define BIB_MAX_RECEIVE(v)      ((v) << 12)
70 #define BIB_CYC_CLK_ACC(v)      ((v) << 16)
71 #define BIB_PMC                 ((1) << 27)
72 #define BIB_BMC                 ((1) << 28)
73 #define BIB_ISC                 ((1) << 29)
74 #define BIB_CMC                 ((1) << 30)
75 #define BIB_IRMC                ((1) << 31)
76 #define NODE_CAPABILITIES       0x0c0083c0 /* per IEEE 1394 clause 8.3.2.6.5.2 */
77
78 static void generate_config_rom(struct fw_card *card, __be32 *config_rom)
79 {
80         struct fw_descriptor *desc;
81         int i, j, k, length;
82
83         /*
84          * Initialize contents of config rom buffer.  On the OHCI
85          * controller, block reads to the config rom accesses the host
86          * memory, but quadlet read access the hardware bus info block
87          * registers.  That's just crack, but it means we should make
88          * sure the contents of bus info block in host memory matches
89          * the version stored in the OHCI registers.
90          */
91
92         config_rom[0] = cpu_to_be32(
93                 BIB_CRC_LENGTH(4) | BIB_INFO_LENGTH(4) | BIB_CRC(0));
94         config_rom[1] = cpu_to_be32(BIB_BUS_NAME);
95         config_rom[2] = cpu_to_be32(
96                 BIB_LINK_SPEED(card->link_speed) |
97                 BIB_GENERATION(card->config_rom_generation++ % 14 + 2) |
98                 BIB_MAX_ROM(2) |
99                 BIB_MAX_RECEIVE(card->max_receive) |
100                 BIB_BMC | BIB_ISC | BIB_CMC | BIB_IRMC);
101         config_rom[3] = cpu_to_be32(card->guid >> 32);
102         config_rom[4] = cpu_to_be32(card->guid);
103
104         /* Generate root directory. */
105         config_rom[6] = cpu_to_be32(NODE_CAPABILITIES);
106         i = 7;
107         j = 7 + descriptor_count;
108
109         /* Generate root directory entries for descriptors. */
110         list_for_each_entry (desc, &descriptor_list, link) {
111                 if (desc->immediate > 0)
112                         config_rom[i++] = cpu_to_be32(desc->immediate);
113                 config_rom[i] = cpu_to_be32(desc->key | (j - i));
114                 i++;
115                 j += desc->length;
116         }
117
118         /* Update root directory length. */
119         config_rom[5] = cpu_to_be32((i - 5 - 1) << 16);
120
121         /* End of root directory, now copy in descriptors. */
122         list_for_each_entry (desc, &descriptor_list, link) {
123                 for (k = 0; k < desc->length; k++)
124                         config_rom[i + k] = cpu_to_be32(desc->data[k]);
125                 i += desc->length;
126         }
127
128         /* Calculate CRCs for all blocks in the config rom.  This
129          * assumes that CRC length and info length are identical for
130          * the bus info block, which is always the case for this
131          * implementation. */
132         for (i = 0; i < j; i += length + 1)
133                 length = fw_compute_block_crc(config_rom + i);
134
135         WARN_ON(j != config_rom_length);
136 }
137
138 static void update_config_roms(void)
139 {
140         struct fw_card *card;
141
142         list_for_each_entry (card, &card_list, link) {
143                 generate_config_rom(card, tmp_config_rom);
144                 card->driver->set_config_rom(card, tmp_config_rom,
145                                              config_rom_length);
146         }
147 }
148
149 static size_t required_space(struct fw_descriptor *desc)
150 {
151         /* descriptor + entry into root dir + optional immediate entry */
152         return desc->length + 1 + (desc->immediate > 0 ? 1 : 0);
153 }
154
155 int fw_core_add_descriptor(struct fw_descriptor *desc)
156 {
157         size_t i;
158         int ret;
159
160         /*
161          * Check descriptor is valid; the length of all blocks in the
162          * descriptor has to add up to exactly the length of the
163          * block.
164          */
165         i = 0;
166         while (i < desc->length)
167                 i += (desc->data[i] >> 16) + 1;
168
169         if (i != desc->length)
170                 return -EINVAL;
171
172         mutex_lock(&card_mutex);
173
174         if (config_rom_length + required_space(desc) > 256) {
175                 ret = -EBUSY;
176         } else {
177                 list_add_tail(&desc->link, &descriptor_list);
178                 config_rom_length += required_space(desc);
179                 descriptor_count++;
180                 if (desc->immediate > 0)
181                         descriptor_count++;
182                 update_config_roms();
183                 ret = 0;
184         }
185
186         mutex_unlock(&card_mutex);
187
188         return ret;
189 }
190 EXPORT_SYMBOL(fw_core_add_descriptor);
191
192 void fw_core_remove_descriptor(struct fw_descriptor *desc)
193 {
194         mutex_lock(&card_mutex);
195
196         list_del(&desc->link);
197         config_rom_length -= required_space(desc);
198         descriptor_count--;
199         if (desc->immediate > 0)
200                 descriptor_count--;
201         update_config_roms();
202
203         mutex_unlock(&card_mutex);
204 }
205 EXPORT_SYMBOL(fw_core_remove_descriptor);
206
207 static void allocate_broadcast_channel(struct fw_card *card, int generation)
208 {
209         int channel, bandwidth = 0;
210
211         if (!card->broadcast_channel_allocated) {
212                 fw_iso_resource_manage(card, generation, 1ULL << 31,
213                                        &channel, &bandwidth, true,
214                                        card->bm_transaction_data);
215                 if (channel != 31) {
216                         fw_notify("failed to allocate broadcast channel\n");
217                         return;
218                 }
219                 card->broadcast_channel_allocated = true;
220         }
221
222         device_for_each_child(card->device, (void *)(long)generation,
223                               fw_device_set_broadcast_channel);
224 }
225
226 static const char gap_count_table[] = {
227         63, 5, 7, 8, 10, 13, 16, 18, 21, 24, 26, 29, 32, 35, 37, 40
228 };
229
230 void fw_schedule_bm_work(struct fw_card *card, unsigned long delay)
231 {
232         fw_card_get(card);
233         if (!schedule_delayed_work(&card->work, delay))
234                 fw_card_put(card);
235 }
236
237 static void fw_card_bm_work(struct work_struct *work)
238 {
239         struct fw_card *card = container_of(work, struct fw_card, work.work);
240         struct fw_device *root_device;
241         struct fw_node *root_node;
242         int root_id, new_root_id, irm_id, local_id;
243         int gap_count, generation, grace, rcode;
244         bool do_reset = false;
245         bool root_device_is_running;
246         bool root_device_is_cmc;
247
248         spin_lock_irq(&card->lock);
249
250         if (card->local_node == NULL) {
251                 spin_unlock_irq(&card->lock);
252                 goto out_put_card;
253         }
254
255         generation = card->generation;
256         root_node = card->root_node;
257         fw_node_get(root_node);
258         root_device = root_node->data;
259         root_device_is_running = root_device &&
260                         atomic_read(&root_device->state) == FW_DEVICE_RUNNING;
261         root_device_is_cmc = root_device && root_device->cmc;
262         root_id  = root_node->node_id;
263         irm_id   = card->irm_node->node_id;
264         local_id = card->local_node->node_id;
265
266         grace = time_after(jiffies, card->reset_jiffies + DIV_ROUND_UP(HZ, 8));
267
268         if ((is_next_generation(generation, card->bm_generation) &&
269              !card->bm_abdicate) ||
270             (card->bm_generation != generation && grace)) {
271                 /*
272                  * This first step is to figure out who is IRM and
273                  * then try to become bus manager.  If the IRM is not
274                  * well defined (e.g. does not have an active link
275                  * layer or does not responds to our lock request, we
276                  * will have to do a little vigilante bus management.
277                  * In that case, we do a goto into the gap count logic
278                  * so that when we do the reset, we still optimize the
279                  * gap count.  That could well save a reset in the
280                  * next generation.
281                  */
282
283                 if (!card->irm_node->link_on) {
284                         new_root_id = local_id;
285                         fw_notify("IRM has link off, making local node (%02x) root.\n",
286                                   new_root_id);
287                         goto pick_me;
288                 }
289
290                 card->bm_transaction_data[0] = cpu_to_be32(0x3f);
291                 card->bm_transaction_data[1] = cpu_to_be32(local_id);
292
293                 spin_unlock_irq(&card->lock);
294
295                 rcode = fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
296                                 irm_id, generation, SCODE_100,
297                                 CSR_REGISTER_BASE + CSR_BUS_MANAGER_ID,
298                                 card->bm_transaction_data, 8);
299
300                 if (rcode == RCODE_GENERATION)
301                         /* Another bus reset, BM work has been rescheduled. */
302                         goto out;
303
304                 if (rcode == RCODE_COMPLETE &&
305                     card->bm_transaction_data[0] != cpu_to_be32(0x3f)) {
306
307                         /* Somebody else is BM.  Only act as IRM. */
308                         if (local_id == irm_id)
309                                 allocate_broadcast_channel(card, generation);
310
311                         goto out;
312                 }
313
314                 if (rcode == RCODE_SEND_ERROR) {
315                         /*
316                          * We have been unable to send the lock request due to
317                          * some local problem.  Let's try again later and hope
318                          * that the problem has gone away by then.
319                          */
320                         fw_schedule_bm_work(card, DIV_ROUND_UP(HZ, 8));
321                         goto out;
322                 }
323
324                 spin_lock_irq(&card->lock);
325
326                 if (rcode != RCODE_COMPLETE) {
327                         /*
328                          * The lock request failed, maybe the IRM
329                          * isn't really IRM capable after all. Let's
330                          * do a bus reset and pick the local node as
331                          * root, and thus, IRM.
332                          */
333                         new_root_id = local_id;
334                         fw_notify("BM lock failed, making local node (%02x) root.\n",
335                                   new_root_id);
336                         goto pick_me;
337                 }
338         } else if (card->bm_generation != generation) {
339                 /*
340                  * We weren't BM in the last generation, and the last
341                  * bus reset is less than 125ms ago.  Reschedule this job.
342                  */
343                 spin_unlock_irq(&card->lock);
344                 fw_schedule_bm_work(card, DIV_ROUND_UP(HZ, 8));
345                 goto out;
346         }
347
348         /*
349          * We're bus manager for this generation, so next step is to
350          * make sure we have an active cycle master and do gap count
351          * optimization.
352          */
353         card->bm_generation = generation;
354
355         if (root_device == NULL) {
356                 /*
357                  * Either link_on is false, or we failed to read the
358                  * config rom.  In either case, pick another root.
359                  */
360                 new_root_id = local_id;
361         } else if (!root_device_is_running) {
362                 /*
363                  * If we haven't probed this device yet, bail out now
364                  * and let's try again once that's done.
365                  */
366                 spin_unlock_irq(&card->lock);
367                 goto out;
368         } else if (root_device_is_cmc) {
369                 /*
370                  * We will send out a force root packet for this
371                  * node as part of the gap count optimization.
372                  */
373                 new_root_id = root_id;
374         } else {
375                 /*
376                  * Current root has an active link layer and we
377                  * successfully read the config rom, but it's not
378                  * cycle master capable.
379                  */
380                 new_root_id = local_id;
381         }
382
383  pick_me:
384         /*
385          * Pick a gap count from 1394a table E-1.  The table doesn't cover
386          * the typically much larger 1394b beta repeater delays though.
387          */
388         if (!card->beta_repeaters_present &&
389             root_node->max_hops < ARRAY_SIZE(gap_count_table))
390                 gap_count = gap_count_table[root_node->max_hops];
391         else
392                 gap_count = 63;
393
394         /*
395          * Finally, figure out if we should do a reset or not.  If we have
396          * done less than 5 resets with the same physical topology and we
397          * have either a new root or a new gap count setting, let's do it.
398          */
399
400         if (card->bm_retries++ < 5 &&
401             (card->gap_count != gap_count || new_root_id != root_id))
402                 do_reset = true;
403
404         spin_unlock_irq(&card->lock);
405
406         if (do_reset) {
407                 fw_notify("phy config: card %d, new root=%x, gap_count=%d\n",
408                           card->index, new_root_id, gap_count);
409                 fw_send_phy_config(card, new_root_id, generation, gap_count);
410                 fw_core_initiate_bus_reset(card, 1);
411                 /* Will allocate broadcast channel after the reset. */
412                 goto out;
413         }
414
415         if (root_device_is_cmc) {
416                 /*
417                  * Make sure that the cycle master sends cycle start packets.
418                  */
419                 card->bm_transaction_data[0] = cpu_to_be32(CSR_STATE_BIT_CMSTR);
420                 rcode = fw_run_transaction(card, TCODE_WRITE_QUADLET_REQUEST,
421                                 root_id, generation, SCODE_100,
422                                 CSR_REGISTER_BASE + CSR_STATE_SET,
423                                 card->bm_transaction_data, 4);
424                 if (rcode == RCODE_GENERATION)
425                         goto out;
426         }
427
428         if (local_id == irm_id)
429                 allocate_broadcast_channel(card, generation);
430
431  out:
432         fw_node_put(root_node);
433  out_put_card:
434         fw_card_put(card);
435 }
436
437 void fw_card_initialize(struct fw_card *card,
438                         const struct fw_card_driver *driver,
439                         struct device *device)
440 {
441         static atomic_t index = ATOMIC_INIT(-1);
442
443         card->index = atomic_inc_return(&index);
444         card->driver = driver;
445         card->device = device;
446         card->current_tlabel = 0;
447         card->tlabel_mask = 0;
448         card->split_timeout_hi = 0;
449         card->split_timeout_lo = 800 << 19;
450         card->split_timeout_cycles = 800;
451         card->split_timeout_jiffies = DIV_ROUND_UP(HZ, 10);
452         card->color = 0;
453         card->broadcast_channel = BROADCAST_CHANNEL_INITIAL;
454
455         kref_init(&card->kref);
456         init_completion(&card->done);
457         INIT_LIST_HEAD(&card->transaction_list);
458         spin_lock_init(&card->lock);
459
460         card->local_node = NULL;
461
462         INIT_DELAYED_WORK(&card->work, fw_card_bm_work);
463 }
464 EXPORT_SYMBOL(fw_card_initialize);
465
466 int fw_card_add(struct fw_card *card,
467                 u32 max_receive, u32 link_speed, u64 guid)
468 {
469         int ret;
470
471         card->max_receive = max_receive;
472         card->link_speed = link_speed;
473         card->guid = guid;
474
475         mutex_lock(&card_mutex);
476
477         generate_config_rom(card, tmp_config_rom);
478         ret = card->driver->enable(card, tmp_config_rom, config_rom_length);
479         if (ret == 0)
480                 list_add_tail(&card->link, &card_list);
481
482         mutex_unlock(&card_mutex);
483
484         return ret;
485 }
486 EXPORT_SYMBOL(fw_card_add);
487
488
489 /*
490  * The next few functions implement a dummy driver that is used once a card
491  * driver shuts down an fw_card.  This allows the driver to cleanly unload,
492  * as all IO to the card will be handled (and failed) by the dummy driver
493  * instead of calling into the module.  Only functions for iso context
494  * shutdown still need to be provided by the card driver.
495  */
496
497 static int dummy_enable(struct fw_card *card,
498                         const __be32 *config_rom, size_t length)
499 {
500         BUG();
501         return -1;
502 }
503
504 static int dummy_update_phy_reg(struct fw_card *card, int address,
505                                 int clear_bits, int set_bits)
506 {
507         return -ENODEV;
508 }
509
510 static int dummy_set_config_rom(struct fw_card *card,
511                                 const __be32 *config_rom, size_t length)
512 {
513         /*
514          * We take the card out of card_list before setting the dummy
515          * driver, so this should never get called.
516          */
517         BUG();
518         return -1;
519 }
520
521 static void dummy_send_request(struct fw_card *card, struct fw_packet *packet)
522 {
523         packet->callback(packet, card, -ENODEV);
524 }
525
526 static void dummy_send_response(struct fw_card *card, struct fw_packet *packet)
527 {
528         packet->callback(packet, card, -ENODEV);
529 }
530
531 static int dummy_cancel_packet(struct fw_card *card, struct fw_packet *packet)
532 {
533         return -ENOENT;
534 }
535
536 static int dummy_enable_phys_dma(struct fw_card *card,
537                                  int node_id, int generation)
538 {
539         return -ENODEV;
540 }
541
542 static const struct fw_card_driver dummy_driver_template = {
543         .enable          = dummy_enable,
544         .update_phy_reg  = dummy_update_phy_reg,
545         .set_config_rom  = dummy_set_config_rom,
546         .send_request    = dummy_send_request,
547         .cancel_packet   = dummy_cancel_packet,
548         .send_response   = dummy_send_response,
549         .enable_phys_dma = dummy_enable_phys_dma,
550 };
551
552 void fw_card_release(struct kref *kref)
553 {
554         struct fw_card *card = container_of(kref, struct fw_card, kref);
555
556         complete(&card->done);
557 }
558
559 void fw_core_remove_card(struct fw_card *card)
560 {
561         struct fw_card_driver dummy_driver = dummy_driver_template;
562
563         card->driver->update_phy_reg(card, 4,
564                                      PHY_LINK_ACTIVE | PHY_CONTENDER, 0);
565         fw_core_initiate_bus_reset(card, 1);
566
567         mutex_lock(&card_mutex);
568         list_del_init(&card->link);
569         mutex_unlock(&card_mutex);
570
571         /* Switch off most of the card driver interface. */
572         dummy_driver.free_iso_context   = card->driver->free_iso_context;
573         dummy_driver.stop_iso           = card->driver->stop_iso;
574         card->driver = &dummy_driver;
575
576         fw_destroy_nodes(card);
577
578         /* Wait for all users, especially device workqueue jobs, to finish. */
579         fw_card_put(card);
580         wait_for_completion(&card->done);
581
582         WARN_ON(!list_empty(&card->transaction_list));
583 }
584 EXPORT_SYMBOL(fw_core_remove_card);
585
586 int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset)
587 {
588         int reg = short_reset ? 5 : 1;
589         int bit = short_reset ? PHY_BUS_SHORT_RESET : PHY_BUS_RESET;
590
591         return card->driver->update_phy_reg(card, reg, 0, bit);
592 }
593 EXPORT_SYMBOL(fw_core_initiate_bus_reset);