Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 1 | /* |
| 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 Williams | ce2b326 | 2011-05-08 15:49:15 -0700 | [diff] [blame] | 55 | #ifndef _SCI_HOST_H_ |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 56 | #define _SCI_HOST_H_ |
| 57 | |
Dan Williams | 11cc518 | 2012-02-01 00:23:10 -0800 | [diff] [blame] | 58 | #include <scsi/sas_ata.h> |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 59 | #include "remote_device.h" |
Dan Williams | ce2b326 | 2011-05-08 15:49:15 -0700 | [diff] [blame] | 60 | #include "phy.h" |
Edmund Nadolski | 12ef654 | 2011-06-02 00:10:50 +0000 | [diff] [blame] | 61 | #include "isci.h" |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 62 | #include "remote_node_table.h" |
Dan Williams | 63a3a15 | 2011-05-08 21:36:46 -0700 | [diff] [blame] | 63 | #include "registers.h" |
Dan Williams | 63a3a15 | 2011-05-08 21:36:46 -0700 | [diff] [blame] | 64 | #include "unsolicited_frame_control.h" |
Dan Williams | e2f8db5 | 2011-05-10 02:28:46 -0700 | [diff] [blame] | 65 | #include "probe_roms.h" |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 66 | |
Dan Williams | 5076a1a | 2011-06-27 14:57:03 -0700 | [diff] [blame] | 67 | struct isci_request; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 68 | struct scu_task_context; |
| 69 | |
Dan Williams | e2f8db5 | 2011-05-10 02:28:46 -0700 | [diff] [blame] | 70 | |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 71 | /** |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 72 | * struct sci_power_control - |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 73 | * |
| 74 | * This structure defines the fields for managing power control for direct |
| 75 | * attached disk devices. |
| 76 | */ |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 77 | struct sci_power_control { |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 78 | /** |
| 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 Nadolski | 0473661 | 2011-05-19 20:17:47 -0700 | [diff] [blame] | 85 | * Timer to control when the directed attached disks can consume power. |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 86 | */ |
Edmund Nadolski | 0473661 | 2011-05-19 20:17:47 -0700 | [diff] [blame] | 87 | struct sci_timer timer; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 88 | |
| 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 Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 102 | * mapped into requesters via struct sci_phy.phy_index |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 103 | */ |
Dan Williams | 8528095 | 2011-06-28 15:05:53 -0700 | [diff] [blame] | 104 | struct isci_phy *requesters[SCI_MAX_PHYS]; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 105 | |
| 106 | }; |
| 107 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 108 | struct sci_port_configuration_agent; |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 109 | typedef void (*port_config_fn)(struct isci_host *, |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 110 | struct sci_port_configuration_agent *, |
Dan Williams | ffe191c | 2011-06-29 13:09:25 -0700 | [diff] [blame] | 111 | struct isci_port *, struct isci_phy *); |
Dan Williams | e2f8db5 | 2011-05-10 02:28:46 -0700 | [diff] [blame] | 112 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 113 | struct sci_port_configuration_agent { |
Dan Williams | e2f8db5 | 2011-05-10 02:28:46 -0700 | [diff] [blame] | 114 | u16 phy_configured_mask; |
| 115 | u16 phy_ready_mask; |
| 116 | struct { |
| 117 | u8 min_index; |
| 118 | u8 max_index; |
| 119 | } phy_valid_port_range[SCI_MAX_PHYS]; |
| 120 | bool timer_pending; |
| 121 | port_config_fn link_up_handler; |
| 122 | port_config_fn link_down_handler; |
Edmund Nadolski | ac0eeb4 | 2011-05-19 20:00:51 -0700 | [diff] [blame] | 123 | struct sci_timer timer; |
Dan Williams | e2f8db5 | 2011-05-10 02:28:46 -0700 | [diff] [blame] | 124 | }; |
| 125 | |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 126 | /** |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 127 | * isci_host - primary host/controller object |
| 128 | * @timer: timeout start/stop operations |
| 129 | * @device_table: rni (hw remote node index) to remote device lookup table |
| 130 | * @available_remote_nodes: rni allocator |
| 131 | * @power_control: manage device spin up |
| 132 | * @io_request_sequence: generation number for tci's (task contexts) |
| 133 | * @task_context_table: hw task context table |
| 134 | * @remote_node_context_table: hw remote node context table |
| 135 | * @completion_queue: hw-producer driver-consumer communication ring |
| 136 | * @completion_queue_get: tracks the driver 'head' of the ring to notify hw |
| 137 | * @logical_port_entries: min({driver|silicon}-supported-port-count) |
| 138 | * @remote_node_entries: min({driver|silicon}-supported-node-count) |
| 139 | * @task_context_entries: min({driver|silicon}-supported-task-count) |
| 140 | * @phy_timer: phy startup timer |
| 141 | * @invalid_phy_mask: if an invalid_link_up notification is reported a bit for |
| 142 | * the phy index is set so further notifications are not |
| 143 | * made. Once the phy reports link up and is made part of a |
| 144 | * port then this bit is cleared. |
| 145 | |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 146 | */ |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 147 | struct isci_host { |
Edmund Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 148 | struct sci_base_state_machine sm; |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 149 | /* XXX can we time this externally */ |
Edmund Nadolski | 6cb5853 | 2011-05-19 11:59:56 +0000 | [diff] [blame] | 150 | struct sci_timer timer; |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 151 | /* XXX drop reference module params directly */ |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 152 | struct sci_user_parameters user_parameters; |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 153 | /* XXX no need to be a union */ |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 154 | struct sci_oem_params oem_parameters; |
| 155 | struct sci_port_configuration_agent port_agent; |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 156 | struct isci_remote_device *device_table[SCI_MAX_REMOTE_DEVICES]; |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 157 | struct sci_remote_node_table available_remote_nodes; |
| 158 | struct sci_power_control power_control; |
Dan Williams | dd047c8 | 2011-06-09 11:06:58 -0700 | [diff] [blame] | 159 | u8 io_request_sequence[SCI_MAX_IO_REQUESTS]; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 160 | struct scu_task_context *task_context_table; |
Dan Williams | abec912 | 2012-02-15 13:58:42 -0800 | [diff] [blame^] | 161 | dma_addr_t tc_dma; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 162 | union scu_remote_node_context *remote_node_context_table; |
Dan Williams | abec912 | 2012-02-15 13:58:42 -0800 | [diff] [blame^] | 163 | dma_addr_t rnc_dma; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 164 | u32 *completion_queue; |
Dan Williams | abec912 | 2012-02-15 13:58:42 -0800 | [diff] [blame^] | 165 | dma_addr_t cq_dma; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 166 | u32 completion_queue_get; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 167 | u32 logical_port_entries; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 168 | u32 remote_node_entries; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 169 | u32 task_context_entries; |
Dan Williams | abec912 | 2012-02-15 13:58:42 -0800 | [diff] [blame^] | 170 | void *ufi_buf; |
| 171 | dma_addr_t ufi_dma; |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 172 | struct sci_unsolicited_frame_control uf_control; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 173 | |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 174 | /* phy startup */ |
Edmund Nadolski | bb3dbdf | 2011-05-19 20:26:02 -0700 | [diff] [blame] | 175 | struct sci_timer phy_timer; |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 176 | /* XXX kill */ |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 177 | bool phy_startup_timer_pending; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 178 | u32 next_phy_to_start; |
Dan Williams | 34a9915 | 2011-07-01 02:25:15 -0700 | [diff] [blame] | 179 | /* XXX convert to unsigned long and use bitops */ |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 180 | u8 invalid_phy_mask; |
| 181 | |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 182 | /* TODO attempt dynamic interrupt coalescing scheme */ |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 183 | u16 interrupt_coalesce_number; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 184 | u32 interrupt_coalesce_timeout; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 185 | struct smu_registers __iomem *smu_registers; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 186 | struct scu_registers __iomem *scu_registers; |
| 187 | |
Dan Williams | ac668c6 | 2011-06-07 18:50:55 -0700 | [diff] [blame] | 188 | u16 tci_head; |
| 189 | u16 tci_tail; |
| 190 | u16 tci_pool[SCI_MAX_IO_REQUESTS]; |
| 191 | |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 192 | int id; /* unique within a given pci device */ |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 193 | struct isci_phy phys[SCI_MAX_PHYS]; |
Dan Williams | e531381 | 2011-05-07 10:11:43 -0700 | [diff] [blame] | 194 | struct isci_port ports[SCI_MAX_PORTS + 1]; /* includes dummy port */ |
Dan Williams | c132f69 | 2012-01-03 23:26:08 -0800 | [diff] [blame] | 195 | struct asd_sas_port sas_ports[SCI_MAX_PORTS]; |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 196 | struct sas_ha_struct sas_ha; |
| 197 | |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 198 | struct pci_dev *pdev; |
Dan Williams | 0cf89d1 | 2011-02-18 09:25:07 -0800 | [diff] [blame] | 199 | #define IHOST_START_PENDING 0 |
| 200 | #define IHOST_STOP_PENDING 1 |
| 201 | unsigned long flags; |
| 202 | wait_queue_head_t eventq; |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 203 | struct Scsi_Host *shost; |
| 204 | struct tasklet_struct completion_tasklet; |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 205 | struct list_head requests_to_complete; |
Jeff Skirvin | 11b00c1 | 2011-03-04 14:06:40 -0800 | [diff] [blame] | 206 | struct list_head requests_to_errorback; |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 207 | spinlock_t scic_lock; |
Dan Williams | db05625 | 2011-06-17 14:18:39 -0700 | [diff] [blame] | 208 | struct isci_request *reqs[SCI_MAX_IO_REQUESTS]; |
Dan Williams | 57f20f4 | 2011-04-21 18:14:45 -0700 | [diff] [blame] | 209 | struct isci_remote_device devices[SCI_MAX_REMOTE_DEVICES]; |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 210 | }; |
| 211 | |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 212 | /** |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 213 | * enum sci_controller_states - This enumeration depicts all the states |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 214 | * for the common controller state machine. |
| 215 | */ |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 216 | enum sci_controller_states { |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 217 | /** |
| 218 | * Simply the initial state for the base controller state machine. |
| 219 | */ |
Edmund Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 220 | SCIC_INITIAL = 0, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 221 | |
| 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 Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 229 | SCIC_RESET, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 230 | |
| 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 Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 237 | SCIC_INITIALIZING, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 238 | |
| 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 Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 244 | SCIC_INITIALIZED, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 245 | |
| 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 Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 251 | SCIC_STARTING, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 252 | |
| 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 Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 258 | SCIC_READY, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 259 | |
| 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 Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 269 | SCIC_RESETTING, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 270 | |
| 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 Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 277 | SCIC_STOPPING, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 278 | |
| 279 | /** |
| 280 | * This state indicates that the controller has successfully been stopped. |
| 281 | * In this state no new IO operations are permitted. |
| 282 | * This state is entered from the STOPPING state. |
| 283 | */ |
Edmund Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 284 | SCIC_STOPPED, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 285 | |
| 286 | /** |
| 287 | * This state indicates that the controller could not successfully be |
| 288 | * initialized. In this state no new IO operations are permitted. |
| 289 | * This state is entered from the INITIALIZING state. |
| 290 | * This state is entered from the STARTING state. |
| 291 | * This state is entered from the STOPPING state. |
| 292 | * This state is entered from the RESETTING state. |
| 293 | */ |
Edmund Nadolski | e301370 | 2011-06-02 00:10:43 +0000 | [diff] [blame] | 294 | SCIC_FAILED, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 295 | }; |
| 296 | |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 297 | /** |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 298 | * struct isci_pci_info - This class represents the pci function containing the |
| 299 | * controllers. Depending on PCI SKU, there could be up to 2 controllers in |
| 300 | * the PCI function. |
| 301 | */ |
| 302 | #define SCI_MAX_MSIX_INT (SCI_NUM_MSI_X_INT*SCI_MAX_CONTROLLERS) |
| 303 | |
| 304 | struct isci_pci_info { |
| 305 | struct msix_entry msix_entries[SCI_MAX_MSIX_INT]; |
Dan Williams | b329aff | 2011-03-07 16:02:25 -0800 | [diff] [blame] | 306 | struct isci_host *hosts[SCI_MAX_CONTROLLERS]; |
Dan Williams | d044af1 | 2011-03-08 09:52:49 -0800 | [diff] [blame] | 307 | struct isci_orom *orom; |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 308 | }; |
| 309 | |
| 310 | static inline struct isci_pci_info *to_pci_info(struct pci_dev *pdev) |
| 311 | { |
| 312 | return pci_get_drvdata(pdev); |
| 313 | } |
| 314 | |
Dan Williams | b329aff | 2011-03-07 16:02:25 -0800 | [diff] [blame] | 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]) |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 319 | |
Dan Williams | 0cf89d1 | 2011-02-18 09:25:07 -0800 | [diff] [blame] | 320 | static inline void wait_for_start(struct isci_host *ihost) |
| 321 | { |
| 322 | wait_event(ihost->eventq, !test_bit(IHOST_START_PENDING, &ihost->flags)); |
| 323 | } |
| 324 | |
| 325 | static inline void wait_for_stop(struct isci_host *ihost) |
| 326 | { |
| 327 | wait_event(ihost->eventq, !test_bit(IHOST_STOP_PENDING, &ihost->flags)); |
| 328 | } |
| 329 | |
Dan Williams | 6ad31fe | 2011-03-04 12:10:29 -0800 | [diff] [blame] | 330 | static inline void wait_for_device_start(struct isci_host *ihost, struct isci_remote_device *idev) |
| 331 | { |
| 332 | wait_event(ihost->eventq, !test_bit(IDEV_START_PENDING, &idev->flags)); |
| 333 | } |
| 334 | |
| 335 | static inline void wait_for_device_stop(struct isci_host *ihost, struct isci_remote_device *idev) |
| 336 | { |
Dan Williams | d9c3739 | 2011-03-03 17:59:32 -0800 | [diff] [blame] | 337 | wait_event(ihost->eventq, !test_bit(IDEV_STOP_PENDING, &idev->flags)); |
Dan Williams | 6ad31fe | 2011-03-04 12:10:29 -0800 | [diff] [blame] | 338 | } |
Dan Williams | 0cf89d1 | 2011-02-18 09:25:07 -0800 | [diff] [blame] | 339 | |
Dan Williams | 4393aa4 | 2011-03-31 13:10:44 -0700 | [diff] [blame] | 340 | static inline struct isci_host *dev_to_ihost(struct domain_device *dev) |
| 341 | { |
| 342 | return dev->port->ha->lldd_ha; |
| 343 | } |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 344 | |
Dan Williams | 34a9915 | 2011-07-01 02:25:15 -0700 | [diff] [blame] | 345 | /* we always use protocol engine group zero */ |
| 346 | #define ISCI_PEG 0 |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 347 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 348 | /* see sci_controller_io_tag_allocate|free for how seq and tci are built */ |
Dan Williams | dd047c8 | 2011-06-09 11:06:58 -0700 | [diff] [blame] | 349 | #define ISCI_TAG(seq, tci) (((u16) (seq)) << 12 | tci) |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 350 | |
Dan Williams | dd047c8 | 2011-06-09 11:06:58 -0700 | [diff] [blame] | 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)) |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 354 | |
Dan Williams | 9b4be52 | 2011-07-29 17:17:10 -0700 | [diff] [blame] | 355 | /* interrupt coalescing baseline: 9 == 3 to 5us interrupt delay per command */ |
| 356 | #define ISCI_COALESCE_BASE 9 |
| 357 | |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 358 | /* expander attached sata devices require 3 rnc slots */ |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 359 | static inline int sci_remote_device_node_count(struct isci_remote_device *idev) |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 360 | { |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 361 | struct domain_device *dev = idev->domain_dev; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 362 | |
Dan Williams | 11cc518 | 2012-02-01 00:23:10 -0800 | [diff] [blame] | 363 | if (dev_is_sata(dev) && dev->parent) |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 364 | return SCU_STP_REMOTE_NODE_COUNT; |
| 365 | return SCU_SSP_REMOTE_NODE_COUNT; |
| 366 | } |
| 367 | |
| 368 | /** |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 369 | * sci_controller_clear_invalid_phy() - |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 370 | * |
| 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 |
| 373 | * notifications. |
| 374 | */ |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 375 | #define sci_controller_clear_invalid_phy(controller, phy) \ |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 376 | ((controller)->invalid_phy_mask &= ~(1 << (phy)->phy_index)) |
| 377 | |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 378 | static inline struct device *scirdev_to_dev(struct isci_remote_device *idev) |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 379 | { |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 380 | if (!idev || !idev->isci_port || !idev->isci_port->isci_host) |
| 381 | return NULL; |
| 382 | |
| 383 | return &idev->isci_port->isci_host->pdev->dev; |
| 384 | } |
| 385 | |
Dan Williams | dc00c8b | 2011-07-01 11:41:21 -0700 | [diff] [blame] | 386 | static inline bool is_a2(struct pci_dev *pdev) |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 387 | { |
Dan Williams | dc00c8b | 2011-07-01 11:41:21 -0700 | [diff] [blame] | 388 | if (pdev->revision < 4) |
| 389 | return true; |
| 390 | return false; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 391 | } |
| 392 | |
Dan Williams | dc00c8b | 2011-07-01 11:41:21 -0700 | [diff] [blame] | 393 | static inline bool is_b0(struct pci_dev *pdev) |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 394 | { |
Dan Williams | dc00c8b | 2011-07-01 11:41:21 -0700 | [diff] [blame] | 395 | if (pdev->revision == 4) |
| 396 | return true; |
| 397 | return false; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 398 | } |
| 399 | |
Dan Williams | dc00c8b | 2011-07-01 11:41:21 -0700 | [diff] [blame] | 400 | static inline bool is_c0(struct pci_dev *pdev) |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 401 | { |
Jeff Skirvin | afd13a1 | 2012-01-04 01:32:39 -0800 | [diff] [blame] | 402 | if (pdev->revision == 5) |
| 403 | return true; |
| 404 | return false; |
| 405 | } |
| 406 | |
| 407 | static inline bool is_c1(struct pci_dev *pdev) |
| 408 | { |
| 409 | if (pdev->revision >= 6) |
Dan Williams | dc00c8b | 2011-07-01 11:41:21 -0700 | [diff] [blame] | 410 | return true; |
| 411 | return false; |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 412 | } |
| 413 | |
Jeff Skirvin | 9fee607 | 2012-01-04 01:32:49 -0800 | [diff] [blame] | 414 | enum cable_selections { |
| 415 | short_cable = 0, |
| 416 | long_cable = 1, |
| 417 | medium_cable = 2, |
| 418 | undefined_cable = 3 |
| 419 | }; |
| 420 | |
| 421 | #define CABLE_OVERRIDE_DISABLED (0x10000) |
| 422 | |
| 423 | static inline int is_cable_select_overridden(void) |
| 424 | { |
| 425 | return cable_selection_override < CABLE_OVERRIDE_DISABLED; |
| 426 | } |
| 427 | |
| 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); |
| 431 | |
Dan Williams | ad4f4c1 | 2011-09-01 21:18:31 -0700 | [diff] [blame] | 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 |
| 435 | * FSENG output |
| 436 | */ |
| 437 | #define SGPIO_HW_CONTROL 0x00000443 |
| 438 | |
| 439 | static inline int isci_gpio_count(struct isci_host *ihost) |
| 440 | { |
| 441 | return ARRAY_SIZE(ihost->scu_registers->peg0.sgpio.output_data_select); |
| 442 | } |
| 443 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 444 | void sci_controller_post_request(struct isci_host *ihost, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 445 | u32 request); |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 446 | void sci_controller_release_frame(struct isci_host *ihost, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 447 | u32 frame_index); |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 448 | void sci_controller_copy_sata_response(void *response_buffer, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 449 | void *frame_header, |
| 450 | void *frame_buffer); |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 451 | enum sci_status sci_controller_allocate_remote_node_context(struct isci_host *ihost, |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 452 | struct isci_remote_device *idev, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 453 | u16 *node_id); |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 454 | void sci_controller_free_remote_node_context( |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 455 | struct isci_host *ihost, |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 456 | struct isci_remote_device *idev, |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 457 | u16 node_id); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 458 | |
Dan Williams | abec912 | 2012-02-15 13:58:42 -0800 | [diff] [blame^] | 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); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 470 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 471 | enum sci_status sci_controller_continue_io(struct isci_request *ireq); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 472 | int isci_host_scan_finished(struct Scsi_Host *, unsigned long); |
| 473 | void isci_host_scan_start(struct Scsi_Host *); |
Dan Williams | 312e0c2 | 2011-06-28 13:47:09 -0700 | [diff] [blame] | 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); |
Dan Williams | 6f231dd | 2011-07-02 22:56:22 -0700 | [diff] [blame] | 477 | |
| 478 | int isci_host_init(struct isci_host *); |
Dan Williams | abec912 | 2012-02-15 13:58:42 -0800 | [diff] [blame^] | 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); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 482 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 483 | enum sci_status sci_controller_start_io( |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 484 | struct isci_host *ihost, |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 485 | struct isci_remote_device *idev, |
Dan Williams | 5076a1a | 2011-06-27 14:57:03 -0700 | [diff] [blame] | 486 | struct isci_request *ireq); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 487 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 488 | enum sci_task_status sci_controller_start_task( |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 489 | struct isci_host *ihost, |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 490 | struct isci_remote_device *idev, |
Dan Williams | 5076a1a | 2011-06-27 14:57:03 -0700 | [diff] [blame] | 491 | struct isci_request *ireq); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 492 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 493 | enum sci_status sci_controller_terminate_request( |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 494 | struct isci_host *ihost, |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 495 | struct isci_remote_device *idev, |
Dan Williams | 5076a1a | 2011-06-27 14:57:03 -0700 | [diff] [blame] | 496 | struct isci_request *ireq); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 497 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 498 | enum sci_status sci_controller_complete_io( |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 499 | struct isci_host *ihost, |
Dan Williams | 78a6f06 | 2011-06-30 16:31:37 -0700 | [diff] [blame] | 500 | struct isci_remote_device *idev, |
Dan Williams | 5076a1a | 2011-06-27 14:57:03 -0700 | [diff] [blame] | 501 | struct isci_request *ireq); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 502 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 503 | void sci_port_configuration_agent_construct( |
| 504 | struct sci_port_configuration_agent *port_agent); |
Dan Williams | e2f8db5 | 2011-05-10 02:28:46 -0700 | [diff] [blame] | 505 | |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 506 | enum sci_status sci_port_configuration_agent_initialize( |
Dan Williams | d9dcb4b | 2011-06-30 17:38:32 -0700 | [diff] [blame] | 507 | struct isci_host *ihost, |
Dan Williams | 89a7301 | 2011-06-30 19:14:33 -0700 | [diff] [blame] | 508 | struct sci_port_configuration_agent *port_agent); |
Dan Williams | ad4f4c1 | 2011-09-01 21:18:31 -0700 | [diff] [blame] | 509 | |
| 510 | int isci_gpio_write(struct sas_ha_struct *, u8 reg_type, u8 reg_index, |
| 511 | u8 reg_count, u8 *write_data); |
Dan Williams | cc9203b | 2011-05-08 17:34:44 -0700 | [diff] [blame] | 512 | #endif |