src/AmigaOS/ether_amiga.cpp

/*
 *  ether_amiga.cpp - Ethernet device driver, AmigaOS specific stuff
 *
 *  Basilisk II (C) 1997-2001 Christian Bauer
 *
 *  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
 */

#include <exec/types.h>
#include <exec/memory.h>
#include <exec/errors.h>
#include <dos/dos.h>
#include <dos/dosextens.h>
#include <dos/dostags.h>
#include <devices/sana2.h>
#include <proto/exec.h>
#include <proto/dos.h>

#include "sysdeps.h"
#include "cpu_emulation.h"
#include "main.h"
#include "prefs.h"
#include "user_strings.h"
#include "macos_util.h"
#include "ether.h"
#include "ether_defs.h"

#define DEBUG 0
#include "debug.h"

#define MONITOR 0


// These messages are sent to the network process
const uint32 MSG_CLEANUP = 'clea';                      // Remove all protocols
const uint32 MSG_ADD_MULTI = 'addm';            // Add multicast address
const uint32 MSG_DEL_MULTI = 'delm';            // Add multicast address
const uint32 MSG_ATTACH_PH = 'atph';            // Attach protocol handler
const uint32 MSG_DETACH_PH = 'deph';            // Attach protocol handler
const uint32 MSG_WRITE = 'writ';                        // Write packet

struct NetMessage : public Message {
        NetMessage(uint32 what_, const struct MsgPort *reply_port)
        {
                what = what_;
                mn_ReplyPort = (struct MsgPort *)reply_port;
                mn_Length = sizeof(*this);
        }
        uint32 what;
        uint32 pointer;
        uint16 type;
        int16 result;
};


// List of attached protocols
static const int NUM_READ_REQUESTS = 32;        // Number of read requests that are sent to device in advance

struct NetProtocol : public Node {
        struct IOSana2Req read_io[NUM_READ_REQUESTS];
        uint8 read_buf[NUM_READ_REQUESTS][1518];        // 14 bytes header, 1500 bytes data, 4 bytes CRC
        uint16 type;
        uint32 handler;
};

static struct List prot_list;


// Global variables
static struct Process *net_proc = NULL;         // Network device handler process
static bool proc_error;                                         // Flag: process didn't initialize
static struct MsgPort *proc_port = NULL;        // Message port of process, for communication with main task
static struct MsgPort *reply_port = NULL;       // Reply port for communication with process
static struct MsgPort *read_port = NULL;        // Reply port for read IORequests (set up and owned by network process)

static bool write_done = false;                         // Flag: write request done

extern struct Task *MainTask;                           // Pointer to main task (from main_amiga.cpp)


// Prototypes
static void net_func(void);


/*
 *  Send message to network process
 */

static int16 send_to_proc(uint32 what, uint32 pointer = 0, uint16 type = 0)
{
        D(bug("sending %08lx to net_proc\n", what));
        NetMessage msg(what, reply_port);
        msg.pointer = pointer;
        msg.type = type;
        PutMsg(proc_port, &msg);
        WaitPort(reply_port);
        GetMsg(reply_port);
        D(bug(" sent\n"));
        return msg.result;
}


/*
 *  Initialization
 */

bool ether_init(void)
{
        // Do nothing if no Ethernet device specified
        if (PrefsFindString("ether") == NULL)
                return false;

        // Initialize protocol list
        NewList(&prot_list);

        // Create message port
        reply_port = CreateMsgPort();
        if (reply_port == NULL)
                goto open_error;
        D(bug("signal mask %08lx\n", 1 << reply_port->mp_SigBit));

        // Start process
        proc_error = false;
        SetSignal(0, SIGF_SINGLE);
        net_proc = CreateNewProcTags(
                NP_Entry, (ULONG)net_func,
                NP_Name, (ULONG)"Basilisk II Ethernet Task",
                NP_Priority, 1,
                TAG_END 
        );
        if (net_proc == NULL)
                goto open_error;

        // Wait for signal from process
        Wait(SIGF_SINGLE);

        // Initialization error? Then bail out
        if (proc_error)
                goto open_error;

        // Everything OK
        return true;

open_error:
        net_proc = NULL;
        if (reply_port) {
                DeleteMsgPort(reply_port);
                reply_port = NULL;
        }
        return false;
}


/*
 *  Deinitialization
 */

void ether_exit(void)
{
        // Stop process
        if (net_proc) {
                SetSignal(0, SIGF_SINGLE);
                Signal(&net_proc->pr_Task, SIGBREAKF_CTRL_C);
                Wait(SIGF_SINGLE);
        }

        // Delete reply port
        if (reply_port) {
                DeleteMsgPort(reply_port);
                reply_port = NULL;
        }
}


/*
 *  Reset
 */

void ether_reset(void)
{
        // Remove all protocols
        if (net_proc)
                send_to_proc(MSG_CLEANUP);
}


/*
 *  Add multicast address
 */

int16 ether_add_multicast(uint32 pb)
{
        return send_to_proc(MSG_ADD_MULTI, pb);
}


/*
 *  Delete multicast address
 */

int16 ether_del_multicast(uint32 pb)
{
        return send_to_proc(MSG_DEL_MULTI, pb);
}


/*
 *  Attach protocol handler
 */

int16 ether_attach_ph(uint16 type, uint32 handler)
{
        return send_to_proc(MSG_ATTACH_PH, handler, type);
}


/*
 *  Detach protocol handler
 */

int16 ether_detach_ph(uint16 type)
{
        return send_to_proc(MSG_DETACH_PH, type);
}


/*
 *  Transmit raw ethernet packet
 */

int16 ether_write(uint32 wds)
{
        send_to_proc(MSG_WRITE, wds);
        return 1;       // Command in progress
}


/*
 *  Remove protocol from protocol list
 */

static void remove_protocol(NetProtocol *p)
{
        // Remove from list
        Forbid();
        Remove(p);
        Permit();

        // Cancel read requests
        for (int i=0; i<NUM_READ_REQUESTS; i++) {
                AbortIO((struct IORequest *)(p->read_io + i));
                WaitIO((struct IORequest *)(p->read_io + i));
        }

        // Free protocol struct
        FreeMem(p, sizeof(NetProtocol));
}


/*
 *  Remove all protocols
 */

static void remove_all_protocols(void)
{
        NetProtocol *n = (NetProtocol *)prot_list.lh_Head, *next;
        while ((next = (NetProtocol *)n->ln_Succ) != NULL) {
                remove_protocol(n);
                n = next;
        }
}


/*
 *  Copy received network packet to Mac side
 */

static __saveds __regargs LONG copy_to_buff(uint8 *to /*a0*/, uint8 *from /*a1*/, uint32 packet_len /*d0*/)
{
        D(bug("CopyToBuff to %08lx, from %08lx, size %08lx\n", to, from, packet_len));

        // It would be more efficient (and take up less memory) if we
        // could invoke the packet handler from here. But we don't know
        // in what context we run, so calling Execute68k() would not be
        // a good idea, and even worse, we might run inside a hardware
        // interrupt, so we can't even trigger a Basilisk interrupt from
        // here and wait for its completion.
        CopyMem(from, to, packet_len);
#if MONITOR
        bug("Receiving Ethernet packet:\n");
        for (int i=0; i<packet_len; i++) {
                bug("%02lx ", from[i]);
        }
        bug("\n");
#endif
        return 1;
}


/*
 *  Copy data from Mac WDS to outgoing network packet
 */

static __saveds __regargs LONG copy_from_buff(uint8 *to /*a0*/, char *wds /*a1*/, uint32 packet_len /*d0*/)
{
        D(bug("CopyFromBuff to %08lx, wds %08lx, size %08lx\n", to, wds, packet_len));
#if MONITOR
        bug("Sending Ethernet packet:\n");
#endif
        for (;;) {
                int len = ReadMacInt16((uint32)wds);
                if (len == 0)
                        break;
#if MONITOR
                uint8 *adr = Mac2HostAddr(ReadMacInt32((uint32)wds + 2));
                for (int i=0; i<len; i++) {
                        bug("%02lx ", adr[i]);
                }
#endif
                CopyMem(Mac2HostAddr(ReadMacInt32((uint32)wds + 2)), to, len);
                to += len;
                wds += 6;
        }
#if MONITOR
        bug("\n");
#endif
        return 1;
}


/*
 *  Process for communication with the Ethernet device
 */

static __saveds void net_func(void)
{
        const char *str;
        BYTE od_error;
        struct MsgPort *write_port = NULL, *control_port = NULL;
        struct IOSana2Req *write_io = NULL, *control_io = NULL;
        bool opened = false;
        ULONG read_mask = 0, write_mask = 0, proc_port_mask = 0;
        struct Sana2DeviceQuery query_data = {sizeof(Sana2DeviceQuery)};
        ULONG buffer_tags[] = {
                S2_CopyToBuff, (uint32)copy_to_buff,
                S2_CopyFromBuff, (uint32)copy_from_buff,
                TAG_END
        };

        // Default: error occured
        proc_error = true;

        // Create message port for communication with main task
        proc_port = CreateMsgPort();
        if (proc_port == NULL)
                goto quit;
        proc_port_mask = 1 << proc_port->mp_SigBit;

        // Create message ports for device I/O
        read_port = CreateMsgPort();
        if (read_port == NULL)
                goto quit;
        read_mask = 1 << read_port->mp_SigBit;
        write_port = CreateMsgPort();
        if (write_port == NULL)
                goto quit;
        write_mask = 1 << write_port->mp_SigBit;
        control_port = CreateMsgPort();
        if (control_port == NULL)
                goto quit;

        // Create control IORequest
        control_io = (struct IOSana2Req *)CreateIORequest(control_port, sizeof(struct IOSana2Req));
        if (control_io == NULL)
                goto quit;
        control_io->ios2_Req.io_Message.mn_Node.ln_Type = 0;    // Avoid CheckIO() bug

        // Parse device name
        char dev_name[256];
        ULONG dev_unit;

        str = PrefsFindString("ether");
        if (str) {
                const char *FirstSlash = strchr(str, '/');
                const char *LastSlash = strrchr(str, '/');

                if (FirstSlash && FirstSlash && FirstSlash != LastSlash) {

                        // Device name contains path, i.e. "Networks/xyzzy.device"
                        const char *lp = str;
                        char *dp = dev_name;

                        while (lp != LastSlash)
                                *dp++ = *lp++;
                        *dp = '\0';

                        if (strlen(dev_name) < 1)
                                goto quit;

                        if (sscanf(LastSlash, "/%ld", &dev_unit) != 1)
                                goto quit;
                } else {
                        if (sscanf(str, "%[^/]/%ld", dev_name, &dev_unit) != 2)
                                goto quit;
                }
        } else
                goto quit;

        // Open device
        control_io->ios2_BufferManagement = buffer_tags;
        od_error = OpenDevice((UBYTE *)dev_name, dev_unit, (struct IORequest *)control_io, 0);
        if (od_error != 0 || control_io->ios2_Req.io_Device == 0) {
                printf("WARNING: OpenDevice(<%s>, unit=%d) returned error %d)\n", (UBYTE *)dev_name, dev_unit, od_error);
                goto quit;
        }
        opened = true;

        // Is it Ethernet?
        control_io->ios2_Req.io_Command = S2_DEVICEQUERY;
        control_io->ios2_StatData = (void *)&query_data;
        DoIO((struct IORequest *)control_io);
        if (control_io->ios2_Req.io_Error)
                goto quit;
        if (query_data.HardwareType != S2WireType_Ethernet) {
                WarningAlert(GetString(STR_NOT_ETHERNET_WARN));
                goto quit;
        }

        // Yes, create IORequest for writing
        write_io = (struct IOSana2Req *)CreateIORequest(write_port, sizeof(struct IOSana2Req));
        if (write_io == NULL)
                goto quit;
        memcpy(write_io, control_io, sizeof(struct IOSana2Req));
        write_io->ios2_Req.io_Message.mn_Node.ln_Type = 0;      // Avoid CheckIO() bug
        write_io->ios2_Req.io_Message.mn_ReplyPort = write_port;

        // Configure Ethernet
        control_io->ios2_Req.io_Command = S2_GETSTATIONADDRESS;
        DoIO((struct IORequest *)control_io);
        memcpy(ether_addr, control_io->ios2_DstAddr, 6);
        memcpy(control_io->ios2_SrcAddr, control_io->ios2_DstAddr, 6);
        control_io->ios2_Req.io_Command = S2_CONFIGINTERFACE;
        DoIO((struct IORequest *)control_io);
        D(bug("Ethernet address %08lx %08lx\n", *(uint32 *)ether_addr, *(uint16 *)(ether_addr + 4)));

        // Initialization went well, inform main task
        proc_error = false;
        Signal(MainTask, SIGF_SINGLE);

        // Main loop
        for (;;) {

                // Wait for I/O and messages (CTRL_C is used for quitting the task)
                ULONG sig = Wait(proc_port_mask | read_mask | write_mask | SIGBREAKF_CTRL_C);

                // Main task wants to quit us
                if (sig & SIGBREAKF_CTRL_C)
                        break;

                // Main task sent a command to us
                if (sig & proc_port_mask) {
                        struct NetMessage *msg;
                        while (msg = (NetMessage *)GetMsg(proc_port)) {
                                D(bug("net_proc received %08lx\n", msg->what));
                                switch (msg->what) {
                                        case MSG_CLEANUP:
                                                remove_all_protocols();
                                                break;

                                        case MSG_ADD_MULTI:
                                                control_io->ios2_Req.io_Command = S2_ADDMULTICASTADDRESS;
                                                Mac2Host_memcpy(control_io->ios2_SrcAddr, msg->pointer + eMultiAddr, 6);
                                                DoIO((struct IORequest *)control_io);
                                                if (control_io->ios2_Req.io_Error == S2ERR_NOT_SUPPORTED) {
                                                        WarningAlert(GetString(STR_NO_MULTICAST_WARN));
                                                        msg->result = noErr;
                                                } else if (control_io->ios2_Req.io_Error)
                                                        msg->result = eMultiErr;
                                                else
                                                        msg->result = noErr;
                                                break;

                                        case MSG_DEL_MULTI:
                                                control_io->ios2_Req.io_Command = S2_DELMULTICASTADDRESS;
                                                Mac2Host_memcpy(control_io->ios2_SrcAddr, msg->pointer + eMultiAddr, 6);
                                                DoIO((struct IORequest *)control_io);
                                                if (control_io->ios2_Req.io_Error)
                                                        msg->result = eMultiErr;
                                                else
                                                        msg->result = noErr;
                                                break;

                                        case MSG_ATTACH_PH: {
                                                uint16 type = msg->type;
                                                uint32 handler = msg->pointer;

                                                // Protocol of that type already installed?
                                                NetProtocol *p = (NetProtocol *)prot_list.lh_Head, *next;
                                                while ((next = (NetProtocol *)p->ln_Succ) != NULL) {
                                                        if (p->type == type) {
                                                                msg->result = lapProtErr;
                                                                goto reply;
                                                        }
                                                        p = next;
                                                }

                                                // Allocate NetProtocol, set type and handler
                                                p = (NetProtocol *)AllocMem(sizeof(NetProtocol), MEMF_PUBLIC);
                                                if (p == NULL) {
                                                        msg->result = lapProtErr;
                                                        goto reply;
                                                }
                                                p->type = type;
                                                p->handler = handler;

                                                // Set up and submit read requests
                                                for (int i=0; i<NUM_READ_REQUESTS; i++) {
                                                        memcpy(p->read_io + i, control_io, sizeof(struct IOSana2Req));
                                                        p->read_io[i].ios2_Req.io_Message.mn_Node.ln_Name = (char *)p;  // Hide pointer to NetProtocol in node name
                                                        p->read_io[i].ios2_Req.io_Message.mn_Node.ln_Type = 0;                  // Avoid CheckIO() bug
                                                        p->read_io[i].ios2_Req.io_Message.mn_ReplyPort = read_port;
                                                        p->read_io[i].ios2_Req.io_Command = CMD_READ;
                                                        p->read_io[i].ios2_PacketType = type;
                                                        p->read_io[i].ios2_Data = p->read_buf[i];
                                                        p->read_io[i].ios2_Req.io_Flags = SANA2IOF_RAW;
                                                        BeginIO((struct IORequest *)(p->read_io + i));
                                                }

                                                // Add protocol to list
                                                AddTail(&prot_list, p);

                                                // Everything OK
                                                msg->result = noErr;
                                                break;
                                        }

                                        case MSG_DETACH_PH: {
                                                uint16 type = msg->type;
                                                msg->result = lapProtErr;
                                                NetProtocol *p = (NetProtocol *)prot_list.lh_Head, *next;
                                                while ((next = (NetProtocol *)p->ln_Succ) != NULL) {
                                                        if (p->type == type) {
                                                                remove_protocol(p);
                                                                msg->result = noErr;
                                                                break;
                                                        }
                                                        p = next;
                                                }
                                                break;
                                        }

                                        case MSG_WRITE: {
                                                // Get pointer to Write Data Structure
                                                uint32 wds = msg->pointer;
                                                write_io->ios2_Data = (void *)wds;

                                                // Calculate total packet length
                                                long len = 0;
                                                uint32 tmp = wds;
                                                for (;;) {
                                                        int16 w = ReadMacInt16(tmp);
                                                        if (w == 0)
                                                                break;
                                                        len += w;
                                                        tmp += 6;
                                                }
                                                write_io->ios2_DataLength = len;

                                                // Get destination address
                                                uint32 hdr = ReadMacInt32(wds + 2);
                                                Mac2Host_memcpy(write_io->ios2_DstAddr, hdr, 6);

                                                // Get packet type
                                                uint32 type = ReadMacInt16(hdr + 12);
                                                if (type <= 1500)
                                                        type = 0;               // 802.3 packet
                                                write_io->ios2_PacketType = type;

                                                // Multicast/broadcard packet?
                                                if (write_io->ios2_DstAddr[0] & 1) {
                                                        if (*(uint32 *)(write_io->ios2_DstAddr) == 0xffffffff && *(uint16 *)(write_io->ios2_DstAddr + 4) == 0xffff)
                                                                write_io->ios2_Req.io_Command = S2_BROADCAST;
                                                        else
                                                                write_io->ios2_Req.io_Command = S2_MULTICAST;
                                                } else
                                                        write_io->ios2_Req.io_Command = CMD_WRITE;

                                                // Send packet
                                                write_done = false;
                                                write_io->ios2_Req.io_Flags = SANA2IOF_RAW;
                                                BeginIO((IORequest *)write_io);
                                                break;
                                        }
                                }
reply:                  D(bug(" net_proc replying\n"));
                                ReplyMsg(msg);
                        }
                }

                // Packet received
                if (sig & read_mask) {
                        D(bug(" packet received, triggering Ethernet interrupt\n"));
                        SetInterruptFlag(INTFLAG_ETHER);
                        TriggerInterrupt();
                }

                // Packet write completed
                if (sig & write_mask) {
                        GetMsg(write_port);
                        WriteMacInt32(ether_data + ed_Result, write_io->ios2_Req.io_Error ? excessCollsns : 0);
                        write_done = true;
                        D(bug(" packet write done, triggering Ethernet interrupt\n"));
                        SetInterruptFlag(INTFLAG_ETHER);
                        TriggerInterrupt();
                }
        }
quit:

        // Close everything
        remove_all_protocols();
        if (opened) {
                if (CheckIO((struct IORequest *)write_io) == 0) {
                        AbortIO((struct IORequest *)write_io);
                        WaitIO((struct IORequest *)write_io);
                }
                CloseDevice((struct IORequest *)control_io);
        }
        if (write_io)
                DeleteIORequest(write_io);
        if (control_io)
                DeleteIORequest(control_io);
        if (control_port)
                DeleteMsgPort(control_port);
        if (write_port)
                DeleteMsgPort(write_port);
        if (read_port)
                DeleteMsgPort(read_port);

        // Send signal to main task to confirm termination
        Forbid();
        Signal(MainTask, SIGF_SINGLE);
}


/*
 *  Ethernet interrupt - activate deferred tasks to call IODone or protocol handlers
 */

void EtherInterrupt(void)
{
        D(bug("EtherIRQ\n"));

        // Packet write done, enqueue DT to call IODone
        if (write_done) {
                EnqueueMac(ether_data + ed_DeferredTask, 0xd92);
                write_done = false;
        }

        // Call protocol handler for received packets
        IOSana2Req *io;
        while (io = (struct IOSana2Req *)GetMsg(read_port)) {

                // Get pointer to NetProtocol (hidden in node name)
                NetProtocol *p = (NetProtocol *)io->ios2_Req.io_Message.mn_Node.ln_Name;

                // No default handler
                if (p->handler == 0)
                        continue;

                // Copy header to RHA
                Host2Mac_memcpy(ether_data + ed_RHA, io->ios2_Data, 14);
                D(bug(" header %08lx%04lx %08lx%04lx %04lx\n", ReadMacInt32(ether_data + ed_RHA), ReadMacInt16(ether_data + ed_RHA + 4), ReadMacInt32(ether_data + ed_RHA + 6), ReadMacInt16(ether_data + ed_RHA + 10), ReadMacInt16(ether_data + ed_RHA + 12)));

                // Call protocol handler
                M68kRegisters r;
                r.d[0] = *(uint16 *)((uint32)io->ios2_Data + 12);       // Packet type
                r.d[1] = io->ios2_DataLength - 18;                                      // Remaining packet length (without header, for ReadPacket) (-18 because the CRC is also included)
                r.a[0] = (uint32)io->ios2_Data + 14;                            // Pointer to packet (host address, for ReadPacket)
                r.a[3] = ether_data + ed_RHA + 14;                                      // Pointer behind header in RHA
                r.a[4] = ether_data + ed_ReadPacket;                            // Pointer to ReadPacket/ReadRest routines
                D(bug(" calling protocol handler %08lx, type %08lx, length %08lx, data %08lx, rha %08lx, read_packet %08lx\n", p->handler, r.d[0], r.d[1], r.a[0], r.a[3], r.a[4]));
                Execute68k(p->handler, &r);

                // Resend IORequest
                io->ios2_Req.io_Flags = SANA2IOF_RAW;
                BeginIO((struct IORequest *)io);
        }
        D(bug(" EtherIRQ done\n"));
}
Revision:	1.10
Committed:	2001-07-15T02:34:23Z (22 years, 10 months ago) by cebix
Branch:	MAIN
Changes since 1.9:	+9 -16 lines
Log Message:	fixed indentation
#	Content
1	/*
2	* ether_amiga.cpp - Ethernet device driver, AmigaOS specific stuff
3	*
4	* Basilisk II (C) 1997-2001 Christian Bauer
5	*
6	* This program is free software; you can redistribute it and/or modify
7	* it under the terms of the GNU General Public License as published by
8	* the Free Software Foundation; either version 2 of the License, or
9	* (at your option) any later version.
10	*
11	* This program is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU General Public License for more details.
15	*
16	* You should have received a copy of the GNU General Public License
17	* along with this program; if not, write to the Free Software
18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19	*/
20
21	#include <exec/types.h>
22	#include <exec/memory.h>
23	#include <exec/errors.h>
24	#include <dos/dos.h>
25	#include <dos/dosextens.h>
26	#include <dos/dostags.h>
27	#include <devices/sana2.h>
28	#include <proto/exec.h>
29	#include <proto/dos.h>
30
31	#include "sysdeps.h"
32	#include "cpu_emulation.h"
33	#include "main.h"
34	#include "prefs.h"
35	#include "user_strings.h"
36	#include "macos_util.h"
37	#include "ether.h"
38	#include "ether_defs.h"
39
40	#define DEBUG 0
41	#include "debug.h"
42
43	#define MONITOR 0
44
45
46	// These messages are sent to the network process
47	const uint32 MSG_CLEANUP = 'clea'; // Remove all protocols
48	const uint32 MSG_ADD_MULTI = 'addm'; // Add multicast address
49	const uint32 MSG_DEL_MULTI = 'delm'; // Add multicast address
50	const uint32 MSG_ATTACH_PH = 'atph'; // Attach protocol handler
51	const uint32 MSG_DETACH_PH = 'deph'; // Attach protocol handler
52	const uint32 MSG_WRITE = 'writ'; // Write packet
53
54	struct NetMessage : public Message {
55	NetMessage(uint32 what_, const struct MsgPort *reply_port)
56	{
57	what = what_;
58	mn_ReplyPort = (struct MsgPort *)reply_port;
59	mn_Length = sizeof(*this);
60	}
61	uint32 what;
62	uint32 pointer;
63	uint16 type;
64	int16 result;
65	};
66
67
68	// List of attached protocols
69	static const int NUM_READ_REQUESTS = 32; // Number of read requests that are sent to device in advance
70
71	struct NetProtocol : public Node {
72	struct IOSana2Req read_io[NUM_READ_REQUESTS];
73	uint8 read_buf[NUM_READ_REQUESTS][1518]; // 14 bytes header, 1500 bytes data, 4 bytes CRC
74	uint16 type;
75	uint32 handler;
76	};
77
78	static struct List prot_list;
79
80
81	// Global variables
82	static struct Process *net_proc = NULL; // Network device handler process
83	static bool proc_error; // Flag: process didn't initialize
84	static struct MsgPort *proc_port = NULL; // Message port of process, for communication with main task
85	static struct MsgPort *reply_port = NULL; // Reply port for communication with process
86	static struct MsgPort *read_port = NULL; // Reply port for read IORequests (set up and owned by network process)
87
88	static bool write_done = false; // Flag: write request done
89
90	extern struct Task *MainTask; // Pointer to main task (from main_amiga.cpp)
91
92
93	// Prototypes
94	static void net_func(void);
95
96
97	/*
98	* Send message to network process
99	*/
100
101	static int16 send_to_proc(uint32 what, uint32 pointer = 0, uint16 type = 0)
102	{
103	D(bug("sending %08lx to net_proc\n", what));
104	NetMessage msg(what, reply_port);
105	msg.pointer = pointer;
106	msg.type = type;
107	PutMsg(proc_port, &msg);
108	WaitPort(reply_port);
109	GetMsg(reply_port);
110	D(bug(" sent\n"));
111	return msg.result;
112	}
113
114
115	/*
116	* Initialization
117	*/
118
119	bool ether_init(void)
120	{
121	// Do nothing if no Ethernet device specified
122	if (PrefsFindString("ether") == NULL)
123	return false;
124
125	// Initialize protocol list
126	NewList(&prot_list);
127
128	// Create message port
129	reply_port = CreateMsgPort();
130	if (reply_port == NULL)
131	goto open_error;
132	D(bug("signal mask %08lx\n", 1 << reply_port->mp_SigBit));
133
134	// Start process
135	proc_error = false;
136	SetSignal(0, SIGF_SINGLE);
137	net_proc = CreateNewProcTags(
138	NP_Entry, (ULONG)net_func,
139	NP_Name, (ULONG)"Basilisk II Ethernet Task",
140	NP_Priority, 1,
141	TAG_END
142	);
143	if (net_proc == NULL)
144	goto open_error;
145
146	// Wait for signal from process
147	Wait(SIGF_SINGLE);
148
149	// Initialization error? Then bail out
150	if (proc_error)
151	goto open_error;
152
153	// Everything OK
154	return true;
155
156	open_error:
157	net_proc = NULL;
158	if (reply_port) {
159	DeleteMsgPort(reply_port);
160	reply_port = NULL;
161	}
162	return false;
163	}
164
165
166	/*
167	* Deinitialization
168	*/
169
170	void ether_exit(void)
171	{
172	// Stop process
173	if (net_proc) {
174	SetSignal(0, SIGF_SINGLE);
175	Signal(&net_proc->pr_Task, SIGBREAKF_CTRL_C);
176	Wait(SIGF_SINGLE);
177	}
178
179	// Delete reply port
180	if (reply_port) {
181	DeleteMsgPort(reply_port);
182	reply_port = NULL;
183	}
184	}
185
186
187	/*
188	* Reset
189	*/
190
191	void ether_reset(void)
192	{
193	// Remove all protocols
194	if (net_proc)
195	send_to_proc(MSG_CLEANUP);
196	}
197
198
199	/*
200	* Add multicast address
201	*/
202
203	int16 ether_add_multicast(uint32 pb)
204	{
205	return send_to_proc(MSG_ADD_MULTI, pb);
206	}
207
208
209	/*
210	* Delete multicast address
211	*/
212
213	int16 ether_del_multicast(uint32 pb)
214	{
215	return send_to_proc(MSG_DEL_MULTI, pb);
216	}
217
218
219	/*
220	* Attach protocol handler
221	*/
222
223	int16 ether_attach_ph(uint16 type, uint32 handler)
224	{
225	return send_to_proc(MSG_ATTACH_PH, handler, type);
226	}
227
228
229	/*
230	* Detach protocol handler
231	*/
232
233	int16 ether_detach_ph(uint16 type)
234	{
235	return send_to_proc(MSG_DETACH_PH, type);
236	}
237
238
239	/*
240	* Transmit raw ethernet packet
241	*/
242
243	int16 ether_write(uint32 wds)
244	{
245	send_to_proc(MSG_WRITE, wds);
246	return 1; // Command in progress
247	}
248
249
250	/*
251	* Remove protocol from protocol list
252	*/
253
254	static void remove_protocol(NetProtocol *p)
255	{
256	// Remove from list
257	Forbid();
258	Remove(p);
259	Permit();
260
261	// Cancel read requests
262	for (int i=0; i<NUM_READ_REQUESTS; i++) {
263	AbortIO((struct IORequest *)(p->read_io + i));
264	WaitIO((struct IORequest *)(p->read_io + i));
265	}
266
267	// Free protocol struct
268	FreeMem(p, sizeof(NetProtocol));
269	}
270
271
272	/*
273	* Remove all protocols
274	*/
275
276	static void remove_all_protocols(void)
277	{
278	NetProtocol n = (NetProtocol )prot_list.lh_Head, *next;
279	while ((next = (NetProtocol *)n->ln_Succ) != NULL) {
280	remove_protocol(n);
281	n = next;
282	}
283	}
284
285
286	/*
287	* Copy received network packet to Mac side
288	*/
289
290	static __saveds __regargs LONG copy_to_buff(uint8 to /a0/, uint8 from /a1/, uint32 packet_len /d0/)
291	{
292	D(bug("CopyToBuff to %08lx, from %08lx, size %08lx\n", to, from, packet_len));
293
294	// It would be more efficient (and take up less memory) if we
295	// could invoke the packet handler from here. But we don't know
296	// in what context we run, so calling Execute68k() would not be
297	// a good idea, and even worse, we might run inside a hardware
298	// interrupt, so we can't even trigger a Basilisk interrupt from
299	// here and wait for its completion.
300	CopyMem(from, to, packet_len);
301	#if MONITOR
302	bug("Receiving Ethernet packet:\n");
303	for (int i=0; i<packet_len; i++) {
304	bug("%02lx ", from[i]);
305	}
306	bug("\n");
307	#endif
308	return 1;
309	}
310
311
312	/*
313	* Copy data from Mac WDS to outgoing network packet
314	*/
315
316	static __saveds __regargs LONG copy_from_buff(uint8 to /a0/, char wds /a1/, uint32 packet_len /d0/)
317	{
318	D(bug("CopyFromBuff to %08lx, wds %08lx, size %08lx\n", to, wds, packet_len));
319	#if MONITOR
320	bug("Sending Ethernet packet:\n");
321	#endif
322	for (;;) {
323	int len = ReadMacInt16((uint32)wds);
324	if (len == 0)
325	break;
326	#if MONITOR
327	uint8 *adr = Mac2HostAddr(ReadMacInt32((uint32)wds + 2));
328	for (int i=0; i<len; i++) {
329	bug("%02lx ", adr[i]);
330	}
331	#endif
332	CopyMem(Mac2HostAddr(ReadMacInt32((uint32)wds + 2)), to, len);
333	to += len;
334	wds += 6;
335	}
336	#if MONITOR
337	bug("\n");
338	#endif
339	return 1;
340	}
341
342
343	/*
344	* Process for communication with the Ethernet device
345	*/
346
347	static __saveds void net_func(void)
348	{
349	const char *str;
350	BYTE od_error;
351	struct MsgPort write_port = NULL, control_port = NULL;
352	struct IOSana2Req write_io = NULL, control_io = NULL;
353	bool opened = false;
354	ULONG read_mask = 0, write_mask = 0, proc_port_mask = 0;
355	struct Sana2DeviceQuery query_data = {sizeof(Sana2DeviceQuery)};
356	ULONG buffer_tags[] = {
357	S2_CopyToBuff, (uint32)copy_to_buff,
358	S2_CopyFromBuff, (uint32)copy_from_buff,
359	TAG_END
360	};
361
362	// Default: error occured
363	proc_error = true;
364
365	// Create message port for communication with main task
366	proc_port = CreateMsgPort();
367	if (proc_port == NULL)
368	goto quit;
369	proc_port_mask = 1 << proc_port->mp_SigBit;
370
371	// Create message ports for device I/O
372	read_port = CreateMsgPort();
373	if (read_port == NULL)
374	goto quit;
375	read_mask = 1 << read_port->mp_SigBit;
376	write_port = CreateMsgPort();
377	if (write_port == NULL)
378	goto quit;
379	write_mask = 1 << write_port->mp_SigBit;
380	control_port = CreateMsgPort();
381	if (control_port == NULL)
382	goto quit;
383
384	// Create control IORequest
385	control_io = (struct IOSana2Req *)CreateIORequest(control_port, sizeof(struct IOSana2Req));
386	if (control_io == NULL)
387	goto quit;
388	control_io->ios2_Req.io_Message.mn_Node.ln_Type = 0; // Avoid CheckIO() bug
389
390	// Parse device name
391	char dev_name[256];
392	ULONG dev_unit;
393
394	str = PrefsFindString("ether");
395	if (str) {
396	const char *FirstSlash = strchr(str, '/');
397	const char *LastSlash = strrchr(str, '/');
398
399	if (FirstSlash && FirstSlash && FirstSlash != LastSlash) {
400
401	// Device name contains path, i.e. "Networks/xyzzy.device"
402	const char *lp = str;
403	char *dp = dev_name;
404
405	while (lp != LastSlash)
406	dp++ = lp++;
407	*dp = '\0';
408
409	if (strlen(dev_name) < 1)
410	goto quit;
411
412	if (sscanf(LastSlash, "/%ld", &dev_unit) != 1)
413	goto quit;
414	} else {
415	if (sscanf(str, "%[^/]/%ld", dev_name, &dev_unit) != 2)
416	goto quit;
417	}
418	} else
419	goto quit;
420
421	// Open device
422	control_io->ios2_BufferManagement = buffer_tags;
423	od_error = OpenDevice((UBYTE )dev_name, dev_unit, (struct IORequest )control_io, 0);
424	if (od_error != 0 \|\| control_io->ios2_Req.io_Device == 0) {
425	printf("WARNING: OpenDevice(<%s>, unit=%d) returned error %d)\n", (UBYTE *)dev_name, dev_unit, od_error);
426	goto quit;
427	}
428	opened = true;
429
430	// Is it Ethernet?
431	control_io->ios2_Req.io_Command = S2_DEVICEQUERY;
432	control_io->ios2_StatData = (void *)&query_data;
433	DoIO((struct IORequest *)control_io);
434	if (control_io->ios2_Req.io_Error)
435	goto quit;
436	if (query_data.HardwareType != S2WireType_Ethernet) {
437	WarningAlert(GetString(STR_NOT_ETHERNET_WARN));
438	goto quit;
439	}
440
441	// Yes, create IORequest for writing
442	write_io = (struct IOSana2Req *)CreateIORequest(write_port, sizeof(struct IOSana2Req));
443	if (write_io == NULL)
444	goto quit;
445	memcpy(write_io, control_io, sizeof(struct IOSana2Req));
446	write_io->ios2_Req.io_Message.mn_Node.ln_Type = 0; // Avoid CheckIO() bug
447	write_io->ios2_Req.io_Message.mn_ReplyPort = write_port;
448
449	// Configure Ethernet
450	control_io->ios2_Req.io_Command = S2_GETSTATIONADDRESS;
451	DoIO((struct IORequest *)control_io);
452	memcpy(ether_addr, control_io->ios2_DstAddr, 6);
453	memcpy(control_io->ios2_SrcAddr, control_io->ios2_DstAddr, 6);
454	control_io->ios2_Req.io_Command = S2_CONFIGINTERFACE;
455	DoIO((struct IORequest *)control_io);
456	D(bug("Ethernet address %08lx %08lx\n", (uint32 )ether_addr, (uint16 )(ether_addr + 4)));
457
458	// Initialization went well, inform main task
459	proc_error = false;
460	Signal(MainTask, SIGF_SINGLE);
461
462	// Main loop
463	for (;;) {
464
465	// Wait for I/O and messages (CTRL_C is used for quitting the task)
466	ULONG sig = Wait(proc_port_mask \| read_mask \| write_mask \| SIGBREAKF_CTRL_C);
467
468	// Main task wants to quit us
469	if (sig & SIGBREAKF_CTRL_C)
470	break;
471
472	// Main task sent a command to us
473	if (sig & proc_port_mask) {
474	struct NetMessage *msg;
475	while (msg = (NetMessage *)GetMsg(proc_port)) {
476	D(bug("net_proc received %08lx\n", msg->what));
477	switch (msg->what) {
478	case MSG_CLEANUP:
479	remove_all_protocols();
480	break;
481
482	case MSG_ADD_MULTI:
483	control_io->ios2_Req.io_Command = S2_ADDMULTICASTADDRESS;
484	Mac2Host_memcpy(control_io->ios2_SrcAddr, msg->pointer + eMultiAddr, 6);
485	DoIO((struct IORequest *)control_io);
486	if (control_io->ios2_Req.io_Error == S2ERR_NOT_SUPPORTED) {
487	WarningAlert(GetString(STR_NO_MULTICAST_WARN));
488	msg->result = noErr;
489	} else if (control_io->ios2_Req.io_Error)
490	msg->result = eMultiErr;
491	else
492	msg->result = noErr;
493	break;
494
495	case MSG_DEL_MULTI:
496	control_io->ios2_Req.io_Command = S2_DELMULTICASTADDRESS;
497	Mac2Host_memcpy(control_io->ios2_SrcAddr, msg->pointer + eMultiAddr, 6);
498	DoIO((struct IORequest *)control_io);
499	if (control_io->ios2_Req.io_Error)
500	msg->result = eMultiErr;
501	else
502	msg->result = noErr;
503	break;
504
505	case MSG_ATTACH_PH: {
506	uint16 type = msg->type;
507	uint32 handler = msg->pointer;
508
509	// Protocol of that type already installed?
510	NetProtocol p = (NetProtocol )prot_list.lh_Head, *next;
511	while ((next = (NetProtocol *)p->ln_Succ) != NULL) {
512	if (p->type == type) {
513	msg->result = lapProtErr;
514	goto reply;
515	}
516	p = next;
517	}
518
519	// Allocate NetProtocol, set type and handler
520	p = (NetProtocol *)AllocMem(sizeof(NetProtocol), MEMF_PUBLIC);
521	if (p == NULL) {
522	msg->result = lapProtErr;
523	goto reply;
524	}
525	p->type = type;
526	p->handler = handler;
527
528	// Set up and submit read requests
529	for (int i=0; i<NUM_READ_REQUESTS; i++) {
530	memcpy(p->read_io + i, control_io, sizeof(struct IOSana2Req));
531	p->read_io[i].ios2_Req.io_Message.mn_Node.ln_Name = (char *)p; // Hide pointer to NetProtocol in node name
532	p->read_io[i].ios2_Req.io_Message.mn_Node.ln_Type = 0; // Avoid CheckIO() bug
533	p->read_io[i].ios2_Req.io_Message.mn_ReplyPort = read_port;
534	p->read_io[i].ios2_Req.io_Command = CMD_READ;
535	p->read_io[i].ios2_PacketType = type;
536	p->read_io[i].ios2_Data = p->read_buf[i];
537	p->read_io[i].ios2_Req.io_Flags = SANA2IOF_RAW;
538	BeginIO((struct IORequest *)(p->read_io + i));
539	}
540
541	// Add protocol to list
542	AddTail(&prot_list, p);
543
544	// Everything OK
545	msg->result = noErr;
546	break;
547	}
548
549	case MSG_DETACH_PH: {
550	uint16 type = msg->type;
551	msg->result = lapProtErr;
552	NetProtocol p = (NetProtocol )prot_list.lh_Head, *next;
553	while ((next = (NetProtocol *)p->ln_Succ) != NULL) {
554	if (p->type == type) {
555	remove_protocol(p);
556	msg->result = noErr;
557	break;
558	}
559	p = next;
560	}
561	break;
562	}
563
564	case MSG_WRITE: {
565	// Get pointer to Write Data Structure
566	uint32 wds = msg->pointer;
567	write_io->ios2_Data = (void *)wds;
568
569	// Calculate total packet length
570	long len = 0;
571	uint32 tmp = wds;
572	for (;;) {
573	int16 w = ReadMacInt16(tmp);
574	if (w == 0)
575	break;
576	len += w;
577	tmp += 6;
578	}
579	write_io->ios2_DataLength = len;
580
581	// Get destination address
582	uint32 hdr = ReadMacInt32(wds + 2);
583	Mac2Host_memcpy(write_io->ios2_DstAddr, hdr, 6);
584
585	// Get packet type
586	uint32 type = ReadMacInt16(hdr + 12);
587	if (type <= 1500)
588	type = 0; // 802.3 packet
589	write_io->ios2_PacketType = type;
590
591	// Multicast/broadcard packet?
592	if (write_io->ios2_DstAddr[0] & 1) {
593	if ((uint32 )(write_io->ios2_DstAddr) == 0xffffffff && (uint16 )(write_io->ios2_DstAddr + 4) == 0xffff)
594	write_io->ios2_Req.io_Command = S2_BROADCAST;
595	else
596	write_io->ios2_Req.io_Command = S2_MULTICAST;
597	} else
598	write_io->ios2_Req.io_Command = CMD_WRITE;
599
600	// Send packet
601	write_done = false;
602	write_io->ios2_Req.io_Flags = SANA2IOF_RAW;
603	BeginIO((IORequest *)write_io);
604	break;
605	}
606	}
607	reply: D(bug(" net_proc replying\n"));
608	ReplyMsg(msg);
609	}
610	}
611
612	// Packet received
613	if (sig & read_mask) {
614	D(bug(" packet received, triggering Ethernet interrupt\n"));
615	SetInterruptFlag(INTFLAG_ETHER);
616	TriggerInterrupt();
617	}
618
619	// Packet write completed
620	if (sig & write_mask) {
621	GetMsg(write_port);
622	WriteMacInt32(ether_data + ed_Result, write_io->ios2_Req.io_Error ? excessCollsns : 0);
623	write_done = true;
624	D(bug(" packet write done, triggering Ethernet interrupt\n"));
625	SetInterruptFlag(INTFLAG_ETHER);
626	TriggerInterrupt();
627	}
628	}
629	quit:
630
631	// Close everything
632	remove_all_protocols();
633	if (opened) {
634	if (CheckIO((struct IORequest *)write_io) == 0) {
635	AbortIO((struct IORequest *)write_io);
636	WaitIO((struct IORequest *)write_io);
637	}
638	CloseDevice((struct IORequest *)control_io);
639	}
640	if (write_io)
641	DeleteIORequest(write_io);
642	if (control_io)
643	DeleteIORequest(control_io);
644	if (control_port)
645	DeleteMsgPort(control_port);
646	if (write_port)
647	DeleteMsgPort(write_port);
648	if (read_port)
649	DeleteMsgPort(read_port);
650
651	// Send signal to main task to confirm termination
652	Forbid();
653	Signal(MainTask, SIGF_SINGLE);
654	}
655
656
657	/*
658	* Ethernet interrupt - activate deferred tasks to call IODone or protocol handlers
659	*/
660
661	void EtherInterrupt(void)
662	{
663	D(bug("EtherIRQ\n"));
664
665	// Packet write done, enqueue DT to call IODone
666	if (write_done) {
667	EnqueueMac(ether_data + ed_DeferredTask, 0xd92);
668	write_done = false;
669	}
670
671	// Call protocol handler for received packets
672	IOSana2Req *io;
673	while (io = (struct IOSana2Req *)GetMsg(read_port)) {
674
675	// Get pointer to NetProtocol (hidden in node name)
676	NetProtocol p = (NetProtocol )io->ios2_Req.io_Message.mn_Node.ln_Name;
677
678	// No default handler
679	if (p->handler == 0)
680	continue;
681
682	// Copy header to RHA
683	Host2Mac_memcpy(ether_data + ed_RHA, io->ios2_Data, 14);
684	D(bug(" header %08lx%04lx %08lx%04lx %04lx\n", ReadMacInt32(ether_data + ed_RHA), ReadMacInt16(ether_data + ed_RHA + 4), ReadMacInt32(ether_data + ed_RHA + 6), ReadMacInt16(ether_data + ed_RHA + 10), ReadMacInt16(ether_data + ed_RHA + 12)));
685
686	// Call protocol handler
687	M68kRegisters r;
688	r.d[0] = (uint16 )((uint32)io->ios2_Data + 12); // Packet type
689	r.d[1] = io->ios2_DataLength - 18; // Remaining packet length (without header, for ReadPacket) (-18 because the CRC is also included)
690	r.a[0] = (uint32)io->ios2_Data + 14; // Pointer to packet (host address, for ReadPacket)
691	r.a[3] = ether_data + ed_RHA + 14; // Pointer behind header in RHA
692	r.a[4] = ether_data + ed_ReadPacket; // Pointer to ReadPacket/ReadRest routines
693	D(bug(" calling protocol handler %08lx, type %08lx, length %08lx, data %08lx, rha %08lx, read_packet %08lx\n", p->handler, r.d[0], r.d[1], r.a[0], r.a[3], r.a[4]));
694	Execute68k(p->handler, &r);
695
696	// Resend IORequest
697	io->ios2_Req.io_Flags = SANA2IOF_RAW;
698	BeginIO((struct IORequest *)io);
699	}
700	D(bug(" EtherIRQ done\n"));
701	}