blob: da873d795aad94bccf9e88a58a4b9bde9821daf1 [file] [log] [blame]
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001/*
2 * Copyright (C) 2005-2007 Kristian Hoegsberg <krh@bitplanet.net>
Kristian Høgsberg3038e352006-12-19 19:58:27 -05003 *
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
Stefan Richter459f7922008-05-24 16:50:22 +020019#include <linux/completion.h>
20#include <linux/crc-itu-t.h>
Stefan Richter855c6032008-02-27 22:14:27 +010021#include <linux/delay.h>
Kristian Høgsberg3038e352006-12-19 19:58:27 -050022#include <linux/device.h>
Stefan Richter459f7922008-05-24 16:50:22 +020023#include <linux/errno.h>
24#include <linux/kref.h>
25#include <linux/module.h>
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -040026#include <linux/mutex.h>
Stefan Richter459f7922008-05-24 16:50:22 +020027
Kristian Høgsberg3038e352006-12-19 19:58:27 -050028#include "fw-transaction.h"
29#include "fw-topology.h"
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050030#include "fw-device.h"
Kristian Høgsberg3038e352006-12-19 19:58:27 -050031
Kristian Høgsberge1755692007-05-07 20:33:31 -040032int fw_compute_block_crc(u32 *block)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050033{
Kristian Høgsberge1755692007-05-07 20:33:31 -040034 __be32 be32_block[256];
35 int i, length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050036
Kristian Høgsberge1755692007-05-07 20:33:31 -040037 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);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050041
Kristian Høgsberge1755692007-05-07 20:33:31 -040042 return length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050043}
44
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -040045static DEFINE_MUTEX(card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050046static LIST_HEAD(card_list);
47
48static LIST_HEAD(descriptor_list);
49static int descriptor_count;
50
Kristian Høgsberga77754a2007-05-07 20:33:35 -040051#define BIB_CRC(v) ((v) << 0)
52#define BIB_CRC_LENGTH(v) ((v) << 16)
53#define BIB_INFO_LENGTH(v) ((v) << 24)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050054
Kristian Høgsberga77754a2007-05-07 20:33:35 -040055#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)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050065
66static u32 *
Kristian Høgsberga98e2712007-05-07 20:33:34 -040067generate_config_rom(struct fw_card *card, size_t *config_rom_length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050068{
69 struct fw_descriptor *desc;
70 static u32 config_rom[256];
71 int i, j, length;
72
Kristian Høgsbergc781c062007-05-07 20:33:32 -040073 /*
74 * Initialize contents of config rom buffer. On the OHCI
Stefan Richter5e20c282007-01-21 20:44:09 +010075 * 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 mathces
Kristian Høgsbergc781c062007-05-07 20:33:32 -040079 * the version stored in the OHCI registers.
80 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -050081
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -040082 memset(config_rom, 0, sizeof(config_rom));
Kristian Høgsberga77754a2007-05-07 20:33:35 -040083 config_rom[0] = BIB_CRC_LENGTH(4) | BIB_INFO_LENGTH(4) | BIB_CRC(0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050084 config_rom[1] = 0x31333934;
85
86 config_rom[2] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -040087 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;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050092 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 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -050099 j = i + descriptor_count;
100
101 /* Generate root directory entries for descriptors. */
102 list_for_each_entry (desc, &descriptor_list, link) {
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500103 if (desc->immediate > 0)
104 config_rom[i++] = desc->immediate;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500105 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. */
Kristian Høgsberge1755692007-05-07 20:33:31 -0400123 for (i = 0; i < j; i += length + 1)
124 length = fw_compute_block_crc(config_rom + i);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500125
126 *config_rom_length = j;
127
128 return config_rom;
129}
130
131static void
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400132update_config_roms(void)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500133{
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
144int
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400145fw_core_add_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500146{
147 size_t i;
148
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400149 /*
150 * Check descriptor is valid; the length of all blocks in the
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500151 * descriptor has to add up to exactly the length of the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400152 * block.
153 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500154 i = 0;
155 while (i < desc->length)
156 i += (desc->data[i] >> 16) + 1;
157
158 if (i != desc->length)
Kristian Høgsberg66dea3e2007-03-28 21:26:42 +0200159 return -EINVAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500160
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400161 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500162
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400163 list_add_tail(&desc->link, &descriptor_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500164 descriptor_count++;
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500165 if (desc->immediate > 0)
166 descriptor_count++;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500167 update_config_roms();
168
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400169 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500170
171 return 0;
172}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500173
174void
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400175fw_core_remove_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500176{
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400177 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500178
179 list_del(&desc->link);
180 descriptor_count--;
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500181 if (desc->immediate > 0)
182 descriptor_count--;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500183 update_config_roms();
184
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400185 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500186}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500187
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500188static const char gap_count_table[] = {
189 63, 5, 7, 8, 10, 13, 16, 18, 21, 24, 26, 29, 32, 35, 37, 40
190};
191
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500192struct bm_data {
193 struct fw_transaction t;
194 struct {
195 __be32 arg;
196 __be32 data;
197 } lock;
198 u32 old;
199 int rcode;
200 struct completion done;
201};
202
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500203static void
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500204complete_bm_lock(struct fw_card *card, int rcode,
205 void *payload, size_t length, void *data)
206{
207 struct bm_data *bmd = data;
208
209 if (rcode == RCODE_COMPLETE)
210 bmd->old = be32_to_cpu(*(__be32 *) payload);
211 bmd->rcode = rcode;
212 complete(&bmd->done);
213}
214
215static void
216fw_card_bm_work(struct work_struct *work)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500217{
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500218 struct fw_card *card = container_of(work, struct fw_card, work.work);
Stefan Richter15803472008-02-24 18:57:23 +0100219 struct fw_device *root_device;
220 struct fw_node *root_node, *local_node;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500221 struct bm_data bmd;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500222 unsigned long flags;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500223 int root_id, new_root_id, irm_id, gap_count, generation, grace;
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100224 bool do_reset = false;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500225
226 spin_lock_irqsave(&card->lock, flags);
Stefan Richter15803472008-02-24 18:57:23 +0100227 local_node = card->local_node;
228 root_node = card->root_node;
229
230 if (local_node == NULL) {
231 spin_unlock_irqrestore(&card->lock, flags);
232 return;
233 }
234 fw_node_get(local_node);
235 fw_node_get(root_node);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500236
237 generation = card->generation;
Stefan Richter15803472008-02-24 18:57:23 +0100238 root_device = root_node->data;
239 if (root_device)
240 fw_device_get(root_device);
241 root_id = root_node->node_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500242 grace = time_after(jiffies, card->reset_jiffies + DIV_ROUND_UP(HZ, 10));
243
244 if (card->bm_generation + 1 == generation ||
245 (card->bm_generation != generation && grace)) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400246 /*
247 * This first step is to figure out who is IRM and
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500248 * then try to become bus manager. If the IRM is not
249 * well defined (e.g. does not have an active link
250 * layer or does not responds to our lock request, we
251 * will have to do a little vigilante bus management.
252 * In that case, we do a goto into the gap count logic
253 * so that when we do the reset, we still optimize the
254 * gap count. That could well save a reset in the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400255 * next generation.
256 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500257
258 irm_id = card->irm_node->node_id;
259 if (!card->irm_node->link_on) {
Stefan Richter15803472008-02-24 18:57:23 +0100260 new_root_id = local_node->node_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500261 fw_notify("IRM has link off, making local node (%02x) root.\n",
262 new_root_id);
263 goto pick_me;
264 }
265
266 bmd.lock.arg = cpu_to_be32(0x3f);
Stefan Richter15803472008-02-24 18:57:23 +0100267 bmd.lock.data = cpu_to_be32(local_node->node_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500268
269 spin_unlock_irqrestore(&card->lock, flags);
270
271 init_completion(&bmd.done);
272 fw_send_request(card, &bmd.t, TCODE_LOCK_COMPARE_SWAP,
273 irm_id, generation,
274 SCODE_100, CSR_REGISTER_BASE + CSR_BUS_MANAGER_ID,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400275 &bmd.lock, sizeof(bmd.lock),
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500276 complete_bm_lock, &bmd);
277 wait_for_completion(&bmd.done);
278
279 if (bmd.rcode == RCODE_GENERATION) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400280 /*
281 * Another bus reset happened. Just return,
282 * the BM work has been rescheduled.
283 */
Stefan Richter15803472008-02-24 18:57:23 +0100284 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500285 }
286
287 if (bmd.rcode == RCODE_COMPLETE && bmd.old != 0x3f)
288 /* Somebody else is BM, let them do the work. */
Stefan Richter15803472008-02-24 18:57:23 +0100289 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500290
291 spin_lock_irqsave(&card->lock, flags);
292 if (bmd.rcode != RCODE_COMPLETE) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400293 /*
294 * The lock request failed, maybe the IRM
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500295 * isn't really IRM capable after all. Let's
296 * do a bus reset and pick the local node as
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400297 * root, and thus, IRM.
298 */
Stefan Richter15803472008-02-24 18:57:23 +0100299 new_root_id = local_node->node_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500300 fw_notify("BM lock failed, making local node (%02x) root.\n",
301 new_root_id);
302 goto pick_me;
303 }
304 } else if (card->bm_generation != generation) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400305 /*
306 * OK, we weren't BM in the last generation, and it's
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500307 * less than 100ms since last bus reset. Reschedule
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400308 * this task 100ms from now.
309 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500310 spin_unlock_irqrestore(&card->lock, flags);
311 schedule_delayed_work(&card->work, DIV_ROUND_UP(HZ, 10));
Stefan Richter15803472008-02-24 18:57:23 +0100312 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500313 }
314
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400315 /*
316 * We're bus manager for this generation, so next step is to
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500317 * make sure we have an active cycle master and do gap count
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400318 * optimization.
319 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500320 card->bm_generation = generation;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500321
Stefan Richter15803472008-02-24 18:57:23 +0100322 if (root_device == NULL) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400323 /*
324 * Either link_on is false, or we failed to read the
325 * config rom. In either case, pick another root.
326 */
Stefan Richter15803472008-02-24 18:57:23 +0100327 new_root_id = local_node->node_id;
328 } else if (atomic_read(&root_device->state) != FW_DEVICE_RUNNING) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400329 /*
330 * If we haven't probed this device yet, bail out now
331 * and let's try again once that's done.
332 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500333 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richter15803472008-02-24 18:57:23 +0100334 goto out;
Stefan Richterc9755e12008-03-24 20:54:28 +0100335 } else if (root_device->cmc) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400336 /*
337 * FIXME: I suppose we should set the cmstr bit in the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500338 * STATE_CLEAR register of this node, as described in
339 * 1394-1995, 8.4.2.6. Also, send out a force root
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400340 * packet for this node.
341 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500342 new_root_id = root_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500343 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400344 /*
345 * Current root has an active link layer and we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500346 * successfully read the config rom, but it's not
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400347 * cycle master capable.
348 */
Stefan Richter15803472008-02-24 18:57:23 +0100349 new_root_id = local_node->node_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500350 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500351
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500352 pick_me:
Stefan Richter24d40122007-06-18 19:44:12 +0200353 /*
354 * Pick a gap count from 1394a table E-1. The table doesn't cover
355 * the typically much larger 1394b beta repeater delays though.
356 */
357 if (!card->beta_repeaters_present &&
Stefan Richter15803472008-02-24 18:57:23 +0100358 root_node->max_hops < ARRAY_SIZE(gap_count_table))
359 gap_count = gap_count_table[root_node->max_hops];
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500360 else
361 gap_count = 63;
362
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400363 /*
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100364 * Finally, figure out if we should do a reset or not. If we have
365 * done less than 5 resets with the same physical topology and we
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400366 * have either a new root or a new gap count setting, let's do it.
367 */
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500368
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500369 if (card->bm_retries++ < 5 &&
370 (card->gap_count != gap_count || new_root_id != root_id))
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100371 do_reset = true;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500372
373 spin_unlock_irqrestore(&card->lock, flags);
374
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500375 if (do_reset) {
376 fw_notify("phy config: card %d, new root=%x, gap_count=%d\n",
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500377 card->index, new_root_id, gap_count);
378 fw_send_phy_config(card, new_root_id, generation, gap_count);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500379 fw_core_initiate_bus_reset(card, 1);
380 }
Stefan Richter15803472008-02-24 18:57:23 +0100381 out:
382 if (root_device)
383 fw_device_put(root_device);
384 fw_node_put(root_node);
385 fw_node_put(local_node);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500386}
387
388static void
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500389flush_timer_callback(unsigned long data)
390{
391 struct fw_card *card = (struct fw_card *)data;
392
393 fw_flush_transactions(card);
394}
395
396void
Stefan Richter21ebcd12007-01-14 15:29:07 +0100397fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500398 struct device *device)
399{
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500400 static atomic_t index = ATOMIC_INIT(-1);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500401
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500402 card->index = atomic_inc_return(&index);
Stefan Richter5e20c282007-01-21 20:44:09 +0100403 card->driver = driver;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500404 card->device = device;
Stefan Richter5e20c282007-01-21 20:44:09 +0100405 card->current_tlabel = 0;
406 card->tlabel_mask = 0;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500407 card->color = 0;
Stefan Richtere534fe12008-05-24 16:41:09 +0200408 card->broadcast_channel = BROADCAST_CHANNEL_INITIAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500409
Stefan Richter459f7922008-05-24 16:50:22 +0200410 kref_init(&card->kref);
411 init_completion(&card->done);
Stefan Richter5e20c282007-01-21 20:44:09 +0100412 INIT_LIST_HEAD(&card->transaction_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500413 spin_lock_init(&card->lock);
414 setup_timer(&card->flush_timer,
415 flush_timer_callback, (unsigned long)card);
416
417 card->local_node = NULL;
418
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500419 INIT_DELAYED_WORK(&card->work, fw_card_bm_work);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500420}
421EXPORT_SYMBOL(fw_card_initialize);
422
423int
424fw_card_add(struct fw_card *card,
425 u32 max_receive, u32 link_speed, u64 guid)
426{
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500427 u32 *config_rom;
428 size_t length;
429
430 card->max_receive = max_receive;
431 card->link_speed = link_speed;
432 card->guid = guid;
433
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400434 mutex_lock(&card_mutex);
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400435 config_rom = generate_config_rom(card, &length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500436 list_add_tail(&card->link, &card_list);
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400437 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500438
439 return card->driver->enable(card, config_rom, length);
440}
441EXPORT_SYMBOL(fw_card_add);
442
443
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400444/*
445 * The next few functions implements a dummy driver that use once a
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500446 * card driver shuts down an fw_card. This allows the driver to
447 * cleanly unload, as all IO to the card will be handled by the dummy
448 * driver instead of calling into the (possibly) unloaded module. The
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400449 * dummy driver just fails all IO.
450 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500451
452static int
453dummy_enable(struct fw_card *card, u32 *config_rom, size_t length)
454{
455 BUG();
456 return -1;
457}
458
459static int
460dummy_update_phy_reg(struct fw_card *card, int address,
461 int clear_bits, int set_bits)
462{
463 return -ENODEV;
464}
465
466static int
467dummy_set_config_rom(struct fw_card *card,
468 u32 *config_rom, size_t length)
469{
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400470 /*
471 * We take the card out of card_list before setting the dummy
472 * driver, so this should never get called.
473 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500474 BUG();
475 return -1;
476}
477
478static void
479dummy_send_request(struct fw_card *card, struct fw_packet *packet)
480{
Stefan Richter5e20c282007-01-21 20:44:09 +0100481 packet->callback(packet, card, -ENODEV);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500482}
483
484static void
485dummy_send_response(struct fw_card *card, struct fw_packet *packet)
486{
Stefan Richter5e20c282007-01-21 20:44:09 +0100487 packet->callback(packet, card, -ENODEV);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500488}
489
490static int
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500491dummy_cancel_packet(struct fw_card *card, struct fw_packet *packet)
492{
493 return -ENOENT;
494}
495
496static int
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500497dummy_enable_phys_dma(struct fw_card *card,
498 int node_id, int generation)
499{
500 return -ENODEV;
501}
502
503static struct fw_card_driver dummy_driver = {
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500504 .enable = dummy_enable,
505 .update_phy_reg = dummy_update_phy_reg,
506 .set_config_rom = dummy_set_config_rom,
Stefan Richter5e20c282007-01-21 20:44:09 +0100507 .send_request = dummy_send_request,
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500508 .cancel_packet = dummy_cancel_packet,
Stefan Richter5e20c282007-01-21 20:44:09 +0100509 .send_response = dummy_send_response,
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100510 .enable_phys_dma = dummy_enable_phys_dma,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500511};
512
513void
Stefan Richter459f7922008-05-24 16:50:22 +0200514fw_card_release(struct kref *kref)
515{
516 struct fw_card *card = container_of(kref, struct fw_card, kref);
517
518 complete(&card->done);
519}
520
521void
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500522fw_core_remove_card(struct fw_card *card)
523{
Marc Butlerecab4132007-03-23 10:24:02 -0600524 card->driver->update_phy_reg(card, 4,
525 PHY_LINK_ACTIVE | PHY_CONTENDER, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500526 fw_core_initiate_bus_reset(card, 1);
527
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400528 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500529 list_del(&card->link);
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400530 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500531
532 /* Set up the dummy driver. */
533 card->driver = &dummy_driver;
534
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500535 fw_destroy_nodes(card);
Stefan Richter459f7922008-05-24 16:50:22 +0200536
537 /* Wait for all users, especially device workqueue jobs, to finish. */
538 fw_card_put(card);
539 wait_for_completion(&card->done);
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200540
Stefan Richter855c6032008-02-27 22:14:27 +0100541 cancel_delayed_work_sync(&card->work);
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200542 fw_flush_transactions(card);
543 del_timer_sync(&card->flush_timer);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500544}
545EXPORT_SYMBOL(fw_core_remove_card);
546
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500547int
548fw_core_initiate_bus_reset(struct fw_card *card, int short_reset)
549{
Marc Butlerecab4132007-03-23 10:24:02 -0600550 int reg = short_reset ? 5 : 1;
Marc Butlerecab4132007-03-23 10:24:02 -0600551 int bit = short_reset ? PHY_BUS_SHORT_RESET : PHY_BUS_RESET;
552
553 return card->driver->update_phy_reg(card, reg, 0, bit);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500554}
555EXPORT_SYMBOL(fw_core_initiate_bus_reset);