Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394...
[linux-2.6] / drivers / firewire / fw-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/completion.h>
20 #include <linux/crc-itu-t.h>
21 #include <linux/delay.h>
22 #include <linux/device.h>
23 #include <linux/errno.h>
24 #include <linux/kref.h>
25 #include <linux/module.h>
26 #include <linux/mutex.h>
27
28 #include "fw-transaction.h"
29 #include "fw-topology.h"
30 #include "fw-device.h"
31
32 int fw_compute_block_crc(u32 *block)
33 {
34         __be32 be32_block[256];
35         int i, length;
36
37         length = (*block >> 16) & 0xff;
38         for (i = 0; i < length; i++)
39                 be32_block[i] = cpu_to_be32(block[i + 1]);
40         *block |= crc_itu_t(0, (u8 *) be32_block, length * 4);
41
42         return length;
43 }
44
45 static DEFINE_MUTEX(card_mutex);
46 static LIST_HEAD(card_list);
47
48 static LIST_HEAD(descriptor_list);
49 static int descriptor_count;
50
51 #define BIB_CRC(v)              ((v) <<  0)
52 #define BIB_CRC_LENGTH(v)       ((v) << 16)
53 #define BIB_INFO_LENGTH(v)      ((v) << 24)
54
55 #define BIB_LINK_SPEED(v)       ((v) <<  0)
56 #define BIB_GENERATION(v)       ((v) <<  4)
57 #define BIB_MAX_ROM(v)          ((v) <<  8)
58 #define BIB_MAX_RECEIVE(v)      ((v) << 12)
59 #define BIB_CYC_CLK_ACC(v)      ((v) << 16)
60 #define BIB_PMC                 ((1) << 27)
61 #define BIB_BMC                 ((1) << 28)
62 #define BIB_ISC                 ((1) << 29)
63 #define BIB_CMC                 ((1) << 30)
64 #define BIB_IMC                 ((1) << 31)
65
66 static u32 *
67 generate_config_rom(struct fw_card *card, size_t *config_rom_length)
68 {
69         struct fw_descriptor *desc;
70         static u32 config_rom[256];
71         int i, j, length;
72
73         /*
74          * Initialize contents of config rom buffer.  On the OHCI
75          * controller, block reads to the config rom accesses the host
76          * memory, but quadlet read access the hardware bus info block
77          * registers.  That's just crack, but it means we should make
78          * sure the contents of bus info block in host memory matches
79          * the version stored in the OHCI registers.
80          */
81
82         memset(config_rom, 0, sizeof(config_rom));
83         config_rom[0] = BIB_CRC_LENGTH(4) | BIB_INFO_LENGTH(4) | BIB_CRC(0);
84         config_rom[1] = 0x31333934;
85
86         config_rom[2] =
87                 BIB_LINK_SPEED(card->link_speed) |
88                 BIB_GENERATION(card->config_rom_generation++ % 14 + 2) |
89                 BIB_MAX_ROM(2) |
90                 BIB_MAX_RECEIVE(card->max_receive) |
91                 BIB_BMC | BIB_ISC | BIB_CMC | BIB_IMC;
92         config_rom[3] = card->guid >> 32;
93         config_rom[4] = card->guid;
94
95         /* Generate root directory. */
96         i = 5;
97         config_rom[i++] = 0;
98         config_rom[i++] = 0x0c0083c0; /* node capabilities */
99         j = i + descriptor_count;
100
101         /* Generate root directory entries for descriptors. */
102         list_for_each_entry (desc, &descriptor_list, link) {
103                 if (desc->immediate > 0)
104                         config_rom[i++] = desc->immediate;
105                 config_rom[i] = desc->key | (j - i);
106                 i++;
107                 j += desc->length;
108         }
109
110         /* Update root directory length. */
111         config_rom[5] = (i - 5 - 1) << 16;
112
113         /* End of root directory, now copy in descriptors. */
114         list_for_each_entry (desc, &descriptor_list, link) {
115                 memcpy(&config_rom[i], desc->data, desc->length * 4);
116                 i += desc->length;
117         }
118
119         /* Calculate CRCs for all blocks in the config rom.  This
120          * assumes that CRC length and info length are identical for
121          * the bus info block, which is always the case for this
122          * implementation. */
123         for (i = 0; i < j; i += length + 1)
124                 length = fw_compute_block_crc(config_rom + i);
125
126         *config_rom_length = j;
127
128         return config_rom;
129 }
130
131 static void
132 update_config_roms(void)
133 {
134         struct fw_card *card;
135         u32 *config_rom;
136         size_t length;
137
138         list_for_each_entry (card, &card_list, link) {
139                 config_rom = generate_config_rom(card, &length);
140                 card->driver->set_config_rom(card, config_rom, length);
141         }
142 }
143
144 int
145 fw_core_add_descriptor(struct fw_descriptor *desc)
146 {
147         size_t i;
148
149         /*
150          * Check descriptor is valid; the length of all blocks in the
151          * descriptor has to add up to exactly the length of the
152          * block.
153          */
154         i = 0;
155         while (i < desc->length)
156                 i += (desc->data[i] >> 16) + 1;
157
158         if (i != desc->length)
159                 return -EINVAL;
160
161         mutex_lock(&card_mutex);
162
163         list_add_tail(&desc->link, &descriptor_list);
164         descriptor_count++;
165         if (desc->immediate > 0)
166                 descriptor_count++;
167         update_config_roms();
168
169         mutex_unlock(&card_mutex);
170
171         return 0;
172 }
173
174 void
175 fw_core_remove_descriptor(struct fw_descriptor *desc)
176 {
177         mutex_lock(&card_mutex);
178
179         list_del(&desc->link);
180         descriptor_count--;
181         if (desc->immediate > 0)
182                 descriptor_count--;
183         update_config_roms();
184
185         mutex_unlock(&card_mutex);
186 }
187
188 static const char gap_count_table[] = {
189         63, 5, 7, 8, 10, 13, 16, 18, 21, 24, 26, 29, 32, 35, 37, 40
190 };
191
192 void
193 fw_schedule_bm_work(struct fw_card *card, unsigned long delay)
194 {
195         int scheduled;
196
197         fw_card_get(card);
198         scheduled = schedule_delayed_work(&card->work, delay);
199         if (!scheduled)
200                 fw_card_put(card);
201 }
202
203 static void
204 fw_card_bm_work(struct work_struct *work)
205 {
206         struct fw_card *card = container_of(work, struct fw_card, work.work);
207         struct fw_device *root_device;
208         struct fw_node *root_node, *local_node;
209         unsigned long flags;
210         int root_id, new_root_id, irm_id, gap_count, generation, grace, rcode;
211         bool do_reset = false;
212         bool root_device_is_running;
213         bool root_device_is_cmc;
214         __be32 lock_data[2];
215
216         spin_lock_irqsave(&card->lock, flags);
217         local_node = card->local_node;
218         root_node  = card->root_node;
219
220         if (local_node == NULL) {
221                 spin_unlock_irqrestore(&card->lock, flags);
222                 goto out_put_card;
223         }
224         fw_node_get(local_node);
225         fw_node_get(root_node);
226
227         generation = card->generation;
228         root_device = root_node->data;
229         root_device_is_running = root_device &&
230                         atomic_read(&root_device->state) == FW_DEVICE_RUNNING;
231         root_device_is_cmc = root_device && root_device->cmc;
232         root_id = root_node->node_id;
233         grace = time_after(jiffies, card->reset_jiffies + DIV_ROUND_UP(HZ, 10));
234
235         if (card->bm_generation + 1 == generation ||
236             (card->bm_generation != generation && grace)) {
237                 /*
238                  * This first step is to figure out who is IRM and
239                  * then try to become bus manager.  If the IRM is not
240                  * well defined (e.g. does not have an active link
241                  * layer or does not responds to our lock request, we
242                  * will have to do a little vigilante bus management.
243                  * In that case, we do a goto into the gap count logic
244                  * so that when we do the reset, we still optimize the
245                  * gap count.  That could well save a reset in the
246                  * next generation.
247                  */
248
249                 irm_id = card->irm_node->node_id;
250                 if (!card->irm_node->link_on) {
251                         new_root_id = local_node->node_id;
252                         fw_notify("IRM has link off, making local node (%02x) root.\n",
253                                   new_root_id);
254                         goto pick_me;
255                 }
256
257                 lock_data[0] = cpu_to_be32(0x3f);
258                 lock_data[1] = cpu_to_be32(local_node->node_id);
259
260                 spin_unlock_irqrestore(&card->lock, flags);
261
262                 rcode = fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
263                                 irm_id, generation, SCODE_100,
264                                 CSR_REGISTER_BASE + CSR_BUS_MANAGER_ID,
265                                 lock_data, sizeof(lock_data));
266
267                 if (rcode == RCODE_GENERATION)
268                         /* Another bus reset, BM work has been rescheduled. */
269                         goto out;
270
271                 if (rcode == RCODE_COMPLETE &&
272                     lock_data[0] != cpu_to_be32(0x3f))
273                         /* Somebody else is BM, let them do the work. */
274                         goto out;
275
276                 spin_lock_irqsave(&card->lock, flags);
277
278                 if (rcode != RCODE_COMPLETE) {
279                         /*
280                          * The lock request failed, maybe the IRM
281                          * isn't really IRM capable after all. Let's
282                          * do a bus reset and pick the local node as
283                          * root, and thus, IRM.
284                          */
285                         new_root_id = local_node->node_id;
286                         fw_notify("BM lock failed, making local node (%02x) root.\n",
287                                   new_root_id);
288                         goto pick_me;
289                 }
290         } else if (card->bm_generation != generation) {
291                 /*
292                  * OK, we weren't BM in the last generation, and it's
293                  * less than 100ms since last bus reset. Reschedule
294                  * this task 100ms from now.
295                  */
296                 spin_unlock_irqrestore(&card->lock, flags);
297                 fw_schedule_bm_work(card, DIV_ROUND_UP(HZ, 10));
298                 goto out;
299         }
300
301         /*
302          * We're bus manager for this generation, so next step is to
303          * make sure we have an active cycle master and do gap count
304          * optimization.
305          */
306         card->bm_generation = generation;
307
308         if (root_device == NULL) {
309                 /*
310                  * Either link_on is false, or we failed to read the
311                  * config rom.  In either case, pick another root.
312                  */
313                 new_root_id = local_node->node_id;
314         } else if (!root_device_is_running) {
315                 /*
316                  * If we haven't probed this device yet, bail out now
317                  * and let's try again once that's done.
318                  */
319                 spin_unlock_irqrestore(&card->lock, flags);
320                 goto out;
321         } else if (root_device_is_cmc) {
322                 /*
323                  * FIXME: I suppose we should set the cmstr bit in the
324                  * STATE_CLEAR register of this node, as described in
325                  * 1394-1995, 8.4.2.6.  Also, send out a force root
326                  * packet for this node.
327                  */
328                 new_root_id = root_id;
329         } else {
330                 /*
331                  * Current root has an active link layer and we
332                  * successfully read the config rom, but it's not
333                  * cycle master capable.
334                  */
335                 new_root_id = local_node->node_id;
336         }
337
338  pick_me:
339         /*
340          * Pick a gap count from 1394a table E-1.  The table doesn't cover
341          * the typically much larger 1394b beta repeater delays though.
342          */
343         if (!card->beta_repeaters_present &&
344             root_node->max_hops < ARRAY_SIZE(gap_count_table))
345                 gap_count = gap_count_table[root_node->max_hops];
346         else
347                 gap_count = 63;
348
349         /*
350          * Finally, figure out if we should do a reset or not.  If we have
351          * done less than 5 resets with the same physical topology and we
352          * have either a new root or a new gap count setting, let's do it.
353          */
354
355         if (card->bm_retries++ < 5 &&
356             (card->gap_count != gap_count || new_root_id != root_id))
357                 do_reset = true;
358
359         spin_unlock_irqrestore(&card->lock, flags);
360
361         if (do_reset) {
362                 fw_notify("phy config: card %d, new root=%x, gap_count=%d\n",
363                           card->index, new_root_id, gap_count);
364                 fw_send_phy_config(card, new_root_id, generation, gap_count);
365                 fw_core_initiate_bus_reset(card, 1);
366         }
367  out:
368         fw_node_put(root_node);
369         fw_node_put(local_node);
370  out_put_card:
371         fw_card_put(card);
372 }
373
374 static void
375 flush_timer_callback(unsigned long data)
376 {
377         struct fw_card *card = (struct fw_card *)data;
378
379         fw_flush_transactions(card);
380 }
381
382 void
383 fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver,
384                    struct device *device)
385 {
386         static atomic_t index = ATOMIC_INIT(-1);
387
388         card->index = atomic_inc_return(&index);
389         card->driver = driver;
390         card->device = device;
391         card->current_tlabel = 0;
392         card->tlabel_mask = 0;
393         card->color = 0;
394         card->broadcast_channel = BROADCAST_CHANNEL_INITIAL;
395
396         kref_init(&card->kref);
397         init_completion(&card->done);
398         INIT_LIST_HEAD(&card->transaction_list);
399         spin_lock_init(&card->lock);
400         setup_timer(&card->flush_timer,
401                     flush_timer_callback, (unsigned long)card);
402
403         card->local_node = NULL;
404
405         INIT_DELAYED_WORK(&card->work, fw_card_bm_work);
406 }
407 EXPORT_SYMBOL(fw_card_initialize);
408
409 int
410 fw_card_add(struct fw_card *card,
411             u32 max_receive, u32 link_speed, u64 guid)
412 {
413         u32 *config_rom;
414         size_t length;
415
416         card->max_receive = max_receive;
417         card->link_speed = link_speed;
418         card->guid = guid;
419
420         mutex_lock(&card_mutex);
421         config_rom = generate_config_rom(card, &length);
422         list_add_tail(&card->link, &card_list);
423         mutex_unlock(&card_mutex);
424
425         return card->driver->enable(card, config_rom, length);
426 }
427 EXPORT_SYMBOL(fw_card_add);
428
429
430 /*
431  * The next few functions implements a dummy driver that use once a
432  * card driver shuts down an fw_card.  This allows the driver to
433  * cleanly unload, as all IO to the card will be handled by the dummy
434  * driver instead of calling into the (possibly) unloaded module.  The
435  * dummy driver just fails all IO.
436  */
437
438 static int
439 dummy_enable(struct fw_card *card, u32 *config_rom, size_t length)
440 {
441         BUG();
442         return -1;
443 }
444
445 static int
446 dummy_update_phy_reg(struct fw_card *card, int address,
447                      int clear_bits, int set_bits)
448 {
449         return -ENODEV;
450 }
451
452 static int
453 dummy_set_config_rom(struct fw_card *card,
454                      u32 *config_rom, size_t length)
455 {
456         /*
457          * We take the card out of card_list before setting the dummy
458          * driver, so this should never get called.
459          */
460         BUG();
461         return -1;
462 }
463
464 static void
465 dummy_send_request(struct fw_card *card, struct fw_packet *packet)
466 {
467         packet->callback(packet, card, -ENODEV);
468 }
469
470 static void
471 dummy_send_response(struct fw_card *card, struct fw_packet *packet)
472 {
473         packet->callback(packet, card, -ENODEV);
474 }
475
476 static int
477 dummy_cancel_packet(struct fw_card *card, struct fw_packet *packet)
478 {
479         return -ENOENT;
480 }
481
482 static int
483 dummy_enable_phys_dma(struct fw_card *card,
484                       int node_id, int generation)
485 {
486         return -ENODEV;
487 }
488
489 static struct fw_card_driver dummy_driver = {
490         .enable          = dummy_enable,
491         .update_phy_reg  = dummy_update_phy_reg,
492         .set_config_rom  = dummy_set_config_rom,
493         .send_request    = dummy_send_request,
494         .cancel_packet   = dummy_cancel_packet,
495         .send_response   = dummy_send_response,
496         .enable_phys_dma = dummy_enable_phys_dma,
497 };
498
499 void
500 fw_card_release(struct kref *kref)
501 {
502         struct fw_card *card = container_of(kref, struct fw_card, kref);
503
504         complete(&card->done);
505 }
506
507 void
508 fw_core_remove_card(struct fw_card *card)
509 {
510         card->driver->update_phy_reg(card, 4,
511                                      PHY_LINK_ACTIVE | PHY_CONTENDER, 0);
512         fw_core_initiate_bus_reset(card, 1);
513
514         mutex_lock(&card_mutex);
515         list_del(&card->link);
516         mutex_unlock(&card_mutex);
517
518         /* Set up the dummy driver. */
519         card->driver = &dummy_driver;
520
521         fw_destroy_nodes(card);
522
523         /* Wait for all users, especially device workqueue jobs, to finish. */
524         fw_card_put(card);
525         wait_for_completion(&card->done);
526
527         WARN_ON(!list_empty(&card->transaction_list));
528         del_timer_sync(&card->flush_timer);
529 }
530 EXPORT_SYMBOL(fw_core_remove_card);
531
532 int
533 fw_core_initiate_bus_reset(struct fw_card *card, int short_reset)
534 {
535         int reg = short_reset ? 5 : 1;
536         int bit = short_reset ? PHY_BUS_SHORT_RESET : PHY_BUS_RESET;
537
538         return card->driver->update_phy_reg(card, reg, 0, bit);
539 }
540 EXPORT_SYMBOL(fw_core_initiate_bus_reset);