blob: 59e023696fffe96d3fb7869de5233161dce8fa1d [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;
Don Brace01d0e782018-07-03 17:34:48 -050071 u64 eli; /* from report diags. */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080072 unsigned char vendor[8]; /* bytes 8-15 of inquiry data */
73 unsigned char model[16]; /* bytes 16-31 of inquiry data */
Hannes Reinecke7630b3a2016-11-17 12:15:56 +010074 unsigned char rev; /* byte 2 of inquiry data */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080075 unsigned char raid_level; /* from inquiry page 0xC1 */
Stephen M. Cameron98465902014-02-21 16:25:00 -060076 unsigned char volume_offline; /* discovered via TUR or VPD */
Don Brace03383732015-01-23 16:43:30 -060077 u16 queue_depth; /* max queue_depth for this device */
Webb Scalesd604f532015-04-23 09:35:22 -050078 atomic_t reset_cmds_out; /* Count of commands to-be affected */
Don Brace03383732015-01-23 16:43:30 -060079 atomic_t ioaccel_cmds_out; /* Only used for physical devices
80 * counts commands sent to physical
81 * device via "ioaccel" path.
82 */
Matt Gatese1f7de02014-02-18 13:55:17 -060083 u32 ioaccel_handle;
Joe Handzik8270b862015-07-18 11:12:43 -050084 u8 active_path_index;
85 u8 path_map;
86 u8 bay;
87 u8 box[8];
88 u16 phys_connector[8];
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060089 int offload_config; /* I/O accel RAID offload configured */
90 int offload_enabled; /* I/O accel RAID offload enabled */
Stephen Cameron41ce4c32015-04-23 09:31:47 -050091 int offload_to_be_enabled;
Joe Handzika3144e02015-04-23 09:32:59 -050092 int hba_ioaccel_enabled;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060093 int offload_to_mirror; /* Send next I/O accelerator RAID
94 * offload request to mirror drive
95 */
96 struct raid_map_data raid_map; /* I/O accelerator RAID map */
97
Don Brace03383732015-01-23 16:43:30 -060098 /*
99 * Pointers from logical drive map indices to the phys drives that
100 * make those logical drives. Note, multiple logical drives may
101 * share physical drives. You can have for instance 5 physical
102 * drives with 3 logical drives each using those same 5 physical
103 * disks. We need these pointers for counting i/o's out to physical
104 * devices in order to honor physical device queue depth limits.
105 */
106 struct hpsa_scsi_dev_t *phys_disk[RAID_MAP_MAX_ENTRIES];
Webb Scalesd604f532015-04-23 09:35:22 -0500107 int nphysical_disks;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500108 int supports_aborts;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600109 struct hpsa_sas_port *sas_port;
Scott Teel66749d02015-11-04 15:51:57 -0600110 int external; /* 1-from external array 0-not <0-unknown */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800111};
112
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500113struct reply_queue_buffer {
Matt Gates254f7962012-05-01 11:43:06 -0500114 u64 *head;
115 size_t size;
116 u8 wraparound;
117 u32 current_entry;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500118 dma_addr_t busaddr;
Matt Gates254f7962012-05-01 11:43:06 -0500119};
120
Stephen M. Cameron316b2212014-02-21 16:25:15 -0600121#pragma pack(1)
122struct bmic_controller_parameters {
123 u8 led_flags;
124 u8 enable_command_list_verification;
125 u8 backed_out_write_drives;
126 u16 stripes_for_parity;
127 u8 parity_distribution_mode_flags;
128 u16 max_driver_requests;
129 u16 elevator_trend_count;
130 u8 disable_elevator;
131 u8 force_scan_complete;
132 u8 scsi_transfer_mode;
133 u8 force_narrow;
134 u8 rebuild_priority;
135 u8 expand_priority;
136 u8 host_sdb_asic_fix;
137 u8 pdpi_burst_from_host_disabled;
138 char software_name[64];
139 char hardware_name[32];
140 u8 bridge_revision;
141 u8 snapshot_priority;
142 u32 os_specific;
143 u8 post_prompt_timeout;
144 u8 automatic_drive_slamming;
145 u8 reserved1;
146 u8 nvram_flags;
147 u8 cache_nvram_flags;
148 u8 drive_config_flags;
149 u16 reserved2;
150 u8 temp_warning_level;
151 u8 temp_shutdown_level;
152 u8 temp_condition_reset;
153 u8 max_coalesce_commands;
154 u32 max_coalesce_delay;
155 u8 orca_password[4];
156 u8 access_id[16];
157 u8 reserved[356];
158};
159#pragma pack()
160
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800161struct ctlr_info {
Ming Lei8b834bf2018-03-13 17:42:39 +0800162 unsigned int *reply_map;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800163 int ctlr;
164 char devname[8];
165 char *product_name;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800166 struct pci_dev *pdev;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600167 u32 board_id;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600168 u64 sas_address;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800169 void __iomem *vaddr;
170 unsigned long paddr;
171 int nr_cmds; /* Number of commands allowed on this controller */
Stephen Camerond54c5c22015-01-23 16:42:59 -0600172#define HPSA_CMDS_RESERVED_FOR_ABORTS 2
173#define HPSA_CMDS_RESERVED_FOR_DRIVER 1
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800174 struct CfgTable __iomem *cfgtable;
175 int interrupts_enabled;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800176 int max_commands;
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600177 atomic_t commands_outstanding;
Don Brace303932f2010-02-04 08:42:40 -0600178# define PERF_MODE_INT 0
179# define DOORBELL_INT 1
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800180# define SIMPLE_MODE_INT 2
181# define MEMQ_MODE_INT 3
Christoph Hellwigbc2bb152016-11-09 10:42:22 -0800182 unsigned int msix_vectors;
Stephen M. Camerona9a3a272011-02-15 15:32:53 -0600183 int intr_mode; /* either PERF_MODE_INT or SIMPLE_MODE_INT */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800184 struct access_method access;
185
186 /* queue and queue Info */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800187 unsigned int Qdepth;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800188 unsigned int maxSG;
189 spinlock_t lock;
Stephen M. Cameron33a2ffc2010-02-25 14:03:27 -0600190 int maxsgentries;
191 u8 max_cmd_sg_entries;
192 int chainsize;
193 struct SGDescriptor **cmd_sg_list;
Webb Scalesd9a729f2015-04-23 09:33:27 -0500194 struct ioaccel2_sg_element **ioaccel2_cmd_sg_list;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800195
196 /* pointers to command and error info pool */
197 struct CommandList *cmd_pool;
198 dma_addr_t cmd_pool_dhandle;
Matt Gatese1f7de02014-02-18 13:55:17 -0600199 struct io_accel1_cmd *ioaccel_cmd_pool;
200 dma_addr_t ioaccel_cmd_pool_dhandle;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600201 struct io_accel2_cmd *ioaccel2_cmd_pool;
202 dma_addr_t ioaccel2_cmd_pool_dhandle;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800203 struct ErrorInfo *errinfo_pool;
204 dma_addr_t errinfo_pool_dhandle;
205 unsigned long *cmd_pool_bits;
Stephen M. Camerona08a84712010-02-04 08:43:16 -0600206 int scan_finished;
Don Brace87b9e6a2017-03-10 14:35:17 -0600207 u8 scan_waiting : 1;
Stephen M. Camerona08a84712010-02-04 08:43:16 -0600208 spinlock_t scan_lock;
209 wait_queue_head_t scan_wait_queue;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800210
211 struct Scsi_Host *scsi_host;
212 spinlock_t devlock; /* to protect hba[ctlr]->dev[]; */
213 int ndevices; /* number of used elements in .dev[] array. */
Scott Teelcfe5bad2011-10-26 16:21:07 -0500214 struct hpsa_scsi_dev_t *dev[HPSA_MAX_DEVICES];
Don Brace303932f2010-02-04 08:42:40 -0600215 /*
216 * Performant mode tables.
217 */
218 u32 trans_support;
219 u32 trans_offset;
Don Brace42a91642014-11-14 17:26:27 -0600220 struct TransTable_struct __iomem *transtable;
Don Brace303932f2010-02-04 08:42:40 -0600221 unsigned long transMethod;
222
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500223 /* cap concurrent passthrus at some reasonable maximum */
Stephen Cameron45fcb862015-01-23 16:43:04 -0600224#define HPSA_MAX_CONCURRENT_PASSTHRUS (10)
Don Brace34f0c622015-01-23 16:43:46 -0600225 atomic_t passthru_cmds_avail;
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500226
Don Brace303932f2010-02-04 08:42:40 -0600227 /*
Matt Gates254f7962012-05-01 11:43:06 -0500228 * Performant mode completion buffers
Don Brace303932f2010-02-04 08:42:40 -0600229 */
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500230 size_t reply_queue_size;
231 struct reply_queue_buffer reply_queue[MAX_REPLY_QUEUES];
Matt Gates254f7962012-05-01 11:43:06 -0500232 u8 nreply_queues;
Don Brace303932f2010-02-04 08:42:40 -0600233 u32 *blockFetchTable;
Matt Gatese1f7de02014-02-18 13:55:17 -0600234 u32 *ioaccel1_blockFetchTable;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600235 u32 *ioaccel2_blockFetchTable;
Don Brace42a91642014-11-14 17:26:27 -0600236 u32 __iomem *ioaccel2_bft2_regs;
Stephen M. Cameron339b2b12010-02-04 08:42:50 -0600237 unsigned char *hba_inquiry_data;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600238 u32 driver_support;
239 u32 fw_support;
240 int ioaccel_support;
241 int ioaccel_maxsg;
Stephen M. Camerona0c12412011-10-26 16:22:04 -0500242 u64 last_intr_timestamp;
243 u32 last_heartbeat;
244 u64 last_heartbeat_timestamp;
Stephen M. Camerone85c5972012-05-01 11:43:42 -0500245 u32 heartbeat_sample_interval;
246 atomic_t firmware_flash_in_progress;
Don Brace42a91642014-11-14 17:26:27 -0600247 u32 __percpu *lockup_detected;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600248 struct delayed_work monitor_ctlr_work;
Don Brace6636e7f2015-01-23 16:45:17 -0600249 struct delayed_work rescan_ctlr_work;
Scott Teel3d38f002017-05-04 17:51:36 -0500250 struct delayed_work event_monitor_work;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600251 int remove_in_progress;
Matt Gates254f7962012-05-01 11:43:06 -0500252 /* Address of h->q[x] is passed to intr handler to know which queue */
253 u8 q[MAX_REPLY_QUEUES];
Robert Elliott8b470042015-04-23 09:34:58 -0500254 char intrname[MAX_REPLY_QUEUES][16]; /* "hpsa0-msix00" names */
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500255 u32 TMFSupportFlags; /* cache what task mgmt funcs are supported. */
256#define HPSATMF_BITS_SUPPORTED (1 << 0)
257#define HPSATMF_PHYS_LUN_RESET (1 << 1)
258#define HPSATMF_PHYS_NEX_RESET (1 << 2)
259#define HPSATMF_PHYS_TASK_ABORT (1 << 3)
260#define HPSATMF_PHYS_TSET_ABORT (1 << 4)
261#define HPSATMF_PHYS_CLEAR_ACA (1 << 5)
262#define HPSATMF_PHYS_CLEAR_TSET (1 << 6)
263#define HPSATMF_PHYS_QRY_TASK (1 << 7)
264#define HPSATMF_PHYS_QRY_TSET (1 << 8)
265#define HPSATMF_PHYS_QRY_ASYNC (1 << 9)
Stephen Cameron8be986c2015-04-23 09:34:06 -0500266#define HPSATMF_IOACCEL_ENABLED (1 << 15)
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500267#define HPSATMF_MASK_SUPPORTED (1 << 16)
268#define HPSATMF_LOG_LUN_RESET (1 << 17)
269#define HPSATMF_LOG_NEX_RESET (1 << 18)
270#define HPSATMF_LOG_TASK_ABORT (1 << 19)
271#define HPSATMF_LOG_TSET_ABORT (1 << 20)
272#define HPSATMF_LOG_CLEAR_ACA (1 << 21)
273#define HPSATMF_LOG_CLEAR_TSET (1 << 22)
274#define HPSATMF_LOG_QRY_TASK (1 << 23)
275#define HPSATMF_LOG_QRY_TSET (1 << 24)
276#define HPSATMF_LOG_QRY_ASYNC (1 << 25)
Stephen M. Cameron76438d02014-02-18 13:55:43 -0600277 u32 events;
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600278#define CTLR_STATE_CHANGE_EVENT (1 << 0)
279#define CTLR_ENCLOSURE_HOT_PLUG_EVENT (1 << 1)
280#define CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV (1 << 4)
281#define CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV (1 << 5)
282#define CTLR_STATE_CHANGE_EVENT_REDUNDANT_CNTRL (1 << 6)
283#define CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED (1 << 30)
284#define CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE (1 << 31)
285
286#define RESCAN_REQUIRED_EVENT_BITS \
Stephen M. Cameron7b2c46e2014-05-29 10:53:44 -0500287 (CTLR_ENCLOSURE_HOT_PLUG_EVENT | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600288 CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV | \
289 CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600290 CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED | \
291 CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE)
Stephen M. Cameron98465902014-02-21 16:25:00 -0600292 spinlock_t offline_device_lock;
293 struct list_head offline_device_list;
Scott Teelda0697b2014-02-18 13:57:00 -0600294 int acciopath_status;
Don Brace853633e2015-11-04 15:50:37 -0600295 int drv_req_rescan;
Stephen M. Cameron2ba8bfc2014-02-18 13:57:52 -0600296 int raid_offload_debug;
Scott Teel34592252015-11-04 15:52:09 -0600297 int discovery_polling;
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200298 int legacy_board;
Scott Teel34592252015-11-04 15:52:09 -0600299 struct ReportLUNdata *lastlogicals;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500300 int needs_abort_tags_swizzled;
Don Brace080ef1c2015-01-23 16:43:25 -0600301 struct workqueue_struct *resubmit_wq;
Don Brace6636e7f2015-01-23 16:45:17 -0600302 struct workqueue_struct *rescan_ctlr_wq;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500303 atomic_t abort_cmds_available;
Webb Scalesd604f532015-04-23 09:35:22 -0500304 wait_queue_head_t event_sync_wait_queue;
305 struct mutex reset_mutex;
Don Braceda03ded2015-11-04 15:50:56 -0600306 u8 reset_in_progress;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600307 struct hpsa_sas_node *sas_host;
Don Bracec59d04f2017-05-04 17:51:22 -0500308 spinlock_t reset_lock;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800309};
Stephen M. Cameron98465902014-02-21 16:25:00 -0600310
311struct offline_device_entry {
312 unsigned char scsi3addr[8];
313 struct list_head offline_list;
314};
315
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800316#define HPSA_ABORT_MSG 0
317#define HPSA_DEVICE_RESET_MSG 1
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500318#define HPSA_RESET_TYPE_CONTROLLER 0x00
319#define HPSA_RESET_TYPE_BUS 0x01
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500320#define HPSA_RESET_TYPE_LUN 0x04
Scott Teel0b9b7b62015-11-04 15:51:02 -0600321#define HPSA_PHYS_TARGET_RESET 0x99 /* not defined by cciss spec */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800322#define HPSA_MSG_SEND_RETRY_LIMIT 10
Stephen M. Cameron516fda42011-05-03 14:59:15 -0500323#define HPSA_MSG_SEND_RETRY_INTERVAL_MSECS (10000)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800324
325/* Maximum time in seconds driver will wait for command completions
326 * when polling before giving up.
327 */
328#define HPSA_MAX_POLL_TIME_SECS (20)
329
330/* During SCSI error recovery, HPSA_TUR_RETRY_LIMIT defines
331 * how many times to retry TEST UNIT READY on a device
332 * while waiting for it to become ready before giving up.
333 * HPSA_MAX_WAIT_INTERVAL_SECS is the max wait interval
334 * between sending TURs while waiting for a device
335 * to become ready.
336 */
337#define HPSA_TUR_RETRY_LIMIT (20)
338#define HPSA_MAX_WAIT_INTERVAL_SECS (30)
339
340/* HPSA_BOARD_READY_WAIT_SECS is how long to wait for a board
341 * to become ready, in seconds, before giving up on it.
342 * HPSA_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
343 * between polling the board to see if it is ready, in
344 * milliseconds. HPSA_BOARD_READY_POLL_INTERVAL and
345 * HPSA_BOARD_READY_ITERATIONS are derived from those.
346 */
347#define HPSA_BOARD_READY_WAIT_SECS (120)
Stephen M. Cameron2ed71272011-05-03 14:59:31 -0500348#define HPSA_BOARD_NOT_READY_WAIT_SECS (100)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800349#define HPSA_BOARD_READY_POLL_INTERVAL_MSECS (100)
350#define HPSA_BOARD_READY_POLL_INTERVAL \
351 ((HPSA_BOARD_READY_POLL_INTERVAL_MSECS * HZ) / 1000)
352#define HPSA_BOARD_READY_ITERATIONS \
353 ((HPSA_BOARD_READY_WAIT_SECS * 1000) / \
354 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronfe5389c2011-01-06 14:48:03 -0600355#define HPSA_BOARD_NOT_READY_ITERATIONS \
356 ((HPSA_BOARD_NOT_READY_WAIT_SECS * 1000) / \
357 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800358#define HPSA_POST_RESET_PAUSE_MSECS (3000)
359#define HPSA_POST_RESET_NOOP_RETRIES (12)
360
361/* Defining the diffent access_menthods */
362/*
363 * Memory mapped FIFO interface (SMART 53xx cards)
364 */
365#define SA5_DOORBELL 0x20
366#define SA5_REQUEST_PORT_OFFSET 0x40
Webb Scales281a7fd2015-01-23 16:43:35 -0600367#define SA5_REQUEST_PORT64_LO_OFFSET 0xC0
368#define SA5_REQUEST_PORT64_HI_OFFSET 0xC4
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800369#define SA5_REPLY_INTR_MASK_OFFSET 0x34
370#define SA5_REPLY_PORT_OFFSET 0x44
371#define SA5_INTR_STATUS 0x30
372#define SA5_SCRATCHPAD_OFFSET 0xB0
373
374#define SA5_CTCFG_OFFSET 0xB4
375#define SA5_CTMEM_OFFSET 0xB8
376
377#define SA5_INTR_OFF 0x08
378#define SA5B_INTR_OFF 0x04
379#define SA5_INTR_PENDING 0x08
380#define SA5B_INTR_PENDING 0x04
381#define FIFO_EMPTY 0xffffffff
382#define HPSA_FIRMWARE_READY 0xffff0000 /* value in scratchpad register */
383
384#define HPSA_ERROR_BIT 0x02
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800385
Don Brace303932f2010-02-04 08:42:40 -0600386/* Performant mode flags */
387#define SA5_PERF_INTR_PENDING 0x04
388#define SA5_PERF_INTR_OFF 0x05
389#define SA5_OUTDB_STATUS_PERF_BIT 0x01
390#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
391#define SA5_OUTDB_CLEAR 0xA0
392#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
393#define SA5_OUTDB_STATUS 0x9C
394
395
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800396#define HPSA_INTR_ON 1
397#define HPSA_INTR_OFF 0
Mike Millerb66cc252014-02-18 13:56:04 -0600398
399/*
400 * Inbound Post Queue offsets for IO Accelerator Mode 2
401 */
402#define IOACCEL2_INBOUND_POSTQ_32 0x48
403#define IOACCEL2_INBOUND_POSTQ_64_LOW 0xd0
404#define IOACCEL2_INBOUND_POSTQ_64_HI 0xd4
405
Kevin Barnettc7955052015-11-04 15:51:45 -0600406#define HPSA_PHYSICAL_DEVICE_BUS 0
407#define HPSA_RAID_VOLUME_BUS 1
408#define HPSA_EXTERNAL_RAID_VOLUME_BUS 2
Don Brace09371d62015-12-22 10:36:42 -0600409#define HPSA_HBA_BUS 0
Hannes Reinecke7630b3a2016-11-17 12:15:56 +0100410#define HPSA_LEGACY_HBA_BUS 3
Kevin Barnettc7955052015-11-04 15:51:45 -0600411
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800412/*
413 Send the command to the hardware
414*/
415static void SA5_submit_command(struct ctlr_info *h,
416 struct CommandList *c)
417{
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800418 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Stephen M. Cameronfec62c32011-07-21 13:16:05 -0500419 (void) readl(h->vaddr + SA5_SCRATCHPAD_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800420}
421
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500422static void SA5_submit_command_no_read(struct ctlr_info *h,
423 struct CommandList *c)
424{
425 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
426}
427
Scott Teelc3497752014-02-18 13:56:34 -0600428static void SA5_submit_command_ioaccel2(struct ctlr_info *h,
429 struct CommandList *c)
430{
Stephen Cameronc05e8862015-01-23 16:44:40 -0600431 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Scott Teelc3497752014-02-18 13:56:34 -0600432}
433
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800434/*
435 * This card is the opposite of the other cards.
436 * 0 turns interrupts on...
437 * 0x08 turns them off...
438 */
439static void SA5_intr_mask(struct ctlr_info *h, unsigned long val)
440{
441 if (val) { /* Turn interrupts on */
442 h->interrupts_enabled = 1;
443 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500444 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800445 } else { /* Turn them off */
446 h->interrupts_enabled = 0;
447 writel(SA5_INTR_OFF,
448 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500449 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800450 }
451}
Don Brace303932f2010-02-04 08:42:40 -0600452
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200453/*
454 * Variant of the above; 0x04 turns interrupts off...
455 */
456static void SA5B_intr_mask(struct ctlr_info *h, unsigned long val)
457{
458 if (val) { /* Turn interrupts on */
459 h->interrupts_enabled = 1;
460 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
461 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
462 } else { /* Turn them off */
463 h->interrupts_enabled = 0;
464 writel(SA5B_INTR_OFF,
465 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
466 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
467 }
468}
469
Don Brace303932f2010-02-04 08:42:40 -0600470static void SA5_performant_intr_mask(struct ctlr_info *h, unsigned long val)
471{
472 if (val) { /* turn on interrupts */
473 h->interrupts_enabled = 1;
474 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500475 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Don Brace303932f2010-02-04 08:42:40 -0600476 } else {
477 h->interrupts_enabled = 0;
478 writel(SA5_PERF_INTR_OFF,
479 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500480 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Don Brace303932f2010-02-04 08:42:40 -0600481 }
482}
483
Matt Gates254f7962012-05-01 11:43:06 -0500484static unsigned long SA5_performant_completed(struct ctlr_info *h, u8 q)
Don Brace303932f2010-02-04 08:42:40 -0600485{
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500486 struct reply_queue_buffer *rq = &h->reply_queue[q];
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600487 unsigned long register_value = FIFO_EMPTY;
Don Brace303932f2010-02-04 08:42:40 -0600488
Don Brace303932f2010-02-04 08:42:40 -0600489 /* msi auto clears the interrupt pending bit. */
Christoph Hellwigbc2bb152016-11-09 10:42:22 -0800490 if (unlikely(!(h->pdev->msi_enabled || h->msix_vectors))) {
Stephen M. Cameron2c17d2d2012-05-01 11:42:30 -0500491 /* flush the controller write of the reply queue by reading
492 * outbound doorbell status register.
493 */
Don Bracebee266a2015-01-23 16:43:51 -0600494 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600495 writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
496 /* Do a read in order to flush the write to the controller
497 * (as per spec.)
498 */
Don Bracebee266a2015-01-23 16:43:51 -0600499 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600500 }
501
Don Bracebee266a2015-01-23 16:43:51 -0600502 if ((((u32) rq->head[rq->current_entry]) & 1) == rq->wraparound) {
Matt Gates254f7962012-05-01 11:43:06 -0500503 register_value = rq->head[rq->current_entry];
504 rq->current_entry++;
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600505 atomic_dec(&h->commands_outstanding);
Don Brace303932f2010-02-04 08:42:40 -0600506 } else {
507 register_value = FIFO_EMPTY;
508 }
509 /* Check for wraparound */
Matt Gates254f7962012-05-01 11:43:06 -0500510 if (rq->current_entry == h->max_commands) {
511 rq->current_entry = 0;
512 rq->wraparound ^= 1;
Don Brace303932f2010-02-04 08:42:40 -0600513 }
Don Brace303932f2010-02-04 08:42:40 -0600514 return register_value;
515}
516
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800517/*
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800518 * returns value read from hardware.
519 * returns FIFO_EMPTY if there is nothing to read
520 */
Matt Gates254f7962012-05-01 11:43:06 -0500521static unsigned long SA5_completed(struct ctlr_info *h,
522 __attribute__((unused)) u8 q)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800523{
524 unsigned long register_value
525 = readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
526
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600527 if (register_value != FIFO_EMPTY)
528 atomic_dec(&h->commands_outstanding);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800529
530#ifdef HPSA_DEBUG
531 if (register_value != FIFO_EMPTY)
Stephen M. Cameron84ca0be2010-02-04 08:42:30 -0600532 dev_dbg(&h->pdev->dev, "Read %lx back from board\n",
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800533 register_value);
534 else
Stephen M. Cameronf79cfec2012-01-19 14:00:59 -0600535 dev_dbg(&h->pdev->dev, "FIFO Empty read\n");
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800536#endif
537
538 return register_value;
539}
540/*
541 * Returns true if an interrupt is pending..
542 */
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600543static bool SA5_intr_pending(struct ctlr_info *h)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800544{
545 unsigned long register_value =
546 readl(h->vaddr + SA5_INTR_STATUS);
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600547 return register_value & SA5_INTR_PENDING;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800548}
549
Don Brace303932f2010-02-04 08:42:40 -0600550static bool SA5_performant_intr_pending(struct ctlr_info *h)
551{
552 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
553
554 if (!register_value)
555 return false;
556
Don Brace303932f2010-02-04 08:42:40 -0600557 /* Read outbound doorbell to flush */
558 register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
559 return register_value & SA5_OUTDB_STATUS_PERF_BIT;
560}
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800561
Matt Gatese1f7de02014-02-18 13:55:17 -0600562#define SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT 0x100
563
564static bool SA5_ioaccel_mode1_intr_pending(struct ctlr_info *h)
565{
566 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
567
568 return (register_value & SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT) ?
569 true : false;
570}
571
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200572/*
573 * Returns true if an interrupt is pending..
574 */
575static bool SA5B_intr_pending(struct ctlr_info *h)
576{
577 return readl(h->vaddr + SA5_INTR_STATUS) & SA5B_INTR_PENDING;
578}
579
Matt Gatese1f7de02014-02-18 13:55:17 -0600580#define IOACCEL_MODE1_REPLY_QUEUE_INDEX 0x1A0
581#define IOACCEL_MODE1_PRODUCER_INDEX 0x1B8
582#define IOACCEL_MODE1_CONSUMER_INDEX 0x1BC
583#define IOACCEL_MODE1_REPLY_UNUSED 0xFFFFFFFFFFFFFFFFULL
584
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600585static unsigned long SA5_ioaccel_mode1_completed(struct ctlr_info *h, u8 q)
Matt Gatese1f7de02014-02-18 13:55:17 -0600586{
587 u64 register_value;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500588 struct reply_queue_buffer *rq = &h->reply_queue[q];
Matt Gatese1f7de02014-02-18 13:55:17 -0600589
590 BUG_ON(q >= h->nreply_queues);
591
592 register_value = rq->head[rq->current_entry];
593 if (register_value != IOACCEL_MODE1_REPLY_UNUSED) {
594 rq->head[rq->current_entry] = IOACCEL_MODE1_REPLY_UNUSED;
595 if (++rq->current_entry == rq->size)
596 rq->current_entry = 0;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600597 /*
598 * @todo
599 *
600 * Don't really need to write the new index after each command,
601 * but with current driver design this is easiest.
602 */
603 wmb();
604 writel((q << 24) | rq->current_entry, h->vaddr +
605 IOACCEL_MODE1_CONSUMER_INDEX);
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600606 atomic_dec(&h->commands_outstanding);
Matt Gatese1f7de02014-02-18 13:55:17 -0600607 }
608 return (unsigned long) register_value;
609}
610
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800611static struct access_method SA5_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200612 .submit_command = SA5_submit_command,
613 .set_intr_mask = SA5_intr_mask,
614 .intr_pending = SA5_intr_pending,
615 .command_completed = SA5_completed,
616};
617
618/* Duplicate entry of the above to mark unsupported boards */
619static struct access_method SA5A_access = {
620 .submit_command = SA5_submit_command,
621 .set_intr_mask = SA5_intr_mask,
622 .intr_pending = SA5_intr_pending,
623 .command_completed = SA5_completed,
624};
625
626static struct access_method SA5B_access = {
627 .submit_command = SA5_submit_command,
628 .set_intr_mask = SA5B_intr_mask,
629 .intr_pending = SA5B_intr_pending,
630 .command_completed = SA5_completed,
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800631};
632
Matt Gatese1f7de02014-02-18 13:55:17 -0600633static struct access_method SA5_ioaccel_mode1_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200634 .submit_command = SA5_submit_command,
635 .set_intr_mask = SA5_performant_intr_mask,
636 .intr_pending = SA5_ioaccel_mode1_intr_pending,
637 .command_completed = SA5_ioaccel_mode1_completed,
Matt Gatese1f7de02014-02-18 13:55:17 -0600638};
639
Scott Teelc3497752014-02-18 13:56:34 -0600640static struct access_method SA5_ioaccel_mode2_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200641 .submit_command = SA5_submit_command_ioaccel2,
642 .set_intr_mask = SA5_performant_intr_mask,
643 .intr_pending = SA5_performant_intr_pending,
644 .command_completed = SA5_performant_completed,
Scott Teelc3497752014-02-18 13:56:34 -0600645};
646
Don Brace303932f2010-02-04 08:42:40 -0600647static struct access_method SA5_performant_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200648 .submit_command = SA5_submit_command,
649 .set_intr_mask = SA5_performant_intr_mask,
650 .intr_pending = SA5_performant_intr_pending,
651 .command_completed = SA5_performant_completed,
Don Brace303932f2010-02-04 08:42:40 -0600652};
653
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500654static struct access_method SA5_performant_access_no_read = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200655 .submit_command = SA5_submit_command_no_read,
656 .set_intr_mask = SA5_performant_intr_mask,
657 .intr_pending = SA5_performant_intr_pending,
658 .command_completed = SA5_performant_completed,
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500659};
660
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800661struct board_type {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600662 u32 board_id;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800663 char *product_name;
664 struct access_method *access;
665};
666
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800667#endif /* HPSA_H */
668