tools/firewire: add userspace front-end of nosy

This adds nosy-dump, the userspace part of nosy, the IEEE 1394 traffic
sniffer for Texas Instruments PCILynx/ PCILynx2 based cards.  Author is
Kristian Høgsberg.

The files added here are taken from
git://anongit.freedesktop.org/~krh/nosy commit ee29be97 (2009-11-10)
with the following changes by Stefan Richter:
  - Parts pertaining to the kernel module removed from Makefile.
  - dist target removed from the Makefile.
  - Mentioned nosy-dump in the Kconfig help to nosy's kernel component.
  - Add copyright notice to nosy-dump.c.  This is a duplicate of the
    respective notice in the kernel component nosy.c except for a time
    span of 2002 - 2006, according to Kristian's git log.

"git shortlog decode-fcp.c list.h nosy-dump.[ch]" from nosy's git
repository:

Jonathan Woithe (1):
      Save logs on Ctrl-C

Kristian Høgsberg (11):
      Pull over nosy from mercurial repo.
      Remove some fields from default view, add logging feature.
      Use infinite time out for poll(), mark more detail fields.
      Fix byte ordering macro.
      Add decoding of iso data and lock packets.
      Add flag to indicate data length field.
      Add cycle start packet decoding, add --iso and --cycle-start flags.
      Distinguish between phy-packets and 0-length iso data.
      Fix transaction and stats view.
      Add simple AV/C decoder.
      Don't break down on big payloads.
Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
Acked-by: Kristian Høgsberg <krh@bitplanet.net>

MAINTAINERS

@@ -2256,6 +2256,7 @@ T:	git git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394/linux1394-2.6.git
 S:	Maintained
 F:	drivers/firewire/
 F:	include/linux/firewire*.h
+F:	tools/firewire/
 
 FIRMWARE LOADER (request_firmware)
 S:	Orphan

drivers/firewire/Kconfig

@@ -85,7 +85,8 @@ config FIREWIRE_NOSY
 	  Apple Power Mac G3 blue & white (onboard controller).
 
 	  To compile this driver as a module, say M here:  The module will be
-	  called nosy.
+	  called nosy.  Source code of a userspace interface to nosy, called
+	  nosy-dump, can be found in tools/firewire/ of the kernel sources.
 
 	  If unsure, say N.
 

tools/firewire/Makefile

+version = 0.3
+prefix = /usr
+
+CC = gcc
+
+all : nosy-dump
+
+nosy-dump : CFLAGS = -Wall -O2 -g
+nosy-dump : CPPFLAGS = -DVERSION=\"$(version)\" -I../../drivers/firewire
+nosy-dump : LDFLAGS = -g
+nosy-dump : LDLIBS = -lpopt
+
+nosy-dump : nosy-dump.o decode-fcp.o
+
+clean :
+	rm -rf *.o nosy-dump
+
+install :
+	install nosy-dump $(prefix)/bin/nosy-dump

tools/firewire/decode-fcp.c

+#include <stdlib.h>
+#include <stdio.h>
+#include "list.h"
+#include "nosy-dump.h"
+
+#define CSR_FCP_COMMAND			0xfffff0000b00ull
+#define CSR_FCP_RESPONSE		0xfffff0000d00ull
+
+static const char * const ctype_names[16] = {
+    "control",
+    "status",
+    "specific inquiry",
+    "notify",
+    "general inquiry",
+    "(reserved 0x05)",
+    "(reserved 0x06)",
+    "(reserved 0x07)",
+    "not implemented",
+    "accepted",
+    "rejected",
+    "in transition",
+    "stable",
+    "changed",
+    "(reserved 0x0e)",
+    "interim"
+};
+
+static const char * const subunit_type_names[32] = {
+    "monitor",
+    "audio",
+    "printer",
+    "disc",
+    "tape recorder/player",
+    "tuner",
+    "ca",
+    "camera",
+    "(reserved 0x08)",
+    "panel",
+    "bulletin board",
+    "camera storage",
+    "(reserved 0x0c)",
+    "(reserved 0x0d)",
+    "(reserved 0x0e)",
+    "(reserved 0x0f)",
+    "(reserved 0x10)",
+    "(reserved 0x11)",
+    "(reserved 0x12)",
+    "(reserved 0x13)",
+    "(reserved 0x14)",
+    "(reserved 0x15)",
+    "(reserved 0x16)",
+    "(reserved 0x17)",
+    "(reserved 0x18)",
+    "(reserved 0x19)",
+    "(reserved 0x1a)",
+    "(reserved 0x1b)",
+    "vendor unique",
+    "all subunit types",
+    "subunit_type extended to next byte",
+    "unit"
+};
+
+struct avc_enum {
+    int value;
+    const char *name;
+};
+
+struct avc_field {
+  const char *name;	/* Short name for field. */
+  int offset;		/* Location of field, specified in bits.
+			 * Negative means from end of packet */
+  int width;		/* Width of field, 0 means use data_length. */
+  struct avc_enum *names;
+};
+
+struct avc_opcode_info {
+    const char *name;
+    struct avc_field fields[8];
+};
+
+struct avc_enum power_field_names[] = {
+    { 0x70, "on" },
+    { 0x60, "off" },
+    { }
+};
+
+static const struct avc_opcode_info opcode_info[256] = {
+
+    /* TA Document 1999026
+     * AV/C Digital Interface Command Set General Specification
+     * Version 4.0 */
+    [0xb2] =
+    { "power", {
+	    { "state", 0, 8, power_field_names }
+	}
+    },
+    [0x30] =
+    { "unit info", {
+	    { "foo", 0, 8 },
+	    { "unit_type", 8, 5 },
+	    { "unit", 13, 3 },
+	    { "company id", 16, 24 },
+	}
+    },
+    [0x31] = { "subunit info" },
+    [0x01] = { "reserve" },
+    [0xb0] = { "version" },
+    [0x00] = { "vendor dependent" },
+
+    [0x02] = { "plug info" },
+    [0x12] = { "channel usage" },
+    [0x24] = { "connect" },
+    [0x20] = { "connect av" },
+    [0x22] = { "connections" },
+    [0x11] = { "digital input" },
+    [0x10] = { "digital output" },
+    [0x25] = { "disconnect" },
+    [0x21] = { "disconnect av" },
+    [0x19] = { "input plug signal format" },
+    [0x18] = { "output plug signal format" },
+    [0x1f] = { "general bus setup" },
+
+    /* TA Document 1999025
+     * AV/C Descriptor Mechanism Specification Version 1.0 */
+    [0x0c] = { "create descriptor" },
+    [0x08] = { "open descriptor" },
+    [0x09] = { "read descriptor" },
+    [0x0a] = { "write descriptor" },
+    [0x05] = { "open info block" },
+    [0x06] = { "read info block" },
+    [0x07] = { "write info block" },
+    [0x0b] = { "search descriptor" },
+    [0x0d] = { "object number select" },
+
+    /* TA Document 1999015
+     * AV/C Command Set for Rate Control of Isochronous Data Flow 1.0 */
+    [0xb3] = { "rate", {
+	    { "subfunction", 0, 8 },
+	    { "result", 8, 8 },
+	    { "plug_type", 16, 8 },
+	    { "plug_id", 16, 8 },
+	}
+    },
+
+    /* TA Document 1999008
+     * AV/C Audio Subunit Specification 1.0 */
+    [0xb8] = { "function block" },
+
+    /* TA Document 2001001
+     * AV/C Panel Subunit Specification 1.1 */
+    [0x7d] = { "gui update" },
+    [0x7e] = { "push gui data" },
+    [0x7f] = { "user action" },
+    [0x7c] = { "pass through" },
+
+    /* */
+    [0x26] = { "asynchronous connection" },
+};
+
+struct avc_frame {
+    unsigned int operand0 : 8;
+    unsigned int opcode : 8;
+    unsigned int subunit_id : 3;
+    unsigned int subunit_type : 5;
+    unsigned int ctype : 4;
+    unsigned int cts : 4;
+};
+
+static void
+decode_avc(struct link_transaction *t)
+{
+    struct avc_frame *frame = (struct avc_frame *) t->request->packet.write_block.data;
+    const struct avc_opcode_info *info;
+    const char *name;
+    char buffer[32];
+    int i;
+
+    info = &opcode_info[frame->opcode];
+    if (info->name == NULL) {
+	snprintf(buffer, sizeof buffer, "(unknown opcode 0x%02x)", frame->opcode);
+	name = buffer;
+    } else {
+	name = info->name;
+    }
+
+    printf("av/c %s, subunit_type=%s, subunit_id=%d, opcode=%s",
+	   ctype_names[frame->ctype], subunit_type_names[frame->subunit_type],
+	   frame->subunit_id, name);
+
+    for (i = 0; info->fields[i].name != NULL; i++) {
+	printf(", %s", info->fields[i].name);
+    }
+
+    printf("\n");
+}
+
+
+int
+decode_fcp(struct link_transaction *t)
+{
+    struct avc_frame *frame = (struct avc_frame *) t->request->packet.write_block.data;
+    unsigned long long offset;
+
+    offset = ((unsigned long long) t->request->packet.common.offset_high << 32) |
+	t->request->packet.common.offset_low;
+
+    if (t->request->packet.common.tcode != TCODE_WRITE_BLOCK)
+	return 0;
+
+    if (offset == CSR_FCP_COMMAND || offset == CSR_FCP_RESPONSE) {
+	switch (frame->cts) {
+	case 0x00:
+	    decode_avc(t);
+	    break;
+	case 0x01:
+	    printf("cal fcp frame (cts=0x01)\n");
+	    break;
+	case 0x02:
+	    printf("ehs fcp frame (cts=0x02)\n");
+	    break;
+	case 0x03:
+	    printf("havi fcp frame (cts=0x03)\n");
+	    break;
+	case 0x0e:
+	    printf("vendor specific fcp frame (cts=0x0e)\n");
+	    break;
+	case 0x0f:
+	    printf("extended cts\n");
+	    break;
+	default:
+	    printf("reserved fcp frame (ctx=0x%02x)\n", frame->cts);
+	    break;
+	}
+	return 1;
+    }
+
+    return 0;
+}
+

tools/firewire/list.h

+struct list {
+  struct list *next, *prev;
+};
+
+static inline void
+list_init(struct list *list)
+{
+  list->next = list;
+  list->prev = list;
+}
+
+static inline int
+list_empty(struct list *list)
+{
+  return list->next == list;
+}
+
+static inline void
+list_insert(struct list *link, struct list *new_link)
+{
+  new_link->prev       = link->prev;
+  new_link->next       = link;
+  new_link->prev->next = new_link;
+  new_link->next->prev = new_link;
+}
+
+static inline void
+list_append(struct list *list, struct list *new_link)
+{
+  list_insert((struct list *)list, new_link);
+}
+
+static inline void
+list_prepend(struct list *list, struct list *new_link)
+{
+  list_insert(list->next, new_link);
+}
+
+static inline void
+list_remove(struct list *link)
+{
+  link->prev->next = link->next;
+  link->next->prev = link->prev;
+}
+
+#define list_entry(link, type, member) \
+	((type *)((char *)(link)-(unsigned long)(&((type *)0)->member)))
+
+#define list_head(list, type, member)		\
+	list_entry((list)->next, type, member)
+
+#define list_tail(list, type, member)		\
+	list_entry((list)->prev, type, member)
+
+#define list_next(elm, member)					\
+	list_entry((elm)->member.next, typeof(*elm), member)
+
+#define list_for_each_entry(pos, list, member)			\
+	for (pos = list_head(list, typeof(*pos), member);	\
+	     &pos->member != (list);				\
+	     pos = list_next(pos, member))
+

tools/firewire/nosy-dump.h

+#ifndef __nosy_dump_h__
+#define __nosy_dump_h__
+
+#define array_length(array) (sizeof(array) / sizeof(array[0]))
+
+#define TCODE_WRITE_QUADLET         0x0
+#define TCODE_WRITE_BLOCK           0x1
+#define TCODE_WRITE_RESPONSE        0x2
+#define TCODE_READ_QUADLET          0x4
+#define TCODE_READ_BLOCK            0x5
+#define TCODE_READ_QUADLET_RESPONSE 0x6
+#define TCODE_READ_BLOCK_RESPONSE   0x7
+#define TCODE_CYCLE_START           0x8
+#define TCODE_LOCK_REQUEST          0x9
+#define TCODE_ISO_DATA              0xa
+#define TCODE_LOCK_RESPONSE         0xb
+#define TCODE_PHY_PACKET            0x10
+
+#define ACK_NO_ACK               0x0
+#define ACK_COMPLETE             0x1
+#define ACK_PENDING              0x2
+#define ACK_BUSY_X               0x4
+#define ACK_BUSY_A               0x5
+#define ACK_BUSY_B               0x6
+#define ACK_DATA_ERROR           0xd
+#define ACK_TYPE_ERROR           0xe 
+
+#define ACK_DONE(a)  ((a >> 2) == 0)
+#define ACK_BUSY(a)  ((a >> 2) == 1)
+#define ACK_ERROR(a) ((a >> 2) == 3)
+
+#define SPEED_100                0x0
+#define SPEED_200                0x1
+#define SPEED_400                0x2
+
+struct phy_packet {
+  unsigned long timestamp;
+
+  union {
+    struct {
+      unsigned int zero : 24;
+      unsigned int phy_id : 6;
+      unsigned int identifier : 2;
+    } common, link_on;
+    struct {
+      unsigned int zero : 16;
+      unsigned int gap_count : 6;
+      unsigned int set_gap_count : 1;
+      unsigned int set_root : 1;
+      unsigned int root_id : 6;
+      unsigned int identifier : 2;
+    } phy_config;
+    struct {
+      unsigned int more_packets : 1;
+      unsigned int initiated_reset : 1;
+      unsigned int port2 : 2;
+      unsigned int port1 : 2;
+      unsigned int port0 : 2;
+      unsigned int power_class : 3;
+      unsigned int contender : 1;
+      unsigned int phy_delay : 2;
+      unsigned int phy_speed : 2;
+      unsigned int gap_count : 6;
+      unsigned int link_active : 1;
+      unsigned int extended : 1;
+      unsigned int phy_id : 6;
+      unsigned int identifier : 2;
+    } self_id;
+
+    struct {
+      unsigned int more_packets : 1;
+      unsigned int reserved1 : 1;
+      unsigned int porth : 2;
+      unsigned int portg : 2;
+      unsigned int portf : 2;
+      unsigned int porte : 2;
+      unsigned int portd : 2;
+      unsigned int portc : 2;
+      unsigned int portb : 2;
+      unsigned int porta : 2;
+      unsigned int reserved0 : 2;
+      unsigned int sequence : 3;
+      unsigned int extended : 1;
+      unsigned int phy_id : 6;
+      unsigned int identifier : 2;
+    } ext_self_id;
+  };
+
+  unsigned long inverted;
+  unsigned long ack;
+};
+
+#define PHY_PACKET_CONFIGURATION 0x00
+#define PHY_PACKET_LINK_ON 0x01
+#define PHY_PACKET_SELF_ID 0x02
+
+struct link_packet {
+  unsigned long timestamp;
+
+  union {
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int offset_high : 16;
+      unsigned int source : 16;
+
+      unsigned long offset_low;
+    } common;
+
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int offset_high : 16;
+      unsigned int source : 16;
+
+      unsigned long offset_low;
+
+      unsigned long crc;
+    } read_quadlet;
+
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int reserved0 : 12;
+      unsigned int rcode : 4;
+      unsigned int source : 16;
+
+      unsigned long reserved1;
+
+      unsigned long data;
+ 
+      unsigned long crc; 
+    } read_quadlet_response;
+
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int offset_high : 16;
+      unsigned int source : 16;
+
+      unsigned long offset_low;
+
+      unsigned int extended_tcode : 16;
+      unsigned int data_length : 16;
+
+      unsigned long crc;
+    } read_block;
+
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int reserved0 : 12;
+      unsigned int rcode : 4;
+      unsigned int source : 16;
+
+      unsigned long reserved1;
+
+      unsigned int extended_tcode : 16;
+      unsigned int data_length : 16;
+
+      unsigned long crc; 
+
+      unsigned long data[0];
+
+      /* crc and ack follows. */
+
+    } read_block_response;
+
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int offset_high : 16;
+      unsigned int source : 16;
+
+      unsigned long offset_low;
+
+      unsigned long data;
+ 
+      unsigned long crc; 
+
+    } write_quadlet;
+
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int offset_high : 16;
+      unsigned int source : 16;
+
+      unsigned int offset_low : 32;
+
+      unsigned int extended_tcode : 16;
+      unsigned int data_length : 16;
+ 
+      unsigned long crc; 
+      unsigned long data[0];
+
+      /* crc and ack follows. */
+
+    } write_block;
+
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int reserved0 : 12;
+      unsigned int rcode : 4;
+      unsigned int source : 16;
+
+      unsigned long reserved1;
+
+      unsigned long crc; 
+    } write_response;
+
+    struct {
+      unsigned int priority : 4;
+      unsigned int tcode : 4;
+      unsigned int rt : 2;
+      unsigned int tlabel : 6;
+      unsigned int destination : 16;
+
+      unsigned int offset_high : 16;
+      unsigned int source : 16;
+
+      unsigned long offset_low;
+
+      unsigned long data;
+
+      unsigned long crc; 
+    } cycle_start;
+
+    struct {
+      unsigned int sy : 4;
+      unsigned int tcode : 4;
+      unsigned int channel : 6;
+      unsigned int tag : 2;
+      unsigned int data_length : 16;
+
+      unsigned long crc;
+    } iso_data;
+
+  };
+
+};
+
+struct subaction {
+  unsigned long ack;
+  size_t length;
+  struct list link;
+  struct link_packet packet;
+};
+
+struct link_transaction {
+  int request_node, response_node, tlabel;
+  struct subaction *request, *response;
+  struct list request_list, response_list;
+  struct list link;
+};
+
+int decode_fcp(struct link_transaction *t);
+
+#endif /* __nosy_dump_h__ */