blob: 646051afd3cbd07e2ab6761a18edef7355cf39f6 [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 Williams6f231dd2011-07-02 22:56:22 -070058#include "remote_device.h"
Dan Williamsce2b3262011-05-08 15:49:15 -070059#include "phy.h"
Edmund Nadolski12ef6542011-06-02 00:10:50 +000060#include "isci.h"
Dan Williamscc9203b2011-05-08 17:34:44 -070061#include "remote_node_table.h"
Dan Williams63a3a152011-05-08 21:36:46 -070062#include "registers.h"
Dan Williams63a3a152011-05-08 21:36:46 -070063#include "unsolicited_frame_control.h"
Dan Williamse2f8db52011-05-10 02:28:46 -070064#include "probe_roms.h"
Dan Williamscc9203b2011-05-08 17:34:44 -070065
Dan Williams5076a1a2011-06-27 14:57:03 -070066struct isci_request;
Dan Williamscc9203b2011-05-08 17:34:44 -070067struct scu_task_context;
68
Dan Williamse2f8db52011-05-10 02:28:46 -070069
Dan Williamscc9203b2011-05-08 17:34:44 -070070/**
Dan Williams89a73012011-06-30 19:14:33 -070071 * struct sci_power_control -
Dan Williamscc9203b2011-05-08 17:34:44 -070072 *
73 * This structure defines the fields for managing power control for direct
74 * attached disk devices.
75 */
Dan Williams89a73012011-06-30 19:14:33 -070076struct sci_power_control {
Dan Williamscc9203b2011-05-08 17:34:44 -070077 /**
78 * This field is set when the power control timer is running and cleared when
79 * it is not.
80 */
81 bool timer_started;
82
83 /**
Edmund Nadolski04736612011-05-19 20:17:47 -070084 * Timer to control when the directed attached disks can consume power.
Dan Williamscc9203b2011-05-08 17:34:44 -070085 */
Edmund Nadolski04736612011-05-19 20:17:47 -070086 struct sci_timer timer;
Dan Williamscc9203b2011-05-08 17:34:44 -070087
88 /**
89 * This field is used to keep track of how many phys are put into the
90 * requesters field.
91 */
92 u8 phys_waiting;
93
94 /**
95 * This field is used to keep track of how many phys have been granted to consume power
96 */
97 u8 phys_granted_power;
98
99 /**
100 * This field is an array of phys that we are waiting on. The phys are direct
Dan Williams89a73012011-06-30 19:14:33 -0700101 * mapped into requesters via struct sci_phy.phy_index
Dan Williamscc9203b2011-05-08 17:34:44 -0700102 */
Dan Williams85280952011-06-28 15:05:53 -0700103 struct isci_phy *requesters[SCI_MAX_PHYS];
Dan Williamscc9203b2011-05-08 17:34:44 -0700104
105};
106
Dan Williams89a73012011-06-30 19:14:33 -0700107struct sci_port_configuration_agent;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700108typedef void (*port_config_fn)(struct isci_host *,
Dan Williams89a73012011-06-30 19:14:33 -0700109 struct sci_port_configuration_agent *,
Dan Williamsffe191c2011-06-29 13:09:25 -0700110 struct isci_port *, struct isci_phy *);
Dan Williamse2f8db52011-05-10 02:28:46 -0700111
Dan Williams89a73012011-06-30 19:14:33 -0700112struct sci_port_configuration_agent {
Dan Williamse2f8db52011-05-10 02:28:46 -0700113 u16 phy_configured_mask;
114 u16 phy_ready_mask;
115 struct {
116 u8 min_index;
117 u8 max_index;
118 } phy_valid_port_range[SCI_MAX_PHYS];
119 bool timer_pending;
120 port_config_fn link_up_handler;
121 port_config_fn link_down_handler;
Edmund Nadolskiac0eeb42011-05-19 20:00:51 -0700122 struct sci_timer timer;
Dan Williamse2f8db52011-05-10 02:28:46 -0700123};
124
Dan Williamscc9203b2011-05-08 17:34:44 -0700125/**
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700126 * isci_host - primary host/controller object
127 * @timer: timeout start/stop operations
128 * @device_table: rni (hw remote node index) to remote device lookup table
129 * @available_remote_nodes: rni allocator
130 * @power_control: manage device spin up
131 * @io_request_sequence: generation number for tci's (task contexts)
132 * @task_context_table: hw task context table
133 * @remote_node_context_table: hw remote node context table
134 * @completion_queue: hw-producer driver-consumer communication ring
135 * @completion_queue_get: tracks the driver 'head' of the ring to notify hw
136 * @logical_port_entries: min({driver|silicon}-supported-port-count)
137 * @remote_node_entries: min({driver|silicon}-supported-node-count)
138 * @task_context_entries: min({driver|silicon}-supported-task-count)
139 * @phy_timer: phy startup timer
140 * @invalid_phy_mask: if an invalid_link_up notification is reported a bit for
141 * the phy index is set so further notifications are not
142 * made. Once the phy reports link up and is made part of a
143 * port then this bit is cleared.
144
Dan Williamscc9203b2011-05-08 17:34:44 -0700145 */
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700146struct isci_host {
Edmund Nadolskie3013702011-06-02 00:10:43 +0000147 struct sci_base_state_machine sm;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700148 /* XXX can we time this externally */
Edmund Nadolski6cb58532011-05-19 11:59:56 +0000149 struct sci_timer timer;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700150 /* XXX drop reference module params directly */
Dan Williams89a73012011-06-30 19:14:33 -0700151 struct sci_user_parameters user_parameters;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700152 /* XXX no need to be a union */
Dan Williams89a73012011-06-30 19:14:33 -0700153 struct sci_oem_params oem_parameters;
154 struct sci_port_configuration_agent port_agent;
Dan Williams78a6f062011-06-30 16:31:37 -0700155 struct isci_remote_device *device_table[SCI_MAX_REMOTE_DEVICES];
Dan Williams89a73012011-06-30 19:14:33 -0700156 struct sci_remote_node_table available_remote_nodes;
157 struct sci_power_control power_control;
Dan Williamsdd047c82011-06-09 11:06:58 -0700158 u8 io_request_sequence[SCI_MAX_IO_REQUESTS];
Dan Williamscc9203b2011-05-08 17:34:44 -0700159 struct scu_task_context *task_context_table;
Dan Williams312e0c22011-06-28 13:47:09 -0700160 dma_addr_t task_context_dma;
Dan Williamscc9203b2011-05-08 17:34:44 -0700161 union scu_remote_node_context *remote_node_context_table;
Dan Williamscc9203b2011-05-08 17:34:44 -0700162 u32 *completion_queue;
Dan Williamscc9203b2011-05-08 17:34:44 -0700163 u32 completion_queue_get;
Dan Williamscc9203b2011-05-08 17:34:44 -0700164 u32 logical_port_entries;
Dan Williamscc9203b2011-05-08 17:34:44 -0700165 u32 remote_node_entries;
Dan Williamscc9203b2011-05-08 17:34:44 -0700166 u32 task_context_entries;
Dan Williams89a73012011-06-30 19:14:33 -0700167 struct sci_unsolicited_frame_control uf_control;
Dan Williamscc9203b2011-05-08 17:34:44 -0700168
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700169 /* phy startup */
Edmund Nadolskibb3dbdf2011-05-19 20:26:02 -0700170 struct sci_timer phy_timer;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700171 /* XXX kill */
Dan Williamscc9203b2011-05-08 17:34:44 -0700172 bool phy_startup_timer_pending;
Dan Williamscc9203b2011-05-08 17:34:44 -0700173 u32 next_phy_to_start;
Dan Williams34a99152011-07-01 02:25:15 -0700174 /* XXX convert to unsigned long and use bitops */
Dan Williamscc9203b2011-05-08 17:34:44 -0700175 u8 invalid_phy_mask;
176
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700177 /* TODO attempt dynamic interrupt coalescing scheme */
Dan Williamscc9203b2011-05-08 17:34:44 -0700178 u16 interrupt_coalesce_number;
Dan Williamscc9203b2011-05-08 17:34:44 -0700179 u32 interrupt_coalesce_timeout;
Dan Williamscc9203b2011-05-08 17:34:44 -0700180 struct smu_registers __iomem *smu_registers;
Dan Williamscc9203b2011-05-08 17:34:44 -0700181 struct scu_registers __iomem *scu_registers;
182
Dan Williamsac668c62011-06-07 18:50:55 -0700183 u16 tci_head;
184 u16 tci_tail;
185 u16 tci_pool[SCI_MAX_IO_REQUESTS];
186
Dan Williams6f231dd2011-07-02 22:56:22 -0700187 int id; /* unique within a given pci device */
Dan Williams6f231dd2011-07-02 22:56:22 -0700188 struct isci_phy phys[SCI_MAX_PHYS];
Dan Williamse5313812011-05-07 10:11:43 -0700189 struct isci_port ports[SCI_MAX_PORTS + 1]; /* includes dummy port */
Dan Williams6f231dd2011-07-02 22:56:22 -0700190 struct sas_ha_struct sas_ha;
191
Dan Williams6f231dd2011-07-02 22:56:22 -0700192 spinlock_t state_lock;
Dan Williams6f231dd2011-07-02 22:56:22 -0700193 struct pci_dev *pdev;
Dan Williams6f231dd2011-07-02 22:56:22 -0700194 enum isci_status status;
Dan Williams0cf89d12011-02-18 09:25:07 -0800195 #define IHOST_START_PENDING 0
196 #define IHOST_STOP_PENDING 1
197 unsigned long flags;
198 wait_queue_head_t eventq;
Dan Williams6f231dd2011-07-02 22:56:22 -0700199 struct Scsi_Host *shost;
200 struct tasklet_struct completion_tasklet;
Dan Williams6f231dd2011-07-02 22:56:22 -0700201 struct list_head requests_to_complete;
Jeff Skirvin11b00c12011-03-04 14:06:40 -0800202 struct list_head requests_to_errorback;
Dan Williams6f231dd2011-07-02 22:56:22 -0700203 spinlock_t scic_lock;
Dan Williamsdb056252011-06-17 14:18:39 -0700204 struct isci_request *reqs[SCI_MAX_IO_REQUESTS];
Dan Williams57f20f42011-04-21 18:14:45 -0700205 struct isci_remote_device devices[SCI_MAX_REMOTE_DEVICES];
Dan Williams6f231dd2011-07-02 22:56:22 -0700206};
207
Dan Williams6f231dd2011-07-02 22:56:22 -0700208/**
Dan Williams89a73012011-06-30 19:14:33 -0700209 * enum sci_controller_states - This enumeration depicts all the states
Dan Williamscc9203b2011-05-08 17:34:44 -0700210 * for the common controller state machine.
211 */
Dan Williams89a73012011-06-30 19:14:33 -0700212enum sci_controller_states {
Dan Williamscc9203b2011-05-08 17:34:44 -0700213 /**
214 * Simply the initial state for the base controller state machine.
215 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000216 SCIC_INITIAL = 0,
Dan Williamscc9203b2011-05-08 17:34:44 -0700217
218 /**
219 * This state indicates that the controller is reset. The memory for
220 * the controller is in it's initial state, but the controller requires
221 * initialization.
222 * This state is entered from the INITIAL state.
223 * This state is entered from the RESETTING state.
224 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000225 SCIC_RESET,
Dan Williamscc9203b2011-05-08 17:34:44 -0700226
227 /**
228 * This state is typically an action state that indicates the controller
229 * is in the process of initialization. In this state no new IO operations
230 * are permitted.
231 * This state is entered from the RESET state.
232 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000233 SCIC_INITIALIZING,
Dan Williamscc9203b2011-05-08 17:34:44 -0700234
235 /**
236 * This state indicates that the controller has been successfully
237 * initialized. In this state no new IO operations are permitted.
238 * This state is entered from the INITIALIZING state.
239 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000240 SCIC_INITIALIZED,
Dan Williamscc9203b2011-05-08 17:34:44 -0700241
242 /**
243 * This state indicates the the controller is in the process of becoming
244 * ready (i.e. starting). In this state no new IO operations are permitted.
245 * This state is entered from the INITIALIZED state.
246 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000247 SCIC_STARTING,
Dan Williamscc9203b2011-05-08 17:34:44 -0700248
249 /**
250 * This state indicates the controller is now ready. Thus, the user
251 * is able to perform IO operations on the controller.
252 * This state is entered from the STARTING state.
253 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000254 SCIC_READY,
Dan Williamscc9203b2011-05-08 17:34:44 -0700255
256 /**
257 * This state is typically an action state that indicates the controller
258 * is in the process of resetting. Thus, the user is unable to perform
259 * IO operations on the controller. A reset is considered destructive in
260 * most cases.
261 * This state is entered from the READY state.
262 * This state is entered from the FAILED state.
263 * This state is entered from the STOPPED state.
264 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000265 SCIC_RESETTING,
Dan Williamscc9203b2011-05-08 17:34:44 -0700266
267 /**
268 * This state indicates that the controller is in the process of stopping.
269 * In this state no new IO operations are permitted, but existing IO
270 * operations are allowed to complete.
271 * This state is entered from the READY state.
272 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000273 SCIC_STOPPING,
Dan Williamscc9203b2011-05-08 17:34:44 -0700274
275 /**
276 * This state indicates that the controller has successfully been stopped.
277 * In this state no new IO operations are permitted.
278 * This state is entered from the STOPPING state.
279 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000280 SCIC_STOPPED,
Dan Williamscc9203b2011-05-08 17:34:44 -0700281
282 /**
283 * This state indicates that the controller could not successfully be
284 * initialized. In this state no new IO operations are permitted.
285 * This state is entered from the INITIALIZING state.
286 * This state is entered from the STARTING state.
287 * This state is entered from the STOPPING state.
288 * This state is entered from the RESETTING state.
289 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000290 SCIC_FAILED,
Dan Williamscc9203b2011-05-08 17:34:44 -0700291};
292
Dan Williamscc9203b2011-05-08 17:34:44 -0700293/**
Dan Williams6f231dd2011-07-02 22:56:22 -0700294 * struct isci_pci_info - This class represents the pci function containing the
295 * controllers. Depending on PCI SKU, there could be up to 2 controllers in
296 * the PCI function.
297 */
298#define SCI_MAX_MSIX_INT (SCI_NUM_MSI_X_INT*SCI_MAX_CONTROLLERS)
299
300struct isci_pci_info {
301 struct msix_entry msix_entries[SCI_MAX_MSIX_INT];
Dan Williamsb329aff2011-03-07 16:02:25 -0800302 struct isci_host *hosts[SCI_MAX_CONTROLLERS];
Dan Williamsd044af12011-03-08 09:52:49 -0800303 struct isci_orom *orom;
Dan Williams6f231dd2011-07-02 22:56:22 -0700304};
305
306static inline struct isci_pci_info *to_pci_info(struct pci_dev *pdev)
307{
308 return pci_get_drvdata(pdev);
309}
310
Dan Williamsb329aff2011-03-07 16:02:25 -0800311#define for_each_isci_host(id, ihost, pdev) \
312 for (id = 0, ihost = to_pci_info(pdev)->hosts[id]; \
313 id < ARRAY_SIZE(to_pci_info(pdev)->hosts) && ihost; \
314 ihost = to_pci_info(pdev)->hosts[++id])
Dan Williams6f231dd2011-07-02 22:56:22 -0700315
Dan Williamscc9203b2011-05-08 17:34:44 -0700316static inline enum isci_status isci_host_get_state(struct isci_host *isci_host)
Dan Williams6f231dd2011-07-02 22:56:22 -0700317{
318 return isci_host->status;
319}
320
Dan Williamscc9203b2011-05-08 17:34:44 -0700321static inline void isci_host_change_state(struct isci_host *isci_host,
322 enum isci_status status)
Dan Williams6f231dd2011-07-02 22:56:22 -0700323{
324 unsigned long flags;
325
326 dev_dbg(&isci_host->pdev->dev,
327 "%s: isci_host = %p, state = 0x%x",
328 __func__,
329 isci_host,
330 status);
331 spin_lock_irqsave(&isci_host->state_lock, flags);
332 isci_host->status = status;
333 spin_unlock_irqrestore(&isci_host->state_lock, flags);
334
335}
336
Dan Williams0cf89d12011-02-18 09:25:07 -0800337static inline void wait_for_start(struct isci_host *ihost)
338{
339 wait_event(ihost->eventq, !test_bit(IHOST_START_PENDING, &ihost->flags));
340}
341
342static inline void wait_for_stop(struct isci_host *ihost)
343{
344 wait_event(ihost->eventq, !test_bit(IHOST_STOP_PENDING, &ihost->flags));
345}
346
Dan Williams6ad31fe2011-03-04 12:10:29 -0800347static inline void wait_for_device_start(struct isci_host *ihost, struct isci_remote_device *idev)
348{
349 wait_event(ihost->eventq, !test_bit(IDEV_START_PENDING, &idev->flags));
350}
351
352static inline void wait_for_device_stop(struct isci_host *ihost, struct isci_remote_device *idev)
353{
Dan Williamsd9c37392011-03-03 17:59:32 -0800354 wait_event(ihost->eventq, !test_bit(IDEV_STOP_PENDING, &idev->flags));
Dan Williams6ad31fe2011-03-04 12:10:29 -0800355}
Dan Williams0cf89d12011-02-18 09:25:07 -0800356
Dan Williams4393aa42011-03-31 13:10:44 -0700357static inline struct isci_host *dev_to_ihost(struct domain_device *dev)
358{
359 return dev->port->ha->lldd_ha;
360}
Dan Williams6f231dd2011-07-02 22:56:22 -0700361
Dan Williams34a99152011-07-01 02:25:15 -0700362/* we always use protocol engine group zero */
363#define ISCI_PEG 0
Dan Williams6f231dd2011-07-02 22:56:22 -0700364
Dan Williams89a73012011-06-30 19:14:33 -0700365/* see sci_controller_io_tag_allocate|free for how seq and tci are built */
Dan Williamsdd047c82011-06-09 11:06:58 -0700366#define ISCI_TAG(seq, tci) (((u16) (seq)) << 12 | tci)
Dan Williamscc9203b2011-05-08 17:34:44 -0700367
Dan Williamsdd047c82011-06-09 11:06:58 -0700368/* these are returned by the hardware, so sanitize them */
369#define ISCI_TAG_SEQ(tag) (((tag) >> 12) & (SCI_MAX_SEQ-1))
370#define ISCI_TAG_TCI(tag) ((tag) & (SCI_MAX_IO_REQUESTS-1))
Dan Williamscc9203b2011-05-08 17:34:44 -0700371
Dan Williams9b4be522011-07-29 17:17:10 -0700372/* interrupt coalescing baseline: 9 == 3 to 5us interrupt delay per command */
373#define ISCI_COALESCE_BASE 9
374
Dan Williamscc9203b2011-05-08 17:34:44 -0700375/* expander attached sata devices require 3 rnc slots */
Dan Williams89a73012011-06-30 19:14:33 -0700376static inline int sci_remote_device_node_count(struct isci_remote_device *idev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700377{
Dan Williams78a6f062011-06-30 16:31:37 -0700378 struct domain_device *dev = idev->domain_dev;
Dan Williamscc9203b2011-05-08 17:34:44 -0700379
380 if ((dev->dev_type == SATA_DEV || (dev->tproto & SAS_PROTOCOL_STP)) &&
Dan Williams78a6f062011-06-30 16:31:37 -0700381 !idev->is_direct_attached)
Dan Williamscc9203b2011-05-08 17:34:44 -0700382 return SCU_STP_REMOTE_NODE_COUNT;
383 return SCU_SSP_REMOTE_NODE_COUNT;
384}
385
386/**
Dan Williams89a73012011-06-30 19:14:33 -0700387 * sci_controller_clear_invalid_phy() -
Dan Williamscc9203b2011-05-08 17:34:44 -0700388 *
389 * This macro will clear the bit in the invalid phy mask for this controller
390 * object. This is used to control messages reported for invalid link up
391 * notifications.
392 */
Dan Williams89a73012011-06-30 19:14:33 -0700393#define sci_controller_clear_invalid_phy(controller, phy) \
Dan Williamscc9203b2011-05-08 17:34:44 -0700394 ((controller)->invalid_phy_mask &= ~(1 << (phy)->phy_index))
395
Dan Williams85280952011-06-28 15:05:53 -0700396static inline struct device *sciphy_to_dev(struct isci_phy *iphy)
Dan Williamscc9203b2011-05-08 17:34:44 -0700397{
Dan Williamscc9203b2011-05-08 17:34:44 -0700398
399 if (!iphy || !iphy->isci_port || !iphy->isci_port->isci_host)
400 return NULL;
401
402 return &iphy->isci_port->isci_host->pdev->dev;
403}
404
Dan Williamsffe191c2011-06-29 13:09:25 -0700405static inline struct device *sciport_to_dev(struct isci_port *iport)
Dan Williamscc9203b2011-05-08 17:34:44 -0700406{
Dan Williamscc9203b2011-05-08 17:34:44 -0700407
408 if (!iport || !iport->isci_host)
409 return NULL;
410
411 return &iport->isci_host->pdev->dev;
412}
413
Dan Williams78a6f062011-06-30 16:31:37 -0700414static inline struct device *scirdev_to_dev(struct isci_remote_device *idev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700415{
Dan Williamscc9203b2011-05-08 17:34:44 -0700416 if (!idev || !idev->isci_port || !idev->isci_port->isci_host)
417 return NULL;
418
419 return &idev->isci_port->isci_host->pdev->dev;
420}
421
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700422static inline bool is_a2(struct pci_dev *pdev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700423{
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700424 if (pdev->revision < 4)
425 return true;
426 return false;
Dan Williamscc9203b2011-05-08 17:34:44 -0700427}
428
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700429static inline bool is_b0(struct pci_dev *pdev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700430{
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700431 if (pdev->revision == 4)
432 return true;
433 return false;
Dan Williamscc9203b2011-05-08 17:34:44 -0700434}
435
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700436static inline bool is_c0(struct pci_dev *pdev)
Dan Williamscc9203b2011-05-08 17:34:44 -0700437{
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700438 if (pdev->revision >= 5)
439 return true;
440 return false;
Dan Williamscc9203b2011-05-08 17:34:44 -0700441}
442
Dan Williamsad4f4c12011-09-01 21:18:31 -0700443/* set hw control for 'activity', even though active enclosures seem to drive
444 * the activity led on their own. Skip setting FSENG control on 'status' due
445 * to unexpected operation and 'error' due to not being a supported automatic
446 * FSENG output
447 */
448#define SGPIO_HW_CONTROL 0x00000443
449
450static inline int isci_gpio_count(struct isci_host *ihost)
451{
452 return ARRAY_SIZE(ihost->scu_registers->peg0.sgpio.output_data_select);
453}
454
Dan Williams89a73012011-06-30 19:14:33 -0700455void sci_controller_post_request(struct isci_host *ihost,
Dan Williamscc9203b2011-05-08 17:34:44 -0700456 u32 request);
Dan Williams89a73012011-06-30 19:14:33 -0700457void sci_controller_release_frame(struct isci_host *ihost,
Dan Williamscc9203b2011-05-08 17:34:44 -0700458 u32 frame_index);
Dan Williams89a73012011-06-30 19:14:33 -0700459void sci_controller_copy_sata_response(void *response_buffer,
Dan Williamscc9203b2011-05-08 17:34:44 -0700460 void *frame_header,
461 void *frame_buffer);
Dan Williams89a73012011-06-30 19:14:33 -0700462enum sci_status sci_controller_allocate_remote_node_context(struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700463 struct isci_remote_device *idev,
Dan Williamscc9203b2011-05-08 17:34:44 -0700464 u16 *node_id);
Dan Williams89a73012011-06-30 19:14:33 -0700465void sci_controller_free_remote_node_context(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700466 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700467 struct isci_remote_device *idev,
Dan Williamscc9203b2011-05-08 17:34:44 -0700468 u16 node_id);
Dan Williamscc9203b2011-05-08 17:34:44 -0700469
Dan Williams89a73012011-06-30 19:14:33 -0700470struct isci_request *sci_request_by_tag(struct isci_host *ihost,
Dan Williamscc9203b2011-05-08 17:34:44 -0700471 u16 io_tag);
472
Dan Williams89a73012011-06-30 19:14:33 -0700473void sci_controller_power_control_queue_insert(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700474 struct isci_host *ihost,
Dan Williams85280952011-06-28 15:05:53 -0700475 struct isci_phy *iphy);
Dan Williamscc9203b2011-05-08 17:34:44 -0700476
Dan Williams89a73012011-06-30 19:14:33 -0700477void sci_controller_power_control_queue_remove(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700478 struct isci_host *ihost,
Dan Williams85280952011-06-28 15:05:53 -0700479 struct isci_phy *iphy);
Dan Williamscc9203b2011-05-08 17:34:44 -0700480
Dan Williams89a73012011-06-30 19:14:33 -0700481void sci_controller_link_up(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700482 struct isci_host *ihost,
Dan Williamsffe191c2011-06-29 13:09:25 -0700483 struct isci_port *iport,
Dan Williams85280952011-06-28 15:05:53 -0700484 struct isci_phy *iphy);
Dan Williamscc9203b2011-05-08 17:34:44 -0700485
Dan Williams89a73012011-06-30 19:14:33 -0700486void sci_controller_link_down(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700487 struct isci_host *ihost,
Dan Williamsffe191c2011-06-29 13:09:25 -0700488 struct isci_port *iport,
Dan Williams85280952011-06-28 15:05:53 -0700489 struct isci_phy *iphy);
Dan Williamscc9203b2011-05-08 17:34:44 -0700490
Dan Williams89a73012011-06-30 19:14:33 -0700491void sci_controller_remote_device_stopped(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700492 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700493 struct isci_remote_device *idev);
Dan Williamscc9203b2011-05-08 17:34:44 -0700494
Dan Williams89a73012011-06-30 19:14:33 -0700495void sci_controller_copy_task_context(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700496 struct isci_host *ihost,
Dan Williams5076a1a2011-06-27 14:57:03 -0700497 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700498
Dan Williams89a73012011-06-30 19:14:33 -0700499void sci_controller_register_setup(struct isci_host *ihost);
Dan Williamscc9203b2011-05-08 17:34:44 -0700500
Dan Williams89a73012011-06-30 19:14:33 -0700501enum sci_status sci_controller_continue_io(struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700502int isci_host_scan_finished(struct Scsi_Host *, unsigned long);
503void isci_host_scan_start(struct Scsi_Host *);
Dan Williams312e0c22011-06-28 13:47:09 -0700504u16 isci_alloc_tag(struct isci_host *ihost);
505enum sci_status isci_free_tag(struct isci_host *ihost, u16 io_tag);
506void isci_tci_free(struct isci_host *ihost, u16 tci);
Dan Williams6f231dd2011-07-02 22:56:22 -0700507
508int isci_host_init(struct isci_host *);
509
510void isci_host_init_controller_names(
511 struct isci_host *isci_host,
512 unsigned int controller_idx);
513
514void isci_host_deinit(
515 struct isci_host *);
516
517void isci_host_port_link_up(
518 struct isci_host *,
Dan Williamsffe191c2011-06-29 13:09:25 -0700519 struct isci_port *,
Dan Williams85280952011-06-28 15:05:53 -0700520 struct isci_phy *);
Dan Williams6f231dd2011-07-02 22:56:22 -0700521int isci_host_dev_found(struct domain_device *);
522
523void isci_host_remote_device_start_complete(
524 struct isci_host *,
525 struct isci_remote_device *,
526 enum sci_status);
527
Dan Williams89a73012011-06-30 19:14:33 -0700528void sci_controller_disable_interrupts(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700529 struct isci_host *ihost);
Dan Williamscc9203b2011-05-08 17:34:44 -0700530
Dan Williams89a73012011-06-30 19:14:33 -0700531enum sci_status sci_controller_start_io(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700532 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700533 struct isci_remote_device *idev,
Dan Williams5076a1a2011-06-27 14:57:03 -0700534 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700535
Dan Williams89a73012011-06-30 19:14:33 -0700536enum sci_task_status sci_controller_start_task(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700537 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700538 struct isci_remote_device *idev,
Dan Williams5076a1a2011-06-27 14:57:03 -0700539 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700540
Dan Williams89a73012011-06-30 19:14:33 -0700541enum sci_status sci_controller_terminate_request(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700542 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700543 struct isci_remote_device *idev,
Dan Williams5076a1a2011-06-27 14:57:03 -0700544 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700545
Dan Williams89a73012011-06-30 19:14:33 -0700546enum sci_status sci_controller_complete_io(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700547 struct isci_host *ihost,
Dan Williams78a6f062011-06-30 16:31:37 -0700548 struct isci_remote_device *idev,
Dan Williams5076a1a2011-06-27 14:57:03 -0700549 struct isci_request *ireq);
Dan Williamscc9203b2011-05-08 17:34:44 -0700550
Dan Williams89a73012011-06-30 19:14:33 -0700551void sci_port_configuration_agent_construct(
552 struct sci_port_configuration_agent *port_agent);
Dan Williamse2f8db52011-05-10 02:28:46 -0700553
Dan Williams89a73012011-06-30 19:14:33 -0700554enum sci_status sci_port_configuration_agent_initialize(
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700555 struct isci_host *ihost,
Dan Williams89a73012011-06-30 19:14:33 -0700556 struct sci_port_configuration_agent *port_agent);
Dan Williamsad4f4c12011-09-01 21:18:31 -0700557
558int isci_gpio_write(struct sas_ha_struct *, u8 reg_type, u8 reg_index,
559 u8 reg_count, u8 *write_data);
Dan Williamscc9203b2011-05-08 17:34:44 -0700560#endif