isci: uplevel register hardware data structures and unsolicited frame handling
[linux-2.6.git] / drivers / scsi / isci / port.h
1 /*
2  * This file is provided under a dual BSD/GPLv2 license.  When using or
3  * redistributing this file, you may do so under either license.
4  *
5  * GPL LICENSE SUMMARY
6  *
7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21  * The full GNU General Public License is included in this distribution
22  * in the file called LICENSE.GPL.
23  *
24  * BSD LICENSE
25  *
26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27  * All rights reserved.
28  *
29  * Redistribution and use in source and binary forms, with or without
30  * modification, are permitted provided that the following conditions
31  * are met:
32  *
33  *   * Redistributions of source code must retain the above copyright
34  *     notice, this list of conditions and the following disclaimer.
35  *   * Redistributions in binary form must reproduce the above copyright
36  *     notice, this list of conditions and the following disclaimer in
37  *     the documentation and/or other materials provided with the
38  *     distribution.
39  *   * Neither the name of Intel Corporation nor the names of its
40  *     contributors may be used to endorse or promote products derived
41  *     from this software without specific prior written permission.
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54  */
55
56 #ifndef _ISCI_PORT_H_
57 #define _ISCI_PORT_H_
58
59 #include <scsi/libsas.h>
60 #include "isci.h"
61 #include "scic_sds_port.h"
62
63 struct isci_phy;
64 struct isci_host;
65
66 enum isci_status {
67         isci_freed        = 0x00,
68         isci_starting     = 0x01,
69         isci_ready        = 0x02,
70         isci_ready_for_io = 0x03,
71         isci_stopping     = 0x04,
72         isci_stopped      = 0x05,
73 };
74
75 /**
76  * struct isci_port - This class represents the port object used to internally
77  *    represent libsas port objects. It also keeps a list of remote device
78  *    objects.
79  *
80  *
81  */
82 struct isci_port {
83         enum isci_status status;
84         struct isci_host *isci_host;
85         struct asd_sas_port sas_port;
86         struct list_head remote_dev_list;
87         spinlock_t state_lock;
88         struct list_head domain_dev_list;
89         struct completion start_complete;
90         struct completion hard_reset_complete;
91         enum sci_status hard_reset_status;
92         struct scic_sds_port sci;
93 };
94
95 static inline struct isci_port *sci_port_to_iport(struct scic_sds_port *sci_port)
96 {
97         struct isci_port *iport = container_of(sci_port, typeof(*iport), sci);
98
99         return iport;
100 }
101
102 enum isci_status isci_port_get_state(
103         struct isci_port *isci_port);
104
105 void isci_port_formed(
106         struct asd_sas_phy *);
107
108 void isci_port_deformed(
109         struct asd_sas_phy *);
110
111 void isci_port_bc_change_received(
112         struct isci_host *isci_host,
113         struct scic_sds_port *port,
114         struct scic_sds_phy *phy);
115
116 void isci_port_link_up(
117         struct isci_host *isci_host,
118         struct scic_sds_port *port,
119         struct scic_sds_phy *phy);
120
121 void isci_port_link_down(
122         struct isci_host *isci_host,
123         struct isci_phy *isci_phy,
124         struct isci_port *port);
125
126 void isci_port_ready(
127         struct isci_host *isci_host,
128         struct isci_port *isci_port);
129
130 void isci_port_not_ready(
131         struct isci_host *isci_host,
132         struct isci_port *port);
133
134 void isci_port_init(
135         struct isci_port *port,
136         struct isci_host *host,
137         int index);
138
139 void isci_port_hard_reset_complete(
140         struct isci_port *isci_port,
141         enum sci_status completion_status);
142
143 int isci_port_perform_hard_reset(struct isci_host *ihost, struct isci_port *iport,
144                                  struct isci_phy *iphy);
145
146 void isci_port_stop_complete(
147                 struct scic_sds_controller *scic,
148                 struct scic_sds_port *sci_port,
149                 enum sci_status completion_status);
150
151 #endif /* !defined(_ISCI_PORT_H_) */
152