blob: 6f04f2ad412530a76d615b394250d502221d5457 [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
Stephen M. Cameronedd16362009-12-08 14:09:11 -080060struct hpsa_scsi_dev_t {
Don Brace3ad7de62015-11-04 15:50:19 -060061 unsigned int devtype;
Stephen M. Cameronedd16362009-12-08 14:09:11 -080062 int bus, target, lun; /* as presented to the OS */
63 unsigned char scsi3addr[8]; /* as presented to the HW */
Kevin Barnett04fa2f42015-11-04 15:51:27 -060064 u8 physical_device : 1;
Kevin Barnett2a168202015-11-04 15:51:21 -060065 u8 expose_device;
Don Braceba74fdc2016-04-27 17:14:17 -050066 u8 removed : 1; /* device is marked for death */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080067#define RAID_CTLR_LUNID "\0\0\0\0\0\0\0\0"
68 unsigned char device_id[16]; /* from inquiry pg. 0x83 */
Kevin Barnettd04e62b2015-11-04 15:52:34 -060069 u64 sas_address;
Stephen M. Cameronedd16362009-12-08 14:09:11 -080070 unsigned char vendor[8]; /* bytes 8-15 of inquiry data */
71 unsigned char model[16]; /* bytes 16-31 of inquiry data */
Hannes Reinecke7630b3a2016-11-17 12:15:56 +010072 unsigned char rev; /* byte 2 of inquiry data */
Stephen M. Cameronedd16362009-12-08 14:09:11 -080073 unsigned char raid_level; /* from inquiry page 0xC1 */
Stephen M. Cameron98465902014-02-21 16:25:00 -060074 unsigned char volume_offline; /* discovered via TUR or VPD */
Don Brace03383732015-01-23 16:43:30 -060075 u16 queue_depth; /* max queue_depth for this device */
Webb Scalesd604f532015-04-23 09:35:22 -050076 atomic_t reset_cmds_out; /* Count of commands to-be affected */
Don Brace03383732015-01-23 16:43:30 -060077 atomic_t ioaccel_cmds_out; /* Only used for physical devices
78 * counts commands sent to physical
79 * device via "ioaccel" path.
80 */
Matt Gatese1f7de02014-02-18 13:55:17 -060081 u32 ioaccel_handle;
Joe Handzik8270b862015-07-18 11:12:43 -050082 u8 active_path_index;
83 u8 path_map;
84 u8 bay;
85 u8 box[8];
86 u16 phys_connector[8];
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060087 int offload_config; /* I/O accel RAID offload configured */
88 int offload_enabled; /* I/O accel RAID offload enabled */
Stephen Cameron41ce4c32015-04-23 09:31:47 -050089 int offload_to_be_enabled;
Joe Handzika3144e02015-04-23 09:32:59 -050090 int hba_ioaccel_enabled;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -060091 int offload_to_mirror; /* Send next I/O accelerator RAID
92 * offload request to mirror drive
93 */
94 struct raid_map_data raid_map; /* I/O accelerator RAID map */
95
Don Brace03383732015-01-23 16:43:30 -060096 /*
97 * Pointers from logical drive map indices to the phys drives that
98 * make those logical drives. Note, multiple logical drives may
99 * share physical drives. You can have for instance 5 physical
100 * drives with 3 logical drives each using those same 5 physical
101 * disks. We need these pointers for counting i/o's out to physical
102 * devices in order to honor physical device queue depth limits.
103 */
104 struct hpsa_scsi_dev_t *phys_disk[RAID_MAP_MAX_ENTRIES];
Webb Scalesd604f532015-04-23 09:35:22 -0500105 int nphysical_disks;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500106 int supports_aborts;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600107 struct hpsa_sas_port *sas_port;
Scott Teel66749d02015-11-04 15:51:57 -0600108 int external; /* 1-from external array 0-not <0-unknown */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800109};
110
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500111struct reply_queue_buffer {
Matt Gates254f7962012-05-01 11:43:06 -0500112 u64 *head;
113 size_t size;
114 u8 wraparound;
115 u32 current_entry;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500116 dma_addr_t busaddr;
Matt Gates254f7962012-05-01 11:43:06 -0500117};
118
Stephen M. Cameron316b2212014-02-21 16:25:15 -0600119#pragma pack(1)
120struct bmic_controller_parameters {
121 u8 led_flags;
122 u8 enable_command_list_verification;
123 u8 backed_out_write_drives;
124 u16 stripes_for_parity;
125 u8 parity_distribution_mode_flags;
126 u16 max_driver_requests;
127 u16 elevator_trend_count;
128 u8 disable_elevator;
129 u8 force_scan_complete;
130 u8 scsi_transfer_mode;
131 u8 force_narrow;
132 u8 rebuild_priority;
133 u8 expand_priority;
134 u8 host_sdb_asic_fix;
135 u8 pdpi_burst_from_host_disabled;
136 char software_name[64];
137 char hardware_name[32];
138 u8 bridge_revision;
139 u8 snapshot_priority;
140 u32 os_specific;
141 u8 post_prompt_timeout;
142 u8 automatic_drive_slamming;
143 u8 reserved1;
144 u8 nvram_flags;
145 u8 cache_nvram_flags;
146 u8 drive_config_flags;
147 u16 reserved2;
148 u8 temp_warning_level;
149 u8 temp_shutdown_level;
150 u8 temp_condition_reset;
151 u8 max_coalesce_commands;
152 u32 max_coalesce_delay;
153 u8 orca_password[4];
154 u8 access_id[16];
155 u8 reserved[356];
156};
157#pragma pack()
158
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800159struct ctlr_info {
160 int ctlr;
161 char devname[8];
162 char *product_name;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800163 struct pci_dev *pdev;
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600164 u32 board_id;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600165 u64 sas_address;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800166 void __iomem *vaddr;
167 unsigned long paddr;
168 int nr_cmds; /* Number of commands allowed on this controller */
Stephen Camerond54c5c22015-01-23 16:42:59 -0600169#define HPSA_CMDS_RESERVED_FOR_ABORTS 2
170#define HPSA_CMDS_RESERVED_FOR_DRIVER 1
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800171 struct CfgTable __iomem *cfgtable;
172 int interrupts_enabled;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800173 int max_commands;
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600174 atomic_t commands_outstanding;
Don Brace303932f2010-02-04 08:42:40 -0600175# define PERF_MODE_INT 0
176# define DOORBELL_INT 1
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800177# define SIMPLE_MODE_INT 2
178# define MEMQ_MODE_INT 3
Christoph Hellwigbc2bb152016-11-09 10:42:22 -0800179 unsigned int msix_vectors;
Stephen M. Camerona9a3a272011-02-15 15:32:53 -0600180 int intr_mode; /* either PERF_MODE_INT or SIMPLE_MODE_INT */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800181 struct access_method access;
182
183 /* queue and queue Info */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800184 unsigned int Qdepth;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800185 unsigned int maxSG;
186 spinlock_t lock;
Stephen M. Cameron33a2ffc2010-02-25 14:03:27 -0600187 int maxsgentries;
188 u8 max_cmd_sg_entries;
189 int chainsize;
190 struct SGDescriptor **cmd_sg_list;
Webb Scalesd9a729f2015-04-23 09:33:27 -0500191 struct ioaccel2_sg_element **ioaccel2_cmd_sg_list;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800192
193 /* pointers to command and error info pool */
194 struct CommandList *cmd_pool;
195 dma_addr_t cmd_pool_dhandle;
Matt Gatese1f7de02014-02-18 13:55:17 -0600196 struct io_accel1_cmd *ioaccel_cmd_pool;
197 dma_addr_t ioaccel_cmd_pool_dhandle;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600198 struct io_accel2_cmd *ioaccel2_cmd_pool;
199 dma_addr_t ioaccel2_cmd_pool_dhandle;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800200 struct ErrorInfo *errinfo_pool;
201 dma_addr_t errinfo_pool_dhandle;
202 unsigned long *cmd_pool_bits;
Stephen M. Camerona08a8472010-02-04 08:43:16 -0600203 int scan_finished;
Don Brace87b9e6a2017-03-10 14:35:17 -0600204 u8 scan_waiting : 1;
Stephen M. Camerona08a8472010-02-04 08:43:16 -0600205 spinlock_t scan_lock;
206 wait_queue_head_t scan_wait_queue;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800207
208 struct Scsi_Host *scsi_host;
209 spinlock_t devlock; /* to protect hba[ctlr]->dev[]; */
210 int ndevices; /* number of used elements in .dev[] array. */
Scott Teelcfe5bad2011-10-26 16:21:07 -0500211 struct hpsa_scsi_dev_t *dev[HPSA_MAX_DEVICES];
Don Brace303932f2010-02-04 08:42:40 -0600212 /*
213 * Performant mode tables.
214 */
215 u32 trans_support;
216 u32 trans_offset;
Don Brace42a91642014-11-14 17:26:27 -0600217 struct TransTable_struct __iomem *transtable;
Don Brace303932f2010-02-04 08:42:40 -0600218 unsigned long transMethod;
219
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500220 /* cap concurrent passthrus at some reasonable maximum */
Stephen Cameron45fcb862015-01-23 16:43:04 -0600221#define HPSA_MAX_CONCURRENT_PASSTHRUS (10)
Don Brace34f0c622015-01-23 16:43:46 -0600222 atomic_t passthru_cmds_avail;
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500223
Don Brace303932f2010-02-04 08:42:40 -0600224 /*
Matt Gates254f7962012-05-01 11:43:06 -0500225 * Performant mode completion buffers
Don Brace303932f2010-02-04 08:42:40 -0600226 */
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500227 size_t reply_queue_size;
228 struct reply_queue_buffer reply_queue[MAX_REPLY_QUEUES];
Matt Gates254f7962012-05-01 11:43:06 -0500229 u8 nreply_queues;
Don Brace303932f2010-02-04 08:42:40 -0600230 u32 *blockFetchTable;
Matt Gatese1f7de02014-02-18 13:55:17 -0600231 u32 *ioaccel1_blockFetchTable;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600232 u32 *ioaccel2_blockFetchTable;
Don Brace42a91642014-11-14 17:26:27 -0600233 u32 __iomem *ioaccel2_bft2_regs;
Stephen M. Cameron339b2b12010-02-04 08:42:50 -0600234 unsigned char *hba_inquiry_data;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600235 u32 driver_support;
236 u32 fw_support;
237 int ioaccel_support;
238 int ioaccel_maxsg;
Stephen M. Camerona0c12412011-10-26 16:22:04 -0500239 u64 last_intr_timestamp;
240 u32 last_heartbeat;
241 u64 last_heartbeat_timestamp;
Stephen M. Camerone85c5972012-05-01 11:43:42 -0500242 u32 heartbeat_sample_interval;
243 atomic_t firmware_flash_in_progress;
Don Brace42a91642014-11-14 17:26:27 -0600244 u32 __percpu *lockup_detected;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600245 struct delayed_work monitor_ctlr_work;
Don Brace6636e7f2015-01-23 16:45:17 -0600246 struct delayed_work rescan_ctlr_work;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600247 int remove_in_progress;
Matt Gates254f7962012-05-01 11:43:06 -0500248 /* Address of h->q[x] is passed to intr handler to know which queue */
249 u8 q[MAX_REPLY_QUEUES];
Robert Elliott8b470042015-04-23 09:34:58 -0500250 char intrname[MAX_REPLY_QUEUES][16]; /* "hpsa0-msix00" names */
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500251 u32 TMFSupportFlags; /* cache what task mgmt funcs are supported. */
252#define HPSATMF_BITS_SUPPORTED (1 << 0)
253#define HPSATMF_PHYS_LUN_RESET (1 << 1)
254#define HPSATMF_PHYS_NEX_RESET (1 << 2)
255#define HPSATMF_PHYS_TASK_ABORT (1 << 3)
256#define HPSATMF_PHYS_TSET_ABORT (1 << 4)
257#define HPSATMF_PHYS_CLEAR_ACA (1 << 5)
258#define HPSATMF_PHYS_CLEAR_TSET (1 << 6)
259#define HPSATMF_PHYS_QRY_TASK (1 << 7)
260#define HPSATMF_PHYS_QRY_TSET (1 << 8)
261#define HPSATMF_PHYS_QRY_ASYNC (1 << 9)
Stephen Cameron8be986c2015-04-23 09:34:06 -0500262#define HPSATMF_IOACCEL_ENABLED (1 << 15)
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500263#define HPSATMF_MASK_SUPPORTED (1 << 16)
264#define HPSATMF_LOG_LUN_RESET (1 << 17)
265#define HPSATMF_LOG_NEX_RESET (1 << 18)
266#define HPSATMF_LOG_TASK_ABORT (1 << 19)
267#define HPSATMF_LOG_TSET_ABORT (1 << 20)
268#define HPSATMF_LOG_CLEAR_ACA (1 << 21)
269#define HPSATMF_LOG_CLEAR_TSET (1 << 22)
270#define HPSATMF_LOG_QRY_TASK (1 << 23)
271#define HPSATMF_LOG_QRY_TSET (1 << 24)
272#define HPSATMF_LOG_QRY_ASYNC (1 << 25)
Stephen M. Cameron76438d02014-02-18 13:55:43 -0600273 u32 events;
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600274#define CTLR_STATE_CHANGE_EVENT (1 << 0)
275#define CTLR_ENCLOSURE_HOT_PLUG_EVENT (1 << 1)
276#define CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV (1 << 4)
277#define CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV (1 << 5)
278#define CTLR_STATE_CHANGE_EVENT_REDUNDANT_CNTRL (1 << 6)
279#define CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED (1 << 30)
280#define CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE (1 << 31)
281
282#define RESCAN_REQUIRED_EVENT_BITS \
Stephen M. Cameron7b2c46e2014-05-29 10:53:44 -0500283 (CTLR_ENCLOSURE_HOT_PLUG_EVENT | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600284 CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV | \
285 CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600286 CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED | \
287 CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE)
Stephen M. Cameron98465902014-02-21 16:25:00 -0600288 spinlock_t offline_device_lock;
289 struct list_head offline_device_list;
Scott Teelda0697b2014-02-18 13:57:00 -0600290 int acciopath_status;
Don Brace853633e2015-11-04 15:50:37 -0600291 int drv_req_rescan;
Stephen M. Cameron2ba8bfc2014-02-18 13:57:52 -0600292 int raid_offload_debug;
Scott Teel34592252015-11-04 15:52:09 -0600293 int discovery_polling;
294 struct ReportLUNdata *lastlogicals;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500295 int needs_abort_tags_swizzled;
Don Brace080ef1c2015-01-23 16:43:25 -0600296 struct workqueue_struct *resubmit_wq;
Don Brace6636e7f2015-01-23 16:45:17 -0600297 struct workqueue_struct *rescan_ctlr_wq;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500298 atomic_t abort_cmds_available;
299 wait_queue_head_t abort_cmd_wait_queue;
Webb Scalesd604f532015-04-23 09:35:22 -0500300 wait_queue_head_t event_sync_wait_queue;
301 struct mutex reset_mutex;
Don Braceda03ded2015-11-04 15:50:56 -0600302 u8 reset_in_progress;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600303 struct hpsa_sas_node *sas_host;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800304};
Stephen M. Cameron98465902014-02-21 16:25:00 -0600305
306struct offline_device_entry {
307 unsigned char scsi3addr[8];
308 struct list_head offline_list;
309};
310
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800311#define HPSA_ABORT_MSG 0
312#define HPSA_DEVICE_RESET_MSG 1
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500313#define HPSA_RESET_TYPE_CONTROLLER 0x00
314#define HPSA_RESET_TYPE_BUS 0x01
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500315#define HPSA_RESET_TYPE_LUN 0x04
Scott Teel0b9b7b62015-11-04 15:51:02 -0600316#define HPSA_PHYS_TARGET_RESET 0x99 /* not defined by cciss spec */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800317#define HPSA_MSG_SEND_RETRY_LIMIT 10
Stephen M. Cameron516fda42011-05-03 14:59:15 -0500318#define HPSA_MSG_SEND_RETRY_INTERVAL_MSECS (10000)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800319
320/* Maximum time in seconds driver will wait for command completions
321 * when polling before giving up.
322 */
323#define HPSA_MAX_POLL_TIME_SECS (20)
324
325/* During SCSI error recovery, HPSA_TUR_RETRY_LIMIT defines
326 * how many times to retry TEST UNIT READY on a device
327 * while waiting for it to become ready before giving up.
328 * HPSA_MAX_WAIT_INTERVAL_SECS is the max wait interval
329 * between sending TURs while waiting for a device
330 * to become ready.
331 */
332#define HPSA_TUR_RETRY_LIMIT (20)
333#define HPSA_MAX_WAIT_INTERVAL_SECS (30)
334
335/* HPSA_BOARD_READY_WAIT_SECS is how long to wait for a board
336 * to become ready, in seconds, before giving up on it.
337 * HPSA_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
338 * between polling the board to see if it is ready, in
339 * milliseconds. HPSA_BOARD_READY_POLL_INTERVAL and
340 * HPSA_BOARD_READY_ITERATIONS are derived from those.
341 */
342#define HPSA_BOARD_READY_WAIT_SECS (120)
Stephen M. Cameron2ed71272011-05-03 14:59:31 -0500343#define HPSA_BOARD_NOT_READY_WAIT_SECS (100)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800344#define HPSA_BOARD_READY_POLL_INTERVAL_MSECS (100)
345#define HPSA_BOARD_READY_POLL_INTERVAL \
346 ((HPSA_BOARD_READY_POLL_INTERVAL_MSECS * HZ) / 1000)
347#define HPSA_BOARD_READY_ITERATIONS \
348 ((HPSA_BOARD_READY_WAIT_SECS * 1000) / \
349 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronfe5389c2011-01-06 14:48:03 -0600350#define HPSA_BOARD_NOT_READY_ITERATIONS \
351 ((HPSA_BOARD_NOT_READY_WAIT_SECS * 1000) / \
352 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800353#define HPSA_POST_RESET_PAUSE_MSECS (3000)
354#define HPSA_POST_RESET_NOOP_RETRIES (12)
355
356/* Defining the diffent access_menthods */
357/*
358 * Memory mapped FIFO interface (SMART 53xx cards)
359 */
360#define SA5_DOORBELL 0x20
361#define SA5_REQUEST_PORT_OFFSET 0x40
Webb Scales281a7fd2015-01-23 16:43:35 -0600362#define SA5_REQUEST_PORT64_LO_OFFSET 0xC0
363#define SA5_REQUEST_PORT64_HI_OFFSET 0xC4
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800364#define SA5_REPLY_INTR_MASK_OFFSET 0x34
365#define SA5_REPLY_PORT_OFFSET 0x44
366#define SA5_INTR_STATUS 0x30
367#define SA5_SCRATCHPAD_OFFSET 0xB0
368
369#define SA5_CTCFG_OFFSET 0xB4
370#define SA5_CTMEM_OFFSET 0xB8
371
372#define SA5_INTR_OFF 0x08
373#define SA5B_INTR_OFF 0x04
374#define SA5_INTR_PENDING 0x08
375#define SA5B_INTR_PENDING 0x04
376#define FIFO_EMPTY 0xffffffff
377#define HPSA_FIRMWARE_READY 0xffff0000 /* value in scratchpad register */
378
379#define HPSA_ERROR_BIT 0x02
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800380
Don Brace303932f2010-02-04 08:42:40 -0600381/* Performant mode flags */
382#define SA5_PERF_INTR_PENDING 0x04
383#define SA5_PERF_INTR_OFF 0x05
384#define SA5_OUTDB_STATUS_PERF_BIT 0x01
385#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
386#define SA5_OUTDB_CLEAR 0xA0
387#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
388#define SA5_OUTDB_STATUS 0x9C
389
390
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800391#define HPSA_INTR_ON 1
392#define HPSA_INTR_OFF 0
Mike Millerb66cc252014-02-18 13:56:04 -0600393
394/*
395 * Inbound Post Queue offsets for IO Accelerator Mode 2
396 */
397#define IOACCEL2_INBOUND_POSTQ_32 0x48
398#define IOACCEL2_INBOUND_POSTQ_64_LOW 0xd0
399#define IOACCEL2_INBOUND_POSTQ_64_HI 0xd4
400
Kevin Barnettc7955052015-11-04 15:51:45 -0600401#define HPSA_PHYSICAL_DEVICE_BUS 0
402#define HPSA_RAID_VOLUME_BUS 1
403#define HPSA_EXTERNAL_RAID_VOLUME_BUS 2
Don Brace09371d62015-12-22 10:36:42 -0600404#define HPSA_HBA_BUS 0
Hannes Reinecke7630b3a2016-11-17 12:15:56 +0100405#define HPSA_LEGACY_HBA_BUS 3
Kevin Barnettc7955052015-11-04 15:51:45 -0600406
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800407/*
408 Send the command to the hardware
409*/
410static void SA5_submit_command(struct ctlr_info *h,
411 struct CommandList *c)
412{
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800413 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Stephen M. Cameronfec62c32011-07-21 13:16:05 -0500414 (void) readl(h->vaddr + SA5_SCRATCHPAD_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800415}
416
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500417static void SA5_submit_command_no_read(struct ctlr_info *h,
418 struct CommandList *c)
419{
420 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
421}
422
Scott Teelc3497752014-02-18 13:56:34 -0600423static void SA5_submit_command_ioaccel2(struct ctlr_info *h,
424 struct CommandList *c)
425{
Stephen Cameronc05e8862015-01-23 16:44:40 -0600426 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Scott Teelc3497752014-02-18 13:56:34 -0600427}
428
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800429/*
430 * This card is the opposite of the other cards.
431 * 0 turns interrupts on...
432 * 0x08 turns them off...
433 */
434static void SA5_intr_mask(struct ctlr_info *h, unsigned long val)
435{
436 if (val) { /* Turn interrupts on */
437 h->interrupts_enabled = 1;
438 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500439 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800440 } else { /* Turn them off */
441 h->interrupts_enabled = 0;
442 writel(SA5_INTR_OFF,
443 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 }
446}
Don Brace303932f2010-02-04 08:42:40 -0600447
448static void SA5_performant_intr_mask(struct ctlr_info *h, unsigned long val)
449{
450 if (val) { /* turn on interrupts */
451 h->interrupts_enabled = 1;
452 writel(0, 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);
Don Brace303932f2010-02-04 08:42:40 -0600454 } else {
455 h->interrupts_enabled = 0;
456 writel(SA5_PERF_INTR_OFF,
457 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500458 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Don Brace303932f2010-02-04 08:42:40 -0600459 }
460}
461
Matt Gates254f7962012-05-01 11:43:06 -0500462static unsigned long SA5_performant_completed(struct ctlr_info *h, u8 q)
Don Brace303932f2010-02-04 08:42:40 -0600463{
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500464 struct reply_queue_buffer *rq = &h->reply_queue[q];
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600465 unsigned long register_value = FIFO_EMPTY;
Don Brace303932f2010-02-04 08:42:40 -0600466
Don Brace303932f2010-02-04 08:42:40 -0600467 /* msi auto clears the interrupt pending bit. */
Christoph Hellwigbc2bb152016-11-09 10:42:22 -0800468 if (unlikely(!(h->pdev->msi_enabled || h->msix_vectors))) {
Stephen M. Cameron2c17d2d2012-05-01 11:42:30 -0500469 /* flush the controller write of the reply queue by reading
470 * outbound doorbell status register.
471 */
Don Bracebee266a2015-01-23 16:43:51 -0600472 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600473 writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
474 /* Do a read in order to flush the write to the controller
475 * (as per spec.)
476 */
Don Bracebee266a2015-01-23 16:43:51 -0600477 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600478 }
479
Don Bracebee266a2015-01-23 16:43:51 -0600480 if ((((u32) rq->head[rq->current_entry]) & 1) == rq->wraparound) {
Matt Gates254f7962012-05-01 11:43:06 -0500481 register_value = rq->head[rq->current_entry];
482 rq->current_entry++;
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600483 atomic_dec(&h->commands_outstanding);
Don Brace303932f2010-02-04 08:42:40 -0600484 } else {
485 register_value = FIFO_EMPTY;
486 }
487 /* Check for wraparound */
Matt Gates254f7962012-05-01 11:43:06 -0500488 if (rq->current_entry == h->max_commands) {
489 rq->current_entry = 0;
490 rq->wraparound ^= 1;
Don Brace303932f2010-02-04 08:42:40 -0600491 }
Don Brace303932f2010-02-04 08:42:40 -0600492 return register_value;
493}
494
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800495/*
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800496 * returns value read from hardware.
497 * returns FIFO_EMPTY if there is nothing to read
498 */
Matt Gates254f7962012-05-01 11:43:06 -0500499static unsigned long SA5_completed(struct ctlr_info *h,
500 __attribute__((unused)) u8 q)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800501{
502 unsigned long register_value
503 = readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
504
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600505 if (register_value != FIFO_EMPTY)
506 atomic_dec(&h->commands_outstanding);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800507
508#ifdef HPSA_DEBUG
509 if (register_value != FIFO_EMPTY)
Stephen M. Cameron84ca0be2010-02-04 08:42:30 -0600510 dev_dbg(&h->pdev->dev, "Read %lx back from board\n",
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800511 register_value);
512 else
Stephen M. Cameronf79cfec2012-01-19 14:00:59 -0600513 dev_dbg(&h->pdev->dev, "FIFO Empty read\n");
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800514#endif
515
516 return register_value;
517}
518/*
519 * Returns true if an interrupt is pending..
520 */
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600521static bool SA5_intr_pending(struct ctlr_info *h)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800522{
523 unsigned long register_value =
524 readl(h->vaddr + SA5_INTR_STATUS);
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600525 return register_value & SA5_INTR_PENDING;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800526}
527
Don Brace303932f2010-02-04 08:42:40 -0600528static bool SA5_performant_intr_pending(struct ctlr_info *h)
529{
530 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
531
532 if (!register_value)
533 return false;
534
Don Brace303932f2010-02-04 08:42:40 -0600535 /* Read outbound doorbell to flush */
536 register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
537 return register_value & SA5_OUTDB_STATUS_PERF_BIT;
538}
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800539
Matt Gatese1f7de02014-02-18 13:55:17 -0600540#define SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT 0x100
541
542static bool SA5_ioaccel_mode1_intr_pending(struct ctlr_info *h)
543{
544 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
545
546 return (register_value & SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT) ?
547 true : false;
548}
549
550#define IOACCEL_MODE1_REPLY_QUEUE_INDEX 0x1A0
551#define IOACCEL_MODE1_PRODUCER_INDEX 0x1B8
552#define IOACCEL_MODE1_CONSUMER_INDEX 0x1BC
553#define IOACCEL_MODE1_REPLY_UNUSED 0xFFFFFFFFFFFFFFFFULL
554
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600555static unsigned long SA5_ioaccel_mode1_completed(struct ctlr_info *h, u8 q)
Matt Gatese1f7de02014-02-18 13:55:17 -0600556{
557 u64 register_value;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500558 struct reply_queue_buffer *rq = &h->reply_queue[q];
Matt Gatese1f7de02014-02-18 13:55:17 -0600559
560 BUG_ON(q >= h->nreply_queues);
561
562 register_value = rq->head[rq->current_entry];
563 if (register_value != IOACCEL_MODE1_REPLY_UNUSED) {
564 rq->head[rq->current_entry] = IOACCEL_MODE1_REPLY_UNUSED;
565 if (++rq->current_entry == rq->size)
566 rq->current_entry = 0;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600567 /*
568 * @todo
569 *
570 * Don't really need to write the new index after each command,
571 * but with current driver design this is easiest.
572 */
573 wmb();
574 writel((q << 24) | rq->current_entry, h->vaddr +
575 IOACCEL_MODE1_CONSUMER_INDEX);
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600576 atomic_dec(&h->commands_outstanding);
Matt Gatese1f7de02014-02-18 13:55:17 -0600577 }
578 return (unsigned long) register_value;
579}
580
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800581static struct access_method SA5_access = {
Kees Cook93380122016-12-16 17:04:49 -0800582 .submit_command = SA5_submit_command,
583 .set_intr_mask = SA5_intr_mask,
584 .intr_pending = SA5_intr_pending,
585 .command_completed = SA5_completed,
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800586};
587
Matt Gatese1f7de02014-02-18 13:55:17 -0600588static struct access_method SA5_ioaccel_mode1_access = {
Kees Cook93380122016-12-16 17:04:49 -0800589 .submit_command = SA5_submit_command,
590 .set_intr_mask = SA5_performant_intr_mask,
591 .intr_pending = SA5_ioaccel_mode1_intr_pending,
592 .command_completed = SA5_ioaccel_mode1_completed,
Matt Gatese1f7de02014-02-18 13:55:17 -0600593};
594
Scott Teelc3497752014-02-18 13:56:34 -0600595static struct access_method SA5_ioaccel_mode2_access = {
Kees Cook93380122016-12-16 17:04:49 -0800596 .submit_command = SA5_submit_command_ioaccel2,
597 .set_intr_mask = SA5_performant_intr_mask,
598 .intr_pending = SA5_performant_intr_pending,
599 .command_completed = SA5_performant_completed,
Scott Teelc3497752014-02-18 13:56:34 -0600600};
601
Don Brace303932f2010-02-04 08:42:40 -0600602static struct access_method SA5_performant_access = {
Kees Cook93380122016-12-16 17:04:49 -0800603 .submit_command = SA5_submit_command,
604 .set_intr_mask = SA5_performant_intr_mask,
605 .intr_pending = SA5_performant_intr_pending,
606 .command_completed = SA5_performant_completed,
Don Brace303932f2010-02-04 08:42:40 -0600607};
608
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500609static struct access_method SA5_performant_access_no_read = {
Kees Cook93380122016-12-16 17:04:49 -0800610 .submit_command = SA5_submit_command_no_read,
611 .set_intr_mask = SA5_performant_intr_mask,
612 .intr_pending = SA5_performant_intr_pending,
613 .command_completed = SA5_performant_completed,
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500614};
615
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800616struct board_type {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600617 u32 board_id;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800618 char *product_name;
619 struct access_method *access;
620};
621
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800622#endif /* HPSA_H */
623