drivers/scsi/hpsa.h

   1 /*
   2  *    Disk Array driver for HP Smart Array SAS controllers
   3  *    Copyright 2000, 2009 Hewlett-Packard Development Company, L.P.
   4  *
   5  *    This program is free software; you can redistribute it and/or modify
   6  *    it under the terms of the GNU General Public License as published by
   7  *    the Free Software Foundation; version 2 of the License.
   8  *
   9  *    This program is distributed in the hope that it will be useful,
  10  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  12  *    NON INFRINGEMENT.  See the GNU General Public License for more details.
  13  *
  14  *    You should have received a copy of the GNU General Public License
  15  *    along with this program; if not, write to the Free Software
  16  *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  *
  18  *    Questions/Comments/Bugfixes to iss_storagedev@hp.com
  19  *
  20  */
  21 #ifndef HPSA_H
  22 #define HPSA_H
  23
  24 #include <scsi/scsicam.h>
  25
  26 #define IO_OK           0
  27 #define IO_ERROR        1
  28
  29 struct ctlr_info;
  30
  31 struct access_method {
  32         void (*submit_command)(struct ctlr_info *h,
  33                 struct CommandList *c);
  34         void (*set_intr_mask)(struct ctlr_info *h, unsigned long val);
  35         unsigned long (*fifo_full)(struct ctlr_info *h);
  36         unsigned long (*intr_pending)(struct ctlr_info *h);
  37         unsigned long (*command_completed)(struct ctlr_info *h);
  38 };
  39
  40 struct hpsa_scsi_dev_t {
  41         int devtype;
  42         int bus, target, lun;           /* as presented to the OS */
  43         unsigned char scsi3addr[8];     /* as presented to the HW */
  44 #define RAID_CTLR_LUNID "\0\0\0\0\0\0\0\0"
  45         unsigned char device_id[16];    /* from inquiry pg. 0x83 */
  46         unsigned char vendor[8];        /* bytes 8-15 of inquiry data */
  47         unsigned char model[16];        /* bytes 16-31 of inquiry data */
  48         unsigned char revision[4];      /* bytes 32-35 of inquiry data */
  49         unsigned char raid_level;       /* from inquiry page 0xC1 */
  50 };
  51
  52 struct ctlr_info {
  53         int     ctlr;
  54         char    devname[8];
  55         char    *product_name;
  56         char    firm_ver[4]; /* Firmware version */
  57         struct pci_dev *pdev;
  58         __u32   board_id;
  59         void __iomem *vaddr;
  60         unsigned long paddr;
  61         int     nr_cmds; /* Number of commands allowed on this controller */
  62         struct CfgTable __iomem *cfgtable;
  63         int     interrupts_enabled;
  64         int     major;
  65         int     max_commands;
  66         int     commands_outstanding;
  67         int     max_outstanding; /* Debug */
  68         int     usage_count;  /* number of opens all all minor devices */
  69 #       define DOORBELL_INT     0
  70 #       define PERF_MODE_INT    1
  71 #       define SIMPLE_MODE_INT  2
  72 #       define MEMQ_MODE_INT    3
  73         unsigned int intr[4];
  74         unsigned int msix_vector;
  75         unsigned int msi_vector;
  76         struct access_method access;
  77
  78         /* queue and queue Info */
  79         struct hlist_head reqQ;
  80         struct hlist_head cmpQ;
  81         unsigned int Qdepth;
  82         unsigned int maxQsinceinit;
  83         unsigned int maxSG;
  84         spinlock_t lock;
  85
  86         /* pointers to command and error info pool */
  87         struct CommandList      *cmd_pool;
  88         dma_addr_t              cmd_pool_dhandle;
  89         struct ErrorInfo        *errinfo_pool;
  90         dma_addr_t              errinfo_pool_dhandle;
  91         unsigned long           *cmd_pool_bits;
  92         int                     nr_allocs;
  93         int                     nr_frees;
  94
  95         struct Scsi_Host *scsi_host;
  96         spinlock_t devlock; /* to protect hba[ctlr]->dev[];  */
  97         int ndevices; /* number of used elements in .dev[] array. */
  98 #define HPSA_MAX_SCSI_DEVS_PER_HBA 256
  99         struct hpsa_scsi_dev_t *dev[HPSA_MAX_SCSI_DEVS_PER_HBA];
 100 };
 101 #define HPSA_ABORT_MSG 0
 102 #define HPSA_DEVICE_RESET_MSG 1
 103 #define HPSA_BUS_RESET_MSG 2
 104 #define HPSA_HOST_RESET_MSG 3
 105 #define HPSA_MSG_SEND_RETRY_LIMIT 10
 106 #define HPSA_MSG_SEND_RETRY_INTERVAL_SECS 1
 107
 108 /* Maximum time in seconds driver will wait for command completions
 109  * when polling before giving up.
 110  */
 111 #define HPSA_MAX_POLL_TIME_SECS (20)
 112
 113 /* During SCSI error recovery, HPSA_TUR_RETRY_LIMIT defines
 114  * how many times to retry TEST UNIT READY on a device
 115  * while waiting for it to become ready before giving up.
 116  * HPSA_MAX_WAIT_INTERVAL_SECS is the max wait interval
 117  * between sending TURs while waiting for a device
 118  * to become ready.
 119  */
 120 #define HPSA_TUR_RETRY_LIMIT (20)
 121 #define HPSA_MAX_WAIT_INTERVAL_SECS (30)
 122
 123 /* HPSA_BOARD_READY_WAIT_SECS is how long to wait for a board
 124  * to become ready, in seconds, before giving up on it.
 125  * HPSA_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
 126  * between polling the board to see if it is ready, in
 127  * milliseconds.  HPSA_BOARD_READY_POLL_INTERVAL and
 128  * HPSA_BOARD_READY_ITERATIONS are derived from those.
 129  */
 130 #define HPSA_BOARD_READY_WAIT_SECS (120)
 131 #define HPSA_BOARD_READY_POLL_INTERVAL_MSECS (100)
 132 #define HPSA_BOARD_READY_POLL_INTERVAL \
 133         ((HPSA_BOARD_READY_POLL_INTERVAL_MSECS * HZ) / 1000)
 134 #define HPSA_BOARD_READY_ITERATIONS \
 135         ((HPSA_BOARD_READY_WAIT_SECS * 1000) / \
 136                 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
 137 #define HPSA_POST_RESET_PAUSE (30 * HZ)
 138 #define HPSA_POST_RESET_NOOP_RETRIES (12)
 139
 140 /*  Defining the diffent access_menthods */
 141 /*
 142  * Memory mapped FIFO interface (SMART 53xx cards)
 143  */
 144 #define SA5_DOORBELL    0x20
 145 #define SA5_REQUEST_PORT_OFFSET 0x40
 146 #define SA5_REPLY_INTR_MASK_OFFSET      0x34
 147 #define SA5_REPLY_PORT_OFFSET           0x44
 148 #define SA5_INTR_STATUS         0x30
 149 #define SA5_SCRATCHPAD_OFFSET   0xB0
 150
 151 #define SA5_CTCFG_OFFSET        0xB4
 152 #define SA5_CTMEM_OFFSET        0xB8
 153
 154 #define SA5_INTR_OFF            0x08
 155 #define SA5B_INTR_OFF           0x04
 156 #define SA5_INTR_PENDING        0x08
 157 #define SA5B_INTR_PENDING       0x04
 158 #define FIFO_EMPTY              0xffffffff
 159 #define HPSA_FIRMWARE_READY     0xffff0000 /* value in scratchpad register */
 160
 161 #define HPSA_ERROR_BIT          0x02
 162 #define HPSA_TAG_CONTAINS_INDEX(tag) ((tag) & 0x04)
 163 #define HPSA_TAG_TO_INDEX(tag) ((tag) >> 3)
 164 #define HPSA_TAG_DISCARD_ERROR_BITS(tag) ((tag) & ~3)
 165
 166 #define HPSA_INTR_ON    1
 167 #define HPSA_INTR_OFF   0
 168 /*
 169         Send the command to the hardware
 170 */
 171 static void SA5_submit_command(struct ctlr_info *h,
 172         struct CommandList *c)
 173 {
 174 #ifdef HPSA_DEBUG
 175          printk(KERN_WARNING "hpsa: Sending %x - down to controller\n",
 176                 c->busaddr);
 177 #endif /* HPSA_DEBUG */
 178         writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
 179         h->commands_outstanding++;
 180         if (h->commands_outstanding > h->max_outstanding)
 181                 h->max_outstanding = h->commands_outstanding;
 182 }
 183
 184 /*
 185  *  This card is the opposite of the other cards.
 186  *   0 turns interrupts on...
 187  *   0x08 turns them off...
 188  */
 189 static void SA5_intr_mask(struct ctlr_info *h, unsigned long val)
 190 {
 191         if (val) { /* Turn interrupts on */
 192                 h->interrupts_enabled = 1;
 193                 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
 194         } else { /* Turn them off */
 195                 h->interrupts_enabled = 0;
 196                 writel(SA5_INTR_OFF,
 197                         h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
 198         }
 199 }
 200 /*
 201  *  Returns true if fifo is full.
 202  *
 203  */
 204 static unsigned long SA5_fifo_full(struct ctlr_info *h)
 205 {
 206         if (h->commands_outstanding >= h->max_commands)
 207                 return 1;
 208         else
 209                 return 0;
 210
 211 }
 212 /*
 213  *   returns value read from hardware.
 214  *     returns FIFO_EMPTY if there is nothing to read
 215  */
 216 static unsigned long SA5_completed(struct ctlr_info *h)
 217 {
 218         unsigned long register_value
 219                 = readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
 220
 221         if (register_value != FIFO_EMPTY)
 222                 h->commands_outstanding--;
 223
 224 #ifdef HPSA_DEBUG
 225         if (register_value != FIFO_EMPTY)
 226                 printk(KERN_INFO "hpsa:  Read %lx back from board\n",
 227                         register_value);
 228         else
 229                 printk(KERN_INFO "hpsa:  FIFO Empty read\n");
 230 #endif
 231
 232         return register_value;
 233 }
 234 /*
 235  *      Returns true if an interrupt is pending..
 236  */
 237 static unsigned long SA5_intr_pending(struct ctlr_info *h)
 238 {
 239         unsigned long register_value  =
 240                 readl(h->vaddr + SA5_INTR_STATUS);
 241 #ifdef HPSA_DEBUG
 242         printk(KERN_INFO "hpsa: intr_pending %lx\n", register_value);
 243 #endif  /* HPSA_DEBUG */
 244         if (register_value &  SA5_INTR_PENDING)
 245                 return  1;
 246         return 0 ;
 247 }
 248
 249
 250 static struct access_method SA5_access = {
 251         SA5_submit_command,
 252         SA5_intr_mask,
 253         SA5_fifo_full,
 254         SA5_intr_pending,
 255         SA5_completed,
 256 };
 257
 258 struct board_type {
 259         __u32   board_id;
 260         char    *product_name;
 261         struct access_method *access;
 262 };
 263
 264
 265 /* end of old hpsa_scsi.h file */
 266
 267 #endif /* HPSA_H */
 268