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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
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.
59 #include <scsi/libsas.h>
64 #define SCIC_SDS_DUMMY_PORT 0xFF
73 isci_ready_for_io
= 0x03,
79 * struct scic_sds_port
81 * The core port object provides the the abstraction for an SCU port.
83 struct scic_sds_port
{
85 * This field contains the information for the base port state machine.
87 struct sci_base_state_machine state_machine
;
92 * This field is the port index that is reported to the SCI USER.
93 * This allows the actual hardware physical port to change without
94 * the SCI USER getting a different answer for the get port index.
96 u8 logical_port_index
;
99 * This field is the port index used to program the SCU hardware.
101 u8 physical_port_index
;
104 * This field contains the active phy mask for the port.
105 * This mask is used in conjunction with the phy state to determine
106 * which phy to select for some port operations.
114 * This field contains the count of the io requests started on this port
115 * object. It is used to control controller shutdown.
117 u32 started_request_count
;
120 * This field contains the number of devices assigned to this port.
121 * It is used to control port start requests.
123 u32 assigned_device_count
;
126 * This field contains the reason for the port not going ready. It is
127 * assigned in the state handlers and used in the state transition.
129 u32 not_ready_reason
;
132 * This field is the table of phys assigned to the port.
134 struct scic_sds_phy
*phy_table
[SCI_MAX_PHYS
];
137 * This field is a pointer back to the controller that owns this
140 struct scic_sds_controller
*owning_controller
;
143 * This field contains the port start/stop timer handle.
148 * This field points to the current set of state handlers for this port
149 * object. These state handlers are assigned at each enter state of
152 struct scic_sds_port_state_handler
*state_handlers
;
154 /* / Memory mapped hardware register space */
157 * This field is the pointer to the port task scheduler registers
158 * for the SCU hardware.
160 struct scu_port_task_scheduler_registers __iomem
161 *port_task_scheduler_registers
;
164 * This field is identical for all port objects and points to the port
165 * task scheduler group PE configuration registers.
166 * It is used to assign PEs to a port.
168 u32 __iomem
*port_pe_configuration_register
;
171 * This field is the VIIT register space for ths port object.
173 struct scu_viit_entry __iomem
*viit_registers
;
179 * struct isci_port - This class represents the port object used to internally
180 * represent libsas port objects. It also keeps a list of remote device
186 enum isci_status status
;
187 struct isci_host
*isci_host
;
188 struct asd_sas_port sas_port
;
189 struct list_head remote_dev_list
;
190 spinlock_t state_lock
;
191 struct list_head domain_dev_list
;
192 struct completion start_complete
;
193 struct completion hard_reset_complete
;
194 enum sci_status hard_reset_status
;
195 struct scic_sds_port sci
;
198 static inline struct isci_port
*sci_port_to_iport(struct scic_sds_port
*sci_port
)
200 struct isci_port
*iport
= container_of(sci_port
, typeof(*iport
), sci
);
205 enum scic_port_not_ready_reason_code
{
206 SCIC_PORT_NOT_READY_NO_ACTIVE_PHYS
,
207 SCIC_PORT_NOT_READY_HARD_RESET_REQUESTED
,
208 SCIC_PORT_NOT_READY_INVALID_PORT_CONFIGURATION
,
209 SCIC_PORT_NOT_READY_RECONFIGURING
,
211 SCIC_PORT_NOT_READY_REASON_CODE_MAX
214 struct scic_port_end_point_properties
{
215 struct sci_sas_address sas_address
;
216 struct scic_phy_proto protocols
;
219 struct scic_port_properties
{
221 struct scic_port_end_point_properties local
;
222 struct scic_port_end_point_properties remote
;
227 * enum scic_sds_port_states - This enumeration depicts all the states for the
228 * common port state machine.
232 enum scic_sds_port_states
{
234 * This state indicates that the port has successfully been stopped.
235 * In this state no new IO operations are permitted.
236 * This state is entered from the STOPPING state.
238 SCI_BASE_PORT_STATE_STOPPED
,
241 * This state indicates that the port is in the process of stopping.
242 * In this state no new IO operations are permitted, but existing IO
243 * operations are allowed to complete.
244 * This state is entered from the READY state.
246 SCI_BASE_PORT_STATE_STOPPING
,
249 * This state indicates the port is now ready. Thus, the user is
250 * able to perform IO operations on this port.
251 * This state is entered from the STARTING state.
253 SCI_BASE_PORT_STATE_READY
,
256 * The substate where the port is started and ready but has no
259 SCIC_SDS_PORT_READY_SUBSTATE_WAITING
,
262 * The substate where the port is started and ready and there is
263 * at least one phy operational.
265 SCIC_SDS_PORT_READY_SUBSTATE_OPERATIONAL
,
268 * The substate where the port is started and there was an
269 * add/remove phy event. This state is only used in Automatic
270 * Port Configuration Mode (APC)
272 SCIC_SDS_PORT_READY_SUBSTATE_CONFIGURING
,
275 * This state indicates the port is in the process of performing a hard
276 * reset. Thus, the user is unable to perform IO operations on this
278 * This state is entered from the READY state.
280 SCI_BASE_PORT_STATE_RESETTING
,
283 * This state indicates the port has failed a reset request. This state
284 * is entered when a port reset request times out.
285 * This state is entered from the RESETTING state.
287 SCI_BASE_PORT_STATE_FAILED
,
289 SCI_BASE_PORT_MAX_STATES
293 struct scic_sds_remote_device
;
294 struct scic_sds_request
;
296 typedef enum sci_status (*scic_sds_port_handler_t
)(struct scic_sds_port
*);
298 typedef enum sci_status (*scic_sds_port_phy_handler_t
)(struct scic_sds_port
*,
299 struct scic_sds_phy
*);
301 typedef enum sci_status (*scic_sds_port_reset_handler_t
)(struct scic_sds_port
*,
304 typedef enum sci_status (*scic_sds_port_event_handler_t
)(struct scic_sds_port
*, u32
);
306 typedef enum sci_status (*scic_sds_port_frame_handler_t
)(struct scic_sds_port
*, u32
);
308 typedef void (*scic_sds_port_link_handler_t
)(struct scic_sds_port
*, struct scic_sds_phy
*);
310 typedef enum sci_status (*scic_sds_port_io_request_handler_t
)(struct scic_sds_port
*,
311 struct scic_sds_remote_device
*,
312 struct scic_sds_request
*);
314 struct scic_sds_port_state_handler
{
316 * The stop_handler specifies the method invoked when a user
317 * attempts to stop a port.
319 scic_sds_port_handler_t stop_handler
;
322 * The destruct_handler specifies the method invoked when attempting to
325 scic_sds_port_handler_t destruct_handler
;
328 * The reset_handler specifies the method invoked when a user
329 * attempts to hard reset a port.
331 scic_sds_port_reset_handler_t reset_handler
;
334 * The add_phy_handler specifies the method invoked when a user
335 * attempts to add another phy into the port.
337 scic_sds_port_phy_handler_t add_phy_handler
;
340 * The remove_phy_handler specifies the method invoked when a user
341 * attempts to remove a phy from the port.
343 scic_sds_port_phy_handler_t remove_phy_handler
;
345 scic_sds_port_frame_handler_t frame_handler
;
346 scic_sds_port_event_handler_t event_handler
;
348 scic_sds_port_link_handler_t link_up_handler
;
349 scic_sds_port_link_handler_t link_down_handler
;
351 scic_sds_port_io_request_handler_t start_io_handler
;
352 scic_sds_port_io_request_handler_t complete_io_handler
;
357 * scic_sds_port_get_controller() -
359 * Helper macro to get the owning controller of this port
361 #define scic_sds_port_get_controller(this_port) \
362 ((this_port)->owning_controller)
365 * scic_sds_port_set_base_state_handlers() -
367 * This macro will change the state handlers to those of the specified state id
369 #define scic_sds_port_set_base_state_handlers(this_port, state_id) \
370 scic_sds_port_set_state_handlers(\
371 (this_port), &scic_sds_port_state_handler_table[(state_id)])
374 * scic_sds_port_set_state_handlers() -
376 * Helper macro to set the port object state handlers
378 #define scic_sds_port_set_state_handlers(this_port, handlers) \
379 ((this_port)->state_handlers = (handlers))
382 * scic_sds_port_get_index() -
384 * This macro returns the physical port index for this port object
386 #define scic_sds_port_get_index(this_port) \
387 ((this_port)->physical_port_index)
390 static inline void scic_sds_port_decrement_request_count(struct scic_sds_port
*sci_port
)
392 if (WARN_ONCE(sci_port
->started_request_count
== 0,
393 "%s: tried to decrement started_request_count past 0!?",
397 sci_port
->started_request_count
--;
400 #define scic_sds_port_active_phy(port, phy) \
401 (((port)->active_phy_mask & (1 << (phy)->phy_index)) != 0)
403 void scic_sds_port_construct(
404 struct scic_sds_port
*sci_port
,
406 struct scic_sds_controller
*scic
);
408 enum sci_status
scic_sds_port_initialize(
409 struct scic_sds_port
*sci_port
,
410 void __iomem
*port_task_scheduler_registers
,
411 void __iomem
*port_configuration_regsiter
,
412 void __iomem
*viit_registers
);
414 enum sci_status
scic_sds_port_start(struct scic_sds_port
*sci_port
);
416 enum sci_status
scic_sds_port_add_phy(
417 struct scic_sds_port
*sci_port
,
418 struct scic_sds_phy
*sci_phy
);
420 enum sci_status
scic_sds_port_remove_phy(
421 struct scic_sds_port
*sci_port
,
422 struct scic_sds_phy
*sci_phy
);
424 void scic_sds_port_setup_transports(
425 struct scic_sds_port
*sci_port
,
429 void scic_sds_port_deactivate_phy(
430 struct scic_sds_port
*sci_port
,
431 struct scic_sds_phy
*sci_phy
,
432 bool do_notify_user
);
434 bool scic_sds_port_link_detected(
435 struct scic_sds_port
*sci_port
,
436 struct scic_sds_phy
*sci_phy
);
438 void scic_sds_port_link_up(
439 struct scic_sds_port
*sci_port
,
440 struct scic_sds_phy
*sci_phy
);
442 void scic_sds_port_link_down(
443 struct scic_sds_port
*sci_port
,
444 struct scic_sds_phy
*sci_phy
);
446 enum sci_status
scic_sds_port_start_io(
447 struct scic_sds_port
*sci_port
,
448 struct scic_sds_remote_device
*sci_dev
,
449 struct scic_sds_request
*sci_req
);
451 enum sci_status
scic_sds_port_complete_io(
452 struct scic_sds_port
*sci_port
,
453 struct scic_sds_remote_device
*sci_dev
,
454 struct scic_sds_request
*sci_req
);
456 enum sas_linkrate
scic_sds_port_get_max_allowed_speed(
457 struct scic_sds_port
*sci_port
);
459 void scic_sds_port_broadcast_change_received(
460 struct scic_sds_port
*sci_port
,
461 struct scic_sds_phy
*sci_phy
);
463 bool scic_sds_port_is_valid_phy_assignment(
464 struct scic_sds_port
*sci_port
,
467 void scic_sds_port_get_sas_address(
468 struct scic_sds_port
*sci_port
,
469 struct sci_sas_address
*sas_address
);
471 void scic_sds_port_get_attached_sas_address(
472 struct scic_sds_port
*sci_port
,
473 struct sci_sas_address
*sas_address
);
475 enum isci_status
isci_port_get_state(
476 struct isci_port
*isci_port
);
478 void isci_port_formed(struct asd_sas_phy
*);
479 void isci_port_deformed(struct asd_sas_phy
*);
482 struct isci_port
*port
,
483 struct isci_host
*host
,
486 int isci_port_perform_hard_reset(struct isci_host
*ihost
, struct isci_port
*iport
,
487 struct isci_phy
*iphy
);
488 #endif /* !defined(_ISCI_PORT_H_) */