blob: 22a9bb1abae1473062b06031494bb38b2cc11576 [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 */
Dan Williamsce2b3262011-05-08 15:49:15 -070055#ifndef _SCI_HOST_H_
Dan Williams6f231dd2011-07-02 22:56:22 -070056#define _SCI_HOST_H_
57
Dan Williams11cc5182012-02-01 00:23:10 -080058#include <scsi/sas_ata.h>
Dan Williams6f231dd2011-07-02 22:56:22 -070059#include "remote_device.h"
Dan Williamsce2b3262011-05-08 15:49:15 -070060#include "phy.h"
Edmund Nadolski12ef6542011-06-02 00:10:50 +000061#include "isci.h"
Dan Williamscc9203b2011-05-08 17:34:44 -070062#include "remote_node_table.h"
Dan Williams63a3a152011-05-08 21:36:46 -070063#include "registers.h"
Dan Williams63a3a152011-05-08 21:36:46 -070064#include "unsolicited_frame_control.h"
Dan Williamse2f8db52011-05-10 02:28:46 -070065#include "probe_roms.h"
Dan Williamscc9203b2011-05-08 17:34:44 -070066
Dan Williams5076a1a2011-06-27 14:57:03 -070067struct isci_request;
Dan Williamscc9203b2011-05-08 17:34:44 -070068struct scu_task_context;
69
Dan Williamse2f8db52011-05-10 02:28:46 -070070
Dan Williamscc9203b2011-05-08 17:34:44 -070071/**
Dan Williams89a73012011-06-30 19:14:33 -070072 * struct sci_power_control -
Dan Williamscc9203b2011-05-08 17:34:44 -070073 *
74 * This structure defines the fields for managing power control for direct
75 * attached disk devices.
76 */
Dan Williams89a73012011-06-30 19:14:33 -070077struct sci_power_control {
Dan Williamscc9203b2011-05-08 17:34:44 -070078 /**
79 * This field is set when the power control timer is running and cleared when
80 * it is not.
81 */
82 bool timer_started;
83
84 /**
Edmund Nadolski04736612011-05-19 20:17:47 -070085 * Timer to control when the directed attached disks can consume power.
Dan Williamscc9203b2011-05-08 17:34:44 -070086 */
Edmund Nadolski04736612011-05-19 20:17:47 -070087 struct sci_timer timer;
Dan Williamscc9203b2011-05-08 17:34:44 -070088
89 /**
90 * This field is used to keep track of how many phys are put into the
91 * requesters field.
92 */
93 u8 phys_waiting;
94
95 /**
96 * This field is used to keep track of how many phys have been granted to consume power
97 */
98 u8 phys_granted_power;
99
100 /**
101 * This field is an array of phys that we are waiting on. The phys are direct
Dan Williams89a73012011-06-30 19:14:33 -0700102 * mapped into requesters via struct sci_phy.phy_index
Dan Williamscc9203b2011-05-08 17:34:44 -0700103 */
Dan Williams85280952011-06-28 15:05:53 -0700104 struct isci_phy *requesters[SCI_MAX_PHYS];
Dan Williamscc9203b2011-05-08 17:34:44 -0700105
106};
107
Dan Williams89a73012011-06-30 19:14:33 -0700108struct sci_port_configuration_agent;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700109typedef void (*port_config_fn)(struct isci_host *,
Dan Williams89a73012011-06-30 19:14:33 -0700110 struct sci_port_configuration_agent *,
Dan Williamsffe191c2011-06-29 13:09:25 -0700111 struct isci_port *, struct isci_phy *);
Dan Williams50a92d92012-02-29 01:07:56 -0800112bool is_port_config_apc(struct isci_host *ihost);
113bool is_controller_start_complete(struct isci_host *ihost);
Dan Williamse2f8db52011-05-10 02:28:46 -0700114
Dan Williams89a73012011-06-30 19:14:33 -0700115struct sci_port_configuration_agent {
Dan Williamse2f8db52011-05-10 02:28:46 -0700116 u16 phy_configured_mask;
117 u16 phy_ready_mask;
118 struct {
119 u8 min_index;
120 u8 max_index;
121 } phy_valid_port_range[SCI_MAX_PHYS];
122 bool timer_pending;
123 port_config_fn link_up_handler;
124 port_config_fn link_down_handler;
Edmund Nadolskiac0eeb42011-05-19 20:00:51 -0700125 struct sci_timer timer;
Dan Williamse2f8db52011-05-10 02:28:46 -0700126};
127
Dan Williamscc9203b2011-05-08 17:34:44 -0700128/**
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700129 * 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.
147
Dan Williamscc9203b2011-05-08 17:34:44 -0700148 */
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700149struct isci_host {
Edmund Nadolskie3013702011-06-02 00:10:43 +0000150 struct sci_base_state_machine sm;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700151 /* XXX can we time this externally */
Edmund Nadolski6cb58532011-05-19 11:59:56 +0000152 struct sci_timer timer;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700153 /* XXX drop reference module params directly */
Dan Williams89a73012011-06-30 19:14:33 -0700154 struct sci_user_parameters user_parameters;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700155 /* XXX no need to be a union */
Dan Williams89a73012011-06-30 19:14:33 -0700156 struct sci_oem_params oem_parameters;
157 struct sci_port_configuration_agent port_agent;
Dan Williams78a6f062011-06-30 16:31:37 -0700158 struct isci_remote_device *device_table[SCI_MAX_REMOTE_DEVICES];
Dan Williams89a73012011-06-30 19:14:33 -0700159 struct sci_remote_node_table available_remote_nodes;
160 struct sci_power_control power_control;
Dan Williamsdd047c82011-06-09 11:06:58 -0700161 u8 io_request_sequence[SCI_MAX_IO_REQUESTS];
Dan Williamscc9203b2011-05-08 17:34:44 -0700162 struct scu_task_context *task_context_table;
Dan Williamsabec9122012-02-15 13:58:42 -0800163 dma_addr_t tc_dma;
Dan Williamscc9203b2011-05-08 17:34:44 -0700164 union scu_remote_node_context *remote_node_context_table;
Dan Williamsabec9122012-02-15 13:58:42 -0800165 dma_addr_t rnc_dma;
Dan Williamscc9203b2011-05-08 17:34:44 -0700166 u32 *completion_queue;
Dan Williamsabec9122012-02-15 13:58:42 -0800167 dma_addr_t cq_dma;
Dan Williamscc9203b2011-05-08 17:34:44 -0700168 u32 completion_queue_get;
Dan Williamscc9203b2011-05-08 17:34:44 -0700169 u32 logical_port_entries;
Dan Williamscc9203b2011-05-08 17:34:44 -0700170 u32 remote_node_entries;
Dan Williamscc9203b2011-05-08 17:34:44 -0700171 u32 task_context_entries;
Dan Williamsabec9122012-02-15 13:58:42 -0800172 void *ufi_buf;
173 dma_addr_t ufi_dma;
Dan Williams89a73012011-06-30 19:14:33 -0700174 struct sci_unsolicited_frame_control uf_control;
Dan Williamscc9203b2011-05-08 17:34:44 -0700175
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700176 /* phy startup */
Edmund Nadolskibb3dbdf2011-05-19 20:26:02 -0700177 struct sci_timer phy_timer;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700178 /* XXX kill */
Dan Williamscc9203b2011-05-08 17:34:44 -0700179 bool phy_startup_timer_pending;
Dan Williamscc9203b2011-05-08 17:34:44 -0700180 u32 next_phy_to_start;
Dan Williams34a99152011-07-01 02:25:15 -0700181 /* XXX convert to unsigned long and use bitops */
Dan Williamscc9203b2011-05-08 17:34:44 -0700182 u8 invalid_phy_mask;
183
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700184 /* TODO attempt dynamic interrupt coalescing scheme */
Dan Williamscc9203b2011-05-08 17:34:44 -0700185 u16 interrupt_coalesce_number;
Dan Williamscc9203b2011-05-08 17:34:44 -0700186 u32 interrupt_coalesce_timeout;
Dan Williamscc9203b2011-05-08 17:34:44 -0700187 struct smu_registers __iomem *smu_registers;
Dan Williamscc9203b2011-05-08 17:34:44 -0700188 struct scu_registers __iomem *scu_registers;
189
Dan Williamsac668c62011-06-07 18:50:55 -0700190 u16 tci_head;
191 u16 tci_tail;
192 u16 tci_pool[SCI_MAX_IO_REQUESTS];
193
Dan Williams6f231dd2011-07-02 22:56:22 -0700194 int id; /* unique within a given pci device */
Dan Williams6f231dd2011-07-02 22:56:22 -0700195 struct isci_phy phys[SCI_MAX_PHYS];
Dan Williamse5313812011-05-07 10:11:43 -0700196 struct isci_port ports[SCI_MAX_PORTS + 1]; /* includes dummy port */
Dan Williamsc132f692012-01-03 23:26:08 -0800197 struct asd_sas_port sas_ports[SCI_MAX_PORTS];
Dan Williams6f231dd2011-07-02 22:56:22 -0700198 struct sas_ha_struct sas_ha;
199
Dan Williams6f231dd2011-07-02 22:56:22 -0700200 struct pci_dev *pdev;
Dan Williams0cf89d12011-02-18 09:25:07 -0800201 #define IHOST_START_PENDING 0
202 #define IHOST_STOP_PENDING 1
Dan Williams2396a2652012-03-01 17:06:24 -0800203 #define IHOST_IRQ_ENABLED 2
Dan Williams0cf89d12011-02-18 09:25:07 -0800204 unsigned long flags;
205 wait_queue_head_t eventq;
Dan Williams6f231dd2011-07-02 22:56:22 -0700206 struct tasklet_struct completion_tasklet;
Dan Williams6f231dd2011-07-02 22:56:22 -0700207 spinlock_t scic_lock;
Dan Williamsdb056252011-06-17 14:18:39 -0700208 struct isci_request *reqs[SCI_MAX_IO_REQUESTS];
Dan Williams57f20f42011-04-21 18:14:45 -0700209 struct isci_remote_device devices[SCI_MAX_REMOTE_DEVICES];
Dan Williams6f231dd2011-07-02 22:56:22 -0700210};
211
Dan Williams6f231dd2011-07-02 22:56:22 -0700212/**
Dan Williams89a73012011-06-30 19:14:33 -0700213 * enum sci_controller_states - This enumeration depicts all the states
Dan Williamscc9203b2011-05-08 17:34:44 -0700214 * for the common controller state machine.
215 */
Dan Williams89a73012011-06-30 19:14:33 -0700216enum sci_controller_states {
Dan Williamscc9203b2011-05-08 17:34:44 -0700217 /**
218 * Simply the initial state for the base controller state machine.
219 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000220 SCIC_INITIAL = 0,
Dan Williamscc9203b2011-05-08 17:34:44 -0700221
222 /**
223 * This state indicates that the controller is reset. The memory for
224 * the controller is in it's initial state, but the controller requires
225 * initialization.
226 * This state is entered from the INITIAL state.
227 * This state is entered from the RESETTING state.
228 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000229 SCIC_RESET,
Dan Williamscc9203b2011-05-08 17:34:44 -0700230
231 /**
232 * This state is typically an action state that indicates the controller
233 * is in the process of initialization. In this state no new IO operations
234 * are permitted.
235 * This state is entered from the RESET state.
236 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000237 SCIC_INITIALIZING,
Dan Williamscc9203b2011-05-08 17:34:44 -0700238
239 /**
240 * This state indicates that the controller has been successfully
241 * initialized. In this state no new IO operations are permitted.
242 * This state is entered from the INITIALIZING state.
243 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000244 SCIC_INITIALIZED,
Dan Williamscc9203b2011-05-08 17:34:44 -0700245
246 /**
247 * This state indicates the the controller is in the process of becoming
248 * ready (i.e. starting). In this state no new IO operations are permitted.
249 * This state is entered from the INITIALIZED state.
250 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000251 SCIC_STARTING,
Dan Williamscc9203b2011-05-08 17:34:44 -0700252
253 /**
254 * This state indicates the controller is now ready. Thus, the user
255 * is able to perform IO operations on the controller.
256 * This state is entered from the STARTING state.
257 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000258 SCIC_READY,
Dan Williamscc9203b2011-05-08 17:34:44 -0700259
260 /**
261 * This state is typically an action state that indicates the controller
262 * is in the process of resetting. Thus, the user is unable to perform
263 * IO operations on the controller. A reset is considered destructive in
264 * most cases.
265 * This state is entered from the READY state.
266 * This state is entered from the FAILED state.
267 * This state is entered from the STOPPED state.
268 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000269 SCIC_RESETTING,
Dan Williamscc9203b2011-05-08 17:34:44 -0700270
271 /**
272 * This state indicates that the controller is in the process of stopping.
273 * In this state no new IO operations are permitted, but existing IO
274 * operations are allowed to complete.
275 * This state is entered from the READY state.
276 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000277 SCIC_STOPPING,
Dan Williamscc9203b2011-05-08 17:34:44 -0700278
279 /**
Dan Williamscc9203b2011-05-08 17:34:44 -0700280 * This state indicates that the controller could not successfully be
281 * initialized. In this state no new IO operations are permitted.
282 * This state is entered from the INITIALIZING state.
283 * This state is entered from the STARTING state.
284 * This state is entered from the STOPPING state.
285 * This state is entered from the RESETTING state.
286 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000287 SCIC_FAILED,
Dan Williamscc9203b2011-05-08 17:34:44 -0700288};
289
Dan Williamscc9203b2011-05-08 17:34:44 -0700290/**
Dan Williams6f231dd2011-07-02 22:56:22 -0700291 * struct isci_pci_info - This class represents the pci function containing the
292 * controllers. Depending on PCI SKU, there could be up to 2 controllers in
293 * the PCI function.
294 */
295#define SCI_MAX_MSIX_INT (SCI_NUM_MSI_X_INT*SCI_MAX_CONTROLLERS)
296
297struct isci_pci_info {
298 struct msix_entry msix_entries[SCI_MAX_MSIX_INT];
Dan Williamsb329aff2011-03-07 16:02:25 -0800299 struct isci_host *hosts[SCI_MAX_CONTROLLERS];
Dan Williamsd044af12011-03-08 09:52:49 -0800300 struct isci_orom *orom;
Dan Williams6f231dd2011-07-02 22:56:22 -0700301};
302
303static inline struct isci_pci_info *to_pci_info(struct pci_dev *pdev)
304{
305 return pci_get_drvdata(pdev);
306}
307
Dan Williamsd1dc5e22012-02-25 14:29:49 -0800308static inline struct Scsi_Host *to_shost(struct isci_host *ihost)
309{
310 return ihost->sas_ha.core.shost;
311}
312
Dan Williamsb329aff2011-03-07 16:02:25 -0800313#define for_each_isci_host(id, ihost, pdev) \
Lukasz Dorauc59053a2014-02-06 12:23:20 -0800314 for (id = 0; id < SCI_MAX_CONTROLLERS && \
315 (ihost = to_pci_info(pdev)->hosts[id]); id++)
Dan Williams6f231dd2011-07-02 22:56:22 -0700316
Dan Williams0cf89d12011-02-18 09:25:07 -0800317static inline void wait_for_start(struct isci_host *ihost)
318{
319 wait_event(ihost->eventq, !test_bit(IHOST_START_PENDING, &ihost->flags));
320}
321
322static inline void wait_for_stop(struct isci_host *ihost)
323{
324 wait_event(ihost->eventq, !test_bit(IHOST_STOP_PENDING, &ihost->flags));
325}
326
Dan Williams6ad31fe2011-03-04 12:10:29 -0800327static inline void wait_for_device_start(struct isci_host *ihost, struct isci_remote_device *idev)
328{
329 wait_event(ihost->eventq, !test_bit(IDEV_START_PENDING, &idev->flags));
330}
331
332static inline void wait_for_device_stop(struct isci_host *ihost, struct isci_remote_device *idev)
333{
Dan Williamsd9c37392011-03-03 17:59:32 -0800334 wait_event(ihost->eventq, !test_bit(IDEV_STOP_PENDING, &idev->flags));
Dan Williams6ad31fe2011-03-04 12:10:29 -0800335}
Dan Williams0cf89d12011-02-18 09:25:07 -0800336
Dan Williams4393aa42011-03-31 13:10:44 -0700337static inline struct isci_host *dev_to_ihost(struct domain_device *dev)
338{
339 return dev->port->ha->lldd_ha;
340}
Dan Williams6f231dd2011-07-02 22:56:22 -0700341
Jeff Skirvinde2eb4d2012-03-13 17:15:11 -0700342static inline struct isci_host *idev_to_ihost(struct isci_remote_device *idev)
343{
344 return dev_to_ihost(idev->domain_dev);
345}
346
Dan Williams34a99152011-07-01 02:25:15 -0700347/* we always use protocol engine group zero */
348#define ISCI_PEG 0
Dan Williams6f231dd2011-07-02 22:56:22 -0700349
Dan Williams89a73012011-06-30 19:14:33 -0700350/* see sci_controller_io_tag_allocate|free for how seq and tci are built */
Dan Williamsdd047c82011-06-09 11:06:58 -0700351#define ISCI_TAG(seq, tci) (((u16) (seq)) << 12 | tci)
Dan Williamscc9203b2011-05-08 17:34:44 -0700352
Dan Williamsdd047c82011-06-09 11:06:58 -0700353/* these are returned by the hardware, so sanitize them */
354#define ISCI_TAG_SEQ(tag) (((tag) >> 12) & (SCI_MAX_SEQ-1))
355#define ISCI_TAG_TCI(tag) ((tag) & (SCI_MAX_IO_REQUESTS-1))
Dan Williamscc9203b2011-05-08 17:34:44 -0700356
Dan Williams9b4be522011-07-29 17:17:10 -0700357/* interrupt coalescing baseline: 9 == 3 to 5us interrupt delay per command */
358#define ISCI_COALESCE_BASE 9
359
Dan Williamscc9203b2011-05-08 17:34:44 -0700360/* expander attached sata devices require 3 rnc slots */
Dan Williams89a73012011-06-30 19:14:33 -0700361static inline int sci_remote_device_node_count(struct isci_remote_device *idev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700362{
Dan Williams78a6f062011-06-30 16:31:37 -0700363 struct domain_device *dev = idev->domain_dev;
Dan Williamscc9203b2011-05-08 17:34:44 -0700364
Dan Williams11cc5182012-02-01 00:23:10 -0800365 if (dev_is_sata(dev) && dev->parent)
Dan Williamscc9203b2011-05-08 17:34:44 -0700366 return SCU_STP_REMOTE_NODE_COUNT;
367 return SCU_SSP_REMOTE_NODE_COUNT;
368}
369
370/**
Dan Williams89a73012011-06-30 19:14:33 -0700371 * sci_controller_clear_invalid_phy() -
Dan Williamscc9203b2011-05-08 17:34:44 -0700372 *
373 * This macro will clear the bit in the invalid phy mask for this controller
374 * object. This is used to control messages reported for invalid link up
375 * notifications.
376 */
Dan Williams89a73012011-06-30 19:14:33 -0700377#define sci_controller_clear_invalid_phy(controller, phy) \
Dan Williamscc9203b2011-05-08 17:34:44 -0700378 ((controller)->invalid_phy_mask &= ~(1 << (phy)->phy_index))
379
Dan Williams78a6f062011-06-30 16:31:37 -0700380static inline struct device *scirdev_to_dev(struct isci_remote_device *idev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700381{
Dan Williamscc9203b2011-05-08 17:34:44 -0700382 if (!idev || !idev->isci_port || !idev->isci_port->isci_host)
383 return NULL;
384
385 return &idev->isci_port->isci_host->pdev->dev;
386}
387
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700388static inline bool is_a2(struct pci_dev *pdev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700389{
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700390 if (pdev->revision < 4)
391 return true;
392 return false;
Dan Williamscc9203b2011-05-08 17:34:44 -0700393}
394
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700395static inline bool is_b0(struct pci_dev *pdev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700396{
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700397 if (pdev->revision == 4)
398 return true;
399 return false;
Dan Williamscc9203b2011-05-08 17:34:44 -0700400}
401
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700402static inline bool is_c0(struct pci_dev *pdev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700403{
Jeff Skirvinafd13a12012-01-04 01:32:39 -0800404 if (pdev->revision == 5)
405 return true;
406 return false;
407}
408
409static inline bool is_c1(struct pci_dev *pdev)
410{
411 if (pdev->revision >= 6)
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700412 return true;
413 return false;
Dan Williamscc9203b2011-05-08 17:34:44 -0700414}
415
Jeff Skirvin9fee6072012-01-04 01:32:49 -0800416enum cable_selections {
417 short_cable = 0,
418 long_cable = 1,
419 medium_cable = 2,
420 undefined_cable = 3
421};
422
423#define CABLE_OVERRIDE_DISABLED (0x10000)
424
425static inline int is_cable_select_overridden(void)
426{
427 return cable_selection_override < CABLE_OVERRIDE_DISABLED;
428}
429
430enum cable_selections decode_cable_selection(struct isci_host *ihost, int phy);
431void validate_cable_selections(struct isci_host *ihost);
432char *lookup_cable_names(enum cable_selections);
433
Dan Williamsad4f4c12011-09-01 21:18:31 -0700434/* set hw control for 'activity', even though active enclosures seem to drive
435 * the activity led on their own. Skip setting FSENG control on 'status' due
436 * to unexpected operation and 'error' due to not being a supported automatic
437 * FSENG output
438 */
439#define SGPIO_HW_CONTROL 0x00000443
440
441static inline int isci_gpio_count(struct isci_host *ihost)
442{
443 return ARRAY_SIZE(ihost->scu_registers->peg0.sgpio.output_data_select);
444}
445
Dan Williams89a73012011-06-30 19:14:33 -0700446void sci_controller_post_request(struct isci_host *ihost,
Dan Williamscc9203b2011-05-08 17:34:44 -0700447 u32 request);
Dan Williams89a73012011-06-30 19:14:33 -0700448void sci_controller_release_frame(struct isci_host *ihost,
Dan Williamscc9203b2011-05-08 17:34:44 -0700449 u32 frame_index);
Dan Williams89a73012011-06-30 19:14:33 -0700450void sci_controller_copy_sata_response(void *response_buffer,
Dan Williamscc9203b2011-05-08 17:34:44 -0700451 void *frame_header,
452 void *frame_buffer);
Dan Williams89a73012011-06-30 19:14:33 -0700453enum sci_status sci_controller_allocate_remote_node_context(struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700454 struct isci_remote_device *idev,
Dan Williamscc9203b2011-05-08 17:34:44 -0700455 u16 *node_id);
Dan Williams89a73012011-06-30 19:14:33 -0700456void sci_controller_free_remote_node_context(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700457 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700458 struct isci_remote_device *idev,
Dan Williamscc9203b2011-05-08 17:34:44 -0700459 u16 node_id);
Dan Williamscc9203b2011-05-08 17:34:44 -0700460
Dan Williamsabec9122012-02-15 13:58:42 -0800461struct isci_request *sci_request_by_tag(struct isci_host *ihost, u16 io_tag);
462void sci_controller_power_control_queue_insert(struct isci_host *ihost,
463 struct isci_phy *iphy);
464void sci_controller_power_control_queue_remove(struct isci_host *ihost,
465 struct isci_phy *iphy);
466void sci_controller_link_up(struct isci_host *ihost, struct isci_port *iport,
467 struct isci_phy *iphy);
468void sci_controller_link_down(struct isci_host *ihost, struct isci_port *iport,
469 struct isci_phy *iphy);
470void sci_controller_remote_device_stopped(struct isci_host *ihost,
471 struct isci_remote_device *idev);
Dan Williamscc9203b2011-05-08 17:34:44 -0700472
Dan Williams89a73012011-06-30 19:14:33 -0700473enum sci_status sci_controller_continue_io(struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700474int isci_host_scan_finished(struct Scsi_Host *, unsigned long);
Artur Wojcike468dc12012-06-21 23:41:56 -0700475void isci_host_start(struct Scsi_Host *);
Dan Williams312e0c22011-06-28 13:47:09 -0700476u16 isci_alloc_tag(struct isci_host *ihost);
477enum sci_status isci_free_tag(struct isci_host *ihost, u16 io_tag);
478void isci_tci_free(struct isci_host *ihost, u16 tci);
Jeff Skirvinf8381802012-03-04 12:44:53 +0000479void ireq_done(struct isci_host *ihost, struct isci_request *ireq, struct sas_task *task);
Dan Williams6f231dd2011-07-02 22:56:22 -0700480
481int isci_host_init(struct isci_host *);
Dan Williamsabec9122012-02-15 13:58:42 -0800482void isci_host_completion_routine(unsigned long data);
483void isci_host_deinit(struct isci_host *);
484void sci_controller_disable_interrupts(struct isci_host *ihost);
Dan Williamseb608c32012-02-23 01:12:10 -0800485bool sci_controller_has_remote_devices_stopping(struct isci_host *ihost);
Dan Williams50a92d92012-02-29 01:07:56 -0800486void sci_controller_transition_to_ready(struct isci_host *ihost, enum sci_status status);
Dan Williamscc9203b2011-05-08 17:34:44 -0700487
Dan Williams89a73012011-06-30 19:14:33 -0700488enum sci_status sci_controller_start_io(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700489 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700490 struct isci_remote_device *idev,
Dan Williams5076a1a2011-06-27 14:57:03 -0700491 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700492
Dan Williams89a73012011-06-30 19:14:33 -0700493enum sci_task_status sci_controller_start_task(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700494 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700495 struct isci_remote_device *idev,
Dan Williams5076a1a2011-06-27 14:57:03 -0700496 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700497
Dan Williams89a73012011-06-30 19:14:33 -0700498enum sci_status sci_controller_terminate_request(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700499 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700500 struct isci_remote_device *idev,
Dan Williams5076a1a2011-06-27 14:57:03 -0700501 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700502
Dan Williams89a73012011-06-30 19:14:33 -0700503enum sci_status sci_controller_complete_io(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700504 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700505 struct isci_remote_device *idev,
Dan Williams5076a1a2011-06-27 14:57:03 -0700506 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700507
Dan Williams89a73012011-06-30 19:14:33 -0700508void sci_port_configuration_agent_construct(
509 struct sci_port_configuration_agent *port_agent);
Dan Williamse2f8db52011-05-10 02:28:46 -0700510
Dan Williams89a73012011-06-30 19:14:33 -0700511enum sci_status sci_port_configuration_agent_initialize(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700512 struct isci_host *ihost,
Dan Williams89a73012011-06-30 19:14:33 -0700513 struct sci_port_configuration_agent *port_agent);
Dan Williamsad4f4c12011-09-01 21:18:31 -0700514
515int isci_gpio_write(struct sas_ha_struct *, u8 reg_type, u8 reg_index,
516 u8 reg_count, u8 *write_data);
Dan Williamscc9203b2011-05-08 17:34:44 -0700517#endif