ieee1394: eth1394: some conditions are unlikely
[linux-2.6.git] / drivers / ieee1394 / ieee1394.h
1 /*
2  * Generic IEEE 1394 definitions
3  */
4
5 #ifndef _IEEE1394_IEEE1394_H
6 #define _IEEE1394_IEEE1394_H
7
8 #define TCODE_WRITEQ            0x0
9 #define TCODE_WRITEB            0x1
10 #define TCODE_WRITE_RESPONSE    0x2
11 #define TCODE_READQ             0x4
12 #define TCODE_READB             0x5
13 #define TCODE_READQ_RESPONSE    0x6
14 #define TCODE_READB_RESPONSE    0x7
15 #define TCODE_CYCLE_START       0x8
16 #define TCODE_LOCK_REQUEST      0x9
17 #define TCODE_ISO_DATA          0xa
18 #define TCODE_STREAM_DATA       0xa
19 #define TCODE_LOCK_RESPONSE     0xb
20
21 #define RCODE_COMPLETE          0x0
22 #define RCODE_CONFLICT_ERROR    0x4
23 #define RCODE_DATA_ERROR        0x5
24 #define RCODE_TYPE_ERROR        0x6
25 #define RCODE_ADDRESS_ERROR     0x7
26
27 #define EXTCODE_MASK_SWAP       0x1
28 #define EXTCODE_COMPARE_SWAP    0x2
29 #define EXTCODE_FETCH_ADD       0x3
30 #define EXTCODE_LITTLE_ADD      0x4
31 #define EXTCODE_BOUNDED_ADD     0x5
32 #define EXTCODE_WRAP_ADD        0x6
33
34 #define ACK_COMPLETE            0x1
35 #define ACK_PENDING             0x2
36 #define ACK_BUSY_X              0x4
37 #define ACK_BUSY_A              0x5
38 #define ACK_BUSY_B              0x6
39 #define ACK_TARDY               0xb
40 #define ACK_CONFLICT_ERROR      0xc
41 #define ACK_DATA_ERROR          0xd
42 #define ACK_TYPE_ERROR          0xe
43 #define ACK_ADDRESS_ERROR       0xf
44
45 /* Non-standard "ACK codes" for internal use */
46 #define ACKX_NONE               (-1)
47 #define ACKX_SEND_ERROR         (-2)
48 #define ACKX_ABORTED            (-3)
49 #define ACKX_TIMEOUT            (-4)
50
51 #define IEEE1394_SPEED_100      0x00
52 #define IEEE1394_SPEED_200      0x01
53 #define IEEE1394_SPEED_400      0x02
54 #define IEEE1394_SPEED_800      0x03
55 #define IEEE1394_SPEED_1600     0x04
56 #define IEEE1394_SPEED_3200     0x05
57
58 /* The current highest tested speed supported by the subsystem */
59 #define IEEE1394_SPEED_MAX      IEEE1394_SPEED_800
60
61 /* Maps speed values above to a string representation */
62 extern const char *hpsb_speedto_str[];
63
64 /* 1394a cable PHY packets */
65 #define SELFID_PWRCL_NO_POWER           0x0
66 #define SELFID_PWRCL_PROVIDE_15W        0x1
67 #define SELFID_PWRCL_PROVIDE_30W        0x2
68 #define SELFID_PWRCL_PROVIDE_45W        0x3
69 #define SELFID_PWRCL_USE_1W             0x4
70 #define SELFID_PWRCL_USE_3W             0x5
71 #define SELFID_PWRCL_USE_6W             0x6
72 #define SELFID_PWRCL_USE_10W            0x7
73
74 #define SELFID_PORT_CHILD               0x3
75 #define SELFID_PORT_PARENT              0x2
76 #define SELFID_PORT_NCONN               0x1
77 #define SELFID_PORT_NONE                0x0
78
79 #define SELFID_SPEED_UNKNOWN            0x3     /* 1394b PHY */
80
81 #define PHYPACKET_LINKON                        0x40000000
82 #define PHYPACKET_PHYCONFIG_R                   0x00800000
83 #define PHYPACKET_PHYCONFIG_T                   0x00400000
84 #define EXTPHYPACKET_TYPE_PING                  0x00000000
85 #define EXTPHYPACKET_TYPE_REMOTEACCESS_BASE     0x00040000
86 #define EXTPHYPACKET_TYPE_REMOTEACCESS_PAGED    0x00140000
87 #define EXTPHYPACKET_TYPE_REMOTEREPLY_BASE      0x000C0000
88 #define EXTPHYPACKET_TYPE_REMOTEREPLY_PAGED     0x001C0000
89 #define EXTPHYPACKET_TYPE_REMOTECOMMAND         0x00200000
90 #define EXTPHYPACKET_TYPE_REMOTECONFIRMATION    0x00280000
91 #define EXTPHYPACKET_TYPE_RESUME                0x003C0000
92
93 #define EXTPHYPACKET_TYPEMASK                   0xC0FC0000
94
95 #define PHYPACKET_PORT_SHIFT            24
96 #define PHYPACKET_GAPCOUNT_SHIFT        16
97
98 /* 1394a PHY register map bitmasks */
99 #define PHY_00_PHYSICAL_ID      0xFC
100 #define PHY_00_R                0x02 /* Root */
101 #define PHY_00_PS               0x01 /* Power Status*/
102 #define PHY_01_RHB              0x80 /* Root Hold-Off */
103 #define PHY_01_IBR              0x80 /* Initiate Bus Reset */
104 #define PHY_01_GAP_COUNT        0x3F
105 #define PHY_02_EXTENDED         0xE0 /* 0x7 for 1394a-compliant PHY */
106 #define PHY_02_TOTAL_PORTS      0x1F
107 #define PHY_03_MAX_SPEED        0xE0
108 #define PHY_03_DELAY            0x0F
109 #define PHY_04_LCTRL            0x80 /* Link Active Report Control */
110 #define PHY_04_CONTENDER        0x40
111 #define PHY_04_JITTER           0x38
112 #define PHY_04_PWR_CLASS        0x07 /* Power Class */
113 #define PHY_05_WATCHDOG         0x80
114 #define PHY_05_ISBR             0x40 /* Initiate Short Bus Reset */
115 #define PHY_05_LOOP             0x20 /* Loop Detect */
116 #define PHY_05_PWR_FAIL         0x10 /* Cable Power Failure Detect */
117 #define PHY_05_TIMEOUT          0x08 /* Arbitration State Machine Timeout */
118 #define PHY_05_PORT_EVENT       0x04 /* Port Event Detect */
119 #define PHY_05_ENAB_ACCEL       0x02 /* Enable Arbitration Acceleration */
120 #define PHY_05_ENAB_MULTI       0x01 /* Ena. Multispeed Packet Concatenation */
121
122 #include <asm/byteorder.h>
123
124 #ifdef __BIG_ENDIAN_BITFIELD
125
126 struct selfid {
127         u32 packet_identifier:2; /* always binary 10 */
128         u32 phy_id:6;
129         /* byte */
130         u32 extended:1; /* if true is struct ext_selfid */
131         u32 link_active:1;
132         u32 gap_count:6;
133         /* byte */
134         u32 speed:2;
135         u32 phy_delay:2;
136         u32 contender:1;
137         u32 power_class:3;
138         /* byte */
139         u32 port0:2;
140         u32 port1:2;
141         u32 port2:2;
142         u32 initiated_reset:1;
143         u32 more_packets:1;
144 } __attribute__((packed));
145
146 struct ext_selfid {
147         u32 packet_identifier:2; /* always binary 10 */
148         u32 phy_id:6;
149         /* byte */
150         u32 extended:1; /* if false is struct selfid */
151         u32 seq_nr:3;
152         u32 reserved:2;
153         u32 porta:2;
154         /* byte */
155         u32 portb:2;
156         u32 portc:2;
157         u32 portd:2;
158         u32 porte:2;
159         /* byte */
160         u32 portf:2;
161         u32 portg:2;
162         u32 porth:2;
163         u32 reserved2:1;
164         u32 more_packets:1;
165 } __attribute__((packed));
166
167 #elif defined __LITTLE_ENDIAN_BITFIELD /* __BIG_ENDIAN_BITFIELD */
168
169 /*
170  * Note: these mean to be bit fields of a big endian SelfID as seen on a little
171  * endian machine.  Without swapping.
172  */
173
174 struct selfid {
175         u32 phy_id:6;
176         u32 packet_identifier:2; /* always binary 10 */
177         /* byte */
178         u32 gap_count:6;
179         u32 link_active:1;
180         u32 extended:1; /* if true is struct ext_selfid */
181         /* byte */
182         u32 power_class:3;
183         u32 contender:1;
184         u32 phy_delay:2;
185         u32 speed:2;
186         /* byte */
187         u32 more_packets:1;
188         u32 initiated_reset:1;
189         u32 port2:2;
190         u32 port1:2;
191         u32 port0:2;
192 } __attribute__((packed));
193
194 struct ext_selfid {
195         u32 phy_id:6;
196         u32 packet_identifier:2; /* always binary 10 */
197         /* byte */
198         u32 porta:2;
199         u32 reserved:2;
200         u32 seq_nr:3;
201         u32 extended:1; /* if false is struct selfid */
202         /* byte */
203         u32 porte:2;
204         u32 portd:2;
205         u32 portc:2;
206         u32 portb:2;
207         /* byte */
208         u32 more_packets:1;
209         u32 reserved2:1;
210         u32 porth:2;
211         u32 portg:2;
212         u32 portf:2;
213 } __attribute__((packed));
214
215 #else
216 #error What? PDP endian?
217 #endif /* __BIG_ENDIAN_BITFIELD */
218
219 #endif /* _IEEE1394_IEEE1394_H */