blob: f8c88fc7b80a050039b44e5690cbf91805b040c0 [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 */
Don Brace9e33f0d2019-05-07 13:32:26 -050068 u8 was_removed : 1; /* device actually removed */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080069#define RAID_CTLR_LUNID "\0\0\0\0\0\0\0\0"
70 unsigned char device_id[16]; /* from inquiry pg. 0x83 */
Kevin Barnettd04e62b2015-11-04 15:52:34 -060071 u64 sas_address;
Don Brace01d0e782018-07-03 17:34:48 -050072 u64 eli; /* from report diags. */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080073 unsigned char vendor[8]; /* bytes 8-15 of inquiry data */
74 unsigned char model[16]; /* bytes 16-31 of inquiry data */
Hannes Reinecke7630b3a2016-11-17 12:15:56 +010075 unsigned char rev; /* byte 2 of inquiry data */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080076 unsigned char raid_level; /* from inquiry page 0xC1 */
Stephen M. Cameron98465902014-02-21 16:25:00 -060077 unsigned char volume_offline; /* discovered via TUR or VPD */
Don Brace03383732015-01-23 16:43:30 -060078 u16 queue_depth; /* max queue_depth for this device */
Don Bracec5dfd102019-05-07 13:32:33 -050079 atomic_t commands_outstanding; /* track commands sent to device */
Don Brace03383732015-01-23 16:43:30 -060080 atomic_t ioaccel_cmds_out; /* Only used for physical devices
81 * counts commands sent to physical
82 * device via "ioaccel" path.
83 */
Don Bracec5dfd102019-05-07 13:32:33 -050084 bool in_reset;
Matt Gatese1f7de02014-02-18 13:55:17 -060085 u32 ioaccel_handle;
Joe Handzik8270b862015-07-18 11:12:43 -050086 u8 active_path_index;
87 u8 path_map;
88 u8 bay;
89 u8 box[8];
90 u16 phys_connector[8];
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060091 int offload_config; /* I/O accel RAID offload configured */
92 int offload_enabled; /* I/O accel RAID offload enabled */
Stephen Cameron41ce4c32015-04-23 09:31:47 -050093 int offload_to_be_enabled;
Joe Handzika3144e02015-04-23 09:32:59 -050094 int hba_ioaccel_enabled;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060095 int offload_to_mirror; /* Send next I/O accelerator RAID
96 * offload request to mirror drive
97 */
98 struct raid_map_data raid_map; /* I/O accelerator RAID map */
99
Don Brace03383732015-01-23 16:43:30 -0600100 /*
101 * Pointers from logical drive map indices to the phys drives that
102 * make those logical drives. Note, multiple logical drives may
103 * share physical drives. You can have for instance 5 physical
104 * drives with 3 logical drives each using those same 5 physical
105 * disks. We need these pointers for counting i/o's out to physical
106 * devices in order to honor physical device queue depth limits.
107 */
108 struct hpsa_scsi_dev_t *phys_disk[RAID_MAP_MAX_ENTRIES];
Webb Scalesd604f532015-04-23 09:35:22 -0500109 int nphysical_disks;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500110 int supports_aborts;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600111 struct hpsa_sas_port *sas_port;
Scott Teel66749d02015-11-04 15:51:57 -0600112 int external; /* 1-from external array 0-not <0-unknown */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800113};
114
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500115struct reply_queue_buffer {
Matt Gates254f7962012-05-01 11:43:06 -0500116 u64 *head;
117 size_t size;
118 u8 wraparound;
119 u32 current_entry;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500120 dma_addr_t busaddr;
Matt Gates254f7962012-05-01 11:43:06 -0500121};
122
Stephen M. Cameron316b2212014-02-21 16:25:15 -0600123#pragma pack(1)
124struct bmic_controller_parameters {
125 u8 led_flags;
126 u8 enable_command_list_verification;
127 u8 backed_out_write_drives;
128 u16 stripes_for_parity;
129 u8 parity_distribution_mode_flags;
130 u16 max_driver_requests;
131 u16 elevator_trend_count;
132 u8 disable_elevator;
133 u8 force_scan_complete;
134 u8 scsi_transfer_mode;
135 u8 force_narrow;
136 u8 rebuild_priority;
137 u8 expand_priority;
138 u8 host_sdb_asic_fix;
139 u8 pdpi_burst_from_host_disabled;
140 char software_name[64];
141 char hardware_name[32];
142 u8 bridge_revision;
143 u8 snapshot_priority;
144 u32 os_specific;
145 u8 post_prompt_timeout;
146 u8 automatic_drive_slamming;
147 u8 reserved1;
148 u8 nvram_flags;
149 u8 cache_nvram_flags;
150 u8 drive_config_flags;
151 u16 reserved2;
152 u8 temp_warning_level;
153 u8 temp_shutdown_level;
154 u8 temp_condition_reset;
155 u8 max_coalesce_commands;
156 u32 max_coalesce_delay;
157 u8 orca_password[4];
158 u8 access_id[16];
159 u8 reserved[356];
160};
161#pragma pack()
162
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800163struct ctlr_info {
Ming Lei8b834bf2018-03-13 17:42:39 +0800164 unsigned int *reply_map;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800165 int ctlr;
166 char devname[8];
167 char *product_name;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800168 struct pci_dev *pdev;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600169 u32 board_id;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600170 u64 sas_address;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800171 void __iomem *vaddr;
172 unsigned long paddr;
173 int nr_cmds; /* Number of commands allowed on this controller */
Stephen Camerond54c5c22015-01-23 16:42:59 -0600174#define HPSA_CMDS_RESERVED_FOR_ABORTS 2
175#define HPSA_CMDS_RESERVED_FOR_DRIVER 1
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800176 struct CfgTable __iomem *cfgtable;
177 int interrupts_enabled;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800178 int max_commands;
Don Brace4770e682019-05-07 13:32:13 -0500179 int last_collision_tag; /* tags are global */
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600180 atomic_t commands_outstanding;
Don Brace303932f2010-02-04 08:42:40 -0600181# define PERF_MODE_INT 0
182# define DOORBELL_INT 1
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800183# define SIMPLE_MODE_INT 2
184# define MEMQ_MODE_INT 3
Christoph Hellwigbc2bb152016-11-09 10:42:22 -0800185 unsigned int msix_vectors;
Stephen M. Camerona9a3a272011-02-15 15:32:53 -0600186 int intr_mode; /* either PERF_MODE_INT or SIMPLE_MODE_INT */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800187 struct access_method access;
188
189 /* queue and queue Info */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800190 unsigned int Qdepth;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800191 unsigned int maxSG;
192 spinlock_t lock;
Stephen M. Cameron33a2ffc2010-02-25 14:03:27 -0600193 int maxsgentries;
194 u8 max_cmd_sg_entries;
195 int chainsize;
196 struct SGDescriptor **cmd_sg_list;
Webb Scalesd9a729f2015-04-23 09:33:27 -0500197 struct ioaccel2_sg_element **ioaccel2_cmd_sg_list;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800198
199 /* pointers to command and error info pool */
200 struct CommandList *cmd_pool;
201 dma_addr_t cmd_pool_dhandle;
Matt Gatese1f7de02014-02-18 13:55:17 -0600202 struct io_accel1_cmd *ioaccel_cmd_pool;
203 dma_addr_t ioaccel_cmd_pool_dhandle;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600204 struct io_accel2_cmd *ioaccel2_cmd_pool;
205 dma_addr_t ioaccel2_cmd_pool_dhandle;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800206 struct ErrorInfo *errinfo_pool;
207 dma_addr_t errinfo_pool_dhandle;
208 unsigned long *cmd_pool_bits;
Stephen M. Camerona08a84712010-02-04 08:43:16 -0600209 int scan_finished;
Don Brace87b9e6a2017-03-10 14:35:17 -0600210 u8 scan_waiting : 1;
Stephen M. Camerona08a84712010-02-04 08:43:16 -0600211 spinlock_t scan_lock;
212 wait_queue_head_t scan_wait_queue;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800213
214 struct Scsi_Host *scsi_host;
215 spinlock_t devlock; /* to protect hba[ctlr]->dev[]; */
216 int ndevices; /* number of used elements in .dev[] array. */
Scott Teelcfe5bad2011-10-26 16:21:07 -0500217 struct hpsa_scsi_dev_t *dev[HPSA_MAX_DEVICES];
Don Brace303932f2010-02-04 08:42:40 -0600218 /*
219 * Performant mode tables.
220 */
221 u32 trans_support;
222 u32 trans_offset;
Don Brace42a91642014-11-14 17:26:27 -0600223 struct TransTable_struct __iomem *transtable;
Don Brace303932f2010-02-04 08:42:40 -0600224 unsigned long transMethod;
225
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500226 /* cap concurrent passthrus at some reasonable maximum */
Stephen Cameron45fcb862015-01-23 16:43:04 -0600227#define HPSA_MAX_CONCURRENT_PASSTHRUS (10)
Don Brace34f0c622015-01-23 16:43:46 -0600228 atomic_t passthru_cmds_avail;
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500229
Don Brace303932f2010-02-04 08:42:40 -0600230 /*
Matt Gates254f7962012-05-01 11:43:06 -0500231 * Performant mode completion buffers
Don Brace303932f2010-02-04 08:42:40 -0600232 */
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500233 size_t reply_queue_size;
234 struct reply_queue_buffer reply_queue[MAX_REPLY_QUEUES];
Matt Gates254f7962012-05-01 11:43:06 -0500235 u8 nreply_queues;
Don Brace303932f2010-02-04 08:42:40 -0600236 u32 *blockFetchTable;
Matt Gatese1f7de02014-02-18 13:55:17 -0600237 u32 *ioaccel1_blockFetchTable;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600238 u32 *ioaccel2_blockFetchTable;
Don Brace42a91642014-11-14 17:26:27 -0600239 u32 __iomem *ioaccel2_bft2_regs;
Stephen M. Cameron339b2b12010-02-04 08:42:50 -0600240 unsigned char *hba_inquiry_data;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600241 u32 driver_support;
242 u32 fw_support;
243 int ioaccel_support;
244 int ioaccel_maxsg;
Stephen M. Camerona0c12412011-10-26 16:22:04 -0500245 u64 last_intr_timestamp;
246 u32 last_heartbeat;
247 u64 last_heartbeat_timestamp;
Stephen M. Camerone85c5972012-05-01 11:43:42 -0500248 u32 heartbeat_sample_interval;
249 atomic_t firmware_flash_in_progress;
Don Brace42a91642014-11-14 17:26:27 -0600250 u32 __percpu *lockup_detected;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600251 struct delayed_work monitor_ctlr_work;
Don Brace6636e7f2015-01-23 16:45:17 -0600252 struct delayed_work rescan_ctlr_work;
Scott Teel3d38f002017-05-04 17:51:36 -0500253 struct delayed_work event_monitor_work;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600254 int remove_in_progress;
Matt Gates254f7962012-05-01 11:43:06 -0500255 /* Address of h->q[x] is passed to intr handler to know which queue */
256 u8 q[MAX_REPLY_QUEUES];
Robert Elliott8b470042015-04-23 09:34:58 -0500257 char intrname[MAX_REPLY_QUEUES][16]; /* "hpsa0-msix00" names */
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500258 u32 TMFSupportFlags; /* cache what task mgmt funcs are supported. */
259#define HPSATMF_BITS_SUPPORTED (1 << 0)
260#define HPSATMF_PHYS_LUN_RESET (1 << 1)
261#define HPSATMF_PHYS_NEX_RESET (1 << 2)
262#define HPSATMF_PHYS_TASK_ABORT (1 << 3)
263#define HPSATMF_PHYS_TSET_ABORT (1 << 4)
264#define HPSATMF_PHYS_CLEAR_ACA (1 << 5)
265#define HPSATMF_PHYS_CLEAR_TSET (1 << 6)
266#define HPSATMF_PHYS_QRY_TASK (1 << 7)
267#define HPSATMF_PHYS_QRY_TSET (1 << 8)
268#define HPSATMF_PHYS_QRY_ASYNC (1 << 9)
Stephen Cameron8be986c2015-04-23 09:34:06 -0500269#define HPSATMF_IOACCEL_ENABLED (1 << 15)
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500270#define HPSATMF_MASK_SUPPORTED (1 << 16)
271#define HPSATMF_LOG_LUN_RESET (1 << 17)
272#define HPSATMF_LOG_NEX_RESET (1 << 18)
273#define HPSATMF_LOG_TASK_ABORT (1 << 19)
274#define HPSATMF_LOG_TSET_ABORT (1 << 20)
275#define HPSATMF_LOG_CLEAR_ACA (1 << 21)
276#define HPSATMF_LOG_CLEAR_TSET (1 << 22)
277#define HPSATMF_LOG_QRY_TASK (1 << 23)
278#define HPSATMF_LOG_QRY_TSET (1 << 24)
279#define HPSATMF_LOG_QRY_ASYNC (1 << 25)
Stephen M. Cameron76438d02014-02-18 13:55:43 -0600280 u32 events;
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600281#define CTLR_STATE_CHANGE_EVENT (1 << 0)
282#define CTLR_ENCLOSURE_HOT_PLUG_EVENT (1 << 1)
283#define CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV (1 << 4)
284#define CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV (1 << 5)
285#define CTLR_STATE_CHANGE_EVENT_REDUNDANT_CNTRL (1 << 6)
286#define CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED (1 << 30)
287#define CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE (1 << 31)
288
289#define RESCAN_REQUIRED_EVENT_BITS \
Stephen M. Cameron7b2c46e2014-05-29 10:53:44 -0500290 (CTLR_ENCLOSURE_HOT_PLUG_EVENT | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600291 CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV | \
292 CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600293 CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED | \
294 CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE)
Stephen M. Cameron98465902014-02-21 16:25:00 -0600295 spinlock_t offline_device_lock;
296 struct list_head offline_device_list;
Scott Teelda0697b2014-02-18 13:57:00 -0600297 int acciopath_status;
Don Brace853633e2015-11-04 15:50:37 -0600298 int drv_req_rescan;
Stephen M. Cameron2ba8bfc2014-02-18 13:57:52 -0600299 int raid_offload_debug;
Scott Teel34592252015-11-04 15:52:09 -0600300 int discovery_polling;
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200301 int legacy_board;
Scott Teel34592252015-11-04 15:52:09 -0600302 struct ReportLUNdata *lastlogicals;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500303 int needs_abort_tags_swizzled;
Don Brace080ef1c2015-01-23 16:43:25 -0600304 struct workqueue_struct *resubmit_wq;
Don Brace6636e7f2015-01-23 16:45:17 -0600305 struct workqueue_struct *rescan_ctlr_wq;
Don Brace01192082019-05-07 13:32:07 -0500306 struct workqueue_struct *monitor_ctlr_wq;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500307 atomic_t abort_cmds_available;
Webb Scalesd604f532015-04-23 09:35:22 -0500308 wait_queue_head_t event_sync_wait_queue;
309 struct mutex reset_mutex;
Don Braceda03ded2015-11-04 15:50:56 -0600310 u8 reset_in_progress;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600311 struct hpsa_sas_node *sas_host;
Don Bracec59d04f2017-05-04 17:51:22 -0500312 spinlock_t reset_lock;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800313};
Stephen M. Cameron98465902014-02-21 16:25:00 -0600314
315struct offline_device_entry {
316 unsigned char scsi3addr[8];
317 struct list_head offline_list;
318};
319
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800320#define HPSA_ABORT_MSG 0
321#define HPSA_DEVICE_RESET_MSG 1
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500322#define HPSA_RESET_TYPE_CONTROLLER 0x00
323#define HPSA_RESET_TYPE_BUS 0x01
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500324#define HPSA_RESET_TYPE_LUN 0x04
Scott Teel0b9b7b62015-11-04 15:51:02 -0600325#define HPSA_PHYS_TARGET_RESET 0x99 /* not defined by cciss spec */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800326#define HPSA_MSG_SEND_RETRY_LIMIT 10
Stephen M. Cameron516fda42011-05-03 14:59:15 -0500327#define HPSA_MSG_SEND_RETRY_INTERVAL_MSECS (10000)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800328
329/* Maximum time in seconds driver will wait for command completions
330 * when polling before giving up.
331 */
332#define HPSA_MAX_POLL_TIME_SECS (20)
333
334/* During SCSI error recovery, HPSA_TUR_RETRY_LIMIT defines
335 * how many times to retry TEST UNIT READY on a device
336 * while waiting for it to become ready before giving up.
337 * HPSA_MAX_WAIT_INTERVAL_SECS is the max wait interval
338 * between sending TURs while waiting for a device
339 * to become ready.
340 */
341#define HPSA_TUR_RETRY_LIMIT (20)
342#define HPSA_MAX_WAIT_INTERVAL_SECS (30)
343
344/* HPSA_BOARD_READY_WAIT_SECS is how long to wait for a board
345 * to become ready, in seconds, before giving up on it.
346 * HPSA_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
347 * between polling the board to see if it is ready, in
348 * milliseconds. HPSA_BOARD_READY_POLL_INTERVAL and
349 * HPSA_BOARD_READY_ITERATIONS are derived from those.
350 */
351#define HPSA_BOARD_READY_WAIT_SECS (120)
Stephen M. Cameron2ed71272011-05-03 14:59:31 -0500352#define HPSA_BOARD_NOT_READY_WAIT_SECS (100)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800353#define HPSA_BOARD_READY_POLL_INTERVAL_MSECS (100)
354#define HPSA_BOARD_READY_POLL_INTERVAL \
355 ((HPSA_BOARD_READY_POLL_INTERVAL_MSECS * HZ) / 1000)
356#define HPSA_BOARD_READY_ITERATIONS \
357 ((HPSA_BOARD_READY_WAIT_SECS * 1000) / \
358 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronfe5389c2011-01-06 14:48:03 -0600359#define HPSA_BOARD_NOT_READY_ITERATIONS \
360 ((HPSA_BOARD_NOT_READY_WAIT_SECS * 1000) / \
361 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800362#define HPSA_POST_RESET_PAUSE_MSECS (3000)
363#define HPSA_POST_RESET_NOOP_RETRIES (12)
364
365/* Defining the diffent access_menthods */
366/*
367 * Memory mapped FIFO interface (SMART 53xx cards)
368 */
369#define SA5_DOORBELL 0x20
370#define SA5_REQUEST_PORT_OFFSET 0x40
Webb Scales281a7fd2015-01-23 16:43:35 -0600371#define SA5_REQUEST_PORT64_LO_OFFSET 0xC0
372#define SA5_REQUEST_PORT64_HI_OFFSET 0xC4
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800373#define SA5_REPLY_INTR_MASK_OFFSET 0x34
374#define SA5_REPLY_PORT_OFFSET 0x44
375#define SA5_INTR_STATUS 0x30
376#define SA5_SCRATCHPAD_OFFSET 0xB0
377
378#define SA5_CTCFG_OFFSET 0xB4
379#define SA5_CTMEM_OFFSET 0xB8
380
381#define SA5_INTR_OFF 0x08
382#define SA5B_INTR_OFF 0x04
383#define SA5_INTR_PENDING 0x08
384#define SA5B_INTR_PENDING 0x04
385#define FIFO_EMPTY 0xffffffff
386#define HPSA_FIRMWARE_READY 0xffff0000 /* value in scratchpad register */
387
388#define HPSA_ERROR_BIT 0x02
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800389
Don Brace303932f2010-02-04 08:42:40 -0600390/* Performant mode flags */
391#define SA5_PERF_INTR_PENDING 0x04
392#define SA5_PERF_INTR_OFF 0x05
393#define SA5_OUTDB_STATUS_PERF_BIT 0x01
394#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
395#define SA5_OUTDB_CLEAR 0xA0
396#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
397#define SA5_OUTDB_STATUS 0x9C
398
399
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800400#define HPSA_INTR_ON 1
401#define HPSA_INTR_OFF 0
Mike Millerb66cc252014-02-18 13:56:04 -0600402
403/*
404 * Inbound Post Queue offsets for IO Accelerator Mode 2
405 */
406#define IOACCEL2_INBOUND_POSTQ_32 0x48
407#define IOACCEL2_INBOUND_POSTQ_64_LOW 0xd0
408#define IOACCEL2_INBOUND_POSTQ_64_HI 0xd4
409
Kevin Barnettc7955052015-11-04 15:51:45 -0600410#define HPSA_PHYSICAL_DEVICE_BUS 0
411#define HPSA_RAID_VOLUME_BUS 1
412#define HPSA_EXTERNAL_RAID_VOLUME_BUS 2
Don Brace09371d62015-12-22 10:36:42 -0600413#define HPSA_HBA_BUS 0
Hannes Reinecke7630b3a2016-11-17 12:15:56 +0100414#define HPSA_LEGACY_HBA_BUS 3
Kevin Barnettc7955052015-11-04 15:51:45 -0600415
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800416/*
417 Send the command to the hardware
418*/
419static void SA5_submit_command(struct ctlr_info *h,
420 struct CommandList *c)
421{
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800422 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Stephen M. Cameronfec62c32011-07-21 13:16:05 -0500423 (void) readl(h->vaddr + SA5_SCRATCHPAD_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800424}
425
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500426static void SA5_submit_command_no_read(struct ctlr_info *h,
427 struct CommandList *c)
428{
429 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
430}
431
Scott Teelc3497752014-02-18 13:56:34 -0600432static void SA5_submit_command_ioaccel2(struct ctlr_info *h,
433 struct CommandList *c)
434{
Stephen Cameronc05e8862015-01-23 16:44:40 -0600435 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Scott Teelc3497752014-02-18 13:56:34 -0600436}
437
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800438/*
439 * This card is the opposite of the other cards.
440 * 0 turns interrupts on...
441 * 0x08 turns them off...
442 */
443static void SA5_intr_mask(struct ctlr_info *h, unsigned long val)
444{
445 if (val) { /* Turn interrupts on */
446 h->interrupts_enabled = 1;
447 writel(0, 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 } else { /* Turn them off */
450 h->interrupts_enabled = 0;
451 writel(SA5_INTR_OFF,
452 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500453 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800454 }
455}
Don Brace303932f2010-02-04 08:42:40 -0600456
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200457/*
458 * Variant of the above; 0x04 turns interrupts off...
459 */
460static void SA5B_intr_mask(struct ctlr_info *h, unsigned long val)
461{
462 if (val) { /* Turn interrupts on */
463 h->interrupts_enabled = 1;
464 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
465 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
466 } else { /* Turn them off */
467 h->interrupts_enabled = 0;
468 writel(SA5B_INTR_OFF,
469 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
470 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
471 }
472}
473
Don Brace303932f2010-02-04 08:42:40 -0600474static void SA5_performant_intr_mask(struct ctlr_info *h, unsigned long val)
475{
476 if (val) { /* turn on interrupts */
477 h->interrupts_enabled = 1;
478 writel(0, 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 } else {
481 h->interrupts_enabled = 0;
482 writel(SA5_PERF_INTR_OFF,
483 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500484 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Don Brace303932f2010-02-04 08:42:40 -0600485 }
486}
487
Matt Gates254f7962012-05-01 11:43:06 -0500488static unsigned long SA5_performant_completed(struct ctlr_info *h, u8 q)
Don Brace303932f2010-02-04 08:42:40 -0600489{
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500490 struct reply_queue_buffer *rq = &h->reply_queue[q];
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600491 unsigned long register_value = FIFO_EMPTY;
Don Brace303932f2010-02-04 08:42:40 -0600492
Don Brace303932f2010-02-04 08:42:40 -0600493 /* msi auto clears the interrupt pending bit. */
Christoph Hellwigbc2bb152016-11-09 10:42:22 -0800494 if (unlikely(!(h->pdev->msi_enabled || h->msix_vectors))) {
Stephen M. Cameron2c17d2d2012-05-01 11:42:30 -0500495 /* flush the controller write of the reply queue by reading
496 * outbound doorbell status register.
497 */
Don Bracebee266a2015-01-23 16:43:51 -0600498 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600499 writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
500 /* Do a read in order to flush the write to the controller
501 * (as per spec.)
502 */
Don Bracebee266a2015-01-23 16:43:51 -0600503 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600504 }
505
Don Bracebee266a2015-01-23 16:43:51 -0600506 if ((((u32) rq->head[rq->current_entry]) & 1) == rq->wraparound) {
Matt Gates254f7962012-05-01 11:43:06 -0500507 register_value = rq->head[rq->current_entry];
508 rq->current_entry++;
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600509 atomic_dec(&h->commands_outstanding);
Don Brace303932f2010-02-04 08:42:40 -0600510 } else {
511 register_value = FIFO_EMPTY;
512 }
513 /* Check for wraparound */
Matt Gates254f7962012-05-01 11:43:06 -0500514 if (rq->current_entry == h->max_commands) {
515 rq->current_entry = 0;
516 rq->wraparound ^= 1;
Don Brace303932f2010-02-04 08:42:40 -0600517 }
Don Brace303932f2010-02-04 08:42:40 -0600518 return register_value;
519}
520
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800521/*
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800522 * returns value read from hardware.
523 * returns FIFO_EMPTY if there is nothing to read
524 */
Matt Gates254f7962012-05-01 11:43:06 -0500525static unsigned long SA5_completed(struct ctlr_info *h,
526 __attribute__((unused)) u8 q)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800527{
528 unsigned long register_value
529 = readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
530
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600531 if (register_value != FIFO_EMPTY)
532 atomic_dec(&h->commands_outstanding);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800533
534#ifdef HPSA_DEBUG
535 if (register_value != FIFO_EMPTY)
Stephen M. Cameron84ca0be2010-02-04 08:42:30 -0600536 dev_dbg(&h->pdev->dev, "Read %lx back from board\n",
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800537 register_value);
538 else
Stephen M. Cameronf79cfec2012-01-19 14:00:59 -0600539 dev_dbg(&h->pdev->dev, "FIFO Empty read\n");
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800540#endif
541
542 return register_value;
543}
544/*
545 * Returns true if an interrupt is pending..
546 */
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600547static bool SA5_intr_pending(struct ctlr_info *h)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800548{
549 unsigned long register_value =
550 readl(h->vaddr + SA5_INTR_STATUS);
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600551 return register_value & SA5_INTR_PENDING;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800552}
553
Don Brace303932f2010-02-04 08:42:40 -0600554static bool SA5_performant_intr_pending(struct ctlr_info *h)
555{
556 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
557
558 if (!register_value)
559 return false;
560
Don Brace303932f2010-02-04 08:42:40 -0600561 /* Read outbound doorbell to flush */
562 register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
563 return register_value & SA5_OUTDB_STATUS_PERF_BIT;
564}
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800565
Matt Gatese1f7de02014-02-18 13:55:17 -0600566#define SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT 0x100
567
568static bool SA5_ioaccel_mode1_intr_pending(struct ctlr_info *h)
569{
570 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
571
572 return (register_value & SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT) ?
573 true : false;
574}
575
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200576/*
577 * Returns true if an interrupt is pending..
578 */
579static bool SA5B_intr_pending(struct ctlr_info *h)
580{
581 return readl(h->vaddr + SA5_INTR_STATUS) & SA5B_INTR_PENDING;
582}
583
Matt Gatese1f7de02014-02-18 13:55:17 -0600584#define IOACCEL_MODE1_REPLY_QUEUE_INDEX 0x1A0
585#define IOACCEL_MODE1_PRODUCER_INDEX 0x1B8
586#define IOACCEL_MODE1_CONSUMER_INDEX 0x1BC
587#define IOACCEL_MODE1_REPLY_UNUSED 0xFFFFFFFFFFFFFFFFULL
588
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600589static unsigned long SA5_ioaccel_mode1_completed(struct ctlr_info *h, u8 q)
Matt Gatese1f7de02014-02-18 13:55:17 -0600590{
591 u64 register_value;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500592 struct reply_queue_buffer *rq = &h->reply_queue[q];
Matt Gatese1f7de02014-02-18 13:55:17 -0600593
594 BUG_ON(q >= h->nreply_queues);
595
596 register_value = rq->head[rq->current_entry];
597 if (register_value != IOACCEL_MODE1_REPLY_UNUSED) {
598 rq->head[rq->current_entry] = IOACCEL_MODE1_REPLY_UNUSED;
599 if (++rq->current_entry == rq->size)
600 rq->current_entry = 0;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600601 /*
602 * @todo
603 *
604 * Don't really need to write the new index after each command,
605 * but with current driver design this is easiest.
606 */
607 wmb();
608 writel((q << 24) | rq->current_entry, h->vaddr +
609 IOACCEL_MODE1_CONSUMER_INDEX);
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600610 atomic_dec(&h->commands_outstanding);
Matt Gatese1f7de02014-02-18 13:55:17 -0600611 }
612 return (unsigned long) register_value;
613}
614
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800615static struct access_method SA5_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200616 .submit_command = SA5_submit_command,
617 .set_intr_mask = SA5_intr_mask,
618 .intr_pending = SA5_intr_pending,
619 .command_completed = SA5_completed,
620};
621
622/* Duplicate entry of the above to mark unsupported boards */
623static struct access_method SA5A_access = {
624 .submit_command = SA5_submit_command,
625 .set_intr_mask = SA5_intr_mask,
626 .intr_pending = SA5_intr_pending,
627 .command_completed = SA5_completed,
628};
629
630static struct access_method SA5B_access = {
631 .submit_command = SA5_submit_command,
632 .set_intr_mask = SA5B_intr_mask,
633 .intr_pending = SA5B_intr_pending,
634 .command_completed = SA5_completed,
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800635};
636
Matt Gatese1f7de02014-02-18 13:55:17 -0600637static struct access_method SA5_ioaccel_mode1_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200638 .submit_command = SA5_submit_command,
639 .set_intr_mask = SA5_performant_intr_mask,
640 .intr_pending = SA5_ioaccel_mode1_intr_pending,
641 .command_completed = SA5_ioaccel_mode1_completed,
Matt Gatese1f7de02014-02-18 13:55:17 -0600642};
643
Scott Teelc3497752014-02-18 13:56:34 -0600644static struct access_method SA5_ioaccel_mode2_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200645 .submit_command = SA5_submit_command_ioaccel2,
646 .set_intr_mask = SA5_performant_intr_mask,
647 .intr_pending = SA5_performant_intr_pending,
648 .command_completed = SA5_performant_completed,
Scott Teelc3497752014-02-18 13:56:34 -0600649};
650
Don Brace303932f2010-02-04 08:42:40 -0600651static struct access_method SA5_performant_access = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200652 .submit_command = SA5_submit_command,
653 .set_intr_mask = SA5_performant_intr_mask,
654 .intr_pending = SA5_performant_intr_pending,
655 .command_completed = SA5_performant_completed,
Don Brace303932f2010-02-04 08:42:40 -0600656};
657
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500658static struct access_method SA5_performant_access_no_read = {
Hannes Reinecke135ae6e2017-08-15 08:58:04 +0200659 .submit_command = SA5_submit_command_no_read,
660 .set_intr_mask = SA5_performant_intr_mask,
661 .intr_pending = SA5_performant_intr_pending,
662 .command_completed = SA5_performant_completed,
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500663};
664
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800665struct board_type {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600666 u32 board_id;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800667 char *product_name;
668 struct access_method *access;
669};
670
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800671#endif /* HPSA_H */
672