First commit

Author: ronybeck

GPL

@@ -0,0 +1,18 @@
+Short:        V2.70, SANA-II network drivers for several adapters 
+Author:       Henryk Richter
+Uploader:     henryk.richter@gmx.net
+Type:         driver/net
+Architecture: m68k-amigaos
+Requires:     OS 2.04+
+
+This package contains network drivers for the following hardware:
+- ZII LAN IDE CP (matze, scrat and buggs @a1k.org)
+  OSS Zorro-II card with ENC624J600 ethernet controller, autoboot
+  IDE and Clockport
+- Vampire500/600 with ENC28J60 module connected to the SD-card slot
+- Vampire500V2+ with ENC28J60 module connected to the expansion port
+- VampireV4 with onboard Ethernet
+
+Full source code is included. Please refer to README.sdnet and
+README.enc for installation and operation instructions
+

README

@@ -0,0 +1,178 @@
+ENC624J6Net - A SANA-II driver for the Scratze card
+
+ENC624J6Net Copyright (C) 2018 Henryk Richter <henryk.richter@gmx.net>
+
+This driver is supposed to support ENC624J600 based ethernet on the 
+ZII LAN IDE CP card designed by Matze (a1k.org), Buggs (a1k.org) 
+and Scrat (a1k.org).
+
+Please see at the end of the file for information about licensing 
+conditions.
+
+
+Installation:
+-------------
+
+Installation of the driver is straightforward. 
+Just copy the enc624j6net.device to devs:networks and enable 
+the interface in your favorite  TCP/IP stack as usual. There is a version
+for MC68020 or later (enc624j6net.device) and another version for 
+68000 (enc624j6net.device_68000). Choose the right one.
+
+So far, successful tests have been done with the free AmiTCP/IP 3.0b2, 
+AmiTCP4.0-4.2, Genesis, MiamiDX and RoadShow. 
+
+The Zorro board itself should be visible in early startup with manufacturer 
+ID 2588 and card ID 123. 
+
+
+
+Configuration options
+---------------------
+
+No special configuration of the driver is necessary for normal operation. 
+The configuration options outlined below are documented for tuning purposes.
+
+The config to be placed in ENVARC:sana2/enc624j6net.config and consists
+of a single line with parameters (much like CLI parameters).
+
+PRIORITY=PRI/K/N,BPS/K/N,MTU/K/N,FULLDUPLEX/S,FLOWCONTROL/S,TIMER/K/N,MULTICAST/S
+
+ FULLDUPLEX     - change Ethernet module into full duplex mode, 
+                  caution: requires manual configuration of duplex mode
+                           on the switch, too.
+                  note: this switch should not be enabled in normal cases.
+                        The module features autoconfiguration that determines
+                        speed and duplex automatically.
+                  note(2): see miitool for changing speed/duplex
+                           settings at runtime.
+
+ PRIORITY       - server task priority (default 1)
+
+ BPS            - bit per seconds for statistics purposes
+
+ MTU            - maximum transmission unit (default 1500) 
+
+ MULTICAST      - (V2.3+) override fine-grained automatic multicast filtering
+                  and accept all multicast frames (default: off)
+
+ FLOWCONTROL    - enable automatic flow control that throttles incoming
+                  data when the hardware buffer gets full
+
+ example (useful for DSL via PPPoE with AmiTCP):
+  echo "MTU=1492 PRIORITY=6" >ENVARC:sana2/enc624j6net.config  
+
+
+Changelog:
+----------
+
+2.7   - fixed MuForce hit
+
+2.4   - added second semaphore, specifically for the write list
+      - recompiled using GCC 2.95 for slightly smaller binary
+      - avoid full ethernet chip reset on startup when the 
+        registers seem to be in a sane state (faster init, especially
+        with DHCP)
+      - additional checks for properly built hardware:
+        verify data bus bits before accepting card by
+        a simple short mem test
+
+2.3   - implemented fine grained multicast filter hashes
+
+2.2   - some more tuning to RX/TX scheduling
+      - added optional debug code to lowlevel routines
+      - removed some obsolete bus transfers
+      - uses DMACopyFromBuffer for IP-stacks supporting
+        this capability
+      - explicit 32 bit alignment for RX/TX to speed up
+        ZIII transfers
+      - added experimental support for MII interface to
+        poll and modify speed and duplex settings on the
+        fly
+      - miitool added (see README.miitool)
+
+2.00  - improved RX speed for buffer wraparound cases
+      - some more safety checks for boards with unresponsive
+        ENC chips (explicit card bus clear before verification of
+        chip presence)
+      - version bump
+
+1.99  - fixed soft reset for ZIII firmware
+      - re-enabled 32 Bit Buffer copies (unless Miami is active)
+      - default server task priority for AmiTCP=6 (otherwise 0)
+      - tuned RX/TX balancing to make RoadShow happy
+      - added Packet Filter hook processing (needs testing)
+
+1.98  - improved TX speed
+      - precaution: soft-reset cards in detection loop to make
+        sure that no bogus settings are left over after reset
+      - optional: disable length check in Sana-II Device Query
+
+1.97  - added New Style Device (NSD) commands
+      - implemented SANA-II Device Query Extension
+
+1.93  - recompiled using SAS/C, now 1kB smaller
+
+1.91  - first Beta of completely rewritten driver
+      - support for concurrent IP stacks
+      - faster handling of statistics
+      - multiple board support where applicable
+      - workaround for Shapeshifter network plugin bug
+      - GCC or VBCC as compiler (cross or native compilation)
+      - faster lowlevel read/write
+
+
+Compilation / Development Notes
+-------------------------------
+
+Either VBCC or GCC (tested with version 2.95 only) can be used for 
+cross-compiles. General options for compiler usage can be found in 
+Common.mk. Also, you might want to adapt the paths to your setup 
+(PREFX,SYSINC). In addition to the regular NDK, the sana2.h is expected 
+in the devices/ subdir of the includes. sana2.h may be found in the 
+AmiTCP or Roadshow SDK, respectively.
+
+Call
+
+ make -f Makefile.enc
+
+for building the device. 
+
+VBCC note: When calling the GNU Make port supplied with ADE/GG natively on AmigaOS3, 
+please make sure that "vc" is within the search path of "/bin/sh".
+
+Native compilation is also supported for GCC and VBCC. In addition, SAS/C
+smakefiles are provided for the hardware targets.
+
+Call 
+
+ smake -f smakefile.enc
+
+for native building with SAS/C.
+
+Conceptually, the driver was meant to support multiple hardware targets. Therefore,
+it features a SANA-II frontend (device.c,deviceheader.c,deviceinit.c), a main
+server running in a task (server.c) and several hardware backends. A new hardware
+backend requires customized implementation of hw.c and hwprivate.h, along with
+additional hardware-specfic code, if needed. The device unit structure reserves
+three LONGS and three pointers for exclusive use by the hardware instance. Additional
+data for the hardware can be auto-allocated at device initialization time, if necessary.
+See "struct HWData" in hwprivate.h of existing backends.
+
+
+License:
+--------
+
+    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 3 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, see <https://www.gnu.org/licenses/>.
+

README.enc

@@ -0,0 +1,101 @@
+MIITool
+-------
+
+This utility allows to observe and change the physical parameters 
+of Ethernet NICs on AmigaOS. The parameters include autonegotiation
+settings and forced speed/duplex combinations. While it is expected
+that autonegotiation "just works" with modern equipment, there still
+are people with some interest in retro-computing who might or might
+not experience link-related problems or are just curious about some
+inner workings of everyday hardware.
+
+A modern switch ("link partner") should advertise it`s capabilities
+properly such that the Ethernet hardware can select the optimal mode
+out of the supported set. If that is not the case, you can narrow down
+the list of advertised modes such that the link partners come to a
+working agreement. The last resort is to set a fixed speed/duplex
+combination. Please note that fixed parameters must be set at both
+ends of the link. Otherwise the link will work slowly or not at all.
+
+None of the settings this tool applies is permanent. Changed parameters
+are only valid until the next reset of the NIC. 
+
+This utility is able to detect an active Ethernet interface in case that
+the RoadShow TCP/IP stack is active. Otherwise, the device needs to be
+passed as commandline option explicitly.
+
+Examples for usage are given at the end of this text.
+
+
+Prerequisites:
+- AmigaOS 2.04 on 68k
+- active Ethernet SANA-II driver, i.e. after starting the IP-Stack
+
+
+Invocation:
+- MIITool is supposed to be run from CLI/Shell. 
+
+
+Arguments template:
+DEVICE/K,UNIT/K/N,V/S,FORCEMEDIA/K,ADVERTISE/K,RENEG/S,RESET/S,VV/S
+
+
+Detailed description of arguments:
+
+keyword    - description
+------------------------
+DEVICE/K   - device name corresponding to active ethernet interface
+DEV/K        example: DEVICE=enc624j6net.device
+
+UNIT/K/N   - unit number of device to be opened (default: 0)
+             example: UNIT=0
+
+FORCEMEDIA - speed/duplex combination to set unconditionally,
+             see below for a list of valid speed or duplex modes
+
+ADVERTISE  - speed/duplex combinations to announce by autonegotiation,
+             implicitly restart autonegotiation,
+             see below for a list of valid speed or duplex modes
+
+RENEG      - restart autonegotiation, please allow a couple of seconds
+RESTART      until the negotiation is finished
+
+RESET      - reset PHY to power-on state
+
+VERBOSE    - more detailed outputs
+V          
+
+VERYVERBOSE- even more detailed outputs
+VV
+
+
+Valid Speed/Duplex combinations (not case sensitive):
+
+10baseT-HD   - 10 Mbit/s half duplex
+10baseT-FD   - 10 Mbit/s full duplex
+100baseTx-HD - 100 Mbit/s half duplex over two wire pairs
+100baseTx-FD - 100 Mbit/s full duplex over two wire pairs (common)
+100baseT4    - 100 Mbit/s full duplex over 4 wire pairs (rare)
+10baseT      - 10 Mbit/s half or full duplex
+10bT         - 10 Mbit/s half or full duplex
+100baseTx    - 100 Mbit/s half or full duplex
+100bTx       - 100 Mbit/s half or full duplex
+
+
+Examples:
+
+current status (detailed, autodetect)
+ miitool v
+
+current status (detailed):
+ miitool DEV=enc624j6net.device v
+ 
+negotiate 10 Mbit/s only
+ miitool DEV=enc624j6net.device ADVERTISE=10bT
+
+negotiate 100baseTx and 10baseT half duplex only:
+ miitool DEV=enc624j6net.device ADVERTISE=100bTx,10baseT-HD
+
+force 100 Mbit/s full duplex
+ miitool DEV=enc624j6net.device FORCEMEDIA=100baseTx-FD
+