blob: f74edae5cb4cfce68726102cca77711865003bc5 [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 Richtere8ca9702009-06-04 21:09:38 +020019#include <linux/bug.h>
Stefan Richter459f7922008-05-24 16:50:22 +020020#include <linux/completion.h>
21#include <linux/crc-itu-t.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>
Stefan Richter77c9a5d2009-06-05 16:26:18 +020024#include <linux/firewire.h>
25#include <linux/firewire-constants.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020026#include <linux/jiffies.h>
27#include <linux/kernel.h>
Stefan Richter459f7922008-05-24 16:50:22 +020028#include <linux/kref.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020029#include <linux/list.h>
Stefan Richter459f7922008-05-24 16:50:22 +020030#include <linux/module.h>
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -040031#include <linux/mutex.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020032#include <linux/spinlock.h>
33#include <linux/timer.h>
34#include <linux/workqueue.h>
Stefan Richter459f7922008-05-24 16:50:22 +020035
Stefan Richtere8ca9702009-06-04 21:09:38 +020036#include <asm/atomic.h>
37#include <asm/byteorder.h>
38
Stefan Richter77c9a5d2009-06-05 16:26:18 +020039#include "core.h"
Kristian Høgsberg3038e352006-12-19 19:58:27 -050040
Kristian Høgsberge1755692007-05-07 20:33:31 -040041int fw_compute_block_crc(u32 *block)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050042{
Kristian Høgsberge1755692007-05-07 20:33:31 -040043 __be32 be32_block[256];
44 int i, length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050045
Kristian Høgsberge1755692007-05-07 20:33:31 -040046 length = (*block >> 16) & 0xff;
47 for (i = 0; i < length; i++)
48 be32_block[i] = cpu_to_be32(block[i + 1]);
49 *block |= crc_itu_t(0, (u8 *) be32_block, length * 4);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050050
Kristian Høgsberge1755692007-05-07 20:33:31 -040051 return length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050052}
53
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -040054static DEFINE_MUTEX(card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050055static LIST_HEAD(card_list);
56
57static LIST_HEAD(descriptor_list);
58static int descriptor_count;
59
Kristian Høgsberga77754a2007-05-07 20:33:35 -040060#define BIB_CRC(v) ((v) << 0)
61#define BIB_CRC_LENGTH(v) ((v) << 16)
62#define BIB_INFO_LENGTH(v) ((v) << 24)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050063
Kristian Høgsberga77754a2007-05-07 20:33:35 -040064#define BIB_LINK_SPEED(v) ((v) << 0)
65#define BIB_GENERATION(v) ((v) << 4)
66#define BIB_MAX_ROM(v) ((v) << 8)
67#define BIB_MAX_RECEIVE(v) ((v) << 12)
68#define BIB_CYC_CLK_ACC(v) ((v) << 16)
69#define BIB_PMC ((1) << 27)
70#define BIB_BMC ((1) << 28)
71#define BIB_ISC ((1) << 29)
72#define BIB_CMC ((1) << 30)
73#define BIB_IMC ((1) << 31)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050074
Stefan Richter53dca512008-12-14 21:47:04 +010075static u32 *generate_config_rom(struct fw_card *card, size_t *config_rom_length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050076{
77 struct fw_descriptor *desc;
78 static u32 config_rom[256];
79 int i, j, length;
80
Kristian Høgsbergc781c062007-05-07 20:33:32 -040081 /*
82 * Initialize contents of config rom buffer. On the OHCI
Stefan Richter5e20c282007-01-21 20:44:09 +010083 * controller, block reads to the config rom accesses the host
84 * memory, but quadlet read access the hardware bus info block
85 * registers. That's just crack, but it means we should make
Jay Fenlason2cc489c2008-10-22 15:59:42 -040086 * sure the contents of bus info block in host memory matches
Kristian Høgsbergc781c062007-05-07 20:33:32 -040087 * the version stored in the OHCI registers.
88 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -050089
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -040090 memset(config_rom, 0, sizeof(config_rom));
Kristian Høgsberga77754a2007-05-07 20:33:35 -040091 config_rom[0] = BIB_CRC_LENGTH(4) | BIB_INFO_LENGTH(4) | BIB_CRC(0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050092 config_rom[1] = 0x31333934;
93
94 config_rom[2] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -040095 BIB_LINK_SPEED(card->link_speed) |
96 BIB_GENERATION(card->config_rom_generation++ % 14 + 2) |
97 BIB_MAX_ROM(2) |
98 BIB_MAX_RECEIVE(card->max_receive) |
99 BIB_BMC | BIB_ISC | BIB_CMC | BIB_IMC;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500100 config_rom[3] = card->guid >> 32;
101 config_rom[4] = card->guid;
102
103 /* Generate root directory. */
104 i = 5;
105 config_rom[i++] = 0;
106 config_rom[i++] = 0x0c0083c0; /* node capabilities */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500107 j = i + descriptor_count;
108
109 /* Generate root directory entries for descriptors. */
110 list_for_each_entry (desc, &descriptor_list, link) {
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500111 if (desc->immediate > 0)
112 config_rom[i++] = desc->immediate;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500113 config_rom[i] = desc->key | (j - i);
114 i++;
115 j += desc->length;
116 }
117
118 /* Update root directory length. */
119 config_rom[5] = (i - 5 - 1) << 16;
120
121 /* End of root directory, now copy in descriptors. */
122 list_for_each_entry (desc, &descriptor_list, link) {
123 memcpy(&config_rom[i], desc->data, desc->length * 4);
124 i += desc->length;
125 }
126
127 /* Calculate CRCs for all blocks in the config rom. This
128 * assumes that CRC length and info length are identical for
129 * the bus info block, which is always the case for this
130 * implementation. */
Kristian Høgsberge1755692007-05-07 20:33:31 -0400131 for (i = 0; i < j; i += length + 1)
132 length = fw_compute_block_crc(config_rom + i);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500133
134 *config_rom_length = j;
135
136 return config_rom;
137}
138
Stefan Richter53dca512008-12-14 21:47:04 +0100139static void update_config_roms(void)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500140{
141 struct fw_card *card;
142 u32 *config_rom;
143 size_t length;
144
145 list_for_each_entry (card, &card_list, link) {
146 config_rom = generate_config_rom(card, &length);
147 card->driver->set_config_rom(card, config_rom, length);
148 }
149}
150
Stefan Richter53dca512008-12-14 21:47:04 +0100151int fw_core_add_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500152{
153 size_t i;
154
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400155 /*
156 * Check descriptor is valid; the length of all blocks in the
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500157 * descriptor has to add up to exactly the length of the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400158 * block.
159 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500160 i = 0;
161 while (i < desc->length)
162 i += (desc->data[i] >> 16) + 1;
163
164 if (i != desc->length)
Kristian Høgsberg66dea3e2007-03-28 21:26:42 +0200165 return -EINVAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500166
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400167 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500168
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400169 list_add_tail(&desc->link, &descriptor_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500170 descriptor_count++;
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500171 if (desc->immediate > 0)
172 descriptor_count++;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500173 update_config_roms();
174
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400175 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500176
177 return 0;
178}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400179EXPORT_SYMBOL(fw_core_add_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500180
Stefan Richter53dca512008-12-14 21:47:04 +0100181void fw_core_remove_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500182{
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400183 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500184
185 list_del(&desc->link);
186 descriptor_count--;
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500187 if (desc->immediate > 0)
188 descriptor_count--;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500189 update_config_roms();
190
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400191 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500192}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400193EXPORT_SYMBOL(fw_core_remove_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500194
Stefan Richtercbae7872009-03-10 21:08:37 +0100195static void allocate_broadcast_channel(struct fw_card *card, int generation)
Jay Fenlason6104ee92009-02-23 15:59:34 -0500196{
Stefan Richtercbae7872009-03-10 21:08:37 +0100197 int channel, bandwidth = 0;
Jay Fenlason6104ee92009-02-23 15:59:34 -0500198
Stefan Richter6fdc0372009-06-20 13:23:59 +0200199 fw_iso_resource_manage(card, generation, 1ULL << 31, &channel,
200 &bandwidth, true, card->bm_transaction_data);
Stefan Richtercbae7872009-03-10 21:08:37 +0100201 if (channel == 31) {
Stefan Richter7889b602009-03-10 21:09:28 +0100202 card->broadcast_channel_allocated = true;
203 device_for_each_child(card->device, (void *)(long)generation,
Stefan Richter099d5412009-06-06 18:37:25 +0200204 fw_device_set_broadcast_channel);
Jay Fenlason6104ee92009-02-23 15:59:34 -0500205 }
Jay Fenlason6104ee92009-02-23 15:59:34 -0500206}
Jay Fenlason6104ee92009-02-23 15:59:34 -0500207
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500208static const char gap_count_table[] = {
209 63, 5, 7, 8, 10, 13, 16, 18, 21, 24, 26, 29, 32, 35, 37, 40
210};
211
Stefan Richter53dca512008-12-14 21:47:04 +0100212void fw_schedule_bm_work(struct fw_card *card, unsigned long delay)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100213{
214 int scheduled;
215
216 fw_card_get(card);
217 scheduled = schedule_delayed_work(&card->work, delay);
218 if (!scheduled)
219 fw_card_put(card);
220}
221
Stefan Richter53dca512008-12-14 21:47:04 +0100222static void fw_card_bm_work(struct work_struct *work)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500223{
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500224 struct fw_card *card = container_of(work, struct fw_card, work.work);
Stefan Richtercbae7872009-03-10 21:08:37 +0100225 struct fw_device *root_device;
226 struct fw_node *root_node;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500227 unsigned long flags;
Stefan Richtercbae7872009-03-10 21:08:37 +0100228 int root_id, new_root_id, irm_id, local_id;
229 int gap_count, generation, grace, rcode;
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100230 bool do_reset = false;
Stefan Richter62305822009-01-09 20:49:37 +0100231 bool root_device_is_running;
232 bool root_device_is_cmc;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500233
234 spin_lock_irqsave(&card->lock, flags);
Stefan Richter15803472008-02-24 18:57:23 +0100235
Stefan Richtercbae7872009-03-10 21:08:37 +0100236 if (card->local_node == NULL) {
Stefan Richter15803472008-02-24 18:57:23 +0100237 spin_unlock_irqrestore(&card->lock, flags);
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100238 goto out_put_card;
Stefan Richter15803472008-02-24 18:57:23 +0100239 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500240
241 generation = card->generation;
Stefan Richtercbae7872009-03-10 21:08:37 +0100242 root_node = card->root_node;
243 fw_node_get(root_node);
Stefan Richter15803472008-02-24 18:57:23 +0100244 root_device = root_node->data;
Stefan Richter62305822009-01-09 20:49:37 +0100245 root_device_is_running = root_device &&
246 atomic_read(&root_device->state) == FW_DEVICE_RUNNING;
247 root_device_is_cmc = root_device && root_device->cmc;
Stefan Richtercbae7872009-03-10 21:08:37 +0100248 root_id = root_node->node_id;
249 irm_id = card->irm_node->node_id;
250 local_id = card->local_node->node_id;
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100251
252 grace = time_after(jiffies, card->reset_jiffies + DIV_ROUND_UP(HZ, 8));
253
Stefan Richter8cd0bbb2008-03-24 20:56:40 +0100254 if (is_next_generation(generation, card->bm_generation) ||
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500255 (card->bm_generation != generation && grace)) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400256 /*
257 * This first step is to figure out who is IRM and
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500258 * then try to become bus manager. If the IRM is not
259 * well defined (e.g. does not have an active link
260 * layer or does not responds to our lock request, we
261 * will have to do a little vigilante bus management.
262 * In that case, we do a goto into the gap count logic
263 * so that when we do the reset, we still optimize the
264 * gap count. That could well save a reset in the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400265 * next generation.
266 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500267
Stefan Richtercbae7872009-03-10 21:08:37 +0100268 if (!card->irm_node->link_on) {
269 new_root_id = local_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500270 fw_notify("IRM has link off, making local node (%02x) root.\n",
271 new_root_id);
272 goto pick_me;
273 }
274
Stefan Richter6fdc0372009-06-20 13:23:59 +0200275 card->bm_transaction_data[0] = cpu_to_be32(0x3f);
276 card->bm_transaction_data[1] = cpu_to_be32(local_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500277
278 spin_unlock_irqrestore(&card->lock, flags);
279
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200280 rcode = fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
281 irm_id, generation, SCODE_100,
282 CSR_REGISTER_BASE + CSR_BUS_MANAGER_ID,
Stefan Richter6fdc0372009-06-20 13:23:59 +0200283 card->bm_transaction_data,
284 sizeof(card->bm_transaction_data));
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500285
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200286 if (rcode == RCODE_GENERATION)
287 /* Another bus reset, BM work has been rescheduled. */
Stefan Richter15803472008-02-24 18:57:23 +0100288 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500289
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200290 if (rcode == RCODE_COMPLETE &&
Stefan Richter6fdc0372009-06-20 13:23:59 +0200291 card->bm_transaction_data[0] != cpu_to_be32(0x3f)) {
Stefan Richtercbae7872009-03-10 21:08:37 +0100292
293 /* Somebody else is BM. Only act as IRM. */
294 if (local_id == irm_id)
295 allocate_broadcast_channel(card, generation);
296
Stefan Richter15803472008-02-24 18:57:23 +0100297 goto out;
Jay Fenlason6104ee92009-02-23 15:59:34 -0500298 }
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500299
300 spin_lock_irqsave(&card->lock, flags);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200301
302 if (rcode != RCODE_COMPLETE) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400303 /*
304 * The lock request failed, maybe the IRM
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500305 * isn't really IRM capable after all. Let's
306 * do a bus reset and pick the local node as
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400307 * root, and thus, IRM.
308 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100309 new_root_id = local_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500310 fw_notify("BM lock failed, making local node (%02x) root.\n",
311 new_root_id);
312 goto pick_me;
313 }
314 } else if (card->bm_generation != generation) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400315 /*
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100316 * We weren't BM in the last generation, and the last
317 * bus reset is less than 125ms ago. Reschedule this job.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400318 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500319 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100320 fw_schedule_bm_work(card, DIV_ROUND_UP(HZ, 8));
Stefan Richter15803472008-02-24 18:57:23 +0100321 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500322 }
323
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400324 /*
325 * We're bus manager for this generation, so next step is to
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500326 * make sure we have an active cycle master and do gap count
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400327 * optimization.
328 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500329 card->bm_generation = generation;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500330
Stefan Richter15803472008-02-24 18:57:23 +0100331 if (root_device == NULL) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400332 /*
333 * Either link_on is false, or we failed to read the
334 * config rom. In either case, pick another root.
335 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100336 new_root_id = local_id;
Stefan Richter62305822009-01-09 20:49:37 +0100337 } else if (!root_device_is_running) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400338 /*
339 * If we haven't probed this device yet, bail out now
340 * and let's try again once that's done.
341 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500342 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richter15803472008-02-24 18:57:23 +0100343 goto out;
Stefan Richter62305822009-01-09 20:49:37 +0100344 } else if (root_device_is_cmc) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400345 /*
346 * FIXME: I suppose we should set the cmstr bit in the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500347 * STATE_CLEAR register of this node, as described in
348 * 1394-1995, 8.4.2.6. Also, send out a force root
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400349 * packet for this node.
350 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500351 new_root_id = root_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500352 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400353 /*
354 * Current root has an active link layer and we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500355 * successfully read the config rom, but it's not
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400356 * cycle master capable.
357 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100358 new_root_id = local_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500359 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500360
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500361 pick_me:
Stefan Richter24d40122007-06-18 19:44:12 +0200362 /*
363 * Pick a gap count from 1394a table E-1. The table doesn't cover
364 * the typically much larger 1394b beta repeater delays though.
365 */
366 if (!card->beta_repeaters_present &&
Stefan Richter15803472008-02-24 18:57:23 +0100367 root_node->max_hops < ARRAY_SIZE(gap_count_table))
368 gap_count = gap_count_table[root_node->max_hops];
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500369 else
370 gap_count = 63;
371
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400372 /*
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100373 * Finally, figure out if we should do a reset or not. If we have
374 * done less than 5 resets with the same physical topology and we
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400375 * have either a new root or a new gap count setting, let's do it.
376 */
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500377
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500378 if (card->bm_retries++ < 5 &&
379 (card->gap_count != gap_count || new_root_id != root_id))
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100380 do_reset = true;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500381
382 spin_unlock_irqrestore(&card->lock, flags);
383
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500384 if (do_reset) {
385 fw_notify("phy config: card %d, new root=%x, gap_count=%d\n",
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500386 card->index, new_root_id, gap_count);
387 fw_send_phy_config(card, new_root_id, generation, gap_count);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500388 fw_core_initiate_bus_reset(card, 1);
Stefan Richtercbae7872009-03-10 21:08:37 +0100389 /* Will allocate broadcast channel after the reset. */
390 } else {
391 if (local_id == irm_id)
392 allocate_broadcast_channel(card, generation);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500393 }
Jay Fenlason6104ee92009-02-23 15:59:34 -0500394
Stefan Richter15803472008-02-24 18:57:23 +0100395 out:
Stefan Richter15803472008-02-24 18:57:23 +0100396 fw_node_put(root_node);
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100397 out_put_card:
398 fw_card_put(card);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500399}
400
Stefan Richter53dca512008-12-14 21:47:04 +0100401static void flush_timer_callback(unsigned long data)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500402{
403 struct fw_card *card = (struct fw_card *)data;
404
405 fw_flush_transactions(card);
406}
407
Stefan Richter53dca512008-12-14 21:47:04 +0100408void fw_card_initialize(struct fw_card *card,
409 const struct fw_card_driver *driver,
410 struct device *device)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500411{
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500412 static atomic_t index = ATOMIC_INIT(-1);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500413
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500414 card->index = atomic_inc_return(&index);
Stefan Richter5e20c282007-01-21 20:44:09 +0100415 card->driver = driver;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500416 card->device = device;
Stefan Richter5e20c282007-01-21 20:44:09 +0100417 card->current_tlabel = 0;
418 card->tlabel_mask = 0;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500419 card->color = 0;
Stefan Richtere534fe12008-05-24 16:41:09 +0200420 card->broadcast_channel = BROADCAST_CHANNEL_INITIAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500421
Stefan Richter459f7922008-05-24 16:50:22 +0200422 kref_init(&card->kref);
423 init_completion(&card->done);
Stefan Richter5e20c282007-01-21 20:44:09 +0100424 INIT_LIST_HEAD(&card->transaction_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500425 spin_lock_init(&card->lock);
426 setup_timer(&card->flush_timer,
427 flush_timer_callback, (unsigned long)card);
428
429 card->local_node = NULL;
430
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500431 INIT_DELAYED_WORK(&card->work, fw_card_bm_work);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500432}
433EXPORT_SYMBOL(fw_card_initialize);
434
Stefan Richter53dca512008-12-14 21:47:04 +0100435int fw_card_add(struct fw_card *card,
436 u32 max_receive, u32 link_speed, u64 guid)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500437{
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500438 u32 *config_rom;
439 size_t length;
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100440 int ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500441
442 card->max_receive = max_receive;
443 card->link_speed = link_speed;
444 card->guid = guid;
445
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400446 mutex_lock(&card_mutex);
Kristian Høgsberga98e2712007-05-07 20:33:34 -0400447 config_rom = generate_config_rom(card, &length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500448 list_add_tail(&card->link, &card_list);
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400449 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500450
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100451 ret = card->driver->enable(card, config_rom, length);
452 if (ret < 0) {
Petr Vandrovecb7479fe2009-02-01 01:29:35 -0800453 mutex_lock(&card_mutex);
454 list_del(&card->link);
455 mutex_unlock(&card_mutex);
456 }
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100457
458 return ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500459}
460EXPORT_SYMBOL(fw_card_add);
461
462
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400463/*
Stefan Richterd645f4d2009-06-16 19:15:25 +0200464 * The next few functions implement a dummy driver that is used once a card
465 * driver shuts down an fw_card. This allows the driver to cleanly unload,
466 * as all IO to the card will be handled (and failed) by the dummy driver
467 * instead of calling into the module. Only functions for iso context
468 * shutdown still need to be provided by the card driver.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400469 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500470
Stefan Richter53dca512008-12-14 21:47:04 +0100471static int dummy_enable(struct fw_card *card, u32 *config_rom, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500472{
473 BUG();
474 return -1;
475}
476
Stefan Richter53dca512008-12-14 21:47:04 +0100477static int dummy_update_phy_reg(struct fw_card *card, int address,
478 int clear_bits, int set_bits)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500479{
480 return -ENODEV;
481}
482
Stefan Richter53dca512008-12-14 21:47:04 +0100483static int dummy_set_config_rom(struct fw_card *card,
484 u32 *config_rom, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500485{
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400486 /*
487 * We take the card out of card_list before setting the dummy
488 * driver, so this should never get called.
489 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500490 BUG();
491 return -1;
492}
493
Stefan Richter53dca512008-12-14 21:47:04 +0100494static void dummy_send_request(struct fw_card *card, struct fw_packet *packet)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500495{
Stefan Richter5e20c282007-01-21 20:44:09 +0100496 packet->callback(packet, card, -ENODEV);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500497}
498
Stefan Richter53dca512008-12-14 21:47:04 +0100499static void dummy_send_response(struct fw_card *card, struct fw_packet *packet)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500500{
Stefan Richter5e20c282007-01-21 20:44:09 +0100501 packet->callback(packet, card, -ENODEV);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500502}
503
Stefan Richter53dca512008-12-14 21:47:04 +0100504static int dummy_cancel_packet(struct fw_card *card, struct fw_packet *packet)
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500505{
506 return -ENOENT;
507}
508
Stefan Richter53dca512008-12-14 21:47:04 +0100509static int dummy_enable_phys_dma(struct fw_card *card,
510 int node_id, int generation)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500511{
512 return -ENODEV;
513}
514
Stefan Richterd645f4d2009-06-16 19:15:25 +0200515static const struct fw_card_driver dummy_driver_template = {
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500516 .enable = dummy_enable,
517 .update_phy_reg = dummy_update_phy_reg,
518 .set_config_rom = dummy_set_config_rom,
Stefan Richter5e20c282007-01-21 20:44:09 +0100519 .send_request = dummy_send_request,
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500520 .cancel_packet = dummy_cancel_packet,
Stefan Richter5e20c282007-01-21 20:44:09 +0100521 .send_response = dummy_send_response,
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100522 .enable_phys_dma = dummy_enable_phys_dma,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500523};
524
Stefan Richter53dca512008-12-14 21:47:04 +0100525void fw_card_release(struct kref *kref)
Stefan Richter459f7922008-05-24 16:50:22 +0200526{
527 struct fw_card *card = container_of(kref, struct fw_card, kref);
528
529 complete(&card->done);
530}
531
Stefan Richter53dca512008-12-14 21:47:04 +0100532void fw_core_remove_card(struct fw_card *card)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500533{
Stefan Richterd645f4d2009-06-16 19:15:25 +0200534 struct fw_card_driver dummy_driver = dummy_driver_template;
535
Marc Butlerecab4132007-03-23 10:24:02 -0600536 card->driver->update_phy_reg(card, 4,
537 PHY_LINK_ACTIVE | PHY_CONTENDER, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500538 fw_core_initiate_bus_reset(card, 1);
539
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400540 mutex_lock(&card_mutex);
Stefan Richtere747a5c2009-01-24 20:35:38 +0100541 list_del_init(&card->link);
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400542 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500543
Stefan Richterd645f4d2009-06-16 19:15:25 +0200544 /* Switch off most of the card driver interface. */
545 dummy_driver.free_iso_context = card->driver->free_iso_context;
546 dummy_driver.stop_iso = card->driver->stop_iso;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500547 card->driver = &dummy_driver;
548
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500549 fw_destroy_nodes(card);
Stefan Richter459f7922008-05-24 16:50:22 +0200550
551 /* Wait for all users, especially device workqueue jobs, to finish. */
552 fw_card_put(card);
553 wait_for_completion(&card->done);
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200554
Stefan Richter1e8afea2008-07-12 14:51:18 +0200555 WARN_ON(!list_empty(&card->transaction_list));
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200556 del_timer_sync(&card->flush_timer);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500557}
558EXPORT_SYMBOL(fw_core_remove_card);
559
Stefan Richter53dca512008-12-14 21:47:04 +0100560int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500561{
Marc Butlerecab4132007-03-23 10:24:02 -0600562 int reg = short_reset ? 5 : 1;
Marc Butlerecab4132007-03-23 10:24:02 -0600563 int bit = short_reset ? PHY_BUS_SHORT_RESET : PHY_BUS_RESET;
564
565 return card->driver->update_phy_reg(card, reg, 0, bit);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500566}
567EXPORT_SYMBOL(fw_core_initiate_bus_reset);