sys/netproto/atm/atm_ioctl.h

   1 /*
   2  *
   3  * ===================================
   4  * HARP  |  Host ATM Research Platform
   5  * ===================================
   6  *
   7  *
   8  * This Host ATM Research Platform ("HARP") file (the "Software") is
   9  * made available by Network Computing Services, Inc. ("NetworkCS")
  10  * "AS IS".  NetworkCS does not provide maintenance, improvements or
  11  * support of any kind.
  12  *
  13  * NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
  14  * INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
  15  * AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
  16  * SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
  17  * In no event shall NetworkCS be responsible for any damages, including
  18  * but not limited to consequential damages, arising from or relating to
  19  * any use of the Software or related support.
  20  *
  21  * Copyright 1994-1998 Network Computing Services, Inc.
  22  *
  23  * Copies of this Software may be made, however, the above copyright
  24  * notice must be reproduced on all copies.
  25  *
  26  *      @(#) $FreeBSD: src/sys/netatm/atm_ioctl.h,v 1.3 1999/08/28 00:48:36 peter Exp $
  27  *      @(#) $DragonFly: src/sys/netproto/atm/atm_ioctl.h,v 1.3 2005/02/01 00:51:50 joerg Exp $
  28  *
  29  */
  30
  31 /*
  32  * Core ATM Services
  33  * -----------------
  34  *
  35  * PF_ATM socket ioctl definitions
  36  *
  37  */
  38
  39 #ifndef _NETATM_ATM_IOCTL_H
  40 #define _NETATM_ATM_IOCTL_H
  41
  42 #include <sys/ioccom.h>
  43
  44 /*
  45  * Structure for PF_ATM configure (AIOCCFG) socket ioctls
  46  */
  47 struct atmcfgreq {
  48         int             acr_opcode;             /* Sub-operation */
  49         union {
  50                 struct {
  51                         /* Configure - attach */
  52                         char    acru_att_intf[IFNAMSIZ];/* Interface name */
  53                         u_char  acru_att_proto; /* Signalling protocol */
  54                 } acru_att;
  55                 struct {
  56                         /* Configure - detach */
  57                         char    acru_det_intf[IFNAMSIZ];/* Interface name */
  58                 } acru_det;
  59         } acr_u;
  60 };
  61 #define acr_att_intf    acr_u.acru_att.acru_att_intf
  62 #define acr_att_proto   acr_u.acru_att.acru_att_proto
  63 #define acr_det_intf    acr_u.acru_det.acru_det_intf
  64
  65
  66 /*
  67  * Structure for PF_ATM set (AIOCSET) socket ioctls
  68  */
  69 struct atmsetreq {
  70         int             asr_opcode;             /* Sub-operation */
  71         union {
  72                 /* ARP server */
  73                 struct {
  74                         char    asru_arp_intf[IFNAMSIZ];/* Interface name */
  75                         Atm_addr        asru_arp_addr;  /* ARP srvr address */
  76                         Atm_addr        asru_arp_subaddr;/* ARP srvr subaddr */
  77                         caddr_t         asru_arp_pbuf;  /* Prefix buffer addr */
  78                         int             asru_arp_plen;  /* Prefix buffer len */
  79                 } asru_asrvr;
  80                 /* MAC address */
  81                 struct {
  82                         char    asru_mac_intf[IFNAMSIZ];/* Interface name */
  83                         struct mac_addr asru_mac_addr;  /* MAC address */
  84                 } asru_mac;
  85                 /* Network interface */
  86                 struct {
  87                         char    asru_nif_intf[IFNAMSIZ];/* Interface name */
  88                         char    asru_nif_pref[IFNAMSIZ];/* I/f prefix name */
  89                         int     asru_nif_cnt;           /* Number of i/fs */
  90                 } asru_nif;
  91                 /* NSAP prefix */
  92                 struct {
  93                         char    asru_prf_intf[IFNAMSIZ];/* Interface name */
  94                         u_char  asru_prf_pref[13];      /* NSAP prefix */
  95                 } asru_prf;
  96         } asr_u;
  97 };
  98 #define asr_arp_intf    asr_u.asru_asrvr.asru_arp_intf
  99 #define asr_arp_addr    asr_u.asru_asrvr.asru_arp_addr
 100 #define asr_arp_pbuf    asr_u.asru_asrvr.asru_arp_pbuf
 101 #define asr_arp_plen    asr_u.asru_asrvr.asru_arp_plen
 102 #define asr_arp_subaddr asr_u.asru_asrvr.asru_arp_subaddr
 103 #define asr_mac_intf    asr_u.asru_mac.asru_mac_intf
 104 #define asr_mac_addr    asr_u.asru_mac.asru_mac_addr
 105 #define asr_nif_intf    asr_u.asru_nif.asru_nif_intf
 106 #define asr_nif_pref    asr_u.asru_nif.asru_nif_pref
 107 #define asr_nif_cnt     asr_u.asru_nif.asru_nif_cnt
 108 #define asr_prf_intf    asr_u.asru_prf.asru_prf_intf
 109 #define asr_prf_pref    asr_u.asru_prf.asru_prf_pref
 110
 111
 112 /*
 113  * Structure for PF_ATM add (AIOCADD) socket ioctls
 114  */
 115 struct atmaddreq {
 116         int             aar_opcode;             /* Sub-operation */
 117         union {
 118                 /* Add PVC */
 119                 struct {
 120                         char    aaru_pvc_intf[IFNAMSIZ];/* Interface name */
 121                         u_short aaru_pvc_vpi;           /* VPI value */
 122                         u_short aaru_pvc_vci;           /* VCI value */
 123                         struct sockaddr aaru_pvc_dst;   /* Destination addr */
 124                         Sap_t   aaru_pvc_sap;           /* Endpoint SAP */
 125                         Aal_t   aaru_pvc_aal;           /* AAL */
 126                         Encaps_t aaru_pvc_encaps;       /* Encapsulation */
 127                         u_char  aaru_pvc_flags;         /* Flags (see below) */
 128                 } aaru_add_pvc;
 129
 130                 /* Add ARP table entry */
 131                 struct {
 132                         char    aaru_arp_intf[IFNAMSIZ];/* Interface name */
 133                         struct sockaddr aaru_arp_dst;   /* IP addr */
 134                         Atm_addr        aaru_arp_addr;  /* ATM addr */
 135                         u_char  aaru_arp_origin;        /* Entry origin */
 136                 } aaru_add_arp;
 137         } aar_u;
 138 };
 139 #define aar_pvc_intf    aar_u.aaru_add_pvc.aaru_pvc_intf
 140 #define aar_pvc_vpi     aar_u.aaru_add_pvc.aaru_pvc_vpi
 141 #define aar_pvc_vci     aar_u.aaru_add_pvc.aaru_pvc_vci
 142 #define aar_pvc_dst     aar_u.aaru_add_pvc.aaru_pvc_dst
 143 #define aar_pvc_sap     aar_u.aaru_add_pvc.aaru_pvc_sap
 144 #define aar_pvc_aal     aar_u.aaru_add_pvc.aaru_pvc_aal
 145 #define aar_pvc_encaps  aar_u.aaru_add_pvc.aaru_pvc_encaps
 146 #define aar_pvc_flags   aar_u.aaru_add_pvc.aaru_pvc_flags
 147 #define aar_arp_intf    aar_u.aaru_add_arp.aaru_arp_intf
 148 #define aar_arp_dst     aar_u.aaru_add_arp.aaru_arp_dst
 149 #define aar_arp_addr    aar_u.aaru_add_arp.aaru_arp_addr
 150 #define aar_arp_origin  aar_u.aaru_add_arp.aaru_arp_origin
 151
 152 /* PVC flags */
 153 #define PVC_DYN         0x01                    /* Dest addr is dynamic */
 154
 155
 156 /*
 157  * Structure for PF_ATM delete (AIOCDEL) socket ioctls
 158  */
 159 struct atmdelreq {
 160         int             adr_opcode;             /* Sub-operation */
 161         union {
 162                 /* Delete PVC */
 163                 struct {
 164                         char    adru_pvc_intf[IFNAMSIZ];/* Interface name */
 165                         u_short adru_pvc_vpi;           /* VPI value */
 166                         u_short adru_pvc_vci;           /* VCI value */
 167                 } adru_del_pvc;
 168
 169                 /* Delete SVC */
 170                 struct {
 171                         char    adru_svc_intf[IFNAMSIZ];/* Interface name */
 172                         u_short adru_svc_vpi;           /* VPI value */
 173                         u_short adru_svc_vci;           /* VCI value */
 174                 } adru_del_svc;
 175
 176                 /* Delete ARP table entry */
 177                 struct {
 178                         char    adru_arp_intf[IFNAMSIZ];/* Interface name */
 179                         struct sockaddr adru_arp_dst;   /* IP addr */
 180                 } adru_del_arp;
 181         } adr_u;
 182 };
 183 #define adr_pvc_intf    adr_u.adru_del_pvc.adru_pvc_intf
 184 #define adr_pvc_vpi     adr_u.adru_del_pvc.adru_pvc_vpi
 185 #define adr_pvc_vci     adr_u.adru_del_pvc.adru_pvc_vci
 186 #define adr_svc_intf    adr_u.adru_del_svc.adru_svc_intf
 187 #define adr_svc_vpi     adr_u.adru_del_svc.adru_svc_vpi
 188 #define adr_svc_vci     adr_u.adru_del_svc.adru_svc_vci
 189 #define adr_arp_intf    adr_u.adru_del_arp.adru_arp_intf
 190 #define adr_arp_dst     adr_u.adru_del_arp.adru_arp_dst
 191
 192
 193 /*
 194  * Structure for PF_ATM information (AIOCINFO) socket ioctls
 195  */
 196 struct atminfreq {
 197         int             air_opcode;             /* Sub-operation */
 198         caddr_t         air_buf_addr;           /* Buffer for returned info */
 199         int             air_buf_len;            /* Buffer length */
 200         union {
 201                 /* Vendor info */
 202                 char            airu_vinfo_intf[IFNAMSIZ];/* Interface name */
 203                 /* IP VCC */
 204                 struct sockaddr airu_ip_addr;           /* Destination host */
 205                 /* ARP table */
 206                 struct {
 207                         struct sockaddr airu_arp_addr;  /* Destination host */
 208                         u_char          airu_arp_flags; /* Flags (see below) */
 209                 } airu_arp;
 210                 /* ARP server */
 211                 char            airu_asrv_intf[IFNAMSIZ];/* Interface name */
 212                 /* Interface */
 213                 char            airu_int_intf[IFNAMSIZ];/* Interface name */
 214                 /* VCC */
 215                 char            airu_vcc_intf[IFNAMSIZ];/* Interface name */
 216                 /* Configuration */
 217                 char            airu_cfg_intf[IFNAMSIZ];/* Interface name */
 218                 /* Network interface */
 219                 char            airu_netif_intf[IFNAMSIZ];/* Interface name */
 220                 /* Physical interface statistics */
 221                 char            airu_physt_intf[IFNAMSIZ];/* Interface name */
 222         } air_u;
 223 };
 224 #define air_vinfo_intf          air_u.airu_vinfo_intf
 225 #define air_ip_addr             air_u.airu_ip_addr
 226 #define air_arp_addr            air_u.airu_arp.airu_arp_addr
 227 #define air_arp_flags           air_u.airu_arp.airu_arp_flags
 228 #define air_asrv_intf           air_u.airu_asrv_intf
 229 #define air_int_intf            air_u.airu_int_intf
 230 #define air_vcc_intf            air_u.airu_vcc_intf
 231 #define air_cfg_intf            air_u.airu_cfg_intf
 232 #define air_netif_intf          air_u.airu_netif_intf
 233 #define air_physt_intf          air_u.airu_physt_intf
 234
 235 /* ARP table info flags */
 236 #define ARP_RESET_REF   0x01                    /* Reset refresh status */
 237
 238
 239 /*
 240  * Structures returned by information requests
 241  */
 242
 243 /*
 244  * Vendor-specific interface information
 245  */
 246 struct air_vinfo_rsp {
 247         char            avsp_intf[IFNAMSIZ];    /* Interface name */
 248         int             avsp_len;               /* Length of returned
 249                                                         Vendor Info block */
 250                                                 /* Vendor info ... */
 251 };
 252
 253
 254 /*
 255  * ARP table information
 256  */
 257 struct air_arp_rsp {
 258         struct sockaddr aap_arp_addr;           /* Destination host */
 259         char            aap_intf[IFNAMSIZ];     /* Interface name */
 260         u_char          aap_flags;              /* Flags (see below) */
 261         u_char          aap_origin;             /* Entry origin (see below) */
 262         u_char          aap_age;                /* Aging timeout (minutes) */
 263         Atm_addr        aap_addr;               /* ATM address */
 264         Atm_addr        aap_subaddr;            /* ATM subaddress */
 265 };
 266
 267 /*
 268  * ARP entry flags
 269  */
 270 #define ARPF_VALID      0x01                    /* Entry is valid */
 271 #define ARPF_REFRESH    0x02                    /* Entry has been refreshed */
 272
 273 /*
 274  * ARP entry origin
 275  */
 276 #define ARP_ORIG_PERM   50                      /* Permanent entry */
 277
 278 /*
 279  * IP VCC information
 280  */
 281 struct air_ip_vcc_rsp {
 282         struct sockaddr aip_dst_addr;           /* Destination host */
 283         char            aip_intf[IFNAMSIZ];     /* Interface name */
 284         u_short         aip_vpi;                /* VPI value */
 285         u_short         aip_vci;                /* VCI value */
 286         u_char          aip_sig_proto;          /* Signalling protocol */
 287         u_char          aip_flags;              /* Flags (IVF_*) */
 288         u_char          aip_state;              /* IP VCC state */
 289 };
 290
 291 /*
 292  * ARP server information
 293  */
 294 struct air_asrv_rsp {
 295         char            asp_intf[IFNAMSIZ];     /* Interface name */
 296         Atm_addr        asp_addr;               /* Server ATM address */
 297         Atm_addr        asp_subaddr;            /* Server ATM subaddress */
 298         int             asp_state;              /* Server state */
 299         int             asp_nprefix;            /* Number of prefix entries */
 300 };
 301
 302 /*
 303  * Interface information
 304  */
 305 struct air_int_rsp {
 306         char            anp_intf[IFNAMSIZ];     /* Interface name */
 307         Atm_addr        anp_addr;               /* ATM address */
 308         Atm_addr        anp_subaddr;            /* ATM subaddress */
 309         u_char          anp_sig_proto;          /* Signalling protocol */
 310         u_char          anp_sig_state;          /* Signalling protocol state */
 311         char            anp_nif_pref[IFNAMSIZ]; /* Netif prefix */
 312         int             anp_nif_cnt;            /* No. of netifs */
 313 };
 314
 315 /*
 316  * Network interface information
 317  */
 318 struct air_netif_rsp {
 319         char            anp_intf[IFNAMSIZ];     /* Interface name */
 320         struct sockaddr anp_proto_addr;         /* Protocol address */
 321         char            anp_phy_intf[IFNAMSIZ]; /* Interface name */
 322 };
 323
 324 /*
 325  * VCC information
 326  */
 327 #define O_CNT           8
 328 struct air_vcc_rsp {
 329         char            avp_intf[IFNAMSIZ];     /* Interface name */
 330         u_short         avp_vpi;                /* VPI value */
 331         u_short         avp_vci;                /* VCI value */
 332         u_char          avp_type;               /* Type (SVC or PVC) */
 333         u_char          avp_aal;                /* AAL */
 334         u_char          avp_sig_proto;          /* Signalling protocol */
 335         Encaps_t        avp_encaps;             /* Encapsulation */
 336         u_char          avp_state;              /* State (sig mgr specific) */
 337         char            avp_owners[(T_ATM_APP_NAME_LEN+1)*O_CNT];/* VCC users */
 338         Atm_addr        avp_daddr;              /* Address of far end */
 339         Atm_addr        avp_dsubaddr;           /* Subaddress of far end */
 340         long            avp_ipdus;              /* PDUs received from VCC */
 341         long            avp_opdus;              /* PDUs sent to VCC */
 342         long            avp_ibytes;             /* Bytes received from VCC */
 343         long            avp_obytes;             /* Bytes sent to VCC */
 344         long            avp_ierrors;            /* Errors receiving from VCC */
 345         long            avp_oerrors;            /* Errors sending to VCC */
 346         time_t          avp_tstamp;             /* State transition timestamp */
 347 };
 348
 349 /*
 350  * Adapter configuration information
 351  */
 352 struct air_cfg_rsp {
 353         char            acp_intf[IFNAMSIZ];     /* Interface name */
 354         Atm_config      acp_cfg;                /* Config info */
 355 };
 356 #define acp_vendor      acp_cfg.ac_vendor
 357 #define acp_vendapi     acp_cfg.ac_vendapi
 358 #define acp_device      acp_cfg.ac_device
 359 #define acp_media       acp_cfg.ac_media
 360 #define acp_serial      acp_cfg.ac_serial
 361 #define acp_bustype     acp_cfg.ac_bustype
 362 #define acp_busslot     acp_cfg.ac_busslot
 363 #define acp_ram         acp_cfg.ac_ram
 364 #define acp_ramsize     acp_cfg.ac_ramsize
 365 #define acp_macaddr     acp_cfg.ac_macaddr
 366 #define acp_hard_vers   acp_cfg.ac_hard_vers
 367 #define acp_firm_vers   acp_cfg.ac_firm_vers
 368
 369 /*
 370  * Version information
 371  */
 372 struct air_version_rsp {
 373         int             avp_version;            /* Software version */
 374 };
 375
 376 /*
 377  * Physical interface statistics
 378  */
 379 struct air_phy_stat_rsp {
 380         char            app_intf[IFNAMSIZ];     /* Interface name */
 381         long            app_ipdus;              /* PDUs received from I/F */
 382         long            app_opdus;              /* PDUs sent to I/F */
 383         long            app_ibytes;             /* Bytes received from I/F */
 384         long            app_obytes;             /* Bytes sent to I/F */
 385         long            app_ierrors;            /* Errors receiving from I/F */
 386         long            app_oerrors;            /* Errors sending to I/F */
 387         long            app_cmderrors;          /* I/F command errors */
 388 };
 389
 390
 391 /*
 392  * PF_ATM sub-operation codes
 393  */
 394 #define AIOCS_CFG_ATT   1
 395 #define AIOCS_CFG_DET   2
 396 #define AIOCS_ADD_PVC   32
 397 #define AIOCS_ADD_ARP   33
 398 #define AIOCS_DEL_PVC   64
 399 #define AIOCS_DEL_SVC   65
 400 #define AIOCS_DEL_ARP   66
 401 #define AIOCS_SET_ASV   96
 402 #define AIOCS_SET_NIF   97
 403 #define AIOCS_SET_PRF   98
 404 #define AIOCS_SET_MAC   99
 405 #define AIOCS_INF_VST   160
 406 #define AIOCS_INF_IPM   161
 407 #define AIOCS_INF_ARP   162
 408 #define AIOCS_INF_ASV   163
 409 #define AIOCS_INF_INT   164
 410 #define AIOCS_INF_VCC   165
 411 #define AIOCS_INF_CFG   166
 412 #define AIOCS_INF_NIF   167
 413 #define AIOCS_INF_PIS   168
 414 #define AIOCS_INF_VER   169
 415
 416
 417 /*
 418  * PF_ATM ioctls
 419  */
 420 #define AIOCCFG         _IOW('A', 128, struct atmcfgreq)/* Configure i/f */
 421 #define AIOCADD         _IOW('A', 129, struct atmaddreq)/* Add (e.g. PVC) */
 422 #define AIOCDEL         _IOW('A', 130, struct atmdelreq)/* Delete */
 423 #define AIOCSET         _IOW('A', 132, struct atmsetreq)/* Set (e.g. net i/f) */
 424 #define AIOCINFO        _IOWR('A', 133, struct atminfreq)/* Show kernel info */
 425
 426 #endif  /* _NETATM_ATM_IOCTL_H */