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_ALL            = 0xff,
  57         CTL_PORT_ISC            = 0x100 // FC port for inter-shelf communication
  58 } ctl_port_type;
  59
  60 struct ctl_port_entry {
  61         ctl_port_type           port_type;
  62         char                    port_name[64];
  63         int32_t                 targ_port;
  64         int                     physical_port;
  65         int                     virtual_port;
  66         u_int                   flags;
  67 #define CTL_PORT_WWNN_VALID     0x01
  68 #define CTL_PORT_WWPN_VALID     0x02
  69         uint64_t                wwnn;
  70         uint64_t                wwpn;
  71         int                     online;
  72 };
  73
  74 struct ctl_modepage_header {
  75         uint8_t page_code;
  76         uint8_t subpage;
  77         int32_t len_used;
  78         int32_t len_left;
  79 };
  80
  81 struct ctl_modepage_aps {
  82         struct ctl_modepage_header header;
  83         uint8_t lock_active;
  84 };
  85
  86 union ctl_modepage_info {
  87         struct ctl_modepage_header header;
  88         struct ctl_modepage_aps aps;
  89 };
  90
  91 /*
  92  * Serial number length, for VPD page 0x80.
  93  */
  94 #define CTL_SN_LEN      16
  95
  96 /*
  97  * Device ID length, for VPD page 0x83.
  98  */
  99 #define CTL_DEVID_LEN   16
 100 /*
 101  * WWPN length, for VPD page 0x83.
 102  */
 103 #define CTL_WWPN_LEN   8
 104
 105 /*
 106  * Unit attention types. ASC/ASCQ values for these should be placed in
 107  * ctl_build_ua.  These are also listed in order of reporting priority.
 108  * i.e. a poweron UA is reported first, bus reset second, etc.
 109  */
 110 typedef enum {
 111         CTL_UA_NONE             = 0x0000,
 112         CTL_UA_POWERON          = 0x0001,
 113         CTL_UA_BUS_RESET        = 0x0002,
 114         CTL_UA_TARG_RESET       = 0x0004,
 115         CTL_UA_LUN_RESET        = 0x0008,
 116         CTL_UA_LUN_CHANGE       = 0x0010,
 117         CTL_UA_MODE_CHANGE      = 0x0020,
 118         CTL_UA_LOG_CHANGE       = 0x0040,
 119         CTL_UA_LVD              = 0x0080,
 120         CTL_UA_SE               = 0x0100,
 121         CTL_UA_RES_PREEMPT      = 0x0200,
 122         CTL_UA_RES_RELEASE      = 0x0400,
 123         CTL_UA_REG_PREEMPT      = 0x0800,
 124         CTL_UA_ASYM_ACC_CHANGE  = 0x1000,
 125         CTL_UA_CAPACITY_CHANGED = 0x2000
 126 } ctl_ua_type;
 127
 128 #ifdef  _KERNEL
 129
 130 MALLOC_DECLARE(M_CTL);
 131
 132 typedef enum {
 133         CTL_THREAD_NONE         = 0x00,
 134         CTL_THREAD_WAKEUP       = 0x01
 135 } ctl_thread_flags;
 136
 137 struct ctl_thread {
 138         void                    (*thread_func)(void *arg);
 139         void                    *arg;
 140         struct cv               wait_queue;
 141         const char              *thread_name;
 142         ctl_thread_flags        thread_flags;
 143         struct completion       *thread_event;
 144         struct task_struct      *task;
 145 };
 146
 147 struct ctl_page_index;
 148
 149 #ifdef SYSCTL_DECL      /* from sysctl.h */
 150 SYSCTL_DECL(_kern_cam_ctl);
 151 #endif
 152
 153 /*
 154  * Call these routines to enable or disable front end ports.
 155  */
 156 int ctl_port_enable(ctl_port_type port_type);
 157 int ctl_port_disable(ctl_port_type port_type);
 158 /*
 159  * This routine grabs a list of frontend ports.
 160  */
 161 int ctl_port_list(struct ctl_port_entry *entries, int num_entries_alloced,
 162                   int *num_entries_filled, int *num_entries_dropped,
 163                   ctl_port_type port_type, int no_virtual);
 164
 165 /*
 166  * Put a string into an sbuf, escaping characters that are illegal or not
 167  * recommended in XML.  Note this doesn't escape everything, just > < and &.
 168  */
 169 int ctl_sbuf_printf_esc(struct sbuf *sb, char *str);
 170
 171 int ctl_ffz(uint32_t *mask, uint32_t size);
 172 int ctl_set_mask(uint32_t *mask, uint32_t bit);
 173 int ctl_clear_mask(uint32_t *mask, uint32_t bit);
 174 int ctl_is_set(uint32_t *mask, uint32_t bit);
 175 int ctl_control_page_handler(struct ctl_scsiio *ctsio,
 176                              struct ctl_page_index *page_index,
 177                              uint8_t *page_ptr);
 178 /**
 179 int ctl_failover_sp_handler(struct ctl_scsiio *ctsio,
 180                             struct ctl_page_index *page_index,
 181                             uint8_t *page_ptr);
 182 **/
 183 int ctl_power_sp_handler(struct ctl_scsiio *ctsio,
 184                          struct ctl_page_index *page_index, uint8_t *page_ptr);
 185 int ctl_power_sp_sense_handler(struct ctl_scsiio *ctsio,
 186                                struct ctl_page_index *page_index, int pc);
 187 int ctl_aps_sp_handler(struct ctl_scsiio *ctsio,
 188                        struct ctl_page_index *page_index, uint8_t *page_ptr);
 189 int ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
 190                                    struct ctl_page_index *page_index,
 191                                    int pc);
 192 int ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
 193                                     struct ctl_page_index *page_index,
 194                                     uint8_t *page_ptr);
 195 int ctl_config_move_done(union ctl_io *io);
 196 void ctl_datamove(union ctl_io *io);
 197 void ctl_done(union ctl_io *io);
 198 void ctl_config_write_done(union ctl_io *io);
 199 #if 0
 200 int ctl_thread(void *arg);
 201 #endif
 202 void ctl_wakeup_thread(void);
 203 #if 0
 204 struct ctl_thread *ctl_create_thread(void (*thread_func)
 205         (void *thread_arg), void *thread_arg, const char *thread_name);
 206 void ctl_signal_thread(struct ctl_thread *thread);
 207 void ctl_shutdown_thread(struct ctl_thread *thread);
 208 #endif
 209 void ctl_portDB_changed(int portnum);
 210 void ctl_init_isc_msg(void);
 211
 212 #endif  /* _KERNEL */
 213
 214 #endif  /* _CTL_H_ */
 215
 216 /*
 217  * vim: ts=8
 218  */