blob: d6a09b9cd8ccae2c35cee866ac35b1d4ba066975 [file] [log] [blame]
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001/*
2 * Core IEEE1394 transaction logic
Kristian Høgsberg3038e352006-12-19 19:58:27 -05003 *
4 * Copyright (C) 2004-2006 Kristian Hoegsberg <krh@bitplanet.net>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
Stefan Richtere8ca9702009-06-04 21:09:38 +020021#include <linux/bug.h>
Stefan Richter2a0a2592008-03-20 23:48:23 +010022#include <linux/completion.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020023#include <linux/device.h>
24#include <linux/errno.h>
Stefan Richter77c9a5d2009-06-05 16:26:18 +020025#include <linux/firewire.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020026#include <linux/firewire-constants.h>
27#include <linux/fs.h>
Kristian Høgsberg3038e352006-12-19 19:58:27 -050028#include <linux/init.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020029#include <linux/idr.h>
30#include <linux/jiffies.h>
31#include <linux/kernel.h>
Kristian Høgsberg3038e352006-12-19 19:58:27 -050032#include <linux/list.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020033#include <linux/module.h>
Peter Hurley35202f72012-08-19 02:50:02 -040034#include <linux/rculist.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020035#include <linux/slab.h>
36#include <linux/spinlock.h>
37#include <linux/string.h>
38#include <linux/timer.h>
39#include <linux/types.h>
Stefan Richter6ea9e7b2010-10-13 13:39:46 +020040#include <linux/workqueue.h>
Kristian Høgsberg3038e352006-12-19 19:58:27 -050041
Stefan Richtere8ca9702009-06-04 21:09:38 +020042#include <asm/byteorder.h>
43
Stefan Richter77c9a5d2009-06-05 16:26:18 +020044#include "core.h"
Kristian Høgsberg3038e352006-12-19 19:58:27 -050045
Kristian Høgsberga77754a2007-05-07 20:33:35 -040046#define HEADER_PRI(pri) ((pri) << 0)
47#define HEADER_TCODE(tcode) ((tcode) << 4)
48#define HEADER_RETRY(retry) ((retry) << 8)
49#define HEADER_TLABEL(tlabel) ((tlabel) << 10)
50#define HEADER_DESTINATION(destination) ((destination) << 16)
51#define HEADER_SOURCE(source) ((source) << 16)
52#define HEADER_RCODE(rcode) ((rcode) << 12)
53#define HEADER_OFFSET_HIGH(offset_high) ((offset_high) << 0)
54#define HEADER_DATA_LENGTH(length) ((length) << 16)
55#define HEADER_EXTENDED_TCODE(tcode) ((tcode) << 0)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050056
Kristian Høgsberga77754a2007-05-07 20:33:35 -040057#define HEADER_GET_TCODE(q) (((q) >> 4) & 0x0f)
58#define HEADER_GET_TLABEL(q) (((q) >> 10) & 0x3f)
59#define HEADER_GET_RCODE(q) (((q) >> 12) & 0x0f)
60#define HEADER_GET_DESTINATION(q) (((q) >> 16) & 0xffff)
61#define HEADER_GET_SOURCE(q) (((q) >> 16) & 0xffff)
62#define HEADER_GET_OFFSET_HIGH(q) (((q) >> 0) & 0xffff)
63#define HEADER_GET_DATA_LENGTH(q) (((q) >> 16) & 0xffff)
64#define HEADER_GET_EXTENDED_TCODE(q) (((q) >> 0) & 0xffff)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050065
Stefan Richtera7ea6782008-05-25 11:06:55 +020066#define HEADER_DESTINATION_IS_BROADCAST(q) \
67 (((q) & HEADER_DESTINATION(0x3f)) == HEADER_DESTINATION(0x3f))
68
Stefan Richter77c9a5d2009-06-05 16:26:18 +020069#define PHY_PACKET_CONFIG 0x0
70#define PHY_PACKET_LINK_ON 0x1
71#define PHY_PACKET_SELF_ID 0x2
72
Kristian Høgsberga77754a2007-05-07 20:33:35 -040073#define PHY_CONFIG_GAP_COUNT(gap_count) (((gap_count) << 16) | (1 << 22))
74#define PHY_CONFIG_ROOT_ID(node_id) ((((node_id) & 0x3f) << 24) | (1 << 23))
75#define PHY_IDENTIFIER(id) ((id) << 30)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050076
Clemens Ladisch410cf2b2010-12-13 14:56:02 +010077/* returns 0 if the split timeout handler is already running */
78static int try_cancel_split_timeout(struct fw_transaction *t)
79{
80 if (t->is_split_transaction)
81 return del_timer(&t->split_timeout_timer);
82 else
83 return 1;
84}
85
Stefan Richter53dca512008-12-14 21:47:04 +010086static int close_transaction(struct fw_transaction *transaction,
Stefan Richtera38a00f2009-03-10 21:07:06 +010087 struct fw_card *card, int rcode)
Kristian Høgsberg3038e352006-12-19 19:58:27 -050088{
Kristian Høgsberg730c32f2007-02-06 14:49:32 -050089 struct fw_transaction *t;
Kristian Høgsberg3038e352006-12-19 19:58:27 -050090 unsigned long flags;
91
92 spin_lock_irqsave(&card->lock, flags);
Kristian Høgsberg730c32f2007-02-06 14:49:32 -050093 list_for_each_entry(t, &card->transaction_list, link) {
94 if (t == transaction) {
Clemens Ladisch410cf2b2010-12-13 14:56:02 +010095 if (!try_cancel_split_timeout(t)) {
Clemens Ladisch2222bcb2010-08-18 15:05:02 +020096 spin_unlock_irqrestore(&card->lock, flags);
97 goto timed_out;
98 }
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +020099 list_del_init(&t->link);
Stefan Richter1e626fd2009-06-14 13:23:58 +0200100 card->tlabel_mask &= ~(1ULL << t->tlabel);
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500101 break;
102 }
103 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500104 spin_unlock_irqrestore(&card->lock, flags);
105
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500106 if (&t->link != &card->transaction_list) {
Stefan Richtera38a00f2009-03-10 21:07:06 +0100107 t->callback(card, rcode, NULL, 0, t->callback_data);
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500108 return 0;
109 }
110
Clemens Ladisch2222bcb2010-08-18 15:05:02 +0200111 timed_out:
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500112 return -ENOENT;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500113}
114
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400115/*
116 * Only valid for transactions that are potentially pending (ie have
117 * been sent).
118 */
Stefan Richter53dca512008-12-14 21:47:04 +0100119int fw_cancel_transaction(struct fw_card *card,
120 struct fw_transaction *transaction)
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500121{
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400122 /*
123 * Cancel the packet transmission if it's still queued. That
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500124 * will call the packet transmission callback which cancels
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400125 * the transaction.
126 */
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500127
128 if (card->driver->cancel_packet(card, &transaction->packet) == 0)
129 return 0;
130
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400131 /*
132 * If the request packet has already been sent, we need to see
133 * if the transaction is still pending and remove it in that case.
134 */
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500135
Stefan Richtera38a00f2009-03-10 21:07:06 +0100136 return close_transaction(transaction, card, RCODE_CANCELLED);
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500137}
138EXPORT_SYMBOL(fw_cancel_transaction);
139
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +0200140static void split_transaction_timeout_callback(unsigned long data)
141{
142 struct fw_transaction *t = (struct fw_transaction *)data;
143 struct fw_card *card = t->card;
144 unsigned long flags;
145
146 spin_lock_irqsave(&card->lock, flags);
147 if (list_empty(&t->link)) {
148 spin_unlock_irqrestore(&card->lock, flags);
149 return;
150 }
151 list_del(&t->link);
152 card->tlabel_mask &= ~(1ULL << t->tlabel);
153 spin_unlock_irqrestore(&card->lock, flags);
154
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +0200155 t->callback(card, RCODE_CANCELLED, NULL, 0, t->callback_data);
156}
157
Clemens Ladisch410cf2b2010-12-13 14:56:02 +0100158static void start_split_transaction_timeout(struct fw_transaction *t,
159 struct fw_card *card)
160{
161 unsigned long flags;
162
163 spin_lock_irqsave(&card->lock, flags);
164
165 if (list_empty(&t->link) || WARN_ON(t->is_split_transaction)) {
166 spin_unlock_irqrestore(&card->lock, flags);
167 return;
168 }
169
170 t->is_split_transaction = true;
171 mod_timer(&t->split_timeout_timer,
172 jiffies + card->split_timeout_jiffies);
173
174 spin_unlock_irqrestore(&card->lock, flags);
175}
176
Stefan Richter53dca512008-12-14 21:47:04 +0100177static void transmit_complete_callback(struct fw_packet *packet,
178 struct fw_card *card, int status)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500179{
180 struct fw_transaction *t =
181 container_of(packet, struct fw_transaction, packet);
182
183 switch (status) {
184 case ACK_COMPLETE:
Stefan Richtera38a00f2009-03-10 21:07:06 +0100185 close_transaction(t, card, RCODE_COMPLETE);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500186 break;
187 case ACK_PENDING:
Clemens Ladisch410cf2b2010-12-13 14:56:02 +0100188 start_split_transaction_timeout(t, card);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500189 break;
190 case ACK_BUSY_X:
191 case ACK_BUSY_A:
192 case ACK_BUSY_B:
Stefan Richtera38a00f2009-03-10 21:07:06 +0100193 close_transaction(t, card, RCODE_BUSY);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500194 break;
195 case ACK_DATA_ERROR:
Stefan Richtera38a00f2009-03-10 21:07:06 +0100196 close_transaction(t, card, RCODE_DATA_ERROR);
Kristian Høgsberge5f49c32007-01-26 00:38:34 -0500197 break;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500198 case ACK_TYPE_ERROR:
Stefan Richtera38a00f2009-03-10 21:07:06 +0100199 close_transaction(t, card, RCODE_TYPE_ERROR);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500200 break;
201 default:
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400202 /*
203 * In this case the ack is really a juju specific
204 * rcode, so just forward that to the callback.
205 */
Stefan Richtera38a00f2009-03-10 21:07:06 +0100206 close_transaction(t, card, status);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500207 break;
208 }
209}
210
Stefan Richter53dca512008-12-14 21:47:04 +0100211static void fw_fill_request(struct fw_packet *packet, int tcode, int tlabel,
Stefan Richterb9549bc2008-07-12 14:50:42 +0200212 int destination_id, int source_id, int generation, int speed,
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500213 unsigned long long offset, void *payload, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500214{
215 int ext_tcode;
216
Stefan Richter18e9b10f2009-03-10 21:02:21 +0100217 if (tcode == TCODE_STREAM_DATA) {
218 packet->header[0] =
219 HEADER_DATA_LENGTH(length) |
220 destination_id |
221 HEADER_TCODE(TCODE_STREAM_DATA);
222 packet->header_length = 4;
223 packet->payload = payload;
224 packet->payload_length = length;
225
226 goto common;
227 }
228
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500229 if (tcode > 0x10) {
Jarod Wilson8f9f9632008-01-23 16:05:45 -0500230 ext_tcode = tcode & ~0x10;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500231 tcode = TCODE_LOCK_REQUEST;
232 } else
233 ext_tcode = 0;
234
235 packet->header[0] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400236 HEADER_RETRY(RETRY_X) |
237 HEADER_TLABEL(tlabel) |
238 HEADER_TCODE(tcode) |
Stefan Richterb9549bc2008-07-12 14:50:42 +0200239 HEADER_DESTINATION(destination_id);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500240 packet->header[1] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400241 HEADER_OFFSET_HIGH(offset >> 32) | HEADER_SOURCE(source_id);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500242 packet->header[2] =
243 offset;
244
245 switch (tcode) {
246 case TCODE_WRITE_QUADLET_REQUEST:
247 packet->header[3] = *(u32 *)payload;
248 packet->header_length = 16;
249 packet->payload_length = 0;
250 break;
251
252 case TCODE_LOCK_REQUEST:
253 case TCODE_WRITE_BLOCK_REQUEST:
254 packet->header[3] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400255 HEADER_DATA_LENGTH(length) |
256 HEADER_EXTENDED_TCODE(ext_tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500257 packet->header_length = 16;
258 packet->payload = payload;
259 packet->payload_length = length;
260 break;
261
262 case TCODE_READ_QUADLET_REQUEST:
263 packet->header_length = 12;
264 packet->payload_length = 0;
265 break;
266
267 case TCODE_READ_BLOCK_REQUEST:
268 packet->header[3] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400269 HEADER_DATA_LENGTH(length) |
270 HEADER_EXTENDED_TCODE(ext_tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500271 packet->header_length = 16;
272 packet->payload_length = 0;
273 break;
Stefan Richter5b189bf2009-10-14 20:37:36 +0200274
275 default:
Joe Perches58787302010-10-30 14:08:27 -0700276 WARN(1, "wrong tcode %d\n", tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500277 }
Stefan Richter18e9b10f2009-03-10 21:02:21 +0100278 common:
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500279 packet->speed = speed;
280 packet->generation = generation;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500281 packet->ack = 0;
Stefan Richter19593ff2009-10-14 20:40:10 +0200282 packet->payload_mapped = false;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500283}
284
Clemens Ladisch79060542010-04-19 17:29:14 +0200285static int allocate_tlabel(struct fw_card *card)
286{
287 int tlabel;
288
289 tlabel = card->current_tlabel;
290 while (card->tlabel_mask & (1ULL << tlabel)) {
291 tlabel = (tlabel + 1) & 0x3f;
292 if (tlabel == card->current_tlabel)
293 return -EBUSY;
294 }
295
296 card->current_tlabel = (tlabel + 1) & 0x3f;
297 card->tlabel_mask |= 1ULL << tlabel;
298
299 return tlabel;
300}
301
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500302/**
Stefan Richter656b7af2010-07-07 13:26:18 +0200303 * fw_send_request() - submit a request packet for transmission
304 * @card: interface to send the request at
305 * @t: transaction instance to which the request belongs
306 * @tcode: transaction code
307 * @destination_id: destination node ID, consisting of bus_ID and phy_ID
308 * @generation: bus generation in which request and response are valid
309 * @speed: transmission speed
310 * @offset: 48bit wide offset into destination's address space
311 * @payload: data payload for the request subaction
312 * @length: length of the payload, in bytes
313 * @callback: function to be called when the transaction is completed
314 * @callback_data: data to be passed to the transaction completion callback
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500315 *
Stefan Richter656b7af2010-07-07 13:26:18 +0200316 * Submit a request packet into the asynchronous request transmission queue.
317 * Can be called from atomic context. If you prefer a blocking API, use
318 * fw_run_transaction() in a context that can sleep.
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500319 *
Stefan Richter656b7af2010-07-07 13:26:18 +0200320 * In case of lock requests, specify one of the firewire-core specific %TCODE_
321 * constants instead of %TCODE_LOCK_REQUEST in @tcode.
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500322 *
Stefan Richter656b7af2010-07-07 13:26:18 +0200323 * Make sure that the value in @destination_id is not older than the one in
324 * @generation. Otherwise the request is in danger to be sent to a wrong node.
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500325 *
Stefan Richter656b7af2010-07-07 13:26:18 +0200326 * In case of asynchronous stream packets i.e. %TCODE_STREAM_DATA, the caller
Stefan Richter18e9b10f2009-03-10 21:02:21 +0100327 * needs to synthesize @destination_id with fw_stream_packet_destination_id().
Stefan Richter656b7af2010-07-07 13:26:18 +0200328 * It will contain tag, channel, and sy data instead of a node ID then.
329 *
330 * The payload buffer at @data is going to be DMA-mapped except in case of
Stefan Richterf30e6d32011-04-22 15:13:54 +0200331 * @length <= 8 or of local (loopback) requests. Hence make sure that the
332 * buffer complies with the restrictions of the streaming DMA mapping API.
Stefan Richter656b7af2010-07-07 13:26:18 +0200333 * @payload must not be freed before the @callback is called.
334 *
335 * In case of request types without payload, @data is NULL and @length is 0.
336 *
337 * After the transaction is completed successfully or unsuccessfully, the
338 * @callback will be called. Among its parameters is the response code which
339 * is either one of the rcodes per IEEE 1394 or, in case of internal errors,
Stefan Richter18d0cdf2010-07-18 12:44:01 +0200340 * the firewire-core specific %RCODE_SEND_ERROR. The other firewire-core
341 * specific rcodes (%RCODE_CANCELLED, %RCODE_BUSY, %RCODE_GENERATION,
342 * %RCODE_NO_ACK) denote transaction timeout, busy responder, stale request
343 * generation, or missing ACK respectively.
Stefan Richter656b7af2010-07-07 13:26:18 +0200344 *
345 * Note some timing corner cases: fw_send_request() may complete much earlier
346 * than when the request packet actually hits the wire. On the other hand,
347 * transaction completion and hence execution of @callback may happen even
348 * before fw_send_request() returns.
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500349 */
Stefan Richter53dca512008-12-14 21:47:04 +0100350void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode,
351 int destination_id, int generation, int speed,
352 unsigned long long offset, void *payload, size_t length,
353 fw_transaction_callback_t callback, void *callback_data)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500354{
355 unsigned long flags;
Stefan Richterb9549bc2008-07-12 14:50:42 +0200356 int tlabel;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500357
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400358 /*
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400359 * Allocate tlabel from the bitmap and put the transaction on
360 * the list while holding the card spinlock.
361 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500362
363 spin_lock_irqsave(&card->lock, flags);
364
Clemens Ladisch79060542010-04-19 17:29:14 +0200365 tlabel = allocate_tlabel(card);
366 if (tlabel < 0) {
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500367 spin_unlock_irqrestore(&card->lock, flags);
368 callback(card, RCODE_SEND_ERROR, NULL, 0, callback_data);
369 return;
370 }
371
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200372 t->node_id = destination_id;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500373 t->tlabel = tlabel;
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +0200374 t->card = card;
Clemens Ladisch410cf2b2010-12-13 14:56:02 +0100375 t->is_split_transaction = false;
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +0200376 setup_timer(&t->split_timeout_timer,
377 split_transaction_timeout_callback, (unsigned long)t);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500378 t->callback = callback;
379 t->callback_data = callback_data;
380
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200381 fw_fill_request(&t->packet, tcode, t->tlabel,
382 destination_id, card->node_id, generation,
383 speed, offset, payload, length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500384 t->packet.callback = transmit_complete_callback;
385
Stefan Richtere9aeb462008-07-12 14:50:06 +0200386 list_add_tail(&t->link, &card->transaction_list);
387
388 spin_unlock_irqrestore(&card->lock, flags);
389
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500390 card->driver->send_request(card, &t->packet);
391}
392EXPORT_SYMBOL(fw_send_request);
393
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200394struct transaction_callback_data {
395 struct completion done;
396 void *payload;
397 int rcode;
398};
399
400static void transaction_callback(struct fw_card *card, int rcode,
401 void *payload, size_t length, void *data)
402{
403 struct transaction_callback_data *d = data;
404
405 if (rcode == RCODE_COMPLETE)
406 memcpy(d->payload, payload, length);
407 d->rcode = rcode;
408 complete(&d->done);
409}
410
411/**
Stefan Richter656b7af2010-07-07 13:26:18 +0200412 * fw_run_transaction() - send request and sleep until transaction is completed
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200413 *
Stefan Richter656b7af2010-07-07 13:26:18 +0200414 * Returns the RCODE. See fw_send_request() for parameter documentation.
415 * Unlike fw_send_request(), @data points to the payload of the request or/and
Stefan Richterf30e6d32011-04-22 15:13:54 +0200416 * to the payload of the response. DMA mapping restrictions apply to outbound
417 * request payloads of >= 8 bytes but not to inbound response payloads.
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200418 */
419int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
Stefan Richter53dca512008-12-14 21:47:04 +0100420 int generation, int speed, unsigned long long offset,
Stefan Richterba27e1f2009-03-05 19:07:00 +0100421 void *payload, size_t length)
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200422{
423 struct transaction_callback_data d;
424 struct fw_transaction t;
425
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +0200426 init_timer_on_stack(&t.split_timeout_timer);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200427 init_completion(&d.done);
Stefan Richterba27e1f2009-03-05 19:07:00 +0100428 d.payload = payload;
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200429 fw_send_request(card, &t, tcode, destination_id, generation, speed,
Stefan Richterba27e1f2009-03-05 19:07:00 +0100430 offset, payload, length, transaction_callback, &d);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200431 wait_for_completion(&d.done);
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +0200432 destroy_timer_on_stack(&t.split_timeout_timer);
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200433
434 return d.rcode;
435}
436EXPORT_SYMBOL(fw_run_transaction);
437
Stefan Richterc0220d62008-07-22 21:35:47 +0200438static DEFINE_MUTEX(phy_config_mutex);
439static DECLARE_COMPLETION(phy_config_done);
Stefan Richterae1e5352008-06-18 18:20:45 +0200440
441static void transmit_phy_packet_callback(struct fw_packet *packet,
442 struct fw_card *card, int status)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500443{
Stefan Richterc0220d62008-07-22 21:35:47 +0200444 complete(&phy_config_done);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500445}
446
Stefan Richterc0220d62008-07-22 21:35:47 +0200447static struct fw_packet phy_config_packet = {
Clemens Ladisch5b06db12010-11-30 08:24:47 +0100448 .header_length = 12,
449 .header[0] = TCODE_LINK_INTERNAL << 4,
Stefan Richterc0220d62008-07-22 21:35:47 +0200450 .payload_length = 0,
451 .speed = SCODE_100,
452 .callback = transmit_phy_packet_callback,
453};
454
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500455void fw_send_phy_config(struct fw_card *card,
456 int node_id, int generation, int gap_count)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500457{
Stefan Richterae1e5352008-06-18 18:20:45 +0200458 long timeout = DIV_ROUND_UP(HZ, 10);
Stefan Richter02d37be2010-07-08 16:09:06 +0200459 u32 data = PHY_IDENTIFIER(PHY_PACKET_CONFIG);
460
461 if (node_id != FW_PHY_CONFIG_NO_NODE_ID)
462 data |= PHY_CONFIG_ROOT_ID(node_id);
463
464 if (gap_count == FW_PHY_CONFIG_CURRENT_GAP_COUNT) {
465 gap_count = card->driver->read_phy_reg(card, 1);
466 if (gap_count < 0)
467 return;
468
469 gap_count &= 63;
470 if (gap_count == 63)
471 return;
472 }
473 data |= PHY_CONFIG_GAP_COUNT(gap_count);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500474
Stefan Richterc0220d62008-07-22 21:35:47 +0200475 mutex_lock(&phy_config_mutex);
Kristian Høgsberg83db8012007-01-26 00:37:50 -0500476
Clemens Ladisch5b06db12010-11-30 08:24:47 +0100477 phy_config_packet.header[1] = data;
478 phy_config_packet.header[2] = ~data;
Stefan Richterc0220d62008-07-22 21:35:47 +0200479 phy_config_packet.generation = generation;
Wolfram Sang16735d02013-11-14 14:32:02 -0800480 reinit_completion(&phy_config_done);
Stefan Richterae1e5352008-06-18 18:20:45 +0200481
Stefan Richterc0220d62008-07-22 21:35:47 +0200482 card->driver->send_request(card, &phy_config_packet);
483 wait_for_completion_timeout(&phy_config_done, timeout);
Stefan Richterae1e5352008-06-18 18:20:45 +0200484
Stefan Richterc0220d62008-07-22 21:35:47 +0200485 mutex_unlock(&phy_config_mutex);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500486}
487
Stefan Richter53dca512008-12-14 21:47:04 +0100488static struct fw_address_handler *lookup_overlapping_address_handler(
489 struct list_head *list, unsigned long long offset, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500490{
491 struct fw_address_handler *handler;
492
Peter Hurley35202f72012-08-19 02:50:02 -0400493 list_for_each_entry_rcu(handler, list, link) {
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500494 if (handler->offset < offset + length &&
495 offset < handler->offset + handler->length)
496 return handler;
497 }
498
499 return NULL;
500}
501
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100502static bool is_enclosing_handler(struct fw_address_handler *handler,
503 unsigned long long offset, size_t length)
504{
505 return handler->offset <= offset &&
506 offset + length <= handler->offset + handler->length;
507}
508
Stefan Richter53dca512008-12-14 21:47:04 +0100509static struct fw_address_handler *lookup_enclosing_address_handler(
510 struct list_head *list, unsigned long long offset, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500511{
512 struct fw_address_handler *handler;
513
Peter Hurley35202f72012-08-19 02:50:02 -0400514 list_for_each_entry_rcu(handler, list, link) {
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100515 if (is_enclosing_handler(handler, offset, length))
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500516 return handler;
517 }
518
519 return NULL;
520}
521
Stefan Richter4d50c442012-09-27 21:46:09 +0200522static DEFINE_SPINLOCK(address_handler_list_lock);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500523static LIST_HEAD(address_handler_list);
524
Stefan Richter21ebcd12007-01-14 15:29:07 +0100525const struct fw_address_region fw_high_memory_region =
Stefan Richterfcd46b32014-01-18 17:32:20 +0100526 { .start = FW_MAX_PHYSICAL_RANGE, .end = 0xffffe0000000ULL, };
Adrian Bunkdb8be072008-03-31 02:22:11 +0300527EXPORT_SYMBOL(fw_high_memory_region);
528
Clemens Ladischf07d42a2012-05-24 19:28:58 +0200529static const struct fw_address_region low_memory_region =
Stefan Richterfcd46b32014-01-18 17:32:20 +0100530 { .start = 0x000000000000ULL, .end = FW_MAX_PHYSICAL_RANGE, };
Clemens Ladischf07d42a2012-05-24 19:28:58 +0200531
532#if 0
Stefan Richter21ebcd12007-01-14 15:29:07 +0100533const struct fw_address_region fw_private_region =
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100534 { .start = 0xffffe0000000ULL, .end = 0xfffff0000000ULL, };
Stefan Richter21ebcd12007-01-14 15:29:07 +0100535const struct fw_address_region fw_csr_region =
Jarod Wilsoncca60972008-03-08 12:52:03 -0500536 { .start = CSR_REGISTER_BASE,
537 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM_END, };
Stefan Richter21ebcd12007-01-14 15:29:07 +0100538const struct fw_address_region fw_unit_space_region =
Stefan Richter5af4e5e2007-01-21 20:45:32 +0100539 { .start = 0xfffff0000900ULL, .end = 0x1000000000000ULL, };
Adrian Bunkdb8be072008-03-31 02:22:11 +0300540#endif /* 0 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500541
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100542static bool is_in_fcp_region(u64 offset, size_t length)
543{
544 return offset >= (CSR_REGISTER_BASE | CSR_FCP_COMMAND) &&
545 offset + length <= (CSR_REGISTER_BASE | CSR_FCP_END);
546}
547
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500548/**
Stefan Richter656b7af2010-07-07 13:26:18 +0200549 * fw_core_add_address_handler() - register for incoming requests
550 * @handler: callback
551 * @region: region in the IEEE 1212 node space address range
Stefan Richter3e0b5f02008-12-14 19:21:01 +0100552 *
553 * region->start, ->end, and handler->length have to be quadlet-aligned.
554 *
555 * When a request is received that falls within the specified address range,
556 * the specified callback is invoked. The parameters passed to the callback
557 * give the details of the particular request.
Stefan Richter1415d912007-07-17 02:10:16 +0200558 *
Stefan Richter4d50c442012-09-27 21:46:09 +0200559 * To be called in process context.
Stefan Richter1415d912007-07-17 02:10:16 +0200560 * Return value: 0 on success, non-zero otherwise.
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100561 *
Stefan Richter1415d912007-07-17 02:10:16 +0200562 * The start offset of the handler's address region is determined by
563 * fw_core_add_address_handler() and is returned in handler->offset.
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100564 *
565 * Address allocations are exclusive, except for the FCP registers.
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500566 */
Stefan Richter53dca512008-12-14 21:47:04 +0100567int fw_core_add_address_handler(struct fw_address_handler *handler,
568 const struct fw_address_region *region)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500569{
570 struct fw_address_handler *other;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500571 int ret = -EBUSY;
572
Stefan Richter3e0b5f02008-12-14 19:21:01 +0100573 if (region->start & 0xffff000000000003ULL ||
Stefan Richter3e0b5f02008-12-14 19:21:01 +0100574 region->start >= region->end ||
Stefan Richter0c9ae702010-07-23 13:02:54 +0200575 region->end > 0x0001000000000000ULL ||
Stefan Richter3e0b5f02008-12-14 19:21:01 +0100576 handler->length & 3 ||
577 handler->length == 0)
578 return -EINVAL;
579
Stefan Richter4d50c442012-09-27 21:46:09 +0200580 spin_lock(&address_handler_list_lock);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500581
Stefan Richter3e0b5f02008-12-14 19:21:01 +0100582 handler->offset = region->start;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500583 while (handler->offset + handler->length <= region->end) {
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100584 if (is_in_fcp_region(handler->offset, handler->length))
585 other = NULL;
586 else
587 other = lookup_overlapping_address_handler
588 (&address_handler_list,
589 handler->offset, handler->length);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500590 if (other != NULL) {
Stefan Richter3e0b5f02008-12-14 19:21:01 +0100591 handler->offset += other->length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500592 } else {
Peter Hurley35202f72012-08-19 02:50:02 -0400593 list_add_tail_rcu(&handler->link, &address_handler_list);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500594 ret = 0;
595 break;
596 }
597 }
598
Stefan Richter4d50c442012-09-27 21:46:09 +0200599 spin_unlock(&address_handler_list_lock);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500600
601 return ret;
602}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500603EXPORT_SYMBOL(fw_core_add_address_handler);
604
605/**
Stefan Richter656b7af2010-07-07 13:26:18 +0200606 * fw_core_remove_address_handler() - unregister an address handler
Stefan Richter90963f12012-02-18 19:54:45 +0100607 *
Stefan Richter4d50c442012-09-27 21:46:09 +0200608 * To be called in process context.
609 *
Stefan Richter90963f12012-02-18 19:54:45 +0100610 * When fw_core_remove_address_handler() returns, @handler->callback() is
611 * guaranteed to not run on any CPU anymore.
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500612 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500613void fw_core_remove_address_handler(struct fw_address_handler *handler)
614{
Stefan Richter4d50c442012-09-27 21:46:09 +0200615 spin_lock(&address_handler_list_lock);
Peter Hurley35202f72012-08-19 02:50:02 -0400616 list_del_rcu(&handler->link);
Stefan Richter4d50c442012-09-27 21:46:09 +0200617 spin_unlock(&address_handler_list_lock);
Peter Hurley35202f72012-08-19 02:50:02 -0400618 synchronize_rcu();
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500619}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500620EXPORT_SYMBOL(fw_core_remove_address_handler);
621
622struct fw_request {
623 struct fw_packet response;
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500624 u32 request_header[4];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500625 int ack;
626 u32 length;
627 u32 data[0];
628};
629
Stefan Richter53dca512008-12-14 21:47:04 +0100630static void free_response_callback(struct fw_packet *packet,
631 struct fw_card *card, int status)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500632{
633 struct fw_request *request;
634
635 request = container_of(packet, struct fw_request, response);
636 kfree(request);
637}
638
Clemens Ladischa10c0ce72010-05-19 08:28:32 +0200639int fw_get_response_length(struct fw_request *r)
640{
641 int tcode, ext_tcode, data_length;
642
643 tcode = HEADER_GET_TCODE(r->request_header[0]);
644
645 switch (tcode) {
646 case TCODE_WRITE_QUADLET_REQUEST:
647 case TCODE_WRITE_BLOCK_REQUEST:
648 return 0;
649
650 case TCODE_READ_QUADLET_REQUEST:
651 return 4;
652
653 case TCODE_READ_BLOCK_REQUEST:
654 data_length = HEADER_GET_DATA_LENGTH(r->request_header[3]);
655 return data_length;
656
657 case TCODE_LOCK_REQUEST:
658 ext_tcode = HEADER_GET_EXTENDED_TCODE(r->request_header[3]);
659 data_length = HEADER_GET_DATA_LENGTH(r->request_header[3]);
660 switch (ext_tcode) {
661 case EXTCODE_FETCH_ADD:
662 case EXTCODE_LITTLE_ADD:
663 return data_length;
664 default:
665 return data_length / 2;
666 }
667
668 default:
Joe Perches58787302010-10-30 14:08:27 -0700669 WARN(1, "wrong tcode %d\n", tcode);
Clemens Ladischa10c0ce72010-05-19 08:28:32 +0200670 return 0;
671 }
672}
673
Stefan Richter53dca512008-12-14 21:47:04 +0100674void fw_fill_response(struct fw_packet *response, u32 *request_header,
675 int rcode, void *payload, size_t length)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500676{
677 int tcode, tlabel, extended_tcode, source, destination;
678
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400679 tcode = HEADER_GET_TCODE(request_header[0]);
680 tlabel = HEADER_GET_TLABEL(request_header[0]);
681 source = HEADER_GET_DESTINATION(request_header[0]);
682 destination = HEADER_GET_SOURCE(request_header[1]);
683 extended_tcode = HEADER_GET_EXTENDED_TCODE(request_header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500684
685 response->header[0] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400686 HEADER_RETRY(RETRY_1) |
687 HEADER_TLABEL(tlabel) |
688 HEADER_DESTINATION(destination);
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500689 response->header[1] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400690 HEADER_SOURCE(source) |
691 HEADER_RCODE(rcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500692 response->header[2] = 0;
693
694 switch (tcode) {
695 case TCODE_WRITE_QUADLET_REQUEST:
696 case TCODE_WRITE_BLOCK_REQUEST:
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400697 response->header[0] |= HEADER_TCODE(TCODE_WRITE_RESPONSE);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500698 response->header_length = 12;
699 response->payload_length = 0;
700 break;
701
702 case TCODE_READ_QUADLET_REQUEST:
703 response->header[0] |=
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400704 HEADER_TCODE(TCODE_READ_QUADLET_RESPONSE);
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500705 if (payload != NULL)
706 response->header[3] = *(u32 *)payload;
707 else
708 response->header[3] = 0;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500709 response->header_length = 16;
710 response->payload_length = 0;
711 break;
712
713 case TCODE_READ_BLOCK_REQUEST:
714 case TCODE_LOCK_REQUEST:
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400715 response->header[0] |= HEADER_TCODE(tcode + 2);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500716 response->header[3] =
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400717 HEADER_DATA_LENGTH(length) |
718 HEADER_EXTENDED_TCODE(extended_tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500719 response->header_length = 16;
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500720 response->payload = payload;
721 response->payload_length = length;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500722 break;
723
724 default:
Joe Perches58787302010-10-30 14:08:27 -0700725 WARN(1, "wrong tcode %d\n", tcode);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500726 }
Stefan Richter1d1dc5e2008-12-10 00:20:38 +0100727
Stefan Richter19593ff2009-10-14 20:40:10 +0200728 response->payload_mapped = false;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500729}
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500730EXPORT_SYMBOL(fw_fill_response);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500731
Clemens Ladisch8e4b50f2010-06-10 08:26:28 +0200732static u32 compute_split_timeout_timestamp(struct fw_card *card,
733 u32 request_timestamp)
734{
735 unsigned int cycles;
736 u32 timestamp;
737
738 cycles = card->split_timeout_cycles;
739 cycles += request_timestamp & 0x1fff;
740
741 timestamp = request_timestamp & ~0x1fff;
742 timestamp += (cycles / 8000) << 13;
743 timestamp |= cycles % 8000;
744
745 return timestamp;
746}
747
748static struct fw_request *allocate_request(struct fw_card *card,
749 struct fw_packet *p)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500750{
751 struct fw_request *request;
752 u32 *data, length;
Clemens Ladisch8e4b50f2010-06-10 08:26:28 +0200753 int request_tcode;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500754
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400755 request_tcode = HEADER_GET_TCODE(p->header[0]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500756 switch (request_tcode) {
757 case TCODE_WRITE_QUADLET_REQUEST:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500758 data = &p->header[3];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500759 length = 4;
760 break;
761
762 case TCODE_WRITE_BLOCK_REQUEST:
763 case TCODE_LOCK_REQUEST:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500764 data = p->payload;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400765 length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500766 break;
767
768 case TCODE_READ_QUADLET_REQUEST:
769 data = NULL;
770 length = 4;
771 break;
772
773 case TCODE_READ_BLOCK_REQUEST:
774 data = NULL;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400775 length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500776 break;
777
778 default:
Stefan Richter26b49502012-02-18 22:03:14 +0100779 fw_notice(card, "ERROR - corrupt request received - %08x %08x %08x\n",
Stefan Richter0bf607c2008-05-31 19:01:26 +0200780 p->header[0], p->header[1], p->header[2]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500781 return NULL;
782 }
783
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400784 request = kmalloc(sizeof(*request) + length, GFP_ATOMIC);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500785 if (request == NULL)
786 return NULL;
787
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500788 request->response.speed = p->speed;
Clemens Ladisch8e4b50f2010-06-10 08:26:28 +0200789 request->response.timestamp =
790 compute_split_timeout_timestamp(card, p->timestamp);
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500791 request->response.generation = p->generation;
Kristian Høgsberg730c32f2007-02-06 14:49:32 -0500792 request->response.ack = 0;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500793 request->response.callback = free_response_callback;
794 request->ack = p->ack;
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500795 request->length = length;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500796 if (data)
Kristian Høgsberg6e2e8422007-02-16 17:34:37 -0500797 memcpy(request->data, data, length);
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500798
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400799 memcpy(request->request_header, p->header, sizeof(p->header));
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500800
801 return request;
802}
803
Stefan Richter53dca512008-12-14 21:47:04 +0100804void fw_send_response(struct fw_card *card,
805 struct fw_request *request, int rcode)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500806{
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100807 if (WARN_ONCE(!request, "invalid for FCP address handlers"))
808 return;
809
Stefan Richtera7ea6782008-05-25 11:06:55 +0200810 /* unified transaction or broadcast transaction: don't respond */
811 if (request->ack != ACK_PENDING ||
812 HEADER_DESTINATION_IS_BROADCAST(request->request_header[0])) {
Stefan Richter9c9bdf42007-07-17 02:15:36 +0200813 kfree(request);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500814 return;
Stefan Richter9c9bdf42007-07-17 02:15:36 +0200815 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500816
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500817 if (rcode == RCODE_COMPLETE)
818 fw_fill_response(&request->response, request->request_header,
Clemens Ladischa10c0ce72010-05-19 08:28:32 +0200819 rcode, request->data,
820 fw_get_response_length(request));
Kristian Høgsberg36bfe492007-01-26 00:38:13 -0500821 else
822 fw_fill_response(&request->response, request->request_header,
823 rcode, NULL, 0);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500824
825 card->driver->send_response(card, &request->response);
826}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500827EXPORT_SYMBOL(fw_send_response);
828
Chris Boot253d9232012-02-16 09:16:35 +0000829/**
830 * fw_get_request_speed() - returns speed at which the @request was received
831 */
832int fw_get_request_speed(struct fw_request *request)
833{
834 return request->response.speed;
835}
836EXPORT_SYMBOL(fw_get_request_speed);
837
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100838static void handle_exclusive_region_request(struct fw_card *card,
839 struct fw_packet *p,
840 struct fw_request *request,
841 unsigned long long offset)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500842{
843 struct fw_address_handler *handler;
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500844 int tcode, destination, source;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500845
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400846 destination = HEADER_GET_DESTINATION(p->header[0]);
Rabin Vincent478b2332007-12-21 23:02:15 +0530847 source = HEADER_GET_SOURCE(p->header[1]);
Jay Fenlasonc82f91f2010-05-18 10:57:33 -0400848 tcode = HEADER_GET_TCODE(p->header[0]);
849 if (tcode == TCODE_LOCK_REQUEST)
850 tcode = 0x10 + HEADER_GET_EXTENDED_TCODE(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500851
Peter Hurley35202f72012-08-19 02:50:02 -0400852 rcu_read_lock();
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500853 handler = lookup_enclosing_address_handler(&address_handler_list,
854 offset, request->length);
Stefan Richter90963f12012-02-18 19:54:45 +0100855 if (handler)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500856 handler->address_callback(card, request,
857 tcode, destination, source,
Stefan Richter33e553f2010-06-20 22:50:35 +0200858 p->generation, offset,
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500859 request->data, request->length,
860 handler->callback_data);
Peter Hurley35202f72012-08-19 02:50:02 -0400861 rcu_read_unlock();
Stefan Richter90963f12012-02-18 19:54:45 +0100862
863 if (!handler)
864 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500865}
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100866
867static void handle_fcp_region_request(struct fw_card *card,
868 struct fw_packet *p,
869 struct fw_request *request,
870 unsigned long long offset)
871{
872 struct fw_address_handler *handler;
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100873 int tcode, destination, source;
874
875 if ((offset != (CSR_REGISTER_BASE | CSR_FCP_COMMAND) &&
876 offset != (CSR_REGISTER_BASE | CSR_FCP_RESPONSE)) ||
877 request->length > 0x200) {
878 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
879
880 return;
881 }
882
883 tcode = HEADER_GET_TCODE(p->header[0]);
884 destination = HEADER_GET_DESTINATION(p->header[0]);
885 source = HEADER_GET_SOURCE(p->header[1]);
886
887 if (tcode != TCODE_WRITE_QUADLET_REQUEST &&
888 tcode != TCODE_WRITE_BLOCK_REQUEST) {
889 fw_send_response(card, request, RCODE_TYPE_ERROR);
890
891 return;
892 }
893
Peter Hurley35202f72012-08-19 02:50:02 -0400894 rcu_read_lock();
895 list_for_each_entry_rcu(handler, &address_handler_list, link) {
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100896 if (is_enclosing_handler(handler, offset, request->length))
897 handler->address_callback(card, NULL, tcode,
898 destination, source,
Stefan Richter33e553f2010-06-20 22:50:35 +0200899 p->generation, offset,
900 request->data,
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100901 request->length,
902 handler->callback_data);
903 }
Peter Hurley35202f72012-08-19 02:50:02 -0400904 rcu_read_unlock();
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100905
906 fw_send_response(card, request, RCODE_COMPLETE);
907}
908
909void fw_core_handle_request(struct fw_card *card, struct fw_packet *p)
910{
911 struct fw_request *request;
912 unsigned long long offset;
913
914 if (p->ack != ACK_PENDING && p->ack != ACK_COMPLETE)
915 return;
916
Stefan Richterbf54e142010-07-16 22:25:51 +0200917 if (TCODE_IS_LINK_INTERNAL(HEADER_GET_TCODE(p->header[0]))) {
918 fw_cdev_handle_phy_packet(card, p);
919 return;
920 }
921
Clemens Ladisch8e4b50f2010-06-10 08:26:28 +0200922 request = allocate_request(card, p);
Clemens Ladischdb5d2472009-12-24 12:05:58 +0100923 if (request == NULL) {
924 /* FIXME: send statically allocated busy packet. */
925 return;
926 }
927
928 offset = ((u64)HEADER_GET_OFFSET_HIGH(p->header[1]) << 32) |
929 p->header[2];
930
931 if (!is_in_fcp_region(offset, request->length))
932 handle_exclusive_region_request(card, p, request, offset);
933 else
934 handle_fcp_region_request(card, p, request, offset);
935
936}
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500937EXPORT_SYMBOL(fw_core_handle_request);
938
Stefan Richter53dca512008-12-14 21:47:04 +0100939void fw_core_handle_response(struct fw_card *card, struct fw_packet *p)
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500940{
941 struct fw_transaction *t;
942 unsigned long flags;
943 u32 *data;
944 size_t data_length;
Stefan Richterae86e812010-06-15 01:22:45 +0200945 int tcode, tlabel, source, rcode;
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500946
Stefan Richterae86e812010-06-15 01:22:45 +0200947 tcode = HEADER_GET_TCODE(p->header[0]);
948 tlabel = HEADER_GET_TLABEL(p->header[0]);
949 source = HEADER_GET_SOURCE(p->header[1]);
950 rcode = HEADER_GET_RCODE(p->header[1]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500951
952 spin_lock_irqsave(&card->lock, flags);
953 list_for_each_entry(t, &card->transaction_list, link) {
954 if (t->node_id == source && t->tlabel == tlabel) {
Clemens Ladisch410cf2b2010-12-13 14:56:02 +0100955 if (!try_cancel_split_timeout(t)) {
Clemens Ladisch2222bcb2010-08-18 15:05:02 +0200956 spin_unlock_irqrestore(&card->lock, flags);
957 goto timed_out;
958 }
Clemens Ladisch5c40cbf2010-04-27 09:07:00 +0200959 list_del_init(&t->link);
Peter Hurley753a8972010-04-23 19:27:25 -0400960 card->tlabel_mask &= ~(1ULL << t->tlabel);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500961 break;
962 }
963 }
964 spin_unlock_irqrestore(&card->lock, flags);
965
966 if (&t->link == &card->transaction_list) {
Clemens Ladisch2222bcb2010-08-18 15:05:02 +0200967 timed_out:
Stefan Richter26b49502012-02-18 22:03:14 +0100968 fw_notice(card, "unsolicited response (source %x, tlabel %x)\n",
Kristian Høgsberg32b46092007-02-06 14:49:30 -0500969 source, tlabel);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500970 return;
971 }
972
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400973 /*
974 * FIXME: sanity check packet, is length correct, does tcodes
975 * and addresses match.
976 */
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500977
978 switch (tcode) {
979 case TCODE_READ_QUADLET_RESPONSE:
Kristian Høgsberg2639a6f2007-01-26 00:37:57 -0500980 data = (u32 *) &p->header[3];
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500981 data_length = 4;
982 break;
983
984 case TCODE_WRITE_RESPONSE:
985 data = NULL;
986 data_length = 0;
987 break;
988
989 case TCODE_READ_BLOCK_RESPONSE:
990 case TCODE_LOCK_RESPONSE:
Kristian Høgsberg93c4cce2007-01-26 00:38:26 -0500991 data = p->payload;
Kristian Høgsberga77754a2007-05-07 20:33:35 -0400992 data_length = HEADER_GET_DATA_LENGTH(p->header[3]);
Kristian Høgsberg3038e352006-12-19 19:58:27 -0500993 break;
994
995 default:
996 /* Should never happen, this is just to shut up gcc. */
997 data = NULL;
998 data_length = 0;
999 break;
1000 }
1001
Stefan Richter10a4c732008-03-16 00:56:41 +01001002 /*
1003 * The response handler may be executed while the request handler
1004 * is still pending. Cancel the request handler.
1005 */
1006 card->driver->cancel_packet(card, &t->packet);
1007
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001008 t->callback(card, rcode, data, data_length, t->callback_data);
1009}
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001010EXPORT_SYMBOL(fw_core_handle_response);
1011
Clemens Ladisch7bdbff62012-04-11 17:38:10 +02001012/**
1013 * fw_rcode_string - convert a firewire result code to an error description
1014 * @rcode: the result code
1015 */
1016const char *fw_rcode_string(int rcode)
1017{
1018 static const char *const names[] = {
1019 [RCODE_COMPLETE] = "no error",
1020 [RCODE_CONFLICT_ERROR] = "conflict error",
1021 [RCODE_DATA_ERROR] = "data error",
1022 [RCODE_TYPE_ERROR] = "type error",
1023 [RCODE_ADDRESS_ERROR] = "address error",
1024 [RCODE_SEND_ERROR] = "send error",
1025 [RCODE_CANCELLED] = "timeout",
1026 [RCODE_BUSY] = "busy",
1027 [RCODE_GENERATION] = "bus reset",
1028 [RCODE_NO_ACK] = "no ack",
1029 };
1030
1031 if ((unsigned int)rcode < ARRAY_SIZE(names) && names[rcode])
1032 return names[rcode];
1033 else
1034 return "unknown";
1035}
1036EXPORT_SYMBOL(fw_rcode_string);
1037
Stefan Richterae579882007-08-02 20:34:17 +02001038static const struct fw_address_region topology_map_region =
Jarod Wilsoncca60972008-03-08 12:52:03 -05001039 { .start = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP,
1040 .end = CSR_REGISTER_BASE | CSR_TOPOLOGY_MAP_END, };
Kristian Høgsberg473d28c2007-03-07 12:12:55 -05001041
Stefan Richter53dca512008-12-14 21:47:04 +01001042static void handle_topology_map(struct fw_card *card, struct fw_request *request,
1043 int tcode, int destination, int source, int generation,
Stefan Richter33e553f2010-06-20 22:50:35 +02001044 unsigned long long offset, void *payload, size_t length,
1045 void *callback_data)
Kristian Høgsberg473d28c2007-03-07 12:12:55 -05001046{
Stefan Richtercb7c96d2009-10-08 00:42:53 +02001047 int start;
Kristian Høgsberg473d28c2007-03-07 12:12:55 -05001048
1049 if (!TCODE_IS_READ_REQUEST(tcode)) {
1050 fw_send_response(card, request, RCODE_TYPE_ERROR);
1051 return;
1052 }
1053
1054 if ((offset & 3) > 0 || (length & 3) > 0) {
1055 fw_send_response(card, request, RCODE_ADDRESS_ERROR);
1056 return;
1057 }
1058
1059 start = (offset - topology_map_region.start) / 4;
Stefan Richtercb7c96d2009-10-08 00:42:53 +02001060 memcpy(payload, &card->topology_map[start], length);
Kristian Høgsberg473d28c2007-03-07 12:12:55 -05001061
1062 fw_send_response(card, request, RCODE_COMPLETE);
1063}
1064
1065static struct fw_address_handler topology_map = {
Stefan Richter85cb9b62009-09-08 01:13:53 +02001066 .length = 0x400,
Kristian Høgsberg473d28c2007-03-07 12:12:55 -05001067 .address_callback = handle_topology_map,
1068};
1069
Stefan Richterae579882007-08-02 20:34:17 +02001070static const struct fw_address_region registers_region =
Jarod Wilsoncca60972008-03-08 12:52:03 -05001071 { .start = CSR_REGISTER_BASE,
1072 .end = CSR_REGISTER_BASE | CSR_CONFIG_ROM, };
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001073
Clemens Ladisch8e4b50f2010-06-10 08:26:28 +02001074static void update_split_timeout(struct fw_card *card)
1075{
1076 unsigned int cycles;
1077
1078 cycles = card->split_timeout_hi * 8000 + (card->split_timeout_lo >> 19);
1079
Stefan Richter4ec4a672011-09-19 00:20:48 +02001080 /* minimum per IEEE 1394, maximum which doesn't overflow OHCI */
1081 cycles = clamp(cycles, 800u, 3u * 8000u);
Clemens Ladisch8e4b50f2010-06-10 08:26:28 +02001082
1083 card->split_timeout_cycles = cycles;
1084 card->split_timeout_jiffies = DIV_ROUND_UP(cycles * HZ, 8000);
1085}
1086
Stefan Richter53dca512008-12-14 21:47:04 +01001087static void handle_registers(struct fw_card *card, struct fw_request *request,
1088 int tcode, int destination, int source, int generation,
Stefan Richter33e553f2010-06-20 22:50:35 +02001089 unsigned long long offset, void *payload, size_t length,
1090 void *callback_data)
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001091{
Jarod Wilson15f0d832008-03-08 13:18:58 -05001092 int reg = offset & ~CSR_REGISTER_BASE;
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001093 __be32 *data = payload;
Stefan Richtere534fe12008-05-24 16:41:09 +02001094 int rcode = RCODE_COMPLETE;
Clemens Ladisch8e4b50f2010-06-10 08:26:28 +02001095 unsigned long flags;
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001096
1097 switch (reg) {
Stefan Richterb384cf12010-06-12 20:35:21 +02001098 case CSR_PRIORITY_BUDGET:
1099 if (!card->priority_budget_implemented) {
1100 rcode = RCODE_ADDRESS_ERROR;
1101 break;
1102 }
1103 /* else fall through */
Clemens Ladisch3e07ec02010-06-10 08:24:03 +02001104
Clemens Ladisch506f1a32010-06-10 08:25:19 +02001105 case CSR_NODE_IDS:
Stefan Richter65b27422010-06-12 20:26:51 +02001106 /*
1107 * per IEEE 1394-2008 8.3.22.3, not IEEE 1394.1-2004 3.2.8
1108 * and 9.6, but interoperable with IEEE 1394.1-2004 bridges
1109 */
Stefan Richterb384cf12010-06-12 20:35:21 +02001110 /* fall through */
1111
1112 case CSR_STATE_CLEAR:
1113 case CSR_STATE_SET:
1114 case CSR_CYCLE_TIME:
1115 case CSR_BUS_TIME:
1116 case CSR_BUSY_TIMEOUT:
Clemens Ladisch506f1a32010-06-10 08:25:19 +02001117 if (tcode == TCODE_READ_QUADLET_REQUEST)
Stefan Richter0fcff4e2010-06-12 20:35:52 +02001118 *data = cpu_to_be32(card->driver->read_csr(card, reg));
Clemens Ladisch506f1a32010-06-10 08:25:19 +02001119 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
Stefan Richter0fcff4e2010-06-12 20:35:52 +02001120 card->driver->write_csr(card, reg, be32_to_cpu(*data));
Clemens Ladisch506f1a32010-06-10 08:25:19 +02001121 else
1122 rcode = RCODE_TYPE_ERROR;
1123 break;
1124
Clemens Ladisch446eba02010-06-10 08:25:46 +02001125 case CSR_RESET_START:
Clemens Ladisch7e0e314f2010-06-10 08:37:15 +02001126 if (tcode == TCODE_WRITE_QUADLET_REQUEST)
Stefan Richter0fcff4e2010-06-12 20:35:52 +02001127 card->driver->write_csr(card, CSR_STATE_CLEAR,
1128 CSR_STATE_BIT_ABDICATE);
Clemens Ladisch7e0e314f2010-06-10 08:37:15 +02001129 else
Clemens Ladisch446eba02010-06-10 08:25:46 +02001130 rcode = RCODE_TYPE_ERROR;
1131 break;
1132
Clemens Ladisch8e4b50f2010-06-10 08:26:28 +02001133 case CSR_SPLIT_TIMEOUT_HI:
1134 if (tcode == TCODE_READ_QUADLET_REQUEST) {
1135 *data = cpu_to_be32(card->split_timeout_hi);
1136 } else if (tcode == TCODE_WRITE_QUADLET_REQUEST) {
1137 spin_lock_irqsave(&card->lock, flags);
1138 card->split_timeout_hi = be32_to_cpu(*data) & 7;
1139 update_split_timeout(card);
1140 spin_unlock_irqrestore(&card->lock, flags);
1141 } else {
1142 rcode = RCODE_TYPE_ERROR;
1143 }
1144 break;
1145
1146 case CSR_SPLIT_TIMEOUT_LO:
1147 if (tcode == TCODE_READ_QUADLET_REQUEST) {
1148 *data = cpu_to_be32(card->split_timeout_lo);
1149 } else if (tcode == TCODE_WRITE_QUADLET_REQUEST) {
1150 spin_lock_irqsave(&card->lock, flags);
1151 card->split_timeout_lo =
1152 be32_to_cpu(*data) & 0xfff80000;
1153 update_split_timeout(card);
1154 spin_unlock_irqrestore(&card->lock, flags);
1155 } else {
1156 rcode = RCODE_TYPE_ERROR;
1157 }
1158 break;
1159
Clemens Ladisch3d1f46e2010-06-10 08:35:37 +02001160 case CSR_MAINT_UTILITY:
1161 if (tcode == TCODE_READ_QUADLET_REQUEST)
1162 *data = card->maint_utility_register;
1163 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
1164 card->maint_utility_register = *data;
1165 else
1166 rcode = RCODE_TYPE_ERROR;
1167 break;
1168
Stefan Richtere534fe12008-05-24 16:41:09 +02001169 case CSR_BROADCAST_CHANNEL:
1170 if (tcode == TCODE_READ_QUADLET_REQUEST)
1171 *data = cpu_to_be32(card->broadcast_channel);
1172 else if (tcode == TCODE_WRITE_QUADLET_REQUEST)
1173 card->broadcast_channel =
1174 (be32_to_cpu(*data) & BROADCAST_CHANNEL_VALID) |
1175 BROADCAST_CHANNEL_INITIAL;
1176 else
1177 rcode = RCODE_TYPE_ERROR;
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001178 break;
1179
1180 case CSR_BUS_MANAGER_ID:
1181 case CSR_BANDWIDTH_AVAILABLE:
1182 case CSR_CHANNELS_AVAILABLE_HI:
1183 case CSR_CHANNELS_AVAILABLE_LO:
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001184 /*
1185 * FIXME: these are handled by the OHCI hardware and
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001186 * the stack never sees these request. If we add
1187 * support for a new type of controller that doesn't
1188 * handle this in hardware we need to deal with these
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001189 * transactions.
1190 */
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001191 BUG();
1192 break;
1193
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001194 default:
Stefan Richtere534fe12008-05-24 16:41:09 +02001195 rcode = RCODE_ADDRESS_ERROR;
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001196 break;
1197 }
Stefan Richtere534fe12008-05-24 16:41:09 +02001198
1199 fw_send_response(card, request, rcode);
Kristian Høgsbergd60d7f12007-03-07 12:12:56 -05001200}
1201
1202static struct fw_address_handler registers = {
1203 .length = 0x400,
1204 .address_callback = handle_registers,
1205};
1206
Clemens Ladischf07d42a2012-05-24 19:28:58 +02001207static void handle_low_memory(struct fw_card *card, struct fw_request *request,
1208 int tcode, int destination, int source, int generation,
1209 unsigned long long offset, void *payload, size_t length,
1210 void *callback_data)
1211{
1212 /*
1213 * This catches requests not handled by the physical DMA unit,
1214 * i.e., wrong transaction types or unauthorized source nodes.
1215 */
1216 fw_send_response(card, request, RCODE_TYPE_ERROR);
1217}
1218
1219static struct fw_address_handler low_memory = {
Stefan Richterfcd46b32014-01-18 17:32:20 +01001220 .length = FW_MAX_PHYSICAL_RANGE,
Clemens Ladischf07d42a2012-05-24 19:28:58 +02001221 .address_callback = handle_low_memory,
1222};
1223
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001224MODULE_AUTHOR("Kristian Hoegsberg <krh@bitplanet.net>");
1225MODULE_DESCRIPTION("Core IEEE1394 transaction logic");
1226MODULE_LICENSE("GPL");
1227
Kristian Høgsberg937f6872007-03-07 12:12:36 -05001228static const u32 vendor_textual_descriptor[] = {
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001229 /* textual descriptor leaf () */
Kristian Høgsberg937f6872007-03-07 12:12:36 -05001230 0x00060000,
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001231 0x00000000,
1232 0x00000000,
1233 0x4c696e75, /* L i n u */
1234 0x78204669, /* x F i */
1235 0x72657769, /* r e w i */
Kristian Høgsberg937f6872007-03-07 12:12:36 -05001236 0x72650000, /* r e */
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001237};
1238
Kristian Høgsberg937f6872007-03-07 12:12:36 -05001239static const u32 model_textual_descriptor[] = {
1240 /* model descriptor leaf () */
1241 0x00030000,
1242 0x00000000,
1243 0x00000000,
1244 0x4a756a75, /* J u j u */
1245};
1246
1247static struct fw_descriptor vendor_id_descriptor = {
1248 .length = ARRAY_SIZE(vendor_textual_descriptor),
Clemens Ladischd71e6a12015-01-28 21:04:48 +01001249 .immediate = 0x03001f11,
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001250 .key = 0x81000000,
Kristian Høgsberg937f6872007-03-07 12:12:36 -05001251 .data = vendor_textual_descriptor,
1252};
1253
1254static struct fw_descriptor model_id_descriptor = {
1255 .length = ARRAY_SIZE(model_textual_descriptor),
Clemens Ladischd71e6a12015-01-28 21:04:48 +01001256 .immediate = 0x17023901,
Kristian Høgsberg937f6872007-03-07 12:12:36 -05001257 .key = 0x81000000,
1258 .data = model_textual_descriptor,
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001259};
1260
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001261static int __init fw_core_init(void)
1262{
Stefan Richter2dbd7d72008-12-14 21:45:45 +01001263 int ret;
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001264
Tejun Heo4e6b9312013-07-30 08:40:23 -04001265 fw_workqueue = alloc_workqueue("firewire", WQ_MEM_RECLAIM, 0);
Stefan Richter105e53f2011-05-01 20:50:31 +02001266 if (!fw_workqueue)
Stefan Richter6ea9e7b2010-10-13 13:39:46 +02001267 return -ENOMEM;
1268
Stefan Richter2dbd7d72008-12-14 21:45:45 +01001269 ret = bus_register(&fw_bus_type);
Stefan Richter6ea9e7b2010-10-13 13:39:46 +02001270 if (ret < 0) {
Stefan Richter105e53f2011-05-01 20:50:31 +02001271 destroy_workqueue(fw_workqueue);
Stefan Richter2dbd7d72008-12-14 21:45:45 +01001272 return ret;
Stefan Richter6ea9e7b2010-10-13 13:39:46 +02001273 }
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001274
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001275 fw_cdev_major = register_chrdev(0, "firewire", &fw_device_ops);
1276 if (fw_cdev_major < 0) {
1277 bus_unregister(&fw_bus_type);
Stefan Richter105e53f2011-05-01 20:50:31 +02001278 destroy_workqueue(fw_workqueue);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001279 return fw_cdev_major;
1280 }
1281
Stefan Richterc490a6d2008-12-14 21:45:14 +01001282 fw_core_add_address_handler(&topology_map, &topology_map_region);
1283 fw_core_add_address_handler(&registers, &registers_region);
Clemens Ladischf07d42a2012-05-24 19:28:58 +02001284 fw_core_add_address_handler(&low_memory, &low_memory_region);
Stefan Richterc490a6d2008-12-14 21:45:14 +01001285 fw_core_add_descriptor(&vendor_id_descriptor);
1286 fw_core_add_descriptor(&model_id_descriptor);
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001287
1288 return 0;
1289}
1290
1291static void __exit fw_core_cleanup(void)
1292{
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001293 unregister_chrdev(fw_cdev_major, "firewire");
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001294 bus_unregister(&fw_bus_type);
Stefan Richter105e53f2011-05-01 20:50:31 +02001295 destroy_workqueue(fw_workqueue);
Stefan Richterd6053e02008-11-24 20:40:00 +01001296 idr_destroy(&fw_device_idr);
Kristian Høgsberg3038e352006-12-19 19:58:27 -05001297}
1298
1299module_init(fw_core_init);
1300module_exit(fw_core_cleanup);