sys/dev/disk/isp/isp_ioctl.h

   1 /* $FreeBSD: src/sys/dev/isp/isp_ioctl.h,v 1.1.2.4 2002/07/29 04:21:23 mjacob Exp $ */
   2 /*
   3  * Copyright (c) 2001 by Matthew Jacob
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * Alternatively, this software may be distributed under the terms of the
  16  * the GNU Public License ("GPL", Library, Version 2).
  17  *
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * Matthew Jacob <mjacob@feral.com)
  31  *
  32  */
  33 /*
  34  * ioctl definitions for Qlogic FC/SCSI HBA driver
  35  */
  36 #define ISP_IOC         (021)   /* 'Ctrl-Q' */
  37
  38 /*
  39  * This ioctl sets/retrieves the debugging level for this hba instance.
  40  * Note that this is not a simple integer level- see ispvar.h for definitions.
  41  *
  42  * The arguments is a pointer to an integer with the new debugging level.
  43  * The old value is written into this argument.
  44  */
  45
  46 #define ISP_SDBLEV      _IOWR(ISP_IOC, 1, int)
  47
  48 /*
  49  * This ioctl resets the HBA. Use with caution.
  50  */
  51 #define ISP_RESETHBA    _IO(ISP_IOC, 2)
  52
  53 /*
  54  * This ioctl performs a fibre chanel rescan.
  55  */
  56 #define ISP_RESCAN      _IO(ISP_IOC, 3)
  57
  58 /*
  59  * This ioctl performs a reset and then will set the adapter to the
  60  * role that was passed in (the old role will be returned). It almost
  61  * goes w/o saying: use with caution.
  62  */
  63 #define ISP_SETROLE     _IOWR(ISP_IOC, 4, int)
  64
  65 #define ISP_ROLE_NONE           0x0
  66 #define ISP_ROLE_INITIATOR      0x1
  67 #define ISP_ROLE_TARGET         0x2
  68 #define ISP_ROLE_BOTH           (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
  69 #ifndef ISP_DEFAULT_ROLES
  70 #define ISP_DEFAULT_ROLES       ISP_ROLE_BOTH
  71 #endif
  72
  73 /*
  74  * Get the current adapter role
  75  */
  76 #define ISP_GETROLE     _IOR(ISP_IOC, 5), int
  77
  78 /*
  79  * Get/Clear Stats
  80  */
  81 #define ISP_STATS_VERSION       0
  82 typedef struct {
  83         u_int8_t        isp_stat_version;
  84         u_int8_t        isp_type;               /* (ro) reflects chip type */
  85         u_int8_t        isp_revision;           /* (ro) reflects chip version */
  86         u_int8_t        unused1;
  87         u_int32_t       unused2;
  88         /*
  89          * Statistics Counters
  90          */
  91 #define ISP_NSTATS      16
  92 #define ISP_INTCNT      0
  93 #define ISP_INTBOGUS    1
  94 #define ISP_INTMBOXC    2
  95 #define ISP_INGOASYNC   3
  96 #define ISP_RSLTCCMPLT  4
  97 #define ISP_FPHCCMCPLT  5
  98 #define ISP_RSCCHIWAT   6
  99 #define ISP_FPCCHIWAT   7
 100         u_int64_t       isp_stats[ISP_NSTATS];
 101 } isp_stats_t;
 102
 103 #define ISP_GET_STATS   _IOR(ISP_IOC, 6, isp_stats_t)
 104 #define ISP_CLR_STATS   _IO(ISP_IOC, 7)
 105
 106 /*
 107  * Initiate a LIP
 108  */
 109 #define ISP_FC_LIP      _IO(ISP_IOC, 8)
 110
 111 /*
 112  * Return the Port Database structure for the named device, or ENODEV if none.
 113  * Caller fills in virtual loopid (0..255), aka 'target'. The driver returns
 114  * ENODEV (if nothing valid there) or the actual loopid (for local loop devices
 115  * only), 24 bit Port ID and Node and Port WWNs.
 116  */
 117 struct isp_fc_device {
 118         u_int32_t       loopid; /* 0..255 */
 119         u_int32_t       portid; /* 24 bit Port ID */
 120         u_int64_t       node_wwn;
 121         u_int64_t       port_wwn;
 122 };
 123 #define ISP_FC_GETDINFO _IOWR(ISP_IOC, 9, struct isp_fc_device)
 124
 125 /*
 126  * Get F/W crash dump
 127  */
 128 #define ISP_GET_FW_CRASH_DUMP   _IO(ISP_IOC, 10)
 129 #define ISP_FORCE_CRASH_DUMP    _IO(ISP_IOC, 11)
 130
 131 /*
 132  * Get information about this Host Adapter, including current connection
 133  * topology and capabilities.
 134  */
 135 struct isp_hba_device {
 136         u_int32_t
 137                                         : 8,
 138                                         : 4,
 139                 fc_speed                : 4,    /* Gbps */
 140                                         : 2,
 141                 fc_class2               : 1,
 142                 fc_ip_supported         : 1,
 143                 fc_scsi_supported       : 1,
 144                 fc_topology             : 3,
 145                 fc_loopid               : 8;
 146         u_int64_t       nvram_node_wwn;
 147         u_int64_t       nvram_port_wwn;
 148         u_int64_t       active_node_wwn;
 149         u_int64_t       active_port_wwn;
 150 };
 151
 152 #define ISP_TOPO_UNKNOWN        0       /* connection topology unknown */
 153 #define ISP_TOPO_FCAL           1       /* private or PL_DA */
 154 #define ISP_TOPO_LPORT          2       /* public loop */
 155 #define ISP_TOPO_NPORT          3       /* N-port */
 156 #define ISP_TOPO_FPORT          4       /* F-port */
 157
 158 #define ISP_FC_GETHINFO _IOR(ISP_IOC, 12, struct isp_hba_device)
 159 /*
 160  * Set some internal parameters. This doesn't take effect until
 161  * the chip is reset.
 162  *
 163  * Each parameter is generalized to be a name string with an integer value.
 164  *
 165  * Known parameters are:
 166  *
 167  *      Name                            Value Range
 168  *
 169  *      "framelength"                   512,1024,2048
 170  *      "exec_throttle"                 16..255
 171  *      "fullduplex"                    0,1
 172  *      "loopid"                        0..125
 173  */
 174
 175 struct isp_fc_param {
 176         char            param_name[16]; /* null terminated */
 177         u_int32_t       parameter;
 178 };
 179
 180 #define ISP_GET_FC_PARAM        _IOWR(ISP_IOC, 98, struct isp_fc_param)
 181 #define ISP_SET_FC_PARAM        _IOWR(ISP_IOC, 99, struct isp_fc_param)