mpt2sas_base.h revision 50d5c60634673a79f8d88564e10345b50fca7378
1/*
2 * This is the Fusion MPT base driver providing common API layer interface
3 * for access to MPT (Message Passing Technology) firmware.
4 *
5 * This code is based on drivers/scsi/mpt2sas/mpt2_base.h
6 * Copyright (C) 2007-2009  LSI Corporation
7 *  (mailto:DL-MPTFusionLinux@lsi.com)
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * NO WARRANTY
20 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
21 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
22 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
23 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
24 * solely responsible for determining the appropriateness of using and
25 * distributing the Program and assumes all risks associated with its
26 * exercise of rights under this Agreement, including but not limited to
27 * the risks and costs of program errors, damage to or loss of data,
28 * programs or equipment, and unavailability or interruption of operations.
29
30 * DISCLAIMER OF LIABILITY
31 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
32 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
34 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
35 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
36 * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
37 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
38
39 * You should have received a copy of the GNU General Public License
40 * along with this program; if not, write to the Free Software
41 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
42 * USA.
43 */
44
45#ifndef MPT2SAS_BASE_H_INCLUDED
46#define MPT2SAS_BASE_H_INCLUDED
47
48#include "mpi/mpi2_type.h"
49#include "mpi/mpi2.h"
50#include "mpi/mpi2_ioc.h"
51#include "mpi/mpi2_cnfg.h"
52#include "mpi/mpi2_init.h"
53#include "mpi/mpi2_raid.h"
54#include "mpi/mpi2_tool.h"
55#include "mpi/mpi2_sas.h"
56
57#include <scsi/scsi.h>
58#include <scsi/scsi_cmnd.h>
59#include <scsi/scsi_device.h>
60#include <scsi/scsi_host.h>
61#include <scsi/scsi_tcq.h>
62#include <scsi/scsi_transport_sas.h>
63#include <scsi/scsi_dbg.h>
64#include <scsi/scsi_eh.h>
65
66#include "mpt2sas_debug.h"
67
68/* driver versioning info */
69#define MPT2SAS_DRIVER_NAME		"mpt2sas"
70#define MPT2SAS_AUTHOR	"LSI Corporation <DL-MPTFusionLinux@lsi.com>"
71#define MPT2SAS_DESCRIPTION	"LSI MPT Fusion SAS 2.0 Device Driver"
72#define MPT2SAS_DRIVER_VERSION		"03.100.03.00"
73#define MPT2SAS_MAJOR_VERSION		03
74#define MPT2SAS_MINOR_VERSION		100
75#define MPT2SAS_BUILD_VERSION		03
76#define MPT2SAS_RELEASE_VERSION		00
77
78/*
79 * Set MPT2SAS_SG_DEPTH value based on user input.
80 */
81#ifdef CONFIG_SCSI_MPT2SAS_MAX_SGE
82#if     CONFIG_SCSI_MPT2SAS_MAX_SGE  < 16
83#define MPT2SAS_SG_DEPTH       16
84#elif CONFIG_SCSI_MPT2SAS_MAX_SGE  > 128
85#define MPT2SAS_SG_DEPTH       128
86#else
87#define MPT2SAS_SG_DEPTH       CONFIG_SCSI_MPT2SAS_MAX_SGE
88#endif
89#else
90#define MPT2SAS_SG_DEPTH       128 /* MAX_HW_SEGMENTS */
91#endif
92
93
94/*
95 * Generic Defines
96 */
97#define MPT2SAS_SATA_QUEUE_DEPTH	32
98#define MPT2SAS_SAS_QUEUE_DEPTH		254
99#define MPT2SAS_RAID_QUEUE_DEPTH	128
100
101#define MPT_NAME_LENGTH			32	/* generic length of strings */
102#define MPT_STRING_LENGTH		64
103
104#define	MPT_MAX_CALLBACKS		16
105
106#define	 CAN_SLEEP			1
107#define  NO_SLEEP			0
108
109#define INTERNAL_CMDS_COUNT		10	/* reserved cmds */
110
111#define MPI2_HIM_MASK			0xFFFFFFFF /* mask every bit*/
112
113#define MPT2SAS_INVALID_DEVICE_HANDLE	0xFFFF
114
115
116/*
117 * reset phases
118 */
119#define MPT2_IOC_PRE_RESET		1 /* prior to host reset */
120#define MPT2_IOC_AFTER_RESET		2 /* just after host reset */
121#define MPT2_IOC_DONE_RESET		3 /* links re-initialized */
122#define MPT2_IOC_RUNNING		4 /* shost running */
123
124/*
125 * logging format
126 */
127#define MPT2SAS_FMT			"%s: "
128#define MPT2SAS_DEBUG_FMT		KERN_DEBUG MPT2SAS_FMT
129#define MPT2SAS_INFO_FMT		KERN_INFO MPT2SAS_FMT
130#define MPT2SAS_NOTE_FMT		KERN_NOTICE MPT2SAS_FMT
131#define MPT2SAS_WARN_FMT		KERN_WARNING MPT2SAS_FMT
132#define MPT2SAS_ERR_FMT			KERN_ERR MPT2SAS_FMT
133
134/*
135 * Dell HBA branding
136 */
137#define MPT2SAS_DELL_BRANDING_SIZE                 32
138
139#define MPT2SAS_DELL_6GBPS_SAS_HBA_BRANDING        "Dell 6Gbps SAS HBA"
140#define MPT2SAS_DELL_PERC_H200_ADAPTER_BRANDING    "Dell PERC H200 Adapter"
141#define MPT2SAS_DELL_PERC_H200_INTEGRATED_BRANDING "Dell PERC H200 Integrated"
142#define MPT2SAS_DELL_PERC_H200_MODULAR_BRANDING    "Dell PERC H200 Modular"
143#define MPT2SAS_DELL_PERC_H200_EMBEDDED_BRANDING   "Dell PERC H200 Embedded"
144#define MPT2SAS_DELL_PERC_H200_BRANDING            "Dell PERC H200"
145#define MPT2SAS_DELL_6GBPS_SAS_BRANDING            "Dell 6Gbps SAS"
146
147/*
148 * Dell HBA SSDIDs
149 */
150#define MPT2SAS_DELL_6GBPS_SAS_HBA_SSDID           0x1F1C
151#define MPT2SAS_DELL_PERC_H200_ADAPTER_SSDID       0x1F1D
152#define MPT2SAS_DELL_PERC_H200_INTEGRATED_SSDID    0x1F1E
153#define MPT2SAS_DELL_PERC_H200_MODULAR_SSDID       0x1F1F
154#define MPT2SAS_DELL_PERC_H200_EMBEDDED_SSDID      0x1F20
155#define MPT2SAS_DELL_PERC_H200_SSDID               0x1F21
156#define MPT2SAS_DELL_6GBPS_SAS_SSDID               0x1F22
157
158/*
159 * per target private data
160 */
161#define MPT_TARGET_FLAGS_RAID_COMPONENT	0x01
162#define MPT_TARGET_FLAGS_VOLUME		0x02
163#define MPT_TARGET_FLAGS_DELETED	0x04
164
165/**
166 * struct MPT2SAS_TARGET - starget private hostdata
167 * @starget: starget object
168 * @sas_address: target sas address
169 * @handle: device handle
170 * @num_luns: number luns
171 * @flags: MPT_TARGET_FLAGS_XXX flags
172 * @deleted: target flaged for deletion
173 * @tm_busy: target is busy with TM request.
174 */
175struct MPT2SAS_TARGET {
176	struct scsi_target *starget;
177	u64	sas_address;
178	u16	handle;
179	int	num_luns;
180	u32	flags;
181	u8	deleted;
182	u8	tm_busy;
183};
184
185/*
186 * per device private data
187 */
188#define MPT_DEVICE_FLAGS_INIT		0x01
189#define MPT_DEVICE_TLR_ON		0x02
190
191/**
192 * struct MPT2SAS_DEVICE - sdev private hostdata
193 * @sas_target: starget private hostdata
194 * @lun: lun number
195 * @flags: MPT_DEVICE_XXX flags
196 * @configured_lun: lun is configured
197 * @block: device is in SDEV_BLOCK state
198 * @tlr_snoop_check: flag used in determining whether to disable TLR
199 */
200
201/* OEM Identifiers */
202#define MFG10_OEM_ID_INVALID                   (0x00000000)
203#define MFG10_OEM_ID_DELL                      (0x00000001)
204#define MFG10_OEM_ID_FSC                       (0x00000002)
205#define MFG10_OEM_ID_SUN                       (0x00000003)
206#define MFG10_OEM_ID_IBM                       (0x00000004)
207
208/* GENERIC Flags 0*/
209#define MFG10_GF0_OCE_DISABLED                 (0x00000001)
210#define MFG10_GF0_R1E_DRIVE_COUNT              (0x00000002)
211#define MFG10_GF0_R10_DISPLAY                  (0x00000004)
212#define MFG10_GF0_SSD_DATA_SCRUB_DISABLE       (0x00000008)
213#define MFG10_GF0_SINGLE_DRIVE_R0              (0x00000010)
214
215/* OEM Specific Flags will come from OEM specific header files */
216typedef struct _MPI2_CONFIG_PAGE_MAN_10 {
217    MPI2_CONFIG_PAGE_HEADER Header;                                 /* 00h */
218    U8                      OEMIdentifier;                          /* 04h */
219    U8                      Reserved1;                              /* 05h */
220    U16                     Reserved2;                              /* 08h */
221    U32                     Reserved3;                              /* 0Ch */
222    U32                     GenericFlags0;                          /* 10h */
223    U32                     GenericFlags1;                          /* 14h */
224    U32                     Reserved4;                              /* 18h */
225    U32                     OEMSpecificFlags0;                      /* 1Ch */
226    U32                     OEMSpecificFlags1;                      /* 20h */
227    U32                     Reserved5[18];                          /* 24h-60h*/
228} MPI2_CONFIG_PAGE_MAN_10,
229  MPI2_POINTER PTR_MPI2_CONFIG_PAGE_MAN_10,
230  Mpi2ManufacturingPage10_t, MPI2_POINTER pMpi2ManufacturingPage10_t;
231
232struct MPT2SAS_DEVICE {
233	struct MPT2SAS_TARGET *sas_target;
234	unsigned int	lun;
235	u32	flags;
236	u8	configured_lun;
237	u8	block;
238	u8	tlr_snoop_check;
239};
240
241#define MPT2_CMD_NOT_USED	0x8000	/* free */
242#define MPT2_CMD_COMPLETE	0x0001	/* completed */
243#define MPT2_CMD_PENDING	0x0002	/* pending */
244#define MPT2_CMD_REPLY_VALID	0x0004	/* reply is valid */
245#define MPT2_CMD_RESET		0x0008	/* host reset dropped the command */
246
247/**
248 * struct _internal_cmd - internal commands struct
249 * @mutex: mutex
250 * @done: completion
251 * @reply: reply message pointer
252 * @status: MPT2_CMD_XXX status
253 * @smid: system message id
254 */
255struct _internal_cmd {
256	struct mutex mutex;
257	struct completion done;
258	void 	*reply;
259	u16	status;
260	u16	smid;
261};
262
263/*
264 * SAS Topology Structures
265 */
266
267#define MPTSAS_STATE_TR_SEND		0x0001
268#define MPTSAS_STATE_TR_COMPLETE	0x0002
269#define MPTSAS_STATE_CNTRL_SEND		0x0004
270#define MPTSAS_STATE_CNTRL_COMPLETE	0x0008
271
272#define MPT2SAS_REQ_SAS_CNTRL		0x0010
273
274/**
275 * struct _sas_device - attached device information
276 * @list: sas device list
277 * @starget: starget object
278 * @sas_address: device sas address
279 * @device_name: retrieved from the SAS IDENTIFY frame.
280 * @handle: device handle
281 * @sas_address_parent: sas address of parent expander or sas host
282 * @enclosure_handle: enclosure handle
283 * @enclosure_logical_id: enclosure logical identifier
284 * @volume_handle: volume handle (valid when hidden raid member)
285 * @volume_wwid: volume unique identifier
286 * @device_info: bitfield provides detailed info about the device
287 * @id: target id
288 * @channel: target channel
289 * @slot: number number
290 * @hidden_raid_component: set to 1 when this is a raid member
291 * @responding: used in _scsih_sas_device_mark_responding
292 */
293struct _sas_device {
294	struct list_head list;
295	struct scsi_target *starget;
296	u64	sas_address;
297	u64	device_name;
298	u16	handle;
299	u64	sas_address_parent;
300	u16	enclosure_handle;
301	u64	enclosure_logical_id;
302	u16	volume_handle;
303	u64	volume_wwid;
304	u32	device_info;
305	int	id;
306	int	channel;
307	u16	slot;
308	u8	hidden_raid_component;
309	u8	responding;
310	u16	state;
311};
312
313/**
314 * struct _raid_device - raid volume link list
315 * @list: sas device list
316 * @starget: starget object
317 * @sdev: scsi device struct (volumes are single lun)
318 * @wwid: unique identifier for the volume
319 * @handle: device handle
320 * @id: target id
321 * @channel: target channel
322 * @volume_type: the raid level
323 * @device_info: bitfield provides detailed info about the hidden components
324 * @num_pds: number of hidden raid components
325 * @responding: used in _scsih_raid_device_mark_responding
326 * @percent_complete: resync percent complete
327 */
328struct _raid_device {
329	struct list_head list;
330	struct scsi_target *starget;
331	struct scsi_device *sdev;
332	u64	wwid;
333	u16	handle;
334	int	id;
335	int	channel;
336	u8	volume_type;
337	u32	device_info;
338	u8	num_pds;
339	u8	responding;
340	u8	percent_complete;
341};
342
343/**
344 * struct _boot_device - boot device info
345 * @is_raid: flag to indicate whether this is volume
346 * @device: holds pointer for either struct _sas_device or
347 *     struct _raid_device
348 */
349struct _boot_device {
350	u8 is_raid;
351	void *device;
352};
353
354/**
355 * struct _sas_port - wide/narrow sas port information
356 * @port_list: list of ports belonging to expander
357 * @num_phys: number of phys belonging to this port
358 * @remote_identify: attached device identification
359 * @rphy: sas transport rphy object
360 * @port: sas transport wide/narrow port object
361 * @phy_list: _sas_phy list objects belonging to this port
362 */
363struct _sas_port {
364	struct list_head port_list;
365	u8	num_phys;
366	struct sas_identify remote_identify;
367	struct sas_rphy *rphy;
368	struct sas_port *port;
369	struct list_head phy_list;
370};
371
372/**
373 * struct _sas_phy - phy information
374 * @port_siblings: list of phys belonging to a port
375 * @identify: phy identification
376 * @remote_identify: attached device identification
377 * @phy: sas transport phy object
378 * @phy_id: unique phy id
379 * @handle: device handle for this phy
380 * @attached_handle: device handle for attached device
381 */
382struct _sas_phy {
383	struct list_head port_siblings;
384	struct sas_identify identify;
385	struct sas_identify remote_identify;
386	struct sas_phy *phy;
387	u8	phy_id;
388	u16	handle;
389	u16	attached_handle;
390};
391
392/**
393 * struct _sas_node - sas_host/expander information
394 * @list: list of expanders
395 * @parent_dev: parent device class
396 * @num_phys: number phys belonging to this sas_host/expander
397 * @sas_address: sas address of this sas_host/expander
398 * @handle: handle for this sas_host/expander
399 * @sas_address_parent: sas address of parent expander or sas host
400 * @enclosure_handle: handle for this a member of an enclosure
401 * @device_info: bitwise defining capabilities of this sas_host/expander
402 * @responding: used in _scsih_expander_device_mark_responding
403 * @phy: a list of phys that make up this sas_host/expander
404 * @sas_port_list: list of ports attached to this sas_host/expander
405 */
406struct _sas_node {
407	struct list_head list;
408	struct device *parent_dev;
409	u8	num_phys;
410	u64	sas_address;
411	u16	handle;
412	u64	sas_address_parent;
413	u16	enclosure_handle;
414	u64	enclosure_logical_id;
415	u8	responding;
416	struct	_sas_phy *phy;
417	struct list_head sas_port_list;
418};
419
420/**
421 * enum reset_type - reset state
422 * @FORCE_BIG_HAMMER: issue diagnostic reset
423 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
424 */
425enum reset_type {
426	FORCE_BIG_HAMMER,
427	SOFT_RESET,
428};
429
430/**
431 * struct request_tracker - firmware request tracker
432 * @smid: system message id
433 * @scmd: scsi request pointer
434 * @cb_idx: callback index
435 * @chain_list: list of chains associated to this IO
436 * @tracker_list: list of free request (ioc->free_list)
437 */
438struct request_tracker {
439	u16	smid;
440	struct scsi_cmnd *scmd;
441	u8	cb_idx;
442	struct list_head tracker_list;
443};
444
445/**
446 * struct _tr_list - target reset list
447 * @handle: device handle
448 * @state: state machine
449 */
450struct _tr_list {
451	struct list_head list;
452	u16	handle;
453	u16	state;
454};
455
456typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
457
458/**
459 * struct MPT2SAS_ADAPTER - per adapter struct
460 * @list: ioc_list
461 * @shost: shost object
462 * @id: unique adapter id
463 * @pci_irq: irq number
464 * @name: generic ioc string
465 * @tmp_string: tmp string used for logging
466 * @pdev: pci pdev object
467 * @chip: memory mapped register space
468 * @chip_phys: physical addrss prior to mapping
469 * @logging_level: see mpt2sas_debug.h
470 * @fwfault_debug: debuging FW timeouts
471 * @ir_firmware: IR firmware present
472 * @bars: bitmask of BAR's that must be configured
473 * @mask_interrupts: ignore interrupt
474 * @fault_reset_work_q_name: fw fault work queue
475 * @fault_reset_work_q: ""
476 * @fault_reset_work: ""
477 * @firmware_event_name: fw event work queue
478 * @firmware_event_thread: ""
479 * @fw_events_off: flag to turn off fw event handling
480 * @fw_event_lock:
481 * @fw_event_list: list of fw events
482 * @aen_event_read_flag: event log was read
483 * @broadcast_aen_busy: broadcast aen waiting to be serviced
484 * @shost_recovery: host reset in progress
485 * @ioc_reset_in_progress_lock:
486 * @ioc_link_reset_in_progress: phy/hard reset in progress
487 * @ignore_loginfos: ignore loginfos during task managment
488 * @remove_host: flag for when driver unloads, to avoid sending dev resets
489 * @wait_for_port_enable_to_complete:
490 * @msix_enable: flag indicating msix is enabled
491 * @msix_vector_count: number msix vectors
492 * @msix_table: virt address to the msix table
493 * @msix_table_backup: backup msix table
494 * @scsi_io_cb_idx: shost generated commands
495 * @tm_cb_idx: task management commands
496 * @scsih_cb_idx: scsih internal commands
497 * @transport_cb_idx: transport internal commands
498 * @ctl_cb_idx: clt internal commands
499 * @base_cb_idx: base internal commands
500 * @config_cb_idx: base internal commands
501 * @base_cmds:
502 * @transport_cmds:
503 * @scsih_cmds:
504 * @tm_cmds:
505 * @ctl_cmds:
506 * @config_cmds:
507 * @base_add_sg_single: handler for either 32/64 bit sgl's
508 * @event_type: bits indicating which events to log
509 * @event_context: unique id for each logged event
510 * @event_log: event log pointer
511 * @event_masks: events that are masked
512 * @facts: static facts data
513 * @pfacts: static port facts data
514 * @manu_pg0: static manufacturing page 0
515 * @manu_pg10: static manufacturing page 10
516 * @bios_pg2: static bios page 2
517 * @bios_pg3: static bios page 3
518 * @ioc_pg8: static ioc page 8
519 * @iounit_pg0: static iounit page 0
520 * @iounit_pg1: static iounit page 1
521 * @sas_hba: sas host object
522 * @sas_expander_list: expander object list
523 * @sas_node_lock:
524 * @sas_device_list: sas device object list
525 * @sas_device_init_list: sas device object list (used only at init time)
526 * @sas_device_lock:
527 * @io_missing_delay: time for IO completed by fw when PDR enabled
528 * @device_missing_delay: time for device missing by fw when PDR enabled
529 * @config_page_sz: config page size
530 * @config_page: reserve memory for config page payload
531 * @config_page_dma:
532 * @hba_queue_depth: hba request queue depth
533 * @sge_size: sg element size for either 32/64 bit
534 * @scsiio_depth: SCSI_IO queue depth
535 * @request_sz: per request frame size
536 * @request: pool of request frames
537 * @request_dma:
538 * @request_dma_sz:
539 * @scsi_lookup: firmware request tracker list
540 * @scsi_lookup_lock:
541 * @free_list: free list of request
542 * @chain: pool of chains
543 * @pending_io_count:
544 * @reset_wq:
545 * @chain_dma:
546 * @max_sges_in_main_message: number sg elements in main message
547 * @max_sges_in_chain_message: number sg elements per chain
548 * @chains_needed_per_io: max chains per io
549 * @chain_offset_value_for_main_message: location 1st sg in main
550 * @chain_depth: total chains allocated
551 * @hi_priority_smid:
552 * @hi_priority:
553 * @hi_priority_dma:
554 * @hi_priority_depth:
555 * @hpr_lookup:
556 * @hpr_free_list:
557 * @internal_smid:
558 * @internal:
559 * @internal_dma:
560 * @internal_depth:
561 * @internal_lookup:
562 * @internal_free_list:
563 * @sense: pool of sense
564 * @sense_dma:
565 * @sense_dma_pool:
566 * @reply_depth: hba reply queue depth:
567 * @reply_sz: per reply frame size:
568 * @reply: pool of replys:
569 * @reply_dma:
570 * @reply_dma_pool:
571 * @reply_free_queue_depth: reply free depth
572 * @reply_free: pool for reply free queue (32 bit addr)
573 * @reply_free_dma:
574 * @reply_free_dma_pool:
575 * @reply_free_host_index: tail index in pool to insert free replys
576 * @reply_post_queue_depth: reply post queue depth
577 * @reply_post_free: pool for reply post (64bit descriptor)
578 * @reply_post_free_dma:
579 * @reply_post_free_dma_pool:
580 * @reply_post_host_index: head index in the pool where FW completes IO
581 */
582struct MPT2SAS_ADAPTER {
583	struct list_head list;
584	struct Scsi_Host *shost;
585	u8		id;
586	u32		pci_irq;
587	char		name[MPT_NAME_LENGTH];
588	char		tmp_string[MPT_STRING_LENGTH];
589	struct pci_dev	*pdev;
590	Mpi2SystemInterfaceRegs_t __iomem *chip;
591	resource_size_t	chip_phys;
592	int		logging_level;
593	int		fwfault_debug;
594	u8		ir_firmware;
595	int		bars;
596	u8		mask_interrupts;
597
598	/* fw fault handler */
599	char		fault_reset_work_q_name[20];
600	struct workqueue_struct *fault_reset_work_q;
601	struct delayed_work fault_reset_work;
602
603	/* fw event handler */
604	char		firmware_event_name[20];
605	struct workqueue_struct	*firmware_event_thread;
606	u8		fw_events_off;
607	spinlock_t	fw_event_lock;
608	struct list_head fw_event_list;
609
610	 /* misc flags */
611	int		aen_event_read_flag;
612	u8		broadcast_aen_busy;
613	u8		shost_recovery;
614	spinlock_t 	ioc_reset_in_progress_lock;
615	u8		ioc_link_reset_in_progress;
616	u8		ignore_loginfos;
617	u8		remove_host;
618	u8		wait_for_port_enable_to_complete;
619
620	u8		msix_enable;
621	u16		msix_vector_count;
622	u32		*msix_table;
623	u32		*msix_table_backup;
624
625	/* internal commands, callback index */
626	u8		scsi_io_cb_idx;
627	u8		tm_cb_idx;
628	u8		transport_cb_idx;
629	u8		scsih_cb_idx;
630	u8		ctl_cb_idx;
631	u8		base_cb_idx;
632	u8		config_cb_idx;
633	u8		tm_tr_cb_idx;
634	u8		tm_sas_control_cb_idx;
635	struct _internal_cmd base_cmds;
636	struct _internal_cmd transport_cmds;
637	struct _internal_cmd scsih_cmds;
638	struct _internal_cmd tm_cmds;
639	struct _internal_cmd ctl_cmds;
640	struct _internal_cmd config_cmds;
641
642	MPT_ADD_SGE	base_add_sg_single;
643
644	/* event log */
645	u32		event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
646	u32		event_context;
647	void		*event_log;
648	u32		event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
649
650	/* static config pages */
651	Mpi2IOCFactsReply_t facts;
652	Mpi2PortFactsReply_t *pfacts;
653	Mpi2ManufacturingPage0_t manu_pg0;
654	Mpi2BiosPage2_t	bios_pg2;
655	Mpi2BiosPage3_t	bios_pg3;
656	Mpi2IOCPage8_t ioc_pg8;
657	Mpi2IOUnitPage0_t iounit_pg0;
658	Mpi2IOUnitPage1_t iounit_pg1;
659
660	struct _boot_device req_boot_device;
661	struct _boot_device req_alt_boot_device;
662	struct _boot_device current_boot_device;
663
664	/* sas hba, expander, and device list */
665	struct _sas_node sas_hba;
666	struct list_head sas_expander_list;
667	spinlock_t	sas_node_lock;
668	struct list_head sas_device_list;
669	struct list_head sas_device_init_list;
670	spinlock_t	sas_device_lock;
671	struct list_head raid_device_list;
672	spinlock_t	raid_device_lock;
673	u8		io_missing_delay;
674	u16		device_missing_delay;
675	int		sas_id;
676
677	/* config page */
678	u16		config_page_sz;
679	void 		*config_page;
680	dma_addr_t	config_page_dma;
681
682	/* scsiio request */
683	u16		hba_queue_depth;
684	u16		sge_size;
685	u16 		scsiio_depth;
686	u16		request_sz;
687	u8		*request;
688	dma_addr_t	request_dma;
689	u32		request_dma_sz;
690	struct request_tracker *scsi_lookup;
691	spinlock_t scsi_lookup_lock;
692	struct list_head free_list;
693	int		pending_io_count;
694	wait_queue_head_t reset_wq;
695
696	/* chain */
697	u8		*chain;
698	dma_addr_t	chain_dma;
699	u16 		max_sges_in_main_message;
700	u16		max_sges_in_chain_message;
701	u16		chains_needed_per_io;
702	u16		chain_offset_value_for_main_message;
703	u16		chain_depth;
704
705	/* hi-priority queue */
706	u16		hi_priority_smid;
707	u8		*hi_priority;
708	dma_addr_t	hi_priority_dma;
709	u16		hi_priority_depth;
710	struct request_tracker *hpr_lookup;
711	struct list_head hpr_free_list;
712
713	/* internal queue */
714	u16		internal_smid;
715	u8		*internal;
716	dma_addr_t	internal_dma;
717	u16		internal_depth;
718	struct request_tracker *internal_lookup;
719	struct list_head internal_free_list;
720
721	/* sense */
722	u8		*sense;
723	dma_addr_t	sense_dma;
724	struct dma_pool *sense_dma_pool;
725
726	/* reply */
727	u16		reply_sz;
728	u8		*reply;
729	dma_addr_t	reply_dma;
730	struct dma_pool *reply_dma_pool;
731
732	/* reply free queue */
733	u16 		reply_free_queue_depth;
734	u32		*reply_free;
735	dma_addr_t	reply_free_dma;
736	struct dma_pool *reply_free_dma_pool;
737	u32		reply_free_host_index;
738
739	/* reply post queue */
740	u16 		reply_post_queue_depth;
741	Mpi2ReplyDescriptorsUnion_t *reply_post_free;
742	dma_addr_t	reply_post_free_dma;
743	struct dma_pool *reply_post_free_dma_pool;
744	u32		reply_post_host_index;
745
746	struct list_head delayed_tr_list;
747
748	/* diag buffer support */
749	u8		*diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
750	u32		diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
751	dma_addr_t	diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
752	u8		diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
753	u32		unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
754	Mpi2ManufacturingPage10_t manu_pg10;
755	u32		product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
756	u32		diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
757};
758
759typedef u8 (*MPT_CALLBACK)(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
760    u32 reply);
761
762
763/* base shared API */
764extern struct list_head mpt2sas_ioc_list;
765void mpt2sas_base_start_watchdog(struct MPT2SAS_ADAPTER *ioc);
766void mpt2sas_base_stop_watchdog(struct MPT2SAS_ADAPTER *ioc);
767
768int mpt2sas_base_attach(struct MPT2SAS_ADAPTER *ioc);
769void mpt2sas_base_detach(struct MPT2SAS_ADAPTER *ioc);
770int mpt2sas_base_map_resources(struct MPT2SAS_ADAPTER *ioc);
771void mpt2sas_base_free_resources(struct MPT2SAS_ADAPTER *ioc);
772int mpt2sas_base_hard_reset_handler(struct MPT2SAS_ADAPTER *ioc, int sleep_flag,
773    enum reset_type type);
774
775void *mpt2sas_base_get_msg_frame(struct MPT2SAS_ADAPTER *ioc, u16 smid);
776void *mpt2sas_base_get_sense_buffer(struct MPT2SAS_ADAPTER *ioc, u16 smid);
777void mpt2sas_base_build_zero_len_sge(struct MPT2SAS_ADAPTER *ioc, void *paddr);
778__le32 mpt2sas_base_get_sense_buffer_dma(struct MPT2SAS_ADAPTER *ioc,
779    u16 smid);
780
781/* hi-priority queue */
782u16 mpt2sas_base_get_smid_hpr(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
783u16 mpt2sas_base_get_smid_scsiio(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx,
784    struct scsi_cmnd *scmd);
785
786u16 mpt2sas_base_get_smid(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
787void mpt2sas_base_free_smid(struct MPT2SAS_ADAPTER *ioc, u16 smid);
788void mpt2sas_base_put_smid_scsi_io(struct MPT2SAS_ADAPTER *ioc, u16 smid,
789    u16 handle);
790void mpt2sas_base_put_smid_hi_priority(struct MPT2SAS_ADAPTER *ioc, u16 smid);
791void mpt2sas_base_put_smid_target_assist(struct MPT2SAS_ADAPTER *ioc, u16 smid,
792    u16 io_index);
793void mpt2sas_base_put_smid_default(struct MPT2SAS_ADAPTER *ioc, u16 smid);
794void mpt2sas_base_initialize_callback_handler(void);
795u8 mpt2sas_base_register_callback_handler(MPT_CALLBACK cb_func);
796void mpt2sas_base_release_callback_handler(u8 cb_idx);
797
798u8 mpt2sas_base_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
799    u32 reply);
800void *mpt2sas_base_get_reply_virt_addr(struct MPT2SAS_ADAPTER *ioc, u32 phys_addr);
801
802u32 mpt2sas_base_get_iocstate(struct MPT2SAS_ADAPTER *ioc, int cooked);
803
804void mpt2sas_base_fault_info(struct MPT2SAS_ADAPTER *ioc , u16 fault_code);
805int mpt2sas_base_sas_iounit_control(struct MPT2SAS_ADAPTER *ioc,
806    Mpi2SasIoUnitControlReply_t *mpi_reply, Mpi2SasIoUnitControlRequest_t
807    *mpi_request);
808int mpt2sas_base_scsi_enclosure_processor(struct MPT2SAS_ADAPTER *ioc,
809    Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
810void mpt2sas_base_validate_event_type(struct MPT2SAS_ADAPTER *ioc, u32 *event_type);
811
812void mpt2sas_halt_firmware(struct MPT2SAS_ADAPTER *ioc);
813
814/* scsih shared API */
815u8 mpt2sas_scsih_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
816    u32 reply);
817void mpt2sas_scsih_issue_tm(struct MPT2SAS_ADAPTER *ioc, u16 handle, uint lun,
818    u8 type, u16 smid_task, ulong timeout);
819void mpt2sas_scsih_set_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
820void mpt2sas_scsih_clear_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
821struct _sas_node *mpt2sas_scsih_expander_find_by_handle(struct MPT2SAS_ADAPTER *ioc,
822    u16 handle);
823struct _sas_node *mpt2sas_scsih_expander_find_by_sas_address(struct MPT2SAS_ADAPTER
824    *ioc, u64 sas_address);
825struct _sas_device *mpt2sas_scsih_sas_device_find_by_sas_address(
826    struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
827
828void mpt2sas_scsih_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
829
830/* config shared API */
831u8 mpt2sas_config_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
832    u32 reply);
833int mpt2sas_config_get_number_hba_phys(struct MPT2SAS_ADAPTER *ioc, u8 *num_phys);
834int mpt2sas_config_get_manufacturing_pg0(struct MPT2SAS_ADAPTER *ioc,
835    Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
836int mpt2sas_config_get_manufacturing_pg10(struct MPT2SAS_ADAPTER *ioc,
837    Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage10_t *config_page);
838int mpt2sas_config_get_bios_pg2(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
839    *mpi_reply, Mpi2BiosPage2_t *config_page);
840int mpt2sas_config_get_bios_pg3(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
841    *mpi_reply, Mpi2BiosPage3_t *config_page);
842int mpt2sas_config_get_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
843    *mpi_reply, Mpi2IOUnitPage0_t *config_page);
844int mpt2sas_config_get_sas_device_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
845    *mpi_reply, Mpi2SasDevicePage0_t *config_page, u32 form, u32 handle);
846int mpt2sas_config_get_sas_device_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
847    *mpi_reply, Mpi2SasDevicePage1_t *config_page, u32 form, u32 handle);
848int mpt2sas_config_get_sas_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
849    *mpi_reply, Mpi2SasIOUnitPage0_t *config_page, u16 sz);
850int mpt2sas_config_get_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
851    *mpi_reply, Mpi2IOUnitPage1_t *config_page);
852int mpt2sas_config_set_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
853    *mpi_reply, Mpi2IOUnitPage1_t *config_page);
854int mpt2sas_config_get_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
855    *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
856int mpt2sas_config_set_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc,
857    Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
858int mpt2sas_config_get_ioc_pg8(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
859    *mpi_reply, Mpi2IOCPage8_t *config_page);
860int mpt2sas_config_get_expander_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
861    *mpi_reply, Mpi2ExpanderPage0_t *config_page, u32 form, u32 handle);
862int mpt2sas_config_get_expander_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
863    *mpi_reply, Mpi2ExpanderPage1_t *config_page, u32 phy_number, u16 handle);
864int mpt2sas_config_get_enclosure_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
865    *mpi_reply, Mpi2SasEnclosurePage0_t *config_page, u32 form, u32 handle);
866int mpt2sas_config_get_phy_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
867    *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
868int mpt2sas_config_get_phy_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
869    *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
870int mpt2sas_config_get_raid_volume_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
871    *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, u32 handle);
872int mpt2sas_config_get_number_pds(struct MPT2SAS_ADAPTER *ioc, u16 handle, u8 *num_pds);
873int mpt2sas_config_get_raid_volume_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
874    *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form, u32 handle, u16 sz);
875int mpt2sas_config_get_phys_disk_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
876    *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, u32 form,
877    u32 form_specific);
878int mpt2sas_config_get_volume_handle(struct MPT2SAS_ADAPTER *ioc, u16 pd_handle,
879    u16 *volume_handle);
880int mpt2sas_config_get_volume_wwid(struct MPT2SAS_ADAPTER *ioc, u16 volume_handle,
881    u64 *wwid);
882/* ctl shared API */
883extern struct device_attribute *mpt2sas_host_attrs[];
884extern struct device_attribute *mpt2sas_dev_attrs[];
885void mpt2sas_ctl_init(void);
886void mpt2sas_ctl_exit(void);
887u8 mpt2sas_ctl_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
888    u32 reply);
889void mpt2sas_ctl_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
890u8 mpt2sas_ctl_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
891    u32 reply);
892void mpt2sas_ctl_add_to_event_log(struct MPT2SAS_ADAPTER *ioc,
893    Mpi2EventNotificationReply_t *mpi_reply);
894
895void mpt2sas_enable_diag_buffer(struct MPT2SAS_ADAPTER *ioc,
896	u8 bits_to_regsiter);
897
898/* transport shared API */
899u8 mpt2sas_transport_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
900    u32 reply);
901struct _sas_port *mpt2sas_transport_port_add(struct MPT2SAS_ADAPTER *ioc,
902     u16 handle, u64 sas_address);
903void mpt2sas_transport_port_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address,
904     u64 sas_address_parent);
905int mpt2sas_transport_add_host_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
906    *mpt2sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
907int mpt2sas_transport_add_expander_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
908    *mpt2sas_phy, Mpi2ExpanderPage1_t expander_pg1, struct device *parent_dev);
909void mpt2sas_transport_update_links(struct MPT2SAS_ADAPTER *ioc,
910     u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
911extern struct sas_function_template mpt2sas_transport_functions;
912extern struct scsi_transport_template *mpt2sas_transport_template;
913extern int scsi_internal_device_block(struct scsi_device *sdev);
914extern u8 mpt2sas_stm_zero_smid_handler(struct MPT2SAS_ADAPTER *ioc,
915    u8 msix_index, u32 reply);
916extern int scsi_internal_device_unblock(struct scsi_device *sdev);
917
918#endif /* MPT2SAS_BASE_H_INCLUDED */
919