bf528a5b59b1470329d4374c888f981fa25dd9f6
[linux-2.6.git] / 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_INACTIVE_VOLUME,
65         MPTSAS_IGNORE_EVENT,
66 };
67
68 struct mptsas_hotplug_event {
69         struct work_struct      work;
70         MPT_ADAPTER             *ioc;
71         enum mptsas_hotplug_action event_type;
72         u64                     sas_address;
73         u8                      channel;
74         u8                      id;
75         u32                     device_info;
76         u16                     handle;
77         u16                     parent_handle;
78         u8                      phy_id;
79         u8                      phys_disk_num_valid;    /* hrc (hidden raid component) */
80         u8                      phys_disk_num;          /* hrc - unique index*/
81         u8                      hidden_raid_component;  /* hrc - don't expose*/
82 };
83
84 struct mptsas_discovery_event {
85         struct work_struct      work;
86         MPT_ADAPTER             *ioc;
87 };
88
89 /*
90  * SAS topology structures
91  *
92  * The MPT Fusion firmware interface spreads information about the
93  * SAS topology over many manufacture pages, thus we need some data
94  * structure to collect it and process it for the SAS transport class.
95  */
96
97 struct mptsas_devinfo {
98         u16     handle;         /* unique id to address this device */
99         u16     handle_parent;  /* unique id to address parent device */
100         u16     handle_enclosure; /* enclosure identifier of the enclosure */
101         u16     slot;           /* physical slot in enclosure */
102         u8      phy_id;         /* phy number of parent device */
103         u8      port_id;        /* sas physical port this device
104                                    is assoc'd with */
105         u8      id;             /* logical target id of this device */
106         u32     phys_disk_num;  /* phys disk id, for csmi-ioctls */
107         u8      channel;        /* logical bus number of this device */
108         u64     sas_address;    /* WWN of this device,
109                                    SATA is assigned by HBA,expander */
110         u32     device_info;    /* bitfield detailed info about this device */
111 };
112
113 /*
114  * Specific details on ports, wide/narrow
115  */
116 struct mptsas_portinfo_details{
117         u16     num_phys;       /* number of phys belong to this port */
118         u64     phy_bitmask;    /* TODO, extend support for 255 phys */
119         struct sas_rphy *rphy;  /* transport layer rphy object */
120         struct sas_port *port;  /* transport layer port object */
121         struct scsi_target *starget;
122         struct mptsas_portinfo *port_info;
123 };
124
125 struct mptsas_phyinfo {
126         u16     handle;                 /* unique id to address this */
127         u8      phy_id;                 /* phy index */
128         u8      port_id;                /* firmware port identifier */
129         u8      negotiated_link_rate;   /* nego'd link rate for this phy */
130         u8      hw_link_rate;           /* hardware max/min phys link rate */
131         u8      programmed_link_rate;   /* programmed max/min phy link rate */
132         u8      sas_port_add_phy;       /* flag to request sas_port_add_phy*/
133         struct mptsas_devinfo identify; /* point to phy device info */
134         struct mptsas_devinfo attached; /* point to attached device info */
135         struct sas_phy *phy;            /* transport layer phy object */
136         struct mptsas_portinfo *portinfo;
137         struct mptsas_portinfo_details * port_details;
138 };
139
140 struct mptsas_portinfo {
141         struct list_head list;
142         u16             num_phys;       /* number of phys */
143         struct mptsas_phyinfo *phy_info;
144 };
145
146 struct mptsas_enclosure {
147         u64     enclosure_logical_id;   /* The WWN for the enclosure */
148         u16     enclosure_handle;       /* unique id to address this */
149         u16     flags;                  /* details enclosure management */
150         u16     num_slot;               /* num slots */
151         u16     start_slot;             /* first slot */
152         u8      start_id;               /* starting logical target id */
153         u8      start_channel;          /* starting logical channel id */
154         u8      sep_id;                 /* SEP device logical target id */
155         u8      sep_channel;            /* SEP channel logical channel id */
156 };
157
158 /*}-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
159 #endif