bsd/netat/ddp.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  *
  30  * ORIGINS: 82
  31  *
  32  * (C) COPYRIGHT Apple Computer, Inc. 1992-1996
  33  * All Rights Reserved
  34  *
  35  */
  36
  37 #ifndef _NETAT_DDP_H_
  38 #define _NETAT_DDP_H_
  39 #include <sys/appleapiopts.h>
  40
  41 #ifdef __APPLE_API_OBSOLETE
  42
  43 /* Header and data sizes */
  44
  45 #define  DDP_HDR_SIZE                 5  /* DDP (short) header size */
  46 #define  DDP_X_HDR_SIZE              13  /* DDP extended header size */
  47 #define  DDP_DATA_SIZE              586  /* Maximum DataGram data size */
  48 #define  DDP_DATAGRAM_SIZE          599  /* Maximum DataGram size */
  49
  50 /* DDP socket definitions */
  51
  52 #define  DDP_SOCKET_1st_RESERVED      1  /* First in reserved range */
  53 #define  DDP_SOCKET_1st_EXPERIMENTAL 64  /* First in experimental range */
  54 #define  DDP_SOCKET_1st_DYNAMIC     128  /* First in dynamic range */
  55 #define  DDP_SOCKET_LAST            253  /* Last socket in any range */
  56
  57 /* DDP type used to replace "0" on packets sent out, for compatibility
  58    with Open Transport */
  59 #define DEFAULT_OT_DDPTYPE 11
  60
  61 /* DDP well-known sockets */
  62
  63 #define RTMP_SOCKET     1       /* RTMP socket number   */
  64 #define NBP_SOCKET      2       /* NIS socket number */
  65 #define EP_SOCKET       4       /* EP socket number */
  66 #define ZIP_SOCKET      6       /* ZIP socket number */
  67
  68 /* DDP extended header packet format */
  69
  70 typedef struct {
  71         unsigned   unused:2,
  72                    hopcount:4,
  73                    length:10;           /* Datagram length */
  74         ua_short   checksum;            /* Checksum */
  75         at_net     dst_net;             /* Destination network number */
  76         at_net     src_net;             /* Source network number */
  77         at_node    dst_node;            /* Destination node ID */
  78         at_node    src_node;            /* Source node ID */
  79         at_socket  dst_socket;          /* Destination socket number */
  80         at_socket  src_socket;          /* Source socket number */
  81         u_char     type;                /* Protocol type */
  82         char       data[DDP_DATA_SIZE];
  83 } at_ddp_t;
  84
  85 #define DDPLEN_ASSIGN(ddp, len)         ddp->length = len
  86 #define DDPLEN_VALUE(ddp)               ddp->length
  87
  88 /* DDP module statistics and configuration */
  89
  90 typedef struct at_ddp_stats {
  91         /* General */
  92
  93         /* Receive stats */
  94         u_int   rcv_bytes;
  95         u_int   rcv_packets;
  96         u_int   rcv_bad_length;
  97         u_int   rcv_unreg_socket;
  98         u_int   rcv_bad_socket;
  99         u_int   rcv_bad_checksum;
 100         u_int   rcv_dropped_nobuf;
 101
 102         /* Transmit stats */
 103         u_int   xmit_bytes;
 104         u_int   xmit_packets;
 105         u_int   xmit_BRT_used;
 106         u_int   xmit_bad_length;
 107         u_int   xmit_bad_addr;
 108         u_int   xmit_dropped_nobuf;
 109 } at_ddp_stats_t;
 110
 111
 112 /* DDP streams module ioctls */
 113
 114 #define AT_MID_DDP      203
 115
 116 #define DDP_IOC_MYIOCTL(i)      ((i>>8) == AT_MID_DDP)
 117 #define DDP_IOC_GET_CFG         ((AT_MID_DDP<<8) | 1)
 118
 119 #ifdef NOT_USED
 120 #define DDP_IOC_BIND_SOCK       ((AT_MID_DDP<<8) | 2)
 121 #define DDP_IOC_GET_STATS       ((AT_MID_DDP<<8) | 3)
 122 #define DDP_IOC_LSTATUS_TABLE   ((AT_MID_DDP<<8) | 4)
 123 #define DDP_IOC_ULSTATUS_TABLE  ((AT_MID_DDP<<8) | 5)
 124 #define DDP_IOC_RSTATUS_TABLE   ((AT_MID_DDP<<8) | 6)
 125 #define DDP_IOC_SET_WROFF       ((AT_MID_DDP<<8) | 7 )
 126 #define DDP_IOC_SET_OPTS        ((AT_MID_DDP<<8) | 8 )
 127 #define DDP_IOC_GET_OPTS        ((AT_MID_DDP<<8) | 9 )
 128 #define DDP_IOC_GET_SOCK        ((AT_MID_DDP<<8) | 10)
 129 #define DDP_IOC_GET_PEER        ((AT_MID_DDP<<8) | 11)
 130 #define DDP_IOC_SET_PEER        ((AT_MID_DDP<<8) | 12)
 131 #define DDP_IOC_SET_PROTO       ((AT_MID_DDP<<8) | 13)
 132 #endif
 133
 134 #ifdef KERNEL_PRIVATE
 135
 136 #define DDP_MIN_NETWORK         0x0001
 137 #define DDP_MAX_NETWORK         0xfffe
 138 #define DDP_STARTUP_LOW         0xff00
 139 #define DDP_STARTUP_HIGH        DDP_MAX_NETWORK
 140
 141 typedef struct {
 142         void **inputQ;
 143         int  *pidM;
 144         char  **socketM;
 145         char  *dbgBits;
 146 } proto_reg_t;
 147
 148 /* *** note: this counts on the src address always being that of the
 149        home port
 150    *** */
 151 #define FROM_US(ddp)    ((NET_VALUE(ddp->src_net) ==\
 152         ifID_home->ifThisNode.s_net) && \
 153         ifID_home->ifThisNode.s_node == ddp->src_node)
 154
 155 #define RT_LOOKUP_OKAY(ifID, ddp) \
 156      ((ROUTING_MODE && ifID->ifRoutingState==PORT_ONLINE) || \
 157       (MULTIHOME_MODE && FROM_US(ddp)))
 158
 159 #ifdef NOT_YET
 160 /* from sys_glue.c */
 161 int ddp_adjmsg(gbuf_t *m, int len);
 162 gbuf_t *ddp_growmsg(gbuf_t  *mp, int len);
 163
 164 /* from ddp.c */
 165 int ddp_add_if(at_ifaddr_t *ifID);
 166 int ddp_rem_if(at_ifaddr_t *ifID);
 167 int ddp_bind_socket(ddp_socket_t *socketp);
 168 int ddp_close_socket(ddp_socket_t *socketp);
 169 int ddp_output(gbuf_t **mp, at_socket src_socket, int src_addr_included);
 170 void ddp_input(gbuf_t   *mp, at_ifaddr_t *ifID);
 171 int ddp_router_output(
 172      gbuf_t  *mp,
 173      at_ifaddr_t *ifID,
 174      int addr_type,
 175      at_net_al router_net,
 176      at_node router_node,
 177      etalk_addr_t *enet_addr);
 178
 179 /* from ddp_proto.c */
 180 int ddp_close(gref_t *gref);
 181 void ddp_putmsg(gref_t *gref, gbuf_t *mp);
 182 gbuf_t *ddp_compress_msg(gbuf_t *mp);
 183 void ddp_stop(gbuf_t *mioc, gref_t *gref);
 184
 185 /* in ddp_lap.c */
 186 void ddp_bit_reverse(unsigned char *);
 187
 188 #endif /* NOT_YET */
 189
 190 /* in ddp_lap.c */
 191 int ddp_shutdown(int);
 192
 193 #endif /* KERNEL_PRIVATE */
 194 #endif /* __APPLE_API_OBSOLETE */
 195 #endif /* _NETAT_DDP_H_ */