blob: b01b0c63e53f9802b30159e1491d5ac1e2af2cb1 [file] [log] [blame]
Dan Williams6f231dd2011-07-02 22:56:22 -07001/*
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
65struct isci_phy;
66struct isci_host;
67
68
69enum 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 isci_host_quiesce = 0x06
77};
78
79/**
80 * struct isci_port - This class represents the port object used to internally
81 * represent libsas port objects. It also keeps a list of remote device
82 * objects.
83 *
84 *
85 */
86struct isci_port {
87
88 struct scic_sds_port *sci_port_handle;
89
90 enum isci_status status;
91 struct isci_host *isci_host;
92 struct asd_sas_port sas_port;
93 struct list_head remote_dev_list;
94 spinlock_t remote_device_lock;
95 spinlock_t state_lock;
96 struct list_head domain_dev_list;
97 struct completion start_complete;
98 struct completion hard_reset_complete;
99 enum sci_status hard_reset_status;
100};
101
102#define to_isci_port(p) \
103 container_of(p, struct isci_port, sas_port);
104
105enum isci_status isci_port_get_state(
106 struct isci_port *isci_port);
107
108
109
110void isci_port_formed(
111 struct asd_sas_phy *);
112
113void isci_port_deformed(
114 struct asd_sas_phy *);
115
116void isci_port_bc_change_received(
117 struct isci_host *isci_host,
118 struct scic_sds_port *port,
119 struct scic_sds_phy *phy);
120
121void isci_port_link_up(
122 struct isci_host *isci_host,
123 struct scic_sds_port *port,
124 struct scic_sds_phy *phy);
125
126void isci_port_link_down(
127 struct isci_host *isci_host,
128 struct isci_phy *isci_phy,
129 struct isci_port *port);
130
131void isci_port_ready(
132 struct isci_host *isci_host,
133 struct isci_port *isci_port);
134
135void isci_port_not_ready(
136 struct isci_host *isci_host,
137 struct isci_port *port);
138
139void isci_port_init(
140 struct isci_port *port,
141 struct isci_host *host,
142 int index);
143
144void isci_port_hard_reset_complete(
145 struct isci_port *isci_port,
146 enum sci_status completion_status);
147
148int isci_port_perform_hard_reset(
149 struct isci_port *isci_port_ptr,
150 struct isci_phy *isci_phy_ptr);
151
152#endif /* !defined(_ISCI_PORT_H_) */
153