sys/dev/mps/mps_sas.h

   1 /*-
   2  * Copyright (c) 2011-2015 LSI Corp.
   3  * Copyright (c) 2013-2015 Avago Technologies
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   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  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 struct mps_fw_event_work;
  33
  34 struct mpssas_lun {
  35         SLIST_ENTRY(mpssas_lun) lun_link;
  36         lun_id_t        lun_id;
  37         uint8_t         eedp_formatted;
  38         uint32_t        eedp_block_size;
  39 };
  40
  41 struct mpssas_target {
  42         uint16_t        handle;
  43         uint8_t         linkrate;
  44         uint64_t        devname;
  45         uint32_t        devinfo;
  46         uint16_t        encl_handle;
  47         uint16_t        encl_slot;
  48         uint8_t         flags;
  49 #define MPSSAS_TARGET_INABORT   (1 << 0)
  50 #define MPSSAS_TARGET_INRESET   (1 << 1)
  51 #define MPSSAS_TARGET_INDIAGRESET (1 << 2)
  52 #define MPSSAS_TARGET_INREMOVAL (1 << 3)
  53 #define MPS_TARGET_FLAGS_RAID_COMPONENT (1 << 4)
  54 #define MPS_TARGET_FLAGS_VOLUME         (1 << 5)
  55 #define MPS_TARGET_IS_SATA_SSD  (1 << 6)
  56 #define MPSSAS_TARGET_INRECOVERY (MPSSAS_TARGET_INABORT | \
  57     MPSSAS_TARGET_INRESET | MPSSAS_TARGET_INCHIPRESET)
  58
  59         uint16_t        tid;
  60         SLIST_HEAD(, mpssas_lun) luns;
  61         TAILQ_HEAD(, mps_command) commands;
  62         struct mps_command *tm;
  63         TAILQ_HEAD(, mps_command) timedout_commands;
  64         uint16_t        exp_dev_handle;
  65         uint16_t        phy_num;
  66         uint64_t        sasaddr;
  67         uint16_t        parent_handle;
  68         uint64_t        parent_sasaddr;
  69         uint32_t        parent_devinfo;
  70         uint64_t        issued;
  71         uint64_t        completed;
  72         unsigned int    outstanding;
  73         unsigned int    timeouts;
  74         unsigned int    aborts;
  75         unsigned int    logical_unit_resets;
  76         unsigned int    target_resets;
  77         uint8_t         stop_at_shutdown;
  78         uint8_t         supports_SSU;
  79 };
  80
  81 struct mpssas_softc {
  82         struct mps_softc        *sc;
  83         u_int                   flags;
  84 #define MPSSAS_IN_DISCOVERY     (1 << 0)
  85 #define MPSSAS_IN_STARTUP       (1 << 1)
  86 #define MPSSAS_DISCOVERY_TIMEOUT_PENDING        (1 << 2)
  87 #define MPSSAS_QUEUE_FROZEN     (1 << 3)
  88 #define MPSSAS_SHUTDOWN         (1 << 4)
  89         u_int                   maxtargets;
  90         struct mpssas_target    *targets;
  91         struct cam_devq         *devq;
  92         struct cam_sim          *sim;
  93         struct cam_path         *path;
  94         struct intr_config_hook sas_ich;
  95         struct callout          discovery_callout;
  96         struct mps_event_handle *mpssas_eh;
  97
  98         u_int                   startup_refcount;
  99         struct proc             *sysctl_proc;
 100
 101         struct taskqueue        *ev_tq;
 102         struct task             ev_task;
 103         TAILQ_HEAD(, mps_fw_event_work) ev_queue;
 104 };
 105
 106 MALLOC_DECLARE(M_MPSSAS);
 107
 108 /*
 109  * Abstracted so that the driver can be backwards and forwards compatible
 110  * with future versions of CAM that will provide this functionality.
 111  */
 112 #define MPS_SET_LUN(lun, ccblun)        \
 113         mpssas_set_lun(lun, ccblun)
 114
 115 static __inline int
 116 mpssas_set_lun(uint8_t *lun, u_int ccblun)
 117 {
 118         uint64_t *newlun;
 119
 120         newlun = (uint64_t *)lun;
 121         *newlun = 0;
 122         if (ccblun <= 0xff) {
 123                 /* Peripheral device address method, LUN is 0 to 255 */
 124                 lun[1] = ccblun;
 125         } else if (ccblun <= 0x3fff) {
 126                 /* Flat space address method, LUN is <= 16383 */
 127                 scsi_ulto2b(ccblun, lun);
 128                 lun[0] |= 0x40;
 129         } else if (ccblun <= 0xffffff) {
 130                 /* Extended flat space address method, LUN is <= 16777215 */
 131                 scsi_ulto3b(ccblun, &lun[1]);
 132                 /* Extended Flat space address method */
 133                 lun[0] = 0xc0;
 134                 /* Length = 1, i.e. LUN is 3 bytes long */
 135                 lun[0] |= 0x10;
 136                 /* Extended Address Method */
 137                 lun[0] |= 0x02;
 138         } else {
 139                 return (EINVAL);
 140         }
 141
 142         return (0);
 143 }
 144
 145 static __inline void
 146 mpssas_set_ccbstatus(union ccb *ccb, int status)
 147 {
 148         ccb->ccb_h.status &= ~CAM_STATUS_MASK;
 149         ccb->ccb_h.status |= status;
 150 }
 151
 152 static __inline int
 153 mpssas_get_ccbstatus(union ccb *ccb)
 154 {
 155         return (ccb->ccb_h.status & CAM_STATUS_MASK);
 156 }
 157
 158 #define MPS_SET_SINGLE_LUN(req, lun)    \
 159 do {                                    \
 160         bzero((req)->LUN, 8);           \
 161         (req)->LUN[1] = lun;            \
 162 } while(0)
 163
 164 void mpssas_rescan_target(struct mps_softc *sc, struct mpssas_target *targ);
 165 void mpssas_discovery_end(struct mpssas_softc *sassc);
 166 void mpssas_prepare_for_tm(struct mps_softc *sc, struct mps_command *tm,
 167     struct mpssas_target *target, lun_id_t lun_id);
 168 void mpssas_startup_increment(struct mpssas_softc *sassc);
 169 void mpssas_startup_decrement(struct mpssas_softc *sassc);
 170
 171 void mpssas_firmware_event_work(void *arg, int pending);
 172 int mpssas_check_id(struct mpssas_softc *sassc, int id);