summaryrefslogtreecommitdiffstats
path: root/drivers/net/sonic.h
diff options
context:
space:
mode:
authorRalf Baechle <ralf@linux-mips.org>1995-11-14 08:00:00 +0000
committer <ralf@linux-mips.org>1995-11-14 08:00:00 +0000
commite7c2a72e2680827d6a733931273a93461c0d8d1b (patch)
treec9abeda78ef7504062bb2e816bcf3e3c9d680112 /drivers/net/sonic.h
parentec6044459060a8c9ce7f64405c465d141898548c (diff)
Import of Linux/MIPS 1.3.0
Diffstat (limited to 'drivers/net/sonic.h')
-rw-r--r--drivers/net/sonic.h359
1 files changed, 359 insertions, 0 deletions
diff --git a/drivers/net/sonic.h b/drivers/net/sonic.h
new file mode 100644
index 000000000..81487e2cd
--- /dev/null
+++ b/drivers/net/sonic.h
@@ -0,0 +1,359 @@
+/*
+ * Helpfile for sonic.c
+ *
+ * (C) Waldorf Electronics, Germany
+ * Written by Andreas Busse
+ *
+ * NOTE: most of the structure definitions here are endian dependent.
+ * If you want to use this driver on big endian machines, the data
+ * and pad structure members must be exchanged. Also, the structures
+ * need to be changed accordingly to the bus size.
+ *
+ */
+
+#ifndef SONIC_H
+#define SONIC_H
+
+#include <linux/etherdevice.h>
+#include <linux/skbuff.h>
+
+/*
+ * Macros to access SONIC registers
+ */
+
+#define sonic_read_register(reg) \
+ *((volatile unsigned int *)SONIC_BASE_ADDR+reg)
+
+#define sonic_write_register(reg,val) \
+ *((volatile unsigned int *)SONIC_BASE_ADDR+reg) = val
+
+/*
+ * Base address of the SONIC controller on JAZZ boards
+ */
+
+#define SONIC_BASE_ADDR 0xe0001000
+
+/*
+ * SONIC register offsets
+ */
+
+#define SONIC_CMD 0x00
+#define SONIC_DCR 0x01
+#define SONIC_RCR 0x02
+#define SONIC_TCR 0x03
+#define SONIC_IMR 0x04
+#define SONIC_ISR 0x05
+
+#define SONIC_UTDA 0x06
+#define SONIC_CTDA 0x07
+
+#define SONIC_URDA 0x0d
+#define SONIC_CRDA 0x0e
+#define SONIC_EOBC 0x13
+#define SONIC_URRA 0x14
+#define SONIC_RSA 0x15
+#define SONIC_REA 0x16
+#define SONIC_RRP 0x17
+#define SONIC_RWP 0x18
+#define SONIC_RSC 0x2b
+
+#define SONIC_CEP 0x21
+#define SONIC_CAP2 0x22
+#define SONIC_CAP1 0x23
+#define SONIC_CAP0 0x24
+#define SONIC_CE 0x25
+#define SONIC_CDP 0x26
+#define SONIC_CDC 0x27
+
+#define SONIC_WT0 0x29
+#define SONIC_WT1 0x2a
+
+#define SONIC_SR 0x28
+
+
+/* test-only registers */
+
+#define SONIC_TPS 0x08
+#define SONIC_TFC 0x09
+#define SONIC_TSA0 0x0a
+#define SONIC_TSA1 0x0b
+#define SONIC_TFS 0x0c
+
+#define SONIC_CRBA0 0x0f
+#define SONIC_CRBA1 0x10
+#define SONIC_RBWC0 0x11
+#define SONIC_RBWC1 0x12
+#define SONIC_TTDA 0x20
+#define SONIC_MDT 0x2f
+
+#define SONIC_TRBA0 0x19
+#define SONIC_TRBA1 0x1a
+#define SONIC_TBWC0 0x1b
+#define SONIC_TBWC1 0x1c
+#define SONIC_LLFA 0x1f
+
+#define SONIC_ADDR0 0x1d
+#define SONIC_ADDR1 0x1e
+
+/*
+ * Error counters
+ */
+#define SONIC_CRCT 0x2c
+#define SONIC_FAET 0x2d
+#define SONIC_MPT 0x2e
+
+
+/*
+ * SONIC command bits
+ */
+
+#define SONIC_CR_LCAM 0x0200
+#define SONIC_CR_RRRA 0x0100
+#define SONIC_CR_RST 0x0080
+#define SONIC_CR_ST 0x0020
+#define SONIC_CR_STP 0x0010
+#define SONIC_CR_RXEN 0x0008
+#define SONIC_CR_RXDIS 0x0004
+#define SONIC_CR_TXP 0x0002
+#define SONIC_CR_HTX 0x0001
+
+/*
+ * SONIC data configuration bits
+ */
+
+#define SONIC_DCR_EXBUS 0x8000
+#define SONIC_DCR_LBR 0x2000
+#define SONIC_DCR_PO1 0x1000
+#define SONIC_DCR_PO0 0x0800
+#define SONIC_DCR_SBUS 0x0400
+#define SONIC_DCR_USR1 0x0200
+#define SONIC_DCR_USR0 0x0100
+#define SONIC_DCR_WC1 0x0080
+#define SONIC_DCR_WC0 0x0040
+#define SONIC_DCR_DW 0x0020
+#define SONIC_DCR_BMS 0x0010
+#define SONIC_DCR_RFT1 0x0008
+#define SONIC_DCR_RFT0 0x0004
+#define SONIC_DCR_TFT1 0x0002
+#define SONIC_DCR_TFT0 0x0001
+
+/*
+ * Constants for the SONIC receive control register.
+ */
+
+#define SONIC_RCR_ERR 0x8000
+#define SONIC_RCR_RNT 0x4000
+#define SONIC_RCR_BRD 0x2000
+#define SONIC_RCR_PRO 0x1000
+#define SONIC_RCR_AMC 0x0800
+#define SONIC_RCR_LB1 0x0400
+#define SONIC_RCR_LB0 0x0200
+
+#define SONIC_RCR_MC 0x0100
+#define SONIC_RCR_BC 0x0080
+#define SONIC_RCR_LPKT 0x0040
+#define SONIC_RCR_CRS 0x0020
+#define SONIC_RCR_COL 0x0010
+#define SONIC_RCR_CRCR 0x0008
+#define SONIC_RCR_FAER 0x0004
+#define SONIC_RCR_LBK 0x0002
+#define SONIC_RCR_PRX 0x0001
+
+#define SONIC_RCR_LB_OFF 0
+#define SONIC_RCR_LB_MAC SONIC_RCR_LB0
+#define SONIC_RCR_LB_ENDEC SONIC_RCR_LB1
+#define SONIC_RCR_LB_TRANS (SONIC_RCR_LB0 | SONIC_RCR_LB1)
+
+/* default RCR setup */
+
+#define SONIC_RCR_DEFAULT (SONIC_RCR_ERR | SONIC_RCR_RNT)
+
+
+/*
+ * SONIC Transmit Control register bits
+ */
+
+#define SONIC_TCR_PINTR 0x8000
+#define SONIC_TCR_POWC 0x4000
+#define SONIC_TCR_CRCI 0x2000
+#define SONIC_TCR_EXDIS 0x1000
+#define SONIC_TCR_EXD 0x0400
+#define SONIC_TCR_DEF 0x0200
+#define SONIC_TCR_NCRS 0x0100
+#define SONIC_TCR_CRLS 0x0080
+#define SONIC_TCR_EXC 0x0040
+#define SONIC_TCR_PMB 0x0008
+#define SONIC_TCR_FU 0x0004
+#define SONIC_TCR_BCM 0x0002
+#define SONIC_TCR_PTX 0x0001
+
+#define SONIC_TCR_DEFAULT 0x0000
+
+/*
+ * Constants for the SONIC_INTERRUPT_MASK and
+ * SONIC_INTERRUPT_STATUS registers.
+ */
+
+#define SONIC_INT_BR 0x4000
+#define SONIC_INT_HBL 0x2000
+#define SONIC_INT_LCD 0x1000
+#define SONIC_INT_PINT 0x0800
+#define SONIC_INT_PKTRX 0x0400
+#define SONIC_INT_TXDN 0x0200
+#define SONIC_INT_TXER 0x0100
+#define SONIC_INT_TC 0x0080
+#define SONIC_INT_RDE 0x0040
+#define SONIC_INT_RBE 0x0020
+#define SONIC_INT_RBAE 0x0010
+#define SONIC_INT_CRC 0x0008
+#define SONIC_INT_FAE 0x0004
+#define SONIC_INT_MP 0x0002
+#define SONIC_INT_RFO 0x0001
+
+
+/*
+ * The interrupts we allow.
+ */
+
+#define SONIC_IMR_DEFAULT (SONIC_INT_BR | \
+ SONIC_INT_LCD | \
+ SONIC_INT_PINT | \
+ SONIC_INT_PKTRX | \
+ SONIC_INT_TXDN | \
+ SONIC_INT_TXER | \
+ SONIC_INT_RDE | \
+ SONIC_INT_RBE | \
+ SONIC_INT_RBAE | \
+ SONIC_INT_CRC | \
+ SONIC_INT_FAE | \
+ SONIC_INT_MP)
+
+
+#define SONIC_MAX_FRAGMENTS 4
+#define SONIC_MIN_FRAGMENT_SIZE 12
+
+#define SONIC_MIN_PACKET_SIZE 60
+
+#define SONIC_END_OF_LINKS 0x0001
+
+
+/*
+ * The number of receive descriptors and the
+ * buffer size we allocate by default
+ */
+#define SONIC_MAX_RDS 64
+#define SONIC_RXBUFSIZE (1024 * 16)
+
+
+/*
+ * structure definitions
+ */
+
+typedef struct SONIC_RECEIVE_RESOURCE {
+
+ unsigned int rx_bufadr_l; /* receive buffer ptr */
+ unsigned int rx_bufadr_h;
+
+ unsigned int rx_bufsize_l; /* no. of words in the receive buffer */
+ unsigned int rx_bufsize_h;
+
+} SONIC_RECEIVE_RESOURCE;
+
+/*
+ * Sonic receive descriptor. Receive descriptors are
+ * kept in a linked list of these structures.
+ */
+
+typedef struct SONIC_RECEIVE_DESCRIPTOR {
+
+ unsigned short rx_status; /* status after reception of a packet */
+ unsigned short pad0;
+ unsigned short rx_pktlen; /* length of the packet incl. CRC */
+ unsigned short pad1;
+
+ /*
+ * Pointers to the location in the receive buffer area (RBA)
+ * where the packet resides. A packet is always received into
+ * a contiguous piece of memory.
+ */
+
+ unsigned short rx_pktptr_l;
+ unsigned short pad2;
+ unsigned short rx_pktptr_h;
+ unsigned short pad3;
+
+ unsigned short rx_seqno; /* sequence no. */
+ unsigned short pad4;
+
+ unsigned short link; /* link to next RDD (end if EOL bit set) */
+ unsigned short pad5;
+
+ /*
+ * Owner of this descriptor, 0= driver, 1=sonic
+ */
+
+ unsigned short in_use;
+ unsigned short pad6;
+
+ caddr_t rda_next; /* pointer to next RD */
+
+} SONIC_RECEIVE_DESCRIPTOR;
+
+
+/*
+ * Describes a Transmit Descriptor
+ */
+typedef struct SONIC_TRANSMIT_DESCRIPTOR {
+
+ unsigned short tx_status; /* status after transmission of a packet */
+ unsigned short pad0;
+ unsigned short tx_config; /* transmit configuration for this packet */
+ unsigned short pad1;
+ unsigned short tx_pktsize; /* size of the packet to be transmitted */
+ unsigned short pad2;
+ unsigned short tx_frag_count; /* no. of fragments */
+ unsigned short pad3;
+
+ unsigned short tx_frag_ptr_l;
+ unsigned short pad4;
+ unsigned short tx_frag_ptr_h;
+ unsigned short pad5;
+ unsigned short tx_frag_size;
+ unsigned short pad6;
+
+ unsigned short link; /* ptr to next descriptor */
+ unsigned short pad7;
+
+} SONIC_TRANSMIT_DESCRIPTOR;
+
+
+/*
+ * Describes an entry in the CAM Descriptor Area.
+ */
+
+typedef struct SONIC_CAM_DESCRIPTOR
+{
+ unsigned short cam_entry_pointer;
+ unsigned short pad;
+ unsigned short cam_frag2;
+ unsigned short pad2;
+ unsigned short cam_frag1;
+ unsigned short pad1;
+ unsigned short cam_frag0;
+ unsigned short pad0;
+
+} SONIC_CAM_DESCRIPTOR;
+
+#define CAM_DESCRIPTORS 16
+
+
+typedef struct SONIC_CAM_DESCRIPTOR_AREA
+{
+ SONIC_CAM_DESCRIPTOR cam_descriptors[CAM_DESCRIPTORS];
+ unsigned short cam_enable;
+ unsigned short pad;
+
+} SONIC_CAM_DESCRIPTOR_AREA;
+
+
+#endif /* SONIC_H */