rt_eth1394.h

/*
 * eth1394.h -- Driver for Ethernet emulation over FireWire, (adapted from Linux1394)
 *              working under RTnet.
 *
 * Copyright (C) 2005   Zhang Yuchen <yuchen623@gmail.com>
 *
 * 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 <ieee1394.h>
#include <rtskb.h>
#include <linux/netdevice.h>
#include <rtnet_port.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
#define ETHER1394_REGION_ADDR           0xfffff0200000ULL
#define ETHER1394_REGION_ADDR_END       (ETHER1394_REGION_ADDR + ETHER1394_REGION_ADDR_LEN)

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

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

#define ETHER1394_GASP_BUFFERS 16

#define ETH1394_BC_CHANNEL 31

#define ALL_NODES       0x003f //stolen from ieee1394_types.h
/* Node set == 64 */
#define NODE_SET                        (ALL_NODES + 1)

enum eth1394_bc_states { ETHER1394_BC_CLOSED, ETHER1394_BC_OPENED,
                         ETHER1394_BC_CHECK, ETHER1394_BC_ERROR,
                         ETHER1394_BC_RUNNING,
                         ETHER1394_BC_STOPPED  };

#define TX_RING_SIZE    32
#define RX_RING_SIZE    8 /* RX_RING_SIZE*2 rtskbs will be preallocated */

struct pdg_list {
        struct list_head list;          /* partial datagram list per node */
        unsigned int sz;                /* partial datagram list size per node  */
        rtdm_lock_t lock;               /* partial datagram lock                */
};

/* IP1394 headers */
#include <asm/byteorder.h>

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

/* 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      2       /* In RFC, the value is 16; here use the value for modified spec                */

/* Our arp packet (ARPHRD_IEEE1394) */
struct eth1394_arp {
        u16 hw_type;            /* 0x0018       */
        u16 proto_type;         /* 0x0080       */
        u8 hw_addr_len;         /* 2            */
        u8 ip_addr_len;         /* 4            */
        u16 opcode;             /* ARP Opcode: 1 for req, 2 for resp    */
        /* Above is exactly the same format as struct arphdr */

        unsigned char s_uniq_id[ETH_ALEN];      /* Sender's node id padded with zeros   */
        u8 max_rec;             /* Sender's max packet size             */
        u8 sspd;                /* Sender's max speed                   */
        u32 sip;                /* Sender's IP Address                  */
        u32 tip;                /* IP Address of requested hw addr      */
};


/* Network timeout */
#define ETHER1394_TIMEOUT       100000

/* First fragment */
#if defined __BIG_ENDIAN_BITFIELD
struct eth1394_ff_hdr {
        u16 lf:2;
        u16 res1:2;
        u16 dg_size:12;         /* Datagram size */
        u16 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;
        u16 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;
};

typedef enum {ETH1394_GASP, ETH1394_WRREQ} eth1394_tx_type;

/* This is our task struct. It's used for the packet complete callback.  */
struct packet_task {
        struct list_head lh;
        struct rtskb *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;
        unsigned int priority; //the priority mapped to priority on 1394 transaction
};

/* Private structure for our ethernet driver */
struct eth1394_priv {
        struct net_device_stats stats;  /* Device stats                  */
        struct hpsb_host *host;         /* The card for this dev         */
        u16 maxpayload[NODE_SET];       /* Max payload per node          */
        unsigned char sspd[NODE_SET];   /* Max speed per node            */
        rtdm_lock_t lock;               /* Private lock                  */
        int broadcast_channel;          /* Async stream Broadcast Channel */
        enum eth1394_bc_states bc_state; /* broadcast channel state      */
        struct hpsb_iso *iso;
        struct pdg_list pdg[ALL_NODES]; /* partial RX datagram lists     */
        int dgl[NODE_SET];              /* Outgoing datagram label per node */

        /* The addresses of a Tx/Rx-in-place packets/buffers. */
        struct rtskb *tx_skbuff[TX_RING_SIZE];
        struct rtskb *rx_skbuff[RX_RING_SIZE];
        struct packet_task ptask_list[20]; //the list of pre-allocated ptask structure
};



struct host_info {
        struct hpsb_host *host;
        struct rtnet_device *dev;
};


#endif /* __ETH1394_H */