blob: 5045156c5313b0c59114850f003f17ef46945c36 [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
Stefan Richtercb7c96d2009-10-08 00:42:53 +020041int fw_compute_block_crc(__be32 *block)
Stefan Richter8e859732009-10-08 00:41:59 +020042{
43 int length;
44 u16 crc;
45
46 length = (be32_to_cpu(block[0]) >> 16) & 0xff;
47 crc = crc_itu_t(0, (u8 *)&block[1], length * 4);
48 *block |= cpu_to_be32(crc);
49
50 return length;
51}
52
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -040053static DEFINE_MUTEX(card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050054static LIST_HEAD(card_list);
55
56static LIST_HEAD(descriptor_list);
57static int descriptor_count;
58
Stefan Richterfe242572009-10-08 00:42:27 +020059static __be32 tmp_config_rom[256];
Stefan Richtere3008392010-01-24 14:47:02 +010060/* ROM header, bus info block, root dir header, capabilities = 7 quadlets */
61static size_t config_rom_length = 1 + 4 + 1 + 1;
Stefan Richterfe242572009-10-08 00:42:27 +020062
Kristian Høgsberga77754a2007-05-07 20:33:35 -040063#define BIB_CRC(v) ((v) << 0)
64#define BIB_CRC_LENGTH(v) ((v) << 16)
65#define BIB_INFO_LENGTH(v) ((v) << 24)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050066
Kristian Høgsberga77754a2007-05-07 20:33:35 -040067#define BIB_LINK_SPEED(v) ((v) << 0)
68#define BIB_GENERATION(v) ((v) << 4)
69#define BIB_MAX_ROM(v) ((v) << 8)
70#define BIB_MAX_RECEIVE(v) ((v) << 12)
71#define BIB_CYC_CLK_ACC(v) ((v) << 16)
72#define BIB_PMC ((1) << 27)
73#define BIB_BMC ((1) << 28)
74#define BIB_ISC ((1) << 29)
75#define BIB_CMC ((1) << 30)
76#define BIB_IMC ((1) << 31)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050077
Stefan Richtere3008392010-01-24 14:47:02 +010078static void generate_config_rom(struct fw_card *card, __be32 *config_rom)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050079{
80 struct fw_descriptor *desc;
Stefan Richter8e859732009-10-08 00:41:59 +020081 int i, j, k, length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050082
Kristian Høgsbergc781c062007-05-07 20:33:32 -040083 /*
84 * Initialize contents of config rom buffer. On the OHCI
Stefan Richter5e20c282007-01-21 20:44:09 +010085 * controller, block reads to the config rom accesses the host
86 * memory, but quadlet read access the hardware bus info block
87 * registers. That's just crack, but it means we should make
Jay Fenlason2cc489c2008-10-22 15:59:42 -040088 * sure the contents of bus info block in host memory matches
Kristian Høgsbergc781c062007-05-07 20:33:32 -040089 * the version stored in the OHCI registers.
90 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -050091
Stefan Richter8e859732009-10-08 00:41:59 +020092 config_rom[0] = cpu_to_be32(
93 BIB_CRC_LENGTH(4) | BIB_INFO_LENGTH(4) | BIB_CRC(0));
94 config_rom[1] = cpu_to_be32(0x31333934);
95 config_rom[2] = cpu_to_be32(
Kristian Høgsberga77754a2007-05-07 20:33:35 -040096 BIB_LINK_SPEED(card->link_speed) |
97 BIB_GENERATION(card->config_rom_generation++ % 14 + 2) |
98 BIB_MAX_ROM(2) |
99 BIB_MAX_RECEIVE(card->max_receive) |
Stefan Richter8e859732009-10-08 00:41:59 +0200100 BIB_BMC | BIB_ISC | BIB_CMC | BIB_IMC);
101 config_rom[3] = cpu_to_be32(card->guid >> 32);
102 config_rom[4] = cpu_to_be32(card->guid);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500103
104 /* Generate root directory. */
Stefan Richter8e859732009-10-08 00:41:59 +0200105 config_rom[6] = cpu_to_be32(0x0c0083c0); /* node capabilities */
106 i = 7;
107 j = 7 + descriptor_count;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500108
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)
Stefan Richter8e859732009-10-08 00:41:59 +0200112 config_rom[i++] = cpu_to_be32(desc->immediate);
113 config_rom[i] = cpu_to_be32(desc->key | (j - i));
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500114 i++;
115 j += desc->length;
116 }
117
118 /* Update root directory length. */
Stefan Richter8e859732009-10-08 00:41:59 +0200119 config_rom[5] = cpu_to_be32((i - 5 - 1) << 16);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500120
121 /* End of root directory, now copy in descriptors. */
122 list_for_each_entry (desc, &descriptor_list, link) {
Stefan Richter8e859732009-10-08 00:41:59 +0200123 for (k = 0; k < desc->length; k++)
124 config_rom[i + k] = cpu_to_be32(desc->data[k]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500125 i += desc->length;
126 }
127
128 /* Calculate CRCs for all blocks in the config rom. This
129 * assumes that CRC length and info length are identical for
130 * the bus info block, which is always the case for this
131 * implementation. */
Kristian Høgsberge1755692007-05-07 20:33:31 -0400132 for (i = 0; i < j; i += length + 1)
Stefan Richtercb7c96d2009-10-08 00:42:53 +0200133 length = fw_compute_block_crc(config_rom + i);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500134
Stefan Richtere3008392010-01-24 14:47:02 +0100135 WARN_ON(j != config_rom_length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500136}
137
Stefan Richter53dca512008-12-14 21:47:04 +0100138static void update_config_roms(void)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500139{
140 struct fw_card *card;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500141
142 list_for_each_entry (card, &card_list, link) {
Stefan Richtere3008392010-01-24 14:47:02 +0100143 generate_config_rom(card, tmp_config_rom);
144 card->driver->set_config_rom(card, tmp_config_rom,
145 config_rom_length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500146 }
147}
148
Stefan Richtere3008392010-01-24 14:47:02 +0100149static size_t required_space(struct fw_descriptor *desc)
150{
151 /* descriptor + entry into root dir + optional immediate entry */
152 return desc->length + 1 + (desc->immediate > 0 ? 1 : 0);
153}
154
Stefan Richter53dca512008-12-14 21:47:04 +0100155int fw_core_add_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500156{
157 size_t i;
Stefan Richtere3008392010-01-24 14:47:02 +0100158 int ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500159
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400160 /*
161 * Check descriptor is valid; the length of all blocks in the
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500162 * descriptor has to add up to exactly the length of the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400163 * block.
164 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500165 i = 0;
166 while (i < desc->length)
167 i += (desc->data[i] >> 16) + 1;
168
169 if (i != desc->length)
Kristian Høgsberg66dea3e2007-03-28 21:26:42 +0200170 return -EINVAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500171
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400172 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500173
Stefan Richtere3008392010-01-24 14:47:02 +0100174 if (config_rom_length + required_space(desc) > 256) {
175 ret = -EBUSY;
176 } else {
177 list_add_tail(&desc->link, &descriptor_list);
178 config_rom_length += required_space(desc);
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500179 descriptor_count++;
Stefan Richtere3008392010-01-24 14:47:02 +0100180 if (desc->immediate > 0)
181 descriptor_count++;
182 update_config_roms();
183 ret = 0;
184 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500185
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400186 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500187
Stefan Richtere3008392010-01-24 14:47:02 +0100188 return ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500189}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400190EXPORT_SYMBOL(fw_core_add_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500191
Stefan Richter53dca512008-12-14 21:47:04 +0100192void fw_core_remove_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500193{
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400194 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500195
196 list_del(&desc->link);
Stefan Richtere3008392010-01-24 14:47:02 +0100197 config_rom_length -= required_space(desc);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500198 descriptor_count--;
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500199 if (desc->immediate > 0)
200 descriptor_count--;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500201 update_config_roms();
202
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400203 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500204}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400205EXPORT_SYMBOL(fw_core_remove_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500206
Stefan Richtercbae7872009-03-10 21:08:37 +0100207static void allocate_broadcast_channel(struct fw_card *card, int generation)
Jay Fenlason6104ee92009-02-23 15:59:34 -0500208{
Stefan Richtercbae7872009-03-10 21:08:37 +0100209 int channel, bandwidth = 0;
Jay Fenlason6104ee92009-02-23 15:59:34 -0500210
Stefan Richter6fdc0372009-06-20 13:23:59 +0200211 fw_iso_resource_manage(card, generation, 1ULL << 31, &channel,
212 &bandwidth, true, card->bm_transaction_data);
Stefan Richtercbae7872009-03-10 21:08:37 +0100213 if (channel == 31) {
Stefan Richter7889b602009-03-10 21:09:28 +0100214 card->broadcast_channel_allocated = true;
215 device_for_each_child(card->device, (void *)(long)generation,
Stefan Richter099d5412009-06-06 18:37:25 +0200216 fw_device_set_broadcast_channel);
Jay Fenlason6104ee92009-02-23 15:59:34 -0500217 }
Jay Fenlason6104ee92009-02-23 15:59:34 -0500218}
Jay Fenlason6104ee92009-02-23 15:59:34 -0500219
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500220static const char gap_count_table[] = {
221 63, 5, 7, 8, 10, 13, 16, 18, 21, 24, 26, 29, 32, 35, 37, 40
222};
223
Stefan Richter53dca512008-12-14 21:47:04 +0100224void fw_schedule_bm_work(struct fw_card *card, unsigned long delay)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100225{
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100226 fw_card_get(card);
Stefan Richter9fb551b2009-10-08 00:41:10 +0200227 if (!schedule_delayed_work(&card->work, delay))
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100228 fw_card_put(card);
229}
230
Stefan Richter53dca512008-12-14 21:47:04 +0100231static void fw_card_bm_work(struct work_struct *work)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500232{
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500233 struct fw_card *card = container_of(work, struct fw_card, work.work);
Stefan Richtercbae7872009-03-10 21:08:37 +0100234 struct fw_device *root_device;
235 struct fw_node *root_node;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500236 unsigned long flags;
Stefan Richtercbae7872009-03-10 21:08:37 +0100237 int root_id, new_root_id, irm_id, local_id;
238 int gap_count, generation, grace, rcode;
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100239 bool do_reset = false;
Stefan Richter62305822009-01-09 20:49:37 +0100240 bool root_device_is_running;
241 bool root_device_is_cmc;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500242
243 spin_lock_irqsave(&card->lock, flags);
Stefan Richter15803472008-02-24 18:57:23 +0100244
Stefan Richtercbae7872009-03-10 21:08:37 +0100245 if (card->local_node == NULL) {
Stefan Richter15803472008-02-24 18:57:23 +0100246 spin_unlock_irqrestore(&card->lock, flags);
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100247 goto out_put_card;
Stefan Richter15803472008-02-24 18:57:23 +0100248 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500249
250 generation = card->generation;
Stefan Richtercbae7872009-03-10 21:08:37 +0100251 root_node = card->root_node;
252 fw_node_get(root_node);
Stefan Richter15803472008-02-24 18:57:23 +0100253 root_device = root_node->data;
Stefan Richter62305822009-01-09 20:49:37 +0100254 root_device_is_running = root_device &&
255 atomic_read(&root_device->state) == FW_DEVICE_RUNNING;
256 root_device_is_cmc = root_device && root_device->cmc;
Stefan Richtercbae7872009-03-10 21:08:37 +0100257 root_id = root_node->node_id;
258 irm_id = card->irm_node->node_id;
259 local_id = card->local_node->node_id;
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100260
261 grace = time_after(jiffies, card->reset_jiffies + DIV_ROUND_UP(HZ, 8));
262
Stefan Richter8cd0bbb2008-03-24 20:56:40 +0100263 if (is_next_generation(generation, card->bm_generation) ||
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500264 (card->bm_generation != generation && grace)) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400265 /*
266 * This first step is to figure out who is IRM and
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500267 * then try to become bus manager. If the IRM is not
268 * well defined (e.g. does not have an active link
269 * layer or does not responds to our lock request, we
270 * will have to do a little vigilante bus management.
271 * In that case, we do a goto into the gap count logic
272 * so that when we do the reset, we still optimize the
273 * gap count. That could well save a reset in the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400274 * next generation.
275 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500276
Stefan Richtercbae7872009-03-10 21:08:37 +0100277 if (!card->irm_node->link_on) {
278 new_root_id = local_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500279 fw_notify("IRM has link off, making local node (%02x) root.\n",
280 new_root_id);
281 goto pick_me;
282 }
283
Stefan Richter6fdc0372009-06-20 13:23:59 +0200284 card->bm_transaction_data[0] = cpu_to_be32(0x3f);
285 card->bm_transaction_data[1] = cpu_to_be32(local_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500286
287 spin_unlock_irqrestore(&card->lock, flags);
288
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200289 rcode = fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
290 irm_id, generation, SCODE_100,
291 CSR_REGISTER_BASE + CSR_BUS_MANAGER_ID,
Stefan Richter6fdc0372009-06-20 13:23:59 +0200292 card->bm_transaction_data,
293 sizeof(card->bm_transaction_data));
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500294
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200295 if (rcode == RCODE_GENERATION)
296 /* Another bus reset, BM work has been rescheduled. */
Stefan Richter15803472008-02-24 18:57:23 +0100297 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500298
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200299 if (rcode == RCODE_COMPLETE &&
Stefan Richter6fdc0372009-06-20 13:23:59 +0200300 card->bm_transaction_data[0] != cpu_to_be32(0x3f)) {
Stefan Richtercbae7872009-03-10 21:08:37 +0100301
302 /* Somebody else is BM. Only act as IRM. */
303 if (local_id == irm_id)
304 allocate_broadcast_channel(card, generation);
305
Stefan Richter15803472008-02-24 18:57:23 +0100306 goto out;
Jay Fenlason6104ee92009-02-23 15:59:34 -0500307 }
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500308
309 spin_lock_irqsave(&card->lock, flags);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200310
311 if (rcode != RCODE_COMPLETE) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400312 /*
313 * The lock request failed, maybe the IRM
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500314 * isn't really IRM capable after all. Let's
315 * do a bus reset and pick the local node as
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400316 * root, and thus, IRM.
317 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100318 new_root_id = local_id;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500319 fw_notify("BM lock failed, making local node (%02x) root.\n",
320 new_root_id);
321 goto pick_me;
322 }
323 } else if (card->bm_generation != generation) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400324 /*
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100325 * We weren't BM in the last generation, and the last
326 * bus reset is less than 125ms ago. Reschedule this job.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400327 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500328 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100329 fw_schedule_bm_work(card, DIV_ROUND_UP(HZ, 8));
Stefan Richter15803472008-02-24 18:57:23 +0100330 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500331 }
332
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400333 /*
334 * We're bus manager for this generation, so next step is to
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500335 * make sure we have an active cycle master and do gap count
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400336 * optimization.
337 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500338 card->bm_generation = generation;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500339
Stefan Richter15803472008-02-24 18:57:23 +0100340 if (root_device == NULL) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400341 /*
342 * Either link_on is false, or we failed to read the
343 * config rom. In either case, pick another root.
344 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100345 new_root_id = local_id;
Stefan Richter62305822009-01-09 20:49:37 +0100346 } else if (!root_device_is_running) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400347 /*
348 * If we haven't probed this device yet, bail out now
349 * and let's try again once that's done.
350 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500351 spin_unlock_irqrestore(&card->lock, flags);
Stefan Richter15803472008-02-24 18:57:23 +0100352 goto out;
Stefan Richter62305822009-01-09 20:49:37 +0100353 } else if (root_device_is_cmc) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400354 /*
355 * FIXME: I suppose we should set the cmstr bit in the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500356 * STATE_CLEAR register of this node, as described in
357 * 1394-1995, 8.4.2.6. Also, send out a force root
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400358 * packet for this node.
359 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500360 new_root_id = root_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500361 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400362 /*
363 * Current root has an active link layer and we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500364 * successfully read the config rom, but it's not
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400365 * cycle master capable.
366 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100367 new_root_id = local_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500368 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500369
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500370 pick_me:
Stefan Richter24d40122007-06-18 19:44:12 +0200371 /*
372 * Pick a gap count from 1394a table E-1. The table doesn't cover
373 * the typically much larger 1394b beta repeater delays though.
374 */
375 if (!card->beta_repeaters_present &&
Stefan Richter15803472008-02-24 18:57:23 +0100376 root_node->max_hops < ARRAY_SIZE(gap_count_table))
377 gap_count = gap_count_table[root_node->max_hops];
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500378 else
379 gap_count = 63;
380
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400381 /*
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100382 * Finally, figure out if we should do a reset or not. If we have
383 * done less than 5 resets with the same physical topology and we
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400384 * have either a new root or a new gap count setting, let's do it.
385 */
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500386
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500387 if (card->bm_retries++ < 5 &&
388 (card->gap_count != gap_count || new_root_id != root_id))
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100389 do_reset = true;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500390
391 spin_unlock_irqrestore(&card->lock, flags);
392
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500393 if (do_reset) {
394 fw_notify("phy config: card %d, new root=%x, gap_count=%d\n",
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500395 card->index, new_root_id, gap_count);
396 fw_send_phy_config(card, new_root_id, generation, gap_count);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500397 fw_core_initiate_bus_reset(card, 1);
Stefan Richtercbae7872009-03-10 21:08:37 +0100398 /* Will allocate broadcast channel after the reset. */
399 } else {
400 if (local_id == irm_id)
401 allocate_broadcast_channel(card, generation);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500402 }
Jay Fenlason6104ee92009-02-23 15:59:34 -0500403
Stefan Richter15803472008-02-24 18:57:23 +0100404 out:
Stefan Richter15803472008-02-24 18:57:23 +0100405 fw_node_put(root_node);
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100406 out_put_card:
407 fw_card_put(card);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500408}
409
Stefan Richter53dca512008-12-14 21:47:04 +0100410static void flush_timer_callback(unsigned long data)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500411{
412 struct fw_card *card = (struct fw_card *)data;
413
414 fw_flush_transactions(card);
415}
416
Stefan Richter53dca512008-12-14 21:47:04 +0100417void fw_card_initialize(struct fw_card *card,
418 const struct fw_card_driver *driver,
419 struct device *device)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500420{
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500421 static atomic_t index = ATOMIC_INIT(-1);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500422
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500423 card->index = atomic_inc_return(&index);
Stefan Richter5e20c282007-01-21 20:44:09 +0100424 card->driver = driver;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500425 card->device = device;
Stefan Richter5e20c282007-01-21 20:44:09 +0100426 card->current_tlabel = 0;
427 card->tlabel_mask = 0;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500428 card->color = 0;
Stefan Richtere534fe12008-05-24 16:41:09 +0200429 card->broadcast_channel = BROADCAST_CHANNEL_INITIAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500430
Stefan Richter459f7922008-05-24 16:50:22 +0200431 kref_init(&card->kref);
432 init_completion(&card->done);
Stefan Richter5e20c282007-01-21 20:44:09 +0100433 INIT_LIST_HEAD(&card->transaction_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500434 spin_lock_init(&card->lock);
435 setup_timer(&card->flush_timer,
436 flush_timer_callback, (unsigned long)card);
437
438 card->local_node = NULL;
439
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500440 INIT_DELAYED_WORK(&card->work, fw_card_bm_work);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500441}
442EXPORT_SYMBOL(fw_card_initialize);
443
Stefan Richter53dca512008-12-14 21:47:04 +0100444int fw_card_add(struct fw_card *card,
445 u32 max_receive, u32 link_speed, u64 guid)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500446{
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100447 int ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500448
449 card->max_receive = max_receive;
450 card->link_speed = link_speed;
451 card->guid = guid;
452
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400453 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500454
Stefan Richtere3008392010-01-24 14:47:02 +0100455 generate_config_rom(card, tmp_config_rom);
456 ret = card->driver->enable(card, tmp_config_rom, config_rom_length);
Stefan Richterb171e202009-09-06 18:50:29 +0200457 if (ret == 0)
458 list_add_tail(&card->link, &card_list);
459
460 mutex_unlock(&card_mutex);
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100461
462 return ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500463}
464EXPORT_SYMBOL(fw_card_add);
465
466
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400467/*
Stefan Richterd645f4d2009-06-16 19:15:25 +0200468 * The next few functions implement a dummy driver that is used once a card
469 * driver shuts down an fw_card. This allows the driver to cleanly unload,
470 * as all IO to the card will be handled (and failed) by the dummy driver
471 * instead of calling into the module. Only functions for iso context
472 * shutdown still need to be provided by the card driver.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400473 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500474
Stefan Richter8e859732009-10-08 00:41:59 +0200475static int dummy_enable(struct fw_card *card,
476 const __be32 *config_rom, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500477{
478 BUG();
479 return -1;
480}
481
Stefan Richter53dca512008-12-14 21:47:04 +0100482static int dummy_update_phy_reg(struct fw_card *card, int address,
483 int clear_bits, int set_bits)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500484{
485 return -ENODEV;
486}
487
Stefan Richter53dca512008-12-14 21:47:04 +0100488static int dummy_set_config_rom(struct fw_card *card,
Stefan Richter8e859732009-10-08 00:41:59 +0200489 const __be32 *config_rom, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500490{
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400491 /*
492 * We take the card out of card_list before setting the dummy
493 * driver, so this should never get called.
494 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500495 BUG();
496 return -1;
497}
498
Stefan Richter53dca512008-12-14 21:47:04 +0100499static void dummy_send_request(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 void dummy_send_response(struct fw_card *card, struct fw_packet *packet)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500505{
Stefan Richter5e20c282007-01-21 20:44:09 +0100506 packet->callback(packet, card, -ENODEV);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500507}
508
Stefan Richter53dca512008-12-14 21:47:04 +0100509static int dummy_cancel_packet(struct fw_card *card, struct fw_packet *packet)
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500510{
511 return -ENOENT;
512}
513
Stefan Richter53dca512008-12-14 21:47:04 +0100514static int dummy_enable_phys_dma(struct fw_card *card,
515 int node_id, int generation)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500516{
517 return -ENODEV;
518}
519
Stefan Richterd645f4d2009-06-16 19:15:25 +0200520static const struct fw_card_driver dummy_driver_template = {
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500521 .enable = dummy_enable,
522 .update_phy_reg = dummy_update_phy_reg,
523 .set_config_rom = dummy_set_config_rom,
Stefan Richter5e20c282007-01-21 20:44:09 +0100524 .send_request = dummy_send_request,
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500525 .cancel_packet = dummy_cancel_packet,
Stefan Richter5e20c282007-01-21 20:44:09 +0100526 .send_response = dummy_send_response,
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100527 .enable_phys_dma = dummy_enable_phys_dma,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500528};
529
Stefan Richter53dca512008-12-14 21:47:04 +0100530void fw_card_release(struct kref *kref)
Stefan Richter459f7922008-05-24 16:50:22 +0200531{
532 struct fw_card *card = container_of(kref, struct fw_card, kref);
533
534 complete(&card->done);
535}
536
Stefan Richter53dca512008-12-14 21:47:04 +0100537void fw_core_remove_card(struct fw_card *card)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500538{
Stefan Richterd645f4d2009-06-16 19:15:25 +0200539 struct fw_card_driver dummy_driver = dummy_driver_template;
540
Marc Butlerecab4132007-03-23 10:24:02 -0600541 card->driver->update_phy_reg(card, 4,
542 PHY_LINK_ACTIVE | PHY_CONTENDER, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500543 fw_core_initiate_bus_reset(card, 1);
544
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400545 mutex_lock(&card_mutex);
Stefan Richtere747a5c2009-01-24 20:35:38 +0100546 list_del_init(&card->link);
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400547 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500548
Stefan Richterd645f4d2009-06-16 19:15:25 +0200549 /* Switch off most of the card driver interface. */
550 dummy_driver.free_iso_context = card->driver->free_iso_context;
551 dummy_driver.stop_iso = card->driver->stop_iso;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500552 card->driver = &dummy_driver;
553
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500554 fw_destroy_nodes(card);
Stefan Richter459f7922008-05-24 16:50:22 +0200555
556 /* Wait for all users, especially device workqueue jobs, to finish. */
557 fw_card_put(card);
558 wait_for_completion(&card->done);
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200559
Stefan Richter1e8afea2008-07-12 14:51:18 +0200560 WARN_ON(!list_empty(&card->transaction_list));
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200561 del_timer_sync(&card->flush_timer);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500562}
563EXPORT_SYMBOL(fw_core_remove_card);
564
Stefan Richter53dca512008-12-14 21:47:04 +0100565int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500566{
Marc Butlerecab4132007-03-23 10:24:02 -0600567 int reg = short_reset ? 5 : 1;
Marc Butlerecab4132007-03-23 10:24:02 -0600568 int bit = short_reset ? PHY_BUS_SHORT_RESET : PHY_BUS_RESET;
569
570 return card->driver->update_phy_reg(card, reg, 0, bit);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500571}
572EXPORT_SYMBOL(fw_core_initiate_bus_reset);