sys/cam/ctl/ctl.h

   1 /*-
   2  * Copyright (c) 2003 Silicon Graphics International Corp.
   3  * All rights reserved.
   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  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions, and the following disclaimer,
  10  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    substantially similar to the "NO WARRANTY" disclaimer below
  13  *    ("Disclaimer") and any redistribution must be conditioned upon
  14  *    including a substantially similar Disclaimer requirement for further
  15  *    binary redistribution.
  16  *
  17  * NO WARRANTY
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  27  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGES.
  29  *
  30  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl.h#5 $
  31  * $FreeBSD$
  32  */
  33 /*
  34  * Function definitions used both within CTL and potentially in various CTL
  35  * clients.
  36  *
  37  * Author: Ken Merry <ken@FreeBSD.org>
  38  */
  39
  40 #ifndef _CTL_H_
  41 #define _CTL_H_
  42
  43 #define ctl_min(x,y)    (((x) < (y)) ? (x) : (y))
  44 #define CTL_RETVAL_COMPLETE     0
  45 #define CTL_RETVAL_QUEUED       1
  46 #define CTL_RETVAL_ALLOCATED    2
  47 #define CTL_RETVAL_ERROR        3
  48
  49 typedef enum {
  50         CTL_PORT_NONE           = 0x00,
  51         CTL_PORT_FC             = 0x01,
  52         CTL_PORT_SCSI           = 0x02,
  53         CTL_PORT_IOCTL          = 0x04,
  54         CTL_PORT_INTERNAL       = 0x08,
  55         CTL_PORT_ISCSI          = 0x10,
  56         CTL_PORT_SAS            = 0x20,
  57         CTL_PORT_ALL            = 0xff,
  58         CTL_PORT_ISC            = 0x100 // FC port for inter-shelf communication
  59 } ctl_port_type;
  60
  61 struct ctl_port_entry {
  62         ctl_port_type           port_type;
  63         char                    port_name[64];
  64         int32_t                 targ_port;
  65         int                     physical_port;
  66         int                     virtual_port;
  67         u_int                   flags;
  68 #define CTL_PORT_WWNN_VALID     0x01
  69 #define CTL_PORT_WWPN_VALID     0x02
  70         uint64_t                wwnn;
  71         uint64_t                wwpn;
  72         int                     online;
  73 };
  74
  75 struct ctl_modepage_header {
  76         uint8_t page_code;
  77         uint8_t subpage;
  78         int32_t len_used;
  79         int32_t len_left;
  80 };
  81
  82 struct ctl_modepage_aps {
  83         struct ctl_modepage_header header;
  84         uint8_t lock_active;
  85 };
  86
  87 union ctl_modepage_info {
  88         struct ctl_modepage_header header;
  89         struct ctl_modepage_aps aps;
  90 };
  91
  92 /*
  93  * Serial number length, for VPD page 0x80.
  94  */
  95 #define CTL_SN_LEN      16
  96
  97 /*
  98  * Device ID length, for VPD page 0x83.
  99  */
 100 #define CTL_DEVID_LEN   64
 101 #define CTL_DEVID_MIN_LEN       16
 102 /*
 103  * WWPN length, for VPD page 0x83.
 104  */
 105 #define CTL_WWPN_LEN   8
 106
 107 #define CTL_DRIVER_NAME_LEN     32
 108
 109 /*
 110  * Unit attention types. ASC/ASCQ values for these should be placed in
 111  * ctl_build_ua.  These are also listed in order of reporting priority.
 112  * i.e. a poweron UA is reported first, bus reset second, etc.
 113  */
 114 typedef enum {
 115         CTL_UA_NONE             = 0x0000,
 116         CTL_UA_POWERON          = 0x0001,
 117         CTL_UA_BUS_RESET        = 0x0002,
 118         CTL_UA_TARG_RESET       = 0x0004,
 119         CTL_UA_I_T_NEXUS_LOSS   = 0x0008,
 120         CTL_UA_LUN_RESET        = 0x0010,
 121         CTL_UA_LUN_CHANGE       = 0x0020,
 122         CTL_UA_MODE_CHANGE      = 0x0040,
 123         CTL_UA_LOG_CHANGE       = 0x0080,
 124         CTL_UA_LVD              = 0x0100,
 125         CTL_UA_SE               = 0x0200,
 126         CTL_UA_RES_PREEMPT      = 0x0400,
 127         CTL_UA_RES_RELEASE      = 0x0800,
 128         CTL_UA_REG_PREEMPT      = 0x1000,
 129         CTL_UA_ASYM_ACC_CHANGE  = 0x2000,
 130         CTL_UA_CAPACITY_CHANGED = 0x4000
 131 } ctl_ua_type;
 132
 133 #ifdef  _KERNEL
 134
 135 MALLOC_DECLARE(M_CTL);
 136
 137 struct ctl_page_index;
 138
 139 #ifdef SYSCTL_DECL      /* from sysctl.h */
 140 SYSCTL_DECL(_kern_cam_ctl);
 141 #endif
 142
 143 /*
 144  * Call these routines to enable or disable front end ports.
 145  */
 146 int ctl_port_enable(ctl_port_type port_type);
 147 int ctl_port_disable(ctl_port_type port_type);
 148 /*
 149  * This routine grabs a list of frontend ports.
 150  */
 151 int ctl_port_list(struct ctl_port_entry *entries, int num_entries_alloced,
 152                   int *num_entries_filled, int *num_entries_dropped,
 153                   ctl_port_type port_type, int no_virtual);
 154
 155 /*
 156  * Put a string into an sbuf, escaping characters that are illegal or not
 157  * recommended in XML.  Note this doesn't escape everything, just > < and &.
 158  */
 159 int ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size);
 160
 161 int ctl_ffz(uint32_t *mask, uint32_t size);
 162 int ctl_set_mask(uint32_t *mask, uint32_t bit);
 163 int ctl_clear_mask(uint32_t *mask, uint32_t bit);
 164 int ctl_is_set(uint32_t *mask, uint32_t bit);
 165 int ctl_caching_sp_handler(struct ctl_scsiio *ctsio,
 166                          struct ctl_page_index *page_index, uint8_t *page_ptr);
 167 int ctl_control_page_handler(struct ctl_scsiio *ctsio,
 168                              struct ctl_page_index *page_index,
 169                              uint8_t *page_ptr);
 170 /**
 171 int ctl_failover_sp_handler(struct ctl_scsiio *ctsio,
 172                             struct ctl_page_index *page_index,
 173                             uint8_t *page_ptr);
 174 **/
 175 int ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
 176                                    struct ctl_page_index *page_index,
 177                                    int pc);
 178 int ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
 179                                     struct ctl_page_index *page_index,
 180                                     uint8_t *page_ptr);
 181 int ctl_config_move_done(union ctl_io *io);
 182 void ctl_datamove(union ctl_io *io);
 183 void ctl_done(union ctl_io *io);
 184 void ctl_data_submit_done(union ctl_io *io);
 185 void ctl_config_write_done(union ctl_io *io);
 186 void ctl_portDB_changed(int portnum);
 187 void ctl_init_isc_msg(void);
 188
 189 /*
 190  * KPI to manipulate LUN/port options
 191  */
 192
 193 struct ctl_option {
 194         STAILQ_ENTRY(ctl_option)        links;
 195         char                    *name;
 196         char                    *value;
 197 };
 198 typedef STAILQ_HEAD(ctl_options, ctl_option) ctl_options_t;
 199
 200 struct ctl_be_arg;
 201 void ctl_init_opts(ctl_options_t *opts, int num_args, struct ctl_be_arg *args);
 202 void ctl_free_opts(ctl_options_t *opts);
 203 char * ctl_get_opt(ctl_options_t *opts, const char *name);
 204
 205 #endif  /* _KERNEL */
 206
 207 #endif  /* _CTL_H_ */
 208
 209 /*
 210  * vim: ts=8
 211  */