bsd/netat/ddp.h

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