xref: /freebsd/share/man/man4/altera_atse.4 (revision 57718be8fa0bd5edc11ab9a72e68cc71982939a6)
1.\"-
2.\" Copyright (c) 2013-2014 SRI International
3.\" All rights reserved.
4.\"
5.\" This software was developed by SRI International and the University of
6.\" Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7.\" ("CTSRD"), as part of the DARPA CRASH research programme.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\" $FreeBSD$
31.\"
32.Dd May 21, 2014
33.Dt ALTERA_ATSE 4
34.Os
35.Sh NAME
36.Nm atse
37.Nd driver for the Altera Triple-Speed Ethernet MegaCore
38.Sh SYNOPSIS
39.Cd "device atse"
40.Cd "options ATSE_CFI_HACK"
41.Pp
42In
43.Pa /boot/device.hints :
44.Cd hint.atse.0.at="nexus0"
45.Cd hint.atse.0.maddr=0x7f007000
46.Cd hint.atse.0.msize=0x540
47.Cd hint.atse.0.rc_irq=1
48.Cd hint.atse.0.rx_maddr=0x7f007500
49.Cd hint.atse.0.rx_msize=0x8
50.Cd hint.atse.0.rxc_maddr=0x7f007520
51.Cd hint.atse.0.rxc_msize=0x20
52.Cd hint.atse.0.tx_irq=2
53.Cd hint.atse.0.tx_maddr=0x7f007400
54.Cd hint.atse.0.tx_msize=0x8
55.Cd hint.atse.0.txc_maddr=0x7f007420
56.Cd hint.atse.0.txc_msize=0x20
57.Cd hint.e1000phy.0.at="miibus0"
58.Cd hint.e1000phy.0.phyno=0
59.Sh DESCRIPTION
60The
61.Nm
62device driver provides support for the Altera Triple-Speed Ethernet
63MegaCore.
64.Sh HARDWARE
65The current version of the
66.Nm
67driver supports the Ethernet MegaCore as described in version 11.1 of
68Altera's documentation when the device is configured with internal FIFOs.
69.Sh MAC SELECTION
70The default MAC address for each
71.Nm
72interface is derived from a value stored in
73.Xr cfi 4
74flash.
75The value is managed by the
76.Xr atsectl 8
77utility.
78.Pp
79Only a single MAC address may be stored in flash.
80If the address begins with the Altera prefix 00:07:ed and ends in 00 then
81up to 16 addresses will be derived from it by adding the unit number of
82the interface to the stored address.
83For other prefixes, the address will be assigned to atse0 and random
84addresses will be used for other interfaces.
85If the stored address is invalid, for example all zero's, multicast, or the
86default address shipped on all DE4 boards (00:07:ed:ff:ed:15) then a random
87address is generated when the device is attached.
88.Sh SEE ALSO
89.Xr miibus 4 ,
90.Xr netintro 4 ,
91.Xr ifconfig 8
92.Rs
93.%T Triple-Speed Ethernet MegaCore Function User Guide
94.%D November 2011
95.%I Altera Corporation
96.Re
97.Sh HISTORY
98The
99.Nm
100device driver first appeared in
101.Fx 10.0 .
102.Sh AUTHORS
103The
104.Nm
105device driver and this manual page were
106developed by SRI International and the University of Cambridge Computer
107Laboratory under DARPA/AFRL contract
108.Pq FA8750-10-C-0237
109.Pq Do CTSRD Dc ,
110as part of the DARPA CRASH research programme.
111This device driver was written by
112.An Bjoern A. Zeeb .
113.Sh BUGS
114The
115.Nm
116driver only supports a single configuration of the MegaCore as installed
117on the Terasic Technologies Altera DE4 Development and Education Board.
118.Pp
119Only gigabit Ethernet speeds are currently supported.
120