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.
58 #include <scsi/sas_ata.h>
59 #include "remote_device.h"
62 #include "remote_node_table.h"
63 #include "registers.h"
64 #include "unsolicited_frame_control.h"
65 #include "probe_roms.h"
68 struct scu_task_context
;
72 * struct sci_power_control -
74 * This structure defines the fields for managing power control for direct
75 * attached disk devices.
77 struct sci_power_control
{
79 * This field is set when the power control timer is running and cleared when
85 * Timer to control when the directed attached disks can consume power.
87 struct sci_timer timer
;
90 * This field is used to keep track of how many phys are put into the
96 * This field is used to keep track of how many phys have been granted to consume power
98 u8 phys_granted_power
;
101 * This field is an array of phys that we are waiting on. The phys are direct
102 * mapped into requesters via struct sci_phy.phy_index
104 struct isci_phy
*requesters
[SCI_MAX_PHYS
];
108 struct sci_port_configuration_agent
;
109 typedef void (*port_config_fn
)(struct isci_host
*,
110 struct sci_port_configuration_agent
*,
111 struct isci_port
*, struct isci_phy
*);
112 bool is_port_config_apc(struct isci_host
*ihost
);
113 bool is_controller_start_complete(struct isci_host
*ihost
);
115 struct sci_port_configuration_agent
{
116 u16 phy_configured_mask
;
121 } phy_valid_port_range
[SCI_MAX_PHYS
];
123 port_config_fn link_up_handler
;
124 port_config_fn link_down_handler
;
125 struct sci_timer timer
;
129 * isci_host - primary host/controller object
130 * @timer: timeout start/stop operations
131 * @device_table: rni (hw remote node index) to remote device lookup table
132 * @available_remote_nodes: rni allocator
133 * @power_control: manage device spin up
134 * @io_request_sequence: generation number for tci's (task contexts)
135 * @task_context_table: hw task context table
136 * @remote_node_context_table: hw remote node context table
137 * @completion_queue: hw-producer driver-consumer communication ring
138 * @completion_queue_get: tracks the driver 'head' of the ring to notify hw
139 * @logical_port_entries: min({driver|silicon}-supported-port-count)
140 * @remote_node_entries: min({driver|silicon}-supported-node-count)
141 * @task_context_entries: min({driver|silicon}-supported-task-count)
142 * @phy_timer: phy startup timer
143 * @invalid_phy_mask: if an invalid_link_up notification is reported a bit for
144 * the phy index is set so further notifications are not
145 * made. Once the phy reports link up and is made part of a
146 * port then this bit is cleared.
150 struct sci_base_state_machine sm
;
151 /* XXX can we time this externally */
152 struct sci_timer timer
;
153 /* XXX drop reference module params directly */
154 struct sci_user_parameters user_parameters
;
155 /* XXX no need to be a union */
156 struct sci_oem_params oem_parameters
;
157 struct sci_port_configuration_agent port_agent
;
158 struct isci_remote_device
*device_table
[SCI_MAX_REMOTE_DEVICES
];
159 struct sci_remote_node_table available_remote_nodes
;
160 struct sci_power_control power_control
;
161 u8 io_request_sequence
[SCI_MAX_IO_REQUESTS
];
162 struct scu_task_context
*task_context_table
;
164 union scu_remote_node_context
*remote_node_context_table
;
166 u32
*completion_queue
;
168 u32 completion_queue_get
;
169 u32 logical_port_entries
;
170 u32 remote_node_entries
;
171 u32 task_context_entries
;
174 struct sci_unsolicited_frame_control uf_control
;
177 struct sci_timer phy_timer
;
179 bool phy_startup_timer_pending
;
180 u32 next_phy_to_start
;
181 /* XXX convert to unsigned long and use bitops */
184 /* TODO attempt dynamic interrupt coalescing scheme */
185 u16 interrupt_coalesce_number
;
186 u32 interrupt_coalesce_timeout
;
187 struct smu_registers __iomem
*smu_registers
;
188 struct scu_registers __iomem
*scu_registers
;
192 u16 tci_pool
[SCI_MAX_IO_REQUESTS
];
194 int id
; /* unique within a given pci device */
195 struct isci_phy phys
[SCI_MAX_PHYS
];
196 struct isci_port ports
[SCI_MAX_PORTS
+ 1]; /* includes dummy port */
197 struct asd_sas_port sas_ports
[SCI_MAX_PORTS
];
198 struct sas_ha_struct sas_ha
;
200 struct pci_dev
*pdev
;
201 #define IHOST_START_PENDING 0
202 #define IHOST_STOP_PENDING 1
203 #define IHOST_IRQ_ENABLED 2
205 wait_queue_head_t eventq
;
206 struct tasklet_struct completion_tasklet
;
207 struct list_head requests_to_complete
;
208 struct list_head requests_to_errorback
;
209 spinlock_t scic_lock
;
210 struct isci_request
*reqs
[SCI_MAX_IO_REQUESTS
];
211 struct isci_remote_device devices
[SCI_MAX_REMOTE_DEVICES
];
215 * enum sci_controller_states - This enumeration depicts all the states
216 * for the common controller state machine.
218 enum sci_controller_states
{
220 * Simply the initial state for the base controller state machine.
225 * This state indicates that the controller is reset. The memory for
226 * the controller is in it's initial state, but the controller requires
228 * This state is entered from the INITIAL state.
229 * This state is entered from the RESETTING state.
234 * This state is typically an action state that indicates the controller
235 * is in the process of initialization. In this state no new IO operations
237 * This state is entered from the RESET state.
242 * This state indicates that the controller has been successfully
243 * initialized. In this state no new IO operations are permitted.
244 * This state is entered from the INITIALIZING state.
249 * This state indicates the the controller is in the process of becoming
250 * ready (i.e. starting). In this state no new IO operations are permitted.
251 * This state is entered from the INITIALIZED state.
256 * This state indicates the controller is now ready. Thus, the user
257 * is able to perform IO operations on the controller.
258 * This state is entered from the STARTING state.
263 * This state is typically an action state that indicates the controller
264 * is in the process of resetting. Thus, the user is unable to perform
265 * IO operations on the controller. A reset is considered destructive in
267 * This state is entered from the READY state.
268 * This state is entered from the FAILED state.
269 * This state is entered from the STOPPED state.
274 * This state indicates that the controller is in the process of stopping.
275 * In this state no new IO operations are permitted, but existing IO
276 * operations are allowed to complete.
277 * This state is entered from the READY state.
282 * This state indicates that the controller could not successfully be
283 * initialized. In this state no new IO operations are permitted.
284 * This state is entered from the INITIALIZING state.
285 * This state is entered from the STARTING state.
286 * This state is entered from the STOPPING state.
287 * This state is entered from the RESETTING state.
293 * struct isci_pci_info - This class represents the pci function containing the
294 * controllers. Depending on PCI SKU, there could be up to 2 controllers in
297 #define SCI_MAX_MSIX_INT (SCI_NUM_MSI_X_INT*SCI_MAX_CONTROLLERS)
299 struct isci_pci_info
{
300 struct msix_entry msix_entries
[SCI_MAX_MSIX_INT
];
301 struct isci_host
*hosts
[SCI_MAX_CONTROLLERS
];
302 struct isci_orom
*orom
;
305 static inline struct isci_pci_info
*to_pci_info(struct pci_dev
*pdev
)
307 return pci_get_drvdata(pdev
);
310 static inline struct Scsi_Host
*to_shost(struct isci_host
*ihost
)
312 return ihost
->sas_ha
.core
.shost
;
315 #define for_each_isci_host(id, ihost, pdev) \
316 for (id = 0, ihost = to_pci_info(pdev)->hosts[id]; \
317 id < ARRAY_SIZE(to_pci_info(pdev)->hosts) && ihost; \
318 ihost = to_pci_info(pdev)->hosts[++id])
320 static inline void wait_for_start(struct isci_host
*ihost
)
322 wait_event(ihost
->eventq
, !test_bit(IHOST_START_PENDING
, &ihost
->flags
));
325 static inline void wait_for_stop(struct isci_host
*ihost
)
327 wait_event(ihost
->eventq
, !test_bit(IHOST_STOP_PENDING
, &ihost
->flags
));
330 static inline void wait_for_device_start(struct isci_host
*ihost
, struct isci_remote_device
*idev
)
332 wait_event(ihost
->eventq
, !test_bit(IDEV_START_PENDING
, &idev
->flags
));
335 static inline void wait_for_device_stop(struct isci_host
*ihost
, struct isci_remote_device
*idev
)
337 wait_event(ihost
->eventq
, !test_bit(IDEV_STOP_PENDING
, &idev
->flags
));
340 static inline struct isci_host
*dev_to_ihost(struct domain_device
*dev
)
342 return dev
->port
->ha
->lldd_ha
;
345 /* we always use protocol engine group zero */
348 /* see sci_controller_io_tag_allocate|free for how seq and tci are built */
349 #define ISCI_TAG(seq, tci) (((u16) (seq)) << 12 | tci)
351 /* these are returned by the hardware, so sanitize them */
352 #define ISCI_TAG_SEQ(tag) (((tag) >> 12) & (SCI_MAX_SEQ-1))
353 #define ISCI_TAG_TCI(tag) ((tag) & (SCI_MAX_IO_REQUESTS-1))
355 /* interrupt coalescing baseline: 9 == 3 to 5us interrupt delay per command */
356 #define ISCI_COALESCE_BASE 9
358 /* expander attached sata devices require 3 rnc slots */
359 static inline int sci_remote_device_node_count(struct isci_remote_device
*idev
)
361 struct domain_device
*dev
= idev
->domain_dev
;
363 if (dev_is_sata(dev
) && dev
->parent
)
364 return SCU_STP_REMOTE_NODE_COUNT
;
365 return SCU_SSP_REMOTE_NODE_COUNT
;
369 * sci_controller_clear_invalid_phy() -
371 * This macro will clear the bit in the invalid phy mask for this controller
372 * object. This is used to control messages reported for invalid link up
375 #define sci_controller_clear_invalid_phy(controller, phy) \
376 ((controller)->invalid_phy_mask &= ~(1 << (phy)->phy_index))
378 static inline struct device
*scirdev_to_dev(struct isci_remote_device
*idev
)
380 if (!idev
|| !idev
->isci_port
|| !idev
->isci_port
->isci_host
)
383 return &idev
->isci_port
->isci_host
->pdev
->dev
;
386 static inline bool is_a2(struct pci_dev
*pdev
)
388 if (pdev
->revision
< 4)
393 static inline bool is_b0(struct pci_dev
*pdev
)
395 if (pdev
->revision
== 4)
400 static inline bool is_c0(struct pci_dev
*pdev
)
402 if (pdev
->revision
== 5)
407 static inline bool is_c1(struct pci_dev
*pdev
)
409 if (pdev
->revision
>= 6)
414 enum cable_selections
{
421 #define CABLE_OVERRIDE_DISABLED (0x10000)
423 static inline int is_cable_select_overridden(void)
425 return cable_selection_override
< CABLE_OVERRIDE_DISABLED
;
428 enum cable_selections
decode_cable_selection(struct isci_host
*ihost
, int phy
);
429 void validate_cable_selections(struct isci_host
*ihost
);
430 char *lookup_cable_names(enum cable_selections
);
432 /* set hw control for 'activity', even though active enclosures seem to drive
433 * the activity led on their own. Skip setting FSENG control on 'status' due
434 * to unexpected operation and 'error' due to not being a supported automatic
437 #define SGPIO_HW_CONTROL 0x00000443
439 static inline int isci_gpio_count(struct isci_host
*ihost
)
441 return ARRAY_SIZE(ihost
->scu_registers
->peg0
.sgpio
.output_data_select
);
444 void sci_controller_post_request(struct isci_host
*ihost
,
446 void sci_controller_release_frame(struct isci_host
*ihost
,
448 void sci_controller_copy_sata_response(void *response_buffer
,
451 enum sci_status
sci_controller_allocate_remote_node_context(struct isci_host
*ihost
,
452 struct isci_remote_device
*idev
,
454 void sci_controller_free_remote_node_context(
455 struct isci_host
*ihost
,
456 struct isci_remote_device
*idev
,
459 struct isci_request
*sci_request_by_tag(struct isci_host
*ihost
, u16 io_tag
);
460 void sci_controller_power_control_queue_insert(struct isci_host
*ihost
,
461 struct isci_phy
*iphy
);
462 void sci_controller_power_control_queue_remove(struct isci_host
*ihost
,
463 struct isci_phy
*iphy
);
464 void sci_controller_link_up(struct isci_host
*ihost
, struct isci_port
*iport
,
465 struct isci_phy
*iphy
);
466 void sci_controller_link_down(struct isci_host
*ihost
, struct isci_port
*iport
,
467 struct isci_phy
*iphy
);
468 void sci_controller_remote_device_stopped(struct isci_host
*ihost
,
469 struct isci_remote_device
*idev
);
471 enum sci_status
sci_controller_continue_io(struct isci_request
*ireq
);
472 int isci_host_scan_finished(struct Scsi_Host
*, unsigned long);
473 void isci_host_scan_start(struct Scsi_Host
*);
474 u16
isci_alloc_tag(struct isci_host
*ihost
);
475 enum sci_status
isci_free_tag(struct isci_host
*ihost
, u16 io_tag
);
476 void isci_tci_free(struct isci_host
*ihost
, u16 tci
);
478 int isci_host_init(struct isci_host
*);
479 void isci_host_completion_routine(unsigned long data
);
480 void isci_host_deinit(struct isci_host
*);
481 void sci_controller_disable_interrupts(struct isci_host
*ihost
);
482 bool sci_controller_has_remote_devices_stopping(struct isci_host
*ihost
);
483 void sci_controller_transition_to_ready(struct isci_host
*ihost
, enum sci_status status
);
485 enum sci_status
sci_controller_start_io(
486 struct isci_host
*ihost
,
487 struct isci_remote_device
*idev
,
488 struct isci_request
*ireq
);
490 enum sci_task_status
sci_controller_start_task(
491 struct isci_host
*ihost
,
492 struct isci_remote_device
*idev
,
493 struct isci_request
*ireq
);
495 enum sci_status
sci_controller_terminate_request(
496 struct isci_host
*ihost
,
497 struct isci_remote_device
*idev
,
498 struct isci_request
*ireq
);
500 enum sci_status
sci_controller_complete_io(
501 struct isci_host
*ihost
,
502 struct isci_remote_device
*idev
,
503 struct isci_request
*ireq
);
505 void sci_port_configuration_agent_construct(
506 struct sci_port_configuration_agent
*port_agent
);
508 enum sci_status
sci_port_configuration_agent_initialize(
509 struct isci_host
*ihost
,
510 struct sci_port_configuration_agent
*port_agent
);
512 int isci_gpio_write(struct sas_ha_struct
*, u8 reg_type
, u8 reg_index
,
513 u8 reg_count
, u8
*write_data
);