sys/cam/ctl/ctl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2003 Silicon Graphics International Corp.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions, and the following disclaimer,
  12  *    without modification.
  13  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  14  *    substantially similar to the "NO WARRANTY" disclaimer below
  15  *    ("Disclaimer") and any redistribution must be conditioned upon
  16  *    including a substantially similar Disclaimer requirement for further
  17  *    binary redistribution.
  18  *
  19  * NO WARRANTY
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  28  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  29  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGES.
  31  *
  32  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl.h#5 $
  33  */
  34 /*
  35  * Function definitions used both within CTL and potentially in various CTL
  36  * clients.
  37  *
  38  * Author: Ken Merry <ken@FreeBSD.org>
  39  */
  40
  41 #ifndef _CTL_H_
  42 #define _CTL_H_
  43
  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_UMASS          = 0x40,
  58         CTL_PORT_ALL            = 0xff,
  59         CTL_PORT_ISC            = 0x100 // FC port for inter-shelf communication
  60 } ctl_port_type;
  61
  62 struct ctl_port_entry {
  63         ctl_port_type           port_type;
  64         char                    port_name[64];
  65         int32_t                 targ_port;
  66         int                     physical_port;
  67         int                     virtual_port;
  68         u_int                   flags;
  69 #define CTL_PORT_WWNN_VALID     0x01
  70 #define CTL_PORT_WWPN_VALID     0x02
  71         uint64_t                wwnn;
  72         uint64_t                wwpn;
  73         int                     online;
  74 };
  75
  76 struct ctl_modepage_header {
  77         uint8_t                 page_code;
  78         uint8_t                 subpage;
  79         uint16_t                len_used;
  80         uint16_t                len_left;
  81 };
  82
  83 union ctl_modepage_info {
  84         struct ctl_modepage_header header;
  85 };
  86
  87 /*
  88  * Serial number length, for VPD page 0x80.
  89  */
  90 #define CTL_SN_LEN      16
  91
  92 /*
  93  * Device ID length, for VPD page 0x83.
  94  */
  95 #define CTL_DEVID_LEN   64
  96 #define CTL_DEVID_MIN_LEN       16
  97 /*
  98  * WWPN length, for VPD page 0x83.
  99  */
 100 #define CTL_WWPN_LEN   8
 101
 102 #define CTL_DRIVER_NAME_LEN     32
 103
 104 /*
 105  * Unit attention types. ASC/ASCQ values for these should be placed in
 106  * ctl_build_ua.  These are also listed in order of reporting priority.
 107  * i.e. a poweron UA is reported first, bus reset second, etc.
 108  */
 109 typedef enum {
 110         CTL_UA_NONE             = 0x0000,
 111         CTL_UA_POWERON          = 0x0001,
 112         CTL_UA_BUS_RESET        = 0x0002,
 113         CTL_UA_TARG_RESET       = 0x0004,
 114         CTL_UA_I_T_NEXUS_LOSS   = 0x0008,
 115         CTL_UA_LUN_RESET        = 0x0010,
 116         CTL_UA_LUN_CHANGE       = 0x0020,
 117         CTL_UA_MODE_CHANGE      = 0x0040,
 118         CTL_UA_LOG_CHANGE       = 0x0080,
 119         CTL_UA_INQ_CHANGE       = 0x0100,
 120         CTL_UA_RES_PREEMPT      = 0x0400,
 121         CTL_UA_RES_RELEASE      = 0x0800,
 122         CTL_UA_REG_PREEMPT      = 0x1000,
 123         CTL_UA_ASYM_ACC_CHANGE  = 0x2000,
 124         CTL_UA_CAPACITY_CHANGE  = 0x4000,
 125         CTL_UA_THIN_PROV_THRES  = 0x8000,
 126         CTL_UA_MEDIUM_CHANGE    = 0x10000,
 127         CTL_UA_IE               = 0x20000
 128 } ctl_ua_type;
 129
 130 #ifdef  _KERNEL
 131
 132 #ifdef MALLOC_DECLARE   /* from malloc.h */
 133 MALLOC_DECLARE(M_CTL);
 134 #endif
 135
 136 struct ctl_page_index;
 137
 138 #ifdef SYSCTL_DECL      /* from sysctl.h */
 139 SYSCTL_DECL(_kern_cam_ctl);
 140 #endif
 141
 142 struct cdev;
 143 struct ctl_lun;
 144 struct ctl_port;
 145 struct ctl_softc;
 146 struct ctl_scsiio;
 147 struct sbuf;
 148 union ctl_io;
 149
 150 /*
 151  * Put a string into an sbuf, escaping characters that are illegal or not
 152  * recommended in XML.  Note this doesn't escape everything, just > < and &.
 153  */
 154 int ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size);
 155
 156 int ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last);
 157 int ctl_set_mask(uint32_t *mask, uint32_t bit);
 158 int ctl_clear_mask(uint32_t *mask, uint32_t bit);
 159 int ctl_is_set(uint32_t *mask, uint32_t bit);
 160 int ctl_default_page_handler(struct ctl_scsiio *ctsio,
 161                              struct ctl_page_index *page_index,
 162                              uint8_t *page_ptr);
 163 int ctl_ie_page_handler(struct ctl_scsiio *ctsio,
 164                         struct ctl_page_index *page_index,
 165                         uint8_t *page_ptr);
 166 int ctl_temp_log_sense_handler(struct ctl_scsiio *ctsio,
 167                                    struct ctl_page_index *page_index,
 168                                    int pc);
 169 int ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
 170                                    struct ctl_page_index *page_index,
 171                                    int pc);
 172 int ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
 173                                    struct ctl_page_index *page_index,
 174                                    int pc);
 175 int ctl_ie_log_sense_handler(struct ctl_scsiio *ctsio,
 176                                    struct ctl_page_index *page_index,
 177                                    int pc);
 178 int ctl_config_move_done(union ctl_io *io, bool samethr);
 179 void ctl_datamove_done(union ctl_io *io, bool samethr);
 180 void ctl_datamove(union ctl_io *io);
 181 void ctl_serseq_done(union ctl_io *io);
 182 void ctl_done(union ctl_io *io);
 183 void ctl_data_submit_done(union ctl_io *io);
 184 void ctl_config_read_done(union ctl_io *io);
 185 void ctl_config_write_done(union ctl_io *io);
 186 void ctl_portDB_changed(int portnum);
 187 int ctl_ioctl_io(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
 188                  struct thread *td);
 189
 190 void ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua);
 191 void ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except,
 192     ctl_ua_type ua);
 193 void ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua);
 194 void ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua);
 195 void ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua);
 196 void ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx,
 197     ctl_ua_type ua_type);
 198
 199 uint32_t ctl_decode_lun(uint64_t encoded);
 200 uint64_t ctl_encode_lun(uint32_t decoded);
 201
 202 void ctl_isc_announce_lun(struct ctl_lun *lun);
 203 void ctl_isc_announce_port(struct ctl_port *port);
 204 void ctl_isc_announce_iid(struct ctl_port *port, int iid);
 205 void ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx,
 206     uint8_t page, uint8_t subpage);
 207
 208 int ctl_expand_number(const char *buf, uint64_t *num);
 209
 210 #endif  /* _KERNEL */
 211
 212 #endif  /* _CTL_H_ */
 213
 214 /*
 215  * vim: ts=8
 216  */