include/sys/dld_ioc.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  23  */
  24
  25 #ifndef _SYS_DLD_IOC_H
  26 #define _SYS_DLD_IOC_H
  27
  28 #include <sys/types.h>
  29 #include <sys/cred.h>
  30
  31 #ifdef  __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 /*
  36  * The name of the dld control device.  All GLDv3 control ioctls are
  37  * performed on this device.
  38  */
  39 #define DLD_CONTROL_DEV         "/dev/dld"
  40
  41 /*
  42  * GLDv3 ioctl values are structured as follows:
  43  *
  44  * |    16-bits     |     16-bits    |
  45  * +----------------+----------------+
  46  * |   module-id    |   command-id   |
  47  * +----------------+----------------+
  48  */
  49 #define DLD_IOC_CMD(modid, cmdid)       (((uint_t)(modid) << 16) | (cmdid))
  50 #define DLD_IOC_MODID(cmd)              (((cmd) & 0xffff0000) >> 16)
  51 /*
  52  * GLDv3 module ids to be passed in as the first argument to
  53  * dld_ioc_register() and dld_ioc_unregister().
  54  */
  55 #define DLD_IOC         0x0D1D
  56 #define AGGR_IOC        0x0A66
  57 #define VNIC_IOC        0x0171
  58 #define SIMNET_IOC      0x5132
  59 #define IPTUN_IOC       0x454A
  60 #define BRIDGE_IOC      0xB81D
  61 #define IBPART_IOC      0x6171
  62
  63 /* GLDv3 modules use these macros to generate unique ioctl commands */
  64 #define DLDIOC(cmdid)           DLD_IOC_CMD(DLD_IOC, (cmdid))
  65 #define AGGRIOC(cmdid)          DLD_IOC_CMD(AGGR_IOC, (cmdid))
  66 #define VNICIOC(cmdid)          DLD_IOC_CMD(VNIC_IOC, (cmdid))
  67 #define SIMNETIOC(cmdid)        DLD_IOC_CMD(SIMNET_IOC, (cmdid))
  68 #define IPTUNIOC(cmdid)         DLD_IOC_CMD(IPTUN_IOC, (cmdid))
  69 #define BRIDGEIOC(cmdid)        DLD_IOC_CMD(BRIDGE_IOC, (cmdid))
  70 #define IBPARTIOC(cmdid)        DLD_IOC_CMD(IBPART_IOC, (cmdid))
  71
  72 #ifdef _KERNEL
  73
  74 /*
  75  * GLDv3 modules register the ioctls they're interested in by passing
  76  * in an array of dld_ioc_info_t to dld_ioc_register().  Modules
  77  * should call dld_ioc_register() either in _init() or attach().  The
  78  * dld module assumes that ddi_hold_devi_by_instance(<module>, 0, 0)
  79  * will cause the module to load and call dld_ioc_register().
  80  *
  81  * The di_cmd field is an ioctl command generated using one of the
  82  * macros above.  The di_argsize value is used by dld to copyin or
  83  * copyout the correct amount of data depending on whether the
  84  * DLDCOPYIN or DLDCOPYOUT flags are set so that every di_func()
  85  * callback function does not need to copyin/out its own data.
  86  */
  87
  88 typedef int (dld_ioc_func_t)(void *, intptr_t, int, cred_t *, int *);
  89 typedef int (dld_ioc_priv_func_t)(const cred_t *);
  90 typedef struct dld_ioc_info {
  91         uint_t          di_cmd;
  92         uint_t          di_flags;
  93         size_t          di_argsize;
  94         dld_ioc_func_t  *di_func;
  95         dld_ioc_priv_func_t *di_priv_func;
  96 } dld_ioc_info_t;
  97
  98 /* Values for di_flags */
  99 #define DLDCOPYIN       0x00000001 /* copyin di_argsize amount of data */
 100 #define DLDCOPYOUT      0x00000002 /* copyout di_argsize amount of data */
 101 #define DLDCOPYINOUT    (DLDCOPYIN | DLDCOPYOUT)
 102
 103 #define DLDIOCCNT(l)    (sizeof (l) / sizeof (dld_ioc_info_t))
 104 int     dld_ioc_register(uint16_t, dld_ioc_info_t *, uint_t);
 105 void    dld_ioc_unregister(uint16_t);
 106
 107 #endif /* _KERNEL */
 108
 109 #ifdef  __cplusplus
 110 }
 111 #endif
 112
 113 #endif  /* _SYS_DLD_IOC_H */