RTEMS 7.0-rc1
Loading...
Searching...
No Matches
at91rm9200_emac.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-2-Clause */
2
11/*
12 * Copyright (C) 2003 Cogent Computer Systems
13 * Written by Mike Kelly <mike@cogcomp.com>
14 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
17 * are met:
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef __AT91RM9200_EMAC_H__
38#define __AT91RM9200_EMAC_H__
39
40#include <bits.h>
41
42/*Register offsets */
43#define EMAC_CTL 0x00 /* Network Control Register */
44#define EMAC_CFG 0x04 /* Network Configuration Register */
45#define EMAC_SR 0x08 /* Network Status Register */
46#define EMAC_TAR 0x0C /* Transmit Address Register */
47#define EMAC_TCR 0x10 /* Transmit Control Register */
48#define EMAC_TSR 0x14 /* Transmit Status Register */
49#define EMAC_RBQP 0x18 /* Receive Buffer Queue Pointer */
50#define EMAC_RSR 0x20 /* Receive Status Register */
51#define EMAC_ISR 0x24 /* Interrupt Enable Register */
52#define EMAC_IER 0x28 /* Interrupt Enable Register */
53#define EMAC_IDR 0x2C /* Interrupt Disable Register */
54#define EMAC_IMR 0x30 /* Interrupt Mask Register */
55#define EMAC_MAN 0x34 /* PHY Maintenance Register */
56#define EMAC_FRA 0x40 /* Frames Transmitted OK Register */
57#define EMAC_SCOL 0x44 /* Single Collision Frame Register */
58#define EMAC_MCOL 0x48 /* Multiple Collision Frame Register */
59#define EMAC_OK 0x4C /* Frames Received OK Register */
60#define EMAC_SEQE 0x50 /* Frame Check Sequence Error Register */
61#define EMAC_ALE 0x54 /* Alignment Error Register */
62#define EMAC_DTE 0x58 /* Deferred Transmission Frame Register */
63#define EMAC_LCOL 0x5C /* Late Collision Register */
64#define EMAC_ECOL 0x60 /* Excessive Collision Register */
65#define EMAC_CSE 0x64 /* Carrier Sense Error Register */
66#define EMAC_TUE 0x68 /* Transmit Underrun Error Register */
67#define EMAC_CDE 0x6C /* Code Error Register */
68#define EMAC_ELR 0x70 /* Excessive Length Error Register */
69#define EMAC_RJB 0x74 /* Receive Jabber Register */
70#define EMAC_USF 0x78 /* Undersize Frame Register */
71#define EMAC_SQEE 0x7C /* SQE Test Error Register */
72#define EMAC_DRFC 0x80 /* Discarded RX Frame Register */
73#define EMAC_HSH 0x90 /* Hash Address High[63:32] */
74#define EMAC_HSL 0x94 /* Hash Address Low[31:0] */
75#define EMAC_SA1L 0x98 /* Specific Addr 1 Low, First 4 bytes */
76#define EMAC_SA1H 0x9C /* Specific Addr 1 High, Last 2 bytes */
77#define EMAC_SA2L 0xA0 /* Specific Addr 2 Low, First 4 bytes */
78#define EMAC_SA2H 0xA4 /* Specific Addr 2 High, Last 2 bytes */
79#define EMAC_SA3L 0xA8 /* Specific Addr 3 Low, First 4 bytes */
80#define EMAC_SA3H 0xAC /* Specific Addr 3 High, Last 2 bytes */
81#define EMAC_SA4L 0xB0 /* Specific Addr 4 Low, First 4 bytes */
82#define EMAC_SA4H 0xB4 /* Specific Addr 4 High, Last 2 bytesr */
83
84/* Control Register, EMAC_CTL, Offset 0x0 */
85#define EMAC_CTL_LB BIT0 /* 1 = Set Loopback output signal */
86#define EMAC_CTL_LBL BIT1 /* 1 = Loopback local. */
87#define EMAC_CTL_RE BIT2 /* 1 = Receive enable. */
88#define EMAC_CTL_TE BIT3 /* 1 = Transmit enable. */
89#define EMAC_CTL_MPE BIT4 /* 1 = Management port enable. */
90#define EMAC_CTL_CSR BIT5 /* Write 1 to clear stats registers. */
91#define EMAC_CTL_ISR BIT6 /* Write to increment stats registers */
92#define EMAC_CTL_WES BIT7 /* 1 = Enable writing to stats regs */
93#define EMAC_CTL_BP BIT8 /* 1 = Force collision on all RX frames */
94
95/* Configuration Register, EMAC_CFG, Offset 0x4 */
96#define EMAC_CFG_SPD BIT0 /* 1 = 10/100 Speed (not functional?) */
97#define EMAC_CFG_FD BIT1 /* 1 = Full duplex. */
98#define EMAC_CFG_BR BIT2 /* write 0 */
99#define EMAC_CFG_CAF BIT4 /* 1 = accept all frames */
100#define EMAC_CFG_NBC BIT5 /* 1 = disable reception of bcast frms */
101#define EMAC_CFG_MTI BIT6 /* 1 = Multicast hash enable */
102#define EMAC_CFG_UNI BIT7 /* 1 = Unicast hash enable. */
103#define EMAC_CFG_BIG BIT8 /* 1 = enable reception 1522 byte frms */
104#define EMAC_CFG_EAE BIT9 /* write 0 */
105#define EMAC_CFG_CLK_8 (0 << 10) /* MII Clock = HCLK divided by 8 */
106#define EMAC_CFG_CLK_16 (1 << 10) /* MII Clock = HCLK divided by 16 */
107#define EMAC_CFG_CLK_32 (2 << 10) /* MII Clock = HCLK divided by 32 */
108#define EMAC_CFG_CLK_64 (3 << 10) /* MII Clock = HCLK divided by 64 */
109#define EMAC_CFG_CLK_MASK (3 << 10) /* MII Clock mask */
110#define EMAC_CFG_RTY BIT12 /* Retry Test Mode - Must be 0 */
111#define EMAC_CFG_RMII BIT13 /* Reduced MII Mode Enable */
112
113/* Status Register, EMAC_SR, Offset 0x8 */
114#define EMAC_LINK BIT0 /* Link pin */
115#define EMAC_MDIO BIT1 /* Real Time state of MDIO pin */
116#define EMAC_IDLE BIT2 /* 0 = PHY Logic is idle */
117
118/* Transmit Control Register, EMAC_TCR, Offset 0x10 */
119#define EMAC_TCR_LEN(_x_) ((_x_ & 0x7FF) << 0) /* Tx frame len minus CRC */
120#define EMAC_TCR_NCRC BIT15 /* Do'nt append CRC on Tx */
121
122/* Transmit Status Register, EMAC_TSR, Offset 0x14 */
123#define EMAC_TSR_OVR BIT0 /* 1 = Transmit buffer overrun */
124#define EMAC_TSR_COL BIT1 /* 1 = Collision occured */
125#define EMAC_TSR_RLE BIT2 /* 1 = Retry lmimt exceeded */
126#define EMAC_TSR_TXIDLE BIT3 /* 1 = Transmitter is idle */
127#define EMAC_TSR_BNQ BIT4 /* 1 = Transmit buffer not queued */
128#define EMAC_TSR_COMP BIT5 /* 1 = Transmit complete */
129#define EMAC_TSR_UND BIT6 /* 1 = Transmit underrun */
130
131/* Receive Status Register, EMAC_RSR, Offset 0x20 */
132#define EMAC_RSR_BNA BIT0 /* 1 = Buffer not available */
133#define EMAC_RSR_REC BIT1 /* 1 = Frame received */
134#define EMAC_RSR_OVR BIT2 /* 1 = Receive overrun */
135
136/*
137 * Interrupt Status Register, EMAC_ISR, Offsen 0x24
138 * Interrupt Enable Register, EMAC_IER, Offset 0x28
139 * Interrupt Disable Register, EMAC_IDR, Offset 0x2c
140 * Interrupt Mask Register, EMAC_IMR, Offset 0x30
141 */
142#define EMAC_INT_DONE BIT0 /* Phy management done */
143#define EMAC_INT_RCOM BIT1 /* Receive complete */
144#define EMAC_INT_RBNA BIT2 /* Receive buffer not available */
145#define EMAC_INT_TOVR BIT3 /* Transmit buffer overrun */
146#define EMAC_INT_TUND BIT4 /* Transmit buffer underrun */
147#define EMAC_INT_RTRY BIT5 /* Transmit Retry limt */
148#define EMAC_INT_TBRE BIT6 /* Transmit buffer register empty */
149#define EMAC_INT_TCOM BIT7 /* Transmit complete */
150#define EMAC_INT_TIDLE BIT8 /* Transmit idle */
151#define EMAC_INT_LINK BIT9 /* Link pin changed value */
152#define EMAC_INT_ROVR BIT10 /* Receive overrun */
153#define EMAC_INT_ABT BIT11 /* Abort on DMA transfer */
154
155/* PHY Maintenance Register, EMAC_MAN, Offset 0x34 */
156#define EMAC_MAN_DATA(_x_) ((_x_ & 0xFFFF) << 0)/* PHY data register */
157#define EMAC_MAN_CODE (0x2 << 16) /* IEEE Code */
158#define EMAC_MAN_REGA(_x_) ((_x_ & 0x1F) << 18) /* PHY register address */
159#define EMAC_MAN_PHYA(_x_) ((_x_ & 0x1F) << 23) /* PHY address */
160#define EMAC_MAN_WRITE (0x1 << 28) /* Transfer is a write */
161#define EMAC_MAN_READ (0x2 << 28) /* Transfer is a read */
162#define EMAC_MAN_HIGH BIT30 /* Must be set */
163#define EMAC_MAN_LOW BIT31
164
165/*
166 * Bit assignments for Receive Buffer Descriptor
167 * Address - Word 0
168 */
169#define RXBUF_ADD_BASE_MASK 0xfffffffc /* Base addr of the rx buf */
170#define RXBUF_ADD_WRAP BIT1 /* set indicates last buf */
171#define RXBUF_ADD_OWNED BIT0 /* 1 = SW owns the pointer */
172
173/* Status - Word 1 */
174#define RXBUF_STAT_BCAST BIT31 /* Global bcast addr detected */
175#define RXBUF_STAT_MULTI BIT30 /* Multicast hash match */
176#define RXBUF_STAT_UNI BIT29 /* Unicast hash match */
177#define RXBUF_STAT_EXT BIT28 /* External address (optional) */
178#define RXBUF_STAT_UNK BIT27 /* Unknown source address */
179#define RXBUF_STAT_LOC1 BIT26 /* Local address 1 match */
180#define RXBUF_STAT_LOC2 BIT25 /* Local address 2 match */
181#define RXBUF_STAT_LOC3 BIT24 /* Local address 3 match */
182#define RXBUF_STAT_LOC4 BIT23 /* Local address 4 match */
183#define RXBUF_STAT_LEN_MASK 0x7ff /* Len of frame including FCS */
184
185#endif /* __AT91RM9200_EMAC_H__ */
186
bits.h
Contains bit position definitions.
Generated by doxygen 1.9.6