/* protosw.h */

#ifndef _SYS_PROTOSW_H
#define _SYS_PROTOSW_H

#include <sys/socketvar.h> /* for struct socket */
#include <net/route.h>

#define PRCO_SETOPT    0
#define PRCO_GETOPT    1

/* every protocol module init's one of these and passes it into
 * the add_protocol() function, defined below */
/* NB The pr_domain pointer will be filled in during the
 * add_protocol() call
 */
struct protosw {
	char *name;
	char *mod_path;
	uint16	pr_type;	/* SOCK_xxx */
	struct domain *pr_domain;
	uint16 pr_protocol;	/* protocol number */
	uint16 pr_flags;	/* flags, PR_xxx */
	int layer;			/* which layer are we? */
	
	/* the functions! */
	void (*pr_init)(void);
	void (*pr_input)(struct mbuf*, int);
	int  (*pr_output)(struct mbuf *, struct mbuf *, 
	                  struct route *,
	                  int, void *);
	
	int  (*pr_userreq)(struct socket *, int,
	                   struct mbuf *, 
	                   struct mbuf *, 
	                   struct mbuf *);
	int  (*pr_sysctl)(int *, uint, void *, size_t *, void *, size_t);
	void (*pr_ctlinput)(int, struct sockaddr *, void *);
	int  (*pr_ctloutput)(int, struct socket*, int, int, struct mbuf **);
	
	struct protosw *pr_next;	/* pointer to next proto structure */
	struct protosw *dom_next;	/* next protosw pointed by the domain */
};


/*
 * Values for pr_flags.
 * PR_ADDR requires PR_ATOMIC;
 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
 */
#define PR_ATOMIC       0x01            /* exchange atomic messages only */
#define PR_ADDR         0x02            /* addresses given with messages */
#define PR_CONNREQUIRED 0x04            /* connection required by protocol */
#define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
#define PR_RIGHTS       0x10            /* passes capabilities */
#define PR_ABRTACPTDIS  0x20            /* abort on accept(2) to disconnected
                                           socket */

#define PR_SLOWHZ        2              /* 2 timeouts per second... */
#define PR_FASTHZ        5              /* 5 timeouts per second */
/*
 * Defines for the userreq function req field are below.
 * 
 *      (*usrreq)(up, req, m, nam, opt);
 *
 * up is a (struct socket *)
 * req is one of these requests,
 * m is a optional mbuf chain containing a message,
 * nam is an optional mbuf chain containing an address,
 * opt is a pointer to a socketopt structure or nil.
 *
 * The protocol is responsible for disposal of the mbuf chain m,
 * the caller is responsible for any space held by nam and opt.
 * A non-zero return from usrreq gives an
 * UNIX error number which should be passed to higher level software.
 */
#define PRU_ATTACH              0       /* attach protocol to up */
#define PRU_DETACH              1       /* detach protocol from up */
#define PRU_BIND                2       /* bind socket to address */
#define PRU_LISTEN              3       /* listen for connection */
#define PRU_CONNECT             4       /* establish connection to peer */
#define PRU_ACCEPT              5       /* accept connection from peer */
#define PRU_DISCONNECT          6       /* disconnect from peer */
#define PRU_SHUTDOWN            7       /* won't send any more data */
#define PRU_RCVD                8       /* have taken data; more room now */
#define PRU_SEND                9       /* send this data */
#define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
#define PRU_CONTROL             11      /* control operations on protocol */
#define PRU_SENSE               12      /* return status into m */
#define PRU_RCVOOB              13      /* retrieve out of band data */
#define PRU_SENDOOB             14      /* send out of band data */
#define PRU_SOCKADDR            15      /* fetch socket's address */
#define PRU_PEERADDR            16      /* fetch peer's address */
#define PRU_CONNECT2            17      /* connect two sockets */
/* begin for protocols internal use */
#define PRU_FASTTIMO            18      /* 200ms timeout */
#define PRU_SLOWTIMO            19      /* 500ms timeout */
#define PRU_PROTORCV            20      /* receive from below */
#define PRU_PROTOSEND           21      /* send to below */
#define PRU_PEEREID             22      /* get local peer eid */

#define PRU_NREQ                22

/*
 * The arguments to the ctlinput routine are
 *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
 * where cmd is one of the commands below, sa is a pointer to a sockaddr,
 * and arg is an optional caddr_t argument used within a protocol family.
 */
#define PRC_IFDOWN              0       /* interface transition */
#define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
#define PRC_MTUINC              2       /* increase in mtu to host */
#define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
#define PRC_QUENCH              4       /* some one said to slow down */
#define PRC_MSGSIZE             5       /* message size forced drop */
#define PRC_HOSTDEAD            6       /* host appears to be down */
#define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
#define PRC_UNREACH_NET         8       /* no route to network */
#define PRC_UNREACH_HOST        9       /* no route to host */
#define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
#define PRC_UNREACH_PORT        11      /* bad port # */
/* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
#define PRC_UNREACH_SRCFAIL     13      /* source route failed */
#define PRC_REDIRECT_NET        14      /* net routing redirect */
#define PRC_REDIRECT_HOST       15      /* host routing redirect */
#define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
#define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
#define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
#define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
#define PRC_PARAMPROB           20      /* header incorrect */

#define PRC_NCMDS               21

#define PRC_IS_REDIRECT(cmd)    \
        ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)


/* Network stack defines... */
#ifdef _KERNEL_MODE
  struct protosw *protocols;

  enum {
	NET_LAYER1 = 1,
	NET_LAYER2,
	NET_LAYER3,
	NET_LAYER4
  };
  
  void add_protosw     (struct protosw *prt[], int);
  void add_protocol    (struct protosw *, int);
  void remove_protocol (struct protosw *);
#endif

struct protosw *pffindproto(int domain, int protocol, int type);
struct protosw *pffindtype(int domain, int type);

#endif /* _SYS_PROTOSW_H */