/* sim_ether.h: OS-dependent network information
  ------------------------------------------------------------------------------

   Copyright (c) 2002-2004, David T. Hittner

   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
   THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
   IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

   Except as contained in this notice, the name of the author shall not be
   used in advertising or otherwise to promote the sale, use or other dealings
   in this Software without prior written authorization from the author.

  ------------------------------------------------------------------------------

  Modification history:

  04-Feb-04  DTH  Added debugging information
  14-Jan-04  MP   Generalized BSD support issues
  05-Jan-04  DTH  Added eth_mac_scan
  26-Dec-03  DTH  Added ethernet show and queue functions from pdp11_xq
  23-Dec-03  DTH  Added status to packet
  01-Dec-03  DTH  Added reflections, tweaked decnet fix items
  25-Nov-03  DTH  Verified DECNET_FIX, reversed ifdef to mainstream code
  14-Nov-03  DTH  Added #ifdef DECNET_FIX for problematic duplicate detection code
  07-Jun-03  MP   Added WIN32 support for DECNET duplicate address detection.
  05-Jun-03  DTH  Added used to struct eth_packet
  01-Feb-03  MP   Changed some uint8 strings to char* to reflect usage 
  22-Oct-02  DTH  Added all_multicast and promiscuous support
  21-Oct-02  DTH  Corrected copyright again
  16-Oct-02  DTH  Fixed copyright
  08-Oct-02  DTH  Integrated with 2.10-0p4, added variable vector and copyrights
  03-Oct-02  DTH  Beta version of xq/sim_ether released for SIMH 2.09-11
  15-Aug-02  DTH  Started XQ simulation

  ------------------------------------------------------------------------------
*/

#ifndef _SIM_ETHER_H
#define _SIM_ETHER_H

#include "sim_defs.h"

/* make common BSD code a bit easier to read in this file */
/* OS/X seems to define and compile using one of these BSD types */
#if defined(__NetBSD__) || defined (__OpenBSD__) || defined (__FreeBSD__)
#define xBSD 1
#endif
#if !defined(__FreeBSD__) && !defined(_WIN32) && !defined(VMS)
#define USE_SETNONBLOCK 1
#endif

#if defined(__sun__) && defined(__i386__)
#define USE_READER_THREAD 1
#endif

/* make common winpcap code a bit easier to read in this file */
#if defined(_WIN32) || defined(VMS)
#define PCAP_READ_TIMEOUT -1
#else
#define PCAP_READ_TIMEOUT  1
#endif

/* set related values to have correct relationships */
#if defined (USE_READER_THREAD)
#if defined (USE_SETNONBLOCK)
#undef USE_SETNONBLOCK
#endif
#undef PCAP_READ_TIMEOUT
#define PCAP_READ_TIMEOUT 15
#if !defined (xBSD) && !defined(_WIN32) && !defined(VMS)
#define MUST_DO_SELECT
#endif
#endif

/*
  USE_BPF is defined to let this code leverage the libpcap/OS kernel provided 
  BPF packet filtering.  This generally will enhance performance.  It may not 
  be available in some environments and/or it may not work correctly, so 
  undefining this will still provide working code here.
*/
#define USE_BPF 1

#if defined (USE_READER_THREAD)
#include <pthread.h>
#endif

/* structure declarations */

#define ETH_PROMISC            1      /* promiscuous mode = true */
#define ETH_TIMEOUT           -1      /* read timeout in milliseconds (immediate) */
#define ETH_FILTER_MAX        20      /* maximum address filters */
#define ETH_DEV_NAME_MAX     256      /* maximum device name size */
#define ETH_DEV_DESC_MAX     256      /* maximum device description size */
#define ETH_MIN_PACKET        60      /* minimum ethernet packet size */
#define ETH_MAX_PACKET      1514      /* maximum ethernet packet size */
#define ETH_MAX_DEVICE        10      /* maximum ethernet devices */

#define DECNET_SELF_FRAME(dnet_mac, msg)    \
    ((memcmp(dnet_mac, msg  , 6) == 0) &&   \
     (memcmp(dnet_mac, msg+6, 6) == 0))

struct eth_packet {
  uint8   msg[1518];
  int     len;
  int     used;
  int     status;
};

struct eth_item {
  int                 type;           /* receive (0=setup, 1=loopback, 2=normal) */
  struct eth_packet   packet;
};

struct eth_queue {
  int                 max;
  int                 count;
  int                 head;
  int                 tail;
  int                 loss;
  int                 high;
  struct eth_item*    item;
};

struct eth_list {
  int     num;
  char    name[ETH_DEV_NAME_MAX];
  char    desc[ETH_DEV_DESC_MAX];
};

typedef int ETH_BOOL;
typedef unsigned char ETH_MAC[6];
typedef struct eth_packet  ETH_PACK;
typedef void (*ETH_PCALLBACK)(int status);
typedef struct eth_list ETH_LIST;
typedef struct eth_queue ETH_QUE;
typedef struct eth_item ETH_ITEM;

struct eth_device {
  char*         name;                           /* name of ethernet device */
  void*         handle;                         /* handle of implementation-specific device */
  ETH_PCALLBACK read_callback;                  /* read callback function */
  ETH_PCALLBACK write_callback;                 /* write callback function */
  ETH_PACK*     read_packet;                    /* read packet */
  ETH_PACK*     write_packet;                   /* write packet */
  ETH_MAC       filter_address[ETH_FILTER_MAX]; /* filtering addresses */
  int		addr_count;			/* count of filtering addresses */
  ETH_BOOL      promiscuous;                    /* promiscuous mode flag */
  ETH_BOOL      all_multicast;                  /* receive all multicast messages */
  int32         decnet_self_sent;               /* loopback packets sent but not seen */
  ETH_MAC       decnet_addr;                    /* decnet address of interface */
  DEVICE*       dptr;                           /* device ethernet is attached to */
  uint32        dbit;                           /* debugging bit */
  int           reflections;                    /* packet reflections on interface */
#if defined (USE_READER_THREAD)
  ETH_QUE       read_queue;
  pthread_mutex_t     lock;
  pthread_t     reader_thread;                  /* Reader Thread Id */
#endif
};

typedef struct eth_device  ETH_DEV;

/* prototype declarations*/

t_stat eth_open   (ETH_DEV* dev, char* name,      /* open ethernet interface */
                   DEVICE* dptr, uint32 dbit);
t_stat eth_close  (ETH_DEV* dev);                 /* close ethernet interface */
t_stat eth_write  (ETH_DEV* dev, ETH_PACK* packet,/* write sychronous packet; */
                   ETH_PCALLBACK routine);        /*  callback when done */
t_stat eth_read   (ETH_DEV* dev, ETH_PACK* packet,/* read single packet; */
                   ETH_PCALLBACK routine);        /*  callback when done*/
t_stat eth_filter (ETH_DEV* dev, int addr_count,  /* set filter on incoming packets */
                   ETH_MAC* addresses,
                   ETH_BOOL all_multicast,
                   ETH_BOOL promiscuous);
int eth_devices   (int max, ETH_LIST* dev);       /* get ethernet devices on host */

void eth_packet_trace (ETH_DEV* dev, const uint8 *msg, int len, char* txt); /* trace ethernet packet */
t_stat eth_show  (FILE* st, UNIT* uptr,           /* show ethernet devices */
                  int32 val, void* desc);

void eth_mac_fmt      (ETH_MAC* add, char* buffer);  /* format ethernet mac address */
t_stat eth_mac_scan (ETH_MAC* mac, char* strmac);  /* scan string for mac, put in mac */

t_stat ethq_init (ETH_QUE* que, int max);         /* initialize FIFO queue */
void ethq_clear  (ETH_QUE* que);                  /* clear FIFO queue */
void ethq_remove (ETH_QUE* que);                  /* remove item from FIFO queue */
void ethq_insert (ETH_QUE* que, int32 type,       /* insert item into FIFO queue */
                  ETH_PACK* packet, int32 status);


#endif  /* _SIM_ETHER_H */
