The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/raid/ciss/cissreg.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 2001 Michael Smith
    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  * 2. Redistributions in binary form must reproduce the above copyright
   11  *    notice, this list of conditions and the following disclaimer in the
   12  *    documentation and/or other materials provided with the distribution.
   13  *
   14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   24  * SUCH DAMAGE.
   25  *
   26  *      $FreeBSD: src/sys/dev/ciss/cissreg.h,v 1.21 2009/09/16 23:27:14 scottl Exp $
   27  */
   28 
   29 /*
   30  * Structure and I/O definitions for the Command Interface for SCSI-3 Support.
   31  *
   32  * Data in command CDBs are in big-endian format.  All other data is little-endian.
   33  * This header only supports little-endian hosts at this time.
   34  */
   35 
   36 union ciss_device_address
   37 {
   38     struct                              /* MODE_PERIPHERAL and MODE_MASK_PERIPHERAL */
   39     {
   40         u_int32_t       target:24;      /* SCSI target */
   41         u_int32_t       bus:6;          /* SCSI bus */
   42         u_int32_t       mode:2;         /* CISS_HDR_ADDRESS_MODE_* */
   43         u_int32_t       extra_address;  /* SCSI-3 level-2 and level-3 address bytes */
   44     } physical;
   45     struct                              /* MODE_LOGICAL */
   46     {
   47         u_int32_t       lun:30;         /* logical device ID */
   48         u_int32_t       mode:2;         /* CISS_HDR_ADDRESS_MODE_LOGICAL */
   49         u_int32_t       :32;            /* reserved */
   50     } logical;
   51     struct
   52     {
   53         u_int32_t       :30;
   54         u_int32_t       mode:2;
   55         u_int32_t       :32;
   56     } mode;
   57 };
   58 #define CISS_HDR_ADDRESS_MODE_PERIPHERAL        0x0
   59 #define CISS_HDR_ADDRESS_MODE_LOGICAL           0x1
   60 #define CISS_HDR_ADDRESS_MODE_MASK_PERIPHERAL   0x3
   61 
   62 #define CISS_EXTRA_MODE2(extra)         ((extra & 0xc0000000) >> 30)
   63 #define CISS_EXTRA_BUS2(extra)          ((extra & 0x3f000000) >> 24)
   64 #define CISS_EXTRA_TARGET2(extra)       ((extra & 0x00ff0000) >> 16)
   65 #define CISS_EXTRA_MODE3(extra)         ((extra & 0x0000c000) >> 14)
   66 #define CISS_EXTRA_BUS3(extra)          ((extra & 0x00003f00) >> 8)
   67 #define CISS_EXTRA_TARGET3(extra)       ((extra & 0x000000ff))
   68 
   69 struct ciss_header
   70 {
   71     u_int8_t    :8;                     /* reserved */
   72     u_int8_t    sg_in_list;             /* SG's in the command structure */
   73     u_int16_t   sg_total;               /* total count of SGs for this command */
   74     u_int32_t   host_tag;               /* host identifier, bits 0&1 must be clear */
   75 #define CISS_HDR_HOST_TAG_ERROR (1<<1)
   76     u_int32_t   host_tag_zeroes;        /* tag is 64 bits, but interface only supports 32 */
   77     union ciss_device_address address;
   78 } __packed;
   79 
   80 struct ciss_cdb
   81 {
   82     u_int8_t    cdb_length;             /* valid CDB bytes */
   83     u_int8_t    type:3;
   84 #define CISS_CDB_TYPE_COMMAND                   0
   85 #define CISS_CDB_TYPE_MESSAGE                   1
   86     u_int8_t    attribute:3;
   87 #define CISS_CDB_ATTRIBUTE_UNTAGGED             0
   88 #define CISS_CDB_ATTRIBUTE_SIMPLE               4
   89 #define CISS_CDB_ATTRIBUTE_HEAD_OF_QUEUE        5
   90 #define CISS_CDB_ATTRIBUTE_ORDERED              6
   91 #define CISS_CDB_ATTRIBUTE_AUTO_CONTINGENT      7
   92     u_int8_t    direction:2;
   93 #define CISS_CDB_DIRECTION_NONE                 0
   94 #define CISS_CDB_DIRECTION_WRITE                1
   95 #define CISS_CDB_DIRECTION_READ                 2
   96     u_int16_t   timeout;                /* seconds */
   97 #define CISS_CDB_BUFFER_SIZE    16
   98     u_int8_t    cdb[CISS_CDB_BUFFER_SIZE];
   99 } __packed;
  100 
  101 struct ciss_error_info_pointer
  102 {
  103     u_int64_t   error_info_address;     /* points to ciss_error_info structure */
  104     u_int32_t   error_info_length;
  105 } __packed;
  106 
  107 struct ciss_error_info
  108 {
  109     u_int8_t    scsi_status;
  110 #define CISS_SCSI_STATUS_GOOD                   0x00    /* these are scsi-standard values */
  111 #define CISS_SCSI_STATUS_CHECK_CONDITION        0x02
  112 #define CISS_SCSI_STATUS_CONDITION_MET          0x04
  113 #define CISS_SCSI_STATUS_BUSY                   0x08
  114 #define CISS_SCSI_STATUS_INDETERMINATE          0x10
  115 #define CISS_SCSI_STATUS_INDETERMINATE_CM       0x14
  116 #define CISS_SCSI_STATUS_RESERVATION_CONFLICT   0x18
  117 #define CISS_SCSI_STATUS_COMMAND_TERMINATED     0x22
  118 #define CISS_SCSI_STATUS_QUEUE_FULL             0x28
  119 #define CISS_SCSI_STATUS_ACA_ACTIVE             0x30
  120     u_int8_t    sense_length;
  121     u_int16_t   command_status;
  122 #define CISS_CMD_STATUS_SUCCESS                 0
  123 #define CISS_CMD_STATUS_TARGET_STATUS           1
  124 #define CISS_CMD_STATUS_DATA_UNDERRUN           2
  125 #define CISS_CMD_STATUS_DATA_OVERRUN            3
  126 #define CISS_CMD_STATUS_INVALID_COMMAND         4
  127 #define CISS_CMD_STATUS_PROTOCOL_ERROR          5
  128 #define CISS_CMD_STATUS_HARDWARE_ERROR          6
  129 #define CISS_CMD_STATUS_CONNECTION_LOST         7
  130 #define CISS_CMD_STATUS_ABORTED                 8
  131 #define CISS_CMD_STATUS_ABORT_FAILED            9
  132 #define CISS_CMD_STATUS_UNSOLICITED_ABORT       10
  133 #define CISS_CMD_STATUS_TIMEOUT                 11
  134 #define CISS_CMD_STATUS_UNABORTABLE             12
  135     u_int32_t   residual_count;
  136     union {
  137         struct {
  138             u_int8_t    res1[3];
  139             u_int8_t    type;
  140             u_int32_t   error_info;
  141         } __packed common_info;
  142         struct {
  143             u_int8_t    res1[2];
  144             u_int8_t    offense_size;
  145             u_int8_t    offense_offset;
  146             u_int32_t   offense_value;
  147         } __packed invalid_command;
  148     } additional_error_info;
  149     u_int8_t    sense_info[0];
  150 } __packed;
  151 
  152 struct ciss_sg_entry
  153 {
  154     u_int64_t   address;
  155 #define CISS_SG_ADDRESS_BITBUCKET       (~(u_int64_t)0)
  156     u_int32_t   length;
  157     u_int32_t   :31;
  158     u_int32_t   extension:1;            /* address points to another s/g chain */
  159 } __packed;
  160 
  161 struct ciss_command
  162 {
  163     struct ciss_header                  header;
  164     struct ciss_cdb                     cdb;
  165     struct ciss_error_info_pointer      error_info;
  166     struct ciss_sg_entry                sg[0];
  167 } __packed;
  168 
  169 #define CISS_OPCODE_REPORT_LOGICAL_LUNS         0xc2
  170 #define CISS_OPCODE_REPORT_PHYSICAL_LUNS        0xc3
  171 
  172 struct ciss_lun_report
  173 {
  174     u_int32_t   list_size;              /* big-endian */
  175     u_int32_t   :32;
  176     union ciss_device_address lun[0];
  177 } __packed;
  178 
  179 #define CISS_VPD_LOGICAL_DRIVE_GEOMETRY         0xc1
  180 struct ciss_ldrive_geometry
  181 {
  182     u_int8_t    periph_qualifier:3;
  183     u_int8_t    periph_devtype:5;
  184     u_int8_t    page_code;
  185     u_int8_t    res1;
  186     u_int8_t    page_length;
  187     u_int16_t   cylinders;              /* big-endian */
  188     u_int8_t    heads;
  189     u_int8_t    sectors;
  190     u_int8_t    fault_tolerance;
  191     u_int8_t    res2[3];
  192 } __attribute__ ((packed));
  193 
  194 struct ciss_report_cdb
  195 {
  196     u_int8_t    opcode;
  197     u_int8_t    reserved[5];
  198     u_int32_t   length;                 /* big-endian */
  199     u_int8_t    :8;
  200     u_int8_t    control;
  201 } __packed;
  202 
  203 /*
  204  * Note that it's not clear whether we have to set the detail field to
  205  * the tag of the command to be aborted, or the tag field in the command itself;
  206  * documentation conflicts on this.
  207  */
  208 #define CISS_OPCODE_MESSAGE_ABORT               0x00
  209 #define CISS_MESSAGE_ABORT_TASK                 0x00
  210 #define CISS_MESSAGE_ABORT_TASK_SET             0x01
  211 #define CISS_MESSAGE_ABORT_CLEAR_ACA            0x02
  212 #define CISS_MESSAGE_ABORT_CLEAR_TASK_SET       0x03
  213 
  214 #define CISS_OPCODE_MESSAGE_RESET               0x01
  215 #define CISS_MESSAGE_RESET_CONTROLLER           0x00
  216 #define CISS_MESSAGE_RESET_BUS                  0x01
  217 #define CISS_MESSAGE_RESET_TARGET               0x03
  218 #define CISS_MESSAGE_RESET_LOGICAL_UNIT         0x04
  219 
  220 #define CISS_OPCODE_MESSAGE_SCAN                0x02
  221 #define CISS_MESSAGE_SCAN_CONTROLLER            0x00
  222 #define CISS_MESSAGE_SCAN_BUS                   0x01
  223 #define CISS_MESSAGE_SCAN_TARGET                0x03
  224 #define CISS_MESSAGE_SCAN_LOGICAL_UNIT          0x04
  225 
  226 #define CISS_OPCODE_MESSAGE_NOP                 0x03
  227 
  228 struct ciss_message_cdb
  229 {
  230     u_int8_t    opcode;
  231     u_int8_t    type;
  232     u_int16_t   :16;
  233     u_int32_t   abort_tag;                                      /* XXX endianness? */
  234     u_int8_t    reserved[8];
  235 } __packed;
  236 
  237 /*
  238  * CISS vendor-specific commands/messages.
  239  *
  240  * Note that while messages and vendor-specific commands are
  241  * differentiated, they are handled in basically the same way and can
  242  * be considered to be basically the same thing, as long as the cdb
  243  * type field is set correctly.
  244  */
  245 #define CISS_OPCODE_READ                0xc0
  246 #define CISS_OPCODE_WRITE               0xc1
  247 #define CISS_COMMAND_NOTIFY_ON_EVENT    0xd0
  248 #define CISS_COMMAND_ABORT_NOTIFY       0xd1
  249 
  250 struct ciss_notify_cdb
  251 {
  252     u_int8_t    opcode;
  253     u_int8_t    command;
  254     u_int8_t    res1[2];
  255     u_int16_t   timeout;                /* seconds, little-endian */
  256     u_int8_t    res2;                   /* reserved */
  257     u_int8_t    synchronous:1;          /* return immediately */
  258     u_int8_t    ordered:1;              /* return events in recorded order */
  259     u_int8_t    seek_to_oldest:1;       /* reset read counter to oldest event */
  260     u_int8_t    new_only:1;             /* ignore any queued events */
  261     u_int8_t    :4;
  262     u_int32_t   length;                 /* must be 512, little-endian */
  263 #define CISS_NOTIFY_DATA_SIZE   512
  264     u_int8_t    control;
  265 } __packed;
  266 
  267 #define CISS_NOTIFY_NOTIFIER            0
  268 #define CISS_NOTIFY_NOTIFIER_STATUS             0
  269 #define CISS_NOTIFY_NOTIFIER_PROTOCOL           1
  270 
  271 #define CISS_NOTIFY_HOTPLUG             1
  272 #define CISS_NOTIFY_HOTPLUG_PHYSICAL            0
  273 #define CISS_NOTIFY_HOTPLUG_POWERSUPPLY         1
  274 #define CISS_NOTIFY_HOTPLUG_FAN                 2
  275 #define CISS_NOTIFY_HOTPLUG_POWER               3
  276 #define CISS_NOTIFY_HOTPLUG_REDUNDANT           4
  277 #define CISS_NOTIFY_HOTPLUG_NONDISK             5
  278 
  279 #define CISS_NOTIFY_HARDWARE            2
  280 #define CISS_NOTIFY_HARDWARE_CABLES             0
  281 #define CISS_NOTIFY_HARDWARE_MEMORY             1
  282 #define CISS_NOTIFY_HARDWARE_FAN                2
  283 #define CISS_NOTIFY_HARDWARE_VRM                3
  284 
  285 #define CISS_NOTIFY_ENVIRONMENT         3
  286 #define CISS_NOTIFY_ENVIRONMENT_TEMPERATURE     0
  287 #define CISS_NOTIFY_ENVIRONMENT_POWERSUPPLY     1
  288 #define CISS_NOTIFY_ENVIRONMENT_CHASSIS         2
  289 #define CISS_NOTIFY_ENVIRONMENT_POWER           3
  290 
  291 #define CISS_NOTIFY_PHYSICAL            4
  292 #define CISS_NOTIFY_PHYSICAL_STATE              0
  293 
  294 #define CISS_NOTIFY_LOGICAL             5
  295 #define CISS_NOTIFY_LOGICAL_STATUS              0
  296 #define CISS_NOTIFY_LOGICAL_ERROR               1
  297 #define CISS_NOTIFY_LOGICAL_SURFACE             2
  298 
  299 #define CISS_NOTIFY_REDUNDANT           6
  300 #define CISS_NOTIFY_REDUNDANT_STATUS            0
  301 
  302 #define CISS_NOTIFY_CISS                8
  303 #define CISS_NOTIFY_CISS_REDUNDANT_CHANGE       0
  304 #define CISS_NOTIFY_CISS_PATH_STATUS            1
  305 #define CISS_NOTIFY_CISS_HARDWARE_ERROR         2
  306 #define CISS_NOTIFY_CISS_LOGICAL                3
  307 
  308 struct ciss_notify_drive
  309 {
  310     u_int16_t   physical_drive_number;
  311     u_int8_t    configured_drive_flag;
  312     u_int8_t    spare_drive_flag;
  313     u_int8_t    big_physical_drive_number;
  314     u_int8_t    enclosure_bay_number;
  315 } __packed;
  316 
  317 struct ciss_notify_locator
  318 {
  319     u_int16_t   port;
  320     u_int16_t   id;
  321     u_int16_t   box;
  322 } __packed;
  323 
  324 struct ciss_notify_redundant_controller
  325 {
  326     u_int16_t   slot;
  327 } __packed;
  328 
  329 struct ciss_notify_logical_status
  330 {
  331     u_int16_t   logical_drive;
  332     u_int8_t    previous_state;
  333     u_int8_t    new_state;
  334     u_int8_t    spare_state;
  335 } __packed;
  336 
  337 struct ciss_notify_rebuild_aborted
  338 {
  339     u_int16_t   logical_drive;
  340     u_int8_t    replacement_drive;
  341     u_int8_t    error_drive;
  342     u_int8_t    big_replacement_drive;
  343     u_int8_t    big_error_drive;
  344 } __packed;
  345 
  346 struct ciss_notify_io_error
  347 {
  348     u_int16_t   logical_drive;
  349     u_int32_t   lba;
  350     u_int16_t   block_count;
  351     u_int8_t    command;
  352     u_int8_t    failure_bus;
  353     u_int8_t    failure_drive;
  354     u_int64_t   big_lba;
  355 } __packed;
  356 
  357 struct ciss_notify_consistency_completed
  358 {
  359     u_int16_t   logical_drive;
  360 } __packed;
  361 
  362 struct ciss_notify
  363 {
  364     u_int32_t   timestamp;              /* seconds since controller power-on */
  365     u_int16_t   class;
  366     u_int16_t   subclass;
  367     u_int16_t   detail;
  368     union
  369     {
  370         struct ciss_notify_drive                drive;
  371         struct ciss_notify_locator              location;
  372         struct ciss_notify_redundant_controller redundant_controller;
  373         struct ciss_notify_logical_status       logical_status;
  374         struct ciss_notify_rebuild_aborted      rebuild_aborted;
  375         struct ciss_notify_io_error             io_error;
  376         struct ciss_notify_consistency_completed consistency_completed;
  377         u_int8_t        data[64];
  378     } data;
  379     char        message[80];
  380     u_int32_t   tag;
  381     u_int16_t   date;
  382     u_int16_t   year;
  383     u_int32_t   time;
  384     u_int16_t   pre_power_up_time;
  385     union ciss_device_address   device;
  386     /* XXX pads to 512 bytes */
  387 } __packed;
  388 
  389 /*
  390  * CISS config table, which describes the controller's
  391  * supported interface(s) and capabilities.
  392  *
  393  * This is mapped directly via PCI.
  394  */
  395 struct ciss_config_table
  396 {
  397     char        signature[4];           /* "CISS" */
  398     u_int32_t   valence;
  399     u_int32_t   supported_methods;
  400 #define CISS_TRANSPORT_METHOD_READY     (1<<0)
  401 #define CISS_TRANSPORT_METHOD_SIMPLE    (1<<1)
  402 #define CISS_TRANSPORT_METHOD_PERF      (1<<2)
  403     u_int32_t   active_method;
  404     u_int32_t   requested_method;
  405     u_int32_t   command_physlimit;
  406     u_int32_t   interrupt_coalesce_delay;
  407     u_int32_t   interrupt_coalesce_count;
  408     u_int32_t   max_outstanding_commands;
  409     u_int32_t   bus_types;
  410 #define CISS_TRANSPORT_BUS_TYPE_ULTRA2  (1<<0)
  411 #define CISS_TRANSPORT_BUS_TYPE_ULTRA3  (1<<1)
  412 #define CISS_TRANSPORT_BUS_TYPE_FIBRE1  (1<<8)
  413 #define CISS_TRANSPORT_BUS_TYPE_FIBRE2  (1<<9)
  414     u_int32_t   transport_offset;
  415     char        server_name[16];
  416     u_int32_t   heartbeat;
  417     u_int32_t   host_driver;
  418 #define CISS_DRIVER_SUPPORT_UNIT_ATTENTION      (1<<0)
  419 #define CISS_DRIVER_QUICK_INIT                  (1<<1)
  420 #define CISS_DRIVER_INTERRUPT_ON_LOCKUP         (1<<2)
  421 #define CISS_DRIVER_SUPPORT_MIXED_Q_TAGS        (1<<3)
  422 #define CISS_DRIVER_HOST_IS_ALPHA               (1<<4)
  423 #define CISS_DRIVER_MULTI_LUN_SUPPORT           (1<<5)
  424 #define CISS_DRIVER_MESSAGE_REQUESTS_SUPPORTED  (1<<7)
  425 #define CISS_DRIVER_DAUGHTER_ATTACHED           (1<<8)
  426 #define CISS_DRIVER_SCSI_PREFETCH               (1<<9)
  427     u_int32_t   max_sg_length;          /* 31 in older firmware */
  428 } __packed;
  429 
  430 /*
  431  * Configuration table for the Performant transport.  Only 4 request queues
  432  * are mentioned in this table, though apparently up to 256 can exist.
  433  */
  434 struct ciss_perf_config {
  435     uint32_t    fetch_count[8];
  436 #define CISS_SG_FETCH_MAX       0
  437 #define CISS_SG_FETCH_1         1
  438 #define CISS_SG_FETCH_2         2
  439 #define CISS_SG_FETCH_4         3
  440 #define CISS_SG_FETCH_8         4
  441 #define CISS_SG_FETCH_16        5
  442 #define CISS_SG_FETCH_32        6
  443 #define CISS_SG_FETCH_NONE      7
  444     uint32_t    rq_size;
  445     uint32_t    rq_count;
  446     uint32_t    rq_bank_lo;
  447     uint32_t    rq_bank_hi;
  448     struct {
  449         uint32_t        rq_addr_lo;
  450         uint32_t        rq_addr_hi;
  451     } __packed rq[4];
  452 } __packed;
  453 
  454 /*
  455  * In a flagrant violation of what CISS seems to be meant to be about,
  456  * Compaq recycle a goodly portion of their previous generation's
  457  * command set (and all the legacy baggage related to a design
  458  * originally aimed at narrow SCSI) through the Array Controller Read
  459  * and Array Controller Write interface.
  460  *
  461  * Command ID values here can be looked up for in the
  462  * publically-available documentation for the older controllers; note
  463  * that the command layout is necessarily different to fit within the
  464  * CDB.
  465  */
  466 #define CISS_ARRAY_CONTROLLER_READ      0x26
  467 #define CISS_ARRAY_CONTROLLER_WRITE     0x27
  468 
  469 #define CISS_BMIC_ID_LDRIVE             0x10
  470 #define CISS_BMIC_ID_CTLR               0x11
  471 #define CISS_BMIC_ID_LSTATUS            0x12
  472 #define CISS_BMIC_ID_PDRIVE             0x15
  473 #define CISS_BMIC_BLINK_PDRIVE          0x16
  474 #define CISS_BMIC_SENSE_BLINK_PDRIVE    0x17
  475 #define CISS_BMIC_SOFT_RESET            0x40
  476 #define CISS_BMIC_FLUSH_CACHE           0xc2
  477 #define CISS_BMIC_ACCEPT_MEDIA          0xe0
  478 
  479 /*
  480  * When numbering drives, the original design assumed that
  481  * drives 0-7 are on the first SCSI bus, 8-15 on the second,
  482  * and so forth.  In order to handle modern SCSI configurations,
  483  * the MSB is set in the drive ID field, in which case the
  484  * modulus changes from 8 to the number of supported drives
  485  * per SCSI bus (as obtained from the ID_CTLR command).
  486  * This feature is referred to as BIG_MAP support, and we assume
  487  * that all CISS controllers support it.
  488  */
  489 
  490 #define CISS_BIG_MAP_ID(sc, bus, target)                \
  491         (0x80 |                                         \
  492          ((sc)->ciss_id->drives_per_scsi_bus * (bus)) | \
  493          (target))
  494 
  495 #define CISS_BIG_MAP_BUS(sc, id)                        \
  496         (((id) & 0x80) ? (((id) & ~0x80) / (sc)->ciss_id->drives_per_scsi_bus) : -1)
  497 
  498 #define CISS_BIG_MAP_TARGET(sc, id)                     \
  499         (((id) & 0x80) ? (((id) & ~0x80) % (sc)->ciss_id->drives_per_scsi_bus) : -1)
  500 
  501 #define CISS_BIG_MAP_ENTRIES    128     /* number of entries in a BIG_MAP */
  502 
  503 /*
  504  * In the device address of a logical volume, the bus number
  505  * is encoded into the logical lun volume number starting
  506  * at the second byte, with the first byte defining the
  507  * logical drive number.
  508  */
  509 #define CISS_LUN_TO_BUS(x)    (((x) >> 16) & 0xFF)
  510 #define CISS_LUN_TO_TARGET(x) ((x) & 0xFF)
  511 
  512 /*
  513  * BMIC CDB
  514  *
  515  * Note that the phys_drive/res1 field is nominally the 32-bit
  516  * "block number" field, but the only BMIC command(s) of interest
  517  * implemented overload the MSB (note big-endian format here)
  518  * to be the physical drive ID, so we define accordingly.
  519  */
  520 struct ciss_bmic_cdb {
  521     u_int8_t    opcode;
  522     u_int8_t    log_drive;
  523     u_int8_t    phys_drive;
  524     u_int8_t    res1[3];
  525     u_int8_t    bmic_opcode;
  526     u_int16_t   size;                   /* big-endian */
  527     u_int8_t    res2;
  528 } __packed;
  529 
  530 /*
  531  * BMIC command command/return structures.
  532  */
  533 
  534 /* CISS_BMIC_ID_LDRIVE */
  535 struct ciss_bmic_id_ldrive {
  536     u_int16_t   block_size;
  537     u_int32_t   blocks_available;
  538     u_int8_t    drive_parameter_table[16];      /* XXX define */
  539     u_int8_t    fault_tolerance;
  540 #define CISS_LDRIVE_RAID0       0
  541 #define CISS_LDRIVE_RAID4       1
  542 #define CISS_LDRIVE_RAID1       2
  543 #define CISS_LDRIVE_RAID5       3
  544 #define CISS_LDRIVE_RAID51      4
  545 #define CISS_LDRIVE_RAIDADG     5
  546     u_int8_t    res1;
  547     u_int8_t    bios_disable_flag;
  548     u_int8_t    res2;
  549     u_int32_t   logical_drive_identifier;
  550     char        logical_drive_label[64];
  551     u_int64_t   big_blocks_available;
  552     u_int8_t    res3[410];
  553 } __packed;
  554 
  555 /* CISS_BMIC_ID_LSTATUS */
  556 struct ciss_bmic_id_lstatus {
  557     u_int8_t    status;
  558 #define CISS_LSTATUS_OK                         0
  559 #define CISS_LSTATUS_FAILED                     1
  560 #define CISS_LSTATUS_NOT_CONFIGURED             2
  561 #define CISS_LSTATUS_INTERIM_RECOVERY           3
  562 #define CISS_LSTATUS_READY_RECOVERY             4
  563 #define CISS_LSTATUS_RECOVERING                 5
  564 #define CISS_LSTATUS_WRONG_PDRIVE               6
  565 #define CISS_LSTATUS_MISSING_PDRIVE             7
  566 #define CISS_LSTATUS_EXPANDING                  10
  567 #define CISS_LSTATUS_BECOMING_READY             11
  568 #define CISS_LSTATUS_QUEUED_FOR_EXPANSION       12
  569     u_int32_t   deprecated_drive_failure_map;
  570     u_int8_t    res1[416];
  571     u_int32_t   blocks_to_recover;
  572     u_int8_t    deprecated_drive_rebuilding;
  573     u_int16_t   deprecated_remap_count[32];
  574     u_int32_t   deprecated_replacement_map;
  575     u_int32_t   deprecated_active_spare_map;
  576     u_int8_t    spare_configured:1;
  577     u_int8_t    spare_rebuilding:1;
  578     u_int8_t    spare_rebuilt:1;
  579     u_int8_t    spare_failed:1;
  580     u_int8_t    spare_switched:1;
  581     u_int8_t    spare_available:1;
  582     u_int8_t    res2:2;
  583     u_int8_t    deprecated_spare_to_replace_map[32];
  584     u_int32_t   deprecated_replaced_marked_ok_map;
  585     u_int8_t    media_exchanged;
  586     u_int8_t    cache_failure;
  587     u_int8_t    expand_failure;
  588     u_int8_t    rebuild_read_failure:1;
  589     u_int8_t    rebuild_write_failure:1;
  590     u_int8_t    res3:6;
  591     u_int8_t    drive_failure_map[CISS_BIG_MAP_ENTRIES / 8];
  592     u_int16_t   remap_count[CISS_BIG_MAP_ENTRIES];
  593     u_int8_t    replacement_map[CISS_BIG_MAP_ENTRIES / 8];
  594     u_int8_t    active_spare_map[CISS_BIG_MAP_ENTRIES / 8];
  595     u_int8_t    spare_to_replace_map[CISS_BIG_MAP_ENTRIES];
  596     u_int8_t    replaced_marked_ok_map[CISS_BIG_MAP_ENTRIES / 8];
  597     u_int8_t    drive_rebuilding;
  598     u_int64_t   big_blocks_to_recover;
  599     u_int8_t    res4[28];
  600 } __packed;
  601 
  602 /* CISS_BMIC_ID_CTLR */
  603 struct ciss_bmic_id_table {
  604     u_int8_t    configured_logical_drives;
  605     u_int32_t   config_signature;
  606     char        running_firmware_revision[4];
  607     char        stored_firmware_revision[4];
  608     u_int8_t    hardware_revision;
  609     u_int8_t    res1[4];
  610     u_int32_t   deprecated_drive_present_map;
  611     u_int32_t   deprecated_external_drive_present_map;
  612     u_int32_t   board_id;
  613     u_int8_t    res2;
  614     u_int32_t   deprecated_non_disk_map;
  615     u_int8_t    res3[5];
  616     char        marketting_revision;
  617     u_int8_t    res4:3;
  618     u_int8_t    more_than_seven_supported:1;
  619     u_int8_t    res5:3;
  620     u_int8_t    big_map_supported:1;            /* must be set! */
  621     u_int8_t    res6[2];
  622     u_int8_t    scsi_bus_count;
  623     u_int32_t   res7;
  624     u_int32_t   controller_clock;
  625     u_int8_t    drives_per_scsi_bus;
  626     u_int8_t    big_drive_present_map[CISS_BIG_MAP_ENTRIES / 8];
  627     u_int8_t    big_external_drive_present_map[CISS_BIG_MAP_ENTRIES / 8];
  628     u_int8_t    big_non_disk_map[CISS_BIG_MAP_ENTRIES / 8];
  629 } __packed;
  630 
  631 /* CISS_BMIC_ID_PDRIVE */
  632 struct ciss_bmic_id_pdrive {
  633     u_int8_t    scsi_bus;
  634     u_int8_t    scsi_id;
  635     u_int16_t   block_size;
  636     u_int32_t   total_blocks;
  637     u_int32_t   reserved_blocks;
  638     char        model[40];
  639     char        serial[40];
  640     char        revision[8];
  641     u_int8_t    inquiry_bits;
  642     u_int8_t    res1[2];
  643     u_int8_t    drive_present:1;
  644     u_int8_t    non_disk:1;
  645     u_int8_t    wide:1;
  646     u_int8_t    synchronous:1;
  647     u_int8_t    narrow:1;
  648     u_int8_t    wide_downgraded_to_narrow:1;
  649     u_int8_t    ultra:1;
  650     u_int8_t    ultra2:1;
  651     u_int8_t    SMART:1;
  652     u_int8_t    SMART_errors_recorded:1;
  653     u_int8_t    SMART_errors_enabled:1;
  654     u_int8_t    SMART_errors_detected:1;
  655     u_int8_t    external:1;
  656     u_int8_t    configured:1;
  657     u_int8_t    configured_spare:1;
  658     u_int8_t    cache_saved_enabled:1;
  659     u_int8_t    res2;
  660     u_int8_t    res3:6;
  661     u_int8_t    cache_currently_enabled:1;
  662     u_int8_t    cache_safe:1;
  663     u_int8_t    res4[5];
  664     char        connector[2];
  665     u_int8_t    res5;
  666     u_int8_t    bay;
  667     u_int16_t   rpm;
  668     u_int8_t    drive_type;
  669     u_int8_t    res6[393];
  670 } __packed;
  671 
  672 /* CISS_BMIC_BLINK_PDRIVE */
  673 /* CISS_BMIC_SENSE_BLINK_PDRIVE */
  674 struct ciss_bmic_blink_pdrive {
  675     u_int32_t   blink_duration;         /* 10ths of a second */
  676     u_int32_t   duration_elapsed;       /* only for sense command  */
  677     u_int8_t    blinktab[256];
  678 #define CISS_BMIC_BLINK_ALL     1
  679 #define CISS_BMIC_BLINK_TIMED   2
  680     u_int8_t    res2[248];
  681 } __packed;
  682 
  683 /* CISS_BMIC_FLUSH_CACHE */
  684 struct ciss_bmic_flush_cache {
  685     u_int16_t   flag;
  686 #define CISS_BMIC_FLUSH_AND_ENABLE      0
  687 #define CISS_BMIC_FLUSH_AND_DISABLE     1
  688     u_int8_t    res1[510];
  689 } __packed;
  690 
  691 #ifdef _KERNEL
  692 /*
  693  * CISS "simple" transport layer.
  694  *
  695  * Note that there are two slightly different versions of this interface
  696  * with different interrupt mask bits.  There's nothing like consistency...
  697  */
  698 #define CISS_TL_SIMPLE_BAR_REGS 0x10    /* BAR pointing to register space */
  699 #define CISS_TL_SIMPLE_BAR_CFG  0x14    /* BAR pointing to space containing config table */
  700 
  701 #define CISS_TL_SIMPLE_IDBR     0x20    /* inbound doorbell register */
  702 #define CISS_TL_SIMPLE_IDBR_CFG_TABLE   (1<<0)  /* notify controller of config table update */
  703 
  704 #define CISS_TL_SIMPLE_ISR      0x30    /* interrupt status register */
  705 #define CISS_TL_SIMPLE_IMR      0x34    /* interrupt mask register */
  706 #define CISS_TL_SIMPLE_INTR_OPQ_SA5     (1<<3)  /* OPQ not empty interrupt, SA5 boards */
  707 #define CISS_TL_SIMPLE_INTR_OPQ_SA5B    (1<<2)  /* OPQ not empty interrupt, SA5B boards */
  708 
  709 #define CISS_TL_SIMPLE_IPQ      0x40    /* inbound post queue */
  710 #define CISS_TL_SIMPLE_OPQ      0x44    /* outbound post queue */
  711 #define CISS_TL_SIMPLE_OPQ_EMPTY        (~(u_int32_t)0)
  712 
  713 #define CISS_TL_SIMPLE_OSR      0x9c    /* outbound status register */
  714 #define CISS_TL_SIMPLE_ODC      0xa0    /* outbound doorbell clear register */
  715 #define CISS_TL_SIMPLE_ODC_CLEAR        (0x1)
  716 
  717 #define CISS_TL_SIMPLE_CFG_BAR  0xb4    /* should be 0x14 */
  718 #define CISS_TL_SIMPLE_CFG_OFF  0xb8    /* offset in BAR at which config table is located */
  719 
  720 /*
  721  * Register access primitives.
  722  */
  723 #define CISS_TL_SIMPLE_READ(sc, ofs) \
  724         bus_space_read_4(sc->ciss_regs_btag, sc->ciss_regs_bhandle, ofs)
  725 #define CISS_TL_SIMPLE_WRITE(sc, ofs, val) \
  726         bus_space_write_4(sc->ciss_regs_btag, sc->ciss_regs_bhandle, ofs, val)
  727 
  728 #define CISS_TL_SIMPLE_POST_CMD(sc, phys)       CISS_TL_SIMPLE_WRITE(sc, CISS_TL_SIMPLE_IPQ, phys)
  729 #define CISS_TL_SIMPLE_FETCH_CMD(sc)            CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_OPQ)
  730 
  731 #define CISS_TL_PERF_INTR_OPQ   (CISS_TL_SIMPLE_INTR_OPQ_SA5 | CISS_TL_SIMPLE_INTR_OPQ_SA5B)
  732 #define CISS_TL_PERF_INTR_MSI   0x01
  733 
  734 #define CISS_TL_PERF_POST_CMD(sc, cr)           CISS_TL_SIMPLE_WRITE(sc, CISS_TL_SIMPLE_IPQ, cr->cr_ccphys | (cr)->cr_sg_tag)
  735 #define CISS_TL_PERF_FLUSH_INT(sc)              CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_OSR)
  736 #define CISS_TL_PERF_CLEAR_INT(sc)              CISS_TL_SIMPLE_WRITE(sc, CISS_TL_SIMPLE_ODC, CISS_TL_SIMPLE_ODC_CLEAR)
  737 #define CISS_CYCLE_MASK         0x00000001
  738 
  739 /* Only need one MSI/MSI-X vector */
  740 #define CISS_MSI_COUNT  1
  741 
  742 #define CISS_TL_SIMPLE_DISABLE_INTERRUPTS(sc) \
  743         CISS_TL_SIMPLE_WRITE(sc, CISS_TL_SIMPLE_IMR, \
  744                              CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_IMR) | (sc)->ciss_interrupt_mask)
  745 #define CISS_TL_SIMPLE_ENABLE_INTERRUPTS(sc) \
  746         CISS_TL_SIMPLE_WRITE(sc, CISS_TL_SIMPLE_IMR, \
  747                              CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_IMR) & ~(sc)->ciss_interrupt_mask)
  748 
  749 
  750 
  751 #endif /* _KERNEL */

Cache object: ce0b0aeccfaf17fee60e82eedec7449c


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.