xref: /linux/drivers/scsi/isci/port.h (revision 09d7da135b34bc74a7996b5db373521557ddf3d4)
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 /**
57  * This file contains the isci_port object definition.
58  *
59  * port.h
60  */
61 
62 #if !defined(_ISCI_PORT_H_)
63 #define _ISCI_PORT_H_
64 
65 struct isci_phy;
66 struct isci_host;
67 
68 
69 enum isci_status {
70 	isci_freed        = 0x00,
71 	isci_starting     = 0x01,
72 	isci_ready        = 0x02,
73 	isci_ready_for_io = 0x03,
74 	isci_stopping     = 0x04,
75 	isci_stopped      = 0x05,
76 };
77 
78 /**
79  * struct isci_port - This class represents the port object used to internally
80  *    represent libsas port objects. It also keeps a list of remote device
81  *    objects.
82  *
83  *
84  */
85 struct isci_port {
86 
87 	struct scic_sds_port *sci_port_handle;
88 
89 	enum isci_status status;
90 	struct isci_host *isci_host;
91 	struct asd_sas_port sas_port;
92 	struct list_head remote_dev_list;
93 	spinlock_t state_lock;
94 	struct list_head domain_dev_list;
95 	struct completion start_complete;
96 	struct completion hard_reset_complete;
97 	enum sci_status hard_reset_status;
98 };
99 
100 #define to_isci_port(p)	\
101 	container_of(p, struct isci_port, sas_port);
102 
103 enum isci_status isci_port_get_state(
104 	struct isci_port *isci_port);
105 
106 
107 
108 void isci_port_formed(
109 	struct asd_sas_phy *);
110 
111 void isci_port_deformed(
112 	struct asd_sas_phy *);
113 
114 void isci_port_bc_change_received(
115 	struct isci_host *isci_host,
116 	struct scic_sds_port *port,
117 	struct scic_sds_phy *phy);
118 
119 void isci_port_link_up(
120 	struct isci_host *isci_host,
121 	struct scic_sds_port *port,
122 	struct scic_sds_phy *phy);
123 
124 void isci_port_link_down(
125 	struct isci_host *isci_host,
126 	struct isci_phy *isci_phy,
127 	struct isci_port *port);
128 
129 void isci_port_ready(
130 	struct isci_host *isci_host,
131 	struct isci_port *isci_port);
132 
133 void isci_port_not_ready(
134 	struct isci_host *isci_host,
135 	struct isci_port *port);
136 
137 void isci_port_init(
138 	struct isci_port *port,
139 	struct isci_host *host,
140 	int index);
141 
142 void isci_port_hard_reset_complete(
143 	struct isci_port *isci_port,
144 	enum sci_status completion_status);
145 
146 int isci_port_perform_hard_reset(
147 	struct isci_port *isci_port_ptr,
148 	struct isci_phy *isci_phy_ptr);
149 
150 void isci_port_invalid_link_up(
151 		struct scic_sds_controller *scic,
152 		struct scic_sds_port *sci_port,
153 		struct scic_sds_phy *phy);
154 
155 void isci_port_stop_complete(
156 		struct scic_sds_controller *scic,
157 		struct scic_sds_port *sci_port,
158 		enum sci_status completion_status);
159 
160 #endif /* !defined(_ISCI_PORT_H_) */
161 
162