blob: 29d2423fae6d999827c682648278366c07238a6e [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>
Stefan Richtere8ca9702009-06-04 21:09:38 +020033#include <linux/workqueue.h>
Stefan Richter459f7922008-05-24 16:50:22 +020034
Stefan Richtere8ca9702009-06-04 21:09:38 +020035#include <asm/atomic.h>
36#include <asm/byteorder.h>
37
Stefan Richter77c9a5d2009-06-05 16:26:18 +020038#include "core.h"
Kristian Høgsberg3038e352006-12-19 19:58:27 -050039
Stefan Richtercb7c96d2009-10-08 00:42:53 +020040int fw_compute_block_crc(__be32 *block)
Stefan Richter8e859732009-10-08 00:41:59 +020041{
42 int length;
43 u16 crc;
44
45 length = (be32_to_cpu(block[0]) >> 16) & 0xff;
46 crc = crc_itu_t(0, (u8 *)&block[1], length * 4);
47 *block |= cpu_to_be32(crc);
48
49 return length;
50}
51
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -040052static DEFINE_MUTEX(card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -050053static LIST_HEAD(card_list);
54
55static LIST_HEAD(descriptor_list);
56static int descriptor_count;
57
Stefan Richterfe242572009-10-08 00:42:27 +020058static __be32 tmp_config_rom[256];
Stefan Richtere3008392010-01-24 14:47:02 +010059/* ROM header, bus info block, root dir header, capabilities = 7 quadlets */
60static size_t config_rom_length = 1 + 4 + 1 + 1;
Stefan Richterfe242572009-10-08 00:42:27 +020061
Kristian Høgsberga77754a2007-05-07 20:33:35 -040062#define BIB_CRC(v) ((v) << 0)
63#define BIB_CRC_LENGTH(v) ((v) << 16)
64#define BIB_INFO_LENGTH(v) ((v) << 24)
Stefan Richteredd5bda2010-04-14 22:30:18 +020065#define BIB_BUS_NAME 0x31333934 /* "1394" */
Kristian Høgsberga77754a2007-05-07 20:33:35 -040066#define BIB_LINK_SPEED(v) ((v) << 0)
67#define BIB_GENERATION(v) ((v) << 4)
68#define BIB_MAX_ROM(v) ((v) << 8)
69#define BIB_MAX_RECEIVE(v) ((v) << 12)
70#define BIB_CYC_CLK_ACC(v) ((v) << 16)
71#define BIB_PMC ((1) << 27)
72#define BIB_BMC ((1) << 28)
73#define BIB_ISC ((1) << 29)
74#define BIB_CMC ((1) << 30)
Stefan Richteredd5bda2010-04-14 22:30:18 +020075#define BIB_IRMC ((1) << 31)
76#define NODE_CAPABILITIES 0x0c0083c0 /* per IEEE 1394 clause 8.3.2.6.5.2 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -050077
Clemens Ladischdd5eeb92011-03-07 11:21:15 +010078/*
79 * IEEE-1394 specifies a default SPLIT_TIMEOUT value of 800 cycles (100 ms),
80 * but we have to make it longer because there are many devices whose firmware
81 * is just too slow for that.
82 */
83#define DEFAULT_SPLIT_TIMEOUT (2 * 8000)
84
Stefan Richter60445652011-01-15 18:19:48 +010085#define CANON_OUI 0x000085
86
Stefan Richtere3008392010-01-24 14:47:02 +010087static void generate_config_rom(struct fw_card *card, __be32 *config_rom)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050088{
89 struct fw_descriptor *desc;
Stefan Richter8e859732009-10-08 00:41:59 +020090 int i, j, k, length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050091
Kristian Høgsbergc781c062007-05-07 20:33:32 -040092 /*
93 * Initialize contents of config rom buffer. On the OHCI
Stefan Richter5e20c282007-01-21 20:44:09 +010094 * controller, block reads to the config rom accesses the host
95 * memory, but quadlet read access the hardware bus info block
96 * registers. That's just crack, but it means we should make
Jay Fenlason2cc489c2008-10-22 15:59:42 -040097 * sure the contents of bus info block in host memory matches
Kristian Høgsbergc781c062007-05-07 20:33:32 -040098 * the version stored in the OHCI registers.
99 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500100
Stefan Richter8e859732009-10-08 00:41:59 +0200101 config_rom[0] = cpu_to_be32(
102 BIB_CRC_LENGTH(4) | BIB_INFO_LENGTH(4) | BIB_CRC(0));
Stefan Richteredd5bda2010-04-14 22:30:18 +0200103 config_rom[1] = cpu_to_be32(BIB_BUS_NAME);
Stefan Richter8e859732009-10-08 00:41:59 +0200104 config_rom[2] = cpu_to_be32(
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400105 BIB_LINK_SPEED(card->link_speed) |
106 BIB_GENERATION(card->config_rom_generation++ % 14 + 2) |
107 BIB_MAX_ROM(2) |
108 BIB_MAX_RECEIVE(card->max_receive) |
Stefan Richteredd5bda2010-04-14 22:30:18 +0200109 BIB_BMC | BIB_ISC | BIB_CMC | BIB_IRMC);
Stefan Richter8e859732009-10-08 00:41:59 +0200110 config_rom[3] = cpu_to_be32(card->guid >> 32);
111 config_rom[4] = cpu_to_be32(card->guid);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500112
113 /* Generate root directory. */
Stefan Richteredd5bda2010-04-14 22:30:18 +0200114 config_rom[6] = cpu_to_be32(NODE_CAPABILITIES);
Stefan Richter8e859732009-10-08 00:41:59 +0200115 i = 7;
116 j = 7 + descriptor_count;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500117
118 /* Generate root directory entries for descriptors. */
119 list_for_each_entry (desc, &descriptor_list, link) {
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500120 if (desc->immediate > 0)
Stefan Richter8e859732009-10-08 00:41:59 +0200121 config_rom[i++] = cpu_to_be32(desc->immediate);
122 config_rom[i] = cpu_to_be32(desc->key | (j - i));
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500123 i++;
124 j += desc->length;
125 }
126
127 /* Update root directory length. */
Stefan Richter8e859732009-10-08 00:41:59 +0200128 config_rom[5] = cpu_to_be32((i - 5 - 1) << 16);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500129
130 /* End of root directory, now copy in descriptors. */
131 list_for_each_entry (desc, &descriptor_list, link) {
Stefan Richter8e859732009-10-08 00:41:59 +0200132 for (k = 0; k < desc->length; k++)
133 config_rom[i + k] = cpu_to_be32(desc->data[k]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500134 i += desc->length;
135 }
136
137 /* Calculate CRCs for all blocks in the config rom. This
138 * assumes that CRC length and info length are identical for
139 * the bus info block, which is always the case for this
140 * implementation. */
Kristian Høgsberge1755692007-05-07 20:33:31 -0400141 for (i = 0; i < j; i += length + 1)
Stefan Richtercb7c96d2009-10-08 00:42:53 +0200142 length = fw_compute_block_crc(config_rom + i);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500143
Stefan Richtere3008392010-01-24 14:47:02 +0100144 WARN_ON(j != config_rom_length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500145}
146
Stefan Richter53dca512008-12-14 21:47:04 +0100147static void update_config_roms(void)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500148{
149 struct fw_card *card;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500150
151 list_for_each_entry (card, &card_list, link) {
Stefan Richtere3008392010-01-24 14:47:02 +0100152 generate_config_rom(card, tmp_config_rom);
153 card->driver->set_config_rom(card, tmp_config_rom,
154 config_rom_length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500155 }
156}
157
Stefan Richtere3008392010-01-24 14:47:02 +0100158static size_t required_space(struct fw_descriptor *desc)
159{
160 /* descriptor + entry into root dir + optional immediate entry */
161 return desc->length + 1 + (desc->immediate > 0 ? 1 : 0);
162}
163
Stefan Richter53dca512008-12-14 21:47:04 +0100164int fw_core_add_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500165{
166 size_t i;
Stefan Richtere3008392010-01-24 14:47:02 +0100167 int ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500168
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400169 /*
170 * Check descriptor is valid; the length of all blocks in the
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500171 * descriptor has to add up to exactly the length of the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400172 * block.
173 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500174 i = 0;
175 while (i < desc->length)
176 i += (desc->data[i] >> 16) + 1;
177
178 if (i != desc->length)
Kristian Høgsberg66dea3e2007-03-28 21:26:42 +0200179 return -EINVAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500180
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400181 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500182
Stefan Richtere3008392010-01-24 14:47:02 +0100183 if (config_rom_length + required_space(desc) > 256) {
184 ret = -EBUSY;
185 } else {
186 list_add_tail(&desc->link, &descriptor_list);
187 config_rom_length += required_space(desc);
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500188 descriptor_count++;
Stefan Richtere3008392010-01-24 14:47:02 +0100189 if (desc->immediate > 0)
190 descriptor_count++;
191 update_config_roms();
192 ret = 0;
193 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500194
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400195 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500196
Stefan Richtere3008392010-01-24 14:47:02 +0100197 return ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500198}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400199EXPORT_SYMBOL(fw_core_add_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500200
Stefan Richter53dca512008-12-14 21:47:04 +0100201void fw_core_remove_descriptor(struct fw_descriptor *desc)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500202{
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400203 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500204
205 list_del(&desc->link);
Stefan Richtere3008392010-01-24 14:47:02 +0100206 config_rom_length -= required_space(desc);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500207 descriptor_count--;
Kristian Høgsberg937f6872007-03-07 12:12:36 -0500208 if (desc->immediate > 0)
209 descriptor_count--;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500210 update_config_roms();
211
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400212 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500213}
Jay Fenlasonc76acec2009-05-18 13:08:06 -0400214EXPORT_SYMBOL(fw_core_remove_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500215
Stefan Richter02d37be2010-07-08 16:09:06 +0200216static int reset_bus(struct fw_card *card, bool short_reset)
217{
218 int reg = short_reset ? 5 : 1;
219 int bit = short_reset ? PHY_BUS_SHORT_RESET : PHY_BUS_RESET;
220
221 return card->driver->update_phy_reg(card, reg, 0, bit);
222}
223
224void fw_schedule_bus_reset(struct fw_card *card, bool delayed, bool short_reset)
225{
226 /* We don't try hard to sort out requests of long vs. short resets. */
227 card->br_short = short_reset;
228
229 /* Use an arbitrary short delay to combine multiple reset requests. */
230 fw_card_get(card);
Stefan Richter105e53f2011-05-01 20:50:31 +0200231 if (!queue_delayed_work(fw_workqueue, &card->br_work,
Stefan Richter6ea9e7b2010-10-13 13:39:46 +0200232 delayed ? DIV_ROUND_UP(HZ, 100) : 0))
Stefan Richter02d37be2010-07-08 16:09:06 +0200233 fw_card_put(card);
234}
235EXPORT_SYMBOL(fw_schedule_bus_reset);
236
237static void br_work(struct work_struct *work)
238{
239 struct fw_card *card = container_of(work, struct fw_card, br_work.work);
240
241 /* Delay for 2s after last reset per IEEE 1394 clause 8.2.1. */
242 if (card->reset_jiffies != 0 &&
Clemens Ladische71084a2011-01-22 15:05:03 +0100243 time_before64(get_jiffies_64(), card->reset_jiffies + 2 * HZ)) {
Stefan Richter105e53f2011-05-01 20:50:31 +0200244 if (!queue_delayed_work(fw_workqueue, &card->br_work, 2 * HZ))
Stefan Richter02d37be2010-07-08 16:09:06 +0200245 fw_card_put(card);
246 return;
247 }
248
249 fw_send_phy_config(card, FW_PHY_CONFIG_NO_NODE_ID, card->generation,
250 FW_PHY_CONFIG_CURRENT_GAP_COUNT);
251 reset_bus(card, card->br_short);
252 fw_card_put(card);
253}
254
Stefan Richtercbae7872009-03-10 21:08:37 +0100255static void allocate_broadcast_channel(struct fw_card *card, int generation)
Jay Fenlason6104ee92009-02-23 15:59:34 -0500256{
Stefan Richtercbae7872009-03-10 21:08:37 +0100257 int channel, bandwidth = 0;
Jay Fenlason6104ee92009-02-23 15:59:34 -0500258
Clemens Ladische91b2782010-06-10 08:40:49 +0200259 if (!card->broadcast_channel_allocated) {
260 fw_iso_resource_manage(card, generation, 1ULL << 31,
Stefan Richterf30e6d32011-04-22 15:13:54 +0200261 &channel, &bandwidth, true);
Clemens Ladische91b2782010-06-10 08:40:49 +0200262 if (channel != 31) {
263 fw_notify("failed to allocate broadcast channel\n");
264 return;
265 }
Stefan Richter7889b602009-03-10 21:09:28 +0100266 card->broadcast_channel_allocated = true;
Jay Fenlason6104ee92009-02-23 15:59:34 -0500267 }
Clemens Ladische91b2782010-06-10 08:40:49 +0200268
269 device_for_each_child(card->device, (void *)(long)generation,
270 fw_device_set_broadcast_channel);
Jay Fenlason6104ee92009-02-23 15:59:34 -0500271}
Jay Fenlason6104ee92009-02-23 15:59:34 -0500272
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500273static const char gap_count_table[] = {
274 63, 5, 7, 8, 10, 13, 16, 18, 21, 24, 26, 29, 32, 35, 37, 40
275};
276
Stefan Richter53dca512008-12-14 21:47:04 +0100277void fw_schedule_bm_work(struct fw_card *card, unsigned long delay)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100278{
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100279 fw_card_get(card);
Stefan Richter02d37be2010-07-08 16:09:06 +0200280 if (!schedule_delayed_work(&card->bm_work, delay))
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100281 fw_card_put(card);
282}
283
Stefan Richter02d37be2010-07-08 16:09:06 +0200284static void bm_work(struct work_struct *work)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500285{
Stefan Richter02d37be2010-07-08 16:09:06 +0200286 struct fw_card *card = container_of(work, struct fw_card, bm_work.work);
Stefan Richter10389532010-05-30 19:43:52 +0200287 struct fw_device *root_device, *irm_device;
Stefan Richtercbae7872009-03-10 21:08:37 +0100288 struct fw_node *root_node;
Stefan Richter250b2b62010-06-21 23:24:35 +0200289 int root_id, new_root_id, irm_id, bm_id, local_id;
Stefan Richtercbae7872009-03-10 21:08:37 +0100290 int gap_count, generation, grace, rcode;
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100291 bool do_reset = false;
Stefan Richter62305822009-01-09 20:49:37 +0100292 bool root_device_is_running;
293 bool root_device_is_cmc;
Stefan Richter10389532010-05-30 19:43:52 +0200294 bool irm_is_1394_1995_only;
Stefan Richter60445652011-01-15 18:19:48 +0100295 bool keep_this_irm;
Stefan Richterf30e6d32011-04-22 15:13:54 +0200296 __be32 transaction_data[2];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500297
Stefan Richterae948012010-06-21 23:23:52 +0200298 spin_lock_irq(&card->lock);
Stefan Richter15803472008-02-24 18:57:23 +0100299
Stefan Richtercbae7872009-03-10 21:08:37 +0100300 if (card->local_node == NULL) {
Stefan Richterae948012010-06-21 23:23:52 +0200301 spin_unlock_irq(&card->lock);
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100302 goto out_put_card;
Stefan Richter15803472008-02-24 18:57:23 +0100303 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500304
305 generation = card->generation;
Stefan Richter10389532010-05-30 19:43:52 +0200306
Stefan Richtercbae7872009-03-10 21:08:37 +0100307 root_node = card->root_node;
308 fw_node_get(root_node);
Stefan Richter15803472008-02-24 18:57:23 +0100309 root_device = root_node->data;
Stefan Richter62305822009-01-09 20:49:37 +0100310 root_device_is_running = root_device &&
311 atomic_read(&root_device->state) == FW_DEVICE_RUNNING;
312 root_device_is_cmc = root_device && root_device->cmc;
Stefan Richter10389532010-05-30 19:43:52 +0200313
314 irm_device = card->irm_node->data;
315 irm_is_1394_1995_only = irm_device && irm_device->config_rom &&
316 (irm_device->config_rom[2] & 0x000000f0) == 0;
317
Stefan Richter60445652011-01-15 18:19:48 +0100318 /* Canon MV5i works unreliably if it is not root node. */
319 keep_this_irm = irm_device && irm_device->config_rom &&
320 irm_device->config_rom[3] >> 8 == CANON_OUI;
321
Stefan Richtercbae7872009-03-10 21:08:37 +0100322 root_id = root_node->node_id;
323 irm_id = card->irm_node->node_id;
324 local_id = card->local_node->node_id;
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100325
Clemens Ladische71084a2011-01-22 15:05:03 +0100326 grace = time_after64(get_jiffies_64(),
327 card->reset_jiffies + DIV_ROUND_UP(HZ, 8));
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100328
Clemens Ladisch7e0e314f2010-06-10 08:37:15 +0200329 if ((is_next_generation(generation, card->bm_generation) &&
330 !card->bm_abdicate) ||
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500331 (card->bm_generation != generation && grace)) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400332 /*
333 * This first step is to figure out who is IRM and
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500334 * then try to become bus manager. If the IRM is not
335 * well defined (e.g. does not have an active link
336 * layer or does not responds to our lock request, we
337 * will have to do a little vigilante bus management.
338 * In that case, we do a goto into the gap count logic
339 * so that when we do the reset, we still optimize the
340 * gap count. That could well save a reset in the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400341 * next generation.
342 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500343
Stefan Richtercbae7872009-03-10 21:08:37 +0100344 if (!card->irm_node->link_on) {
345 new_root_id = local_id;
Stefan Richter10389532010-05-30 19:43:52 +0200346 fw_notify("%s, making local node (%02x) root.\n",
347 "IRM has link off", new_root_id);
348 goto pick_me;
349 }
350
Stefan Richter60445652011-01-15 18:19:48 +0100351 if (irm_is_1394_1995_only && !keep_this_irm) {
Stefan Richter10389532010-05-30 19:43:52 +0200352 new_root_id = local_id;
353 fw_notify("%s, making local node (%02x) root.\n",
354 "IRM is not 1394a compliant", new_root_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500355 goto pick_me;
356 }
357
Stefan Richterf30e6d32011-04-22 15:13:54 +0200358 transaction_data[0] = cpu_to_be32(0x3f);
359 transaction_data[1] = cpu_to_be32(local_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500360
Stefan Richterae948012010-06-21 23:23:52 +0200361 spin_unlock_irq(&card->lock);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500362
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200363 rcode = fw_run_transaction(card, TCODE_LOCK_COMPARE_SWAP,
364 irm_id, generation, SCODE_100,
365 CSR_REGISTER_BASE + CSR_BUS_MANAGER_ID,
Stefan Richterf30e6d32011-04-22 15:13:54 +0200366 transaction_data, 8);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500367
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200368 if (rcode == RCODE_GENERATION)
369 /* Another bus reset, BM work has been rescheduled. */
Stefan Richter15803472008-02-24 18:57:23 +0100370 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500371
Stefan Richterf30e6d32011-04-22 15:13:54 +0200372 bm_id = be32_to_cpu(transaction_data[0]);
Stefan Richtercbae7872009-03-10 21:08:37 +0100373
Stefan Richter250b2b62010-06-21 23:24:35 +0200374 spin_lock_irq(&card->lock);
375 if (rcode == RCODE_COMPLETE && generation == card->generation)
376 card->bm_node_id =
377 bm_id == 0x3f ? local_id : 0xffc0 | bm_id;
378 spin_unlock_irq(&card->lock);
379
380 if (rcode == RCODE_COMPLETE && bm_id != 0x3f) {
Stefan Richtercbae7872009-03-10 21:08:37 +0100381 /* Somebody else is BM. Only act as IRM. */
382 if (local_id == irm_id)
383 allocate_broadcast_channel(card, generation);
384
Stefan Richter15803472008-02-24 18:57:23 +0100385 goto out;
Jay Fenlason6104ee92009-02-23 15:59:34 -0500386 }
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500387
Clemens Ladischbda3b8a2010-06-10 08:23:28 +0200388 if (rcode == RCODE_SEND_ERROR) {
389 /*
390 * We have been unable to send the lock request due to
391 * some local problem. Let's try again later and hope
392 * that the problem has gone away by then.
393 */
394 fw_schedule_bm_work(card, DIV_ROUND_UP(HZ, 8));
395 goto out;
396 }
397
Stefan Richterae948012010-06-21 23:23:52 +0200398 spin_lock_irq(&card->lock);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200399
Stefan Richter60445652011-01-15 18:19:48 +0100400 if (rcode != RCODE_COMPLETE && !keep_this_irm) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400401 /*
402 * The lock request failed, maybe the IRM
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500403 * isn't really IRM capable after all. Let's
404 * do a bus reset and pick the local node as
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400405 * root, and thus, IRM.
406 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100407 new_root_id = local_id;
Stefan Richter10389532010-05-30 19:43:52 +0200408 fw_notify("%s, making local node (%02x) root.\n",
409 "BM lock failed", new_root_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500410 goto pick_me;
411 }
412 } else if (card->bm_generation != generation) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400413 /*
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100414 * We weren't BM in the last generation, and the last
415 * bus reset is less than 125ms ago. Reschedule this job.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400416 */
Stefan Richterae948012010-06-21 23:23:52 +0200417 spin_unlock_irq(&card->lock);
Stefan Richtere1dc7ca2009-03-10 21:07:46 +0100418 fw_schedule_bm_work(card, DIV_ROUND_UP(HZ, 8));
Stefan Richter15803472008-02-24 18:57:23 +0100419 goto out;
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500420 }
421
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400422 /*
423 * We're bus manager for this generation, so next step is to
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500424 * make sure we have an active cycle master and do gap count
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400425 * optimization.
426 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500427 card->bm_generation = generation;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500428
Stefan Richter15803472008-02-24 18:57:23 +0100429 if (root_device == NULL) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400430 /*
431 * Either link_on is false, or we failed to read the
432 * config rom. In either case, pick another root.
433 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100434 new_root_id = local_id;
Stefan Richter62305822009-01-09 20:49:37 +0100435 } else if (!root_device_is_running) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400436 /*
437 * If we haven't probed this device yet, bail out now
438 * and let's try again once that's done.
439 */
Stefan Richterae948012010-06-21 23:23:52 +0200440 spin_unlock_irq(&card->lock);
Stefan Richter15803472008-02-24 18:57:23 +0100441 goto out;
Stefan Richter62305822009-01-09 20:49:37 +0100442 } else if (root_device_is_cmc) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400443 /*
Clemens Ladischc374ab42010-06-10 08:41:51 +0200444 * We will send out a force root packet for this
445 * node as part of the gap count optimization.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400446 */
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500447 new_root_id = root_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500448 } else {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400449 /*
450 * Current root has an active link layer and we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500451 * successfully read the config rom, but it's not
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400452 * cycle master capable.
453 */
Stefan Richtercbae7872009-03-10 21:08:37 +0100454 new_root_id = local_id;
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500455 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500456
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500457 pick_me:
Stefan Richter24d40122007-06-18 19:44:12 +0200458 /*
459 * Pick a gap count from 1394a table E-1. The table doesn't cover
460 * the typically much larger 1394b beta repeater delays though.
461 */
462 if (!card->beta_repeaters_present &&
Stefan Richter15803472008-02-24 18:57:23 +0100463 root_node->max_hops < ARRAY_SIZE(gap_count_table))
464 gap_count = gap_count_table[root_node->max_hops];
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500465 else
466 gap_count = 63;
467
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400468 /*
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100469 * Finally, figure out if we should do a reset or not. If we have
470 * done less than 5 resets with the same physical topology and we
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400471 * have either a new root or a new gap count setting, let's do it.
472 */
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500473
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500474 if (card->bm_retries++ < 5 &&
475 (card->gap_count != gap_count || new_root_id != root_id))
Stefan Richter25b1c3d2008-03-24 20:57:12 +0100476 do_reset = true;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500477
Stefan Richterae948012010-06-21 23:23:52 +0200478 spin_unlock_irq(&card->lock);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500479
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500480 if (do_reset) {
481 fw_notify("phy config: card %d, new root=%x, gap_count=%d\n",
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500482 card->index, new_root_id, gap_count);
483 fw_send_phy_config(card, new_root_id, generation, gap_count);
Stefan Richter02d37be2010-07-08 16:09:06 +0200484 reset_bus(card, true);
Stefan Richtercbae7872009-03-10 21:08:37 +0100485 /* Will allocate broadcast channel after the reset. */
Clemens Ladischc374ab42010-06-10 08:41:51 +0200486 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500487 }
Jay Fenlason6104ee92009-02-23 15:59:34 -0500488
Clemens Ladischc374ab42010-06-10 08:41:51 +0200489 if (root_device_is_cmc) {
490 /*
491 * Make sure that the cycle master sends cycle start packets.
492 */
Stefan Richterf30e6d32011-04-22 15:13:54 +0200493 transaction_data[0] = cpu_to_be32(CSR_STATE_BIT_CMSTR);
Clemens Ladischc374ab42010-06-10 08:41:51 +0200494 rcode = fw_run_transaction(card, TCODE_WRITE_QUADLET_REQUEST,
495 root_id, generation, SCODE_100,
496 CSR_REGISTER_BASE + CSR_STATE_SET,
Stefan Richterf30e6d32011-04-22 15:13:54 +0200497 transaction_data, 4);
Clemens Ladischc374ab42010-06-10 08:41:51 +0200498 if (rcode == RCODE_GENERATION)
499 goto out;
500 }
501
502 if (local_id == irm_id)
503 allocate_broadcast_channel(card, generation);
504
Stefan Richter15803472008-02-24 18:57:23 +0100505 out:
Stefan Richter15803472008-02-24 18:57:23 +0100506 fw_node_put(root_node);
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100507 out_put_card:
508 fw_card_put(card);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500509}
510
Stefan Richter53dca512008-12-14 21:47:04 +0100511void fw_card_initialize(struct fw_card *card,
512 const struct fw_card_driver *driver,
513 struct device *device)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500514{
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500515 static atomic_t index = ATOMIC_INIT(-1);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500516
Kristian Høgsbergbbf19db2007-02-06 14:49:38 -0500517 card->index = atomic_inc_return(&index);
Stefan Richter5e20c282007-01-21 20:44:09 +0100518 card->driver = driver;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500519 card->device = device;
Stefan Richter5e20c282007-01-21 20:44:09 +0100520 card->current_tlabel = 0;
521 card->tlabel_mask = 0;
Clemens Ladischdd5eeb92011-03-07 11:21:15 +0100522 card->split_timeout_hi = DEFAULT_SPLIT_TIMEOUT / 8000;
523 card->split_timeout_lo = (DEFAULT_SPLIT_TIMEOUT % 8000) << 19;
524 card->split_timeout_cycles = DEFAULT_SPLIT_TIMEOUT;
525 card->split_timeout_jiffies =
526 DIV_ROUND_UP(DEFAULT_SPLIT_TIMEOUT * HZ, 8000);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500527 card->color = 0;
Stefan Richtere534fe12008-05-24 16:41:09 +0200528 card->broadcast_channel = BROADCAST_CHANNEL_INITIAL;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500529
Stefan Richter459f7922008-05-24 16:50:22 +0200530 kref_init(&card->kref);
531 init_completion(&card->done);
Stefan Richter5e20c282007-01-21 20:44:09 +0100532 INIT_LIST_HEAD(&card->transaction_list);
Stefan Richterbf54e142010-07-16 22:25:51 +0200533 INIT_LIST_HEAD(&card->phy_receiver_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500534 spin_lock_init(&card->lock);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500535
536 card->local_node = NULL;
537
Stefan Richter02d37be2010-07-08 16:09:06 +0200538 INIT_DELAYED_WORK(&card->br_work, br_work);
539 INIT_DELAYED_WORK(&card->bm_work, bm_work);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500540}
541EXPORT_SYMBOL(fw_card_initialize);
542
Stefan Richter53dca512008-12-14 21:47:04 +0100543int fw_card_add(struct fw_card *card,
544 u32 max_receive, u32 link_speed, u64 guid)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500545{
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100546 int ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500547
548 card->max_receive = max_receive;
549 card->link_speed = link_speed;
550 card->guid = guid;
551
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400552 mutex_lock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500553
Stefan Richtere3008392010-01-24 14:47:02 +0100554 generate_config_rom(card, tmp_config_rom);
555 ret = card->driver->enable(card, tmp_config_rom, config_rom_length);
Stefan Richterb171e202009-09-06 18:50:29 +0200556 if (ret == 0)
557 list_add_tail(&card->link, &card_list);
558
559 mutex_unlock(&card_mutex);
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100560
561 return ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500562}
563EXPORT_SYMBOL(fw_card_add);
564
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400565/*
Stefan Richterd645f4d2009-06-16 19:15:25 +0200566 * The next few functions implement a dummy driver that is used once a card
567 * driver shuts down an fw_card. This allows the driver to cleanly unload,
568 * as all IO to the card will be handled (and failed) by the dummy driver
569 * instead of calling into the module. Only functions for iso context
570 * shutdown still need to be provided by the card driver.
Stefan Richter20802222010-08-01 12:23:14 +0200571 *
572 * .read/write_csr() should never be called anymore after the dummy driver
573 * was bound since they are only used within request handler context.
574 * .set_config_rom() is never called since the card is taken out of card_list
575 * before switching to the dummy driver.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400576 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500577
Stefan Richter02d37be2010-07-08 16:09:06 +0200578static int dummy_read_phy_reg(struct fw_card *card, int address)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500579{
Stefan Richter02d37be2010-07-08 16:09:06 +0200580 return -ENODEV;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500581}
582
Stefan Richter53dca512008-12-14 21:47:04 +0100583static int dummy_update_phy_reg(struct fw_card *card, int address,
584 int clear_bits, int set_bits)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500585{
586 return -ENODEV;
587}
588
Stefan Richter53dca512008-12-14 21:47:04 +0100589static void dummy_send_request(struct fw_card *card, struct fw_packet *packet)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500590{
Stefan Richter18d0cdf2010-07-18 12:44:01 +0200591 packet->callback(packet, card, RCODE_CANCELLED);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500592}
593
Stefan Richter53dca512008-12-14 21:47:04 +0100594static void dummy_send_response(struct fw_card *card, struct fw_packet *packet)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500595{
Stefan Richter18d0cdf2010-07-18 12:44:01 +0200596 packet->callback(packet, card, RCODE_CANCELLED);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500597}
598
Stefan Richter53dca512008-12-14 21:47:04 +0100599static int dummy_cancel_packet(struct fw_card *card, struct fw_packet *packet)
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500600{
601 return -ENOENT;
602}
603
Stefan Richter53dca512008-12-14 21:47:04 +0100604static int dummy_enable_phys_dma(struct fw_card *card,
605 int node_id, int generation)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500606{
607 return -ENODEV;
608}
609
Stefan Richter20802222010-08-01 12:23:14 +0200610static struct fw_iso_context *dummy_allocate_iso_context(struct fw_card *card,
611 int type, int channel, size_t header_size)
612{
613 return ERR_PTR(-ENODEV);
614}
615
616static int dummy_start_iso(struct fw_iso_context *ctx,
617 s32 cycle, u32 sync, u32 tags)
618{
619 return -ENODEV;
620}
621
622static int dummy_set_iso_channels(struct fw_iso_context *ctx, u64 *channels)
623{
624 return -ENODEV;
625}
626
627static int dummy_queue_iso(struct fw_iso_context *ctx, struct fw_iso_packet *p,
628 struct fw_iso_buffer *buffer, unsigned long payload)
629{
630 return -ENODEV;
631}
632
Clemens Ladisch13882a82011-05-02 09:33:56 +0200633static void dummy_flush_queue_iso(struct fw_iso_context *ctx)
634{
635}
636
Stefan Richterd645f4d2009-06-16 19:15:25 +0200637static const struct fw_card_driver dummy_driver_template = {
Stefan Richter20802222010-08-01 12:23:14 +0200638 .read_phy_reg = dummy_read_phy_reg,
639 .update_phy_reg = dummy_update_phy_reg,
640 .send_request = dummy_send_request,
641 .send_response = dummy_send_response,
642 .cancel_packet = dummy_cancel_packet,
643 .enable_phys_dma = dummy_enable_phys_dma,
644 .allocate_iso_context = dummy_allocate_iso_context,
645 .start_iso = dummy_start_iso,
646 .set_iso_channels = dummy_set_iso_channels,
647 .queue_iso = dummy_queue_iso,
Clemens Ladisch13882a82011-05-02 09:33:56 +0200648 .flush_queue_iso = dummy_flush_queue_iso,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500649};
650
Stefan Richter53dca512008-12-14 21:47:04 +0100651void fw_card_release(struct kref *kref)
Stefan Richter459f7922008-05-24 16:50:22 +0200652{
653 struct fw_card *card = container_of(kref, struct fw_card, kref);
654
655 complete(&card->done);
656}
657
Stefan Richter53dca512008-12-14 21:47:04 +0100658void fw_core_remove_card(struct fw_card *card)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500659{
Stefan Richterd645f4d2009-06-16 19:15:25 +0200660 struct fw_card_driver dummy_driver = dummy_driver_template;
661
Marc Butlerecab4132007-03-23 10:24:02 -0600662 card->driver->update_phy_reg(card, 4,
663 PHY_LINK_ACTIVE | PHY_CONTENDER, 0);
Stefan Richter02d37be2010-07-08 16:09:06 +0200664 fw_schedule_bus_reset(card, false, true);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500665
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400666 mutex_lock(&card_mutex);
Stefan Richtere747a5c2009-01-24 20:35:38 +0100667 list_del_init(&card->link);
Kristian Høgsberg6a5033b2007-05-07 20:33:33 -0400668 mutex_unlock(&card_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500669
Stefan Richterd645f4d2009-06-16 19:15:25 +0200670 /* Switch off most of the card driver interface. */
671 dummy_driver.free_iso_context = card->driver->free_iso_context;
672 dummy_driver.stop_iso = card->driver->stop_iso;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500673 card->driver = &dummy_driver;
674
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500675 fw_destroy_nodes(card);
Stefan Richter459f7922008-05-24 16:50:22 +0200676
677 /* Wait for all users, especially device workqueue jobs, to finish. */
678 fw_card_put(card);
679 wait_for_completion(&card->done);
Stefan Richter8a2d9ed2007-08-21 01:05:14 +0200680
Stefan Richter1e8afea2008-07-12 14:51:18 +0200681 WARN_ON(!list_empty(&card->transaction_list));
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500682}
683EXPORT_SYMBOL(fw_core_remove_card);