[linux-2.6-block.git] / drivers / ieee1394 / eth1394.h

/*
 * eth1394.h -- Ethernet driver for Linux IEEE-1394 Subsystem
 *
 * Copyright (C) 2000 Bonin Franck <boninf@free.fr>
 *           (C) 2001 Ben Collins <bcollins@debian.org>
 *
 * Mainly based on work by Emanuel Pirker and Andreas E. Bombe
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __ETH1394_H
#define __ETH1394_H

#include <linux/netdevice.h>
#include <linux/skbuff.h>
#include <asm/byteorder.h>

#include "ieee1394.h"
#include "ieee1394_types.h"

/* Register for incoming packets. This is 4096 bytes, which supports up to
 * S3200 (per Table 16-3 of IEEE 1394b-2002). */
#define ETHER1394_REGION_ADDR_LEN	4096

/* GASP identifier numbers for IPv4 over IEEE 1394 */
#define ETHER1394_GASP_SPECIFIER_ID	0x00005E
#define ETHER1394_GASP_SPECIFIER_ID_HI	((0x00005E >> 8) & 0xffff)
#define ETHER1394_GASP_SPECIFIER_ID_LO	(0x00005E & 0xff)
#define ETHER1394_GASP_VERSION		1

#define ETHER1394_GASP_OVERHEAD	(2 * sizeof(quadlet_t))	/* for GASP header */

#define ETHER1394_GASP_BUFFERS	16

#define NODE_SET		(ALL_NODES + 1)		/* Node set == 64 */

enum eth1394_bc_states { ETHER1394_BC_ERROR,
			 ETHER1394_BC_RUNNING,
			 ETHER1394_BC_STOPPED };


/* Private structure for our ethernet driver */
struct eth1394_priv {
	struct hpsb_host *host;		/* The card for this dev	 */
	u16 bc_maxpayload;		/* Max broadcast payload	 */
	u8 bc_sspd;			/* Max broadcast speed		 */
	u64 local_fifo;			/* Local FIFO Address		 */
	spinlock_t lock;		/* Private lock			 */
	int broadcast_channel;		/* Async stream Broadcast Channel */
	enum eth1394_bc_states bc_state; /* broadcast channel state	 */
	struct hpsb_iso *iso;		/* Async stream recv handle	 */
	int bc_dgl;			/* Outgoing broadcast datagram label */
	struct list_head ip_node_list;	/* List of IP capable nodes	 */
	struct unit_directory *ud_list[ALL_NODES]; /* Cached unit dir list */

	struct work_struct wake;	/* Wake up after xmit failure	 */
	struct net_device *wake_dev;	/* Stupid backlink for .wake	 */
	nodeid_t wake_node;		/* Destination of failed xmit	 */
};


/* Define a fake hardware header format for the networking core.  Note that
 * header size cannot exceed 16 bytes as that is the size of the header cache.
 * Also, we do not need the source address in the header so we omit it and
 * keep the header to under 16 bytes */
#define ETH1394_ALEN (8)
#define ETH1394_HLEN (10)

struct eth1394hdr {
	unsigned char	h_dest[ETH1394_ALEN];	/* destination eth1394 addr	*/
	__be16		h_proto;		/* packet type ID field	*/
}  __attribute__((packed));

static inline struct eth1394hdr *eth1394_hdr(const struct sk_buff *skb)
{
	return (struct eth1394hdr *)skb_mac_header(skb);
}

typedef enum {ETH1394_GASP, ETH1394_WRREQ} eth1394_tx_type;

/* IP1394 headers */

/* Unfragmented */
#if defined __BIG_ENDIAN_BITFIELD
struct eth1394_uf_hdr {
	u16 lf:2;
	u16 res:14;
	__be16 ether_type;		/* Ethernet packet type */
} __attribute__((packed));
#elif defined __LITTLE_ENDIAN_BITFIELD
struct eth1394_uf_hdr {
	u16 res:14;
	u16 lf:2;
	__be16 ether_type;
} __attribute__((packed));
#else
#error Unknown bit field type
#endif

/* First fragment */
#if defined __BIG_ENDIAN_BITFIELD
struct eth1394_ff_hdr {
	u16 lf:2;
	u16 res1:2;
	u16 dg_size:12;		/* Datagram size */
	__be16 ether_type;		/* Ethernet packet type */
	u16 dgl;		/* Datagram label */
	u16 res2;
} __attribute__((packed));
#elif defined __LITTLE_ENDIAN_BITFIELD
struct eth1394_ff_hdr {
	u16 dg_size:12;
	u16 res1:2;
	u16 lf:2;
	__be16 ether_type;
	u16 dgl;
	u16 res2;
} __attribute__((packed));
#else
#error Unknown bit field type
#endif

/* XXX: Subsequent fragments, including last */
#if defined __BIG_ENDIAN_BITFIELD
struct eth1394_sf_hdr {
	u16 lf:2;
	u16 res1:2;
	u16 dg_size:12;		/* Datagram size */
	u16 res2:4;
	u16 fg_off:12;		/* Fragment offset */
	u16 dgl;		/* Datagram label */
	u16 res3;
} __attribute__((packed));
#elif defined __LITTLE_ENDIAN_BITFIELD
struct eth1394_sf_hdr {
	u16 dg_size:12;
	u16 res1:2;
	u16 lf:2;
	u16 fg_off:12;
	u16 res2:4;
	u16 dgl;
	u16 res3;
} __attribute__((packed));
#else
#error Unknown bit field type
#endif

#if defined __BIG_ENDIAN_BITFIELD
struct eth1394_common_hdr {
	u16 lf:2;
	u16 pad1:14;
} __attribute__((packed));
#elif defined __LITTLE_ENDIAN_BITFIELD
struct eth1394_common_hdr {
	u16 pad1:14;
	u16 lf:2;
} __attribute__((packed));
#else
#error Unknown bit field type
#endif

struct eth1394_hdr_words {
	u16 word1;
	u16 word2;
	u16 word3;
	u16 word4;
};

union eth1394_hdr {
	struct eth1394_common_hdr common;
	struct eth1394_uf_hdr uf;
	struct eth1394_ff_hdr ff;
	struct eth1394_sf_hdr sf;
	struct eth1394_hdr_words words;
};

/* End of IP1394 headers */

/* Fragment types */
#define ETH1394_HDR_LF_UF	0	/* unfragmented		*/
#define ETH1394_HDR_LF_FF	1	/* first fragment	*/
#define ETH1394_HDR_LF_LF	2	/* last fragment	*/
#define ETH1394_HDR_LF_IF	3	/* interior fragment	*/

#define IP1394_HW_ADDR_LEN	16	/* As per RFC		*/

/* Our arp packet (ARPHRD_IEEE1394) */
struct eth1394_arp {
	u16 hw_type;		/* 0x0018	*/
	u16 proto_type;		/* 0x0806	*/
	u8 hw_addr_len;		/* 16 		*/
	u8 ip_addr_len;		/* 4		*/
	u16 opcode;		/* ARP Opcode	*/
	/* Above is exactly the same format as struct arphdr */

	__be64 s_uniq_id;	/* Sender's 64bit EUI		*/
	u8 max_rec;		/* Sender's max packet size		*/
	u8 sspd;		/* Sender's max speed			*/
	__be16 fifo_hi;		/* hi 16bits of sender's FIFO addr	*/
	__be32 fifo_lo;		/* lo 32bits of sender's FIFO addr	*/
	u32 sip;		/* Sender's IP Address			*/
	u32 tip;		/* IP Address of requested hw addr	*/
};

/* Network timeout */
#define ETHER1394_TIMEOUT	100000

/* This is our task struct. It's used for the packet complete callback.  */
struct packet_task {
	struct sk_buff *skb;
	int outstanding_pkts;
	eth1394_tx_type tx_type;
	int max_payload;
	struct hpsb_packet *packet;
	struct eth1394_priv *priv;
	union eth1394_hdr hdr;
	u64 addr;
	u16 dest_node;
};

#endif /* __ETH1394_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* eth1394.h -- Ethernet driver for Linux IEEE-1394 Subsystem
	3	*
	4	* Copyright (C) 2000 Bonin Franck <boninf@free.fr>
	5	* (C) 2001 Ben Collins <bcollins@debian.org>
	6	*
	7	* Mainly based on work by Emanuel Pirker and Andreas E. Bombe
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software Foundation,
	21	* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	22	*/
	23
	24	#ifndef __ETH1394_H
	25	#define __ETH1394_H
	26
	27	#include <linux/netdevice.h>
efbeccf1 SR	28	#include <linux/skbuff.h>
efbeccf1 SR	29	#include <asm/byteorder.h>
1da177e4 LT	30
1da177e4 LT	31	#include "ieee1394.h"
e167c88e	32	#include "ieee1394_types.h"
1da177e4 LT	33
	34	/* Register for incoming packets. This is 4096 bytes, which supports up to
	35	* S3200 (per Table 16-3 of IEEE 1394b-2002). */
	36	#define ETHER1394_REGION_ADDR_LEN 4096
	37
1da177e4 LT	38	/* GASP identifier numbers for IPv4 over IEEE 1394 */
1da177e4 LT	39	#define ETHER1394_GASP_SPECIFIER_ID 0x00005E
efbeccf1 SR	40	#define ETHER1394_GASP_SPECIFIER_ID_HI ((0x00005E >> 8) & 0xffff)
efbeccf1 SR	41	#define ETHER1394_GASP_SPECIFIER_ID_LO (0x00005E & 0xff)
1da177e4 LT	42	#define ETHER1394_GASP_VERSION 1
1da177e4 LT	43
efbeccf1	44	#define ETHER1394_GASP_OVERHEAD (2 * sizeof(quadlet_t)) /* for GASP header */
1da177e4	45
efbeccf1	46	#define ETHER1394_GASP_BUFFERS 16
3ae3d0d4	47
efbeccf1	48	#define NODE_SET (ALL_NODES + 1) /* Node set == 64 */
1da177e4 LT	49
	50	enum eth1394_bc_states { ETHER1394_BC_ERROR,
	51	ETHER1394_BC_RUNNING,
	52	ETHER1394_BC_STOPPED };
	53
	54
	55	/* Private structure for our ethernet driver */
	56	struct eth1394_priv {
1da177e4 LT	57	struct hpsb_host host; / The card for this dev */
	58	u16 bc_maxpayload; /* Max broadcast payload */
	59	u8 bc_sspd; /* Max broadcast speed */
	60	u64 local_fifo; /* Local FIFO Address */
	61	spinlock_t lock; /* Private lock */
	62	int broadcast_channel; /* Async stream Broadcast Channel */
	63	enum eth1394_bc_states bc_state; /* broadcast channel state */
	64	struct hpsb_iso iso; / Async stream recv handle */
	65	int bc_dgl; /* Outgoing broadcast datagram label */
	66	struct list_head ip_node_list; /* List of IP capable nodes */
	67	struct unit_directory ud_list[ALL_NODES]; / Cached unit dir list */
7a97bc03 SR	68
	69	struct work_struct wake; /* Wake up after xmit failure */
	70	struct net_device wake_dev; / Stupid backlink for .wake */
	71	nodeid_t wake_node; /* Destination of failed xmit */
1da177e4 LT	72	};
	73
	74
	75	/* Define a fake hardware header format for the networking core. Note that
	76	* header size cannot exceed 16 bytes as that is the size of the header cache.
	77	* Also, we do not need the source address in the header so we omit it and
	78	* keep the header to under 16 bytes */
	79	#define ETH1394_ALEN (8)
	80	#define ETH1394_HLEN (10)
	81
	82	struct eth1394hdr {
	83	unsigned char h_dest[ETH1394_ALEN]; /* destination eth1394 addr */
faf26bcc	84	__be16 h_proto; /* packet type ID field */
1da177e4 LT	85	} __attribute__((packed));
1da177e4 LT	86
1da177e4 LT	87	static inline struct eth1394hdr eth1394_hdr(const struct sk_buff skb)
1da177e4 LT	88	{
98e399f8	89	return (struct eth1394hdr *)skb_mac_header(skb);
1da177e4	90	}
1da177e4 LT	91
	92	typedef enum {ETH1394_GASP, ETH1394_WRREQ} eth1394_tx_type;
	93
	94	/* IP1394 headers */
1da177e4 LT	95
	96	/* Unfragmented */
	97	#if defined __BIG_ENDIAN_BITFIELD
	98	struct eth1394_uf_hdr {
	99	u16 lf:2;
	100	u16 res:14;
faf26bcc	101	__be16 ether_type; /* Ethernet packet type */
1da177e4 LT	102	} __attribute__((packed));
	103	#elif defined __LITTLE_ENDIAN_BITFIELD
	104	struct eth1394_uf_hdr {
	105	u16 res:14;
	106	u16 lf:2;
faf26bcc	107	__be16 ether_type;
1da177e4 LT	108	} __attribute__((packed));
	109	#else
	110	#error Unknown bit field type
	111	#endif
	112
	113	/* First fragment */
	114	#if defined __BIG_ENDIAN_BITFIELD
	115	struct eth1394_ff_hdr {
	116	u16 lf:2;
	117	u16 res1:2;
	118	u16 dg_size:12; /* Datagram size */
faf26bcc	119	__be16 ether_type; /* Ethernet packet type */
1da177e4 LT	120	u16 dgl; /* Datagram label */
	121	u16 res2;
	122	} __attribute__((packed));
	123	#elif defined __LITTLE_ENDIAN_BITFIELD
	124	struct eth1394_ff_hdr {
	125	u16 dg_size:12;
	126	u16 res1:2;
	127	u16 lf:2;
faf26bcc	128	__be16 ether_type;
1da177e4 LT	129	u16 dgl;
	130	u16 res2;
	131	} __attribute__((packed));
	132	#else
	133	#error Unknown bit field type
	134	#endif
	135
	136	/* XXX: Subsequent fragments, including last */
	137	#if defined __BIG_ENDIAN_BITFIELD
	138	struct eth1394_sf_hdr {
	139	u16 lf:2;
	140	u16 res1:2;
	141	u16 dg_size:12; /* Datagram size */
	142	u16 res2:4;
	143	u16 fg_off:12; /* Fragment offset */
	144	u16 dgl; /* Datagram label */
	145	u16 res3;
	146	} __attribute__((packed));
	147	#elif defined __LITTLE_ENDIAN_BITFIELD
	148	struct eth1394_sf_hdr {
	149	u16 dg_size:12;
	150	u16 res1:2;
	151	u16 lf:2;
	152	u16 fg_off:12;
	153	u16 res2:4;
	154	u16 dgl;
	155	u16 res3;
	156	} __attribute__((packed));
	157	#else
	158	#error Unknown bit field type
	159	#endif
	160
	161	#if defined __BIG_ENDIAN_BITFIELD
	162	struct eth1394_common_hdr {
	163	u16 lf:2;
	164	u16 pad1:14;
	165	} __attribute__((packed));
	166	#elif defined __LITTLE_ENDIAN_BITFIELD
	167	struct eth1394_common_hdr {
	168	u16 pad1:14;
	169	u16 lf:2;
	170	} __attribute__((packed));
	171	#else
	172	#error Unknown bit field type
	173	#endif
	174
	175	struct eth1394_hdr_words {
	176	u16 word1;
	177	u16 word2;
	178	u16 word3;
	179	u16 word4;
	180	};
	181
	182	union eth1394_hdr {
	183	struct eth1394_common_hdr common;
	184	struct eth1394_uf_hdr uf;
	185	struct eth1394_ff_hdr ff;
	186	struct eth1394_sf_hdr sf;
	187	struct eth1394_hdr_words words;
	188	};
	189
	190	/* End of IP1394 headers */
	191
	192	/* Fragment types */
193	#define ETH1394_HDR_LF_UF 0 /* unfragmented */
194	#define ETH1394_HDR_LF_FF 1 /* first fragment */
195	#define ETH1394_HDR_LF_LF 2 /* last fragment */
196	#define ETH1394_HDR_LF_IF 3 /* interior fragment */
197
198	#define IP1394_HW_ADDR_LEN 16 /* As per RFC */
199
200	/* Our arp packet (ARPHRD_IEEE1394) */
201	struct eth1394_arp {
202	u16 hw_type; /* 0x0018 */
203	u16 proto_type; /* 0x0806 */
204	u8 hw_addr_len; /* 16 */
205	u8 ip_addr_len; /* 4 */
206	u16 opcode; /* ARP Opcode */
207	/* Above is exactly the same format as struct arphdr */
208
faf26bcc	209	__be64 s_uniq_id; /* Sender's 64bit EUI */
1da177e4 LT	210	u8 max_rec; /* Sender's max packet size */
1da177e4 LT	211	u8 sspd; /* Sender's max speed */
faf26bcc HH	212	__be16 fifo_hi; /* hi 16bits of sender's FIFO addr */
faf26bcc HH	213	__be32 fifo_lo; /* lo 32bits of sender's FIFO addr */
1da177e4 LT	214	u32 sip; /* Sender's IP Address */
	215	u32 tip; /* IP Address of requested hw addr */
	216	};
	217
	218	/* Network timeout */
	219	#define ETHER1394_TIMEOUT 100000
	220
	221	/* This is our task struct. It's used for the packet complete callback. */
	222	struct packet_task {
	223	struct sk_buff *skb;
	224	int outstanding_pkts;
	225	eth1394_tx_type tx_type;
	226	int max_payload;
	227	struct hpsb_packet *packet;
	228	struct eth1394_priv *priv;
	229	union eth1394_hdr hdr;
	230	u64 addr;
	231	u16 dest_node;
	232	};
	233
	234	#endif /* __ETH1394_H */