sys/dev/mpr/mpr_sas.h

   1 /*-
   2  * Copyright (c) 2011-2015 LSI Corp.
   3  * Copyright (c) 2013-2016 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 mpr_fw_event_work;
  33
  34 struct mprsas_lun {
  35         SLIST_ENTRY(mprsas_lun) lun_link;
  36         lun_id_t        lun_id;
  37         uint8_t         eedp_formatted;
  38         uint32_t        eedp_block_size;
  39 };
  40
  41 struct mprsas_target {
  42         uint16_t        handle;
  43         uint8_t         linkrate;
  44         uint8_t         encl_level_valid;
  45         uint8_t         encl_level;
  46         char            connector_name[4];
  47         uint64_t        devname;
  48         uint32_t        devinfo;
  49         uint16_t        encl_handle;
  50         uint16_t        encl_slot;
  51         uint8_t         flags;
  52 #define MPRSAS_TARGET_INABORT   (1 << 0)
  53 #define MPRSAS_TARGET_INRESET   (1 << 1)
  54 #define MPRSAS_TARGET_INDIAGRESET (1 << 2)
  55 #define MPRSAS_TARGET_INREMOVAL (1 << 3)
  56 #define MPR_TARGET_FLAGS_RAID_COMPONENT (1 << 4)
  57 #define MPR_TARGET_FLAGS_VOLUME         (1 << 5)
  58 #define MPR_TARGET_IS_SATA_SSD  (1 << 6)
  59 #define MPRSAS_TARGET_INRECOVERY (MPRSAS_TARGET_INABORT | \
  60     MPRSAS_TARGET_INRESET | MPRSAS_TARGET_INCHIPRESET)
  61
  62         uint16_t        tid;
  63         SLIST_HEAD(, mprsas_lun) luns;
  64         TAILQ_HEAD(, mpr_command) commands;
  65         struct mpr_command *tm;
  66         TAILQ_HEAD(, mpr_command) timedout_commands;
  67         uint16_t        exp_dev_handle;
  68         uint16_t        phy_num;
  69         uint64_t        sasaddr;
  70         uint16_t        parent_handle;
  71         uint64_t        parent_sasaddr;
  72         uint32_t        parent_devinfo;
  73         struct sysctl_ctx_list sysctl_ctx;
  74         struct sysctl_oid *sysctl_tree;
  75         TAILQ_ENTRY(mprsas_target) sysctl_link;
  76         uint64_t        issued;
  77         uint64_t        completed;
  78         unsigned int    outstanding;
  79         unsigned int    timeouts;
  80         unsigned int    aborts;
  81         unsigned int    logical_unit_resets;
  82         unsigned int    target_resets;
  83         uint8_t         scsi_req_desc_type;
  84         uint8_t         stop_at_shutdown;
  85         uint8_t         supports_SSU;
  86         uint8_t         is_nvme;
  87         uint32_t        MDTS;
  88 };
  89
  90 struct mprsas_softc {
  91         struct mpr_softc        *sc;
  92         u_int                   flags;
  93 #define MPRSAS_IN_DISCOVERY     (1 << 0)
  94 #define MPRSAS_IN_STARTUP       (1 << 1)
  95 #define MPRSAS_DISCOVERY_TIMEOUT_PENDING        (1 << 2)
  96 #define MPRSAS_QUEUE_FROZEN     (1 << 3)
  97 #define MPRSAS_SHUTDOWN         (1 << 4)
  98         u_int                   maxtargets;
  99         struct mprsas_target    *targets;
 100         struct cam_devq         *devq;
 101         struct cam_sim          *sim;
 102         struct cam_path         *path;
 103         struct intr_config_hook sas_ich;
 104         struct callout          discovery_callout;
 105         struct mpr_event_handle *mprsas_eh;
 106
 107         u_int                   startup_refcount;
 108         struct proc             *sysctl_proc;
 109
 110         struct taskqueue        *ev_tq;
 111         struct task             ev_task;
 112         TAILQ_HEAD(, mpr_fw_event_work) ev_queue;
 113 };
 114
 115 MALLOC_DECLARE(M_MPRSAS);
 116
 117 /*
 118  * Abstracted so that the driver can be backwards and forwards compatible
 119  * with future versions of CAM that will provide this functionality.
 120  */
 121 #define MPR_SET_LUN(lun, ccblun)        \
 122         mprsas_set_lun(lun, ccblun)
 123
 124 static __inline int
 125 mprsas_set_lun(uint8_t *lun, u_int ccblun)
 126 {
 127         uint64_t *newlun;
 128
 129         newlun = (uint64_t *)lun;
 130         *newlun = 0;
 131         if (ccblun <= 0xff) {
 132                 /* Peripheral device address method, LUN is 0 to 255 */
 133                 lun[1] = ccblun;
 134         } else if (ccblun <= 0x3fff) {
 135                 /* Flat space address method, LUN is <= 16383 */
 136                 scsi_ulto2b(ccblun, lun);
 137                 lun[0] |= 0x40;
 138         } else if (ccblun <= 0xffffff) {
 139                 /* Extended flat space address method, LUN is <= 16777215 */
 140                 scsi_ulto3b(ccblun, &lun[1]);
 141                 /* Extended Flat space address method */
 142                 lun[0] = 0xc0;
 143                 /* Length = 1, i.e. LUN is 3 bytes long */
 144                 lun[0] |= 0x10;
 145                 /* Extended Address Method */
 146                 lun[0] |= 0x02;
 147         } else {
 148                 return (EINVAL);
 149         }
 150
 151         return (0);
 152 }
 153
 154 static __inline void
 155 mprsas_set_ccbstatus(union ccb *ccb, int status)
 156 {
 157         ccb->ccb_h.status &= ~CAM_STATUS_MASK;
 158         ccb->ccb_h.status |= status;
 159 }
 160
 161 static __inline int
 162 mprsas_get_ccbstatus(union ccb *ccb)
 163 {
 164         return (ccb->ccb_h.status & CAM_STATUS_MASK);
 165 }
 166
 167 #define MPR_SET_SINGLE_LUN(req, lun)    \
 168 do {                                    \
 169         bzero((req)->LUN, 8);           \
 170         (req)->LUN[1] = lun;            \
 171 } while(0)
 172
 173 void mprsas_rescan_target(struct mpr_softc *sc, struct mprsas_target *targ);
 174 void mprsas_discovery_end(struct mprsas_softc *sassc);
 175 void mprsas_prepare_for_tm(struct mpr_softc *sc, struct mpr_command *tm,
 176     struct mprsas_target *target, lun_id_t lun_id);
 177 void mprsas_startup_increment(struct mprsas_softc *sassc);
 178 void mprsas_startup_decrement(struct mprsas_softc *sassc);
 179
 180 void mprsas_firmware_event_work(void *arg, int pending);
 181 int mprsas_check_id(struct mprsas_softc *sassc, int id);