blob: e16f2945f6acfe0b4dfc0311e57d9620af230d1f [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
Matt Gates254f7962012-05-01 11:43:06 -0500179 unsigned int intr[MAX_REPLY_QUEUES];
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800180 unsigned int msix_vector;
181 unsigned int msi_vector;
Stephen M. Camerona9a3a272011-02-15 15:32:53 -0600182 int intr_mode; /* either PERF_MODE_INT or SIMPLE_MODE_INT */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800183 struct access_method access;
184
185 /* queue and queue Info */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800186 unsigned int Qdepth;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800187 unsigned int maxSG;
188 spinlock_t lock;
Stephen M. Cameron33a2ffc2010-02-25 14:03:27 -0600189 int maxsgentries;
190 u8 max_cmd_sg_entries;
191 int chainsize;
192 struct SGDescriptor **cmd_sg_list;
Webb Scalesd9a729f2015-04-23 09:33:27 -0500193 struct ioaccel2_sg_element **ioaccel2_cmd_sg_list;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800194
195 /* pointers to command and error info pool */
196 struct CommandList *cmd_pool;
197 dma_addr_t cmd_pool_dhandle;
Matt Gatese1f7de02014-02-18 13:55:17 -0600198 struct io_accel1_cmd *ioaccel_cmd_pool;
199 dma_addr_t ioaccel_cmd_pool_dhandle;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600200 struct io_accel2_cmd *ioaccel2_cmd_pool;
201 dma_addr_t ioaccel2_cmd_pool_dhandle;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800202 struct ErrorInfo *errinfo_pool;
203 dma_addr_t errinfo_pool_dhandle;
204 unsigned long *cmd_pool_bits;
Stephen M. Camerona08a8472010-02-04 08:43:16 -0600205 int scan_finished;
Don Brace0f07e762017-03-10 14:35:17 -0600206 u8 scan_waiting : 1;
Stephen M. Camerona08a8472010-02-04 08:43:16 -0600207 spinlock_t scan_lock;
208 wait_queue_head_t scan_wait_queue;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800209
210 struct Scsi_Host *scsi_host;
211 spinlock_t devlock; /* to protect hba[ctlr]->dev[]; */
212 int ndevices; /* number of used elements in .dev[] array. */
Scott Teelcfe5bad2011-10-26 16:21:07 -0500213 struct hpsa_scsi_dev_t *dev[HPSA_MAX_DEVICES];
Don Brace303932f2010-02-04 08:42:40 -0600214 /*
215 * Performant mode tables.
216 */
217 u32 trans_support;
218 u32 trans_offset;
Don Brace42a91642014-11-14 17:26:27 -0600219 struct TransTable_struct __iomem *transtable;
Don Brace303932f2010-02-04 08:42:40 -0600220 unsigned long transMethod;
221
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500222 /* cap concurrent passthrus at some reasonable maximum */
Stephen Cameron45fcb862015-01-23 16:43:04 -0600223#define HPSA_MAX_CONCURRENT_PASSTHRUS (10)
Don Brace34f0c622015-01-23 16:43:46 -0600224 atomic_t passthru_cmds_avail;
Stephen M. Cameron0390f0c2013-09-23 13:34:12 -0500225
Don Brace303932f2010-02-04 08:42:40 -0600226 /*
Matt Gates254f7962012-05-01 11:43:06 -0500227 * Performant mode completion buffers
Don Brace303932f2010-02-04 08:42:40 -0600228 */
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500229 size_t reply_queue_size;
230 struct reply_queue_buffer reply_queue[MAX_REPLY_QUEUES];
Matt Gates254f7962012-05-01 11:43:06 -0500231 u8 nreply_queues;
Don Brace303932f2010-02-04 08:42:40 -0600232 u32 *blockFetchTable;
Matt Gatese1f7de02014-02-18 13:55:17 -0600233 u32 *ioaccel1_blockFetchTable;
Stephen M. Cameronaca90122014-02-18 13:56:14 -0600234 u32 *ioaccel2_blockFetchTable;
Don Brace42a91642014-11-14 17:26:27 -0600235 u32 __iomem *ioaccel2_bft2_regs;
Stephen M. Cameron339b2b12010-02-04 08:42:50 -0600236 unsigned char *hba_inquiry_data;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600237 u32 driver_support;
238 u32 fw_support;
239 int ioaccel_support;
240 int ioaccel_maxsg;
Stephen M. Camerona0c12412011-10-26 16:22:04 -0500241 u64 last_intr_timestamp;
242 u32 last_heartbeat;
243 u64 last_heartbeat_timestamp;
Stephen M. Camerone85c5972012-05-01 11:43:42 -0500244 u32 heartbeat_sample_interval;
245 atomic_t firmware_flash_in_progress;
Don Brace42a91642014-11-14 17:26:27 -0600246 u32 __percpu *lockup_detected;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600247 struct delayed_work monitor_ctlr_work;
Don Brace6636e7f2015-01-23 16:45:17 -0600248 struct delayed_work rescan_ctlr_work;
Stephen M. Cameron8a98db732013-12-04 17:10:07 -0600249 int remove_in_progress;
Matt Gates254f7962012-05-01 11:43:06 -0500250 /* Address of h->q[x] is passed to intr handler to know which queue */
251 u8 q[MAX_REPLY_QUEUES];
Robert Elliott8b470042015-04-23 09:34:58 -0500252 char intrname[MAX_REPLY_QUEUES][16]; /* "hpsa0-msix00" names */
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500253 u32 TMFSupportFlags; /* cache what task mgmt funcs are supported. */
254#define HPSATMF_BITS_SUPPORTED (1 << 0)
255#define HPSATMF_PHYS_LUN_RESET (1 << 1)
256#define HPSATMF_PHYS_NEX_RESET (1 << 2)
257#define HPSATMF_PHYS_TASK_ABORT (1 << 3)
258#define HPSATMF_PHYS_TSET_ABORT (1 << 4)
259#define HPSATMF_PHYS_CLEAR_ACA (1 << 5)
260#define HPSATMF_PHYS_CLEAR_TSET (1 << 6)
261#define HPSATMF_PHYS_QRY_TASK (1 << 7)
262#define HPSATMF_PHYS_QRY_TSET (1 << 8)
263#define HPSATMF_PHYS_QRY_ASYNC (1 << 9)
Stephen Cameron8be986c2015-04-23 09:34:06 -0500264#define HPSATMF_IOACCEL_ENABLED (1 << 15)
Stephen M. Cameron75167d22012-05-01 11:42:51 -0500265#define HPSATMF_MASK_SUPPORTED (1 << 16)
266#define HPSATMF_LOG_LUN_RESET (1 << 17)
267#define HPSATMF_LOG_NEX_RESET (1 << 18)
268#define HPSATMF_LOG_TASK_ABORT (1 << 19)
269#define HPSATMF_LOG_TSET_ABORT (1 << 20)
270#define HPSATMF_LOG_CLEAR_ACA (1 << 21)
271#define HPSATMF_LOG_CLEAR_TSET (1 << 22)
272#define HPSATMF_LOG_QRY_TASK (1 << 23)
273#define HPSATMF_LOG_QRY_TSET (1 << 24)
274#define HPSATMF_LOG_QRY_ASYNC (1 << 25)
Stephen M. Cameron76438d02014-02-18 13:55:43 -0600275 u32 events;
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600276#define CTLR_STATE_CHANGE_EVENT (1 << 0)
277#define CTLR_ENCLOSURE_HOT_PLUG_EVENT (1 << 1)
278#define CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV (1 << 4)
279#define CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV (1 << 5)
280#define CTLR_STATE_CHANGE_EVENT_REDUNDANT_CNTRL (1 << 6)
281#define CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED (1 << 30)
282#define CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE (1 << 31)
283
284#define RESCAN_REQUIRED_EVENT_BITS \
Stephen M. Cameron7b2c46e2014-05-29 10:53:44 -0500285 (CTLR_ENCLOSURE_HOT_PLUG_EVENT | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600286 CTLR_STATE_CHANGE_EVENT_PHYSICAL_DRV | \
287 CTLR_STATE_CHANGE_EVENT_LOGICAL_DRV | \
Stephen M. Cameronfaff6ee2014-02-18 13:57:42 -0600288 CTLR_STATE_CHANGE_EVENT_AIO_ENABLED_DISABLED | \
289 CTLR_STATE_CHANGE_EVENT_AIO_CONFIG_CHANGE)
Stephen M. Cameron98465902014-02-21 16:25:00 -0600290 spinlock_t offline_device_lock;
291 struct list_head offline_device_list;
Scott Teelda0697b2014-02-18 13:57:00 -0600292 int acciopath_status;
Don Brace853633e2015-11-04 15:50:37 -0600293 int drv_req_rescan;
Stephen M. Cameron2ba8bfc2014-02-18 13:57:52 -0600294 int raid_offload_debug;
Scott Teel34592252015-11-04 15:52:09 -0600295 int discovery_polling;
296 struct ReportLUNdata *lastlogicals;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500297 int needs_abort_tags_swizzled;
Don Brace080ef1c2015-01-23 16:43:25 -0600298 struct workqueue_struct *resubmit_wq;
Don Brace6636e7f2015-01-23 16:45:17 -0600299 struct workqueue_struct *rescan_ctlr_wq;
Stephen Cameron9b5c48c2015-04-23 09:32:06 -0500300 atomic_t abort_cmds_available;
301 wait_queue_head_t abort_cmd_wait_queue;
Webb Scalesd604f532015-04-23 09:35:22 -0500302 wait_queue_head_t event_sync_wait_queue;
303 struct mutex reset_mutex;
Don Braceda03ded2015-11-04 15:50:56 -0600304 u8 reset_in_progress;
Kevin Barnettd04e62b2015-11-04 15:52:34 -0600305 struct hpsa_sas_node *sas_host;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800306};
Stephen M. Cameron98465902014-02-21 16:25:00 -0600307
308struct offline_device_entry {
309 unsigned char scsi3addr[8];
310 struct list_head offline_list;
311};
312
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800313#define HPSA_ABORT_MSG 0
314#define HPSA_DEVICE_RESET_MSG 1
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500315#define HPSA_RESET_TYPE_CONTROLLER 0x00
316#define HPSA_RESET_TYPE_BUS 0x01
Stephen M. Cameron64670ac2011-05-03 14:59:51 -0500317#define HPSA_RESET_TYPE_LUN 0x04
Scott Teel0b9b7b62015-11-04 15:51:02 -0600318#define HPSA_PHYS_TARGET_RESET 0x99 /* not defined by cciss spec */
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800319#define HPSA_MSG_SEND_RETRY_LIMIT 10
Stephen M. Cameron516fda42011-05-03 14:59:15 -0500320#define HPSA_MSG_SEND_RETRY_INTERVAL_MSECS (10000)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800321
322/* Maximum time in seconds driver will wait for command completions
323 * when polling before giving up.
324 */
325#define HPSA_MAX_POLL_TIME_SECS (20)
326
327/* During SCSI error recovery, HPSA_TUR_RETRY_LIMIT defines
328 * how many times to retry TEST UNIT READY on a device
329 * while waiting for it to become ready before giving up.
330 * HPSA_MAX_WAIT_INTERVAL_SECS is the max wait interval
331 * between sending TURs while waiting for a device
332 * to become ready.
333 */
334#define HPSA_TUR_RETRY_LIMIT (20)
335#define HPSA_MAX_WAIT_INTERVAL_SECS (30)
336
337/* HPSA_BOARD_READY_WAIT_SECS is how long to wait for a board
338 * to become ready, in seconds, before giving up on it.
339 * HPSA_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
340 * between polling the board to see if it is ready, in
341 * milliseconds. HPSA_BOARD_READY_POLL_INTERVAL and
342 * HPSA_BOARD_READY_ITERATIONS are derived from those.
343 */
344#define HPSA_BOARD_READY_WAIT_SECS (120)
Stephen M. Cameron2ed71272011-05-03 14:59:31 -0500345#define HPSA_BOARD_NOT_READY_WAIT_SECS (100)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800346#define HPSA_BOARD_READY_POLL_INTERVAL_MSECS (100)
347#define HPSA_BOARD_READY_POLL_INTERVAL \
348 ((HPSA_BOARD_READY_POLL_INTERVAL_MSECS * HZ) / 1000)
349#define HPSA_BOARD_READY_ITERATIONS \
350 ((HPSA_BOARD_READY_WAIT_SECS * 1000) / \
351 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronfe5389c2011-01-06 14:48:03 -0600352#define HPSA_BOARD_NOT_READY_ITERATIONS \
353 ((HPSA_BOARD_NOT_READY_WAIT_SECS * 1000) / \
354 HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800355#define HPSA_POST_RESET_PAUSE_MSECS (3000)
356#define HPSA_POST_RESET_NOOP_RETRIES (12)
357
358/* Defining the diffent access_menthods */
359/*
360 * Memory mapped FIFO interface (SMART 53xx cards)
361 */
362#define SA5_DOORBELL 0x20
363#define SA5_REQUEST_PORT_OFFSET 0x40
Webb Scales281a7fd2015-01-23 16:43:35 -0600364#define SA5_REQUEST_PORT64_LO_OFFSET 0xC0
365#define SA5_REQUEST_PORT64_HI_OFFSET 0xC4
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800366#define SA5_REPLY_INTR_MASK_OFFSET 0x34
367#define SA5_REPLY_PORT_OFFSET 0x44
368#define SA5_INTR_STATUS 0x30
369#define SA5_SCRATCHPAD_OFFSET 0xB0
370
371#define SA5_CTCFG_OFFSET 0xB4
372#define SA5_CTMEM_OFFSET 0xB8
373
374#define SA5_INTR_OFF 0x08
375#define SA5B_INTR_OFF 0x04
376#define SA5_INTR_PENDING 0x08
377#define SA5B_INTR_PENDING 0x04
378#define FIFO_EMPTY 0xffffffff
379#define HPSA_FIRMWARE_READY 0xffff0000 /* value in scratchpad register */
380
381#define HPSA_ERROR_BIT 0x02
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800382
Don Brace303932f2010-02-04 08:42:40 -0600383/* Performant mode flags */
384#define SA5_PERF_INTR_PENDING 0x04
385#define SA5_PERF_INTR_OFF 0x05
386#define SA5_OUTDB_STATUS_PERF_BIT 0x01
387#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
388#define SA5_OUTDB_CLEAR 0xA0
389#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
390#define SA5_OUTDB_STATUS 0x9C
391
392
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800393#define HPSA_INTR_ON 1
394#define HPSA_INTR_OFF 0
Mike Millerb66cc252014-02-18 13:56:04 -0600395
396/*
397 * Inbound Post Queue offsets for IO Accelerator Mode 2
398 */
399#define IOACCEL2_INBOUND_POSTQ_32 0x48
400#define IOACCEL2_INBOUND_POSTQ_64_LOW 0xd0
401#define IOACCEL2_INBOUND_POSTQ_64_HI 0xd4
402
Kevin Barnettc7955052015-11-04 15:51:45 -0600403#define HPSA_PHYSICAL_DEVICE_BUS 0
404#define HPSA_RAID_VOLUME_BUS 1
405#define HPSA_EXTERNAL_RAID_VOLUME_BUS 2
Don Brace09371d62015-12-22 10:36:42 -0600406#define HPSA_HBA_BUS 0
Hannes Reinecke7630b3a2016-11-17 12:15:56 +0100407#define HPSA_LEGACY_HBA_BUS 3
Kevin Barnettc7955052015-11-04 15:51:45 -0600408
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800409/*
410 Send the command to the hardware
411*/
412static void SA5_submit_command(struct ctlr_info *h,
413 struct CommandList *c)
414{
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800415 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Stephen M. Cameronfec62c32011-07-21 13:16:05 -0500416 (void) readl(h->vaddr + SA5_SCRATCHPAD_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800417}
418
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500419static void SA5_submit_command_no_read(struct ctlr_info *h,
420 struct CommandList *c)
421{
422 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
423}
424
Scott Teelc3497752014-02-18 13:56:34 -0600425static void SA5_submit_command_ioaccel2(struct ctlr_info *h,
426 struct CommandList *c)
427{
Stephen Cameronc05e8862015-01-23 16:44:40 -0600428 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
Scott Teelc3497752014-02-18 13:56:34 -0600429}
430
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800431/*
432 * This card is the opposite of the other cards.
433 * 0 turns interrupts on...
434 * 0x08 turns them off...
435 */
436static void SA5_intr_mask(struct ctlr_info *h, unsigned long val)
437{
438 if (val) { /* Turn interrupts on */
439 h->interrupts_enabled = 1;
440 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500441 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800442 } else { /* Turn them off */
443 h->interrupts_enabled = 0;
444 writel(SA5_INTR_OFF,
445 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500446 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800447 }
448}
Don Brace303932f2010-02-04 08:42:40 -0600449
450static void SA5_performant_intr_mask(struct ctlr_info *h, unsigned long val)
451{
452 if (val) { /* turn on interrupts */
453 h->interrupts_enabled = 1;
454 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500455 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Don Brace303932f2010-02-04 08:42:40 -0600456 } else {
457 h->interrupts_enabled = 0;
458 writel(SA5_PERF_INTR_OFF,
459 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Stephen M. Cameron8cd21da2011-05-03 14:58:55 -0500460 (void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
Don Brace303932f2010-02-04 08:42:40 -0600461 }
462}
463
Matt Gates254f7962012-05-01 11:43:06 -0500464static unsigned long SA5_performant_completed(struct ctlr_info *h, u8 q)
Don Brace303932f2010-02-04 08:42:40 -0600465{
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500466 struct reply_queue_buffer *rq = &h->reply_queue[q];
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600467 unsigned long register_value = FIFO_EMPTY;
Don Brace303932f2010-02-04 08:42:40 -0600468
Don Brace303932f2010-02-04 08:42:40 -0600469 /* msi auto clears the interrupt pending bit. */
Don Bracebee266a2015-01-23 16:43:51 -0600470 if (unlikely(!(h->msi_vector || h->msix_vector))) {
Stephen M. Cameron2c17d2d2012-05-01 11:42:30 -0500471 /* flush the controller write of the reply queue by reading
472 * outbound doorbell status register.
473 */
Don Bracebee266a2015-01-23 16:43:51 -0600474 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600475 writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
476 /* Do a read in order to flush the write to the controller
477 * (as per spec.)
478 */
Don Bracebee266a2015-01-23 16:43:51 -0600479 (void) readl(h->vaddr + SA5_OUTDB_STATUS);
Don Brace303932f2010-02-04 08:42:40 -0600480 }
481
Don Bracebee266a2015-01-23 16:43:51 -0600482 if ((((u32) rq->head[rq->current_entry]) & 1) == rq->wraparound) {
Matt Gates254f7962012-05-01 11:43:06 -0500483 register_value = rq->head[rq->current_entry];
484 rq->current_entry++;
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600485 atomic_dec(&h->commands_outstanding);
Don Brace303932f2010-02-04 08:42:40 -0600486 } else {
487 register_value = FIFO_EMPTY;
488 }
489 /* Check for wraparound */
Matt Gates254f7962012-05-01 11:43:06 -0500490 if (rq->current_entry == h->max_commands) {
491 rq->current_entry = 0;
492 rq->wraparound ^= 1;
Don Brace303932f2010-02-04 08:42:40 -0600493 }
Don Brace303932f2010-02-04 08:42:40 -0600494 return register_value;
495}
496
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800497/*
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800498 * returns value read from hardware.
499 * returns FIFO_EMPTY if there is nothing to read
500 */
Matt Gates254f7962012-05-01 11:43:06 -0500501static unsigned long SA5_completed(struct ctlr_info *h,
502 __attribute__((unused)) u8 q)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800503{
504 unsigned long register_value
505 = readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
506
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600507 if (register_value != FIFO_EMPTY)
508 atomic_dec(&h->commands_outstanding);
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800509
510#ifdef HPSA_DEBUG
511 if (register_value != FIFO_EMPTY)
Stephen M. Cameron84ca0be2010-02-04 08:42:30 -0600512 dev_dbg(&h->pdev->dev, "Read %lx back from board\n",
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800513 register_value);
514 else
Stephen M. Cameronf79cfec2012-01-19 14:00:59 -0600515 dev_dbg(&h->pdev->dev, "FIFO Empty read\n");
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800516#endif
517
518 return register_value;
519}
520/*
521 * Returns true if an interrupt is pending..
522 */
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600523static bool SA5_intr_pending(struct ctlr_info *h)
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800524{
525 unsigned long register_value =
526 readl(h->vaddr + SA5_INTR_STATUS);
Stephen M. Cameron900c5442010-02-04 08:42:35 -0600527 return register_value & SA5_INTR_PENDING;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800528}
529
Don Brace303932f2010-02-04 08:42:40 -0600530static bool SA5_performant_intr_pending(struct ctlr_info *h)
531{
532 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
533
534 if (!register_value)
535 return false;
536
Don Brace303932f2010-02-04 08:42:40 -0600537 /* Read outbound doorbell to flush */
538 register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
539 return register_value & SA5_OUTDB_STATUS_PERF_BIT;
540}
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800541
Matt Gatese1f7de02014-02-18 13:55:17 -0600542#define SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT 0x100
543
544static bool SA5_ioaccel_mode1_intr_pending(struct ctlr_info *h)
545{
546 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
547
548 return (register_value & SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT) ?
549 true : false;
550}
551
552#define IOACCEL_MODE1_REPLY_QUEUE_INDEX 0x1A0
553#define IOACCEL_MODE1_PRODUCER_INDEX 0x1B8
554#define IOACCEL_MODE1_CONSUMER_INDEX 0x1BC
555#define IOACCEL_MODE1_REPLY_UNUSED 0xFFFFFFFFFFFFFFFFULL
556
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600557static unsigned long SA5_ioaccel_mode1_completed(struct ctlr_info *h, u8 q)
Matt Gatese1f7de02014-02-18 13:55:17 -0600558{
559 u64 register_value;
Stephen M. Cameron072b0512014-05-29 10:53:07 -0500560 struct reply_queue_buffer *rq = &h->reply_queue[q];
Matt Gatese1f7de02014-02-18 13:55:17 -0600561
562 BUG_ON(q >= h->nreply_queues);
563
564 register_value = rq->head[rq->current_entry];
565 if (register_value != IOACCEL_MODE1_REPLY_UNUSED) {
566 rq->head[rq->current_entry] = IOACCEL_MODE1_REPLY_UNUSED;
567 if (++rq->current_entry == rq->size)
568 rq->current_entry = 0;
Stephen M. Cameron283b4a92014-02-18 13:55:33 -0600569 /*
570 * @todo
571 *
572 * Don't really need to write the new index after each command,
573 * but with current driver design this is easiest.
574 */
575 wmb();
576 writel((q << 24) | rq->current_entry, h->vaddr +
577 IOACCEL_MODE1_CONSUMER_INDEX);
Stephen M. Cameron0cbf7682014-11-14 17:27:09 -0600578 atomic_dec(&h->commands_outstanding);
Matt Gatese1f7de02014-02-18 13:55:17 -0600579 }
580 return (unsigned long) register_value;
581}
582
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800583static struct access_method SA5_access = {
584 SA5_submit_command,
585 SA5_intr_mask,
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800586 SA5_intr_pending,
587 SA5_completed,
588};
589
Matt Gatese1f7de02014-02-18 13:55:17 -0600590static struct access_method SA5_ioaccel_mode1_access = {
591 SA5_submit_command,
592 SA5_performant_intr_mask,
Matt Gatese1f7de02014-02-18 13:55:17 -0600593 SA5_ioaccel_mode1_intr_pending,
594 SA5_ioaccel_mode1_completed,
595};
596
Scott Teelc3497752014-02-18 13:56:34 -0600597static struct access_method SA5_ioaccel_mode2_access = {
598 SA5_submit_command_ioaccel2,
599 SA5_performant_intr_mask,
Scott Teelc3497752014-02-18 13:56:34 -0600600 SA5_performant_intr_pending,
601 SA5_performant_completed,
602};
603
Don Brace303932f2010-02-04 08:42:40 -0600604static struct access_method SA5_performant_access = {
605 SA5_submit_command,
606 SA5_performant_intr_mask,
Don Brace303932f2010-02-04 08:42:40 -0600607 SA5_performant_intr_pending,
608 SA5_performant_completed,
609};
610
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500611static struct access_method SA5_performant_access_no_read = {
612 SA5_submit_command_no_read,
613 SA5_performant_intr_mask,
Stephen M. Cameronb3a52e72014-05-29 10:53:23 -0500614 SA5_performant_intr_pending,
615 SA5_performant_completed,
616};
617
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800618struct board_type {
Stephen M. Cameron01a02ff2010-02-04 08:41:33 -0600619 u32 board_id;
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800620 char *product_name;
621 struct access_method *access;
622};
623
Stephen M. Cameronedd16362009-12-08 14:09:11 -0800624#endif /* HPSA_H */
625