blob: 3d7e1a6dfe93dac7782366f1d0ce64c9e0086a11 [file] [log] [blame]
Stefan Richter9f6d3c42010-07-22 11:58:05 +02001/*
2 * nosy-dump - Interface to snoop mode driver for TI PCILynx 1394 controllers
3 * Copyright (C) 2002-2006 Kristian Høgsberg
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software Foundation,
17 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
Stefan Richter92c16f72010-07-22 11:58:05 +020020#include <byteswap.h>
21#include <endian.h>
Stefan Richter9f6d3c42010-07-22 11:58:05 +020022#include <fcntl.h>
Stefan Richter92c16f72010-07-22 11:58:05 +020023#include <poll.h>
24#include <popt.h>
25#include <signal.h>
26#include <stdio.h>
27#include <stdlib.h>
28#include <string.h>
Stefan Richter9f6d3c42010-07-22 11:58:05 +020029#include <sys/ioctl.h>
30#include <sys/time.h>
Stefan Richter9f6d3c42010-07-22 11:58:05 +020031#include <termios.h>
Stefan Richter92c16f72010-07-22 11:58:05 +020032#include <unistd.h>
Stefan Richter9f6d3c42010-07-22 11:58:05 +020033
34#include "list.h"
Stefan Richter9f6d3c42010-07-22 11:58:05 +020035#include "nosy-dump.h"
Stefan Richter92c16f72010-07-22 11:58:05 +020036#include "nosy-user.h"
Stefan Richter9f6d3c42010-07-22 11:58:05 +020037
38enum {
Stefan Richter92c16f72010-07-22 11:58:05 +020039 PACKET_FIELD_DETAIL = 0x01,
40 PACKET_FIELD_DATA_LENGTH = 0x02,
41 /* Marks the fields we print in transaction view. */
42 PACKET_FIELD_TRANSACTION = 0x04,
Stefan Richter9f6d3c42010-07-22 11:58:05 +020043};
44
Stefan Richter92c16f72010-07-22 11:58:05 +020045static void print_packet(uint32_t *data, size_t length);
46static void decode_link_packet(struct link_packet *packet, size_t length,
47 int include_flags, int exclude_flags);
48static int run = 1;
Stefan Richter9f6d3c42010-07-22 11:58:05 +020049sig_t sys_sigint_handler;
50
51static char *option_nosy_device = "/dev/nosy";
52static char *option_view = "packet";
Stefan Richter92c16f72010-07-22 11:58:05 +020053static char *option_output;
54static char *option_input;
55static int option_hex;
56static int option_iso;
57static int option_cycle_start;
58static int option_version;
59static int option_verbose;
Stefan Richter9f6d3c42010-07-22 11:58:05 +020060
61enum {
Stefan Richter92c16f72010-07-22 11:58:05 +020062 VIEW_TRANSACTION,
63 VIEW_PACKET,
64 VIEW_STATS,
Stefan Richter9f6d3c42010-07-22 11:58:05 +020065};
66
67static const struct poptOption options[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +020068 {
69 .longName = "device",
70 .shortName = 'd',
71 .argInfo = POPT_ARG_STRING,
72 .arg = &option_nosy_device,
73 .descrip = "Path to nosy device.",
74 .argDescrip = "DEVICE"
75 },
76 {
77 .longName = "view",
78 .argInfo = POPT_ARG_STRING,
79 .arg = &option_view,
80 .descrip = "Specify view of bus traffic: packet, transaction or stats.",
81 .argDescrip = "VIEW"
82 },
83 {
84 .longName = "hex",
85 .shortName = 'x',
86 .argInfo = POPT_ARG_NONE,
87 .arg = &option_hex,
88 .descrip = "Print each packet in hex.",
89 },
90 {
91 .longName = "iso",
92 .argInfo = POPT_ARG_NONE,
93 .arg = &option_iso,
94 .descrip = "Print iso packets.",
95 },
96 {
97 .longName = "cycle-start",
98 .argInfo = POPT_ARG_NONE,
99 .arg = &option_cycle_start,
100 .descrip = "Print cycle start packets.",
101 },
102 {
103 .longName = "verbose",
104 .shortName = 'v',
105 .argInfo = POPT_ARG_NONE,
106 .arg = &option_verbose,
107 .descrip = "Verbose packet view.",
108 },
109 {
110 .longName = "output",
111 .shortName = 'o',
112 .argInfo = POPT_ARG_STRING,
113 .arg = &option_output,
114 .descrip = "Log to output file.",
115 .argDescrip = "FILENAME"
116 },
117 {
118 .longName = "input",
119 .shortName = 'i',
120 .argInfo = POPT_ARG_STRING,
121 .arg = &option_input,
122 .descrip = "Decode log from file.",
123 .argDescrip = "FILENAME"
124 },
125 {
126 .longName = "version",
127 .argInfo = POPT_ARG_NONE,
128 .arg = &option_version,
129 .descrip = "Specify print version info.",
130 },
131 POPT_AUTOHELP
132 POPT_TABLEEND
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200133};
134
Stefan Richter92c16f72010-07-22 11:58:05 +0200135/* Allow all ^C except the first to interrupt the program in the usual way. */
136void
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200137sigint_handler(int signal_num)
138{
Stefan Richter92c16f72010-07-22 11:58:05 +0200139 if (run == 1) {
140 run = 0;
141 signal(SIGINT, SIG_DFL);
142 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200143}
144
145struct subaction *
Stefan Richter1bcc69f2010-07-22 11:58:05 +0200146subaction_create(uint32_t *data, size_t length)
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200147{
Stefan Richter92c16f72010-07-22 11:58:05 +0200148 struct subaction *sa;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200149
Stefan Richter92c16f72010-07-22 11:58:05 +0200150 /* we put the ack in the subaction struct for easy access. */
151 sa = malloc(sizeof *sa - sizeof sa->packet + length);
152 sa->ack = data[length / 4 - 1];
153 sa->length = length;
154 memcpy(&sa->packet, data, length);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200155
Stefan Richter92c16f72010-07-22 11:58:05 +0200156 return sa;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200157}
158
159void
160subaction_destroy(struct subaction *sa)
161{
Stefan Richter92c16f72010-07-22 11:58:05 +0200162 free(sa);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200163}
164
Stefan Richter92c16f72010-07-22 11:58:05 +0200165struct list pending_transaction_list = {
166 &pending_transaction_list, &pending_transaction_list
167};
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200168
169struct link_transaction *
170link_transaction_lookup(int request_node, int response_node, int tlabel)
171{
Stefan Richter92c16f72010-07-22 11:58:05 +0200172 struct link_transaction *t;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200173
Stefan Richter92c16f72010-07-22 11:58:05 +0200174 list_for_each_entry(t, &pending_transaction_list, link) {
175 if (t->request_node == request_node &&
176 t->response_node == response_node &&
177 t->tlabel == tlabel)
178 return t;
179 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200180
Stefan Richter92c16f72010-07-22 11:58:05 +0200181 t = malloc(sizeof *t);
182 t->request_node = request_node;
183 t->response_node = response_node;
184 t->tlabel = tlabel;
185 list_init(&t->request_list);
186 list_init(&t->response_list);
187
188 list_append(&pending_transaction_list, &t->link);
189
190 return t;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200191}
192
193void
194link_transaction_destroy(struct link_transaction *t)
195{
Stefan Richter92c16f72010-07-22 11:58:05 +0200196 struct subaction *sa;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200197
Stefan Richter92c16f72010-07-22 11:58:05 +0200198 while (!list_empty(&t->request_list)) {
199 sa = list_head(&t->request_list, struct subaction, link);
200 list_remove(&sa->link);
201 subaction_destroy(sa);
202 }
203 while (!list_empty(&t->response_list)) {
204 sa = list_head(&t->response_list, struct subaction, link);
205 list_remove(&sa->link);
206 subaction_destroy(sa);
207 }
208 free(t);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200209}
210
211struct protocol_decoder {
Stefan Richter92c16f72010-07-22 11:58:05 +0200212 const char *name;
213 int (*decode)(struct link_transaction *t);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200214};
215
216static struct protocol_decoder protocol_decoders[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200217 { "FCP", decode_fcp }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200218};
219
220void
221handle_transaction(struct link_transaction *t)
222{
Stefan Richter92c16f72010-07-22 11:58:05 +0200223 struct subaction *sa;
224 int i;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200225
Stefan Richter92c16f72010-07-22 11:58:05 +0200226 if (!t->request) {
227 printf("BUG in handle_transaction\n");
228 return;
229 }
Stefan Richtera8461c02010-07-22 11:58:05 +0200230
Stefan Richter92c16f72010-07-22 11:58:05 +0200231 for (i = 0; i < array_length(protocol_decoders); i++)
232 if (protocol_decoders[i].decode(t))
233 break;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200234
Stefan Richter92c16f72010-07-22 11:58:05 +0200235 /* HACK: decode only fcp right now. */
236 return;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200237
Stefan Richter92c16f72010-07-22 11:58:05 +0200238 decode_link_packet(&t->request->packet, t->request->length,
239 PACKET_FIELD_TRANSACTION, 0);
240 if (t->response)
241 decode_link_packet(&t->response->packet, t->request->length,
242 PACKET_FIELD_TRANSACTION, 0);
243 else
244 printf("[no response]");
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200245
Stefan Richter92c16f72010-07-22 11:58:05 +0200246 if (option_verbose) {
247 list_for_each_entry(sa, &t->request_list, link)
248 print_packet((uint32_t *) &sa->packet, sa->length);
249 list_for_each_entry(sa, &t->response_list, link)
250 print_packet((uint32_t *) &sa->packet, sa->length);
251 }
252 printf("\r\n");
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200253
Stefan Richter92c16f72010-07-22 11:58:05 +0200254 link_transaction_destroy(t);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200255}
256
257void
258clear_pending_transaction_list(void)
259{
Stefan Richter92c16f72010-07-22 11:58:05 +0200260 struct link_transaction *t;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200261
Stefan Richter92c16f72010-07-22 11:58:05 +0200262 while (!list_empty(&pending_transaction_list)) {
263 t = list_head(&pending_transaction_list,
264 struct link_transaction, link);
265 list_remove(&t->link);
266 link_transaction_destroy(t);
267 /* print unfinished transactions */
268 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200269}
270
271static const char * const tcode_names[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200272 [0x0] = "write_quadlet_request", [0x6] = "read_quadlet_response",
273 [0x1] = "write_block_request", [0x7] = "read_block_response",
274 [0x2] = "write_response", [0x8] = "cycle_start",
275 [0x3] = "reserved", [0x9] = "lock_request",
276 [0x4] = "read_quadlet_request", [0xa] = "iso_data",
277 [0x5] = "read_block_request", [0xb] = "lock_response",
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200278};
279
280static const char * const ack_names[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200281 [0x0] = "no ack", [0x8] = "reserved (0x08)",
282 [0x1] = "ack_complete", [0x9] = "reserved (0x09)",
283 [0x2] = "ack_pending", [0xa] = "reserved (0x0a)",
284 [0x3] = "reserved (0x03)", [0xb] = "reserved (0x0b)",
285 [0x4] = "ack_busy_x", [0xc] = "reserved (0x0c)",
286 [0x5] = "ack_busy_a", [0xd] = "ack_data_error",
287 [0x6] = "ack_busy_b", [0xe] = "ack_type_error",
288 [0x7] = "reserved (0x07)", [0xf] = "reserved (0x0f)",
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200289};
290
291static const char * const rcode_names[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200292 [0x0] = "complete", [0x4] = "conflict_error",
293 [0x1] = "reserved (0x01)", [0x5] = "data_error",
294 [0x2] = "reserved (0x02)", [0x6] = "type_error",
295 [0x3] = "reserved (0x03)", [0x7] = "address_error",
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200296};
297
298static const char * const retry_names[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200299 [0x0] = "retry_1",
300 [0x1] = "retry_x",
301 [0x2] = "retry_a",
302 [0x3] = "retry_b",
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200303};
304
305enum {
Stefan Richter92c16f72010-07-22 11:58:05 +0200306 PACKET_RESERVED,
307 PACKET_REQUEST,
308 PACKET_RESPONSE,
309 PACKET_OTHER,
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200310};
311
312struct packet_info {
Stefan Richter92c16f72010-07-22 11:58:05 +0200313 const char *name;
314 int type;
315 int response_tcode;
316 struct packet_field *fields;
317 int field_count;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200318};
319
320struct packet_field {
Stefan Richter92c16f72010-07-22 11:58:05 +0200321 const char *name; /* Short name for field. */
322 int offset; /* Location of field, specified in bits; */
323 /* negative means from end of packet. */
324 int width; /* Width of field, 0 means use data_length. */
325 int flags; /* Show options. */
326 const char * const *value_names;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200327};
328
Stefan Richter92c16f72010-07-22 11:58:05 +0200329#define COMMON_REQUEST_FIELDS \
330 { "dest", 0, 16, PACKET_FIELD_TRANSACTION }, \
331 { "tl", 16, 6 }, \
332 { "rt", 22, 2, PACKET_FIELD_DETAIL, retry_names }, \
333 { "tcode", 24, 4, PACKET_FIELD_TRANSACTION, tcode_names }, \
334 { "pri", 28, 4, PACKET_FIELD_DETAIL }, \
335 { "src", 32, 16, PACKET_FIELD_TRANSACTION }, \
336 { "offs", 48, 48, PACKET_FIELD_TRANSACTION }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200337
Stefan Richter92c16f72010-07-22 11:58:05 +0200338#define COMMON_RESPONSE_FIELDS \
339 { "dest", 0, 16 }, \
340 { "tl", 16, 6 }, \
341 { "rt", 22, 2, PACKET_FIELD_DETAIL, retry_names }, \
342 { "tcode", 24, 4, 0, tcode_names }, \
343 { "pri", 28, 4, PACKET_FIELD_DETAIL }, \
344 { "src", 32, 16 }, \
345 { "rcode", 48, 4, PACKET_FIELD_TRANSACTION, rcode_names }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200346
347struct packet_field read_quadlet_request_fields[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200348 COMMON_REQUEST_FIELDS,
349 { "crc", 96, 32, PACKET_FIELD_DETAIL },
350 { "ack", 156, 4, 0, ack_names },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200351};
352
353struct packet_field read_quadlet_response_fields[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200354 COMMON_RESPONSE_FIELDS,
355 { "data", 96, 32, PACKET_FIELD_TRANSACTION },
356 { "crc", 128, 32, PACKET_FIELD_DETAIL },
357 { "ack", 188, 4, 0, ack_names },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200358};
359
360struct packet_field read_block_request_fields[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200361 COMMON_REQUEST_FIELDS,
362 { "data_length", 96, 16, PACKET_FIELD_TRANSACTION },
363 { "extended_tcode", 112, 16 },
364 { "crc", 128, 32, PACKET_FIELD_DETAIL },
365 { "ack", 188, 4, 0, ack_names },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200366};
367
368struct packet_field block_response_fields[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200369 COMMON_RESPONSE_FIELDS,
370 { "data_length", 96, 16, PACKET_FIELD_DATA_LENGTH },
371 { "extended_tcode", 112, 16 },
372 { "crc", 128, 32, PACKET_FIELD_DETAIL },
373 { "data", 160, 0, PACKET_FIELD_TRANSACTION },
374 { "crc", -64, 32, PACKET_FIELD_DETAIL },
375 { "ack", -4, 4, 0, ack_names },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200376};
377
378struct packet_field write_quadlet_request_fields[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200379 COMMON_REQUEST_FIELDS,
380 { "data", 96, 32, PACKET_FIELD_TRANSACTION },
381 { "ack", -4, 4, 0, ack_names },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200382};
383
384struct packet_field block_request_fields[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200385 COMMON_REQUEST_FIELDS,
386 { "data_length", 96, 16, PACKET_FIELD_DATA_LENGTH | PACKET_FIELD_TRANSACTION },
387 { "extended_tcode", 112, 16, PACKET_FIELD_TRANSACTION },
388 { "crc", 128, 32, PACKET_FIELD_DETAIL },
389 { "data", 160, 0, PACKET_FIELD_TRANSACTION },
390 { "crc", -64, 32, PACKET_FIELD_DETAIL },
391 { "ack", -4, 4, 0, ack_names },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200392};
393
394struct packet_field write_response_fields[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200395 COMMON_RESPONSE_FIELDS,
396 { "reserved", 64, 32, PACKET_FIELD_DETAIL },
397 { "ack", -4, 4, 0, ack_names },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200398};
399
400struct packet_field iso_data_fields[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200401 { "data_length", 0, 16, PACKET_FIELD_DATA_LENGTH },
402 { "tag", 16, 2 },
403 { "channel", 18, 6 },
404 { "tcode", 24, 4, 0, tcode_names },
405 { "sy", 28, 4 },
406 { "crc", 32, 32, PACKET_FIELD_DETAIL },
407 { "data", 64, 0 },
408 { "crc", -64, 32, PACKET_FIELD_DETAIL },
409 { "ack", -4, 4, 0, ack_names },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200410};
411
412static struct packet_info packet_info[] = {
Stefan Richter92c16f72010-07-22 11:58:05 +0200413 {
414 .name = "write_quadlet_request",
415 .type = PACKET_REQUEST,
416 .response_tcode = TCODE_WRITE_RESPONSE,
417 .fields = write_quadlet_request_fields,
418 .field_count = array_length(write_quadlet_request_fields)
419 },
420 {
421 .name = "write_block_request",
422 .type = PACKET_REQUEST,
423 .response_tcode = TCODE_WRITE_RESPONSE,
424 .fields = block_request_fields,
425 .field_count = array_length(block_request_fields)
426 },
427 {
428 .name = "write_response",
429 .type = PACKET_RESPONSE,
430 .fields = write_response_fields,
431 .field_count = array_length(write_response_fields)
432 },
433 {
434 .name = "reserved",
435 .type = PACKET_RESERVED,
436 },
437 {
438 .name = "read_quadlet_request",
439 .type = PACKET_REQUEST,
440 .response_tcode = TCODE_READ_QUADLET_RESPONSE,
441 .fields = read_quadlet_request_fields,
442 .field_count = array_length(read_quadlet_request_fields)
443 },
444 {
445 .name = "read_block_request",
446 .type = PACKET_REQUEST,
447 .response_tcode = TCODE_READ_BLOCK_RESPONSE,
448 .fields = read_block_request_fields,
449 .field_count = array_length(read_block_request_fields)
450 },
451 {
452 .name = "read_quadlet_response",
453 .type = PACKET_RESPONSE,
454 .fields = read_quadlet_response_fields,
455 .field_count = array_length(read_quadlet_response_fields)
456 },
457 {
458 .name = "read_block_response",
459 .type = PACKET_RESPONSE,
460 .fields = block_response_fields,
461 .field_count = array_length(block_response_fields)
462 },
463 {
464 .name = "cycle_start",
465 .type = PACKET_OTHER,
466 .fields = write_quadlet_request_fields,
467 .field_count = array_length(write_quadlet_request_fields)
468 },
469 {
470 .name = "lock_request",
471 .type = PACKET_REQUEST,
472 .fields = block_request_fields,
473 .field_count = array_length(block_request_fields)
474 },
475 {
476 .name = "iso_data",
477 .type = PACKET_OTHER,
478 .fields = iso_data_fields,
479 .field_count = array_length(iso_data_fields)
480 },
481 {
482 .name = "lock_response",
483 .type = PACKET_RESPONSE,
484 .fields = block_response_fields,
485 .field_count = array_length(block_response_fields)
486 },
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200487};
488
489int
Stefan Richter1bcc69f2010-07-22 11:58:05 +0200490handle_packet(uint32_t *data, size_t length)
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200491{
Stefan Richter92c16f72010-07-22 11:58:05 +0200492 if (length == 0) {
493 printf("bus reset\r\n");
494 clear_pending_transaction_list();
495 } else if (length > sizeof(struct phy_packet)) {
496 struct link_packet *p = (struct link_packet *) data;
497 struct subaction *sa, *prev;
498 struct link_transaction *t;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200499
Stefan Richter92c16f72010-07-22 11:58:05 +0200500 switch (packet_info[p->common.tcode].type) {
501 case PACKET_REQUEST:
502 t = link_transaction_lookup(p->common.source, p->common.destination,
503 p->common.tlabel);
504 sa = subaction_create(data, length);
505 t->request = sa;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200506
Stefan Richter92c16f72010-07-22 11:58:05 +0200507 if (!list_empty(&t->request_list)) {
508 prev = list_tail(&t->request_list,
509 struct subaction, link);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200510
Stefan Richter92c16f72010-07-22 11:58:05 +0200511 if (!ACK_BUSY(prev->ack)) {
512 /*
513 * error, we should only see ack_busy_* before the
514 * ack_pending/ack_complete -- this is an ack_pending
515 * instead (ack_complete would have finished the
516 * transaction).
517 */
518 }
519
520 if (prev->packet.common.tcode != sa->packet.common.tcode ||
521 prev->packet.common.tlabel != sa->packet.common.tlabel) {
522 /* memcmp() ? */
523 /* error, these should match for retries. */
524 }
525 }
526
527 list_append(&t->request_list, &sa->link);
528
529 switch (sa->ack) {
530 case ACK_COMPLETE:
531 if (p->common.tcode != TCODE_WRITE_QUADLET &&
532 p->common.tcode != TCODE_WRITE_BLOCK)
533 /* error, unified transactions only allowed for write */;
534 list_remove(&t->link);
535 handle_transaction(t);
536 break;
537
538 case ACK_NO_ACK:
539 case ACK_DATA_ERROR:
540 case ACK_TYPE_ERROR:
541 list_remove(&t->link);
542 handle_transaction(t);
543 break;
544
545 case ACK_PENDING:
546 /* request subaction phase over, wait for response. */
547 break;
548
549 case ACK_BUSY_X:
550 case ACK_BUSY_A:
551 case ACK_BUSY_B:
552 /* ok, wait for retry. */
553 /* check that retry protocol is respected. */
554 break;
555 }
556 break;
557
558 case PACKET_RESPONSE:
559 t = link_transaction_lookup(p->common.destination, p->common.source,
560 p->common.tlabel);
561 if (list_empty(&t->request_list)) {
562 /* unsolicited response */
563 }
564
565 sa = subaction_create(data, length);
566 t->response = sa;
567
568 if (!list_empty(&t->response_list)) {
569 prev = list_tail(&t->response_list, struct subaction, link);
570
571 if (!ACK_BUSY(prev->ack)) {
572 /*
573 * error, we should only see ack_busy_* before the
574 * ack_pending/ack_complete
575 */
576 }
577
578 if (prev->packet.common.tcode != sa->packet.common.tcode ||
579 prev->packet.common.tlabel != sa->packet.common.tlabel) {
580 /* use memcmp() instead? */
581 /* error, these should match for retries. */
582 }
583 } else {
584 prev = list_tail(&t->request_list, struct subaction, link);
585 if (prev->ack != ACK_PENDING) {
586 /*
587 * error, should not get response unless last request got
588 * ack_pending.
589 */
590 }
591
592 if (packet_info[prev->packet.common.tcode].response_tcode !=
593 sa->packet.common.tcode) {
594 /* error, tcode mismatch */
595 }
596 }
597
598 list_append(&t->response_list, &sa->link);
599
600 switch (sa->ack) {
601 case ACK_COMPLETE:
602 case ACK_NO_ACK:
603 case ACK_DATA_ERROR:
604 case ACK_TYPE_ERROR:
605 list_remove(&t->link);
606 handle_transaction(t);
607 /* transaction complete, remove t from pending list. */
608 break;
609
610 case ACK_PENDING:
611 /* error for responses. */
612 break;
613
614 case ACK_BUSY_X:
615 case ACK_BUSY_A:
616 case ACK_BUSY_B:
617 /* no problem, wait for next retry */
618 break;
619 }
620
621 break;
622
623 case PACKET_OTHER:
624 case PACKET_RESERVED:
625 return 0;
626 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200627 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200628
Stefan Richter92c16f72010-07-22 11:58:05 +0200629 return 1;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200630}
631
632unsigned int get_bits(struct link_packet *packet, int offset, int width)
633{
Stefan Richter92c16f72010-07-22 11:58:05 +0200634 uint32_t *data = (uint32_t *) packet;
635 uint32_t index, shift, mask;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200636
Stefan Richter92c16f72010-07-22 11:58:05 +0200637 index = offset / 32 + 1;
638 shift = 32 - (offset & 31) - width;
639 mask = width == 32 ? ~0 : (1 << width) - 1;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200640
Stefan Richter92c16f72010-07-22 11:58:05 +0200641 return (data[index] >> shift) & mask;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200642}
643
644#if __BYTE_ORDER == __LITTLE_ENDIAN
645#define byte_index(i) ((i) ^ 3)
646#elif __BYTE_ORDER == __BIG_ENDIAN
647#define byte_index(i) (i)
648#else
649#error unsupported byte order.
650#endif
651
652void dump_data(unsigned char *data, int length)
653{
Stefan Richter92c16f72010-07-22 11:58:05 +0200654 int i, print_length;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200655
Stefan Richter92c16f72010-07-22 11:58:05 +0200656 if (length > 128)
657 print_length = 128;
658 else
659 print_length = length;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200660
Stefan Richter92c16f72010-07-22 11:58:05 +0200661 for (i = 0; i < print_length; i++)
662 printf("%s%02hhx",
663 (i % 4 == 0 && i != 0) ? " " : "",
664 data[byte_index(i)]);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200665
Stefan Richter92c16f72010-07-22 11:58:05 +0200666 if (print_length < length)
667 printf(" (%d more bytes)", length - print_length);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200668}
669
670static void
671decode_link_packet(struct link_packet *packet, size_t length,
672 int include_flags, int exclude_flags)
673{
Stefan Richter92c16f72010-07-22 11:58:05 +0200674 struct packet_info *pi;
675 int data_length = 0;
676 int i;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200677
Stefan Richter92c16f72010-07-22 11:58:05 +0200678 pi = &packet_info[packet->common.tcode];
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200679
Stefan Richter92c16f72010-07-22 11:58:05 +0200680 for (i = 0; i < pi->field_count; i++) {
681 struct packet_field *f = &pi->fields[i];
682 int offset;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200683
Stefan Richter92c16f72010-07-22 11:58:05 +0200684 if (f->flags & exclude_flags)
685 continue;
686 if (include_flags && !(f->flags & include_flags))
687 continue;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200688
Stefan Richter92c16f72010-07-22 11:58:05 +0200689 if (f->offset < 0)
690 offset = length * 8 + f->offset - 32;
691 else
692 offset = f->offset;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200693
Stefan Richter92c16f72010-07-22 11:58:05 +0200694 if (f->value_names != NULL) {
695 uint32_t bits;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200696
Stefan Richter92c16f72010-07-22 11:58:05 +0200697 bits = get_bits(packet, offset, f->width);
698 printf("%s", f->value_names[bits]);
699 } else if (f->width == 0) {
700 printf("%s=[", f->name);
701 dump_data((unsigned char *) packet + (offset / 8 + 4), data_length);
702 printf("]");
703 } else {
704 unsigned long long bits;
705 int high_width, low_width;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200706
Stefan Richter92c16f72010-07-22 11:58:05 +0200707 if ((offset & ~31) != ((offset + f->width - 1) & ~31)) {
708 /* Bit field spans quadlet boundary. */
709 high_width = ((offset + 31) & ~31) - offset;
710 low_width = f->width - high_width;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200711
Stefan Richter92c16f72010-07-22 11:58:05 +0200712 bits = get_bits(packet, offset, high_width);
713 bits = (bits << low_width) |
714 get_bits(packet, offset + high_width, low_width);
715 } else {
716 bits = get_bits(packet, offset, f->width);
717 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200718
Stefan Richter92c16f72010-07-22 11:58:05 +0200719 printf("%s=0x%0*llx", f->name, (f->width + 3) / 4, bits);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200720
Stefan Richter92c16f72010-07-22 11:58:05 +0200721 if (f->flags & PACKET_FIELD_DATA_LENGTH)
722 data_length = bits;
723 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200724
Stefan Richter92c16f72010-07-22 11:58:05 +0200725 if (i < pi->field_count - 1)
726 printf(", ");
727 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200728}
729
730static void
Stefan Richter1bcc69f2010-07-22 11:58:05 +0200731print_packet(uint32_t *data, size_t length)
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200732{
Stefan Richter92c16f72010-07-22 11:58:05 +0200733 int i;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200734
Stefan Richter92c16f72010-07-22 11:58:05 +0200735 printf("%6u ", data[0]);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200736
Stefan Richter92c16f72010-07-22 11:58:05 +0200737 if (length == 4) {
738 printf("bus reset");
739 } else if (length < sizeof(struct phy_packet)) {
740 printf("short packet: ");
741 for (i = 1; i < length / 4; i++)
742 printf("%s%08x", i == 0 ? "[" : " ", data[i]);
743 printf("]");
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200744
Stefan Richter92c16f72010-07-22 11:58:05 +0200745 } else if (length == sizeof(struct phy_packet) && data[1] == ~data[2]) {
746 struct phy_packet *pp = (struct phy_packet *) data;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200747
Stefan Richter92c16f72010-07-22 11:58:05 +0200748 /* phy packet are 3 quadlets: the 1 quadlet payload,
749 * the bitwise inverse of the payload and the snoop
750 * mode ack */
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200751
Stefan Richter92c16f72010-07-22 11:58:05 +0200752 switch (pp->common.identifier) {
753 case PHY_PACKET_CONFIGURATION:
754 if (!pp->phy_config.set_root && !pp->phy_config.set_gap_count) {
755 printf("ext phy config: phy_id=%02x", pp->phy_config.root_id);
756 } else {
757 printf("phy config:");
758 if (pp->phy_config.set_root)
759 printf(" set_root_id=%02x", pp->phy_config.root_id);
760 if (pp->phy_config.set_gap_count)
761 printf(" set_gap_count=%d", pp->phy_config.gap_count);
762 }
763 break;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200764
Stefan Richter92c16f72010-07-22 11:58:05 +0200765 case PHY_PACKET_LINK_ON:
766 printf("link-on packet, phy_id=%02x", pp->link_on.phy_id);
767 break;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200768
Stefan Richter92c16f72010-07-22 11:58:05 +0200769 case PHY_PACKET_SELF_ID:
770 if (pp->self_id.extended) {
771 printf("extended self id: phy_id=%02x, seq=%d",
772 pp->ext_self_id.phy_id, pp->ext_self_id.sequence);
773 } else {
774 static const char * const speed_names[] = {
775 "S100", "S200", "S400", "BETA"
776 };
777 printf("self id: phy_id=%02x, link %s, gap_count=%d, speed=%s%s%s",
778 pp->self_id.phy_id,
779 (pp->self_id.link_active ? "active" : "not active"),
780 pp->self_id.gap_count,
781 speed_names[pp->self_id.phy_speed],
782 (pp->self_id.contender ? ", irm contender" : ""),
783 (pp->self_id.initiated_reset ? ", initiator" : ""));
784 }
785 break;
786 default:
787 printf("unknown phy packet: ");
788 for (i = 1; i < length / 4; i++)
789 printf("%s%08x", i == 0 ? "[" : " ", data[i]);
790 printf("]");
791 break;
792 }
793 } else {
794 struct link_packet *packet = (struct link_packet *) data;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200795
Stefan Richter92c16f72010-07-22 11:58:05 +0200796 decode_link_packet(packet, length, 0,
797 option_verbose ? 0 : PACKET_FIELD_DETAIL);
798 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200799
Stefan Richter92c16f72010-07-22 11:58:05 +0200800 if (option_hex) {
801 printf(" [");
802 dump_data((unsigned char *) data + 4, length - 4);
803 printf("]");
804 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200805
Stefan Richter92c16f72010-07-22 11:58:05 +0200806 printf("\r\n");
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200807}
808
809#define HIDE_CURSOR "\033[?25l"
810#define SHOW_CURSOR "\033[?25h"
811#define CLEAR "\033[H\033[2J"
812
813static void
Stefan Richter1bcc69f2010-07-22 11:58:05 +0200814print_stats(uint32_t *data, size_t length)
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200815{
Stefan Richter92c16f72010-07-22 11:58:05 +0200816 static int bus_reset_count, short_packet_count, phy_packet_count;
817 static int tcode_count[16];
818 static struct timeval last_update;
819 struct timeval now;
820 int i;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200821
Stefan Richter92c16f72010-07-22 11:58:05 +0200822 if (length == 0)
823 bus_reset_count++;
824 else if (length < sizeof(struct phy_packet))
825 short_packet_count++;
826 else if (length == sizeof(struct phy_packet) && data[1] == ~data[2])
827 phy_packet_count++;
828 else {
829 struct link_packet *packet = (struct link_packet *) data;
830 tcode_count[packet->common.tcode]++;
831 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200832
Stefan Richter92c16f72010-07-22 11:58:05 +0200833 gettimeofday(&now, NULL);
834 if (now.tv_sec <= last_update.tv_sec &&
835 now.tv_usec < last_update.tv_usec + 500000)
836 return;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200837
Stefan Richter92c16f72010-07-22 11:58:05 +0200838 last_update = now;
839 printf(CLEAR HIDE_CURSOR
840 " bus resets : %8d\n"
841 " short packets : %8d\n"
842 " phy packets : %8d\n",
843 bus_reset_count, short_packet_count, phy_packet_count);
844
845 for (i = 0; i < array_length(packet_info); i++)
846 if (packet_info[i].type != PACKET_RESERVED)
847 printf(" %-24s: %8d\n", packet_info[i].name, tcode_count[i]);
848 printf(SHOW_CURSOR "\n");
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200849}
850
851struct termios saved_attributes;
852
853void
Stefan Richter92c16f72010-07-22 11:58:05 +0200854reset_input_mode(void)
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200855{
Stefan Richter92c16f72010-07-22 11:58:05 +0200856 tcsetattr(STDIN_FILENO, TCSANOW, &saved_attributes);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200857}
858
859void
Stefan Richter92c16f72010-07-22 11:58:05 +0200860set_input_mode(void)
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200861{
Stefan Richter92c16f72010-07-22 11:58:05 +0200862 struct termios tattr;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200863
Stefan Richter92c16f72010-07-22 11:58:05 +0200864 /* Make sure stdin is a terminal. */
865 if (!isatty(STDIN_FILENO)) {
866 fprintf(stderr, "Not a terminal.\n");
867 exit(EXIT_FAILURE);
868 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200869
Stefan Richter92c16f72010-07-22 11:58:05 +0200870 /* Save the terminal attributes so we can restore them later. */
871 tcgetattr(STDIN_FILENO, &saved_attributes);
872 atexit(reset_input_mode);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200873
Stefan Richter92c16f72010-07-22 11:58:05 +0200874 /* Set the funny terminal modes. */
875 tcgetattr(STDIN_FILENO, &tattr);
876 tattr.c_lflag &= ~(ICANON|ECHO); /* Clear ICANON and ECHO. */
877 tattr.c_cc[VMIN] = 1;
878 tattr.c_cc[VTIME] = 0;
879 tcsetattr(STDIN_FILENO, TCSAFLUSH, &tattr);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200880}
881
882int main(int argc, const char *argv[])
883{
Stefan Richter92c16f72010-07-22 11:58:05 +0200884 int fd = -1;
885 FILE *output = NULL, *input = NULL;
886 poptContext con;
887 int retval;
888 int view;
889 char c;
890 struct pollfd pollfds[2];
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200891
Stefan Richter92c16f72010-07-22 11:58:05 +0200892 sys_sigint_handler = signal(SIGINT, sigint_handler);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200893
Stefan Richter92c16f72010-07-22 11:58:05 +0200894 con = poptGetContext(NULL, argc, argv, options, 0);
895 retval = poptGetNextOpt(con);
896 if (retval < -1) {
897 poptPrintUsage(con, stdout, 0);
898 return -1;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200899 }
900
Stefan Richter92c16f72010-07-22 11:58:05 +0200901 if (option_version) {
902 printf("dump tool for nosy sniffer, version %s\n", VERSION);
903 return 0;
904 }
905
906 if (__BYTE_ORDER != __LITTLE_ENDIAN)
907 fprintf(stderr, "warning: nosy has only been tested on little "
908 "endian machines\n");
909
910 if (option_input != NULL) {
911 input = fopen(option_input, "r");
912 if (input == NULL) {
913 fprintf(stderr, "Could not open %s, %m\n", option_input);
914 return -1;
915 }
916 } else {
917 fd = open(option_nosy_device, O_RDWR);
918 if (fd < 0) {
919 fprintf(stderr, "Could not open %s, %m\n", option_nosy_device);
920 return -1;
921 }
922 set_input_mode();
923 }
924
925 if (strcmp(option_view, "transaction") == 0)
926 view = VIEW_TRANSACTION;
927 else if (strcmp(option_view, "stats") == 0)
928 view = VIEW_STATS;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200929 else
Stefan Richter92c16f72010-07-22 11:58:05 +0200930 view = VIEW_PACKET;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200931
Stefan Richter92c16f72010-07-22 11:58:05 +0200932 if (option_output) {
933 output = fopen(option_output, "w");
934 if (output == NULL) {
935 fprintf(stderr, "Could not open %s, %m\n", option_output);
936 return -1;
937 }
938 }
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200939
Stefan Richter92c16f72010-07-22 11:58:05 +0200940 setvbuf(stdout, NULL, _IOLBF, BUFSIZ);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200941
Stefan Richter92c16f72010-07-22 11:58:05 +0200942 if (1) {
943 uint32_t buf[128 * 1024];
944 uint32_t filter;
945 int length;
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200946
Stefan Richter92c16f72010-07-22 11:58:05 +0200947 filter = ~0;
948 if (!option_iso)
949 filter &= ~(1 << TCODE_ISO_DATA);
950 if (!option_cycle_start)
951 filter &= ~(1 << TCODE_CYCLE_START);
952 if (view == VIEW_STATS)
953 filter = ~(1 << TCODE_CYCLE_START);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200954
Stefan Richter92c16f72010-07-22 11:58:05 +0200955 ioctl(fd, NOSY_IOC_FILTER, filter);
Stefan Richter9f6d3c42010-07-22 11:58:05 +0200956
Stefan Richter92c16f72010-07-22 11:58:05 +0200957 ioctl(fd, NOSY_IOC_START);
958
959 pollfds[0].fd = fd;
960 pollfds[0].events = POLLIN;
961 pollfds[1].fd = STDIN_FILENO;
962 pollfds[1].events = POLLIN;
963
964 while (run) {
965 if (input != NULL) {
966 if (fread(&length, sizeof length, 1, input) != 1)
967 return 0;
968 fread(buf, 1, length, input);
969 } else {
970 poll(pollfds, 2, -1);
971 if (pollfds[1].revents) {
972 read(STDIN_FILENO, &c, sizeof c);
973 switch (c) {
974 case 'q':
975 if (output != NULL)
976 fclose(output);
977 return 0;
978 }
979 }
980
981 if (pollfds[0].revents)
982 length = read(fd, buf, sizeof buf);
983 else
984 continue;
985 }
986
987 if (output != NULL) {
988 fwrite(&length, sizeof length, 1, output);
989 fwrite(buf, 1, length, output);
990 }
991
992 switch (view) {
993 case VIEW_TRANSACTION:
994 handle_packet(buf, length);
995 break;
996 case VIEW_PACKET:
997 print_packet(buf, length);
998 break;
999 case VIEW_STATS:
1000 print_stats(buf, length);
1001 break;
1002 }
1003 }
1004 } else {
1005 poptPrintUsage(con, stdout, 0);
1006 }
1007
1008 if (output != NULL)
1009 fclose(output);
1010
1011 close(fd);
1012
1013 poptFreeContext(con);
1014
1015 return 0;
Stefan Richter9f6d3c42010-07-22 11:58:05 +02001016}