drivers/message/fusion/mptsas.h

   1 /*
   2  *  linux/drivers/message/fusion/mptsas.h
   3  *      High performance SCSI + LAN / Fibre Channel device drivers.
   4  *      For use with PCI chip/adapter(s):
   5  *          LSIFC9xx/LSI409xx Fibre Channel
   6  *      running LSI MPT (Message Passing Technology) firmware.
   7  *
   8  *  Copyright (c) 1999-2008 LSI Corporation
   9  *  (mailto:DL-MPTFusionLinux@lsi.com)
  10  *
  11  */
  12 /*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  13 /*
  14     This program is free software; you can redistribute it and/or modify
  15     it under the terms of the GNU General Public License as published by
  16     the Free Software Foundation; version 2 of the License.
  17
  18     This program is distributed in the hope that it will be useful,
  19     but WITHOUT ANY WARRANTY; without even the implied warranty of
  20     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21     GNU General Public License for more details.
  22
  23     NO WARRANTY
  24     THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
  25     CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
  26     LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
  27     MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
  28     solely responsible for determining the appropriateness of using and
  29     distributing the Program and assumes all risks associated with its
  30     exercise of rights under this Agreement, including but not limited to
  31     the risks and costs of program errors, damage to or loss of data,
  32     programs or equipment, and unavailability or interruption of operations.
  33
  34     DISCLAIMER OF LIABILITY
  35     NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
  36     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37     DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
  38     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  39     TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  40     USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
  41     HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
  42
  43     You should have received a copy of the GNU General Public License
  44     along with this program; if not, write to the Free Software
  45     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  46 */
  47
  48 #ifndef MPTSAS_H_INCLUDED
  49 #define MPTSAS_H_INCLUDED
  50 /*{-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  51
  52 struct mptsas_target_reset_event {
  53         struct list_head        list;
  54         EVENT_DATA_SAS_DEVICE_STATUS_CHANGE sas_event_data;
  55         u8      target_reset_issued;
  56         unsigned long    time_count;
  57 };
  58
  59 enum mptsas_hotplug_action {
  60         MPTSAS_ADD_DEVICE,
  61         MPTSAS_DEL_DEVICE,
  62         MPTSAS_ADD_RAID,
  63         MPTSAS_DEL_RAID,
  64         MPTSAS_ADD_PHYSDISK,
  65         MPTSAS_ADD_PHYSDISK_REPROBE,
  66         MPTSAS_DEL_PHYSDISK,
  67         MPTSAS_DEL_PHYSDISK_REPROBE,
  68         MPTSAS_ADD_INACTIVE_VOLUME,
  69         MPTSAS_IGNORE_EVENT,
  70 };
  71
  72 struct mptsas_mapping{
  73         u8                      id;
  74         u8                      channel;
  75 };
  76
  77 struct mptsas_device_info {
  78         struct list_head        list;
  79         struct mptsas_mapping   os;     /* operating system mapping*/
  80         struct mptsas_mapping   fw;     /* firmware mapping */
  81         u64                     sas_address;
  82         u32                     device_info; /* specific bits for devices */
  83         u16                     slot;           /* enclosure slot id */
  84         u64                     enclosure_logical_id; /*enclosure address */
  85         u8                      is_logical_volume; /* is this logical volume */
  86         /* this belongs to volume */
  87         u8                      is_hidden_raid_component;
  88         /* this valid when is_hidden_raid_component set */
  89         u8                      volume_id;
  90         /* cached data for a removed device */
  91         u8                      is_cached;
  92 };
  93
  94 struct mptsas_hotplug_event {
  95         MPT_ADAPTER             *ioc;
  96         enum mptsas_hotplug_action event_type;
  97         u64                     sas_address;
  98         u8                      channel;
  99         u8                      id;
 100         u32                     device_info;
 101         u16                     handle;
 102         u8                      phy_id;
 103         u8                      phys_disk_num;          /* hrc - unique index*/
 104         struct scsi_device      *sdev;
 105 };
 106
 107 struct fw_event_work {
 108         struct list_head        list;
 109         struct delayed_work      work;
 110         MPT_ADAPTER     *ioc;
 111         u32                     event;
 112         u8                      retries;
 113         u8                      __attribute__((aligned(4))) event_data[1];
 114 };
 115
 116 struct mptsas_discovery_event {
 117         struct work_struct      work;
 118         MPT_ADAPTER             *ioc;
 119 };
 120
 121 /*
 122  * SAS topology structures
 123  *
 124  * The MPT Fusion firmware interface spreads information about the
 125  * SAS topology over many manufacture pages, thus we need some data
 126  * structure to collect it and process it for the SAS transport class.
 127  */
 128
 129 struct mptsas_devinfo {
 130         u16     handle;         /* unique id to address this device */
 131         u16     handle_parent;  /* unique id to address parent device */
 132         u16     handle_enclosure; /* enclosure identifier of the enclosure */
 133         u16     slot;           /* physical slot in enclosure */
 134         u8      phy_id;         /* phy number of parent device */
 135         u8      port_id;        /* sas physical port this device
 136                                    is assoc'd with */
 137         u8      id;             /* logical target id of this device */
 138         u32     phys_disk_num;  /* phys disk id, for csmi-ioctls */
 139         u8      channel;        /* logical bus number of this device */
 140         u64     sas_address;    /* WWN of this device,
 141                                    SATA is assigned by HBA,expander */
 142         u32     device_info;    /* bitfield detailed info about this device */
 143 };
 144
 145 /*
 146  * Specific details on ports, wide/narrow
 147  */
 148 struct mptsas_portinfo_details{
 149         u16     num_phys;       /* number of phys belong to this port */
 150         u64     phy_bitmask;    /* TODO, extend support for 255 phys */
 151         struct sas_rphy *rphy;  /* transport layer rphy object */
 152         struct sas_port *port;  /* transport layer port object */
 153         struct scsi_target *starget;
 154         struct mptsas_portinfo *port_info;
 155 };
 156
 157 struct mptsas_phyinfo {
 158         u16     handle;                 /* unique id to address this */
 159         u8      phy_id;                 /* phy index */
 160         u8      port_id;                /* firmware port identifier */
 161         u8      negotiated_link_rate;   /* nego'd link rate for this phy */
 162         u8      hw_link_rate;           /* hardware max/min phys link rate */
 163         u8      programmed_link_rate;   /* programmed max/min phy link rate */
 164         u8      sas_port_add_phy;       /* flag to request sas_port_add_phy*/
 165         struct mptsas_devinfo identify; /* point to phy device info */
 166         struct mptsas_devinfo attached; /* point to attached device info */
 167         struct sas_phy *phy;            /* transport layer phy object */
 168         struct mptsas_portinfo *portinfo;
 169         struct mptsas_portinfo_details * port_details;
 170 };
 171
 172 struct mptsas_portinfo {
 173         struct list_head list;
 174         u16             num_phys;       /* number of phys */
 175         struct mptsas_phyinfo *phy_info;
 176 };
 177
 178 struct mptsas_enclosure {
 179         u64     enclosure_logical_id;   /* The WWN for the enclosure */
 180         u16     enclosure_handle;       /* unique id to address this */
 181         u16     flags;                  /* details enclosure management */
 182         u16     num_slot;               /* num slots */
 183         u16     start_slot;             /* first slot */
 184         u8      start_id;               /* starting logical target id */
 185         u8      start_channel;          /* starting logical channel id */
 186         u8      sep_id;                 /* SEP device logical target id */
 187         u8      sep_channel;            /* SEP channel logical channel id */
 188 };
 189
 190 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
 191 #endif