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