blob: fb9f5e7f8209447771d07016bca7924774b143af [file] [log] [blame]
Stephen M. Cameronedd16362009-12-08 14:09:11 -08001/*
2 * Disk Array driver for HP Smart Array SAS controllers
Don Brace94c7bc32016-02-23 15:16:46 -06003 * Copyright 2016 Microsemi Corporation
Don Brace1358f6d2015-07-18 11:12:38 -05004 * Copyright 2014-2015 PMC-Sierra, Inc.
5 * Copyright 2000,2009-2015 Hewlett-Packard Development Company, L.P.
Stephen M. Cameronedd16362009-12-08 14:09:11 -08006 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
14 * NON INFRINGEMENT. See the GNU General Public License for more details.
15 *
Don Brace94c7bc32016-02-23 15:16:46 -060016 * Questions/Comments/Bugfixes to esc.storagedev@microsemi.com
Stephen M. Cameronedd16362009-12-08 14:09:11 -080017 *
18 */
19#ifndef HPSA_H
20#define HPSA_H
21
22#include <scsi/scsicam.h>
23
24#define IO_OK 0
25#define IO_ERROR 1
26
27struct ctlr_info;
28
29struct access_method {
30 void (*submit_command)(struct ctlr_info *h,
31 struct CommandList *c);
32 void (*set_intr_mask)(struct ctlr_info *h, unsigned long val);
Stephen M. Cameron900c5442010-02-04 08:42:35 -060033 bool (*intr_pending)(struct ctlr_info *h);
Matt Gates254f7962012-05-01 11:43:06 -050034 unsigned long (*command_completed)(struct ctlr_info *h, u8 q);
Stephen M. Cameronedd16362009-12-08 14:09:11 -080035};
36
Kevin Barnettd04e62b2015-11-04 15:52:34 -060037/* for SAS hosts and SAS expanders */
38struct hpsa_sas_node {
39 struct device *parent_dev;
40 struct list_head port_list_head;
41};
42
43struct hpsa_sas_port {
44 struct list_head port_list_entry;
45 u64 sas_address;
46 struct sas_port *port;
47 int next_phy_index;
48 struct list_head phy_list_head;
49 struct hpsa_sas_node *parent_node;
50 struct sas_rphy *rphy;
51};
52
53struct hpsa_sas_phy {
54 struct list_head phy_list_entry;
55 struct sas_phy *phy;
56 struct hpsa_sas_port *parent_port;
57 bool added_to_port;
58};
59
Don Brace50864352017-05-04 17:51:28 -050060#define EXTERNAL_QD 7
Stephen M. Cameronedd16362009-12-08 14:09:11 -080061struct hpsa_scsi_dev_t {
Don Brace3ad7de62015-11-04 15:50:19 -060062 unsigned int devtype;
Stephen M. Cameronedd16362009-12-08 14:09:11 -080063 int bus, target, lun; /* as presented to the OS */
64 unsigned char scsi3addr[8]; /* as presented to the HW */
Kevin Barnett04fa2f42015-11-04 15:51:27 -060065 u8 physical_device : 1;
Kevin Barnett2a168202015-11-04 15:51:21 -060066 u8 expose_device;
Don Braceba74fdc2016-04-27 17:14:17 -050067 u8 removed : 1; /* device is marked for death */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080068#define RAID_CTLR_LUNID "\0\0\0\0\0\0\0\0"
69 unsigned char device_id[16]; /* from inquiry pg. 0x83 */
Kevin Barnettd04e62b2015-11-04 15:52:34 -060070 u64 sas_address;
Stephen M. Cameronedd16362009-12-08 14:09:11 -080071 unsigned char vendor[8]; /* bytes 8-15 of inquiry data */
72 unsigned char model[16]; /* bytes 16-31 of inquiry data */
Hannes Reinecke7630b3a2016-11-17 12:15:56 +010073 unsigned char rev; /* byte 2 of inquiry data */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080074 unsigned char raid_level; /* from inquiry page 0xC1 */
Stephen M. Cameron98465902014-02-21 16:25:00 -060075 unsigned char volume_offline; /* discovered via TUR or VPD */
Don Brace03383732015-01-23 16:43:30 -060076 u16 queue_depth; /* max queue_depth for this device */
Webb Scalesd604f532015-04-23 09:35:22 -050077 atomic_t reset_cmds_out; /* Count of commands to-be affected */
Don Brace03383732015-01-23 16:43:30 -060078 atomic_t ioaccel_cmds_out; /* Only used for physical devices
79 * counts commands sent to physical
80 * device via "ioaccel" path.
81 */
Matt Gatese1f7de02014-02-18 13:55:17 -060082 u32 ioaccel_handle;
Joe Handzik8270b862015-07-18 11:12:43 -050083 u8 active_path_index;
84 u8 path_map;
85 u8 bay;
86 u8 box[8];
87 u16 phys_connector[8];
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060088 int offload_config; /* I/O accel RAID offload configured */
89 int offload_enabled; /* I/O accel RAID offload enabled */
Stephen Cameron41ce4c32015-04-23 09:31:47 -050090 int offload_to_be_enabled;
Joe Handzika3144e02015-04-23 09:32:59 -050091 int hba_ioaccel_enabled;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060092 int offload_to_mirror; /* Send next I/O accelerator RAID
93 * offload request to mirror drive
94 */
95 struct raid_map_data raid_map; /* I/O accelerator RAID map */
96
Don Brace03383732015-01-23 16:43:30 -060097 /*
98 * Pointers from logical drive map indices to the phys drives that
99 * make those logical drives. Note, multiple logical drives may
100 * share physical drives. You can have for instance 5 physical
101 * drives with 3 logical drives each using those same 5 physical
102 * disks. We need these pointers for counting i/o's out to physical
103 * devices in order to honor physical device queue depth limits.
104 */
105 struct hpsa_scsi_dev_t *phys_disk[RAID_MAP_MAX_ENTRIES];
Webb Scalesd604f532015-04-23 09:35:22 -0500106 int nphysical_disks;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500107 int supports_aborts;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600108 struct hpsa_sas_port *sas_port;
Scott Teel66749d02015-11-04 15:51:57 -0600109 int external; /* 1-from external array 0-not <0-unknown */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800110};
111
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500112struct reply_queue_buffer {
Matt Gates254f7962012-05-01 11:43:06 -0500113 u64 *head;
114 size_t size;
115 u8 wraparound;
116 u32 current_entry;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500117 dma_addr_t busaddr;
Matt Gates254f7962012-05-01 11:43:06 -0500118};
119
Stephen M. Cameron316b2212014-02-21 16:25:15 -0600120#pragma pack(1)
121struct bmic_controller_parameters {
122 u8 led_flags;
123 u8 enable_command_list_verification;
124 u8 backed_out_write_drives;
125 u16 stripes_for_parity;
126 u8 parity_distribution_mode_flags;
127 u16 max_driver_requests;
128 u16 elevator_trend_count;
129 u8 disable_elevator;
130 u8 force_scan_complete;
131 u8 scsi_transfer_mode;
132 u8 force_narrow;
133 u8 rebuild_priority;
134 u8 expand_priority;
135 u8 host_sdb_asic_fix;
136 u8 pdpi_burst_from_host_disabled;
137 char software_name[64];
138 char hardware_name[32];
139 u8 bridge_revision;
140 u8 snapshot_priority;
141 u32 os_specific;
142 u8 post_prompt_timeout;
143 u8 automatic_drive_slamming;
144 u8 reserved1;
145 u8 nvram_flags;
146 u8 cache_nvram_flags;
147 u8 drive_config_flags;
148 u16 reserved2;
149 u8 temp_warning_level;
150 u8 temp_shutdown_level;
151 u8 temp_condition_reset;
152 u8 max_coalesce_commands;
153 u32 max_coalesce_delay;
154 u8 orca_password[4];
155 u8 access_id[16];
156 u8 reserved[356];
157};
158#pragma pack()
159
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800160struct ctlr_info {
Ming Lei8b834bf2018-03-13 17:42:39 +0800161 unsigned int *reply_map;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800162 int ctlr;
163 char devname[8];
164 char *product_name;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800165 struct pci_dev *pdev;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600166 u32 board_id;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600167 u64 sas_address;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800168 void __iomem *vaddr;
169 unsigned long paddr;
170 int nr_cmds; /* Number of commands allowed on this controller */
Stephen Camerond54c5c22015-01-23 16:42:59 -0600171#define HPSA_CMDS_RESERVED_FOR_ABORTS 2
172#define HPSA_CMDS_RESERVED_FOR_DRIVER 1
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800173 struct CfgTable __iomem *cfgtable;
174 int interrupts_enabled;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800175 int max_commands;
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600176 atomic_t commands_outstanding;
Don Brace303932f2010-02-04 08:42:40 -0600177# define PERF_MODE_INT 0
178# define DOORBELL_INT 1
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800179# define SIMPLE_MODE_INT 2
180# define MEMQ_MODE_INT 3
Christoph Hellwigbc2bb152016-11-09 10:42:22 -0800181 unsigned int msix_vectors;
Stephen M. Camerona9a3a272011-02-15 15:32:53 -0600182 int intr_mode; /* either PERF_MODE_INT or SIMPLE_MODE_INT */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800183 struct access_method access;
184
185 /* queue and queue Info */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800186 unsigned int Qdepth;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800187 unsigned int maxSG;
188 spinlock_t lock;
Stephen M. Cameron33a2ffc2010-02-25 14:03:27 -0600189 int maxsgentries;
190 u8 max_cmd_sg_entries;
191 int chainsize;
192 struct SGDescriptor **cmd_sg_list;
Webb Scalesd9a729f2015-04-23 09:33:27 -0500193 struct ioaccel2_sg_element **ioaccel2_cmd_sg_list;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800194
195 /* pointers to command and error info pool */
196 struct CommandList *cmd_pool;
197 dma_addr_t cmd_pool_dhandle;
Matt Gatese1f7de02014-02-18 13:55:17 -0600198 struct io_accel1_cmd *ioaccel_cmd_pool;
199 dma_addr_t ioaccel_cmd_pool_dhandle;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600200 struct io_accel2_cmd *ioaccel2_cmd_pool;
201 dma_addr_t ioaccel2_cmd_pool_dhandle;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800202 struct ErrorInfo *errinfo_pool;
203 dma_addr_t errinfo_pool_dhandle;
204 unsigned long *cmd_pool_bits;
Stephen M. Camerona08a8472010-02-04 08:43:16 -0600205 int scan_finished;
Don Brace87b9e6a2017-03-10 14:35:17 -0600206 u8 scan_waiting : 1;
Stephen M. Camerona08a8472010-02-04 08:43:16 -0600207 spinlock_t scan_lock;
208 wait_queue_head_t scan_wait_queue;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800209
210 struct Scsi_Host *scsi_host;
211 spinlock_t devlock; /* to protect hba[ctlr]->dev[]; */
212 int ndevices; /* number of used elements in .dev[] array. */
Scott Teelcfe5bad2011-10-26 16:21:07 -0500213 struct hpsa_scsi_dev_t *dev[HPSA_MAX_DEVICES];
Don Brace303932f2010-02-04 08:42:40 -0600214 /*
215 * Performant mode tables.
216 */
217 u32 trans_support;
218 u32 trans_offset;
Don Brace42a91642014-11-14 17:26:27 -0600219 struct TransTable_struct __iomem *transtable;
Don Brace303932f2010-02-04 08:42:40 -0600220 unsigned long transMethod;
221
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500222 /* cap concurrent passthrus at some reasonable maximum */
Stephen Cameron45fcb862015-01-23 16:43:04 -0600223#define HPSA_MAX_CONCURRENT_PASSTHRUS (10)
Don Brace34f0c622015-01-23 16:43:46 -0600224 atomic_t passthru_cmds_avail;
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500225
Don Brace303932f2010-02-04 08:42:40 -0600226 /*
Matt Gates254f7962012-05-01 11:43:06 -0500227 * Performant mode completion buffers
Don Brace303932f2010-02-04 08:42:40 -0600228 */
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500229 size_t reply_queue_size;
230 struct reply_queue_buffer reply_queue[MAX_REPLY_QUEUES];
Matt Gates254f7962012-05-01 11:43:06 -0500231 u8 nreply_queues;
Don Brace303932f2010-02-04 08:42:40 -0600232 u32 *blockFetchTable;
Matt Gatese1f7de02014-02-18 13:55:17 -0600233 u32 *ioaccel1_blockFetchTable;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600234 u32 *ioaccel2_blockFetchTable;
Don Brace42a91642014-11-14 17:26:27 -0600235 u32 __iomem *ioaccel2_bft2_regs;
Stephen M. Cameron339b2b12010-02-04 08:42:50 -0600236 unsigned char *hba_inquiry_data;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600237 u32 driver_support;
238 u32 fw_support;
239 int ioaccel_support;
240 int ioaccel_maxsg;
Stephen M. Camerona0c12412011-10-26 16:22:04 -0500241 u64 last_intr_timestamp;
242 u32 last_heartbeat;
243 u64 last_heartbeat_timestamp;
Stephen M. Camerone85c5972012-05-01 11:43:42 -0500244 u32 heartbeat_sample_interval;
245 atomic_t firmware_flash_in_progress;
Don Brace42a91642014-11-14 17:26:27 -0600246 u32 __percpu *lockup_detected;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600247 struct delayed_work monitor_ctlr_work;
Don Brace6636e7f2015-01-23 16:45:17 -0600248 struct delayed_work rescan_ctlr_work;
Scott Teel3d38f002017-05-04 17:51:36 -0500249 struct delayed_work event_monitor_work;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600250 int remove_in_progress;
Matt Gates254f7962012-05-01 11:43:06 -0500251 /* Address of h->q[x] is passed to intr handler to know which queue */
252 u8 q[MAX_REPLY_QUEUES];
Robert Elliott8b470042015-04-23 09:34:58 -0500253 char intrname[MAX_REPLY_QUEUES][16]; /* "hpsa0-msix00" names */
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500254 u32 TMFSupportFlags; /* cache what task mgmt funcs are supported. */
255#define HPSATMF_BITS_SUPPORTED (1 << 0)
256#define HPSATMF_PHYS_LUN_RESET (1 << 1)
257#define HPSATMF_PHYS_NEX_RESET (1 << 2)
258#define HPSATMF_PHYS_TASK_ABORT (1 << 3)
259#define HPSATMF_PHYS_TSET_ABORT (1 << 4)
260#define HPSATMF_PHYS_CLEAR_ACA (1 << 5)
261#define HPSATMF_PHYS_CLEAR_TSET (1 << 6)
262#define HPSATMF_PHYS_QRY_TASK (1 << 7)
263#define HPSATMF_PHYS_QRY_TSET (1 << 8)
264#define HPSATMF_PHYS_QRY_ASYNC (1 << 9)
Stephen Cameron8be986c2015-04-23 09:34:06 -0500265#define HPSATMF_IOACCEL_ENABLED (1 << 15)
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500266#define HPSATMF_MASK_SUPPORTED (1 << 16)
267#define HPSATMF_LOG_LUN_RESET (1 << 17)
268#define HPSATMF_LOG_NEX_RESET (1 << 18)
269#define HPSATMF_LOG_TASK_ABORT (1 << 19)
270#define HPSATMF_LOG_TSET_ABORT (1 << 20)
271#define HPSATMF_LOG_CLEAR_ACA (1 << 21)
272#define HPSATMF_LOG_CLEAR_TSET (1 << 22)
273#define HPSATMF_LOG_QRY_TASK (1 << 23)
274#define HPSATMF_LOG_QRY_TSET (1 << 24)
275#define HPSATMF_LOG_QRY_ASYNC (1 << 25)
Stephen M. Cameron76438d02014-02-18 13:55:43 -0600276 u32 events;
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600277#define CTLR_STATE_CHANGE_EVENT (1 << 0)
278#define CTLR_ENCLOSURE_HOT_PLUG_EVENT (1 << 1)
279#define CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV (1 << 4)
280#define CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV (1 << 5)
281#define CTLR_STATE_CHANGE_EVENT_REDUNDANT_CNTRL (1 << 6)
282#define CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED (1 << 30)
283#define CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE (1 << 31)
284
285#define RESCAN_REQUIRED_EVENT_BITS \
Stephen M. Cameron7b2c46e2014-05-29 10:53:44 -0500286 (CTLR_ENCLOSURE_HOT_PLUG_EVENT | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600287 CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV | \
288 CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600289 CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED | \
290 CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE)
Stephen M. Cameron98465902014-02-21 16:25:00 -0600291 spinlock_t offline_device_lock;
292 struct list_head offline_device_list;
Scott Teelda0697b2014-02-18 13:57:00 -0600293 int acciopath_status;
Don Brace853633e2015-11-04 15:50:37 -0600294 int drv_req_rescan;
Stephen M. Cameron2ba8bfc2014-02-18 13:57:52 -0600295 int raid_offload_debug;
Scott Teel34592252015-11-04 15:52:09 -0600296 int discovery_polling;
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200297 int legacy_board;
Scott Teel34592252015-11-04 15:52:09 -0600298 struct ReportLUNdata *lastlogicals;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500299 int needs_abort_tags_swizzled;
Don Brace080ef1c2015-01-23 16:43:25 -0600300 struct workqueue_struct *resubmit_wq;
Don Brace6636e7f2015-01-23 16:45:17 -0600301 struct workqueue_struct *rescan_ctlr_wq;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500302 atomic_t abort_cmds_available;
Webb Scalesd604f532015-04-23 09:35:22 -0500303 wait_queue_head_t event_sync_wait_queue;
304 struct mutex reset_mutex;
Don Braceda03ded2015-11-04 15:50:56 -0600305 u8 reset_in_progress;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600306 struct hpsa_sas_node *sas_host;
Don Bracec59d04f2017-05-04 17:51:22 -0500307 spinlock_t reset_lock;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800308};
Stephen M. Cameron98465902014-02-21 16:25:00 -0600309
310struct offline_device_entry {
311 unsigned char scsi3addr[8];
312 struct list_head offline_list;
313};
314
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800315#define HPSA_ABORT_MSG 0
316#define HPSA_DEVICE_RESET_MSG 1
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500317#define HPSA_RESET_TYPE_CONTROLLER 0x00
318#define HPSA_RESET_TYPE_BUS 0x01
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500319#define HPSA_RESET_TYPE_LUN 0x04
Scott Teel0b9b7b62015-11-04 15:51:02 -0600320#define HPSA_PHYS_TARGET_RESET 0x99 /* not defined by cciss spec */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800321#define HPSA_MSG_SEND_RETRY_LIMIT 10
Stephen M. Cameron516fda42011-05-03 14:59:15 -0500322#define HPSA_MSG_SEND_RETRY_INTERVAL_MSECS (10000)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800323
324/* Maximum time in seconds driver will wait for command completions
325 * when polling before giving up.
326 */
327#define HPSA_MAX_POLL_TIME_SECS (20)
328
329/* During SCSI error recovery, HPSA_TUR_RETRY_LIMIT defines
330 * how many times to retry TEST UNIT READY on a device
331 * while waiting for it to become ready before giving up.
332 * HPSA_MAX_WAIT_INTERVAL_SECS is the max wait interval
333 * between sending TURs while waiting for a device
334 * to become ready.
335 */
336#define HPSA_TUR_RETRY_LIMIT (20)
337#define HPSA_MAX_WAIT_INTERVAL_SECS (30)
338
339/* HPSA_BOARD_READY_WAIT_SECS is how long to wait for a board
340 * to become ready, in seconds, before giving up on it.
341 * HPSA_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
342 * between polling the board to see if it is ready, in
343 * milliseconds. HPSA_BOARD_READY_POLL_INTERVAL and
344 * HPSA_BOARD_READY_ITERATIONS are derived from those.
345 */
346#define HPSA_BOARD_READY_WAIT_SECS (120)
Stephen M. Cameron2ed71272011-05-03 14:59:31 -0500347#define HPSA_BOARD_NOT_READY_WAIT_SECS (100)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800348#define HPSA_BOARD_READY_POLL_INTERVAL_MSECS (100)
349#define HPSA_BOARD_READY_POLL_INTERVAL \
350 ((HPSA_BOARD_READY_POLL_INTERVAL_MSECS * HZ) / 1000)
351#define HPSA_BOARD_READY_ITERATIONS \
352 ((HPSA_BOARD_READY_WAIT_SECS * 1000) / \
353 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronfe5389c2011-01-06 14:48:03 -0600354#define HPSA_BOARD_NOT_READY_ITERATIONS \
355 ((HPSA_BOARD_NOT_READY_WAIT_SECS * 1000) / \
356 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800357#define HPSA_POST_RESET_PAUSE_MSECS (3000)
358#define HPSA_POST_RESET_NOOP_RETRIES (12)
359
360/* Defining the diffent access_menthods */
361/*
362 * Memory mapped FIFO interface (SMART 53xx cards)
363 */
364#define SA5_DOORBELL 0x20
365#define SA5_REQUEST_PORT_OFFSET 0x40
Webb Scales281a7fd2015-01-23 16:43:35 -0600366#define SA5_REQUEST_PORT64_LO_OFFSET 0xC0
367#define SA5_REQUEST_PORT64_HI_OFFSET 0xC4
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800368#define SA5_REPLY_INTR_MASK_OFFSET 0x34
369#define SA5_REPLY_PORT_OFFSET 0x44
370#define SA5_INTR_STATUS 0x30
371#define SA5_SCRATCHPAD_OFFSET 0xB0
372
373#define SA5_CTCFG_OFFSET 0xB4
374#define SA5_CTMEM_OFFSET 0xB8
375
376#define SA5_INTR_OFF 0x08
377#define SA5B_INTR_OFF 0x04
378#define SA5_INTR_PENDING 0x08
379#define SA5B_INTR_PENDING 0x04
380#define FIFO_EMPTY 0xffffffff
381#define HPSA_FIRMWARE_READY 0xffff0000 /* value in scratchpad register */
382
383#define HPSA_ERROR_BIT 0x02
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800384
Don Brace303932f2010-02-04 08:42:40 -0600385/* Performant mode flags */
386#define SA5_PERF_INTR_PENDING 0x04
387#define SA5_PERF_INTR_OFF 0x05
388#define SA5_OUTDB_STATUS_PERF_BIT 0x01
389#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
390#define SA5_OUTDB_CLEAR 0xA0
391#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
392#define SA5_OUTDB_STATUS 0x9C
393
394
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800395#define HPSA_INTR_ON 1
396#define HPSA_INTR_OFF 0
Mike Millerb66cc252014-02-18 13:56:04 -0600397
398/*
399 * Inbound Post Queue offsets for IO Accelerator Mode 2
400 */
401#define IOACCEL2_INBOUND_POSTQ_32 0x48
402#define IOACCEL2_INBOUND_POSTQ_64_LOW 0xd0
403#define IOACCEL2_INBOUND_POSTQ_64_HI 0xd4
404
Kevin Barnettc7955052015-11-04 15:51:45 -0600405#define HPSA_PHYSICAL_DEVICE_BUS 0
406#define HPSA_RAID_VOLUME_BUS 1
407#define HPSA_EXTERNAL_RAID_VOLUME_BUS 2
Don Brace09371d62015-12-22 10:36:42 -0600408#define HPSA_HBA_BUS 0
Hannes Reinecke7630b3a2016-11-17 12:15:56 +0100409#define HPSA_LEGACY_HBA_BUS 3
Kevin Barnettc7955052015-11-04 15:51:45 -0600410
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800411/*
412 Send the command to the hardware
413*/
414static void SA5_submit_command(struct ctlr_info *h,
415 struct CommandList *c)
416{
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800417 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Stephen M. Cameronfec62c32011-07-21 13:16:05 -0500418 (void) readl(h->vaddr + SA5_SCRATCHPAD_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800419}
420
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500421static void SA5_submit_command_no_read(struct ctlr_info *h,
422 struct CommandList *c)
423{
424 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
425}
426
Scott Teelc3497752014-02-18 13:56:34 -0600427static void SA5_submit_command_ioaccel2(struct ctlr_info *h,
428 struct CommandList *c)
429{
Stephen Cameronc05e8862015-01-23 16:44:40 -0600430 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Scott Teelc3497752014-02-18 13:56:34 -0600431}
432
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800433/*
434 * This card is the opposite of the other cards.
435 * 0 turns interrupts on...
436 * 0x08 turns them off...
437 */
438static void SA5_intr_mask(struct ctlr_info *h, unsigned long val)
439{
440 if (val) { /* Turn interrupts on */
441 h->interrupts_enabled = 1;
442 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500443 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800444 } else { /* Turn them off */
445 h->interrupts_enabled = 0;
446 writel(SA5_INTR_OFF,
447 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500448 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800449 }
450}
Don Brace303932f2010-02-04 08:42:40 -0600451
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200452/*
453 * Variant of the above; 0x04 turns interrupts off...
454 */
455static void SA5B_intr_mask(struct ctlr_info *h, unsigned long val)
456{
457 if (val) { /* Turn interrupts on */
458 h->interrupts_enabled = 1;
459 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
460 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
461 } else { /* Turn them off */
462 h->interrupts_enabled = 0;
463 writel(SA5B_INTR_OFF,
464 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
465 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
466 }
467}
468
Don Brace303932f2010-02-04 08:42:40 -0600469static void SA5_performant_intr_mask(struct ctlr_info *h, unsigned long val)
470{
471 if (val) { /* turn on interrupts */
472 h->interrupts_enabled = 1;
473 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500474 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Don Brace303932f2010-02-04 08:42:40 -0600475 } else {
476 h->interrupts_enabled = 0;
477 writel(SA5_PERF_INTR_OFF,
478 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500479 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Don Brace303932f2010-02-04 08:42:40 -0600480 }
481}
482
Matt Gates254f7962012-05-01 11:43:06 -0500483static unsigned long SA5_performant_completed(struct ctlr_info *h, u8 q)
Don Brace303932f2010-02-04 08:42:40 -0600484{
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500485 struct reply_queue_buffer *rq = &h->reply_queue[q];
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600486 unsigned long register_value = FIFO_EMPTY;
Don Brace303932f2010-02-04 08:42:40 -0600487
Don Brace303932f2010-02-04 08:42:40 -0600488 /* msi auto clears the interrupt pending bit. */
Christoph Hellwigbc2bb152016-11-09 10:42:22 -0800489 if (unlikely(!(h->pdev->msi_enabled || h->msix_vectors))) {
Stephen M. Cameron2c17d2d2012-05-01 11:42:30 -0500490 /* flush the controller write of the reply queue by reading
491 * outbound doorbell status register.
492 */
Don Bracebee266a2015-01-23 16:43:51 -0600493 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600494 writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
495 /* Do a read in order to flush the write to the controller
496 * (as per spec.)
497 */
Don Bracebee266a2015-01-23 16:43:51 -0600498 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600499 }
500
Don Bracebee266a2015-01-23 16:43:51 -0600501 if ((((u32) rq->head[rq->current_entry]) & 1) == rq->wraparound) {
Matt Gates254f7962012-05-01 11:43:06 -0500502 register_value = rq->head[rq->current_entry];
503 rq->current_entry++;
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600504 atomic_dec(&h->commands_outstanding);
Don Brace303932f2010-02-04 08:42:40 -0600505 } else {
506 register_value = FIFO_EMPTY;
507 }
508 /* Check for wraparound */
Matt Gates254f7962012-05-01 11:43:06 -0500509 if (rq->current_entry == h->max_commands) {
510 rq->current_entry = 0;
511 rq->wraparound ^= 1;
Don Brace303932f2010-02-04 08:42:40 -0600512 }
Don Brace303932f2010-02-04 08:42:40 -0600513 return register_value;
514}
515
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800516/*
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800517 * returns value read from hardware.
518 * returns FIFO_EMPTY if there is nothing to read
519 */
Matt Gates254f7962012-05-01 11:43:06 -0500520static unsigned long SA5_completed(struct ctlr_info *h,
521 __attribute__((unused)) u8 q)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800522{
523 unsigned long register_value
524 = readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
525
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600526 if (register_value != FIFO_EMPTY)
527 atomic_dec(&h->commands_outstanding);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800528
529#ifdef HPSA_DEBUG
530 if (register_value != FIFO_EMPTY)
Stephen M. Cameron84ca0be2010-02-04 08:42:30 -0600531 dev_dbg(&h->pdev->dev, "Read %lx back from board\n",
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800532 register_value);
533 else
Stephen M. Cameronf79cfec2012-01-19 14:00:59 -0600534 dev_dbg(&h->pdev->dev, "FIFO Empty read\n");
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800535#endif
536
537 return register_value;
538}
539/*
540 * Returns true if an interrupt is pending..
541 */
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600542static bool SA5_intr_pending(struct ctlr_info *h)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800543{
544 unsigned long register_value =
545 readl(h->vaddr + SA5_INTR_STATUS);
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600546 return register_value & SA5_INTR_PENDING;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800547}
548
Don Brace303932f2010-02-04 08:42:40 -0600549static bool SA5_performant_intr_pending(struct ctlr_info *h)
550{
551 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
552
553 if (!register_value)
554 return false;
555
Don Brace303932f2010-02-04 08:42:40 -0600556 /* Read outbound doorbell to flush */
557 register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
558 return register_value & SA5_OUTDB_STATUS_PERF_BIT;
559}
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800560
Matt Gatese1f7de02014-02-18 13:55:17 -0600561#define SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT 0x100
562
563static bool SA5_ioaccel_mode1_intr_pending(struct ctlr_info *h)
564{
565 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
566
567 return (register_value & SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT) ?
568 true : false;
569}
570
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200571/*
572 * Returns true if an interrupt is pending..
573 */
574static bool SA5B_intr_pending(struct ctlr_info *h)
575{
576 return readl(h->vaddr + SA5_INTR_STATUS) & SA5B_INTR_PENDING;
577}
578
Matt Gatese1f7de02014-02-18 13:55:17 -0600579#define IOACCEL_MODE1_REPLY_QUEUE_INDEX 0x1A0
580#define IOACCEL_MODE1_PRODUCER_INDEX 0x1B8
581#define IOACCEL_MODE1_CONSUMER_INDEX 0x1BC
582#define IOACCEL_MODE1_REPLY_UNUSED 0xFFFFFFFFFFFFFFFFULL
583
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600584static unsigned long SA5_ioaccel_mode1_completed(struct ctlr_info *h, u8 q)
Matt Gatese1f7de02014-02-18 13:55:17 -0600585{
586 u64 register_value;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500587 struct reply_queue_buffer *rq = &h->reply_queue[q];
Matt Gatese1f7de02014-02-18 13:55:17 -0600588
589 BUG_ON(q >= h->nreply_queues);
590
591 register_value = rq->head[rq->current_entry];
592 if (register_value != IOACCEL_MODE1_REPLY_UNUSED) {
593 rq->head[rq->current_entry] = IOACCEL_MODE1_REPLY_UNUSED;
594 if (++rq->current_entry == rq->size)
595 rq->current_entry = 0;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600596 /*
597 * @todo
598 *
599 * Don't really need to write the new index after each command,
600 * but with current driver design this is easiest.
601 */
602 wmb();
603 writel((q << 24) | rq->current_entry, h->vaddr +
604 IOACCEL_MODE1_CONSUMER_INDEX);
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600605 atomic_dec(&h->commands_outstanding);
Matt Gatese1f7de02014-02-18 13:55:17 -0600606 }
607 return (unsigned long) register_value;
608}
609
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800610static struct access_method SA5_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200611 .submit_command = SA5_submit_command,
612 .set_intr_mask = SA5_intr_mask,
613 .intr_pending = SA5_intr_pending,
614 .command_completed = SA5_completed,
615};
616
617/* Duplicate entry of the above to mark unsupported boards */
618static struct access_method SA5A_access = {
619 .submit_command = SA5_submit_command,
620 .set_intr_mask = SA5_intr_mask,
621 .intr_pending = SA5_intr_pending,
622 .command_completed = SA5_completed,
623};
624
625static struct access_method SA5B_access = {
626 .submit_command = SA5_submit_command,
627 .set_intr_mask = SA5B_intr_mask,
628 .intr_pending = SA5B_intr_pending,
629 .command_completed = SA5_completed,
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800630};
631
Matt Gatese1f7de02014-02-18 13:55:17 -0600632static struct access_method SA5_ioaccel_mode1_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200633 .submit_command = SA5_submit_command,
634 .set_intr_mask = SA5_performant_intr_mask,
635 .intr_pending = SA5_ioaccel_mode1_intr_pending,
636 .command_completed = SA5_ioaccel_mode1_completed,
Matt Gatese1f7de02014-02-18 13:55:17 -0600637};
638
Scott Teelc3497752014-02-18 13:56:34 -0600639static struct access_method SA5_ioaccel_mode2_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200640 .submit_command = SA5_submit_command_ioaccel2,
641 .set_intr_mask = SA5_performant_intr_mask,
642 .intr_pending = SA5_performant_intr_pending,
643 .command_completed = SA5_performant_completed,
Scott Teelc3497752014-02-18 13:56:34 -0600644};
645
Don Brace303932f2010-02-04 08:42:40 -0600646static struct access_method SA5_performant_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200647 .submit_command = SA5_submit_command,
648 .set_intr_mask = SA5_performant_intr_mask,
649 .intr_pending = SA5_performant_intr_pending,
650 .command_completed = SA5_performant_completed,
Don Brace303932f2010-02-04 08:42:40 -0600651};
652
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500653static struct access_method SA5_performant_access_no_read = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200654 .submit_command = SA5_submit_command_no_read,
655 .set_intr_mask = SA5_performant_intr_mask,
656 .intr_pending = SA5_performant_intr_pending,
657 .command_completed = SA5_performant_completed,
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500658};
659
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800660struct board_type {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600661 u32 board_id;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800662 char *product_name;
663 struct access_method *access;
664};
665
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800666#endif /* HPSA_H */
667