blob: a03462750b95ee0045408a5c8d669ba7bc3d461d [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
19#include <linux/module.h>
20#include <linux/errno.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>
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -040023#include <linux/mutex.h>
Kristian Høgsberge1755692007-05-07 20:33:31 -040024#include <linux/crc-itu-t.h>
Kristian Høgsberg3038e352006-12-19 19:58:27 -050025#include "fw-transaction.h"
26#include "fw-topology.h"
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050027#include "fw-device.h"
Kristian Høgsberg3038e352006-12-19 19:58:27 -050028
Kristian Høgsberge1755692007-05-07 20:33:31 -040029int fw_compute_block_crc(u32 *block)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050030{
Kristian Høgsberge1755692007-05-07 20:33:31 -040031 __be32 be32_block[256];
32 int i, length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050033
Kristian Høgsberge1755692007-05-07 20:33:31 -040034 length = (*block >> 16) & 0xff;
35 for (i = 0; i < length; i++)
36 be32_block[i] = cpu_to_be32(block[i + 1]);
37 *block |= crc_itu_t(0, (u8 *) be32_block, length * 4);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050038
Kristian Høgsberge1755692007-05-07 20:33:31 -040039 return length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050040}
41
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -040042static DEFINE_MUTEX(card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050043static LIST_HEAD(card_list);
44
45static LIST_HEAD(descriptor_list);
46static int descriptor_count;
47
Kristian Høgsberga77754a2007-05-07 20:33:35 -040048#define BIB_CRC(v) ((v) << 0)
49#define BIB_CRC_LENGTH(v) ((v) << 16)
50#define BIB_INFO_LENGTH(v) ((v) << 24)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050051
Kristian Høgsberga77754a2007-05-07 20:33:35 -040052#define BIB_LINK_SPEED(v) ((v) << 0)
53#define BIB_GENERATION(v) ((v) << 4)
54#define BIB_MAX_ROM(v) ((v) << 8)
55#define BIB_MAX_RECEIVE(v) ((v) << 12)
56#define BIB_CYC_CLK_ACC(v) ((v) << 16)
57#define BIB_PMC ((1) << 27)
58#define BIB_BMC ((1) << 28)
59#define BIB_ISC ((1) << 29)
60#define BIB_CMC ((1) << 30)
61#define BIB_IMC ((1) << 31)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050062
63static u32 *
Kristian Høgsberga98e2712007-05-07 20:33:34 -040064generate_config_rom(struct fw_card *card, size_t *config_rom_length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050065{
66 struct fw_descriptor *desc;
67 static u32 config_rom[256];
68 int i, j, length;
69
Kristian Høgsbergc781c062007-05-07 20:33:32 -040070 /*
71 * Initialize contents of config rom buffer. On the OHCI
Stefan Richter5e20c282007-01-21 20:44:09 +010072 * controller, block reads to the config rom accesses the host
73 * memory, but quadlet read access the hardware bus info block
74 * registers. That's just crack, but it means we should make
75 * sure the contents of bus info block in host memory mathces
Kristian Høgsbergc781c062007-05-07 20:33:32 -040076 * the version stored in the OHCI registers.
77 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -050078
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -040079 memset(config_rom, 0, sizeof(config_rom));
Kristian Høgsberga77754a2007-05-07 20:33:35 -040080 config_rom[0] = BIB_CRC_LENGTH(4) | BIB_INFO_LENGTH(4) | BIB_CRC(0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050081 config_rom[1] = 0x31333934;
82
83 config_rom[2] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -040084 BIB_LINK_SPEED(card->link_speed) |
85 BIB_GENERATION(card->config_rom_generation++ % 14 + 2) |
86 BIB_MAX_ROM(2) |
87 BIB_MAX_RECEIVE(card->max_receive) |
88 BIB_BMC | BIB_ISC | BIB_CMC | BIB_IMC;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050089 config_rom[3] = card->guid >> 32;
90 config_rom[4] = card->guid;
91
92 /* Generate root directory. */
93 i = 5;
94 config_rom[i++] = 0;
95 config_rom[i++] = 0x0c0083c0; /* node capabilities */
Kristian Høgsberg3038e352006-12-19 19:58:27 -050096 j = i + descriptor_count;
97
98 /* Generate root directory entries for descriptors. */
99 list_for_each_entry (desc, &descriptor_list, link) {
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500100 if (desc->immediate > 0)
101 config_rom[i++] = desc->immediate;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500102 config_rom[i] = desc->key | (j - i);
103 i++;
104 j += desc->length;
105 }
106
107 /* Update root directory length. */
108 config_rom[5] = (i - 5 - 1) << 16;
109
110 /* End of root directory, now copy in descriptors. */
111 list_for_each_entry (desc, &descriptor_list, link) {
112 memcpy(&config_rom[i], desc->data, desc->length * 4);
113 i += desc->length;
114 }
115
116 /* Calculate CRCs for all blocks in the config rom. This
117 * assumes that CRC length and info length are identical for
118 * the bus info block, which is always the case for this
119 * implementation. */
Kristian Høgsberge1755692007-05-07 20:33:31 -0400120 for (i = 0; i < j; i += length + 1)
121 length = fw_compute_block_crc(config_rom + i);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500122
123 *config_rom_length = j;
124
125 return config_rom;
126}
127
128static void
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400129update_config_roms(void)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500130{
131 struct fw_card *card;
132 u32 *config_rom;
133 size_t length;
134
135 list_for_each_entry (card, &card_list, link) {
136 config_rom = generate_config_rom(card, &length);
137 card->driver->set_config_rom(card, config_rom, length);
138 }
139}
140
141int
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400142fw_core_add_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500143{
144 size_t i;
145
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400146 /*
147 * Check descriptor is valid; the length of all blocks in the
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500148 * descriptor has to add up to exactly the length of the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400149 * block.
150 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500151 i = 0;
152 while (i < desc->length)
153 i += (desc->data[i] >> 16) + 1;
154
155 if (i != desc->length)
Kristian Høgsberg66dea3e2007-03-28 21:26:42 +0200156 return -EINVAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500157
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400158 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500159
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400160 list_add_tail(&desc->link, &descriptor_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500161 descriptor_count++;
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500162 if (desc->immediate > 0)
163 descriptor_count++;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500164 update_config_roms();
165
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400166 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500167
168 return 0;
169}
170EXPORT_SYMBOL(fw_core_add_descriptor);
171
172void
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400173fw_core_remove_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500174{
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400175 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500176
177 list_del(&desc->link);
178 descriptor_count--;
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500179 if (desc->immediate > 0)
180 descriptor_count--;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500181 update_config_roms();
182
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400183 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500184}
185EXPORT_SYMBOL(fw_core_remove_descriptor);
186
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500187static const char gap_count_table[] = {
188 63, 5, 7, 8, 10, 13, 16, 18, 21, 24, 26, 29, 32, 35, 37, 40
189};
190
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500191struct bm_data {
192 struct fw_transaction t;
193 struct {
194 __be32 arg;
195 __be32 data;
196 } lock;
197 u32 old;
198 int rcode;
199 struct completion done;
200};
201
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500202static void
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500203complete_bm_lock(struct fw_card *card, int rcode,
204 void *payload, size_t length, void *data)
205{
206 struct bm_data *bmd = data;
207
208 if (rcode == RCODE_COMPLETE)
209 bmd->old = be32_to_cpu(*(__be32 *) payload);
210 bmd->rcode = rcode;
211 complete(&bmd->done);
212}
213
214static void
215fw_card_bm_work(struct work_struct *work)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500216{
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500217 struct fw_card *card = container_of(work, struct fw_card, work.work);
Stefan Richter15803472008-02-24 18:57:23 +0100218 struct fw_device *root_device;
219 struct fw_node *root_node, *local_node;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500220 struct bm_data bmd;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500221 unsigned long flags;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500222 int root_id, new_root_id, irm_id, gap_count, generation, grace;
223 int do_reset = 0;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500224
225 spin_lock_irqsave(&card->lock, flags);
Stefan Richter15803472008-02-24 18:57:23 +0100226 local_node = card->local_node;
227 root_node = card->root_node;
228
229 if (local_node == NULL) {
230 spin_unlock_irqrestore(&card->lock, flags);
231 return;
232 }
233 fw_node_get(local_node);
234 fw_node_get(root_node);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500235
236 generation = card->generation;
Stefan Richter15803472008-02-24 18:57:23 +0100237 root_device = root_node->data;
238 if (root_device)
239 fw_device_get(root_device);
240 root_id = root_node->node_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500241 grace = time_after(jiffies, card->reset_jiffies + DIV_ROUND_UP(HZ, 10));
242
243 if (card->bm_generation + 1 == generation ||
244 (card->bm_generation != generation && grace)) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400245 /*
246 * This first step is to figure out who is IRM and
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500247 * then try to become bus manager. If the IRM is not
248 * well defined (e.g. does not have an active link
249 * layer or does not responds to our lock request, we
250 * will have to do a little vigilante bus management.
251 * In that case, we do a goto into the gap count logic
252 * so that when we do the reset, we still optimize the
253 * gap count. That could well save a reset in the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400254 * next generation.
255 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500256
257 irm_id = card->irm_node->node_id;
258 if (!card->irm_node->link_on) {
Stefan Richter15803472008-02-24 18:57:23 +0100259 new_root_id = local_node->node_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500260 fw_notify("IRM has link off, making local node (%02x) root.\n",
261 new_root_id);
262 goto pick_me;
263 }
264
265 bmd.lock.arg = cpu_to_be32(0x3f);
Stefan Richter15803472008-02-24 18:57:23 +0100266 bmd.lock.data = cpu_to_be32(local_node->node_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500267
268 spin_unlock_irqrestore(&card->lock, flags);
269
270 init_completion(&bmd.done);
271 fw_send_request(card, &bmd.t, TCODE_LOCK_COMPARE_SWAP,
272 irm_id, generation,
273 SCODE_100, CSR_REGISTER_BASE + CSR_BUS_MANAGER_ID,
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400274 &bmd.lock, sizeof(bmd.lock),
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500275 complete_bm_lock, &bmd);
276 wait_for_completion(&bmd.done);
277
278 if (bmd.rcode == RCODE_GENERATION) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400279 /*
280 * Another bus reset happened. Just return,
281 * the BM work has been rescheduled.
282 */
Stefan Richter15803472008-02-24 18:57:23 +0100283 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500284 }
285
286 if (bmd.rcode == RCODE_COMPLETE && bmd.old != 0x3f)
287 /* Somebody else is BM, let them do the work. */
Stefan Richter15803472008-02-24 18:57:23 +0100288 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500289
290 spin_lock_irqsave(&card->lock, flags);
291 if (bmd.rcode != RCODE_COMPLETE) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400292 /*
293 * The lock request failed, maybe the IRM
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500294 * isn't really IRM capable after all. Let's
295 * do a bus reset and pick the local node as
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400296 * root, and thus, IRM.
297 */
Stefan Richter15803472008-02-24 18:57:23 +0100298 new_root_id = local_node->node_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500299 fw_notify("BM lock failed, making local node (%02x) root.\n",
300 new_root_id);
301 goto pick_me;
302 }
303 } else if (card->bm_generation != generation) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400304 /*
305 * OK, we weren't BM in the last generation, and it's
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500306 * less than 100ms since last bus reset. Reschedule
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400307 * this task 100ms from now.
308 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500309 spin_unlock_irqrestore(&card->lock, flags);
310 schedule_delayed_work(&card->work, DIV_ROUND_UP(HZ, 10));
Stefan Richter15803472008-02-24 18:57:23 +0100311 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500312 }
313
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400314 /*
315 * We're bus manager for this generation, so next step is to
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500316 * make sure we have an active cycle master and do gap count
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400317 * optimization.
318 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500319 card->bm_generation = generation;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500320
Stefan Richter15803472008-02-24 18:57:23 +0100321 if (root_device == NULL) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400322 /*
323 * Either link_on is false, or we failed to read the
324 * config rom. In either case, pick another root.
325 */
Stefan Richter15803472008-02-24 18:57:23 +0100326 new_root_id = local_node->node_id;
327 } else if (atomic_read(&root_device->state) != FW_DEVICE_RUNNING) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400328 /*
329 * If we haven't probed this device yet, bail out now
330 * and let's try again once that's done.
331 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500332 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richter15803472008-02-24 18:57:23 +0100333 goto out;
334 } else if (root_device->config_rom[2] & BIB_CMC) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400335 /*
336 * FIXME: I suppose we should set the cmstr bit in the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500337 * STATE_CLEAR register of this node, as described in
338 * 1394-1995, 8.4.2.6. Also, send out a force root
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400339 * packet for this node.
340 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500341 new_root_id = root_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500342 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400343 /*
344 * Current root has an active link layer and we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500345 * successfully read the config rom, but it's not
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400346 * cycle master capable.
347 */
Stefan Richter15803472008-02-24 18:57:23 +0100348 new_root_id = local_node->node_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500349 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500350
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500351 pick_me:
Stefan Richter24d40122007-06-18 19:44:12 +0200352 /*
353 * Pick a gap count from 1394a table E-1. The table doesn't cover
354 * the typically much larger 1394b beta repeater delays though.
355 */
356 if (!card->beta_repeaters_present &&
Stefan Richter15803472008-02-24 18:57:23 +0100357 root_node->max_hops < ARRAY_SIZE(gap_count_table))
358 gap_count = gap_count_table[root_node->max_hops];
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500359 else
360 gap_count = 63;
361
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400362 /*
363 * Finally, figure out if we should do a reset or not. If we've
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500364 * done less that 5 resets with the same physical topology and we
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400365 * have either a new root or a new gap count setting, let's do it.
366 */
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500367
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500368 if (card->bm_retries++ < 5 &&
369 (card->gap_count != gap_count || new_root_id != root_id))
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500370 do_reset = 1;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500371
372 spin_unlock_irqrestore(&card->lock, flags);
373
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500374 if (do_reset) {
375 fw_notify("phy config: card %d, new root=%x, gap_count=%d\n",
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500376 card->index, new_root_id, gap_count);
377 fw_send_phy_config(card, new_root_id, generation, gap_count);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500378 fw_core_initiate_bus_reset(card, 1);
379 }
Stefan Richter15803472008-02-24 18:57:23 +0100380 out:
381 if (root_device)
382 fw_device_put(root_device);
383 fw_node_put(root_node);
384 fw_node_put(local_node);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500385}
386
387static void
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500388flush_timer_callback(unsigned long data)
389{
390 struct fw_card *card = (struct fw_card *)data;
391
392 fw_flush_transactions(card);
393}
394
395void
Stefan Richter21ebcd12007-01-14 15:29:07 +0100396fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500397 struct device *device)
398{
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500399 static atomic_t index = ATOMIC_INIT(-1);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500400
Kristian Høgsberg49e11792007-03-07 12:12:37 -0500401 kref_init(&card->kref);
Stefan Richter855c6032008-02-27 22:14:27 +0100402 atomic_set(&card->device_count, 0);
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500403 card->index = atomic_inc_return(&index);
Stefan Richter5e20c282007-01-21 20:44:09 +0100404 card->driver = driver;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500405 card->device = device;
Stefan Richter5e20c282007-01-21 20:44:09 +0100406 card->current_tlabel = 0;
407 card->tlabel_mask = 0;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500408 card->color = 0;
409
Stefan Richter5e20c282007-01-21 20:44:09 +0100410 INIT_LIST_HEAD(&card->transaction_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500411 spin_lock_init(&card->lock);
412 setup_timer(&card->flush_timer,
413 flush_timer_callback, (unsigned long)card);
414
415 card->local_node = NULL;
416
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500417 INIT_DELAYED_WORK(&card->work, fw_card_bm_work);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500418}
419EXPORT_SYMBOL(fw_card_initialize);
420
421int
422fw_card_add(struct fw_card *card,
423 u32 max_receive, u32 link_speed, u64 guid)
424{
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500425 u32 *config_rom;
426 size_t length;
427
428 card->max_receive = max_receive;
429 card->link_speed = link_speed;
430 card->guid = guid;
431
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400432 /*
433 * The subsystem grabs a reference when the card is added and
434 * drops it when the driver calls fw_core_remove_card.
435 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500436 fw_card_get(card);
437
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400438 mutex_lock(&card_mutex);
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400439 config_rom = generate_config_rom(card, &length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500440 list_add_tail(&card->link, &card_list);
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400441 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500442
443 return card->driver->enable(card, config_rom, length);
444}
445EXPORT_SYMBOL(fw_card_add);
446
447
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400448/*
449 * The next few functions implements a dummy driver that use once a
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500450 * card driver shuts down an fw_card. This allows the driver to
451 * cleanly unload, as all IO to the card will be handled by the dummy
452 * driver instead of calling into the (possibly) unloaded module. The
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400453 * dummy driver just fails all IO.
454 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500455
456static int
457dummy_enable(struct fw_card *card, u32 *config_rom, size_t length)
458{
459 BUG();
460 return -1;
461}
462
463static int
464dummy_update_phy_reg(struct fw_card *card, int address,
465 int clear_bits, int set_bits)
466{
467 return -ENODEV;
468}
469
470static int
471dummy_set_config_rom(struct fw_card *card,
472 u32 *config_rom, size_t length)
473{
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400474 /*
475 * We take the card out of card_list before setting the dummy
476 * driver, so this should never get called.
477 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500478 BUG();
479 return -1;
480}
481
482static void
483dummy_send_request(struct fw_card *card, struct fw_packet *packet)
484{
Stefan Richter5e20c282007-01-21 20:44:09 +0100485 packet->callback(packet, card, -ENODEV);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500486}
487
488static void
489dummy_send_response(struct fw_card *card, struct fw_packet *packet)
490{
Stefan Richter5e20c282007-01-21 20:44:09 +0100491 packet->callback(packet, card, -ENODEV);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500492}
493
494static int
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500495dummy_cancel_packet(struct fw_card *card, struct fw_packet *packet)
496{
497 return -ENOENT;
498}
499
500static int
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500501dummy_enable_phys_dma(struct fw_card *card,
502 int node_id, int generation)
503{
504 return -ENODEV;
505}
506
507static struct fw_card_driver dummy_driver = {
Stefan Richter5e20c282007-01-21 20:44:09 +0100508 .name = "dummy",
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500509 .enable = dummy_enable,
510 .update_phy_reg = dummy_update_phy_reg,
511 .set_config_rom = dummy_set_config_rom,
Stefan Richter5e20c282007-01-21 20:44:09 +0100512 .send_request = dummy_send_request,
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500513 .cancel_packet = dummy_cancel_packet,
Stefan Richter5e20c282007-01-21 20:44:09 +0100514 .send_response = dummy_send_response,
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100515 .enable_phys_dma = dummy_enable_phys_dma,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500516};
517
518void
519fw_core_remove_card(struct fw_card *card)
520{
Marc Butlerecab4132007-03-23 10:24:02 -0600521 card->driver->update_phy_reg(card, 4,
522 PHY_LINK_ACTIVE | PHY_CONTENDER, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500523 fw_core_initiate_bus_reset(card, 1);
524
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400525 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500526 list_del(&card->link);
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400527 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500528
529 /* Set up the dummy driver. */
530 card->driver = &dummy_driver;
531
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500532 fw_destroy_nodes(card);
Stefan Richter855c6032008-02-27 22:14:27 +0100533 /*
534 * Wait for all device workqueue jobs to finish. Otherwise the
535 * firewire-core module could be unloaded before the jobs ran.
536 */
537 while (atomic_read(&card->device_count) > 0)
538 msleep(100);
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200539
Stefan Richter855c6032008-02-27 22:14:27 +0100540 cancel_delayed_work_sync(&card->work);
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200541 fw_flush_transactions(card);
542 del_timer_sync(&card->flush_timer);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500543
Kristian Høgsberg49e11792007-03-07 12:12:37 -0500544 fw_card_put(card);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500545}
546EXPORT_SYMBOL(fw_core_remove_card);
547
548struct fw_card *
549fw_card_get(struct fw_card *card)
550{
Kristian Høgsberg49e11792007-03-07 12:12:37 -0500551 kref_get(&card->kref);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500552
553 return card;
554}
555EXPORT_SYMBOL(fw_card_get);
556
Kristian Høgsberg49e11792007-03-07 12:12:37 -0500557static void
558release_card(struct kref *kref)
559{
560 struct fw_card *card = container_of(kref, struct fw_card, kref);
561
562 kfree(card);
563}
564
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400565/*
566 * An assumption for fw_card_put() is that the card driver allocates
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500567 * the fw_card struct with kalloc and that it has been shut down
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400568 * before the last ref is dropped.
569 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500570void
571fw_card_put(struct fw_card *card)
572{
Kristian Høgsberg49e11792007-03-07 12:12:37 -0500573 kref_put(&card->kref, release_card);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500574}
575EXPORT_SYMBOL(fw_card_put);
576
577int
578fw_core_initiate_bus_reset(struct fw_card *card, int short_reset)
579{
Marc Butlerecab4132007-03-23 10:24:02 -0600580 int reg = short_reset ? 5 : 1;
Marc Butlerecab4132007-03-23 10:24:02 -0600581 int bit = short_reset ? PHY_BUS_SHORT_RESET : PHY_BUS_RESET;
582
583 return card->driver->update_phy_reg(card, reg, 0, bit);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500584}
585EXPORT_SYMBOL(fw_core_initiate_bus_reset);